Script Elements for Variables and VARA Objects

You can write scripts that retrieve or store values in VARA objects, or assign values to different types of variables. For an overview of the different types of variables in the Automation Engine, see Variables and VARA Objects.

Define or Retrieve Script Variable Values

The following script elements assign or retrieve values of script variables.

• :CONST, :CONSTANT
  Creates a script variable with a constant value

• :DEFINE
  
  Defines a script variable and declares the data type

• :SET
  
  Assigns a value to a script variable

• :RSET
  
  Assigns a value to a script variable and stores it in the activation report

• :SET_SCRIPT_VAR
  
  Indirectly sets the value of a script variable by means of a placeholder

• GET_SCRIPT_VAR
  Queries multiple script variables at once by means of a placeholder

• :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER
  Writes the name and content of a script variable or PromptSet variable respectively to the read buffer

Assign or Define Object Variables

The following script elements define values of object variables.

• :PSET
  
  Assigns a value to an object variable

• :PUBLISH
  Defines a script variable or array as an object variable

Script Arrays

• :CLEAR
  Resets a script array to the initial values

• :FILL
  Stores values in a script array

• FIND
  Searches for a string or number in a script array and returns the position

• LENGTH
  Returns the size of a script array

• SYS_LAST_ARRAY_INDEX
  Retrieves the last filled index of a script variable array

Retrieve Values of PromptSet Variables

The following script element returns the values defined in a PromptSet variable.

• GET_PUBLISHED_VALUE
  Retrieves the value or PromptSet variable of a certain task

Resolve Variables

The following script elements resolve variables used in scripts.

• :RESOLVE
  
  Attempts to resolve all variables in a string

• RESOLVE_VAR
  Resolves any kind of variable (prompt value, system variable, script variables or VARA object) in text

Read or Modify Values in VARA Objects

The following script elements read or modify values stored in VARA objects.

• GET_VAR
  Returns the value of a VARA object

• :PUT_VAR
  Stores a value in a static VARA object

• :PUT_VAR_COL
  Stores a value to a particular column in a static VARA object

• :PUT_VAR_PROCESS
  Writes the content of a data sequence to a static VARA object

• PREP_PROCESS_VAR and PREP_PROCESS_VAR_XML
  Accesses all or some of the entries of a VARA object and prepares the processing of a data sequence

• :DELETE_VAR
  Deletes one or all values stored in a static VARA object

Create or Delete VARA Objects

The following script elements add or remove VARA objects.

• CREATE_OBJECT
  Creates a STATIC VARA object

• MODIFY_OBJECT
  Modifies a STATIC VARA object

• REMOVE_OBJECT
  Deletes a VARA object