AE Script Guide
Introduction
Automation Engine
AE Script Guide
Table of Contents
Introduction
About Automation Engine Scripts
First Steps
Introduction
Preliminary Checklist
The First Script
Script Statements
Script Variables
Script Functions
JCL
User-defined Dialogs
IF Conditions
Loops
Basics
Script Structure
Control Structures
Script Variable
Script Literal
Script Tabs
Script Editor
Getting Started
Advanced Users
Using Script Components
Error Handling
Using Variable Objects
Changing Object Attributes
Return Codes of Functions
Calculations
Strings
Date, Time and Period Formats
Sending Messages
Script Processing
Non-Supported Script Elements
Alphabetical Listing
Ordered by Function
Table Overwiew
Handle Objects
:REGISTER_OUTPUTFILE
CREATE_OBJECT
EXPORT
IMPORT
MODIFY_OBJECT
MOVE_OBJECT
REMOVE_OBJECT
Activate Objects
:BEGINREAD... :ENDREAD
:PRINT
:PUT_READ_BUFFER
:READ
ACTIVATE_UC_OBJECT
AUTOFORECAST
CANCEL_UC_OBJECT
DEACTIVATE_UC_OBJECT
DELETE_FORECAST
FORECAST_OBJECT
FORECAST_TASK
RERUN_UC_OBJECT
RESTART_UC_OBJECT
ROLLBACK_UC_OBJECT
SYS_ACTIVE_COUNT
SYS_STATE_ACTIVE
SYS_STATE_JOB_ACTIVE
SYS_STATE_JOBS_IN_GROUP
SYS_STATE_JP_ACTIVE
TOGGLE_OBJECT_STATUS
Read or Modify Objects
:ADD_ATT
:ADD_COMMENT
:ATTACH_SYNC
:DELETE_VAR
:MODIFY_STATE
:PUT_ATT
:PUT_ATT_APPEND
:PUT_VAR
:PUT_VAR_COL
:PUT_VAR_PROCESS
:REMOVE_ATT
:REPLACE_STRUCTURE
:RESOLVE
:SET_CALE
:SET_CONDITION
:XML_CLOSE
GET_ATT
GET_ATT_PLAIN
GET_ATT_SUBSTR
GET_CONDITION
GET_CONNECTION
GET_LOGIN
GET_OBJECT_TYPE
GET_OH_IDNR
GET_PUBLISHED_VALUE
GET_STATISTIC_DETAIL
GET_SYNC
GET_VAR
MODIFY_TASK
MODIFY_UC_OBJECT
RESOLVE_VAR
SET_SYNC
XML_APPEND_BEFORE
XML_APPEND_CHILD
XML_APPEND_CLONE
XML_APPEND_ELEMENT
XML_BEAUTIFY
XML_CLONE_AND_RENAME
XML_DELETE_NODE
XML_GET_ATTRIBUTE
XML_GET_CHILD_COUNT
XML_GET_FIRST_CHILD
XML_GET_LAST_CHILD
XML_GET_NEXTSIBLING
XML_GET_NODE_NAME
XML_GET_NODE_TEXT
XML_INSERT_BEFORE
XML_OPEN
XML_PRINTINTOFILE
XML_REMOVE_CHILDREN
XML_SELECT_NODE
XML_SET_ATTRIBUTE
XML_SET_NODE_TEXT
XML_TO_STRING
Script Structure and Processing
:ATTACH_RES
:BEGIN_EXT_INTERPRETER... :END_EXT_INTERPRETER
:CLEAR
:CONST
:DATA
:DEFINE
:EXT_REPORT_OFF
:EXT_REPORT_ON
:FILL
:GENERATE
:IF... :ELSE... :ENDIF
:INCLUDE
:INC_SCRIPT
:IFVERS [:ELSEVERS] :ENDVERS
:JCL_CONCAT_CHAR
:JCL_SUBSTITUTE
:PSET
:PUBLISH
:REGISTER_VARIABLE
:RESTART
:RSET
:SET
:SET_SCRIPT_VAR
:SWITCH... :CASE... :ENDSWITCH
:WAIT
:WHILE... :ENDWHILE
FIND
GET_SCRIPT_VAR
LENGTH
Error Handling and Messages
:EXIT
:ON_ERROR
:SEND_MSG
:SEND_SNMP_TRAP
:SET_LAST_ERR
:STOP
GET_MSG_TXT
GET_MSG_TYPE
SEND_MAIL
SYS_LAST_ERR_INS
SYS_LAST_ERR_NR
SYS_LAST_ERR_SYSTXT
Activation Data
GET_PARENT_NAME
GET_PARENT_NR
GET_PARENT_TYPE
GET_UC_OBJECT_STATUS
GET_UC_OBJECT_NR
SYS_ACT_HOST
SYS_ACT_JP
SYS_ACT_ME_NAME
SYS_ACT_ME_NR
SYS_ACT_ME_TYPE
SYS_ACT_PARENT_NAME
SYS_ACT_PARENT_NR
SYS_ACT_PARENT_TYPE
SYS_ACT_PREV_NAME
SYS_ACT_PREV_NR
SYS_ACT_PTTYP
SYS_ACT_RESTART
SYS_ACT_RESTART_COUNT
SYS_ACT_RESTART_ME_NR
SYS_ACT_TOP_NAME
SYS_ACT_TOP_NR
SYS_ACT_USERID
SYS_LAST_RESTART_POINT
SYS_LAST_RESTART_TEXT
SYS_RESTART_POINT
User Data
IS_GROUP_MEMBER
SYS_ACT_CLIENT
SYS_ACT_CLIENT_TEXT
SYS_USER_ALIVE
SYS_USER_DEP
SYS_USER_LNAME
SYS_USER_NAME
Data Sequences
:CLOSE_PROCESS
:PROCESS... :TERM_PROCESS... :ENDPROCESS
CREATE_PROCESS
GET_PROCESS_INFO
GET_PROCESS_LINE
LOAD_PROCESS
PREP_PROCESS
PREP_PROCESS_AGENTGROUP
PREP_PROCESS_COMMENTS
PREP_PROCESS_DOCU
PREP_PROCESS_FILE
PREP_PROCESS_FILENAME
PREP_PROCESS_PROMPTSET
PREP_PROCESS_REPORT
PREP_PROCESS_REPORTLIST
PREP_PROCESS_VAR - PREP_PROCESS_VAR_XML
PUT_PROCESS_LINE
SAVE_PROCESS
WRITE_PROCESS
XML_DOM_TO_PROCESS
XML_PROCESS_TO_DOM
Event Handling
GET_CONSOLE
GET_FILESYSTEM
GET_WIN_EVENT
System Conditions and Settings
:DISCONNECT
:SET_UC_SETTING
:SHUTDOWN
:TERMINATE
CHANGE_LOGGING
GET_UC_SERVER_NAME
GET_UC_SETTING
GET_UC_SYSTEM_NAME
ILM
MODIFY_SYSTEM
SYS_BUSY_01
SYS_BUSY_10
SYS_BUSY_60
SYS_HOST_ALIVE
SYS_INFO
SYS_SERVER_ALIVE
SYS_SNMP_ACTIVE
SYS_USER_LANGUAGE
TOGGLE_SYSTEM_STATUS
Date and Time
ADD_DAYS
ADD_PERIOD
ADD_TIME
ADD_TIMESTAMP
CALE_LOOK_AHEAD
CONV_DATE
CONV_TIMESTAMP
DAY_OF_YEAR
DIFF_DATE
DIFF_TIME
FIRST_OF_PERIOD
LAST_OF_PERIOD
SUB_DAYS
SUB_PERIOD
SUB_TIME
SUB_TIMESTAMP
SYS_DATE
SYS_DATE_PHYSICAL
SYS_LDATE
SYS_TIME
SYS_TIME_PHYSICAL
SYS_TIMESTAMP_PHYSICAL
VALID_CALE
VALID_DATE
VALID_TIME
WEEK_NR
WEEKDAY_NR
WEEKDAY_XX
YEAR_9999
Arithmetics
ADD
DIV
GET_BIT
MOD
MULT
RANDOM
SUB
Strings
ARRAY_2_STRING
ALPHA2RUNNR
CONVERT
FORMAT
HEX
ISNUMERIC
RUNNR2ALPHA
STR_CAT
STR_CUT
STR_ENDS_WITH
STR_FIND
STR_FIND_REVERSE
STR_ISLOWER
STR_ISUPPER
STR_LC
STR_LENGTH
STR_LTRIM
STR_MATCH
STR_PAD
STR_REVERSE
STR_RTRIM
STR_SPLIT
STR_STARTS_WITH
STR_SUBSTITUTE
STR_SUBSTITUTE_VAR
STR_TRIM
STR_UC
UC_CRLF
AE JCL for Applications
About AE JCL for Applications
PeopleSoft
About PeopleSoft JCL
PS_GET_HEARTBEAT
PS_GRANT_OUTPUT_ACCESS
PS_MODIFY_RUNCONTROL
PS_RUN_JOB
PS_RUN_PROCESS
PS_SET_BINDVAR
SAP
SAP Basis
About SAP JCL
R3_ACTIVATE_CM_PROFILE
R3_ACTIVATE_EXT_COMMAND
R3_ACTIVATE_EXT_PROGRAM
R3_ACTIVATE_INTERCEPTED_JOBS
R3_ACTIVATE_JOBS
R3_ACTIVATE_REPORT
R3_ACTIVATE_SESSIONS
R3_CALL_TRANSACTION
R3_COPY_VARIANT
R3_CREATE_OUTPUT_REQUEST
R3_CREATE_VARIANT
R3_DEACTIVATE_CM_PROFILE
R3_DELETE_NODE
R3_DELETE_VARIANT
R3_GET_APPLICATION_RC
R3_GET_APPLICATIONLOG
R3_GET_EVENT
R3_GET_INTERCEPTION
R3_GET_JOB_SPOOL
R3_GET_JOBLOG
R3_GET_JOBS
R3_GET_MONITOR
R3_GET_SESSIONS
R3_GET_SPOOLREQUESTS
R3_GET_SYSTEMLOG
R3_GET_VARIANTS
R3_GET_VARIANT_CONTENTS
R3_IMPORT_CALENDAR
R3_IMPORT_JOBS
R3_MODIFY_INTERCEPTION
R3_MODIFY_JOB
R3_MODIFY_VARIANT
R3_RAISE_EVENT
R3_SCHEDULE_JOB_CANCEL
R3_SEND_SPOOL_REQUEST
R3_SET_BDCDATA
R3_SET_FREE_SELECTION
R3_SET_LOG_ATTR
R3_SET_PERF_ATTR
R3_SET_PRINT_DEFAULTS
R3_SET_SELECT_OPTION
R3_SET_STATUS_ATTR
R3_SET_TEXT_ATTR
R3_SWITCH_OPMODE
SAP BCA
BCA_ACTIVATE_PROCESS
SAP BW
About SAP BW JCL
BW_ACTIVATE_CHAIN
BW_ACTIVATE_INFOPACKAGE
BW_GET_CHAINS
BW_GET_INFOPACKAGES
BW_RESTART_CHAIN
BW_SET_CONSTRAINT
BW_SET_INFOPACKAGE_SELECTION
SAP XI
XI_GET_CHANNEL
XI_SET_CHANNEL
Siebel
SI_START_TASK
AE JCL for JMX
About JMX JCL
JMX_COMPOSITE_ADD
JMX_CREATE_MBEAN
JMX_GET_AGENT
JMX_GET_ATTRIBUTE
JMX_GET_INFO
JMX_INVOKE
JMX_QUERY_NAMES
JMX_SET_ATTRIBUTE
JMX_UNREGISTER_MBEAN
JMX_WAIT_FOR_NOTIFICATION
AE JCL for SQL
About SQL JCL
SQL_EXECUTE_JOB
SQL_GET_COLUMNS
SQL_GET_JOBS
SQL_GET_TABLES
SQL_ON_ERROR
SQL_ON_ROWCOUNT_ZERO
SQL_SET_STATEMENT_TERMINATOR