Signal End Event

Plan Availability:

A Signal End Event object broadcasts a specific Signal designed in Signal Manager that contains none, part, or all of its Request data when it triggers to all objects throughout that ProcessMaker Platform instance. Any object listening for that specific Signal thereby triggers. The Signal End Event object triggers when its Request completes. 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 object that listens for that broadcasting Signal does not need to be in the same Process model as the Signal End Event object. Pool objects in the same Process model that contain objects listening for that Signal also trigger.

The purpose of the broadcasting Signal may be the following:

Signal Start Event object: Broadcast a specific Signal to all Signal Start Event objects listening for that Signal to simultaneously start Requests for those Processes. The Signal Start Event object references the Signal's payload when starting the new Request.
Intermediate Signal Catch Event object: Broadcast a specific Signal to all Intermediate Signal Catch Event objects listening for that Signal to simultaneously resume workflow for those Requests that have been paused. Each triggered Intermediate Signal Catch Event object references the Signal's payload when resuming its Request.
Boundary Signal Event: Broadcast a specific Signal to all Boundary Signal Event objects listening for that Signal to follow alternative workflow from its associating object or connector. Each triggered Boundary Signal Event object references the Signal's payload when taking alternative workflow in its Request.

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

The Signal End Event object triggers, thereby completing its Request.
The Signal End Event object broadcasts its specified Signal.
If the object is listening for that broadcasted Signal, then that listening object triggers. Otherwise, the Signal is ignored.

Add a Signal End Event to a Process

Permissions

Your user account or group membership must have the following permissions to configure a Signal 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 Signal 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.

Add from the Object panel

Add from the Object bar

Follow these steps to add a Signal End 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 End 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 Signal End Event option.
The Signal End Event object displays.

Follow these steps to add a Signal End 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 Signal End Event option.
The Signal End Event object displays.

Adjust location and appearance

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

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

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

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

Select the Signal End Event object to change to another ending Request event object. Available options display above the selected object.
Click the Objects icon. The Objects drop-down menu displays the ending Request event objects.
Select the object to replace the Signal End Event object. The Change Type screen displays to confirm replacing the currently selected object.
Click Confirm. The new object replaces the Signal End Event object with its default settings and color.

Settings

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

Configuration Panel Settings

The Signal 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 Signal End Event object:

Select the Signal End 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 Signal The Object Broadcasts

A Signal End Event object broadcasts a specific Signal that contains part or all of its current Request data when it triggers to all objects throughout that ProcessMaker Platform instance listening for that Signal. The Signal End Event object triggers when its Request completes. The object that listens for the broadcast Signal does not need to be in the same Process model as the Signal End Event object. Select the Signal that this object broadcasts.

Follow these steps to select the Signal that the Signal End Event object broadcasts:

Select the Signal End Event object from the Process model in which to select the signal that it broadcasts.
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 Signal setting.
Do one of the following:
- The Signal to trigger this object exists:
  1. From the Signal drop-down menu, select the Signal that triggers this object. This setting is required.
- The Signal to trigger this object 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 objects 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 object. 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 objects that can broadcast or listen for a Signal.

Follow these steps to edit the name of a Signal:

Select any object from the Process model that broadcasts or listens for a Signal.
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 Signal setting. The Signal setting may have a selection unlike the image below indicates.
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.
Click the Edit iconthat displays beside each Signal to edit that signal. The Name setting displays the name of that Signal.
In the Name setting, edit the name of the Signal as necessary.
Click Save.
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 object, a message displays with which object(s) subscribes to that Signal.
Carefully consider whether to delete a Signal. Deleting a Signal makes that Signal unavailable when
configuring all objects that broadcast or listen to Signals throughout your ProcessMaker Platform instance.
Deleting a Signal cannot be undone.

Follow these steps to delete a Signal:

Select any object from the Process model that broadcasts or listens for a Signal.
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 Signal setting. The Signal setting may have a selection unlike the image below indicates.
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.
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 object anywhere in your ProcessMaker Platform instance, that Signal cannot be deleted. A message displays by which object(s) subscribes to this Signal.
Click Delete.
Save your Process model. The Signal is also deleted from Signal Manager.

Select the Contents of the Broadcasting Signal's Payload

Configure the contents of the broadcasting Signal's payload when the Signal End Event object triggers:

Send no Request data in the Signal's payload, thereby sending no data. All objects configured to listen for the broadcasting Signal trigger, but no data from the Signal End Event object's Request can be referenced from the receiving object.
Send all current Request data in the Signal's payload.
Send the current value of a specified Request variable in the Signal's payload.

Follow these steps to select the contents of the Signal's payload that the Signal End Event object broadcasts:

Select the Signal End Event object from the Process model in which to select contents of the Signal's payload.
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 Signal Payload setting.
From the Signal Payload drop-down menu, select one of the following options:
- No Request Data: Select No Request Data to send no Request data in the Signal's payload.
- All Request Data: Select All Request Data to send all current Request data in the Signal's payload.
- Specify Data Variable: Select Specify Data Variable to specify a Request variable's current value as the Signal's payload. The Request Variable setting displays. In the Request Variable setting, enter or edit the name of the Request variable to use its current value as the Signal's payload.

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:

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 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 a Signal End Event object:

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