ProcessMaker 4.1
ProcessMaker API Documentation
ProcessMaker Examples
Powered By GitBook
Signal Start Event Element
Add, copy, delete, change the color, align, and configure Signal Start Event elements in your Process model.

Don't Know What a Signal Start Event Element Is?

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

Permissions Required

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

Follow these steps to add a Signal Start Event element to the Process model:
    1.
    View your Processes. The Processes page displays.
    2.
    Create a new Process or click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
    3.
    Locate the Start 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 Start Event element's icon
    .
    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 Signal Start Event element cannot be placed outside of the Pool element.
    5.
    From the Elements drop-down menu, select the Start Timer Event option. The Signal Start Event element displays.
Signal Start Event element
After the element is placed into the Process model, you may adjust its location in the following ways:
Moving a Signal Start Event element has the following limitations in regards to the following Process model elements:
    Pool element: If the Signal Start 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 Signal Start Event element inside the Pool element closest to where you attempt to move it.
    Lane element: If the Signal Start Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Signal Start Event element cannot be moved outside of the Pool element.

Change a Signal Start Event Element's Color

The Signal Start Event element and label have a default green color to indicate that this element is a starting Request event. After a Signal Start Event element is added to a Process model, its shape and label color can be changed. Element and connector colors may only be changed individually.
Follow these steps to change the color and label for a Signal Start Event element:
    1.
    View your Processes. The Processes page displays.
    2.
    Click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
    3.
    Select the Signal Start Event element to change its color. Available options display above the selected element.
    4.
    Click the Open Color Palette icon
    . The color palette displays.
    5.
    Do one of the following to change the color:
      Select a color swatch: Select one of the color swatches from the color palette. The Signal Start Event element and label change to that color.
      Specify a custom color: Click the
      icon to display the color selector, and then select a color, enter the Hex color code, or enter the red, green, blue, and alpha color values for the custom color. The Signal Start Event element and label change to that color.
      Reset to the default color: Click the
      icon to reset the Signal Start Event element and label to its default color.

Replace a Signal Start Event Element with a Different Starting Request Event Element

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

Copy a Signal Start Event Element

Copying a Signal Start Event element copies the original along with its current settings, making it easier and faster to continue designing without adding default elements or connectors with their default settings.
The copied Signal Start Event element displays below the original. Any Sequence Flow and/or Message Flow elements incoming to or outgoing from the original are not copied.
Follow these steps to copy a Signal Start Event element in your Process model:
    1.
    View your Processes. The Processes page displays.
    2.
    Click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
    3.
    Select the Signal Start Event element to copy. Available options display above the selected element.
    4.
    Click the Copy Element icon
    . The Process model element copies.

Delete a Signal Start Event Element

Deleting a Process model element also deletes any Sequence Flow elements incoming to or outgoing from that element. For example, if a Process model element is deleted that has both incoming and outgoing Sequence Flow elements, the Sequence Flow elements must be reconnected for the remaining elements/connectors.
Follow these steps to delete a Signal Start Event element from your Process model:
    1.
    View your Processes. The Processes page displays.
    2.
    Click the Open Modeler icon
    to edit the selected Process model. Process Modeler displays.
    3.
    Select the Signal Start Event element to delete. Available options display above the selected element.
    4.
    Click the Delete icon
    . The Process model element deletes.

Settings

The Signal Start 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 a Signal Start Event element:
    1.
    Select the Signal Start Event element from the Process model in which to edit its name. Panels to configure this element display.
    2.
    Expand the Configuration panel if it is not presently expanded. 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

A Signal Start Event element starts a Request for a Process when it triggers by receiving a specific Signal from a broadcasting element in any other Request. The element that broadcasts the Signal does not need to be in the same Process model as the Signal Start Event element to receive the broadcast. Select the Signal that triggers this element.
Follow these steps to select the Signal that triggers the Signal Start Event element:
    1.
    Select the Signal Start Event element from the Process model in which to select the Signal that triggers it. Panels to configure this element display.
    2.
    Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting.
    3.
    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 icon
        beside 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 in this ProcessMaker instance. 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:
        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 in this ProcessMaker instance. 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.

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

When the Signal Start 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 new Request that the Signal Start Event element starts.
Follow these steps to enter the Request variable to store the broadcasting Signal's payload:
    1.
    Select the Signal Start Event element from the Process model in which to enter the Request variable. Panels to configure this element display.
    2.
    Expand the Configuration panel if it is not presently expanded, and then locate the Request Variable setting.
    3.
    In the Request Variable setting, enter the name of the Request Variable to store the broadcasting Signal's payload and then press Enter.

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. Panels to configure this element display.
    2.
    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.
    3.
    Click the menu icon
    beside the Signal drop-down menu. All Signals configured display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.
    4.
    Click the Edit icon
    that displays beside each Signal to edit that signal. The Name setting displays the name of that Signal.
    5.
    In the Name setting, edit the name of the Signal as necessary.
    6.
    Click Save.
    7.
    Save your Process model. The name of the Signal also changes in Signal Manager.

Delete a Signal from the ProcessMaker 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 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. Panels to configure this element display.
    2.
    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.
    3.
    Click the menu icon
    beside the Signal drop-down menu. All Signals configured display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.
    4.
    Click the Delete icon
    that 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 instance, that Signal cannot be deleted. A message displays by which element(s) subscribes to this Signal.
    5.
    Click Delete.
    6.
    Save your Process model. The Signal is also deleted from Signal Manager.

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.

ProcessMaker 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.
    Select the element from the Process model in which to edit its description. Panels to configure this element display.
    2.
    Expand the Documentation panel if it is not presently expanded. The Description setting displays.
    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.
        Select the required text from the Rich Text control.
        2.
        Click on the
        icon. 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 icon
      to 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 icon
        to 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 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 Signal Start Event element:
    1.
    Select the Signal Start Event element from the Process model in which to edit its identifier value. Panels to configure this element display.
    2.
    Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
    3.
    In the Node Identifier setting, edit the Signal Start Event element's identifier to a unique value from all nodes in the Process model and then press Enter.

Related Topics

Last modified 2mo ago