Taskflows > Taskflows > Parameter set
  

Parameter set

A parameter set is a list of user-defined parameters and their associated values.
You can assign a parameter set to provide values for taskflow input parameters and run a taskflow. You can use a parameter set to define values that you want to update without having to edit the taskflow. The taskflow reads parameters from the parameter set, and when the taskflow runs, the values are applied.

Parameter set requirements

You can reuse parameter sets across taskflows. You can also define parameters for Subtaskflow steps in a taskflow. To reuse a parameter set, define local and global parameters within a parameter set.
You can group parameters in different sections of the parameter set. Each section is preceded by a heading that identifies the project, folder, and assets to which you want to apply the parameter values. You define parameters directly below the heading, entering each parameter on a new line.
The following table describes the headings that define each section in the parameter set and the scope of the parameters that you define in each section:
Heading
Description
#USE_SECTIONS
Use this heading as the first line of a parameter set that contains sections. Otherwise, the taskflow reads only the first global section and ignores all other sections.
[Global]
Defines parameters for all projects, folders, taskflows, and Subtaskflow steps.
[project name].[folder name].[taskflow name]
-or-
[project name].[taskflow name]
Defines parameters for a specific taskflow.
If a parameter is defined in a taskflow section and in a global section, the value in the taskflow section overrides the global value. If a parameter value is not defined in the taskflow section, the global value is considered.
[project name].[folder name].[taskflow name].[subtaskflow step name]
-or-
[project name].[taskflow name].[subtaskflow step name]
Defines parameters for a specific Subtaskflow step.
If a parameter is defined in a Subtaskflow step section and in a global section, the value in the Subtaskflow step section overrides the global value.
If a parameter is defined in a Subtaskflow step section and in a taskflow section, and the taskflow uses the Subtaskflow step, the value in the Subtaskflow step section is considered.
If a parameter value is not defined in the Subtaskflow step or in the taskflow section, the global value is considered.
If the parameter set does not contain sections, the taskflow reads all parameters as global.
Precede the parameter name with two dollar signs, as follows:
$$<parameter>
Define parameter values as follows:
$$<parameter>=value1
$$<parameter2>=value2
The parameter value includes any characters after the equals sign (=), including leading or trailing spaces. Parameter values are treated as string values.

Parameter scope

When you define values for the same parameter in multiple sections in a parameter set, the parameter with the smallest scope takes precedence over parameters with a larger scope.
In this case, the taskflow gives precedence to parameter values in the following order:
  1. 1Value defined in the Subtaskflow step section.
  2. 2Values defined in a taskflow section.
  3. 3Values defined in the #USE_SECTIONS section.
  4. 4Values defined in a global section.
If you define a parameter in a Subtaskflow step section and in a taskflow section, and the taskflow uses the Subtaskflow step, the taskflow uses the parameter value defined in the Subtaskflow step section.
For example, consider a taskflow that contains a Subtaskflow step named Subtaskflow step1 as shown in the following image:
The image shows a taskflow that contains a Subtaskflow step.
You define the following parameter values in a parameter set:
#USE_SECTIONS
$$input=employee_table
[GLOBAL]
$$location=USA
$$department=R&D
[Default].[Folder1].[TaskflowA]
$$input=Leads_table
$$department=HR
$$designation=Manager
[Default].[Folder1].[TaskflowA].[Subtaskflow step1]
$$input=Associates_table
$$department=Finance
TaskflowA contains Subtaskflow step1.
When you run TaskflowA, TaskflowA uses the following parameter values:
Parameter
Section
Value
$$input
[Default].[Folder1].[TaskflowA]
Leads_table
$$department
[Default].[Folder1].[TaskflowA]
HR
$$location
[GLOBAL]
USA
When you run Subtaskflow step1, the taskflow uses the following parameter values:
Parameter
Section
Value
$$input
[Default].[Folder1].[TaskflowA].[Subtaskflow step1]
Associates_table
$$department
[Default].[Folder1].[TaskflowA].[Subtaskflow step1]
Finance
$$location
[GLOBAL]
USA
$$designation
[Default].[Folder1].[TaskflowA]
Manager
For all other assets that contain the $$input parameter, the taskflow uses the value employee_table.

Sample parameter set

The following example shows a sample parameter set that contains parameter values for a taskflow:
#USE_SECTIONS
$$input=customer_table
[GLOBAL]
$$Country=USA

[Project1].[Folder1].[Taskflow1]
$$FirstName=John
$$LastName=Williams
$$State=Karnataka
$$Country=India

$$Company=CompanyA
$$ShippingID=1234
$$CustomerID=1
$$ContactNumber=1234567890

[Project1].[Folder1].[Taskflow1].[Subtaskflow1]
$$FirstName=Jones
$$LastName=Greg
$$ContactNumber=0123456789
$$ShippingID=4321

The taskflow uses parameters to pass different values for the country, state, first name, last name, shipping ID, customer ID, and contact number.

Rules and guidelines for parameter sets

Consider the following rules and guidelines when you use parameter sets in taskflows: