Workflow Branching Feature

TABLE OF CONTENTS

• What is Workflow Branching?
• Detailing the branching conditions
  • Element Presence
  • Label Comparison
  • Spotlight Comparison
  • Custom Script
  • Custom Script Example 
• How to configure branching inside Apty Studio?

What is Workflow Branching?

As per 4.15 release, Apty added the workflow branching feature that enables admins to configure workflow in such a way that it can be branched within the same or to another workflow. Earlier admins could configure workflows for end-users to jump or branch within the same workflow. Admins had to use permalinks for end-users to jump from one workflow to another, but now admins can configure Jump Steps from one workflow to another, without using permalinks.

This feature helps to:

• Connect two different workflows
• Jump from one step to another step based on the business use case.
• Create a set of common steps and use them across workflows.

Workflow branching can be configured based on certain conditions which include:

• Element Presence
• Label Comparison,
• Spotlight Comparison,
• Custom Script.

Whenever these conditions are matched, admins can configure the workflow in such a way that, while executing workflow the end-users can either jump backward or forward in that workflow or to another.

Detailing the branching conditions

Element Presence

When the Element presence condition is selected, the branching is determined by the presence or absence of a selected element. To define the elements of the hosting application which should determine the branching, select Element Presence from the Conditions drop-down list. The control is now passed to the browser window to click on the element of the hosting application to define its significance.

Note:

• The element can be changed by re-selecting.
• One Element Presence condition will define only one element of the host application.
• To define other elements, admins have the option to add more Element Presence conditions.
• Multiple conditions can be added at a time.
  

Label Comparison

Label Comparison is an alternative to the Element Presence condition but on top of checking the presence of a label, it also compares the value in the label. If the value provided by admins while creating the branch (or adding jump steps) matches with the value selected, the workflow will be branched.

• To set up Label Comparison, click Select Label. The control is now passed to the browser window to select the Label.
• Select the access comparison criteria from the drop-down list: Equal, Not Equal, Regex, Contains, Empty Value, Not Empty Value. It will define the relationship between the Label and value based on the defined comparison criterion.
• After that admins need to enter the value, which should match the selected value of the label. 

Note: 

• One Label Comparison condition will define only one element of the host application.
• To define other elements, admins have the option to add more Label Comparison conditions.
  
• Multiple Label Comparison conditions can be added at a time.

Spotlight Comparison

Spotlight comparison follows the same logic as Label Comparison and can be applied to any editable fields or input fields. 

Note: The above conditions will apply to only DOM elements. 

Custom Script

The custom script comes into play for advanced condition control options, such as,

1. Local storage values,

2. Session storage values,

3. Cookies,

4. Window variables, etc.

For the above advanced options, branching can be controlled based on a custom script. The custom script must return true for a workflow to be branched.

Custom Script Example 

To create workflow branching based on a local storage element, we can refer to the following example. Here, we will execute the workflow branching if the department is HR.  

var department = window.localStorage.getItem('department')if(department ==='HR'){returntrue;}else{returnfalse;}

The workflow branching will only be executed if the above script returns true. 

Note: Similarly, multiple conditions can be added targeting other elements in the script. 

How to configure branching inside Apty Studio?