Automation Engine Script Guide > Ordered by Function > Table Overwiew

Script Elements - Ordered by Function

The overview that is shown below lists all AE Script elements in groups of similar functional areas.

Handling Objects

[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 job output.
CREATE_OBJECT	Creates an object (Calendar, Login and Variable only).
EXPORT	Exports objects to an XML file.
IMPORT	Imports objects from an XML file.
MODIFY_OBJECT	Changes an existing object (only Calendar, Login and Variable).
MOVE_OBJECT	Moves an object to a folder.
REMOVE_OBJECT	Deletes an existing object.

Activating Objects

Script Element	Description
:BEGINREAD... :ENDREAD	Beginning and end of a dialog for user queries.
:PRINT	Writes text to a dialog for user queries or to the activation report of an object.
:PUT_READ_BUFFER	Puts name and content of a script variable in an input buffer.
:PUT_PROMPT_BUFFER	Puts name and content of a script variable in an input buffer.
:READ	Queries the user in a dialog.
ACTIVATE_UC_OBJECT	Activates an object.
AUTOFORECAST	Calculates forecast data for future activities.
CANCEL_UC_OBJECT	Cancels execution of an activated object.
DEACTIVATE_UC_OBJECT	Deactivates a completed task.
DELETE_FORECAST	Deletes any number or given Forecasts from the Automation Engine databaseA database is an organized collection of data including relevant data structures..
FORECAST_OBJECT	Creates a forecast of a given object.
FORECAST_TASK	Creates a forecast of a running task.
RERUN_UC_OBJECT	Continues a certain workflow.
RESTART_UC_OBJECT	Repeats the execution of a task.
ROLLBACK_UC_OBJECT	Executes the rollback of a specific task
SYS_ACTIVE_COUNT	Returns the number of all activated objects.
SYS_STATE_ACTIVE	Checks if an object is already active.
SYS_STATE_JOB_ACTIVE	Checks if a job has already been activated.
SYS_STATE_JOBS_IN_GROUP	Retrieves the number of jobs that are registered in groups.
SYS_STATE_JP_ACTIVE	Checks if a workflow has already been activated.
TOGGLE_OBJECT_STATUS	Stops or starts the automatic execution of several object types.

Reading or Modifying Objects

Script Element	Description
:ADD_ATT	Adds recipients to a notification at runtime.
:ADD_COMMENT	Adds a comment to a task.
:ATTACH_SYNC	Assigns a Sync object to a task.
:DELETE_VAR	Deletes one or all values of a Variable object.
:MODIFY_STATE	Modifies the return code or status text of a job when it has finished.
:PUT_ATT	Sets or changes attributes of objects.
:PUT_ATT_APPEND	Extends the notification's message text at runtime.
:PUT_VAR	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 sequence to a static Variable object.
:REMOVE_ATT	Removes recipients in a Notification object at runtime.
:REPLACE_STRUCTURE	Replaces the structure of a workflow with the structure of another workflow at activation.
:RESOLVE	Tries to resolve all variables in the string.
:SET_CALE	Inserts/deletes a date or time period in a calendar.
:SET_CONDITION	Sets the earliest start time in workflows.
:XML_CLOSE	Closes an XML document.
GET_ATT	Returns the values of attributes of an object during its generation.
GET_ATT_SUBSTR	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_OBJECT_TYPE	Returns a task's object type.
GET_OH_IDNR	Supplies an object's internal number.
GET_PUBLISHED_VALUE	Retrieves the value or PromptSet variable of a certain task.
GET_STATISTIC_DETAIL	Retrieves details from the statistical record of an executable object.
GET_SYNC	Queries the current condition or value of a Sync object.
GET_VAR	Returns the content of a Variable object.
MODIFY_TASK	Modifies active workflows.
MODIFY_UC_OBJECT	Modifies the attribute of an activated object.
RESOLVE_VAR	Resolves any kind of variable (Prompt values, System variables, Script variables, Variable objects) in text.
SET_SYNC	Executes the defined action 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.
XML_BEAUTIFY	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.
XML_GET_ATTRIBUTE	Supplies the value of an attribute.
XML_GET_CHILD_COUNT	Counts the sub-elements of an element.
XML_GET_FIRST_CHILD	Identifies the first sub-element of an element.
XML_GET_LAST_CHILD	Identifies the last sub-element of an element.
XML_GET_NEXTSIBLING	Identifies the succeeding element.
XML_GET_NODE_NAME	Supplies the name of an element.
XML_GET_NODE_TEXT	Supplies the text of an element.
XML_INSERT_BEFORE	Creates a new XML element and inserts this in front of another element.
XML_OPEN	Opens an XML document for processing.
XML_PRINTINTOFILE	Writes the XML document in a file.
XML_REMOVE_CHILDREN	Removes all the sub-elements of an XML element.
XML_SELECT_NODE	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.

Script Structure and Processing

[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 agent.
:BEGIN_EXT_INTERPRETERS... :END_EXT_INTERPRETERS	Marks the beginning and end of an external interpreter's script 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.
:EXT_REPORT_OFF	Deactivates the logging of a task's script.
:EXT_REPORT_ON	Activates the logging of a task's script.
:FILL	Stores several values in a script array.
:GENERATE	Controls the processing of script lines during execution of the script.
:IF... :ELSE... :ENDIF	Branching under certain conditions.
:INCLUDE	Integrates an Include object into the current script.
:INC_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.
:JCL_CONCAT_CHAR	Forms JCL lines to a size of up to 2 KB.
:JCL_SUBSTITUTE	Replaces a string in the JCL with another string.
:PSET	Assigns a value to an object variable.
:PUBLISH	Defines script variables and arrays as object variables.
: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.
:RESTART	Sets restart 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.
GET_SCRIPT_VAR	Returns the values of script variables by indirect access.
LENGTH	Retrieves the size of a script array.

Error Handling and Messages

[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
:EXIT	Terminates the processing of a script with a return code.
:ON_ERROR	Determines the reaction to certain errors and messages of script elements.
:SEND_MSG	Sends messages to the user of the UserInterface.
:SEND_SNMP_TRAP	Sends an SNMP trap.
:SET_LAST_ERR	Sets error number and text.
:STOP	Terminates the activation of a script and can display error messages.
GET_MSG_TXT	Retrieves the message text of the latest occurred error.
GET_MSG_TYPE	Retrieves the type of a message number.
SEND_MAIL	Sends email to a user.
SYS_LAST_ERR_INS	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.

Activation Data

[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
GET_PARENT_NAME	Returns the name of the superordinate task (Parent).
GET_PARENT_NR	Returns the run number of the superordinate task (Parent).
GET_PARENT_TYPE	Returns the object type of the superordinate task (Parent).
GET_UC_OBJECT_NR	Returns the RunID of an activated object.
GET_UC_OBJECT_STATUS	This returns the status of an activated object.
SYS_ACT_HOST	Returns the name of the host.
SYS_ACT_JP	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#
SYS_ACT_PARENT_NAME	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.
SYS_RESTART_POINT	Supplies the restart point from which the object will be executed.	&$RESTART_POINT#

User Data

[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
IS_GROUP_MEMBER	Checks a user's membership status within a user group.
SYS_ACT_CLIENT	Number of the current client.	&$CLIENT#
SYS_ACT_CLIENT_TEXT	Text of the current client.	&$CLIENT_DESC#
SYS_USER_ALIVE	Checks if a user is logged with a UserInterface in AE.
SYS_USER_DEP	Supplies the departmentDepartment name to which the Automation Engine user belongs. of the user who started the task.	&$DEPARTMENT#
SYS_USER_LNAME	Supplies the first and last name of the user who started the task.	&$USER_FL#
SYS_USER_NAME	Supplies the name of the user who started the task.	&$USER#

Data Sequences

[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
:CLOSE_PROCESS	Discards a data sequence within a script.
:PROCESS... :TERM_PROCESS... :ENDPROCESS	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
GET_PROCESS_LINE	Returns the content of the current line of a data sequence.
LOAD_PROCESS	Loads a stored data sequence.
PREP_PROCESS	Via specific Job objects (event jobs), this script function processes commands on a computer and returns the Console output as an internal list (data sequence) which can further be processed.
PREP_PROCESS_AGENTGROUP	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).
PREP_PROCESS_COMMENTS	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.
PREP_PROCESS_FILE	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).
PREP_PROCESS_FILENAME	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.
PREP_PROCESS_REPORT	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.
PREP_PROCESS_VAR and PREP_PROCESS_VAR_XML	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.

Event Handling

[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
GET_CONSOLE	Reads message data of an occurred console event.
GET_EVENT_INFO	Reads data of occurred Console, FileSystem and Database events.
GET_FILESYSTEM	Retrieves several file-system values from a defined path of a computer.
GET_WIN_EVENT	Determines entries in the Windows system, security and application logs if an event occurs.

System Conditions and Settings

[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
:DISCONNECT	Disconnects a connection to the AE system.
:SET_UC_SETTING	Changes system settings during system operation.
:SHUTDOWN	Ends an AE system.
:TERMINATE	Ends an agent, a work, or communication process.
CHANGE_LOGGING	Causes the log file to be changed.
GET_UC_SERVER_NAME	Determines the name of the work process in which the script runs.
GET_UC_SETTING	Reads current system settings.
GET_UC_SYSTEM_NAME	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 ServiceManager actions or queue modifications.
SYS_BUSY_01	Returns the size of the workload of the Automation Engine during the last minute (in percent).
SYS_BUSY_10	Returns the size of the workload of the Automation Engine during the last 10 minutes (in percent).
SYS_BUSY_60	Returns the size of the workload of the Automation Engine during the last hour (in percent).
SYS_HOST_ALIVE	Checks if a certain host is active.
SYS_INFO	Reads AE-system information.
SYS_SERVER_ALIVE	Checks if a certain server process is active.
SYS_SNMP_ACTIVE	Checks if the SNMP connection (Simple Network Management Protocol) of AE is active.	&$SNMP_ACTIVE#
SYS_USER_LANGUAGE	Supplies the language in which the Server generates the log files.	&$SYS_LANGUAGE#
TOGGLE_SYSTEM_STATUS	Stops or starts automatic processing of a client.

Date and Time

[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
ADD_DAYS	Adds days to a given date.
ADD_PERIOD	Adds a period to a specified date.
ADD_TIME	Adds two times.
ADD_TIMESTAMP	Adds time to a Time Stamp.
CALE_LOOK_AHEAD	Returns the next date based on calendar conditions.
CONV_DATE	Converts a date from one date format to another.
CONV_TIMESTAMP	Converts date and time for use in another TimeZone.
DAY_OF_YEAR	Returns the current day of the year.
DIFF_DATE	Determines the difference between two date entries in days.
DIFF_TIME	Returns the difference between two time entries.
FIRST_OF_PERIOD	Determines the first day of the period for a specified date.
LAST_OF_PERIOD	Determines the last day of the period of a specified date.
SUB_DAYS	Subtracts days from a given date.
SUB_PERIOD	Subtracts a period from a specified date.
SUB_TIME	Subtracts two times.
SUB_TIMESTAMP	Subtracts time from a Time Stamp.
SYS_DATE	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 date.	&$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#
SYS_TIMESTAMP_PHYSICAL	Provides current date and time.
VALID_CALE	Checks whether a date is included in the calendar keyword.
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.

Arithmetic

[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
ADD	Adds
DIV	Divides
GET_BIT	Checks if a bit is set in a bit field.
MOD	Returns the remainder of a division.
MULT	Multiplies
RANDOM	Generates random numbers.
SUB	Subtracts

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
ALPHA2RUNNR	Converts the name of a job or report file to a RunID.
ARRAY_2_STRING	Converts a script array to a string.
CONV_LC or STR_LC	Converts all characters of a string to lowercase letters.
CONV_UC or STR_UC	Converts all characters of a string to uppercase letters.
CONVERT	Converts the data type of a value.
FORMAT	Changes the formatting of a number.
HEX	Converts a string into hexadecimal form.
ISNUMERIC	Checks if a string is numeric.
MID, STR_CUT or SUBSTR	Copy string characters.
RUNNR2ALPHA	Converts the RunID to the corresponding file names.
STR_CAT	Combines two strings to a new string.
STR_ENDS_WITH	Checks whether a string ends with a certain other string.
STR_FIND	Searches for a character or a string within a string.
STR_FIND_REVERSE	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.
STR_TRIM	Removes empty spaces at the beginning and the end of a string.
UC_CRLF	Returns a page break.