Signal Event Listener

Introduction

A signal can be used to communicate within a case instances and the children, or to broadcast events throughout all cases and processes. This signal event listener simply waits for a signal to be triggered.

For all use-cases it is also possible to use the Event Listener which allows to specify a payload for the event.

danger

When you would like to receive messages and also provide additional content, the Event Listener might be the better option.

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 identity the event listener, 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	Multiline Text	The documentation attribute additionally adds a description to the component.
Inbound event	inboundeventconfiguration	A reference to an event model.	Create or link an event model that defines the structure of the event that is received through an inbound channel. An event model reference can be unlinked to allow another event model to be linked in its place. Note that unlinking an event model does not delete the model itself.
Inbound channel	Reference	Configures the channel on which the event is received	Create or link a channel model, which is a model that defines how an event is received (for example through an external messaging system) and processed before being passed to the case instance. A channel model reference can be unlinked to allow another channel model to be linked in its place. Note that unlinking a channel model does not delete the model itself.
Signal reference	Text	The signal name to listen to.	Signals are a mechanism from BPMN process models and are used to introduce synchronisation between instances: signal events will be thrown at runtime which then can be caught by one or more wait states that are configured to received a particular signal event. Likewise, a case instance can wait to receive a signal event, allowing for process to case instance(s) synchronisations.

Control

Attribute	Type	Description	Category
Required	Boolean	Select this option to mark the element as required (exclamation mark decorator). Required plan items must be either in the status COMPLETED, TERMINATED, or DISABLED in order for their parent stage to complete.	Check this option to mark this event listener as required, which means that it needs to be in a terminal state in order for its parent to complete. Note that event listeners, unlike plan items don't get a visual indication when they're required. Required plan items must be in a terminal state (such as completed or terminated) in order for their parent stage to complete.
Completion neutral	Boolean	Completion neutral influences the plan item's parent stage completes. Plan items in the state AVAILABLE may prevent the parent stage (or case) from automatically completing. By checking this property, the plan item will behave neutral with respect to the completion of the parent container.	Completion neutral influences the plan item's parent stage completion. Normally, plan item instances in the state available may prevent the parent stage (or case) from automatically completing. By checking this property, the plan item will behave neutral with respect to the completion of the parent container (i.e. it will not stop the completion).
Manual activation name	Text	Define the name to be used for the manual activation trigger.
Manual activation icon	Icon	Define the icon to be used for the manual activation trigger.
Manual activation priority	Integer	The priority for the Manual activation action
Manual activation permission groups	Group Selection	Define the groups which have access to the manual activation trigger.
Manual activation permission users	User Selection	Define the users which have access to the manual activation trigger.
Manual activation channels	Text	Define a list of channels to expose the manual activation action.
Start form	Reference	An optional form shown when the event listener is manually activated.
In same deployment	Boolean	Set it to true if the referenced definition should be referenced from within the same app deployment. Set it to false to always use the newest definition.
Validate start form fields (server-side)	Boolean	If the start form is submitted and validate form fields expression evaluates to true, form fields are validated on the BE side according to the form model restrictions.

Repetition

Attribute	Type	Description	Category
Repetition	Boolean	Select this option to mark the element as repeatable (fencemark decorator). Repeatable plan items may exist more than once at run-time, each having their own life-cycle.	An event listener can be repeatable, in which case multiple instances will be created, resulting effecively in multiple receivers for events. The repetition can be an expression, and new instances are created as long as the expression resolves to true. This can be limited using the Max instance count. The Repetition counter variable is a local variable with a value incremented by one for each new plan item instance created. Alternatively, a Collection variable can be passed which leads to a plan item instance per element in the collection. The element can be captured in a variable using the Element variable and its index in the collection in the Element index variable.
Repetition counter variable	Text	Name of the repetition counter variable.
Don't create repetition counter variable	Boolean	Enable this flag to prevent the creation of the repetition counter variable. When a variable aggregation is defined, this flag will be ignored and a repetition counter variable will be created.
Max instance count	Selection: unlimited one	Defines the maximum number of instances for repetition. Note that this does not mean there can be only one instance ever in the lifetime of a case instance, this will limit the instances each time when the repetition is evaluated (for example when an entry sentry evaluates to true to re-enter a stage or plan item).
Collection variable	Text	Variable to be used as the collection for the repetition.
Element variable	Text	Variable that will be used to store the current item value for the repetition.
Element index variable	Text	Variable that will be used to store the current index value for the repetition.
Variable Aggregations	List		When using repetition, there is often a need to create an aggregation of the variables created and/or updated in each instance. With variable aggregation, a JSON variable can be created that after all instances have been completed contains the summary of all the used variables. This is needed because for repetition, variables are persisted locally, to avoid clashes on the case instance level. Alternatively, an 'overview' variable can be created while the instances are still unfinished. Each aggregation consists of one or multiple definitions that map instance variables of one instance of the repetition to the aggregation variable.

Advanced

Execution

Attribute	Type	Description	Category
Impact on parent completion	Selection: default ignore ignore if available ignore if available or enabled ignore after first completion ignore after first completion if available or enabled	Defines how the plan item is used when the parent completion evaluation is executed.	Normally, a parent stage completes when it has no active child plan item instances and all such instances are in a terminal state. Using auto complete, this can be changed to only look at the plan items marked as required. Using the Parent completion here, this behavior can be further specified: default will be as described above while ignore means that this event listener isn't taking into account when checking if the parent stage completes. The other options allow for even finer-grained control to determine when to ignore this event listener with regards to parent stage completion.

Details

Attribute	Type	Description	Category
Available condition	Text	Sets an available condition, which is an expression that moves the event listener into the available state after creation if true. Also returns the event listener back to the unavailable state when the condition becomes false again.	The life cycle of event listeners is simpler than that of plan items such as human tasks: an event listener stays in the available state until the event happens. There’s no active state like for other plan items. In some use cases however, the event listener shouldn’t be available for the user to interact with unless a certain condition is true, typically based on case instance variables. The available condition serves exactly that purpose.
Include in history	Boolean	When the history level is set to "instance" or "task" level with this property it can be configured if this plan item instance should be included in the historic plan item instance data.	The Include in history flag can be used to store the historical entry of this event listener when running with a history level that normally would not store details of its execution. Note that this flag has no effect when running with history level 'none'.

Listeners

Attribute	Type	Description	Category
Lifecycle listeners	List	Allows you to define lifecycle listeners for a plan item. Lifecycle listeners allow you to execute an expression, a delegate expression or a class when a plan item transitions from one state to another.	With lifecycle listeners it is possible to react to state changes of the event listener instance. Lifecycle listeners allow you to execute an expression, a delegate expression or a class when the plan model transitions from one state to another.

Reactivation

Attribute	Type	Description	Category
Direct activation condition	Boolean	Condition that expresses if the plan item should be directly activated when a case instance is reactivated.	Case reactivation is the the ability to reopen a finished case instance and continue with its execution. Case reactivation needs to be modeled using a reactivation listener and specific behavior can be configured for each plan item in the case model. The Direct Activation Condition is the first condition to be evaluated during case reactivation. If checked or if there is an expression evaluating to true, the event listener immediately gets activated, regardless of any entry sentry or condition which might be necessary to restart at a certain state of the case (e.g. a stage). The Ignore Condition, if checked or if there is an expression evaluating to true, means that the event listener is ignored on reactivation. The Default Condition only gets evaluated, if the previous ones are either not checked or evaluated to false. If so, the event listener behaves like a regular one as if the case instance was started from scratch. This means that any necessary entry sentry is considered and evaluated and the engine proceeds as normal. Please check the Flowable documentation for more details.
Ignore condition	Boolean	Condition that expresses if the plan item should be ignored when a case instance is reactivated.
Default condition	Boolean	Condition that expresses if the plan item should trigger when a case instance is reactivated.

Visual

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

List Attribute Details

Variable Aggregations

Attribute	Type	Description
Target (Variable / Expression)	Text	The name of the target variable or an expression that gives the variable name
Type	Selection: Default Custom
Delegate Expression	Text	Delegate Expression to be executed when the task is activated. A delegate expression must resolve to a Java object, for instance a Spring bean. The object's class must implement either PlanItemJavaDelegate or CmmnActivityBehavior.
Class	String	Fully qualified classname of a class to be invoked when executing the task. The class must implement either PlanItemJavaDelegate or CmmnActivityBehavior.
Target variable creation	Selection: Default Create overview variable Store as transient variable
Variable Definitions	List

Variable Definitions

Attribute	Type	Description
Source (Variable / Expression)	Text	The name of the source variable or an expression that provides the value
Target (Variable / Expression)	Text	The name of the target variable or an expression that gives the variable name

Lifecycle listeners

Attribute	Type	Description
Source state	Selection: Any Available Active Enabled Disabled Completed Failed Suspended Closed Terminated Waiting for repetition Async active
Target state	Selection: Any Available Active Enabled Disabled Completed Failed Suspended Closed Terminated Waiting for repetition Async active
Class	Text	Fully qualified classname of a class to be invoked when executing the task. The class must implement either PlanItemJavaDelegate or CmmnActivityBehavior.
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