
Human task events
Human task events are sent if monitoring is requested for the elements of the task in IBM® Integration Designer. Use the information provided here for a detailed description of all of the events, that is, task events and escalation events, that can be emitted by human tasks.
Inline tasks can emit both human task events and activity events. For a list of the activity events, see Common Base Events for activities.
All human task events can be emitted in both the CEI and the audit trail, with the exception of the task template events. The task template events TASK_TEMPLATE_INSTALLED and TASK_TEMPLATE_UNINSTALLED can only be emitted in the audit trail.
XML Schema Definition (XSD) files
The structure of the events that are sent to CEI is described in the following schema definition file install_root\ProcessChoreographer\client\HTMEvents.xsd
Key to table columns
- Code
- Contains the number of the event. For Business Monitor 6.0.2 format events, the value is written to the Common Base Event as an extended data element with the name HTMEventCode. For Business Monitor 6.1 format events, the value is written to the xs:any slot of the Common Base Event.
- Event name and extension name
- This column contains
two values. The name of the event and the value that is set in the extensionName attribute
of the Common Base Event. The extension name identifies which event
specific information is contained in the Common Base Event, and it
is also the name of the XML element that provides additional data
about the 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 BPEL process element in the EventNature parameter, as they are displayed in Integration Designer.
Task events
The following table describes all task events.
| Code | Event name and extension name | Situation | Event nature | Description |
|---|---|---|---|---|
| 51001 | TASK_CREATED |
Report | CREATED | Task created |
| 51002 | TASK_DELETED |
Destroy | DELETED | Task deleted |
| 51003 | TASK_STARTED |
Start | ENTRY | Task started |
| 51004 | TASK_COMPLETED |
Stop | EXIT | Task completed |
| 51005 | TASK_CLAIM_ |
Report | DEASSIGNED | Claim canceled |
| 51006 | TASK_CLAIMED |
Report | ASSIGNED | Task claimed |
| 51007 | TASK_TERMINATED |
Stop | TERMINATED | Task terminated |
| 51008 | TASK_FAILED |
Fail | FAILED | Task failed |
| 51009 | TASK_EXPIRED |
Report | EXPIRED | Task expired |
| 51010 | TASK_WAITING_FOR_ |
Report | WAITFORSUBTASK | Waiting for subtasks |
| 51011 | TASK_SUBTASKS_ |
Stop | SUBTASKCOMPLETED | Subtasks completed |
| 51012 | TASK_RESTARTED |
Report | RESTARTED | Task restarted |
| 51013 | TASK_SUSPENDED |
Report | SUSPENDED | Task suspended |
| 51014 | TASK_RESUMED |
Report | RESUMED | Task resumed |
| 51015 | TASK_COMPLETED_ |
Report | COMPLETEDFOLLOW | Task completed and follow-on task started |
| 51101 | TASK_UPDATED |
Report | UPDATED | Task updated |
| 51102 | TASK_INPUT_MESSAGE_ |
Report | INPUTSET | Input message updated. Business object payload is available. |
| 51103 | TASK_OUTPUT_ |
Report | OUTPUTSET | Output message updated. Business object payload is available. |
| 51104 | TASK_FAULT_ |
Report | FAULTSET | Fault message updated. Business object payload is available. |
| 51201 | TASK_WORKITEM_ |
Destroy | WI_DELETED | Work item deleted |
| 51202 | TASK_WORKITEM_ |
Report | WI_CREATED | Work items created |
| 51204 | TASK_WORKITEM_ |
Report | WI_TRANSFERRED | Work item transferred |
| 51205 | TASK_WORKITEM_ |
Report | WI_REFRESHED | Work items refreshed |
| 51301 | TASK_CUSTOMPROPERTY_ |
Report | CP_SET | Custom property set. This event is generated when a custom property of a task instance is changed. |
| 52001 | TASK_TEMPLATE_ |
Report | INSTALLED | These are task template events, which are only emitted in the audit trail. They are not emitted as common base events, and are included here for completeness. |
| 52002 | TASK_TEMPLATE_ |
Report | UNINSTALLED | These are task template events, which are only emitted in the audit trail. They are not emitted as common base events, and are included here for completeness. |
- 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 | Event name and extension name | Situation | Event nature | Description |
|---|---|---|---|---|
| 53001 | ESCALATION_UPDATED |
Report | UPDATED | Escalation updated |
| 53201 | ESCALATION_WORKITEM_DELETED |
Destroy | WI_DELETED | Work item deleted |
| 53202 | ESCALATION_WORKITEM_CREATED |
Report | WI_CREATED | Work item created |
| 53204 | ESCALATION_WORKITEM_TRANSFERRED |
Report | WI_TRANSFERRED | Escalation transferred |
| 53205 | ESCALATION_WORKITEM_REFRESHED |
Report | WI_REFRESHED | Work item refreshed |
| 51302 | ESCALATION_CUSTOMPROPERTY_SET |
Report | CP_SET | Custom property set. This event is generated when a custom property of an escalation instance is changed. |
- The ESCcurrentID provides the ID of the escalation.
- The ECSParentID provides the ID of the associated task instance.