Format of process time series

Edit online
Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
Process time series for BPMN processes are timeSeries JSON objects with attributes, as described in the table.
In the following table, the processId, processVersionId, processName, processInstanceId, and shortProcessInstanceId attributes can 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.
Table 1. Attributes for process time series
Attribute Description Optional or required Type
id The identifier of the timeSeries event. This identifier 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 timeSeries event Required A string constant in V.R.M format
type The type of the event Required String - Typical values:
  • "PROCESS_STARTED"
  • "PROCESS_COMPLETED"
  • "PROCESS_TERMINATED"
  • "PROCESS_SUSPENDED"
  • "PROCESS_DELETED"
  • "PROCESS_RESUMED"
  • "PROCESS_AT_RISK_DATE_ASSIGNED"
  • "PROCESS_FAILED"
  • "PROCESS_MIGRATED"
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. It can refer to a top-level process, a subprocess, or a linked process. Required String
processName The process name Required String
processVersionId The process snapshot identifier Required String
processSnapshotName The process snapshot name. Empty for the current (TIP) snapshot Required String
processApplicationId The process application identifier Required String
processApplicationSnapshotName The process application snapshot name. Empty for the current (TIP) snapshot Required String
processApplicationVersionId The identifier of the process application snapshot Required String
processApplicationName The process application name 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
processState The process state Required String - Possible values: "Active" or "Completed"
trace-id The trace identifier Required if the trace-id and span-id values are set in the raw event context. String
span-id The span identifier Required if the trace-id and span-id values are set in the raw event context. String
parent-span-id The identifier of the parent span Optional String
atRiskDate The date that was set for the process to be considered at risk Optional A string containing an ISO8601 date in this format: yyyy-mm-ddThh:mm:ss.nnn+|-hh:mm
dueDate The due date of the process Optional A string containing an ISO8601 date in this format: yyyy-mm-ddThh:mm:ss.nnn+|-hh:mm
performerName The name of the user who started the process. Optional String
performerId The identifier of the user who started the process. Optional String

Example of process time series attributes

{
             "id": "I21182bb87a319361792162189",
             "offset": 61253,
             "partition": 0,
             "version": "1.0.0",
             "type": "PROCESS_STARTED",
             "timestamp": "2018-05-24T03:18:38.379-05:00",
             "bpmSystemId": "7cf5b53b-6c76-487c-93e5-25361b46d01d",
             "bpmCellName": "bpmCell01",
             "processId": "aba2ab57-97b0-4ff4-be70-08cb69dc03ca",
             "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": 1,
             "createdHighResolutionTimestamp": 56152534230
             "processName": "Process 2-1",
             "processSnapshotName": "",
             "processState": "Active",
             "trace-id": "1b944420-1143-46a4-b30f-d6a269db3a4c",
             "span-id": "bf5a-a20892c20275"
}