Parameters allow you to define named values and reuse them across tasks, task runs, scripts, macros, and API‑initiated executions.

Parameters enable dynamic, reusable, and configurable workflows directly into tasks. They can be defined at multiple levels and overridden as needed during execution. This allows a single task to be defined in a flexible manner so that it can be used to perform similar, yet different operations depending on context. For example, it is possible to define a task that uses a parameter to define the file directory on an endpoint as the source of files. When the task runs, it will look up the current value of the parameter, and dynamically replace the source directory definition.

Where to use parameters

Parameters can be used anywhere macros are supported, including:
  • File and folder paths
  • Rename patterns
  • Task steps and processes
  • Post‑run actions
  • Scripts
  • API‑initiated task runs

Parameter syntax

When using a parameter in a field that you want to change dynamically as the task runs, use the following syntax: 
[Params:<parameter name>]
Note: The parameter syntax is case-sensitive.

Parameter scope and precedence

Parameters are defined at the following levels, listed from lowest to highest precedence:

  1. Tenant‑level parameters: Defined at the highest level, and available to all tasks. This allows administrators to define default values once and update them in a single location, rather than modifying individual tasks.
  2. Task‑level parameters: Defined on a specific task and override tenant‑level parameters with the same name.
  3. Task‑run parameters: Supplied at execution time and override both tenant‑level and task‑level values. They can be provided when a task is started through the API, defined in a Set Parameter process step within a task, set or updated by a PowerShell script during execution, or supplied in a post‑run Run Task step.

When multiple parameters with the same name exist, the value with the highest precedence is used during task execution. By providing this inheritance functionality, you can create parameters that represent default values at the tenant level, and then override them at the task level, or even at the time of task run.

Parameter limits

The following limits apply:
  • Tenant-level parameters: Up to 10 parameters per tenant
  • Task-level parameters: Up to 10 parameters per task. Each task manages its own set of task‑level parameters independently
  • Task-run parameters: Up to 10 parameters per task run
  • Parameter name: Maximum 50 characters
  • Parameter value: Maximum 150 characters
  • Supported data type: String only. If you need to do math calculation of parameters in a script, they easily convert to numeric types in PowerShell. For more information, see Custom scripts.
While each individual task or task run is limited to 10 parameters, these limits are applied per task, not across the tenant. For example, in a tenant with 100 tasks, each task can define up to 10 task‑level parameters.