Branch Split Operator

Prev Next

A static image displaying the Brach Split operator and its Info window.The Branch Split operator executes different processes based on your criteria. The Branch Split operator has two different outputs. The Condition determines the output path your data takes. If your input matches your Condition, the operator returns True. From there, your data follows one of the possible paths. If your input does not match, the operator returns False, choosing the second path. Only one process can function at a time, and blocks the other.

The Branch Split operator works best with the Branch Merge operator. The Branch Split operator completes one of two different processes based on your criteria. The Branch Merge operator merges these two processes into a single output. While you can use the Branch Split operator on its own, you'll likely want to pair it with the Branch Merge operator.

For some applications, you might display different information based on end-user input. The Branch Split operator can take end-user input as your criteria. You can then add different content based on whether it does or does not meet the criteria. You'll end each process with the same output using the Branch Merge operator.

You’ll find the Branch Split operator under the Gateways group to the left of the Data Workflow canvas.

Similar Data Workflow Operators

The Branch Split operator is similar to the Decision and Filter operators. Here are the operators compared:

  • Branch Split operator: Pairs with the Branch Merge operator. Splits a single input into two possible pathways based on criteria. The Branch Split operator only takes one pathway and blocks the other.

  • Branch Merge operator: Merges the split pathways from the Branch Split operator.

  • Decision operator: Completes different processes based on criteria, like the Branch Split operator, but the Decision operator does not require a merge operation to combine its pathways into a single output.

  • Filter operator: Completes different processes based on the criteria. If the input matches the criteria, your data takes one path. If the input does not match the criteria, your data takes a different path. The Filter operator does not block its outputs.

About the Info Window

And here's a breakdown of each setting in the Info window:

Setting

Description

Category

Grayed out and non-adjustable setting indicating the operation type.

Label

Sets the label for your operator, displaying below the operator on your Data Workflow canvas.

This field is optional, but set a label if you use more than one of the same operator type. A label helps you identify your operators without opening any Info windows.

Do Not Sanitize Formula

When this checkbox is clear, the operator cleans values coming into or defined in the operator. For example, removing special characters. Some of those special characters include ', $, #, and &amp. The operator also cleans up complex values. For example, logically breaking up strings of numbers and letters using underscores. A sample module ID can go from 5f6b4cdfabf886024d4de2d3 to 5f_6b_4cdfabf_886024d_4de_2d_3.

Sanitizing improves performance. But it can also lead to unexpected data behavior. If your Create Field is not behaving as expected, try selecting this box. When selected, the operator uses your values and expressions as-is. This is best when working with complex values or values that should remain unchanged.

By default, this setting is selected, which means the operator does not attempt to sanitize.

Preserve Argument Type

When selected, this setting ensures the argument data type is respected when the operator executes.

Condition

Use this to define the action of the Branch Split operator. Here, you'll enter an argument (_arg) or Condition expression (<, >, =, >=, <=).

If the Input meets the Condition, it'll return True. Then, the Branch Split operator passes the input value to the upper-right output node. If the input does not meet the Condition, it'll return False and pass it to the lower-right output node.

The Branch Split operator output only passes data to one of the two output nodes. The input cannot pass through both outputs at the same time.

Adding a Branch Split Operator

In this example, you’ll design a dynamic applicant information form that adapts based on age. The form begins by capturing the applicant’s age and classifying it as either an adult or a minor. The adult and minor are guided through different sets of questionnaires. Once the application is complete, a Submit button is enabled.

Configure an HTML Element Component

  1. In the Module Builder, drag and drop an HTML Element component onto your canvas.

  2. In the Property ID field, enter formTitle.

  3. In the Content field, enter Application Information Form.

  4. In the Tag field, enter h2.

  5. Click Save Component.

Configure Two Text Field Components

  1. Drag and drop two Text Field components onto your canvas, placing them below the formTitle HTML Element component.

  2. In the Property ID and Label Text fields, enter the following for each component:

    #

    Property ID

    Label Text

    1

    firstName

    Applicant First Name

    2

    lastName

    Applicant Last Name

  3. Click Save Component after adding each component.

Configure the Number Component

  1. Drag and drop a Number component onto your canvas, placing it below the lastName Text Field component.

  2. In the Property ID field, enter age.

  3. In the Label Text field, enter Applicant Age.

  4. Click Save Component.

Configure Two Field Group Components

  1. Drag and drop two Field Group components onto your canvas, placing them below the age Number component.

  2. In the Property ID and Canvas Label Text fields, enter the following for each component:

    #

    Property ID

    Canvas Label Text

    1

    fgAdultQuestions

    Adult Questionnaire

    2

    fgMinorQuestions

    Minor Questionnaire

  3. Set Hide All Nested Fields to A toggle switch icon indicating an on state for user interface settings. (ON) for each component.

  4. Click Save Component after adding each component.

Configure the fgAdultQuestions Field Group Component

Next, let’s add the input fields that are stored in the fgAdultQuestions Field Group component.

  1. Drag and drop two Radio Buttons components inside the fgAdultQuestions Field Group component.

  2. In the Property ID and Label Text fields, enter the following for each component:

    #

    Property ID

    Label Text

    1

    employmentStatus

    Are you currently employed?

    2

    financialIndependence

    Do you manage your own expenses?

  3. Click Save Component as you add each component.

  4. Drag and drop a Text Area component inside the fgAdultQuestions Field Group component, placing it below the financialIndependence Radio Buttons component.

  5. In the Property ID field, enter futurePlans.

  6. In the Label Text field, enter Write about your higher education or career plans.

  7. Click Save Component.

Configure the fgMinorQuestions Field Group Component

  1. Drag and drop two Text Field components inside the fgMinorQuestions Field Group component.

  2. In the Property ID and Label Text fields, enter the following for each component:

    #

    Property ID

    Label Text

    1

    educationLevel

    What is your current education level?

    2

    favoriteSubjects

    What are your favorite subjects?

  3. Click Save Component as you add each component.

  4. Drag and drop a Text Area component inside the fgMinorQuestions Field Group component, placing it below the favoriteSubjects Text Field component.

  5. In the Property ID field, enter aspirations.

  6. In the Label Text field, enter What do you want to do when you graduate high school? .

  7. Click Save Component.

Configure a Button Component

  1. Drag and drop a Button component onto the canvas, placing it below the fgMinorQuestions Field Group component.

  2. In the Property ID field, enter btnSubmit.

  3. Set Disable User Input to A toggle switch icon indicating an on state for user interface settings. (ON).

  4. Under the Formatting section, set Button Width as Block.

  5. Click Save Component.

Configure a Data Workflow Component

  1. Drag and drop a Data Workflow component onto the canvas, placing it below the age Number component.

  2. In the Property ID and Canvas Label Text fields, enter dwfAdultOrMinor.

Configure an Input Operator

  1. Drag and drop an Input operator onto the Data Workflow canvas.

  2. Configure the operator’s Info window as follows:

    Setting

    Value

    Category

    Input

    Component

    age

    Required

    Yes

    Source

    Default

Configure a Branch Split Operator

  1. Drag and drop a Branch Split operator onto the Data Workflow canvas.

  2. Configure the operator’s Info window as follows:

    Setting

    Value

    Category

    Branch Start

    Component

    Adult or Minor?

    Do Not Sanitize Formula

    (checked)

    Preserve Argument Type

    (checked)

    Condition

    A>17

  3. Connect the output port (right) of the age Input operator to the input port (left) of the Adult or Minor? Branch Split operator.

Configure Four Set Outputs Operators

  1. Drag and drop two Set Outputs operators onto the Data Workflow canvas.

  2. Configure the operator’s Info window as follows:

    Component

    Action

    Set Value

    fgAdultQuestions

    hidden

    false

    fgMinorQuestions

    visible

    false

  3. Connect the upper output port (right) of the Adult or Minor? Branch Split operator to the input port (left) of the fgAdultQuestions and fgMinorQuestions Set Outputs operators.

  4. Drag and drop two Set Outputs operators onto the Data Workflow canvas.

  5. Configure the operator’s Info window as follows:

    Component

    Action

    Set Value

    fgMinorQuestions

    hidden

    false

    fgAdultQuestions

    visible

    false

  6. Connect the lower output port (right) of the Adult or Minor? Branch Split operator to the input port (left) of the fgAdultQuestions and fgMinorQuestions Set Outputs operators.

Configure a Branch Merge Operator

  1. Drag and drop a Branch Merge operator onto the Data Workflow canvas.

  2. Configure the operator’s Info window as follows:

    Setting

    Value

    Category

    Branch End

    Label

    Merge

    Preserve Argument Type

    (unchecked

  3. Connect the upper output port (right) of the Adult or Minor? Branch Split operator to the upper input port (left) of the merge Branch Merge operator.

  4. Connect the lower output port (right) of the Adult or Minor? Branch Split operator to the lower input port (left) of the merge Branch Merge operator.

Configure a Set Outputs operator

  1. Drag and drop a Set Outputs operator.

  2. Configure the operator’s Info window as follows:

    Setting

    Value

    Category

    Set Outputs

    Component

    btnSubmit

    Action

    disabled

    Set Value

    false

  3. Connect the output port (right) of the merge Branch Merge operator to the input port (left) of the btnSubmit Set Outputs operator.

  4. Click Save Component.

    A static image displaying the configuration of the dwfAdultOrMinor Data Workflow in the UDesigner.

  5. Save your module.

Here’s how the completed module looks in the Module Builder:

A static image displaying the module in the UDesigner.

Preview your module in Express View to view the functionality:

Open the DevTools Console and view the data:

A static image displaying the DevTools Console.

A static image of the Branch Split operator and its Info window in the Classic Designer.

The Branch Split operator executes different processes based on your criteria. The Branch Split operator has two different outputs. The Condition determines the output path your data takes. If your input matches your Condition, the operator returns True. From there, your data follows one of the possible paths. If your input does not match, the operator returns False, choosing the second path. Only one process can function at a time, and blocks the other.

The Branch Split operator works best with the Branch Merge operator. The Branch Split operator completes one of two different processes based on your criteria. The Branch Merge operator merges these two processes into a single output. While you can use the Branch Split operator on its own, you'll likely want to pair it with the Branch Merge operator.

For some applications, you might display different information based on end-user input. The Branch Split operator can take end-user input as your criteria. You can then add different content based on whether it does or does not meet the criteria. You'll end each process with the same output using the Branch Merge operator.

You’ll find the Branch Split operator under the Gateways group to the left of the Data Workflow canvas.

Similar Data Workflow Operators

The Branch Split operator is similar to the Decision and Filter operators. Here are the operators compared:

  • Branch Split operator: Pairs with the Branch Merge operator. Splits a single input into two possible pathways based on criteria. The Branch Split operator only takes one pathway and blocks the other.

  • Branch Merge operator: Merges the split pathways from the Branch Split operator.

  • Decision operator: Completes different processes based on criteria, like the Branch Split operator, but the Decision operator does not require a merge operation to combine its pathways into a single output.

  • Filter operator: Completes different processes based on the criteria. If the input matches the criteria, your data takes one path. If the input does not match the criteria, your data takes a different path. The Filter operator does not block its outputs.

About the Info Window

And here's a breakdown of each setting in the Info window:

Setting

Description

Category

Grayed out and non-adjustable setting indicating the operation type.

Label

Sets the label for your operator, displaying below the operator on your Data Workflow canvas.

This field is optional, but set a label if you use more than one of the same operator type. A label helps you identify your operators without opening any Info windows.

Do Not Sanitize Formula

When this checkbox is clear, the operator cleans values coming into or defined in the operator. For example, removing special characters. Some of those special characters include ', $, #, and &amp. The operator also cleans up complex values. For example, logically breaking up strings of numbers and letters using underscores. A sample module ID can go from 5f6b4cdfabf886024d4de2d3 to 5f_6b_4cdfabf_886024d_4de_2d_3.

Sanitizing improves performance. But it can also lead to unexpected data behavior. If your Create Field is not behaving as expected, try selecting this box. When selected, the operator uses your values and expressions as-is. This is best when working with complex values or values that should remain unchanged.

By default, this setting is selected, which means the operator does not attempt to sanitize.

Preserve Argument Type

When selected, this setting ensures the argument data type is respected when the operator executes.

Condition

Use this to define the action of the Branch Split operator. Here, you'll enter an argument (_arg) or Condition expression (<, >, =, >=, <=).

If the Input meets the Condition, it'll return True. Then, the Branch Split operator passes the input value to the upper-right output node. If the input does not meet the Condition, it'll return False and pass it to the lower-right output node.

The Branch Split operator output only passes data to one of the two output nodes. The input cannot pass through both outputs at the same time.

Adding a Branch Split Operator

In this example, you’ll design a dynamic applicant information form that adapts based on age. The form begins by capturing the applicant’s age and classifying it as either an adult or a minor. The adult and minor are guided through different sets of questionnaires. Once the application is complete, a Submit button is enabled.

Configure an HTML Element Component

  1. In the Module Builder, drag and drop an HTML Element component onto your canvas.

  2. In the Property ID field, enter formTitle.

  3. In the Content field, enter Application Information Form.

  4. In the Tag field, enter h2.

  5. Click Save & Close.

Configure two Text Field Components

  1. Drag and drop two Text Field components onto your canvas, placing them below the formTitle HTML Element component.

  2. In the Property ID and the Label Text fields, enter the following for each component:

    Property ID

    Label Text

    firstName

    Applicant First Name

    lastName

    Applicant Last Name

  3. Click Save & Close for each component as you add it.

Configure the Number Component

  1. Drag and drop a Number component onto your canvas, place it below the lastName Text Field component.

  2. In the Property ID field, enter age.

  3. In the Label Text field, enter Applicant Age.

  4. Click Save & Close.

Configure Two Field Group Components

  1. Drag and drop two Field Group components onto your canvas, placing them below the age Number component.

  2. In the Property ID and Canvas Label Text fields, enter the following for each component:

    Property ID

    Canvas Label Text

    fgAdultQuestions

    Adult Questionnaire

    fgMinorQuestions

    Minor Questionnaire

  3. Set Hide All Nested Fields to (ON) for each component.

  4. Click Save & Close for each component as you add it.

Configure the fgAdultQuestions Field Group Component

Next, let’s add the input fields that are stored in the fgAdultQuestions Field Group component.

  1. Drag and drop two Radio Buttons components inside the fgAdultQuestions Field Group component.

  2. In the Property ID and Label Text fields, enter the following for each component:

    #

    Property ID

    Label Text

    1

    employmentStatus

    Are you currently employed?

    2

    financialIndependence

    Do you manage your own expenses?

  3. Click Save & Close as you add each component.

  4. Drag and drop a Text Area component into the fgAdultQuestions Field Group component, placing it below the financialIndependence Radio Buttons component.

  5. In the Property ID field, enter futurePlans.

  6. In the Label Text field, enter Write about your higher education or career plans.

  7. Click Save & Close.

Configure the fgMinorQuestions Field Group Component

  1. Drag and drop two Text Field components inside the fgMinorQuestions Field Group component.

  2. In the Property ID and Label Text fields, enter the following:

    #

    Property ID

    Label Text

    1

    educationLevel

    What is your current education level?

    2

    favoriteSubjects

    What are your favorite subjects?

  3. Click Save & Close as you add each component.

  4. Drag and drop a Text Area component into the fgMinorQuestions Field Group component, placing it below the favoriteSubjects Text Field component.

  5. In the Property ID field, enter aspirations.

  6. In the Label Text field, enter What do you want to do when you graduate high school? .

  7. Click Save & Close.

Configure a Button Component

  1. Drag and drop a Button component onto the canvas, placing it below the fgMinorQuestions Field Group component.

  2. In the Property ID field, enter btnSubmit.

  3. Set Disable User Input to (ON).

  4. Under the Formatting section, set Button Width to Block.

  5. Click Save & Close.

Configure a Data Workflow Component

  1. Drag and drop a Data Workflow component onto the canvas, placing it below the age Number component.

  2. In the Property ID and Canvas Label Text fields, enter dwfAdultOrMinor.

Configure an Input Operator

  1. Drag and drop an Input operator onto the Data Workflow canvas.

  2. Configure the operator’s Info window as follows:

    Setting

    Value

    Category

    Input

    Component

    age

    Required

    Yes

    Source

    Default

Configure a Branch Split Operator

  1. Drag and drop a Branch Split operator onto the Data Workflow canvas.

  2. Configure the operator’s Info window as follows:

    Setting

    Value

    Category

    Branch Start

    Component

    Adult or Minor?

    Do Not Sanitize Formula

    (checked)

    Preserve Argument Type

    (checked)

    Condition

    A>17

  3. Connect the output port (right) of the age Input operator to the input port (left) of the Adult or Minor? Branch Split operator.

Configure Four Set Outputs Operators

  1. Drag and drop two Set Outputs operators onto the Data Workflow canvas.

  2. Configure the operator’s Info window as follows:

    Component

    action

    setValue

    fgAdultQuestions

    hidden

    false

    fgMinorQuestions

    visible

    false

  3. Connect the upper output port (right) of the Adult or Minor? Branch Split operator to the input port (left) of the fgAdultQuestions and fgMinorQuestions Set Outputs operators.

  4. Drag and drop two Set Outputs operators onto the Data Workflow canvas.

  5. Configure the operator’s Info window as follows:

    Component

    action

    setValue

    fgMinorQuestions

    hidden

    false

    fgAdultQuestions

    visible

    false

  6. Connect the lower output port (right) of the Adult or Minor? Branch Split operator to the input port (left) of the fgAdultQuestions and fgMinorQuestions Set Outputs operators.

Configure a Branch Merge Operator

  1. Drag and drop a Branch Merge operator onto the Data Workflow canvas.

  2. Configure the operator’s Info window as follows:

    Setting

    Value

    Category

    Branch End

    Label

    Merge

    Preserve Argument Type

    (unchecked

  3. Connect the upper output port (right) of the Adult or Minor? Branch Split operator to the upper input port (left) of the merge Branch Merge operator.

  4. Connect the lower output port (right) of the Adult or Minor? Branch Split operator to the lower input port (left) of the merge Branch Merge operator.

Configure a Set Outputs operator

  1. Drag and drop a Set Outputs operator.

  2. Configure the operator’s Info window as follows:

    Setting

    Value

    Category

    Set Outputs

    Component

    btnSubmit

    Action

    disabled

    Set Value

    false

  3. Connect the output port (right) of the merge Branch Merge operator to the input port (left) of the btnSubmit Set Outputs operator.

  4. Click Save.

    A static image displaying the configuration of the dwfAdultOrMinor Data Workflow in the UDesigner.

  5. Save your module.

Here’s how the completed module looks in the Module Builder:

A static image displaying the module in the Classic Designer.Preview your module in Express View to view the functionality:

Open the DevTools Console and view the data:

A static image displaying the DevTools Console.