Message End Event

Updated
  • 6 minute(s) read
Prev Next

A Message End Event object sends a message to a Message Start Event or an Intermediate Message Catch Event object when the Request using the Message End Event object completes. The purpose of the message transfer is to send data between Requests running from the same Process model since each Pool object represents its own Request with its own distinct Request data.

A Message Flow object can connect from the Message End Event object to the object listening for its message.

A Message End Event object functions as follows during a Request:

  • The Message End Event object triggers when the Request using it completes.

  • The Message End Event object sends its message. The message has a name which is a placeholder for the Request data it sends to the catching object.

  • If the message name matches that for which the catching object is listening, then that object triggers. Otherwise, the message is ignored.

Add a Message End Event to a Process

Permissions

  • Processes: Edit Processes

  • Processes: View Processes

See the Process permissions or ask your Administrator for assistance.

Your user account or group membership must have the following permissions to configure a Message End Event object in the Process model unless your user account has the Make this user a Super Admin setting selected:

Processes: Edit Processes

Processes: View Processes

See the Process permissions or ask your Administrator for assistance.

Add a Message End Event object from one of the following locations in Process Modeler:

  • Object Panel: Located to the left of the Process Modeler, the Object Panel contains various process modeling objects.

  • Object Bar: Located at the bottom of the Process Modeler, the Object Bar contains pinned Process modeling objects for quick access.

Follow these steps to add a Message End Event from the Object panel to the Process model:

  1. Ensure that the Object panel is visible. If not, click the Add icon from the Object bar at the bottom.

  2. Click the End Event object from the Object panel to select it.

  3. Click the location in the Process model to place this object. If your process has a Pool object, the object cannot be placed outside of the Pool.

  4. Click the Objects drop-down menu, and then select the Message End Event option.

    The Message End Event object displays.  

Follow these steps to add a Message End Event object from the Object bar to the Process model:

  1. Ensure that the object is pinned to the Object bar. If not, see instructions to pin it.

  2. In the Object bar at the bottom center, click the object's icon.

  3. Click the location in the Process model to place this object. If your process has a Pool object, the object cannot be placed outside of the Pool.

  4. Click the Objects drop-down menu, and then select the Message End Event option.

    The Message End Event object displays.

Replace a Message End Event Object with a Different Ending Request Event Object

After a Message End Event object is added to a Process model, you may replace it with a different ending Request event object:

The selected Message End Event object is replaced by the default settings and color of the replacing object.

Follow these steps to replace a Message End Event object with a different ending Request event object:

  1. Select the Message End Event object to change to another ending Request event object. Available options display above the selected object.

  2. Click the Objects icon. The Objects drop-down menu displays the ending Request event objects.

  3. Select the object to replace the Message End Event object. The Change Type screen displays to confirm replacing the currently selected object.

  4. Click Confirm. The new object replaces the Message End Event object with its default settings and color.

Settings

The Message End Event object has the following panels that contain settings:

Configuration Panel Settings

The Message End Event object has the following settings in the Properties panel:

Edit the Object Name

An object name is a human-readable reference for a Process object. Process Modeler automatically assigns the name of a Process object with its object type. However, an object's name can be changed.

Follow these steps to edit the name for a Message End Event object:

  1. Select the Message End Event object from the Process model in which to edit its name.

  2. Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.

  3. In the Name setting, edit the selected object's name and then press Enter.

Edit the Message Name

The Message End Event object uses a message name as a placeholder for the Request data that this object sends to a catching object. When a Message Start Event object or an Intermediate Message Catch Event object listens for a message, it references the Message End Event object's message name.

Follow these steps to configure how to trigger a Message End Event object:

  1. Select the Message End Event object from the Process model in which to configure its message name.

  2. Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.

  3. Expand the Configuration panel if it is not presently expanded, and then locate the Message Name setting.

  4. In the Message Name setting, edit the message name that a catching object references to listen for the Message End Event's message.

Data Inputs & Assignments Panel Settings

The Data Inputs & Assignments panel allows designers to define and map fields that make up the message payload. Each payload field can be built using FEEL Expression Syntax to generate dynamic content.

Add Data Inputs & Assignments

Follow these steps to configure Data Inputs & Assignments for an Intermediate Message Throw Event:

  1. Select the Intermediate Message Throw Event in the Process model.

  2. Ensure the Configuration panel is visible. If it is hidden, show it. Panels to configure this object display.

  3. Expand the Data Inputs & Assignments panel if it is not already expanded.

  4. Click +Add Data Input. A new Data Input Name entry displays.

  5. In Data Input Name, enter the name of the data input.

  6. Click +Add Assignment to define the payload fields.

  7. In the From, enter the data to map. Use FEEL expressions to construct dynamic values, for example, concatenate the variables firstname and lastname using firstname + " " + lastname .

  8. In the To, enter the target payload field name. For example, enter completeName .

  9. Add additional assignments as needed, then click Save. The assignment expressions displays in the list.

Advanced Panel Settings

Edit the Node's Identifier Value

Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.

All identifier values for all nodes in the Process model must be unique.

Follow these steps to edit the identifier value for a Message End Event object:

  1. Select the Message End Event object from the Process model in which to edit its identifier value.

  2. Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.

  3. Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.

  4. In the Node Identifier setting, edit the Message End Event object's identifier to a unique value from all nodes in the Process model and then press Enter.