ProcessMaker 4.1
ProcessMaker API Documentation
ProcessMaker Examples
Powered By GitBook
Pool and Lane Elements
Add, resize, delete, and configure Pool and Lane elements in your Process model.

Don't Know What a Pool Element Is?

See Process Modeling Element Descriptions for a description of the Pool element.

Permissions Required

Your user account or group membership must have the following permissions to configure a Pool or Lane 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 Pool Element to the Process Model

Follow these steps to add a Pool 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 Pool 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 Pool element's icon
    .
    4.
    Drag the element into the Process model canvas where you want to place it. If non-Pool/Lane elements or controls are in your Process model when you place the Pool element, those elements are automatically placed into the Pool element. A Pool element cannot be placed into another Pool element, though the most recently placed Pool element can overlap another such that only the recent Pool element and its contents is visible.
Pool element
After the element is placed into the Process model, you may adjust its location in the following ways:

Elements Placed Into a Pool Element Cannot Be Moved Out of It

If a non-Pool element is placed into a Pool element, that element cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places that element inside the Pool element closest to where you attempt to move it.

Deleting a Pool Element Also Deletes All Elements Within It

When a Pool element is deleted, all elements within it are also deleted. If you want to keep the elements within a Pool element, you must add those elements outside of the Pool element prior to deleting the Pool element.
If you accidentally delete a Pool element with other elements you want to keep, then click the Undo button.

Change a Pool Element's Color

The Pool element outline and label are black-colored by default with a gray-colored background. After a Pool element is added to a Process model, its shape, label, and background color can be changed. Element and connector colors may only be changed individually.
Follow these steps to change the color of the outline, label, and background for a Pool 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 Pool 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 Pool element outline, label, and background 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 Pool element outline, label, and background change to that color.
      Reset to the default color: Click the
      icon to reset the Pool element to its default colors.

Resize a Pool Element

Follow these steps to resize a Pool element:
    2.
    Select the Pool element from the Process model to resize. Anchors display on each corner of the Pool element.
    3.
    Click one of the anchors on the Pool element
    , hold your cursor, and then adjust the size of the Pool element on the Process model canvas. If the Pool element contains elements within it prior to resizing, the Pool element only resizes to contain all elements within it. Lane elements automatically adjust to the width of the Pool element, though Lane elements can be resized separately.

Delete a Pool Element

When a Pool element is deleted, all elements and connectors within it are also deleted. If you want to keep the elements/controls within a Pool element, you must add those elements/controls outside of the Pool element prior to deleting the Pool element.
If you accidentally delete a Pool element with other elements/connectors you want to keep, then select the Undo button.
Follow these steps to delete a Pool element from a 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 Pool name in the Pool element to delete, thereby selecting the Pool element. Available options display to the right of the selected element.
    4.
    Click the Delete icon
    . The Pool element is deleted. All non-Pool elements and connectors within the Pool element also delete.

Pool Element Settings

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

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 Pool element:
    1.
    Select the Pool 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 Pool element's identifier to a unique value from all nodes in the Process model and then press Enter.

Add a Lane Element to a Pool Element

Don't Know What a Lane Element Is?

See Process Modeling Element Descriptions for a description of the Lane element.
Follow these steps to add a Lane element to a Pool element:
    1.
    View your Processes. The Processes page displays.
    2.
    Click the Open Modeler icon
    for edit the selected Process model. Process Modeler displays.
    3.
    Click the Pool element from the Process model into which to add a Lane element. Icons to add a Lane to a Pool element display.
    4.
    Do one of the following:
      Add a Lane element above existing Lane elements: Click the Lane Above icon
      to add a Lane element above all existing Lane elements. If only the Pool element exists, two Lane elements display.
      Add a Lane element below existing Lane elements: Click the Lane Below icon
      to add a Lane element below all existing Lane elements. If only the Pool element exists, two Lane elements display.

Change a Lane Element's Color

The Lane element outline and label are black-colored by default with a gray-colored background. After a Lane element is added to a Process model, its shape, label, and background color can be changed. Element and connector colors may only be changed individually.
Follow these steps to change the color of the outline, label, and background for a Lane 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 Lane element to change its color. Anchors display on each corner of the Lane element
    . 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 Lane element outline, label, and background 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 Lane element outline, label, and background change to that color.
      Reset to the default color: Click the
      icon to reset the Lane element to its default colors.

Resize a Lane Element

Follow these steps to resize a Lane element:
    2.
    Select the Lane element from the Pool element to resize. Anchors display on each corner of the Lane element
    .
    3.
    Click one of the anchors on the Lane element, hold your cursor, and then adjust the size of the Lane element in the Pool element. If the Lane element contains elements within it prior to resizing, the Lane element only resizes to contain all elements within it. The Pool element automatically adjusts to the width of the resized Lane element so far as all elements contained within the Pool element remain contained in it. Pool elements can be resized separately.

Delete a Lane Element from a Pool Element

Follow these steps to delete a Lane element from a Pool 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 Lane element in the Pool element to delete. Available options display above the selected element.
    4.
    Click the Delete icon
    . The Pool element is deleted. All non-Pool elements and connectors that were within the deleted Lane element stay in their current positions within the Pool element.

Lane Element Settings

The Lane 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.
Follow these steps to enter or edit the name for a Lane element:
    1.
    Select the Lane 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, enter or edit the selected element's name and then press Enter.

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.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Lane element:
    1.
    Select the Lane 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 Lane element's identifier to a unique value from all nodes in the Process model and then press Enter.

Related Topics

Last modified 2mo ago