Skip to content

Start Message Event Activity

The Start Message Event activity initiates a new process instance upon receiving a predefined message. This activity acts as a trigger, allowing external systems or other process instances to start a workflow by sending a specific message. It ensures that the process begins only when the expected message is successfully received.

Field Description Requirement
Message reference Specifies the unique identifier for the message that triggers the process instance. Required
Interrupting Determines whether all parent executions are terminated when this message event starts a new process instance. Optional

Action Types & Examples

Event Trigger Status

  • Format: boolean
  • Example Result: true

Implementation Examples

Field Setup - Message reference: NewOrderNotification - Interrupting: false

Execution Parameters - The Start Message Event activity is configured within a workflow definition to listen for a message with the reference NewOrderNotification. - When an external system sends a message matching this reference, a new process instance is automatically created. - Since Interrupting is false, any existing parent processes or scopes will continue to execute independently.

Technical Notes

The Start Message Event activity is crucial for designing event-driven architectures, enabling processes to react dynamically to external stimuli. It relies on a robust messaging infrastructure to ensure reliable message delivery and processing. Careful consideration of the Message reference is essential to prevent unintended process instantiations or missed messages. If the 'Interrupting' parameter is set to true, any active parent processes or scopes associated with the message correlation will be terminated, allowing the new process instance to take over.