Variables (VARA)

There are several Variable object types. Variable objects can be static or dynamic. Static variables store values in their object definition, while dynamic variables retrieve values from a specified data source. Depending on a variable's content, you can use it to influence the processes of your Automation Engine system.

Object Definition

Object class: Active object
Object type/Short form: VARA
Variable types: 

• BACKEND Variables
• EXEC Variables
• FILELIST Variables
• MULTI Variables
• SEC_SQL Variables
• SEC_SQLI Variables
• SQL Variables
• SQLI Variables
• STATIC Variables
• XML Variables

This topic provides information on the following:

• Static and Dynamic Variable Objects

• About the Many Kinds of Variables in Automation Engine

  • Automation Variables
  • System Properties Variables
  • Object Properties Variables
  • Script Variables (Including PromptSet Variables)
  • Object Variables
  • Agent Variables
  • Predefined Variables

Static and Dynamic Variable Objects

There are several variable object types, they are grouped into static or dynamic categories as shown below.

Variable Type	Variable Category	Variable Category Description
STATIC	Static	Static Variable objects have values stored in their object definition. You set static variable objects' values: By manually entering them. Note: Case-sensitive keys are supported. Example: Add the keys "test" and "TEST". If the database is case sensitive, it will save both keys, otherwise, the second entry will replace the first one. Using the Cell Editor window. You open the Cell Editor window by clicking the icon for a cell. When cell text is on multiple lines, you must edit it in the Cell Editor window. By defining a SET VARIABLE or CLEAR VARIABLE condition action for a Workflow task. However, you cannot define a new VARA object with a condition action. The following script elements are available for STATIC and XML variables: :PUT_VAR - Stores values in static variables. :PUT_VAR_COL - Stores a value in a specific column of a static Variable object. :DELETE_VAR - Deletes one or all values of a static variable.
XML
BACKEND	Dynamic	The values of dynamic Variable objects are not stored in the object. They are directly retrieved from the specified data source while they are accessed. This process is referred to as variable resolution. Values can neither be defined by a user nor by script.
EXEC
FILELIST
MULTI
SEC_SQLI
SEC_SQL
SQLI
SQL

Reading Variable Object Values with the GET_VAR Script Function

The values of static and dynamic Variable objects can be read using the script function GET_VAR.

About the Many Kinds of Variables in Automation Engine

There are many kinds of variables in Automation Engine. There are the Variable object types and categories described above. Additionally, there are several additional kinds and groups of variables described below.

Automation Variables

A predefined subset of static VARA objects used for system properties. You can pick most of these variables in the Insert Variables dialog.dialog by selecting Automation Variables.

System Properties Variables

System properties variables are not objects. They are the same throughout the system. For example, &$SYSTEM# for the name of the Automation Engine system. You can pick most of these variables in the Insert Variables dialog.dialog by selecting System Properties. For a complete list, see System Properties.

Several System Properties variables are described in the topic Settings in Variables.

Object Properties Variables

Object properties variables reference objects or their runtime instance (task). They are either:

• Object attributes. For example, &$AGENT# for the name of the agent the task should be processed on. You can pick most of these variables in the Insert Variables dialog.dialog by selecting Object. For a complete list, see Object - Attributes.
• Runtime attributes of the task. For example, &$RUNID# for the Run number (RunID) of the task. You can pick most of these variables in the Insert Variables dialog.dialog by selecting Object. For a complete list, see Object - Attributes.

Script Variables (Including PromptSet Variables)

Script Variable are not objects. You set them in Automation Engine scripting to store values. Script variables can include numbers, strings, and date and time formats. You set script variables' values:

• With script statements such as:
  • :SET to assign a value to a script variable.
  • :SET_SCRIPT_VAR to set the values of script variables through indirect access.
  • :DEFINE and :SET to declare a script variable with a particular data type and array size and set it.
  • :RSET to assign a value to a script variable and store it in the activation report.
• As workflow task's SET VALUE condition action.
• In Web Service agent responses.
• As the variable name for each prompt in the PromptSet designer of a PromptSet object.

Script variables are used in scripts like &INPUT# and in the PromptSet designer like TEXTFIELD1#. Note that the leading & is not used, but if the variable is used in scripting, it requires it like &TEXTFIELD1#.

Object Variables

Object Variables store values that can be used throughout an object. They are defined on the Variables page of an executable object or with the :PSET script statement.

Agent Variables

Agent Variables are either available as Variable objects in the system client 0000 or directly stored in the database. If they are stored in the database, they are referred to as virtual agent variables. They can be read with the script element GET_VAR, but they cannot be set with the statement :PUT_VAR.

Predefined Variables

Predefined variables is an umbrella term that refers to all:

• Variable objects
• Automation variables
• System properties variables
• Object properties variables