Variables

A variable is a named location that stores a textual or numeric value.

Variable characteristics

Variable characteristics include:

  • Availability: By default, a variable is valid only during runtime for the wizard for which it was created. The variables of an embedded wizard and its containing wizard become available to each other during runtime.

  • Name:

    • The variable name is free, alphanumeric text

    • It is not case sensitive, and can include spaces

    • Variable names cannot include any special characters, such as ! @ # $ % ^ & * ( ) / < > - = | \

  • Value:

    • Variables do not have to contain a value in order to be used in commands. An undefined variable will simply contain an empty string.

    • Variable values can be changed at any time

    • The variable value is always treated by the wizard as a string

Referencing variables

  • In wizard bubbles and commands, variables can be referred to by wrapping them with dollar signs ($), e.g., $MyVar$.

  • To use a variable as a numeric value, you must wrap the variable name with pound (hash) signs, e.g., #MyVar#.

    • A variable used in comparison operators (such as < > = ) that contain numeric values is automatically defined as numeric. In such a case, you do not need to indicate the variable type.

  • A credential variable is associated with credential display name(s). Since the credential variables are dynamic, if you export a wizard to another environment, make sure that the credentials associated with the variable are defined in the new environment's credential vault.

Using variables

Use variables in advanced commands to execute a sequence of actions in a wizard, and also in the following places:

  • Bubble text: Insert a variable into the text, so that the text is customized based on the variable’s current value

  • Bubble button caption: Insert a variable into the text, so that the text is customized based on the variable’s current value.

  • Bubble Show/Hide properties: Display the bubble only if a specific variable's value is True. If the variable's value is False, the bubble is not displayed to the user.

You can find and mass update variables using the Find and Replace tool.


There are also input variables that you can use. These allow you to receive external variables.