This topic lists all elements of the Automation Engine scripting language in alphabetical order and briefly describes their purpose.
- Jump to Script Functions
- Also see Script Elements Ordered by Purpose
[A] [B] [C] [D] [E] [F] [G ] [I] [J] [M] [O] [P] [R] [S] [T] [W] [X]
- :ADD_ATT
Adds recipients to a Notification at runtime - :ADD_COMMENT
Adds a comment to a task - :ATTACH_RES
(Windows and UNIX Jobs only) Specifies resources to use with the Agent - :ATTACH_SYNC
Assigns a Sync object to a task
- :BEGINREAD... :ENDREAD
Starts and ends a dialog for user queries - :BEGIN_EXT_INTERPRETERS... :END_EXT_INTERPRETERS
(Windows and Unix Jobs only) Starts and ends a script for an external interpreter
- :CLEAR
Resets a script array to the initial values - :CLOSE_PROCESS
Discards a data sequence within a script - :CONST, :CONSTANT
Creates a script variable as a constant with a specific value
- :DATA
Explicitly declares a DATA line in a script - :DEFINE
Declares a script variable with a data type - :DELETE_VAR
Deletes one or all values in a VARA object - :DISCONNECT
Disconnects a connection to the Automation Engine
- :EXIT
Terminates processing of a script and sends a return code - :EXT_REPORT_OFF
Deactivates logging of the script for a task - :EXT_REPORT_ON
Activates logging of the script for a task
- :FILL
Stores values in a script array
- :GENERATE
Controls the processing of script lines during execution
- :IF... :ELSE... :ENDIF
Starts and ends a conditional block - :IFVERS [:ELSEVERS] :ENDVERS
Pre-compiler instructions for skipping script blocks depending on the installed Automation Engine version - :INC_SCRIPT
Integrates a script from a different Process page in the same object - :INCLUDE
Integrates an Include object into the script
- :JCL_CONCAT_CHAR
Forms JCL lines of up to a size of 2 KB - :JCL_SUBSTITUTE
Replaces a character set in JCL with another character set
- :MODIFY_STATE
Modifies the return code or status text of a Job after completion
- :ON_ERROR
Resumes or aborts script processing in reaction to certain errors and messages of particular script elements
- :PRINT
Writes text to a dialog for user queries or to the activation report of a task - :PROCESS... :TERM_PROCESS... :ENDPROCESS
Starts and ends a loop for line by line processing of a data sequence - :PSET
Assigns a value to an object variable - :PUBLISH
Defines a script variable or arrays as an object variable - :PUT_ATT
Sets or changes an object attribute - :PUT_ATT_APPEND
Writes text to a dialog for user queries or to the activation report of a task - :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER
Stores the name and content of a script variable in an input buffer - :PUT_VAR
Stores a value in a VARA object - :PUT_VAR_COL
Stores a value in a particular column in a static VARA object - :PUT_VAR_PROCESS
Writes the content of a data sequence to a static VARA object
- :READ
Queries the user in a dialog or reads variables in the read buffer - :REGISTER_OUTPUTFILE
(Windows and UNIX Jobs only) Registers a file as an external job output - :REGISTER_VARIABLE
(Windows and UNIX Jobs only) Registers the name and value of a variable - :REMOVE_ATT
Removes recipients from a Notification at runtime - :REPLACE_STRUCTURE
Replaces the content of a Workflow with the content of a different Workflow at activation - :RESOLVE
Attempts to resolve all variables in a string - :RESTART
Sets a restart point in an object - :RSET
Assigns a value to a script variable and stores the value in the activation report of the task
- :SEND_MSG
Sends a message to a user of the Automic Web Interface - :SEND_SNMP_TRAP
Sends an SNMP trap - :SET
Assigns a value to a script variable - :SET_CALE
Inserts or deletes a date or time period in a Calendar Event - :SET_CONDITION
Sets the earliest start time of a Workflow - :SET_LAST_ERR
Sets an error number and error text - :SET_SCRIPT_VAR
Indirectly sets the values of script variables - :SET_UC_SETTING
Changes a system setting during system operation - :SHUTDOWN
Ends an AE system - :STOP
Cancels the processing of a script - :SWITCH ... :CASE ... :OTHER ... :ENDSWITCH
Starts and ends a conditional block based on the value of a variable
- :TERMINATE
Ends an Agent, work process or communication process
- :WAIT
Stops processing of the script for a specified period of time - :WHILE... :ENDWHILE
Starts and ends a loop for repeated execution of script statements
- :XML_CLOSE
Closes an XML document
[A] [C] [D] [E] [F] [G ] [H ] [I] [L] [M] [P] [R] [S] [T] [U] [V] [W] [X] [Y]
- ACTIVATE_UC_OBJECT
Activates an object - ADD
Adds two values - ADD_DAYS
Assigns a Sync object to a task - ADD_PERIOD
Adds a period to a date - ADD_TIME
Adds two times - ADD_TIMESTAMP
Adds time to a timestamp - ALPHA2RUNNR
Converts the name of a Job or report file to a RunID - ARRAY_2_STRING
Converts a script array to a string - AUTOFORECAST
Calculates forecast data for future activities
- CALE_LOOK_AHEAD
Returns the next date based on calendar conditions - CANCEL_UC_OBJECT
Cancels the execution of an activated object - CHANGE_LOGGING
Causes the log file to change - CONV_DATE
Converts a date from one format to another format - CONV_LC: see STR_LC, CONV_LC
Converts all characters of a string to lower case letters - CONV_TIMESTAMP
Converts date and time to a different time zone - CONV_UC: see STR_UC, CONV_UC
Converts all characters of a string to upper case letters - CONVERT
Converts the data type of a value - CREATE_OBJECT
Creates a Calendar, Login or VARA object - CREATE_PROCESS
Creates a new data sequence
- DAY_OF_YEAR
Returns the day of the year for a specified date - DEACTIVATE_UC_OBJECT
Deactivates a completed task - DELETE_FORECAST
Deletes one more forecasts from the Automation Engine database - DIFF_DATE
Calculates the difference between two dates in days - DIFF_TIME
Calculates the difference between two times - DIV
Divides a value by another value
- EXPORT
Exports objects to an XML file
- FIND
Searches a script array and returns the corresponding index position - FIRST_OF_PERIOD
Stores values in a script array - FORECAST_OBJECT
Generates a forecast of an object - FORECAST_TASK
Generates a forecast of a running task - FORMAT
Changes the format of a number
- GENERATE_SCRIPT_VARS
Generates a script variable from a VARA object or data sequence on the fly - GET_ATT
Returns the value of an object attribute during generation - GET_ATT_PLAIN
Returns the variable name of an object attribute during generation - GET_ATT_SUBSTR
Returns part of the message text in a Notification - GET_BIT
Checks if a bit is set in a bit field - GET_CONDITION
Determines the earliest start time in a Workflow - GET_CONNECTION
Reads information from a database Connection object - GET_CONSOLE, GET_EVENT_INFO
Reads values from Events - GET_EVENT_INFO: see GET_CONSOLE, GET_EVENT_INFO
- GET_FILESYSTEM
Retrieves file system values from a specified path on a computer - GET_LOGIN
Reads information from a Login object - GET_MSG_TXT
Returns the message text of the last error - GET_MSG_TYPE
Returns the type of a message number - GET_OBJECT_TYPE
Returns the object type of a task - GET_OH_IDNR
Returns the internal ID number of an object - GET_PARENT_NAME
Returns the name of the parent task - GET_PARENT_NR
Returns the RunID of the parent task - GET_PARENT_TYPE
Returns the object type of the parent task - GET_PROCESS_INFO
Returns information about a data sequence - GET_PROCESS_LINE
Returns the content of a line in a data sequence - GET_PUBLISHED_VALUE
Returns the value of an object variable or PromptSet variable from a task - GET_SCRIPT_VAR
Returns the values of script variables by indirect access - GET_STATISTIC_DETAIL
Returns information from the execution data of an object - GET_SYNC
Returns the current condition or value of a Sync object - GET_UC_OBJECT_NR
Returns the RunID of an activated object - GET_UC_OBJECT_STATUS
Returns the status of an activated object - GET_UC_SERVER_NAME
Returns the name of the work process in which the script is running - GET_UC_SETTING
Reads current system settings - GET_UC_SYSTEM_NAME
Returns the name of the AE system
Predefined variable: &$SYSTEM# - GET_VAR
Retrieves a value from a VARA object - GET_WIN_EVENT
Retrieves the content of a field in a Windows system, security or application log
- HEX
Converts a character set into hexadecimal form
- ILM
Controls ILM functionality - IMPORT
Imports objects from an XML file - IS_GROUP_MEMBER
Checks if a user is a member of a given user group - ISNUMERIC
Checks if a character set is numeric
- LAST_OF_PERIOD
Determines the last day of the period of a specified date - LENGTH
Returns the size of a script array - LOAD_PROCESS
Loads a stored data sequence
-
MID: see STR_LC, CONV_LC
- MOD
Returns the remainder of a division - MODIFY_OBJECT
Change an existing Calendar, Login or VARA object - MODIFY_SYSTEM
Processes ServiceManager actions or queue modifications - MODIFY_TASK
Modifies an active STANDARD Workflow or task - MODIFY_UC_OBJECT
Modifies an attribute of an activated object - MOVE_OBJECT
Move an object to a folder
- PREP_PROCESS
Create a data sequence based on target system commands - PREP_PROCESS_AGENTGROUP
Retrieves the Agents in an Agent Group object - PREP_PROCESS_COMMENTS
Retrieves the timestamp, user and text of a task comment - PREP_PROCESS_DOCU
Retrieves the content of a Documentation page from an object - PREP_PROCESS_FILE
Retrieves the content of a text file from a particular computer - PREP_PROCESS_FILENAME
Retrieves a list of files in a specific computer directory - PREP_PROCESS_PROMPTSET
Retrieves information about each element in a PromptSet object - PREP_PROCESS_REPORT
Retrieves the report lines of an executable object from the database - PREP_PROCESS_REPORTLIST
Retrieves a list of registered output files of a Job that has already run - PREP_PROCESS_VAR and PREP_PROCESS_VAR_XML
Retrieves a list of VARA object values - PUT_PROCESS_LINE
Adds a line to a data sequence
- RANDOM
Generates a random number - REMOVE_OBJECT
Deletes an existing object - RERUN_UC_OBJECT
Reruns a Workflow that has been rolled back - RESOLVE_VAR
Resolve a variable in text - RESTART_UC_OBJECT
Repeats the execution of a task - ROLLBACK_UC_OBJECT
Rolls back an active task - RUNNR2ALPHA
Converts a RunID to the corresponding file name
- SAVE_PROCESS
Stores a data sequence - SEND_MAIL
Sends an email to a user - SET_SYNC
Executes the defined action of a Sync object - STR_CAT
Combines two strings to a new string - STR_CUT, MID, SUBSTR
Copies string characters - STR_ENDS_WITH
Checks if a string ends with a certain 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, starting at the end of the string - 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_LC, CONV_LC
Converts all characters of a string to lowercase - STR_LENGTH, STR_LNG
Returns the length of a string - STR_LTRIM
Deletes empty spaces at the beginning of a character set - STR_MATCH
Compares two character sets - STR_PAD
Extends a string to a certain length - STR_REVERSE
Reverses the order of characters within a string - STR_RTRIM
Deletes empty spaces at the end of a character set - 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 a character or string within a string - STR_SUBSTITUTE_VAR, STR_SUB_VAR
Replaces script variable names by their values - STR_TRIM
Removes empty spaces at the beginning and end of a character set - SUB
Subtracts a number from another number - SUB_DAYS
Subtracts days from a specified date - SUB_PERIOD
Subtracts a period from a specified date - SUB_TIME
Subtracts time from another time - SUB_TIMESTAMP
Subtracts time from a timestamp - SUBSTR: see STR_CUT, MID, SUBSTR
- SYS_ACT_CLIENT, SYS_USER_CLIENT
Returns the number of the current Client
Predefined variable: &$CLIENT# - SYS_ACT_CLIENT_TEXT
Returns the title of the current Client
Predefined variable: &$CLIENT_DESC# - SYS_ACT_HOST
Returns the name of the Agent on which the task runs - SYS_ACT_JP
Determines whether the task was activated by a Workflow
Predefined variable: &$IN_PROCESSFLOW# - SYS_ACT_ME_LNR
Returns the sequence number of the task that contains the script - SYS_ACT_ME_NAME
Returns the name of the task that contains the script
Predefined variable: &$NAME# - SYS_ACT_ME_NR
Returns the RunID of the task that contains the script
Predefined variable: &$RUNID# - SYS_ACT_ME_TYPE
Returns the object type of the task that contains the script
Predefined variable: &$OBJECT_TYPE# - SYS_ACT_PARENT_NAME
Returns the name of the parent task
Predefined variable: &$ACTIVATOR#, &$PROCESSOR# - SYS_ACT_PARENT_NR
Returns the RunID of the parent task
Predefined variable: &$ACTIVATOR_RUNID#, &$PROCESSOR_RUNID# - SYS_ACT_PARENT_TYPE
Returns the object type of the parent task
Predefined variable: &$ACTIVATOR_TYPE#, &$PROCESSOR_TYPE# - SYS_ACT_PREV_NAME
Returns the name of the previous task in the Workflow - SYS_ACT_PREV_NR
Returns the RunID name of the previous task in the Workflow - SYS_ACT_PTTYP
Returns the partner type of the user
Predefined variable: &$PARTNER_TYPE# - SYS_ACT_RESTART
Checks whether the object was activated in restart mode
Predefined variable: &$RESTARTED# - SYS_ACT_RESTART_COUNT
Returns the number of Workflow task restarts through RESTART_TASK
Predefined variable: &$RESTART_COUNT# - SYS_ACT_RESTART_ME_NR
Returns the RunID of an objected activated in restart mode
Predefined variable: &$RESTART_RUNID# - SYS_ACT_TOP_NAME
Returns the name of the top Workflow
Predefined variable: &$TOP_PROCESSFLOW_NAME# - SYS_ACT_TOP_NR
Returns the RunID of the top Workflow
Predefined variable: &$TOP_PROCESSFLOW_RUNID# - SYS_ACT_USERID
Returns the User ID under which the Job runs - SYS_ACTIVE_COUNT
Returns the number of all activated objects - SYS_BUSY_01
Returns the size of the workload of the Automation Engine in the last minute - SYS_BUSY_10
Returns the size of the workload of the Automation Engine in the last 10 minutes - SYS_BUSY_60
Returns the size of the workload of the Automation Engine in the last hour - SYS_DATE
Returns the current date at the beginning of script processing
Predefined variable: &$DATE_format# - SYS_DATE_PHYSICAL
Returns the current date
Predefined variable: &$PHYS_DATE_format# - SYS_HOST_ALIVE
Checks whether a particular Agent is active - SYS_INFO
Retrieves version information from the Automation Engine, or data about message queues - SYS_LAST_ARRAY_INDEX
Returns the last filled index of an array - SYS_LAST_ERR_INS
Retrieves the variable message part of the latest error - SYS_LAST_ERR_NR
Retrieves the number of the latest error - SYS_LAST_ERR_SYSTXT
Retrieves the latest error message from the operating system - SYS_LAST_REGISTERED_OFILE
Returns the last used output file of the :REGISTER_OUTPUTFILE command - SYS_LAST_REGISTERED_ULOGIN
Returns the last used login of the :REGISTER_OUTPUTFILE command - SYS_LAST_REGISTERED_VALUENAME
Returns the last used variable value of the :REGISTER_VARIABLE command - SYS_LAST_REGISTERED_VARNAME
Returns the last used variable name of the :REGISTER_VARIABLE command - SYS_LAST_RESTART_POINT
Returns the name of the previous restart point in the script - SYS_LAST_RESTART_TEXT
Returns the text of the previous restart point in the script - SYS_LDATE
Returns the logical date
Predefined variable: &$LDATE_format# - SYS_RESTART_POINT
Returns the restart point from which the object will be executed
Predefined variable: &$RESTART_POINT# - SYS_SERVER_ALIVE
Checks whether a particular server process is active - SYS_SNMP_ACTIVE
Checks if the SNMP connection of the Automation Engine is active
Predefined variable: &$SNMP_ACTIVE# - SYS_STATE_ACTIVE
Checks if an object is active - SYS_STATE_JOB_ACTIVE
Checks if a Job is activated - SYS_STATE_JOBS_IN_GROUP
Returns the number of Jobs that are registered in Groups - SYS_STATE_JP_ACTIVE
Checks if a Workflow is activated - SYS_TIME
Returns the current time of day at the beginning of script processing
Predefined variable: &$TIME_format# - SYS_TIME_PHYSICAL
Returns the current time of day
Predefined variable: &$PHYS_TIME_format# - SYS_TIMESTAMP_PHYSICAL
Returns the current date and time - SYS_USER_ALIVE
Checks if a user is logged in to the Automic Web Interface - SYS_USER_DEP
Returns the department of the user who started the task
Predefined variable: &$DEPARTMENT# - SYS_USER_LANGUAGE
Returns the language in which the server generates log files
Predefined variable: &$SYS_LANGUAGE# - SYS_USER_LNAME
Returns the first and last name of the user who started the task
Predefined variable: &$USER_FL# - SYS_USER_NAME
Returns the name of the user who started the task
Predefined variable: &$USER#
- TOGGLE_OBJECT_STATUS
Stops or starts the automatic processing of certain object types - TOGGLE_SYSTEM_STATUS
Stops or starts the automatic processing of a Client
- UC_CRLF
Inserts a line break
- VALID_CALE
Checks whether a date is included in a specified Calendar Event - VALID_DATE
Checks if a date is valid - VALID_TIME
Checks if a time is valid
- WEEK_NR
Returns the calendar week of a specified date - WEEKDAY_NR
Returns the day of the week of a specified date as a number - WEEKDAY_XX
Returns the day of the week of a specified date as an abbreviation - WRITE_PROCESS
Writes the content of a data sequence to a file
- 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 an XML document - XML_CLONE_AND_RENAME
Duplicates and renames an XML element - XML_DELETE_NODE
Removes a specific XML element - XML_DOM_TO_PROCESS
Creates a data sequence based on an XML document - XML_GET_ATTRIBUTE
Returns the value of an attribute of an XML element - XML_GET_CHILD_COUNT
Returns the number of sub-elements of an XML element - XML_GET_FIRST_CHILD
Identifies the first sub-element of an XML element - XML_GET_LAST_CHILD
Identifies the last sub-element of an XML element - XML_GET_NEXTSIBLING
Identifies the next XML element - XML_GET_NODE_NAME
Returns the name of an XML element - XML_GET_NODE_TEXT
Returns the text of an XML element - XML_INSERT_BEFORE
Creates a new XML element and inserts it in front of another element - XML_OPEN
Opens an XML document for processing - XML_PRINTINTOFILE
Writes the XML document in a file - XML_PROCESS_TO_DOM
Creates an XML document from a data sequence - XML_REMOVE_CHILDREN
Removes all sub-elements of an XML element - XML_SELECT_NODE
Identifies any XML 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 specified element as text
- YEAR_9999
Extracts the year from a given date