Skip to main content

Error Boundary Event

Introduction

Catches a named error, which is thrown by an inner scope (for example, a sub-process). This event must be attached to the boundary of an activity.

Properties

General

AttributeTypeDescriptionCategory
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 identity the boundary event, to give it a user-friendly name and to add a free-form description.

Name Expression usage possibleText

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.

When an error event is thrown and the error code matches, this boundary event will trigger if the activity it is attached to is active.

An error boundary event is always interrupting, which means it will always cancel the activity it is attached to.

If no error code is provided, any BPMN error will be caught by this boundary event.

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

Visual

AttributeTypeDescriptionCategory
Font size Selection:
  • 8
  • 9
  • 10
  • 11
  • 12
  • 14
  • 18
  • 20
  • 24
  • 36
  • 48
  • 72

Font size.

Visual properties that determine how the boundary 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 RequiredColor

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 RequiredColor

The background color of the element in the diagram.

List Attribute Details

Error mapping

AttributeTypeDescription
Source (Name / Expression) RequiredText 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 RequiredExpression usage possibleText

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.