Skip to main content

Create Helper Flows

Follow the below steps to create a helper flow:

  1. From the explorer menu, right-click Helper Flows and select Add Folder.
  2. Provide a suitable name for the folder. These folders can be used to segregate and categorize the related helper flows together.
  3. Right-click the created folder and select Add.
  4. In the properties panel, configure the properties as required and then click save.
PropertyDescriptionComments
Name*Provide the name of a helper flow.Name must start with a character followed by alphanumeric or '_'. No spaces are allowed. Except underscore (_), no other special characters are allowed. Name cannot start with a number.
GroupName of the folder is displayed here.This property cannot be edited.
Async Operation*Specify whether the flow is an async operation. Either Yes or No.By default, it is set to No.
DescriptionProvide the summary.-
Is ActiveSpecify whether the helper flow is active for accessing. Either Yes or No.By default, it is set to Yes.

Note: An asterisk (*) denotes that the property is mandatory for creating a helper flow.

The "Helper Flow added successfully" message displays upon successful creation.

  1. The helper flow designer canvas shows the Start and Stop constructs by default. From the ribbon, add the required constructs and configure them as required inside the flow to create a logic. For more information on constructs, refer to Configure Constructs.
  2. Click save icon to save a helper flow.

The "Helper Flow updated successfully" message displays upon successful update.

Add Helper Flow Folder

Add Helper Flow

Structure of a Helper Flow​

The created helper flow contains the following:

  • Input Params
  • Output Param
  • Variables
  • Exceptions. A base exception is created by default when a helper flow is created.

Structure of Helper Flow

Add Input Parameters, Output Parameter and Variables​

Users can add the parameters and variables to a helper flow as applicable. To add, follow the below steps:

  1. Right-click the Input Params (or) Output Param (or) Variables and select Add. A pop-up window displays.
  2. Configure the below properties as required and the click Save.
PropertyDescriptionComments
Parameter Name*Provide the name of a parameter.Name must start with a character followed by alphanumeric or '_'. No spaces are allowed. Except underscore (_), no other special characters are allowed. Name cannot start with a number.
Is ArraySpecify whether the parameter is an array or not.By default, it is set to No.
Data Type*Select the data type of the parameter from the drop-down.-

Note: An asterisk (*) denotes that the property is mandatory for creating a parameter or variable.

The success message displays upon successfully adding a parameter or variable.

Add Parameter to Helper Flow

Add Exceptions​

Users can add the exceptions to a helper flow as applicable. To add, follow the below steps:

  1. Right-click Exceptions and select Add. A pop-up window displays.
  2. Configure the below properties as required and the click Save.
PropertyDescriptionComments
Name*Provide the name of the exception.Name must start with a character followed by alphanumeric or '_'. No spaces are allowed. Except underscore (_), no other special characters are allowed. Name cannot start with a number.
Exception*Select the exception from the drop-down.The exceptions created in the Workflow Exceptions folder are available in the drop-down.

Note: An asterisk (*) denotes that the property is mandatory for adding an exception.

Add Exception to Helper Flow

Constructs​

The following are the constructs available in a helper flow:

Constructs in Helper Flows
IfAssignmentForeachBreak
ContinueWhileReturnInitialize
SwitchCall REST APICall Helper FlowRun Query
Run Query AsyncQuery Output MappingBegin TransactionComplete Transaction
C# SnippetLogRaise ExceptionPrepare File Content
Call WorkflowGet Workflow StatusTerminate WorkflowGet Workflow Result
Raise EventWhenAllWhenAnyCreate Anonymous Object
Json ParseJson SearchConvert Json to XmlConvert Xml to Json
Call Aggregate Function