Parameter types

When configuring parameters, you can use the following types:

Type

Explanation

Example

Credentials

A Credentials parameter is a combination of domain\username and password.

  • The matching password field will be disabled, as the Credentials parameter will fill both. The password is always masked.
  • You can use parameters to specify the user name. The use of parameters in passwords is not allowed, as it may lead to unpredictable results when linking in Projects and Run Books.

Use this in a username field for which there is also a password field, for example in the Security Context of a Task.

List

A List parameter is a list with possible values for the parameter from which a value can be selected at the input moment of the parameter.

Use this in text fields where only specific information is allowed, and where the options are known in advance. For example, in a Task Execute Database Statement, you could provide a list of Database servers.

Multi-line text

A Multi-line text parameter can be a text of several lines, containing line breaks.

  • A Multi-line text parameter is displayed as a single line when the parameter is set.
  • When specifying the default value for this type of parameter, press ENTER to start on a new line. When providing a value at the input moment, press CTRL+ENTER to start a new line.

Use this, for example, for a message box text, Active Directory User Notes, or for the value for a multi-string registry value.

Multi-select list

A Multi-select list parameter is a list with possible values for the parameter from which multiple values can be selected at the input moment of the parameter. This multi selection is converted into a semicolon (;) separated string.

Use this type of parameter in text fields where only specific information is allowed, where the options are known in advance, and where multiple entries are allowed. For example, in a Task Manage Active Directory User, you could provide a list of Active Directory Groups of which the user can be made member.

Password

A Password parameter is a password only. The value of a Password parameter is always masked. Its input must be entered twice for confirmation. You can use Variables and parameters as value:

  • The value of the parameter may contain only a single Variable or parameter, not multiple Variables and/or parameters (one after another) or variables and/or parameters inside Variables and/or parameters (e.g. ^[My password $[param]]).
  • The value may NOT contain functions.
  • When a Password parameter value is changed in the Jobs section when the Job is scheduled, the string will be handled as a password.

Use this in password fields that are not part of a set of credentials, for example for the password for a new local user.

Text

A Text parameter is a text string of a single line.

  • The format of input for Text parameters can be restricted using an input mask (see Parameter input mask).
  • To generate (partial) input automatically, you can use functions in Text parameters. (see Functions).

Use this in any field that needs to contain text, for example file name, Organizational Unit name, etc.

Changing a Parameter Type

When editing Module, Project, or Run Book parameters, it is possible to change the parameter type. When changing the parameter type:

  • Any values will be lost.
  • Linked parameters may become linked to parameters of a different type. This may lead to unexpected results when executing Modules, Projects or Run Books in which they are used. For example, a Text parameter may become linked to a credentials parameter.
  • Parameters will become unlinked if the different types are not allowed to be linked. For example, Text parameters and List parameters cannot be linked.