Set Variable script step

Contents > Script steps reference (alphabetical list) > Control script steps > Set Variable script step

Set Variable script step

Format


Set Variable [<variable name> {[<repetition number>]}; Value:<value or formula>]

Options

Click Specify to set the variable options:

Name is the name of the variable you want to create. Prefix the name with $ for a local variable or $$ for a global variable. If no prefix is added, $ is automatically added to the beginning of the name.

Value is the value the variable is set to. You can enter text or specify a calculation.

Repetition is the repetition (index) number of the variable you want to create. If no repetition is specified, the default is 1.

Web compatibility

This script step is web-compatible.

Description

Sets a local or global variable to a specified value. If a variable doesn't exist, this script step will create one. A variable name has the same naming restrictions as a field name. For more information, see About naming fields.

Local and global variables can be created and used in calculations.

A local variable can only be used in script steps in the currently executing script. The value in a local variable is cleared when the script exits.

A global variable can be used in a calculation or script anywhere in a file, for example, other scripts or file paths. The value of a global variable is not cleared until the file is closed.

Local and global variables (or even two local variables in different scripts) can have the same name but they are treated as different variables and can store different values.

Examples

The following example sets a local variable.


Set Variable [$commission; Value:.05]

The following example sets a global variable.


Set Variable [$$commission; Value:.1]

The following example sets a global variable at a specified repetition number.


Set Variable [$$bonus[2]; Value:3 * 4]

Script step categories

About formulas

Using variables

Defining repeating fields

Contents > Script steps reference (alphabetical list) > Control script steps > Set Variable script step