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 objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task's (JOBS) Process Tab in conjunction with an external interpreter scriptA particular Automation Engine object type. call and :BEGIN_EXT_INTERPRETER... :END_EXT_INTERPRETER.

Syntax

:REGISTER_VARIABLE VariableName, VariableValue

Value

Description/Format

VariableName

Name of the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type..

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

VariableValue

Value of the respective variable.

Format: string

Description

This script statement is used between the :BEGIN_EXT_INTERPRETERS and :END_EXT_INTERPRETERS script statement to register a userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. defined variable while executing an external interpreter script.
The external interpreter script would be called and run from the Process Tab of any Job object (JOBS) on Windows or UNIX.
This script statement registers the variable 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 EngineThis component drives an Automation Engine system and consists of different types of server processes..

Settings used in the Process Tab of the Job object (JOBS) in this context will be overridden by a script in the parentThere are different ways of activating objects. The originator of an activation is referred to as the superordinate task (parent). See also: Child; Children Workflow object, in case the Job object is part of a workflowAn object of the Automation Engine that can include several executable objects and which runs them in a specified order. [Formerly called "ProcessFlow" and "JobPlan."].

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.

 

See also:

 

 

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH