User Interface

EccTask

EccTask describes a user task of a case - what a user has to do, who may do it and with which data.

A user task of a process instance, as delivered by the BPM engine.

TypeScript

 import type { EccTask } 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`
`id`	string	Unique id of the task instance. Example: `5f1c2a7e-8d34-4b8e-9a61-0c2f4e7b9d10`
`description`	string	Task description from the BPMN model.
`name`	string	Task name from the BPMN model. Also used to find the task page in the frontend. Example: `Approve Request Level 1`
`priority`	string	Task priority.
`state`	string	Lifecycle state: Ready, Reserved, InProgress, Completed, Skipped, Obsolete, Error. Example: `Ready`
`icon`	string	Suggested icon key, derived from state (processObject=tasks only), e.g. userTask-ready, userTask-reserved. Example: `userTask-ready`
`started`	date-time	Creation time of the task.
`completed`	date-time	Completion time.
`lastUpdate`	date-time	Time of the last change.
`slaDueDate`	date-time	Due date, if defined.
`referenceName`	string	Reference name of the task node in the BPMN model.
`externalReferenceId`	string	External reference id, if set by the engine.
`endpoint`	string	REST endpoint of the task in the BPM engine.
`nodeInstanceId`	string	nodeInstanceId of the userTask node this task belongs to (from the BPM engine's process history).
`comment`	string	Comment/subject configured for the task node in the BPMN model (from workItem.input, not the userTask object). Example: `Approve request level 1 - subject`
`content`	string	Content/body configured for the task node in the BPMN model (from workItem.input, not the userTask object).
`groupId`	string	Group id the task was created for (from workItem.input, not the userTask object). Example: `app-purchase-approvalLevel1`
`actualOwner`	string	preferredUsername of the user who claimed the task. Null if not claimed. Example: `max.keller@example.org`
`actualOwnerUserId`	string	Stable userId (subject) of actualOwner, looked up in the 'user' collection by preferredUsername. Null until claimed or if the user has no master record yet.
`actualOwnerDisplayName`	string	"Lastname, Firstname" of actualOwner, looked up the same way as actualOwnerUserId. Example: `Keller, Max`
`adminGroups`	list of string	Groups with admin rights on the task.
`adminUsers`	list of string	Users with admin rights on the task.
`excludedUsers`	list of string	Users who must not see or work on the task (e.g. four-eyes principle).
`potentialGroups`	list of string	Groups allowed to claim the task.
`potentialUsers`	list of string	Users allowed to claim the task.
`potentialUserIds`	list of string	Stable userIds (subject), one per entry in potentialUsers, looked up in the 'user' collection by preferredUsername. Null entries where no master record exists yet.
`potentialUserDisplayNames`	list of string	"Lastname, Firstname", one per entry in potentialUsers, looked up the same way as potentialUserIds.
`processId`	string	processId of the process the task belongs to. Example: `purchaseRelease`
`processInstanceId`	string	processInstanceId of the process the task belongs to.
`rootProcessId`	string	processId of the root process. Example: `purchase`
`rootProcessInstanceId`	string	processInstanceId of the root process.
`rootProcessInstance`	EccProcess	Root process instance (GET /api/v1/task only).
`inputs`	object	Task input data. Structure depends on the process model. GET /api/v1/task/{taskId} returns it as JSON object; list endpoints may return it as JSON string.
`outputs`	object	Task output data. Structure depends on the process model. Same format rules as inputs.
`metadata`	object	Engine metadata such as ProcessType, Lifecycle, skippable, NodeInstanceId.
`userTask`	object	Full raw userTask snapshot from the latest USERTASKSTATE/USERTASKASSIGNMENT event in 'eccprocesshistory' (processObject=tasks only) — everything the typed fields above already surface, plus anything not individually mapped.
`eccUiPage`	string	Name of the task page in the frontend, derived from the task name (read-only).
`eccUiDirectory`	string	Folder of the task page in the frontend, derived from the task name (read-only).

Fields without a value are left out of the JSON.

TypeScript type

The frontend type EccTask follows this structure. Delivered by the API but not declared in the TypeScript type: _id, potentialUserIds, potentialUserDisplayNames.

Where it is used

Page

Context

List tasks of the current user	API Reference
Get a task	API Reference
Execute a task action	API Reference
Get related objects of a process instance	API Reference
EccTasks	Developer Guide
EccTasksDetail	Developer Guide
EccProcessTasks	Developer Guide
Task Page	Developer Guide
Task Detail Renderer	Developer Guide
Task Handling 🔒	System Handbook
EccProcess	object used in a field of EccTask

Sections

EccTask

Fields

TypeScript type

Where it is used

On this page