ProcessMaker Platform Documentation
Spring 2023, ProcessMaker Platform
ProcessMaker HomeGive Us FeedbackRelease NotesDownload Open-Source Edition
Search
⌃K
Links

Intermediate Message Catch Event Element

Add, copy, delete, change the color, align, and configure Intermediate Message Catch Event elements in your Process model.

Don't Know What an Intermediate Message Catch Event Element Is?

See Process Modeling Element Descriptions for a description of the Intermediate Message Catch Event element.

Permissions Required

Your user account or group membership must have the following permissions to configure an Intermediate Message Catch Event element 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 an Intermediate Message Catch Event Element

Follow these steps to add an Intermediate Message Catch Event element to the Process model:
  1. 1.
    ​View your Processes. The Processes page displays.
  2. 2.
    ​Create a new Process or click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
  3. 3.
    Locate the Intermediate Event element in the Elements and Connectors palette that is to the left of the Process Modeler canvas. If the Hide Menus button​
    is enabled, the Elements and Connectors palette displays the Intermediate Event element's icon
    .
  4. 4.
    Drag the element into the Process model canvas where you want to place it. If a Pool element is in your Process model, the Intermediate Message Catch Event element cannot be placed outside of the Pool element.
  5. 5.
    From the Elements drop-down menu, select the Intermediate Message Catch Event option. The Intermediate Message Catch Event element displays.
Intermediate Message Catch Event element
After the element is placed into the Process model, you may adjust its location in the following ways:
Moving an Intermediate Message Catch Event element has the following limitations in regards to the following Process model elements:
  • Pool element: If the Intermediate Message Catch Event element is inside of a Pool element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Intermediate Message Catch Event element inside the Pool element closest to where you attempt to move it.
  • Lane element: If the Intermediate Message Catch Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Intermediate Message Catch Event element cannot be moved outside of the Pool element.

Replace an Intermediate Message Catch Event Element with a Different Intermediate Request Event Element

After an Intermediate Message Catch Event element is added to a Process model, you may replace it with a different intermediate Request event element:
The selected Intermediate Message Catch Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Intermediate Message Catch Event element with a different intermediate Request event element:
  1. 1.
    ​View your Processes. The Processes page displays.
  2. 2.
    Click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
  3. 3.
    Select the Intermediate Message Catch Event element to change to another intermediate Request event element. Available options display above the selected element.
  4. 4.
    Click the Elements icon. The Elements drop-down menu displays the intermediate Request event elements.
  5. 5.
    Select the element to replace the Intermediate Message Catch Event element. The Change Type screen displays to confirm replacing the currently selected element.
  6. 6.
    Click Confirm. The new element replaces the Intermediate Message Catch Event element with its default settings and color.

Change an Intermediate Message Catch Event Element's Color

Copy an Intermediate Message Catch Event Element

Clone an Intermediate Message Catch Event Element

Delete an Intermediate Message Catch Event Element

Settings

The Intermediate Message Catch Event element has the following panels that contain settings:

Configuration Panel Settings

Edit the Element Name

An element name is a human-readable reference for a Process element. Process Modeler automatically assigns the name of a Process element with its element type. However, an element's name can be changed.
Follow these steps to edit the name for an Intermediate Message Catch Event element:
  1. 1.
    Select the Intermediate Message Catch Event element from the Process model in which to edit its name. Panels to configure this element display.
  2. 2.
    Expand the Configuration panel if it is not presently expanded. The Name setting displays. This is a required setting.
    ​
    ​
  3. 3.
    In the Name setting, edit the selected element's name and then press Enter.

Select the Element from Which to Listen for a Message

An Intermediate Message Catch Event element pauses a Request until that element receives a message from either an Intermediate Message Throw Event element or a Message End Event element (but not both) located in a different Pool element than the Intermediate Message Catch Event element receiving the message. After the Intermediate Message Catch Event element receives its message, that element triggers. Select from which element to listen for a message based on the Intermediate Message Throw Event or Message End Event element's Message Name setting value.
Follow these steps to select the element from which to listen for a message:
  1. 1.
    Select the Intermediate Message Catch Event element from the Process model in which to configure how it is triggered. Panels to configure this element display.
  2. 2.
    Expand the Configuration panel if it is not presently expanded, and then locate the Listen For Message setting.
  3. 3.
    From the Listen For Message drop-down menu, select from which Intermediate Message Throw Event element or End Event element triggers the Intermediate Message Catch Event element.

Documentation Panel Settings

Edit the Element's Description Displayed in Process Documentation

If the Documentation package is installed, describe the element'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 element 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.

Package Required

The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
  1. 1.
    Select the element from the Process model in which to edit its description. Panels to configure this element display.
  2. 2.
    Expand the Documentation panel if it is not presently expanded. The Description setting displays.
  3. 3.
    In the Description setting, edit the information to display when viewing documentation for this element 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:
      1. 1.
        Select the required text from the Rich Text control.
      2. 2.
        Click on the
        icon. The Insert/Edit Link screen displays.
      3. 3.
        In the URL setting, enter the destination URL.
      4. 4.
        In the Text to display setting, edit or enter the text displayed in the Rich Text control.
      5. 5.
        In the Title setting, enter the text to display when a user hovers over the displayed text.
      6. 6.
        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:
      1. 1.
        Click on the Insert/Edit Image icon
        .
      2. 2.
        The Insert/Edit Image screen displays:
      3. 3.
        In the Source setting, enter a URL for the image.
      4. 4.
        In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
      5. 5.
        In the Width setting, enter the maximum width for the image.
      6. 6.
        In the Height setting, enter the maximum height for the image.
      7. 7.
        Toggle the Constrain Proportions icon
        to maintain the width-height ratio of the image to its original proportion.
      8. 8.
        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.

Vocabularies Panel Settings

Assign Vocabularies That Validate Request Data from This Element

Assign Vocabularies that validate Request data complies with a specific JSON schema. This is often mandatory for many types of business sectors including banking and healthcare. Ensure the quality and compliance of Request data. For example, during a Loan Application process, ensure that personal information has been included in the Request to that moment in that in-progress Request. The Vocabularies package must be installed to make this configuration.
Use a Vocabulary on an Intermediate Message Catch Event element to validate Request data complies with the Vocabulary's JSON schema. See What is a Vocabulary? for more information.
Each moment ProcessMaker evaluates workflow routing for an in-progress Request, ProcessMaker Platform also evaluates the Request data's conformity to the Vocabularies applied to the Process and/or a specific BPMN 2.0 element in the Process model. The Request's JSON data model must conform to the ProcessMaker Vocabulary's JSON schema.
During an in-progress Request, if ProcessMaker Platform evaluates that the Request data no longer complies with all Vocabularies to that moment, the Request status changes from In Progress to Error. The error displays in the Request summary. Vocabularies are cumulative in an in-progress Request: as the Request progresses, if Request data does not conform with any Vocabulary's JSON schema to that moment in the Request, the Request errors.
If no Vocabularies are assigned, ProcessMaker Platform does not validate Request data complies with a specific JSON schema prior to continuing workflow for that Request.
One or more Vocabularies must be created to your ProcessMaker Platform instance before assigning a Vocabulary. See Create a New Vocabulary. Multiple Vocabularies can be assigned to a Start Event element.

Package Required

The Vocabularies package must be installed to assign which Vocabularies validate Request data at an Intermediate Message Catch Event element. Use the Vocabularies package to maintain uniform JSON schemas across all assets in your organization. These assets include Processes, Screens, and Scripts.
A Vocabulary is a JSON schema. The JSON schema describes the data objects, types, and structure that you want in both a machine and human readable format. Apply one or more Vocabularies to your Processes and/or specific BPMN 2.0 elements in your Process models to ensure the JSON data model in Request data complies with the data structure outlined in the JSON schema that you need to meet regulatory specifications or ensure Request data contains required information.
Follow these steps to assign Vocabularies that validate Request data from an Intermediate Message Catch Event element:
  1. 1.
    Select the Intermediate Message Catch Event element from the Process model in which to assign Vocabularies that validate Request data prior to when this element completes. Panels to configure this element display.
  2. 2.
    Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.
  3. 3.
    Click the
    icon to add a Vocabulary. The Assign Vocabulary option displays.
  4. 4.
    From the Select Vocabulary drop-down menu, select a Vocabulary from which to validate Request data complies with its JSON schema.
    If no Vocabularies are configured in your ProcessMaker Platform instance, then the following message displays: List is empty. Create at least one Vocabulary. See Create a New Vocabulary.
  5. 5.
    Click Save.
  6. 6.
    Repeat Steps 3 through 6 as necessary for each Vocabulary required to validate Request data complies with its JSON schema.
Click the Remove icon
from the Vocabularies setting to remove a Vocabulary from assignment to this element.
After one or more Vocabularies are assigned to an Intermediate Message Catch Event element, the Vocabulary icon displays above that element.
Intermediate Message Catch Event element with an assigned Vocabulary

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 an Intermediate Message Catch Event element:
  1. 1.
    Select the Intermediate Message Catch Event element from the Process model in which to edit its identifier value. Panels to configure this element display.
  2. 2.
    Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
    ​
    ​
  3. 3.
    In the Node Identifier setting, edit the Intermediate Message Catch Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Last modified 1mo ago