EccProcessHistoryEntry
EccProcessHistoryEntry is one entry of the history of a case, as returned by the history endpoint. In the API Reference and in the business service the object is called EccProcessHistory; the frontend type is EccProcessHistoryEntry. (Not to be confused with the EccProcessHistory widget, which shows these entries.)
One immutable event of the process history, written by the BPMN service extension and read from ‘eccprocesshistory’.
import type { EccProcessHistoryEntry } from "@/ecc/types/taskTypes";
Fields
| string | Technical MongoDB document id. Not a business identifier - do not use it to address objects. Example: |
| string | Object type, e.g. process, task, history, processhistory, processnode, event. Example: |
| string | Java class name of the object. Example: |
| string | Unique id of the event (also the MongoDB _id). |
| string | Event type: PROCESSSTARTED, PROCESSCOMPLETED, PROCESSABORTED, PROCESSERROR, ACTIVITYSTARTED, ACTIVITYCOMPLETED, USERTASKSTATE, USERTASKASSIGNMENT, USERTASKVARIABLE, USERTASKCOMMENT, USERTASKATTACHMENT, USERTASKDEADLINE, CUSTOM. Example: |
| string | History level used for this event: FULL (with variable snapshot) or MINIMAL. Example: |
| string | Engine that produced the event. Example: |
| string | processId of the instance the event belongs to. |
| string | processInstanceId of the instance the event belongs to. |
| string | processInstanceId of the root process. |
| string | processInstanceId of the calling process. |
| string | processId of the root process. |
| string | Process name. |
| string | Version of the process definition. |
| string | State of the instance after the event. |
| string | Business key of the instance. Example: |
| integer | Version of the history document structure. Example: |
| integer | Sequence number of the transfer outbox, ascending over all processes of the service. Tie-breaker for events with the same timestamp; not contiguous within one case. Example: |
| date-time | Time the step happened in the engine (start of the instance, entry or exit of the node, task change). Primary sort key. |
| string | Name of the node or user task. |
| string | BPMN type of the node, e.g. userTask, scriptTask, exclusiveGateway, callActivity. Example: |
| Acting user. Missing for system events. | |
| string | Process Instance Description of the process model, evaluated for this instance at the time of the event. Example: |
| integer | Time between entering and leaving the node in milliseconds; set when node.enteredAt and node.leftAt are both present (ACTIVITY_COMPLETED). |
| string | Suggested icon key (format=ui only), e.g. processstarted, custom, userTask-started, userTask-claim, userTask-ready, userTask-usertask_state, exclusiveGateway-split, callActivity-completed. Example: |
| User task summary (format=ui only). | |
| object | Snapshot of all process variables (level FULL). Without include=data removed for user task entries and entries without workItem. |
| object | Custom entry written from the process model: { type, message, data }. data only with include=data. |
| object | What changed, e.g. { action: claim, from: Ready, to: Reserved }. |
| object | Full user task state after the change for USERTASK* events. Once the task has an owner, actualOwnerUserId (subject) and actualOwnerDisplayName are added. inputs only with include=data. |
| object | Node details: id, name, bpmnType, engineType, nodeInstanceId, enteredAt, leftAt. |
| object | Work item details: id, name, input, output. Business data in input only with include=data. |
| string |
Fields without a value are left out of the JSON.
Where it is used
API Reference | |
Developer Guide | |
Developer Guide | |
System Handbook | |
System Handbook | |
object used in a field of EccProcessHistory | |
object used in a field of EccProcessHistory |
On this page
- EccProcessHistoryEntry