Message catch start event
Message Catch Start Event node represents the starting point for a process instance based on the receipt of a specific message. When this event is triggered by receiving the designated message, it initiates the execution of the associated process.
Why it is important? The Message Catch Start Event is important because it allows a process to be triggered and initiated based on the reception of a specific message.
Configuring a message catch start event
A Message Catch Start Event is a special event in a process that initiates the start of a process instance upon receiving a specific message. It acts as the trigger for the process, waiting for the designated message to arrive. Once the message is received, the process instance is created and begins its execution, following the defined process flow from that point onwards. The Message Catch Start Event serves as the entry point for the process, enabling it to start based on the occurrence of the expected message.
It is mandatory that in order to use this type of node together with task management plugin, to have a service account defined in your identity solution. For more information, check our documentation in how to create service accounts using Keycloak, here.
General config
- Can go back? - setting this to true will allow users to return to this step after completing it, when encountering a step with
canGoBackfalse, all steps found behind it will become unavailable - Correlate with catch events - the dropdown contains all catch messages from the process definitions accessible to the user
- Correlation key - is a process key that uniquely identifies the instance to which the message is sent
- Send data - allows the user to define a JSON structure with the data to be sent along with the message
- Stage - assign a stage to the node, if needed
Interprocess communication with throw and message catch start events
Throw process
Configuring the throw intermediate event
General config
- Can go back? - Setting this to true allows users to return to this step after completion. When encountering a step with canGoBack set to false, all steps found behind it become unavailable.
- Correlate with catch events - Should match the configuration in the message catch start event.
- Correlation key - A process key that uniquely identifies the instance to which the message is sent.
- Send data - Define a JSON structure with the data to be sent along with the message. In our example, we will send a test object:
{"test": "docs"}
- Stage - Assign a stage to the node if needed.
Start with catch process
Configuring the message catch start event
Remember, it’s mandatory to have a service account defined in your identity solution to have the necessary rights to start a process using the message catch start event. Refer to our documentation on how to create service accounts using Keycloak, here.
After running the throw process, the process containing the start catch message event will be triggered. The data is also sent:
Was this page helpful?