This section describes the main functionalities in the VSS Communication Framework. :
Imagine the following user stories:
...
Dynamic parameters can be used in notification customizing, notification trigger definition and task transaction definition. To check, whether given field value can be entered as dynamic parameter, please refer to Performance Assistant (F1 help) for the field in SAP-GUI. For example:
...
Definition
Dynamic Parameter type
...
Any field from DDIC structure /DBE/DP_STR_PYMNT_TR_DETAIL.
xxxx
Dynamic Date Processor operators
...
.
Task instance
Attributes
In general, all simple fields of structure /DBE/CF_STR_INS_TASK_BASE are available as Task instance attributes. It means, that any customer-enhancement fields added to that structure will become available as well. Below is the list of most important standard Task instance attributes.
TASK_ID
Task ID
Data type (internal): CHAR 30 (/DBE/CF_TASK_ID)
TASK_KEY
Key properties formatted into one field
Data type (internal): CHAR 70
STATUS
Current status
Data type (internal): CHAR 10 (/DBE/CF_TASK_STATUS)
STATUS_PR
Previous status
Data type (internal): CHAR 10 (/DBE/CF_TASK_STATUS)
STATUS_TS
Time of the status change (timestamp)
Data type (internal): DEC 15 (TZNTSTMPS)
HISTRY_TS
Time of history change (timestamp)
Data type (internal): DEC 15 (TZNTSTMPS)
SRCOB_CL
Source object class
Data type (internal): CHAR 2 (/DBE/CF_SRCOB_CLASS)
SRCOB_TYPE
Source object type
Data type (internal): CHAR 30 (/DBE/CF_SRCOB_TYPE)
SRCOB_KEY
Source object key
Data type (internal): CHAR 70
SRCOB_EXTID
Source object external key
Data type (internal): CHAR 50
PRIORITY
Task priority (priority code)
Data type (internal): CHAR 1 (/DBE/CF_TASK_PRIORITY)
DUEDATE
Due date (date)
Data type (internal): CHAR 8 (DATS)
XREATM_TS
Expected reaction time (timestamp)
Data type (internal): DEC 15 (TZNTSTMPS)
CREATED_AT
Time of the task creation (timestamp)
Data type (internal): DEC 15 (TZNTSTMPS)
CHANGED_AT
Time of the task update (timestamp)
Data type (internal): DEC 15 (TZNTSTMPS)
CLOSED
Task closed indicator (Boolean)
Data type (internal): CHAR 1(XFELD)
CREATED_BY
Username of the task creator
Data type (internal): CHAR 12 (UBNAME)
CHANGED_BY
Username of the task last processor
Data type (internal): CHAR 12 (UBNAME)
PROGRESS
Progress value (percentage number)
Data type (internal): DEC 3.0
ITS_OBJTID
Internal Task Instance UID
Data type (internal): CHAR 32
ITSUID
Internal Task Instance UID (url-formatted)
Data type (internal): CHAR 32
STATUS_CT
Time elapsed from the status change (in seconds)
Data type (internal): DEC 10
HISTRY_CT
Time elapsed from the previous history update (in seconds)
Data type (internal): DEC 10
INITIATED_BY
Initiator of the last task update (encoded recipient ID)
Data type (internal): CHAR 82
XREATM_DATE
Expected reaction time (date part)
Data type (internal): CHAR 8 (DATS)
XREATM_TIME
Expected reaction time (time part)
Data type (internal): CHAR 6 (TIMS)
XREATM_EXC
Expected reaction time has exceeded (Boolean)
Data type (internal): CHAR 1(XFELD)
Special attributes
There are also special attributes predefined by the framework, that are used for access to some Task instance information, that is not available directly as simple attribute. It includes access to texts, attachments and Task properties. Special attributes are indicated by ‘@’ at the beginning of the name.
@TEXT
@T
Return text element information.
Usage syntax:
| Code Block |
|---|
$task|$tsk|$t-@text|@t[-<text_id>[-<field_name>[-<option>]]] |
Component meaning:
o TEXT_ID – ID of the text; possible values:
‘REMARKS’ for comments (default value),
‘DESCRIPTION’ for task description,
Any customer defined text ID).
o FIELD_NAME – ID of the text attribute that should be returned, possible values:
‘CONTENT’ – text content (default value),
‘SEQNO’ – text sequence number,
‘VERSION’ – text version number,
'CREATED_AT’ – username of the author,
‘CREATED_BY’ – time of the text creation (timestamp),
‘INITIATED_BY’ – text author (external).
o OPTION – control option; possible values:
‘ALL’ – return information of all text entries (result is a list),
‘LAST’ – return information for only last text entry (with last sequence number) (default value),
‘NEW’ – return information only for text added by last task transaction.
Components are optional, default values are used when not provided. Component can be omitted only if there is no subsequent component that needs to be provided.
Return type:
o FIELD_NAME: CONTENT, CREATED_BY, INITIATED_BY
String | String table
o FIELD_NAME: SEQNO, VERSION
Number | Number table
o FIELD_NAME: CREATED_AT
DEC 15 (TZNTSTMPS) | DEC 15 (TZNTSTMPS) table
@ATTACHMENT
@ATTA
@A
Return attachment information.
Usage syntax:
| Code Block |
|---|
$task|$tsk|$t-@attachment|@atta|@a[-<mimetype>[-<field_name>[-<option>]]] |
Component meaning:
o MIMETYPE – can be used to filter attachments by the type; by default, all types are selected (*/*)
o FIELD_NAME – ID of the attachment information attribute; possible values:
‘ID’ – attachment ID (default value),
‘FILENAME’ – file name of the attachment,
‘FILESIZE’ – size of the attachment,
‘MIMETYPE’ – type of the attachment.
o OPTION – control option; possible values:
‘ALL’ – get information for all attachments (result is a list) (default value),
‘LAST’ – get information about last attachment (of given type)
Components are optional, default values are used when not provided. Component can be omitted only if there is no subsequent component that needs to be provided.
Return type:
o FIELD_NAME: ID, FILENAME, MIMETYPE
String | String table
o FIELD_NAME: FILESIZE
Number | Number table
@PROPERTY
@PROP
@P
Returns value of the property ID. Works in similar way as function $PROPERTY, but property ID must be provided directly here (cannot be variable)
Usage syntax:
| Code Block |
|---|
$task|$tsk|$t-@property|@prop|@p-<property_id> |
Component meaning:
o PROPERTY_ID – ID of the property
Return type:
o String
Functions
Task instance provides few built-in functions, that operate on Task internal data and provide information not available via simple attributes. Customers are allowed to implement own build-int Task instance functions (refer to BAdI for Task instance processing).
PROPERTY
Returns value of the property passed by the name (ID). Property ID can be provided as dynamic parameter variable (in contrast to special attribute @PROPERTY).
Parameters:
o Property ID [character-like (/DBE/CF_TASK_PROP)]
Result type: string
INITIATOR_NAME
Returns name of the last task update initiatorP
arameters:
o none
Result type: string
STATUS_NAME
Returns name of the Task status
Parameters:
o Status ID [character-like (/DBE/CF_TASK_STATUS)]
Result type: string
Examples:
$task-xreatm_ext– returns ‘X’ (ABAP ‘true’) when expected reaction time has exceeded$task-$actor_id('RES')-recip_key– returns recipient key for the ‘Responsible’ actor role$task-@text– returns content of the last comment$task-@text-description-created_at– returns time of the task description update$task-@property-vin– returns value of the ‘VIN’ task property$task-@attachment-image/*– returns ID of all image attachments (result is a list of attachment ID)
Dynamic Date Processor operators
DAY
Parameters:
o Days [number, default: 0]
Result:
o Current date shifted by Days days.
WEEK_BEGIN
Parameters:
o Date [date, default: today]
o Weeks [number, default: 0]
Result:
o Begin of the week calculated from Date shifted by Weeks weeks.
WEEK_END
Parameters:
o Date [date, default: today]
o Weeks [number, default: 0]
Result:
o End of the week calculated from date Date shifted by Weeks weeks.
MONTH_BEGIN
Parameters:
o Date [date, default: today]
o Months [number, default: 0]
Result:
o Begin of the month calculated from date Date shifted by Months months.
MONTH_END
Parameters:
o Date [date, default: today]
o Months [number, default: 0]
Result:
o End of the month calculated from date Date shifted by Months months.
QUARTER_BEGIN
Parameters:
o Date [date, default: today]
o Quarters [number, default: 0]
Result:
o Begin of the quarter calculated from Date shifted by Quarters quarters.
QUARTER_END
Parameters:
o Date [date, default: today]
o Quarters [number, default: 0]
Result:
o End of the quarter calculated from Date shifted by Quarters quarters.
YEAR_BEGIN
Parameters:
o Date [date, default: today]
o Years [number, default: 0]
Result:
o Begin of the year calculated from Date shifted by Years years.
YEAR_END
Parameters:
o Date [date, default: today]
o Years [number, default: 0]
Result:
o End of the year calculated from Date shifted by Years years.
Examples:
$date-year_end– gets end of the current year$date-year_end(sy-datum, 1)– gets end of the next year$date-quarter_begin(sy-datum, -1)– gets begin of the previous quarter$date-quarter_end($date-year_begin, 1)– gets end of the 2nd quarter of the current year
...