Intermediate Event Registry Catch

Introduction

Catches an event registry event within a process.

The intermediate event registry catch event can be used with an input and output sequence flow. The process flow will stop until the appropriate event is received. This event creates a subscription, which will then be triggered by next event received by the event registry. It is possible to specify a correlation parameter to filter for the event.

note

This event is also available as a task.

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 intermediate catching event, to give it 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	MarkdownMinimal	A free-form text that can be used to explain details about the particular element.
Enable persisting content items	Boolean	If set to true, content items will be automatically created for incoming events.
Persisted content item name	Text	This property can be used to override the default naming convention for persisted content items.
Content item variable name	Text	Optional. The name of a process or case variable that will hold the content item created from the incoming email (the email itself, not its attachments or folder). Leave empty to create the content item without storing a variable. Supports a static name or an expression.
Store as transient variable	Boolean	When enabled, the content item variable is transient: it is available only for the duration of the triggering transaction (for example to a start form or expression) and is not persisted. When left unchecked, the variable is stored as a persistent variable that survives the transaction. Only applies when a content item variable name is set.
Content item list variable name	Text	Optional. The name of a process or case variable holding a list of the content items created from inbound events. On the first event the list is created with that content item; on each subsequent event the new content item is appended to the end. Always stored as a persistent variable. Leave empty to skip the list.
Inbound event	inboundeventconfiguration	A reference to an event model.	This intermediate event will wait until an event is received, which can be configured here. The data of the incoming event can be mapped into the process instance as variables in the 'payload mapping'.
Inbound channel	Reference	Configures the channel on which the event is received	Configure the channel on which the event will be received.

Advanced

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 intermediate 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

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