Message Start Event

Introduction

A process instance is started on receipt of a message. The reception of messages must occur in the back end.

tip

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

Properties

General

Common

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.
Message reference	Selection	A message reference from the message definitions of the root model, usually the process.	A process instance (or event subprocess if used there) of this BPMN process model will be started when a message event is fired from somewhere else. Select either a message definition that's been configured on the root level or use a message expression.
Message expression	Text	An expression resolving to a message name, without needing to define a message event on the process instance level. The message reference has precedence, if set.

Form

Attribute	Type	Description	Category
Work form reference	Reference	Reference of the form that will be displayed when the 'Work Form' of the process is displayed.
Work Form 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.

Advanced Form

Data mapping

Attribute	Type	Description	Category
Input mapping type work form	Selection: Allowed Blocked	Defines the type for the input mapping definitions for a work form, which can be allowed or blocked.
Input mappings to work form	List	Defines the input mappings that are allowed or blocked for the work form.
Output mapping type work form	Selection: Allowed Blocked	Defines the type for the output mapping definitions for a work form, which can be allowed or blocked.
Output mappings to work form	List	Defines the output mappings that are allowed or blocked for the work form.

Validation

Attribute	Type	Description	Category
Validate work form fields (server-side)	Boolean	If the work form is submitted and validate work form fields expression evaluates to true, form fields are validated on the BE side according to the form model restrictions.

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

Input mappings to work form

Attribute	Type	Description
Mapping value	Text

Output mappings to work form

Attribute	Type	Description
Mapping value	Text

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