Exclusive Gateway Node

Estimated Reading Time:  9 minutes

Overview

A static image displaying the Exclusive Gateway node.

The Exclusive Gateway node uses conditional logic in workflow links to direct a workflow down a specific path. For example, you can use an Exclusive Gateway node to direct an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. to a different Task node depending on their specified age. An Exclusive Gateway node can direct a workflow between two or more paths.

Exclusive Gateway nodes include a single input port on the left side and a single output port on the right side. Connecting an Exclusive Gateway node to another node creates an Exclusive Gateway link. Specify logic in the Exclusive Gateway link to dictate which path the workflow travels through. When your workflow reaches an Exclusive Gateway node, it follows the first Exclusive Gateway link it evaluates as true.

You can also set an Exclusive Gateway link as default. If no other links evaluate as true, the workflow follows the default link. A good use for default links is when customizing a navigation bar in Express View.

You'll find the Exclusive Gateway node in the list of nodes to the left of the Workflow Builder.

What You'll Learn

In this article, you'll learn about the Exclusive Gateway node's settings, how to use them in a workflow, and apply best practices.

Settings Menu Description

Next, let's explore the node's Settings Menu. This menu appears as a blue menu bar, either above or below the node, when selected. The End node has these Settings Menu options:

Setting Description

Edit

Takes you to the Edit Exclusive Gateway window, where you can configure related settings.

Delete

Removes the node from the workflow.

Edit Exclusive Gateway Window Description

Clicking the Edit button displays the Edit Exclusive Gateway window.

The following settings are available in the Edit Exclusive Gateway window:

A static image displaying the Exclusive Gateway node default settings window.

Setting

Description

Label

Sets the name of your node. By default, the Label displays as exclusive-gateway-1. This label is optional and displays below the node once set.

Define your labels by associating them with the role of the node.

Error Message

This message lets end-users know when there's a break in the logic. If you do not set an error message, the default message "An error has occurred: No Exclusive Gateway result found." is shown.

Output Links

Displays the logic and linked node for each path from the Exclusive Gateway node. You can edit each item from here.

NOTE  If you see Output Links without an Edit button, you have not set up Exclusive Gateway links for this Exclusive Gateway Node.

Edit

Click an output link Edit button to edit it. Click this button to open the Edit Exclusive Gateway Link window.

X (Close)

Closes the Edit window, returning your focus to the pool.

Exclusive Gateway Links Settings Menu

Selecting an Exclusive Gateway link opens a Settings Menu. This menu displays as a blue menu bar, above the link indicator. The menu has the following options:

Setting Description

Edit

Opens the Edit Exclusive Gateway Link window. From there, you can configure settings relating to the Exclusive Gateway link.

Delete

Removes the link from the workflow.

Edit Exclusive Gateway Link Window Description

Clicking the Edit button displays the Edit Inclusive Gateway Split Link window.

Setting Description

Label

The name applied to the link. This label is optional and displays below the link once set.

Labels should be user-friendly and well-associated with the role of the node.

Status

You can enter a text value here.

Other components can query the Status value of a link. When the workflow passes the link, the Status value populates with the Status field text.

Logic

Sets the logic for the Exclusive Gateway link. The Exclusive Gateway link icon changes from unlinked (unlinked) to linked (linked) when logic is present.

The expression typically consists of a Property ID, an operator, and criteria (value) for matching. For example:

  • propertyId='string'
  • propertyId>100
  • propertyId=TRUE

The Logic field also supports Excel formulas. For example:

  • EXACT(propertyId,'value')

  • ISNUMBER(propertyId)

  • SUM(propertyId, propertyId)

NOTE  Expressions that begin with an equal sign (=) are also valid. For example, =EXACT(propertyId,'value') and EXACT(propertyId,'value') evaluate the same way.

TIP  If you want your workflow to always follow a given path, you can enter TRUE in the link's Logic field. Because you've hardcoded the value, the logic always evaluates as true.

The Property ID should reference a field accessible to your workflow, for example, a field present in the workflow submission. The Logic field autosuggests Property ID values as you type.

NOTE  When entering a Property ID in your logic expression you don't need to include data. as a prefix.

TIP  You can use dot notation to reference keys under a given Property ID. For example, referencing a key/value pair in an object.

Logic expressions support the following operators: =, <, >, >=, <=.

When entering the criteria (value) the formula matches against, you can use a string, number, or Boolean value. You must wrap strings in single (') or double (") quotes. Numerical values do not need quotes. To reference Boolean values, use TRUE or FALSE.

Default

This setting makes this link the Default link. If no other links evaluate as true, the workflow follows the Default link. You may only have a single Default link per Exclusive Gateway node.

When the Default setting is  (ON), you can’t enter a logic expression for the link.

The Default setting is  (OFF) by default.

Unidirectional

Sets the link one-way. End-users can't navigate back through a unidirectional link.

The link has a double arrowhead when the Unidirectional setting is  (ON).

The link has a single arrowhead when the Unidirectional setting is  (OFF).

By default, the Unidirectional setting is OFF.

Use Flash Message

When set to ON, you can create a flash message for this link. Flash Messages are alerts that display at the top of the workflow in Express View. They show when an end-user navigates past a link that has a Flash Message enabled.

By default, the Use Flash Message setting is  (OFF).

Flash Message

This setting displays when the Use Flash Message setting  (ON).

Enter a custom flash message for the alert.

Make Flash Message Dismissible

This setting displays when the Use Flash Message setting is  (ON).

When set to  (ON), your end-user can manually dismiss the flash message. To dismiss the flash message, end-users can click the X button on the flash message. When set to  (OFF), the Flash Message disappears on its own.

NOTE  This setting is not currently working as intended. Flash Messages remain on-screen until manually dismissed.

Message Status

This setting displays when the Use Flash Message setting is  (ON).

Select a message status for your flash message. The message status affects the styling of your flash message. The drop-down options are:

  • Success: The flash message is light green.

  • Info: The flash message is light blue.

  • Danger: The flash message is red.

Adding an Exclusive Gateway Node with Exclusive Gateway Links

For this use case, create a workflow that verifies if an end-user is of legal age to apply for membership. If the end-user is under 18 years old, the workflow directs them to a Task node notifying them they are not eligible. If the end-user is older than 18 years old, the workflow directs them to a Task node telling them that a manager has been notified to review their application.

This use case assumes that you’ve set up your modules in advance and that you have a new workflow open.

What You'll Need

To set up this use case, you’ll need:

Configure the Authenticated Task Nodes

First, add three Task nodes to the Authenticated swimlane.

1. Drag and drop three Task  nodes into the Authenticated swimlane.
2. Select the first Task node and click Edit.
3. In the Label field, enter Intake Form.
4. From the Module drop-down, enter Enablement Lab: Exclusive Gateway Node - Intake Form.
5. Click X (Close).
6. Repeat this process for the other Task nodes using the following information:

Label

Module

Notify Manager

Enablement Lab: Exclusive Gateway Node - Notify Manager

Decline membership

Enablement Lab: Exclusive Gateway Node - Decline Membership

7. Connect the output port (right) of the Start node to the input port (left) of the Intake Form  Task node.

NOTE  You'll connect the remaining Task nodes at a later stage.

Configure the Automated Task Node

Next, add one Task node to the Automated swimlane. This Task node links to a module that calculates the end-user's age.

1. Drag and drop a Task  node into the Automated swimlane.
2. In the Label field, enter Age Check
3. From the Module drop-down, enter or select Enablement Lab: Exclusive Gateway Node - Age Check.
4. Click X (Close).
5. Connect the output port (right) of the Intake Form  Task node to the input port (left) of the Age Check  Task node.

NOTE  You'll connect the remaining Task nodes at a later stage.

Configure the Exclusive Gateway Node

Add the first Exclusive Gateway node. This Exclusive Gateway splits your workflow between end-users that over or under the age of 18. For valid adults, your workflow advances to notify them the manager has received their application. If the end-user is underage, they reach a Task node informing them that they cannot complete the application.

1. Drag and drop an Exclusive Gateway node into the Automated swimlane.
2. Click Edit.
3. In the Label field, enter Age Check Gateway.
4. Click X (Close).
5. Connect the output port (right) of the Age Check  Task node to the input port (left) of the Age Check Gateway Exclusive Gateway node.
6. Connect the output port (right) of the Age Check Gateway Exclusive Gateway node to the input port (left) of the Notify Manager  Task node. This connector becomes an Exclusive Gateway Link.
7. Connect the output port (right) of the Age Check Gateway Exclusive Gateway node to the input port (left) of the Decline Membership  Task node. This connector becomes an Exclusive Gateway Link.
8. For each Exclusive Gateway Link, click Edit and configure as follows:
Exclusive Gateway Link Label Logic

Age Check Gateway to Notify Manager Task

ofAge=Yes

ofAge='yes'

Age Check Gateway to Decline Membership Task

ofAge=No

ofAge='no'

The gateway link icon changes to after adding a logic argument.

TIP  To learn more about workflow links, visit our Workflow Links article.

9. Click X (Close).

Configure the End Node

After informing the end-user that the Manager has been notify, the End node finishes the workflow.

1. Drag and drop an End  node in the pool, placing the node in the Automated swimlane.
2. Click Edit.
3. In the Label field,
4. Connect the output port (right) of the Notify Manager  Task node to the input port (left) of the End  End node.
5. Click X (Close).

Configuring the Handoff Node

After informing the end-user they cannot continue, the Handoff node redirects them to the beginning of the workflow.

1. Drag and drop a Handoff   node into the Authenticated swimlane.
2. Click Edit.
3. In the Label field, enter Redirect.
4. Connect the output port (right) of the Decline Membership  Task node to the input port (left) of the Redirect  Handoff node.
5. Click X (Close).
6. Click Save....
7. Save your workflow.

Your workflow looks like this when completed:

A static image displaying a completed workflow using the Exlusive Gateway node.

Resources