Inserting Variables in Objects and Scripts

As a developer and object designer, you can use variables and VARA objects to populate input fields and combo boxes and to write your scripts. This topic describes how to insert them and provides links to related topics.

Inserting Variables in Scripts

The Automation Engine scripting language provides various language elements that allow you to use variables and VARA object in your scripts.

More Information:

Inserting Variables Using the Variable Picker

The variable picker lists the variables and VARA objects that are available to you and allows you to select one. You can access it from input fields and combo boxes that support their use as follows:

Click the variable button where available (input fields).
Choose the Select Variable option in combo boxes.

To Insert VARA Objects or Variables Using the Variable Picker

Select a category from the drop-down list at the top of the dialog. The following options are available:
- System Properties *
  
  They return values that refer to the Automation Engine system and are the same throughout the system.
  
  This list does not contain all variables for system properties. For a complete list, see List of System Properties.
- Object Properties *
  
  They retrieve values from the object, for example:
  - Object script values, which return codes of script elements. For example, &$RUNID# for the Run number (RunID) of the task.
  - Object attributes. For example, &$AGENT# for the name of the Agent on which the task should be processed.
- Automation Variables **
  
  Predefined VARA objects that return system properties. This category is not available when you open the variable picker dialog from the Form view on Process pages.
- Variable Objects **
  
  The VARA objects defined in the current Client. For example, {VARA.DB.1} will be inserted for the VARA object VARA.DB.1.
* System Properties and Object Properties variables start with &$ and end with #. The string in between is constant except for the format of date and time values.

** For both Automation Variables and Variable Objects, to reference a particular value of the predefined VARA object in an object field, use the following format:

{ Variable object [, Key [, Column number ]] }

For example, {UC_CLIENT_SETTINGS, AUTO_FORECAST_DAYS, 1}, where:
- UC_CLIENT_SETTINGS is the VARA object.
- AUTO_FORECAST_DAYS is a key name.
- 1 is a column number.
If neither the key nor the column is defined, the system uses the value of the first entry or the result column/first Value column. You cannot select the key and column for a Variable object with the variable picker dialog. You must add and edit the variable manually to add them.
Optionally start typing the name of the VARA object or variable in the Search field to limit the displayed results. The search is not case-sensitive.
Select an entry from the list. A short description is displayed at the bottom of the dialog.
If the variable you select has date or time format, select a Format.
If the variable you select is a STATIC VARA object, optionally enter the key name and column number for the cell you want to select.
Click Select to add the variable or VARA object to the field.