User Event Listener

Introduction

A user event listener allows to manually trigger the evaluation of connected sentries, e.g., through the user interface.

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 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.
Start form	Reference	An optional form shown when the event listener is manually activated.	A start form is used whenever the action (button) is triggered in the Flowable Work UI. The event listener will only be move to the completed state when the form is submitted. If the form isn't filled in, the event listener remains in the available state.
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.	The Same deployment flag is used to indicate that the start form model that is used is part of the same app deployment package as where the current CMMN model is in. If unchecked, the latest version is used which can come from an app that is deployed at a later point in time.

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).

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 Form

Attribute	Type	Description	Category
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.	If checked, the data being submitted through the start form be validated on the server side according the form definition.

UI Configuration

Attribute	Type	Description	Category
Action Icon	Icon	Define the icon to be used for the user event listener.	A user event listeners gets an action (button) in Flowable work. The Action icon and the Action name of the button can be used to distinguish it from other actions. The Priority is used to order actions when there are multple actions defined in a case instance. By default, action buttons are shown in the header in Flowable Work. The Channels allows to change that. For example menu will not render a button, but move it to the dropdown menu. Check the documentation for alternatives.
Action name	Text	Define the name to be used for the user event listener.
Priority	Integer	Define the priority for the exposed user event listener action.
Channels	Text	Define a list of channels to expose the user event listener action.
Expose as action to object	List	Allows you to expose the activation action to objects other than the case or process, such as a user or conversation.	Actions related to a user event listener can be exposed to other scopes than the default case instance that it belongs to. Link the action to another scope type via its unique scope ID to have the action appear for that object.
Expose as an action message	List	Allows you to expose the activation action as a message to a conversation.

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'.
Permission users	Text	Define the users which have access to the user event listener.	Configure the users or groups that should be permitted to execute the action related to the user event listener.
Permission groups	Group Selection	Define the groups which have access to the user event listener.

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	The audit log type.
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	BasicFormList

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

Expose as action to object

Attribute	Type	Description
Scope Id	Text	Scope id points to the scope under which the audit task log is created. If all of scope attributes are empty, current scope is used.
Scope type	Text with suggestions: conversation cmmn bpmn task user user-account	Scope type defines the type of the scope and sub scope instances. If all of scope attributes are empty, current scope type is used.
Participant users	User Selection
Participant groups	Group Selection
Action name	Text
Action description	Text

Expose as an action message

Attribute	Type	Description
Conversation id	Text	The id of the conversation to modify, must be provided.
Sending user id	Text	Defines the optional user id that will send the message, defaults to the current user, if left empty.
Receiving user id	Text	Defines the optional user id that will receive the message, defaults to all participants of the conversation if left empty. If a receiving user id is specified, the message will be created as a private message.
Message content	Text	Defines the content for the message to be sent, if there is no template message code provided.
Template message code	Text	Optionally define a template message code to be used as the message content (in this case, the message content is ignored).
Template language	Text	Optionally define the language in which the template should be rendered as the message content.
Sticky message	Boolean

Lifecycle listeners

Attribute	Type	Description
Source state	Selection: Any Available Active Enabled Disabled Completed Failed Suspended Closed Terminated Waiting for repetition Async active Async active leave
Target state	Selection: Any Available Active Enabled Disabled Completed Failed Suspended Closed Terminated Waiting for repetition Async active Async active leave
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