BPM CBE Events

This topic describes the Common Base Event (CBE) events that will be emitted by BPM when integrating with WebSphere Business Monitor.

The CBE specification is a standard XML-based format for business events, system events, and performance information. The BPM CBE Adaptor for WebSphere Business Monitor converts BPM events to the standard format required by WebSphere Business Monitor, and then transmits the events via the Common Event Infrastructure (CEI) to the WebSphere Business Monitor server.

Header information (predefined data)

The following table lists the data that is present on each event

CBE Attribute

Description

Process Engine BPM Attribute

version

 

Set to 1.0.1

creationTime

The time at which the event is created – UTC timestamp.

F_TimeStamp

extensionName

Set to the BPM event name.

F_EventType (in text format)

sequenceNumber

 

F_SeqNumber (monotonically increasing but not sequential)

Correlation data (property data)

CBE Attribute

Description

Process Engine BPM Attribute

processId

Set to process instance id

F_WorkFlowNumber

workItemId

Set to work item instance id

F_WobNum

parentId

Set to instance id of parent work item.

F_ParentWobNum

Common extended data

The following extended data is common to all BPM CBE events.

CBE Attribute

Description

Process Engine BPM Attribute

processName

Process definition name

Derived from F_WorkClassId

processVersion

Process version

F_WCRevision

processStartTime

Process start time

F_StartTime

logName

Event log view name

 

isolatedRegion

Isolated region

 

username

User that executed the action.

F_UserId

businessData

Set of user defined fields

 

Events

Process Events

Event

Description

P8.BPM.Process.Start

Event is emitted when the process starts.

P8.BPM.Process.End

Event is emitted when the process ends.

 

Work Item Events

Event

Description

P8.BPM.WorkItem.Start

Event is emitted when a work item starts.

P8.BPM.WorkItem.End

Event is emitted when a work item ends.

 

Activity Events

The following extended data is common to all activity events.

CBE Attribute

Description

Process Engine BPM Attribute

activityId

Activity id.

<F_InstrSheetId>+<F_WorkOrderId>

map

Map (same as scope) name

Derived from F_InstrSheetId

activity

Step name

Derived from F_WorkOrderId

queue

Queue used by this activity

Derived from F_WPClassId

operation

Operation in the queue used by this activity

Derived from F_OperationId

boundUser

User the work item is assigned to.

F_BoundUserId

enqueueTime

Time the work item was placed in the current queue.

F_EnqueueTime

 

Event

Description

P8.BPM.Activity.Start

Event is emitted when an activity starts.

In the case of activity reassignment or delegation, multiple P8.BPM.Activity.Start events can be emitted for the same activity.  This is as designed and is necessary since Process Engine will generate multiple 352 events for this case.  Monitor models must be able to handle multiple P8.BPM.Activity.Start events.

P8.BPM.WorkItem.End

Event is emitted when a work item ends.

P8.BPM.Activity.Locked Event is emitted when an activity is locked for processing.
P8.BPM.Activity.Unlocked Event is emitted with an activity is unlocked.
P8.BPM.Activity.Failure Event is emitted when an activity fails.

User-Defined Fields

In BPM, fields can be exposed to an event log to capture the values of user defined fields within a process.  These user defined fields are included in all of the BPM CBE events. The fields are stored in an extended data element named businessData.  The user can access the user defined fields via XPath expressions when building a monitor model in MME.