Error Start Event

Introduction

Catches named errors. This event is only used inside an event sub-process.

Properties

General

Attribute	Type	Description	Category
Model Id	Text	Model Id identifies the element within the process model.	The model id, name and documentation properties can be found on any element. They are used respectively to uniquely identify the start event, to give the start event a user-friendly name and to add a free-form description.
Name	Text	The name of the element. This is the name displayed in the diagram.
Documentation	Multiline Text	A free-form text that can be used to explain details about the particular element.
Error code	Text	The code of an error definition.	The error start event can only be used in an event subprocess. In that use case, the event subprocess will be started through this start event when an error with matching error code is thrown in the parent process instance. It is possible to map certain error information into a process variable by using the error mapping. As a source for the mapping there is the errorCode, error (the BPMN Error or the mapped Exception, this should be marked as transient) and errorMessage, in addition to those if an error has additional data it can be accessed by giving the name of that additional data parameter.
Error variable name	Text	Name of variable to contain the BPMN error code.
Error variable transient	Boolean	Whether to store the variable holding the error code as transient variable.
Error variable local scope	Boolean	Whether to store the variable holding the error code local to the current scope.
Error mapping	List	The mapping from the error attributes into the process instance

Advanced

Details

Attribute	Type	Description	Category
Interrupting	Boolean	If used in an event subprocess, determines whether parent executions will be terminated.

Listeners

Attribute	Type	Description	Category
Execution listeners	List	Allows invoking custom after certain lifecycle events. Start: Executes after the activity has been started. End: Executes after the activity was completed. Transition: When defined on a sequence flow, executes once the flow is transition is taken.	Execution listeners are used to add logic on certain lifecycle events. Typically it is used to add extra technical logic which shouldn't be visible in the BPMN process model.

Visual

Attribute	Type	Description	Category
Font size	Selection: 8 9 10 11 12 14 18 20 24 36 48 72	Font size.	Visual properties that determine how the start event is shown in the diagram. This has no impact on the runtime execution.
Font weight	Selection: Normal Bold	Select the style between bold and normal.
Border color	Color	The border color of the element in the diagram.
Font style	Selection: Normal Italic	Select the style between italic and normal.
Font color	Color	Select a font color.
Background color	Color	The background color of the element in the diagram.

List Attribute Details

Error mapping

Attribute	Type	Description
Source (Name / Expression)	Text with suggestions: Error code Error message BPMN Error	The name of the source property of an error that should be mapped to the target variable, or an expression.
Target variable	Text	The name of the variable into which the source or source expression is mapped.
Transient	Boolean	Flag indicating whether the target variable should be saved as a transient variable.

Execution listeners

Attribute	Type	Description
Event	Selection: Start End Take	The lifecycle event. The 'Take' event is only available for sequence flow.
Class	Text	Fully qualified classname of a class to be invoked when executing the task. The class must implement either JavaDelegate or ActivityBehavior.
Expression	Text	JUEL Expression to be executed when the task is started. Expressions allow you to interact with the backend by calling services, making calculations etc. You can find more information about expressions in the documentation.
Delegate expression	Text	Delegate Expression to be executed when the task is started. A delegate expression must resolve to a Java object, for instance a Spring bean. The object's class must implement either JavaDelegate or ActivityBehavior.
Fields	List

Fields

Attribute	Type	Description
Name	Text	The name of the element. This is the name displayed in the diagram.
String value	Text
Expression	Text	JUEL Expression to be executed when the task is started. Expressions allow you to interact with the backend by calling services, making calculations etc. You can find more information about expressions in the documentation.
String	Text