Human task events

Human task events are sent if monitoring is requested for the elements of the task in WebSphere Integration Developer. A list of all the events that can be emitted by human tasks can be found here.

The following types of events can be caused by human tasks:
Note: Events are only emitted for ad-hoc tasks if the business relevance flag is set to true in the task model.

Events for inline tasks are emitted as activity events. For a list of these events, see Business process events

XML syntax

The payloads for human task events have the following syntax:
Read syntax diagramSkip visual syntax diagram
BPC.HTM.BASE

>>-BPC.HTM.BASE--HTMEventCode--| BPC.HTM.TASK.BASE |-----------><

BPC.HTM.TASK.BASE

|--BPC.HTM.TASK.BASE--taskTemplateName--taskTemplateValidFrom--taskTemplateId--+-| BPC.HTM.TASK.STATUS |-------+--|
                                                                               '-| BPC.HTM.ESCALATION.STATUS |-'   

Where:
HTMEventCode
The Business Process Choreographer event code that identifies the number of the event type. Possible event codes are listed in the following tables.
taskTemplateName
The name of the task template.
taskTemplateValidFrom
The date and time from which the task template is valid.
taskTemplateId
The ID of the template.

The name of event elements are in uppercase, for example BPC.HTM.BASE, and the names of extended data elements are in mixed case, for example, HTMEventCode. Except where indicated, all data elements are of the type string.

Key to table columns

The Code column contains the number of the event. The value is written to the Common Base Event as an extended data element with the name HTMEventCode. The columns are as follows:
Extension name
Contains the string value that is used as the value of the extensionName attribute of the Common Base Event.

If WebSphere Business Integration Modeler is used to create the underlying task model, the extension name for events that contain message data in their payload can be extended by a hash character (#) followed by additional characters. These additional characters are used to distinguish Common Base Events that carry different message objects. Events that emit message data also contain additional nested extendedDataElements in order to report the contents of the data object. Refer to the documentation for WebSphere Business Integration Modeler for more information.

Situation
Refers to the situation name of the human task event. For details of situations, see Situations in human task events.
Event nature
A pointer to the event situation for a business process element in the EventNature parameter, as they are displayed in WebSphere® Integration Developer.

Task events

The following table describes all task events.

Code Description Extension name Situation Event nature
51001 Task created BPC.HTM.TASK.INTERACT Report CREATED
51002 Task deleted BPC.HTM.TASK.STATUS Destroy DELETED
51003 Task started BPC.HTM.TASK.STATUS Start ENTRY
51004 Task completed BPC.HTM.TASK.STATUS Stop EXIT
51005 Claim canceled BPC.HTM.TASK.STATUS Report DEASSIGNED
51006 Task claimed BPC.HTM.TASK.INTERACT Report ASSIGNED
51007 Task terminated BPC.HTM.TASK.STATUS Stop TERMINATED
51008 Task failed BPC.HTM.TASK.FAILURE Fail FAILED
51009 Task expired BPC.HTM.TASK.STATUS Report EXPIRED
51010 Waiting for subtasks BPC.HTM.TASK.STATUS Report WAITFORSUBTASK
51011 Subtasks completed BPC.HTM.TASK.STATUS Stop SUBTASKCOMPLETED
51012 Task restarted BPC.HTM.TASK.STATUS Report RESTARTED
51013 Task suspended BPC.HTM.TASK.STATUS Report SUSPENDED
51014 Task resumed BPC.HTM.TASK.STATUS Report RESUMED
51015 Task completed and follow-on task started BPC.HTM.TASK.FOLLOW Report COMPLETEDFOLLOW
51101 Task properties updated BPC.HTM.TASK.STATUS Report UPDATED
51103 Output message updated BPC.HTM.TASK.MESSAGE Report OUTPUTSET
51104 Fault message updated BPC.HTM.TASK.MESSAGE Report FAULTSET
51201 Work item deleted BPC.HTM.TASK.WISTATUS Destroy WI_DELETED
51202 Work items created BPC.HTM.TASK.WISTATUS Report WI_CREATED
51204 Work item transferred BPC.HTM.TASKWITRANSFER Report WI_TRANSFERRED
51205 Work items refreshed BPC.HTM.TASK.WISTATUS Report WI_REFRESHED
The payloads for task events have the following syntax:
Read syntax diagramSkip visual syntax diagram
BPC.HTM.TASK.STATUS

>>-BPC.HTM.TASK.STATUS--+-------------------------+--+-------------------------------------------+-><
                        '-taskInstanceDescription-'  +-BPC.HTM.TASK.FOLLOW--followTaskId---------+   
                                                     +-BPC.HTM.TASK.MESSAGE--+-message----+------+   
                                                     |                       '-message_BO-'      |   
                                                     +-BPC.HTM.TASK.INTERACT--username-----------+   
                                                     +-BPC.HTM.TASK.FAILURE--taskFailedException-+   
                                                     |                        .----------.       |   
                                                     |                        V          |       |   
                                                     +-BPC.HTM.TASK.WISTATUS----username-+-------+   
                                                     '-BPC.HTM.TASK.WITRANSFER--current--target--'   

Where:
taskInstanceDescription
The description of the task.
followTaskId
The ID of the task that was started as a follow-on-task.
message or message_BO
A string or business object representation that contains the input or output message. The format depends on whether the Monitor Compatible Events option was selected on the Event Monitor tab in WebSphere Integration Developer.
taskFailedException
A string containing the faultNameSpace and faultName separated by a semicolon (;).
username
For BPC.HTM.TASK.INTERACT this is the name of the user associated with the task. For BPC.BPC.TASK.WISTATUS this is a list of users whose work item was created or deleted.
current
The name of the current user. This is the user whose work item has been transferred away.
target
The user name of the work item receiver.
For task events, the following identifiers of event correlation spheres are written as the context data elements to the Common Base Event:
  • The ESCcurrentID provides the ID of the task instance.
  • The ECSParentID is the ECSCurrentID before the task instance event.

Escalation events

The following table describes all task escalation events.

Code Description Extension name Situation
53001 Escalation fired BPC.HTM.ESCALATION.STATUS Report
53201 Work item deleted BPC.HTM.ESCALATION.WISTATUS Destroy
53202 Work item created BPC.HTM.ESCALATION.WISTATUS Report
53204 Escalation transferred BPC.HTM.ESCALATION. WITRANSFER Report
53205 Work item refreshed BPC.HTM.ESCALATION.WISTATUS Report
The payloads for escalation events have the following syntax:
Read syntax diagramSkip visual syntax diagram
BPC.HTM.ESCALATION.STATUS

>>-BPC.HTM.ESCALATION.STATUS--escalationName--+-------------------------------+--+------------------------------------------------+-><
                                              '-escalationInstanceDescription-'  |                              .----------.      |   
                                                                                 |                              V          |      |   
                                                                                 +-BPC.HTM.ESCALATION.WISTATUS----username-+------+   
                                                                                 '-BPC.HTM.ESCALATION.WITRANSFER--current--target-'   

Where:
EscalationName
The name of the escalation.
escalationInstanceDescription
The description of the escalation.
username
This is a list of users whose work item was escalated.
current
The name of the current user. This is the user whose work item has been transferred away.
target
The user name of the work item receiver.
For task events, the following identifiers of event correlation spheres are written as the context data elements to the Common Base Event:
  • The ESCcurrentID provides the ID of the escalation.
  • The ECSParentID provides the ID of the associated task instance.

Copyright IBM Corporation 2005, 2006.
This information center is powered by Eclipse technology (http://www.eclipse.org)