Extension names for BPEL process events

IBM BPM, V8.0.1, All platforms > Measuring and improving business processes > Monitoring > Event catalog > Business Process Choreographer events > BPEL process events overview
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.
The following extension names are available for BPEL process events:

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.BASE

BPC.BFM.LINK

BPC.BFM.LINK.STATUS

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.VARIABLE.STATUS

BPC.BFM.ACTIVITY.BASE

BPC.BFM.ACTIVITY.BASE inherits the XML elements from BPC.BFM.BASE.

XML elements for BPC.BFM.ACTIVITY.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
21 - KIND_INVOKE
23 - KIND_RECEIVE
24 - KIND_REPLY
25 - KIND_THROW
26 - KIND_TERMINATE
27 - KIND_WAIT
29 - KIND_COMPENSATE
30 - KIND_SEQUENCE
32 - KIND_SWITCH
34 - KIND_WHILE
36 - KIND_PICK
38 - KIND_FLOW
40 - KIND_SCOPE
42 - KIND_SCRIPT
43 - KIND_STAFF
44 - KIND_ASSIGN
45 - KIND_CUSTOM
46 - KIND_RETHROW
47 - KIND_FOR_EACH_SERIAL
49 - KIND_FOR_EACH_PARALLEL
52 - KIND_REPEAT_UNTIL
1000 - SQLSnippet
1001 - RetrieveSet
1002 - InvokeInformationService
1003 - AtomicSQLSnippetSequence
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
2 - STATE_READY
3 - STATE_RUNNING
4 - STATE_SKIPPED
5 - STATE_FINISHED
6 - STATE_FAILED
7 - STATE_TERMINATED
8 - STATE_CLAIMED
11 - STATE_WAITING
12 - STATE_EXPIRED
13 - STATE_STOPPED For scope activities, this attribute can have one of the following values:
1 - STATE_READY
2 - STATE_RUNNING
3 - STATE_FINISHED
4 - STATE_COMPENSATING
5 - STATE_FAILED
6 - STATE_TERMINATED
7 - STATE_COMPENSATED
8 - STATE_COMPENSATION_FAILED
9 - STATE_FAILING
10 - STATE_SKIPPED
11 - STATE_COMPENSATION_FAILING
12 - STATE_FAULTHANDLER_FAILING
13 - STATE_FINISHING
14 - STATE_STOPPED
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 elements for BPC.BFM.ACTIVITY.CHILD_PROCESS_TERMINATING
XML element Description
subState The substate of the activity. The substate can be one of the following strings:
SUB_STATE_NONE
SUB_STATE_EXPIRING
SUB_STATE_SKIPPING
SUB_STATE_RESTARTING
SUB_STATE_FINISHING
SUB_STATE_FAILING
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 elements for BPC.BFM.ACTIVITY.CLAIM
XML element Description
username The name of the user for whom the task has been claimed.

BPC.BFM.ACTIVITY.CONDITION

BPC.BFM.ACTIVITY.CONDITION inherits the XML elements from BPC.BFM.ACTIVITY.BASE.

XML elements for 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 elements for BPC.BFM.ACTIVITY.CUSTOMPROPERTYSET
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 elements for BPC.BFM.ACTIVITY.ESCALATED
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 elements for BPC.BFM.ACTIVITY.EVENT
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 elements for BPC.BFM.ACTIVITY.FAILURE
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 elements for BPC.BFM.ACTIVITY.FOREACH
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 elements for BPC.BFM.ACTIVITY.JUMPED
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 elements for BPC.BFM.ACTIVITY.MESSAGE
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 elements for BPC.BFM.ACTIVITY.SKIP_REQUESTED
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 elements for BPC.BFM.ACTIVITY.STATUS
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
2 - STOP_REASON_ACTIVATION_FAILED
3 - STOP_REASON_IMPLEMENTATION_FAILED
4 - STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED
5 - STOP_REASON_EXIT_CONDITION_FALSE

A payload is available for the event nature FRETRIED for activities that provide payload for the ENTRY event nature, and similarly for the event nature FCOMPLETED corresponding to the EXIT event nature:

FRETRIED and ENTRY for the element kinds invoke and staff (see CREATED).
FCOMPLETED and EXIT for the element kinds: pick, receive, and reply.
The payload is provided in the application data section of the event, but only for event version 6.1.

BPC.BFM.ACTIVITY.TIMER_RESCHEDULED

BPC.BFM.ACTIVITY.TIMER_RESCHEDULED inherits the XML elements from BPC.BFM.ACTIVITY.BASE.

XML elements for BPC.BFM.ACTIVITY.TIMER_RESCHEDULED
XML element Description
timestamp The date and time are expressed in Coordinated Universal Time (UTC), in the format yyyy-MM-dd[T hh: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 elements for BPC.BFM.ACTIVITY.WISTATUS
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
2 - REASON_EDITOR
3 - REASON_READER
4 - REASON_OWNER
5 - REASON_POTENTIAL_STARTER
6 - REASON_STARTER
7 - REASON_ADMINISTRATOR
9 - REASON_ORIGINATOR
10 - REASON_ESCALATION_RECEIVER
11 - REASON_POTENTIAL_INSTANCE_CREATOR

BPC.BFM.ACTIVITY.WITRANSFER

BPC.BFM.ACTIVITY.WITRANSFER inherits the XML elements from BPC.BFM.ACTIVITY.BASE.

XML elements for BPC.BFM.ACTIVITY.WITRANSFER
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
2 - REASON_EDITOR
3 - REASON_READER
4 - REASON_OWNER
5 - REASON_POTENTIAL_STARTER
6 - REASON_STARTER
7 - REASON_ADMINISTRATOR
9 - REASON_ORIGINATOR
10 - REASON_ESCALATION_RECEIVER
11 - REASON_POTENTIAL_INSTANCE_CREATOR

BPC.BFM.BASE

BPC.BFM.BASE inherits the XML elements from WBIMonitoringEvent.

XML elements for BPC.BFM.BASE
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 elements for BPC.BFM.LINK.STATUS
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 elements for BPC.BFM.PROCESS.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
2 - STATE_RUNNING
3 - STATE_FINISHED
4 - STATE_COMPENSATING
5 - STATE_FAILED
6 - STATE_TERMINATED
7 - STATE_COMPENSATED
8 - STATE_TERMINATING
9 - STATE_FAILING
11 - STATE_SUSPENDED
12 - STATE_COMPENSATION_FAILED
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 elements for BPC.BFM.PROCESS.CORREL
XML element Description
correlationSet
This is a hexBinary string. After converting it to a string, it has the following format:
<?xml version="1.0"?>
<correlationSet name=” correlation_set_name”>
  <property name=” property_name” 
            value=” property_value”/>*
</correlationSet>
action Contains one of the following strings:

init

This indicates that the correlation set property correlationSet was initialized.

set

This indicates that the value of the correlation set property correlationSet was set using the API.

unset

This indicates that the correlation set property correlationSet was deleted or unset using the API, causing the property to contain no value.
BPC.BFM.PROCESS.CUSTOMPROPERTYSET

BPC.BFM.PROCESS.CUSTOMPROPERTYSET inherits the XML elements from BPC.BFM.PROCESS.BASE.

XML elements for BPC.BFM.PROCESS.CUSTOMPROPERTYSET
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 elements for BPC.BFM.PROCESS.ESCALATED
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 elements for BPC.BFM.PROCESS.EVENT
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 elements for BPC.BFM.PROCESS.FAILURE
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 elements for BPC.BFM.PROCESS.MIGRATED
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.

After the migration, information about the activity instances within the process is provided in a business object (BO) in the application data section of the event. The business object is defined by in the INSTALL_ROOT/ProcessChoreographer/client/BFMEvent_Data_V7.xsd file. On Windows platforms, it is in INSTALL_ROOT\ProcessChoreographer\client\BFMEvent_Data_V7.xsd. The business object contains the following information for each activity that has been migrated.

XML elements for the business object after migration
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
2 - STOP_REASON_ACTIVATION_FAILED
3 - STOP_REASON_IMPLEMENTATION_FAILED
4 - STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED
5 - STOP_REASON_EXIT_CONDITION_FALSE

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 elements for BPC.BFM.PROCESS.MIGRATIONTRIGGERED
XML element Description
migrateToPTID The ID of the process template to migrate to.
migrateToValidFrom The validFrom date for the process template to migrate to.

Before the migration, information about the activity instances within the process is provided in a business object (BO) in the application data section of the event. The business object is defined in the INSTALL_ROOT/ProcessChoreographer/client/BFMEvent_Data_V7.xsd file. On Windows platforms, it is in INSTALL_ROOT\ProcessChoreographer\client\BFMEvent_Data_V7.xsd. The business object contains the following information for each activity that will be migrated.

XML elements for the business object that is to be migrated
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
2 - STOP_REASON_ACTIVATION_FAILED
3 - STOP_REASON_IMPLEMENTATION_FAILED
4 - STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED
5 - STOP_REASON_EXIT_CONDITION_FALSE

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 elements for BPC.BFM.PROCESS.OWNERTRANSFER
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 elements for BPC.BFM.PROCESS.PARTNER
XML element Description
partnerLinkName The name of the partner link.

The endpoint reference for a BPC.BFM.PROCESS.PARTNER event is only written to the application data section of the event for version 6.1 events. The payload is the Web Services Business Process Execution Language (WS-BPEL) ServiceRefType wrapper element that contains the Web Services Addressing (WS-Addressing) EndpointReferenceType element. The ServiceRefType artifact (schema) must be available in the context of the application, which is the case in typical scenarios. However, if you dynamically assign an endpoint from one statically defined partner link to another, the schema is not available, and the endpoint reference is not included.

BPC.BFM.PROCESS.START

BPC.BFM.PROCESS.START inherits the XML elements from BPC.BFM.PROCESS.BASE.

XML elements for BPC.BFM.PROCESS.START
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 elements for BPC.BFM.PROCESS.WISTATUS
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
2 - REASON_EDITOR
3 - REASON_READER
4 - REASON_OWNER
5 - REASON_POTENTIAL_STARTER
6 - REASON_STARTER
7 - REASON_ADMINISTRATOR
9 - REASON_ORIGINATOR
10 - REASON_ESCALATION_RECEIVER
11 - REASON_POTENTIAL_INSTANCE_CREATOR

BPC.BFM.PROCESS.WITRANSFER

BPC.BFM.PROCESS.WITRANSFER inherits the XML elements from BPC.BFM.PROCESS.BASE.

XML elements for BPC.BFM.PROCESS.WITRANSFER
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
2 - REASON_EDITOR
3 - REASON_READER
4 - REASON_OWNER
5 - REASON_POTENTIAL_STARTER
6 - REASON_STARTER
7 - REASON_ADMINISTRATOR
9 - REASON_ORIGINATOR
10 - REASON_ESCALATION_RECEIVER
11 - REASON_POTENTIAL_INSTANCE_CREATOR

BPC.BFM.VARIABLE.STATUS

BPC.BFM.VARIABLE.STATUS inherits the XML elements from BPC.BFM.BASE.

XML elements for BPC.BFM.VARIABLE.STATUS
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.

BPEL process events overview

Related reference:
Business process events
Common Base Events for BPEL processes
Common Base Events for activities
Common Base Events for scope activities
Common Base Events for links in flow activities
Common Base Events for process variables

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 21 - KIND_INVOKE 23 - KIND_RECEIVE 24 - KIND_REPLY 25 - KIND_THROW 26 - KIND_TERMINATE 27 - KIND_WAIT 29 - KIND_COMPENSATE 30 - KIND_SEQUENCE 32 - KIND_SWITCH 34 - KIND_WHILE 36 - KIND_PICK 38 - KIND_FLOW 40 - KIND_SCOPE 42 - KIND_SCRIPT 43 - KIND_STAFF 44 - KIND_ASSIGN 45 - KIND_CUSTOM 46 - KIND_RETHROW 47 - KIND_FOR_EACH_SERIAL 49 - KIND_FOR_EACH_PARALLEL 52 - KIND_REPEAT_UNTIL 1000 - SQLSnippet 1001 - RetrieveSet 1002 - InvokeInformationService 1003 - AtomicSQLSnippetSequence
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 2 - STATE_READY 3 - STATE_RUNNING 4 - STATE_SKIPPED 5 - STATE_FINISHED 6 - STATE_FAILED 7 - STATE_TERMINATED 8 - STATE_CLAIMED 11 - STATE_WAITING 12 - STATE_EXPIRED 13 - STATE_STOPPED For scope activities, this attribute can have one of the following values: 1 - STATE_READY 2 - STATE_RUNNING 3 - STATE_FINISHED 4 - STATE_COMPENSATING 5 - STATE_FAILED 6 - STATE_TERMINATED 7 - STATE_COMPENSATED 8 - STATE_COMPENSATION_FAILED 9 - STATE_FAILING 10 - STATE_SKIPPED 11 - STATE_COMPENSATION_FAILING 12 - STATE_FAULTHANDLER_FAILING 13 - STATE_FINISHING 14 - STATE_STOPPED
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.

XML element	Description
subState	The substate of the activity. The substate can be one of the following strings: SUB_STATE_NONE SUB_STATE_EXPIRING SUB_STATE_SKIPPING SUB_STATE_RESTARTING SUB_STATE_FINISHING SUB_STATE_FAILING
childProcessInstanceID	The ProcessInstanceID of the child process.

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).

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.

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.

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.

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 2 - REASON_EDITOR 3 - REASON_READER 4 - REASON_OWNER 5 - REASON_POTENTIAL_STARTER 6 - REASON_STARTER 7 - REASON_ADMINISTRATOR 9 - REASON_ORIGINATOR 10 - REASON_ESCALATION_RECEIVER 11 - REASON_POTENTIAL_INSTANCE_CREATOR

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 2 - REASON_EDITOR 3 - REASON_READER 4 - REASON_OWNER 5 - REASON_POTENTIAL_STARTER 6 - REASON_STARTER 7 - REASON_ADMINISTRATOR 9 - REASON_ORIGINATOR 10 - REASON_ESCALATION_RECEIVER 11 - REASON_POTENTIAL_INSTANCE_CREATOR

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.

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.

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 2 - STATE_RUNNING 3 - STATE_FINISHED 4 - STATE_COMPENSATING 5 - STATE_FAILED 6 - STATE_TERMINATED 7 - STATE_COMPENSATED 8 - STATE_TERMINATING 9 - STATE_FAILING 11 - STATE_SUSPENDED 12 - STATE_COMPENSATION_FAILED
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.

XML element	Description
correlationSet	This is a hexBinary string. After converting it to a string, it has the following format: <?xml version="1.0"?> <correlationSet name=” correlation_set_name”> <property name=” property_name” value=” property_value”/>* </correlationSet>
action	Contains one of the following strings: init This indicates that the correlation set property correlationSet was initialized. set This indicates that the value of the correlation set property correlationSet was set using the API. unset This indicates that the correlation set property correlationSet was deleted or unset using the API, causing the property to contain no value.

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.

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.

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 2 - STOP_REASON_ACTIVATION_FAILED 3 - STOP_REASON_IMPLEMENTATION_FAILED 4 - STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED 5 - STOP_REASON_EXIT_CONDITION_FALSE
bpelId	The BPEL ID of the activity.
activityTemplateName	The name of the activity template.
activityTemplateId	The ID of the activity template.

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
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 2 - REASON_EDITOR 3 - REASON_READER 4 - REASON_OWNER 5 - REASON_POTENTIAL_STARTER 6 - REASON_STARTER 7 - REASON_ADMINISTRATOR 9 - REASON_ORIGINATOR 10 - REASON_ESCALATION_RECEIVER 11 - REASON_POTENTIAL_INSTANCE_CREATOR

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.