The Common Base Event specification events that are emitted
by BPM when integrating with IBM®
WebSphere® Business Monitor is a standard XML-based
format for business events, system events, and performance information.
The BPM common base event adapter for WebSphere Business
Monitor converts
BPM events to the standard format required by WebSphere Business
Monitor,
and then transmits the events through 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
Table 1. Common Base Event specification header
information Common Base Event specification Attribute |
Description |
Workflow BPM Attribute |
version |
|
Set to 1.0.1 |
creationTime |
The time at which the event is created. |
F_TimeStamp (UTC 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)
Common Base Event specification Attribute |
Description |
Workflow 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 Common Base Event specification events.
Common Base Event specification Attribute |
Description |
Workflow 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 |
|
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.
Common Base Event specification Attribute |
Description |
Workflow 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 to whom the work item is assigned |
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 because the workflow system generates multiple 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 when 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 Common Base Event specification events. The fields
are stored in an extended data element named businessData.
The user can access the user-defined fields through XPath expressions
when building a monitor model in MME.