Format of activity time series
An activity time series for a BPMN activity is a JSON object
with attributes.
In the following table, the processId, processVersionId, processName, processInstanceId, and shortProcessInstanceId attributes refer to a top-level process, a subprocess, or a linked process, depending on the execution flow context. The startingProcessInstanceId attribute always refers to the top-level process in the BPMN execution flow context. The activityId, activityRefId, activityVersionId, and activityName attributes refer to a top-level process, a subprocess, or a linked process, depending on the execution flow context.
| Attribute | Description | Optional or required | Type |
|---|---|---|---|
| id | The identifier of the time series event. It matches the id attribute of the corresponding raw event. | Required | String |
| offset | The Kafka message offset | Required | Number |
| partition | The Kafka message partition | Required | Number |
| version | The document version of the time series event | Required | A string constant in V.R.M format |
| type | The type of the event | Required | String - Typical values: “ACTIVITY_READY” “ACTIVITY_RESOURCE_ASSIGNED” “ACTIVITY_ACTIVE” “ACTIVITY_COMPLETED” “ACTIVITY_FAILED” “ACTIVITY_TERMINATED” “ACTIVITY_LOOP_CONDITION_TRUE” “ACTIVITY_LOOP_CONDITION_FALSE” “ACTIVITY_PARALLEL_INSTANCES_STARTED” “TASK_SUBJECT_CHANGED” “TASK_FIELD_CHANGED” “TASK_STATUS_CHANGED” |
| timestamp | The timestamp of the corresponding raw event | Required | A string containing an ISO8601 date in this format: yyyy-mm-ddThh:mm:ss.nnn+|-hh:mm |
| bpmSystemId | The BPM system identifier that uniquely identifies a Process Server or Workflow Server environment | Required | String |
| bpmCellName | The name of the BPM cell that emits raw events | Required | String |
| processId | The process identifier | Required | String |
| processName | The name of the process | Required | String |
| processVersionId | The process snapshot identifier | Required | String |
| processSnapshotName | The name of the process snapshot. Present if the name of the snapshot is not the current (TIP) snapshot | Optional | String |
| processApplicationId | The identifier of the process application | Required | String |
| processApplicationName | The name of the process application | Required | String |
| processApplicationSnapshotName | The name of the process application snapshot. Present if the name of the snapshot is not the current (TIP) snapshot | Optional | String |
| processApplicationVersionId | The process application identifier | Required | String |
| processInstanceId | The unique identifier of the process instance, which results from the concatenation of the value of the processId attribute, the value of the bpmSystemId attribute, and the process instance identifier that is assigned by the BPM runtime. The values are separated by dots. | Required | String |
| shortProcessInstanceId | The non-fully qualified process instance identifier that corresponds to the process instance identifier assigned by the BPM runtime. | Required | String |
| startingProcessInstanceId | The unique top-level process identifier. It results from the concatenation of the value of the processId attribute, the value of the bpmSystemId attribute, and the process instance identifier that is assigned by the BPM runtime. The values are separated by dots. | Required | String |
| sequenceId | The corresponding raw event sequence identifier | Required | Number |
| createdHighResolutionTimestamp | The high resolution timestamp of the corresponding raw event. | Required | Number |
| activityInstanceId | The identifier of the activity instance | Required | String |
| activityName | The name of the tracking activity | Required | String |
| activityVersionId | The activity snapshot identifier | Required | String |
| activityType | The type of activity that was chosen at design time, such as userTask for human performers or scriptTask for automated tasks | Required | String |
| startedParallelLoops | The number of started loops in parallel for an activity | Optional | Number |
| taskInstanceId | The identifier of the task instance. Present if the enable-task-api-def option is set in IBM® Business Automation Workflow. | Optional | String |
| taskRecord | Additional information about the current task. Present if option task-record-enabled is set to true in the IBM Business Automation Workflow configuration. | Optional | String |
| trackingGroupId | The identifier of the tracking group that contains the tracked fields. Present if options enable-task-api-def and task-record-enabled are set in the IBM Business Automation Workflow configuration | Optional | JSON object |
| performerId | The identifier of the performer of the task. Present if the task has been claimed. | Optional | String |
| performerName | The name of the user who claimed the task to work on. Present if the task has been claimed. | Optional | String |
| potentialPerformerId | The identifier of the potential performer of the task. Present if the activity refers to an activity that can be claimed. | Optional | String |
| potentialPerformerName | The name of the user, or group of users, who can claim the task. Present if the activity refers to an activity that can be claimed. | Optional | String |
| potentialPerformerDocumentation | The task documentation to the intention of the performer of the task | Optional | String |
| trackingPointId | The identifier of the tracking point. Present if tracking information is available and held by the raw event type. | Optional | String |
| trackingPointName | The name of the tracking point. Present if tracking information is available and held by the raw event type. | Optional | String |
| trackingPointVersionId | The identifier of the tracking point snapshot. Present if tracking information is available and held by the raw event type. | Optional | String |
| trackingGroupId | The identifier of the tracking group. Present if tracking information is available and held by the raw event type. | Optional | String |
| trackingGroupName | The name of the tracking group. Present if tracking information is available and held by the raw event type. | Optional | String |
| trackingGroupVersionId | The identifier of the tracking group snapshot. Present if tracking information is available and held by the raw event type. | Optional | String |
| trackingGroupOccurrenceTime | The timestamp indicating the instant when the tracking data was retrieved. Present if tracking information is available and held by the raw event type. | Optional | A string that contains an ISO8601 date in this format: yyyy-mm-ddThh:mm:ss.nnn+|-hh:mm |
| trackedFields | The associated tracked fields. Present if tracking information is available and held by the raw event type. | Optional | JSON object |
| trace-id | The identifier of the trace. Required if the trace-id and span-id values are set in the raw event context. | Conditionally required | String |
| span-id | The identifier of the span. Required if the trace-id and span-id values are set in the raw event context. | Conditionally required | String |
| parent-span-id | The identifier of the parent span. | Optional | String |
| assignerId | The identifier of the user who reassigned the task. If the task was claimed, the assignerId is the same value as the performerId. If the assignment was done by the server, the default system admin id will appear here. | Optional | String |
| assignerName | The name of the user who reassigned the task. If the task was claimed, the assignerName is the same value as the performerName. If the assignment was done by the server, the default system admin name will appear here. | Optional | String |
Example of activity time series attributes
{
"id": "K21189a7b7a319361792162189",
"offset": 61258,
"partition": 0,
"version": "0.1.0",
"type": "ACTIVITY_RESOURCE_ASSIGNED",
"timestamp": "2018-05-24T03:18:39.098-05:00",
"bpmSystemId": "7cf5b53b-6c76-487c-93e5-25361b46d01d",
"bpmCellName": "bpmCell01",
"processId": "aba2ab57-97b0-4ff4-be70-08cb69dc03ca",
"processName: "Tracking process",
"processVersionId": "2064.b265633f-17b0-4204-adf5-4973c81959be",
"processApplicationId": "629954f3-3be8-4f9b-ae78-10d8e58392c0",
"processApplicationSnapshotName": "",
"processApplicationVersionId": "2064.b265633f-17b0-4204-adf5-4973c81959be",
"processApplicationName": "Tracking 2",
"processInstanceId": "aba2ab57-97b0-4ff4-be70-08cb69dc03ca.7cf5b53b-6c76-487c-93e5-25361b46d01d.1310",
"shortProcessInstanceId": "1310",
"sequenceId": 6,
"createdHighResolutionTimestamp": 56152534230
"activityInstanceId": "aba2ab57-97b0-4ff4-be70-08cb69dc03ca.7cf5b53b-6c76-487c-93e5-25361b46d01d.1310.6",
"taskInstanceId": "1406",
"taskRecord": {
"displayName": "Step: Tracking 2 Task",
"status": "Received",
"dueDate": "2018-05-24T04:18:39.082-05:00",
"atRiskTime": "2018-05-24T04:16:00.376-05:00",
"priority": "Normal"
},
"activityName": "Tracking 2 Task",
"activityVersionId": "2064.b265633f-17b0-4204-adf5-4973c81959be",
"activityId": "baeac3f1-addd-4ca3-894f-4274b57983fb",
"activityType": "userTask",
"trackingPointId": "a01d120b01961632259c988-7fdebaeac3f1-addd-4ca3-894f-4274b57983fb",
"trackingPointName": "Tracking 2 Task",
"trackingPointVersionId": "2064.b265633f-17b0-4204-adf5-4973c81959be",
"trackingGroupId": "guid:3e146413a740a01d:120b0196:1632259c988:-7fde",
"trackingGroupName": "at1525719944578",
"trackingGroupVersionId": "2064.b265633f-17b0-4204-adf5-4973c81959be",
"trackingPointOccurrenceTime": "2018-05-24T03:18:39.098-05:00"
"trace-id": "e6412e20-815c-4cc2-bc59-b22efcd7447a",
"span-id": "2929e1eb3bcbf3b2"
}