Intermediate Signal Catch Event

An Intermediate Signal Catch Event object pauses a Request until that object receives a specific broadcasting Signal designed in Signal Manager from a broadcasting object in any other Request. These paused Requests may be for many different Process models. The object that broadcasts the Signal does not need to be in the same Process model as the Intermediate Signal Catch Event object to receive the broadcast. Pool objects within the same Process model that contain Intermediate Signal Catch Event objects also trigger.

The Intermediate Signal Catch Event object receives any Request data in the broadcasting Signal's payload. Request data in the Signal's payload may be referenced when resuming its Request.

The broadcasting Signal may originate from any of the following:

  • Intermediate Signal Throw Event object: An Intermediate Signal Throw Event object broadcasts a specified Signal containing none, part, or all of its Request data to all Intermediate Signal Catch Event objects in paused Requests while the Intermediate Signal Catch Event object(s) in those Requests listens for that Signal. In the Signal's payload, the Intermediate Signal Throw Event object may broadcast the entirety of the current Request data to that point in the Request's workflow, the current value of a Request variable, or specific Request data based on an expression. The Intermediate Signal Catch Event object references the Signal's payload when resuming its Request. Use this functionality to resume workflow for potentially multiple paused Requests as soon as the Intermediate Signal Throw Event broadcasts the Signal.

  • Signal End Event object: A Signal End Event object broadcasts a specified Signal containing none, part, or all of its Request data to all Intermediate Signal Catch Event objects in paused Requests while the Intermediate Signal Catch Event object(s) in those Requests listens for that Signal. In the Signal's payload, the Signal End Event object may broadcast the entirety of the Request data, the current value of a Request variable, or specific Request data based on an expression. The Intermediate Signal Catch Event object references the Signal's payload when resuming its Request. Use this functionality to resume workflow for potentially multiple paused Requests as soon as the Signal End Event object completes its Request.

Each Intermediate Signal Catch Event object functions as follows during its Request:

  1. Workflow in each Request using an Intermediate Signal Catch Event object pauses when it reaches this event. Each Intermediate Signal Catch Event object waits for a specified broadcasting Signal.

  2. The Intermediate Signal Throw Event object or Signal End Event object triggers from a separate Request not necessarily represented in the same Process model as any Intermediate Signal Catch Event object.

  3. That triggering object broadcasts its Signal containing Request data.

  4. Each Intermediate Signal Catch Event object in each paused Request that matches the broadcasting Signal triggers, thereby resuming workflow simultaneously in those Requests. Otherwise, that broadcasting Signal is ignored for those Intermediate Signal Catch Event objects not listening for that Signal and those Requests remain paused.


Add an Intermediate Signal Catch Event to a Process

Permissions

Your user account or group membership must have the following permissions to configure an Intermediate Signal Catch 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 an Intermediate Signal Catch 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 an Intermediate Signal Catch 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 Intermediate Event object from the Object panel to select it.

  3. Click the location in the Process model to place this object. Follow these guidelines when placing this object:

    • If your process has a Pool object, the object cannot be placed outside of the Pool.

    • To place this object between two existing objects, follow these instructions.

  4. Click the Objects drop-down menu, and then select the Intermediate Signal Catch Event option.

    The Intermediate Signal Catch Event object displays.

Follow these steps to add an Intermediate Signal Catch 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. Follow these guidelines when placing this object:

    • If your process has a Pool object, the object cannot be placed outside of the Pool.

    • To place this object between two existing objects, follow these instructions.

  4. Click the Objects drop-down menu, and then select the Intermediate Signal Catch Event option.

    The Intermediate Signal Catch Event object displays.

Replace an Intermediate Signal Catch Event Object with a Different Intermediate Request Event Object

After an Intermediate Signal Catch Event object is added to a Process model, you may replace it with a different intermediate Request event object:

The selected Intermediate Signal Catch Event object is replaced by the default settings and color of the replacing object.

Follow these steps to replace an Intermediate Signal Catch Event object with a different Intermediate-type event object:

  1. Select the Intermediate Signal Catch Event object to change to another Intermediate-type event object. Available options display above the selected object.

  2. Click the objects icon. The objects drop-down menu displays the Intermediate-type event objects.

  3. Select the object to replace the Intermediate Signal Catch Event object. The Change Type screen displays to confirm replacing the currently selected object.

  4. Click Confirm. The new object replaces the Intermediate Signal Catch Event object with its default settings and color.


Settings

The Intermediate Signal Catch Event object has the following panels that contain settings:


Configuration Panel Settings

The Intermediate Signal Catch 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 an Intermediate Signal Catch Event object:

  1. Select the Intermediate Signal Catch 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.

Select the Signal to Trigger the Object

An Intermediate Signal Catch Event object pauses a Request until that object receives a specific broadcast from a broadcasting object in any other Request in that ProcessMaker Platform instance. The object that broadcasts the Signal does not need to be in the same Process model as the Intermediate Signal Catch Event object that receives the broadcast. Select the Signal that triggers this object.

Follow these steps to select the Signal that triggers the Intermediate Signal Catch Event object:

  1. Select the Intermediate Signal Catch Event object from the Process model in which to select the Signal that triggers it.

  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 Signal setting.

  4. From the Signal drop-down menu, select the Signal that triggers this object. This setting is required.

  5. Save your Process model.

Enter the Request Variable to Store the Broadcasting Signal's Payload

When the Intermediate Signal Catch Event object receives a broadcasting Signal for which it is listening, enter the Request variable that stores the Request data in the broadcasting Signal's payload. The Request data within the broadcasting Signal may then be used in the paused Request when the Intermediate Signal Catch Event object resumes that Request.

Follow these steps to enter the Request variable to store the broadcasting Signal's payload:

  1. Select the Intermediate Signal Catch Event object from the Process model in which to enter the Request variable.

  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 Request Variable setting.  

  4. In the Request Variable setting, enter the name of the Request Variable to store the broadcasting Signal's payload and then press Enter.

  5. Save your Process model.


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's Description Displayed in Process Documentation

Follow these steps to edit the description for an object:

  1. Select the object from the Process model in which to edit its description.

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

  3. Expand the Documentation panel if it is not presently expanded. The Description setting displays.

  4. 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 theicon to undo the last action.

    • Redo changes: Click on theicon to redo the last undone action.

    • Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:

      1. Select the required text from the Rich Text control.

      2. Click on theicon. The Insert/Edit Link screen displays.  

      3. In the URL setting, enter the destination URL.

      4. In the Text to display setting, edit or enter the text displayed in the Rich Text control.

      5. In the Title setting, enter the text to display when a user hovers over the displayed text.

      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 iconto insert an image. Follow these guidelines:

      1. Click on the Insert/Edit Image icon.

      2. The Insert/Edit Image screen displays:  

      3. In the Source setting, enter a URL for the image.

      4. In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.

      5. In the Width setting, enter the maximum width for the image.

      6. In the Height setting, enter the maximum height for the image.

      7. Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.

      8. Click Save.

    • Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto 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 theicon.

        • From the Paragraph/Formats menu, select Inline and then Bold.

      • Italics: Do one of the following:

        • From the editor toolbar, select theicon.

        • 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 theicon. 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 theicon to select a custom color from the Color Picker.

          • Click theicon 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 theicon 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 theicon 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 theicon 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 theicon to justify text.

          • From the Paragraph/Formats menu, select Align and then Justify.

      • Insert a bullet list: Use theicon to format text as a bulleted list.

      • Insert a numbered list:  Use theicon to format text as a numbered list.

      • Indent text: Click on theicon to increase text indenting.

      • Outdent text: Click on theicon 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 an Intermediate Signal Catch Event object:

  1. Select the Intermediate Signal Catch 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 Intermediate Signal Catch Event object's identifier to a unique value from all node in the Process model and then press Enter.