
Extension names for BPEL process events
The extension name indicates the payload of the event. A list of all the extension names for BPEL process events and their corresponding payload can be found here.
BPEL process events conform to the Common Base Event specification. The extension name contains the string value that is used as the value of the extensionName attribute of the event. This is also the name of the XML element that provides additional data about the event. The names of event elements are in uppercase, for example, BPC.BFM.BASE, and the names of XML elements are in mixed case, for example, BPCEventCode. Except where indicated, all data elements are of the type string.
- BPC.BFM.ACTIVITY
- BPC.BFM.ACTIVITY.BASE
- BPC.BFM.ACTIVITY.CHILD_PROCESS_TERMINATING
- BPC.BFM.ACTIVITY.CLAIM
- BPC.BFM.ACTIVITY.CONDITION
- BPC.BFM.ACTIVITY.CUSTOMPROPERTYSET
- BPC.BFM.ACTIVITY.ESCALATED
- BPC.BFM.ACTIVITY.EVENT
- BPC.BFM.ACTIVITY.FAILURE
- BPC.BFM.ACTIVITY.FOREACH
- BPC.BFM.ACTIVITY.JUMPED
- BPC.BFM.ACTIVITY.MESSAGE
- BPC.BFM.ACTIVITY.SKIP_ON_EXIT_CONDITION_TRUE
- BPC.BFM.ACTIVITY.SKIP_REQUESTED
- BPC.BFM.ACTIVITY.SKIPPED_ON_REQUEST
- BPC.BFM.ACTIVITY.STATUS
- BPC.BFM.ACTIVITY.TIMER_RESCHEDULED
- BPC.BFM.ACTIVITY.WISTATUS
- BPC.BFM.ACTIVITY.WITRANSFER
- BPC.BFM.BASE
- BPC.BFM.LINK
- BPC.BFM.PROCESS
- BPC.BFM.PROCESS.BASE
- BPC.BFM.PROCESS.CORREL
- BPC.BFM.PROCESS.CUSTOMPROPERTYSET
- BPC.BFM.PROCESS.ESCALATED
- BPC.BFM.PROCESS.EVENT
- BPC.BFM.PROCESS.FAILURE
- BPC.BFM.PROCESS.MIGRATED
- BPC.BFM.PROCESS.MIGRATIONTRIGGERED
- BPC.BFM.PROCESS.OWNERTRANSFER
- BPC.BFM.PROCESS.PARTNER
- BPC.BFM.PROCESS.START
- BPC.BFM.PROCESS.STATUS
- BPC.BFM.PROCESS.WISTATUS
- BPC.BFM.PROCESS.WITRANSFER
- BPC.BFM.VARIABLE
BPC.BFM.ACTIVITY.BASE
BPC.BFM.ACTIVITY.BASE inherits the XML elements from BPC.BFM.BASE.
| XML element | Description |
|---|---|
| activityKind | The activity kind, for example, sequence or
invoke. The format is: <kind code>-<kind
name>. This attribute can have one of the following values: 3 - KIND_EMPTY |
| state | The current state of the activity instance in
the format: state code-state name. For activities, this
attribute can have one of the following values: 1 - STATE_INACTIVE 1 - STATE_READY |
| bpelId | The wpc:id attribute of the activity in the BPEL file. It is unique for activities in a process model. |
| activityTemplateName | The name of the activity template. this can differ from the display name. |
| activityTemplateId | The internal ID of the activity template. |
| activityInstanceDescription | The description of the activity instance. |
| principal | The name of the user on whose behalf the current action is being performed. |
| taskInstanceId | The ID of the associated human task instance. This is only included for staff activity events. |
| processTemplateId | The ID of the process template. |
BPC.BFM.ACTIVITY.CHILD_PROCESS_TERMINATING
BPC.BFM.ACTIVITY.CHILD_PROCESS_TERMINATING inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| subState | The substate of the activity. The substate can
be one of the following strings: SUB_STATE_NONE |
| childProcessInstanceID | The ProcessInstanceID of the child process. |
BPC.BFM.ACTIVITY.CLAIM
BPC.BFM.ACTIVITY.CLAIM inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| username | The name of the user for whom the task has been claimed. |
BPC.BFM.ACTIVITY.CONDITION
| XML element | Description |
|---|---|
| branchBpelId | This is set to the value of the wpc:id attribute of the related case element, as specified in the BPEL file. This information is provided only for processes that are installed with version 6.1.2 or later. |
| condition | This specifies the condition as a string for XPath conditions. (This property is not present for otherwise or Java™ conditions.) |
| isForced | This specifies whether the event is triggered through the forceNavigate APIs (=true), or in any other way (=false). |
| isOtherwise | This specifies whether the otherwise branch is entered (=true) or a case branch is entered (=false). |
BPC.BFM.ACTIVITY.CUSTOMPROPERTYSET
BPC.BFM.ACTIVITY.CUSTOMPROPERTYSET inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| propertyName | The name of the custom property. |
| propertyValue | The value of the custom property. |
| ECSCurrentID | The associated process instance ID. |
| ECSParentID | The parent of the process instance. |
| associatedObjectID | The ID of the associated object that is the activity instance ID. |
| associatedObjectName | The name of the associated object that is the activity template name. |
| query | If isBinary is true, this element specifies the query string for the binary property. Otherwise, this element is not present. |
| type | If isBinary is true, this element specifies the type of the binary property. Otherwise, this element is not present. |
| isBinary | Set to false for string custom properties, and to true for binary custom properties. The payload type for binary custom properties is restricted to Empty. The property propertyValue is omitted for binary custom properties. |
BPC.BFM.ACTIVITY.ESCALATED
BPC.BFM.ACTIVITY.ESCALATED inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| escalationName | The name of the escalation. |
| operation | This is the operation that is associated with the event handler for which the inline invocation task is escalated. |
BPC.BFM.ACTIVITY.EVENT
BPC.BFM.ACTIVITY.EVENT inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| operation | The name of the operation for the received event. |
BPC.BFM.ACTIVITY.FAILURE
BPC.BFM.ACTIVITY.FAILURE inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| activityFailedException | The exception that caused the activity to fail. |
| faultNamespace | The namespace URI of the fault. |
| faultName | The local part of the fault. |
BPC.BFM.ACTIVITY.FOREACH
BPC.BFM.ACTIVITY.FOREACH inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| parallelBranchesStarted | The number of branches started. |
BPC.BFM.ACTIVITY.JUMPED
BPC.BFM.ACTIVITY.JUMPED inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| targetName | Contains the activity template name of the target activity for the jump. The aiid contained in the ECSCurrentId of the event refers to the source activity of the jump. |
BPC.BFM.ACTIVITY.MESSAGE
BPC.BFM.ACTIVITY.MESSAGE inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| message or message_BO | The input or the output message for the service
as a string or business object (BO) representation. The format depends
on whether the Monitor Compatible Events option
was selected on the Event Monitor tab in IBM® Integration
Designer. This attribute is only used for Business Monitor 6.0.2 format events. For Business Monitor 6.1 format events, the content of the message is written to the applicationData section, which contains one content element with the name set to the name of the message. |
BPC.BFM.ACTIVITY.SKIP_ON_EXIT_CONDITION_TRUE
BPC.BFM.ACTIVITY.SKIP_ON_EXIT_CONDITION_TRUE inherits the XML elements from BPC.BFM.ACTIVITY.BASE. No further specific properties are defined for BPC.BFM.ACTIVITY.SKIP_ON_EXIT_CONDITION_TRUE beyond the inherited properties
BPC.BFM.ACTIVITY.SKIP_REQUESTED
BPC.BFM.ACTIVITY.SKIP_REQUESTED inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| cancel | Cancel specifies whether the activity is skipped or not to distinguish between a skip (=false) and a cancelSkipRequest (=true) call. |
BPC.BFM.ACTIVITY.SKIPPED_ON_REQUEST
BPC.BFM.ACTIVITY.SKIPPED_ON_REQUEST inherits the XML elements from BPC.BFM.ACTIVITY.BASE. No further specific properties are defined for this BPC.BFM.ACTIVITY.SKIPPED_ON_REQUEST beyond the inherited properties
BPC.BFM.ACTIVITY.STATUS
BPC.BFM.ACTIVITY.STATUS inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| reason | The stop reason code. The
stop reason code is only relevant if the activity is in the stopped
state. It indicates the reason why the activity stopped. This attribute
can have one of the following values:
1 - STOP_REASON_UNSPECIFIED |
- FRETRIED and ENTRY for the element kinds invoke and staff (see CREATED).
- FCOMPLETED and EXIT for the element kinds: pick, receive, and reply.
BPC.BFM.ACTIVITY.TIMER_RESCHEDULED
BPC.BFM.ACTIVITY.TIMER_RESCHEDULED inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| timestamp | The date and time are expressed in Coordinated Universal Time (UTC), in the format yyyy-MM-dd[Thh:mm:ss], which represents year, month, day, T, hours, minutes, and seconds. |
BPC.BFM.ACTIVITY.WISTATUS
BPC.BFM.ACTIVITY.WISTATUS inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| username | The names of the users who are associated with the work item. |
| reason | The
reason for the assignment of the work item. Possible integer values
have the following meanings: 1 - REASON_POTENTIAL_OWNER |
BPC.BFM.ACTIVITY.WITRANSFER
BPC.BFM.ACTIVITY.WITRANSFER inherits the XML elements from BPC.BFM.ACTIVITY.BASE.
| XML element | Description |
|---|---|
| current | The user name of the current owner of the work item. This is the user whose work item has been transferred to someone else. |
| target | The user name of the new owner of the work item. |
| reason | The
reason for the assignment of the work item. Possible integer values
have the following meanings: 1 - REASON_POTENTIAL_OWNER |
BPC.BFM.BASE
BPC.BFM.BASE inherits the XML elements from WBIMonitoringEvent.
| XML element | Description |
|---|---|
| BPCEventCode | The Business Process Choreographer event code that identifies the event nature. |
| processTemplateName | The name of the process template. This name can differ from the display name. |
| processTemplateValidFrom | The valid from attribute of the process template. |
| eventProgressCounter | The event progress counter is used to indicate
the position of the current navigation step in the execution order
of all navigation steps of the same process instance. The event progress counter is required for long-running processes, and it can be used together with the event local counter to re-create the (possibly incomplete) order of the events belonging to the same process instance. In microflows, the event progress counter is set to zero. |
| eventLocalCounter | The local counter is used to discover the order of two events that occur in the same transaction. For a microflow instance, this counter reconstructs an order of all the emitted events. For long-running processes, the local counter indicates an order in the current navigation transaction. |
| processInstanceName | The process instance name, as provided by an API invocation, is only present if it is different from the process instance ID. |
| processInstanceId | The ID of the process instance. |
BPC.BFM.LINK.STATUS
BPC.BFM.LINK.STATUS inherits the XML elements from BPC.BFM.BASE.
| XML element | Description |
|---|---|
| elementName | The name of the link. |
| description | The description of the link. |
| flowBpelId | The ID of the flow activity where the link is defined. |
| sourceBpelId | The wpc:id attribute of the source activity corresponding to the navigated link. |
| targetBpelId | The wpc:id attribute of the target activity corresponding to the navigated link. |
| isForced | This specifies whether the event is triggered through the forceNavigate APIs (=true), or in any other way (=false). |
| processTemplateId | The ID of the process template. |
BPC.BFM.PROCESS.BASE
BPC.BFM.PROCESS.BASE inherits the XML elements from BPC.BFM.BASE.
| XML element | Description |
|---|---|
| processInstanceExecutionState | The current execution state of the process in
the following format: <state code>-<state
name>. This attribute can have one of the following values: 1 - STATE_READY |
| processTemplateId | The ID of the process template. |
| processInstanceDescription | The description of the process instance. |
| principal | The name of the user who is associated with this event. |
BPC.BFM.PROCESS.CORREL
BPC.BFM.PROCESS.CORREL inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| correlationSet | This is a hexBinary string. After converting
it to a string, it has the following format:
|
| action | Contains one of the following strings:
|
BPC.BFM.PROCESS.CUSTOMPROPERTYSET
BPC.BFM.PROCESS.CUSTOMPROPERTYSET inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| propertyName | The name of the custom property. |
| propertyValue | The value of the custom property. |
| ECSCurrentID | The associated process instance ID. |
| ECSParentID | The parent of the process instance. |
| associatedObjectID | The ID of the associated object that is the process instance ID. |
| associatedObjectName | The name of the associated object that is the process template name. |
| query | If isBinary is true, this element specifies the query string for the binary property. Otherwise, this element is not present. |
| type | If isBinary is true, this element specifies the type of the binary property. Otherwise, this element is not present. |
| isBinary | Set to false for string custom properties, and to true for binary custom properties. The payload type for binary custom properties is restricted to Empty. The property propertyValue is omitted for binary custom properties. |
BPC.BFM.PROCESS.ESCALATED
BPC.BFM.PROCESS.ESCALATED inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| escalationName | The name of the escalation. |
| operation | This is the operation that is associated with the event handler for which the inline invocation task is escalated. |
| portTypeName | The port type name of the operation that is associated with the event handler for which the inline invocation task is escalated. |
| portTypeNamespace | The port type namespace of the operation that is associated with the event handler for which the inline invocation task is escalated. |
BPC.BFM.PROCESS.EVENT
BPC.BFM.PROCESS.EVENT inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| message or message_BO- | The input message or the output message for
the service as a String or business object (BO) representation. The
format depends on whether the Monitor Compatible Events option
was selected on the Event Monitor tab in IBM Integration
Designer. This attribute is only used for Business Monitor 6.0.2 format events. For Business Monitor 6.1 format events, the content of the message is written to the applicationData section, which contains one content element with the name set to the name of the message. |
| operation | Name of the operation for the received event. |
| portTypeName | The port type name of the operation that is associated with the event handler. |
| portTypeNamespace | The port type namespace of the operation that is associated with the event handler. |
BPC.BFM.PROCESS.FAILURE
BPC.BFM.PROCESS.FAILURE inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| processFailedException | The exception message that lead to the failure of the process. |
| faultNamespace | The namespace URI of the fault. |
| faultName | The local part of the fault. |
BPC.BFM.PROCESS.MIGRATED
BPC.BFM.PROCESS.MIGRATED inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| migratedFromPTID | The ID of the process template that is being migrated from. |
| migratedFromValidFrom | The validFrom date for the process template that is being migrated from. |
| XML element | Description |
|---|---|
| activityInstanceID | The ID of the activity instance. |
| activityState | The current execution state of the activity in the following format: state_code-state_name |
| activitySubState | The current execution substate of the activity in the following format: substate_code-substate_name |
| activityStopReason | The stop reason code. The
stop reason code is only relevant if the activity is in the stopped
state. It indicates the reason why the activity stopped. This attribute
can have one of the following values:
1 - STOP_REASON_UNSPECIFIED |
| bpelId | The BPEL ID of the activity. |
| activityTemplateName | The name of the activity template. |
| activityTemplateId | The ID of the activity template. |
BPC.BFM.PROCESS.MIGRATIONTRIGGERED
BPC.BFM.PROCESS.MIGRATIONTRIGGERED inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| migrateToPTID | The ID of the process template to migrate to. |
| migrateToValidFrom | The validFrom date for the process template to migrate to. |
| XML element | Description |
|---|---|
| activityInstanceID | The ID of the activity instance. |
| activityState | The current execution state of the activity in the following format: state_code-state_name |
| activitySubState | The current execution substate of the activity in the following format: substate_code-substate_name |
| activityStopReason | The stop reason code. The
stop reason code is only relevant if the activity is in the stopped
state. It indicates the reason why the activity stopped. This attribute
can have one of the following values:
1 - STOP_REASON_UNSPECIFIED |
| bpelId | The BPEL ID of the activity. |
| activityTemplateName | The name of the activity template. |
| activityTemplateId | The ID of the activity template. |
BPC.BFM.PROCESS.OWNERTRANSFER
BPC.BFM.PROCESS.OWNERTRANSFER inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| current | The user name of the current owner of the process. This is the user whose process is transferred to someone else. |
| target | The user name of the new owner of the process. |
BPC.BFM.PROCESS.PARTNER
BPC.BFM.PROCESS.PARTNER inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| partnerLinkName | The name of the partner link. |
BPC.BFM.PROCESS.START
BPC.BFM.PROCESS.START inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| username | The name of the user who requested the start or restart of the process. |
BPC.BFM.PROCESS.STATUS
BPC.BFM.PROCESS.STATUS inherits the XML elements from BPC.BFM.PROCESS.BASE.
BPC.BFM.PROCESS.WISTATUS
BPC.BFM.PROCESS.WISTATUS inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| username | The names of the users with work items that were created or deleted. |
| reason | The
reason for the assignment of the work item. Possible integer values
have the following meanings: 1 - REASON_POTENTIAL_OWNER |
BPC.BFM.PROCESS.WITRANSFER
BPC.BFM.PROCESS.WITRANSFER inherits the XML elements from BPC.BFM.PROCESS.BASE.
| XML element | Description |
|---|---|
| current | The user name of the current owner of the work item. This is the user whose work item has been transferred to someone else. |
| target | The user name of the new owner of the work item. |
| reason | The
reason for the assignment of the work item. Possible integer values
have the following meanings: 1 - REASON_POTENTIAL_OWNER |
BPC.BFM.VARIABLE.STATUS
BPC.BFM.VARIABLE.STATUS inherits the XML elements from BPC.BFM.BASE.
| XML element | Description |
|---|---|
| variableName | The name of the variable. |
| variableData or variableData_BO | If the variable variableName is
not initialized, there is no variableData or VariableData_BO element.
The variable's data is represented either as a String or business
object (BO). The format depends on whether the Monitor
Compatible Events option was selected on the Event
Monitor tab in IBM Integration
Designer. This attribute is only used for Business Monitor 6.0.2 format events. For Business Monitor 6.1 format events, the content of the variable is written to the applicationData section, which contains one content element with the name set to the name of the variable. |
| bpelId | The Business Process Choreographer ID for the variable. |
| principal | The name of the user on whose behalf the current action is being performed. |
| processTemplateId | The ID of the process template. |