Workflow History Task
Calls the History worker using the specified parameters.
As well as the standard ID, Name, Description and Variable elements, the history task includes the various properties needed by the History worker. See the History Service documentation for further information.
When a process instance is started by a form submission, the Workflow - Start Action controls whether or not a history is written. If a history record is written, leaving the label a-e values blank in the history task will write history events to the history of the current instance. Providing new label a-e values will create a new history.
| Property | Description |
|---|---|
| ID | An optional unique ID for this element. The modeller will assign a random ID if left blank |
| Name | A name for this element |
| Description | An optional description for this element |
| Asynchronous | When execution reaches a task that has been marked as asynchronous the engine will commit the current transaction and schedule a background job to continue the process from the asynchronous task |
| Event | A packet of event data in a JSON object. You can use ${...} expressions to access the values of process variables |
| Subject | A packet of subject data in a JSON object. You can use ${...} expressions to access the values of process variables. If writing to a history that already exists, this property is ignored |
| Label A | The labela value. Leave blank to write to the history created when this instance started. You can use ${...} expressions to access the values of process variables |
| Label B | As above |
| Label C | As above |
| Label D | As above |
| Label E | As above |
| Datasource | Leave blank to write to the iCM database |
| Return Variable | The process variable that any return from the activity will be stored in |
| Transient Return Variable? | If enabled, the result will be stored as a transient process variable instead of a persistent one. Transient variables are not saved to the database or process history, and are only visible until the process reaches its next wait state |
| Error Variable | The process variable that any error will be stored in |
| Error Handling | Should an error occur will it be ignored, follow the transition specified on the advanced tab (ie the ID of a sequence flow from the current activity), or throw a BPMN error which could be caught by a boundary error event |
Last modified on 30 September 2026
