Inclusive Gateway Element

Add, copy, delete, change the color, align, and configure Inclusive Gateway elements in your Process model.

Don't Know What an Inclusive Gateway Element Is?

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

Permissions Required

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

Add an Inclusive Gateway element from one of the following locations in Process Modeler:

Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.

Permissions are required to do this.

Follow these steps to add an Inclusive Gateway element from the Explorer panel to the Process model:

Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Locate the Gateway object category from one of the following locations in the Explorer panel:
- Pinned Objects: The Gateway object category displays from the Pinned Objects section when it is pinned. This element type is not pinned by default.
- Object Category: The Gateway object category displays from the Object Category section when it is not pinned.
Click the Gateway object category.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Inclusive Gateway element cannot be placed outside of the Pool element.
Click the Elements drop-down menu, and then select the Inclusive Gateway option.
The Inclusive Gateway element displays.

After the element is placed into the Process model, you may adjust its location in the following ways:

Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.

Moving an Inclusive Gateway element has the following limitations in regards to the following Process model elements:

Pool element: If the Inclusive Gateway 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 Inclusive Gateway element inside the Pool element closest to where you attempt to move it.
Lane element: If the Inclusive Gateway element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Inclusive Gateway element cannot be moved outside of the Pool element.

Replace an Inclusive Gateway Element with a Different Gateway Element

After an Inclusive Gateway element is added to a Process model, you may replace it with a different Gateway type element:

The selected Inclusive Gateway element is replaced by the default settings and color of the replacing element.

Permissions are required to do this.

Follow these steps to replace an Inclusive Gateway element with a different Gateway type element:

Select the Inclusive Gateway element to change to another element. Available options display above the selected element.
Click the Elements icon. The Elements drop-down menu displays the Gateway type elements. Note that the Event-Based Gateway element is only available when the Inclusive Gateway element's outgoing Sequence Flow elements connect with Catch-type Events, such as the Intermediate Signal Catch Event element or the Intermediate Message Catch Event element.
Select the element to replace the Inclusive Gateway element. The Change Type screen displays to confirm replacing the currently selected element.
Click Confirm. The new element replaces the Inclusive Gateway element with its default settings and color.

Change an Inclusive Gateway Element's Color

See Change a Process Model Object's Color.

Copy an Inclusive Gateway Element

See Copy Elements and Connectors into the Clipboard.

Clone an Inclusive Gateway Element

See Clone Elements and Connectors Without the Clipboard.

Delete an Inclusive Gateway Element

See Delete Elements and Connectors.

Settings

The Inclusive Gateway element has the following panels that contain settings:

Configuration panel
- Edit the element name
- Indicate workflow direction
Documentation panel (available when the Documentation package is installed)
- 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.

Permissions are required to do this.

Follow these steps to edit the name for an Inclusive Gateway element:

Select the Inclusive Gateway element 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 element's name and then press Enter.

Indicate Workflow Direction

Indicate if the workflow direction for the Inclusive Gateway is converging or diverging:

Converging workflow (synchronize workflow): An Inclusive Gateway element may synchronize Request workflow from two or more incoming Sequence Flow elements to the Inclusive Gateway element. All incoming Sequence Flow elements converging to the Inclusive Gateway element must trigger before the Inclusive Gateway element triggers, thereby synchronizing a Request's workflow. Use this coordinate workflow.
Diverging workflow (evaluate routing conditions): An Inclusive Gateway element may also evaluate a Request's workflow routing conditions for a Process. These routing conditions are configured on each outgoing Sequence Flow element from the Inclusive Gateway element. When a Request is in progress and the Inclusive Gateway element triggers, each of its outgoing Sequence Flow elements' conditions are evaluated to determine which Sequence Flow element(s) continue routing for that Request. Unlike the Exclusive Gateway element, multiple Sequence Flow elements can trigger from the Inclusive Gateway element, thereby causing multiple workflow routes simultaneously for the same Request that stem from that Inclusive Gateway element. Use an Inclusive Gateway element when you potentially want multiple workflow routes to occur simultaneously in that Request. Otherwise, consider using an Exclusive Gateway element to allow only one Sequence Flow element's condition(s) to continue workflow route for that Request.

One Inclusive Gateway element can only converge or diverge workflow, but not both. Use two Inclusive Gateway elements to both converge and diverge workflow.

Permissions are required to do this.

Follow these steps to indicate the workflow direction for an Inclusive Gateway element:

Select the Inclusive Gateway element from the Process model in which indicate the workflow direction.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Direction setting.
From the Direction drop-down menu, select from one of the following options:
- Diverging: Select the Diverging option to indicate that the workflow direction is for outgoing Sequence Flow elements. When this option is selected, all outgoing Sequence Flow elements are evaluated to determine which trigger based on their specified condition(s). Multiple Sequence Flow elements may be triggered. This is the default option.
- Converging: Select the Converging option to indicate the workflow direction is for incoming Sequence Flow elements. All incoming Sequence Flow elements to the Inclusive Gateway element must trigger before the Inclusive Gateway element triggers.

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.

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:

Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element 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 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.

Permissions are required to do this.

All identifier values for all nodes in the Process model must be unique.

Follow these steps to edit the identifier value for an Inclusive Gateway element:

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