Parameters can be defined at Tenant, Task, and Task-run level. You can define up to 10 parameters per level.

Define tenant‑level parameters

Tenant‑level parameters are defined once and shared across all tasks.

  1. Navigate to System > Tenant Settings.
  2. In the Parameters section, click Edit.
  3. Select from the following options:
    • To add a parameter, click Add Parameter.
      Enter the parameter details:
      • Name
      • Value
    • To edit a parameter, click the more options icon () for the parameter, click Edit.
      • Update the parameter details.
    • To delete a parameter, click the more options icon () for the parameter, click Delete.
      • To confirm, click Delete.
  4. Click Save. Changes are applied immediately and affect all tasks in the tenant.

Tenant‑level parameters are immediately available to all tasks in the tenant.

You can search for parameters when working with parameter lists. The search matches the Name, Value, and Description fields.

Define task‑level parameters

Task‑level parameters apply only to a specific task and override tenant‑level parameters with the same name.

  1. Open a task in Edit mode.
  2. In the right‑hand panel, locate the Parameters section and click the edit icon ().
  3. Select from the following options:
    • To add a parameter, click Add New Parameter.
      Enter the parameter details:
      • Name
      • Value
    • To edit a parameter, click the more options icon () for the parameter, click Edit.
      • Update the parameter details.
    • To delete a parameter, click the more options icon () for the parameter, click Delete.
      • To confirm, click Delete.
  4. Click Save.

You can search for parameters when working with parameter lists. The search matches the Name, Value, and Description fields.

Define task‑run parameters

Task‑run parameters are supplied when a task is executed or during task execution, and apply only to that execution.

Task-run parameters can be supplied or changed in the following cases, providing ultimate flexibility. Any parameters used in this way will override parameters of the same name defined at the tenant or task level.
  • When starting a task via the API, you can optionally send parameters as part of the call. For more information, see API endpoints.
  • When having one task start another task via the Post-run Run Task step, you can also send parameters usable in the next task. They can be based on the value of a macro or parameter in the currently executing task. You can search for parameters when working with parameter lists; the search matches the Name, Value, and Description fields. For more information, see Post run - run task.
  • When using the Set Parameter Process step. For more information, see Process scripts.
  • From within a custom PowerShell script. For more information, see Custom scripts.