Business process events

Business process events are sent if monitoring is requested for the business process elements in WebSphere Integration Developer. A list of all the events that can be emitted by business processes can be found here.

The following types of events can be caused by business process:

XML syntax

The payloads for business process events have the following syntax:
Read syntax diagramSkip visual syntax diagram
>>-BPC.BFM.BASE--BPCEventCode--processTemplateName--processTemplateValidFrom--+-| BPC.BFM.PROCESS.BASE |----+-><
                                                                              +-| BPC.BFM.ACTIVITY.BASE |---+   
                                                                              +-| BPC.BFM.LINK.STATUS |-----+   
                                                                              '-| BPC.BFM.VARIABLE.STATUS |-'   

Where:
BPCEventCode
The Business Process Choreographer event code that identifies the number of the event type. Possible event codes are listed in the following tables.
processTemplateName
The name of the process template.
processTemplateValidFrom
The valid from attribute of the process template.

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

Key to table columns

The columns in the following tables contain:
Code
Contains the number of the event. This value is provided as the BPCEventCode extended data element for all BPC.BFM.BASE elements.
Extension name
Contains the string value that is used as the value of the extensionName attribute of the Common Base Event. This is also the name of the XML extended data element provide additional data about the event.

If WebSphere Business Integration Modeler is used to generate the Business Process Execution Language (BPEL) and the monitoring specification, the extension name can be extended by a hash character (#) followed by additional characters. Also, events that emit message data contain additional extendedDataElements. Refer to the documentation for WebSphere Business Integration Modeler for more information.

Situation
Refers to the situation name of the business process event. For details of situations, see Situations in business process 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.

Process events

The following table describes all process events.

Code Description Extension name Situation Event nature
21000 Process started BPC.BFM.PROCESS.START Start ENTRY
21001 Process suspended BPC.BFM.PROCESS.STATUS Report SUSPENDED
21002 Process resumed BPC.BFM.PROCESS.STATUS Report RESUMED
21004 Process completed BPC.BFM.PROCESS.STATUS Stop EXIT
21005 Process terminated BPC.BFM.PROCESS.STATUS Stop TERMINATED
21019 Process restarted BPC.BFM.PROCESS.START Report RESTARTED
21020 Process deleted BPC.BFM.PROCESS.STATUS Destroy DELETED
42001 Process failed BPC.BFM.PROCESS.FAILURE Fail FAILED
42003 Process compensating BPC.BFM.PROCESS.STATUS Report COMPENSATING
42004 Process compensated BPC.BFM.PROCESS.STATUS Stop COMPENSATED
42009 Process terminating BPC.BFM.PROCESS.STATUS Report TERMINATING
42010 Process failing BPC.BFM.PROCESS.STATUS Report FAILING
42027 Correlation set initialized BPC.BFM.PROCESS.CORREL Report CORRELATION
42041 Process work item deleted BPC.BFM.PROCESS.WISTATUS Report WI_DELETED
42042 Process work item created BPC.BFM.PROCESS.WISTATUS Report WI_CREATED
42046 Process compensation failed BPC.BFM.PROCESS.STATUS Fail COMPFAILED
42047 Process event received BPC.BFM.PROCESS.STATUS Report EV_RECEIVED
42049 Process event escalated BPC.BFM.PROCESS.ESCALATED Report EV_ESCALATED
42056 Process work item transferred BPC.BFM.PROCESS.WITRANSFER Report WI_TRANSFERRED
The payloads for process events have the following syntax:
Read syntax diagramSkip visual syntax diagram
BPC.BFM.PROCESS.BASE

>>-BPC.BFM.PROCESS.BASE--processInstanceExecutionState--| BPC.BFM.PROCESS.STATUS |-><

BPC.BFM.PROCESS.STATUS

|--BPC.BFM.PROCESS.STATUS--processTemplateId--processInstanceDescription--+-------------------------------------------------+--|
                                                                          +-BPC.BFM.PROCESS.CORREL--correlationSet----------+   
                                                                          +-BPC.BFM.PROCESS.ESCALATED--escalationName-------+   
                                                                          +-BPC.BFM.PROCESS.FAILURE--processFailedException-+   
                                                                          +-BPC.BFM.PROCESS.START--username-----------------+   
                                                                          |                           .----------.          |   
                                                                          |                           V          |          |   
                                                                          +-BPC.BFM.PROCESS.WISTATUS----username-+----------+   
                                                                          '-BPC.BFM.PROCESS.WITRANSFER--current--target-----'   

Where:
processInstanceExecutionState
The current execution state of the process in the following format: <state code>-<state name>
processTemplateId
The ID of the process template.
processInstanceDescription
The description of the process instance.
correlationSet
The correlation set instance, in the following format:
<?xml version="1.0"?>
<correlationSet name=”correlation set name”>
  <property name=”property name” 
            value=”property value”/>*
</correlationSet>
escalationName
The name of the escalation.
processFailedException
The exception message that lead to the failure of the process.
username
For BPC.BFM.PROCESS.START this is the name of the user who requested the start or restart of the process. For BPC.BFM.PROCESS.WISTATUS this is a list of users whose work item was created or deleted.
current
The user name of the current owner of the work item. This is the user whose work item has been transferred away.
target
The user name of the new owner of the work item.
For process events, the following event correlation sphere identifiers are also written to the Common Base Event as context data elements:
  • 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.

Activity events

The following table describes all activity events.

Code Description Extension name Situation Event nature
21006 Activity ready BPC.BFM.ACTIVITY.STATUS Start CREATED
21007 Activity started For invoke activities: BPC.BFM.ACTIVITY.MESSAGE. For all other activity types: BPC.BFM.ACTIVITY.STATUS Start ENTRY
21011 Activity completed For invoke, staff, receive, and reply activities: BPC.BFM.ACTIVITY.MESSAGE. For all other activity types: BPC.BFM.ACTIVITY.STATUS Stop EXIT
21021 Claim canceled BPC.BFM.ACTIVITY.STATUS Report DEASSIGNED
21022 Activity claimed BPC.BFM.ACTIVITY.CLAIM Report ASSIGNED
21027 Activity terminated BPC.BFM.ACTIVITY.STATUS Stop TERMINATED
21080 Activity failed BPC.BFM.ACTIVITY.FAILURE Failed FAILED
21081 Activity expired BPC.BFM.ACTIVITY.STATUS Report EXPIRED
42005 Activity skipped BPC.BFM.ACTIVITY.STATUS Report SKIPPED
42012 Activity output message set BPC.BFM.ACTIVITY.MESSAGE Report OUTPUTSET
42013 Activity fault message set BPC.BFM.ACTIVITY.MESSAGE Report FAULTSET
42015 Activity stopped BPC.BFM.ACTIVITY.STATUS Stop STOPPED
42031 Activity force retried BPC.BFM.ACTIVITY.STATUS Report FRETRIED
42032 Activity force completed BPC.BFM.ACTIVITY.STATUS Stop FCOMPLETED
42036 Activity has message received BPC.BFM.ACTIVITY.MESSAGE Report EXIT
42037 Loop condition true BPC.BFM.ACTIVITY.STATUS Report CONDTRUE
42038 Loop condition false BPC.BFM.ACTIVITY.STATUS Report CONDFALSE
42039 Work item deleted BPC.BFM.ACTIVITY.WISTATUS Report WI_DELETED
42040 Work items created BPC.BFM.ACTIVITY.WISTATUS Report WI_CREATED
42050 Activity escalated BPC.BFM.ACTIVITY.ESCALATED Report ESCALATED
42054 Activity work items refreshed BPC.BFM.ACTIVITY.WISTATUS Report WI_REFRESHED
42055 Work item transferred BPC.BFM.ACTIVITY.WITRANSFER Report WI_TRANSFERRED
42057 For each - activity branches started BPC.BFM.ACTIVITY.FOREACH Report BRANCHES_STARTED
The payloads for activity events have the following syntax:
Read syntax diagramSkip visual syntax diagram
BPC.BFM.ACTIVITY.BASE

>>-BPC.BFM.ACTIVITY.BASE--activityKind--state--bpelId--| BPC.BFM.ACTIVITY.STATUS |-><

BPC.BFM.ACTIVITY.STATUS

|--BPC.BFM.ACTIVITY.STATUS--+----------------------+--activityTemplateId--+-----------------------------+--+---------------------------------------------------+--|
                            '-activityTemplateName-'                      '-activityInstanceDescription-'  +-BPC.BFM.ACTIVITY.CLAIM--username--principal-------+   
                                                                                                           +-BPC.BFM.ACTIVITY.ESCALATED--escalationName--------+   
                                                                                                           +-BPC.BFM.ACTIVITY.FAILURE--activityFailedException-+   
                                                                                                           +-BPC.BFM.ACTIVITY.FOREACH--parallelBranchesStarted-+   
                                                                                                           |                           .----------------.      |   
                                                                                                           |                           V                |      |   
                                                                                                           +-BPC.BFM.ACTIVITY.MESSAGE----+-message----+-+------+   
                                                                                                           |                             '-message_BO-'        |   
                                                                                                           |                            .----------.           |   
                                                                                                           |                            V          |           |   
                                                                                                           +-BPC.BFM.ACTIVITY.WISTATUS----username-+-----------+   
                                                                                                           '-BPC.BFM.ACTIVITY.WITRANSFER--current--target------'   

Where:
activityKind
The activity kind, for example, sequence or invoke. The format is: <kind code>-<kind name>
state
The current state of the activity instance in the format: <state code>-<state name>
bpelId
The wpc:id attribute of the activity in the BPEL file. It is unique for activities inside a process model.
activityTemplateName
The name of the activity template.
activityTemplateId
The internal ID of the activity template.
activityInstanceDescription
The description of the activity instance.
username
For BPC.BFM.ACTIVITY.CLAIM this is the user for whom the task has been claimed. For BPC.BFM.ACTIVITY.WISTATUS this is a list users who are associated with the work item.
principal
The name of the user who has claimed the activity.
escalationName
The name of the escalation.
activityFailedException
The exception that caused the activity to fail.
parallelBranchesStarted
The number of branches started.
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 WebSphere Integration Developer.
current
The user name of the current owner of the work item. This is the user whose work item has been transferred away.
target
The user name of the new owner of the work item.
For activity events, the following event correlation sphere identifiers are also written to the Common Base Event as context data elements:
  • The ECSCurrentID provides the ID of the activity.
  • The ECSParentID provides the ID of the containing process.

Activity scope events

The following table describes all activity scope events.

Code Description Extension name Situation Event nature
42020 Scope started BPC.BFM.ACTIVITY.STATUS Start ENTRY
42021 Scope skipped BPC.BFM.ACTIVITY.STATUS Report SKIPPED
42022 Scope failed BPC.BFM.ACTIVITY.FAILURE Fail FAILED
42023 Scope terminating BPC.BFM.ACTIVITY.STATUS Report FAILING
42024 Scope terminated BPC.BFM.ACTIVITY.STATUS Stop TERMINATED
42026 Scope completed BPC.BFM.ACTIVITY.STATUS Stop EXIT
42043 Scope compensating BPC.BFM.ACTIVITY.STATUS Report COMPENSATING
42044 Scope compensated BPC.BFM.ACTIVITY.STATUS Stop COMPENSATED
42045 Scope compensation failed BPC.BFM.ACTIVITY.STATUS Fail COMPFAILED
42048 Scope event received BPC.BFM.ACTIVITY.STATUS Report EV_RECEIVED
42051 Scope event escalated BPC.BFM.ACTIVITY.ESCALATED Report EV_ESCALATED

Activity scope events are a type of activity events, whose syntax is described above for BPC.BFM.ACTIVITY.STATUS.

For activity scope events, the following event correlation sphere identifiers are also written to the Common Base Event as context data elements:
  • The ECSCurrentID provides the ID of the scope.
  • The ECSParentID provides the ID of the containing process.

Link events

The following table describes all link events.

Code Description Extension name Situation Event nature
21034 Link evaluated true BPC.BFM.LINK.STATUS Report CONDTRUE
42000 Link evaluated false BPC.BFM.LINK.STATUS Report CONDFALSE
The payloads for link events have the following syntax:
Read syntax diagramSkip visual syntax diagram
BPC.BFM.LINK.STATUS

>>-BPC.BFM.LINK.STATUS--+-------------+--+-------------+--flowBpelId-><
                        '-elementName-'  '-description-'               

Where:
elementName
The name of the link.
description
The description of the link.
flowBpelId
The ID of the flow activity where the link is defined.
For link events, the following event correlation sphere identifiers are also written to the Common Base Event as context data elements:
  • The ECSCurrentID provides the ID of the source activity of the link.
  • The ECSParentID provides the ID of the containing process.

Variable events

The following table describes the variable events.

Code Description Extension name Situation Event nature
21090 Variable update BPC.BFM.VARIABLE.STATUS Report CHANGED
The payloads for variable events have the following syntax:
Read syntax diagramSkip visual syntax diagram
BPC.BFM.VARIABLE.STATUS

>>-BPC.BFM.VARIABLE.STATUS--variableName--+-----------------+--bpelId-><
                                          +-variableData----+           
                                          '-variableData_BO-'           

Where:
variableName
The name of the variable.
variableData or variableData_BO
If the variable variableName has not been intialized, there is no variableData or VariableData_BO element. The variable's data contents either 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 WebSphere Integration Developer.
bpelId
The Business Process Choreographer ID for the variable.
For the variable event, the following event correlation sphere identifiers are written to the Common Base Event as context data elements:
  • The ECSCurrentID provides the ID of the containing scope or process.
  • The ECSParentID is the ECSCurrentID before the process instance start event of the current process.

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