A Message Start Event object starts a Request for a Process when it triggers from a specific message. The Message Start Event object listens for a message from a specified source. The purpose of the message transfer is to send data from one Pool object's Request data to another Pool object within the same Process model, thereby using the sent Request data to start a Request for the receiving Pool object; each Pool object represents its own Request with its own distinct Request data.
A Message Flow object can connect from the object sending the message to the Message Start Event object. A Process model can have multiple Message Start Event objects.
The message may originate from any of the following:
Intermediate Message Throw Event object: An Intermediate Message Throw Event object sends a message to the Message Start Event. Use this functionality to start a different Process's Request while the Request that sends the message is in progress. If the Message Start Event object is in the same Process model as the Intermediate Message Throw Event object for which it listens for its message, these objects must be in separate Pool objects since each Pool object has its own Request.
Message End Event object: A Message End Event object sends a message to the Message Start Event. Use this functionality to start a different Process's Request when the Request that sends the message completes. If the Message Start Event object is in the same Process model as the Message End Event object for which it listens for its message, these objects must be in separate Pool objects.
Third-party service: A third-party service such as a CRM may send a message via our API to the Message Start Event, thereby starting a Request.
A Message Start Event object functions as follows during a Request:
The Message Start Event object listens for a message based on that message's name. The message name is a placeholder for the message.
The Intermediate Message Throw Event object or Message End Event object triggers.
That triggering object sends its message containing Request data to the Message Start Event object.
If the message name matches that for which the Message Start Event object is listening, then that object triggers, thereby starting the Request. Otherwise, the message is ignored.
Add a Message Start Event to a Process
Permissions
Your user account or group membership must have the following permissions to configure a Message Start 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 Start 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 Start Event from the Object panel to the Process model:
Ensure that the Object panel is visible. If not, click the Add icon
from the Object bar at the bottom.
Click the Start Event object
from the Object panel to select it.
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.
Click the Objects drop-down menu, and then select the Message Start Event option.
The Message Start Event object displays.
Follow these steps to add a Message Start Event object from the Object bar to the Process model:
Ensure that the object is pinned to the Object bar. If not, see instructions to pin it.
In the Object bar at the bottom center, click the object's icon.
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.
Click the Objects drop-down menu, and then select the Message Start Event option.
The Message Start Event object displays.
Replace a Message Start Event Object with a Different Starting Request Event Object
After a Message Start Event object is added to a Process model, you may replace it with a different starting Request event object:
Start Event object
Start Timer Event object
Signal Start Event object
Conditional Start Event object
The selected Message Start Event object is replaced by the default settings and color of the replacing object.
Follow these steps to replace a Message Start Event object with a different Start-type event object:
Select the Message Start Event object to change to another Start-type event object. Available options display above the selected object.
Click the Objects icon. The Objects drop-down menu displays the Start-type event objects.
Select the object to replace the Message Start Event object. The Change Type screen displays to confirm replacing the currently selected object.
Click Confirm. The new object replaces the Message Start Event object with its default settings and color.
Settings
The Message Start Event object has the following panels that contain settings:
Configuration panel
Documentation panel
Advanced panel
Configuration Panel Settings
The Message Start Event object has multiple 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 Start Event object:
Select the Message Start Event object from the Process model in which to edit its name.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
In the Name setting, edit the selected object's name and then press Enter.
Select the Object from Which to Listen for a Message
An Message Start Event object starts a Request when that object receives a message from either an Intermediate Message Throw Event object or a Message End Event object (but not both) located in a different Pool object than the Message Start Event object receiving the message. After the Message Start Event object receives its message, that object triggers. Select from which object to listen for a message based on the Intermediate Message Throw Event or Message End Event object's Message Name setting value.
Follow these steps to select from which object to listen for a message to trigger the Message Start Event object:
Select the Message Start Event object from the Process model in which to select the Process model object from which to listen for a message.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.
Expand the Configuration panel if it is not presently expanded and then locate the Listen For Message setting.
From the Listen For Message drop-down menu, select from which object to listen for a message based on its Message Name setting value.
Documentation Panel Settings
Describe the object's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the object is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
Edit the Object Documentation
Follow these steps to edit the description for an object:
Select the object from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this object and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon
.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Undo changes: Click on the
icon to undo the last action.
Redo changes: Click on the
icon to redo the last undone action.
Insert/Edit Link: Click on the
icon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Select the required text from the Rich Text control.
Click on the
icon. The Insert/Edit Link screen displays.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
Insert/Edit Image: Click on the Insert/Edit Image icon
to insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon
.
The Insert/Edit Image screen displays:
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Toggle the Constrain Proportions icon
to maintain the width-height ratio of the image to its original proportion.
Click Save.
Insert Page Break for PDF: Click on the Insert Page Break for PDF icon
to insert a page break when a PDF document is created for this documentation if your browser supports this feature.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the editor toolbar, select the
icon.
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the editor toolbar, select the
icon.
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Change text color: Use the Text Color drop-down to change text color. Click on the
icon. The color palette displays. Do one of the following:
Select one of the color swatches from the color palette. The selected text changes to that color.
Click the
icon to select a custom color from the Color Picker.
Click the
icon to reset the text to its default color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the editor toolbar, use the
icon to left-align text.
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the editor toolbar, use the
icon to center-align text.
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the editor toolbar, use the
icon to right-align text.
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the editor toolbar, use the
icon to justify text.
From the Paragraph/Formats menu, select Align and then Justify.
Insert a bullet list: Use the
icon to format text as a bulleted list.
Insert a numbered list: Use the
icon to format text as a numbered list.
Indent text: Click on the
icon to increase text indenting.
Outdent text: Click on the
icon to decrease text indenting.
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 Start Event object:
Select the Message Start Event object from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the Message Start Event object's identifier to a unique value from all nodes in the Process model and then press Enter.