User Interface

EccProcess

EccProcess describes a business case: a running or finished process instance, a saved draft or a process definition.

A process instance, a saved process draft or a process definition. Which fields are filled depends on the source: process lists are read from the MongoDB projection ‘eccprocessinstances’, single instances are additionally enriched with live data from the BPM engine, drafts come from ‘ecc_saved’ (state SAVED, processInstanceId prefixed ‘tmp.’) and process definitions only carry processId, processName and version.

TypeScript

 import type { EccProcess } from "@/ecc/types/taskTypes";

Fields

Field

Type

Description

`_id`	string	Technical MongoDB document id. Not a business identifier - do not use it to address objects. Example: `66fa6b1e9c2d4a0012ab34cd`
`eccType`	string	Object type, e.g. process, task, history, processhistory, processnode, event. Example: `process`
`eccClassname`	string	Java class name of the object. Example: `EccProcess`
`processInstanceId`	string	Unique id of the process instance. The only identifier used for instances in the API. Saved drafts use the prefix 'tmp.'. Example: `8c3e5f0a-1b2c-4d3e-9f4a-5b6c7d8e9f01`
`processId`	string	Id of the process definition (name of the BPMN process), used to start new instances. Example: `purchase`
`rootProcessId`	string	processId of the root process. Null for root processes. Example: `purchase`
`rootProcessInstanceId`	string	processInstanceId of the root process. Null for root processes.
`parentProcessInstanceId`	string	processInstanceId of the calling process. Null for root processes.
`parentProcessInstance`	EccProcess	Calling process (sub-processes only). Only processInstanceId, processId, processName and state are filled.
`childProcessInstances`	EccProcess	Sub-processes started by this instance. Only processInstanceId, processId, processName and state are filled.
`nodes`	list of EccProcessNode	Nodes the instance has passed or is currently in (live data from the BPM engine).
`error`	EccProcessError	Error information if the instance is in error state.
`processName`	string	Name of the process as defined in the BPMN model. Example: `purchase`
`businessKey`	string	Human-readable business key generated at process start from the configured pattern (eccatm.keyindex). Example: `PR260930-3f9a1c2b`
`version`	string	Version of the process definition. Example: `1.0`
`slaDueDate`	date-time	Due date of the process, if an SLA is defined in the model.
`createdBy`	EccUserRef	User who saved the draft (saved drafts only).
`updatedBy`	string	Last user who changed the instance (live data from the BPM engine).
`lastUpdate`	date-time	Time of the last change.
`start`	date-time	Start time of the instance.
`end`	date-time	End time of the instance, if completed or aborted.
`serviceUrl`	string	Service URL reported by the BPM engine.
`endpoint`	string	REST endpoint of the process in the BPM engine. Example: `http://localhost:8888/purchase`
`state`	string	State of the instance: PENDING, ACTIVE, COMPLETED, ABORTED, SUSPENDED, ERROR. Saved drafts have the state SAVED. Example: `ACTIVE`
`variables`	object	Business data of the process. Structure depends on the process model, e.g. { "purchase": { ... } }.
`source`	string	BPMN source of the process definition (schema endpoints only).
`info`	string	Free-text note stored with a saved draft. Example: `Waiting for the second quote`
`processInstanceDescription`	string	Process Instance Description from the BPM engine's process definition (as shown in its admin console).
`eccSync`	boolean	Result of the consistency check between the MongoDB projection and the live BPM engine data: `true`: in sync, `false`: diverged, not set: not checked (only set by GET /api/v1/process/{processInstanceId}).
`diagram`	string	SVG diagram of the process instance (only when requested explicitly).
`eccVersion`	string
`eccUiPage`	string	Name of the process instance page in the frontend: src/apps/{eccUiDirectory}/{eccUiPage}.tsx (read-only) Example: `PurchaseInstance`
`eccUiDirectory`	string	App folder of the process in the frontend: src/apps/{eccUiDirectory}/ (read-only) Example: `purchase`
`stateActive`	boolean	true if state is ACTIVE. (read-only)
`statePending`	boolean	true if state is PENDING. (read-only)
`stateCompleted`	boolean	true if state is COMPLETED. (read-only)
`stateAborted`	boolean	true if state is ABORTED. (read-only)
`stateSuspended`	boolean	true if state is SUSPENDED. (read-only)
`stateFailed`	boolean	true if state is FAILED. (read-only)
`overdue`	boolean	true if slaDueDate is in the past. (read-only)

Fields without a value are left out of the JSON.

TypeScript type

The frontend type EccProcess follows this structure. Only in the TypeScript type (set by the frontend or kept for older data): templateDescription, processStarterPage, inputs, data, taskCount. Delivered by the API but not declared in the TypeScript type: _id, rootProcessId, parentProcessInstanceId, parentProcessInstance, error, slaDueDate, updatedBy, end, serviceUrl, source, diagram, stateActive, statePending, stateCompleted, stateAborted, stateSuspended, stateFailed, overdue.

Where it is used

Page

Context

List process instances or drafts	API Reference
Get a process instance	API Reference
Save a process draft	API Reference
Start a process	API Reference
Delete a saved draft	API Reference
List process definitions	API Reference
Get related objects of a process instance	API Reference
EccProcessInstance	Developer Guide
ProcessDetail	Developer Guide
EccProcessDiagram	Developer Guide
EccPageFooter	Developer Guide
EccProcessTemplate	Developer Guide
EccSavedProcesses	Developer Guide
SavedProcessDetail	Developer Guide
Process Instance Page	Developer Guide
Start Form	Developer Guide
Process Lifecycle 🔒	System Handbook
Process Instance Projection 🔒	System Handbook
EccProcessError	object used in a field of EccProcess
EccProcessNode	object used in a field of EccProcess
EccUserRef	object used in a field of EccProcess
EccTask	contains EccProcess in `rootProcessInstance`

Sections

EccProcess

Fields

TypeScript type

Where it is used

On this page