Common Base Events for BPEL processes

Common Base Events are emitted for BPEL processes if monitoring is requested for the BPEL process in IBM® Integration Designer. A list of all the events that can be emitted by a BPEL process can be found here. These events are also written to the audit log.

State transitions and process events

The following diagram shows the state transitions that can occur for a BPEL process and the events that are emitted when these state changes take place. The link between each state indicates the nature of the event and the event code of the event that is emitted for the state transitions.

Figure 1. State transitions and process events The diagram shows the states, the state transitions, and the events that are emitted for a long-running process instance during the process lifetime.

The diagram shows the states, the state transitions, and the events that are emitted for a long-running process instance during the process lifetime.

Process events

The columns in the following table contain:

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 BPCEventCode. 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.
Situation: Refers to the situation name of the BPEL process event.
Event nature: A pointer to the event situation for a BPEL process element in the EventNature parameter, as they are displayed in IBM Integration Designer.

Some process events are emitted without a state change. The following table describes all process events.

Table 1. Process events
Code	Event name and extension name	Situation	Event nature	Description
21000	PROCESS_STARTED BPC.BFM.PROCESS.START	Start	ENTRY	Process started
21001	PROCESS_SUSPENDED BPC.BFM.PROCESS.STATUS	Report	SUSPENDED	Process suspended. To suspend process instances, use Business Process Choreographer Explorer.
21002	PROCESS_RESUMED BPC.BFM.PROCESS.STATUS	Report	RESUMED	Process resumed. Only suspended processes can be resumed. To resume process instances, use Business Process Choreographer Explorer.
21004	PROCESS_COMPLETED BPC.BFM.PROCESS.STATUS	Stop	EXIT	Process completed
21005	PROCESS_TERMINATED BPC.BFM.PROCESS.STATUS	Stop	TERMINATED	Process terminated. To terminate process instances, use Business Process Choreographer Explorer.
21019	PROCESS_RESTARTED BPC.BFM.PROCESS.START	Report	RESTARTED	Process restarted. A process is restarted on request, for example, by using Business Process Choreographer Explorer.
21020	PROCESS_DELETED BPC.BFM.PROCESS.STATUS	Destroy	DELETED	Process deleted
42001	PROCESS_FAILED BPC.BFM.PROCESS. FAILURE	Fail	FAILED	Process failed
42003	PROCESS_COMPENSATING BPC.BFM.PROCESS.STATUS	Report	COMPENSATING	Process compensating. Only child processes can be compensated. The compensation of a child process is triggered by a fault handler or compensation handler associated with the parent process.
42004	PROCESS_COMPENSATED BPC.BFM.PROCESS.STATUS	Stop	COMPENSATED	Process compensated
42006	PROCESS_INSTALLED	Report	INSTALLED	These are process instance events, which are only emitted in the audit trail. They are not emitted as common base events, and are included here for completeness.
42007	PROCESS_UNINSTALLED	Report	UNINSTALLED	These are process instance events, which are only emitted in the audit trail. They are not emitted as common base events, and are included here for completeness.
42009	PROCESS_TERMINATING BPC.BFM.PROCESS.STATUS	Report	TERMINATING	Process terminating
42010	PROCESS_FAILING BPC.BFM.PROCESS.STATUS	Report	FAILING	Process failing
42027	PROCESS_CORRELATION_ SET_INITIALIZED BPC.BFM.PROCESS.CORREL	Report	CORRELATION	This event is emitted when a new correlation set for the process instance is initialized, for example, when a receive activity with an initiating correlation set receives a message. This event is not associated with a state change.
42041	PROCESS_WORKITEM_ DELETED BPC.BFM.PROCESS. WISTATUS	Report	WI_DELETED	Process work item deleted. This event is emitted only when a work item is explicitly deleted by an API request. If the work item is deleted because the corresponding process instance is deleted, an event is not emitted. This event is not associated with a state change.
42042	PROCESS_WORKITEM_ CREATED BPC.BFM.PROCESS. WISTATUS	Report	WI_CREATED	Process work item created. This event is emitted when an additional work item is created for the process, for example, by an API request. This event is not associated with a state change.
42046	PROCESS_COMPENSATION_FAILED BPC.BFM.PROCESS.STATUS	Fail	COMPFAILED	Process compensation failed
42047	PROCESS_EVENT_RECEIVED BPC.BFM.PROCESS.EVENT	Report	EV_RECEIVED	Process event received. The event is emitted when an event handler that is associated with a process is activated. This event is not associated with a state change.
42049	PROCESS_EVENT_ESCALATED BPC.BFM.PROCESS.ESCALATED	Report	EV_ESCALATED	Process event escalated. This event is emitted when an inline invocation task is escalated that is associated with an onEvent event handler for the process. This event is not associated with a state change.
42056	PROCESS_WORKITEM_ TRANSFERRED BPC.BFM.PROCESS. WITRANSFER	Report	WI_ TRANSFERRED	Process work item transferred. This event is not associated with a state change.
42058	PROCESS_PARTNER_CHANGED BPC.BFM.PROCESS.PARTNER	Report	PA_CHANGE	Process partner changed. This event is emitted when a new endpoint reference is assigned to a partner link. This event is not associated with a state change.
42059	PROCESS_CUSTOMPROPERTY_SET BPC.BFM.PROCESS. CUSTOMPROPERTYSET	Report	CP_SET	Process custom property set. This event is emitted when a custom property of a process instance is changed. This event is not associated with a state change.
42071	PROCESS_OWNER_TRANSFERRED BPC.BFM.PROCESS.OWNERTRANSFER	Report	OWNER_ TRANSFERRED	This event is emitted when the ownership of a process is transferred from one user to another. This event is not associated with a state change.
42077	PROCESS_CORRELATION_SET_SET BPC.BFM.PROCESS.CORREL	Report	CORRELATION	This event is emitted when the value of a correlation set for the process instance is set. This event is not associated with a state change.
42078	PROCESS_CORRELATION_SET_UNSET BPC.BFM.PROCESS.CORREL	Report	CORRELATION	This event is emitted when the value of a correlation set for the process instance is deleted or unset. This event is not associated with a state change.
42079	PROCESS_MIGRATED BPC.BFM.PROCESS.MIGRATED	Report	MIGRATED	This event is emitted when a process is migrated to use a new template. This event is not associated with a state change.
42080	PROCESS_MIGRATION_TRIGGERED BPC.BFM.PROCESS. MIGRATIONTRIGGERED	Report	MIGRATION_ TRIGGERED	This event is emitted when the migration of process instances to use a new template is started. This event is not associated with a state change.

For process events, the following event correlation sphere identifiers have the following content:

The ECSCurrentID provides the ID of the process instance.
The ECSParentID provides the value of the ECSCurrentID before the process instance start event of the current process.