Intermediate Signal Catch Event

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

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

Add an Intermediate Signal Catch Event Element

Add an Intermediate Signal Catch Event element from one of the following locations in Process Modeler:

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

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

• Connect Two Process Model Objects with a Sequence Flow Element.

• Move a Process Model Object.

• Customize the Appearance of a Process Model Object.

• Copy Process Model Objects into the Clipboard.

• Clone Process Model Objects Without the Clipboard.

• Delete Process Model Objects.

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

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

• Intermediate Timer Event element

• Intermediate Signal Throw Event element

• Intermediate Message Catch Event element

• Intermediate Message Throw Event element

• Intermediate Conditional Catch Event element

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

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

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

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

   

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

   

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

Settings

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

• Configuration panel

  • Edit the element name

  • Select the Signal to trigger the element

  • Edit the name of a Signal

  • Delete a Signal

  • Enter the Request variable to store the broadcasting Signal's payload

• Documentation panel

  • Edit the element's description displayed in Process documentation

• Advanced panel

  • Edit the node's identifier value

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 Signal Catch Event element:

1. Select the Intermediate Signal Catch Event element 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 element's name and then press Enter.

Select the Signal to Trigger the Element

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

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

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

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

   

4. Do one of the following:

   • The Signal to trigger this element exists:

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

   • The Signal to trigger this element does not exist:

     1. Click the menu iconbeside the Signal drop-down menu. The +Signal button displays.

     2. Click the +Signal button. The ID and Name settings display to configure the new Signal's ID and name, respectively.

        

     3. In the ID setting, enter the unique ID of this Signal. The Signal ID may only contain non-special characters and without spaces. This Signal ID must be unique from all other signal IDs. If the entered Signal ID already exists, the following text displays below the setting: Signal ID is duplicated. Note that the Signal ID cannot be edited after the Signal is created.

        Consider the following when entering the Signal ID value:

        • Signal IDs must be unique and accept alphanumeric characters only.

        • A Signal that corresponds with a User Signal must have the Signal ID value that corresponds with that User Signal's event. See What is a User Signal?. Ensure that the User Signal is enabled for use.

        This is a required setting.

     4. In the Name setting, enter the unique alphanumeric name of this Signal. This Signal name must be unique from all other Signal names. This Signal name displays when selecting a Signal from other elements that can broadcast or listen for a Signal. If the entered Signal name already exists, the following text displays below the setting: Signal Name is duplicated. This is a required setting.

     5. Click Save. The Signal is created.

     6. From the Signal drop-down menu, select the new Signal that triggers this element. This setting is required.

     7. Save your Process model. The new Signal is added to Signal Manager.

Edit the Name of a Signal

Editing the name of a Signal changes that signal's name. This Signal name displays when selecting a Signal from other elements that can broadcast or listen for a Signal.

Follow these steps to edit the name of a Signal:

1. Select any element from the Process model that broadcasts or listens for a Signal.

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

3. Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting. The Signal setting may have a selection unlike the image below indicates.

   

4. Click the menu iconbeside the Signal drop-down menu. All Signals configured in your ProcessMaker instance display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.

   

5. Click the Edit iconthat displays beside each Signal to edit that signal. The Name setting displays the name of that Signal.

   

6. In the Name setting, edit the name of the Signal as necessary.

7. Click Save.

8. Save your Process model. The name of the Signal also changes in Signal Manager.

Delete a Signal from the Instance

A Signal cannot be delete if any other Signal subscribes to it. When attempting to delete a Signal with any subscribing element, a message displays with which element(s) subscribes to that Signal.

Carefully consider whether to delete a Signal. Deleting a Signal makes that Signal unavailable when configuring all elements that broadcast or listen to Signals throughout your ProcessMaker Platform instance.

Deleting a Signal cannot be undone.

Follow these steps to delete a Signal:

1. Select any element from the Process model that broadcasts or listens for a Signal.

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

3. Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting. The Signal setting may have a selection unlike the image below indicates.

   

4. Click the menu iconbeside the Signal drop-down menu. All Signals configured in your ProcessMaker Platform instance display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.

   

5. Click the Delete iconthat displays beside each Signal to delete that Signal. A message displays to confirm deletion of this Signal.

   

   If the Signal is subscribed to by another element anywhere in your ProcessMaker Platform instance, that Signal cannot be deleted. A message displays by which element(s) subscribes to this Signal.

6. Click Delete.

7. Save your Process model.

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

When the Intermediate Signal Catch Event element 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 element 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 element 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 element 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

Edit the Element's Description Displayed in Process Documentation

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.

Follow these steps to edit the description for an element:

1. Select the element 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 element 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 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 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 element:

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