The overview that is shown below lists all AE Script elements in groups of similar functional areas.
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing ] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
---|---|
:REGISTER_OUTPUTFILE | Registers a file as an external jobAn Automation Engine object type for a process that runs on a target system. output. |
Creates an objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task (Calendar, Login and Variable only). |
|
Exports objects to an XML fileA format for imports and exports. An XML file contains object structures.. |
|
Imports objects from an XML file. |
|
Changes an existing object (only Calendar, Login and Variable). |
|
Deletes an existing object. |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing ] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing ] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
---|---|
Adds recipients to a notificationAn Automation Engine object type used to send messages to users and user groups. [Formerly called "CallOperator."] at runtimeThe duration of a task's execution. It refers to the period between a task's start and end. It does not include its activation period (see also: activation and start).. |
|
Adds a comment to a task. |
|
Assigns a Sync objectIt synchronizes executable objects based on defined states and actions. A particular Automation Engine object type. to a task. |
|
Deletes one or all values of a Variable object. |
|
Modifies the return codeThe value that represents the result of tasks and script functions. or statusThis represents the condition of a task (such as active, blocked, generating). text of a job when it has finished. |
|
Sets or changes attributes of objects. |
|
Extends the notification's message text at runtime. |
|
Stores a value in a Variable object. |
|
:PUT_VAR_COL | Stores a value to a particular column of a static Variable object. |
:PUT_VAR_PROCESS | Writes the content of a data sequenceAn internal listing of Console outputs or lines of Variable objects, etc. The lines of a data sequence can be accessed by using a PROCESS loop or the script element GET_PROCESS_LINE. The script elements PREP_PROCESS* generate data sequences. to a static Variable object. |
Removes recipients in a Notification object at runtime. |
|
Replaces the structure of a workflow with the structure of another workflow at activation. |
|
:RESOLVE | Tries to resolve all variables in the string. |
Inserts/deletes a date or time period in a calendarAn Automation Engine object type that defines a set of days based on calendar keywords.. |
|
Sets the earliest start time in workflows. |
|
Closes an XML document. |
|
Returns the values of attributes of an object during its generation. |
|
Supplies part of the message text in a notification. |
|
GET_CONDITION | Determines the earliest start time in workflows. |
GET_CONNECTION | Reads information from a DB-type Connection object. |
GET_LOGIN | Reads information from Login objects. |
GET_OH_IDNR | Supplies an object's internal number. |
GET_PUBLISHED_VALUE | Retrieves the value or PromptSet variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. of a certain task. |
Retrieves details from the statistical record of an executable object. |
|
Queries the current condition or value of a Sync object. |
|
GET_VAR | Returns the content of a Variable object. |
MODIFY_TASK | Modifies active workflows. |
Modifies the attribute of an activated object. |
|
RESOLVE_VAR | Resolves any kind of variable (Prompt values, System variables, Script variables, Variable objects) in text. |
Executes the defined actionActions are predefined building blocks for recurring activities. They are commonly used for managing third party systems or in deployment scenarios. of a Sync object. |
|
XML_APPEND_BEFORE | Moves an XML element in front of another element. |
XML_APPEND_CHILD | Adds a new sub-element to an XML element. |
XML_APPEND_CLONE | Duplicates an XML element and attaches it to another element. |
XML_APPEND_ELEMENT | Attaches an existing XML element to another element. |
Beautifies the display of an element's structure. |
|
XML_CLONE_AND_RENAME | Duplicates and renames an XML element. |
XML_DELETE_NODE | Removes a specific XML element. |
Supplies the value of an attribute. |
|
Counts the sub-elements of an element. |
|
Identifies the first sub-element of an element. |
|
XML_GET_LAST_CHILD | Identifies the last sub-element of an element. |
Identifies the succeeding element. |
|
Supplies the name of an element. |
|
Supplies the text of an element. |
|
XML_INSERT_BEFORE | Creates a new XML element and inserts this in front of another element. |
Opens an XML document for processing. |
|
Writes the XML document in a file. |
|
XML_REMOVE_CHILDREN | Removes all the sub-elements of an XML element. |
Identifies any element. |
|
XML_SET_ATTRIBUTE | Adds a new attribute to an XML element or changes an existing attribute. |
XML_SET_NODE_TEXT | Changes or sets the value of an XML element. |
XML_TO_STRING | Returns the XML of a specific element as text. |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
---|---|
:ATTACH_RES | Transfers resources from a Storage object to the Windows or UNIX agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host. |
:BEGIN_EXT_INTERPRETERS... :END_EXT_INTERPRETERS | Marks the beginning and end of an external interpreter's scriptA particular Automation Engine object type. in the Process Tab of Windows and UNIX Job objects. |
:CLEAR | Resets a script array to its initial values. |
:CONST | Creates a script variable as a constant with a certain value. |
:DATA |
Explicit declaration of a DATA line in a script. |
:DEFINE | Declares a script variable with a particular data type. |
Deactivates the logging of a task's script. |
|
Activates the logging of a task's script. |
|
:FILL | Stores several values in a script array. |
Controls the processing of script lines during execution of the script. |
|
Branching under certain conditions. |
|
Integrates an Include objectAn Automation Engine object type for a script that is frequently used in more than one object. into the current script. |
|
Integrates a script into another script of the same object. |
|
:IFVERS [:ELSEVERS] :ENDVERS | Pre-compiler instructions for skipping script blocks depending on the installed Automation Engine version. |
Forms JCL lines to a size of up to 2 KB. |
|
:JCL_SUBSTITUTE | Replaces a string in the JCL with another string. |
Assigns a value to an object variable. |
|
:PUBLISH | Defines script variables and arrays as object variablesPlaceholder for values that are stored in an object's "Variables & Prompts" tab/section.. |
:REGISTER_VARIABLE | Available on Windows and UNIX, used in a Job object's (JOBS) Process Tab inside :BEGIN_EXT_INTERPRETER... :END_EXT_INTERPRETER for an external interpreter script call. |
Sets restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts. points in an object. |
|
:RSET | Assigns a value to a script variable and saves it to the activation report. |
:SET | Assigns a value to a script variable. |
:SET_SCRIPT_VAR | Sets the values of script variables by indirect access. |
:SWITCH... :CASE... :ENDSWITCH | It verifies whether the value of a variable complies with certain values and depending on the result, it runs various statements. |
:WAIT | This is used to stop processing of the script for a specified period of time. Meanwhile, other tasks are completed. |
:WHILE... :ENDWHILE | Loop for repeated execution of script statements. |
FIND | Searches a script array and returns the corresponding index. |
Returns the values of script variables by indirect access. |
|
LENGTH | Retrieves the size of a script array. |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
---|---|
Terminates the processing of a script with a return code. |
|
Determines the reaction to certain errors and messages of script elements. |
|
Sends messages to the user of the UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."]. |
|
Sends an SNMP trap. |
|
Sets error number and text. |
|
:STOP |
Terminates the activation of a script and can display error messages. |
Retrieves the message text of the latest occurred error. |
|
Retrieves the type of a message number. |
|
Sends email to a user. |
|
Supplies the variable message part of the error that has last occurred. |
|
SYS_LAST_ERR_NR | Returns the number of the error that has last occurred. |
SYS_LAST_ERR_SYSTXT | Retrieves the last-occurred error message from the operating system. |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
Predefined Variable |
---|---|---|
Returns the name of the superordinate taskThere are various ways of activating objects. The originator of the activation is referred to as the superordinate task (parent). (Parent). |
||
Returns the run number of the superordinate task (Parent). |
||
Returns the object type of the superordinate task (Parent). |
||
Returns the RunIDShort for "run number". It is a number that provides unique information about a task's execution. The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component . of an activated object. |
||
This returns the status of an activated object. |
||
Returns the name of the hostComputer, target system.. |
||
Determines if a task was activated in a workflow. |
&$IN_PROCESSFLOW# | |
SYS_ACT_ME_NAME | Returns the name of the own object. | &$NAME# |
SYS_ACT_ME_NR | Returns the run number (RunID) of the own object. | &$RUNID# |
SYS_ACT_ME_TYPE | Returns the object type of the own object. | &$OBJECT_TYPE# |
Supplies the name of a superordinate task. |
&$ACTIVATOR# &$PROCESSOR# |
|
SYS_ACT_PARENT_NR | Supplies the run number (RunID) of the superordinate task. | &$ACTIVATOR_RUNID# &$PROCESSOR_RUNID# |
SYS_ACT_PARENT_TYPE | Returns the object type of the superordinate task. | &$ACTIVATOR_TYPE# &$PROCESSOR_TYPE# |
SYS_ACT_PREV_NAME | Returns the name of the previous task in a workflow. | |
SYS_ACT_PREV_NR | Returns the run number (RunID) of a previous task in a workflow. | |
SYS_ACT_PTTYP | Returns the partner type of the user. | &$PARTNER_TYPE# |
SYS_ACT_RESTART | Retrieves whether the object was activated in restart mode. | &$RESTARTED# |
SYS_ACT_RESTART_COUNT | Supplies the number of restarts that have been executed for workflow tasksusing the script statement RESTART TASK (Postconditions). | &$RESTART_COUNT# |
SYS_ACT_RESTART_ME_NR | Returns the run number (RunID) of an object activated in restart mode. | &$RESTART_RUNID# |
SYS_ACT_TOP_NAME | Supplies the name of the top workflow. | &$TOP_PROCESSFLOW_NAME# |
SYS_ACT_TOP_NR | Supplies the run number (RunID) of the top workflow. | &$TOP_PROCESSFLOW_RUNID# |
SYS_ACT_USERID | Supplies the User ID under which the job will run. | |
SYS_LAST_RESTART_POINT | Supplies the name of the previous restart point in the script. | |
SYS_LAST_RESTART_TEXT | Supplies the text of the previous restart point as defined in the script. | |
Supplies the restart point from which the object will be executed. |
&$RESTART_POINT# |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
Predefined Variable |
---|---|---|
&$CLIENT# | ||
Text of the current client. |
&$CLIENT_DESC# | |
Checks if a user is logged with a UserInterface in AE. |
||
Supplies the departmentDepartment name to which the Automation Engine user belongs. of the user who started the task. |
&$DEPARTMENT# | |
Supplies the first and last name of the user who started the task. |
&$USER_FL# | |
Supplies the name of the user who started the task. |
&$USER# |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
---|---|
Discards a data sequence within a script. |
|
The definition of a loop for the line by line processing of a data sequence such as the content of a sequential file or the text result of a command. |
|
CREATE_PROCESS | Creates a new data sequence. |
GET_PROCESS_INFO | Retrieves information of a data sequence |
Returns the content of the current line of a data sequence. |
|
LOAD_PROCESS | Loads a stored data sequence. |
Via specific Job objects (eventAction that is triggered if particular conditions apply. It can be an Automation Engine object type or an entry in a Policy Orchestrator EventBase. jobs), this script functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… processes commands on a computer and returns the Console output as an internal listShows entities in a grid view (data sequence) which can further be processed. |
|
Uses selection criteria to retrieve the agents of an AgentGroup object and provides the result for further processing in the form of an internal list (data sequence). |
|
Uses filter settings to retrieve the timestamp, user and text of task comments and provides the result for further processing in the form of an internal list (data sequence). |
|
PREP_PROCESS_DOCU | Provides the content of a Documentation tab as an internal list (data sequence) for further processing. |
Uses filter criteria to retrieve the content of a text file which is available on a particular computer line by line. It provides the result for further processing in the form of an internal list (data sequence). |
|
Retrieves a list of file names which are available in a specified computer directory. It provides the result for further processing in the form of an internal list (data sequence). |
|
PREP_PROCESS_PROMPTSET | Reads the definition of PromptSet objects and provides them as an internal list (data sequence) for further processing. |
Uses filter criteria to retrieve the report lines of executable objects and provides the result for further processing in the form of an internal list (data sequence). |
|
PREP_PROCESS_REPORTLIST | Retrieves the list of the registered output of jobs that have already run and provides the result in the form of an internal list (data sequence) for further processing. |
Uses selection criteria to retrieve a list of Variable object values and provides the result for further processing in the form of an internal list (data sequence). |
|
PUT_PROCESS_LINE | Adds a line to a certain data sequence. |
SAVE_PROCESS | Stores a certain data sequence. |
WRITE_PROCESS | It writes the content of a data sequence to a file. |
XML_DOM_TO_PROCESS | Creates a data sequence based on a certain XML document. |
XML_PROCESS_TO_DOM | Creates an XML document from a data sequence. |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
---|---|
Reads message data of an occurred console event. |
|
Reads data of occurred Console, FileSystem and Database events. |
|
Retrieves several file-system values from a defined path of a computer. |
|
Determines entries in the Windows system, security and applicationAn application is a software which helps a user to fulfill specific tasks. In the context of ARA see also: Application entity. logs if an event occurs. |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
Predefined Variable |
---|---|---|
Disconnects a connection to the AE system. |
||
Changes system settings during system operation. |
||
Ends an AE system. |
||
Ends an agent, a work, or communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components.. |
||
Causes the log file to be changed. |
||
Determines the name of the work processA part of the component Automation Engine. It is responsible for an Automation Engine system's processes (see also 'Primary work process'). in which the script runs. |
||
Reads current system settings. |
||
Determines the name of the AE system. |
&$SYSTEM# | |
ILM | Controls ILMStands for Information Lifecycle Management, which refers to a wide-ranging set of strategies for administering storage systems on computing devices. functionality. | |
MODIFY_SYSTEM | Processes ServiceManagerA program that facilitates the starts and stops of Automation Engine components. actions or queueA particular Automation Engine (AE) object type. In AE, a queue determines the maximum number of concurrent tasks, their priorities and the order in which tasks should be executed. In ARA, queues are containers for workflow executions that should be executed at a certain time one after another. modifications. | |
Returns the size of the workload of the Automation Engine during the last minute (in percent). |
||
Returns the size of the workload of the Automation Engine during the last 10 minutes (in percent). |
||
Returns the size of the workload of the Automation Engine during the last hour (in percent). |
||
Checks if a certain host is active. |
||
Reads AE-system information. |
||
Checks if a certain server processThe core of the component Automation Engine. Different types are available: communication, work and dialog processes, as well as nonstop processes. is active. |
||
Checks if the SNMP connection (Simple Network Management Protocol) of AE is active. |
&$SNMP_ACTIVE# | |
Supplies the language in which the Server generates the log files. |
&$SYS_LANGUAGE# | |
Stops or starts automatic processing of a client. |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
Predefined Variable |
---|---|---|
Adds days to a given date. |
||
Adds a period to a specified date. |
||
Adds two times. |
||
Adds time to a Time Stamp. |
||
Returns the next date based on calendar conditions. |
||
Converts a date from one date format to another. |
||
Converts date and time for use in another TimeZone. |
||
Returns the current day of the year. |
||
Determines the difference between two date entries in days. |
||
Returns the difference between two time entries. |
||
Determines the first day of the period for a specified date. |
||
Determines the last day of the period of a specified date. |
||
Subtracts days from a given date. |
||
SUB_PERIOD | Subtracts a period from a specified date. | |
SUB_TIME | Subtracts two times. | |
Subtracts time from a Time Stamp. |
||
Returns the current date at the beginning of the script processing. |
&$DATE_format# | |
SYS_DATE_PHYSICAL | Determines the current date. | &$PHYS_DATE_format# |
SYS_LDATE | Returns the logical dateThe logical date is used as a comparison date for checking Calendar conditions.. | &$LDATE_format# |
SYS_TIME | Returns the current time of day at the beginning of the script processing. | &$TIME_format# |
SYS_TIME_PHYSICAL | Determines the current time of day. | &$PHYS_TIME_format# |
Provides current date and time. |
||
Checks whether a date is included in the calendar keywordThe attribute of a Calendar object that defines which days included in the calendar.. |
||
VALID_DATE | Checks if the date is valid. | |
VALID_TIME | Checks if the time is valid. | |
WEEK_NR | Returns the calendar week of a given date. | |
WEEKDAY_NR | Returns the day of a week of a given date as a number. | |
WEEKDAY_XX | Returns the day of the week of a given date as an abbreviation. | |
YEAR_9999 | Extracts the year from a given date. |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
---|---|
Adds |
|
Divides |
|
Checks if a bit is set in a bit field. |
|
Returns the remainder of a division. |
|
Multiplies |
|
Generates random numbers. |
|
Subtracts |
[Handling Objects] [Activating Objects] [Reading or Modifying Objects] [Script Structure and Processing] [Error Handling and Messages] [Activation Data] [User Data] [Data Sequences] [Event Handling] [System Conditions and Settings] [Date and Time] [Arithmetic] [Strings]
Script Element |
Description |
---|---|
Converts the name of a job or report file to a RunID. |
|
ARRAY_2_STRING | Converts a script array to a string. |
Converts all characters of a string to lowercase letters. |
|
Converts all characters of a string to uppercase letters. |
|
CONVERT | Converts the data type of a value. |
Changes the formatting of a number. |
|
Converts a string into hexadecimal form. |
|
Checks if a string is numeric. |
|
Copy string characters. |
|
Converts the RunID to the corresponding file names. |
|
Combines two strings to a new string. |
|
STR_ENDS_WITH | Checks whether a string ends with a certain other string. |
Searches for a character or a string within a string. |
|
Searches for a character or a string within a string. The search begins at the end of the string being searched. |
|
STR_ISLOWER | Checks whether the characters of a string are written in lowercase letters. |
STR_ISUPPER | Checks whether the characters of a string are written in uppercase letters. |
STR_LENGTH or STR_LNG | Returns the length of a string. |
STR_LTRIM | Deletes empty spaces at the beginning of a string. |
STR_PAD | Extends a string to a certain length. |
STR_MATCH | Compares two strings. |
STR_REVERSE | Reverses the order of the characters within a string. |
STR_RTRIM | Deletes the empty spaces at the end of a string. |
STR_SPLIT | Splits a string into several parts using a separator. |
STR_STARTS_WITH | Checks whether a string starts with a certain other string. |
STR_SUBSTITUTE | Replaces character or string within a string. |
STR_SUBSTITUTE_VAR | Replaces script-variable names by their values. |
Removes empty spaces at the beginning and the end of a string. |
|
Returns a page break. |
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |