Module parameters

With Module parameters, you can parameterize various settings in a Task. Because each Task is part of a Module, you can use the same Module parameter in all Tasks of the Module: This is useful if similar settings in multiple Tasks share the same value (e.g. a specific user name or password).

Configuration

  • On the Settings tab of a Task, you can:
    • Create and insert a new Module parameter manually: Right-click the relevant field, and click Add parameter. This opens the Add Module Parameter window, which allows you to configure the settings of the Module parameter. See Parameters.
    • Create and insert a new Module parameter automatically: Right-click the relevant field and click Insert Parameters > AutoCreate parameter. This automatically creates the suggested parameter.
    • Insert an existing Module parameter (for example, a Module parameter of another Task in the Module), right-click the relevant field, click Insert Parameters and select the parameter.
    • Type the name of the parameter directly in the field in the following format: $[parameter name].
  • On the Module Parameters tab of a Task, you can:
    • Create new Module parameters manually: Right-click the relevant field, and click Add parameter. This opens the Add Module Parameter window, which allows you to configure the settings of the parameter. See Parameters. Parameters that are created manually on the Module Parameters tab need to be inserted manually on the Settings tab.
    • Create and insert new Module parameters for all fields in a Task automatically: Click AutoCreate > All. This option overwrites all existing settings of the Task.
    • Create and insert new Module parameters for all empty fields in a Task automatically: Click AutoCreate > Unused. This option preserves any existing settings.
    • View an overview of all parameters of all Tasks in the Module and edit them: Select a Module parameter and click Edit. The Module parameters of a specific Task in a Module can also be used by other Tasks in the Module. This is useful if similar fields in other Tasks should receive the same value.
  • On the Module Parameters tab of a Module, you can:
    • Create new Module parameters manually: Right-click the relevant field, and click Add parameter. This opens the Add Module Parameter window, which allows you to configure the settings of the parameter. See Parameters. Parameters that are created manually on the Module Parameters tab need to be inserted manually on the Settings tab.
    • View an overview of all parameters of all Tasks in the Module and edit them: Select a Module parameter and click Edit. The Module parameters of a specific Task in a Module can also be used by other Tasks in the Module. This is useful if similar fields in other Tasks should receive the same value.
    • Delete Module parameters: Select a Module parameter and click Delete. If you delete Module parameters that are used in one or more Tasks and/or other parameters, you have the option to replace all references to the parameter with its current value.
    • Change the order in which Module parameters are presented at input moment: Select a Module parameter and use the arrow buttons.
    • Delete Module parameters that are not used by any Task in the Module: Click Cleanup.
  • Parameters that have been created automatically do not have a default value and use the default input settings. You can change the values and input settings of these parameters on the Module parameters tab.
  • The functionality to use global Variables in parameters is supported for Text, Password and Credentials parameters (corresponding to the various Variables types). It is not supported for Run Book parameters.
  • In certain advanced Tasks, like Execute Command, Execute Secure Shell (SSH) Commands or Execute Windows PowerShell Script, you can also use Module parameters on other tabs.