Alphabetical List of Script Statements and Functions

This topic lists all elements of the Automation Engine scripting language in alphabetical order and briefly describes their purpose.

Script Statements

[A] [B] [C] [D] [E] [F] [G ] [I] [J] [M] [O] [P] [R] [S] [T] [W] [X]

A

  • :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

B

C

  • :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

D

  • :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

E

  • :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

F

  • :FILL
    Stores values in a script array

G

  • :GENERATE
    Controls the processing of script lines during execution

I

J

M

  • :MODIFY_STATE
    Modifies the return code or status text of a Job after completion

O

  • :ON_ERROR
    Resumes or aborts script processing in reaction to certain errors and messages of particular script elements

P

R

  • :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

S

T

  • :TERMINATE
    Ends an Agent, work process or communication process

W

  • :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

X

Script Functions

[A] [C] [D] [E] [F] [G ] [H ] [I] [J] [L] [M] [P] [R] [S] [T] [U] [V] [W] [X] [Y]

A

C

D

  • 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

E

  • EXPORT
    Exports objects to an XML file

F

G

H

  • HEX
    Converts a character set into hexadecimal form

I

  • 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

J

  • JSON_ADD_ITEM
    Adds an item to a JSON Array or Object document
  • JSON_COUNT_MATCHES
    Returns the number of matches of a JSONPath Expression in a JSON document
  • JSON_GET_TYPE
    Gets the data type of the JSON element.
  • JSON_GET_VALUE
    Queries the provided JSON document using the JSONPath Expression, and returns all matching values
  • JSON_SET_VALUE
    Sets the value of an existing element in a JSON document
  • JSON_TO_PROCESS
    Stores JSON values in an internal list (process) for further processing
  • JSON_REMOVE_ITEM
    Removes JSON object keys or array elements

L

M

P

R

S

  • 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#

T

U

V

  • 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

W

  • 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

X

Y

  • YEAR_9999
    Extracts the year from a given date