Automation Engine Script Guide > Ordered by Function > Script Structure and Processing > :REGISTER_VARIABLE

:REGISTER_VARIABLE

Script statement: Available on Windows and UNIX for use in a Job object's (JOBS) Process Tab in conjunction with an external interpreter script call and :BEGIN_EXT_INTERPRETER... :END_EXT_INTERPRETER.

Syntax

:REGISTER_VARIABLE VariableName, VariableValue

Value	Description/Format
VariableName	Name of the variable. Format: Name of the variable, excluding the leading "&": "number#"
VariableValue	Value of the respective variable. Format: string

Value

Description/Format

VariableName

Name of the variable.

Format: Name of the variable, excluding the leading "&": "number#"

VariableValue

Value of the respective variable.

Format: string

In order to be able to use :REGISTER_VARIABLE with external interpreter scripts, the desired external interpreters have to be defined by the administrator in the system variables (Job Includes) REGISTER_VARIABLE.WINDOWS and REGISTER_VARIABLE.UNIX respectively.
In addition to that he has to register the external interpreters in the system variables UC_EXT_INTERPRETERS_WINDOWS or UC_EXT_INTERPRETERS_UNIX respectively.

Description

You can use this script element to register a variable's name and value in the AE system. The variable will be registered in the AE system as an object variable.

In order to use the value of a predefined variable together with an external interpreter script you have to enter the variable name and the variable value.

:REGISTER_VARIABLE has to be used between the script statements :BEGIN_EXT_INTERPRETERS...:END_EXT_INTERPRETERS.

:REGISTER_VARIABLE must be used for jobs and external interpreters in order to register a variable, but the command can also be used in regular Windows/UNIX jobs to register variables in the Automation Engine.

Settings used in the Process Tab of the Job object (JOBS) in this context will be overridden by a script in the parent Workflow object, in case the Job object is part of a workflow.

Example:

:REGISTER_VARIABLE "number#", 1234

In order to be able to use :REGISTER_VARIABLE, the external interpreter scripts have to be defined by the administrator in the system variables (Job Includes) REGISTER_VARIABLE.WINDOWS and REGISTER_VARIABLE.UNIX respectively.
The administrator should also register the external interpreters in the system variables UC_EXT_INTERPRETERS_WINDOWS or UC_EXT_INTERPRETERS_UNIX respectively.