advertisement
Automation Engine 9
UC4 Script Guide
Version: 9.12.0
Date: 2015-03
Automic Software GmbH
ii Copyright
Copyright
Automic® and the Automic logo® are trademarks owned by Automic Software GmbH (Automic). All such trademarks can be used by permission only and are subject to the written license terms. This software/computer program is proprietary and confidential to Automic Software and is only available for access and use under approved written license terms.
This software/computer program is further protected by copyright laws, international treaties and other domestic and international laws and any unauthorized access or use gives rise to civil and criminal penalties. Unauthorized copying or other reproduction of any form (in whole or in part), disassembly, decompilation, reverse engineering, modification, and development of any derivative works are all strictly prohibited, and any party or person engaging in such will be prosecuted by Automic.
No liability is accepted for any changes, mistakes, printing or production errors. Reproduction in whole or in part without permission is prohibited.
© Copyright Automic Software GmbH. All rights reserved.
Contents
Highlighting Syntax Components
1.3.4 Changing Object Attributes
1.3.5 Return Codes of Functions
Solving an arithmetic expression
Automation Engine iii
iv Contents
1.3.8 Date, Time and Period Formats
1.4 Non-Supported Script Elements
2 Script Elements - Alphabetical Listing
3.1 Script Elements - Ordered by Function
3.1.3 Reading or Modifying Objects
3.1.4 Script Structure and Processing
3.1.5 Error Handling and Messages
3.1.10 System Conditions and Settings
Automation Engine v
vi Contents
3.3.3 :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER
Automation Engine vii
viii Contents
3.3.16 SYS_STATE_JOBS_IN_GROUP
Automation Engine ix
x Contents
Automation Engine xi
xii Contents
Automation Engine xiii
xiv Contents
3.5 Script Structure and Processing
Automation Engine xv
xvi Contents
Trailing Blank Spaces Are Not Considered
3.5.19 :SWITCH ... :CASE ... :OTHER ... :ENDSWITCH
Automation Engine xvii
xviii Contents
3.6 Error Handling and Messages
Automation Engine xix
xx Contents
Automation Engine xxi
xxii Contents
3.8.2 SYS_ACT_CLIENT, SYS_USER_CLIENT
3.9.2 :PROCESS... :TERM_PROCESS... :ENDPROCESS
Automation Engine xxiii
xxiv Contents
3.9.13 PREP_PROCESS_REPORTLIST
3.10.1 GET_CONSOLE, GET_EVENT_INFO
Automation Engine xxv
xxvi Contents
3.11 System Conditions and Settings
Automation Engine xxvii
xxviii Contents
Automation Engine xxix
xxx Contents
Automation Engine xxxi
xxxii Contents
3.12.22 SYS_TIMESTAMP_PHYSICAL
Automation Engine xxxiii
xxxiv Contents
Automation Engine xxxv
xxxvi Contents
3.14.20 STR_SUBSTITUTE_VAR, STR_SUB_VAR
4.1 About UC4 JCL for Applications
4.2.1 About Oracle Applications JCL
Script Elements and Corresponding Interfaces
Automation Engine xxxvii
xxxviii Contents
Automation Engine xxxix
xl Contents
Automation Engine xli
xlii Contents
Automation Engine xliii
xliv Contents
5.11 JMX_WAIT_FOR_NOTIFICATION
Automation Engine xlv
xlvi Contents
6.8 SQL_SET_STATEMENT_TERMINATOR
Automation Engine 1
1 Introduction
1.1 About UC4 Scripts
UC4 offers a comprehensive scripting language that facilitates the deep automation of your processes. All executable objects include scripting tabs (Process) and in some cases, they also include special tabs in which you can record statements and functions.
This chapter provides a basic outline of UC4's scripting language. Step by step, you are introduced to specific aspects such as how to structure scripts or how to define variables. Tips are listed at the end of this chapter which should help you when it comes to creating your personal UC4 scripts.
This chapter also intends to support the experts among UC4 users. Scripting experts will quickly and easily find all the required information about script elements. Each document about script elements also includes a description of the particular script element plus its required and optional parameters.
Note that the UC4 authorization system also includes the use of UC4 scripts. If users are not authorized to access Variable objects, they can neither read nor modify these objects with the corresponding script functions.
Note the following when you activate or restart objects via the UserInterface: Ending the UserInterface before script generation has finished can have the effect that you will not obtain the desired result.
Enjoy studying and using UC4's scripting language.
2 Chapter 1 Introduction
1.2 Basics
1.2.1 Script Structure
A script consists of 3 different types of lines:
Comment Lines
l
Each line starting with the exclamation mark character "!", is a comment. These lines are not considered as processing steps and skipped during script execution .
Example:
!Comment line l
If the exclamation mark character is used within a line, however, this line is not considered a comment.
l l
Multi-line comments may be created by highlighting the particular lines and pushing the button in the tool bar of the UserInterface.
We recommend making ample use of comments so that you or other users may easily reproduce at a later point what the script lines do.
UC4 Script Lines
l
Lines starting with the colon character ":" contain UC4 script elements. They may be split up in script functions -which supply return codes- and script statements -which do not supply return codes.
Example of a script statement: :
PRINT "UC4 Automation Platform"
Example of a script function: :
SET &RESULT# = ADD (2,2) l
The underscore character "_" may be used for extra long lines to indicate that the text continues in the next line. The last character of a line should therefore be an underscore. The proximate line should start with a colon.
Data Lines
l
If a line neither starts with a "!" nor with a ":", it is considered a DATA line. DATA lines can only be used with "Job" objects. They contain the JCL (Job Control Language) of the target system. If a
DATA line starts with a ":", it must explicitly be declared as such with the script element
.
Example: copy test.txt c:\temp l l
Jobs for Enterprise Business Solutions (SAP, PeopleSoft and Oracle Applications) show some special features. UC4 provides an extra
for those.
Script variables included in DATA lines are replaced by their values. Script variables start with the special character "&". If "&" is used in a DATA line and should remain there as it is, it needs to be doubled. If "&" is used without being followed by a valid variable name, the DATA line also remains unchanged.
Automation Engine 3
1.2.2 Control Structures
UC4 processes scripts line by line. As it is often required that the particular steps are processed depending on conditions, two control structures are available for handling the way how the script will be processed.
The
processes script lines only if the given condition applies.
:IF condition
Script lines
:ENDIF
The
repeats script lines as long as the condition applies.
:WHILE condition
Script lines
:ENDWHILE
Obtain further information in the documents describing these control structures.
1.2.3 Script Variable
You can use script variables in the scripts of UC4 in order to store values. These script variables can include numbers, strings, and date and time formats.
The script element
can be used to declare a script variable to a particular data type.The data type determines the values that the variable should include.The script statement
can be used to assign and change values within a script.
For example:
: DEFINE &FILE# , string
: SET &FILE# = "temp.txt"
You can also create script variables directly by using :SET (without using :DEFINE before). In this case, the variable does not have a specific data type and can only store strings and positive integers.
For example:
: SET &VAR# = 10
: SET &VAR2# = "string"
A script variable's validity ends when the script has been processed.
Data types
Four data types with different value ranges are available for script variables. Use the script statement
in order to determine the data type in the variable declaration.
Data type Description Value range
4 Chapter 1 Introduction unsigned signed string float
Positive integers without algebraic signs
Integers with algebraic signs
String
Floating point numbers with algebraic signs
0 to +9 999 999 999 999
999
-9 999 999 999 999 999 to +9 999 999 999 999
999
1 to 1024 characters
-9 999 999 999 999
999.9999999999999999
to +9 999 999 999 999
999.9999999999999999
First declare the variable and then assign the corresponding value.
: DEFINE &STRING# , string
: DEFINE &SIGNED# , signed
: DEFINE &UNSIGNED# , unsigned
: DEFINE &FLOAT# , float
: SET &STRING# = "1234abc"
: SET &SIGNED# = -5
: SET &UNSIGNED# = 24
: SET &FLOAT# = -0.50
The data type "float" includes positive and negative integers. Positive integers can also be used for the data type "signed".
A variable that has already been used cannot be declared again. A variable's data type cannot be changed.
Note that floating point numbers can cause imprecise results in arithmetic operations.
Syntax
A script variable's name is limited to 32 alphanumeric characters, including the special characters "$", "_",
"@", "§" and "#". German Umlauts are not allowed. The first character must not be a number. Variables within the Script must always specified with a leading "&" following the Variable name!
An exception to the 32 character limit is for the :PSET and :RSET script statements, which are limited to 31 alphanumeric characters.
Note that the script variable's name must be different from the predefined variable's name . UC4 does not recommend using '$' at the beginning of variable names (after the character '&').
Names of script variables are not case sensitive. Script variables are specified without quotation marks.
A script variable's name must not comply with the beginning of another script variable's name. In such a case, you can name the script variable properly by appending a special character. For example, the term
"Enddate" is output in the activation protocol.
: SET &ACTIVITY# = "End"
: SET &ACTIVITY_DATE# = SYS_DATE ()
: PRINT "&ACTIVITY#date"
Do not use "&ACTIVITY_date" and "&ACTIVITY" within one script because in this case, the latter one is not a unique name anymore. The variable name and characters that should be output can be written in one line. Therefore, the following example could either refer to "Enddate" or to "040101".
Automation Engine 5
: SET &ACTIVITY = "End"
: SET &ACTIVITYdate = SYS_DATE ()
: PRINT "&ACTIVITYdate"
Arrays
You can create arrays in combination with script variables. In doing so, you can store several different values in one variable. The individual values can be accessed via an index. This index is specified as a number which is enclosed in [] square brackets after the variable's name. Arrays can only be created during the variable declaration by using:DEFINE . The third parameter defines the number of values (index area).
Unlike Script variables the name of arrays may be up to 24 alphanumeric characters long.
: DEFINE &ARR# , unsigned, 10
: SET &ARR# [5] = 20
An array's maximum size is 99999. The index is always specified as a positive number without inverted commas. The first element is accessed with the index 1.
Note that memory is allocated for all elements when an array is created. Therefore, UC4 recommends creating arrays only with the number of elements that are required in order to avoid performance problems.
Array fields that have not yet been initialized show the default value "" (data type: string) or 0 (numerical data types).
Several values can directly be stored in an array using the script element
. No index must be specified. Doing so is useful if several columns of a Variable object should be read:
: FILL &ARR# [] = GET_VAR ("VARA","JOBS")
Value assignments
Values can be assigned to script variables by using the script element
. You can specify the assigned value (regardless of its data type) with or without inverted commas (script literal), or it can be the return code of a script function.
: DEFINE &NUM# , unsigned
: SET &NUM# = 1234
: SET &NUM# = "1234"
: SET &NUM# = ADD (1,2)
You can create script variables with a particular data type (:DEFINE) or have the data type retrieved during the value assignment.
Variables that are created by using :SET do not have a certain data type but can only store positive integers or strings. Any attempt to assign a negative value to such a variable will result in a runtime error.
The attempt to assign a positive floating-point number causes the decimal places to be truncated.
The following peculiarities apply for script variables that have a data type:
If the assigned variable does not correspond to the script variable's data type, the system tries to correct and adjust it. A runtime error occurs if this is not possible as the following two error cases show:
Error case 1:
A negative number is assigned to a script variable of data type "unsigned".
For example:
6 Chapter 1 Introduction
: DEFINE &NUM# , unsigned
: SET &NUM# = -1
Error case 2:
A string that is not a number is assigned to a script variable that has a numerical data type (unsigned, signed or float).
For example:
: DEFINE &NUM# , signed
: SET &NUM# = "abc123"
The assignment works correctly if the string is a number.
For example:
: DEFINE &NUM# , signed
: SET &NUM# = "-123"
Assigning a floating-point number to a variable although its data type does not support it (such as "signed" and "unsigned") has the effect that the decimal places are truncated and not rounded.
For example: The assignment result is -10 in this case.
: DEFINE &NUM# , signed
: SET &NUM# = -10.654
: P &NUM#
Report:
-0000000000000010
By default, numbers have a 16-digit format. Floating-point numbers (data type float) also include 16 decimal places. Zeros are inserted in places that are not used. You can use the script function
in order to remove leading or final zeros.
1.2.4 Script Literal
A script literal consists of a freely selectable string that is put in single (') or double (") quotation marks.
For example:
"UC4 Automation Platform"
A script literal can also contain
which are replaced by their values when the script line containing the script literal is processed.
For example:
: SET &TIME# = SYS_TIME ( "HH:MM:SS" )
: PRINT "Time &TIME#"
Output:
Time 10:30:05
UC4 Name
The UC4 name is a particularity of the script literal. It does not have to be enclosed in single or double quotation marks. UC4 names are:
Automation Engine 7 l l l
Object names,
Attribute of objects or short forms of object types
For example:
: SET &STATUS# = SYS_HOST_ALIVE (WIN01)
Quotation marks are always required when the UC4 name starts with a number.
Note that using the string <![[ ]]> in script literals results in a syntax error and the object cannot be stored. There are several solution strategies to avoid this error:
1. Insert a comment which includes these characters.
Example:
!<![[ ]]>
: PRINT '<![[ ]]>'
2. This error only occurs if the described characters are used one after the other. Hence, you can also compose a string of 2 different script literals.
Example: Use script variables
: SET &VAR# = "]]"
: PRINT '<![[ &VAR#>'
Example: Use the script element STR_CAT
: SET &VAR# = STR_CAT ( "<![[ ]]" , ">" )
: PRINT &VAR#
Another peculiarity is the reserved combination ##<number>. If you use this string in a script literal, the text is included in the message whose number is specified in <number>. Keep this in mind when you use script literals.
For example:
: PRINT "##1800" or
: PRINT ##1800 shows the following result in the result:
2011-06-15 13:01:51 - U0020408 ENDED_NOT_OK - aborted.|
1.2.5 Scripting Tabs
Process tabs can be used to write UC4 Script. One or several of them are available in every executable object.
The following list gives a comprehensive overview of all scripting (Process) tabs:
Process Tab (in all Executable Objects)
The particular point in time for script processing depends on the option Generate at runtime
(Attributes tab). If this option is not checked, the script is processed immediately when the object
8 Chapter 1 Introduction starts. If "Generate at runtime" is activated, however, the script is only processed when the object is being executed.
Start and execution time of an object are not necessarily the same (for example, if an earliest start time has been specified).
l
Pre and Post Process Tab (FileTransfer, Job and RemoteTaskManager)
Jobs additionally comprise of a pre and post-process scripting tab. These tabs are usually processed as follows: The pre-process starts off, followed by the regular script. The particular point in time depends on whether the setting "Generate at runtime" is activated. Post-script processing starts when the Job has ended (see also: Stages of Workflow Processing ). The FileTransfer and
RemoteTaskManager both only contain a Post Process tab which has the same function as in
Jobs.
l
!Process Tab (Event)
Whenever the Event occurs, the !Process tab is processed.
Note that there is also an object type called " Script ".
Each Process tab can contain up to 32767 lines. By default, only the first 1000 lines are displayed in order to avoid endless loops during the generation process and to protect the UC4 Automation Engine.
Generation is canceled if a script contains more than 1000 lines. You can change this line limit using the script statement
, attribute MAX_JCL_LINES.
1.2.6 Script Editor
Each Process tab includes a script editor which provides numerous functions that support the easy creation of scripts.
Highlighting Syntax Components
For a better distinction, the individual script parts are shown in different colors: l l l l l l green is used for comment lines blue for script statements red for script functions brown for JCL lines gray for strings purple for script variables
The script editor also highlights occurring script variables or script elements if the mouse pointer is positioned somewhere in the name.
Auto Completion
Use the shortcut CTRL + space bar for the code-completion function which completes the names of script functions and script statements. A list of possible script elements is displayed if there is more than one possible choice. Use the ESC key to close this list.
Automation Engine 9
In addition to the list referred to above, the script editor displays the particular page of the UC4
Documentation which contains a description of the highlighted script element provided that the corresponding option has been activated in the settings of the UserInterface .
Include Objects
If Include objects are used in scripts, you can have their contents displayed. Do so clicking the plus signs in the tab's left edge. It is possible to edit the displayed Include object's scripting lines. Storing the script has the effect that modifications made in the Include object are also stored.
Note that this influences alle objects that use the changed Include object.
Users without read or write permissions for the relevant Include object cannot have its content displayed nor modify it. The script lines of the Include object are displayed in light gray and cannot be edited if a user has no write permission.
10 Chapter 1 Introduction
Note that in the script, the search function includes the content of Include objects if these have been expanded using the plus sign. Also, when exporting the script to a text file and when copying scripting lines Include objects include, only the contents of expanded Include objects are considered.
An Include object which has been included in a script several times can only be modified in the position where it has been expanded first. The script editor displays all other positions in light gray.
Line Prefix and Indentation
The script editor supports the quick and clear creation of scripts by assuming the current line's prefix to the subsequent line. It can also indent script lines in constructions such as :IF or :WHILE and close them with the corresponding closing statement (such as :ENDIF or :ENDWHILE). By default, each of these functions is activated ( settings of the UserInterface ).
Opening the UC4 Documentation
Highlight the name of a script function or script statement and press the F1 key. The UC4 Documentation opens exactly the page which contains the description of the relevant script element.
You can also position the mouse pointer somewhere within the name of a script function or script statement and then press the F1 key.
Popup-Menu Commands
The Process tab provides a range of functions which all provide support in the creation of scripts. Open the relevant functions via the UserInterface's toolbar or the context menu.
The following functions are provided in addition to standard commands such as undo, copy or cut: l l l
The search function does not only find strings but can also be used to replace the names of found strings.
Several lines can be commented and uncommented at the same time.
Scripts can be stored or imported to files.
Command Description
Cut
Copy
Insert
Command for text editing.
To upper case
To lower case
Modifies the notationof the highlighted text.
Undo
Redo
Comment
Block
Uncomment
Block
Undoes the last action.
Undoes the last undone action.
Adds an exclamation mark at the beginning of one or several lines. These lines are then comment lines.
Removes the exclamation mark at the beginning of one or several lines. These lines are no longer comment lines then.
Automation Engine 11
Indent
Block
Outdent
Block
Indents or outdents the line or the highlighted text block.
Exclamation marks that identify comment lines and colons that identify UC4 scripting lines remain remain in the first place, only the rest of the line is indented or outdented.
Reformat all Formats all lines of the current tab in UC4 scripting style.
Example:
The line
: PRINT "Start of processing" would be formatted as shown below:
: PRINT "Start of processing"
Imports the content of a text file to the mouse-pointer position.
Import from file
Export to file
Select all
Search
Exports the whole tab content to a file.
Highlights the complete tab content.
Opens the search dialog for text passages.
1.2.7 Getting Started
The chapter, Sample Collection, contains examples describing the use of script elements in combination with objects. Deep insight into UC4's scripting language is provided for experienced users as well as those who have not yet worked with script languages.
l
Overview Sample Collection
All script elements are listed in the UC4 Documentation in alphabetical as well as functional order. Use the following overview to get the particular required script element quickly and easily.
l l
Overview -
Overview -
With the F1 key, the UC4 Documentation can be opened from all script tabs of objects. The exact page describing the particular script element opens when you either highlight the name of the script element
(e.g.
PRINT ) or position the mouse pointer somewhere in the name of the script. Thus, the required syntax description can always easily be accessed.
1.3 Advanced Users
1.3.1 Using Script Components
Many UC4 objects use the same processing steps in their scripts. UC4 recommends storing them in
Include objects in order to avoid repeated creation and maintenance being required in every script. In doing
12 Chapter 1 Introduction so, you can acquire a collection of script components that can easily be maintained and reduce the time required for writing scripts considerably.
How to use Include objects:
1. Store frequently used blocks of script lines in Include objects.
2. Call the script statement
indicating the name of the Include object in the particular script section in which the script lines should be included at runtime.
3. The above script element also contains a parameter which can be used to adjust the script lines to an object as it facilitates a particular string to be replaced. This assignment is only valid for the current generation and does not change the Include object itself.
The Include object's script lines are copied to the object's exact script position at which :INCLUDE is called. Hence, script functions refer to the particular object and not to the Include object. For example, the script function SYS_ACT_ME_NAME supplies the object name and not the name of the Include object.
You can use the script editor to display and edit the contents of your Include objects. You expand the
Include object by clicking the plus symbol on the left edge. When you edit the script of an expanded
Include object and store the object, your modifications apply to the complete Include object. This influences also all objects that use the modified Include object!
The rights assignment for users (write access to Include objects) will help you prevent unwanted modifications in Include objects.
1.3.2 Error Handling
Note that errors might occur when UC4 scripts are written. Take reasonable precautions is therefore highly recommended.
Creating a Script
A possible source of error already lies in the creation of a script. Therefore, the syntax of the applied script functions and statements is checked whenever the object is stored. An error message is displayed if too many/few parameters were used, for example. The error message also contains the line number in which the error occurred.
Only the syntax of the script is checked. The specification of correct values (e.g. object names), however, is entirely in your hands.
Using Return Codes
Return codes of functions inform about the results of script functions. The documentation about script elements also includes the return codes that can be supplied for each script element for further evaluation.
Using :ON_ERROR
An error message is displayed and the script is canceled if an error occurs during the execution of a script.
This, however, does not apply to all script elements.
can be used then in order to determine whether a script should be canceled or not. If not, the error message can be accessed with the special script functions
and
.
Automation Engine 13
1.3.3 Using Variable Objects
Values can be stored in
and also in static Variable objects . Especially when there are lots of values, Variable objects provide a very comfortable way of storing them. UC4 Script offers several script elements that can be used to store, read or delete values in Variable objects.
Values always go together with a key through which access to the particular value is provided.
Variable objects can either be handled manually in the Explorer of the UserInterface or by using the following script elements: l l l
- creates a new Variable object
- changes the attributes of a Variable object
- deletes a Variable object
Loading with Values
Use the script statement :
to store values. If the validity key does not yet exist, the new value is added to the Variable object. Otherwise, the existing value is replaced.
Reading Values
The script function
can be used to retrieve particular, several or all values that are stored in a Variable object.
Deleting Values
The script statement
removes values from a Variable object.
1.3.4 Changing Object Attributes
Every object possesses numerous attributes which have impacts on processing (e.g. the priority or start type). Occasionally it might become necessary to change a particular attribute (when the target host in a
FileTransfer should be changed if a particular Calendar condition applies or if the host is not active), for example.
Hence, UC4 Script contains the script elements
and
GET_ATT . Both of them can be used to
set and read the attributes of objects.
: PUT_ATT GROUP = "MM.GROUP"
: SET &START# = GET_ATT (GROUP)
Refer to the User Guide to get a list of the attributes of all objects including their possible values.
Additional script elements are available for Notifications: l l l l
- adds recipients to a Notification at runtime
- removes recipients from Notifications at runtime
- extends the message text of a Notification at runtime
- supplies part of the message text in a Notification
14 Chapter 1 Introduction
1.3.5 Return Codes of Functions
Script functions supply return codes, which distinguishes them from script statements. Return codes can be individual characters, strings or numbers. Note that numbers are always supplied in 16 digits with leading zeros.
Example:
: SET &SUMME# = ADD (2,2)
: PRINT &SUMME#
The result that can be displayed with the PRINT function looks as shown below:
0000000000000004
If numbers should be output (e.g. in the report), the leading zeros can be removed with the script function
FORMAT . The zeros, however, do not affect the further processing of the number (e.g. arithmetic
operations).
The return code can also contain an error number. The descriptions of the script elements include more detailed information about possible error types and their meanings. Particular
are available that allow for the further handling of the error number.
Some script elements must be used in combination in order to submit valuable information. The script function
, for example, generates a data sequence from the content of a text file.
The return code is a handle. The individual lines of the text file can be read with the script function
which requires the handle that was retrieved with PREP_PROCESS_FILE.
1.3.6 Calculations
This document describes the arithmetic operations which can be used with UC4 Script.
Script elements
UC4 Script provides four basic arithmetic operations in the form of script elements: l l l l
Additionally, the script function
can be used to retrieve the rest of a division.
If required, the script function RANDOM
can be used to generate random numbers.
The results of arithmetic operations are stored in
.
Example:
: SET &DIFFERENCE# = SUB (100,50)
Negative numbers (data type "signed") and decimal numbers (data type "float") are supported arithmetic
"string" is not allowed for arithmetic operations.
Automation Engine 15
Decimal places of results are truncated if the target variable's data type does not support decimal numbers.
A runtime error occurs if an arithmetic operation supplies a negative result and the target variable's data type does not support algebraic signs .
UC4 recommends using the operation's highest data type as the target variable's data type (see table).
The operation's result must not exceed the value "9 999 999 999 999 999".
Data types of operands
unsigned, unsigned unsigned, signed unsigned, float signed, signed signed, float float, float
Allowed data types for the target variable
unsigned, signed, float signed, float float signed, float float float
The highest data type is "float" (negative and positive decimal numbers). It is followed by "signed"
(negative and positive integers). The lowest data type is "unsigned" which only supports positive integers.
Example: The data type of the result variable "&SUM#" must at least be "signed". Data type "float" can also be used.
: DEFINE &UNSIGNED# ,unsigned
: DEFINE &SIGNED# ,signed
: DEFINE &SUM# ,signed
: SET &UNSIGNED# = 12
: SET &SIGNED# = -5
: SET &SUM# = ADD ( &SIGNED# , &UNSIGNED# )
The following line would result in a scripting error:
: SET &UNSIGNED# = ADD ( &SIGNED# , &UNSIGNED# )
Note that arithmetic operations that include floating point numbers can cause inaccurate results.
Solving an arithmetic expression
In UC4, you can also solve an arithmetic expression using the script element
and store the result in a variable. Doing so reduces and simplifies a script's length significantly.
An error occurs if the target variable's data type is "unsigned" and the operation results in a negative number. If the target variable's data type does not support decimal places, they are truncated.
An operation can include the four basic arithmetic operations,parentheses and signs.
l l l l l l
Addition
Subtraction
Multiplication
Division
Parentheses "()"
Signs
16 Chapter 1 Introduction
A line that includes arithmetic operators (+,-,*,/) is handled as an expression. Do not use single or double quotation marks for the expression. Otherwise, the expression cannot be interpreted as a string.
Attention: You must not use script functions within arithmetic expressions.
Note that multiplicative operations (multiplication and division) take precedence over additive operations (addition and subtraction).
Example:
: DEFINE &UNSIGNED# ,unsigned
: DEFINE &FLOAT# ,float
: DEFINE &RES# ,float
: SET &UNSIGNED# = 12
: SET &FLOAT# = -0.50
: SET &RES# = &FLOAT# *3 + (&UNSIGNED# ) - 3
See also:
Script element
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Performs an addition.
Performs a subtraction.
Performs a multiplication.
Performs a division.
Returns the remainder of a division.
Generates random numbers.
Checks if a bit is set in a bit field.
1.3.7 Strings
UC4 Script contains several script elements which can be used to edit strings. The most important strings are explained in this list. A list of all string functions is provided in a
.
Comparing characters
Description
- compares two strings with each other
Example
: SET &COMPARISON# = STR_MATCH ( "UC4" ,
"global" )
Result
N
Connecting characters
Description
- connects two strings
Example
: SET &STRING# = STR_CAT ( "UC4" , " system" )
Automation Engine 17
Result
UC4 system
Line break
Description
- supplies a line break
Example
: SET &NL# = UC_CRLF ()
: SET &STRING# = "UC4 &NL# system"
Result
UC4 system
Replacing characters
Description
replaces part of the string
Example
: SET &STRING# = STR_SUBSTITUTE ( "UC4 environment" , "environment" , "system" )
Retrieving a string's length
Description
- returns the number of characters
Example
: SET &LENGTH# = STR_LENGTH
( "UC4" )
Result
UC4:system
Result
3
Searching characters
Description
- returns the location where the string is found
Example
: SET &LOCATION# = STR_FIND ( "UC4 system" , "system" )
Result
5
Truncating characters
Description
- returns part of the string
Example
: SET &PARTOFSTRING# = SUBSTR ( "UC4:system" ,
5)
Result
system
18 Chapter 1 Introduction
1.3.8 Date, Time and Period Formats
In some
and
, formats for date, time and periods can be specified. The following tables list all possible formats .
Date Format
[Date Formats]
[ Time Formats ] [ Period Formats ]
Date format abbreviations are "Y" or "J" for the year, "M" for the month and "D" or "T" for the day.
Date Format
YYMMDD or JJMMTT
YY.MM.DD or JJ.MM.TT
YY-MM-DD or JJ-MM-TT
YYYYMMDD or JJJJMMTT
YYYY.MM.DD or JJJJ.MM.TT
YYYY-MM-DD or JJJJ-MM-TT
DDMMYY or TTMMJJ
DD.MM.YY or TT.MM.JJ
DD-MM-YY or TT-MM-JJ
DDMMYYYY or TTMMJJJJ
DD.MM.YYYY or TT.MM.JJJJ
DD-MM-YYYY or TT-MM-JJJJ
MMDDYY
MMDDYYYY
MM/DD/YY
MM/DD/YYYY
Example
001231
00.12.31
00-12-31
20001231
2000.12.31
2000-12-31
311200
31.12.00
31-12-00
31122000
31.12.2000
31-12-2000
123100
12312000
12/31/00
12/31/2000
The specification of special terms is possible in date formats. Two special terms are, for example, "WW" and "LLL". "WW" for a week day as a two-digit abbreviation. "LLL" corresponds to the running day of the year.
The use of special terms for date formats is not allowed with script functions which calculate with dates.
An exception is the output format of a determined date.
Date Format (Special Terms)
YY or JJ
YYYY or JJJJ
MM
DD or TT
WW
LLL
Example
99
1999
12
31
FR
365
Automation Engine 19
Time Formats
] [Time Formats] [
Time format abbreviations are "H" for hours, "M" for minutes and "S" for seconds.
Time Format
HHMMSS
HH:MM:SS
HHMM
HH:MM
MMSS
MM:SS
Example
235959
23:59:59
2359
23:59
5959
59:59
Time Format (Special Terms)
HH
MM
SS
Example
23
59
59
Period Formats
] [Period Format]
The following abbreviations are used for period formats: "J" or "Y" for the year, "Q" for the quarter, "M" for the month and "W" for the calendar week.
The following period formats can be used in the script elements
.
Period Format
YY or JJ
YYYY or JJJJ
Q
MM
WW
WS *
Example
00
2000
3
06
53
53
* The period format "WS" can only be used in the script functions for determining the first or the last day of the period. For this period format, Sunday applies as the first day of the week. "WW" on the other hand, takes its starting day on Monday.
20 Chapter 1 Introduction
1.3.9 Sending Messages
Messages are an adequate means for pointing attention to the results of executions. UC4 provides four possible ways to send messages with script elements.
Type Description
Notification The most common method is to activate a Notification. It may be activated with the script function
ACTIVATE_UC_OBJECT . Several UC4 users may so be informed at the same
time.
This script function may be used to send email to any number of receivers.
This script statement is especially suitable for short info messages. The message is directly displayed in the message window of the particular UC4 user.
This script statement is useful if the integration opportunities of UC4 are used in
Frameworks. User-defined traps may be sent with it.
1.3.10 Script Processing
The UC4 Automation Engine processes scripts line by line. The results of executed script elements are regularly written to the UC4 Database (e.g., a value for a Variable object which has been set using :PUT_
VAR).
This process is also referred to as Commit. Other scripts can only access these new or modified values when they have been entered in the database.
The UC4 Automation Engine automatically makes a Commit every five seconds. It is additionally made in the following script elements:
The statement :WAIT 0 enforces a Commit.
Automation Engine 21
1.4 Non-Supported Script Elements
Some script elements have been changed in the course of time.
The ones affected, along with more detailed information are shown below: l
As of UC4 version 8.00A, this script statement has been renamed to :REPLACE_
STRUCTURE. The former notation can still be used.
l
As of version 6.00A, the setting MAX_PARALLEL has been renamed to WORKLOAD_MAX.
The old name is still valid.
l
As of UC4 version 6.00A, this script statement has been renamed to :XML_CLOSE. The former notation can still be used.
l
As of version 6.00A, the setting MAX_PARALLEL has been renamed to WORKLOAD_MAX_
JOB. Scripts are automatically adjusted when the UC4 Database is updated.
l
As of version 8.00A, this script function has been renamed to PREP_PROCESS_
AGENTGROUP. The former notation can still be used.
l
As of version 6.00A, this script function has been renamed to XML_OPEN. The former notation can still be used.
l
and
These script functions do not support negative numbers and floating-point numbers. As of version 9.00A, the script element CONVERT can be used to convert all types of data.
l
and
These script elements have the same functions as SYS_ACT_PARENT_NAME and SYS_
ACT_PARENT_NR. They can still be used.
l
and
These two script elements have the same functions as SYS_ACT_ME_NAME and SYS_ACT_
ME_NR. They can still be used.
22 Chapter 2 Script Elements - Alphabetical Listing
2 Script Elements - Alphabetical
Listing
This document list all UC4 script elements in an alphabetical order and gives a short description about their usage.
2.1 Script Statements
[Script Statements] [
:
Script Statement
Description
Adds recipients to a Notification at runtime.
Adds a comment to a task.
Assigns a Sync object to a task.
Beginning and end of a dialog for user queries.
Discards a data sequence within a script.
Creates a script variable as a constant with a specific value.
Explicit declaration of a DATA Line in a script.
Declares a script variable with a particular data type.
Deletes one or all values of a Variable object.
Disconnects a connection to the UC4 system.
Terminates the processing of a script and sends a return code.
Deactivates the logging of a task's script.
Activates the logging of a task's script.
Stores several values in a script array.
Controls the processing of script lines during execution.
:
Branching under certain conditions.
:
Integrates an Include object into the current script.
Integrates a script into another script of the same object.
Forms JCL lines to a size of up to 2 KB.
:
Replaces a character set in the JCL with another character set.
Modifies the return code or status text of a Job when it has finished.
Determines the reaction to certain errors and messages of script elements.
Writes text to a dialog for user queries or to the activation report of an object.
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.
Automation Engine 23
Assigns a value to an object variable.
Defines script variables and arrays as object variables.
:
Sets or changes attributes of objects.
Extends the Notification's message text at runtime.
Puts name and content of a script variable in an input buffer.
:
Puts name and content of a script variable in an input buffer.
:
Stores a value in a variable object.
Queries the user in a dialog.
Registers a file as an external Job output.
Removes recipients in a Notification at runtime.
Replaces the structure of a Workflow with the structure of another Workflow at activation.
:
Sets restart points in an object.
Assigns a value to a script variable and saves it to the activation report.
Sends messages to the user of the UserInterface.
Sends an SNMP trap.
:
Assigns a value to a script variable.
Inserts/deletes a date or time period in a Calendar.
Sets the earliest start time in Workflows.
Sets error number and text.
:
Sets the values of script variables by indirect access.
Changes system settings during system operation.
Ends a UC4 system.
This cancels the processing of a script.
It verifies whether the value of a variable complies with certain values and depending on the result, it runs various statements.
Ends an Agent, a work-, or communication process.
Processing of the script is stopped for a specified time period.
Loop for repeated execution of script statements.
Closes an XML document.
2.2 Script Functions
[Script Functions]
24 Chapter 2 Script Elements - Alphabetical Listing
Script Function Description
Activates an object.
Adds.
Adds days to a given date.
Adds a period to a specified date.
Adds two times.
Adds time to a Time Stamp.
Converts the name of a job or report file to a
RunID.
Calculates forecast data for future activities.
Returns the next date based on calendar conditions.
Cancels execution of an activated object.
Causes the log file to be changed.
Converts a date from one date format to another.
Converts all characters of a string to lower-case.
Converts date and time for use in another time zone.
Converts all characters of a string to upper-case.
Converts the data type of a value.
Creates an object (Calendar, Login and Variable only).
Creates a new data sequence.
Returns the current day of the year.
Determines the difference between two date entries in days.
Returns the difference between two time entries.
Divides.
Exports objects to an XML file.
Searches a script array and returns the corresponding index.
Determines the first day of the period for a specified date.
Creates a forecast of a given object.
Creates a forecast of a running task.
Changes the formatting of a number.
Returns the values of attributes of an object during its generation.
Supplies part of the message text in a
Notification.
Predefined
Variable
Automation Engine 25
Checks if a bit is set in a bit field.
Determines the earliest start time in Workflows.
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.
Retrieves the message text of the last error.
Retrieves the type of a message number.
Reads information from Login objects.
Returns a task's object type.
Supplies an object's internal number.
Returns the name of the superordinate task
(Parent).
Returns the run number of the superordinate task
(Parent).
Returns the object type of the superordinate task
(Parent).
Retrieves information of a data sequence
Returns the content of the current line of a data sequence.
Retrieves the value or PromptSet variable of a certain task.
Returns the values of script variables by indirect access.
Retrieves details from the statistical record of an executable object.
Queries the current condition or value of a Sync object.
Returns the RunID of an activated object.
Returns the status of an activated object.
Determines the name of the work process in which the script runs.
Reads current system settings.
Determines the name of the UC4 system.
Returns the content of a variable object.
Determines entries in the Windows system, security and application logs if an Event occurs.
Converts a character set into hexadecimal form.
Controls ILM functionality.
&$SYSTEM#
26 Chapter 2 Script Elements - Alphabetical Listing
Imports objects from an XML file.
Checks a user's membership status within a user group.
Checks if a character set is numeric.
Determines the last day of period of a specified date.
Retrieves the size of a script array.
Loads a stored data sequence.
Copies string characters.
Returns the remainder of a division.
Changes an existing object (only Calendar, Login and Variable).
Processes ServiceManager actions or Queue modifications.
Modifies active Workflows.
Modifies the attribute of an activated object.
Moves an object to a folder.
Multiplies.
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.
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).
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).
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).
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).
Adds a line to a certain data sequence
Generates random numbers.
Deletes an existing object.
Continues a certain Workflow.
Repeats the execution of a task.
Executes the rollback of a specific task
Converts the RunID to the corresponding file names.
Stores a certain data sequence.
Sends email to a user.
Executes the defined action of a Sync object.
Combines two strings to a new string.
Copies string characters.
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.
Converts all characters of a string to lower-case.
Returns the length of a string.
Returns the length of a string.
Deletes empty spaces at the beginning of a character set.
Extends a string to a certain length.
Compares two character sets.
Reverses the order of the characters within a string.
Deletes the empty spaces at the end of character set.
Splits a string to several parts using a separator.
Replaces character or string within a string.
Replaces script-variable names by their values.
Removes empty spaces at the beginning and the end of a character set.
Automation Engine 27
28 Chapter 2 Script Elements - Alphabetical Listing
Converts all characters of a string to upper-case.
Subtracts.
Subtracts days from a given date.
Subtracts a period from a specified date.
Subtracts two times.
Subtracts time from a Time Stamp.
Copies string characters .
Returns the number of the current client.
Returns the text of the current client.
Returns the name of the host.
&$CLIENT#
&$CLIENT_DESC#
Determines if a task was activated in a Workflow. &$IN_
PROCESSFLOW#
Returns the name of the own object.
Returns the run number (RunID) of the own object.
&$NAME#
&$RUNID#
Returns the object type of the own object.
Supplies the name of a superordinate task.
&$OBJECT_
TYPE#
&$ACTIVATOR#
&$PROCESSOR#
Supplies the run number (RunID) of the superordinate task.
Returns the object type of the superordinate task.
&$ACTIVATOR_
TYPE#
&$PROCESSOR_
TYPE#
Returns the name of the previous task in a
Workflow.
&$ACTIVATOR_
RUNID#
&$PROCESSOR_
RUNID#
Returns the run number (RunID) of a previous task in a Workflow.
Returns the partner type of the user.
&$PARTNER_
TYPE#
&$RESTARTED#
Retrieves whether the object was activated in restart mode.
Supplies the number of restarts that have been executed for Workflow tasks using the script statement RESTART TASK (Post-Conditions).
&$RESTART_
COUNT#
Returns the run number (RunID) of an object activated in restart mode.
Supplies the name of the top Workflow.
&$RESTART_
RUNID#
&$TOP_
PROCESSFLOW_
NAME#
Automation Engine 29
Supplies the run number (RunID) of the top
Workflow.
&$TOP_
PROCESSFLOW_
RUNID#
Supplies the User ID under which the Job will run.
Returns the number of all activated objects.
Returns the size of the workload of the UC4
Automation Engine during the last minute (in percent).
Returns the size of the workload of the UC4
Automation Engine during the last 10 minutes (in percent).
Returns the size of the workload of the UC4
Automation Engine during the last hour (in percent).
Returns the current date at the beginning of the script processing
Returns the current date
&$DATE_format#
&$PHYS_DATE_
format#
Checks if a certain host is active
Reads UC4-system information
Supplies the variable message part of the error that has last occurred.
Returns the number of the error that has last occurred.
Retrieves the last-occurred error message from the operating system.
Supplies the name of the previous restart point in the script.
Supplies the text of the previous restart point as defined in the script.
Returns the logical date.
Checks if an object is already active.
Checks if a job has already been activated.
Supplies the restart point from which the object will be executed.
Checks if a certain server process is active.
Checks if the SNMP connection (Simple Network
Management Protocol) of UC4 if active.
Returns the number of jobs that are registered in groups.
Checks if a Workflow has already been activated.
Retrieves the current time of day at the beginning of the script processing.
&$LDATE_format#
&$RESTART_
POINT#
&$SNMP_
ACTIVE#
&$TIME_format#
30 Chapter 2 Script Elements - Alphabetical Listing
Determines the current time of day.
&$PHYS_TIME_
format#
Provides current date and time.
Checks if a user is logged with a UserInterface in
UC4.
Supplies the department of the user who started the task.
Supplies the language in which the Server generates the log files.
Supplies the first and last name of the user who started the task.
Supplies the name of the user who started the task.
Stops or starts the automatic processing of several object types .
Stops or starts automatic processing of a client.
Returns a page break.
Checks whether a date is included in the
Calendar keyword.
Checks if the date is valid.
Checks if the time is valid.
Returns the calendar week of a given date.
Returns the day of a week of a given date as a number.
Returns the day of the week of a given date as an abbreviation.
Beautifies the display of an element's structure.
Supplies the value of an attribute.
Counts the sub-elements of an element.
Identifies the first sub-element of an element.
Identifies the last sub-element of an element.
Identifies the succeeding element.
Supplies the name of an element.
Supplies the text of an element.
Opens an XML document for processing.
Writes the XML document in a file.
Identifies any element.
Extracts the year from a given date.
&$DEPARTMENT#
&$SYS_
LANGUAGE#
&$USER_FL#
&$USER#
Automation Engine 31
3 Ordered by Function
3.1 Script Elements - Ordered by Function
The overview that is shown below lists all UC4 script elements in groups of similar functional areas.
3.1.1 Handling Objects
[Handling Objects] [
] [ Reading or Modifying Objects
] [ Script Structure and Processing
] [
] [
] [ Event Handling ] [ System Conditions and Settings
] [
] [
]
Script Element
Description
Registers a file as an external Job output.
Creates an object (Calendar, Login and Variable only).
Exports objects to an XML file.
Imports objects from an XML file.
Changes an existing object (only Calendar, Login and Variable).
Moves an object to a folder.
Deletes an existing object.
3.1.2 Activating Objects
[Activating Objects]
[ Reading or Modifying Objects
] [ Script Structure and Processing
] [
] [
] [
] [
] [
System Conditions and Settings
] [
] [
]
Script Element
Description
Beginning and end of a dialog for user queries.
:
Writes text to a dialog for user queries or to the activation report of an object.
Puts name and content of a script variable in an input buffer.
Puts name and content of a script variable in an input buffer.
:
Queries the user in a dialog.
Activates an object.
Calculates forecast data for future activities.
Cancels execution of an activated object.
32 Chapter 3 Ordered by Function
Creates a forecast of a given object.
Creates a forecast of a running task.
Continues a certain Workflow.
Repeats the execution of a task.
Executes the rollback of a specific task
Returns the number of all activated objects.
Checks if an object is already active.
Checks if a job has already been activated.
Retrieves the number of jobs that are registered in groups.
Checks if a Workflow has already been activated.
Stops or starts the automatic execution of several object types .
3.1.3 Reading or Modifying Objects
[ Handling Objects ] [ Activating Objects ]
[Reading or Modifying Objects]
[ Script Structure and Processing
] [
] [
] [
] [
] [
System Conditions and Settings
] [
] [
]
Script Element
Description
Adds recipients to a Notification at runtime.
Adds a comment to a task.
Assigns a Sync object to a task.
Deletes one or all values of a Variable object.
Modifies the return code or status 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.
Removes recipients in a Notification at runtime.
Replaces the structure of a Workflow with the structure of another Workflow at activation.
Inserts/deletes a date or time period in a Calendar.
Sets the earliest start time in Workflows.
Closes an XML document.
Returns the values of attributes of an object during its generation.
Automation Engine 33
Supplies part of the message text in a Notification.
Determines the earliest start time in Workflows.
Liest Informationen aus Login-Objekten.
Returns a task's object type.
Supplies an object's internal number.
Retrieves the value or PromptSet variable of a certain task.
Retrieves details from the statistical record of an executable object.
Queries the current condition or value of a Sync object.
Returns the content of a Variable object.
Modifies active Workflows.
Modifies the attribute of an activated object.
Executes the defined action of a Sync object.
Beautifies the display of an element's structure.
Supplies the value of an attribute.
Counts the sub-elements of an element.
Identifies the first sub-element of an element.
Identifies the last sub-element of an element.
Identifies the succeeding element.
Supplies the name of an element.
Supplies the text of an element.
Opens an XML document for processing.
Writes the XML document in a file.
Identifies any element.
3.1.4 Script Structure and Processing
[ Handling Objects ] [ Activating Objects
] [ Reading or Modifying Objects ]
[Script Structure and Processing]
] [
] [
] [
] [
System Conditions and Settings
] [
] [
]
Script Element Description
34 Chapter 3 Ordered by Function
:
:
:
Creates a script variable as a constant with a certain value.
Explicit declaration of a DATA line in a script.
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.
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 object into the current script.
Integrates a script into another script of the same object.
Forms JCL lines to a size of up to 2 KB.
Replaces a string in the JCL with another string.
Assigns a value to an object variable.
Defines script variables and arrays as object variables.
Sets restart points in an object.
Assigns a value to a script variable and saves it to the activation report.
Assigns a value to a script variable.
Sets the values of script variables by indirect access.
It verifies whether the value of a variable complies with certain values and depending on the result, it runs various statements.
This is used to stop processing of the script for a specified period of time.
Meanwhile, other tasks are completed.
Loop for repeated execution of script statements.
Searches a script array and returns the corresponding index.
Returns the values of script variables by indirect access.
Retrieves the size of a script array.
3.1.5 Error Handling and Messages
[ Handling Objects ] [ Activating Objects
] [ Reading or Modifying Objects
] [ Script Structure and Processing ]
[Error
Handling and Messages] [
] [
] [
] [
] [
System Conditions and Settings
] [
] [
]
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 UserInterface.
Sends an SNMP trap.
Automation Engine 35
:
Sets error number and text.
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.
Returns the number of the error that has last occurred.
Retrieves the last-occurred error message from the operating system.
3.1.6 Activation Data
[ Handling Objects ] [ Activating Objects
] [ Reading or Modifying Objects
] [ Script Structure and Processing
[Activation Data] [
] [
] [
] [
System Conditions and Settings
] [
] [
]
Script Element Description Predefined
Variable
Returns the object type of the superordinate task (Parent).
Returns the RunID of an activated object.
This returns the status of an activated object.
Returns the name of the superordinate task
(Parent).
Returns the run number of the superordinate task (Parent).
Returns the name of the host.
Determines if a task was activated in a
Workflow.
Return the name of the own object.
Return the run number (RunID) of the own object.
Returns the object type of the own object.
&$IN_
PROCESSFLOW#
&$NAME#
&$RUNID#
Supplies the name of a superordinate task.
Supplies the run number (RunID) of the superordinate task.
&$OBJECT_
TYPE#
&$ACTIVATOR#
&$PROCESSOR#
&$ACTIVATOR_
RUNID#
&$PROCESSOR_
RUNID#
36 Chapter 3 Ordered by Function
Returns the object type of the superordinate task.
&$ACTIVATOR_
TYPE#
&$PROCESSOR_
TYPE#
Returns the name of the previous task in a
Workflow.
Returns the run number (RunID) of a previous task in a Workflow.
Returns the partner type of the user.
&$PARTNER_
TYPE#
&$RESTARTED#
Retrieves whether the object was activated in restart mode.
Supplies the number of restarts that have been executed for Workflow tasks using the script statement RESTART TASK (Post-Conditions).
Returns the run number (RunID) of an object activated in restart mode.
Supplies the name of the top Workflow.
Supplies the run number (RunID) of the top
Workflow.
&$RESTART_
COUNT#
&$RESTART_
RUNID#
&$TOP_
PROCESSFLOW_
NAME#
&$TOP_
PROCESSFLOW_
RUNID#
Supplies the User ID under which the Job will run.
Supplies the name of the previous restart point in the script.
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#
3.1.7 User Data
[ Handling Objects ] [ Activating Objects
] [ Reading or Modifying Objects
] [ Script Structure and Processing
] [User Data] [
] [
] [
System Conditions and Settings
] [
] [
]
Script Element Description Predefined
Variable
Checks a user's membership status within a user group.
Number of the current client.
Text of the current client.
&$CLIENT#
&$CLIENT_DESC#
Automation Engine 37
Checks if a user is logged with a
UserInterface in UC4.
Supplies the department of the user who started the task.
Supplies the first and last name of the user who started the task.
Supplies the name of the user who started the task.
&$DEPARTMENT#
&$USER_FL#
&$USER#
3.1.8 Data Sequences
[ Handling Objects ] [ Activating Objects
] [ Reading or Modifying Objects
] [ Script Structure and Processing
] [
] [Data Sequences] [
] [
System Conditions and Settings
] [
] [
]
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.
Creates a new data sequence.
Retrieves information of a data sequence
Returns the content of the current line of a data sequence.
Loads a stored data sequence.
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.
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).
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).
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).
38 Chapter 3 Ordered by Function
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).
Adds a line to a certain data sequence.
Stores a certain data sequence.
3.1.9 Event Handling
[ Handling Objects ] [ Activating Objects
] [ Reading or Modifying Objects
] [ Script Structure and Processing
] [
] [Event Handling]
[ System Conditions and Settings
] [
] [
]
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 application logs if an
Event occurs.
3.1.10 System Conditions and Settings
[ Handling Objects ] [ Activating Objects
] [ Reading or Modifying Objects
] [ Script Structure and Processing
] [
] [
] [
] [System Conditions and Settings] [
] [
]
Script Element Description Predefined
Variable
Disconnects a connection to the UC4 system.
Changes system settings during system operation.
Ends a UC4 System.
Ends an Agent, a work-, or communication process.
Causes the log file to be changed.
Determines the name of the work process in which the script runs.
Reads current system settings.
Determines the name of the UC4 system.
Controls ILM functionality.
Processes ServiceManager actions or Queue modifications.
&$SYSTEM#
Automation Engine 39
Returns the size of the workload of the UC4 Automation
Engine during the last minute (in percent).
Returns the size of the workload of the UC4 Automation
Engine during the last 10 minutes (in percent).
Returns the size of the workload of the UC4 Automation
Engine during the last hour (in percent).
Checks if a certain host is active.
Reads UC4-system information.
Checks if a certain server process is active.
Checks if the SNMP connection (Simple Network
Management Protocol) of UC4 if active.
Supplies the language in which the Server generates the log files.
Stops or starts automatic processing of a client.
&$SNMP_
ACTIVE#
&$SYS_
LANGUAGE#
3.1.11 Date and Time
[ Handling Objects ] [ Activating Objects
] [ Reading or Modifying Objects
] [ Script Structure and Processing
] [
] [
] [
] [
System Conditions and Settings
] [Date and Time] [
]
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 time zone.
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 period of a specified date.
Subtracts days from a given date.
Subtracts a period from a specified date.
Subtracts two times.
40 Chapter 3 Ordered by Function
Subtracts time from a Time Stamp.
Returns the current date at the beginning of the script processing.
Determines the current date.
Returns the logical date.
Returns the current time of day at the beginning of the script processing.
Determines the current time of day.
&$DATE_
format#
&$PHYS_
DATE_
format#
&$LDATE_
format#
&$TIME_
format#
&$PHYS_
TIME_
format#
Provides current date and time.
Checks whether a date is included in the Calendar keyword.
Checks if the date is valid.
Checks if the time is valid.
Returns the calendar week of a given date.
Returns the day of a week of a given date as a number.
Returns the day of the week of a given date as an abbreviation.
Extracts the year from a given date.
3.1.12 Arithmetic
[ Handling Objects ] [ Activating Objects
] [ Reading or Modifying Objects
] [ Script Structure and Processing
] [
] [
] [
] [
System Conditions and Settings
] [
] [Arithmetic]
]
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
Automation Engine 41
3.1.13 Strings
[ Handling Objects ] [ Activating Objects
] [ Reading or Modifying Objects
] [ Script Structure and Processing
] [
] [
] [
] [
System Conditions and Settings
] [
] [
[Strings]
Script Element
Description
Converts the name of a Job or report file to a RunID.
or
Convert all characters of a string to lower-case.
or
Convert all characters of a string to upper-case.
or
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 .
or
Converts the RunID to the corresponding file names.
Combines two strings to a new 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.
Return the length of a string.
Deletes empty spaces at the beginning of a string.
Extends a string to a certain length.
Compares two string.
Reverses the order of the characters within a string.
Deletes the empty spaces at the end of string.
Splits a string to several parts using a separator.
Replaces character or string within a string.
Replaces script-variable names by their values.
Removes empty spaces at the beginning and the end of a string.
Returns a page break.
42 Chapter 3 Ordered by Function
3.2 Handle Objects
3.2.1 :REGISTER_OUTPUTFILE
Script statement: Registers a file as an external Job output.
Syntax
:REGISTER_OUTPUTFILE
File, User Login
Syntax
File
User Login
Description/Format
Fully qualified path and name of the file that should be registered as a Job output.
Wildcard characters are not allowed. Always specify the absolute path.
Format:
Use the User's Login.
Allowed values: "Y" or "N"
Format: Script literals
Comments
You can only use this script statement in the Process tab of UNIX and Windows Jobs.
External files can also be registered as Job output using the Output tab . The difference lies in the registration time: The files of the Output tab are registered immediately when the Job is executed, regardless of whether the Job could create the file or not. If the script element is used, the specified file is only registered when it is called.
The specified file must be stored on the computer of the Agent on which the Job is executed or must be accessible from there. It makes sense to only specify files that are generated by the Job.
After the Job has been executed, the file is listed in the Directory tab and in the report dialog of the default
Job output. There, the file can be opened or stored directly via the UserInterface.
Example
The following sample script of a Windows Job writes the file list of the directory C:\temp to the file
C:\temp\test.txt. The system then verifies whether the command could successfully be executed. If so, this file is registered as Job output. Otherwise, the Job aborts.
dir C:\temp /S >> C:\temp\test.txt
@set retcode=%errorlevel% !
@if NOT %ERRORLEVEL% == 0 goto :retcode
: REGISTER_OUTPUTFILE "C:\temp\test.txt" , "N"
See also:
Automation Engine 43
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.2.2 CREATE_OBJECT
Script Function: Creates an object (Calendar, Login and Variable only).
General Information
l l l l
Only objects of the object types "Calendar", "Login" and "Variable" (only static) can be created with this Script function.
Use the script statement :ON_ERROR to define the reaction to errors that might occur. It is also possible to analyze error messages with the script functions dealing with the handling of errors (see links on bottom of this page). By default, script processing is continued but it can also be stopped.
You require a write privilege (W) for the object types Calendar, Login and Variable to be able to create them.
The script statement causes all open
of the script to be written to the UC4
Database.
Calendar
[Calendar] [
Syntax
CREATE_OBJECT
(Object Type, Object Name,
[Folder]
,
[Title]
)
Syntax
Object Type
Object Name
Folder
Title
Description/Format
Short Label of the object type
Significant value: CALE
Name of the object
Format:
or
Name of the folder in which the object is to be created
Format: script literal or script variable
Title of the object
Format: script literal or script variable
Return codes
"0" - The Calendar object was successfully created.
"20644" - There is already an object of this name.
"20710" - The object name contains invalid characters.
44 Chapter 3 Ordered by Function
Comments
A Calendar is created in the specified folder. If this folder does not exist or if this parameter is missing, the object is stored in <No folder>.
Examples
In the first example, the object "FIRM.CALENDAR2003" is created in <No folder>.
: SET &RET# = CREATE_OBJECT ( "CALE" , "FIRM.CALENDAR2003" ,, "Firm calendar for
2003" )
Login
[Login] [
Syntax
CREATE_OBJECT
(Object Type, Object Name,
[Folder], [Title]
)
Syntax
Object Type
Object Name
Folder
Title
Description/Format
Short Label of the object type
Significant value: LOGIN
Name of the object
Format:
or
Name of the folder in which the object is to be created
Format: script literal or script variable
Title of the object
Format: script literal or script variable
Return codes
"0" - The Login object was successfully created.
"20644" - There is already an object of this name.
"20710" - The object name contains invalid characters.
Comments
Usually, a Login object is created in the specified folder. If this folder does not exist or if this parameter is missing, the object is stored in <No Folder>.
Examples
In the first example, the object "LOGIN.SMITH" is created in <No Folder>.
: SET &RET# = CREATE_OBJECT ( "LOGIN" , "LOGIN.SMITH" ,, "Standard Logins" )
In the second example, a Login object is created in the folder "LOGIN_STD".
: SET &NEW# = CREATE_OBJECT ( "LOGIN" , "LOGIN.SMITH" , "LOGIN_STD" ,)
Automation Engine 45
Variable
] [
[Variable]
Syntax
CREATE_OBJECT
(Object Type, Object Name,
[Folder], [Title], [Error Handling], [Data Type],
[Validity]
)
Syntax Description/Format
Object Type
Short Label of the object type
Allowed value: VARA
Object Name
Name of the object.
Format:
or
Folder
Name of the folder in which the object is to be created
Format: script literal or script variable
Title
Error
Handling
Title of the object
Format: script literal or script variable
Handling when the variable at runtime does not contain a value
Allowed values: "E" or "I" (Default value)
Data Type
"E" = An error message is output.
"I" = The variable is initialized according to its variable type.
Variable type
Validity
Possible values: "String" (or "C"), "Number" (or "F"), "Timestamp" (or "T"), "Time" or
"Date"
Allowed values: "C" (default value), "F" or "T"
"String", "C"= Text
"Number", "F" = Number
"Timestamp", "T" = Timestamp
"Time" = Time
"Date" = Date
Scope.
Allowed values: "*", "FREE" (Default value), "HON", "JBN", "JPN", "JPS", "USN",
"USS"
"*" = No scope
"FREE" = Freely selected
"HON" = Host - each host name
"JBN" = Job - each job name
"JPN" = Workflow name - each Workflow name
"JPS" = Workflow session - each Workflow activation
"USN" = User - each user name
"USS" = User session - each user session
Return codes
46 Chapter 3 Ordered by Function
"0" - The Variable object was successfully created.
"20644" - There is already an object of this name.
"20710" - The object name contains invalid characters.
Comments
You can only create static Variable objects with this script function. Refer to the description of the
Attributes
tab of Variable objects.
A variable is created in the respective folder. If this folder or the parameter do not exist, the object is stored in <No folder>. If no optional parameter is specified, the default values "String" (for the data type), "Freely selected" (for the scope) and "Initial values" (for Key not found) are used.
Example
In this example a variable is created in which the retrieved number of files can be stored.
: SET &RET# = CREATE_OBJECT
( "VARA" , "OUTPUT.WEBHELP.VARA" , "VARIABLE/TEST" , "Number of Help files" , "I" , "F" , "FREE" )
See also:
Script element
Description
Determines the reaction to certain errors and messages of script elements
Deletes an existing object
Changes an existing object (only Calendar, Login and Variable)
Moves an object to a folder
Activates an object
Script Elements - Handle Objects
Script Elements - Error Handling and Messages
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.2.3 EXPORT
Script Function: Exports objects to an XML file
Syntax
EXPORT
(Object, File )
Syntax Description/Format
Automation Engine 47
Object
File
Name of the object(s) to be exported (with wildcard characters)
Format:
or
The wildcard characters "*" and "?" can be used. "*" stands for any, "?" for exactly one character.
Name of the file (with complete path specifications) in which the objects are to be exported
Format: script literal or Script variable
Return code
"0" - Export was successful
"20693" - The object does not exist
"21723" - The target file exists and is write-protected
Comments
With this Script function you can export objects to a specific XML file. The return value of the Script function is zero if the export was successful.
The importing and exporting functionality is not suitable for mass transports! Use the UC4 Transport
Case instead for this purpose.
With the script statement
you can determine the reaction to an incorrect export. As before, you can analyze the error with the
Script Functions for Error Handling . The script will continue to be
processed. It is also possible to cancel the processing of the script.
Before the export starts, the system checks if the file already exists. If this is the case, it will be overwritten. If the file is write-protected, the export cannot be done.
The export also fails when the user does not have the authorization "Read" (R) for the object.
Further information on exports is kept in the activation report of the object that calls up the export.
In a distributed UC4 environment (work processes run on different computers) you can not determine on which computer the export will be made. We therefore recommend specifying the UNC path under
Windows. Please note that the server should run under an appropriate domain user so that the UNC names can be accessed. For UNIX server, the absolute path must be indicated in UNIX notation.
Additionally, the FileSystem needs to be accessible (NFS; mount command) but it is not important on which computer it is located. This is the only way to assure that the actually required file is used.
The script statement causes all open
of the script to be written to the UC4 Database.
Example
In the following example, all objects with names starting with "MM.DAY", are exported. Object name and file name are transferred to the function as script variable.
: SET &OBJECT# = "MM.DAY*"
: SET &FILE# = "\\PCUC4\UC4global\EXPORT\uc4_export.xml"
: SET &RET# = EXPORT ( &OBJECT# , &FILE# )
Example for UNIX:
48 Chapter 3 Ordered by Function
: SET &OBJECT# = "MM.DAY*"
: SET &FILE# = "/opt/UC4/import/uc4_export.xml"
: SET &RET# = EXPORT ( &OBJECT# , &FILE# )
See also:
Script element
Script Elements - Handle Objects
Importing and Exporting Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Imports objects from an XML file
3.2.4 IMPORT
Script Function: Imports objects from an XML file.
Syntax
IMPORT
(File
[,[Folder], [Object Setting] [,Link Setting]]
)
Syntax
File
Folder
Object Setting
Link Setting
Description/Format
File name with full path specification for the object import.
Format:
or
Name of the folder in which the objects should be stored.
Format: script literal or Script variable
Setting for the handling of existing objects.
Format: script literal, Script variable or number
Allowed values: "0" (default value), "1"
"0" = Existing objects are skipped.
"1" = Existing objects are overwritten.
Setting for the handling of existing folder links.
Format: script literal, script variable or number
Allowed values: "0", "1" (default value)
"0" = Existing folder links are ignored.
"1" = Existing folder links are kept.
This parameter is only relevant when the object setting "1" is selected.
Return codes
Automation Engine 49
"0" - Import process was successful.
"20657" - The target folder does not exist.
"20692" - The file does not exist.
"21724" - File access is not possible due to missing authorization.
"21729" - Import not possible. The XML file to be imported does not have the required UC4 format.
"21730" - The imported XML file does not meet the required encoding.
"21732" - Error occurred during import. Further information is provided in the activation log.
Comments
This script function can be used to import objects from an appropriately formatted XML file.
Do no use the import and export function for mass transports. Use the UC4 Transport Case for this purpose.
Objects are created in the specified folder. If there is no such folder or if the parameter is missing, the script function abends with returncode 20657.
You can use the script statement
in order to determine the reaction to an erroneous import.
You can still use the
Script Functions for Error Handling
in order to analyze the import. Script processing continues. You can also cancel processing.
The XML file's standard size is limited to 1024 KB. The UC4 administrator can specify a different size in the key "MAX_IMPORT_SIZE" of the UC4 Variable UC_SYSTEM_SETTINGS.
More detailed information about the import process is written to the activation report of the object that calls the import.
The import process fails if you do not have a write access to the object or the target folder .
Attention: Imports to the folder "Version Management" are not allowed.
In a distributed UC4 environment (work processes run on different computers) you cannot determine the computer on which the import takes place. UC4 recommends specifying the UNC path under
Windows. Note that the Server must run under an appropriate domain user so that the UNC names can be accessed. If you use a UNIX Server, you must specify the absolute path in UNIX notation. The file system must also be accessible (NFS; mount command) but it is irrelevant on which computer it is located. Doing so is important in order to ensure that the required XML file is used.
This script statement causes all the script's open
to be written to the UC4 Database.
Example
The following example skips objects that already exist in the import process. File and folder name are passed on to the script function as a script variable.
: SET &FILE# = "\\PCUC4\UC4global\IMPORT\uc4_import.xml"
: SET &FOLDER# = "IMPORT/JOBS"
: SET &RET# = IMPORT ( &FILE# , &FOLDER# , "0" )
Example for UNIX:
: SET &FILE# = "/opt/UC4/import/uc4_import.xml"
: SET &FOLDER# = "IMPORT/JOBS"
: SET &RET# = IMPORT ( &FILE# , &FOLDER# , "0" )
50 Chapter 3 Ordered by Function
See also:
Script element
Script Elements - Handle Objects
Importing and Exporting Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Exports objects to an XML file.
3.2.5 MODIFY_OBJECT
Script Function: Changes an existing object (only Calendar, Login and Variable)
General Information
l l l
With this script function, you can change objects of the types Calendar, Login and Variable (only static).
Use the script statement :ON_ERROR to define the reaction to errors that might occur. You can also analyze error messages with the script functions that deal with the handling of errors (see links on bottom of this page). By default, script processing continues but it can also be stopped.
Write access (W) is required for creating the object types Calendar, Login and Variable.
l
The script statement causes all open
of the script to be written to the UC4
Database.
Calendar
[Calendar] [
Syntax
MODIFY_OBJECT
(Object name,
[Title]
,
[Calendar keyword] [,[Date format:]Date1] [,[Date format:]
Date2]]
)
Syntax
Object Name
Title
Calendar Keyword
Date Format
: or ;
Date1
Description/Format
The name of the Calendar object.
Format:
or
The title of the Calendar object.
Format: script literal or script variable
The name of the Calendar keyword.
Format: script literal or script variable
for the given date.
The separator between Date Format and Date
The starting date of the Calendar's validity period.
Specification of a date which corresponds to the Date Format
Automation Engine 51
Date2
[Date Format:]Date1 and
[Date Format:]Date2
The end date of the Calendar's validity period.
Specification of a date which corresponds to the Date Format
The start and end of the Calendar's validity.
Format: script literal or script variable
Return codes
"0" - The Calendar object was successfully changed.
"20645" - This object does not exist.
"20670" - The end date for the Calendar key is before the start date.
Comments
You can use this script function in order to change a Calendar object's title and the start and end date of a
Calendar keyword.Unused parameters leave existing Calendar definitions unchanged.
Calendar keywords can be handled with the following script elements:
- Inserts/deletes a date or time period in/from a calendar keyword .
VALID_CALE - Checks whether or not a date is included in the Calendar keyword.
Examples
This example changes the period of the Calendar keyword "WORKDAYS". The Calendar title remains unchanged.
: SET &RET# = MODIFY_OBJECT
(
"FIRM.CALENDAR"
,, "WORKDAYS" , "DD.MM.YYYY:01.05.2011" , "DD.MM.YYYY:01.05.2012" )
Login
] [Login] [
Syntax
MODIFY_OBJECT
(Object name,
[Title]
, Name, Type, Login info,
[Password]
,
[Action]
)
Syntax
Object name
Title
Description/Format
The name of the Login object.
Format:
or
The title of the Login object.
Format: script literal or script variable
52 Chapter 3 Ordered by Function
Name
Type
The name of an Agent or a backend system.
Format: script literal or script variable
Enter "*" when the Login entry should apply for all Agents or systems.
The name of backend systems is defined in your user's Login object.
The host type or application.
Format: script literal or script variable
Allowed values:
"BS2000" = Host of type BS2000/OSD
"GCOS8" = Host of type Bull GCOS 8
"JMX" = Login entry for Java EE/JMX
"MAIL" = Login entry for the mail interface
"MPE" = Host of type MPE
"MVS" = Host of type z/OS, MVS, z/OS
"OA" = Login entry for Oracle Applications
"OS400" = Host of type OS/400
"PS" = Login entry for PeopleTools
"R3" = Login entry for SAP
"SIEBEL" = Login entry for Siebel
"SQL" = Login entry for databases
"UNIX" = Host of type Unix, Linux, z/Linux
"VMS" = Host of type OpenVMS
"WINDOWS" = Host of type Windows
In addition to the listed Agent platforms, you can also specify all types that the administrator has defined in the UC4 Variable UC_LOGIN_TYPES .
Login Info
The Login information that should be used for logging on.
Format: script literal or script variable
The format for the Login info is platform and application specific. For details, see the chapter
Login object .
Password The password for the platform of the application.
Format: script literal or script variable
Action
There is no plausibility check when the script function MODIFY_OBJECT is executed.
The action that should be processed.
Allowed values: "ADD" (default value), "DEL"
"ADD" = Adds the specified user entry at the end of the list or overwrites an existing one with identical data for host, host type and Login info.
"DEL" = Removes the specified user entry from the list. There is no error code if the user entry is not available in the list. No password is necessary for deleting an entry.
Return codes
"0" - The Login object was successfully changed.
"20645" - This object does not exist.
Automation Engine 53
Comments
You can use this script function in order to change the title and login entries of Login objects.
The script function MODIFY_OBJECT for the Login object mainly automates the administration of users
(such as changing UC4 Automation Platform passwords externally).
An existing entry is changed when you specify an Agent including its type which are already available in the Login object. The scripting line has no effect when the Agent and the type do not comply with each other.
Examples
The first example sets the Login data for the user "Smith" to the host "UNIX01" in the Login object
"LOGIN.SMITH", and the password to "uc4". When the Login object already includes this entry, only the password will be changed to "uc4".
: SET &RET# = MODIFY_OBJECT
( "LOGIN.SMITH" ,, "UNIX01" , "UNIX" , "smith" , "uc4" , "ADD" )
The following example deletes the Login data for the user "smith" in client "012" of the SAP system
"SAP01" in the LOGIN object "LOGIN.SMITH".
: SET &RET# = MODIFY_OBJECT
( "LOGIN.SMITH" ,, "SAP01" , "R3" , "012,smith" , "" , "DEL" )
Variable
] [
[Variable]
Syntax
MODIFY_OBJECT
(Object name,
[Title], [Error Handling], [Data Type]
)
Syntax
Title
Description/Format
Object Name
The name of the Variable object.
Format:
or
The title of the Variable object.
Format: script literal or script variable
Error
Handling
The handling when the variable does not include a value at runtime.
Allowed values: "E" or "I"
"E" = An error message is output
"I" = The variable is initialized according to its variable type
54 Chapter 3 Ordered by Function
Data Type
The Variable type.
Allowed values: "String" (or "C"), "Number" (or "F"), "Timestamp" (or "T"), "Time" or
"Date"
"String", "C"= Text
"Number", "F" = Number
"Timestamp", "T" = Timestamp
"Time" = Time
"Date" = Date
Return codes
"0" - The Variable object was successfully changed.
"20640" - An invalid value was specified for the data type.
"20645" - This object does not exist.
"20651" - The data type cannot be changed as the Variable contains values.
Comments
You can use this script function in order to change the title, the error handling and the data type of a static
Variable object.
Keep in mind that you can only change the data type when the Variable does not include any values.
Dynamic Variable objects cannot be changed with this script function.
Examples
The following example changes a variable so that the retrieved number of files can be stored.
: SET &RET# = MODIFY_OBJECT ( "OUTPUT.WEBHELP.VARA" , "Number of Help files with frames" ,, "F" )
See also:
Script element
Description
Determines the reaction to certain errors and messages of script elements
Creates an object (Calendar, Login and Variable only)
Deletes an existing object
Moves an object to a folder
Activates an object
Script Elements - Handle Objects
Script Elements - Error Handling and Messages
Script Element - Alphabetical Listing
Script Element - Ordered by Function
Automation Engine 55
3.2.6 MOVE_OBJECT
Script Function: Moves an object to a folder.
Syntax
MOVE_OBJECT
(Object Name, Destination Folder)
Syntax
Object Name
Destination Folder
Description/Format
The name of the object.
Format:
or
The path of the folder in which the object should be moved.
Format: script literal or script variable
Return codes
"0" - The object was successfully moved.
"20645" - This object does not exist.
"20657" - The target folder does not exist.
Comments
It is irrelevant in which folder the object that should be moved is stored because it will be retrieved automatically. Existing object links are ignored and will not be moved .
You need writ access (W) to the object and the target folder as otherwise, a runtime error occurs.
When the object or the folder do not exist, a runtime error will occur if the script statement
was used with the parameter ABEND. If the folder does not exist, the object remains in its original folder.
This script statement causes all the script's open
to be written to the UC4 Database.
Example
The following example moves the object VIENNA to the sub-folder OBJECTS of the folder TIME_ZONES.
: ON_ERROR ABEND
: SET &RET# = MOVE_OBJECT ( "VIENNA" , "TIME_ZONES/OBJECTS" )
See also:
Script element
Description
Determines the reaction to certain errors and messages of script elements.
Creates an object (Calendar, Login and Variable only).
Deletes an existing object.
Changes an existing object (only Calendar, Login and Variable).
56 Chapter 3 Ordered by Function
Script Elements - Handling Objects
Script Elements - Error Handling and Messages
Script Elements - Alphabetical Listing
Script Elements - Ordered by Functions
3.2.7 REMOVE_OBJECT
Script Function: Deletes an existing object.
Syntax
REMOVE_OBJECT
(Object Name)
Syntax
Object Name
Description/Format
Name of the object that should be deleted.
Format:
or
Return codes
"0" - Deletion was successful.
"20645" - This object does not exist.
"20217" - This object is currently open for editing purposes.
"20369" - The object is in the Transport Case.
Comment
A deleted object is moved to the Recycle Bin and can be restored afterwards.
The script statement
can be used to define the reaction to errors that can subsequently be analyzed using the
Script Functions For Error Handling .
Depending on the specifications you have made, script processing either continues or is canceled.
This script statement has the effect that all open
of the script are written to the UC4
Database.
Example
This following example deletes the object "FIRM.CALENDAR2003".
: SET &RET# = REMOVE_OBJECT ( "FIRM.CALENDAR2003" )
See also:
Script element Description
Creates an object (Calendar, Login and Variable only).
Changes an existing object (Calendar, Login and Variable only).
Automation Engine 57
Moves an object to a folder.
Determines the reaction to certain errors and messages of script elements.
Script Elements - Handle Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.3 Activate Objects
3.3.1 :BEGINREAD... :ENDREAD
Script Statements: They are used to define the beginning and end of a dialog box for user queries.
Syntax
:BEGINREAD[Label[,F]]
:ENDREAD
Syntax
:BEGINREAD
Label
F
:ENDREAD
Description/Format
Beginning of the dialog box for user queries.
Name of the dialog box.
Format:
or
Default value: name of the object
Formats the text in the dialog box so that all letters are the same width.
End of the dialog box for user queries.
Comments
The script statements :BEGINREAD and :ENDREAD define the beginning and the end of a dialog box for user queries. You can put any number of
statements between those two commands, the number of which determines the size of the dialog box. Their parameters are relevant for the appearance of the dialog box and the functions of the created input fields.
Specifying a name for the dialog is optional. The object name is used if it is not specified. If the parameter
"F" is used, all letters show the same width which is helpful for exact alignment of columns.
Use the
statement, to write text to the dialog box.
The script statement causes all open
of the script to be written to the UC4 Database.
Generate at Runtime
The dialog box is not displayed if the option "Generate at runtime" (Attributes tab) is activate. The same is true if the object runs in a Workflow that uses this setting.
58 Chapter 3 Ordered by Function
Default values are used for :READ statements. If this does not result in a valid response, generation of the script is canceled.
Example
In the example, a dialog box named "Log on" is created. It requests the user to enter his department and name.
: BEGINREAD "Log on"
: READ &DEP# , "08" , "Please enter your Department" ,, M
: READ &NAME# , "08" , "Please enter your Name" ,, M
: ENDREAD
See also:
Script element
Description
Queries the user in a dialog.
This is used to write a text to a dialog for user queries or to the activation report of an object.
Script Elements - Activate Objects
Sample Collection:
Database Maintenance with Options
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.3.2 :PRINT
Script Statement: It can be used to write a text to a dialog for user queries or to the activation report of an object.
Syntax
:P[RINT]
Text
:P[RINT]
Text1, Text2
Syntax
Text, Text1, Text2
Automation Engine 59
Description/Format
Text that should be written to the dialog box or activation protocol, maximum
1024 characters for Text or Text1 + Text2.
Format:
or
Comments
This script statement can be used in two areas:
Display in the Activation Protocol
:PRINT writes the indicated text in the activation protocol. This can be useful to have processing results displayed. It can also be used to check whether the script variables have been replaced correctly. The activation protocol is part of the report.
Syntax
:PRINT Text
:PRINT Text1, Text2
Description
The text is displayed in a separate line.
Extra lines are created for Text1 and for Text2.
An extra line is only created if Text1 is specified either with single or double quotation marks. This does not apply for Text2.
Display in the Dialog Box
used to structure input masks and add explanations.
Syntax
Text
Text1,
Text2
Description
The text is displayed in a separate line.
If a
statement follows a script statement, Text1 is placed before the input request and Text2 before the text field. Otherwise, Text2 is appended to Text1.
It applies to both areas that the script variables included in the texts are replaced by their values.
TThe UC4 administrator can define whether this script statement's output should only be written to the activation log or also to the the UC4 Automation Engine's report / log file in the SERVER_OPTIONS of the UC4 Variable UC_SYSTEM_SETTINGS .
Important note :PRINT truncates blanks at the end of the text that should be output.
Examples
In this example, the output of text in the activation protocol is shown whereby the current date is used in a script variable.
: SET &DATE# = SYS_DATE (DD.MM.YY)
: PRINT "The daily evaluation of &DATE# is activated."
60 Chapter 3 Ordered by Function
In the example, the text "Enter here:" is displayed in the dialog box for user queries above the input box.
: BEGINREAD
: PRINT "" , "Enter here:"
: READ &ANR# ,, "Account number"
: ENDREAD
See also:
Script element
Description
They are used to define the beginning and end of a dialog box for user queries.
Queries the user in a dialog.
Script Elements - Activating Objects
Sample Collection:
Database Maintenance with Options
Setting End States depending on Report Contents
Retrieving Error Message and Number
Reaction to external Events
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Automation Engine 61
3.3.3 :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER
Script Statement: Puts the name and content of a script variable to the input buffer
Syntax
:PUT_READ_BUF[FER]
Variable Name = Content
:PUT_PROMPT_BUF[FER]
Variable Name = Content
Syntax
Variable Name
Description/Format
Name of the
(without &)
Format:
Content
Value that should be assigned to the script variable
or script variable
Comments
Use this script statement in combination with the function
as shown below:
1. Store script variables with :PUT_READ_BUFFER
2. Activate objects using ACTIVATE_UC_OBJECT
3. :READ can now be used to access stored script variables in the script of the activated object
:PUT_READ_BUFFER stores the script variable in a separate storage area and assigns an internal ID to it. Call this statement for each value to be stored. It is then stored in the same memory area.
The parameter Variable name is specified without the character "&" which is used with script variables.
Note that you cannot write complete script arrays to the buffer.
When ACTIVATE_UC_OBJECT is called in the script, the memory area is considered complete. As described above, the activated object can now access the script variables of this memory area.
The statement :PUT_READ_BUFFER which is used after the function ACTIVATE_UC_OBJECT uses a different storage area and assigns a new ID.
The following applies for reading script variables from the input buffer: l l
With the statement :READ, script variables are read individually. This requires the character "&" be put before the variable name.
Each script variable can only be read once. It is deleted from the input buffer as soon it is read.
This script element can also be used to set the PromptSet values for the object which has been activated with ACTIVATE_UC_OBJEC. In this case, the name of the ReadBuffer variable must comply with the name of a PromptSet variable of the started object.
Multiple use of Variable Names
It is also possible to call :PUT_READ_BUFFER several times with the same variable name. The value is not overwritten because the statement creates an individual entry for each call in the memory area. :READ
62 Chapter 3 Ordered by Function always starts searching at the beginning of the memory area when it reads a script variable. The variable's value that occurs first is returned. Then, the entry is deleted. When the script variable is read the next time, the value of its next occurrence is returned. The huge advantage is that values can be set and read in a loop.
Examples
In this first example, the script variable "DATE1" is supplied with a value and moved into the input buffer.
Then the job "EVALUATION" is activated.
: PUT_READ_BUFFER DATE1# = "01.01.2006"
: SET &ACTJOB# = ACTIVATE_UC_OBJECT (JOBS, EVALUATION)
The job "EVALUATION" uses the entry in the input buffer .
: READ &DATE1# ,,
: SET &RET# = VALID_DATE ( "DD.MM.YYYY:&DATE1#" )
The second example writes a particular value of a script array to the input buffer. Note that you cannot write a complete array to the input buffer.
: DEFINE &ARRAY# ,string,5
: SET &ARRAY# [1] = "test1"
:PUT_READ_BUFFER TEST# = &ARRAY# [1]
: SET &AKTJOB# = ACTIVATE_UC_OBJECT (PRINT)
The activated "PRINT" object reads the value from the input buffer and writes it to the activation log.
: READ &TEST# ,,
: PRINT "&TEST#"
The third example writes multiple values to the prompt buffer for a prompt where the Multi select box is checked. In this case, the "VARA#" is the name of the variable selected as the Data reference for the
PromptSet element.
: PUT_PROMPT_BUFFER "VARA#[]"="VALUE1"
: PUT_PROMPT_BUFFER "VARA#[]"="VALUE2"
See also:
Script element
Script Elements - Activate Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Queries the user in a dialog
Activates an object
Automation Engine 63
3.3.4 :READ
Script Statement: Queries the user in a dialog
Syntax
:REA[D]
InVariable,
[Input Check]
,
[Message Text] [, Default Value] [, Input Handling]
Syntax
InVariable
Input Check
Message Text
Default Value
Description/Format
User input is stored here.
Format:
Term that determines how the user input should be checked
Format:
or script variable
The following characters are possible: l l l l l
"00"
No input check (default value)
"01" to "99"
The maximal number of characters of the entered value has to correspond to this number (e.g. "10").
"min. number - max. number"
The entered number must be within this specified range (e.g."10-20").
The indicated value has to correspond to the specified date format
(e.g. YYYYMMDD).
Value, Value1 - Value2
The entered value has to be equal to a defined value or be in a certain range of values. Values and ranges of values can be freely combined
(separated through commas).
Text that is displayed and requests the user to make an entry
Format: script literal or script variable.
Default value: "Please enter value for variable Variable name"
Suggested default value that is displayed in the input field
Format: script literal or script variable.
Maximum 1024 characters
You cannot pass an empty string for the default value. You must enclose a space character in quotes.
64 Chapter 3 Ordered by Function
Input Handling
Options for specifying input handling. You can supply multiple options in any order (e.g. "MN").
Format: script literal or script variable.
The following options are valid: l l l l
"C"
If the READ statement is used within a :BEGINREAD...
:ENDREAD block, the cursor is placed in this input field.
"D"
Secured input. Characters are displayed as asterisks (*).
"I" (only for Jobs)
:READ statements and user inputs are generally documented in the generated Job object in the form of REMARK Lines. By specifying the option "I", this documentation will be suppressed.
"K"
The input can be written in lower-case letters. If this option is not used, the input is automatically written in upper-case letters.
The "K" option is only available for user interface inputs and does not affect the read buffer.
l l l
"M"
The field must not be left blank.
"N"
Only numerical characters can be entered.
"O"
The user can select an entry from the list selection or make individual entries.
"D" and "N" cannot be used together. Use the parameter Input Check for protected entries that should only contain numbers.
Example:
: READ &PASS# , "1-99999999" , "Enter password (numerical)
" ,, "DM"
Note that you must set a comma if you use Input Check without indicating a Default Value. See example above.
Comments
The :READ statement displays a dialog whose appearance and function depend on the given parameters.
The object name is displayed in the headline .
The user input can be specified in an entry field and memorized in a script variable.
This dialog is only displayed when the script runs in dialog mode . Otherwise, the default values are used.
When using this script element, make sure that the specified value is compatible with the
of the "InVariable" (target variable).
The parameters Input Check, Message Text, Default Value and Input Handling are optional. The relevant commas must always be inserted, regardless of the parameters Input Check and Message Text in the
:READ statement.
Automation Engine 65
Field
Number field
Description
If you use a continuous numerical range of values (e.g. "0-255") with the entry format "N" in the Input Check, a number field with arrows (up/down) is displayed.
List selection
Text field
If the parameter Input Check contains a fixed set of values, i.e. A,B,C, these values are then displayed in a list box.
If the parameter contains ranges (i.e. A, 5-9) an input field is created.
Specify commas and hyphens with single quotations if they should not be read as separators. Example:
Either value '1-5' or value '8,9' can be selected.
: READ &OPTION# , "'1-5','8,9'" , 'Please select' , '1-5'
You can either use letters, numbers or a combination of both for the input check. In a combination of letters and numbers, the number of characters are checked. Inputs must then be structured as shown below. The example permits the entries "A" to "F" and "1" to "999":
: READ &INPUT# , "A-F,1-9,01-99,001-999" , "Please select"
A blank (" ") is stored in the script variable if the user does not enter or select a value!
The report automatically logs the values that were entered in the dialog boxes. This function can also be deactivated for Job reports with the parameter "I". Note that protected entries (usually passwords) that were defined with the parameter "D" appear encrypted in the report.
With a :READ statement, values that have been put to the input buffer can be read (see :PUT_READ_
).
The script statement causes all open
of the script to be written to the UC4 Database.
The following particularity appears when
is used before a :READ statement:
If the script generation of :READ is canceled manually via the "Cancel" button or due to invalid default values (see "Generate at runtime"), the Variable object still contains the values that were set with
:PUT_VAR.
Examples
In querying the user for a headline - the input is not checked. It is also possible to leave the field blank. The characters are immediately converted to upper-case letters.
: READ &HEADLINE# , "00" , "Please enter headline"
66 Chapter 3 Ordered by Function
In querying the user for a headline: a default value is not specified, the input is not checked, however, entering lower-case letters is possible.
: READ &HEADLINE# ,,,, "K"
In querying a number: In this case, the parameter "N" generates a number field with arrows. Only numbers ranging from 0 - 5 are accepted.
: READ &NUMBER# , "0-5" , "Please enter number" ,, "N"
In querying the user for a date: The input has to be a valid date in the format "YYMMDD". You cannot leave the field blank.
: READ &DATE1# , "YYMMDD" , "Please specify a date (YYMMDD)" ,, "M"
In querying the user for a signature. The entry field obtains the default value "A". The input value will be checked as it can only contain "A", "X", "5", "6", "7", "8" or "9".
: READ &LKZ# , "A,X,5-9" , "Please enter List Signature" , "A"
Automation Engine 67
Requests the user to enter a password with a maximum of 8 characters. The parameter Input Handling defines the input as "secured" so that it is not converted to upper case and cannot be left blank.
: READ &PASS# , "08" , "Please enter password (max. 8 characters)" ,, "DMK"
In the example, the email address is requested. The user can select from a range of three email addresses.
In order to avoid the hyphens being interpreted as a range of values, one address is set in single quotations.
: READ &USER# , "[email protected],[email protected],'[email protected]'" , "Please select user"
The following example shows that the user can select from among three email addresses and that he can also enter a new one.
: READ &USER# , "[email protected],[email protected],'[email protected]'" , "Please select user" ,, "O"
See also:
Script element
Description
They are used to define the beginning and end of a dialog box for user queries
68 Chapter 3 Ordered by Function
This is used to write text to a dialog for user queries or to the activation protocol of an object
Puts the name and content of a script variable in the input buffer
Script Elements - Activate Objects
Sample Collection:
Database Maintenance with Options
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.3.5 ACTIVATE_UC_OBJECT
Script Function: Activates an object.
Syntax
ACTIVATE_UC_OBJECT ( Object name
[ , [WAIT] [ , [Logical Date] [ , [Time Zone] [ , , [ PASS_
VALUES] [ , [Queue] [ , [Alias] [ , [ENABLE_PROMPTS] ] ] ] ] ] ] ]
)
ACTIVATE_UC_OBJECT ( Object name
[ , , [Logical Date] [ , [Time Zone] [ ,
[ start time] [ , [ PASS_
VALUES] [ , [Queue] [ , [Alias] [ , [ENABLE_PROMPTS] ] ] ] ] ] ] ]
)
Syntax
Object Name
WAIT
Logical Date
Time Zone
Start time
PASS_VALUES
Queue
Description/Format
Name of the object.
Format: UC4 name, script literal or script variable
The keyword WAIT indicates that the script function waits until the object has ended.
Logical date that should be used if you activate the object in the date format
"YYMMDD" or "YYYYMMDD."
Format:
or
You can also specify the date in a different
date format . Do so by entering the
required date format, followed by a separator (: or ;) and then specify the date.
The date format is an optional parameter.
Name of a TimeZone object.
Time zone for time stamp calculation.
Format: script literal or script variable
Time stamp that consists of date and time ("YYYY-MM-DD HH:MM:SS").
Format: script literal or script variable
The keyword PASS_VALUES has the effect that the object variables and
PromptSet variables are passed on to the task that should start.
Specification of a particular Queue object that should be used to restart the task.
The task automatically starts in the Client Queue ( CLIENT_QUEUE ) if no
Queue has been specified.
Automation Engine 69
Alias
Alias name for the object that should be activated. It is shown in the Activity
Window and the Statistics instead of the actual object name.
Format: UC4 name, script literal or script variable
In UC4, the same rules apply for alias names and for object names:
Maximum length: 200 characters
Allowed characters: A-Z, 0-9, $, @, _, . and #
ENABLE_PROMPTS
Calls the PromptSet input mask of the activated object in the UserInterface.
Requirements:
1) A user is logged on to the UserInterface.
2) The script element must be available in an object that is started by this user.
3) When the script element is called, this user must still be logged on to the
UserInterface with the same session ID.
Script processing is neither affected if the above requirements are not met nor if no PrompSet objects are assigned to the object that should be activated.
The input dialogs are just not displayed.
Return codes
Run number (RUN#) of the activated object.
"0" - Activation was not successful.
"20423" - Task attempted to activate itself. This is not allowed because it would result in an endless loop.
Comments
The script function ACTIVATE_UC_OBJECT can be used to activate objects of the object class of executable objects.
Objects are immediately activated if no start time been specified. If a particular start time has been defined, the task is scheduled and obtains the status "Waiting for start time".
Activation and start time can be two different points in time.
You can also activate objects with a logical date. Optionally, you can specify a particular date format. The default date formats to be used are "YYMMDD" or "YYYYMMDD". Use a colon or semicolon as a separator between the date format and the date.
After a successful activation, the script function returns the object's RUN#. Return code "0" is supplied if an error has occurred.
Always query the return code. You can analyze error causes by using the script statement
and the
script functions for error handling .
Situation Return code
General
Object activation was successful
Description
RUN# This is the normal case.
70 Chapter 3 Ordered by Function
Object does not exist
No object execution rights
Object activation aborted
The starting point lies in the past.
Script generation at activation
Scripting error in object
:EXIT 0
0
0
0
0
0
Object could not be found. Activation is not possible.
The authorization system checks whether the user who has activated the object is authorized to execute it.
Tasks can be aborted either manually or through other tasks.
The start point must be in the future.
Scripting errors cause the object activation to be aborted.
RUN# This statement does not abort script processing, it terminates it. It is not handled as an error.
:EXIT <> 0 0
:STOP
NOMSG
This statement cancels the activation of the object.
RUN# This statement does not abort script processing, it terminates it. It is not handled as an error.
:STOP
MSG
Script generation at runtime
Scripting error in object
0
RUN#
This statement cancels the activation of the object.
If "Generate at runtime" has been specified in the object that should be activated, script execution does not take place during the activation process and ACTIVATE_UC_OBJECT can not identify errors that occur. The RUN# is returned such a case.
:EXIT 0 RUN#
:EXIT <> 0 RUN#
RUN# :STOP
MSG
:STOP
NOMSG
RUN#
Post process
Scripting error in object
RUN# Post scripts are processed when the execution has ended. They are not part of the activation and errors are not identified.
Automation Engine 71
Objects cannot activate themselves by using this script function. Any attempt to do so results in an infinite loop and could bring the whole UC4 system to a halt.
Note that you cannot use the parameter WAIT in combination with a start time .
A particular order is required for the parameters of this script function. Therefore, you must set commas if parameters are omitted (see examples below).
This script statement causes all the script's open
to be written to the UC4 Database.
Examples
In the first example, the job "Status" is activated and the return code is checked.
: SET &ACTOBJ# = ACTIVATE_UC_OBJECT (STATUS)
:
:
: IF &ACTOBJ# = "0"
: SET &ERRNR# = SYS_LAST_ERR_NR ()
SET
SET
&ERRINS#
&MESSAGE#
=
=
SYS_LAST_ERR_INS
GET_MSG_TXT (
()
&ERRNR# , &ERRINS# )
: SET &RET# = SEND_MAIL ( "[email protected]" ,, &MESSAGE# , "Please check.
Thank you!" )
: ENDIF
The second example activates the Job with a logical date.
: SET &ACTOBJ# = ACTIVATE_UC_OBJECT (STATUS,, "DD.MM.YY:01.12.00" )
The Workflow MM.WEEK is supposed to run in mid-July at 6 p.m. in the evening.
: SET &ACTOBJ# = ACTIVATE_UC_OBJECT (MM.WEEK,,, "MEZ" , "2005-07-15 18:00:00" )
Object variables should also be inherited to the job MM.END.PROCESSING.
: SET &ACTOBJ# = ACTIVATE_UC_OBJECT ( "MM.END.PROCESSING" ,,,,, PASS_VALUES)
See also:
Script element Description
Repeats the execution of a task.
Terminates an activated object.
Returns the RUN# of an activated object.
Creates an object (only Calendar, Login or Variable).
Determines the reaction to certain errors and messages of script elements.
Script Elements - Activate Objects
Sample Collection:
Notification with Variable Message <text
Database Maintenance with Options
Retrieving Error Message and Number
Reaction to external Events
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
72 Chapter 3 Ordered by Function
3.3.6 AUTOFORECAST
Script function: Calculates forecast data for future activities
Syntax
AUTOFORECAST
()
Return code
"0" - Forecast data was successfully created
Comments
The Auto Forecast provides information about tasks that will run within a specified period of time, thereby providing a comprehensive view on future activities. Forecast data can be calculated manually in the
UserInterface or with the script function AUTOFORECAST. Forecasts are then created for all active
Schedules and Events.
This script function only calculates forecast data for the client in which it is used.
With the script statement
you can determine the reaction to an error. As before, you can analyze the error with the
Script Functions for Error Handling . The script will continue to be processed. It is
also possible to cancel the processing of the script.
Please refer to the document "Auto Forecast" in the chapter UserInterface to get further details.
The script statement causes all open
of the script to be written to the UC4 Database.
Example
The following example shows how this script function can be used.
: SET &RET# = AUTOFORECAST ()
See also:
Script element
Script Elements - Activate Objects
Auto Forecast
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Generates a forecast for the specified object
Creates a forecast for a specified task
Automation Engine 73
3.3.7 CANCEL_UC_OBJECT
Script Function: This is used to terminate an activated object
Syntax
CANCEL_UC_OBJECT
(
RunID [, Extension]
)
Syntax
RunID
Extension
Description/Format
Run number of the activated object
Format: script literal or script variable
This additional parameter is available for specific object types.
Format: UC4 name or script literal l
For Events:
You can specify a status for an Event object on which it will then be ended.
l
Allowed values:
"ENDED_OK"
"ENDED_CANCEL"
"ENDED_TIMEOUT"
For Workflows, Schedules and Groups:
The parameter "ALL" causes that all running subordinated tasks in
Workflows, Schedules and Groups are also canceled.
Allowed value:
"ALL"
Return codes
"0" - Task was canceled successfully
"11049" - Task with this RUN# was not found and therefore not canceled
"11050" - The task has a status that cannot be canceled
"20347" - It is not possible to cancel a script with CANCEL_UC_OBJECT when it was started via a
CallAPI
Comments
The execution of activated objects can be canceled with the statement CANCEL_UC_OBJECT.
Activated objects can be accessed using the Short Label of the object type and the run number with which the object has been activated.
The script statement
can be used to determine the reaction to this error which can then be analyzed with the
Script Functions for Error Handling
. Script processing is continued but can also be canceled if necessary.
74 Chapter 3 Ordered by Function
Keep the following in mind for Events: a new instance of the activated Event is created whenever an
Event occurs. This instance has also a run number. If the Event should be terminated due to specified conditions that occurred, the RUN# can be retrieved with the function SYS_ACT_PARENT_NR.
The script statement causes all open
of the script to be written to the UC4 Database.
Examples
In the example, the Notification "ALARM3" is activated. The statement :READ is used to wait until the
Notification is displayed. After retrieving the run number and the confirmation of the user, the Notification is terminated.
: SET &JOBNR# = ACTIVATE_UC_OBJECT ( "ALARM3" )
: READ &JOBNR# ,,, &JOBNR#
: SET &STATUS# = CANCEL_UC_OBJECT ( &JOBNR# )
The example shows part of the script of an Event. When the Event occurs, the run number is retrieved and the Event is terminated.
: SET &JOBNR# = SYS_ACT_PARENT_NR ()
: SET &STATUS# = CANCEL_UC_OBJECT ( &JOBNR# )
The following lines cancel a running Event object with the status "ENDED_CANCEL".
: SET &RUNNR# = GET_UC_OBJECT_NR (EVNT.NACHT)
: SET &STATUS# = CANCEL_UC_OBJECT ( &RUNNR# , "ENDED_CANCEL" )
See also:
Script element Description
Activates an object
Repeats the execution of a task
Returns the RUN# of an activated Object
Determines the reaction to certain errors and messages of script elements.
Script Elements - Activate Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.3.8 FORECAST_OBJECT
Script Function: Generates a forecast for the specified object
Syntax
FORECAST_OBJECT
(Object Name, Title, Date, Start Time
[,Registrations][,Group_ERT]
)
Syntax Description/Format
Automation Engine 75
Object Name
Name of the object
Format:
or
Title
Name of the forecast
Format: script literal or script variable
Date Format
for the date
Default value: "YYMMDD" and "YYYYMMDD"
: or ;
Date
Separator between Date Format and Date.
Logical start date in the Format "YYMMDD" or "YYYYMMDD"
Start Time
Format:
or
You can also specify a different
date format . Do so by entering the required date format,
followed by a separator (: or ;) and then specifying the date. Date Format is an optional parameter.
Start Time of the task in the format "HHMMSS"
Format:
or
You can also specify a different
time format . Do so by entering the required time format,
followed by a separator (;) and then specifying the time. The time format is an optional parameter.
Registrations Setting whether registrations (for groups) should be considered or not.
Format: script literal or script variable
Allowed values: "Y", "N" (default value)
Group_ERT
Expected runtime (ERT) for groups. It is used when Registrations is set to 'N'.
Allowed values:
"0" - ERT of the group is used (default value)
"1" to "7199" - fixed value in seconds
Return code
"0" - The forecast was successfully created
Comments
A forecast can be created for the expected runtime of any executable object . You can create it manually in the UserInterface using the corresponding command in the UC4 Explorer's context menu. Specify your criteria and a forecast will be created for the particular object. Alternatively, you can use the corresponding script function.
With the script function, the procedure is almost the same. Define a forecast name (in capital letters and without blanks), start date and time. For date and time, you can define any format of your choice. If required, you can set the parameters Registrations and Group_ERT for tasks belonging to a group. Please note that the forecast name must not yet exist!
The return code of this function is a 16-digit number with leading zeros. The value "0000000000000000" is returned after a successful forecast creation.
Use the script element
to create forecasts of running tasks.
This script statement causes all open
of the script to be written to the UC4 Database.
76 Chapter 3 Ordered by Function
Examples
The following line creates a forecast for a FileTransfer, thereby considering date and time formats.
: SET &RET# = FORECAST_OBJECT ( "C70.WINDOWS" , "FORECAST_FT_
C70.WINDOWS" , "MM/DD/YY:11/03/03" , "HH:MM;12:30" )
The second example creates a forecast for a Job running in a group. Instead of using the ERT of this group, a fixed value of 60 second should be applied.
: SET &RET# = FORECAST_OBJECT ( "T91.REM.03" , "FORECAST_
T91.REM.03" , "MM/DD/YY:11.07/03" , "200000" , "Y" ,60)
See also:
Script element
Script Elements - Activate Objects
Forecast
Runtime Evaluation
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Calculates forecast data for future activities
Creates a forecast for a specified task
3.3.9 FORECAST_TASK
Script Function: Creates a Forecast for a specified active task.
Syntax
FORECAST_TASK
(RunID,Title
[,Registrations][,Group_ERT]
)
Syntax
RunID
Description/Format
Run number (RunID) of the activated object.
Format:
or
Title
Name of the Forecast.
Format: script literal or script variable
Registrations
Setting whether registrations (for Groups) should be considered or not.
Format: script literal or script variable
Group_ERT
Allowed values: "Y", "N" (default value)
Expected runtime (ERT) for Froups. It is used when Registrations is set to 'N'.
Allowed values:
"0" - The Group's ERT is used (default value).
"1" to "7199" - Fixed value in seconds.
Automation Engine 77
Days
Maximum number of days in the future that should be used for the calculation.
Format: Number without inverted commas, script literal or script variable
Default value: "1"
Return codes
"0" - Forecast was successfully created
"20463" - Runtime error in object '&01', line '&02'. Object RunID/Name '&04' was not found.
Comments
A Forecast can be created that shows the expected runtime of any running task. You can create it manually in the UserInterface by calling the command of the same name in the Activity Window's context menu. Define your criteria and a Forecast will be created for the task you selected. Alternately, you can use the corresponding script function.
The procedure for using the script function is similar to using it manually. Define a Forecast name (use capital letters and no blanks). If required, the parameters Registrations and Group_ERT may be set for tasks that belong to a Group. Note that the Forecast name must not yet exist.
Use the script element
to create Forecasts for objects.
This script statement has the effect that all open
are written to the UC4 Database.
FORECAST_TASK only works for active tasks.
Examples
The following line creates a Forecast for a FileTransfer.
: SET &RUNNR# = GET_UC_OBJECT_NR ( "C70.WINDOWS" )
: SET &RET# = FORECAST_TASK ( &RUNNR# , "PROGNOSE_FT_C70.WINDOWS" )
The second example creates a Forecast for a Job that runs in a Group. Instead of using the Group's ERT, a fixed value of 60 seconds should be applied.
: SET &RUNNR# = GET_UC_OBJECT_NR ( "T91.SALDO.03" )
: SET &RET# = FORECAST_TASK ( &RUNNR# , "PROGNOSE_T91.SALDO.03" , "N" ,60)
See also:
Script element
Script Elements - Activate Objects
Forecast
Runtime Evaluation
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Calculates Forecast data for future activities.
Generates a Forecast for the specified object.
78 Chapter 3 Ordered by Function
3.3.10 RERUN_UC_OBJECT
Script Function: Continues a particular Workflow.
Syntax
RERUN_UC_OBJECT
(RunID)
Syntax
RunID
Description/Format
The RunID of the Workflow whose tasks should be continued.
Format:
, number without inverted commas or script literal.
Return code
12113 - The specified task is not a Workflow. You can only rerun in a Workflow.
20282 - The object with this RunID could not be found.
Comments
"Continue" is a specific procedure that can be used for active Workflow and has to with the Rollback feature. By continuing a Workflow, you restart all its child tasks that have the status ENDED_
ROLLBACKED, ENDED_ROLLBACK_EMPTY and / or "Waiting for rollback.
Examples
The following example retrieves the status of a Job. If this status is 1904 (ENDED_ROLLBACKED), the
Workflow to which the Job belongs will continue.
: SET &RET# = GET_UC_OBJECT_STATUS (, &RUNID# , "STATUS" )
: IF &RET# = 1904
: SET &PARENT#
=
GET_PARENT_NR ( &RUNID# )
: SET &RB# = RERUN_UC_OBJECT ( &PARENT# )
: ENDIF
See also:
Script Element
Script Element - Data Sequences
Script Element - Alphabetical Order
Script Element - Ordered by Function
Description
Rolls back a particular task.
Automation Engine 79
3.3.11 RESTART_UC_OBJECT
Script Function: Repeats the execution of a task.
Syntax
RESTART_UC_OBJECT
(Object Name, Reference RunID,
[Restart Point], [Flags] [, Queue]
)
Syntax
Object
Name
Description/Format
Name of the object.
Format:
Reference
RunID
RunID to which the restart refers, or the keyword LAST for the task's last execution.
Format: script literal, number, script variable or script function
Restart
Point
You cannot repeat a task that has already been restarted because traces would become very difficult. Therefore, the RunID must refer to an original execution. The latest original execution is used in combination with the keyword LAST.
Point in the script from which execution should be restarted.
Format:
Flags
Queue
Return code
, script literal, number, script variable
This parameter can only be specified if you have specified restart points using
in the task that should be repeated.
The complete script is processed if this parameter is not used.
Instructions for the task execution.
Format: script literal or script variable
Allowed values:
GEN_JCL = Supplies the generated JCL in the activation report.
ORIGINAL_SCRIPT = Supplies the original Script in the activation report.
VAR_MOD = Supplies the modification of variables in the activation report.
ATT_MOD = Supplies the modification of attributes in the activation report.
ATT_DIALOG = Activates the Attribute Dialog.
MAN_RELEASE = Waits for manual release.
KEEP_STARTTYPE = Keeps the start type.
ONLY_ABENDED = Only repeats the subordinated tasks that were canceled.
You can specify several flags that must be separated by commas. The whole term must be written in inverted commas if these flags are named and no script variables are used.
The allowed values refer to the options that are also available for manual restarts in the dialog "Execute..." .
Specification of a particular Queue object that should be used for restarting the task.
The task automatically starts in the Client Queue ( CLIENT_QUEUE ) if no Queue has been specified.
80 Chapter 3 Ordered by Function
"0" - Task restart was successful.
"20628" - The object does not exist.
"7014" - The reference RunID does not exist.
"20346" - The restart point does not exist.
"20380" - The script element
:EXIT has ended script processing in the restarted execution.
"20385" - The object is a Schedule.
"7015" - Restarting a restarted execution is not allowed.
Comments
This script function can be used to restart tasks that have already been executed.
A task can also repeat itself if this script function is called in Post Process. Note that this can result in an infinite loop.
Note that choosing one of the four test options as Flags ("GEN_JCL", "ORIGINAL_SCRIPT", "VAR_
MOD" or "ATT_MOD") results in the Job being aborted with :STOP. This is because the default value
"N" (=No) is used as answer for the question "Do you want to start this job?".
To execute a Restart with one or all of the four test options as flags successfully, please use the
UserInterface, as described in the section " Execution with Options ".
The RunID of the task that should be re-executed is assigned to this script function with the parameter
Reference RunID. The key word LAST can also be used in order to restart a task's latest execution.
You can also specify a restart point that should be considered when the task is re-executed. The task starts but it is processed from the specified restart point. Flags are also optional and affect the task's execution.
The script statement
can be used to determine the reaction to errors. They can then be analyzed using the
Script Functions for Error Handling
. Script processing continues but can also be canceled if necessary.
This script statement has the effect that all the script's open
are written to the UC4
Database.
Examples
The following example repeats a job's the last execution. The generated JCL and the modification of variables are output in an activation log. The job waits in the Activity Window until it is manually released.
: SET &RET# = RESTART_UC_OBJECT ( "JOBS.SYSTEM.CHECK" ,LAST,, "GEN_JCL,VAR_
MOD,MAN_RELEASE" )
See also:
Script element
Description
Controls the processing of script lines during the execution of a script.
Determines the reaction to certain errors and messages of script elements.
Sets restart points in an executable object.
Automation Engine 81
Retrieves whether the object has been activated in restart mode.
Returns the run number (RunID) of an object that has been activated in restart mode.
Supplies the name of the previous restart point in the script.
Supplies the text of the previous restart point as defined in the script.
Supplies the restart point from which the object is executed.
Script Elements - Activate Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.3.12 ROLLBACK_UC_OBJECT
Script function: Runs the rollback of a specific task
Syntax
ROLLBACK_UC_OBJECT
(RunID)
ROLLBACK_UC_OBJECT
(
[Workflow RunID]
, RunID2)
Syntax
RunID
RunID2
Description/Format
The RunID of the task that should be rolled back.
Format:
Script variable , number without quotations or script literal
The RunID of the task within the Workflow to which the Workflow should be rolled back.
Format: script variable, number without inverted commas or script literal
The first parameter is an optional parameter when you define this parameter.
Workflow RunID
To roll the Workflow back to the START object, you must use the keyword
START (without inverted commas (fpr the RunID2. The Workflow's RunID is required in this case.
The RunID of the Workflow that should be rolled back to the task RunID2.
Format: script variable, number without inverted commas or script literal.
Return code
11121 - Task with the specified RunID could not be found.
12108 - Rollback for the task not possible. Rollback is not activated in the object.
12107 - Rollback not possible during the task status.
20282 - Runtime error: Object not found.
82 Chapter 3 Ordered by Function
Comments
This script element processes the rollback actions of the specified task. The processed actions depend on the object's rollback definition ( Rollback Tab ).
You can only roll back ended Workflow tasks and only when their rollback function is enabled.
When the specified task is a Workflow, all its subordinate tasks will also be rolled back.
You can also decide to roll back to a particular task within a Workflow. Use the RunID of this Workflow task for the second parameter RunID2. In the first parameter, you can optionally specify the RunID of the
Workflow in which the task runs.
To roll the Workflow back to the START object, you must use the keyword START for the RunID2. In this case, you must specify the Workflow's RunID.
Further information concerning the execution of backups and rollbacks is in the corresponding document.
Examples
The following example activates a job and checks its return code. The rollback starts when the task ends abnormally.
: SET &ACT# = ACTIVATE_UC_OBJECT (JOBS.TEST,WAIT)
: SET &RET# = GET_UC_OBJECT_STATUS (, &ACT# , "RETCODE" )
: IF &RET# > 0
: SET &RB# = ROLLBACK_UC_OBJECT ( &ACT# )
: ENDIF
See also:
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.3.13 SYS_ACTIVE_COUNT
Script Function: Returns the number of all activated objects
Syntax
SYS_ACTIVE_COUNT
(Status, Object Type
[,Object] [,Group] [,Host]
)
Syntax Description/Format
Automation Engine 83
Status
Status of all objects shown in the Activity Window
Format:
Allowed values: "*", "ANY_ABEND", "BLOCKED", "ANY_ALIVE",
"PREPARED" and "RUNNING"
"*" = tasks of any status
"ANY_ABEND" = canceled tasks
"ANY_ALIVE" = tasks of a group that are neither canceled nor finished
"BLOCKED" = blocked tasks
"PREPARED" = for a group of registered tasks
"RUNNING" = active Jobs
Object Type
Short form of the object type or "*" for all object types
Format: UC4 Name, script literal or script variable
The parameters shown below are optional filter criteria. You can use one, two or all of them in any combination. Note that commas must always be set, even if particular parameters are not used.
Example:
: SET &COUNT# = SYS_ACTIVE_COUNT ( "*" , JOBS,, "MM.GROUP" )
Object
Name of an object or filter for several objects
Format: UC4 Name, script literal or script variable
Group
Host
Wildcard characters can be used. "*" stands for any character, "?" for exactly one.
Name of a group or "*" for all groups
Format: UC4 Name, script literal or script variable
Name of an Agent or filter for several Agents
Format: UC4 Name, script literal or script variable
Wildcard characters can be used. "*" stands for any character, "?" for exactly one.
Return code
Number of objects listed in the Activity Window
Comments
The function SYS_ACTIVE_COUNT can be used to check the number of objects listed in the Activity
Window. Use parameters to limit the search to particular tasks. Filters can be specified for status, object type, object name, group and host. Any combination is possible.
The parameter Host can also be used to handle the parallel execution of a Job on a particular computer.
Check whether or not a Job is active using SYS_ACTIVE_COUNT if a Job is processed on a regular basis. You can so avoid that executions overlap. The target host can be specified subsequently using the
. Source and target host can be specified if FileTransfers are concerned.
84 Chapter 3 Ordered by Function
Using the parameter Host is only useful with objects of type "JOBS", "JOBF", "EVNT" or "*". Host filters exclude all other object types as they do not require Agents for being processed. Hence, the sample script shown below always supplies "0":
: SET &COUNT# = SYS_ACTIVE_COUNT (ANY_ABEND,JOBP,,, "*" )
Keep in mind that it is not checked whether or not the indicated Host actually exists.
When filtering active jobs using the parameter "RUNNING", all Jobs that have a system return code in the range of 1500 to 1599 are considered.
This script function's performance has been improved starting with UC4 version 6.00A. This is beneficial for the database MS SQL Server and DB2. Performance improvement is especially noticeable if many SYS_ACTIVE_COUNTs are called in succession. Tasks are now counted by uncommitted read which means that tasks that were not yet committed in the UC4 database are also counted.
Examples
The following examples count the objects listed in the Activity Window. This includes the number of all blocked and canceled objects as well as the number of all Events.
: SET &COUNT# = SYS_ACTIVE_COUNT ( "BLOCKED" , "*" )
: SET &COUNT# = SYS_ACTIVE_COUNT (ANY_ABEND, "*" )
: SET &COUNT# = SYS_ACTIVE_COUNT ( "*" , EVNT)
This example counts tasks that are registered for a specific group. The string "FILE" must appear in all task names.
: SET &COUNT# = SYS_ACTIVE_COUNT ( "PREPARED" , "*" , "*FILE*" , "GRP7" )
The following example retrieves the number of Jobs that use Agent "UNIX01".
: SET &COUNT# = SYS_ACTIVE_COUNT ( "*" , "JOBS" , "*" ,, "UNIX01" )
See also:
Script element
Script Elements - Activate Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Returns the number of Jobs that are registered in Groups
3.3.14 SYS_STATE_ACTIVE
Script Function: Checks if an object has already been activated
Syntax
SYS_STATE_ACTIVE
(
[Object Type,] Object Name]
)
Automation Engine 85
Syntax
Object Type
Description/Format
Short Label of an executable object
Format:
Object Name
Name of the object
Format: UC4 Name, script literal or script variable
Return codes
"Y" - The object is in a status with system return code < 1699 or 1701.
"N" - The object is in a status with system return code > 1699 and not 1701.
Comments
This script function checks whether or not the specified object (object class of executable objects) is in a status with a system return code below 1699 or equals the return code 1701. If none of the two parameters has been specified, the function checks the object in which it is used.
The check is made when the script line which contains this function is processed. A negative result does not provide the information whether or not the object will be activated later. Thus, this function cannot be used to synchronize processes. The information it supplies about object states is only valid for a limited period of time.
When you specify the name of the own object (= the object that is used to process the script element), your system considers this and always returns the return code "Y".
Examples
This example tests if the same object has already been activated.
: SET &ACTIVE# = SYS_STATE_ACTIVE ()
The function is used here to define a condition.
: IF SYS_STATE_ACTIVE (JOBS, "MM.END.PROCESSING" ) = "Y"
!...
: ENDIF
See also:
Script element
Script Elements - Activate Objects
Description
Checks if a Job has already been activated
Returns the number of Jobs that are registered in Groups
Checks if a Workflow has already been activated
86 Chapter 3 Ordered by Function
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.3.15 SYS_STATE_JOB_ACTIVE
Script Function: Checks if a Job has already been activated
Syntax
SYS_STATE_JOB_ACTIVE
(
[Job]
)
Syntax
Job
Description/Format
Name of a Job
Format:
Return codes
"Y" - The Job is in a status with system return code < 1699 or 1701.
"N" - The Job is in a status with system return code > 1699 and not 1701.
Comments
This script function checks whether or not the specified Job is in a status with a system return code below
1699 or equals the return code 1701. If none of the two parameters has been specified, the function checks the object in which it is used.
The check is made when the script line which contains this function is processed. A negative result does not provide the information whether or not the object will be activated later. Thus, this function cannot be used to synchronize processes. The information it supplies about object states is only valid for a limited period of time.
When you specify the name of the own object (= the object that is used to process the script element), your system considers this and always returns the return code "Y".
Example
In the example, it is tested if a job is currently active and the result is passed to a script variable.
: SET &ACTIVE# = SYS_STATE_JOB_ACTIVE (MM.END.PROCESSING)
See also:
Script element
Description
Checks if an object has already been activated
Automation Engine 87
Script Elements - Activate Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Returns the number of Jobs that are registered in Groups
Checks if a Workflow has already been activated
3.3.16 SYS_STATE_JOBS_IN_GROUP
Script Function: Returns the number of Jobs that are registered in Groups
Syntax
SYS_STATE_JOBS_IN_GROUP
(
[Job[, Group]]
)
Syntax
Job
Description/Format
Name of a Job
Format:
Group
Name of a Group
Format: script literal, object name or script variable
Return code
Number of jobs registered for Groups
Comments
This functions retrieves the number of Jobs which show the status "Registered". The parameters may to used to selectively indicate a particular Job or group whose number should be retrieved.
This script function's performance has been improved starting with UC4 version 6.00A. This is beneficial for the database MS SQL Server and DB2. Performance improvement is especially noticeable if many SYS_ACTIVE_COUNTs are called in succession. Tasks are now counted by uncommitted read which means that tasks that were not yet committed in the UC4 database are also counted.
Example
The first example retrieves all registered Jobs.
: SET &ACTIVE# = SYS_STATE_JOBS_IN_GROUP ()
The second example supplies all jobs registered for the group "MM.GROUP".
88 Chapter 3 Ordered by Function
: SET &AKTIV# = SYS_STATE_JOBS_IN_GROUP (, "MM.GROUP" )
See also:
Script element
Script Elements - Activate Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Checks if an object has already been activated
Checks if a Job has already been activated
Checks if a Workflow has already been activated
3.3.17 SYS_STATE_JP_ACTIVE
Script Function: Checks if a Workflow has already been activated
Syntax
SYS_STATE_JP_ACTIVE
(
[Workflow]
)
Syntax
Workflow
Description/Format
Name of a Workflow.
Format:
Return codes
"Y" - The Workflow is in a status with system return code < 1699 or 1701.
"N" - The Workflow is in a status with system return code > 1699 and not 1701.
Comments
This script function checks whether the specified Workflow is in a status with a system return code that is below 1699 or equals the return code 1701. If none of the two parameters is specified, the function checks the object in which it is used.
The verification takes place while the script line that contains this function is being processed. A negative result does not inform whether the object will be activated later. Therefore, you cannot use this function to synchronize processes. The information that this script function supplies about object states is only valid for a limited period of time.
When you specify the name of the own object (= the object that is used to process the script element), your system considers this and always returns the return code "Y".
Automation Engine 89
Examples
The following example checks whether the Workflow FI.DAY.SET is active. The name of the Workflow is assigned through a script variable.
: SET &JP# = "FI.DAY.SET"
: SET &ACTIVE# = SYS_STATE_JP_ACTIVE ( &JP# )
See also:
Script element
Script Elements - Activate Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Checks if an object has already been activated.
Checks if a Job has already been activated.
Returns the number of Jobs that are registered in Groups.
3.3.18 TOGGLE_OBJECT_STATUS
Script Function: Stops or starts the automatic processing of several object types.
Syntax
TOGGLE_OBJECT_STATUS
(RunID, Status
[,Tasks]
)
Syntax
RunID
Status
Tasks
Description/Format
Run number of the activated object
Format: UC4 Name, script literal or Script variable
Processing status to be set:
Format: UC4 Name, script literal or script Variable
Allowed values: "STOP" and "GO"
"STOP" - Stops automatic processing of a task
"GO" - Starts automatic processing of a task
ALL - The automatic processing of tasks which run within Workflows, Groups and Schedules is also stopped or started.
Format: UC4 Name, script literal or script variable
Return code
"0" - Status modification was successful
90 Chapter 3 Ordered by Function
Comments
This script function changes the processing of Workflows, Groups, Events, RemoteTaskManager and
Schedules.
The privilege "Modify at runtime" is required for this script function!
Example
In the example, the RunID of an Event is determined and a script variable is read. Automatic processing of the Event is stopped. At the same time, the determined RunID is given with the script variable.
: SET &RUNNR# = GET_UC_OBJECT_NR (DUMP.CONTROL)
: SET &RET# = TOGGLE_OBJECT_STATUS ( &RUNNR# , "STOP" )
: PRINT &RET#
See also:
Script element
Script Elements - Activate Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Stops or starts the automatic processing of a client
3.4 Read or Modify Objects
3.4.1 :ADD_ATT
Script statement: Adds recipients to a Notification at runtime.
Syntax
:ADD_ATT RECIPIENT
, Recipient
[, Calendar, Calendar Keyword]
Syntax
RECIPIENT
Description/Format
Name of the attribute that should be added.
Format:
Recipient
Allowed value: "RECIPIENT"
Name of a User, UserGroup or email address.
Format: script literal or script variable
Automation Engine 91
Calendar
Calendar Keyword
Name of a calendar object.
Format: script literal or script variable
Calendar keyword within this calendar.
Format: script literal or script variable
Comments
This script statement can only be used in the Process tab of a Notification. It adds the specified user, user group or email addressto the list of recipients that should be notified. Calendars can also be specified. In this case, the recipient is only notified if a defined Calendar keyword applies.
Recipients that have already been specified are overwritten because this script statement does not change the Notification object. The modified recipient list only applies for the particular execution.
Refer to the report to see the recipients that have been added by this script statement.
Note that the user must be indicated in the format User name/Department which complies with the name of the user object.
Example
The following example adds the user "BU/UC4" to the list of responsible recipients in a Notification. This user is only notified if a valid calendar day exists in the calendar "READINESS".
: ADD_ATT RECIPIENT, "BU/UC4" , "READINESS" , "WEEKDAYS"
The second example informs all members of the UserGroup "ADMIN".
: ADD_ATT RECIPIENT, "ADMIN"
See also:
Script element
Description
Removes recipients s in a Notification at runtime.
This is used to change the value of an attribute during generation.
Extends the Notification's message text at runtime.
This function returns the values of a task's attributes during generation.
Supplies part of the message text in a Notification.
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
92 Chapter 3 Ordered by Function
3.4.2 :ADD_COMMENT
Script statement: Adds a comment to a task
Syntax
:ADD_COMMENT [RunID]
, comment
Syntax
RunID
Comment
Description/Format
Run number (RunID) of the task to which a comment should be added
Format:
or number
If no RunID is specified the comment is stored in the task that executes the script statement.
Comment text
Format: script literal or script variable
Comments
Comment entries include the name of a User object. The User who is responsible for activating the object called by the script statement is automatically entered in the comment area.
The length of the comment is limited in that a script line must not exceed 1024 characters.
Example
The following example adds a comment to the task which is included in the script variable &TEXT#.
: ADD_COMMENT , &TEXT#
In the second example, the comment is stored in the highest Workflow.
: SET &TOP_JP_RunID = SYS_ACT_TOP_NR ()
: ADD_COMMENT &TOP_JP_RunID , "Successfully started FileTransfer."
See also:
Script element Description
Prepares the processing of a file sequence (comments of a task).
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 93
3.4.3 :ATTACH_SYNC
Script Statement: Assigns a Sync object to a task
Syntax
:ATTACH_SYNC [Object type,] [RunID]
, Sync Object,
[Start Action]
,
[Abend Action]
,
[End Action]
,
Other,
[NEXT_OBJECT]
Syntax
Object type
RunID
Sync Object
Start Action
Abend Action
End Action
Other
NEXT_OBJECT
Description/Format
The short form of an executable object.
Format:
or
The run number (RunID) of the object.
Format: script literal, script variable or number
The name of a Sync object that should be used to synchronize the task with.
Format: script literal or script variable
The action that should take place when the task starts.
Format: script literal or script variable
The action that should take place out when the task ends abnormally.
Format: script literal or script variable
The action that should take place out when the task ends.
Format: script literal or script variable
Task handling if neither Start Action, Abend Action nor End Action can be processed.
Format: script literal or script variable
Allowed values: "A", "W" or "S"
"A" - Abnormal end (Abend)
"W" - Wait
"S" - Skip
The Sync object should be assigned to the direct child in a Workflow.
Format: script literal or script variable
Comments
You can use this script statement in order to add a Sync object to a task that has already been activated.
This is a temporary assignment - it is only valid for the particular execution. Object type is an optional parameter because the object type can be clearly identified by its run number (RunID).
You can also use this script statement to assign a Sync object to one of the following tasks of a Workflow, thereby influencing further processing. The option Generate at runtime must be activated in tasks whose scripts contain a script statement. The following task - to which a Sync should be assigned - must already be active and have its own RunID.Therefore, the option Generate at runtime must not be activated. The parameter NEXT_OBJECT can be used to assign a Sync to the direct child of a task in a Workflow. The only restriction is that there must not be more than one child.
94 Chapter 3 Ordered by Function
This script statement can also be used to assign a Sync to the own task. The corresponding Sync conditions can vary. Optionally, you can indicate the parameter RunID. Note that you muse set a comma for this parameter in any case no matter whether you use it or not. The option Generate at runtime must not be activated in this case because the check for Sync objects is already finished when the Script is being executed.
Assigning a Sync to a different task that has already been activated is only possible with particular states.
Either the task has not yet been started (system return code < 1540) or is still in a waiting condition
(system return code between 1600 and 1700). Any other task status results in a runtime error and the
Script will be canceled.
Note that SYNC checks of task always take place after the script has been processed. When you use this script element for Script objects, they will successfully be synchronized but no processing will take place afterwards.
Examples
In the first example, the Sync object "SYSTEM_0001_EXCLUSIVE_SYNC" is added to the Job
"ARCHIVE01". When the indicated actions cannot be executed, the Job will be canceled.
:
SET &RUNNR#
=
GET_UC_OBJECT_NR (ARCHIVE01)
:
ATTACH_SYNC &RUNNR#
,
"SYSTEM_0001_EXCLUSIVE_
SYNC"
,
"USE","RELEASE"
,
"RELEASE"
,
"A"
In the second example, the Sync object is assigned to the directly succeeding task in the Workflow.
:
ATTACH_SYNC
,
"SYSTEM_0001_EXCLUSIVE.SYNC"
,
"USE"
,
"RELEASE"
,
"RELEASE"
,
"A"
,
"NEXT_
OBJECT"
See also:
Script element
Description
Executes the defined action of a Sync object
Queries the current condition or value of a Sync object
Script Elements - Reading or Modifying Objects
Sync
System Return Codes of Executable Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.4 :DELETE_VAR
Script Statement: Deletes one or all values of a static Variable object.
Syntax
:DELETE_VAR
Variable
[, Key]
Syntax
Variable
Key
Automation Engine 95
Description/Format
Name of the Variable object in which contents should be deleted.
Format:
Key that should be deleted including its value.
Format: UC4 Name, script literal or script variable
Comments
Note that this script element can only be used for static Variable objects. For more detailed information refer to the description of the Variable tab .
This script statement deletes all lines of a Variable object if only the parameter Variable has been specified.
If the parameter Key has also been specified, only the relevant line in the Variable object is removed. If "*" has been specified in the Key, the whole content of the Variable object is deleted.
Wildcard characters must not be used. Therefore, you cannot use "*" or "?" to filter several lines in the parameter Key.
Examples
The first example uses this script statement to delete the whole content.
: DELETE_VAR "DATABASE_MAINTENANCE"
The second example only deletes the line which contains the key "Client".
: DELETE_VAR "DATABASE_MAINTENANCE" , "Client"
See also:
Script element
Description
This stores a value in a static Variable object.
This returns the value of a variable object.
Sets the values of script variables by indirect access.
Returns the values of script variables by indirect access.
Prepares the processing of a data sequence (values of a Variable object).
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
96 Chapter 3 Ordered by Function
3.4.5 :MODIFY_STATE
Script Statement: Modifies the return code or status text of a Job when it has finished
Syntax
:MODIFY_STATE
Property=Value
Syntax
Property
Value
Description/Format
Property for the Job's end
Format:
or
Allowed values: "RETCODE", "STATUS_TEXT"
"RETCODE" = Job's Return Code
"STATUS_TEXT" = Job's status text
New assignment for the Job's property
Format:
script literal , script variable, UC4 Name, number without quotations
or
For "RETCODE": Numerical value.
For "STATUS_TEXT": Alphanumeric string, maximum 32 characters.
Description
:MODIFY_STATE can be used for the subsequent modification of a Job's return code or the status text.
Hence, this script statement is only allowed in the
Post Process
tab.
You can use this script statement to subsequently assign the status ENDED_NOT_OK to a Job which ended normally from the technical point of view, for example. This might be necessary for a Job in which an error occurred that was not detected until its report was analyzed.
See:
.
Modifying the return code influences the status of a Job. The status results from the maximum return code that has been defined for a normal job end (Runtime tab). If the modified return code is higher than the specified maximal return code, the status is set to ENDED_NOT_OK. If the modified return code is lower than or equal to the specified maximum return code, the Job ends on the status ENDED_OK.
You can also specify an individual status text for the Job's end. It then replaces the text which the Job messenger put out in the trailer.
Changes are logged in the Post processing tab of the Job report. The modified values are also displayed in the Detail Window of the Job.
Example
In the following example, a job running under Windows should copy a non-existing file. The Job would end normally with return code "0". The result that the file to be copied was not found could only be seen from the Job report.
The Job report is now analyzed in the post process of the Job. The absence of the file that should have been copied is recognized and the return code is changed. As a result, the Job is canceled.
Automation Engine 97
: SET &HND# = PREP_PROCESS_REPORT (,,, "*cannot find the file*" )
: PROCESS &HND#
: MODIFY_STATE STATUS_TEXT= "Files not found"
: MODIFY_STATE RETCODE=50
: ENDPROCESS
See also:
Script element
Description
This terminates the processing of a script and sends a return code
Returns the status of an activated object
Script Elements - Read or Modify Objects
Sample Collection
Setting End Status depending on Report Content
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
98 Chapter 3 Ordered by Function
3.4.6 :PUT_ATT
Script Statement: It changes an attribute's value during the generation process.
Syntax
:PUT_ATT
Attribute = Value
Syntax
Attribute
Description/Format
The name of the attribute to which a value should be assigned.
Format:
Value
A suitable value that should be assigned to the attribute.
or
Comments
Objects are usually processed by using the attributes that have been defined for them. Despite this face, you can use the statement
in order to change attributes dynamically and assign new values during the generation process. These values are only valid for the particular generation and they are not permanently stored in the object.
The values that can be assigned to an attribute depend on the system environment. The start type " " can only be assigned to a job that starts immediately or to a group that has already been defined. Other specifications will cause an error during the generation process.
A list of all object attributes including their allowed values is available in the User Guide.
Attributes of Rapid Automation jobs may change when new versions of the Rapid Automation agents are released. When this happens, :PUT_ATT commands that have been defined in earlier versions of the agents will no longer work. Therefore, UC4 recommends for Rapid Automation jobs that you always use object variables for field replacements instead of :PUT_ATT commands.
To change a job from using a :PUT_ATT command to an object variable, do the following:
1. Remove the :PUT_ATT command from the job's Process or Pre-Process tab.
2. Add a variable and its value to the Variables & Prompts tab of the job.
3. In the field where the you wish to replace a value, enter the object variable in the format
&<Variable># where <Variable> represents the variable name you entered on the Variables &
Prompts tab.
Changing attributes is only useful before an object is processed. Therefore, you cannot use :PUT_ATT in Post-Process tabs.
Note that attributes can have different maximum lengths. :PUT_ATT does not check the specified value but truncates it to the relevant attribute's maximum length.
You cannot change the start type by using :PUT_ATT if the option "Generate at runtime'" is activated in the object.
Automation Engine 99
Agent groups are resolved before the script is processed. This means that the selection on which agent the task runs takes place beforehand. You can use :PUT_ATT in order to define a different agent but not to define a different agent group. The script function
can be used to read the agents of an agent group .
The script statement :PUT_ATT has no effect if you use it in the !Process tab of an Event object and in
Post Process tabs.
The attributes HOST and SYSLST_DB (in BS2000 jobs ) can only be set using :PUT_ATT in the Pre-
Process tab.
:PUT_ATT does not modify the contents of script variables.
You can use this script element in the Process tab in order to limit the maximum number of parallel runs
(attribute: MAX_PARALLEL_TASKS). In this case, the limit will only be checked after the script has been processed when the task is generated at runtime.
For example:
: SET &TYPE# = GET_ATT (EVENT_TYPE)
: PUT_ATT EVENT_CHECK_METHOD2 = "FILE_STABLE"
: PRINT &TYPE#
Explanation: Let's assume that the script variable &TYPE# obtains the value "FA" through GET_ATT.
After the :PUT_ATT call, the Event type is "FT" because the attribute "FILE_STABLE" belongs to the
FileSystem Event. Despite this fact, the variable &TYPE# still includes the value "FA."
You cannot change the attributes of a particular object (such as the Login object) by using:PUT_ATT if the user has write access (W) to the old value but not to the attribute's new value.
To change the queue that is specified in a task (QUEUE attribute ), you can use the script element
:PUT_ATT in the Pre-Process tab.
Note that when the option Generate at runtime is set in this task, the system will check the available slots and the status of the queue before it starts processing the Pre-Process tab. The effect is that the task starts in the modified queue but the system checks the queue that is specified in the object. This means that the limit of the new queue is not verified and as a result, the task may start too early. For example, if the CLIENT_QUEUE is still specified in the queue, the task will start in any case unless it is in a stopped status.
Examples
The following example shows how a new agent can be assigned to an object.
: PUT_ATT HOST = "UNIX02"
See also:
Script element
Description
Adds recipients to a Notification at runtime.
Removes receivers in a Notification at runtime.
Extends the Notification's message text at runtime.
This function returns the values of a task's attributes during generation.
Supplies part of the message text in a Notification.
100 Chapter 3 Ordered by Function
Script Elements - Read or Modify Objects
Sample Collection
Notification with variable Message Text
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.4.7 :PUT_ATT_APPEND
Script Statement: It extends the notification's message text at runtime.
Syntax
:PUT_ATT_APPEND CALL_TEXT
= Text
Syntax
CALL_TEXT
Description/Format
The name of the attribute whose value should be appended.
Format:
Text
Allowed value: "CALL_TEXT"
The text that should be attached to the existing message text.
Format:
script literal , number, script variable or
Comments
This script statement can only be used in the Process tab of a Notification object. It appends the specified text to the end of the message text.
The existing message text remains the same because this script statement does not change the
Notification object. The extended message text is only valid for the notification's particular execution.
The following peculiarities apply if you use blanks (see also: examples): l l
Blanks that are used at the end of the text should be appended are truncated.
If the text only consists of blanks, they will be ignored.
Note that the length of the text that you pass on must not exceed 8,000 characters for technical reasons concerning the database.
Examples
The following example stores the current time in the script variable and put it to the READ buffer.
Subsequently, a notification is activated.
Automation Engine 101
: SET &TIME# = SYS_TIME ( "HH:MM" )
: PUT_READ_BUFFER TIME# = "&TIME#"
: SET &CALL# = ACTIVATE_UC_OBJECT (CALL, BACKUP.END)
The notification reads the script variable's value from the READ buffer. The current time is appended to the notification's message text.
: READ &TIME# ,,
: PUT_ATT_APPEND CALL_TEXT = " &TIME#."
The following examples serve to explain the use of blanks. The notification's message text is "Start checking the".
1) The text is correctly printed because a leading blank is inserted. Note that blanks are not automatically inserted.
: PUT_ATT_APPEND CALL_TEXT = " Server processes"
Output:
Start checking the Server processes
2) Blanks that are used at the end of texts are truncated as the following example shows:
: PUT_ATT_APPEND CALL_TEXT = " Server "
: PUT_ATT_APPEND CALL_TEXT = "processes"
Output:
Start checking the Serverprocesses
3) If a text only consists of blanks, these blanks are also ignored.
: PUT_ATT_APPEND CALL_TEXT = " Server"
: PUT_ATT_APPEND CALL_TEXT = " "
: PUT_ATT_APPEND CALL_TEXT = "processes"
Output:
Start checking the Serverprocesses
See also:
Script element
Description
Adds recipients to a Notification at runtime.
Removes Notification recipients at runtime.
This is used to change the value of an attribute during generation.
This function returns the values of a task's attributes during generation.
Supplies part of a Notification's message text.
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
102 Chapter 3 Ordered by Function
3.4.8 :PUT_VAR
Script Statement: Stores a value in a Variable object.
Syntax
:PUT[_VAR]
Variable,
[Key]
, Value
[, Value [, Value [, Value [, Value ] ] ] ]
Syntax
Variable
Description/Format
The name of the Variable object to which one or several values should be assigned.
Format:
Key
Value
The line in which the value should be stored.
Format:
script literal , script variable or
Entries that should be written to the particular value columns. Values of nonspecified columns are deleted. Existing values are overwritten.
Format: script literal, script variable or number specified without quotation marks
Comments
A runtime error occurs if a dynamic Variable (source: SQL, SQL internal, multi or data type) is used in this script element. Only static Variable objects can be filled using :PUT_VAR.
The following general rules apply: l l
Key and Value are added if the Variable does not contain a value.
Value is replaced if the Variable contains a value of the same Key.
Separate the individual values by using commas if you want to fill several value columns of a Variable.
Static Variables are limited to 5 value columns.
The parameter Key is optional if the setting "validity area" - "no validity key" is selected in the
Attributes
tab. In this case, the Variable contains only one value. Ensure that the commas are set in the statement even if Key is not used .
You can also specify the individual values without using inverted commas. Commas are used as separators.
For example: Values are entered in all the five value columns.
: PUT_VAR VARA.TEST, "KEY1" , Wert1, Wert2, Wert3, Wert4, Wert5
To write a value that includes one or several commas in one line, you must enclose this value in singlequote or double-quote characters.
For example: "Value1" is written to the value column 1 and "Value2, Value3, Value4" to the column 2.
: PUT_VAR VARA.TEST, "KEY1" , Value1, "Value2, Value3, Value4"
Automation Engine 103
One of the following formats must be selected in order to store a value in a Variable of data type
"timestamp": l l l l
"YYYY-MM-DD HH:MM:SS"
"YYMMDD HHMMSS"
"YYYYMMDD HHMMSS"
"YYYYMMDDHH24MISS"
The data types "Time", "Date" and "Number" require the value to be specified in the defined output format
(Attributes tab).
Important note for the data type "Number": Redundant decimal places are truncated if an attempt is made to store a number with more decimal places than have been defined in the output format.
This script function writes values to a Variable object even if a user has opened it in order to ensure that there is no interference with processing. A warning displays if a user tries to store the modifications that were made in this Variable object. It contains the information that the Variable has been modified in the meantime. The user can now decide whether the modifications should be stored or removed.
For the data type "String", leading blanks remain in the content. Blanks at the end of the string are truncated.
The following peculiarity applies if :PUT_VAR is used before a
statement: If script generation is canceled manually using the "Cancel" button or due to invalid default values (see "Generate at runtime"), the Variable object still contains the values that were set with :PUT_VAR.
Examples
In the following example the current date and time are determined and saved in a Variable object of the data type "Time stamp". Date and time are transferred to the script statement as script variables.
: SET &DATE# = SYS_DATE ( "YYYY-MM-DD" )
: SET &TIME# = SYS_TIME ( "HH:MM:SS" )
: PUT_VAR BOOKING.DATE, , "&DATE# &TIME#"
The variable "ATTRIBUTES", which is used in the following example, contains the scope "Freely selected". Therefore, the Key must be entered.
: SET &PRIO# = GET_ATT ( "UC4_PRIORITY" )
: PUT_VAR ATTRIBUTES, "CurrentPriority" , &PRIO#
In the following example, a task's name, object type and parent information are stored with the task's
RunID in the Variable object "OBJECT_STAT".
: SET &PNAME# = SYS_ACT_PARENT_NAME ()
: SET &PNR# = SYS_ACT_PARENT_NR ()
: SET &PTYPE# = SYS_ACT_PARENT_TYPE ()
: SET &NAME# = SYS_ACT_ME_NAME ()
: SET &NR# = SYS _ACT_ME_NR ()
: SET &TYPE# = SYS_ACT_ME_TYPE ()
: PUT_VAR OBJECT_STAT, "&NR#" , "object name: &NAME#" , "object type: &TYPE#" ,
"parent name: &PNAME#" , "parent runid: &PNR#" , "parent object type:
&PTYPE#"
See also:
Script element Description
104 Chapter 3 Ordered by Function
Deletes one or all values of a Variable object.
This returns the value of a variable object.
Sets the values of script variables by indirect access.
Returns the values of script variables by indirect access.
Prepares the processing of a data sequence (values of a Variable object).
Script Elements - Read or Modify Objects
Variable
Sample Collection:
Display with Cockpit
Database Maintenance with Options
Calling an MBean
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.9 :PUT_VAR_COL
Script statement: Stores a value to a particular column of a static Variable object.
Syntax
:PUT_VAR_COL Variable,
[Key]
, column, value
Syntax
Variable
Description/Format
Name of the Variable object to which a value should be assigned.
Format:
Key
Column
Value
Line in which the value should be stored.
Format:
script literal , script variable or
Number of the column in which the value should be entered.
Format:
script literal , script variable or number without inverted commas
Allowed values: "1" to "5"
Value which should be written to the specified Variable line and column.
Format: Script literal or script variable
Comments
This script function writes a particular value to the specified line and column of a Variable object. Unlike with the script element
:PUT_VAR , this does not affect other fields. If the specified line/column already
contains an entry, the corresponding value will be overwritten.
Automation Engine 105
Specifying a dynamic Variable in this script element (source: SQL, SQL-internal, multi or data type) results in a runtime error. Only static Variable objects can be filled with values using
.
When indicating the column number, keep in mind that Variable objects of type "static" only include 5 value columns.
The numbers between "1" (value column 1) and "5" (value column 5) can be used for the columns. The value of the key column cannot be changed with this script element.
The parameter Key is only optional if a static Variable is used with the setting "Scope" - "No validity keyword". In this case, the Variable only includes the key (*).
A new entry is created if the specified Key does not yet exist.
Example
The following example retrieves the name of the superordinate task (Workflow) and the task's own RunID.
Subsequently, the RunID is written below the Workflow name in column 3 of the Variable object
"VARA.JOBP".
: SET &JOBP# = SYS_ACT_PARENT_NAME ()
: SET &RUNID# = SYS _ACT_ME_NR ()
: PUT_VAR_COL VARA.JOBP, &JOBP# , "3" , &RUNID#
See also:
Stores values in a static Variable object.
Deletes one or all values of a static Variable object.
Returns the content entry of a Variable object.
Sets the values of script variables through indirect access.
Returns the values of script variables through indirect access.
Prepares the processing of a data sequence (values of a Variable object).
Script Elements - Read or Modify Objects
Variable
Sample Collection:
Display with Cockpit
Database Maintenance with Options
Calling an MBean
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.10 :REMOVE_ATT
Script statement: Removes recipients in a Notification at runtime.
Syntax
:REMOVE_ATT RECIPIENT
, Recipient
106 Chapter 3 Ordered by Function
Syntax
RECIPIENT
Description/Format
Name of the attribute that should be removed.
Format:
Recipient
Allowed value: "RECIPIENT"
Name of a User, UserGroup or email address.
Format: script literal, Script variable or number
User and UserGroup objects: The wildcard characters "*" and "?" can be used. "*" refers to any number of characters, "?" refers to exactly one character.
Comments
This script statement can only be used in the Process tab of Notifications. It removes the specified Users,
UserGroups or email addresses from the list of responsible recipients .
The specified recipients are not permanently deleted as this script statement does not change the
Notification object. The modification only applies for a particular execution.
Ensure that you do not remove all responsible recipients when you use wildcard characters.
Otherwise, script processing aborts and an error message is generated.
Refer to the report to see the recipients that have been removed with this script statement .
Note that users must be specified in the format User name/Department. It must comply with the name of the user object. The script aborts if the User cannot be found.
Examples
The following example removes the user "BU/UC4" from the list of responsible recipients of a
Notifications.
: REMOVE_ATT RECIPIENT, "BU/UC4"
The second example removes all users of the department "UC4".
: REMOVE_ATT RECIPIENT, "*/UC4"
The UserGroup "ADMIN" is removed in the third example.
: REMOVE_ATT RECIPIENT, "ADMIN"
See also:
Script element
Description
Adds Users and UserGroups to a Notification at runtime.
This is used to change the value of an attribute during generation.
Extends the Notification's message text at runtime.
Automation Engine 107
This function returns the values of a task's attributes during generation.
Supplies part of the message text in a Notification.
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.11 :REPLACE_STRUCTURE
Script statement: Replaces the structure of a Workflow with the structure of another Workflow at activation
Syntax
:REPLACE_STRUCTURE OBJ[ECT]=Workflow
Syntax
Workflow
Description/Format
Name of the Workflow whose structure should be used
Format:
or
Comments
With this script statement, the structure of one Workflow can be replaced with the structure of another
Workflow during its activation. That means the content of the Workflow tab is replaced. A runtime error occurs if the specified Workflow cannot be found.
Modifications to the Workflow structure only apply for the particular execution and do not change the
Workflow object.
Call the monitor in the statistics of a Workflow execution to have the Workflow displayed whose structure was used.
UC4 recommends that you do not use this script statement if modifications can also be made through defining calendar dependencies, time-dependent conditions in scripts, etc.
Example
In the following example, the Job plan "MM.DAY" should run with a modified Workflow structure on
12/31/2001. The Workflow has been copied and the copy has been changed. In the original Workflow, the modified Workflow is called with the following script lines.
: IF "051231" = SYS_LDATE ()
: REPLACE_STRUCTURE OBJECT= "MM.DAY.MOD.051231"
: ENDIF
See also:
108 Chapter 3 Ordered by Function
Script Elements - Alphabetical listing
Script Elements - Ordered by Function
3.4.12 :SET_CALE
Script Statement: Inserts/deletes a date or time period in/from a calendar keyword.
Syntax
:SET_CALE
Calendar, Calendar Keyword, Date1
[, Date2[,Action]]
Syntax
Calendar
Description/Format
Name of the calendar object in/from which a date/time period should be added or removed.
Format:
Calendar Keyword
Date1
and
Date2
Action
Name of the calendar keyword in/from which a date/time period should be added or removed.
Format: UC4 Name, script literal or script variable
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
Marker for adding or removing.
Format: UC4 Name, script literal or script variable
Allowed values: "ON" (default value), "OFF"
"ON" - Add date/time period
"OFF" - Remove date/time period
Comments
You can use this script statement to add or remove a date/time period from a calendar.
If only one date should be added or removed, it is not necessary to specify Date2. For a time period, both
Date1 and Date2 must be specified.
Optionally, you can specify a particular date format. The default date formats that should be used are
"YYMMDD" or "YYYYMMDD".
If the assumed Calendar keyword does not exist, the script statement creates a new Calendar keyword of type "Statistic". By default, the current year minus NOW_MINUS and plus NOW_PLUS is used. Both specifications are keys that the UC4 administrator specified in the UC4 Variable UC_CLIENT_
SETTINGS. The validity range can be changed subsequently using the script function MODIFY_OBJECT .
Automation Engine 109
When adding dates or times, this script statement ignores existing date/time period specifications. The same is true if you remove a date/time period that does not exist.
The script function
can be used to check whether a date is valid regarding a calendar and calendar keyword.
No Calendar calculation is triggered while this script statement is being processed. Open and store the
Calendar object manually to have the Calendar recalculated.
Examples
The first example adds a date to the calendar "Readiness" and the calendar keyword "BU".
: SET_CALE "READINESS" , "BU" , "YY-MM-DD:00-12-24"
The second example removes the current day from this calendar.
: SET &TODAY# = SYS_DATE ()
: SET_CALE "READINESS" , "BU" , &TODAY# ,, OFF
The third example determines the beginning and end of the current week. Afterwards, the time period is entered in the calendar.
: SET &TODAY# = SYS_DATE ()
: SET &BEGINNING# = FIRST_OF_PERIOD ( &TODAY# , "WW" )
: SET &END# = LAST_OF_PERIOD ( &TODAY# , "WW" )
: SET_CALE "READINESS" , "BU" , &BEGINNING# , &END#
See also:
Script element
Description
Checks whether a date is included in the Calendar keyword
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.13 :SET_CONDITION
Script statement: Sets the earliest start time in Workflows
Syntax
:SET_CONDITION
Condition
[= Value]
Syntax Description/Format
110 Chapter 3 Ordered by Function
Condition
Value
Start condition that should be set.
Format:
or
Allowed values: "EARLIEST_START_TIME", "JOBP_EARLIEST_START_
TIME"
"EARLIEST_START_TIME" = Earliest start time of a task within a
Workflow"JOBP_EARLIEST_START_TIME" = Earliest start time of a
Workflow
Earliest start time that should be se.t
Format: script literal or script variable
Format: "DD/HH:MM"
Default value: "00/00:00"
Comments
This script statement only works within a Workflow.
The earliest start time that is set with this function only applies for the particular object execution . The point in time that can be specified in the task properties is not changed. The earliest start time can also be retrieved at runtime using the script function
.
The following rules apply for setting the earliest start time: l l l
With "EARLIEST_START_TIME" this script statement sets the earliest start time of the task in whose script it is called. This script statement is not allowed if "generate at runtime" ("Attributes" tab) has been defined for the task. In this case, the task would have started already when the script is to be processed.
If this script statement is used with "JOBP_EARLIEST_START_TIME" in the script of a task, it sets the earliest start time of the Workflow. Here the script statement does cannot be used with
"Generate at runtime".
In the script of a Workflow, the script statement with "JOBP_EARLIEST_START_TIME" can only be used for setting the earliest start time of a superordinate Workflow (parent). An error occurs if there is no parent Workflow.
The earliest start time of the Workflow is the particular point in time that has been defined in the START box of the Workflow.
Example
In this example, the script statement is used in the script of a task running in a Workflow. The task's and the Workflow's earliest start times are set and output in the activation report.
: SET_CONDITION "EARLIEST_START_TIME" = "00/10:19"
: SET_CONDITION "JOBP_EARLIEST_START_TIME" = "00/10:18"
: SET &RETJOBS# = GET_CONDITION ( "EARLIEST_START_TIME" )
: SET &RETJOBP# = GET_CONDITION ( "JOBP_EARLIEST_START_TIME" )
: PRINT "New earliest start time of the task:" , &RETJOBS#
: PRINT "New earliest start time of the Workflow:" , &RETJOBP#
See also:
Script element
Description
Determines the earliest start time in Workflows.
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 111
3.4.14 :XML_CLOSE
Script Statement: Closes an XML document
Syntax
:XML_CLOSE
Comments
This script statement closes an XML document after processing.
As it is not possible to open more than one XML document at a time, the succeeding one can only be opened for processing afterwards using
.
As of UC4 version 6.00A, this script statement has been renamed from :XML_CLOSE_DOCU to
:XML_CLOSE. The former notation can still be used.
Example
The Detailst tab of a structured documentation is closed after successful execution.
: SET &XMLDOCU# = XML_OPEN ( "MM.DAY" , "@Details" )
!...
: XML_CLOSE
See also:
Script element
Description
Opens an XML document for processing
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Sample Collection:
Retrieving Error Message and Number
112 Chapter 3 Ordered by Function
Script Elements - Alphabetical Listing
Script-Elements - Ordered by Function
3.4.15 GET_ATT
Script Function: This function returns the values of a task's attributes during the generation process.
Syntax
GET_ATT
(Attribute)
Syntax
Attribute
Description/Format
Name of the attribute whose value should be retrieved.
Format:
Return codes
Value of the specified attribute.
Comments
The script function GET_ATT can be used to retrieve an object's attributes value during the generation process. You can only specify attributes that belong to the object.
A list of the attributes of all objects including the allowed values is available in the User Manual.
You can also use a blank " " as an attribute's value. It is used if no value has been specified (for example, if the text field for the archive key is empty).
If the task runs in an AgentGroup , GET_ATT(HOST) returns the name of the Agent on which the task is actually processed and not the AgentGroup name.
If you use a script or object variable's name as attribute (see: Reading and modifying attributes ), the result of reading this attribute by using GET_ATT() is the content of the specified variable (instead of the variable's name). Use the script element
if the Variables should not be resolved.
Examples
In the example shown below, the archive key of an object is retrieved and stored in a script variable.
: SET &START# = GET_ATT (ARCHIVE_KEY1)
Script variables can also be used in this function.
: SET &ATT# = "JOBREPORT_FILE"
: SET &START# = GET_ATT ( &ATT# )
Automation Engine 113
This example uses the script function to define a condition.
: IF GET_ATT (GROUP) = " "
!...
: ENDIF
The following example uses a Script variable in an object's attribute field. The Variable"&DST#" is specified as the target file in a FileTransfer object. The subsequent script sets the attribute, assigns a value to the Variable and reads the attribute. The returned value is the value of the Variable
"C:\Temp\test2.txt" (instead of the Variable name "&DST#").
: PUT_ATT FT_DST_FILE = "&DST#"
: SET &DST# = "C:\Temp\test2.txt"
: SET &DEST# = GET_ATT (FT_DST_FILE)
: PRINT "Target file: &DEST#"
See also:
Script element
Description
Adds recipients to a Notification at runtime.
Removes recipients from a Notification at runtime.
Changes an attribute's value during the generation process.
Extends the Notification's message text at runtime.
Supplies the value of a task's attributes during its generation. Variables are not resolved.
Supplies part of a Notification's message text.
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.16 GET_ATT_PLAIN
Script function: Supplies the value of a task's attributes during its generation. Variables are not resolved.
Syntax
GET_ATT_PLAIN
(Attribute)
Syntax
Attribute
Description/Format
Name of the attribute whose value should be read.
Format:
114 Chapter 3 Ordered by Function
Return code
Value of the specified attribute.
Comments
This script function can be used to read an object's attributes during the generation process. Its behavior is similar to the behavior of the script element
with the difference being that script, object and predefined variables are not replaced by values in the attribute. Therefore, the variable name is retrieved instead of its value. GET_ATT always resolves these variables.
Placeholders for Variable objects that are enclosed in curly brackets {} are supplied with values neither in GET_ATT nor in GET_ATT_PLAIN.
As of version 9.00A, the attribute dialog reads the attributes using the script function GET_ATT_
PLAIN. The dialog now always displays the attributes' actual content instead of the replaced variable value.
For more detailed information, see
Example
The following example writes a script variable's name to an attribute and assigns a value to it. The attribute's content is then retrieved with and without the replaced variable value. The corresponding information is written to the activation protocol.
: PUT_ATT INT_ACCOUNT = "&&test#"
: SET &test# = "test"
: SET &att# = GET_ATT (INT_ACCOUNT)
: SET &attplain# = GET_ATT_PLAIN (INT_ACCOUNT)
: PRINT "Variable name = &attplain#"
: PRINT "Variable value = &att#"
See also:
Script Element
Description
Adds recipients to a Notification object at runtime.
Removes recipients from a Notification object at runtime.
Changes an attribute's value during the generation process.
Extends the Notification's message text at runtime.
Supplies the value of a task's attributes during the generation process.
Supplies part of a Notification's message text.
Script Elements - Read or Modify Objects
Sample Collection
Notification with Variable Message Text
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 115
3.4.17 GET_ATT_SUBSTR
Script Function: Supplies part of the message text in a Notification
Syntax
GET_ATT_SUBSTR
(CALL_TEXT, Begin, Length)
Syntax
CALL_TEXT
Description/Format
Name of the attribute whose value should be partially read
Format:
Begin
Length
Allowed value: "CALL_TEXT"
Position where reading should be started
Format: Number or script variable
Number of characters to be read
Format: Number or script variable.
Return codes
Part of the message text
" " - The specified area is not within the message text.
Comments
This script function can only be used in the Process tab of a Notification. It supplies part of the message text in a Notification.
If the statement
is written before this script function, the part is taken from the extended message text.
Example
The following example shows how to read the first 20 characters of the message text.
: SET &SECTION# = GET_ATT_SUBSTR (CALL_TEXT,1,20)
See also:
Script element
Description
Adds recipients to a Notification at runtime
Removes recipients in a Notification at runtime
This is used to change the value of an attribute during generation
116 Chapter 3 Ordered by Function
Extends the Notification's message text at runtime
This function returns the values of a task's attributes during generation.
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.4.18 GET_CONDITION
Script Function: Determines earliest start times in Workflows
Syntax
GET_CONDITION
(Condition)
Syntax
Condition
Description/Format
Start condition to be determined
Format:
or
Allowed values: "EARLIEST_START_TIME", "JOBP_EARLIEST_START_
TIME"
"EARLIEST_START_TIME" = Earliest start time of a task in the Workflow
"JOBP_EARLIEST_START_TIME" = Earliest start time of Workflow
Return code
Earliest start time of the task or Workflow in the format "TT/HH:MM"
Comments
This script function only works within a Workflow.
The earliest start time may be specified in the properties of tasks and in the START box of Workflows .
It can also be set at runtime with the script statement
For determining the earliest start time, the following relations apply: l l l
With "EARLIEST_START_TIME", this script function determines the earliest start time of the task in whose script it is called.
If this script function is used with "JOBP_EARLIEST_START_TIME" in the script of a task, it returns the earliest start time of the Workflow.
In the script of a Workflow, this script function may only be used with "JOBP_EARLIEST_START_
TIME" if this Workflow is part of a superordinate Workflow. The earliest start time of the parent
Workflow is returned. An error occurs if no parent Workflow exists.
The earliest start time of the Workflow is the point in time that has been defined in the START box of the Workflow.
Automation Engine 117
Example
In the following example, the script function is used in the script of a task that is running within a Workflow.
The earliest start time of the task and the Workflow are queried and output in the activation protocol.
: SET &RETJOBS# = GET_CONDITION ( "EARLIEST_START_TIME" )
: SET &RETJOBP# = GET_CONDITION ( "JOBP_EARLIEST_START_TIME" )
: PRINT "Task's earliest start time:" , &RETJOBS#
: PRINT "Workflow's earliest start time:" , &RETJOBP#
See also:
Script element
Description
Sets earliest start times in Workflows
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
118 Chapter 3 Ordered by Function
3.4.19 GET_LOGIN
Script Function: Reads information from Login objects .
Syntax
GET_LOGIN
(Login object, Name, Type, Information)
Syntax
Login object
Name
Type
Information
Description/Format
The name of a Login object.
Format:
, UC4 name or script literal
The name of the entry in the Login object.
Format: script variable, UC4 name or script literal
The type of the Login entry.
Format: script variable, UC4 name or script literal
The information that should be read.
Format: UC4 name
Allowed values:
LOGIN_INFO - Reads the Login information (user, domain).
PASSWORD - Password
Return Code
The relevant information.
20476 - The specified object does not exist or is not of LOGIN type.
20482 - The specified name could not be found in the Login object.
20493 - Invalid specification of the information that should be read.
Comments
This script function supplies the Login information or the password of a certain entry in the specified Login
object. The parameters Name and Type decide upon the entry .
You can only read the Login entries of backend systems! Make sure that the specified Type is also available in the UC4 Variable UC_LOGIN_TYPES.
The password is returned in encrypted form. You can use the password with the Job messenger (start parameter CMD) where it will be decrypted.
You can use "*" for the Name (use single or double quotation marks). Note that "*" in this case is an own entry in the Login object and not a filter.
Examples
The following example reads the Login information and the password of the backend-system entry SVN from the Login object and runs a command runs via the job messenger afterwards that specifies the Login data.
Automation Engine 119
: SET &LOGIN# = GET_ATT (LOGIN)
: SET &LI# = GET_LOGIN ( &LOGIN# ,SVN,SVN,LOGIN_INFO)
: SET &PW# = GET_LOGIN ( &LOGIN# ,SVN,SVN,PASSWORD)
&UC_JOBMD CMD="&SVN_CMD# checkout ""&SVN_URI#"" ""&SVN_DIR#"" --username
&LI# --password &PW#"
See also:
Script Element - Data Sequences
Script Element - Alphabetical Order
Script Element - Ordered by Function
3.4.20 GET_OBJECT_TYPE
Script function: Returns a task's object type
Syntax
GET_OBJECT_TYPE
(Object name)
Syntax
Object name
Description/Format
Name of the object whose type should be retrieved
Format:
or script variable
Return codes
Short form of the object type
"20223" - The object does not exist.
Comments
This script function first searches the object in the client in which the script is processed and then in system client 0000.
The script statement
may be used to determine the reaction to an erroneous object name.
The error may be analyzed using the
script functions for error handling
. Script processing continues but may also be canceled if required.
Example
The following example returns "JOBP" because MM.DAY is a Workflow.
: SET &OBJECT_TYPE# = GET_OBJECT_TYPE ( "MM.DAY" )
See also:
120 Chapter 3 Ordered by Function
Script Elements - Reading or Modifying Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.21 GET_OH_IDNR
Script function: Supplies an object's internal number.
Syntax
GET_OH_IDNR
(Object name, client )
Syntax
Object name
Client
Description/Format
Name of the object
Format:
or
Number of the client in which the object is stored
Format: number or script variable
Return code
Object's internal number
"0" - The object does not exist.
Comments
Each object obtains an internal number when it is created.
Example
The following example supplies the internal number of the object "MM.DAY" which is stored in client 98.
: SET &RET# = GET_OH_IDNR ( "MM.DAY" ,98)
See also:
Script Elements - Reading or Modifying Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 121
3.4.22 GET_PUBLISHED_VALUE
Script Function: Retrieves the value or PromptSet variable of a certain task.
Syntax
GET_PUBLISHED_VALUE
(RunID, Variable Name)
Syntax
RunID
Variable Name
Description/Format
The running number (RunID) of the task.
Format:
or
The name of an object or PromptSet variable of the specified task (without a leading & character).
Format: UC4 name
In arrays, you must additionally used empty brackets [] at the end of the name.
Return codes
The value of the object or PromptSet variable.
Comments
You can use this script function together with :
and
. The script statement :SET can read the value of a regular object or PromptSet variable or of an individual PromptSet array element and :FILL can read a complete PromptSet array.
You can only define PromptSet variables as arrays in checklist and checkbox elements.
Examples
The following example activates an object and then reads its object variable &VARIABLE1#.
: SET &RUNID# = ACTIVATE_UC_OBJECT ( &OBJ# ,WAIT)
: SET &VAR# = GET_PUBLISHED_VALUE ( &RUNID# ,VARIABLE1#)
: PRINT "&&VARIABLE1# = &VAR#"
The second example reads the PromptSet variable &CHECKLIST1# that has been defined as an array.
Only the value of the first array element is read here.
: SET &RUNID# = ACTIVATE_UC_OBJECT ( &OBJ# ,WAIT)
: SET &VAR# = GET_PUBLISHED_VALUE ( &RUNID# ,CHECKLIST1#[1])
: PRINT "&&CHECKLIST1#[1] = &VAR#"
The following scenario retrieves the activated task's complete PromptSet array. Then, the individual
PromptSet elements are output in the activation report. If the PromptSet array exceeds the size of the script array, the system only stores the elements that fit in.
: DEFINE &ARRAY# , string, 10
: SET &RUNID# = ACTIVATE_UC_OBJECT ( &OBJ# ,WAIT)
: FILL &ARRAY# = GET_PUBLISHED_VALUE ( &RUNID# ,CHECKLIST1#[])
: SET &LEN# = LENGTH ( &ARRAY# [])
: SET &VAR# = 1
122 Chapter 3 Ordered by Function
: WHILE &VAR# LE &LEN#
: PRINT "&&ARRAY#[&VAR#] = &ARRAY#[&VAR#]"
: SET &VAR# = &VAR# + 1
: ENDWHILE
See also:
Script element
Description
Stores several values to a script array.
Defines script variables and arrays as object variables.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Functions
3.4.23 GET_STATISTIC_DETAIL
Script Function: Retrieves details from the statistical record of an executable object.
Syntax
GET_STATISTIC_DETAIL
(
[RunID]
, Detail
[, Object name]
)
Syntax
RunID
Detail
Object name
Description/Format
10-digit run number (RunID) of the execution.
Format:
or number
Information to be retrieved from the statistical record.
Format: UC4 Name,
or script variable
Refer to the "Comments" section of this document which provides detailed information on all the allowed values.
Name of the object whose statistical record should be read.
Format: script literal or script variable
Return code
Detail from a statistical record
Comments
Note that users require the
"S" for the relevant object in order to execute this script function.
This script function can be used for the following parameter constellations: l
RUN#, Detail or RUN#, Detail, Object name
The statistical record can clearly be identified via its RUN#.
Automation Engine 123 l l
Detail, Object name
The last statistical record of the specified object is read.
Detail
The object's current statistical record from which the script function is called serves the identification of details. Hence, particular values are not yet available (e.g. the runtime).
Be careful when using this script function. The default values shown below are returned for values that are not available at the time of script execution: l l l
For strings: " "
For numbers: 0
For date and time stamps: 0000-00-00 00:00:00
These values may also be values that were retrieved from the read statistical details (e.g. return code 0).
This script function returns an empty string if no statistical record could be found. The script does not abort. You can use the script element
to remedy this error.
The second parameter requires the specification of the statistical detail to be read. The following table lists the values that may be retrieved:
Detail
ACCOUNT
ACTIVATION_TIME
ARCHIVE_KEY_1
ARCHIVE_KEY_2
CANCEL_FLAG
CHECK_COUNT
COMPRESSION_RATE
Description
Internal account.
Activation time in the format "YYYY-MM-DD HH:MM:SS".
Archive key 1
Archive key 2
Cancel task.
Return codes:
" " - Task was not canceled.
"m" - Task was canceled manually.
Number of checks made in the Event object.
Compression level.
CPU_TIME
DST_CODE_TABLE
Return codes:
"0" - None
"1" - Normal
"2" - Strong
" " - Default value
Used CPU time.
Name of the destination CodeTable in FileTransfers.
DST_FILE_ATTRIBUTES File attributes for the destination file of FileTransfers.
DST_FILE_NAME Name of the destination file in FileTransfers.
DST_HOST
DST_HOST_TYPE
Name of the destination Agent in FileTransfers and Jobs.
Host type of the destination Agent in FileTransfers.
DST_LOGIN_INFO
Return codes:
"BS2000", "GCOS8", "MPE", "MVS", "NSK", "OS400", "UNIX", "VMS" and "WINDOWS"
Complete Login information of the FileTransfer's destination Login object.
124 Chapter 3 Ordered by Function
DST_LOGIN_NAME
DURATION
END_TIME
EVENTID
FILE_SIZE
IO_COUNT
KERNEL_TIME
LAST_ERR_INS
REFERENCE_NR
RESTART
Name of the destination Login object.
Runtime in seconds.
Object's end time in the format "YYYY-MM-DD HH:MM:SS".
First RunID of FileSystem and Console Events.
Number of bytes used by the transferred file.
Number of I/Os.
Used Kernel time.
Message insertion.
LAST_ERR_NR Number of the last error that occurred.
LAST_RESTART_POINT Restart point that was last passed.
LDATE
MOD_COUNT
Logical date in the format "YYYY-MM-DD HH:MM:SS".
Number of object modifications.
NAME
OBJECT_TYPE
OCCURENCE_COUNT
PARENT_ACT
Name of the object.
Object type.
Number of occurred events (in Event objects).
RUN# of the superordinate task (Activator).
PARENT_PRC
POSTSCRIPT_START_
TIME
PROCESS_ID
RECORDS
RUN# of the superordinate task (Processor).
Start time of the Post Process in the format "YYYY-MM-DD
HH:MM:SS".
TSN / Process ID.
Text FileTransfers: Number of transferred lines/records.
Binary FileTransfers: 0
Reference RUN# in a restart.
Restart
RESTART_POINT
RETURN_CODE
RUNID
SRC_CODE_TABLE
Return codes:
"Y" - The execution is a restart.
"N" - It is not a restart.
Restart point for task start.
Return code.
RunID of the selected statistical record.
Name of the source CodeTable in FileTransfers.
SRC_FILE_ATTRIBUTES File attributes for the source file in FileTransfers.
SRC_FILE_NAME Name of the source file in FileTransfers.
SRC_HOST
SRC_HOST_TYPE
Name of the source Agent in FileTransfers.
Host type of the source Agent in FileTransfers.
SRC_LOGIN_INFO
Return codes:
"BS2000", "GCOS8", "MPE", "MVS", "NSK", "OS400", "UNIX", "VMS" and "WINDOWS"
Complete Login information from the FileTransfer's source Login object.
Automation Engine 125
SRC_LOGIN_NAME
START_TIME
STATUS
TRANSFERRED_BYTE_
COUNT
USER_ID
USER_TIME
Name of the source Login object.
Object's start time in the format "YYYY-MM-DD HH:MM:SS".
Status ( system return code ) of the execution (e.g. "1850").
Number of transferred bytes.
Name of the user in the format "NAME/DEPARTMENT".
Used user time.
Example
The following line is used in a FileTransfer object. It reads the name of the file that should be transferred from the current execution.
: SET &SOURCE_FILE# = GET_STATISTIC_DETAIL (,SRC_FILE_NAME)
The second example reads the start time of the superordinate task.
: SET &NAME# = SYS_ACT_PARENT_NAME ()
: SET &START# = GET_STATISTIC_DETAIL (,START_TIME, &NAME# )
The script function retrieves the activation time of the object MM.DAY:
: SET &RUNNR# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &# = GET_STATISTIC_DETAIL ( &RUNNR# , ACTIVATION_TIME)
See also:
Script Elements - Reading or Modifying Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.24 GET_SYNC
Script Function: Queries the current condition or value of a Sync Object
Syntax
GET_SYNC
(Sync, Type)
Syntax
Sync
Description/Format
Name of a Sync object whose current condition or value should be determined
Format:
126 Chapter 3 Ordered by Function
Type
Specification of whether current condition or current value should be determined
Format: UC4 Name, script literal or script variable
Allowed values: "STATE" and "VALUE"
"STATE" - Current condition
"VALUE" - Current value
Return codes
Current condition of the Sync object
Current value of the Sync object
Comments
This script function supplies the current settings of a Sync object. These settings are also found in the
Attributes
tab.
Example
The following script lines refer to the example Using Sync for Accesses of Jobs .
: SET &ADMIN# = GET_SYNC ( "DB.STATE" , "STATE" )
: IF &ADMIN# = "EXCLUSIVE"
: PRINT "The administrator job is currently exclusively using the database."
: ENDIF
: SET &RET# = GET_SYNC ( "DB.STATE" , "VALUE" )
: IF &RET# = 0
: PRINT "No job is currently using the database."
: ELSE
: PRINT "&RET# jobs are currently using the database."
: ENDIF
See also:
Script element
Description
Executes the defined action of a Sync object
Assigns a Sync object to a task
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Automation Engine 127
3.4.25 GET_VAR
Script Function: It returns the value of a Variable object.
Syntax
GET_VAR
(Variable
[, [Key] [, Column] ]
)
Syntax
Variable
Description/Format
The name of a Variable object whose value should be retrieved.
Format:
Key
Column
The variable line for the value retrieval (entry of the Key / first value column).
Format: script literal or script variable
The number of the column whose value should be used.
Format:
script literal , script variable or number without inverted commas
Allowed values:
Static variables: KEY (Key column), 1 to 5 (Value column 1 to 5)
Dynamic variables: RESULT (Result column), 1 to n (Value column 1 to n)
Return code
Variable's value(s)
" " -The entry does not exist or does not include a value.
Comments
You can use this script element in order to read the values of static and dynamic Variable objects.
Accessing a dynamic variable has the effect that the value is resolved. This means that the value is directly retrieved from the data source (database, Variable, directory).
An error that occurs while dynamic Variable objects are being resolved results in a runtime error.
The first line is used if the parameter Key is not specified. Note that you must always specify the key in static Variable objects in which the validity area "Freely selected" is selected.
If the Column is also missing, the system will automatically use the Value 1 column (for static Variable objects), the Result column (variable source: SQL, SQL-internally, multi) or the Filelist column (variable source: Filelist).
In variables that use the source "Filelist", you can either skip the column or use the value 1. The specified key complies with the returned value because there is only one column.
The area between 1 (first value column) and the last column number can be used as the value for Column.
Use the value RESULT for the Column in order to read the Result column (dynamic variables except
"Filelist"). Note that static variables have only 5 value columns. Using this script element in combination with
has the effect that all values of a line are written to a script array.
The value's format corresponds to the output format that has been defined in the Attributes tab .
128 Chapter 3 Ordered by Function
This script function can also be used to read Agent variables .
To access a key that begins with a "&" character, you must use this character twice. Otherwise, this term will be interpreted as a script variable and the system will try to resolve it.
For example: Access the key "&key" in the Variable object VARA.TEST
: SET &TEST# = GET_VAR (VARA.TEST, "&&key" )
A blank will be returned when you use GET_VAR for a key that does not exist.
In dynamic variables, you must specify the value of the Result column (parameter Line) in the format that it shows in the data source (SQL - database, MULTI - Variable object). The Variable's output format is irrelevant in this case.
In static variables, you can also use the specific value "KEY" for the column. You can use it in order to check whether a certain key exists in this Variable object. It does not exist when the script function returns an empty value and there is an entry when it returns the key.
In the following example, the script function returns "Test" when there is a key and "" when there is no key:
: SET &KEY# = GET_VAR (VARA.TEST, "Test" , "KEY" )
Examples
The following example retrieves the value of a variable and stores the result in a script variable:
: SET &TEST# = GET_VAR (MM.END.PROCESSING, "BookingDate" )
Script variables can also be used in functions:
: SET &VAR# = "MM.END.PROCESSING"
: SET &VAL# = "BookingDate"
: SET &TEST# = GET_VAR ( &VAR# , &VAL# )
In the following example, the script function GET_VAR is used to define a condition:
: IF GET_VAR (MM.END.PROCESSING, "BookingDate" ) = SYS_DATE ( "DDMMYY" )
!...
: ENDIF
See also:
Script element
Description
Deletes one or all values of a static Variable object.
Stores a value in a static variable object.
Sets the values of script variables by indirect access.
Returns the values of script variables by indirect access.
Prepares the processing of a data sequence (values of a Variable object).
Script Elements - Read or Modify Objects
Agent Variables
Sample Collection:
Database Maintenance with Options
Calling an MBean
Automation Engine 129
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.26 MODIFY_TASK
Script function: Modifies active Workflows.
General information
Workflow modifications are made in several steps using MODIFY_TASK:
1. Stop the Workflow by using the status STOP_MODIFY.
2. Make one or several modifications.
3. Activate your modifications using the status COMMIT.
4. Start the Workflow by using the status GO.
The parameters of this script function must be listed in a particular order. Commas are required even if individual parameters are omitted (see examples below).
Use START or END in order to modify properties in the START or END box.
Note that as of version 9.00A, the Result tab (Workflow properties) no longer exists. It cannot be changed anymore by using the script function MODIFY_TASK.
You cannot use this script element in order to stop or continue the execution of its own Workflow and then end it.
Return codes
130 Chapter 3 Ordered by Function
General:
"0" - The modification was successful.
"9" - The user is not authorized to modify the specified task at runtime.
"20437" - Timestamp not specified in the required format TT/HH:MM.
"20591" - A Workflow with this RunID does not exist or is no longer active.
"20738" - The task is in a status in which modifications are not possible.
"20739" - The task cannot be modified because it is being modified by another user.
"20740" - An invalid object type has been specified.
"20741" - There is no task that shows the specified name and/or running number.
"20742" - The specified task name does not comply with the specified running number.
"20743" - The task cannot be modified because the corresponding Workflow has not been stopped for editing purposes.
"20744" - The task cannot be modified because it is in an unmodifiable status.
"20745" - The task cannot be modified because the value is not allowed.
"20746" - It is not possible to add a dependency because it already exists.
"20747" - A dependency cannot be modified because it is in an unmodifiable status.
"20748" - It is not possible to add a task because this position is already used by another task.
"20749" - The object type of the indicated task is not valid.
"20750" - The function cannot be processed for this task with the particular RunID because of a previous error.
"20752" - External tasks can only be replaced by external tasks.
"20753" - <START> and <END> cannot be replaced.
"20754" - <START> must not have a predecessor.
"20755" - <END> must not have a successor.
"20756" - External tasks must not have a predecessor
"20757" - An invalid task has been specified for the modification of an external dependency.
"20758" - It is not possible to indicate external dependencies.
ADD_TASK:
Running number of the added Workflow task.
"0" - The task could not be added.
REPLACE_TASK:
Running number of the new Workflow task.
"0" - The task could not be replaced.
Start, Stop and Commit
[Start, Stop and Commit]
[ Modifying Workflow structures ] [
]
] [
]
Syntax
MODIFY_TASK (RunID, Status
[, FORCED]
)
Syntax
RunID
Description/Format
Running number (RunID) of the activated Workflow.
Format:
Status
FORCED
Automation Engine 131
Processing status that should be set for the task.
Format: UC4 name, script literal or script variable
Allowed values: COMMIT, GO, STOP and STOP_MODIFY
"COMMIT" - Activates modifications without starting the Workflow.
"GO" - Starts a stopped Workflow. Use the parameter FORCED to start a
Workflow even if its Monitor is open for editing purposes.
"STOP" - Stops a Workflow.
"STOP_MODIFY" - Stops a Workflow for modification purposes.
Should be used in combination with the parameter "GO". FORCED starts a stopped Workflow even if its Monitor has been opened for editing purposes.
Possible modifications made by a different user are lost.
Comments
This script function modifies the processing status of a Workflow.
Examples
The Workflow "MM.DAY" is stopped. Subsequently, it is modified.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RET# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
The Workflow "MM.DAY" starts.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RET# = MODIFY_TASK ( &RUNID# , GO, FORCED)
Modifying Workflow structures
[Modifying Workflow structures] [
] [
]
] [
Syntax
MODIFY_TASK (RunID, Object name,,
ADD_TASK [, EXTERNAL [, Workflow name]]
)
Syntax
RunID
Object name
ADD_TASK
EXTERNAL
Workflow name
Description/Format
Running number (RunID) of the activated Workflow.
Format:
Name of the object that should be inserted in the Workflow.
Format: script literal, number or script variable
Adds a task.
Adds a task as an external dependency.
Name of the Workflow to which the external dependency should refer.
Format: script literal or script variable
132 Chapter 3 Ordered by Function
Comments
This script function adds a task or an external dependency to a Workflow.
A task is positioned in an empty spot within a Workflow. Use MODIFY_TASK in combination with MOVE_
TASK to move it.
Attention: The added task is not automatically linked with other tasks. Draw the required lines by using
MODIFY_TASK together with ADD_DEPENDENCY.
Attention: Two commas must be set after the parameter Object name. This third parameter is the running number of a task within the Workflow. It is irrelevant if you add a task.
Example
The object FILE.INPUT is added to the Workflow MM.DAY.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, ADD_TASK)
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Syntax
MODIFY_TASK
(RunID, [Task name], [running number],
REPLACE_TASK
, Object name
[, EXTERNAL [, Workflow name]]
)
Syntax
RunID
Task name running number
REPLACE_TASK
Object name
EXTERNAL
Workflow name
Description/Format
Running number (RunID) of the activated Workflow.
Format:
Name or running number of the Workflow task that should be replaced.
Format: script literal, number or script variable. Within a Workflow, a task can be identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Replaces a task.
Name of the object that should replace the task.
Format: script literal or script variable
Replaces an external dependency.
Name of the Workflow to which the external dependency refers.
Format: script literal or script variable
Automation Engine 133
Comments
This script function replaces a Workflow task by another object.
An external dependency can only be replaced by an external dependency and a regular Workflow task can only be replaced by a regular Workflow task.
Example
The external dependency MM.GET.FILES is replaced by the external dependency MM.FILE.INPUT.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "MM.GET.FILES" ,, REPLACE_TASK,
"MM.FILE.INPUT" , EXTERNAL)
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Syntax
MODIFY_TASK
(RunID, [Task name], [running number],
MOVE_TASK
, Column, Line)
Syntax
RunID
Task name running number
MOVE_TASK
Column
Line
Description/Format
Running number (RunID) of the activated Workflow.
Format:
Name or running number of the Workflow task that should be moved.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Moves a task.
Number of the column to which the task should be moved.
Format: script literal, number or script variable
Number of the line to which the task should be moved.
Format: script literal, number or script variable
Comments
This script function moves a Workflow task.
Example
The task FILE.INPUT is moved to the fourth line of the first column.
134 Chapter 3 Ordered by Function
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, MOVE_TASK, 1, 4)
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Syntax
MODIFY_TASK
(RunID, [Task name], [running number],
ALIAS
, Alias)
MODIFY_TASK
(RunID, [Task name], [running number],
ALIAS_PARENT
, Alias
Parent)
Syntax
RunID
Task name running number
ALIAS
ALIAS_PARENT
Alias
Alias Parent
Description/Format
Running number (RunID) of the activated Workflow.
Format:
Object name or running number of the Workflow task that should be moved.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
The system automatically uses the task that has the lowest number if there are several tasks of the same name in the Workflow and no running number is specified.
Modifies the alias name of a task or an external dependency in the Workflow.
Modifies the alias name of the Workflow of an external dependency. Can only be used if the external task derives from a different Workflow.
Number of the column to which the task should be moved.
Format: script literal, number or script variable
Alias name for the task, the external dependency or for the Workflow of the external task (only for external dependencies that refer to a task in a different
Workflow).
Format: UC4 name, script literal, number or script variable
The same limitations apply for alias names and for object names:
Maximum length: 200 characters
Allowed characters: A-Z, 0-9, $, @, _, . and #
Comments
This script function modifies the alias name of a task or external dependency in a Workflow.
You can only change the alias name of Workflow tasks and external dependencies that have been added using this script element. Use the parameter ADD_TASK for this purpose.
Automation Engine 135
UC4 recommends indicating the running number in order to ensure that the modifications are made in the correct task. This is especially useful if the Workflow includes several tasks of the same object name. The running number is this script function's code that is returned if you add a task (ADD_TASK).
Example
The task FILE.INPUT is added to the Workflow MM.DAY and its alias name is changed to ALIAS.FT.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &NR# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, ADD_TASK)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" , &NR# ,ALIAS,ALIAS.FT)
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
General tab
] [ Modifying Workflow structures ]
[General tab] [
]
] [
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
CHECKPOINT
, Time stamp
[,
Time zone] [, Alarm object]
)
Syntax
RunID
Task name
Running number
CHECKPOINT
Time stamp
Time zone
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Sets or removes a checkpoint.
Time stamp for the checkpoint.
Format: script literal or script variable
Allowed values:
Time stamp in the format TT/HH:MM - Sets a checkpoint using this time stamp.
"NONE" - Removes the checkpoint
Name of a TimeZone object.
Format: script literal or script variable
TimeZone to which the time stamp should be converted.
136 Chapter 3 Ordered by Function
Alarm object
Object that should start if the checkpoint has been exceeded.
Format: script literal or script variable
Comments
This script function adds a checkpoint to a Workflow task or removes it.
Example
The task FILE.INPUT which is part of the Workflow MM.DAY obtains a checkpoint. The Notification object DAYSHIFT should start if the checkpoint has been exceeded.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, CHECKPOINT,
"00/15:00" ,, "DAYSHIFT" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Earliest tab
] [ Modifying Workflow structures ] [
] [Earliest tab] [
]
] [
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
EARLIEST_START
, Time stamp
[, Time zone]
)
Syntax
RunID
Task name
Running number
EARLIEST_START
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Sets or removes an earliest starting time.
Time stamp
Time zone
Automation Engine 137
Time stamp for the earliest starting time.
Format: script literal or script variable
The comparison value for the earliest start time is the real date (= the generation time of the top workflow).
Allowed values:
Time stamp in the format TT/HH:MM - Sets an earliest starting time with this time stamp.
"NONE" - Removes the earliest starting time
Name of a TimeZone object.
Format: script literal or script variable
TimeZone to which the time stamp should be converted.
Comments
This script function adds an earliest starting time to a Workflow task or removes it.
Example
The task "FILE.INPUT" of the Workflow "MM.DAY" obtains an earliest starting time.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, EARLIEST_START,
"00/18:00" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
ACTIVE
, Value)
Syntax
RunID
Task name
Running number
ACTIVE
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Sets a Workflow task to active or inactive.
138 Chapter 3 Ordered by Function
Value
Allowed values: YES and NO
"YES" - Sets the Workflow task to active. Processing starts at its starting time.
"NO" - Sets the Workflow to inactive. Processing does not start at its starting time.
Comments
This script function sets a Workflow task to active or inactive.
Example
The task FILE.INPUT of the Workflow MM.DAY is set to inactive.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, ACTIVE, "NO" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
BREAKPOINT
, Value)
Syntax
RunID
Task name
Running number
BREAKPOINT
Value
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Sets a breakpoint for a Workflow task or removes it.
Allowed values: YES and NO
"YES" - Sets a breakpoint for the Workflow task.
"NO" - Removes a breakpoint from the Workflow task.
Comments
This script function sets a breakpoint for a Workflow task or removes it.
Automation Engine 139
Example
A breakpoint is set for the task FILE.INPUT of the Workflow MM.DAY.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, BREAKPOINT, "YES" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Dependencies tab
] [ Modifying Workflow structures ] [
] [
[Dependencies tab]
] [
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
LATEST_START
, Time stamp
[, Time zone]
)
Syntax
RunID
Task name
Running number
LATEST_START
Time stamp
Time zone
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Sets a latest start time or removes it.
Time stamp for the latest starting time.
Format: script literal or script variable
Allowed values:
Time stamp in the format TT/HH:MM - Sets a latest starting point using this time stamp.
"NONE" - Removes the latest starting point.
Name of a TimeZone object.
Format: script literal or script variable
Time zone to which the time stamp should be converted.
Comments
This script function adds a latest starting point to a Workflow task or removes it.
140 Chapter 3 Ordered by Function
Example
The task FILE.INPUT of the Workflow MM.DAY obtains a latest starting point.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, LATEST_START, "00/10:00" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
LATEST_END
, Time stamp
[,
Time zone]
)
Syntax
RunID
Task name
Running number
LATEST_END
Time stamp
Time zone
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Sets a latest ending time or removes it.
Time stamp for the latest ending time.
Format: script literal or script variable
Allowed values:
Time stamp in the format TT/HH:MM - Sets a latest ending time using this time stamp.
"NONE" - Removes the latest ending time.
Name of a TimeZone object.
Format: script literal or script variable
Time zone to which the time stamp should be converted.
Comments
This script function adds a latest ending time to a Workflow task or removes it.
Example
The task FILE.INPUT of the Workflow MM.DAY obtains a latest ending time.
Automation Engine 141
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, LATEST_END, "00/18:00" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
DEPENDENCY_STATE_
MATCH
, Value )
Syntax
RunID
Task name
Running number
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Specifies the number of predecessor states that must apply.
DEPENDENCY_
STATE_MATCH
Value
Allowed values: ALL and ONE
"ALL" - All states must apply.
"ONE" - At least 1 status must apply.
Comments
This script function determines the number of predecessor states that must apply in order to have the
Workflow task processed.
Example
All predecessors of the task FILE.INPUT of the Workflow MM.DAY must show the expected status.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, DEPENDENCY_STATE_MATCH,
"ALL" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
142 Chapter 3 Ordered by Function
Syntax
MODIFY_TASK
(RunID, [Successor task name], [Running number], Dependency,
[Source task name] , [Running number], Status)
Syntax
RunID
Successortask name
Running number
Dependency
Task name
Running number
Status
Description/Format
Running number (RunID) of the activated Workflow.
Format:
Name or running number of the successor task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Action for editing dependencies.
Allowed values: ADD_DEPENDENCY, MODIFY_DEPENDENCY and
REMOVE_DEPENDENCY
"ADD_DEPENDENCY" - Adds a dependency.
"MODIFY_DEPENDENCY" - Modifies a dependency.
"REMOVE_DEPENDENCY" - Removes a dependency.
Name or running number of the task whose dependency should be changed.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Status that is expected of the preceding task at the end of its execution.
Format: script literal or script variable
Allowed values: "End status" and "NONE"
"End status" (for example, ENDED_OK)
"NONE" - The preceding task's end status is not monitored.
No status indication is required for "REMOVE_DEPENDENCY".
Comments
This script function adds a dependency to a Workflow task, modifies or removes it. It links tasks with lines.
Automation Engine 143
Example
The START box is linked with the 4th task. The end status the 9th task expects of its predecessor is changed to ANY_OK. The dependency including the line linking the 10th and 11th task is removed.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# ,, 4, ADD_DEPENDENCY, "START" ,, "ENDED_OK" )
: SET &RET# = MODIFY_TASK ( &RUNID# ,, 9, MODIFY_DEPENDENCY,, 8, "ANY_OK" )
: SET &RET# = MODIFY_TASK ( &RUNID# ,, 11, REMOVE_DEPENDENCY,, 10, "ENDED_OK" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
DEPENDENCY_ELSE_ACTION
, Else action
[ , Alarm object]
)
Syntax
RunID
Task name
Running number
DEPENDENCY_
ELSE_ACTION
Else action
Alarm object
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Determines the action that should be taken if the dependencies are not fulfilled as expected.
Allowed values: ABORT, BLOCK, BLOCK_ABORT and SKIP
"ABORT" - The task and the Workflow are canceled.
"BLOCK" - The Workflow blocks at the preceding task.
"BLOCK_ABORT" - The Workflow blocks at the preceding task and sends an abort message to the superordinate Workflow (if existing).
"SKIP" - The Workflow task is skipped.
Object that should start if the checkpoint is exceeded.
Format: script literal or script variable
Comments
This script function determines the action that should take place if dependencies are not fulfilled as expected.
144 Chapter 3 Ordered by Function
Example
The task FILE.INPUT of the Workflow MM.DAY is skipped if the dependencies do not apply.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, DEPENDENCY_ELSE_ACTION,
"SKIP" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Runtime tab
] [ Modifying Workflow structures ] [
] [
]
[Runtime tab] [
Syntax
MODIFY_TASK (RunID, [Task name], [Running number], Runtime option, Value )
Syntax
RunID
Task name
Running number
Runtime option
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Runtime option that should be changed.
Allowed values:
"RUNTIME_USE_TASK_SETTINGS" - The task's MRT/SRT setting should be used.
"RUNTIME_MRT_NONE" - No specified maximum runtime.
"RUNTIME_MRT_FIXED" - Fixed value for the maximum runtime.
"RUNTIME_MRT_ERT" - ERT plus percentage for the maximum runtime.
"RUNTIME_MRT_TIME" - Current date plus period for the maximum runtime.
"RUNTIME_SRT_NONE" - No minimum runtime.
"RUNTIME_SRT_FIXED" - Fixed value for the minimum runtime.
"RUNTIME_SRT_ERT" - ERT minus percentage for the minimum runtime.
"RUNTIME_ELSE_ACTION" - Else action for deviant runtime.
Value
Automation Engine 145
The value depends on the particular runtime option:
For "RUNTIME_USE_TASK_SETTINGS": YES and NO
."YES" - The task's runtime options are used.
"NO" - The runtime options specified in the properties are used.
For "RUNTIME_MRT_NONE": No value
For "RUNTIME_MRT_FIXED": Fixed value in the format HHHH:MM:SS
For "RUNTIME_MRT_ERT": Percentage
For "RUNTIME_MRT_TIME": TT/HH:MM [, Time zone]
"TT" - Days that should be added to the current date.
"HH:MM" - Time
Time zone to which the time stamp should be converted.
For "RUNTIME_SRT_NONE": No value
For "RUNTIME_SRT_FIXED": Fixed value in the format HHHH:MM:SS
For "RUNTIME_SRT_ERT": Percentage
For "RUNTIME_ELSE_ACTION": Else action [, Alarm object]
Else action - "CANCEL" (task is canceled/ended) and "NONE" (no Else action takes place)
Alarm object that should start if the expected runtime is exceeded.
Comments
This script function changes a Workflow task's runtime settings.
Example
The Notification object DAYSHIFT starts if executing the task FILE.INPUT takes longer than two hours.
This minimum runtime is irrelevant in this case.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RETMRT# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, RUNTIME_MRT_FIXED,
"2:00:00" )
: SET &RETSRT# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, RUNTIME_SRT_NONE)
: SET &RETACT# = MODIFY_TASK ( &RUNID# , "FILE.INPUT" ,, RUNTIME_ELSE_
ACTION, "CANCEL" , "DAYSHIFT" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
External Dependency tab
] [ Modifying Workflow structures ] [
] [
]
] [External Dependency tab]
146 Chapter 3 Ordered by Function
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
EXTERNAL_SATISFACTION
,
Lead-time satisfaction
[, Duration]
)
Syntax
RunID
Task name
Running number
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
EXTERNAL_
SATISFACTION
Determines the lead-time satisfaction.
Lead-time satisfaction
Validity of the lead-time satisfaction.
Format: script literal or script variable
Duration
Allowed values: LOGICAL_DATE, LAST_EXECUTION, BEFORE_START and AFTER_START
"LOGICAL_DATE" - Only valid if activated with the same logical date.
"LAST_EXECUTION" - Since last Workflow execution.
"BEFORE_START" - Within a period before the Workflow starts.
"AFTER_START" - After the Workflow starts.
Period for the option "BEFORE_START" in the format "HH:MM:SS."
Format: script literal or script variable
Comments
This script function determines the lead-time satisfaction of an external dependency.
Example
The lead time for the external dependency MM.GET.FILES commences when the Workflow starts.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "MM.GET.FILES" ,, EXTERNAL_SATISFACTION,
"AFTER_START" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Automation Engine 147
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
EXTERNAL_STATUS
, Status)
Syntax
RunID
Task name
Running number
Description/Format
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
EXTERNAL_STATUS
Sets or removes the expected status.
Status
Status that is expected for the external task at the end of its execution.
Format: script literal or script variable
Allowed values: "End status" and "NONE"
"End status" (for example, ENDED_OK)
"NONE" - The system only checks whether the task ended within the lead time. Its status is irrelevant in this case.
Comments
This script function sets the status expected for an external dependency.
Example
The Workflow MM.DAY expects the status ENDED_OK for the external dependency to MM.GET.FILES.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "MM.GET.FILES" ,, EXTERNAL_STATUS, "ENDED_
OK" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
EXTERNAL_ELSE_ACTION
,
Action
[, Alarm object]
)
Syntax Description/Format
148 Chapter 3 Ordered by Function
RunID
Task name
Running number
EXTERNAL_ELSE_
ACTION
Action
Alarm object
Running number (RunID) of the activated object.
Format:
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Determines the action that should be taken if the external task could not fulfill the expected status at least once or did not end within the lead time.
Allowed values: WAIT, SKIP and CANCEL
"WAIT" - Waits
"SKIP" - Skips
"CANCEL" - Cancels the Workflow.
Object that should start if a timeout occurs.
Format: script literal or script variable
Comments
This script function determines the Else action of an external dependency.
Example
The Workflow MM.DAY is canceled if the external dependency referring to MM.GET.FILES does not occur as expected. In this case, the notification object DAYSHIFT should start.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "MM.GET.FILES" ,, EXTERNAL_ELSE_ACTION,
"CANCEL" , "DAYSHIFT" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
Syntax
MODIFY_TASK
(RunID, [Task name], [Running number],
EXTERNAL_TIMEOUT_
ACTION
, Timeout length, Action
[, Alarm object]
)
Syntax
RunID
Description/Format
Running number (RunID) of the activated object.
Format:
Automation Engine 149
Task name
Running number
EXTERNAL_
TIMEOUT_ACTION
Timeout length
Action
Alarm object
Name or running number of the Workflow task.
Format: script literal, number or script variable
Within a Workflow, a task is identified via its name or its running number. You can specify the task name or number within the Workflow. Specifying both parameters requires that the name and the number comply with each other.
Attention: The running number refers to the number within the Workflow and not to the task's RunID (such as "3" for the third task). The running number is recorded in the task box.
Determines the timespan to be waited for the Else action "Wait."
Timeout duration in the format HH:MM:SS.
Format: script literal or script variable
Allowed values: WAIT, SKIP and CANCEL.
"WAIT" - Wait
"SKIP" - Skip
"CANCEL" - Cancels the Workflow.
Object that should start if a timeout occurs.
Format: script literal or script variable
Comments
This script function determines the timeout setting of an external dependency.
Example
The external dependency that refers to MM.GET.FILES is skipped after a one-hour waiting time.
: SET &RUNID# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &RETSTOP# = MODIFY_TASK ( &RUNID# , STOP_MODIFY)
: SET &RET# = MODIFY_TASK ( &RUNID# , "MM.GET.FILES" ,, EXTERNAL_TIMEOUT_ACTION,
"01:00:00", "SKIP" )
: SET &RETCOMMIT# = MODIFY_TASK ( &RUNID# , COMMIT)
: SET &RETGO# = MODIFY_TASK ( &RUNID# , GO)
See also:
Script element Description
Script Elements - Activate Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Modifies the attribute of an activated object.
3.4.27 MODIFY_UC_OBJECT
Script Function: Modifies the attribute of an activated object.
150 Chapter 3 Ordered by Function
Syntax
MODIFY_UC_OBJECT
(RunID, Attribute, Value)
Syntax
RunID
Attribute
Value
Description/Format
Run number of the activated object.
Format:
script literal , number or script variable
Note for using the attribute EARLIEST_STARTTIME: Indicate the RunID of the Workflow to which the task belongs (not the task's RunID).
Attribute that should be modified.
Format: UC4 Name or script variable
Value that should be set.
Format: UC4 Name, script literal, number or script variable
Return code
Automation Engine 151
"0" - Attribute was successfully modified.
"20342" - This attribute is not supported.
For the attribute IGNORE_SYNC applies:
"11191" - The RUN# was not found.
For the attribute PRIORITY applies:
"20591" - The RUN# was not found.
"20587" - The value does not lie between 0 and 255.
For attribute RELEASE applies:
"11016" - The Workflow to be changed does not exist.
"11510" - The Workflow is not active.
"20540" - The RUN# was not found.
For the attribute RESPONSE applies:
"20539" - The Notification with the indicated RUN# does not exist.
"20538" - The value is incorrect.
"11151" - The value for the attribute RESPONSE does not apply for the Notification type (alert, request, message).
"11060" - The combination Notification/value is not supported.
"11061" - The Notification was already acknowledged by a different user.
"11062" - The Notification was acknowledged by a user who is not available in the Notification.
"11064" - The Notification was rejected by a user who is not available in the Notification.
"20859" - The reaction to the Notification was made be a user who is available in the Notification but is inactive.
For the attribute GR_MAX_PAR_JOBS apply:
"11121" - The RUN# was not found.
"20460" - The value does not lie between 1 and 999.
The following applies to the attributes GOIMM, EARLIEST_STARTTIME and REMOVE_
DEPENDENCY:
"20378" - The Workflow could not be found.
"20840" - The task appears in the Workflow more than once.
"20841" - The indicated task does not exist in the Workflow.
For there attribute GAP applies:
20534 - Value "0" is not allowed
20591 - RUN# was not found.
20860 - This is not a recurring task
20861 - The option "With a gap of..." has not been selected in the recurring task.
Comments
The attributes of the activated objects shown in the table below can be modified. The new values are only valid for the current execution of the task and are not stored in the object .
Object type Attribute Value
152 Chapter 3 Ordered by Function
CALL
JOBG
JOBP
RESPONSE
Reaction to a
Notification
"OK" = Acknowledge Notification (message)
"YES" = Respond to Notification (request) with "Yes".
"NO" = Respond to Notification (request) with "No".
"ACCEPT" = Accept Notification (Alert)
"REJECT" = Reject Notification (Alert)
"DONE" = Resolve Notification (Alert)
1 to 999 parallel running tasks.
GR_MAX_
PAR_JOBS
Maximum number of parallel running tasks in a group
RELEASE
Releasing a blocked
Workflow
RUN# of the blocked task in the Workflow.
For the following three attributes, the task that should be changed must be in the status "Waiting for precondition".
GOIMM
A Workflow task is started immediately
Task name that must not be used in the Workflow more than once.
EARLIEST_
STARTTIME
Modifying the earliest start time of a task in a Workflow
Either enter the earliest start time or the keyword "OFF". In both cases, the script function requires the task name.
Syntax for the parameter Value:
Task name, [Time format;]Time
or
Task name, OFF
The start time is assigned to the task or replaces an already existing one. The script function expects the time in the format
"HHMMSS" if no particular format has been defined. The keyword "OFF" removes an existing start time.
REMOVE_
DEPENDENCY
Removing the dependency to the direct predecessor
The task ignores the expected end status of the indicated predecessor. As a result thereof, the task continues if it reaches this task provided that all other predecessors have already ended.
Syntax of the parameter Value:
Task name [, Predecessor's name ]
All predecessors are ignored and the task starts immediately if no particular predecessor is indicated.
Allowed values: 0 to 255 CALL, JOBF,
JOBP, JOBS,
JSCH, SCRI
PRIORITY
Task priority
Workflow tasks IGNORE_
CONDITIONS
Starts a Workflow task that is in the status "Waiting for "
Conditions
Pre-
" immediately. The parameter value is not required.
Automation Engine 153
Workflow tasks
CALL, EVNT,
JOBF, JOBG,
JOBP,
JOBQ,JOBS,
JSCH, SCRI
All executable objects
CHECK_
CONDITIONS
IGNORE_
QUEUE
Starts checking the conditions/actions of a Workflow task that are in the status"Waiting for Pre-Conditions" from the beginning.
The parameter value is not required.
Starts a task that is in a waiting condition because of insufficient
Queue slots immediately. The parameter value is not required.
Recurring tasks
All executable objects
IGNORE_
SYNC
GAP
SET_
EXPRESS
Sync settings are ignored. This parameter must be specified but its value is irrelevant.
Example:
MODIFY_UC_OBJECT ( &RUNNR# , IGNORE_SYNC, "" )
Changes the time gap between the executions in a recurring task.
Value in minutes.
Starts a task that is in the status "Waiting for resource" immediately (JOBS, JOBF and JOBD).
Allowed values: "ON" and "OFF"
Using this script function for modifying a task requires that it has already been generated but is still in a waiting condition. The option Generate at runtime must not be set. To modify a task at its generation time, use the script statement
.
The reaction to occurring errors can be specified using the script statement
. Errors can be analyzed using the
Script Functions for Error Handling
. By default, script processing continues, but it can also be canceled.
This script statement has the effect that all the script's open
are written to the UC4
Database.
Examples
The first example shows how a Notification (request) is acknowledged. In a first step, the RUN# must be determined and then saved to the script variable "&RUNNR#".
: SET &RUNNR# = ACTIVATE_UC_OBJECT ( "Nightshift" )
!...
: SET &MODOBJ# = MODIFY_UC_OBJECT ( &RUNNR# , RESPONSE, OK)
In the second example, a Group is activated and the RUN# is saved in a script variable. The number of parallel running tasks in the group is set to "1". Selected tasks can only be processed one by one.
: SET &RUNNR# = ACTIVATE_UC_OBJECT ( "GRP7" )
: SET &MODOBJ# = MODIFY_UC_OBJECT ( &RUNNR# , GR_MAX_PAR_JOBS, 1)
The following examples show modifications in tasks that run in a Workflow:
!The Job "MM.CLOSING" should start immediately.
: SET &RUNNR# = GET_UC_OBJECT_NR (MM.DAY)
: SET &MODOBJ# = MODIFY_UC_OBJECT ( &RUNNR# , GOIMM, "MM.CLOSING" )
!The Job "MM.CLOSING" should not run earlier than 3pm.
: SET &RUNNR# = GET_UC_OBJECT_NR (MM.DAY)
154 Chapter 3 Ordered by Function
: SET &MODOBJ# = MODIFY_UC_OBJECT ( &RUNNR# , EARLIEST_STARTTIME,
"MM.CLOSING" , "150000" )
!The Job "MM.CLOSING" should ignore the earliest start time.
: SET &RUNNR# = GET_UC_OBJECT_NR (MM.DAY)
: SET &MODOBJ# = MODIFY_UC_OBJECT ( &RUNNR# , EARLIEST_STARTTIME, "MM.CLOSING" ,
OFF)
!The Job "MM.CLOSING" should ignore the dependency to the predecessor
"MM.DAY_END".
: SET &RUNNR# = GET_UC_OBJECT_NR (MAWI.TAG)
: SET &MODOBJ# = MODIFY_UC_OBJECT ( &RUNNR# , REMOVE_DEPENDENCY, "MM.CLOSING" ,
"MM.DAY_END" )
See also:
Adds recipients to a Notification at runtime.
Sets or changes attributes of objects.
Returns the values of a task's attributes during its generation.
Modifies active Workflows.
Determines the reaction to certain errors and messages of script elements.
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.28 SET_SYNC
Script Function: Executes the defined action of a Sync Object.
Syntax
SET_SYNC
(Sync, Action)
Syntax
Sync
Description/Format
Name of the Sync Object whose action should be executed.
Format:
Action
Action that should be executed.
Format: UC4 Name, script literal or script variable
Return codes
"Y" - Sync action could be executed .
"N" - Sync action could not be executed.
Automation Engine 155
Comments
You can define actions concerning a Sync object in the
Sync
tab .
Whether or not an action can be executed depends on the specified definitions because each action can only be executed if there is a particular condition.
Note that write access (W) to the specified Sync object is required in order to execute this script element.
Example
: SET &RET# = SET_SYNC ( "DB.STATUS" , "EXCLUSIVE" )
: IF &RET# = "Y"
: PRINT "Sync condition EXCLUSIVE was set!"
: ELSE
: PRINT "Sync condition EXCLUSIVE was not set!"
: ENDIF
See also:
Script element
Description
Queries the current condition or value of a Sync object.
Assigns a Sync object to a task.
Script Elements - Read or Modify Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.4.29 XML_BEAUTIFY
Script Function: Beautifies the display of a XML document
Syntax
XML_BEAUTIFY
(Reference)
Syntax
Reference
Description/Format
Reference to a XML document whose issued structure is to be formatted
Format:
or
Return codes
"0" - The content of the XML document was successfully beautified
156 Chapter 3 Ordered by Function
Comments
This script function prepares the display of a XML document before it is written to an XML file with
.
A handle must be given to the script function to access an element. This handle is made available by script elements which can take position within the XML document - such as
or
XML_SELECT_NODE . The script function beautifies this element including its
sub-elements and corresponding attributes .
It is also possible to use the handle returned by
to prepare the display of the whole XML document.
Without using XML_BEAUTIFY, all the information about a XML document is written to a file in a line
(without line break). If you open this file with a text editor such as Notepad, the information is unintelligible.
Examples
The complete structure of the documentation is edited to enable more comfortable reading, and then written to the file Docu.xml.
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &RET1# = XML_BEAUTIFY ( &XMLDOCU# )
: SET &RET2# = XML_PRINTINTOFILE ( "C:\UC4\XML_
Documentation\Docu.xml" , &XMLDOCU# )
: XML_CLOSE
In the second example, the elements Description and Objects including their attributes are output in a file.
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &HND# = XML_GET_FIRST_CHILD ( &XMLDOCU# )
: SET &RET1# = XML_BEAUTIFY ( &HND# )
: SET &RET2# = XML_PRINTINTOFILE ( "C:\UC4\XML_Documentation\Docu.xml" , &HND# )
: XML_CLOSE
See also:
Script element
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Writes the XML document in a file
Automation Engine 157
3.4.30 XML_GET_ATTRIBUTE
Script Function: Supplies the value of an element's attribute
Syntax
XML_GET_ATTRIBUTE
(Reference, @Attribute)
Syntax
Reference
Attribute
Description/Format
Reference to the element whose attribute value is to be determined
Format:
or
Name of the attribute with a preceded "@"
Format: script literal or Script variable
Return codes
Content of the attribute
" " - The attribute has no value or the element has no attributes.
Comments
This script function may be used to read an element's attribute value in an XML document.
It requires a reference to be able to access the element. This reference is provided by script elements which can position within the XML document (e.g.
or
).
Structured documentation distinguishes the attribute types "text" and "listing", both of which may be read using XML_GET_ATTRIBUTE.
This script function can only process 1024 characters. Exceeding this limit has the effect that no return code is supplied. Keep this in mind when determining the attribute's length.
Example
The example shown below retrieves the values of the attributes "Name" (enumeration type ) and "Title"
(text type). The contents "Smith" and "on call 2009" are written to the activation protocol.
158 Chapter 3 Ordered by Function
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &HND# = XML_GET_FIRST_CHILD ( &XMLDOCU# )
: SET &HND# = XML_GET_NEXTSIBLING ( &HND# )
: SET &NAME# = XML_GET_ATTRIBUTE ( &HND# , "@Name" )
: PRINT "attribute value: &NAME#"
: SET &TITLE# = XML_GET_ATTRIBUTE ( &HND# , "@Title" )
: PRINT "attribute value: &TITLE#"
: XML_CLOSE
See also:
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Script Elements - Alphabetical Listing
Script-Elements - Ordered by Function
3.4.31 XML_GET_CHILD_COUNT
Script Function: Counts the sub-elements of an element
Syntax
XML_GET_CHILD_COUNT
(Reference)
Syntax Description/Format
Reference
Return code
Number of sub-elements
Automation Engine 159
Reference to the element whose number of sub-elements is to be identified
Format:
or
Comments
The script function determines the number of an element's sub-elements.
A handle must be given to the script function to access the element. This handle is made available by script elements which can take position within the XML document, such as
,
or
Please note that only the sub-elements that are in the next structure level may be counted. The script function does not identify an element's total number of sub-elements.
Example
The number of sub-elements ("2") is identified and output in the activation log.
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &NR# = XML_GET_CHILD_COUNT ( &XMLDOCU# )
: PRINT "Number of sub-elements of Content: &NR#"
: XML_CLOSE
See also:
Script Elements - Read or Modify Objects
160 Chapter 3 Ordered by Function
Structured Documentation www.w3c.org/TR/xmlbase
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.32 XML_GET_FIRST_CHILD
Script Function: Identifies the first sub-element of an element
Syntax
XML_GET_FIRST_CHILD
(Reference)
Syntax
Reference
Description/Format
Reference to the element whose sub-element is to be identified
Format:
or
Return code
Reference to the first sub-element
" " - There is no sub-element.
Comments
The Script function identifies the first sub-element of an element in a XML document.
A handle must be given to the script function so that it can access the appropriate first sub-element.
Handles are used by specific script elements for positioning themselves within the XML document and editing it. The very first handle is the one which is returned by
. It refers e.g. to the root element Content of the structured documentation.
With XML_GET_FIRST_CHILD, which is positioned one level to the right in the structure, XML_GET_
may be used to identify the succeeding element on the same level.
Example
In the following example, the name of the first sub-element of "Description" is retrieved.
Automation Engine 161
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &HND# = XML_GET_FIRST_CHILD ( &XMLDOCU# )
:
:
:
:
IF &HND#
SET
ELSE
<> ""
&NAME# = XML_GET_NODE_NAME
"sub-element: &NAME#"
: PRINT "No sub-element"
: ENDIF
( &HND# )
: XML_CLOSE
See also:
Script element
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Script Elements - Alphabetical Listing
Script-Elements - Ordered by Function
Description
Identifies the last sub-element of an element
Identifies the succeeding element
162 Chapter 3 Ordered by Function
3.4.33 XML_GET_LAST_CHILD
Script function: Identifies the last sub-element of an element
Syntax
XML_GET_LAST_CHILD
(Reference)
Syntax
Reference
Description/Format
Reference to the element whose sub-element is to be identified
Format:
or
Return code
Reference to the last sub-element
" " - There is no sub-element.
Comments
The Script function identifies the last sub-element of an element in an XML document.
A handle must be given to the script function so that it can access the appropriate last sub-element. This reference specifies the position in the XML document. The very first handle is the one which is returned by
XML_OPEN . It refers e.g. to the root element Content of the structured documentation.
XML_GET_LAST_CHILD switches a level deeper into the structure starting at the specified element .
retrieves the subsequent element on the same level.
Example
The following example determines the name of the last sub-element Info with the main element "Content" being the starting point.
Automation Engine 163
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &HND# = XML_GET_LAST_CHILD ( &XMLDOCU# )
:
:
:
:
IF &HND#
SET
ELSE
<> ""
&NAME# = XML_GET_NODE_NAME
: PRINT "No sub-element"
: ENDIF
( &HND#
"Last sub-element: &NAME#"
)
: XML_CLOSE
See also:
Script element
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Identifies the first sub-element of an element
Identifies the subsequent element
164 Chapter 3 Ordered by Function
3.4.34 XML_GET_NEXTSIBLING
Script Function: Identifies the succeeding element
Syntax
XML_GET_NEXTSIBLING
(Reference)
Syntax
Reference
Description/Format
Reference to the element whose successor is to be identified
Format:
or
Return codes
Reference to the subsequent element of the same level
" " - There is no subsequent element.
Comments
This script function identifies the succeeding element on the same level in the XML document.
A handle must be given to the Script function in order to access the succeeding element. Specific script elements use handles to position themselves within XML document and to edit it.
While XML_GET_NEXTSIBLING serves to identify the succeeding element on the same level,
is used to identify the first sub-element .
Example
Starting point for the following example is the first sub-element Description. All subsequent elements of the same level are retrieved and written to the activation protocol - here, it is the element Contacts.
Automation Engine 165
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &HND# = XML_GET_FIRST_CHILD ( &XMLDOCU# )
:
:
:
:
WHILE
SET
&HND#
&NAME#
SET
: ENDWHILE
<>
=
""
XML_GET_NODE_NAME
"element: &NAME#"
&HND# =
(
XML_GET_NEXTSIBLING
&HND#
(
)
&HND# )
: XML_CLOSE
See also:
Script element
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Script Elements - Alphabetical Listing
Script-Elements - Ordered by Function
Description
Identifies the first sub-element of an element
166 Chapter 3 Ordered by Function
3.4.35 XML_GET_NODE_NAME
Script Function: Supplies the name of an element
Syntax
XML_GET_NODE_NAME
(Reference)
Syntax
Reference
Description/Format
Reference to the element whose name is to be identified
Format:
or
Return code
Name of the element
Comments
This script function may be used to read the name of an element in an XML document.
This script function requires a reference to be able to access the element. This reference is provided by script elements which can position within the XML document (e.g.
,
, or
).
supplies a reference of the first element.
This script function can only process 1024 characters. Exceeding this limit has the effect that no return code is supplied. Keep this in mind when assigning element names.
Example
This example shown below retrieves all elements of one leve. Their names "Description" and "Contacts" are output in the activation log.
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &HND# = XML_GET_FIRST_CHILD ( &XMLDOCU# )
:
:
:
:
WHILE
SET
&HND#
&NAME#
SET
: ENDWHILE
<>
=
""
XML_GET_NODE_NAME
"element: &NAME#"
&HND# =
(
XML_GET_NEXTSIBLING
&HND#
(
)
&HND# )
: XML_CLOSE
See also:
Script element
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Script Elements - Alphabetical Listing
Script-Elements - Ordered by Function
Description
Supplies the text of an element
Automation Engine 167
168 Chapter 3 Ordered by Function
3.4.36 XML_GET_NODE_TEXT
Script Function: Supplies the text of an element
Syntax
XML_GET_NODE_TEXT
(Reference)
Syntax
Reference
Description/Format
Reference to the element whose text should be retrieved
Format:
or
Return codes
Text of the element
" " - There is no text.
Comments
This script function may be used to read the an element's text in an XML document.
This script function requires a reference to be able to access the element. This reference is provided by script elements which can position within the XML document (e.g.
,
,
or
The content of a text attribute may be retrieved using the script function
.
This script function can only process 1024 characters. Exceeding this limit has the effect that no return code is supplied. Keep this in mind when determining the element text's length.
Example
The text "Related objects:" of the element Objects is written to the activation protocol in the example shown below.
Automation Engine 169
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &HND# = XML_GET_FIRST_CHILD ( &XMLDOCU# )
: SET &HND# = XML_GET_FIRST_CHILD ( &HND# )
:
:
: WHILE &HND# <> ""
: SET &NAME# = XML_GET_NODE_NAME ( &HND# )
SET &TXT#
= XML_GET_NODE_TEXT ( &HND# )
"Text of the element &NAME#: &TXT#"
: SET &HND# = XML_GET_NEXTSIBLING ( &HND# )
: ENDWHILE
: XML_CLOSE
See also:
Script element
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Sample Collection:
Retrieving Error Message and Number
Script Elements - Alphabetical Listing
Script-Elements - Ordered by Function
Description
Supplies the name of an element
170 Chapter 3 Ordered by Function
3.4.37 XML_OPEN
Script Function: Opens an XML document for processing purposes.
Syntax
XML_OPEN
(Source,
[Object Name]
, @Documentation )
XML_OPEN
(Source,
[RunID]
, Report )
Syntax
Source
Description/Format
Source of the XML document.
Format:
Documentation
Allowed values: DOCU and REPORT
DOCU - Structured documentation.
REPORT - Report of an SAP job.
For structured documentations
Object Name
Name of the object.
Format: script literal or Script Variable
This parameter is optional if this is the own object's tab.
Name of the documentation tab with a preceding "@".
Format: script literal or Script variable
For reports
RunID
Run number (RunID) of the task whose report should be opened.
Format: script literal or script variable
Report
This parameter is optional if the report of the own object is concerned.
Type of XML report
Return code
Reference to the XML document.
Comments
The Script function opens an XML document for processing purposes. This can be the structured documentation or the report of an SAP job .
In order to add further descriptions and explanations, you can use tabs for documentation purposes. You can define them for the individual object types in the UC4 Variable UC_OBJECT_DOCU. The structured documentation is a specific type of description which is characterized by a preceding "@". Structured documentation can be processed with specific script elements.
Automation Engine 171
Reports of SAP jobs are stored as XML documents. For XI_GET_CHANNEL, they contain a list of selected communication channels.
The return code of this script function is a handle which refers to the XML document. Some script elements that are used to process the XML document use this handle as a parameter.
You can close the XML document by using
You cannot open more than one XML document at a time.
As of version 6.00A, this script function is renamed from XML_OPEN_DOCU to XML_OPEN. You can still use the old notation.
Example
The Detailst tab of the object MM.DAY is opened for further processing.
: SET &XMLDOCU# = XML_OPEN (DOCU, "MM.DAY" , "@Details" )
See also:
Script element
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Sample Collection:
Retrieving Error Message and Number
Script Elements - Alphabetical Listing
Script-Elements - Ordered by Function
Description
Closes XML documents.
3.4.38 XML_PRINTINTOFILE
Script Function: Writes the structure of elements in an XML file
Syntax
XML_PRINTINTOFILE
(File, Reference)
Syntax Description/Format
172 Chapter 3 Ordered by Function
File
Reference
Name and path of the XML file
Format:
or
Reference to the element whose structure is to be given
Format: script literal or Script variable
Return code
"0" - The structure was successfully written to the file.
Comments
The script function writes the structure of an element and all sub-elements into a specified XML file.
A reference must be given to the script function so that it can access the element. This reference is made available by script elements which can take position within the XML document, such as
or
XML_SELECT_NODE . This script function outputs this
element including its sub-elements and corresponding attributes in a file.
The reference returned by
can also be used to write the whole structure.
All information about the element's structure is written to the specified file in a line (without line break). If you open this file with a text editor such as notepad, the information given is unintelligible. Apply
before you use the script function to format the file's content and have it displayed in a more intelligible way. The file can also be displayed with the Microsoft Internet Explorer. Here, the element's structure is displayed clearly.
Please note that existing files will be overwritten without any queries.
Example
The complete structure of the documentation is edited to enable more comfortable reading, and then written to the file "Docu.xml".
: SET &XMLDOCU# = XML_OPEN (DOCU,, "@Details" )
: SET &RET1# = XML_BEAUTIFY ( &XMLDOCU# )
: SET &RET2# = XML_PRINTINTOFILE ( "C:\UC4\XML_
Documentation\Docu.xml" , &XMLDOCU# )
: XML_CLOSE
The second example shows how the elements "Description" and "Objects" including their attributes may be output to a file.
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &HND# = XML_GET_FIRST_CHILD ( &XMLDOCU# )
: SET &RET1# = XML_BEAUTIFY ( &HND# )
: SET &RET2# = XML_PRINTINTOFILE ( "C:\UC4\XML_Documentation\Docu.xml" , &HND# )
: XML_CLOSE
See also:
Automation Engine 173
Script element
Description
Beautifies the display of an element's structure
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.4.39 XML_SELECT_NODE
Script Function: Identifies any element
Syntax
XML_SELECT_NODE
(Reference, Element)
Syntax
Reference
Element
Description/Format
Reference to the element that serves as starting point
Format:
or
Name of the element with path from the starting point
Format: script literal or Script variable
Return codes
Reference to the searched element
" " - The searched element does not exist.
Comments
The script function identifies any element in the XML document.
A handle must be given to the script function to position to an element. This element is the starting point for searching the structure. From here, the element whose specified path was registered is searched for.
Specific script elements use handles to position themselves within the XML document, and to edit it. The very first handle is the one that is returned by
XML_OPEN . It refers to the root element. It may be used
by XML_SELECT_NODE to directly identify an element. The script function can also receive its handle
or
XML_GET_NEXTSIBLING . This shows that there are several ways of
accessing elements in ramified structures.
Keep in mind that only elements that are sub-elements of the starting point may be found.
174 Chapter 3 Ordered by Function
Example
The example identifies an element directly from the root element "Content" of the structured documentation. The text of the element "Objects" is output in the activation log.
: SET &XMLDOCU# = XML_OPEN (DOCU, "ON_CALL" , "@Details" )
: SET &HND# = XML_SELECT_NODE ( &XMLDOCU# , "Description/Objects" )
: SET &TEXT# = XML_GET_NODE_TEXT ( &HND# )
: PRINT "Text of the element: &TEXT#"
: XML_CLOSE
See also:
Script Elements - Read or Modify Objects
Structured Documentation www.w3c.org/TR/xmlbase
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.5 Script Structure and Processing
3.5.1 :CONST, :CONSTANT
Script Statement: Creates a script variable as a constant with a specific value.
Automation Engine 175
Syntax
:C[ONST[ANT]]
Variable name = Value
Syntax
Variable name
Value
Description/Format
The name of the script variable that should be defined as a constant.
A script variable's name is limited to 32 alphanumeric characters, including the special characters "$", "_", "@", "§" and "#". German Umlauts are not allowed. The first character must not be a number. Variables within the script must always specified with a leading "&" following the variable name!
Format:
The value of the constant.
Format:
script literal , script variable or
This value cannot be changed subsequently.
Comments
This script element creates a new variable as a constant and assigns a specific value to it. As opposed to variables that you create with
:SET , the values of constants are write-protected and cannot be changed
subsequently.
Note that you cannot use this script element in order to convert an existing script variable to a constant.
This includes that you cannot use a name of an existing variable.
You cannot create a constant with
:DEFINE . This includes that they do not have a certain data type.
Please note that :
CONST automatically rounds floating-point numbers up or down. To save floatingpoint numbers, please use
Examples
: CONST &COMPANY# = "UC4 Software"
: CONST &COUNTRY# = "Austria"
See also:
Script Element
Description
Declares a script variable with a particular data type.
176 Chapter 3 Ordered by Function
Assigns a value to an object variable.
Assigns a value to a script variable.
Sets the values of script variables by indirect access.
Script Elements - Script Structures and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.5.2 :DATA
Script Statement: This is used to declare a script line explicitly as a DATA Line.
Syntax
:DATA
Statement
Syntax
Statement
Description/Format
Command for the specific target system.
Format:
or
Comment
DATA Lines contain commands for processing tasks for the target system.
All lines of the script, that are not commentary lines (commentary lines start with an exclamation mark) or contain script statements (which start with a colon), are usually regarded as DATA Lines. If for any reason a DATA Line starts with a colon or an exclamation mark, conflicts could arise. In this case, it is necessary to explicitly declare this line as a DATA Line by using the :DATA statement.
You can write the statement without quotation marks. In this case, all characters to the end of the line will be recognized. The script variables in the statement are replaced by their content.
DATA lines can only be used with objects of type "Job".
Examples
The script in this example, taken from a PC Batch File, defines a branch to a label where Error Handling will be done. As labels in a PC Batch File usually start with a colon, this line has to be explicitly declared by means of the :DATA statement.
!...
GOTO ERRORMESSAGE
!...
: DATA ":ERRORMESSAGE"
!...
See also:
Script Elements - Script Structure and Processing
Automation Engine 177
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.5.3 :DEFINE
Script statement: Declares a script variable with a particular data type.
Syntax
:D[EFINE]
Script variable, data type
[, Array size]
Syntax
Script variable
Data type
Array size
Description/Format
Name of the script variable that is newly created including a data type.
A script variable's name is limited to 32 alphanumeric characters, including the special characters "$", "_", "@", "§" and "#". German Umlauts are not allowed. The first character must not be a number. Variables within the script must always specified with a leading "&" following the variable name!
Format:
Data type of the declared variable.
Allowed values: "unsigned", "string", "float" or "signed" unsigned: positive integers without signs signed: integers with signs float: floating point number string: string, text
Should the script variable be generated as an array, you can use this parameter to define its size.
Format: number without inverted commas
Allowed values:
1 to 99999
Comments
Script variables can also be directly created using the script element
. This is only possible for the data types "string" or "unsigned". In this case, the data type is automatically retrieved via the specified value. A scripting error occurs if a floating point number or a negative number has been specified.
You cannot declare variables that have already been used. This applies to script and object variables including the definitions made in the Variables & Prompts tab .
Directly assigning the value of a different data type is only possible for script variables that have been created using :SET and only with positive integers and strings.
If you assign a value to a script variable that lies outside of the range of its defined data type, the value will be converted to the target data type automatically.
178 Chapter 3 Ordered by Function
Using the script element :DEFINE without a data type or with a data type that is invalid results in a scripting error.
The following value ranges are available for the different data types:
Data type
unsigned signed string float
Value range
0 to +9 999 999 999 999 999
-9 999 999 999 999 999 to +9 999 999 999 999 999
1 to 1024 characters
-9 999 999 999 999 999.9999999999999999 to +9 999 999 999
999 999.9999999999999999
Use the parameter Array size to have the script variable generated as an array with a defined length. The size must not exceed the value 99999. Please pay attention to the peculiarities in handling
No square brackets [] are required for the array declaration.
Use the script statement
to fill script arrays with several different values.
Examples
Declaration of several variables with different data types and subsequent value assignment:
: DEFINE &a#
, unsigned
: DEFINE &b# , signed
: DEFINE &c# , float
: DEFINE &d# , string
: SET &a# = 12
: SET &b# = -5
: SET &c# = 0.50
: SET &d# = "string"
The following example converts the data type of the variable's value automatically:
: DEFINE &unsigned#
, unsigned
: DEFINE &string# , signed
: SET &unsigned# = 12
: SET &string# = &unsigned#
The following example shows a valid assignment because the variable "&unsigned#" is converted to the correct data type via the function CONVERT:
: DEFINE &unsigned# , unsigned
: DEFINE &string# , signed
: SET &unsigned# = 12
: SET &string# = CONVERT (string, &unsigned# )
A direct value assignment with the data types "unsigned" and "string" is possible if a script variable is created using the script element :SET.
:
SET &setvar# = 12
:
SET &setvar2# = "string"
: SET &setvar# = &setvar2#
This example shows how to create and fill an array.
: DEFINE &array# , unsigned, 5
: FILL &array# [] = GET_VAR (VARA1, ARRAY)
Automation Engine 179
The following example rounds the result of the arithmetic operation 3.0 - 0.1 into a string, using the script function FORMAT while taking a common arithmetical error Epsilon = 0.0000005 and one decimal place into account.
:DEFINE &SCRIPT_VERSION_ORIG#
, float
:DEFINE &SCRIPT_VERSION_ORIG1#
, float
:DEFINE &EPSILON#
, float
:SET &SCRIPT_VERSION_ORIG#
=
3.0
:SET &EPSILON#
=
0.0000005
:P &SCRIPT_VERSION_ORIG#
:SET &SCRIPT_VERSION_ORIG#
=
&SCRIPT_VERSION_ORIG#
-
0.1
:P
BEFORE FORMAT:
&SCRIPT_VERSION_ORIG#
:SET &SCRIPT_VERSION_ORIG#
=
&SCRIPT_VERSION_ORIG#
+
&EPSILON#
:SET &SCRIPT_VERSION_ORIG#
=
FORMAT
(
&SCRIPT_VERSION_ORIG#
,
"0.0"
)
:P
AFTER FORMAT:
&SCRIPT_VERSION_ORIG#
Details concerning the problem of representing floating-point numbers you find in the chapter " Floatingpoint numbers in the Automation Engine ".
See also:
Script Element
Description
This assigns a value to a script variable.
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.5.4 :EXT_REPORT_OFF
Script Statement: Deactivates the logging of a task's script
Syntax
:EXT_REPORT_OFF
Comments
Extended reports also include script reports which contain all the script lines of objects. As this report type is not created by default, it must be activated by the UC4 administrator in the UC4 Variable UC_CLIENT_
SETTINGS with the key "EXT_REPORTS". If this report should only be activated for individual objects, this can be done in their Header tabs.
Use the script statement :EXT_REPORT_OFF to exclude particular script lines or the whole script from being logged. Logging is then suppressed until the end of the script or the script statement :EXT_
REPORT_ON.
In the Script tab of the extended reports, a comment line is given stating the number of script lines which were suppressed.
180 Chapter 3 Ordered by Function
**** EXT_REPORT_OFF_ON: 0005 lines suppressed ***
Note that
contents are also logged unless the parameter EXT_REPORT=OFF has been used with them.
Example
In the example, logging is suppressed for a part of the script.
: EXT_REPORT_OFF
: INC JOCO2UC.SET.GLOBALS
: PUT_ATT FT_SRC_FILE = '$&JOCO_USERID.&COB85_ERRLST_PREF_BS2.&PRGMNAME'
: PUT_ATT FT_DST_FILE = '&PC_PATH\&PRGMNAME_ERRLST.TXT'
: EXT_REPORT_ON
See also:
Script element
Description
Activates the logging of a task's script.
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.5.5 :EXT_REPORT_ON
Script statement: Activates the logging of a task's script.
Syntax
:EXT_REPORT_ON
Comments
Extended reports also include script reports which contain all the script lines of objects. As this report type is not created by default, it must be activated by the UC4 administrator in the UC4 Variable "UC_CLIENT_
SETTINGS" with the k ey "EXT_REPORTS". If this report should only be activated for individual objects, this can be done in their Header tabs.
Use the script statement :EXT_REPORT_OFF to exclude particular script lines or the whole script from being reported. Logging is then suppressed until the end of the script or the script statement :EXT_
REPORT_ON.
Note that
contents are also logged unless the parameter EXT_REPORT=OFF has been used with them.
Automation Engine 181
Example
In the example, logging is suppressed for a part of the script.
: EXT_REPORT_OFF
: INC JOCO2UC.SET.GLOBALS
: PUT_ATT FT_SRC_FILE = "$&JOCO_USERID.&COB85_ERRLST_PREF_BS2.&PRGMNAME"
: PUT_ATT FT_DST_FILE = "&PC_PATH\&PRGMNAME_ERRLST.TXT"
: EXT_REPORT_ON
See also:
Script element
Description
Deactivates the logging of a task's script.
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.5.6 :FILL
Script statement: Stores several values to a script array.
Syntax
:FILL script array =values
Syntax
Script array
Values
Description/Format
Name of the script variable that has been defined as an array. Use the square brackets without content.
Format:
Values that should be stored to the array. You can use the script function
for this purpose.
Format:
Comments
This script function can be used to store several values to a script array at a time. Arrays must be created using
:DEFINE . An array size must be specified because otherwise you cannot assign values. You can
use the script function
GET_PROCESS_LINE, STR_SPLIT or
for this purpose. The values are written to the array starting with the first element (index = 1).
182 Chapter 3 Ordered by Function
If the number of values that should be stored exceeds the array's capacity, only the first values are stored until the capacity is used to its full. If the array is larger than the retrieved values, all other values remain unchanged.
Use empty square brackets [] in order to indicate the script array in this function.
In order to pass arrays between subordinate or superordinate objects :PUBLSH must be used.
Example
The first example uses GET_VAR in order to store the values of a Variable object to the array.
:
DEFINE &ARRAY# , string, 20
:
FILL &ARRAY# [] = GET_VAR (VARA.TEST, KEY1)
:
PRINT "First value of the Variable VARA.TEST, key KEY1: &ARRAY#[1]"
The second example creates the columns of a log file's first line (UC4 Automation Engine) in the array.
: DEFINE &ARRAY# , string, 20
: SET &HND# = PREP_PROCESS_FILE (WIN01,
"C:\AUTOMIC\AUTOMATIONENGINE\TEMP\CPsrv_log_001_
00.txt","*","COL=LENGTH""LENGTH_TAB ,,, ='8=DATE,1,6=TIME,7,200=TEXT'" )
:PROCESS &HND#
: FILL &ARRAY# [] = GET_PROCESS_LINE ( &HND# )
:ENDPROCESS
: SET &RUNVAR# = 1
: SET &LEN# = LENGTH ( &ARRAY# [])
: WHILE &RUNVAR# LE &LEN#
: P "Line &RUNVAR#: &ARRAY#[&RUNVAR#]"
: SET &RUNVAR# = &RUNVAR# + 1
: ENDWHILE
See also:
Script Element
Description
Defines script variables and arrays as object variables.
Retrieves the current line content of a data sequence.
Returns the content of a Variable object.
Searches through a script array and returns the corresponding index.
Retrieves the size of a script array.
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 183
3.5.7 :GENERATE
Script Statement: This controls the processing of script lines during execution of a script.
Syntax
:GEN[ERATE]
Generation Mode
Syntax
Generation Mode
Description/Format
Generation modes for restarts: l l l
ON_RESTART_ALWAYS
Script lines are always processed, regardless of the restart point.
ON_RESTART_CHECK
Script lines are not processed when they are located before the restart point.
ON_RESTART_NEVER
Script lines are never processed, regardless of the restart point.
Generation modes for DATA lines: l l l
UPPER_CASE
Converts the text in all DATA Lines to upper-case.
LOWER_CASE
Converts the text in all DATA Lines to lower-case.
CASE_UNCHANGED
Restores the initial condition of the text (upper-case, lower-case).
Comments
Various expressions can be passed to the :GENERATE statement as Generation Modes. On the one hand, a Generation Mode controls the handling of the script lines when an executable object is restarted.
On the other hand, they can be used to determine whether DATA lines are written in upper or lower-case.
Restarting Executable Objects
The Generation Mode can be used when restarting an executable object in order to define the handling of script lines during script execution. This definition is valid until l l the next :GENERATE statement containing one of the three generation modes or the next
statement.
If :GENERATE is not used when restarting an object, all script lines until the first :RESTART statement are processed and additionally, all lines located after the indicated restart point.
Upper-Case and Lower-Case Characters
Text in
is generally left untouched and transferred to the target system as it was. Script variables, which can be part of DATA lines, however, are exempted. They are supplied with values - hence modified - with the activation of an object that containing such a script.
Some target systems require the DATA lines to be in a certain format. The operating system BS2000, for example, processes JCL statements (Job Control Language) only if they are capitalized, which means that any command would have to be formatted in the UC4 Automation Platform. The :GENERATE
184 Chapter 3 Ordered by Function statement provides several generation modes so that restrictions of the specific target system can be avoided when writing scripts.
Examples
The first example shows how :GENERATE can be used for restarting an object and then the different report outputs resulting from the specified restart points are listed.
: PRINT "Script start"
: RESTART R1
: PRINT "Point R1"
: GENERATE ON_RESTART_ALWAYS
: PRINT "ON_RESTART_ALWAYS"
: GENERATE ON_RESTART_CHECK
: RESTART R2
: PRINT "Point R2"
: RESTART R3
: PRINT "Point R3"
: GENERATE ON_RESTART_NEVER
: PRINT "Script end"
Restart with R1:
2005-01-31 12:17:05 - U0020408 Script start
2005-01-31 12:17:05 - U0020408 Point R1
2005-01-31 12:17:05 - U0020408 ON_RESTART_ALWAYS
2005-01-31 12:17:05 - U0020408 Point R2
2005-01-31 12:17:05 - U0020408 Point R3
Restart with R2:
2005-01-31 12:17:23 - U0020408 Script start
2005-01-31 12:17:23 - U0020408 ON_RESTART_ALWAYS
2005-01-31 12:17:23 - U0020408 Point R2
2005-01-31 12:17:23 - U0020408 Point R3
Restart with R3:
2005-01-31 12:17:48 - U0020408 Script start
2005-01-31 12:17:48 - U0020408 ON_RESTART_ALWAYS
2005-01-31 12:17:48 - U0020408 Point R3
In the following example, the text of the DATA lines is converted to upper-case.
: GEN UPPER_CASE fs $uc4.
See also:
Script element
Description
This is used to set restart points in an executable object.
Automation Engine 185
Script Elements - Script Structure and Processing
Restarting Executable Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.5.8 :IF... :ELSE... :ENDIF
Script Statements: They analyze an expression and depending on the result, they run statements.
Syntax
:IF
Condition
[Statements]
[:ELSE]
[Other Statements]
:ENDIF
Syntax
Condition
Statements
Other Statements
Description/Format
A mathematical expression that consists of
,
or numbers with the possible results "True" or "False"
One or more statements that will be executed when the condition is "True"
Format: script statement
One or more statements that will be executed when the condition is "False"
Format: script statement
Comments
An IF statement is a control structure that you can use to process scripts depending on the result that a
condition supplies. A condition is a logical expression.
When the condition applies (it is true), the statements are executed.
When the condition does not apply (it is false), the :ELSE statements are processed. When the IF block does not contain an :ELSE branch, it continues with the next line that follows the :ENDIF statement.
IF blocks can also be nested. The nesting depth is not limited.
IF blocks do not necessarily include ELSE branches.
Using an OR keyword
To link a condition to several values or to link several individual conditions, you use OR as the keyword.
Conditions show the following structure:
ValueComparison operatorComparison Value[OR Comparison Value...]
186 Chapter 3 Ordered by Function
For example:
: IF &DEP# = "EDP" OR "UC4"
You can use up to 12 ORs in a condition .
Comparison operators
A condition contains one of the following comparison operators:
Rule Operator Short form
= EQ
<> NE
This expression is "True" if at least one of the comparison values equals the
Value.
This expression is "True" when none of the comparison values equals the
Value.
<
>
<=
>=
LT
GT
LE
GE
This expression is "True" if one comparison value corresponds to the defined condition.
A numerical comparison takes place when both comparison values of a condition have a numerical value
(data types signed, unsigned or float). A string comparison takes place in all other cases. Note that leading zeros are only ignored in numerical comparisons.
The following condition supplies "True":
: IF "0" = "0"
An alpha-numeric comparison takes place when there are no numerical values.
The following condition supplies "False":
: IF "0" = "abc"
Script lengths are not checked during the comparison process. The following condition supplies "True" because "S" comes before the "U" in the alphabet.
: IF "Smith" < "UC4"
Note that you must define the script variables that you use in a condition beforehand.
Conditions that include the keyword OR several times can show various behaviors depending on the operator.
For example:
In the following example, one of the values must apply in order to meet the condition.
: IF &WD# = "MON" OR "TUE" OR "WED"
The following condition is only met if the variable does not comply to any of the three values.
: IF &WD# <> "THU" OR "FRI" OR "SAT"
Automation Engine 187
Trailing Blank Spaces Are Not Considered
Trailing blank spaces are not considered in string comparisons. Therefore, blank strings always are equal independent on their length.
For example:
: set &a = 'a
: set &b = 'a'
'
: if &a = &b
: print 'true'
: endif
In this case, comparison of &a with &b would return true as trailing blanks are eliminated before the comparison.
Examples
The following examples show different ways of defining a condition. The examples 1 to 3 put a script variable into relation with one or more comparison values. The fourth example uses the return code of a function.
: IF &USER# = "TSOS"
!...
: ENDIF
: IF &DAT1# = &DAT2# OR " "
!...
: ENDIF
: IF &USER# <> "TSOS" OR "SERVICE" OR SYS_USER_NAME ()
!...
: ENDIF
: IF GET_ATT (OO) = "J"
!...
: ENDIF
See also:
Script element Description
This is used to define a loop for the repeated execution of script elements.
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
188 Chapter 3 Ordered by Function
3.5.9 :INCLUDE
Script Statement: Integrates an Include Object into a script
Syntax
:INC[LUDE]
Include Object
[OldString = NewString][,NOFOUND=IGNORE][,EXT_REPORT=OFF]
Syntax
Include Object
OldString
NewString
Description/Format
Name of the Include object to be integrated
Enter the complete name of the Include object. Script variables are not allowed.
String of the Include object's script which should be replaced by NewString
Format:
String that should replace OldString from the script of the Include object
Format: script literal
Maximum 50 characters
NOFOUND=IGNORE
No error occurs if the specified Include object is not found
EXT_REPORT=OFF
Include object contents are not logged in extended reports. A comment line is output instead.
Comments
Many UC4 objects use identical processing steps in their scripts. Due to Include objects , these do not have to be written and maintained in every single script. Include objects contain often used script parts.
Use the statement :INC to address an Include object from a different object. Whenever an object containing this script statement is activated, the Include object's script is integrated.
OldString and NewString are optional parameters. They can be used to replace an Include object's string by another one. Replacements are only valid for the current generation and do not change the Include object itself.
Examples
This example shows how an Include object is integrated. The string "$MM." specified in the Include object obtains the new name "$MMTEST".
: INC MM.FILEASSIGNMENTS
"$MM." = "$MMTEST."
In the next example, a user Include is called. No error occurs if it does not exist.
: INCLUDE HEADER.WINDOWS.USER.HEAD ,NOFOUND=IGNORE
Logging the contents of the Include object to extended reports is suppressed in the example shown below.
: INC MM.FILEASSIGNMENTS ,EXT_REPORT=OFF
See also:
Automation Engine 189
Script element
Description
Integrates a script into another script of the same object
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.5.10 :INC_SCRIPT
Script Statement: Integrates a script into another script of the same object
Syntax
:INC_SCRIPT
(Script ID)
Syntax
Script ID
Description/Format
Number with which the script of an object is identified
Format: Number without quotations
Allowed values: "0", "1" and "2"
"0" - Includes the script (only in Jobs and Events)
"1" - Includes the pre-script (only in Jobs) and the !Process (only in Events)
"2" - Includes the post-script (only in Jobs)
Comments
This script statement was implemented for internal reasons making it possible to call a script in the
Header. Certain attributes can be set in this script which are then requested in the Header (e.g. another host). Special requirements of the z/OS JCL can be handled with this script.
This script statement can also be used "normally" in order to call a script within another script - even repeatedly. Both scripts must belong to the same object. Therefore, this script statement can only be used in Jobs or Events at this time. These objects have two tabs each for scripts.
For creating your script in modular, UC4 recommends using the
script statement.
Example
The "Pre Script" tab of a Job contains a DIR command. The Pre Script is linked in the Script tab.
: INC_SCRIPT (1)
Afterwards, it can be seen in the Job report that the DIR command was executed twice. The first time in the Header (defined in the Pre Script tab) and the second time between Header and Trailer (by the script statement in the Script tab).
See also:
190 Chapter 3 Ordered by Function
Script element
Description
This integrates an Include Object into a script
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script-Elements - Ordered by Function
3.5.11 :JCL_CONCAT_CHAR
Script Statement: Forms JCL lines to a size of up to 2 KB.
Syntax
:JCL_CONCAT_CHAR [Character]
Syntax
Character
Description/Format
An individual character that serves as a connector to the subsequent JCL line.
Format:
or
Comments
This script statement can be used to connect several scripting lines that contain JCL to one single JCL line. This is done while the Job is being generated. The resulting JCL line must not exceed 2047 characters. The maximum length of individual scripting lines is limited to 1024 characters.
This script statement provides a method of bypassing length limitations in scripting lines. So far, you could only use this method for script variables within the JCL. Because the variables are replaced while the script is being processed, you can generate JCL lines that exceed 1024 characters.
Scripting lines that should be integrated in one JCL line end with the specified character. This character connects the relevant scripting lines with each other at this position. The last scripting line of the JCL line ends without this character.
The character itself is not included in the JCL line. Blanks that are used in the scripting line right before the
character will also be used in the JCL line. Blanks that are used at the beginning of scripting lines will be deleted. By doing so, you can Doing so makes it possible to indent individual JCL statements which increases the script's readability.
You can build several JCL lines in succession. Using this script statement again without any parameters ends the processing of scripting lines.
Using this script element without specifying a character has the effect that you cannot connect several
JCL lines. In this case, the script statement has no functionality.
Note that you cannot combine several commands. This script element can only connect lines that belong to one command.
Automation Engine 191
This script element automatically splits JCL lines that are inserted using the Forms tab of SAP, JMX,
PeopleSoft and Database Jobs and that have a certain length in several lines. UC4 does not recommend inserting this script element manually in the Process tab of these Jobs if you use the
Forms tab because this might cause problems.
Examples
The following example uses a * as the character that connects the individual scripting lines. An MS SQL
Server utility is called with several parameters. The parameter EXIT that contains an SQL statement is written in a new scripting line. The SQL statement itself is split to several scripting lines.
: JCL_CONCAT_CHAR "*"
ISQL.EXE /U SA /P /S BUNTWS02 /t 10 /d UC4 /Q *
"EXIT(UPDATE OH SET OH_EXPKZ = 1 *
WHERE OH_MANDANT = 01 *
AND (OH_OTYP_TYP <> 'FOLD') *
AND OH_LOEKZ = 0)"
: JCL_CONCAT_CHAR
See also:
Script element
Description
Replaces a string in the JCL with another string.
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.5.12 :JCL_SUBSTITUTE
Script Statement: Replaces a string in the JCL with another string
Syntax
:JCL_SUBSTITUTE [Old String, New String]
Syntax
Old String
New String
Description/Format
String to be replaced
Format:
or
String to replace the Old String
Format: script literal or script variable
Comments
This script statement replaces any string in the JCL (Job Control Language) during the generation of a Job.
The number of characters in the Old String and the New String can vary. It is also possible to replace a
192 Chapter 3 Ordered by Function single character.
This script statement is used, for example, to handle special requirements of the z/OS JCL. The character
"&" is required there. Because this character is used for definitions of script variables in UC4, problems can occur.
The specified strings are replaced just after the line with the script statement. They are replaced up to the line of the script in which the script statement is recalled with or without parameters.
Example
In the example, the character "$" is replaced with the character "&".
: JCL_SUBSTITUTE "$" , "&"
REPORTS=($REP)
SORT=TIME
: JCL_SUBSTITUTE
RANGE=$RAN
The generated Job then contains the following lines:
REPORTS=(&REP)
SORT=TIME
RANGE=$RAN
See also:
Script element
Description
Forms JCL lines to a size of up to 2 KB
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script-Elements - Ordered by Function
3.5.13 :PSET
Script statement: Assigns a value to an object variable.
Syntax
:PSET
Object variable = value
Syntax Description/Format
Object variable
Value
Automation Engine 193
Name of an object variable (starting with the character "&") that should be supplied with a value.
A script variable's name for the :PSET and :RSET script statements is limited to 31 alphanumeric characters (in most other cases script variable names are limited to 32 characters), including the special characters "$", "_", "@", "§" and "#". German Umlauts are not allowed. The first character must not be a number. Variables within the script must always specified with a leading "&" following the variable name!
Format:
Value that should be assigned to the object variable.
Format:
script literal , script variable or
Comments
Object variables are stored in the Variables & Prompts tabs of objects.
The Workflow containing the Job, where :PSET is used, is called processor or parent (superordinate task).
Below are the individual steps of :PSET:
1. Replaces or adds the object variable in the task.
2. Replaces or adds the object variable in the parent.
The modified value only applies for the execution of tasks. It is not permanently stored in the object itself.
The setting "Generate at runtime" greatly affects objects. Subsequent modifications in object variables do not affect the script if it has already been generated.
Note that object variables are not always passed on to tasks. You can define in each object if values can be inherited and which of them should be inherited from the superordinate task.
In nested Workflows, :PSET does not pass on object variables. These are only replaced or added in the particular Workflow which contains the task the script statement :PSET addresses.
Note that inherited object variables that have not been defined in the task itself are only available as long as the task is shown in the Activity Window. If restarted, the Job as shown in the example below can only access the object variable &HOST# if FileTransfer plus Workflow are still available in the
Activity Window.
Also note that a script where
ACTIVATE_UC_OBJECT is used as the activator of a Job will neither be a parent nor a processor of the Job. Therefore, canceling the script will not cancel the Job.
On the other hand will canceling the Job in a parent (the Workflow containing the Job, for example) directly cancel the Job itself. The parent-child relationship directly affects the Job.
Example
A Workflow contains the two objects "MM.GET.FILES" and "MM.END.PROCESSING". The setting
"Generate at runtime" has been specified in both objects in order to ensure that their scripts are only generated when it is their turn.
194 Chapter 3 Ordered by Function
The FileTransfer checks the environment and changes the object variable &HOST# if required.
: PSET &HOST# = "unix01"
See also:
Script element
Description
Assigns a value to a script variable and stores it in the activation report.
Assigns a value to a script variable.
Sets the values of script variables indirectly.
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.5.14 :PUBLISH
Script Statement: Defines script variables and arrays as object variables.
Syntax
:PUB[LISH]
Variable Name
[, [Object Variable] [,Scope] ]
Syntax Description/Format
Variable Name
Object Variable
Scope
Automation Engine 195
The name of the script variable or script array (including a & character).
A script variable's name is limited to 32 alphanumeric characters, including the special characters "$", "_",
"@", "§" and "#". German Umlauts are not allowed. The first character must not be a number. Variables within the script must always specified with a leading "&" following the variable name!
Format:
In arrays, you must additionally use empty brackets [] at the end of the name.
The new name of the object variable (without a leading & character).
Format: UC4 name
For arrays, the empty index brackets [] at the end of the variable name must not be specified!
This determines the validity range of the variable.
Allowed values: TASK, WORKFLOW or TOP
TASK - The object variable is only available for its own task.
WORKFLOW - The object variable is passed on to the parent Workflow.
TOP - The object variable is passed on to the top
Workflow.
Comments
The script statement :PUBLISH converts a script variable or a script array to an object variable and, if required, it passes it on to the superordinate task.
If you define the parameter Object Variable, the system creates a new object variable with this name and the value of the script variable. An existing object variable of the same name will be overwritten and the script variable remains unchanged in this case.
Note that the specified script variable or the array must already exist. Otherwise, a runtime error will occur.
When you specify a script array, the empty elements at the end of the array will not be used in or removed from the object variable regardless if the script variable is converted or when a new object variable is created.
Performance losses can be the result of using a script array that includes numerous elements (10000 or more).
This script statement is similar to the script element
. The difference is that the specified scripting variable must exist and that you can also use arrays.
By using the parameter Scope, you can specify the tasks in which the object variable should be used. The variable can be passed on to the parent Workflow, the top Workflow or only be used within its own task.
196 Chapter 3 Ordered by Function
Examples
The following example stores the object name in a script variable and passes it on to the superordinate
Workflow using :PUBLISH.
: SET &CHILD# = SYS_ACT_ME_NAME ()
: PUBLISH &CHILD# ,, "WORKFLOW"
The second example creates a script array and fills it with the values of a Variable object. The array and the passed on to the top Workflow as the new object variable.
: DEFINE &ARRAY# , string, 5
: FILL &ARRAY# [] = GET_VAR (VARA.TEST, KEY1)
: PUBLISH &ARRAY# [], VARA_ARRAY#, "TOP"
See also:
Script element
Description
Stores several values to a script array.
Retrieves the value or PromptSet variable of a certain task.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Functions
3.5.15 :RESTART
Script Statement: This statement sets restart points in an executable object.
Syntax
:RESTART
Restart Point
[, Restart Text]
Syntax
Restart Point
Restart Text
Description/Format
The name of the restart point.
Format: restart point name without quotation marks
Maximum of 8 characters
The description of the restart point.
Format:
or
Maximum of 24 characters
Comments
You use the :RESTART statement to set restart points in an executable object. Restart points allow you to start an executable object from a particular position. You can define them when you execute objects with options.
Automation Engine 197
The Restart Text can be used to describe the restart point. This description is written to the execution protocol as additional information. Restart Text is an optional parameter.
Note that script handling in restarts depends on the script statement
this script statement, all script lines are processed until the very first :RESTART statement and additionally all lines are processed that are positioned after the indicated restart point.
The script functions
and
can be used to read the restart point that has last been passed including its restart text.
Examples
The following example defines a restart point and a Restart Text.
: RESTART REORG, "Start Reorganization"
See also:
Script element
Description
This statement controls the processing of script lines during the execution of a script.
Repeats the execution of a task.
Retrieves whether the object has been activated in restart mode.
Returns the run number (RunID) of an object activated in restart mode.
198 Chapter 3 Ordered by Function
Supplies the name of the previous restart point in the script.
Supplies the text of the previous restart point as defined in the script.
Supplies the restart point from which the object will be executed.
Script Elements - Script Structure and Processing
Restarting Executable Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.5.16 :RSET
Script Statement: Assigns a value to a script variable and stores it in the activation report.
Syntax
:RSET
Script variable
[= Value]
Syntax
Script variable
Value
Description/Format
The name of the script variable that should be given a value.
A script variable's name for the :PSET and :RSET script statements is limited to 31 alphanumeric characters (in most other cases script variable names are limited to 32 characters), including the special characters "$", "_", "@", "§" and "#". German Umlauts are not allowed. The first character must not be a number. Variables within the script must always specified with a leading "&" following the variable name!
Format:
The value that should be assigned.
Format:
script literal , number, script variable or
Comments
This script statement stores the value that it assigns to a script variable in the activation report. The following line is written to the activation report:
YYYY-MM-DD HH:MM:SS - U0020206 Variable '&VAR#' was stored with the value
'VALUE'.
You can use the script elements :RSET and :READ in order to store values of script variables in the report.
The stored value can then be used in various ways.
On the one hand, tasks can be restarted with this stored value. No value is assigned in restarts (value assignment is part of the script statement). Activation is canceled when the appropriate script variable
Automation Engine 199 cannot be found. If the script variable has been stored several times, the value that has last been assigned is used without a warning message being displayed.
A different way of using this script statement is to pass the content of a job's script variable from Process to Post Process. In the Process tab, the value is assigned to the script variable. In the Post Process tab, the script statement is called again. No value is assigned this time but the script variable then contains the script value which has last been stored in the activation report.
Note that the data types "signed" and "float" will automatically be converted to "string" when the value of a script variable is stored to the activity report using the script element :RSET. Data type "unsigned" will not be converted.
Using :RSET in the script of a Workflow generates an object variable that will also be passed on to subordinate Workflow tasks (provided that this option is activated in the child tasks). An overlap of the object variable's name with the name of the Workflow task can cause an error when the subordinate
Workflow tasks are generated (see :
- syntax). Make sure that variable names always end with a special character in order to avoid overlaps.
When you assign :SET and :RSET statements the same script variable with different values, their values will be set by those :SET and :RSET statements when the job is executed. However, if the job is restarted, the values of both variables will be set by the :SET statement. This is because
:RSET statements automatically create object values and :SET statements automatically save the value for a restart. This is a change in behavior from v8, where :RSET statements did not create object values.
Example
The following example accesses a script variable whose value is already set in the Process tab in the
Post Process tab .
Process tab:
: RSET &TEXT# = "test"
: SET &NUMBER# = 1
: RSET &NUMBER# = ADD ( &NUMBER# ,1)
Post Process tab:
: RSET &TEXT#
: RSET &NUMBER#
: PRINT &TEXT#
: PRINT &NUMBER#
The values "test" and "2" are transferred to the Post Process tab and written to the activation report.
See also:
Script element
Description
Assigns a value to an object variable.
This assigns a value to a script variable.
Sets the values of script variables by indirect access.
Script Elements - Script Structure and Processing
200 Chapter 3 Ordered by Function
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.5.17 :SET
Script Statement: Assigns a value to a script variable.
Syntax
:S[ET]
Script variable = Value
Syntax
Script variable
Value
Description/Format
The name of the script variable to which a value should be supplied.
A script variable's name is limited to 32 alphanumeric characters, including the special characters "$", "_", "@", "§" and "#". German Umlauts are not allowed. The first character must not be a number. Variables within the script must always specified with a leading "&" following the variable name!
Format:
The value that should be assigned to the script variable.
Format:
script literal , script variable or
Comments
Refer to the document that describes the peculiarities and practical usage of
When the specified variable does not yet exist, it will newly be created. In this case, the variable does not have a specific data type.
You can also use this script element to solve arithmetic expressions. For more information, see
When predefined variables that are enclosed in parentheses are used as values and supply numerical values (such as &$CLIENT#), they will automatically be converted to the 16-digit default format.
When you assign :SET and :RSET statements the same script variable with different values, their values will be set by those :SET and :RSET statements when the job is executed. However, if the job is restarted, the values of both variables will be set by the :SET statement. This is because
:RSET statements automatically create object values and :SET statements automatically save the value for a restart. This is a change in behavior from v8, where :RSET statements did not create object values.
Examples
The example assigns a file name to the script variable "&FILE".
: SET &FILE# = "L.LST.FILE"
Automation Engine 201
In the following example, the current date - which is retrieved using a script function - is assigned to the script variable "&TODAY".
: SET &TODAY# = SYS_DATE (YYMMDD)
A script variable can also include numbers.
: SET &NUMBER# = 1
You can also assign a value of a different script variable.
: SET &NR# = &NUMBER#
See also:
Script element
Description
Declares a script variable with a particular data type.
Assigns a value to an object variable.
Assigns a value to a script variable and saves it to the activation report.
Sets the values of script variables by indirect access.
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.5.18 :SET_SCRIPT_VAR
Script statement: Sets the values of script variables through indirect access.
Syntax
:SET_SCRIPT_VAR
Script variable = Value
Syntax
Script variable
Value
Description/Format
A placeholder for the name of the script variable that should obtain a value.
A script variable's name is limited to 32 alphanumeric characters, including the special characters "$", "_", "@", "§" and "#". German Umlauts are not allowed. The first character must not be a number. Variables within the script must always specified with a leading "&" following the variable name!
Format:
or
The value that is assigned to the script variable.
Format: Script, Script variable or
202 Chapter 3 Ordered by Function
Comments
This script statement sets the values of script variables. It is not necessary to explicitly specify the names of the script variables. Script variables can indirectly be accessed by using placeholders. These placeholders then have variable characters.
You can easily set the values of many script variables (such as in a processing loop). The script statement
:SET_SCRIPT_VAR replaces many conditional statements that were so far required by a single scripting line.
Script variable passes a string on to the script statement that is used for the name of a script variable.
Ensure that this string does not begin with "&" because this character is used to identify script variables.
The minimum number of initial letters that is used for the script variable name (without &) should clearly identify the script variables. The script statement :SET_SCRIPT_VAR creates a valid script variable name and assigns a Valuetoit.
An error occurs if a script variable which that should be accessed does not exist.
No value is assigned if the specified string applies to the names of several script variables. UC4 recommends using a string that ensures that the script variable can be clearly identified.
This script statement cannot be used to create script variables. This must be done before you use the statement :SET where the variables obtain initial values.
Note that this script element does not distinguish uppercase and lowercase letters in the names of script variables. This means that the system will always access the same script variable when you use placeholders (script variable) that are basically the same but use uppercase and lowercase characters differently.
Example
The example is based on a Variable object and a Job. The names of script variables (key) and their values
(value 1) are stored in a Variable object.
Automation Engine 203
In the Job script, the name of the script variable is taken from the first column of the Variable object (using a processing loop). Afterwards the value of the script variable is taken from the second column.
Subsequently, the retrieved values are assigned to the variables "&END#", "&START#" and "&ULTIMO#" in the script.
: SET &END# = ""
: SET &START# = ""
: SET &ULTIMO# = ""
: SET &HANDLE# = PREP_PROCESS_VAR ( "SCRIPT_VARA" )
:
:
: PROCESS &HANDLE#
: SET &VARIABLE# = GET_PROCESS_LINE ( &HANDLE# ,1)
SET &VALUE# = GET_PROCESS_LINE ( &HANDLE# ,2)
SET_SCRIPT_VAR &VARIABLE# = &VALUE#
: PRINT "&VARIABLE# = &VALUE#"
: ENDPROCESS
: CLOSE_PROCESS &HANDLE#
Use PRINT in order to have the Variable object's values output in the activation report (Key = Value 1).
Report extract:
2005-02-03 13:46:59 - U0020408 End = 20051027
2005-02-03 13:46:59 - U0020408 Start = 20051024
2005-02-03 13:46:59 - U0020408 Ultimo = 20051031
See also:
Script element
Description
Returns the values of script variables by indirect access.
Assigns a value to an object variable.
Assigns a value to a script variable and saves it to the activation report.
This assigns a value to a script variable. The statement can be written in short or long form.
Script Elements - Script Structure and Processing
Script Elements - Alphabetical List
Script Elements - Ordered by Function
204 Chapter 3 Ordered by Function
3.5.19 :SWITCH ... :CASE ... :OTHER ... :ENDSWITCH
Script Statement: It verifies whether the value of a variable complies with certain values and, depending on the result, it runs various statements.
Syntax
:SWITCH
Variable
:CASE
Expression1
[Statements]
[:CASE
Expression2
[Statements]
...
]
[:OTHER
[Statements]
...
]
:ENDSWITCH
Syntax
Variable
Expression1,
Expression2 ...
Statements
Description / Format
The name of the variable whose value should be verified.
Format:
Conditions or the values that form the conditions.
Format:
script literal , script variable, complex expression or
One or several statements that should be processed when the variable complies with the specified value.
Format: script statement
Comments
A SWITCH statement forms one or several conditions by running various statements depending on a variable's value. A :SWITCH block consists of one or several :CASE statements and must end with
:ENDSWITCH.
With each :CASE statement, you determine a value or an expression that should be evaluated. It is followed by the statements that should be processed when the value or the expression applies. These statements end with a new :CASE line or with :ENDSWITCH.
You can also define an :OTHER branch whose statements will be processed when no :CASE statement applies. Note that the :OTHER statement must only be used after the last :CASE statement.
You can also use several :CASE statements in a row without explicitly separating them. They are connected by OR relations. Note that this is only useful in complex expressions.
You can also use
to evaluate expressions. Their statement block, however, is limited to one condition and one Else condition.
As values, you can also use complex expressions such as arithmetic terms:
: SWITCH &NUM#
: CASE 3*(5-2)
Automation Engine 205
: PRINT "&NUM# = 9"
: ENDSWITCH
You can also use the construct between value1 and value2, and the operators <, >, <>, <=, >=, = in
:CASE lines. In this case, you must specify the string "Y" instead of the variable name:
: SET &STATUS# = GET_STATISTIC_DETAIL ( &RUNID# ,STATUS)
: SWITCH "Y"
: CASE &STATUS# between 1300 and 1599
: CASE &STATUS# between 1700 and 1799
: PRINT "The task &RUNID# is active."
: CASE &STATUS# between 1600 and 1699
: PRINT "The task &RUNID# is in a waiting condition."
: CASE &STATUS# between 1800 and 1899
: PRINT "The task &RUNID# has aborted."
: CASE &STATUS# >= 1900
: PRINT "The task &RUNID# has successfully ended."
: ENDSWITCH
Examples
The following example retrieves the current day of the week as a number and verifies it using a SWITCH statement. Mondays and Fridays, a specific Job starts.
: SET &DATE# = SYS_DATE_PHYSICAL ( "DD.MM.YYYY" )
: SET &WEEKDAY# = WEEKDAY_NR ( "DD.MM.YYYY:&DATE#" )
: SWITCH &WEEKDAY#
: CASE 1
: SET &ACT# = ACTIVATE_UC_OBJECT (JOBS.MONDAY, WAIT)
: CASE 5
: SET &ACT# = ACTIVATE_UC_OBJECT (JOBS.FRIDAY, WAIT)
: OTHER
: PRINT "No Processing."
: ENDSWITCH
See also:
Script Element
Description
They analyze an expression and depending on the result, they run statements.
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
206 Chapter 3 Ordered by Function
3.5.20 :WAIT
Script Statement: This is used to stop processing of the script for a specified period of time. In the meantime, other tasks will be completed.
Syntax
:WAIT
Time
Syntax
Time
Description/Format
The time in seconds that defines how long the run should be paused.
Format:
or number
Comments
You can use this script statement to pause the processing of a script. Processing is paused for the specified period of Time and will then continue.
This script statement causes all open
of the script to be written to the UC4 Database.
Examples
Script processing will pause for 10 seconds.
: WAIT 10
See also:
Script element
Description
This cancels the processing of a script.
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.5.21 :WHILE... :ENDWHILE
Script Statement: Defines a loop in which scripting parts can be executed several times.
Syntax
:WHILE
Condition
[Statements]
:ENDWHILE
Syntax
Condition
Statements
Automation Engine 207
Description/Format
An expression that consists of
,
,
or numerical expressions and supplies the results "True" or "False".
One or several statements that are processed until the Condition is "True".
Format:
.
Comments
The :WHILE statement is a control structure that can be used to process parts of a script several times depending on the results of a condition. A condition is a logical expression.
The statements are processed when the condition is met (true). The condition is then re-evaluated and the statements are re-processed if the condition is met. This process is repeated until the condition is no longer met (wrong). In this case, the script continues with the line that follows the :ENDWHILE statement.
Note that a terminating condition is required because otherwise, an endless loop occurs.
WHILE blocks can also be nested. Block depths are not limited.
Conditions show the following structure:
Value Comparison operator Comparison Value [OR Comparison Value...]
For example:
: WHILE &ABT# = "EDP" OR "UC4"
A condition can comprise of up to 13 ORs .
A condition consists of one of the following comparison operators:
Operator Abbreviation Rule
= EQ The expression is "True" if at least one of the Comparison Values equals
Value.
<>
<
NE
LT
The expression is "True" if none of the Comparison Values equals Value.
>
<=
>=
GT
LE
GE
The expression is "True" if one of the Comparison Values meets the defined condition.
Script variables do not have a particular data type and can include numbers and strings. Therefore, keep in mind that:
A numerical comparison is made if value contents that should be compared are numeric. It is irrelevant whether the variable has been specified in inverted commas or not.
The following condition supplies "True":
: WHILE "0" = "0"
An alpha-numeric comparison is made if non-numerical values are used.
The following condition supplies "Wrong":
: WHILE "0" = "abc"
208 Chapter 3 Ordered by Function
When you compare strings, the system does not check their lengths. The following condition supplies
"True" because "S" comes before the "U" in the alphabet.
: WHILE "Smith" < "UC4"
Examples
The following example requests a user to enter a name and a department. The request is repeated until the user enters a name that is not his or her own name.
: SET &REPEAT# = "Y"
: WHILE &REPEAT# = "Y"
: SET &DEP# = SYS_USER_DEP ()
: SET &NAME# = SYS_USER_NAME ()
: BEGINREAD
: READ &DEP# , "08" , "Please enter a department" , &DEP# , "M"
: READ &NAME# , "08" , "Please enter a name" , &NAME# , "M"
: ENDREAD
:
:
:
:
: IF SYS_LAST_ERR_NR () <> 0
: STOP
: ELSE
: IF SYS_USER_NAME () = &NAME#
SET
ELSE
SET
: ENDIF
: ENDIF
&REPEAT#
SET_LAST_ERR
&REPEAT#
=
=
"Y"
10006,
"N"
"Please enter a name that is not your own name"
: ENDWHILE
See also:
Script element Description
Evaluate an expression and execute statements depending on the result.
Script Elements - Script Structure and Processing
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.5.22 FIND
Script function: Searches a script array and returns the corresponding index.
Syntax
FIND
(script array, search key
[, start position]
)
Syntax Description/Format
Automation Engine 209
Script array
Search key
Start position
Name of the script array that should be searched.
Format:
String or number that should be searched.
Format:
string literal , number without inverted commas,
Index from which the search should start.
Format: number without inverted commas,
Return codes
Index of the array in which the search key was found.
0 = No search result
Comments
Searching for a search key has the effect that a search is made for all script-array values starting with the index start position. The complete array will be searched if no start position has been specified (starting with index 1). A successful search returns the array index in which the text or number could be found first.
You can use the next index of the previous result as the start position to continue the search for the remaining part of the array. The script function FIND returns 0 if no results could be found.
Script arrays need to be specified with empty square brackets [].
Use
to create script arrays; the data type and size are also determined during this process. Array fields to which no particular value has been assigned obtain the default value "" (data type: string) or 0
(numerical data types). Thus, the script function FIND is only useful if the array includes the corresponding values. You can set array elements individually and specify the index using
. The script statement
can be used to store several different values to an array at the same time.
Examples
The example shown below creates and initializes an array with Variable object values. Afterwards, WIN will be searched in the complete array and all results will be written to the activation report.
: DEFINE &array# , string, 5
: FILL &array# [] = GET_VAR (VARA.WIN, AGENTS)
: SET &search# = FIND ( &array# [], "WIN" , 1)
: WHILE &search# <> 0
: PRINT "WIN found at position &search#"
: SET &search# = &search# + 1
: SET &search# = FIND ( &array# [], "WIN" , &search# )
: ENDWHILE
See also:
Script element
Description
Stores several values in a script array.
Retrieves the size of a script array.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
210 Chapter 3 Ordered by Function
3.5.23 GET_SCRIPT_VAR
Script Function: Returns the values of script variables by indirect access.
Syntax
GET_SCRIPT_VAR
(Script variable)
Syntax
Script variable
Description/Format
Placeholder for the name of the script variables whose values should be read.
Format: UC4 name,
or
Comments
This script function reads the values of script variables. There is no need to set the names of the script variables. You can indirectly access these script variables by using a placeholder. This placeholder has the character of a variable. Therefore, you can easily query the values of many script variables (for example, in a processing loop). This script function replaces many conditional statements with a single scripting line.
You can use Script variable in order to assign a string to this script function. The name of a script variable is the composed of this string. It is not required that the string begins with a "&" character which usually identifies a script variable. However, you must include as many of the variable name's initial characters that are required in order to clearly identify the script variable. If it cannot be identified, the system reads the value of the first applicable variable.
The variable name is searched as of the & or the next character. An error occurs if the specified string does not comply with any variable name's beginning.
This script element can also be used to retrieve the values of object and PromptSet variables.
Example
The following example is based on a Variable object and a Job. The script variable names are stored in the
Variable object.
Automation Engine 211
In a processing loop, the Job script reads the script variable name from the Variable object. This name is passed on to the variable &VALUE#. The script variable name and its value can be output in the activation report by using a PRINT statement in combination with the script variable "&VALUE#". This script variable includes the contents of END#, &START# and &ULTIMO#.
: SET &END# = "20051027"
: SET &START# = "20051024"
: SET &ULTIMO# = "20051031"
: SET &HANDLE# = PREP_PROCESS_VAR ( "SCRIPT_VARA" )
: PROCESS &HANDLE#
: SET &VARIABLE# = GET_PROCESS_LINE ( &HANDLE# ,1)
: SET &VALUE# = GET_SCRIPT_VAR ( &VARIABLE# )
: PRINT "&VARIABLE# = &VALUE#"
: ENDPROCESS
: CLOSE_PROCESS &HANDLE#
Extract from the report:
2005-02-03 12:51:23 - U0020408 End = 20051027
2005-02-03 12:51:23 - U0020408 Start = 20051024
2005-02-03 12:51:23 - U0020408 Ultimo = 20051031
See also:
Script element
Description
Sets the values of script variables by indirect access.
Assigns a value to a script variable and saves it to the activation report.
Script Elements - Script Structure and Processing
212 Chapter 3 Ordered by Function
Script Elements - Alphabetical List
Script Elements - Ordered by Function
3.5.24 LENGTH
Script function: Retrieves the size of a script array.
Syntax
LENGTH
(Script-Array
[, SIZE]
)
Syntax
Script array
Description/Format
The name of the script variable that has been defined as an
.
Format:
Ignores the empty elements at the end of the array.
SIZE
Return codes
The number of script array elements.
Comments
You can create script arrays by using the script element
in which you can also determine the data type and the number of elements. Subsequently, you can query the array size using the script function LENGTH. You use empty brackets [] in order to indicate that it is an array.
The maximum size of a script array is 99999.
A script error will occur when the specified array cannot be found or when you specify a script variable.
When you specify the parameter SIZE, this script function only returns the number of filled array elements.
The empty elements at the end of the array are ignored.
Note that for retrieving the size up to the last filled element (SIZE parameter), the array must have the data type "string". All other data types will always return the total array size.
Examples
The following example creates a script array, fills it with values from a Variable object and outputs these values with a loop.
: DEFINE &ARRAY# , string, 5
: SET &LEN# = LENGTH ( &ARRAY# [])
: SET &VAR# = 1
: FILL &ARRAY# [] = GET_VAR (VARA1, ARRAY)
: WHILE &VAR# LE &LEN#
: PRINT "Element &VAR# = &ARRAY#[&VAR#]"
: SET &VAR# = &VAR# + 1
: ENDWHILE
See also:
Automation Engine 213
Script Element
Description
Stores several values to a script array.
Searches through a script array and returns the corresponding index.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.6 Error Handling and Messages
3.6.1 :EXIT
Script Statement: Terminates the processing of a script and sends a return code.
Syntax
:EXIT [Return code]
Syntax
Return code
Description/Format
Value that should be used as the return code.
Format: number,
or
Default value: "0"
Comment
You can use this script statement in order to stop the processing of a script with a specified return code. In doing so, you can react to conditions that cause the task to be canceled. For example, you can test a variable's content in a Script object and depending on the content, you can either continue or cancel the task.
If you use this script statement without a return code or with the value 0, script processing ends normally with the return code 0. The task itself continues (this means that jobs start with the generated JCL,
Notifications are displayed etc).
You can also define user return codes as return codes. Script processing is canceled and the task ends abnormally (ENDED_NOT_OK). If the option generate at runtime is activated in the task's Attributes tab, you can react to this user return code within a Workflow.
:EXIT terminates script processing. Therefore, you cannot use this script element in Post Process tabs. UC4 recommends using the script statement
in such a case.
Example
The first example ends script processing with the return code 10.
214 Chapter 3 Ordered by Function
: EXIT 10
See also:
Script element
Description
Modifies the return code or status text of a Job after it has ended.
Cancels script processing.
Script Elements - Error Handling and Messages
System Return Codes of Executable Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.6.2 :ON_ERROR
Script Statement: Determines the reaction to particular errors and messages of script elements
Syntax
:ON_ERROR
Reaction
Syntax
Reaction
Description/Format
Keyword for the reaction to errors and messages
Format:
Allowed values: "ABEND", "RESUME"
Default: "RESUME"
"ABEND" - Script processing canceled
"RESUME" - Script processing continued
Comments
This script statement influences the following script functions:
Automation Engine 215
By default, UC4 ensures that script processing with these script functions is not aborted if errors occur.
These errors can be analyzed with the Script Functions for Error Handling .
The "ABEND" parameter prompts the script processing to be aborted if an error occurs. "RESUME", on the other hand, continues the script and the return codes of the previously listed functions can be read.
Example
The example below specifies that the script will not be canceled in the event of an error. The system then attempts to check the capacity of a non-existing drive. An error occurs which can be analyzed with the script functions for error handling.
: ON_ERROR RESUME
: SET &CHECK# = GET_FILESYSTEM ( 'WIN21' , 'Z:\' , FILESYSTEM_SPACE_TOTAL)
: SET &ERRNR# = SYS_LAST_ERR_NR
: SET &ERRINS# = SYS_LAST_ERR_INS
: SET &MESSAGE# = GET_MSG_TXT ( &ERRNR# , &ERRINS# )
See also:
Script Elements - Error Handling and Messages
Sample Collection:
Retrieving Error Message and Number
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.6.3 :SEND_MSG
Script Statement: This statement is used to send messages to the user who is logged on to the
UserInterface.
Syntax
:SEND_MSG
Name, Department, Message
Syntax Description/Format
216 Chapter 3 Ordered by Function
Name
Department
Message
Name of the user who has logged on to the UserInterface and should receive the message.
Format:
or
The wildcard characters "*" and "?" can be used. "*" stands for any character,
"?" for exactly one.
Department of the user who has logged on to the UserInterface and should receive the message.
Format: script literal, script variable or script function
The wildcard characters "*" and "?" can be used. "*" stands for any character,
"?" for exactly one.
Message that should be sent.
Format: script literal, script variable or script function
Comments
This script statement can be used to send messages to users. These messages are then displayed in these users' Message Windows .
Because the message can only be supplied to users who are logged on to the UserInterface, UC4 recommends using the script element
in order to have states checked.
Error "20698" occurs if the indicated user does not exist. Reactions to this error can be defined using the script statement
and analyzed using the
script functions for error handling
. Script processing continues but can also be canceled if necessary.
Sent messages are logged and listed in the system control's message category. The message type is
"Information" and the message category is "Message".
Note that sent messages can only be displayed if the UserInterface option "Display error messages and warnings only" is not active.
You can use the privilege "View all messages from own client" in order to have messages displayed that are sent to other users.
Examples
User "Brown" from the "IT" department has logged on to the UserInterface and is requested to start the backup routine. A Notification object starts if this user has not logged on .
: SET &RET# = SYS_USER_ALIVE ( "BROWN" , "IT" )
: IF &RET# = "Y"
: SEND_MSG "BROWN" , "IT" , "Please start backup routine!"
: ELSE
: SET &ACTOBJ# = ACTIVATE_UC_OBJECT (CALL, "DAY_SHIFT" )
: ENDIF
Automation Engine 217
In the following example, the user receives the same message as shown in the above example. A script function is used for the department and a script variable for the message.
: SET &MSG# = "Please start backup routine!"
: SEND_MSG "BROWN" , SYS_USER_DEP (), &MSG#
The next example uses wildcard characters in order to send the message to all users of the IT department .
: SEND_MSG "*" , "IT" , "Please start backup routine!"
See also:
Script element
Description
Checks whether a user has logged on to UC4 with a UserInterface.
Sends an email to a user.
Script Elements - Error Handling and Messages
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.6.4 :SEND_SNMP_TRAP
Script Statement: Sends an SNMP trap
Syntax
:SEND_SNMP_TRAP
Trap Code, Parameter
[, Parameter[, Parameter]]...
Syntax
Trap Code
Parameter
Description/Format
Freely-definable code to which SNMP management can react
Format: number,
or
function
Additional information that can be sent with the SNMP trap
Format: number,
script literal , script variable or script function
Use inverted commas for the client number (e.g. "1000")
Comments
This script statement sends an SNMP trap with its specified parameters to a management system. It can only be used if all requirements for SNMP functionality have been implemented.
Up to 10 parameters can be set and sent. From these, a maximum of 5 strings and 5 numbers is allowed.
The position of strings and numbers is pre-determined. Strings must come first, then the numbers follow.
At least one string must be indicated.
Trap codes generated by UC4 and HP OpenView Integrator (trap codes: 10000 - 10010) cannot be used.
218 Chapter 3 Ordered by Function
Examples
The first example shows a simple test. Several parameters are sent to the management system with the
SNMP trap 50000.
: SEND_SNMP_TRAP 50000, "Text1" , "TEXT2" , "TEXT3" , "TEXT4" , "TEXT5" ,1,2,3,4,5
In the second example, the activation data is determined in a first step. Depending on whether activation is made directly or within a Workflow, different traps are sent. Both traps consist of the trap code and a prepared string.
: SET &NAME# = SYS_ACT_ME_NAME ()
: SET &ID#
: SET &JPNAME#
=
=
SYS_ACT_ME_NR ()
SYS_ACT_PARENT_NAME ()
: SET &CLIENT# = SYS_ACT_CLIENT ()
!Trap type = Alarm
: SET &TYPE# = 4
!Importance of the event
: SET &SEV# = 4
: IF "&JPNAME#" = ""
: SEND_SNMP_TRAP 50001, "&CLIENT#" , "Error in task &NAME#
(&ID#)!" ,,,, &TYPE# , &SEV#
: ELSE
:
:
SET &JPID# = SYS_ACT_PARENT_NR ()
SEND_SNMP_TRAP 50002, "&CLIENT#" , "Error in Job plan &JPNAME# (&JPID#) in the task &NAME# (&ID#m)!" ,,,, &TYPE# , &SEV#
: ENDIF
The third example shows how the retrieved activation data is assigned to the script statement in the form of individual parameters. Thus, activation data is available in the management system in individual values which facilitates any further processing.
: SET &NAME#
: SET &ID#
: SET &JPNAME#
: SET &CLIENT#
= SYS_ACT_ME_NAME ()
= SYS_ACT_ME_NR ()
= SYS_ACT_PARENT_NAME ()
= SYS_ACT_CLIENT ()
!Trap type = Alarm
: SET &TYPE# = 4
!Importance of the event
: SET &SEV# = 4
: IF
:
&JPNAME# = ""
SEND_SNMP_TRAP 50001, "&CLIENT#" , "&NAME#" ,, "Error in the task!" ,, &TYPE# , &SEV# , &ID#
: ELSE
: SET &JPID = SYS_ACT_PARENT_NR ()
: SEND_SNMP_TRAP 50002, "&CLIENT#" , "&NAME#" , "&JPNAME#" , "Error in the Job plan!" ,, &TYPE# , &SEV# , &ID# , &JPID#
: ENDIF
If &ID# and/or &JPID# should be sent as numbers rather than as strings, they can only be assigned after the fifth parameter. Commas must be used in place of unused parameters which are meant for strings.
See also:
Automation Engine 219
Script element
Description
Checks if the SNMP connection (Simple Network Management Protocol) of UC4 if active
Script Elements - Error Handling and Messages
UC4 and SNMP
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.6.5 :SET_LAST_ERR
Script Statement: Sets error number and text
Syntax
:SET_LAST_ERR
Number
[, Insert]
Syntax
Number
Insert
Description/Format
Error number
Format: Number,
or
Error text, variable part of the error message
Format:
script literal , script variable or script function
Comments
This script statement :SET_LAST_ERR sets error number and text. This statement overwrites error numbers and/or the variable part of the preceding error message. The specification of Insert is optional. If
Insert is not specified, the variable part of the error message is an empty string.
Be careful to specify a valid error number. A list of all available messages including their texts is found in the message manual.
A message can be composed of several parts. Separate these parts with a "|". Their order can also be seen from the message manual.
Error numbers and text can be deleted with :SET_LAST_ERR 0.
The complete modified error message can be retrieved with GET_MSG_TXT .
Example
In the example shown below, error number "20657" is set with the two variable message parts.
: SET_LAST_ERR 20657, "MM.DAY|20||OBJECTS"
: SET &ERRINS# = SYS_LAST_ERR_INS ()
: SET &ERRNR# = SYS_LAST_ERR_NR ()
: SET &MSG# = GET_MSG_TXT ( &ERRNR# , &ERRINS# )
: PRINT &MSG#
220 Chapter 3 Ordered by Function
Extract from the message manual: 20657 - Runtime error in object '&01', line '&02'. Destination folder '&04' not found.
The result of the script statement is:
U0020657 Runtime error in object 'MM.DAY', line '20'. Destination folder
'OBJECTS' not found.
See also:
Script element
Description
Supplies the variable message part of the error that has last occurred
Returns the number of the error that has last occurred
Retrieves the last-occurred error message from the operating system
Script Elements - Error Handling and Messages
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.6.6 :STOP
Script Statement: It cancels the processing of a script.
Syntax
:STOP [Stop Mode]
Syntax
Stop Mode
Description/Format
You can pass on the following parameters to the :STOP statement in the form of Stop Modes:
"No specification"
It cancels the processing of a script and writes the message "U0010014" to the activation report.
NOMSG, Message Number[, Message Text]
Cancels the activation of an object without an error. A message can be created for this purpose.
MSG, Error Number, Error Text
Cancels the activation of an object and gives an error message.
Comments
:STOP cancels the activation of an object. Therefore, this script element cannot be used in the Post
Process tab. UC4 recommends using the statement
instead.
Stop Mode NOMSG
Automation Engine 221
The :STOP statement with Stop Mode NOMSG can be used in objects which do not require an Agent for processing. It is therefore possible to work only with script statements (to set UC4 Variables, for example).
You can also create a message by using the parameter Stop Mode NOMSG. The Message Number is syntactically necessary but is not evaluated. The Message Text is stored in the statistics and sent as part of the confirmation when a call is made via the CallAPI. As a result thereof, the run number (RunID) of a started task can be returned to the CallAPI.
Because Stop Mode NOMSG ends task activations without errors, these tasks will not appear as canceled tasks in the statistics.
Stop Mode MSG
Stop Mode MSG can be used to cancel the activation of an object with an error message. You can define an Error Number and an Error Text. This is especially important for objects that start via the UC4 CallAPI.
The returned information is the only information about the script execution. Error numbers 50 to 59 are reserved for users.
Return code 4 is used for the error number 50 and return code 8 for the numbers ranging from 51 to 59.
Note that you can only use the error numbers 50 - 59. Using other error numbers will cause the script to abort with an error message that informs you that the specified error number is not valid.
Because Stop Mode MSG cancels task activations with an error, these tasks are listed in the statistics as canceled tasks .
If you use the :STOP statement without any parameters or with Stop Mode MSG, script processing will abort with an error and a database rollback takes place. All transactions that were not specifically executed will be rolled back. If you have used script variables, it can happen that the Variable objects that are located at the beginning of the script already include their new values but those located at the script end won't.
The system writes transactions to the UC4 Database (commit) when script processing is interrupted. This occurs: l l l automatically in intervals of 5 second, because of script statements such as ACTIVATE_UC_OBJECT, GET_FILESYSTEM, :READ,
PREP_PROCESS, PREP_PROCESS_FILE, when you use the script statement :WAIT.
You can use the script statement :WAIT 0 in order to force an interruption in script processing and also, to force a database commit.
Examples
The following example returns an error message that informs you whether a job was correctly activated or not.
: SET &ACTNR# = ACTIVATE_UC_OBJECT (JOBS, MM)
: IF &ACTNR# = "0"
: STOP MSG, 50, "Error in activating the job MM."
: ELSE
: PRINT "The Job MM was activated with the activation number &ACTNR#."
: ENDIF
See also:
222 Chapter 3 Ordered by Function
Script element
Description
Terminates the processing of a script and sends a return code.
This is used to stop processing of the script for a specified period of time.
Meanwhile, other tasks are completed.
Script Elements - Activate Objects
Script Elements - Error Handling and Messages
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.6.7 GET_MSG_TXT
Script Function: Retrieves the message text of the last error.
Syntax
GET_MSG_TXT
(Number
[, Insert]
)
Syntax
Number
Insert
Description/Format
Error number.
Format:
or number
The script function SYS_LAST_ERR_NR also supplies the error number.
Variable part of the error message (text).
Format:
or script variable
The script function SYS_LAST_ERR_INS also supplies the variable part of the error number.
Return codes
Message text of the last error.
" " - No error has occurred.
Description
In some script elements, you can use
in order to have script processing continued even if an error occurs. The error message can be retrieved by using the script function GET_MSG_TXT in such a case.
The error number Number and the variable part Insert are the basis for retrieving the message text. You can previously retrieve the error number by using SYS_LAST_ERR_NR and the variable part of the error message by using SYS_LAST_ERR_INS. The script function GET_MSG_TXT uses this information and the error texts in order to compose the complete UC4 error message.
The parameter Insert is not required if the message text does not include variable parts such as in status texts whose numbers can be read by using GET_STATISTIC_DETAIL.
Automation Engine 223
Example
The following example checks the memory capacity of a non-existing drive which results in an error. The error number and the variable part of the error message are read. This information is used to retrieve the complete UC4 error message which is then sent to a user as a message.
: SET &CHECK# = GET_FILESYSTEM ( "WIN21" , "Z:\" , FILESYSTEM_SPACE_TOTAL)
: SET &ERRNR# = SYS_LAST_ERR_NR ()
: SET &ERRINS# = SYS_LAST_ERR_INS ()
: SET &MESSAGE# = GET_MSG_TXT ( &ERRNR# , &ERRINS# )
: SEND_MSG BU,BU, &MESSAGE#
The second example retrieves the text that informs about a task's status.
: SET &STATUS# = GET_STATISTIC_DETAIL ( &RUNNR# , STATUS)
: SET &TEXT# = GET_MSG_TXT ( &STATUS# )
: PRINT &TEXT#
The output could be as shown below:
ENDED_CANCEL - manually canceled.
See also:
Script element
Description
Retrieves the type of a message number.
Supplies the variable message part of the last error.
Returns the number of the last error.
Script Elements - Error Handling and Messages
Sample Collection:
Retrieving Error Message and Number
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.6.8 GET_MSG_TYPE
Script function: Retrieves the type of a message number
Syntax
GET_MSG_TYPE
(Message number)
Syntax
Message number
Description/Format
Number of a message whose type should be read
Format:
or number
Return codes
224 Chapter 3 Ordered by Function
"A" - Abort
"E" - Error
"I" - Information
"Q" - Query
"W" - Warning
" " - The error number does not exist.
Comments
There are different types of message numbers such as warnings and error messages.
The script function
retrieves the number of the last message.
Example
The following example informs the UC4 administrator if an error or abort message is output:
: SET &ERRNR# = SYS_LAST_ERR_NR ()
: SET &ERRTYP# = GET_MSG_TYPE ( &ERRNR# )
: IF &ERRTYP# = "A" OR "E"
: SET &ERRINS# = SYS_LAST_ERR_INS ()
: SET &MESSAGE# = GET_MSG_TXT ( &ERRNR# , &ERRINS# )
: PRINT &MESSAGE#
: SET &RET# = SEND_MAIL ( "[email protected]" ,, "Processing error" , &MESSAGE# )
: ENDIF
See also:
Script element
Description
Retrieves the message text of the last error
Supplies the variable message part of the last error
Returns the number of the last error
Script Elements - Error Handling and Messages
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.6.9 SEND_MAIL
Script Function: Sends an email to a user.
Syntax
SEND_MAIL
(Receiver,
[Cc]
, Subject, Text
[, Attachment]
)
Syntax Description/Format
Automation Engine 225
Receiver
Cc
Subject
Text
Attachment
The person that should receive the message.
Format:
or
The person that should receive a copy of this message.
Format: script literal or script variable
Default: ""
Short description of the message.
Format: script literal or script variable
Message text.
Format: script literal or script variable
The path and the name of the files that should be sent as an attachment.
Format: script literal or script variable
Default: ""
Separate the individual paths with a semicolon (;) if you want to send several files.
Return codes
"0" - Email was sent successfully.
"10034" - There is no active host with email connection.
"50006" - SMTP server returned an error code.
"50014" - Attachment does not exist.
"50027" - Authentication on the STMP Server failed.
"50028" - The receiver address is not valid. Therefore, the SMTP Server has rejected it.
"50029" - The SMTP client cannot connect to the SMTP Server.
"50030" - Error in socket creation.
"50031" - Host information of the SMTP Server could not be retrieved.
"50032" - The SMTP client cannot communicate with the SMTP Server anymore.
"50033" - The SMTP client cannot receive data from the SMTP Server.
"50034" - Data cannot be sent to the SMTP Server.
"50035" - Windows sockets cannot be initialized.
"50036" - Host name of the local computer cannot be retrieved.
Comments
The sending of emails depends on the user's PC configurations.
This script function does not check whether the specified Receiver actually exists. The message is sent even if the receiver is not correct.
When the email cannot be sent because the attachment cannot be found or the email connection is not active, script processing continues by default. In this case, the script function returns the corresponding return code.
You can use the script statement
to cancel script processing if an error occurs. To analyze the error, you use the
script functions for error handling
.
Note that this script element always sends emails via the AutomationEngine. Files that should be attached must be stored on the computer of the AutomationEngine or be accessible from there (UNC path).
Note that the number of characters is limited to 1024 characters per line.
226 Chapter 3 Ordered by Function
The script statement causes all open
of the script to be written to the UC4 Database.
To send emails, you must have configured the Email Connection .
Examples
In the following example, an email is sent only to one user (no copies). One file is attached to this email.
: SET &OUT# = SEND_MAIL ( '[email protected]' ,, 'Meeting' , 'Meeting today at 5pm' ,
'/uc4/agenda' )
An email that includes two attachments is sent to several persons:
: SET &OUT# = SEND_MAIL ( "[email protected];[email protected]" ,, "Meeting" , "Meeting canceled" , "c:\uc4\agenda.doc;c:\uc4\dates.txt" )
See also:
Script element
Description
This statement is used to send messages to the user who is logged on to the
UserInterface.
Determines the reaction to certain errors and messages of script elements.
Script Elements - Error Handling and Messages
Email Connection
Sample Collection:
Retrieving Error Message and Number
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.6.10 SYS_LAST_ERR_INS
Script Function: Supplies the variable message part of the last error
Syntax
SYS_LAST_ERR_INS
()
Return codes
Variable message part of the last error
" " - No error has occurred
Automation Engine 227
Comments
Some script elements facilitate continued script processing in the case of occurring errors when
is used. The script function then retrieves the variable part of the error message .
Most error messages do not only consist of a pre-determined text. Parts of the message refer to object names or script lines, for example. These variable parts of error messages are put in inverted commas.
Example of an error message:
U0020645 - Runtime error in object '&01', line '&02'.: There is no object '&04'.
The variable parts are replaced by values when the above error message is output:
U0020645 - Runtime error in object 'MOVE_OBJECT', line '0003'. There is no object
'MM.CLOSING.2005'.
Example
The example shown below intends to check a hard drive's memory. An error occurs if this hard drive is not available or cannot be accessed. The corresponding error number and variable message parts are read and the entire UC4 error message is retrieved and sent to a user.
: SET &CHECK# = GET_FILESYSTEM ( "WIN21G" , "Z:\" , FILESYSTEM_SPACE_TOTAL)
: SET &ERRINS# = SYS_LAST_ERR_INS ()
: IF &ERRINS# NE ""
: SET &ERRNR# = SYS_LAST_ERR_NR ()
:
:
SET
: ENDIF
&MESSAGE#
SEND_MSG
=
BU,BU,
GET_MSG_TXT
&MESSAGE#
( &ERRNR# , &ERRINS# )
See also:
Script element
Script Elements - Error Handling and Messages
Sample Collection:
Retrieving Error Message and Number
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Retrieves the message text of the last error
Retrieves the type of a message number
Returns the number of the last error
Retrieves the last error message of the OS
228 Chapter 3 Ordered by Function
3.6.11 SYS_LAST_ERR_NR
Script Function: Returns the number of the last error
Syntax
SYS_LAST_ERR_NR
()
Return codes
Error number of the last error
"0" - No error has occurred
Comments
Some script elements facilitate continued script processing in the case of occurring errors when
is used. The error number can then be retrieved with this script function.
Example
The example shown below intends to check the memory of a hard drive. An error occurs if this hard drive does not exist or cannot be accessed. The corresponding error number and variable message part are read and the entire UC4 error message can be determined and sent to a user.
: SET &CHECK# = GET_FILESYSTEM ( "WIN21G" , "Z:\" , FILESYSTEM_SPACE_TOTAL)
: SET &ERRNR# = SYS_LAST_ERR_NR ()
:
:
: IF &ERRNR# NE "0"
SET
SET
&ERRINS#
&MESSAGE#
=
=
SYS_LAST_ERR_INS
GET_MSG_TXT (
()
&ERRNR# , &ERRINS# )
: SEND_MSG BU,BU, &MESSAGE#
: ENDIF
See also:
Script element
Description
Retrieves the message text of the last error
Retrieves the type of a message number
Supplies the variable message part of the last error
Retrieves the last error message of the OS
Script Elements - Error Handling and Messages
Sample Collection:
Retrieving Error Message and Number
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 229
3.6.12 SYS_LAST_ERR_SYSTXT
Script Function: Retrieves the last-occurred error message from the operating system
Syntax
SYS_LAST_ERR_SYSTXT
()
Return codes
Error text from the operating system of a latest occurred error
" " - no error occurred
Comments
This script function determines the error message supplied by the operating system in case of occurring errors. The return code of this script function is the message text or an empty string if there was no error.
Example
The example tries to check the memory of a drive. An error occurs if it is not available. The message text of the operating system ("System cannot find specified path.") will then be sent to a user.
: SET &CHECK# = GET_FILESYSTEM ( "WIN21G" , "Z:\" , FILESYSTEM_SPACE_TOTAL)
: SET &MESSAGE# = SYS_LAST_ERR_SYSTXT ()
: IF &MESSAGE# NE ""
: SEND_MSG BU,BU, "System error: &MESSAGE#"
: ENDIF
See also:
Script element
Description
Returns the number of the error that has last occurred.
Script Elements - Error Handling and Messages
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
230 Chapter 3 Ordered by Function
3.7 Activation Data
3.7.1 GET_PARENT_NAME
Script Function: Returns the name of the superordinate task (Parent)
Syntax
GET_PARENT_NAME
(RunID
[, Activation Type]
)
Syntax
RunID
Activation Type
Description/Format
RUN number of the current task
Allowed values:
ACT = Activator
PRC = Processor (default value)
Return codes
Name of the superordinate task
"*SCRIPT" - The task has been activated via a CallAPI
" " - There is no superordinate task (only for activation type PRC)
Comments
With this script function, the name of the superordinate task of an object that is part of the object class executable objects may be retrieved. With manual activation, this is the name of the user object (e.g.
SMITH/UC4).
If no activation type is indicated, this script function supplies the processor.
If the name of a Group is to be retrieved, "Generate at Runtime" (in the Attributes tab) must be activated in the task that is used with this script function. Otherwise, the name can only be retrieved for
Jobs in post script.
Example
The following example retrieves the running number of a task and then its Activator.
: SET &RunID = GET_UC_OBJECT_NR (MM.END.PROCESSING)
: SET &RET# = GET_PARENT_NAME ( &RunID , ACT)
: PRINT "The name of the superordinate task is: &RET#"
See also:
Script element
Description
Returns the run number (RunID) of the superordinate task (Parent)
Automation Engine 231
Returns the object type of the superordinate task (Parent)
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.7.2 GET_PARENT_NR
Script Function: Returns the run number (RunID) of the superordinate task (Parent)
Syntax
GET_PARENT_NR
(RunID
[, Activation Type]
)
Syntax
RunID
Activation Type
Description/Format
RUN number of the current task
Allowed values:
ACT = Activator
PRC = Processor (Default)
Return codes
RunID of the superordinate task
Session ID for manual activation (only for activation type ACT)
" " - There is no superordinate task (only for activation type PRC)
Comments
With this script function, the name of the superordinate task of an object that is part of the object class of executable objects is retrieved. With manual activation, this is the name of the user object (e.g.
SMITH/UC4).
If no activation type is specified, the script function retrieves the processor.
If the RunID of a Group should be retrieved, "Generate at Runtime" (in the Attributes tab) must be activated in the task using this script function. Otherwise, the RunID can only be retrieved only for
Jobs in post process.
Example
The following example retrieves the running number of a task and then its Activator.
: SET &RunID = GET_UC_OBJECT_NR (MAWI.END.PROCESSING)
: SET &RET# = GET_PARENT_NR ( &RunID , ACT)
: PRINT "The RunID of the superordinate task is: &RET#"
232 Chapter 3 Ordered by Function
See also:
Script element
Description
Returns the name of the superordinate task (Parent)
Returns the object type of the superordinate task (Parent)
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.7.3 GET_PARENT_TYPE
Script Function: Returns the object type of the superordinate task (Parent)
Syntax
GET_PARENT_TYPE
( RunID
[, Activation Type]
)
Syntax
RunID
Activation Type
Description/Format
Run number of the current task
Allowed values:
ACT = Activator
PRC = Processor (Default value)
Return codes
Object type of the superordinate task
"USER" - With manual activation (only for activation type ACT)
"API" - With activation via CallAPI (only for activation type ACT)
" " - There is no superordinate task (only for activation type PRC)
Comments
With this script function, the name of the superordinate task of an object that is part of the object class of executable objects is retrieved. With manual activation, this is "USER".
If no activation type is specified, the script function retrieves the processor.
If the RunID of a Group should be retrieved, "Generate at Runtime" (in the Attributes tab) must be activated in the task using this script function. Otherwise, the RunID can only be retrieved only for
Jobs in post process.
Automation Engine 233
Example
The following example retrieves the running number of a task and subsequently the object type of its
Activator.
: SET &RunID = GET_UC_OBJECT_NR (MAWI.END.PROCESSING)
: SET &RET# = GET_PARENT_TYPE ( &RunID , ACT)
: PRINT "The type of the superordinate task is: &RET#"
See also:
Script element
Description
Returns the name of the superordinate task (Parent)
Returns the run number (RunID) of the superordinate task (Parent)
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.7.4 GET_UC_OBJECT_STATUS
Script Function: Returns the status of an activated object.
Syntax
GET_UC_OBJECT_STATUS
(
[Object type ]
,
[RunID]
,
[ Request]
)
Syntax
Object Type
Description/Format
Short for of the object type .
Format:
RunID
Optional parameter because the object type is clearly identified through its
RunID (compatible with Version 2.6xx).
Run number of the activated object.
Format: script literal or script variable
234 Chapter 3 Ordered by Function
Request
Information that should be retrieved from the activated object.
Format: script literal or script variable
Allowed values: "STATUS" (default value), "RETCODE", "STATUS_TEXT"
"RETCODE" = Retrieves the return code of the activated object.
"STATUS" = Retrieves the current system return code of the activated object.
"STATUS_TEXT" = Retrieves the status text. This value is only available in
Jobs on OS Agents (for example, the status text cannot be retrieved in SAP jobs.
Return codes
Depending on the specifications made, either the return code, status or the status text of the task is returned.
" " - The indicated task does not exist.
Comments
This script function can be used to retrieve information about the status of an executable object .
This script function even returns a value if the task is no longer active because this information is retrieved from the statistics. An empty string is returned if no statistical records are available.
All the parameters of this script function are optional. If you use only the parameter Request, ensure that two commas are set that replace the non-used parameters.
Example:
: SET &STATUS# = GET_UC_OBJECT_STATUS ( ,, "STATUS" )
If object type and RunID are not specified, the status of the task that uses this script function is returned.
If object type or RunID are not specified, the following peculiarities apply: l l l
If object type is the only specified parameter, the status of the own task is returned. Object type and the task's object type must be the same in this case.
If RunID is the only specified parameter, either the status of the own task or the status of a different task can be retrieved.
If the RunID of a different task is assigned to this script function, both tasks must be of the same object type. Otherwise, the object type of the other task must explicitly be specified.
An empty string is returned if object type and RunID do not comply with each other. An empty string is also returned if no task could be found for the specified RunID.
If Request is not used, the script function returns the status code.
It is also possible to retrieve the status text for Jobs. This is the text that was output by the Job messenger in the Trailer or was modified with
. Other object types return an empty string.
Example
The first example activate the job "DB.USE" so that its status can be retrieved subsequently. An additional script function is used to retrieve the job's run number.
: SET &JNR# = ACTIVATE_UC_OBJECT (JOBS,DB.USE)
: SET &STATUS# = GET_UC_OBJECT_STATUS (JOBS, &JNR# )
Automation Engine 235
: PRINT "The Status of job(&JNR#) is &STATUS#".
The second example retrieves a task's own status. This status is output in the activation protocol.
: SET &RET# = GET_UC_OBJECT_STATUS ()
: PRINT &RET#
In the third example, the script of a Job should retrieve the Workflow's (parent) status. Because two different object types are included, the Workflow's object type and RunID must be assigned to the script function.
: SET &RUNNR# = SYS_ACT_PARENT_NR ()
: SET &STATUS# = GET_UC_OBJECT_STATUS (JOBP, &RUNNR# )
: SEND_MSG BU,BU, "The Workflow's status is: &STATUS#."
The fourth example returns a Job's status text.
: SET &RET# = GET_UC_OBJECT_STATUS (,, "STATUS_TEXT" )
: PRINT &RET#
See also:
Script element
Description
Modifies a return code or status text of a Job when it has finished.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.7.5 GET_UC_OBJECT_NR
Script Function: Returns the RunID of an activated object
Syntax
GET_UC_OBJECT_NR
(Object Name)
Syntax
Object Name
Description/Format
Name of an executable object
Format:
or script variable
Return code
Run number of the activated object
" " - The indicated object is not active
Comments
The script function GET_UC_OBJECT_NR may be used to retrieve the run number (RunID) of an object that belongs to the object class of executable objects.
236 Chapter 3 Ordered by Function
If the object has been activated more than once, the oldest RunID is returned.
Example
The following example checks whether or not the task is active.
: SET &RunID = GET_UC_OBJECT_NR ( &task# )
: IF &RunID = ""
: STOP MSG,50, "&task# is not active!"
: ENDIF
See also:
Script element
Description
Returns the run number (RunID) of the superordinate task (Parent).
Supplies the run number (RunID) of the top Workflow
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.7.6 SYS_ACT_HOST
Script Function: Returns the name of the host.
Syntax
SYS_ACT_HOST
()
Return code
Name of the host of the object in which this script function is called.
Comments
This script function can be used in Events of type "File System" and "Console" (Process and !Process
tab) and in the Process tabs of Jobs.
Note that the name of the host on which the Event or Job is actually executed is returned. This host can differ from a previously defined host if the user changes it for one particular Job execution in the Attribute
Dialog or sets :PUT_ATT in the Pre-Process tab.
Automation Engine 237
Example
The following example describes how a returned host name can be assigned to a script variable. This script variable is then used as the first parameter of the script function GET_FILESYSTEM in order to have files of a temporary directory counted.
: SET &HOST# = SYS_ACT_HOST ()
: SET &NUMBER# = GET_FILESYSTEM ( &HOST# , "c:\temp\*.exe" , "PATH_FILE_COUNT" )
See also:
Script element
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Checks if a particular host is active.
3.7.7 SYS_ACT_JP
Script Function: Determines if a task was activated in a Workflow.
Syntax
SYS_ACT_JP
()
Return codes
"Y" - Task was activated by a Workflow
"N" - Task was not activated by a Workflow
Example
In this example, a task was started manually. Therefore, the return code is "N" and "Task does not run in a
Workflow" is printed in the activation report.
: SET &RET# = SYS_ACT_JP ()
: IF &RET# = "Y"
: PRINT "Task runs in a Workflow"
: ELSE
: PRINT "Task does not run in a Workflow"
: ENDIF
See also:
Script element
Description
Returns the name of a superordinate task.
238 Chapter 3 Ordered by Function
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Returns the run number (RunID) of a superordinate task.
3.7.8 SYS_ACT_ME_NAME
Script Function: Returns the name of the own object
Syntax
SYS_ACT_ME_NAME
()
Return code
Name of the object in which this script function is called
Example
A Job's name and status are queried in its Post-Process tab. If the Job does not end normally (ENDED_
OK - 1900), an email message will be sent to the support team.
: SET &NAME# = SYS_ACT_ME_NAME ()
: SET &STATUS# = GET_UC_OBJECT_STATUS ()
:
: IF &STATUS# < "1900"
SET &OUT# = SEND_MAIL ( "[email protected]" ,, "Job abortion!" , "Job: &NAME# is canceled!" )
: ENDIF
See also:
Script element
Script Elements - Activation Data
Sample Collection:
Retrieving Error Message and Number
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Returns the run number (RunID) of the own object
Returns the object type of the own object
Automation Engine 239
3.7.9 SYS_ACT_ME_NR
Script Function: Returns the run number (RunID) of the own object
Syntax
SYS_ACT_ME_NR
()
Return code
Run number of the object in which this script function is called.
Comments
In the case that the task is restarted with the reference RunID, this script function supplies this reference
RunID instead of the RunID of the execution. Always use
to obtain the running number of the reactivated object.
Example
In this example, the RunID of a task is used in order to obtain parent information. If the task was started by a user, this user's name is printed in the activation report. If it was started by a task, the name of this task is printed.
: SET &RUNNR# = SYS_ACT_ME_NR ()
: SET &PNAME# = GET_PARENT_NAME (, &RUNNR# , "ACT" )
: PRINT "Parent-Name: &PNAME#"
See also:
Script element
Script Elements - Activation Data
Sample Collection:
Retrieving Error Message and Number
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Returns the name of the own object
Returns the object type of the own object
240 Chapter 3 Ordered by Function
3.7.10 SYS_ACT_ME_TYPE
Script Function: Returns the object type of the own object.
Syntax
SYS_ACT_ME_TYPE
()
Return code
Short form of the object's object type in which the script function is called.
Comments
This script function supplies the object type (short name) of the own object.
Example
In this example, SYS_ACT_ME_TYPE is used in the Script of a Job and return code "JOBS" is printed in the activation report.
: SET &RET# = SYS_ACT_ME_TYPE ()
: PRINT "The object type is: &RET#"
See also:
Script element
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Returns the name of the own object
Returns the run number (RunID) of the own object
3.7.11 SYS_ACT_PARENT_NAME
Script Function: Supplies the name of a superordinate task.
Syntax
SYS_ACT_PARENT_NAME
(
[Activation type]
)
Syntax Description/Format
Automation Engine 241
Activation type
Allowed values:
ACT = Activator
PRC = Processor (default value)
Return code
Name of the superordinate task
"*SCRIPT" - The task has been activated via a CallAPI
" " - There is no superordinate task (only for activation type PRC)
Comments
This script function supplies the name of a superordinate task (parent). In the case of manual activation, this is the name of the user object (e.g. SMITH/UC4).
If no activation type is indicated, this script function supplies the processor.
In order to facilitate that the name of a Group may be retrieved, "Generate at Runtime" (Attributes tab) must be activated in the task using this script function. Otherwise, the name can only be retrieved for
Jobs in post process.
Examples
The first example checks whether the task runs in a Group, Workflow or Schedule. If so, the name of this task is written in the activation protocol. If there is no superordinate task, the corresponding entry is made in the activation protocol.
: SET &NAME# = SYS_ACT_PARENT_NAME ()
: IF &NAME# NE " "
: PRINT "Name of parent: &NAME#."
: ELSE
: PRINT "No parent"
: ENDIF
The second example determines the Activator of a task whose name is output in the activation log .
In the case of manual activation, the protocol shows the name and department of the particular user.
: SET &NAME# = SYS_ACT_PARENT_NAME (ACT)
: PRINT "Task was activated by &NAME#."
The third example also serves to determine the Activator of a task. If it was activated through the CallAPI, the following line may be printed in the activation protocol:
2004-01-27 13:19:36 - U0020408 Task was activated by *SCRIPT.
See also:
Script element
Script Elements - Activation Data
Description
Supplies the run number (RunID) of the superordinate task.
Returns the object type of the superordinate task.
242 Chapter 3 Ordered by Function
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.7.12 SYS_ACT_PARENT_NR
Script Function: Supplies the run number (RunID) of the superordinate task.
Syntax
SYS_ACT_PARENT_NR
(
[Activation type]
)
Syntax
Activation type
Description/Format
Allowed values:
ACT = Activator
PRC = Processor (default value)
Return codes
RunID of the superordinate task
Session ID in the case of manual activation (only for activation type ACT)
" " - There is no superordinate task (only for activation type PRC)
Comments
This script function supplies the run number (RunID) of the superordinate task (parent). In the case of manual activation, this is the user's Session-ID .
If no activation type is indicated, this script function supplies the processor.
In order to facilitate that the name of a Group may be retrieved, "Generate at Runtime" (Attributes tab) must be activated in the task using this script function. Otherwise, the name can only be retrieved for
Jobs in post process.
Examples
The first example checks whether the task runs in a Group, Workflow or Schedule. If so, the run number
(RunID) of this task is written in the activation protocol. If there is no superordinate task, the corresponding entry is made to the activation protocol.
: SET &NR# = SYS_ACT_PARENT_NR ()
: IF &NR# = " "
: PRINT "No parent"
: ELSE
: PRINT "RunID of parent is &NR#."
: ENDIF
The second example determines the Activator of a task. If it was activated by a task, the run number
(RunID) of this task is shown in the activation protocol. In the case of manual activation, the protocol shows the RunID of the particular user session.
Automation Engine 243
: SET &NR# = SYS_ACT_PARENT_NR (ACT)
: PRINT "RunID of parent is &NR#."
See also:
Script element
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Supplies the name of a superordinate task.
Returns the object type of the superordinate task.
3.7.13 SYS_ACT_PARENT_TYPE
Script Function: Returns the object type of the superordinate task.
Syntax
SYS_ACT_PARENT_TYPE
(Activation type)
Syntax
Activation type
Description/Format
Allowed values:
ACT = Activator
PRC = Processor (default value)
Return codes
Object type of the superordinate task
"USER" - in the case of manual activation (only for activation type ACT)
"API" - in the case of activation via CallAPI (only for activation type ACT)
" " - There is no superordinate task (only for activation type PRC)
Comments
This script function retrieves the object type of the superordinate task (parent). In the case of manual activation, this is "USER".
If no activation type is specified, this script function retrieves the processor.
In order to facilitate that the name of a Group may be retrieved, "Generate at Runtime" (Attributes tab) must be activated in the task using this script function. Otherwise, the name can only be retrieved for
Jobs in post process.
244 Chapter 3 Ordered by Function
Examples
The first example checks whether the task runs in a group, Workflow or Schedule. If so, the object type of this task is written in the activation protocol. If there is no superordinate task, the corresponding entry is made to the activation protocol.
: SET &TYPE# = SYS_ACT_PARENT_TYPE ()
: IF &TYPE# = " "
: PRINT "No parent"
: ELSE
: PRINT "Object type of parent is &TYPE#."
: ENDIF
The second example determines the Activator of a task. If it was activated by a task, its object type is shown in the activation protocol. In the case of manual activation, the protocol shows the entry "Task was activated by USER".
: SET &TYPE# = SYS_ACT_PARENT_TYPE (ACT)
: PRINT "Task was activated by &TYPE#."
The third example also determines the Activator of a task. If it was activated through the CallAPI, the following line may be printed in the activation protocol:
2004-01-28 11:19:26 - U0020408 Task was activated by API.
See also:
Script element
Script Elements - Activation Data
Object Types
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Supplies the name of a superordinate task.
Supplies the run number (RunID) of the superordinate task.
3.7.14 SYS_ACT_PREV_NAME
Script Function: Returns the name of the previous Job in a Workflow
Syntax
SYS_ACT_PREV_NAME
()
Return codes
Name of the preceding task
"START" - The task is the first one in the Workflow as the predecessor is the starting point.
Automation Engine 245
Comments
Only tasks running in Workflows must use this script function.
Only use this script function if there is exactly one previous task. If there is more than one predecessor, a runtime error occurs and the script is aborted.
Example
The name of the previous task within a Workflow is printed in the activation protocol.
: SET &NAME# = SYS_ACT_PREV_NAME ()
: PRINT "Name of the previous task is &NAME#."
See also:
Script element
Description
Returns the run number (RunID) of a previous task in a Workflow.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.7.15 SYS_ACT_PREV_NR
Script Function: Returns the run number (RunID) of a previous task in a Workflow.
Syntax
SYS_ACT_PREV_NR
()
Return codes
RunID of the preceding task
"0" - The task is the first one in the Workflow as its predecessor is the starting point.
Comments
Only tasks running in Workflows must contain this script function.
Only use this script function if there is exactly one previous task. If there is more than one predecessor, a runtime error occurs and the script is aborted.
Example
The activation report shows the run number (RunID) of the previous task in a Workflow.
246 Chapter 3 Ordered by Function
: SET &NR# = SYS_ACT_PREV_NR ()
: PRINT "RunID of the previous task is &NR#."
See also:
Script element
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Returns the name of the previous Job in a Workflow.
3.7.16 SYS_ACT_PTTYP
Script Function: Returns the partner type of the user.
Syntax
SYS_ACT_PTTYP
()
Return codes
"D" - Activation through UserInterface
"C" - Activation through CallAPI
Comments
This script function determines how a task was activated. It cannot be used in post process.
Example
This example shows the line that is written to the activation report if a task has been activated by a
CallAPI.
: SET &PTTYP# = SYS_ACT_PTTYP ()
: IF &PTTYP# = "C"
: PRINT "Task was activated through CallAPI."
: ENDIF
See also:
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 247
3.7.17 SYS_ACT_RESTART
Script Function: Retrieves whether the object was activated in restart mode
Syntax
SYS_ACT_RESTART
()
Return codes
"Y" - The object was activated in restart mode.
"N" - The object was not activated in restart mode.
Example
In the following example, particular processing steps that were integrated in an Include are only executed when the task was activated in restart mode.
: IF SYS_ACT_RESTART () = "Y"
: INCLUDE "INCL.RESTART.PROC"
: ENDIF
See also:
Script element
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
This is used to set restart points in an executable object
Returns the run number (RunID) of an object activated in restart mode
3.7.18 SYS_ACT_RESTART_COUNT
Script function: Supplies the number of restarts that were made for Workflow tasks using the action
RESTART TASK (Post-Conditions).
Syntax
SYS_ACT_RESTART_COUNT
()
Return code
Number of restarts
248 Chapter 3 Ordered by Function
Comments
This script element retrieves the number of times a task has already been restarted within a Workflow using the action RESTART TASK. You can define this action in the task properties of the
Post-
Conditions tab .
This value can also be retrieved using the predefined variable &$RESTART_COUNT#.
Example
The following example queries the number of times that the Workflow task has been restarted and writes the corresponding information to the activation report.
: SET &RCOUNT# = SYS_ACT_RESTART_COUNT ()
: IF &RCOUNT# = 0
: PRINT "The task has not yet been restarted."
: ELSE
: PRINT "Number of restarts: &RCOUNT#"
: ENDIF
See also:
Script Element
Description
Sets restart points in an executable object.
Retrieves whether the object has been activated in restart mode.
Returns the run number (RunID) of an object that has been activated in restart mode.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.7.19 SYS_ACT_RESTART_ME_NR
Script Function: Returns the run number (RunID) of an object activated in restart mode.
Syntax
SYS_ACT_RESTART_ME_NR
()
Return code
Run number of the object in which this script function is called.
Automation Engine 249
Comments
This script function also returns the RunID of the current task when it was activated normally. Thus, it can be used without previous checking for the activation type (normal or restart) being necessary.
Please bear in mind that
reacts differently to activation from restart mode.
Example
In the following example, the run number (RunID) of a task is written in the activation report. Additional information shows whether the task was activated normally or in restart mode.
: SET &RUNNR# = SYS_ACT_RESTART_ME_NR ()
: IF SYS_ACT_RESTART = "Y"
: PRINT "Job with RunID &RUNNR# processed in restart mode."
: ELSE
: PRINT "Job with RunID &RUNNR# processed normally."
: ENDIF
See also:
Script element
Description
This is used to set restart points in an executable object.
Determines if the object was activated in restart mode.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.7.20 SYS_ACT_TOP_NAME
Script Function: Supplies the name of the top Workflow
Syntax
SYS_ACT_TOP_NAME
()
Return codes
Name of the top Workflow
" " - The task was not activated by a Workflow.
Example
In the following example, the return codes of the two script functions are compared in order to determine whether the task was activated without a Workflow, within a Workflow, or within the framework of several nested Workflows. The corresponding message will then be sent to a user.
250 Chapter 3 Ordered by Function
: SET &TNAME# = SYS_ACT_TOP_NAME ()
: SET &PNAME# = SYS_ACT_PARENT_NAME ()
:
: IF &TNAME# = &PNAME#
IF &TNAME# = " "
: SEND_MSG ADMIN,UC4, "Task does not run in a Workflow."
: ELSE
: SEND_MSG ADMIN,UC4, "Task runs in a Workflow &TNAME#. No superordinate Workflows."
: ENDIF
:
: ELSE
SEND_MSG ADMIN,UC4, "Name of the top Workflow: &TNAME#."
: ENDIF
See also:
Script element
Description
Supplies the run number (RunID) of the top Workflow
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.7.21 SYS_ACT_TOP_NR
Script Function: Supplies the run number (RunID) of the top Workflow
Syntax
SYS_ACT_TOP_NR
()
Return codes
RunID of the top Workflow
" " - The task was not activated by a Workflow.
Example
In the following example, the return codes of the two script functions are compared in order to determine whether the task was activated without a Workflow, within a Workflow, or within the framework of several nested Workflows. The corresponding message will then be sent to a user.
: SET &TNR# = SYS_ACT_TOP_NR ()
: SET &PNR# = SYS_ACT_PARENT_NR ()
:
:
:
: IF &TNR#
IF &TNR# =
= &PNR#
" "
:
SEND_MSG
ELSE
SEND_MSG
ADMIN,UC4,
ADMIN,UC4,
"Task does not run in a Workflow."
"Task runs in the Workflow with RunID &TNR#. No
Automation Engine 251 superordinate Workflows."
: ENDIF
:
: ELSE
SEND_MSG ADMIN,UC4, "RunID of the superordinate Workflow: &TNR#."
: ENDIF
See also:
Script element
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Supplies the name of the top Workflow
3.7.22 SYS_ACT_USERID
Script Function: Supplies the User ID under which the Job will run
Syntax
SYS_ACT_USERID
()
Return code
User name from the Login object
Comments
This script function can only be used in Jobs. This script function retrieves the User ID under which a Job will be executed. It is read from the Login information of the Login object specified in the "Attributes" tab of this Job.
This script function supplies the same result as
with the attribute USERID.
Example
The following example prints the User ID and the entire Login information in the activation report.
: SET &URET# = SYS_ACT_USERID ()
: SET &LRET# = GET_ATT (LOGIN_INFO)
: PRINT "User ID: &URET#" , "Full Login information: &LRET#"
See also:
Script Elements - Activation Data
252 Chapter 3 Ordered by Function
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.7.23 SYS_LAST_RESTART_POINT
Script Function: Supplies the name of the previous restart point in the script.
Syntax
SYS_LAST_RESTART_POINT
()
Return codes
Name of the restart point that has last been run through
" " - No restart points have been specified
Comments
Restart points can be specified by using the script element :RESTART .
Example
In this example, files from the UC4 directory are saved. The previous restart point is "BIN", which is written to the activation report.
: RESTART BIN, "Program directory"
COPY C:\UC4G\BIN\*.* C:\BACKUP\UC4G\BIN\*.* /Y
: INC DOS.ERRORLEVEL
: SET &RET# = SYS_LAST_RESTART_POINT ()
: PRINT "Last restart point: &RET#"
: RESTART DB, "Database directory"
XCOPY C:\UC4G\DB\*.* C:\BACKUP\UC4G\DB\*.* /E /Y
: INC DOS.ERRORLEVEL
See also:
Script element
Description
This is used to set restart points in an executable object.
Supplies the text of the previous restart point as defined in the script.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Automation Engine 253
3.7.24 SYS_LAST_RESTART_TEXT
Script Function: Supplies the text of the previous restart point as defined in the script.
Syntax
SYS_LAST_RESTART_TEXT
()
Return codes
Text of the restart point that has last been passed.
"Restart Point Name of the restart point" - A restart point without text has been defined
" " - No restart points have been defined
Comments
Restart points are set using the script element
.
Examples
In the following example, files are copied from a UC4 directory. "Program directory" is written in the activation report as it is the restart text referring to the previous restart point.
: RESTART BIN, "Program directory"
COPY C:\UC4G\BIN\*.* C:\BACKUP\UC4G\BIN\*.* /Y
: INC DOS.ERRORLEVEL
: SET &RET# = SYS_LAST_RESTART_TEXT ()
: PRINT "Last restart point: &RET#"
: RESTART DB, "Database directory"
XCOPY C:\UC4G\DB\*.* C:\BACKUP\UC4G\DB\*.* /E /Y
: INC DOS.ERRORLEVEL
The second example supplies the result "Restart Point BIN" as no text was specified for the restart point.
: RESTART BIN
: SET &RET# = SYS_LAST_RESTART_TEXT ()
: PRINT &RET#
See also:
Script element
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
This is used to set restart points in an executable object.
Supplies the name of the previous restart point in the script.
254 Chapter 3 Ordered by Function
3.7.25 SYS_RESTART_POINT
Script Function: Supplies the restart point from which the object will be executed
Syntax
SYS_RESTART_POINT
()
Return codes
Name of the restart point
" " - The script is not executed from a particular restart point or generally not in restart mode.
Comments
This script function retrieves the restart point from which the script should be processed when a task was started with Execute..., thereby having specified a restart point.
Restart points are set using the script element
.
Example
In the following example, files are copied from the UC4 directory. When the Job is restarted with "DB" being indicated as restart point, only files from the database directory (including all sub-directories) will be copied. A corresponding message is written in the activation report.
: RESTART BIN, "Program directory"
COPY C:\UC4G\BIN\*.* C:\BACKUP\UC4G\BIN\*.* /Y
: INC DOS.ERRORLEVEL
: RESTART DB, "Database directory"
XCOPY C:\UC4G\DB\*.* C:\BACKUP\UC4G\DB\*.* /E /Y
: INC DOS.ERRORLEVEL
: SET &RET# = SYS_RESTART_POINT ()
: PRINT "Script was processed from &RET# on."
See also:
Script element
Description
This is used to set restart points in an executable object.
Repeats the execution of a task.
Determines if the object was activated in restart mode.
Returns the run number (RunID) of an object activated in restart mode.
Supplies the name of the previous restart point in the script.
Supplies the text of the previous restart point as defined in the script.
Script Elements - Activation Data
Automation Engine 255
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.8 User Data
3.8.1 IS_GROUP_MEMBER
Script Function: Checks a user's membership status within a UserGroup
Syntax
IS_GROUP_MEMBER
(User, UserGroup)
Syntax
User
UserGroup
Description/Format
Name of a User object
Format:
or
Name of a UserGroup object
Format: script literal or Script variable
Return codes
"1" - The User is a member of the UserGroup
"0" - The User is no member of the UserGroup or the User and/or the UserGroup do(es) not exist.
Comments
The membership status of a User within a UserGroup may be checked using this Script function. Both must be in the client in which this script function is called.
Example
In this example, the membership status of "BU/UC4" within the UserGroup "ADMIN" is tested. The result is written out in the activation report.
: SET &USGR# = "ADMIN"
: SET &MEMBER# = IS_GROUP_MEMBER ( "BU/UC4" , &USGR# )
:
: IF &MEMBER# = 1
PRINT "Member in &USGR#"
:
: ELSE
PRINT "No member in &USGR#"
: ENDIF
See also:
256 Chapter 3 Ordered by Function
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.8.2 SYS_ACT_CLIENT, SYS_USER_CLIENT
Script Function: Returns the number of the current client
Syntax
SYS_ACT_CLIENT
()
SYS_USER_CLIENT
()
Return code
Number of the current client
Comments
The number returned is the four-digit client number with leading zeros. The client in which the task calling this script function runs is used.
Example
The number of the current client is read in the script variable. One line with this information (e.g.: "0003") is given in the report.
: SET &CLIENT# = SYS_ACT_CLIENT ()
: PRINT "Current client: &CLIENT#"
See also:
Script element
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Returns the text of the current client
Automation Engine 257
3.8.3 SYS_ACT_CLIENT_TEXT
Script Function: Returns the text of the current client
Syntax
SYS_ACT_CLIENT_TEXT
()
Return codes
Title of the current client
" " - no title has been defined
Comments
This script function returns the client's title which can be entered in the Header tab of the Client object.
The client in which the task calling this script function runs is used.
Example
The text of the current client is read in the script variable. The result "Current Client: Productivity environment" - for example - is given in the report.
: SET &TXT# = SYS_ACT_CLIENT_TEXT ()
: PRINT "Current Client: &TXT#"
See also:
Script element
SYS_ACT_CLIENT or SYS_USER_CLIENT
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Returns the number of the current client
3.8.4 SYS_USER_ALIVE
Script Function: Checks whether a user is logged on to UC4 with a UserInterface.
Syntax
SYS_USER_ALIVE
(Name, Department)
Syntax
Description/Format
258 Chapter 3 Ordered by Function
Name
Department
Name of the user.
Format:
or
User's department.
Format: script literal or script variable
Return codes
"Y" - The user is logged on to the UserInterface.
"N" - The user is not logged on to the UserInterface or the User object does not exist.
Comments
This script function checks if a user is logged on to UC4.
Name and Department identify a user (for example, SMITH/UC4). You can only check users of your own client.
Users who are logged on via a utility or Call Interface cannot be identified .
The script function returns "N" if the user is not logged on or if the User object does not exist in the current client.If the specified user does not exist, you can react to this error by using the script statement
and analyze it by using the
Script Functions for Error Handling
. Depending on the settings that have been specified, script processing either continues or aborts.
Example
The following example checks whether a user has logged on to UC4. The user's name and department are passed on to the script function in the form of script variables. The script aborts if the user "SMITH/UC4" is not defined. The result is output to the activation protocol.
: ON_ERROR ABEND
: SET &USR# = "SMITH"
: SET &DEP# = "UC4"
: SET &RET# = SYS_USER_ALIVE ( &USR# , &DEP# )
: PRINT &RET#
See also:
Script element
Description
Supplies the department of the user who has started the task.
Supplies the language in which the Server generates the log files.
Supplies the first and last name of the user who has started the task.
Supplies the name of the user who has started the task.
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 259
3.8.5 SYS_USER_DEP
Script Function: Supplies the department of the user who has started the task.
Syntax
SYS_USER_DEP
()
Return code
Department of the user.
Comments
This script function determines the department of the user who has started the task (for example, "UC4" in
"SMITH/UC4").
Note that you can start tasks manually or by using the script statement "ACTIVATE_UC_OBJECT" via
Workflows and Schedules. Ii the task in which "SYS_USER_DEP" is called belongs to a Schedule, this script functions supplies the department of the user who has started the Schedule.
The user can also be identified in the Statistical Overview .
Example
The following example uses this script function in order to retrieve the department that has been used to log and writes the result to the activation report.
: SET &LOGDEP# = SYS_USER_DEP ()
: PRINT "Login information: The user department is &LOGDEP#."
See also:
Script element
Description
Checks whether a user is logged on to UC4 with a UserInterface.
Supplies the language in which the Server generates the log files.
Supplies the first and last name of the user who has started the task.
Supplies the name of the user who has started the task.
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
260 Chapter 3 Ordered by Function
3.8.6 SYS_USER_LNAME
Script Function: Supplies the first and last name of the user who has started the task.
Syntax
SYS_USER_LNAME
()
Return codes
First and last name of the user.
" " - Name was not defined
Comments
This script function retrieves the first and last name of the user who has started the task (for example,
"John Smith"). The full name can be defined in the User object's "User" tab .
Note that you can start tasks manually or by using the script element "ACTIVATE_UC_OBJECT" in
Workflows and Schedules. If the task in which "SYS_USER_LNAME" is called belongs to a Schedule, this script function supplies the name of the user who has started the Schedule.
The user can also be identified in the Statistical Overview .
Example
The following example retrieves the first and last names that have been used to log on using this script function and writes it to the activation protocol.
: SET &LOGLN# = SYS_USER_LNAME ()
: PRINT "Login information: User's first and last names are &LOGLN#."
See also:
Script element
Description
Checks if a user is logged on to UC4 with a UserInterface.
Supplies the department of the user who has started the task.
Supplies the language in which the Server generates the log files.
Supplies the name of the user who has started the task.
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Automation Engine 261
3.8.7 SYS_USER_NAME
Script Function: Supplies the name of the user who has started the task.
Syntax
SYS_USER_NAME
()
Return code
Name of the user-
Comments
This script function retrieves the name of the user who has started the task (for example, "SMITH" in
"SMITH/UC4").
Note that you can start tasks manually or by using the script element "ACTIVATE_UC_OBJECT" in
Workflows and Schedules. If the task in which "SYS_USER_NAME" is called belongs to a Schedule, this script function supplies the name of the user who has started the Schedule.
The user can also be identified in the Statistical Overview .
Example
The following example determines the name that has been used to log on using this script function and writes it to the activation report.
: SET &LOGN# = SYS_USER_NAME ()
: PRINT "Login information: The name of the user is &LOGN#."
See also:
Script element
Description
Checks if a user is logged on to UC4 with a UserInterface.
Supplies the department of the user who has started the task.
Supplies the language in which the Server generates the log files.
Supplies the first and last name of the user who has started the task.
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
262 Chapter 3 Ordered by Function
3.9 Data Sequences
3.9.1 :CLOSE_PROCESS
Script Statement: Discards a data sequence within a script.
Syntax
:CLOSE_PROCESS
Data sequence reference
Syntax
Data sequence reference
Description/Format
A script variable that includes a reference to a data sequence.
Format:
Comments
The script statement :CLOSE_PROCESS discards an unnecessary data sequence in order to release memory. This is important for complex processing (data sequences in data sequences) in a script.
Data sequences are provided by the following script elements: l l l l l
You cannot assign new values to script variables that include a reference to a data sequence unless these script variables are released with CLOSE_PROCESS.
The Variable is empty after it has been closed with :CLOSE_PROCESS.
Examples
The following example discards a data sequence whose reference is stored in the script variable
"&HND#".
: CLOSE_PROCESS &HND#
See also:
Script Elements - Data Sequences
Sample Collection
Setting End Status depending on Report Content
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Automation Engine 263
3.9.2 :PROCESS... :TERM_PROCESS... :ENDPROCESS
Script Statements: They are used to define 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.
Syntax
:PROCESS
Data sequence reference
[Statement]
:TERM_PROCESS
:ENDPROCESS
Syntax
:PROCESS
Data sequence reference
Statements
:TERM_PROCESS
:ENDPROCESS
Description/Format
The beginning of the loop.
The eference to a data sequence that should be processed.
Format:
One or more statements that will be processed during every processing cycle:
A statement to exit the loop.
The end of the loop.
Comments
The script statements :PROCESS and :ENDPROCESS facilitate the line-by-line processing of data sequences. They are provided by the following script elements: l l l l l l l
A new line is read in every cycle. This is repeated until the loop is either finished or explicitly terminated using the script statement :TERM_PROCESS.
You can use the script function
in order to retrieve the contents of a line.
An empty data sequence does not cause an error message. In this case, t The processing of the data sequence that is defined between :PROCESS and :ENDPROCESS does not take place.
Examples
The following example retrieves the directories of a disk drive and writes the results to the activation report using the :PRINT statement.
: SET &HND# = PREP_PROCESS ( "PC01" , "WINCMD" , "*DIR*" , "CMD=DIR C:" )
: PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE ( &HND# )
264 Chapter 3 Ordered by Function
: PRINT &LINE#
: ENDPROCESS
See also:
Script Elements - Data Sequences
Sample Collection
Setting End Status depending on Report Content
Calling an MBean
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.9.3 CREATE_PROCESS
Script function: Creates a new data sequence.
Syntax
CREATE_PROCESS
(Mode
[[ , Data sequence reference 1] , Data sequence reference 2]
)
Syntax
Mode
Data sequence reference 1
Data sequence reference 2
Description/Format
The mode how the data sequence should be created
Format: UC4 Name
Allowed values: l l l
NEW - Create a new empty data sequence
JOIN - 2 data sequences combined into 1
DUPLICATE - Create a copy of an existing data sequence
The reference to the data sequence that should either be duplicated or combined (depending on mode).
Format:
This parameter is only required for the JOIN or DUPLICATE Mode.
The reference to the data sequence that should be combined with data sequence 1.
Format: Script variable
This parameter is only required for the JOIN Mode.
Return code
The reference to the newly created data sequence.
Comments
The script function creates a new data sequence and returns its reference as a return code. You use the parameter Mode to specify whether the data sequence is empty or filled with lines from other data
Automation Engine 265 sequences.
Data sequences can also be created with the PREP_PROCESS* elements.
To add one or several lines to a data sequence, use the script function
.
Afterwards read the created data sequence using
. The line-by-line processing of data sequences can be executed with
loops.
Examples
The first example shows the creation an empty data sequence. Afterwards 2 lines each with 3 columns are added.
: SET &HND# = CREATE_PROCESS (NEW)
: SET &LINE1# = "Test1,Test2,Test3"
: SET &RET# = PUT_PROCESS_LINE ( &HND# , &LINE1# , "," )
: DEFINE &LINE2# , string, 3
: FILL &LINE2# [] = GET_VAR (TEST.VAR, KEY1)
: SET &RET# = PUT_PROCESS_LINE ( &HND# , &LINE2# )
In the second example a data sequence is duplicated.
: SET &HND1# = PREP_PROCESS_VAR (VARA.DB, "*WIN*" )
: SET &HND2# = CREATE_PROCESS (DUPLICATE, &HND1# )
The last example shows how two data sequences are combined to one.
: SET &HND1# = PREP_PROCESS_VAR (VARA.DB1, "*WIN*" )
: SET &HND2# = PREP_PROCESS_VAR (VARA.DB2,, "*JOBS*" ,1)
: SET &HND# = CREATE_PROCESS (JOIN, &HND1# , &HND2# )
See also:
Script element
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Discards an unnecessary data sequence.
Loop for line by line processing of a data sequence - a sequential file or a command result, for example.
Returns the content of the current line of a data sequence.
Adds a line to a specific data sequence
266 Chapter 3 Ordered by Function
3.9.4 GET_PROCESS_INFO
Script function: Retrieves information from a data sequence.
Syntax
GET_PROCESS_INFO
(Data sequence reference, Information
[ , Line ]
)
Syntax
Data sequence reference
Information
Line
Description/Format
The reference to the data sequence whose nformation should be read.
Format:
The specific Information that should be retrieved
Format: UC4 Name
Allowed values: l l l
INDEX - Current position of the
loop the data sequence is used in.
COLUMNS - Number of columns of the specified line. If no line is specified, the current line (only when used in process loops) or the first line is used.
ROWS - Number of rows of the data sequence
The line whose column number should be determined.
Format: A number without quotations, script literal or script variable.
This parameter can only be specified if the number of columns is queried
(Information = COLUMNS).
Return code
Information from the data sequence
Comments
This script function allows you to retrieve general information (such as the number of columns or lines) of data sequences. To do so, you must specify the reference of the data sequence and the information that should be read.
When the number of columns should be read, you can additionally specify the corresponding line. If no line is given the used line depends on the usage of the script element: l l
The script function is used inside a process loop: Line which is currently accessed by the loop.
The script function is used outside a process loop: First line
The information INDEX stipulates that the function is used inside a process loop. In this case the number of the line is retrieved that is currently processed by the loop.
When reading the number of rows there are no special dependencies.
Note that the specified data sequence must exist and must not closed by the element
PROCESS . Otherwise, a runtime error will occur.
Automation Engine 267
Examples
The following example shows the creation of a data sequence that is filled with the entries of a variable object. Then the number of columns are determined per line and printed to the activation report.
: SET &HND# = PREP_PROCESS_VAR (VARA.SQL, "*WIN*" )
: SET &LNR# = GET_PROCESS_INFO ( &HND# , ROWS)
: PROCESS &HND#
: SET &IND# = GET_PROCESS_INFO ( &HND# ,INDEX)
: SET &COL# = GET_PROCESS_INFO ( &HND# ,COLUMNS, &IND# )
: PRINT "Line &IND# / &LNR# has &COL# columns"
: ENDPROCESS
: CLOSE_PROCESS &HND#
See also:
Script element
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Discards an unnecessary data sequence.
Loop for line by line processing of a data sequence - a sequential file or a command result, for example.
Returns the content of the current line of a data sequence.
Adds a line to a certain data sequence
3.9.5 GET_PROCESS_LINE
Script Function: Retrieves the current line content of a data sequence.
Syntax
GET_PROCESS_LINE
(Data sequence reference
[, [Column] [, [STR_SUBSTITUTE_VAR] [,
Row ] ] ]
)
GET_PROCESS_LINE
(Data sequence reference
[, [Column] [, [STR_SUB_VAR] [, Row ] ] ]
)
Syntax
Data sequence reference
Description/Format
Reference to a data sequence that should be processed.
Format:
268 Chapter 3 Ordered by Function
Column
Access to a column of the data sequence's line.
l
Data sequence in which the lines are divided in columns.
Format: Number without quotations,
or script variable
Allowed values: "1" to "22" or column name l
Data sequence of a Variable object.
Format: Number without quotations or script variable
Allowed values: "1", "2" to n
"1" = Key or Result column. Value column of Variable objects of the type "Filelist".
"2" - "6" = Value columns of static Variable objects.
"2" to n = Number of the value columns of Variable objects.
Dynamic Variables (SQL, SQLI and Multi) can include any number of columns which depends on the relevant data source.
Static Variables only include 5 value columns ("2" to "6").
FILELIST-Variable generally have only one column that can be addressed using "1".
STR_SUBSTITUTE_
VAR
STR_SUB_VAR
Line
l
Data sequence of a comment.
Format: Number without quotations or script variable
Allowed values: "1", "2" and "3"
"1" = Time stamp
"2" = User name
"3" = Comment text
The lines of the data sequence are also searched for script variables that should be replaced with their values.
Note that you must set a comma if you use this parameter is used but do not specify a Column.
For example:
: SET &VALUE# = GET_PROCESS_LINE ( &HND# , ,STR_SUB_VAR)
Line of the data sequence which should be accessed.
Format: Number without quotations, script literal or script variable
Comments
The script function GET_PROCESS_LINE reads a line or columns of a data sequence. The data sequence is provided by the following script elements: l l l l l l l l l
Automation Engine 269
The script function GET_PROCESS_LINE is used within the script statements
and
:ENDPROCESS . These script statements form a loop for the line-by-line processing of the data
sequence.
Please note: As of v9, GET_PROCESS_LINE has to be in a PROCESS loop formed by script statements.
The individual lines of a data sequence can also be subdivided in columns. You can specify this setting by using the parameters COL=LENGTH or COL=DELIMITER when you generate the data sequence.
Particular columns can be accessed with their numbers (1 - first column) or with the column name if it has been specified.
The whole line is returned if the column is not specified or if you use "0". The line is truncated after 255 characters.
If the values of a Variable object are retrieved, the current line includes the Key (static Variable) or the
Result column (dynamic Variable) plus the corresponding values. The value "1" for Column readsthe
Key/Result, the values "2" to "6" (static Variables) reads the relevant value column. The Result column corresponds to the first value column if no Result format is defined in the Variable object (SQL, SQLI,
MULTI).
The number of value columns that is used in dynamic Variables with the sources "SQL", "SQL - internal" or
"Multi" is not limited and depends on the settings that have been made in the Variable objects and the data type .
The comment columns can also be read individually .
If the column number is not specified when a Variable object is accessed, the system returns the value of all columns (Key / Result included) separated by "§§§" characters.
SAP monitors can specifically be accessed. The SAP Agent separates the individual lines that are supplied by SAP monitor in fixed columns. It saves column names and column sizes in the first line of the file that should be processed by the UC4 AutomationEngine. The following columns can be accessed by using GET_PROCESS_LINE: l l l l l l l
CONTEXT - Name of the monitored context
PATH - Path specification of a value
NAME - Name of the value
VALUE - Current value
STATUS - Status: 1 = green, 2 = yellow, 3 = red
DATE - Date of the verification
TIME - Time of the verification
You can also use the parameter STR_SUBSTITUTE_VAR or its short form STR_SUB_VAR. Script variables are then searched within the line and replaced with their values. This function is very useful in combination with PREP_PROCESS_FILE. For example, you can prepare a text file that contains script variables in alterable positions in order to facilitate processing. No matter from where the data sequence is retrieved (file, report, Variable object), the values can be set by using script (see
below).
Furthermore access to a specific line of the data sequence is possible. Enter the number of the line at the corresponding ccript function parameter. The first line is number 1. Line numbers from data sequences can be retrieved with the script function
.
Note that by default, GET_PROCESS_LINE truncates blanks that are used at the end of the line that should be read. The UC4 administrator can deactivate this behavior in the setting GET_PROCESS_
LINE_RTRIM of the UC4 Variable UC_SYSTEM_SETTING.
270 Chapter 3 Ordered by Function
Examples
Example 1 retrieves the directories of a drive and writes them to the activation report within the loop using
:PRINT.
: SET &HND# = PREP_PROCESS ( "PC01" , "WINCMD" , "*DIR*" , "CMD=DIR C:" )
: PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE ( &HND# )
: PRINT &LINE#
: ENDPROCESS
Example 2 retrieves the values of a UC4 Variable and writes them to the activation report within the process loop using :PRINT.
:
:
: SET &HND# = PREP_PROCESS_VAR (UC_CLIENT_SETTINGS)
: PROCESS &HND#
SET
SET
&RET1#
&RET2#
=
=
GET_PROCESS_LINE
GET_PROCESS_LINE
: PRINT "&RET1# &RET2#"
: ENDPROCESS
(
(
&HND#
&HND#
,1)
,2)
Example 3 reads all the UserInterface's log file lines which provide information about the database.
Column size and column names are specified and the relevant information is output in the activation protocol. Spaces (column 2 and 4) are ignored.
: SET &HND# = PREP_PROCESS_FILE (WIN21, "F:\UC4\DIALOG\TEMP\UCDJ_LOGG_
01.TXT" , "*DB-INFO*" , "COL=LENGTH" , "LENGTH_
TAB='8=DATUM,1,6=ZEIT,7,200=TEXT'" )
: PROCESS &HND#
:
:
:
SET &COL1# = GET_PROCESS_LINE ( &HND# ,1)
SET &COL2# = GET_PROCESS_LINE ( &HND# ,3)
SET &COL3# = GET_PROCESS_LINE ( &HND# , "TEXT ")
: PRINT "&COL1# &COL2# &COL3#"
: ENDPROCESS
Example 4 reads the SAP monitor "MON1" from the monitor set "UC4". The individual columns of the monitor data should be accessed. The lines of the data sequence are output in the activation report.
:
:
:
:
: SET &HND# = PREP_PROCESS
( "T01" , "R3MONITOR" , "*" , "MONSET=UC4" , "MONNAM=MON1" , "COL=FILE" , "UC_USER_
ID=UC4" , "UC_SAPCLIENT=001" )
: PROCESS &HND#
SET
SET
SET
SET
&PATH#
&NAME#
&VALUE#
=
=
&STATUS#
=
GET_PROCESS_LINE
GET_PROCESS_LINE
=
(
(
GET_PROCESS_LINE
&HND#
&HND#
(
GET_PROCESS_LINE (
,
,
&HND#
"PATH"
"NAME"
,
&HND# ,
)
")
"VALUE" ")
"STATUS" )
:
:
SET
SET
&DATE#
&TIME#
=
=
GET_PROCESS_LINE
GET_PROCESS_LINE
(
(
&HND#
&HND#
,
,
"DATE"
"TIME"
)
)
: PRINT "&PATH# &NAME# &VALUE# &STATUS# &DATE# &TIME#"
: ENDPROCESS
Definition of the column sizes and names in the file (first line) that is provided by the SAP Agent.
COL=LENGTH,LENGTH_TAB='74=PATH,25=NAME,5=VALUE,2=STATUS,9=DATE,7=TIME'
Example 5 reads the lines of a text file and replaces the included script variables with their values. The modified lines are then written to the activation report.
: SET &NAME# = SYS_ACT_ME_NAME ()
: SET &DATE# = SYS_DATE_PHYSICAL ( "MM/DD/YYYY" )
: SET &TIME# = SYS_TIME_PHYSICAL ( "HH:MM" )
: SET &JPNAME# = SYS_ACT_PARENT_NAME ()
: SET &HND# = PREP_PROCESS_FILE ( "WIN01" , "C:\UC4\REPORT.TXT" )
Automation Engine 271
: PROCESS &HND#
: SET &RET# = GET_PROCESS_LINE ( &HND# ,, STR_SUB_VAR )
: PRINT &RET#
: ENDPROCESS
Abstract of the ready-made text file REPORT.TXT:
&date#/&time#
Report for &NAME#:
Activated by Workflow: &JPNAME#
See also:
Script Elements - Data Sequences
Sample Collection
Setting the End Status depending on the Report Content
Calling an MBean
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.9.6 LOAD_PROCESS
Script Function: Loads a stored data sequence.
Syntax
LOAD_PROCESS
(RunID, Key)
Syntax
RunID
Key
Description/Format
The RunID of the task whose stored data sequence should be loaded.
Format: A number without inverted commas,
or
The internal name under which the data sequence has been stored.
Format: UC4 Name,
or
Return Code
The reference to the stored data sequence.
Comments
This script function loads a data sequence that has been stored in the UC4 Database using the script element
and makes this task available. For this purpose, you must indicate the RunID of the activity that has been used to store the data sequence and the term that has been used to store the data sequence in the database (Key). The Key is the return code of the function SAVE_PROCESS.
Stored data sequences can be loaded and used several times by any tasks.
272 Chapter 3 Ordered by Function
Note that SAVE_PROCESS stores the data sequence but it does not close it. This means that you still need to use the script element
Examples
For detailed examples, see the description of
See also:
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.
Creates a new data sequence.
Returns the content of the current line of a data sequence.
Stores a certain data sequence.
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.9.7 PREP_PROCESS
Script Function: This script function uses specific Job objects (Event jobs) in order to process commands on a computer and it returns the Console output that can be used for further processing as an internal list
(data sequence).
Syntax
PREP_PROCESS
(Host, EventJob
, [Filter]
,Action
[, Column separation]...[, UC_LOGIN=Login object]
)
Syntax
Host
EventJob
Filter
Description/Format
Computer (Agent name) on which the Event runs.
Format:
or
of the Event job that should be executed.
Format: script literal or script variable
Defines a filter condition for the content of the returned line (case insensitive).
Format: script literal or script variable
Default value: "*"
Action
Automation Engine 273
Assigns a value to a script variable of the Event job,
Format: script literal or script variable.
Default value: ""
Specific syntax: Variable=Assignment
Variable - Name of the Event job's script variable which assumes the value assignment. It is specified without the & character.
Assignment - Value of the script variable. This is mainly an action (command, program call or activation of a file) that should be executed in the target system, or any other value assignment (variables of the attribute dialog ).
A specific syntax is required in order to query the UNIX file system.
274 Chapter 3 Ordered by Function
Column separation
You can also specify that data sequence lines should be subdivided in columns.
Use the following format: COL=Definition1[, Definition2].
Format: script literal or script variable
Definition1:
Allowed values: "NONE" (default value), "FILE", "LENGTH", "DELIMITER"
"NONE" = No subdivision in columns
"FILE" = A column definition is used in the first line of the file which the Agent creates if Event jobs start which execute the SAP JCL element
("R3MONITOR" uses the parameter EventJob of the system client's template Event job "EVENT.R3MONITOR" ).
"LENGTH" = Predefined column size. Requires LENGTH_TAB= for Definition2
"DELIMITER" = Columns are separated by a delimiter. Requires DELIMITER= as Definition2
Definition2:
Defines column sizes and names (optional) or the delimiter
Format: script literal or script variable
Allowed values: "LENGTH_TAB" and "DELIMITER" l
"LENGTH_TAB"
Column sizes and names (optional) are specified in the form Column
size=[Column name]. The column size is defined through a number of characters .
The individual column definitions must be separated by commas (maximum 22 columns). Quotes are also required before the first and after the last column definition. Double quotation marks must be used if single quotation marks have been used as script literals for Definition2 and vice versa.
Example:
"LENGTH_TAB='10=Department,25=Head,10=Budget'" l
"DELIMITER"
Columns that should be separated by characters can be specified in the form *Delimiter*.
"*" = You can use any characters of your choice. They only indicate that the string they enclose is a Delimiter. These characters are not shown in the output.
Delimiter = A string of a maximum length of 10 characters which separates the columns. The characters of a line are returned as columns that are positioned before, in between or after the Delimiter string. A column is not separated if a line does not include a Delimiter. If you have used single quotation marks as Delimiters, you must enclose Definition2 in double quotation marks and vice versa.
Default value: Semi colon (;)
Example:
"DELIMITER=*'*"
'DELIMITER=@"@'
Automation Engine 275
UC_LOGIN
Name of a Login object.
Format: script literal or script variable
Note that this script function requires login data. The relevant Event job must include valid login information if the parameter UC_LOGIN has not been specified.
Return code
Reference to the data sequence of the command.
Comments
The script function PREP_PROCESS creates a data sequence with the results of: l l l l
OS commands of BS2000, MPE, UNIX, VMS and Windows,
BS2000 Console commands,
UNIX file system queries,
SAP monitors, SAP system log and SAP jobs
Executing a BS2000 Console command or querying a UNIX file system requires the UC4 utilities
UCYEBXXZ or UCXE???F to be installed.
Console and OS commands are processed by means of Event jobs which start in the background on the computer of the specified Agent (Host). A command's result lines are available in the form of an internal list
(data sequence) via the script function's return code.
The names of Event jobs are structured as follows: "EVENT.EventJob". "EVENT." is a pre-determined part of the job name. The part "EventJob", however, can be defined in any way. The definition of an Event job is given in terms of particular attributes and the general script structure.
Event jobs are supplied in system client 0000. You can use them directly or as a template in the individual clients. If required, you can adjust their contents. Keep in mind to change the script procedure in
EVENT.UNIXCMD to avoid that the report will be deleted if a return code >0 occurs.
The following internal steps are passed when the data sequence that is provided by PREP_PROCESS is being processed:
1. The Event job that has been specified using the parameter EventJob is activated (Job name:
EVENT.EventJob).
2. The Event job runs on the Host and performs the action that is specified in Action. Line by line, it redirects the action result to a data sequence.
3. Lines are only considered if their contents comply with the parameter Filter. Using this parameter is optional.
4. You can specify any value assignment in the parameter Action.
In the OS commands of BS2000, MPE, UNIX, VMS and Windows, as well as the BS2000 Console commands, Variable primarily supplies the value for the script variable "&CMD". You can also assign values to script variables that are available within the attribute dialog . When the Event job starts, the corresponding Include is processed in the script and supplied with values internally
(depending on the EventJob),without the attribute dialog being displayed.
A specific parameter syntax applies for querying UNIX file systems.
5. The data sequence that has been generated on the Host is transferred to the UC4 Automation
Engine via FileTransfer in order to be processed. By default, the name of the file that is transferred from the Host to the UC4 Automation Engine is "ERRRRRRR.TXT". The following placeholders are used for the variable parts:
276 Chapter 3 Ordered by Function l l
E - Event
RRRRRRR - Running number (RunID) of the task
Note that the RunID is shown as a converted string (see
) and not as a number.
By default, this script function reads an entire line. You can also access it in a structured way if the line has been subdivided into columns. The following rules apply: l l l maximum of 22 columns with a total size of 2048 bytes column size of max. 255 characters and column name of max. 32 characters.
can be used to access particular columns.
The script function returns a data sequence reference. This reference is passed to the script statements
and
as a start parameter. In combination with the script function
PROCESS_LINE , you can now process each individual line of the data sequence and its columns.
No error message is displayed if the data sequence does not contain the indicated content .
The processing of the data sequence that is defined between :PROCESS and :ENDPROCESS does simply not take place.
You cannot assign a new value to the script variable which contains the data sequence reference. The data sequence must be discarded with the script statement
first, and then the variable can be reused.
This script statement causes all open
of the script to be written to the UC4 Database.
The script function cannot be used for z/OS and OS400 hosts!
Examples
In the first example, the command "/STA P" is executed on the BS2000 computer "C70". The required ID and account are read from the Login object.
: SET &HND# = PREP_PROCESS ( "C70" , "BS2000CMD" ,, "CMD=/STA P" , "UC_
LOGIN=UC4ADMIN" )
The next example executes a command on a BS2000 console which outputs all open applications. No filter is specified for the line content.
: SET &HND# = PREP_PROCESS ( "C70" , "BS2000UCON" ,, "CMD=/BCDISP DISP=O" , "UC_
LOGIN=UC4ADMIN" )
The third example retrieves the directories of a given drive on the Windows computer "WIN23".
: SET &HND# = PREP_PROCESS ( "WIN23" , "WINCMD" , "*DIR*" , "CMD=DIR C:" , "UC_
LOGIN=UC4ADMIN" )
The fourth example reads the SAP monitor "MON1" from the monitor set "UC4". The individual columns of the monitor data which have been defined in the file should be accessed. User and SAP client are read from the specified Login object.
: SET &HND# = PREP_PROCESS
( "T46" , "R3MONITOR" , "*" , "MONSET=UC4" , "MONNAM=MON1" , "COL=FILE" , "UC_
LOGIN=UC4ADMIN" )
The following example runs a command on the UNIX agent "UNIX01" which returns information about connections with the port 2400.
Automation Engine 277
: SET &HND# = PREP_PROCESS ( "UNIX01" , "UNIXCMD" ,, "CMD=netstat -an | grep
2400" , "UC_LOGIN=LOGIN.UNIX" )
See also:
Script element
Description
Discards an unnecessary data sequence.
They are used to define a loop for line by line processing of data sequences. For example, the contents of sequential files or the result of a command.
This is used to retrieve content from the current line of a data sequence.
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.9.8 PREP_PROCESS_AGENTGROUP
Script function: 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).
Syntax
PREP_PROCESS_AGENTGROUP
(AgentGroup
[, Host] [, Selection option] [, RunID]
)
Syntax
AgentGroup
Description/Format
Name of the AgentGroup object whose Agents should be read
Format:
Host
Filter for the Agent name
Format: script literal or script variable
Maximum 32 characters
Default value: "*"
The wildcard characters "*" and "?" can be used. "*" stands for any number of characters, "?" for exactly one.
278 Chapter 3 Ordered by Function
Selection option
RunID
Method to be used for retrieving the AgentGroup's Agents
Format: UC4 name, script literal or script variable
Allowed values: "BY_RULE" (default value), "ALL" and "RUNNR"
"BY_RULE" - The script function returns the Agent on which the next task will run.
"ALL" - All the AgentGroup's Agents are retrieved.
"RUNNR" - The retrieved Agent(s) depend on a particular task. The RunID of the AgentGroup container must be specified in the parameter of the same name.
In AgentGroups with the mode "All", the options BY_RULE and ALL supply the same result.
Run number (RunID) of the AgentGroup container.
Format: script literal, script variable or number
The Agent(s) on which the task has run is/are returned if this parameter is used.
Only specify this parameter if you selected the selection option RUNNR.
Return code
Reference to the data sequence of the AgentGroup object
Comments
This script function reads the Agents of an AgentGroup object. These Agents can be limited with parameters. By default, the reference to the whole data sequence is returned.
The return code of this script function is the reference to a data sequence. It is assigned to the script statements
and
as a start parameter. In combination with the script function
GET_PROCESS_LINE , it is possible to access each individual line of the data sequence. Data
sequences are divided into two columns which can be specifically read:
1. Name of the Agent
2. Status of the Agent ("Y" - Agent is active, "N" - Agent is not active)
The status is mainly important for AgentGroups of mode "All". The script function always supplies all
Agents for such AgentGroups without consideration of whether they are active or not. The status information can be used to retrieve Agents on which tasks can actually be processed.
Commas must always be set even if you search only for the selection and/or the RUN#.
No new value can be assigned to the script variable containing the data sequence reference. The data sequence must first be discarded with the script statement
and then the variable can be re-used.
Example
The first example retrieves all Agents of a AgentGroups whose names start with "WIN".
: SET &HND# = PREP_PROCESS_AGENTGROUP ( "AGENTGROUP_WINDOWS" , "WIN*" ,ALL)
Automation Engine 279
:
:
: PROCESS &HND#
: SET &AGENT# = GET_PROCESS_LINE ( &HND# ,1)
SET &STATUS#
= GET_PROCESS_LINE
"Agent: &AGENT#"
: PRINT "Status: &STATUS#"
: ENDPROCESS
( &HND# ,2)
: CLOSE_PROCESS &HND#
The following example restarts a task. The script function SYS_ACT_ME_NR returns the RUN# of the original execution which can be used to retrieve the RUN# of the AgentGroup Container. Thus, the Agents on which a task had originally run can be retrieved.
: SET &T_RUNNR# = SYS_ACT_ME_NR ()
: SET &P_RUNNR# = GET_PARENT_NR ( &T_RUNNR# )
: SET &HND# = PREP_PROCESS_AGENTGROUP ( "AGENTGROUP_DB" ,,RUNNR, &P_RUNNR# )
:
:
: PROCESS &HND#
: SET &AGENT# = GET_PROCESS_LINE ( &HND# ,1)
SET &STATUS#
= GET_PROCESS_LINE
"Agent: &AGENT#"
: PRINT "Status: &STATUS#"
: ENDPROCESS
( &HND# ,2)
: CLOSE_PROCESS &HND#
See also:
Script element
Description
Discards an unnecessary data sequence
They are used to define a loop for line-by-line processing of data sequences such as the content of a sequential file or the text result of a command.
This is used to retrieve content from the current line of a data sequence.
Script Element - Data Sequences
Scrip Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.9.9 PREP_PROCESS_COMMENTS
Script function: Uses filter settings to retrieve the time stamp, user and text of task comments, and provides the result for further processing in the form of an internal list (data sequence).
Syntax
PREP_PROCESS_COMMENTS
(
[RunID] [,Text] [, user]
)
Syntax Description/Format
280 Chapter 3 Ordered by Function
RunID
Text
User
Run number (RunID) of the task whose comments should be read.
Format:
or number
If no RunID has been specified, the comments of the task which calls this script statement are read.
Filter for a particular text used in the comment
Format: script literal or script variable
Maximal 200 characters
Default value: "*"
The wildcard characters "*" and "?" can be used. "*" stands for any characters, "?" for exactly one character.
Filter for the name of a User object
Format: script literal or script variable
Maximal 200 characters
Default value: "*"
The wildcard characters "*" and "?" can be used. "*" stands for any characters, "?" for exactly one character.
The first colon is also required if you only filter by the user. See the following example:
: SET &HND# = PREP_PROCESS_COMMENTS (,, "SMITH/UC4" )
Return code
Reference to the data sequence of comments
Comments
This script function reads a task's comments. The result may be limited using the parameters Text and
User.
Upper and lower case are considered in the filter specifications.
Keep in mind that an empty string ("") used as a filter specification has the same effect as "*" - all values are returned.
The return code of this script function is the reference to a data sequence which is assigned to the script statements
and
as a start parameter. Each of a task's comments may now be accessed using the script function
No error message is sent if the values that are searched for are not included in the comment. The processing of the data sequence that is defined between :PROCESS and :ENDPROCESS simply does not take place.
No new value can be assigned to the script variable containing the data sequence reference. The data sequence must first be discarded with the script statement
and then the variable can be re-used.
Examples
The following comments have already been started:
Automation Engine 281
The first example retrieves all comments and :PRINT supplies the user and the text.
: SET &HND# = PREP_PROCESS_COMMENTS ()
: PROCESS &HND#
:
:
SET
SET
&USER#
&TEXT#
=
=
GET_PROCESS_LINE
GET_PROCESS_LINE
(
(
&HND#
&HND#
,2)
,3)
: PRINT "&USER#: &TEXT#"
: ENDPROCESS
: CLOSE_PROCESS &HND#
The second example only reads the entries of Mr. Smith and prints them including the time stamp.
: SET &HND# = PREP_PROCESS_COMMENTS (,, "SMITH/UC4" )
:
:
: PROCESS &HND#
: SET &TIME# = GET_PROCESS_LINE ( &HND# ,1)
SET
&TEXT#
: ENDPROCESS
=
"&TIME#:
GET_PROCESS_LINE
&TEXT#"
( &HND# ,3)
: CLOSE_PROCESS &HND#
In the third example, the script function is called from a different task, hence the RunID. The result supplies all texts of the comment which include the word "file".
: SET &RunID = GET_UC_OBJECT_NR (MM.RETRIEVE.FILES)
: SET &HND# = PREP_PROCESS_COMMENTS ( &RunID , "*file*" )
: PROCESS &HND#
: SET &TEXT# = GET_PROCESS_LINE ( &HND# ,3)
: PRINT "Comment: &TEXT#"
: ENDPROCESS
282 Chapter 3 Ordered by Function
: CLOSE_PROCESS &HND#
See also:
Script element
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Adds a comment to a task
Discards an unnecessary data sequence
Loop for line-by-line processing of a data sequence - a sequential file or a command result, for example
This is used to retrieve content from the current line of a data sequence.
3.9.10 PREP_PROCESS_FILE
Script Function: 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).
Syntax
PREP_PROCESS_FILE
(Host, File,
[ Filter] [, "COL=Definition1[, Definition2]"][, UC_LOGIN=Login object]
)
Syntax
Host
File
Filter
Description/Format
Computer (name of an Agent) on which the file is located
Format:
or
Name of the text file to be read
Format: script literal or script variable
The name of a file which is part of a Generation Data Group can be retrieved using the script function
.
Under Windows the path to the file has to be defined according to the
Universal Naming Convention. A path to a user mapped device will result in an error message.
Definition of a filter condition for the content of a line. Case insensitive
Format: script literal or script variable
Default value: "*"
Automation Engine 283
Definition1
Definition2
UC_LOGIN
Determines if the lines of the data sequence should divided in columns.
Format: script literal or script variable
Allowed values: "NONE" (default), "FILE", "LENGTH", "DELIMITER"
"NONE" = No columns
"FILE" = The columns are defined in the file
"LENGTH" = Specified size of the column. Requires LENGTH_TAB= for
Definition2
"DELIMITER" = Columns separated by a delimiter. Requires DELIMITER= as Definition2
Fixes column sizes and names (optional) or the delimiter
Format: script literal or script variable
Allowed values: "LENGTH_TAB" and "DELIMITER" l
"LENGTH_TAB"
Column sizes and names (optional) are specified in the form Column
size=[Column name]. The column size is defined through a number of characters. The individual columns are separated by commas
(maximum 22 columns). Quotations must be set before the first and after the last column definition. If double quotations are used for
Definition2 as script literal, single quotations must be used for specification or vice versa.
Example:
"COL=LENGTH,LENGTH_TAB='3=drive,100=file name'" l
"DELIMITER"
The delimiter is specified in the form *Delimiter*.
"*" = freely defined delimiter.
Delimiter = String of not more than 10 characters which separates the columns. If single quotations are used as Delimiters, the whole phrase
COL=Definition1[,Definition2] must be enclosed in double quotations and vice versa.
Default value: Semi colon (;)
Example:
"COL=DELIMITER,DELIMITER=*'*"
'COL=DELIMITER,DELIMITER=@"@'
Tabulators can also be defined as separators:
'DELIMITER=<TAB>'
Name of a Login object
Format: script literal or script variable
Return code
Reference to a data sequence of the file
284 Chapter 3 Ordered by Function
Comments
The script function PREP_PROCESS_FILE provides the contents of a text file - for example a LOG or trace file - for further processing with UC4 scripts.
This script function reads the entire line of a data sequence. It can, however, also be accessed when the line is subdivided into columns. The following restrictions apply: l l l maximal 22 columns with a total size of 2048 bytes, column size maximal 255 characters and column name maximum 32 characters.
The columns can also be defined in the file itself (first line).
Example:
COL=LENGTH,LENGTH_TAB='74=PATH,25=NAME,5=VALUE,2=STATUS,9=DATE,7=TIME'
GET_PROCESS_LINE may be used to access particular columns.
With the optional parameter UC_LOGIN, the name of a Login object may be assigned to the script function. Access to the file to be read and its transfer from the Host to the UC4 Automation Engine is made with the login data defined in the Login object. Users require the privilege "FileTransfer: Start without User
ID" if the script function PREP_PROCESS_FILE should be used without the UC_LOGIN parameter.
The return code of the script function is the reference to this data sequence. It is given to the script statements
and
as start parameters. In combination with the script function
GET_PROCESS_LINE , each individual line of the data sequence and its columns can now be processed.
No error occurs if the data sequence does not contain the required content. The processing of the data sequence that is defined between :PROCESS and :ENDPROCESS does simply not take place.
No new value can be assigned to the script variable containing the data sequence reference. The data sequence must be discarded with the script statement
first and then the variable can be re-used.
Only the OS Agent supports PREP_PROCESS_FILE. It cannot be used in combination with Agents for Databases, Oracle Applications, PeopleSoft, SAP, JMX or Rapid Automation.
Keep in mind that the processing of huge files affects the Agent's performance .
The script statement causes all open
of the script to be written to the UC4 Database.
Examples
The first example prints all lines of file "\\FServer\UC4\BSP\INPUT.TXT" containing the string "Start" to the activation protocol.
: SET &HND# = PREP_PROCESS_FILE
(WIN21, "\\FServer\UC4\BSP\INPUT.TXT" , "*Start*" )
: PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE ( &HND# )
: PRINT &LINE#
: ENDPROCESS
The second example reads all lines of a file whereas parameter "COL=FILE" specifies that column names and widths are defined in the file itself. The login object provided is used to log on.
: SET &HND = PREP_PROCESS_FILE (WIN21, "\\FServer\LOG.TXT" , , "COL=FILE" , 'UC_
LOGIN=UC4FT' )
Automation Engine 285
Example three is similar to that above, however, parameter "COL=LENGTH" denotes that column definitions are specified with the subsequent parameter.
Column definitions can be a width assigned a name or a width only. Columns without a name are ignored.
Only lines containing "DB-INFO" are filtered out.
: SET &HND = PREP_PROCESS_FILE (WIN21, "\\FServer\UC4\DIALOG\TEMP\UCDJ_LOGG_
01.TXT" , "*DB-INFO*" , "COL=LENGTH , LENGTH_TAB='8=DATE,1,6=TIME,7,200=TEXT'" )
In the next example parameter "COL=DELIMITER" says that a separator is specified with the next parameter – the tabulator. The script prints the third column only.
: SET &HND# = PREP_PROCESS_FILE (UNIX01,
"/uc4/test.txt" ,, "COL=DELIMITER , DELIMITER=*<TAB>*" )
: PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE ( &HND# ,3)
: PRINT &LINE#
: ENDPROCESS
See also:
Script element
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Rejects an unnecessary data sequence
Loop for line by line processing of a data sequence - a sequential file or a command result, for example
This is used to retrieve content from the current line of a data sequence.
3.9.11 PREP_PROCESS_FILENAME
Script Function: 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).
Syntax
PREP_PROCESS_FILENAME
(Host, File name,
[Wildcards]
,
[Subfolder]
,
[Filter]
[,"COL=Definition1[, Definition2]"][ ,"UC_LOGIN=Login object"]
)
Syntax
Host
Description/Format
Computer (name of the Agent) on which the files are found
Format:
or
286 Chapter 3 Ordered by Function
File name
Wildcards
Subfolder
Filter
Definition1
Path and file name to be located
Format: script literal or script variable
The wildcard characters "*" and "?" can be used in file names. "*" stands for any character, "?" for exactly one. Paths must not contain wildcard characters.
Whether uppercase and lowercase letters are considered depends on the parameter Wildcards.
Indicator showing if the file name was specified with wildcard characters
Format: script literal or script variable
Allowed values: "Y" (default value) and "N"
"Y" = File name with wildcard characters; upper- and lower-case letters are not distinguished
"N" = File name without wildcard characters; upper- and lower-case letters are distinguished
Indicator if subfolders or subdirectories should be included in the search.
Format: script literal or script variable
Allowed value: "Y" and "N" (default value)
"Y" = Subfolders or subdirectories
"N" = Subfolders or subdirectories not considered
Additional possibility for filtering the lines of the data sequence
Format: script literal or script variable
Case-insensitive; upper or lower-case writing is acceptable. The wildcard characters "*" and "?" can be used. "*" stands for any character, "?" for exactly one. Default: "*"
Specifies, if the lines of the data sequence should be divided into columns
Format: script literal or script variable
Allowed values: "NONE" (default value), "LENGTH", "DELIMITER"
"NONE" = No columns
"LENGTH" = Specified size of the column. Requires LENGTH_TAB= as
Definition2
"DELIMITER" = Columns are divided by delimiters. Requires DELIMITER= as Definition2
Automation Engine 287
Definition2
Login object
Fixes column widths and names (optional) or the delimiter
Format: script literal or script variable
Allowed values: "LENGTH_TAB" and "DELIMITER" l
"LENGTH_TAB"
Column sizes and names (optional) are specified in the form Column
size=[Column name]. The column size is defined through a number of characters. The individual columns are separated by commas
(maximum 22 columns). Quotations must additionally be set before the first and after the last column definition. If double quotations are used for Definition2 as script literal, single quotations must be used for specification or vice versa.
Example:
"COL=LENGTH,LENGTH_TAB='3=drive,100=file name'" l
"DELIMITER"
The delimiter is specified in the form *Delimiter*.
"*" = freely defined delimiter
= String of not more than 10 characters which separates the columns.
If single quotations are used as Delimiters, the whole phrase
COL=Definition1[,Definition2] must be enclosed in double quotations and vice versa.
Default value: Semicolon (;)
Example:
"COL=DELIMITER,DELIMITER=*'*"
'COL=DELIMITER,DELIMITER=@"@'
Name of a Login object
Format: script literal or script variable
Place the complete phrase UC_LOGIN=Login object in inverted commas.
Return code
Reference to a data sequence of the filelist
Comments
The script function PREP_PROCESS_FILENAME provides a list of file names for further processing with
UC4 Script. On the host, the files are retrieved by the Agent and processed as a data sequence.
The parameter File name is used to call the files that are to be listed. If File name contains a drive indication, all found files are displayed in the same way. You can specify whether subfolders or subdirectories should be considered. Filtering the list of found files is also possible.
Wildcards, Subfolders, Filters and the parameters for dividing columns are optional. Use a comma to indicate that one of the parameters is not used. Any of the optional parameters can be used as the last
288 Chapter 3 Ordered by Function parameter. Ensure that no comma is used after the last parameter. Definition2 cannot be used without
Definition1.
By default, the script function
reads all lines of a data sequence. Structured access is also possible when the lines are divided in columns. The following rules apply: l l l maximal 22 columns with total size of 2048 bytes column width maximal 255 characters and column name maximal of 32 characters
GET_PROCESS_LINE can be used to access particular columns.
With the optional parameter UC_LOGIN, the name of a Login object can be assigned to the script function. PREP_PROCESS_FILENAME uses the login data that have been defined in the Login object.
This facilitates access to connected network drives, for example. Users require the Privilege "File transfer:
Start without user ID" if the script function PREP_PROCESS_FILENAME should be used without the parameter UC_LOGIN.
The return code of the script function is the reference to this data sequence. It is given to the script statements
and
as start parameters. In combination with the script function
GET_PROCESS_LINE , each individual line of the data sequence and its columns can now be processed.
No error occurs if the data sequence does not contain the required content. The processing of the data sequence that is defined between :PROCESS and :ENDPROCESS does just not take place.
No new value can be assigned to the script variable containing the data sequence reference. The data sequence must be discarded with the script statement
first and then the variable can be re-used.
Agents for applications (Oracle Applications, PeopleSoft or SAP) do not support PREP_PROCESS_
FILENAME.
The script statement causes all open
of the script to be written to the UC4 Database.
Examples
The example lists all HTML documents from the WebHelp of the UC4 Documentation. It is explicitly specified that wildcard characters are used. The result is written to the activation report.
: SET &HND# = PREP_PROCESS_FILENAME
( "WIN01" , "c:\uc4\documentation\webhelp\english\uc*.htm" , "Y" ,,,, "UC_
LOGIN=WIN_LOGIN" )
: PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE ( &HND# )
: PRINT &LINE#
: ENDPROCESS
The second example creates a list of all style sheets that are supplied with the UC4 Documentation. All subfolders of the documentation directory should be searched. The result contains no drive specification and is written to the report.
: SET &HND# = PREP_PROCESS_FILENAME ( "WIN01" ,
"\uc4\documentation\uc*.css" , "Y" , "Y" ,)
: PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE ( &HND# )
: PRINT &LINE#
: ENDPROCESS
Automation Engine 289
In the third example, a list of all UC4 programs is created. The individual lines are divided in columns. The columns are separated by backslashes. The 5th column which contains the file name of the program is accessed during data sequence processing. The result is written to the activation protocol.
: SET &HND# = PREP_PROCESS_FILENAME
( "WIN01" , "c:\uc4\server\bin\*.exe" ,,,, "COL=DELIMITER , DELIMITER=*\*" )
: PROCESS &HND
: SET &LINE# = GET_PROCESS_LINE ( &HND# ,5)
: PRINT &LINE#
: ENDPROCESS
The fourth example is based on the third example. Here, a filter is set so that only the file name of the UC4
Automation Engine is written to the activation protocol.
: SET &HND# = PREP_PROCESS_FILENAME
(
"WIN01"
, "c:\uc4\server\bin\*.exe" ,,, "*server*" , "COL=DELIMITER , DELIMITER=*\*" )
: PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE ( &HND# ,5)
: PRINT &LINE#
: ENDPROCESS
See also:
Script element
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Discards an unnecessary data sequence
Loop for line by line processing of a data sequence - a sequential file or a command result, for example
This is used to retrieve content from the current line of a data sequence.
3.9.12 PREP_PROCESS_REPORT
Script Function: It uses filter criteria in order to retrieve the report lines of executable objects and provides the result for further processing in the form of an internal list (data sequence).
Syntax
PREP_PROCESS_REPORT
(
[Object type]
,
[RunID]
,
[Report type] [,Filter] [,"COL=Definition1]
[,Definition2]"
)
Syntax Description/Format
290 Chapter 3 Ordered by Function
Object type
The short form of the object type that belongs to the executable objects. You can also edit the client in which this script function is used. The short form is
CLT in this case.
Format:
RunID
Report type
Filter
Definition1
This is an optional parameter because the object type can be clearly assigned through its RunID (compatible to version 2.6xx).
The RunID of the task whose report should be processed.
Format: script variable or number
You can activate the Generate at runtime option in the Attributes tab if you want to analyze the report of a different task.
Client reports do not require a RunID in order to be specified.
The abbreviation for the report type.
Format: UC4 Name, script literal or script variable
The definition of a filter condition for the content of a line (case-insensitive).
For the filter definition, you can use the wildcard characters "*" and "?". "*" serves as a placeholder for any number of characters (even none) and "?" represents exactly one character. You can also use these wildcard characters repeatedly.
Format: script literal or script variable
Default value: *
This parameter determines whether the lines of the data sequence will be subdivided into columns.
Format: script literal or script variable
Allowed values: NONE(default value), LENGTH, DELIMITER
NONE = No subdivision
LENGTH = Pre-specified column size. Requires LENGTH_TAB= as
Definition2
DELIMITER = Column are separated by a delimiter. Requires DELIMITER= as Definition2
Automation Engine 291
Definition2
This parameter determines the column sizes and names (optional), or the delimiter.
Format: script literal or script variable
Allowed values: LENGTH_TAB and DELIMITER l
LENGTH_TAB
Column sizes and names (optional) are specified in the form Column
size=[Column name]. The column size is defined through a number of characters. The individual columns are separated by commas
(maximal 22 columns). Quotations must additionally be placed before the first and after the last column definition. If double quotations are used for Definition2 as script literal, single quotations must be used for specification or vice versa.
Examples:
"COL=LENGTH,LENGTH_TAB='3=drive,100=file name'" l
DELIMITER
The delimiter is specified in the form *Delimiter*.
"*" = freely defined delimiter
Delimiter = String of maximum 10 characters which separates the columns. If a single quotation is used as Delimiter, the whole phrase
COL=Definition1[,Definition2] must be enclosed in double quotations and vice versa.
Default value: Semi colon (;)
Examples:
"COL=DELIMITER,DELIMITER=*'*"
'COL=DELIMITER,DELIMITER=@"@'
Return Code
Reference to the data sequence of the report
Comments
This script function provides the report contents of executable objects for further processing with UC4
Script. The report is read from the UC4 database and prepared as data sequence.
If you access a task's report by using this Script function, the parameters RunID and Report Type can be omitted because the script function itself retrieves the RunID. Note that you must set the comma that belongs to the parameter. By default, the job report (REP) is used for jobs and the activation report (ACT) for other tasks.
The Job report of the task itself can be analyzed in the
Post Process
tab. Depending on the result, the definitive end of the job can be specified using the script statement
The script function waits if a task is accessed that has already ended but whose report is still incomplete.
292 Chapter 3 Ordered by Function
By default, this script function reads the entire line of the report. Structured access is also possible provided that the line is subdivided into columns. The following rules apply: l l l maximal 22 columns with a total size of 2048 bytes column size maximal 255 characters and column name maximal 32 characters
GET_PROCESS_LINE can be used to access particular columns.
The report is saved in the same language in which the UC4 Automation Engine logging is made.
The return code of this script function is a data sequence reference. It is given to the script statements
and
as start parameters. In combination with the script function
PROCESS_LINE , each individual line of the data sequence and its columns can now be processed.
No error occurs if the data sequence does not contain the required content. The processing of the data sequence that is defined between :PROCESS and :ENDPROCESS does just not take place.
No new value can be assigned to the script variable containing the data sequence reference. The data sequence must be discarded with the script statement
first and then the variable can be re-used.
The script statement causes all the script's open
to be written to the UC4 Database.
Examples
The first example searches for all lines of a Job report in which the drive C: appears. All lines are output in the activation protocol.
:
:
: SET &HND# = PREP_PROCESS_REPORT ( "JOBS" ,, "REP" , "*C:\*" )
: PROCESS &HND#
SET &RET#
: ENDPROCESS
=
&RET#
GET_PROCESS_LINE ( &HND# )
The second example is based on a Job which requested file names for processing from the user. The file names are stored in the activation report. The file names can be read if a quotation is used as a delimiter.
They are output in the activation protocol.
: SET &RUNNR# = GET_UC_OBJECT_NR ( "MM.DAY" )
: SET &HND# = PREP_PROCESS_REPORT (, &RUNNR# , "ACT" ,, "COL=DELIMITER ,
DELIMITER=*'*" )
: PROCESS &HND#
: SET &RET# = GET_PROCESS_LINE ( &HND# ,1)
: PRINT &RET#
: ENDPROCESS
In the third example, a Job's report is analyzed in its Post Process tab. This allows you to find out whether an error occurred while a file was copied under Windows. You can easily call the script function by using the Filter parameter. The preceding commas stand for the object type, the RunID and the report type JJR1 of the task itself.
: SET &HND# = PREP_PROCESS_REPORT (,,, "*file not found*" )
: PROCESS &HND#
:
:
SEND_MSG
: ENDPROCESS
BU,BU,
MODIFY_STATE
"Error occurred while copying."
RETCODE=50
Automation Engine 293
See also:
Script Element
Description
Discards an unnecessary data sequence.
Loop for line by line processing of a data sequence - a sequential file or a command result, for example
This is used to retrieve content from the current line of a data sequence.
Script Elements - Data Sequences
Sample Collection
Setting End Status depending on Report Content
Calling an MBean
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.9.13 PREP_PROCESS_REPORTLIST
Script function: Retrieves the list of registered output of Jobs that have already run and makes the result available as an internal list (data sequence) for further processing.
Syntax
PREP_PROCESS_REPORTLIST
(
[RunID][, Filter]
)
Syntax
RunID
Description/Format
RunID of a Job that has already run and whose registered output (internal report plus Job output files) should be retrieved.
Format:
Filters
The script element refers to its own object if this parameter is not specified.
This script element should only be used in the Post Process tab as otherwise it is not possible to retrieve all Job output data.
Filters for the name of a Job output file.
The wildcard characters * (placeholder for any number of characters) and ?
(placeholder for exactly one character) can be used several times.
Format: script variable or script literal
Return code
Reference to the data sequence of the Job output list.
294 Chapter 3 Ordered by Function
Comments
This script function retrieves the list of registered Job output that is available in the Directory tab of the report dialog. This includes the external files and the default reports.
The return code of this script function is a data sequence reference. It can be assigned to the script statements
and
as a start parameter, thereby creating a loop. The number of loops corresponds to the number of Job output entries. The script function
can be used to access the individual columns (altogether eight) of each line.
No new value can be assigned to the script variable containing the data sequence reference. The data sequence must be discarded with the script statement
first and then the variable can be re-used.
All Job output files are used if the Filter parameter is not specified (corresponds to Filter = *).
The following columns of each entry can be read:
4
5
Column number
1
Value
Report type (such as ACT, REP, REV01 etc.)
External Job output files are named as follows: l l
$NNN - Statically registered files ( Output tab )
#NNN - Dynamically registered files (script element
2
3
6
7
8
NNN - three-digit sequential number
Point in time at which creation of the Job output started.
Format: YYYY-MM-DD HH:MM:SS
Point in time at which creation of the Job output ended.
Format: YYYY-MM-DD HH:MM:SS
Title (only for SAP Jobs)
Is it an XML report? (Only for SAP Jobs)
Possible values:
"0" - No
"1" - Yes
Full path and name of the external Job output file or the Job report (report type = REP). In default reports (such as ACT), this column is empty.
Job output is on the Agent?
Possible values:
"0" - No
"1" - Yes
Is the Job output stored in the UC4 Database?
Possible values:
"0" - No
"1" - Yes
Automation Engine 295
Example 1
The first simple example reads the output file names and paths of the last execution of the Job
JOBS.WIN.OUTPUT and writes them to the activation report.
: SET &RUNID# = GET_STATISTIC_DETAIL (,RUNID,JOBS.WIN.OUTPUT)
: SET &HND# = PREP_PROCESS_REPORTLIST ( &RUNID# )
: PROCESS &HND#
: SET &FILENAME# = GET_PROCESS_LINE ( &HND# , 6)
: IF &FILENAME# = ""
: ELSE
: PRINT "File name = &FILENAME#"
: ENDIF
: ENDPROCESS
Example 2
In the following example, a Windows Job generates two files and registers them as Job output. The following lines are included in the Job's Process tab: dir C:\temp >> C:\temp\test.txt
: REGISTER_OUTPUTFILE "C:\temp\test.txt" , "N" dir C:\windows >> C:\temp\test2.txt
: REGISTER_OUTPUTFILE "C:\temp\test2.txt" , "N"
The Job's "Post Process" includes the script element PREP_PROCESS_REPORTLIST which queries the complete Job output list and writes the individual columns of each line to the Job log with a process loop. A FileTransfer starts for each external output file and transfers this file to a different computer. The
Agent, Job login and the file's complete path are passed on to the FileTransfer object.
: PSET &AGENT_JOB# = GET_ATT (HOST)
: PSET &LOGIN_JOB# = GET_ATT (LOGIN)
: SET &HND# = PREP_PROCESS_REPORTLIST ()
: PROCESS &HND#
: SET &RH_TYPE# = GET_PROCESS_LINE ( &HND# , 1)
: SET &START_TIME# = GET_PROCESS_LINE ( &HND# , 2)
: SET &END_TIME# = GET_PROCESS_LINE ( &HND# , 3)
: SET &TITLE# = GET_PROCESS_LINE ( &HND# , 4)
: SET &IS_XML# = GET_PROCESS_LINE ( &HND# , 5)
: SET &FILENAME# = GET_PROCESS_LINE ( &HND# , 6)
: SET &ON_AGENT# = GET_PROCESS_LINE ( &HND# , 7)
: SET &IN_DB# = GET_PROCESS_LINE ( &HND# , 8)
: PRINT "Report type = &RH_TYPE#"
: PRINT "Start = &START_TIME#"
: PRINT "End = &END_TIME#"
: PRINT "Title = &TITLE#"
: PRINT "XML report? = &IS_XML#"
: PRINT "File name = &FILENAME#"
: PRINT "On the Agent? = &ON_AGENT#"
: PRINT "In the database? = &IN_DB#"
: IF &FILENAME# = ""
: PRINT "No external output file"
: ELSE
: IF &ON_AGENT# = 1
: PSET &FT_FILE# = &FILENAME#
: SET &AKT# = ACTIVATE_UC_OBJECT (JOBF.OUTPUTHANDLING,,,,,PASS_VALUES,)
296 Chapter 3 Ordered by Function
: ENDIF
: ENDIF
: ENDPROCESS
The activating job's data is now specified as the source Agent and login in the script of the FileTransfer object. The path and name of the external Job output file are also set as the source file. For the destination, the name of the source file is used; the path is changed to "C:\output\".
: PUT_ATT FT_SRC_HOST = &AGENT_JOB#
: PUT_ATT FT_SRC_LOGIN = &LOGIN_JOB#
: PUT_ATT FT_SRC_FILE = &FT_FILE#
: SET &POS# = STR_FIND_REVERSE ( &FT_FILE# , "\" ) + 1
: SET &FNAME# = STR_CUT ( &FT_FILE# , &POS# )
: SET &DST_FILENAME# = STR_CAT ( "C:\output\" , &FNAME# )
: PUT_ATT FT_DST_FILE = &DST_FILENAME#
See also:
Script Element
Description
Uses filter criteria to retrieve the report lines of executable objects and provides the result as an internal list (data sequence) for further processing.
Definition of a loop for line-by-line processing of a data sequence such as the content of a sequential file or the text result of a command, for example.
This is used to retrieve content from the current line of a data sequence.
Script Elements - Data Sequences
Sample Collection
Setting an End Status Depending on the Report Content
Calling an MBean
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.9.14 PREP_PROCESS_VAR
Script Function: Uses selection criteria in order to retrieve a list of Variable object values and provides the result for further processing in the form of an internal list (data sequence).
Syntax
PREP_PROCESS_VAR
(Variable
[,Key [,Value [, Column]]]
)
Syntax
Variable
Automation Engine 297
Description/Format
The name of the Variable object that should be processed.
Format:
Key
Value
Column
The filter for the Key column.
Format: script literal or Script variable you can use a maximum of 64 characters.
Default value: "*"
In dynamic variables, the Key column corresponds to the first basic column (value column). The Result column is build only after retrieving the
Variable values.
The wildcard characters "*" and "?" can be used. "*" stands for any character,
"?" for exactly one.
The filter for the value.
Format: script literal or Script variable
You can use a maximum of 64 characters.
Default value: "*"
The wildcard characters "*" and "?" can be used. "*" stands for any character,
"?" for exactly one.
The filter for a Variable object's particular value column.
Format: script literal, script variable or number without inverted commas.
Wildcard characters must not be used.
Allowed values:
Statistic Variables: "1" to "5"
Dynamic Variables: "1" to n
If you want to filter for the value alone, you must also set the previous comma.
For example:
: SET &HND# = PREP_PROCESS_VAR
( "DB.MAINTENANCE" ,, "CLIENT" , 1)
Return code
Reference to the data sequence of the Variable object.
Comments
This script function reads the values of a Variable object. You can limit the values that should be read by using the optional parameters Key and Value. You can also use the wildcard characters "*" and "?" in these parameters. The input is case sensitive.
Value refers to the content of a value column. Column determines the number of the particular value column that should be searched. The first value column is automatically used if you do not define a
298 Chapter 3 Ordered by Function column. Static Variables include 5 value columns. The column number of dynamic Variables is not limited and depends on the data source and the settings that are defined in the Variable object.
The parameter Column can only be used in combination with Value. Any column specification is invalid if you do not specify the filter Value.
You cannot select particular columns. Each selected Variable entry that is returned includes the values of all columns (including the Key or Result column).
Note that you cannot use wildcard characters in Value if the Variable is a"Number" data type. This script function either returns all entries or those that show exactly the specified value.
Using an empty string ("") as a filter specification has the same effect as using "*". All values are returned.
All the Variable object's entries are used if you do not specify Key and Value.
The return code of this script function is a data sequence reference. It is passed on to the script statements
and
as a start parameter. If you use it in combination with the script function
, you can now access each of the Variable object's individual lines.
No error message is output if the Variable object does not include the searched values. The data sequence that is defined between :PROCESS and :ENDPROCESS is not processed in this case.
Names of VARA objects that include a variable must be specified in quotation marks. Otherwise, an error message is output.
No new value can be assigned to the script variable that includes the data sequence reference. The data sequence must be discarded by using the script statement
, and then the variable can be re-used.
Note for SQL variables (SQL, SQLI): The number of lines that are returned with the setting SQLVAR_
MAX_ROWS (UC_SYSTEM_SETTINGS) is limited. For example, when you specify the value 1000, the system will only return the first 1000 lines.
You can limit the returned lines with the Key but not with the specified Value. This means that when you define a filter for a certain Value in combination with the script element PREP_PROCESS_
VAR, the system will only search for this value within the defined maximum number of lines. However, when you define a Key, it will be passed on to the database and used for the query. Therefore, Automic recommends filtering by using the Key instead of the Value when you have tables that include many entries as otherwise, you might risk that no entries are returned.
Examples
The following Variable object is used for the examples that are shown below:
Automation Engine 299
Example 1 retrieves all values and within the process loop, it prints it to the activation protocol using the script statement :PRINT.
: SET &HND# = PREP_PROCESS_VAR (DATABASE_MAINTENANCE)
: PROCESS &HND#
: SET &VK# = GET_PROCESS_LINE ( &HND# ,1)
:
:
SET &VALUE#
: ENDPROCESS
= GET_PROCESS_LINE
"&VK# &VALUE#"
( &HND# ,2)
: CLOSE_PROCESS &HND#
Example 2 only reads the entries whose keys start with "client".
:
:
: SET &HND# = PREP_PROCESS_VAR (DATABASE_MAINTENANCE, "Client*" )
: PROCESS &HND#
SET
SET
&VK# =
&VALUE#
GET_PROCESS_LINE
=
( &HND#
GET_PROCESS_LINE (
,1)
&HND# ,2)
: PRINT "&VK# &VALUE#"
: ENDPROCESS
: CLOSE_PROCESS &HND#
See also:
Script element
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Discards an unnecessary data sequence.
Loop for the line-by-line processing of a data sequence such as a sequential file or a command result.
This is used to retrieve content from the current line of a data sequence.
300 Chapter 3 Ordered by Function
3.9.15 PUT_PROCESS_LINE
Script function: Adds a line to a specific data sequence
Syntax
PUT_PROCESS_LINE
(Data sequence reference, Line
[ , Delimiter ]
)
Syntax
Data sequence reference
Line
Delimiter
Description/Format
Reference to the data sequence to which a line should be added.
Format:
Line that should be added to the data sequence
Format: Script variable or script literal
You can also specify a script array.
Arbitrary character that splits up the specified line to columns.
Format: Script variable or script literal
If an array has been specified for line, this parameter has no function
Return code
"0" - Data sequence was succesfully extended by the specified line.
Comments
This script function adds a line to a data sequence. The data sequence is changed directly - the return code only indicates if the procedure ends successful. Specify the reference to the data sequence and the line that should be added.
Data sequences can be created with the script element
CREATE_PROCESS or with the PREP_
PROCESS* functions.
Make sure that you specify a data sequence that exists or has not been closed with
PROCESS . Otherwise, a runtime error will occur. You cannot use this script function to create a new
data sequence.
The line that should be added can be specified either as a string (script literal or script variable) or as script array (script variable). If you use a string, a delimiter can be specified to split it into clumns. If no delimiter is used, the line consists of only one column that contains the whole string.
If you specify a script array its splitted automatically into columns according to its elements. Note that the empty array elements at the end are ignored.
Examples
Following Example creates a data sequence which contains a file list. Then a file name is retrived from a
Variable object and added to the data sequence.
: SET &HND# = PREP_PROCESS_FILENAME ( "WIN01" , "C:\uc4\temp\test*.txt" , "Y" ,,)
: SET &LINE# = GET_VAR (VARA.FILELIST)
: SET &RET# = PUT_PROCESS_LINE ( &HND# , &LINE# )
Automation Engine 301
See also:
Script element
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Discards an unnecessary data sequence.
Loop for line by line processing of a data sequence - a sequential file or a command result, for example.
Creates a new data sequence.
Returns the content of the current line of a data sequence.
3.9.16 SAVE_PROCESS
Script Function: Stores a certain data sequence.
Syntax
SAVE_PROCESS
(Data sequence reference)
Syntax
Data sequence
Description/Format
The reference to the data sequence that should be stored.
Format:
Return Code
The term under which the data sequence is stored.
Comments
This script function stores a certain data sequence for the activity in the UC4 Database. This ensures that other tasks can access this data sequence.
The return code is a term that is composed of the name of the data sequence's reference. To use stored data sequences in other tasks, you must load them with the script element
by specifying this term.
You can load stored data sequences as often as you like from any tasks of your choice.
Note that SAVE_PROCESS stores the data sequence but it does not close it. This means that you still need to use the script element
The data sequences remain available until the statistical records of the tasks that have been used to store them will be reorganized.
302 Chapter 3 Ordered by Function
Examples
The two Script objects SCRI.TEST.DS1 and SCRI.TEST.DS2 will be processed in a Workflow one after the other.
The first task SCRI.TEST.DS1 creates a new data sequence and stores it to the UC4 Database. The
RunID of the task and the internal name of the stored data sequence are made available to the Workflow by using object variables. Finally, the data sequence is closed by using the following script:
: SET &HND# = PREP_PROCESS_VAR (VARA.DB)
: PSET &HND_KEY# = SAVE_PROCESS ( &HND# )
: PSET &RUNID# = SYS_ACT_ME_NR ()
: CLOSE_PROCESS &HND#
The second task SCRI.TEST.DS2 inherits the Workflow's object variables. This information is used to load the data sequence, read its content and write it to the activation protocol.
: SET &HND# = LOAD_PROCESS ( &RUNID# , &HND_KEY# )
: PROCESS &HND#
: SET &LINE# = GET_PROCESS_LINE ( &HND# ,2)
: P &LINE#
: ENDPROCESS
: CLOSE_PROCESS &HND#
See also:
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.
Creates a new data sequence.
Returns the content of the current line of a data sequence.
Loads a stored data sequence.
Script Elements - Data Sequences
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 303
3.10 Event Handling
3.10.1 GET_CONSOLE, GET_EVENT_INFO
Script Function: Reads values of occurred Console, FileSystem and Database Events.
Syntax
GET_CONSOLE
(Keyword
[, Index]
)
GET_EVENT_INFO
(Keyword
[, Index]
)
Syntax
Keyword
Description/Format
Specifies the message part which should be read
Format:
Index
The table shown below explains the keywords for the individual platforms:
Can only be used in combination with the keyword INSERT, RESULT1 and
RESULT2.
Format:
script literal , number or script variable. Default value: 1
For INSERT:
Access to the 16-bit fields of an z/OS console message and access to the message text's variable part (insert) of an OS/400 message.
For RESULT1 and RESULT2:
Column number of the SQL query (Database Event)
Keywords
Keyword Cons ole
BS20
00
Cons ole z/OS
Cons ole
OS/4
00
Cons ole
SAP
(ABA
P)
Cons ole
SAP
(XI)
Cons ole
SAP
(Java)
Cons ole
Wind ows
File syst em
File system automati cally z/OS
Datab ase
304 Chapter 3 Ordered by Function
Automation Engine 305
306 Chapter 3 Ordered by Function
Note that the keys listed in the "FileSystem" column can only be used in FileSystem Events with the setting "Check" equals "FILE_SIZE" or "empty" (with or without a combination of "FILE_STABLE" or
"FILE_CHANGED") and "PATH_FILE_COUNT" (only in combination with "FILE_STABLE" or "FILE_
CHANGED").
Description
Keyword
ACCESS
ACTIVATIONSTATE
ALERT_OPTION
CATEGORY
CHANNEL
DDNAME
Description
File access
Allowed value:
"CLOSE" - closes the file
Adapter status
Allowed values: "STARTED" and "STOPPED"
Returns if and when an SNA alert is created and sent to the message
Allowed values:
"*DEFER" - An alert is sent after local problem analysis
"*IMMED" - An alert is sent immediately when the message is sent. For the message queue, the attribute permitting alerts must be set to "*YES"
"*NO" - No alert is sent
"*UNATTEND" - An alert is only sent if the system runs in non-monitored mode. The alarm status network attribute (ALRSTS) is "*UNATTEND".
Event category
Communication channel
DD description
Automation Engine 307
EVENT_
ADDITIONAL_PARM
EVENT_
COUNTOFJOBS
EVENT_GUID
EVENT_ID
EVENT_PARM
EVENT_
PROCESSSTATE
EVENT_SERVER
EVENT_STATE
EVENT_TYPE
FILENAME
FILESIZE
ID
INFO_ACTION
INFO_TEXT
INSERT
INSERT_COUNT
JOB_ABENDED
JOB_ENDED
JOB_ID
LPAR_NAME
JOB_NAME
MEMGEN
Additional parameters of SAP Java Scheduler Events
Number of triggered SAP jobs (ABAP)
SAP Event's instance number (ABAP)
Event ID (ABAP/Java Events)
SAP Event parameter (ABAP/Java Events)
SAP processing status (ABAP)
SAP Event server (ABAP)
SAP Event status (ABAP)
SAP Java Scheduler Event type
Name of the file
In File-System Events with wildcards, the following value is returned as a file name: l l
*ALL - If the option "Consider all files" has been activated.
*ONE - If the option "Consider all files" has been deactivated.
Size of the file
Message ID
Action
Allowed values: "Y" and "N"
"Y" - An object has been activated
"N" - No object has been activated
Name of the activated object
Accesses a certain variable part of a message together with Index
Determines the number of the message's variable part
End status of the job which closed the file
Allowed values: "Y" and "N"
"Y" - The Job ended abnormally
"N" - The Job ended normally
Status of the job which closed the file
Allowed values: "Y" and "N"
"Y" - The Job has already ended
"N" - The Job is still running
Identification name of the Job
Returns the LPAR name
Name of the job
Member name or generation number
308 Chapter 3 Ordered by Function
MSG_DESCRIPTOR Description of the message as a 16-bit field
Bit 01(corresponds to X'80') = SYSTEM_FAILURE - system failure
Bit 02 (corresponds to X'40') = IMMEDIATE_ACTION - immediate action required
Bit 03 (corresponds to X'20') = EVENTUAL_ACTION - eventual action required
Bit 04 (corresponds to X'10') = SYSTEM_STATUS - system status
Bit 05 (corresponds to X'08') = IMMEDIATE_COMMAND - immediate command response
Bit 06 (corresponds to X'04') = JOB_STATUS - job status
Bit 07 (corresponds to X'02') = APPLICATION - application program/processor
Bit 08 (corresponds to X'01') = OUT_OF_LINE - out of line
Bit 09 (corresponds to X'80') = OPERATOR_REQUEST - operator's request
Bit 10 (corresponds to X'40') = TRACK_COMMAND_R - track command response
Bit 11 (corresponds to X'20') = CRITICAL_ACTION - critical eventual action
Bit 12 (corresponds to X'10') = IMPORTANT_INFO - important information
Bit 13 (corresponds to X'08') = PREVIOUSLY_AUTO - previously automated
Bit 14 (corresponds to X'04') - reserved
Bit 15 (corresponds to X'02') - reserved
Bit 16 (corresponds to X'01') - reserved
MSG_FILE_LIBRARY Name of the library containing the message file or the values "*CURLIB" or
"*LIBL" used by the send program
MSG_FILENAME Name of the message file which contains the obtained message
MSG_ID
MSG_KEY
MSG_LEVEL
Message key of the of the obtained message
This field is left blank if an improvised message is obtained
Message key of the obtained message
Four-figure value in hexadecimal format X'xxxxxxxx'
Urgency level of the message (16-bit field).
MSG_LIBRARY_
USED
Bit 01(corresponds to X'80') = WTOR - WTOR
Bit 02 (corresponds to X'40') = IMMEDIATE_ACTION - immediate action
Bit 03 (corresponds to X'20') = CRITICAL_ACTION - critical eventual action
Bit 04 (corresponds to X'10') = EVENTUAL_ACTION - eventual action required
Bit 05 (corresponds to X'08') = INFO - informational
Bit 06 (corresponds to X'04') = BROADCAST
Bit 07 (corresponds to X'02') - reserved
Bit 08 (corresponds to X'01') - reserved
Bit 09 (corresponds to X'80') - reserved
Bit 10 (corresponds to X'40') - reserved
Bit 11 (corresponds to X'20') - reserved
Bit 12 (corresponds to X'10') - reserved
Bit 13 (corresponds to X'08') - reserved
Bit 14 (corresponds to X'04') - reserved
Bit 15 (corresponds to X'02') - reserved
Bit 16 (corresponds to X'01') - reserved
Real name of the library which is used to send the message
The library can contain overriding instructions. Thus, this is not necessarily the library in which the message is actually stored
Automation Engine 309
MSG_MISC
MSG_SEVERITY
Miscellaneous message information (16-bit field).
Bit 01(corresponds to X'80') = DISPLAY_UD_MSG - display UD messages
Bit 02 (corresponds to X'40') = DISPLAY_ONLY_UD_MSG - display only
UD messages
Bit 03 (corresponds to X'20') = QUEUE_BY_ID_ONLY - queue by id only
Bit 04 (corresponds to X'10') = QUEUE_BY_AUTO - queue by automation
Bit 05 (corresponds to X'08') = QUEUE_BY_HARDCOPY - queue by hard copy
Bit 06 (corresponds to X'04') - reserved
Bit 07 (corresponds to X'02') - reserved
Bit 08 (corresponds to X'01') - reserved
Bit 09 (corresponds to X'80') = ECHO_OPERATOR_CMD - echo operator command
Bit 10 (corresponds to X'40') = ECHO_INTERNAL_CMD - echo internal command
Bit 11 (corresponds to X'20') = RESULT_OF_WTL_MACRO - result of wtl macro
Bit 12 (corresponds to X'10') - reserved
Bit 13 (corresponds to X'08') - reserved
Bit 14 (corresponds to X'04') - reserved
Bit 15 (corresponds to X'02') - reserved
Bit 16 (corresponds to X'01') - reserved
Severity of the obtained message
Allowed values: "0" to "99"
MSG_TEXT
MSGNR
Message text (default value)
Message number
MSGTYPE, MSGTYP Message type
OS_NAME
PARTY
Allowed values especially for OS/400:
"01" - Completion
"02" - Diagnostic
"04" - Informational
"05" - Inquiry
"06" - Sender's copy
"08" - Request
"10" - Request with prompting
"14" - Notify (handled exception)
"15" - Escape (handled exception)
"16" - Notify (unhandled exception)
"17" - Escape (unhandled exception)
"21" - Reply, not validity checked
"22" - Reply, validity checked
"23" - Reply, message default used
"24" - Reply, system default used
"25" - Reply, from system reply list
Name of the operating system in the console message defined by IBM.
Currently always "MVS"
Partner
310 Chapter 3 Ordered by Function
PROCESSID
PROGRAM_NAME
REPLY_ID
RESULT
RESULT1
RESULT2
Task number (TSN) in the console message
Program description
Reply ID of the console message.
Indicates whether the conditions of FileSystem Events with the checks
FILESIZE or PATH_FILE_COUNT were fulfilled.
Allowed values: "Y" and "N"
"Y" - The condition was fulfilled
"N" -The condition was not fulfilled
RESULT1 allows access to the SQL query result for "Value 1", RESULT2 to the result for "Value 2".
In index specify the column number whose value should be read.
Note that a Database Event only reads the first 10 columns. Columns contents exceeding 255 characters are truncated.
RETCODE
RETCODE_STATE
The script function supplies the value " " if an attempt is made to access a non-existing column.
Return code of the Job in converted format
Filter specification for the return code
SEND_JOB
Allowed values: "Y" and "N"
"Y" - A filter has been set for the return code
"N" - The return code is not relevant for Event triggering
Name of the job in which the received message was sent
SEND_JOB_NUMBER Job number of the job which the received message was sent
Name of the user profile which sent the received message SEND_USER_
PROFILE
SERVICE
SMS_
MANAGEMENT_
CLASS
SMS_DATA_CLASS
SMS_STORAGE_
CLASS
SOURCE
STATE
Service
Name of the class
Source of the Event
Status
STEP_NAME
SYS_NAME
Allowed values:
"*"
"ERROR"
"OK"
"INACTIVE"
"UNKNOWN"
"UNREGISTERED"
Name of the job step
User-defined system name
Automation Engine 311
SYSPLEX_NAME
TIMESTAMP
TYPE
USER
SYSPLEX name
Date and time of the console message
Type of the Event
Allowed values:
"I" - information
"W" - warning
"E" - error
"S" - success audit
"F" - failure audit
User
Comments
The script elements GET_CONSOLE and GET_EVENT_INFO can be used to retrieve information about an occurred event. They have the same syntax.
With the script function GET_CONSOLE, message data can be retrieved when console events occur.
This data consists of defined components of the console message, which can be specified with keyword.
By default, this function returns the message text.
This script function can be used in the Event-type "Console". The console message can be read with this in BS2000 and in z/OS. In OS/400, this script function is used to receive information from a message queue. The message queue to be monitored can be specified in the INI file of the OS/400 Agent.
GET_EVENT_INFO can be used to read information in the scripts of File System Events. Especially z/OS provides several keywords.
Platform Specific Features z/OS
The keywords MSG_DESCRIPTOR, MSG_LEVEL and MSG_MISC represent special features. They are
16-bit fields of which each individual bit has a specific meaning. Each individual bit can be queried with this script function. This can be done by giving the bit a value or a constant with Index. The value returned by this script function is "1" (bit is set) or "0" (bit is not set).
OS/400
With INSERT_COUNT as the keyword, you can establish the number of variable parts of a message in a
OS/400 message. With INSERT as the keyword and by specifying the Index, a specific variable part of a message can be accessed. Without Index ,the function returns the first variable part of the message.
Examples
The function GET_CONSOLE is used to retrieve the TSN of the process which triggered the Event.
: GET_CONSOLE (PROCESSID)
In the second example, first the number of the variable part of the message of a OS/400 message is determined. Then, a process loop runs in which all inserts are written in the activation report.
312 Chapter 3 Ordered by Function
: SET &COUNT# = GET_CONSOLE ( "INSERT_COUNT" )
: SET &IDX# = 1
: WHILE &COUNT# > 0
: SET &INSERT# = GET_CONSOLE ( "INSERT" , &IDX# )
:
:
:
:
SET
SET
SET
&HELP#
&IDX#
: ENDWHILE
=
&COUNT#
= FORMAT
ADD
=
(
( &IDX#
&IDX#
SUB (
, 1)
&COUNT#
, "000"
, 1)
)
"INSERT[&HELP#] = '&INSERT#'"
The following lines are logged in the activation report:
20010110/235011.000 - U0020408 INSERT[001] = 'QPFRMON'
20010110/235011.000 - U0020408 INSERT[002] = 'QPGMR'
20010110/235011.000 - U0020408 INSERT[003] = '007982'
20010110/235011.000 - U0020408 INSERT[004] = '23:48:43'
20010110/235011.000 - U0020408 INSERT[005] = '10/01/01'
20010110/235011.000 - U0020408 INSERT[006] = '0'
In the third example, a component of the console message in z/OS is requested. Bit 03 of the keyword
MSG_DESCRIPTOR is accessed. Bit 03 is given either as a value or a constant.
: SET &RET# = GET_CONSOLE ( "MSG_DESCRIPTOR" , 3)
: SET &RET# = GET_CONSOLE ( "MSG_DESCRIPTOR" , "EVENTUAL_ACTION" )
The following example shows a script excerpt which retrieves the file name and reads the file content line by line.
: SET &FILE NAME# = GET_EVENT_INFO (FILENAME)
: SET &HND# = PREP_PROCESS_FILE ( "MVSHOST" , &FILE_NAME# )
The fifth example reads the values of an SQL query (for "Value 1") in a Database Event.
SQL results:
Location
Seattle
Last name
Smith
First name
John
The first name is retrieved as shown below:
: SET &First name# = GET_EVENT_INFO (RESULT1, 2)
The following line supplies the location:
: SET &Location# = GET_EVENT_INFO (RESULT1, 3)
See also:
Script element
Script Elements - Event Handling
Sample Collection
Reaction to External Events
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Checks if a bit is set in a bit field
Automation Engine 313
3.10.2 GET_FILESYSTEM
Script Function: It retrieves several file-system values from a computer starting at a defined path.
Syntax
GET_FILESYSTEM
(
[Host]
,
[Path]
,FileSystem Value
[,Unit][,include sub-directories]
)
Syntax
Host
Description/Format
The name of the agent that runs on the computer of which the information should be retrieved.
Format:
.
The agent that has last been used with the script function GET_FILESYSTEM is used if no host name is specified. The values that have been retrieved with the last call are used.
314 Chapter 3 Ordered by Function
Path
The description of files or file systems for which information should be supplied.
Files, drives, volumes, paths, Generation Data
Groups etc. can be named here, depending on the respective system. The wildcard characters "*" or "?" can be used. "*" indicates any number of characters,
"?" stands for exactly one character.
Note that Windows only allows using the wildcard characters "*" and "?" for the file names. You cannot use them for directories within the path.
The characters * and ? are always used as wildcard characters. Note that you cannot use them to define specific files that include these characters in their names.
Format: UC4 Name, script literal or script variable.
The path name last used with the script function
GET_FILESYSTEM is used if no path name is specified. The values retrieved with the last call are used.
End path specifications on Windows with a "\*".
Doing so guarantees that the script functions for error handling can
send an error message if the path does not exist.
Examples:
C:\UC4\*
The prefix "VOL=" is required if one or more volumes are indicated.
Examples: "VOL=ALG*1" supplies information about all volumes starting with the letters "ALG" and ending on "1". Any number of characters can come in between. In our example, we are limited to 4 characters of your choice because the complete name of a volume consists of 8 characters.
For naming Generation Data Groups , you must enclose the wildcard character "*" in parentheses.
Automation Engine 315
File System Value
Unit
Include sub-directories
The following information can be retrieved using this script function:
PATH_SPACE_ALLOCATED - The allocated memory or hard drive space.
PATH_SPACE_RELEASE - The releasable memory
(BS2000 only).
PATH_SPACE_USED - The sum of file sizes in the in the specified path.
PATH_SPACE_UNUSED - the unused memory or hard drive space (BS2000 only).
PATH_FILE_COUNT - The number of files.
PATH_FOLDER_COUNT - The number of folders
(Windows and UNIX only).
FILESYSTEM_SPACE_TOTAL - The total memory of the hard drive (Windows only).
FILESYSTEM_SPACE_USED - Used memory
(Windows only).
FILESYSTEM_SPACE_FREE - Free memory of the volume (z/OS) or drive (Windows).
Format: UC4 Name, script literal or script variable
You can specify the form in which a file-system value should be returned.
Without a definition of Unit, the return code is determined by the host (default). A BS2000 computer returns the value "1" for 1 PAM page, for example.
This corresponds to 2048 bytes.
With a definition of Unit, the return code is converted as specified.
Permitted values: "Bytes", "KB", "MB", "GB" or "TB".
Format: UC4 Name, script literal or script variable
The default value is used if an invalid unit has been specified. Thus, the script function does not abort if you use
The specification whether the sub-directories of the specified path should be searched.
Allowed values: "Y" (default) and "N"
This parameter is only effective for VMS, UNIX and
Windows agents.
Note that activating this option affects the performance of your UC4 system.
Return codes
Result of the searched file-system value.
"0" - An error occurred while retrieving the file-system value (exception: PATH_FILE_COUNT, see below)
316 Chapter 3 Ordered by Function
Comments
This script element can only be used with OS agents (Windows, UNIX, VMS, z/OS, OS/400, NSK and
BS2000).
The return code of this function is zero if an error occurs while accessing information about the file system
(such as path not found).
The reaction to this error can be determined using the script statement
:ON_ERROR . Error analysis is still
possible with the
Script Functions for Error Handling . Script processing is continued but it can also be
canceled.
If you use this script function with PATH_FILE_COUNT, it can return 0 when the directory contains no files. Therefore, additionally use the script functions for error handling (such as SYS_LAST_ERR_
NR). Errors (such as host is not active) can so be detected and it is possible to distinguish whether return code 0 refers to the file number or an error.
Missing access rights to system folders (System Volume Information, Windows) also result in return code 0.
This script statement causes all open
of the script to be written to the UC4 Database.
Optional parameters Host and Path
Example 1:
GET_FILESYSTEM can be used in the Process tabs of all executable objects (such as wrkflows). Host and Path are always required when calling this script function. These parameters can only be omitted if
GET_FILESYSTEM was already called in the script. In such a case, the returned value remains the same as in the last call.
: SET &NumberFiles# = GET_FILESYSTEM (WIN01, "C:\Temp" , PATH_FILE_COUNT)
!several script lines
: SET &NumberFiles# = GET_FILESYSTEM (,, PATH_FILE_COUNT)
!several script lines
: SET &NumberFiles# = GET_FILESYSTEM (WIN01, "C:\Temp" , PATH_FILE_COUNT)
The first call for GET_FILESYSTEM supplies the number of files found in the directory C:\Temp (such as
50). If some of these files are now being deleted, this script function still supplies value 50. The third call finally re-calculates the file-system values and supplies a reduced number of files.
Example 2:
If an event of type file system occurs, the script function GET_FILESYSTEM can be used to retrieve information about the file system, memory and drive space. All information is transferred to the agent.
Each item can then be queried separately with the indication of the File System Value. In this case, the script function is called without the indication of Host and Path as these parameters have already been defined in the event's Detail tab.
OS/400: Peculiarities with file-system values
Always specify a library and a file in order to obtain valid file-system values.
z/OS: Peculiarities with file-system values
PATH_SPACE_ALLOCATED - The allotted disk space in z/OS cannot be retrieved. Returns used disk space.
PATH_SPACE_USED - Used disk space.
PATH_SPACE_UNUSED - It is always zero because the value is the difference between PATH_
SPACE_ALLOCATED and PATH_SPACE_USED.
Automation Engine 317
If a GDG name is indicated, this script function retrieves the following file-system values: PATH_SPACE_
USED and PATH_FILE_COUNT.
Peculiarities with file-system values BS2000 vs. other operating systems
Only in BS2000, allocated and used disk space can differ from each other. 1000 PAM pages can be reserved, for example. The actual file content can still only be 100 PAM pages.
The following applies for other operating systems such as UNIX, VMS and MPE:
PATH_FILE_COUNT - The number of files.
PATH_FOLDER_COUNT - The number of folders.
PATH_SPACE_USED - The sum of file sizes in the specified path.
PATH_SPACE_TOTAL - It supplies the same results as PATH_SPACE_USED and PATH_SPACE_
ALLOCATED.
Examples
In the following example, the script function GET_FILESYSTEM is used to retrieve the number of all existing files and to send a corresponding message. It is an abstract of an event's script which can be seen from the fact that the first two parameters are not specified.
: SET &NUMBER# = GET_FILESYSTEM (,,PATH_FILE_COUNT)
: SEND_MSG "BROWN" , "IT" , "&NUMBER# files are available for processing."
The next example uses the script function GET_FILESYSTEM in a Job's script. All available information about the drive is retrieved and written to the activation protocol.
: SET &E1# = GET_FILESYSTEM (WIN01, "E:\" ,FILESYSTEM_SPACE_TOTAL,MB)
: SET &E2# = GET_FILESYSTEM (,,FILESYSTEM_SPACE_USED,MB)
: SET &E3# = GET_FILESYSTEM (,,FILESYSTEM_SPACE_FREE,MB)
: PRINT "Memory capacity of the drive: &E1# MB"
: PRINT "Used drive space: &E2# MB"
: PRINT "Available space: &E3# MB"
The following examples show how the script function is used with GDG:
!Number of file generations of the group TEST.XXX
: SET &FILENAME# = GET_FILESYSTEM ( "MVSHOST" , "TEST.XXX(*)" , PATH_FILE_COUNT)
!Sum of the space used by the current generation
: SET &SPACE# = GET_FILESYSTEM ( "MVSHOST" , "TEST.XXX(0)" , PATH_SPACE_USED)
See also:
Script element Description
Determines the reaction to particular errors and messages of script elements.
Script Elements - Event Handling
Sample Collection:
Display with Cockpit
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
318 Chapter 3 Ordered by Function
3.10.3 GET_WIN_EVENT
Script Function: Determines entries in the Windows system, security and application logs if an Event occurs.
Syntax
GET_WIN_EVENT
(Keyword
[, Index]
)
Syntax
Keyword
Description/Format
Name of the field whose contents should be determined for this Event.
Format:
Index
.
CATEGORY - category of event
EVENT_ID - Event ID
INSERT - accesses one specific variable message part
INSERT_COUNT - determines the number of variable message parts
SOURCE - source of the Event
TIMESTAMP - date and time
TYPE - type of the Event
USER - user
Access to the variable message parts in the Description field of the Event details.
Format of Index:
Script literal , number or script variable. Default value: "1"
Can only be used in connection with the keyword INSERT (INSERT, Index).
Comments
This script function is used in a "Console" Event for Windows. With this event type the Windows event display can be monitored. This event occurs if an entry in the system, security or application protocol corresponds to the specifications made in the Detail tab. The processing steps from the ! Process tab are then processed. GET_WIN_EVENT in combination with a keyword can now be used to access specific information concerning this entry.
If TYPE is used as keyword, this script function supplies the following return codes: "I" for information,
"W" for warning, "E" for error, "S" for success audit and "F" for failure audit.
Message texts in Microsoft Windows consist of static and variable parts. This script function delivers only the variable message parts. With INSERT_COUNT being the keyword, the number of the variable message parts can be specified. With INSERT being the keyword and the specification of Index, a particular variable message part is accessed. Index can only be specified with INSERT (optionally).
Without Index, the function returns the first variable message part.
Automation Engine 319
Examples
In the example shown below, the first the number of the variable message parts in the "Description" field of the Event's details is determined. The number is stored in the script variable "&COUNT". Afterwards, a processing loop runs in which the second and third variable message part (keyword INSERT) are written to the activation report.
: SET &COUNT# = GET_WIN_EVENT ( "INSERT_COUNT ")
: SET &IDX# = 1
: WHILE &IDX# <= &COUNT#
: SET &INSERT# = GET_WIN_EVENT ( "INSERT ", &IDX# )
:
:
:
SET &HELP#
SET
: ENDWHILE
= FORMAT ( &IDX#
"INSERT[&HELP#] = '&INSERT#'"
&IDX# = ADD ( &IDX# , 1)
, "000" )
This could be the entire message of the Event's details: The user "00432233778822#0001" has established a connection with "T-Online" using the adapter "AVMISDN1". The variable message parts are logged to the activation report with the following lines:
20010117/193135.000 - U0020408 INSERT[002] = 'T-Online'
20010117/193135.000 - U0020408 INSERT[003] = 'AVMISDN1'
See also:
Script Elements - Event Handling
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.11 System Conditions and Settings
3.11.1 :DISCONNECT
Script statement: Disconnects a connection to the UC4 system
Syntax
:DISCONNECT
Connection, Name
Syntax
Connection
Name
Description/Format
Type of connection
Format:
or number
Allowed values: "USER", "HOST" and "HOSTGROUP"
"USER" = Connection of a User or UserGroup
"HOST" = Connection of an Agent
"HOSTGROUP" = Connection of Agents belonging to an AgentGroup
Name of a User, UserGroup, Agent or AgentGroup
Format: script literal, Script variable or number
320 Chapter 3 Ordered by Function
Comments
This script statement can be used to disconnect connections to the UC4 system.
Users or UserGroups must belong to the same client as the object in whose script this script statement is used. A UserInterface message informs the User that the connection to the UC4 Automation Engine has been interrupted and that logging on again is required. This does not result in an error if there were no active connections to the UC4 system. If Users or UserGroups are invalid, script processing is aborted and an error message is sent.
:DISCONNECT used in combination with "HOST" or "HOSTGROUP" does not terminate the Agent but ends the connection temporarily. The Agent reconnects to the UC4 Automation Engine as soon as the next signal which checks the Agents is sent. Disconnecting an Agent connection is useful when a new communication process starts and the Agents rearrange. Use the Script element
to end an
Agent.
Instead of specifying individual Agents, you can also indicate an AgentGroup. The termination then applies to all Agents which belong to this group.
This script statement can only be processed if the User or Agent is authorized to "cancel" processes.
Example
This example disconnects the User "SMITH/UC4" from the UC4 system.
: DISCONNECT "USER" , "SMITH/UC4"
The Agent WIN01 is disconnected from the UC4 system.
: DISCONNECT "HOST" , "WIN01"
Below, all database Agents are disconnected.
: DISCONNECT "HOSTGROUP" , "HOSTG_DB_UNIX"
See also:
Script element
Description
Ends an Agent, a work or communication process
Ends a UC4 system
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 321
3.11.2 :SET_UC_SETTING
Script Statement: Changes the system settings while the system is running.
Syntax
:SET_UC_SETTING
Setting, Component, Value
Syntax
Setting
Description/Format
System setting that should be changed.
Format:
Component
Value
Allowed values: WORKLOAD_MAX, WORKLOAD_MAX_FT,
WORKLOAD_MAX_JOB, SET_TRACE, SERVER_MODE
WORKLOAD_MAX = The maximum number of resources that the Agent provides for FileTransfers and Jobs.
WORKLOAD_MAX_FT = The maximum number of resources that the Agent provides for FileTransfers.
WORKLOAD_MAX_JOB = The maximum number of resources that the
Agent provides for Jobs.
SET_TRACE = The trace options for the work processes of a UC4 system or an Agent.
SERVER_MODE = The type of the Server process.
UC4 component for which the system setting should be changed.
Format: script literal, script variable, UC4 name or
For WORKLOAD_MAX, WORKLOAD_MAX_FT and WORKLOAD_MAX_
JOB: The name of an active Agent or an AgentGroup.
For SET_TRACE: The name of a UC4 System or an Agent.
For SERVER_MODE: The name of the Server process.
New value assignment for the system setting.
Format: script literal, script variable or script function
For WORKLOAD_MAX, WORKLOAD_MAX_FT and WORKLOAD_
MAX_JOB: Any value between -1 and 100000, or UNLIMITED.
Note that values that are greater than 100000 are handled as UNLIMITED values.
For SET_TRACE: 16-digit trace options.
For SERVER_MODE: The Server type, allowed are the values "D" for switching to a Dialog process and "W" for switching to awork process.
Attention: You cannot change a work process to a dialog process if it performs a Server role.
322 Chapter 3 Ordered by Function
Comments
Currently, you can use the script statement :SET_UC_SETTING in order to change three system settings. Your modifications are valid until a new value is assigned or until the Server processes or the
Agent are terminated.
To change the system settings, you need the authorization "Modify at runtime" and the privilege
"Create diagnostic information".
This script statement has the effect that all the script's open
are written to the UC4
Database.
Changing Trace Options
By setting trace options, you can use a script to log the behavior of work processes and Agents in exceptional cases. Neither the work processes nor the Agents need to be terminated for this purpose but setting trace options can result in a lot of data that is accumulated and performance losses can be a result thereof. UC4 recommends setting trace options only in close cooperation with our support team.
To modify the trace options, you can use the Setting SET_TRACE. The Value is a 16-digit string. Each digit corresponds to a particular trace flag (such as the first position in a TCP/IP trace). The order of the trace flags complies with the order that is used in the System Overview's properties dialog for Server processes and Agents .
Note that if you reboot only one work process, it will use the trace options that are specified in the INI file.
All other work processes use the value that are specified by using the script statement :SET_UC_
SETTING until they are rebooted.
Examples
The first example sets the number of resources that the Agent WIN01 provides for Jobs and FileTransfers to 1000. The result is written to the activation report.
: SET_UC_SETTING WORKLOAD_MAX, WIN01, 1000
: SET &RET# = GET_UC_SETTING (WORKLOAD_MAX_JOB, WIN01)
: PRINT &RET#
The second example retrieves the name of the UC4 system and then activates the TCP/IP trace for its work processes.
: SET &TRC# = GET_UC_SYSTEM_NAME ()
: SET_UC_SETTING SET_TRACE, &TRC# , "1000000000000000"
The following example changes the Server process UC4#WP003 to a Dialog process provided that it is active.
: IF SYS_SERVER_ALIVE ( "UC4#WP003" ) = "Y"
: SET_UC_SETTING "SERVER_MODE" , "UC4#WP003" , "D"
: ELSE
: SEND_MSG "ADMIN" , "UC4" , "Work process UC4#WP003 is not active!"
: ENDIF
See also:
Script element
Description
Reads current system settings.
Automation Engine 323
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.11.3 :SHUTDOWN
Script Statement: Ends a UC4 System
Syntax
:SHUTDOWN UC4
Syntax
UC4
Description/Format
Constant that should be indicated to end the UC4 System
Format:
Comments
With this Script statement, all work and communication processes of the UC4 System are ended.
For reliability reasons - e.g. to avoid confusions with JCL - the Script statement should always be used in combination with the absolute term UC4.
Use
to end particular work and communication processes or the Agent.
This script statement can only be executed if the user has the right to "cancel" Servers processes .
Example
In this example, the UC4 System is ended when the current time is later than 20:00 hours.
: IF SYS_TIME () > "200000"
: SHUTDOWN UC4
: ENDIF
See also:
Script element
Description
Disconnects a connection to the UC4 System.
Ends an Agent, a work or communication process.
Script Elements - System Conditions and Settings
324 Chapter 3 Ordered by Function
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.11.4 :TERMINATE
Script Statement: Ends an Agent, the Agents of an AgentGroup, a work or communication process
Syntax
:TERMINATE [Connection],
Name
Syntax
Connection
Description/Format
Type of connection
Format:
Name
Allowed values: "HOST" (default value), "HOSTGROUP" and "SERVER"
"HOST" = Agent
"HOSTGROUP" = Agents of an AgentGroup
"SERVER" = Work or communication process
Name of an Agent, AgentGroup, work or communication process
Format: script literal or script variable
Comments
This script statement can be used to end Agents and work and communication processes. The parameter
Connection does not have to be indicated. A colon must be set if it is not used.
Instead of specifying an individual Agent, you can also indicate an AgentGroup. The termination applies to all Agents which belong to this group.
If the connection to an Agent should end on a temporary basis, we recommend using the script element
is sent. With
all work and communication processes of the UC4 system can be terminated.
The right to "cancel" Server processes or Agents is required to execute this script statement .
Examples
The example below terminates a work process.
: TERMINATE SERVER, "UC4#WP001"
In this example, the Agent "WIN21" is terminated. The type of connection is not indicated.
: TERMINATE , "WIN21"
Automation Engine 325
See also:
Script element/function
Description
Disconnects a connection to the UC4 system.
Ends a UC4 system.
Processes ServiceManager actions or queue modifications.
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.11.5 CHANGE_LOGGING
Script Function: Causes the log file to be changed
Syntax
CHANGE_LOGGING
(Component)
Syntax
Component
Description/Format
Name of the component whose log file should be changed
Format:
or
The following components can be specified: l l l l
Communication process
Work process
Agent
AgentGroup
Return code
"0" - The log file has successfully been changed.
"20223" - The specified AgentGroup does not exist.
"20722" - The indicated Server process, Agent or AgentGroup does not exist or is inactive.
Comments
This script function prompts the log file to be changed.
In the UC4 Variable UC_SYSTEM_SETTINGS, the UC4 administrator can set system-wide specifications for the number of days or the size of the log file (in MB). The log file is changed if the specified values are met. It is also possible to specify temporary changes which apply until the system is restarted. Do so in the Properties tab of the System Overview. The place of storage for log files is determined in the Server's or Agent's INI file.
326 Chapter 3 Ordered by Function
If a AgentGroup is specified, the log files of all corresponding Agents changes. An error number is not returned if one of the Agents is inactive and the log file cannot be changed.
Keep in mind that changing the logging of one work process automatically applies to all work processes.
Example
In the following example, the log file of all work processes is changed.
: SET &RET# = CHANGE_LOGGING ( "UC4#WP001" )
See also:
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.11.6 GET_UC_SERVER_NAME
Script Function: Determines the name of the work process in which the script runs
Syntax
GET_UC_SERVER_NAME
()
Return code
Name of the work process
Example
In this example, the name of the work process (e.g. "UC4#WP001") is determined and output to the activation report.
: SET &RET# = GET_UC_SERVER_NAME ()
: PRINT &RET#
See also:
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 327
3.11.7 GET_UC_SETTING
Script Function: Reads current system settings.
Syntax
GET_UC_SETTING
(Setting,Component,Option)
Syntax
Setting
Description/Format
The system setting that should be read.
Format:
Component
Allowed values: WORKLOAD_ACTUAL_FT, WORKLOAD_ACTUAL_JOB,
WORKLOAD_MAX_FT, WORKLOAD_MAX_JOB, SET_TRACE,
SERVER_MODE, SERVER_OPTIONS
WORKLOAD_ACTUAL_FT = The currently used resources that the Agent provides for FileTransfers.
WORKLOAD_ACTUAL_JOB = The currently used resources that the Agent provides for Jobs.
WORKLOAD_MAX_FT = The maximum number of resources that the Agent provides for FileTransfers.
WORKLOAD_MAX_JOB = The maximum number of resources that the
Agent provides for Jobs
SET_TRACE = The trace options for the work processes of a UC4 system .
SERVER_MODE = The type of the Server process
SERVER_OPTIONS = The Server settings.
The UC4 component whose system setting should be read depending on the parameter Setting.
Format: UC4 name, script literal or script variable
For WORKLOAD_ACTUAL_FT, WORKLOAD_ACTUAL_JOB,
WORKLOAD_MAX_FT and WORKLOAD_MAX_JOB: The name of the
Agent.
For SET_TRACE: The name of the UC4 system.
For SERVER_MODE: The name of the Server process.
For SERVER_OPTIONS: No component is indicated.
328 Chapter 3 Ordered by Function
Option
The option or status of the specified Queue object whose value should be read.
Format: UC4 name, script literal or script variable
You must only specify this parameter if the value of a Queue object should be read (Setting = QUEUE).
Allowed values: ACTIVE_COUNT, CONSIDER_ERT, MAX_SLOTS,
PRIORITY, STATE
ACTIVE_COUNT = The number of the currently used Queue slots.
CONSIDER_ERT = The ERT is considered for exceptions.
MAX_SLOTS = The Queue slot maximum.
PRIORITY = The current priority (for exceptions, this value can differ from the default priority).
STATE = The Queue's current status.
Return codes
For WORKLOAD_ACTUAL_FT and WORKLOAD_ACTUAL_JOB:
The currently used resources that the Agent provides for FileTransfers and Jobs.
UNKNOWN - The resources are not limited.
For WORKLOAD_MAX_FT and WORKLOAD_MAX_JOB:
The maximum number of resources that the Agent provides for FileTransfers and Jobs.
UNLIMITED - The resources are not limited.
For SET_TRACE:
The trace options of the work process.
"0" - No Trace options are specified.
For SERVER_MODE:
"C" - Communication process(CP)
"P" - Primary work process (PWP)
"W" - Work process (WP)
"D" - Dialog process (DWP)
"N" - NonStop process (NWP)
" " - The Server process is inactive.
For SERVER_OPTIONS:
The string that contains the Server options.
For QUEUE - ACTIVE_COUNT:
The number of Queue slots that are used.
For QUEUE - CONSIDER_ERT:
"1" - The ERT is considered when tasks start with regard to Queue exceptions.
"0" - The ERT is not considered.
For QUEUE - MAX_SLOTS:
The maximum number of Queue slots.
"UNLIMITED" - The Queue slots are not limited.
For QUEUE - PRIORITY:
The Queue's current priority.
For QUEUE - STATE:
"0" = GO
"1" = STOP
Automation Engine 329
Comments
You specify trace options in the System Overview's Server category. The script function GET_UC_
SETTING returns a 16-digit number where each number refers to one of the 16 available areas (such as
TCP/IP).
The UC4 administrator can define the Server options in the UC4 Variable UC_SYSTEM_SETTINGS by using the SERVER_OPTIONS key. GET_UC_SETTING returns the complete string. To read a specific
Server option, you can use the script elements MID, SUBSTR or STR_CUT.
GET_UC_SETTING causes all the script's open
to be written to the UC4 Database.
Examples
The following example retrieves the maximum number of resources that the Agent WIN01 provides for
Jobs. The result is written to the activation protocol.
: SET &RET# = GET_UC_SETTING (WORKLOAD_MAX_JOB, "WIN01" )
: PRINT &RET#
The second example reads the trace options of the UC4 system UC4PROD.
: SET &RET# = GET_UC_SETTING (SET_TRACE, "UC4PROD" )
This example retrieves the type of the Server process UC4#WP003.
: SET &RET# = GET_UC_SETTING (SERVER_MODE, "UC4#WP003" )
The following scripting lines read the third digit of the Server options. This setting defines whether the statistical records should be checked when the system is cold booted.
: SET &RET# = GET_UC_SETTING (SERVER_OPTIONS)
: SET &OPTION# = SUBSTR ( &RET# ,3,1)
The next example retrieves a Queue object's current status and writes it to the activation protocol.
: SET &RET# = GET_UC_SETTING (QUEUE,QUEUE.JOBS,STATE)
: IF &RET# = 0
: PRINT "QUEUE.JOBS - Status = GO"
: ELSE
: PRINT "QUEUE.JOBS - Status = STOP"
: ENDIF
The last example reads a Queue object's current slot maximum and writes it to the activation protocol.
: SET &RET# = GET_UC_SETTING (QUEUE,QUEUE.JOBS,MAX_SLOTS)
: PRINT "Queue QUEUE.JOBS - Max Slots: &RET#"
See also:
Script element
Description
Changes the system settings while the system is running.
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
330 Chapter 3 Ordered by Function
3.11.8 GET_UC_SYSTEM_NAME
Script Function: Determines the name of the UC4 system
Syntax
GET_UC_SYSTEM_NAME
()
Return code
Name of the UC4 system
Example
In the example, the name of the UC4 system (e.g. "UC4PROD") is determined and the result is output to the activation report.
: SET &RET# = GET_UC_SYSTEM_NAME ()
: PRINT &RET#
See also:
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.11.9 ILM
Script function: Controls ILM (Information Lifecycle Management) functionality.
Installation
[Installation]
Check ] [ Deleting a Partition ]
Syntax
ILM ( INSTALLED )
Syntax
INSTALLED
Description/Format
Queries whether the UC4 Database has been partitioned with ILM.
Comments
This script function supplies the following return codes:
"Y" - Partitioning with ILM has been installed.
"N" - The UC4 Database has not been partitioned.
Automation Engine 331
Example
: SET &ILM# = ILM (INSTALLED)
Status
[Status] [
] [
]
Syntax
ILM ( ACTIVE )
Syntax
ACTIVE
Description/Format
Queries whether ILM is active.
Comments
This script function supplies the following return codes:
"Y" - ILM is active; new partitions are created and data is switched out (only MS SQL Server).
"N" - ILM is not active; the partition is not changed and no data is switched out (only MS SQL Server).
Example
: SET &ILM# = ILM (ACTIVE)
Start and Stop
[Start and Stop] [
] [
]
Syntax
ILM ( START )
ILM ( STOP )
Syntax
START
STOP
Description/Format
Activates ILM.
Deactivates ILM.
Comments
If ILM is active, new partitions are created and data is switched out (only MS SQL Server).
If ILM is not active, the partition is not changed and no data is switched out (only MS SQL Server).
332 Chapter 3 Ordered by Function
This script function returns the value "0" after a successful start or stop, or the corresponding error number if an error has occurred.
Example
ILM should be deactivated.
: SET &ILM# = ILM (STOP)
Switch-Out
] [ Status ] [ Start and Stop ]
[Switch-Out]
] [
]
Syntax
ILM (
SWITCHOUT [, check]
)
Syntax
SWITCHOUT
Check
Description/Format
Switches out the oldest partition.
Setting that defines whether a check should be made before data is switched out.
Allowed values: "CHECK" (default) and "NOCHECK"
"CHECK" - The system checks whether the relevant partition includes data records of active tasks before it starts to switch out data. No switch-out takes place if it includes active tasks.
"NOCHECK" - Data is switched out without a prior check.
Comments
Switching out data is a function that is specific to the MS SQL Server. It is not relevant for Oracle databases.
Note that this script function triggers a data switch-out but it does not wait until the switch-out has been completed.
This script function returns the value "0" if the data switch-out has been successful, or the corresponding error number if an error has occurred.
Note that the number of online partitions that is specified by the UC4 administrator (UC4 Variable UC_
ILM_SETTINGS, key ONLINE_PARTITIONS) is not considered.
For example:
Four partitions are online. By using this script function several times, you can achieve that only three or two or only one of the partitions are or is online.
You cannot switch out data of the current partition. At least one partition must be online.
Note that switching out data of a partition that includes data records of active tasks will result in data loss.
Automation Engine 333
Contact UC4 Support if you want to perform forced switch-outs that involve active tasks.
Example
A check is made before data is switched out because the default value for the second parameter is
"CHECK".
: SET &ILM# = ILM (SWITCHOUT)
Check
[Check] [
Syntax
ILM ( CHECK
, Partition number)
Syntax
CHECK
Partition number
Description/Format
Checks whether the specified partition includes active objects.
Number of the partition.
Format:
or
Comments
This script function returns "0" if the specified partition does not include any active objects.
Example
Partition "25" is checked.
: SET &ILM# = ILM (CHECK, "25" )
Deleting a Partition
[Deleting a Partition]
Syntax
ILM ( DROP
, Partition
[, Check]
)
Syntax
DROP
Description/Format
Deletes the specified partition.
334 Chapter 3 Ordered by Function
Partition
Check
Name or number of the partition.
Format:
or
If you specify the name of an individual staging table (MS SQL Server), the ILM database user is not used for the deletion process. Instead, the database user specified in the UC4 Automation Engine's INI-file section
[ODBC] is used. Note that this user needs the corresponding authorizations for this purpose.
Setting that defines whether a check should be made before the partition is deleted (only relevant for Oracle databases).
Allowed values: "CHECK" (default value) and "NOCHECK"
"CHECK" - The system checks whether the relevant partition includes active tasks before it starts to delete the partition. No deletion takes place if the partition includes active tasks.
"NOCHECK" - The partition is deleted without a prior check.
Comments
The parameter Check is not relevant for the MS SQL Server. In the MS SQL Server, you can only delete staging tables. These tables are already checked when they are switched out.
Note that you can only drop a partition without losing data if it does not include data records of active tasks.
This script function returns "0" if the specified partition has been deleted successfully.
Example
Partition "25" is deleted.
: SET &ILM# = ILM (DROP, "25" )
See also:
Script Elements - System States and Handling
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.11.10 MODIFY_SYSTEM
Script function: Processes ServiceManager actions or Queue modifications.
General information
This script element can be used to handle two different types of tasks:
1. Executing the actions of a ServiceManager that is connected to the UC4 system
2. Changing the values or states of Queue objects (GO/STOP)
Automation Engine 335
The actions that this script function takes depends on the parameters that are specified. Also refer to the syntax descriptions below.
You can only start Server processes and Agents using this script element if a ServiceManager is available that is correctly configured and connected to the UC4 system. Also refer to the descriptions of the settings for Agent and Server objects.
Return codes
"0" - The action defined for this script function has successfully been processed.
"11901" - The specified Queue object could not be found in the client.
"20836" - An invalid value has been specified for the parameter MOD.
"20837" - An invalid value has been specified for the Queue object's priority or max. slots.
"11677" - The ServiceManager call could not be processed: No CP is started.
"11678" - Server or Agent has not been started.
"11679" - Successful ServiceManager query.
"11680" - Connection to ServiceManager could not be established or the specified process could not be found in the ServiceManager.
"11681" - ServiceManager call is not possible because the specified host type is not supported.
"11682" - ServiceManager call is not possible because the specified Agent / Server process could not be found.
"11683" - ServiceManager call will not be processed because the Server is not linked to the specified
ServiceManger or the same query has already been processed.
Queue
]
Syntax
MODIFY_SYSTEM
(Action, Queue, Value)
Syntax
Action
Queue
Value
Description/Format
Defines the modifications that should be made in Queue objects.
Format:
or
Allowed values: "MODE", "MAX_SLOTS" or "PRIORITY"
"MODE" = Queue status, start or stop of Queue task execution.
"MAX_SLOTS" = Max. number of tasks that can run at the same time (max.
slots).
"PRIORITY" = Task priority.
Name of the Queue object that should be changed.
Format:
or
Value for the setting or status that should be changed (Action).
Format:
or
Allowed values depending on the selected action:
"MODE": "GO" or "STOP"
"MAX_SLOTS": Number between "0" and "99999" or "UNLIMITED".
"PRIORITY": Number between "0" and "255".
336 Chapter 3 Ordered by Function
Comments
Changing the status of Queue objects (Start/Stop) using this script element (Action: MODE) has the effect that the new status is valid until a new modification is made. Modifications to priority or maximum Queue slots remain valid until these values are changed due to an exception or if a User changes them manually.
The number of parallel running tasks is not limited if the maximum slots of Queue objects are changed to "UNLIMITED".
Example
The following example sets the status of the Queue object "QUEUE.JOBS" to "GO":
: SET & RET# = MODIFY_SYSTEM ( "MODE" , "QUEUE.JOBS" , "GO" )
: IF & RET# = "0"
: PRINT "Processing the Queue object QUEUE.JOBS has successfully been activated."
: ELSE
: PRINT "QUEUE.JOBS: Error when changing the status to GO."
: ENDIF
ServiceManager
] [ ServiceManager ]
Syntax
MODIFY_SYSTEM
(Action, Name
[,Server mode]
)
Syntax
Action
Name
Description/Format
Defines the action that should be taken for Agents, Server processes or the
UC4 system.
Format:
or
Allowed values: "STARTUP", "TERMINATE", "CHANGE_MODE",
"DISCONNECT" or "SHUTDOWN"
"STARTUP" = Starts an Agent or a Server process.
"TERMINATE" = Ends an Agent or a Server process.
"SHUTDOWN" = Shuts down the complete UC4 system.
"CHANGE_MODE" = Changes the mode of a Server's work process (WP).
"DISCONNECT" = Closes the Agent connection and re-establishes it.
Name of the Agent or Server process that should be started/ended or whose mode should be changed.
Format:
or
Server mode
Automation Engine 337
Mode to which the specified WP should be changed.
Format:
or
This parameter is only required if the mode of a WP should be changed
(Action = CHANGE_MODE).
Allowed values:
"D": Dialog process
"W": Work process
Comments
The script element MODIFY_SYSTEM can also be used to start or end Server processes and Agents or to change the mode of a Server's work processes.
The action "STARTUP" can only be used if a ServiceManager is available and if the Agent or Server process to be started has correctly been configured. Also refer to the settings in the Attributes tab of
Agent or Server objects.
In order to terminate the UC4 system using "SHUTDOWN", the value "UC4" is required for the parameter
Name (see:
).
The parameter Server mode is required in order to change the mode of a Server's work process (Action:
"CHANGE_MODE"). The parameter Server mode must not be used in combination with the actions
"STARTUP", "TERMINATE", "DISCONNECT" and "SHUTDOWN".
Example
Shutting down the Agent "WIN01":
: SET & ACT# = MODIFY_SYSTEM ( "TERMINATE" , "WIN01" )
See also:
Script Element
Description
Ends a UC4 system.
Checks if a particular host is active.
Checks if a certain Server process is active.
Stops or starts the automatic processing of a complete client.
Script Elements - Read or Modify Objects
Sample Collection
Notification with Variable Message Text
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
338 Chapter 3 Ordered by Function
3.11.11 SYS_BUSY_01
Script Function: Returns the workload percent of the Automation Engine work process where the script is executed during the last minute.
Syntax
SYS_BUSY_01
()
Return code
Percentage of the workload of a Server process
Comments
The script function
can also be used to query the percentage of the UC4 Automation Engine workload .
Example
The size of the workload of the UC4 Automation Engine is queried. If it is above 80%, a notification is sent to a user.
: IF SYS_BUSY_01 () > 80
: SEND_MSG BU,UC4, "Workload of the UC4 Automation Engine above 80%"
: ENDIF
See also:
Script element
Description
Returns the workload percent of the Automation Engine work process where the script is executed during the last 10 minutes
Returns the workload percent of the Automation Engine work process where the script is executed during the last hour.
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 339
3.11.12 SYS_BUSY_10
Script Function: Returns the workload percent of the Automation Engine work process where the script is executed during the last 10 minutes.
Syntax
SYS_BUSY_10
()
Return code
Percentage of the workload of a Server process
Comments
can also be used to query the percentage of the UC4 Automation Engine workload.
Example
The size of the workload of the UC4 Automation Engine is queried. A notification is sent to a user if 80% is exceeded.
: IF SYS_BUSY_10 () > 80
: SEND_MSG BU,UC4, "Workload of the UC4 Automation Engine over 80%"
: ENDIF
See also:
Script element
Description
Returns the workload percent of the Automation Engine work process where the script is executed during the last minute.
Returns the workload percent of the Automation Engine work process where the script is executed during the last hour.
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
340 Chapter 3 Ordered by Function
3.11.13 SYS_BUSY_60
Script Function: Returns the workload percent of the Automation Engine work process where the script is executed during the last hour.
Syntax
SYS_BUSY_60
()
Return code
Percentage of the workload of a Server process
Comments
can also be used to query the percentage of the UC4 Automation Engine workload.
Example
The size of the workload of the UC4 Automation Engine is queried. A notification is sent to a user if it is more than 80%.
: IF SYS_BUSY_60 () > 80
: SEND_MSG BU,UC4, "Workload of the UC4 Automation Engine over 80%"
: ENDIF
See also:
Script element
Description
Returns the workload percent of the Automation Engine work process where the script is executed during the last minute.
Returns the workload percent of the Automation Engine work process where the script is executed during the last 10 minutes
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 341
3.11.14 SYS_HOST_ALIVE
Script Function: It checks whether a particular host is active.
Syntax
SYS_HOST_ALIVE
(Host
[, Connection]
)
Syntax
Host
Description/Format
The name of the Agent whose activity should be checked.
Format:
Connection
.
The name of an R3 or DB Connection object that should be used to verify the availability of the SAP system or the database.
Format: UC4 name or script variable
In SAP, you must enter the Connection object that you have defined in the
Agent object's Agent tab.
The parameter Host is optional when you specify a DB Connection object.
To use this parameter, you must specify either an SAP Agent or a
Database Agent in Host. The system will not check whether the Database
Agent has started in order to resolve SQL variables.
Return codes
A host has been specified:
"Y" - The Agent is active.
"N" - The Agent is inactive.
A host plus a Connection object have been specified:
"Y" - The Agent is active and the SAP system or the database is available.
"N" - The Agent is active but it cannot establish a connection to the SAP system or to the database.
"?" - The Agent is not active. It cannot be identified whether or not the SAP system or the database is available.
Comments
OS Agents
The script function checks whether the Agent is active. You cannot specify the parameter Connection.
ERP Agents
ERP Agent Peoplesoft, OracleApplications and Siebel: The value "N" is supplied when the Agent is active but the Enterprise Business Solution is not available.
342 Chapter 3 Ordered by Function
SAP Agents: There are two options. You can only specify the parameter Host in order to check whether the SAP Agent is active. To check whether the SAP system is available, you can additionally specify the corresponding SAP Connection object.
Note that the SAP Agent will open some connections only if they are required (HTTP) or terminate them automatically if they have not been used for a certain time (ABAP). A new connection will be established if there is no connection to the SAP system when you use SYS_HOST_ALIVE in order to check whether the SAP system is available. In this context, the following notes are important: l l l l
The SAP system is not available: This could result in a long timeout duration.
There is a connection to the SAP system but it is being used: You must establish a new connection in order to ensure that the SAP system is still available.
Establishing an additional connection can result in an error if SAP's CPIC limit is exceeded, for example. In this case, SYS_HOST_ALIVE returns code "N" although jobs are already being processed via existing connections.
Any changes in a connection object require the SAP Agent to be restarted in order to become effective.
Database Agent
As in SAP, you can either specify only the Agent, or a Connection object (type DB) in addition. If you specify a Connection object, you can also check the availability of the particular database.
Examples
The following example checks whether the Windows Agent WIN21 is active. A message is sent to the administrator when it is inactive.
: IF SYS_HOST_ALIVE ( "WIN21" ) = "N"
: SEND_MSG "ADMIN" , "UC4" , "Agent WIN21 is not active!"
: ENDIF
The second example checks whether the SAP system is available for the Agent SAP01.
: SET &STATUS# = SYS_HOST_ALIVE ( "SAP01" , "CONN.R3.ECC.ABAP" )
See also:
Script element
Description
Returns the name of the host.
Script Elements - System Conditions and Settings
Sample Collection:
Display with Cockpit
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 343
3.11.15 SYS_INFO
Script function: Reads UC4 system information
UC4 Version
[UC4 Version] [
]
Syntax
SYS_INFO
(UC4 component,
VERSION
)
Syntax
UC4 component
VERSION
Description/Format
UC4 component whose version should be retrieved
Format:
or
Allowed values: "SERVER" and "INITIALDATA"
This keyword causes the UC4 version of the component to be retrieved.
Return codes
UC4 version including hotfix number
"20863" – An invalid value has been used for the UC4 component.
"20864" – The second parameter is not VERSION.
Comments
This script function retrieves the UC4 Automation Engine's version and the UC4 Database's initial data.
The format of the UC4 version is indicated in 12 digits.
Example: 6.00A732-505.
Examples
The first example reads the UC4 Automation Engine's version:
: SET &VERSION# = SYS_INFO (SERVER, VERSION)
The second example retrieves the version of the UC4 Database's initial data.
: SET &VERSION# = SYS_INFO (INITIALDATA, VERSION)
Workload
[Workload]
Syntax
SYS_INFO
(
MQPWP
,
BUSY
, Period)
SYS_INFO
(Message queue,
COUNT
)
344 Chapter 3 Ordered by Function
SYS_INFO
(Message queue,
LENGTH
, Period)
Syntax
Message queue
BUSY
COUNT
LENGTH
Period
Description/Format
Message queue about which information is to be retrieved
Format:
or
Allowed values: "MQPWP", "MQWP", "MQDWP", "MQOWP" and
"MQRWP"
"MQPWP" - Message queue of the primary work process
"MQWP" - Message queue of work processes
"MQDWP" - Message queue of dialog processes
"MQOWP" - Message queue for outputs
"MQRWP" - Message queue for resource calculations
Supplies the UC4 Automation Engine's workload in percent
Supplies the number of queued messages
Supplies the average time it will take to process the message queue
Period used to calculate the workload or average processing time.
Format: script literal or script variable
Allowed values: "01", "10" and "60"
"01" - the last minute
"10" - the last 10 minutes
"60" - the last hour
Return codes
"20876" - The message queue does not exist.
"20864" - The second parameter is not valid.
"20877" - The period does not comply with the allowed values.
BUSY:
UC4 Automation Engine workload in percent
COUNT:
Number of queued messages
LENGTH:
Average time it will take to process the message queue
Comments
This script function retrieves data about message queues.
The UC4 Automation Engine's workload in percent may be retrieved using the keyword BUSY, and also with the script functions
and
Automation Engine 345
Examples
The first example retrieves the UC4 Automation Engine's workload within the last 10 minutes. A message is sent to a user if 80% is exceeded.
: IF SYS_INFO (MQPWP, BUSY, "10" ) > 80
: SEND_MSG SMITH,UC4, "Workload of UC4 Automation Engine is above 80%"
: ENDIF
The second example reads the number of messages found in the dialog-process queue.
: SET &NUMBER# = SYS_INFO (MQDWP, COUNT)
The third example supplies the current processing time of the work processes' message queue during the last hour.
: SET &DURATION# = SYS_INFO (MQWP, LENGTH, "60" )
See also:
System Conditions and Handling
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.11.16 SYS_SERVER_ALIVE
Script Function: Checks if a certain server process is active
Syntax
SYS_SERVER_ALIVE
(Server process)
Syntax
Server process
Description/Format
Name of the server process whose activity should be checked
Format:
or
.
Return codes
"Y" - The Server process is active
"N" - The Server process is inactive
"20349" - The Server process does not exist
Comments
If the indicated Server process cannot be found, reaction is possible with
Functions for Error Handling and Messages
to analyze this error. Script processing can either be continued or canceled.
The script statement causes all open
of the script to be written to the UC4 Database.
346 Chapter 3 Ordered by Function
Example
In the example, a check is made to determine if the work process "UC4#WP005" is active. If it is not active, a message is sent to the administrator.
: IF SYS_SERVER_ALIVE ( "UC4#WP005" ) = "N"
: SEND_MSG "ADMIN" , "UC4" , "Work process UC4#WP005 is not active!"
: ENDIF
See also:
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.11.17 SYS_SNMP_ACTIVE
Script Function: Checks if the SNMP connection (Simple Network Management Protocol) of UC4 if active.
Syntax
SYS_SNMP_ACTIVE
()
Return codes
"Y" - The SNMP connection of UC4 is active
"N" - The SNMP connection of UC4 is inactive
Example
The example demonstrates a check that is made to determine whether the SNMP connection is active.
The result is output to the activation report.
: SET &RET# = SYS_SNMP_ACTIVE ()
: PRINT &RET#
See also:
Script element
UC4 and SNMP
Script Elements - System Conditions and Settings
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Sends an SNMP trap
3.11.18 SYS_USER_LANGUAGE
Script Function: Supplies the language in which the Server generates the log files.
Automation Engine 347
Syntax
SYS_USER_LANGUAGE
()
Return codes
"D" - German
"E" - English
"F" - French
Comments
You can determine the language in which the Server log files should be generated in the INI file ucsrv.ini by using the parameter language=. This script function retrieves the language character that has been specified.
Example
The following example retrieves the language character using this script function and writes it to the activation report.
: SET &LOGLANG# = SYS_USER_LANGUAGE ()
: PRINT "Server language is &LOGLANG#."
See also:
Script element
Description
Checks if a user is logged on to UC4 with a UserInterface.
Supplies the department of the user who has started the task.
Supplies the first and last name of the user who has started the task.
Supplies the name of the user who has started the task.
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
348 Chapter 3 Ordered by Function
3.11.19 TOGGLE_SYSTEM_STATUS
Script Function: Stops or starts the automatic processing of a client
Syntax
TOGGLE_SYSTEM_STATUS
(Status)
Syntax
Status
Description/Format
Status modification
Format:
Allowed values: "STOP" and "GO"
"STOP" - stops the automatic processing of a client
"GO" - starts the automatic processing of a client
Return codes
"0" - client status was successfully changed
"9" - the required privilege for changing the client status is missing
Comments
This script function sets the system status to STOP or GO.
This script function can only be executed if the privilege "Change system status (STOP/GO)" was assigned!
The script statement causes all open
of the script to be written to the UC4 Database.
Example
In the example, automatic processing is stopped. The return value of the function is given in the report.
: SET &RET# = TOGGLE_SYSTEM_STATUS (STOP)
: PRINT &RET#
See also:
Script element
Description
Stops or starts the automatic processing of Workflows, Groups, Events or
Schedules
Script Elements - System Conditions and Settings
Changing System Status
Automation Engine 349
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12 Date and Time
3.12.1 ADD_DAYS
Script Function: Adds days to a given date
Syntax
ADD_DAYS
(Date,Days
[, Calendar, Calendar Keyword ]
)
Syntax
Date
Days
Calendar
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
A value specifying a number of days.
Format: script literal, number without quotation marks or script variable
The name of the relevant Calendar object.
Format:
Calendar Keyword
UC4 Name
, script literal or script variable
The name of the relevant Calendar keyword.
Format: UC4 Name, script literal or script variable
Return code
Date in the specified format
"0" - No days have been assigned to this Calendar keyword or the calculated date lies out of the
Calendar range.
"20327" - Calendar object does not exist
"20328" - Calendar keyword does not exist in the Calendar object
Comments
This function adds Days to a given Date. Optionally, this calculation can also be made depending on
Calendar and Calendar Keyword. Only Days which have been defined in the Calendar keyword will be taken into account.
350 Chapter 3 Ordered by Function
If you specify a particular date format, the date will be returned in this format. Otherwise, the default formats "YYMMDD" or "YYYYMMDD" must be used and will be returned. Use a colon or semicolon as a separator between Date Format and Date.
It is also possible to specify zero Days. If the Date is valid according to the Calendar, this date will be returned. If it is not valid, the previous valid date (Calendar conditions) will bereturned.
The range of the specified Calendar is automatically considered in the calendar calculation. This range depends on the settings the UC4 administrator defined in the UC4 Variable UC_CLIENT_SETTINGS in the keys NOW_MINUS and NOW_PLUS. The script function returns "0" if the calculated date lies beyond this defined range.
Examples
The first example adds two days to the specified date. The result ("000401") is output to the activation protocol.
: SET &DATE# = ADD_DAYS ( "000330" , 2)
: PRINT &DATE#
In this example, the date is assigned to a script variable. The default format "YYMMDD" will be used because no date format has been specified. The result ("000401") is again output in the activation protocol.
: SET &DATE1# = "000330"
: SET &DATE2# = ADD_DAYS ( &DATE# , 2)
: PRINT &DATE2#
The third example retrieves the next valid work day. This is done using the definitions made in the company calendar. As the current date was not retrieved in the default format, the special date format must again be specified in the script variable.
: SET &CURDATE# = SYS_DATE ( "DD.MM.YY" )
: SET &NWRKDAY# = ADD_DAYS ( "DD.MM.YY:&CURDATE#" , 1, COMPANY, WORKDAY)
See also:
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.2 ADD_PERIOD
Script Function: Adds a period to a specified date.
Syntax
ADD_PERIOD
(Date, Period Format:Period
[, Output Format]
)
Syntax Description/Format
Automation Engine 351
Date
Period Format:Period
Output Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
Format: script literal or script variable
Period: Entry of a period to be added to specified date.
Period Format:
for the Period.
As a separator between the Period Format and the Period you can either use a colon (:) or a semi colon (;).
Format guidelines for the determined date.
Format:
UC4 Name
, script literal or script variable
Default value: "YYMMDD"
Return code
Date in the specified format.
Comments
This script function adds years, months, quarters or weeks to a specified date.
This function is given a date. Optionally, you can specify a date format. The default date format to be used if nothing has been specified is either "YYMMDD" or "YYYYMMDD".Use a colon or semicolon as separator between Date Format and Date.
The Period is added to the specified Date. Period can be any number. An error will occur if the result dates later than 12/31/9999.
Output Format is optional. If it has not been specified, the script function returns the date in the default format "YYMMDD".
Examples
The first example adds two weeks to 03/6/2000. The result (20.03.2000) is output to the report.
: SET &DATE# = ADD_PERIOD ( "DD.MM.YY:06.03.00" , "WW;2" , "DD.MM.YYYY" )
: PRINT &DATE#
The second example adds a quarter to 01/31/2000. The result (30-04-2000) is output to the report.
: SET &DATE# = ADD_PERIOD ( "000131" , "Q:1" , "DD-MM-YYYY" )
: PRINT &DATE#
In the third example, a year is added to the date 02/29/2000. The result of 29.2.2001 is output to the report because the year 2001 is not a leap year.
: SET &DATE# = ADD_PERIOD ( "20000229" , "YY:0001" ,DD.MM.YYYY)
: PRINT &DATE#
352 Chapter 3 Ordered by Function
See also:
Script Elements - Date and Time
Script Element - Alphabetical Listing
Script Element - Listed by Function
3.12.3 ADD_TIME
Script Function: Adds two times.
Syntax
ADD_TIME
(Time1, Time2
[,Output Format]
)
Syntax
Time1
and
Time2
Output Format
Description/Format
Indication of a time in the format "HHMMSS".
Format:
or
It is also possible to specify a different
. Do so by entering the required time format, then enter a separator (;) and afterwards the time.
Indicating a time format is optional.
Format for the determined time.
Format:
Return code
Time in the specified format
UC4 Name
, script literal or script variable
Default: "HHMMSS"
Comments
Two times are added with this script function. The change from 23:59:59 to 00:00:00 is taken into account.
This script function is assigned two times. The indication of a particular time format is optional. The default time format to be used if nothing has been specified is "HHMMSS". Use a semicolon as a separator between the time format and the time.
Output Format is optional. If nothing has been specified, the script function returns the time in the default format "HHMMSS".
Automation Engine 353
Examples
The first example does not use any time formats. The result ("130000") is output in the activation protocol.
: SET &TIME# = ADD_TIME ( "120000" , "010000" )
: PRINT &TIME#
The second example uses time and output format. The result is "04:59".
: SET &TIME# = ADD_TIME ( "235959" , "HH;05" , "HH:MM" )
: PRINT &TIME#
In the third example, 71 seconds are added to 23:59:59 71. Time format is used, output format is not used.
The result ("000110") is output in the default format.
: SET &TIME# = ADD_TIME ( "HH:MM:SS;23:59:59" , "SS;71" )
: PRINT &TIME#
The following example is the same as the third one shown above. The difference is that a special term is used for the output format. The result ("70") is output in the activation protocol in seconds.
: SET &TIME# = ADD_TIME ( "HHMMSS;235959" , "SS;71" , SS)
: PRINT &TIME#
See also:
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.4 ADD_TIMESTAMP
Script function: Adds time to a time stamp.
Syntax
ADD_TIMESTAMP
(Time Stamp,Time)
Syntax
Time Stamp
Time
Description/Format
Time Stamp from date and time ("YYYY-MM-DD HH:MM:SS").
Format:
or
Time ("HH:MM:SS") to be added to a Time Stamp.
Format: script literal or script variable
Allowed values: 0 to 99 (for each HH, MM and SS)
Return code
Time stamp in the "YYYY-MM-DD HH:MM:SS" format
354 Chapter 3 Ordered by Function
Comments
This script function adds time in the "HH:MM:SS" format to a given Time Stamp in the "YYYY-MM-DD
HH:MM:SS" format.
In doing so, UTC is used for calculation. This means that summer and winter time are not considered. A maximum value of 99 is allowed for hours, minutes and seconds, so the script function's result can lie a bit more than 4 days after the original time stamp.
Example
In the following example, 24 hours and one second are added to the time stamp. The result "2004-01-01
00:00:01" is written to the activation protocol.
: SET &RET# = ADD_TIMESTAMP ( "2003-12-31 00:00:00" , "24:00:01" )
: PRINT &RET#
See also:
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered By Function
3.12.5 CALE_LOOK_AHEAD
Script Function: Returns the next date based on calendar conditions.
Syntax
CALE_LOOK_AHEAD
(
[Date]
, JOBP\JSCH, Task Number)
CALE_LOOK_AHEAD
(
[Date]
, Condition, Calendar, Calendar Keyword
[ [,Calendar]
[,Calendar Keyword] ]...
)
Syntax
Date
JOBP\JSCH
Task Number
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
Name of a Workflow or Schedule
Format:
or s
Task number in the Workflow or the Schedule
Format: script literal or script variable
Automation Engine 355
Condition
Calendar
Calendar Keyword
Condition that must apply for the definition of date
Format: script literal or script variable
Allowed values: "ONE", "ALL", "NO"
"ONE" - One of the given calendar conditions must apply
"ALL" - All the given calendar conditions must apply
"NO" - None of the given calendar conditions must apply
If no Calendar condition applies for a task, a SPACE is returned. In this case, CALE_LOOK_AHEAD_MAX is displayed in the Schedule monitor .
Name of a calendar
Format: script literal or script variable
Calendar keyword in this calendar
Format: script literal or script variable
Return codes
Date in the specified format
" " - No Calendar condition applies
Comments
The Script function may be used in two different ways.
On the one hand, it is possible to determine a respective object's next date of execution according to given calendar conditions. The object can be identified by its task number, which is displayed in the graphical picture of the Workflow in the order in which the objects were added to the Workflow. The schedule shows the objects, which are numbered according to their order in the list of the Schedule tab.
On the other hand, the Script function supports the calculation of the next date on which one, all, or no calendar conditions apply. Up to five calendars may be specified, including calendar keywords. The maximum number of days that are to be considered when checking for the next valid date may be specified for each client by the UC4 administrator in the UC4 Variable UC_CLIENT_SETTINGS with the key
"CALE_LOOK_AHEAD_MAX".
It is possible to specify the date from which on calendar conditions should be checked. Optionally, you may specify a particular Date Format. The default Date Formats to be used are "YYMMDD" or
"YYYYMMDD". A colon or semicolon may be used as a separator between Date Format and Date. If no date is specified, the particular current date is used for calculation .
This script function supplies the date either in the default format or in the format that has been defined in its first parameter.
Please note that the parameters Calendar and Calendar keyword must always be used together (see example below).
Example
The following example shows how to identify the next date on which the object with task number "3" will run in the Workflow "MM.DAY".
: SET &DATE# = CALE_LOOK_AHEAD ( 'YYYYMMDD:20041010' , 'MM.DAY' , '3' )
The second example identifies the next date on which all assigned calendar conditions apply.
356 Chapter 3 Ordered by Function
: SET &DATE# = CALE_LOOK_AHEAD
(, 'ALL' , 'FIRM.CALENDAR' , 'WORKDAYS' , 'FIRM.CALENDAR' , 'READINESS01' )
See also:
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.6 CONV_DATE
Script Function: Converts a date from one date format to another.
Syntax
CONV_DATE
(Date
[, NewDateFormat]
)
Syntax
Date
NewDateFormat
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
New Format for the specified Date.
Format:
or
Return code
Date in the new format
Comments
This script function converts the date format from Date to NewDateFormat.
The old and new date formats are optional parameters. They may be used to specify a particular format to be kept or required.
If you decide not to use the old date format, the date must either be specified in the format "YYMMDD" or
"YYYYMMDD". If NewDateFormat has not been used, the default format "YYMMDD" will be returned.
Use a colon or semi colon as a separator between the old date format and Date.
Automation Engine 357
Examples
In the example shown below, a date is converted from one date format to another. The returned value is stored in a script variable. OldDateFormat and NewDateFormat are not specified. The returned values are
"31.12.1999", "31-12-1999" and "991231".
: SET &QUALIFYINGDATE# = CONV_DATE ( "DDMMYY:311299" , "DD.MM.YYYY" )
: SET &QUALIFYINGDATE# = CONV_DATE ( "991231" , "DD-MM-YYYY" )
: SET &QUALIFYINGDATE# = CONV_DATE ( "DDMMYY:311299" )
See also:
Script element
Description
Converts date and time for use in another time zone.
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.7 CONV_TIMESTAMP
Script function: Converts date and time for use in another time zone
Syntax
CONV_TIMESTAMP
(Time Stamp,
[Time Zone1][,Time Zone2]
)
Syntax
Time stamp
Time Zone 1
Time Zone 2
Description/Format
Time stamp from date and time ("YYYY-MM-DD HH:MM:SS").
Format:
or
Name of a Time Zone object or keyword UTC.
The time zone assigned to a time stamp or UTC.
Format: script literal or script variable
Default: "UTC"
Name of a TimeZone object.
Time zone for which the time stamp is to be converted.
Format: script literal or script variable
Return code
Time stamp in the format ""YYYY-MM-DD HH:MM:SS"
358 Chapter 3 Ordered by Function
Remarks
This script function converts date and time into the "YYYY-MM-DD HH:MM:SS" format for use in another time zone .
In doing so, TimeZone 1 may be used to enter the original time zone on which the calculation is based. If this parameter is left out, or if the keyword UTC is used, UTC (Coordinated Universal Time) is the valid basis for calculation. TimeZone 2 is used to name the time zone for which the time stamp is to be converted. If this optional parameter is not specified, the valid time zone is that of the object, or client in case no time zone has been defined for that object.
If UTC is not used as the basis for calculation, time conversion is inaccurate when converting from summertime to wintertime. For example, if 02:30:00 means the first or second occurrence of this time of day cannot be recognized. UC4 always assumes the first appearance of a certain time during conversion to represent wintertime.
Example
The following example shows time stamp conversion for the 2003/2004 turn of year. The conversion basis is a time zone defined for Sydney, Australia, which is converted to Central European Time. The result,
"2003-12-31 14:00:00", is written to the activation protocol.
: SET &MEZ# = CONV_TIMESTAMP ( "2004-01-01 00:00:00" , "TZ.SYD","TZ.MEZ" )
: PRINT &MEZ#
See also:
Script element
Description
Converts a date from one date format to another
Script Elements - Date and Time
Time
Script Elements - Alphabetical Listing
Script Elements - Ordered By Function
3.12.8 DAY_OF_YEAR
Script Function: Returns the current day of a date of the year.
Syntax
DAY_OF_YEAR
(Date)
Syntax Description/Format
Automation Engine 359
Date
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
Return code
Current day of a Date of the year
Comments
Optionally, you may specify a particular Date Format. The default Date Formats to be used are
"YYMMDD" or "YYYYMMDD". A colon or semicolon may be used as a separator between Date Format and Date.
Example
The example returns the value "366" as the day of the year.
: SET &CURDAY# = DAY_OF_YEAR ( "DD.MM.YY:31.12.00" )
See also:
Script element
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Determines the current time of day.
Returns the current date.
Provides current date and time.
3.12.9 DIFF_DATE
Script Function: Determines the difference between two date entries in days.
Syntax
DIFF_DATE
(Date1,Date2)
Syntax Description/Format
360 Chapter 3 Ordered by Function
Date1
and
Date2
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
Return code
Number of days lying between the two indicated dates
Comments
This script function determines the distance between Date1 and Date2 in days. It is possible for Date2 to be before or after Date1.
When defining dates, Date Format is optional. If no particular Date Format has been defined, the date must be entered in the format "YYMMDD" or "YYYYMMDD". You can use a colon or semicolon as a separator between Date Format and date.
Example
The first example calculates the difference between date entries. The dates use the default format
"YYMMDD" and "YYYYMMDD". The result "1" is output in the report.
: SET &DIFF# = DIFF_DATE ( "000330" , "20000331" )
: PRINT &DIFF#
In the second example, the date entries are assigned to the script variables. The script function is called with this script variable. Because the data do not use a default format, the special date format must also be used with the script variables. The result "366" is output in the report.
: SET &DATE1# = "01-01-2000"
: SET &DATE2# = "01012001"
: SET &DIFF# = DIFF_DATE ( "DD-MM-YYYY:&DATE1#" , "DDMMYYYY;&DATE2#" )
: PRINT &DIFF#
The third example has the same result as the second example. The difference here is that the script variables are assigned a date format and a date.
: SET &DATE1# = "DD-MM-YYYY:01-01-2000"
: SET &DATE2# = "DDMMYYYY:01012001"
: SET &DIFF# = DIFF_DATE ( &DATE1# , &DATE2# )
: PRINT &DIFF#
See also:
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Listed by Function
Automation Engine 361
3.12.10 DIFF_TIME
Script Function: Returns the difference between two time entries
DIFF_TIME
(Time1, Time2
[,Output Format]
)
Syntax
Time1
and
Time2
Output Format
Description/Format
Indication of a time in the format "HHMMSS".
Format:
or
It is also possible to specify a different
. Do so by entering the required time format, then enter a separator (;) and afterwards the time.
Indicating a time format is optional.
Format for the determined time.
Format:
Return code
Time in the specified format
UC4 Name
, script literal or script variable
Default: "HHMMSS"
Comments
This script function returns the difference between Time1 and Time2. The time difference is always calculated between the current earlier time to the later time. Therefore, it makes no difference whether the later time is Time1 or Time2.
The script function is assigned two times. Optionally, you may specify a particular time format. If no particular Time Format has been defined, the time must be specified in the default format "HHMMSS".
Only a semicolon may be used as a separator between Time Format and the time. If special terms are used with Time Format, the specified number of hours, minutes and seconds is calculated. "00" is currently used for missing information.
Output Format is optional. If Output Format is not used, the script function returns a time with the default format "HHMMSS".
Examples
The first example returns the difference between the time entries. The times use the default format
"HHMMSS". The result "003000" is output in the report.
: SET &DIFF# = DIFF_TIME ( "230000" , "223000" )
: PRINT &DIFF#
In this example, a special term is used for the second time entry. As a result, the hours and seconds are automatically "00". An output format is predetermined. The result "00:09" appears in the report.
: SET &DIFF# = DIFF_TIME ( "HH:MM:SS;00:01:30" , "MM;11" , "HH:MM" )
: PRINT &DIFF#
362 Chapter 3 Ordered by Function
In the third example, the times are assigned to the script variables. The script function is called with these script variables. Because the time does not use the default format, the special time format must also be specified for the script variables. The result "120000" is output in the report.
: SET &TIME1# = "00:00:00"
: SET &TIME2# = "12:00:00"
: SET &DIFF# = DIFF_TIME ( "HH:MM:SS;&TIME1#" , "HH:MM:SS;&TIME2#" )
: PRINT &DIFF#
See also:
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.11 FIRST_OF_PERIOD
Script Function: Determines the first day of the period for a specified date
Syntax
FIRST_OF_PERIOD
(Date, Period Format
[, Output Format[, Calendar, Calendar Keyword]]
)
Syntax
Date
Period Format
Output Format
Calendar
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
for the Period
Format guidelines for the determined date
Format: script literal or script variable
Default: YYMMDD
Name of the calendar which should be taken into account for the period beginning
Format:
Calendar Keyword
UC4 Name
, script literal or script variable
Name of the calendar keyword which should be taken into account for the period beginning
Format: UC4 Name, script literal or script variable
Automation Engine 363
Return codes
Date of period start in the specified format
"20327" - The Calendar object does not exist
"20328" - The Calendar keyword does not exist in the Calendar object
"20456" - The Calendar keyword does not include the period's starting date
Comments
This script function determines the first day of the period to which a specified date belongs. The returned value is a date.
The script function is given a date. Optionally, you may specify a particular date format. The default date formats to be used are "YYMMDD" or "YYYYMMDD". A colon or semicolon may be used as a separator between Date Format and Date.
With Period Format, the type of period (year, quarter, month or week) is defined.
Note: There is a special period format "WS" for this function. That way Sunday is always taken as the first day of the week. "WW", however, takes Monday as the first day of the week.
Output Format is optional. If Output Format is not used, the script function returns the default format
"YYMMDD" as the date. Please note: Commas are to be used when Output Format is not used but
Calendar and Calendar Keyword are specified.
If Calendar and Calendar Keyword are used, this script function returns the correct calendar day of the period. If there is no valid calendar day for this period, the result is a zero date in the respective date format
(e.g.: 0000-00-00).
The script statement
may be used to determine the reaction to this error which can then be analyzed with the
Script Functions for Error Handling
. Script processing is continued but can also be canceled if required.
Examples
The first example determines the day of the week as 03/29/2000. As a result, 27.03.00 (Monday) is output in the activation protocol.
: SET &DATE# = FIRST_OF_PERIOD ( "000329" , "WW","DD.MM.YY" )
: PRINT &DATE#
With the special period format "WS", 26.03.00 (Sunday) is output in the activation protocol.
: SET &DATE# = FIRST_OF_PERIOD ( "DD.MM.YY:29.03.00" , "WS","DD.MM.YY" )
: PRINT &DATE#
In the third example, the first correct calendar day of a quarter is determined. The guidelines of an output format are not taken into account.
: SET &DATE# = FIRST_OF_PERIOD ( "000329" , "Q" , , READINESS, WEEKDAY)
: PRINT &DATE#
See also:
Script element Description
Determines the last day of period of a specified date
364 Chapter 3 Ordered by Function
Determines the reaction to certain errors and messages of script elements
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.12 LAST_OF_PERIOD
Script Function: Determines the last day of period of a specified date
Syntax
LAST_OF_PERIOD
(Date, Period Format
[, Output Format[, Calendar, Calendar Keyword]]
)
Syntax
Date
Period Format
Output Format
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
for the Period.
Format guidelines for the determined date.
Format:
Calendar
Calendar Keyword
UC4 Name
, script literal or script variable
Default: YYMMDD
Name of the calendar which should be taken into account for the period ending.
Format: UC4 Name, script literal or script variable
Name of the calendar keyword which should be taken into account for the period ending.
Format: UC4 Name, script literal or script variable
Return codes
Date of the period end in the specified format
"20327" - The Calendar object does not exist
"20328" - The Calendar keyword does not exist in the Calendar object
"20456" - The Calendar keyword does not include the end date of the period
Automation Engine 365
Comments
This script function determines the last day of the period to which a specified date belongs. The returned value is a date.
The script function is assigned a date. Optionally, you may specify a particular Date Format. The default
Date Formats to be used are "YYMMDD" or "YYYYMMDD". A colon or semicolon may be used as a separator between Date Format and Date.
With Period Format, the type of period (year, quarter, month or week) is defined.
Note: There is a special period format "WS" for this function. That way Sunday is always taken as the first day of the week. "WW", however, takes Monday as the first day of the week.
Output Format is optional. If Output Format is not used, the script function returns the default format
"YYMMDD" as the date. Please note: Commas are to be used when Output Format is not used but
Calendar and Calendar Keyword are specified.
If Calendar and Calendar Keyword are used, this script function returns the correct calendar day of the period. If there is no valid calendar day for this period, the result is a zero date in the respective date format
(e.g.: 0000-00-00).
With the script statement
you can determine the reaction to this error. As before, you can analyze the error with the
Script Functions for Error Handling . The script will continue to be processed. It is
also possible to cancel the processing of the script.
Examples
The first example determines the last day of the week for the 03/29/2000. The result 02.04.00 (Sunday) is output in the activation protocol.
: SET &DATE# = LAST_OF_PERIOD ( "000329" , "WW" , "DD.MM.YY" )
: PRINT &DATE#
With the special period format "WS", the date 01.04.00 (Saturday) is output in the activation protocol.
: SET &DATE# = LAST_OF_PERIOD ( "DD.MM.YY:29.03.00" , "WS" , "DD.MM.YY" )
: PRINT &DATE#
In the third example, the first correct calendar day of a quarter is determined. The guidelines of an output format are not taken into account.
: SET &DATE# = LAST_OF_PERIOD ( "000329" , "Q" , , READINESS, WEEKDAY)
: PRINT &DATE#
See also:
Script element Description
Determines the first day of the period for a specified date.
Determines the reaction to certain errors and messages of script elements.
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
366 Chapter 3 Ordered by Function
3.12.13 SUB_DAYS
Script Function: Subtracts days from a given date
Syntax
SUB_DAYS
(Date, Days
[, Calendar, Calendar Keyword]
)
Syntax
Date
Days
Calendar
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
A value specifying a number of days.
Format: script literal - number without quotation marks or script variable
The name of the relevant Calendar.
Format:
Calendar Keyword
UC4 Name
- script literal or script variable
The name of the relevant Calendar keyword.
Format: UC4 Name, script literal or script variable
Return code
Date in the specified format
"0" - No days have been assigned to this Calendar keyword or the calculated date lies out of the
Calendar range.
"20327" - Calendar object does not exist
"20328" - Calendar keyword does not exist in the Calendar object
Comments
This function subtracts Days from a given Date. Optionally, you may execute these functions depending on Calendar and Calendar Keyword. In this case only Days which are valid due to the relevant calendar definitions will be taken into account.
If you specify a particular data format, the date will be returned in this format. If no date format has been specified, use the default formats "YYMMDD" or "YYYYMMDD" and the date will be returned in the corresponding format. Use a colon or semicolon as a separator between Date format and Date.
It is also possible to specify zero Days. If the Date is valid according to the Calendar, this date will be returned. If it is not valid, the previous valid date (Calendar conditions) will bereturned.
Automation Engine 367
The range of the specified Calendar is automatically considered in calendar calculations. This range depends on the settings the UC4 administrator defined in the UC4 Variable UC_CLIENT_SETTINGS in the keys NOW_MINUS and NOW_PLUS. Code "0" will be returned if the calculated date lies beyond this defined range".
Examples
The first example subtracts two days from a specified date. The result ("000330") is output in the activation protocol.
: SET &DATE# = SUB_DAYS ( "000401" , 2)
: PRINT &DATE#
The second example queries the number of days to be stored by the user using a script statement. This function deducts the retrieves number from the current date and stores the result in a script variable. The default format "YYMMDD" is used because no date format has been specified.
: SET &CURDATE# = SYS_DATE ()
: READ &NUMBER# , "00" , " Store how many days?" , "08" ,N
: SET &RETDATE# = SUB_DAYS ( &CURRENTDATE# , &NUMBER# )
The third example calculates the current date. Two days are then deducted from this date. As it was not retrieved in the default format, the required date format must again be specified in the script variable.
: SET &CURDATE# = SYS_DATE ( "DD.MM.YY" )
: SET &PWRKDAY# = SUB_DAYS ( "DD.MM.YY:&CURDATE#" , 2)
See also:
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.14 SUB_PERIOD
Script Function: Subtracts a period from a specified date.
Syntax
SUB_PERIOD
(Date, Period Format:Period
[, Output Format]
)
Syntax
Date
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
368 Chapter 3 Ordered by Function
Period Format:Period
Output Format
Format: script literal or script variable.
Period: Specification of a period to be subtracted from the specified date.
Period Format:
for the Period.
Use a colon (:) or semi colon (;) as a separator between the Period Format and the Period.
Format guidelines for the determined date.
Format:
, script literal or script variable
This script function subtracts years, months, quarters or weeks from a specified date.
Output Format is an optional parameter. This script function returns a date in the default format
"YYMMDD" if Output Format has not been specified.
Keep this in mind when subtracting years, quarters and months.
: SET &DATE# = SUB_PERIOD ( "DD.MM.YY:05.07.00"
, "WW;2" , "DD.MM.YYYY" )
: SET &DATE# = SUB_PERIOD ( "000731"
, "Q:1" , "DD-MM-YYYY" )
In the third example, a year is subtracted from 02/28/2001. 28.02.2000 is output in the report.
: SET &DATE# = SUB_PERIOD ( "20010228"
, "YY:0001" ,DD.MM.YYYY)
Script Elements - Date and Time
Automation Engine 369
Script Elements - Alphabetical Listing
Script Elements - Listed by Function
3.12.15 SUB_TIME
Script Function: Subtracts two times
Syntax
SUB_TIME
(Time1, Time2
[,Output Format]
)
Syntax
Time1
and
Time2
Output Format
Description/Format
Indication of a time in the format "HHMMSS".
Format:
or
It is also possible to specify a different
. Do so by entering the required time format, then enter a separator (;) and afterwards the time.
Indicating a time format is optional.
Format for the determined time.
Format:
Return code
Time in the specified format
UC4 Name
, script literal or script variable
Default: "HHMMSS"
Comments
With this script function you subtract two times. The change from 23:59:59 to 00:00:00 is taken into account.
The script function is assigned two times. Optionally, you may specify a particular time format. If no particular Time Format has been defined, the time must be specified in the default format "HHMMSS".
Only a semicolon may be used as a separator between Time Format and the time.
Output Format is optional. If Output Format is not used, the script function returns a time with the default format "HHMMSS".
Examples
The first example does not use a time format. The result ("110000") is output in the activation protocol.
370 Chapter 3 Ordered by Function
: SET &TIME# = SUB_TIME ( "120000" , "010000" )
: PRINT &TIME#
The second example uses time format and output format. The result is "23:00".
: SET &TIME# = SUB_TIME ( "040000" , "HH;05" , "HH:MM" )
: PRINT &TIME#
In the third example, 31 seconds are subtracted from 00:00:10. Time format is used, output format is not.
The result ("235940") corresponds to the default format.
: SET &TIME# = SUB_TIME ( "HH:MM:SS;00:00:10" , "SS;30" )
: PRINT &TIME#
Same example as the third. The difference is that a special term is used for the output format. The result
("86380") is the conversion of 23:59:40 into seconds.
: SET &TIME# = SUB_TIME ( "HHMMSS;000010" , "SS;30" , SS)
: PRINT &TIME#
See also:
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.16 SUB_TIMESTAMP
Script function: Subtracts time from a time stamp
Syntax
SUB_TIMESTAMP
(Time Stamp,Time)
Syntax
Time stamp
Time
Description/Format
Time stamp from date and time ("YYYY-MM-DD HH:MM:SS").
Format:
or
Time ("HH:MM:SS") to be subtracted from a time stamp.
Format: script literal or script variable
Allowed values: 0 to 99 (for each HH, MM and TT)
Return code
Time stamp in the "YYYY-MM-DD HH:MM:SS" format
Automation Engine 371
Comments
This script function subtracts time in the "HH:MM:SS" format from a given time stamp in the "YYYY-MM-
DD HH:MM:SS" format.
In doing so, UTC is used for calculation. This means that summer and winter time are not considered. A maximum value of 99 is allowed for hours, minutes and seconds, so the script function's result can lie a bit more than 4 days before the original time stamp.
Example
In the following example, one second is subtracted from the time stamp. The result "2003-12-31 23:59:59" is written to the activation protocol.
: SET &RET# = SUB_TIMESTAMP ( "2004-01-01 00:00:00" , "00:00:01" )
: PRINT &RET#
See also:
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered By Function
3.12.17 SYS_DATE
Script Function: Returns the current date at the beginning of the script processing
Syntax
SYS_DATE
(
[Date Format][,TimeZone]
)
Syntax
Date Format
TimeZone
Description/Format
for the retrieved date.
Format:
or
Default: "YYMMDD"
Name of a TimeZone object or the keyword UTC.
Format: script literal or script variable
Return code
Current date in the specified format
Comments
This script function determines the current day's date. A TimeZone , entered as a parameter, is included.
372 Chapter 3 Ordered by Function
Date Format is optional. It is used to determine the format in which the function should return values. If you do not specify Date Format, the default format "YYMMDD" is used.
TimeZone is also optional. If the script function is called without this parameter, the object's TimeZone is used, or that of the client if none has been defined for the object itself. If a non-defined TimeZone is entered, the default value (Client's TimeZone) is used. Instead of a TimeZone, the keyword UTC may be used. The date is returned directly in UTC (Coordinated Universal Time).
The current date is determined at the beginning of the script processing and "frozen". This ensures the consistency of the script. If you use the script function repeatedly within a script, the same date will always be returned. This is especially important when the script processing for a specified time period is
interrupted by a :WAIT statement .
In order to transfer the current date with the script statement
to a Variable object of the type
"Time stamp", you must use the date formats "YYMMDD" (Default), "YYYYMMDD" or "YYYY-MM-DD".
This format is not saved after saving to the Variable on the Windows platform. The display of the date is based now on the regional options in the control panel of Windows.
Examples
In the first example, the current date is retrieved and stored in a script variable. The second example shows that it is also possible to use special terms. The day of the week is retrieved while using a script variable as a function parameter.
: SET &DATE# = SYS_DATE ( "DD.MM.YYYY" )
: SET &FORMAT# = "WW"
: SET &WEEKDAY# = SYS_DATE ( &FORMAT# )
This example shows how this function is used without specification of Date Format.
: IF SYS_DATE () = "990101"
!...
: ENDIF
In the third example, the current date is determined and saved in a Variable object of the type "Time stamp". A TimeZone is used which has been defined for Central European Time.
: SET &DATE# = SYS_DATE ( "YYYY-MM-DD" , "TZ.MEZ" )
: PUT_VAR BOOKING.DATE, , &DATE#
See also:
Script element
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Converts a date from one date format to another.
Determines the difference between two date entries in days.
Returns the current date.
Returns the logical date.
Automation Engine 373
3.12.18 SYS_DATE_PHYSICAL
Script Function: Returns the current date
Syntax
SYS_DATE_PHYSICAL
(
[Date Format][,TimeZone]
)
Syntax
Date Format
TimeZone
Description/Format
for the determined date.
Format:
or
Default value: "YYMMDD"
Name of a TimeZone object or the keyword UTC.
Format: script literal or script variable
Return code
Current date in the specified format
Comments
This script function determines the current day's date. A TimeZone , entered as a parameter, is included.
If the script function is repeatedly used within a script, different results might be supplied (if there is a change of date between the first and the second call, for example). Thus, this script function differs from
- which determines the date of the beginning of the script processing and keeps it, in order to ensure the consistency of the script.
Date Format is optional. It serves to define the format in which the value is returned. If you have not specified Date Format, the default format "YYMMDD" is returned.
TimeZone is also optional. If the script function is called without this parameter, the object's TimeZone is used, or that of the client if none has been defined for the object itself. If a non-defined time zone is entered, the default value (client's time zone) is used. Instead of a time zone, the keyword UTC may be used. The date is then returned in UTC (Coordinated Universal Time).
Examples
The first example determines the date and gives the value to a script variable. In the second example should show that the entry of partial terms is also possible. The weekday is determined and a script variable used as a function parameter.
: SET &DATE# = SYS_DATE_PHYSICAL ( 'DD.MM.YYYY' )
: SET &FORMAT# = 'WW'
: SET &WEEKDAY# = SYS_DATE_PHYSICAL ( &FORMAT# )
If the function is used without the specification of Date Format, the syntax is as in the following example.
: IF SYS_DATE_PHYSICAL () = '990101'
!...
: ENDIF
374 Chapter 3 Ordered by Function
In the third example, the current day's date is determined. A TimeZone is used which has been defined for
Central European Time. The result is written out in the activation protocol.
: SET &DATE# = SYS_DATE_PHYSICAL ( 'YYYY-MM-DD' , 'TZ.MEZ' )
: PRINT &DATE#
See also:
Script element
Description
Converts a date from one date format to another.
Determines the difference between two date entries in days.
Returns the logical date.
Returns the current date at the beginning of the script processing.
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.19 SYS_LDATE
Script Function: Returns the logical date.
Syntax
SYS_LDATE
(
[Date Format]
)
Syntax
Date Format
Description/Format
for the retrieved date.
Format:
or
Return code
The logical date in the specified format
Comments
A logical date may be specified for the execution of tasks. This script function then retrieves it.
Date Format is optional. It is used to determine the format in which the function should return values. If you do not specify Date Format, the default format "YYMMDD" is used.
Keep in mind that this script function used in
!Process
tabs of Events does not supply the logical but the CURRENT date.
Automation Engine 375
Example
The example shown below retrieves the logical date in the format "MM/DD/YYYY".
: SET &LDATE# = SYS_LDATE ( "MM/DD/YYYY" )
See also:
Script element
Description
Converts a date from one date format to another.
Determines the difference between two date entries in days.
Returns the current date at the beginning of the script processing.
Returns the current date.
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.20 SYS_TIME
Script Function: Returns the current time of day at the beginning of the script processing.
Syntax
SYS_TIME
(
[Time Format][,TimeZone]
)
Syntax
Time Format
TimeZone
Description/Format
for the retrieved time.
Format:
or
Default: "HHMMSS"
Name of a TimeZone object or keyword UTC.
Format: script literal or script variable
Return code
Current time in the specified format
Comments
This script function determines the current day's date. A TimeZone , entered as a parameter, is included.
Time Format is optional. It is used to determine the format in which the function should return values. If you do not specify a Time Format, the default format "HHMMSS" is used.
376 Chapter 3 Ordered by Function
TimeZone is also optional. If the script function is called without this parameter, the object's TimeZone is used, or that of the client if none has been defined for the object itself. If a non-defined TimeZone is entered, the default value (client's TimeZone) is used. Instead of a TimeZone, the keyword UTC may be used. The date is returned in UTC (Coordinated Universal Time).
The current time is determined at the beginning of the script processing and kept. This ensures the consistency of the script. If you use the script function repeatedly within a script, the same time will always be returned. This is especially important when the script processing for a specified time period is
interrupted with a :WAIT statement .
In order to transfer the current date to a Variable object of the type "Time Stamp" with the script statement
, the date formats "YYMMDD" (Default), "YYYYMMDD" or "YYYY-MM-DD" must be used.
This format is not stored when the Variable is stored on the Windows platform. The display of the date is now based on the regional options in the control panel of Windows.
The time can only be saved together with the date in a Variable of the type "Time stamp". Only the following combinations of date and time format are allowed: "YYMMDD HHMMSS" (Default), "YYYY-MM-
DD" and "YYYYMMDD HHMMSS".
Examples
The first example determines the current time of day and gives the value to a script variable. A TimeZone is used which has been defined for Central European Time. The result is written out in the activation protocol.
: SET &TIME# = SYS_TIME ( "HH:MM:SS" , "TZ.MEZ" )
: PRINT &TIME#
In the second example, a special term is used and transferred with a script variable. Only the seconds of the current time of day are determined.
: SET &FORMAT# = "SS"
: SET &TIME# = SYS_TIME ( &FORMAT# )
If the function is used without the specification of Time Format and TimeZone, the syntax is as in the following example.
: IF SYS_TIME () = "120000"
!...
: ENDIF
In the third example, the current date and time are determined and saved in a Variable object of the type
"Time Stamp". For date and time format, the following default values apply.
: SET &DATE# = SYS_DATE ()
: SET &TIME# = SYS_TIME ()
: PUT_VAR ENTRY DATE, , "&DATE# &TIME#"
See also:
Script element
Script Elements - Date and Time
Description
Determines the current time of day.
Provides current date and time.
Automation Engine 377
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.21 SYS_TIME_PHYSICAL
Script Function: Determines the current time of a day
Syntax
SYS_TIME_PHYSICAL
(
[Time Format][,TimeZone]
)
Syntax
Time Format
TimeZone
Description/Format
for the determined time
Format:
or
Default: "HHMMSS"
Name of a TimeZone object or keyword UTC
Format: script literal or script variable
Return code
Current time in the specified format
Comments
This script function determines the current time of a day. A TimeZone that has been specified in the form of a parameter is considered in this calculation.
Note: Repeated usage of this script function within a script may result in differing results (e.g. in queries to the second or minute). Thus, the script function differs from
which determines the time at the start of script processing and then keeps this time in order to ensure the consistency of the script.
TimeFormat is optional. It serves to determine the format in which the value should be returned. The default format "HHMMSS" is returned if no TimeFormat is specified.
TimeZone is also an optional parameter. If the script function is called without it, the object's TimeZone is used, or that of the client if none was defined for the object. If a non-defined TimeZone is specified, the default value (client's TimeZone) is used. The keyword UTC may be used instead of a TimeZone. The time is then returned in UTC (Coordinated Universal Time).
Examples
The first example determines the current time of date and supplies the values to script variables. The results are two times which are separated by at least ten second.
: SET &TIME1# = SYS_TIME_PHYSICAL ( "HH:MM:SS" )
: WAIT 10
: SET &TIME2# = SYS_TIME_PHYSICAL ( "HH:MM:SS" )
378 Chapter 3 Ordered by Function
In the second example, the current time of day is determined in UTC. Calling up the script function a second time, a TimeZone is given which is defined for CET. The result is two times, at least 1 hour and 10 seconds apart.
: SET &TIME1# = SYS_TIME_PHYSICAL ( "HH:MM:SS" , "UTC" )
: WAIT 10
: SET &TIME2# = SYS_TIME_PHYSICAL ( "HH:MM:SS" , "TZ.MEZ" )
In the third example, a special term is used and assigned with a script variable. Only the minutes of the current time of day are determined.
: SET &FORMAT# = "MM"
: SET &TIME# = SYS_TIME_PHYSICAL ( &FORMAT# )
If the function is used without the specification of Time Format, the syntax is as in the following example.
: IF SYS_TIME_PHYSICAL () = "120000"
!...
: ENDIF
See also:
Script element
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Returns the current time of day at the beginning of the script processing.
Provides current date and time.
3.12.22 SYS_TIMESTAMP_PHYSICAL
Script function: Provides current date and time
Syntax
SYS_TIMESTAMP_PHYSICAL
(
[Time Zone]
)
Syntax
TimeZone
Description/Format
Name of a TimeZone object or keyword UTC
Format:
or
Default value: "UTC"
Return code
Current date and time in the format "JJJJ-MM-TT HH:MM:SS"
Automation Engine 379
Remarks
If the script function is called up without a parameter, or if the keyword UTC is used, date and time are returned in UTC (Coordinated Universal Time).
Example
The following example determines the current date and time in Sydney. The name of a TimeZone object is entered as a parameter, having been defined for the Australian Eastern Standard Time. The script function's return value is written to the activation protocol.
: SET &NOW# = SYS_TIMESTAMP_PHYSICAL ( "TZ.SYD" )
: PRINT &NOW#
See also:
Script element
Description
Returns the current time of day at the beginning of the script processing.
Determines the current time of day.
Script Elements - Date and Time
Time
Script Elements - Alphabetical Listing
Script Elements - Ordered By Function
3.12.23 VALID_CALE
Script Function: Checks whether a date is included in the Calendar keyword
Syntax
VALID_CALE
(Date, Calendar, Calendar Keyword)
Syntax
Date
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
380 Chapter 3 Ordered by Function
Calendar
Name of the calendar object
Format:
, script literal or script variable
Format: UC4 Name, script literal or script variable
"Y" - The date is included in the Calendar keyword
"N" - The date is not included in the Calendar keyword
Optionally, you may specify a particular Date Format. The default Date Formats to be used are
: SET &OPERATOR# = VALID_CALE ( &CURDATE#
, "READINESS" , "WORKDAY" )
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Checks if the date is valid.
Checks if a time is valid.
Automation Engine 381
3.12.24 VALID_DATE
Script Function: Checks if the date is valid
Syntax
VALID_DATE
(Date)
Syntax
Date
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
Return codes
"Y" - The date is valid
"N" - The date is invalid
Comments
Optionally, you may specify a particular Date Format. The default Date Formats to be used are
"YYMMDD" or "YYYYMMDD". A colon or semicolon may be used as a separator between Date Format and Date.
If return code "N" is supply, the
script elements for error handling
may help to analyze the occurred error.
Example
The example checks if the year 2001 is a leap year. The result (N) is output in the activation protocol.
: SET &RET# = VALID_DATE ( "DD.MM.YYYY:29.02.2001" )
: PRINT &RET#
See also:
Script element
Description
Checks whether or not a date is included in a Calendar keyword
Checks if a time is valid
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
382 Chapter 3 Ordered by Function
3.12.25 VALID_TIME
Script Function: Checks if a time is valid
Syntax
VALID_TIME
(Time)
Syntax
Time
Description/Format
Indication of a time in the format "HHMMSS".
Format:
or
It is also possible to specify a different
. Do so by entering the required time format, then enter a separator (;) and afterwards the time.
Indicating a time format is optional.
Return codes
"Y" - Time is valid
"N" - Time is invalid
Comments
Optionally, you may specify a particular Date Format. The default Date Formats to be used are
"YYMMDD" or "YYYYMMDD".You may only use a semicolon as a separator between Time Format and
Time.
Examples
The example checks if the specified time is valid. The result (N) is output in the activation protocol.
: SET &RET# = VALID_TIME ( "HH:MM:SS;24:00:00" )
: PRINT &RET#
The second example gives a positive result (Y).
: SET &RET# = VALID_TIME ( "HH:MM:SS;00:00:00" )
: PRINT &RET#
See also:
Script element
Description
Checks whether or not a date is included in a Calendar keyword
Checks if the date is valid.
Script Elements - Date and Time
Automation Engine 383
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.26 WEEK_NR
Script Function: Returns the calendar week of a date
Syntax
WEEK_NR
(Date)
Syntax
Date
Return code
Calendar week (3-figure)
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
Comments
Optionally, you may specify a particular Date Format. The default Date Formats to be used are
"YYMMDD" or "YYYYMMDD". A colon or semicolon may be used as a separator between Date Format and Date.
Calendar week calculation depends on the definitions made for the first calendar week of the year. The particular week that should be regarded as the starting week may be determined by the UC4 administrator in the UC4 Variable UC_CLIENT_SETTINGS with the keys "FIRST_WEEK_METHOD" and "FIRST_DAY_OF_WEEK".
Example
The function returns the calendar week "052" of this day.
: SET &CW# = WEEK_NR ( "991231" )
See also:
Script element
Description
Returns the day of a week of a given date as a number
Returns the day of the week of a given date as an abbreviation
Script Elements - Date and Time
384 Chapter 3 Ordered by Function
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.27 WEEKDAY_NR
Script Functions: Returns the day of a week of a given date as a number
Syntax
WEEKDAY_NR
(Date)
Syntax
Date
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
Return codes
"1" - Monday
"2" - Tuesday
"3" - Wednesday
"4" - Thursday
"5" - Friday
"6" - Saturday
"7" - Sunday
Comments
Optionally, you may specify a particular Date Format. The default Date Formats to be used are
"YYMMDD" or "YYYYMMDD". A colon or semicolon may be used as a separator between Date Format and Date.
Examples
In these examples, the functions return the values "5" and "6" for the specified date.
: SET &SILVESTER_2000# = WEEKDAY_NR ( 'DD.MM.YY:31.12.99' )
: SET &NEWYEAR_2000# = WEEKDAY_NR ( "DD.MM.YYYY:01.01.2000" )
See also:
Script element Description
Automation Engine 385
Returns the calendar week of a date.
Returns the day of the week of a given date as an abbreviation.
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.28 WEEKDAY_XX
Script Function: Returns the day of the week of a given date as an abbreviation
Syntax
WEEKDAY_XX
(Date)
Syntax
Date
Description/Format
Indication of a date in the format "YYMMDD" or "YYYYMMDD".
Format:
or
It is also possible to specify a different
. Do so by entering the required date format, then enter a separator (: or ;) and afterwards the date.
Indicating a date format is optional.
Return codes
"MO" - Monday
"DI" - Tuesday
"MI" - Wednesday
"DO" - Thursday
"FR" - Friday
"SA" - Saturday
"SO" - Sunday
Comments
Optionally, you may specify a particular Date Format. The default Date Formats to be used are
"YYMMDD" or "YYYYMMDD". A colon or semicolon may be used as a separator between Date Format and Date.
Examples
In these examples, the functions return the values "FR" and "SA" for the specified date.
: SET &SILVESTER_2000# = WEEKDAY_XX ( "991231" )
: SET &NEWYEAR_2000# = WEEKDAY_XX ( "DD-MM-YYYY:01-01-2000" )
386 Chapter 3 Ordered by Function
See also:
Script element
Description
Returns the calendar week of a date.
Returns the day of a week of a given date as a number.
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.12.29 YEAR_9999
Script Function: Extracts the year from a given date
Syntax
YEAR_9999
(
[Date Format:]
Date)
Syntax
Date Format
: or ;
Date
[Date Format:]Date
Description/Format
Format: for the given Date
Separator between the Date Format and the Date
Specification of a date according to the Date Format
or
Return code
Cipher of the year (4-figure)
Comments
The entry of Date Format is optional. If Date Format is not used, the date must be specified in the format
"YYMMDD" or "YYYYMMDD". A colon or semicolon can be used as a separator between Date Format and Date.
Example
The example returns the value '2000' as the year of the specified date.
: SET &YEAR# = YEAR_9999 ( "DD.MM.YY:31.12.00" )
See also:
Automation Engine 387
Script Elements - Date and Time
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.13 Arithmetic
3.13.1 ADD
Script Function: It performs an addition.
Syntax
ADD
(Operand1, Operand2)
Syntax
Operand1
Operand2
Description/Format
The first expression.
Format:
or number specified without quotation marks.
The second expression.
Format: script literal, script variable or number specified without quotation marks.
Return code
Result of the addition
Comments
Adds Operand1 to Operand2. The values that are returned are 16-digit alphanumeric terms (strings) with leading zeros.
Operand1 andOperand2must be expressions that correspond to numbers in the allowed value range of the
. The result must not exceed this range .
You can assign the result to a script variable but it must show the corresponding data type. Any attempt to store a negative number to a variable of the data type "unsigned" results in an error. If the result is a floating-point number and the target variable is of data type "signed" or "unsigned", the decimal positions are truncated. The data type "float" supports negative numbers and floating-point numbers. The data type
"string" can also be used. In this case, the result is stored as a string instead of a number. The data type of script variables can be defined by using the script element
.
The result's data type is decisive and not the operand's data type. A negative and a positive operand can result in a positive number which can then be stored in a target variable of the data type "unsigned".
Note that arithmetic operations using floating-point numbers can supply inexact results.
388 Chapter 3 Ordered by Function
The result is returned in the 16-digit default format. Floating-point numbers also include 16 decimal places and an algebraic sign (+ or -) is used as the first sign if negative numbers are supported.
Formatting can be changed by using the script function FORMAT
.
Examples
The first example stores the arithmetic operation's result in a script variable. Operand1 and Operand2 are numeric expressions.
: SET &RESULT# = ADD (1000,333)
The second example uses this script function in order to define a condition.
: SET &MAXIMUM# = 3000
: SET &RUN1# = 5000
: SET &RUN2# = 2000
!...
: IF ADD ( &RUN1# , &RUN2# ) > &MAXIMUM#
!...
: ENDIF
The following example adds up two floating-point numbers.
: DEFINE &RESULT# ,float
: SET &RESULT# = ADD (10.31,-5.45)
: P &RESULT#
The result is output in the activation protocol as follows:
U0020408 +0000000000000004.8600000000000000
Another Way to Perform Addition
Another way to perform addition is shown below. In this example, the value of a script variable is set to the sum of 1 plus 1.
: SET &ADD# = 1 + 1
: P &ADD#
The result is output in the activation protocol as follows:
U0020408 0000000000000002
See also:
Script element
Description
Performs a subtraction.
Performs a multiplication.
Performs a division.
Returns the remainder of a division.
Generates random numbers.
Automation Engine 389
Script Elements - Alphabetical Listing
Script Elements - ordered by function
3.13.2 DIV
Script Function: It performs a division.
Syntax
DIV
(Operand1, Operand2)
Syntax
Operand1
Operand2
Description/Format
The first expression.
Format:
or number specified without quotation marks.
The second expression.
Format: script literal, script variable or number specified without quotation marks.
Return code
Result of the division
Comments
The script function divides Operand1 by Operand2.
Operand1 and Operand2 must be expressions which correspond to numbers within the allowed value range of the
. The result must not exceed this range .
The Operand2 must not be zero.You can assign the result to a script variable but it must show the corresponding data type. Any attempt to store a negative number to a variable of the data type "unsigned" results in an error. If the result is a floating-point number and the target variable is of data type "signed" or
"unsigned", the decimal positions are truncated. The data type "float" supports negative numbers and floating-point numbers. The data type "string" can also be used. In this case, the result is stored as a string instead of a number. The data type of script variables can be defined by using the script element
The result's data type is decisive and not the operand's data type. Two negative operands result in a positive number which can then be stored in a target variable of the data type "unsigned".
Note that arithmetic operations using floating-point numbers can supply inexact results.
The result is returned in the 16-digit default format. Floating-point numbers also include 16 decimal places and an algebraic sign (+ or -) is used as the first sign if negative numbers are supported.
Formatting can be changed by using the script function FORMAT
.
390 Chapter 3 Ordered by Function
Examples
The first example passes the division result "5" on to a script variable. Script variables are used as
Operand1 and Operand2.
: SET &OP1# = '100'
: SET &OP2# = '20'
: SET &RESULT# = DIV ( &OP1# , &OP2# )
Decimal places are truncated if the target variable's data type is not "float. Therefore, the value "0" is stored to the variable in the following example.
: DEFINE &RESULT# , unsigned
: SET &RESULT# = DIV (10,30)
The following example shows a division with floating-point numbers.
: DEFINE &RESULT# ,float
: SET &RESULT# = DIV (-9,-2.25)
: P &RESULT#
The result is output in the activation protocol:
U0020408 +0000000000000004.0000000000000000
See also:
Script element
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Performs an addition.
Performs a subtraction.
Performs a multiplication.
Returns the remainder of a division.
Generates random numbers.
3.13.3 GET_BIT
Script function: Checks if a bit is set in a bit field.
Syntax
GET_BIT
(Number, Bit Position)
Syntax
Number
Description/Format
Number to be converted into a binary format (bit field).
Format: Number or
Bit position
Position within the bit field which should be checked.
Format: Number or script variable.
Automation Engine 391
Return code
"0" - Bit is set
"1" - Bit is not set
Comments
This script function converts the number - which is given with the first parameter - into a binary format. The result is a so-called bit field. Subsequently, it checks if the bit is set at the specified position.
The Bit Position is always counted from the right.
This script function is also used to request the 16 bit field MSG_DESCRIPTOR, MSG_LEVEL and MSG_
MISC of a console message in z/OS. These can also be directly queried with the script function
Examples
In the first example, a check is made to determine if the 3rd bit is set in the bit field ("110"). This bit field is the binary format of the number "6". The returned value "1" (bit set) is output to the activation protocol.
: SET &RET# = GET_BIT (6, 3)
: PRINT &RET#
The second example demonstrates checking a component of the console message in z/OS. The returned number is subsequently converted to binary and checked in bit position 3.
: SET &RET# = GET_CONSOLE ( "MSG_DESCRIPTOR" )
: SET &RET# = GET_BIT ( &RET# , 3)
See also:
Script element
Description
Reads message data of an occurred console event.
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
392 Chapter 3 Ordered by Function
3.13.4 MOD
Script Function: It returns the remainder of a division.
Syntax
MOD
(Operand1, Operand2)
Syntax
Operand1
Operand2
Description/Format
The first expression.
Format:
or number specified without quotation marks.
The second expression.
Format: script literal, script variable or number specified without quotation marks.
Return code
Remainder of the division
Comments
This script function returns the remainder of the division of Operand1 by Operand2.
Operand1 and Operand2 must be integers that are within the allowed value ranges of the
"unsigned" and "signed". Floating point numbers are not supported. The result is always a positive or negative integer.
Operand2 must not be zero.
Examples
In the following example, this function returns the result "1".
: SET &rest# = MOD (10,3)
The result of the second example is "10".
: SET &rest# = MOD (10,44)
See also:
Script element
Description
Performs an addition.
Performs a subtraction.
Performs a multiplication.
Performs a division.
Generates random numbers.
Automation Engine 393
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.13.5 MULT
Script Function: It performs a multiplication.
Syntax
MULT
(Operand1, Operand2)
Syntax
Operand1
Operand2
Description/Format
The first expression.
Format:
or number specified without quotation marks.
The second expression.
Format: script literal, script variable or number specified without quotation marks.
Return code
The result of the multiplication
Comments
This script function multiplies Operand1 with Operand2.
Operand1 and Operand2 must be expressions which correspond to numbers within the allowed value range of the
. The result must not exceed this range.
You can assign the result to a script variable but it must show the corresponding data type. Any attempt to store a negative number to a variable of the data type "unsigned" results in an error. If the result is a floating-point number and the target variable is of data type "signed" or "unsigned", the decimal positions are truncated. The data type "float" supports negative numbers and floating-point numbers. The data type
"string" can also be used. In this case, the result is stored as a string instead of a number. The data type of script variables can be defined by using the script element
The result's data type is decisive and not the operand's data type. For example, two negative operands result in a positive number which can then be stored in a target variable of the data type "unsigned".
Note that arithmetic operations using floating-point numbers can supply inexact results.
The result is returned in the 16-digit default format. Floating-point numbers also include 16 decimal places and an algebraic sign (+ or -) is used as the first sign if negative numbers are supported.
Formatting can be changed by using the script function
394 Chapter 3 Ordered by Function
Examples
The first example passes the multiplication result on to a script variable. The result that is returned is
"100".
: SET &OP1# = 4
: SET &OP2# = 25
: SET &RESULT# = MULT ( &OP1# , &OP2# )
The following example shows a multiplication with floating-point numbers.
: DEFINE &RESULT# ,float
: SET &RESULT# = MULT (-10.31,5.45)
: P &RESULT#
The result is output in the activation protocol:
U0020408 -0000000000000056.1895000000000000
See also:
Script element
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Performs an addition.
Performs a subtraction.
Returns the remainder of a division.
Performs a division.
Generates random numbers.
3.13.6 RANDOM
Script Function: Generates random numbers.
Syntax
RANDOM
(Minimum, Maximum
[, Basis]
)
Syntax
Minimum
Maximum
Basis
Description/Format
Minimal value of the generated random number.
Format: Number or
Maximal value of the generated random number.
Format: Number or script variable
Initial value for generation.
Format: Number or script variable
Automation Engine 395
Return code
Random number within the specified range.
Comment
The script function RANDOM generates random numbers. A number generator creates a number set that is determined by using its initial value - the Basis.
If you do not specify Basis, this script function returns a number that continuously varies between
Minimum and Maximum.
If Basis is specified, the random number generator is initialized by this value. The result is a numerical series whose numbers can be read without the Basis being necessary. For a particular initial value, the generated numerical series is always identical: the same numbers are supplied in the same order.
If this script function is processed in a different object at the same time, the numerical series that has already been generated is overwritten.
You can only assign positive integers (data type "unsigned") to this script function. The result is also always a positive integer.
Examples
l l
In the first example, this script function supplies a number between 1 and 10 (both numbers are included). The result is "3", for example.
: SET & number# =
RANDOM (1, 10)
The second example generates a numerical series with the parameter Basis being used. These values can be accessed if this function is used again. The first 10 values of the generated numerical with the basis "1" are: 6, 2, 9, 6, 5, 4, 9, 9, 8 and 2. Therefore, the result of the first call that is stored in "&number#" is always "6".
: SET &ret# = RANDOM ( &min# , &max# , 1)
: SET &number# = RANDOM ( &min# , &max# )
Please note that the generated numerical series when using Basis "1" is an example. Depending on the platform RANDOM is being executed on the series may be different.
See also:
Script element
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Description
Performs an addition.
Performs a subtraction.
Performs a multiplication.
Returns the remainder of a division.
Returns the remainder of a division.
396 Chapter 3 Ordered by Function
3.13.7 SUB
Script Function: It performs a subtraction
Syntax
SUB
(Operand1, Operand2)
Syntax
Operand1
Operand2
Description/Format
The first expression.
Format:
or number specified without quotation marks
The second expression.
Format: script literal, script variable or number specified without quotation marks
Return code
The result of the subtraction.
Comments
This script function subtracts Operand2 from Operand1.
Operand1 and Operand2 must be expressions which correspond to numbers in the allowed value range of the
data types . The result must not exceed this range.The Operand2 must not be zero.You can assign the
result to a script variable but it must show the corresponding data type. Any attempt to store a negative number to a variable of the data type "unsigned" results in an error. If the result is a floating-point number and the target variable is of data type "signed" or "unsigned", the decimal positions are truncated. The data type "float" supports negative numbers and floating-point numbers. The data type "string" can also be used. In this case, the result is stored as a string instead of a number. The data type of script variables can be defined by using the script element l
.
The result's data type is decisive and not the operand's data type. A negative Operand2 can result in a positive number which can then be stored in a target variable of the data type "unsigned".
Note that arithmetic operations using floating-point numbers can supply inexact results.
The result is returned in the 16-digit default format. Floating-point numbers also include 16 decimal places and an algebraic sign (+ or -) is used as the first sign if negative numbers are supported.
Formatting can be changed by using the script function
Example
The following example stores the result of the arithmetic operation in a script variable. Operand1 and
Operand2 are specified as numeric expressions.
: SET &RESULT# = SUB (1000,999)
The following example shows a subtraction with floating-point numbers.
Automation Engine 397
: DEFINE &RESULT# ,float
: SET &RESULT# = SUB (10.31,-5.45)
: P &RESULT#
The following result is output in the activation protocol:
U0020408 +0000000000000015.7600000000000000
See also:
Script element
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Performs an addition
Performs a multiplication
Returns the remainder of a division
Performs a division
Generates random numbers
3.14 Strings
3.14.1 ALPHA2RUNNR
Script Function: Converts the name of a job or report file to a RunID
Syntax
ALPHA2RUNNR
(String)
Syntax
String
Description/Format
7-figure string (letters)
Format:
or
Return code
Run number (RunID)
Comments
The script function converts a string consisting of 7 letters to a RunID.
When jobs and job reports are stored in the file system, their file names contain the run number (RunID) of the particular job in form of a 7-figure string (letters). Example for a job report in Windows:
398 Chapter 3 Ordered by Function
OGMITAEV.TXT. "O" indicates the job report, "GMITAEV" is the string of the converted RunID
2000061045. In order to process the file names in a script, the string can again be converted to the 10figure RunID with ALPHA2RUNNR.
With the script function
, the 10-figure RunID is converted to a 7-figure string (letters).
Example
In this example, the 7-figure string is determined from the file name and output in the activation log.
: SET &ALPHA# = MID ( "JAADMXZT.TXT" , 2, 7)
: SET &RET# = ALPHA2RUNNR ( &ALPHA# )
: PRINT "RunID: &RET#"
See also:
Script element
Description
Converts the RunID to the corresponding file name
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.2 CONVERT
Script function: Converts the data type of a value.
Syntax
CONVERT
(Data type, value)
Syntax
Data type
Value
Description/Format
The data type to which you want to convert.
Allowed values: "unsigned", "signed", "float" and "string" unsigned: positive integers without signs signed: integers with signs float: floating point number string: string, text
Data types are indicated without inverted commas.
The value whose data type should be converted to a different data type.
Format:
or
Numbers must also be specified in inverted commas.
Return code
Value including the converted data type.
Automation Engine 399
Comments
This script function can be used to convert the data type of a value that has been specified directly or via a script variable to a different data type. The return code is the converted value which must be assigned to a target variable.
Ensure that the data type of the value that should be converted complies with the target variable's data type when you use this script function.
Strings can only be converted to numbers if the string includes a number in a valid format.
Attempts to convert a higher number type to a lower one have the effect that decimal numbers are rounded or signs are removed.
Conversion is not possible if the target variable's data type does not comply with the function's parameter
"Data type". The result is a scripting error.
Note that you cannot convert negative numbers with this script function.
Example
The first example converts a positive integer into a string.
: define &unsigned# , unsigned
: define &string# , string
: set &unsigned# = 12
: set &string# = CONVERT (string, &unsigned# )
The second example converts a string to a number. This is only possible if the string consists of a number that has a valid format for the target data type.
: define &unsigned# , unsigned
: define &string# , string
: set &string# = "1234"
: set &unsigned# = CONVERT (unsigned, &string# )
See also:
Script Elements - Editing Objects
Import and Export of Objects
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.3 FORMAT
Script Function: Changes the formatting of a number.
Syntax
FORMAT
(Number
[,Format]
)
Syntax Description/Format
400 Chapter 3 Ordered by Function
Number
Format
Number that should be formatted.
Format:
or
Zeros that serve as placeholders for the number of digits. In floating-point numbers, you can also specify a delimiter as the decimal point and the number of positions after the decimal point.
Format: script literal or script variable
Default: 0
Return codes
Number without leading zeros.
Number with leading zeros.
Comments
This script function can be used to add or remove leading zeros to or from a number. In floating-point numbers, you can also specify the number of positions that should be used after the decimal point. You can do so by defining a decimal point as the delimiter in the Format parameter. The zeros that you enter after the delimiter represent the number of decimal places. Numbers that exceed the specified number are truncated. The results are not rounded. If you do not specify a decimal point, all decimal numbers are removed. If the number includes fewer decimal places than is specifies in Format, the rest is filled with zeros.
The number of leading zeros of integers can also be specified in the Format parameter. The number of zeros given in this parameter serve as placeholders for the total number of digits. If you use fewer digits than is specified, the value remains unchanged. The leading zeros are removed if you do not use this parameter.
If you also specify the character '+' as the first character in Format (such as "+0.00", this algebraic sign is also displayed in positive numbers.
The target variable to which this function's return code is assigned must be of data type "
If the result is zero because all decimal positions have been removed, the algebraic sign is irrelevant and is removed.
Examples
The first example deletes the leading zeros from the script function's 16-digit return code. The result is output in the activation protocol.
: SET &SRV# = SYS_BUSY_60
: SET &RET# = FORMAT ( &SRV# )
: PRINT &RET#
The second example formats the specified number to 5 digits. The result (00125) is output in the activation protocol.
: SET &RET# = FORMAT ( "125" , "00000" )
: PRINT &RET#
The leading zeros are also deleted in the third example because the number of specified digits was incorrect (too few). The result (333) is output in the activation protocol.
Automation Engine 401
: SET &RET# = FORMAT ( "0000333" , "00" )
: PRINT &RET#
In the fourth example, the number does not change.
: SET &RET# = FORMAT ( "555" , "00" )
: PRINT &RET#
The fifth example shows the formatting of a floating-point number to one position after the decimal point. "-
0.7" is output in the activation protocol.
: DEFINE &NUM# ,float
: DEFINE &RET# ,string
: SET &NUM# =-0.75
: SET &RET# = FORMAT ( &NUM# , "00.0" )
: PRINT &RET#
Decimal places are removed in the sixth example. The output in the activation report is "0000".
: DEFINE &NUM# ,float
: DEFINE &RET# ,string
: SET &NUM# =0.65
: SET &RET# = FORMAT ( &NUM# , "0000" )
: PRINT &RET#
See also:
Script element
Description
Deletes empty spaces at the beginning of a string.
Deletes the empty spaces at the end of string.
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.4 HEX
Script Function: Convert a string into hexadecimal form
Syntax
HEX
(String)
Syntax
String
Description/Format
Alphanumeric character string that should be converted
Format:
or
Return code
String with a maximum of 252 characters in hexadecimal form
402 Chapter 3 Ordered by Function
Comments
With this script function, each individual character of a Stringcan be converted according to the hexadecimal character set.
The script function is given a Stringthat can consist of not more than 126 characters. If the Stringis longer, it will be truncated to 126 characters without an error message.
Example
In the example, the string is converted into hexadecimal form. The result "554334" is output to the activation protocol.
: SET &RET# = HEX ( "UC4" )
: PRINT &RET#
See also:
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.5 ISNUMERIC
Script Function: Checks if a string is numeric
Syntax
ISNUMERIC
(String)
Syntax
String
Description/Format
Character string which should be checked
Format:
or
Return codes
"Y" - the string is numeric
"N" - the string is not numeric
Comments
With this script function, you can check whether or not all characters of a String are numeric.
Examples
Both of the examples shown below supply the result "Y".
Automation Engine 403
: SET &RET# = ISNUMERIC ( "123" )
: PRINT &RET#
: SET &RET# = ISNUMERIC ( "00123" )
: PRINT &RET#
In the following example, the string is not numeric and value "N" is returned.
: SET &RET# = ISNUMERIC ( "1abc" )
: PRINT &RET#
See also:
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.6 RUNNR2ALPHA
Script Function: Converts the RunID to the corresponding file names
Syntax
RUNNR2ALPHA
(RunID)
Syntax
RunID
Description/Format
10-figure run number (RunID)
Format:
Return code
Name of the job or report file
Comments
The script function converts a 10-figure RunID to a string consisting of 7 letters.
For the file names of jobs and job reports stored in the file system, the 10-figure RunID is converted to a 7figure string (letters). Example for a job report in Windows: OGMITAEVN.TXT. "O" indicates the job report,
"GMITAEVN" is the string of the converted RunID 2000061045. In order to process the file names in a script, this string (letters) may be determined from the 10-figure RunID.
For its own job, the script function
with the attributes FILENAME_JOB or FILENAME_
SYSOUT supplies the file names of the job and the job report.
With the script function
, the 7-figure string (letters) is converted to the 10-figure RunID.
404 Chapter 3 Ordered by Function
Example
In this example, the job "MM.DAY" is activated. The returned RunID is converted to the 7-figure string and output in the activation log.
: SET &RUNNR# = ACTIVATE_UC_OBJECT ( "MM.DAY" )
: SET &RET# = RUNNR2ALPHA ( &RUNNR# )
: PRINT "ALPHA: &RET#"
See also:
Script element
Description
Converts the name of a job or report file to a RunID
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.7 STR_CAT
Script Function: Combines two strings to a new string
Syntax
STR_CAT
(String1, String2)
Syntax
String1, String2
Description/Format
Alphanumeric string
Format:
or
Return code
String consisting of the two specified strings
Example
In the following example, the function STR_CAT is used to create a title and store it in a script variable
("Daily Analysis 12.01.2005").
: SET &PROCESS# = "Daily Analysis "
: SET &DATE# = SYS_DATE ( "DD.MM.YYYY" )
: SET &TITLE# = STR_CAT ( &PROCESS# , &DATE# )
See also:
Automation Engine 405
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.14.8 STR_CUT, MID, SUBSTR
Script Functions: It copies characters of a string.
Syntax
STR_CUT
(String, Start
[, Length]
)
MID
(String, Start
[, Length]
)
SUBSTR
(String, Start
[, Length]
)
Syntax
String
Start
Length
Description/Format
An alphanumeric string.
Format:
or
The start position for the part that should be copied.
Format: number without quotation marks or script variable
The number of characters that should be copied.
Format: number without quotation marks or script variable
Return code
A part of a string.
Comments
These script functions all serve the same purpose. They copy characters from a given String. Length is an optional parameter - not specifying it means that all characters until the end of the String are returned.
The string itself remains unchanged.
Examples
In the first example, the script function returns "CD". The result of the second example is "CDEFGH" - all characters until the end of the string are included.
: SET &STRING# = MID ( "ABCDEFGH" ,3,2)
: SET &STRING# = SUBSTR ( "ABCDEFGH" ,3)
The following example uses the script function SUBSTR to split a user-defined term. The first three characters are assigned to the first script variable and the last character to the second script variable.
: READ &TABNAME# , "04" , "Please specify table name xxxy"
: SET &TABPRE# = SUBSTR ( &TABNAME# ,1,3)
: SET &TABSUF# = SUBSTR ( &TABNAME# ,4,1)
406 Chapter 3 Ordered by Function
See also:
Script element
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
It replaces characters or strings within a string.
It combines two strings to a new string.
3.14.9 STR_FIND
Script Function: It searches for a character or a string in a string.
Syntax
STR_FIND
(String1, String2
[, Start]
)
Syntax
String1
String2
Start
Description/Format
An alphanumeric string in which the search should take place.
Format:
or
An individual character or alphanumeric string that is searched.
Format: script literal or script variable
The position where a search should begin.
Format: Number without quotation marks
Default value: 1
Return codes
Position where the character or string was found
"0" - The character or string was not found
Comments
The function STR_FIND looks for String2 in String1 beginning at position Start. If Start is not specified, the search begins at position 1. String2 can consist of one character. The search is not case sensitive.
The script function returns the first position where String2 has been found. The position is counted from the beginning of String1, not from the position specified by Start.
Examples
In the example, the search for "#" in the string "UC4#01, UC4#02" returns the value 4.
: SET &STRING# = "UC4#01, UC4#02"
: SET &SEARCHSTRING# = "#"
Automation Engine 407
: SET &POS# = STR_FIND ( &STRING# , &SEARCHSTRING# )
: PRINT &POS#
In the following example, the search starts at position 5. Hence, the position where the string is found is
12.
: SET &POS# = STR_FIND ( "UC4 system UC4" , "UC4" , 5)
: PRINT &POS#
See also:
Script element
Description
Searches for a character or a string within a string. The search begins at the end of the string being searched.
Sample Collection
Notification with variable Message Text
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.14.10 STR_FIND_REVERSE
Script Function: Searches for a character or a string within a string. The search begins at the end of the string being searched.
Syntax
STR_FIND_REV[ERSE]
(String1, String2)
Syntax
String 1, String 2
Description/Format
Alphanumeric string
Format:
or
Return code
Position where the character or string was found
"0" - The character or string was not found
Comments
This script function searches for String 2 within String 1. As opposed to the script function
String 1 is search through from the end to the beginning.
String2 can consist one or several characters. The search is not case-sensitive. Upper and lower-case lettering is not taken into account.
408 Chapter 3 Ordered by Function
This script function returns the first position on which String 2 was found as a value. The position is then counted from the beginning of String1.
Example
In the example, the search for "#" within the string "UC4#01, UC4#02" returns the value 12. It is then output to the activation protocol.
: SET &STRING# = "UC4#01, UC4#02"
: SET &SEARCH# = "#"
: SET &POS# = STR_FIND_REVERSE ( &STRING# , &SEARCH# )
: PRINT &POS#
In the following example, a string is searched. It is found at position 12.
: SET &POS# = STR_FIND_REV ( "UC4 system UC4" , "UC4" )
: PRINT &POS#
See also:
Script element
Description
Searches for a character or a string in a string
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.11 STR_LC, CONV_LC
Script Functions: Converts all characters of a string to lower case
Syntax
STR_LC
(String)
CONV_LC
(String)
Syntax
String
Description/Format
Alphanumeric string
Format:
or
Return code
String in which all letters are written in lower case
Comments
Both script functions are functionally identical.
Automation Engine 409
Examples
Both examples convert a character set to lower-case letters. In the first example, the string is supplied as a string literal and in the second as a script variable. The supplied results are "abcdefgh 123&%$§" and
"ucaagx.htm".
: SET &STRING# = CONV_LC ( "ABCDEFGH 123&%$§" )
: SET &NAME# = "UCAAGX.HTM"
: SET &STRING# = STR_LC ( &NAME# )
See also:
Script element
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
Description
Converts all characters of a string to upper case
3.14.12 STR_LENGTH, STR_LNG
Script Functions: Returns the length of a string
Syntax
STR_LENGTH
(String)
STR_LNG
(String)
Syntax
String
Description/Format
Alphanumeric string
Format:
or
Return code
Number of string characters
Comments
Both script functions are functionally identical.
Examples
In the first example, the supplied result indicating the number of characters is 14.
: SET &number# = STR_LENGTH ( " UC4 Software " )
The second example retrieves the length of the string that is assigned with a script variable.
410 Chapter 3 Ordered by Function
: SET &number# = STR_LENGTH ( &string )
See also:
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.14.13 STR_LTRIM
Script Function: Deletes empty spaces at the beginning of a string
Syntax
STR_LTRIM
(String)
Syntax
String
Description/Format
Alphanumeric character string which should be converted
Format:
or
Return code
String without leading empty spaces
Example
The example outputs the result ("Database opening... ") in the activation protocol.
: SET &RET# =
: PRINT &RET#
STR_LTRIM ( " Database opening...
" )
See also:
Script element
Description
Deletes the empty spaces at the end of string
Removes empty spaces at the beginning and the end of a string
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
Automation Engine 411
3.14.14 STR_MATCH
Script Function: Compares two strings
Syntax
STR_MATCH
(String1, String2
[, Wildcard1[, Wildcard2]]
)
Syntax
String1
String2
Wildcard1
Wildcard2
Description/Format
Alphanumeric character string which should be compared
Format:
or
Alphanumeric character string which should be compared
Format: script literal or script variable
Character representing any character
Format: script literal or script variable
Default: "*"
Character representing one character
Format: script literal or script variable
Default: "_"
Return code
"Y" - The two strings are identical
"N" - The two strings are not identical
Comments
This script function checks if String2 is identical String1. Upper and lower case are distinguished (casesensitive).
In String2 wildcard characters may be used to form a comparison pattern. Generally "*" stands for any character and "_" for exactly one.
Other wildcard characters may be used and assigned to Wildcard1 and/or Wildcard2.
Example
The first example shows the output of the result "N" in the activation protocol.
: SET &RET# = STR_MATCH ( "UserInterface" , "User-Interface" )
: PRINT &RET#
The second example uses a wildcard character for comparison. The result "Y" is output in the activation protocol.
: SET &RET# = STR_MATCH ( "UserInterface" , "U*I*" )
: PRINT &RET#
The third example uses a wildcard character which is explicitly specified. The result "Y" is output in the activation protocol.
412 Chapter 3 Ordered by Function
: SET &RET# = STR_MATCH ( "UserInterface" , "User#" , "#" )
: PRINT &RET#
The fourth example also includes a wildcard character. It stands for exactly one character. Therefore, the result is "N".
: SET &RET# = STR_MATCH ( "UserInterface" , "User#" ,, "#" )
: PRINT &RET#
See also:
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.15 STR_PAD
Script Function: Extends a string to a certain length.
Syntax
STR_PAD
(String,
[Character]
, Total Length, Position)
Syntax
String
Character
Total Length
Position
Description/Format
The string that should be extended.
Format:
or
Any character that will be used to extend the string.
Format: UC4 name, script literal or script variable
Default value: " "
The length to which the string should be extended.
Format: a number without inverted commas, script literal or script variable
The string's position.
Format: script literal or script variable
Allowed values:
"LEFT" - The string will be positioned to the left.
"RIGHT" - The string will be positioned to the right.
"CENTER" - The string will be positioned in the center.
Return codes
The extended string.
Automation Engine 413
Comments
This script function extends a string to a certain length. You specify the character that should be used for the extension in the parameter Character. By default, blanks are used.
You can also define the order in which the string should be shown in the result (parameter Position). The possible values are left, right and center.
Center means that the required characters will be equally positioned to the left and to the right of the string.
If the number of characters that are required to extend the string is not even, the position to the right of the string will include one character more than the position to the string's left.
Examples
The following example increases one and the same string in three different ways and writes the result to the activation protocol.
: SET &STRING# = "UC4 String"
: SET &STRLEN# = 15
: SET &STRNEW# = STR_PAD ( &STRING# , "." , &STRLEN# , "LEFT" )
: PRINT &STRNEW#
: SET &STRNEW# = STR_PAD ( &STRING# ,, &STRLEN# , "CENTER" )
: PRINT &STRNEW#
: SET &STRNEW# = STR_PAD ( &STRING# , "_" , &STRLEN# , "RIGHT" )
: PRINT &STRNEW#
The following result is written to the activation protocol:
UC4 String.....
UC4 String
_____UC4 String
See also:
Script element Description
Splits a string to several parts using a separator.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Functions
3.14.16 STR_REVERSE
Script Function: Reverses the order of the characters within a string.
Syntax
STR_REVERSE
(String)
Syntax Description/Format
414 Chapter 3 Ordered by Function
String
Alphanumeric string that should be processed.
Format:
or
Return code
String whose characters are reversed
Example
The example outputs the result "4CU" to the activation report.
: SET &RET# = STR_REVERSE ( "UC4" )
: PRINT &RET#
See also:
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.17 STR_RTRIM
Script Function: Deletes the empty spaces at the end of string
Syntax
STR_RTRIM
(String)
Syntax
String
Description/Format
Alphanumeric character string which should be converted
Format:
or
Return code
String without an empty space at its end
Example
The example outputs the result (" Database opening...") in the activation protocol.
: SET &RET# =
: PRINT &RET#
STR_RTRIM ( " Database opening...
" )
See also:
Script element Description
Automation Engine 415
Deletes empty spaces at the beginning of a string
Removes empty spaces at the beginning and the end of a string
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.18 STR_SPLIT
Script Function: Splits a string to several parts using a separator.
Syntax
STR_SPLIT
(String, Separator)
Syntax
String
Separator
Return codes
Array that includes the individual partial strings.
Description/Format
The string that should be split.
Format:
or
This can be any character of your choice.
Format: UC4-Name, script literal or script variable
Comments
This script function splits the specified String to several partial strings by using a certain Separator. The result is an array that stores the individual strings.
The result does not include the separator.
To store the result, you define a script array using
and then you use the script element
Make sure that you use the data type "String" when you define the array.
Examples
The following example splits the string "123_456_789" as specified with the separator "_" and stores the result in a string array. The individual array elements are then written to the activation report.
: DEFINE &STRINGS# , string, 5
: SET &STRING# = "123_456_789"
: FILL &STRINGS# [] = STR_SPLIT ( &STRING# , "_" )
: SET &VAR# = 1
: SET &LEN# = LENGTH ( &STRINGS# [])
: WHILE &VAR# LE &LEN#
: SET &VAR# = FORMAT ( &VAR# , "0" )
: PRINT "&VAR#. Partial string = &STRINGS#[&VAR#]"
416 Chapter 3 Ordered by Function
: SET &VAR# = &VAR# + 1
: ENDWHILE
Output in the activation protocol:
2013-10-23 10:30:48 - U0020408 1. Partial string = 123
2013-10-23 10:30:48 - U0020408 2. Partial string = 456
2013-10-23 10:30:48 - U0020408 3. Partial string = 789
2013-10-23 10:30:48 - U0020408 4. Partial string =
2013-10-23 10:30:48 - U0020408 5. Partial string =
See also:
Script element
Description
Declares a script variable with a particular data type.
Stores several values to a script array.
Defines script variables and arrays as object variables.
Extends a string to a certain length.
Script Elements - Activation Data
Script Elements - Alphabetical Listing
Script Elements - Ordered by Functions
3.14.19 STR_SUBSTITUTE
Script Function: Replaces characters or strings within a string
Syntax
STR_SUB[STITUTE]
(String,
[Old] [,New]
)
Syntax
String
Old
New
Description/Format
Alphanumeric string in which the replacement should be carried out
Format:
or
Alphanumeric string to be replaced in the string.
Format: script literal or script variable
Default value: " "
Alphanumeric string to replace Old
Format: script literal or script variable
Default value: " "
Return code
String that has been created through the replacement of characters
Automation Engine 417
Comments
This script function replaces a character or string within a string.
Old and New may be a maximum of 1024 characters and are optional. If Old is not specified as a parameter, each individual empty space is replaced by the New character or string. If New is not specified as a parameter, Old is replaced by an individual empty space.
If Old is not included in the string, this function returns the string.
This script function can also be used to delete Old from the string. For this, New must be specified with two successive quotation marks (without empty spaces).
Example
The first example demonstrates how you replace the character "A" with character "B". The result "BBBBB" is output in the activation protocol.
: SET &RET# = STR_SUBSTITUTE ( "AAAAA" , "A" , "B" )
: PRINT &RET#
The second example demonstrates how the string "AAAAA" is replaced by character "B". The result "B" is output in the activation protocol.
: SET &RET# = STR_SUBSTITUTE ( "AAAAA" , "AAAAA" , "B" )
: PRINT &RET#
The third example demonstrates how the string "AA" is replaced with the string "BB". The result "BBBBA" is output in the activation protocol.
: SET &STR1# = "AA"
: SET &STR2# = "BB"
: SET &RET# = STR_SUB ( "AAAAA" , &STR1# , &STR2# )
: PRINT &RET#
The fourth example demonstrates how to delete the empty spaces from the string. The result "AE" is output in the activation protocol.
: SET &RET# = STR_SUB ( "A E", " ", "" )
: PRINT &RET#
See also:
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
418 Chapter 3 Ordered by Function
3.14.20 STR_SUBSTITUTE_VAR, STR_SUB_VAR
Script function: Replaces script variable names by their values.
Syntax
STR_SUB[STITUTE]_VAR
(Variables)
Syntax
Variables
Description/Format
Script variable or string that includes one or several variable names.
Format:
or script variable
Return code
String with the script variable's values.
Comments
The script variable STR_SUB_VAR can be used to replace one or several script variable names that are stored as a string in a different script variable by the actual variable value. The following examples illustrate this behavior.
The script element
includes a parameter that is also called STR_SUB
[STITUTE]_VAR. It makes the same replacements in data sequence lines.
Examples
The following example stores a script variable's name (&VAR#) in a different variable (&VAR_NOSUB#) by using the & character twice.
If &VAR_NOSUB# is output, the name of the script variable &VAR# is written to the activation protocol.
The script element STR_SUB_VAR serves to replace this name by the variable's value.
: SET &VAR# = "script variable"
: SET &VAR_NOSUB# = "&&VAR# = &VAR#"
: PRINT &VAR_NOSUB#
: SET &VAR_SUB# = STR_SUB_VAR ( &VAR_NOSUB# )
: PRINT &VAR_SUB#
Output in the activation protocol:
2011-05-06 10:34:04 - U0020408 &VAR# = script variable
2011-05-06 10:34:04 - U0020408 script variable = script variable
The second example retrieves a value from the Variable object VARA.SUB which includes the names of two script variables. These two script variables are created and set.
Only the script variable names are written to the report if the Variable object's value is directly output. They are not replaced by their values.
The script element STR_SUB_VAR is used to replace the names of the two script variables by their values.
Automation Engine 419
: SET &VARA# = GET_VAR (VARA.SUB, "SUBVAR" )
: SET &VAR1# = "Hello"
: SET &VAR2# = "World"
: PRINT "Content without replacements: &VARA#"
: SET &VARA_SUB_VAR# = STR_SUB_VAR ( &VARA# )
: PRINT "Content with replacements: &VARA_SUB_VAR#"
Output without and with STR_SUB_VAR:
2011-05-06 10:34:04 - U0020408 Content without replacements: &VAR1# &VAR2#
2011-05-06 10:34:04 - U0020408 Content with replacements: Hello World
See also:
Script element Description
Retrieves a data sequence's current line content.
Script Elements - Activating Objects
Sample Collection
Notification with a Variable Message Text
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.21 STR_TRIM
Script Function: Removes empty spaces at the beginning and the end of a string
Syntax
STR_TRIM
(String)
Syntax
String
Description/Format
Alphanumeric character string which should be converted
Format:
or
Return code
String without empty spaces at its beginning and end
Example
The example shows the output of the result ("Database opening...") in the activation protocol.
: SET &RET# =
: PRINT &RET#
STR_TRIM ( " Database opening...
" )
See also:
420 Chapter 3 Ordered by Function
Script element
Description
Deletes empty spaces at the beginning of a string
Deletes the empty spaces at the end of string
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
3.14.22 STR_UC, CONV_UC
Script Functions: Converts all characters of a string to upper case
Syntax
STR_UC
(String)
CONV_UC
(String)
Syntax
String
Description/Format
Alphanumeric string
Format:
or
Return code
String in which all letters are written in upper case
Comments
Both script functions are functionally identical.
Examples
In both examples, a string is converted to upper case. In the first example, the string is supplied as a string literal, in the second example as a script variable. The results are "ABCDEFGH 123&%$§" and "PLEASE
START THE BACKUP ROUTINE!".
: SET &STRING# = CONV_UC ( "abcdefgh 123&%$§" )
: SET &MSG# = "Please start the backup routine!"
: SET &STRING# = CONV_UC ( &MSG# )
See also:
Script element
Description
Converts all characters of a string to lower case
Automation Engine 421
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
3.14.23 UC_CRLF
Script Function: Returns a line break
Syntax
UC_CRLF
()
Examples
In the first example, the message of the Notification is given in two lines.
: PUT_ATT CALL_TEXT = "The Job plan MM.DAY is blocked."
: PUT_ATT_APPEND CALL_TEXT = UC_CRLF ()
: PUT_ATT_APPEND CALL_TEXT = "Escalation in 10 Minutes."
In the second example, the same message is given. The line break is realized by a script variable.
: SET &NL# = UC_CRLF ()
: PUT_ATT CALL_TEXT = "The Job plan MM.DAY is blocked.&NL#Escalation in 10
Minutes."
The third example shows that this script function can also be used for texts that should be sent by email.
: SET &NL# = UC_CRLF ()
: SET &TEXT# = "The Job plan MM.DAY is blocked.&NL#Escalation in 10
Minutes."
: SET &RET# = SEND_MAIL ( "[email protected]" ,, "A task could not be started!" , &TEXT# )
See also:
Script Elements - Error Handling and Messages
Sample Collection:
Retrieving Error Message and Number
Script Elements - Alphabetical Listing
Script Elements - Ordered by function
422 Chapter 4 UC4 JCL for Applications
4 UC4 JCL for Applications
4.1 About UC4 JCL for Applications
UC4 does not only provide Job objects for operating systems but also for standard software solutions such as SAP, PeopleSoft, Oracle Applications and Siebel. These solutions to not have a JCL (Job Control
Language) but interfaces.
Hence UC4 Script provides a range of special functions which facilitate the execution of processing statements. These functions are created with a graphical interface (FORMS) which additionally have an online connection to the particular standard system. Dropdown lists can so be used to select attributes for the functions (e.g. printer name etc).
Alternately, the statement can also be stored as usual in the Process tab of the Job object (script editor).
See also:
Form tab(SAP)
Form tab(PeopleSoft)
4.2 Oracle Applications JCL
4.2.1 About Oracle Applications JCL
Script Elements
Script element
Description
Adds a layout to a request
Adds a message to a request
Adds an additional printer to a request
Sets default values for the print parameters to be used for executing
Concurrent Programs.
Sends a request for executing a concurrent program in Oracle Applications.
See also:
About UC4 JCL for Applications
Automation Engine 423
4.2.2 OA_ADD_LAYOUT
Adds a layout to a request
Syntax
OA_ADD_LAYOUT
[APPLICATION=...]
[,NAME=...]
[,LANGUAGE=...]
[,TERRITORY=...]
[,OUTPUTFORMAT=...]
Syntax
APPLICATION=
NAME=
LANGUAGE=
TERRITORY=
OUTPUTFORMAT=
Description/Format
Short form of the template application
Format:
Name of the template
Format: script literal
Language of the template file
Format: script literal
Specification of the template file's territory
Format: script literal
Output format
Format: script literal
Comments
For each layout, call the statement OA_ADD_LAYOUT in the script. As soon as
is processed, the Agent hands over its specifications to Oracle. If the script contains additional submits, redefine the layouts before using OA_ADD_LAYOUT.
If an error occurs when handing over a layout, it is logged in the activation report and the job ends on return code 10.
Note that using OA_ADD_LAYOUT requires at least Oracle Applications version 11.5.10.2.
Example
OA_ADD_LAYOUT APPLICATION='FND',NAME='XXPOST_XXPPOPS_
PP2',LANGUAGE='en',TERRITORY='US',OUTPUTFORMAT='PDF'
See also:
About the JCL of Oracle Applications
424 Chapter 4 UC4 JCL for Applications
4.2.3 OA_ADD_NOTIFICATION
Adds a message to a request
Syntax
OA_ADD_NOTIFICATION
USER=...
Syntax
USER=
Description/Format
Name of the user
Format:
Comments
Call the statement OA_ADD_NOTIFICATION for each message in the script. As soon as
is processed the Agent hands over its definitions to Oracle. If additional submits are used in the script, redefine the messages beforehand using OA_ADD_NOTIFICATION.
Any error that occurs when the Notification is passed on to Oracle is logged in the activation report and the job ends on return code 10.
Example:
OA_ADD_NOTIFICATION USER='MAX SMITH'
See also:
About the JCL of Oracle Applications
4.2.4 OA_ADD_PRINTER
Adds an additional printer to a request
Syntax
OA_ADD_PRINTER
PRINTER=...
[,COPIES=...]
Syntax
PRINTER=
Description/Format
Name of the printer
Format:
Automation Engine 425
COPIES=
Number of copies
Format: number
Default value: "0"
Comments
Only one printer can be defined with the statement
OA_SET_PRINT_DEFAULTS . Use OA_ADD_
PRINTER if more than one should be specified.
Do so by calling this statement in the script and specify the particular printers. As soon as
has processed, the Agent hands the printer specifications over to Oracle. If additional submits are used in the script, redefine the printers beforehand using OA_ADD_PRINTER.
The printer specified with OA_SET_PRINT_DEFAULTS is used for all subsequent OA_SUBMIT_
REQUEST calls until the job ends or until the next OA_SET_PRINT_DEFAULTS statement is made.
If an error occurs when handing over a printer, this error is logged in the activation report and the job ends on return code 10.
Example
OA_ADD_PRINTER PRINTER='HPLJ',COPIES=2
See also:
About the JCL of Oracle Applications
4.2.5 OA_SET_PRINT_DEFAULTS
Sets the default value for the print parameters to be used for executing Concurrent Programs.
Interface: SBB and XBP
Syntax
OA_SET_PRINT_DEFAULTS
PRINTER=...
[,STYLE=...]
[,COPIES=...]
Syntax
PRINTER=
STYLE=
Description/Format
Printer name
Format:
Style
Format:
426 Chapter 4 UC4 JCL for Applications
COPIES=
Number of copies
Format: number
Defaut value: "0"
Comments
Using this script element, the user can assign default values to the print parameters. They are valid for the entire script or until a new default value is assigned in the script. These values apply only to the Job in which they were set.
By setting default values, the clarity of the UC4 Script is increased. At the same time, problems with the limitation of 255 characters per script line are avoided because the real processing instruction was first assembled in the Oracle Applications Agent.
The script element can be used exclusively for
in order to assign default values to the print parameters.
Example
In the following example, default values for the printer and the number of copies are set.
OA_SET_PRINT_DEFAULTS PRINTER='MINE'
OA_SET_PRINT_DEFAULTS COPIES=2
OA_SUBMIT_REQUEST APPLICATION='FND',PROGRAM='MYPROG',DESCRIPTION='Sunday run of UC4',ARG1='602'
See also:
About JCL for Oracle Applications
4.2.6 OA_SUBMIT_REQUEST
Sends a request for executing a concurrent program in Oracle Applications.
Syntax
OA_SUBMIT_REQUEST
APPLICATION=...
,PROGRAM=...
[,DESCRIPTION=...]
[,ARG1=...[,ARGn=...]]
Syntax
APPLICATION=
Description/Format
The name of application to which the program that should run belongs.
Format:
PROGRAM=
DESCRIPTION=
ARG1=
:
ARGn=
Automation Engine 427
The name of the concurrent program that should run.
Format: script literal
A description of concurrent process. This description is shown online in the concurrent request form.
Format: script literal
Any parameters for the concurrent program.
These could be functions, constants, keywords etc.
Example: chr(0), ZERO, 'abc', NAME_IN('ORDERS.ORDER_ID'), 123
Format: script literal
Comments
This script element creates a process request for a concurrent program in Oracle Applications and monitors the execution. UC4 recognizes the end of the concurrent process with the help of the phase and the accompanying status.
The parameters for ARG1 to ARGn must be put in double quotation marks that are followed by single quotation marks (unless they are variables).
Examples
In the following example, the concurrent program "MYPROG" should be executed in Oracle Applications.
Additionally, the description and a second parameter will be passed on.
OA_SUBMIT_REQUEST APPLICATION='FND',PROGRAM='MYPROG',DESCRIPTION="'Sunday run of UC4'",ARG1="'602'"
The following example shows the usage of quotation marks with the parameter ARG1.
OA_SUBMIT_REQUEST APPLICATION='FND',PROGRAM='FNDPRNEV',ARG1="'PRINTER'"
See also:
About JCL for Oracle Applications
4.3 PeopleSoft
4.3.1 About PeopleSoft JCL
The following overview shows the JCL script elements for PeopleSoft and the corresponding interfaces.
Script Elements and Corresponding Interfaces
Script Element
Description Interface
Monitors a PeopleSoft Process Scheduler Server.
PROCESSREQUEST_
SBB
428 Chapter 4 UC4 JCL for Applications
Authorizes users or roles in order to access the output of a PeopleSoft process.
Changes individual parameters in Run Controls.
Starts and monitors a PeopleSoft job.
Starts and monitors a PeopleSoft process.
Replaces the value of a bind variable in a process definition.
PROCESSREQUEST_
SBB
PROCESSREQUEST_
SBB
PROCESSREQUEST_
SBB none,
PROCESSREQUEST or
PROCESSREQUEST_
SBB (depending on the parameters in use)
PROCESSREQUEST_
SBB
See also:
About UC4 JCL for Applications
4.3.2 PS_GET_HEARTBEAT
Monitors a PeopleSoft Process Scheduler Server.
Interface: PROCESSREQUEST_SBB
PeopleSoft Version: 8+
Syntax
PS_GET_HEARTBEAT
RUNLOCATION=...
[,MAXPERIOD=...]
Syntax
RUNLOCATION=
MAXPERIOD=
Description/Format
Name of an assigned PeopleSoft Process Scheduler Batch Server, for example PSUNX or PSNT.
Format:
Maximum time period in seconds allowed between the system time of the
PeopleSoft Database Server and the time of the last heartbeat from the
Process Scheduler Server.
Format: Number
Comments
Each Process Scheduler Server reports periodically to the PeopleSoft database. This procedure is called the heartbeat of the Process Scheduler Server.
Automation Engine 429
The script element PS_GET_HEARTBEAT makes it possible to monitor the availability of the Process
Scheduler Server. It evaluates system time of the PeopleSoft Database Server and the time of the last heartbeat from the specified Process Scheduler Server. Both times are output in the activation report of the
UC4 Job. The message with the message number U2004942 contains first the time of the Database
Server and, second, the time of the last heartbeat. This information can be evaluated in the post script.
If the optimal parameter MAXPERIOD is used, the time difference between PeopleSoft Database Server and the last heartbeat is calculated and compared with the time period specified here. If the calculated time difference is larger than the maximum allowed time period, the UC4 Job is canceled. If the maximum allowed time period is not reached or exceeded through the calculated time difference, the UC4 Job ends normally.
Example
In the example, the system time of the PeopleSoft Database Server and the time of the last heartbeat by the Process Scheduler Server "PSNT" is determined and output in the activation report.
PS_GET_HEARTBEAT RUNLOCATION='PSNT'
The second example compares the time difference between the PeopleSoft Database Server and the last heartbeat from "PSNT" with the maximum allowed time period. The last heartbeat can be a maximum of 20 seconds behind the time of the PeopleSoft Database Server, otherwise the Job is canceled.
PS_GET_HEARTBEAT RUNLOCATION='PSNT', MAXPERIOD=20
See also:
4.3.3 PS_GRANT_OUTPUT_ACCESS
Authorizes users or roles for access to the output of a PeopleSoft process.
Interface: PROCESSREQUEST_SBB
PeopleSoft Version: 8+
Syntax
PS_GRANT_OUTPUT_ACCESS
NAME=...
[,TYPE=...]
[,PID=...]
[,JOBITEM=...]
Syntax
NAME=
Description/Format
Authorization identification: Name of a role or user
Format:
430 Chapter 4 UC4 JCL for Applications
TYPE=
PID=
JOBITEM=
Authorization type: Role or user
Format: script literal
Allowed values: "R" (default value) and "U"
"R" - Authorization given for a role
"U" - Authorization given for a user
The Agent automatically uses "R" if a character other than "R" or "U" is specified.
Process instance designation
Format: Integer
Item number of a process within a PeopleSoft job
Format: Integer
Comments
This script element is used to dynamically and automatically assign access rights to the output of an executed PeopleSoft process. Rights can be issued for roles or users.
Using the optional PID= parameter, a particular process can be specified. If the parameter is not used, the
script element refers to the process ( PS_RUN_PROCESS
) instance which was started or monitored immediately before.
If the script applies to a PeopleSoft job, individual rights for all processes in that job can be given using
JOBITEM=. For example, rights for the first single process are given with JOBITEM=1, for the second single process with JOBITEM=2, etc. In case this parameter is not specified, identical rights are assigned for all PeopleSoft job single processes.
Example
In this example, the user "PS" is given access rights to the output of a PeopleSoft process.
PS_GRANT_OUTPUT_ACCESS NAME='PS',TYPE='U'
See also:
4.3.4 PS_MODIFY_RUNCONTROL
Changes individual parameters in Run Controls.
Interface: PROCESSREQUEST_SBB
PeopleSoft Version: 8+
Syntax
PS_MODIFY_RUNCONTROL
Automation Engine 431
RUNCONTROLID=...
,RECORDNAME=...
,FIELDNAME=...
,FIELDVALUE=...
[,KEYNAME(1)=...
,KEYVALUE(1)=...]
[,KEYNAME(2)=...
,KEYVALUE(2)=...]
[,KEYNAME(3)=...
,KEYVALUE(3)=...]
Syntax
RUNCONTROLID=
RECORDNAME=
FIELDNAME=
FIELDVALUE=
KEYNAME(n)=
KEYVALUE(n)=
Description/Format
Run Control ID of the PeopleSoft Job.
Format:
Name of a PeopleSoft record which is a part of a Run Control.
Format: script literal
Name of a field of the PeopleSoft record.
Format: script literal
Value which should be assigned to the field.
Format: script literal
Key in the Run Control table
Format: script literal n indicates the level. Values between 1 and 3 are allowed.
Value for the key field
Format: script literal n indicates the level. Values between 1 and 3 are allowed.
Comments
You can use this script element to assign new values to fields of PeopleSoft records and change Run
Control parameters directly. Ensure the plausibility of new values because the PeopleCodes which are defined in the record and the fields are not passed through in this case. An incorrect value assignment can cause "inconsistencies" in date specifications, for example (e.g. a new value is assigned to the "From" part but no to the corresponding "To" part).
UC4 recommends creating and using separate Run Control IDs for batch processing with UC4 in order to avoid any conflicts.
The modification process aborts and the job ends abnormally if no key has been specified or if the specification contains errors.
Two keys are always included in PeopleSoft Run Control tables: OPRID and RUN_CNTL_ID. Makes sure not to specify these parameters when you use the script element PS_MODIFY_RUNCONTROL.
Otherwise, no modifications will be made in the table.
432 Chapter 4 UC4 JCL for Applications
Example
In the following example a new date is assigned to the field ASOFDATE of the PeopleSoft record "RUN_
CTRL_HR".
PS_MODIFY_RUNCONTROL RUNCONTROLID='sbb',RECORDNAME='RUN_CNTL_
HR',FIELDNAME='ASOFDATE',FIELDVALUE='20020117'
The second example shows the modification of a Run Control for currency conversion.
PS_MODIFY_RUNCONTROL RUNCONTROLID='myRunControl',RECORDNAME='RUN_CNTL_CC2_
EO',FIELDNAME='RATE_MULT',FIELDVALUE='100',KEYNAME(1)='CURRENCY_
CD',KEYVALUE(1)='AUT'
See also:
Changes in Run Controls
4.3.5 PS_RUN_JOB
Starts and monitors a PeopleSoft job .
Interface: PROCESSREQUEST_SBB
PeopleSoft Version: 8+
Syntax
PS_RUN_JOB
JOBNAME=...
,RUNCONTROLID=...
[,RUNLOCATION=...]
[,OUTPUTDEST=...]
[,OUTDESTTYPE=...]
[,OUTDESTFORMAT=...]
Syntax
JOBNAME=
RUNCONTROLID=
RUNLOCATION=
OUTPUTDEST=
Description/Format
Name of PeopleSoft job that should be started and monitored.
Format:
Run Control ID of the PeopleSoft job.
Format: script literal
Name of an assigned PeopleSoft Process Scheduler Batch Server (for example PSUNX or PSNT).
Format: script literal
Directory in which the PeopleSoft job writes its output.
Format: script literal
Automation Engine 433
OUTDESTTYPE=
Output type of the PeopleSoft job (for example a file, printer or email).
Format: script literal
All valid values can be displayed with the following database query: select XLATSHORTNAME from XLATTABLE where FIELDNAME =
'OUTDESTTYPE';
OUTDESTFORMAT=
File format in which the output of the PeopleSoft job should be saved (for example TXT, HTM or PDF).
Format: script literal
All valid values can be displayed with the following database query: select XLATSHORTNAME from XLATTABLE where FIELDNAME =
'OUTDESTFORMAT';
Comments
This script element starts a PeopleSoft job and monitors its execution. A PeopleSoft job can be used to execute several PeopleSoft processes at the same time or one after the other.
The name of the PeopleSoft job refers to the definition in PeopleSoft's "Process Scheduler Manager".The
name of the assigned Process Scheduler Batch Server must also comply with a definition if this parameter is used.
OUTPUTDEST, OUTDESTTYPE and OUTDESTFORMAT are additional optional parameters that can be used to specify the PeopleSoft job's output.
This script element can only be used if the UC4 administrator has installed and activated the
PROCESSREQUEST_SBB interface in the Agent's INI file.
PS_RUN_JOB does not work with inline bind variables .
Examples
The following example uses optional parameters in order to store the PeopleSoft job's output in a temporary directory as an SPF file.
PS_RUN_JOB
JOBNAME='3SQR',RUNCONTROLID='sbb',RUNLOCATION=PSNT,OUTDESTTYPE='FILE',OUTDE
STFORMAT='SPF',OUTPUTDEST='c:\temp'
See also:
4.3.6 PS_RUN_PROCESS
Starts and monitors a PeopleSoft process.
Syntax
PS_RUN_PROCESS
434 Chapter 4 UC4 JCL for Applications
PROCESSNAME=...
,PROCESSTYPE=...
,RUNLOCATION=...
,RUNCONTROLID=...
[,OUTPUTDEST=...]
[,OUTDESTTYPE=...]
[,OUTDESTFORMAT=...]
Syntax Description/Format
PROCESSNAME=
PROCESSTYPE=
Name of the PeopleSoft process that should be initialized and monitored.
Format:
Process type of the PeopleSoft process.
Format: script literal
RUNLOCATION=
RUNCONTROLID=
OUTPUTDEST=
OUTDESTTYPE=
Name of an assigned PeopleSoft Process Scheduler Batch Server (for example PSUNX or PSNT).
Format: script literal
Run Control ID of the PeopleSoft process.
Format: script literal
Directory to which the PeopleSoft process writes its output.
Format: script literal
Output type of the PeopleSoft process (for example file, printer or email).
Format: script literal
All valid values can be displayed with the following database query: select XLATSHORTNAME from XLATTABLE where FIELDNAME =
'OUTDESTTYPE';
Interface: PROCESSREQUEST and PROCESSREQUEST_SBB
PeopleSoft Version: 8+
OUTDESTFORMAT=
File format in which the PeopleSoft process should be saved (for example
TXT, HTM or PDF).
Format: script literal
All valid values can be displayed with the following database query: select XLATSHORTNAME from XLATTABLE where FIELDNAME =
'OUTDESTFORMAT';
Interface: PROCESSREQUEST and PROCESSREQUEST_SBB
PeopleSoft Version: 8+
Comments
This script element creates a process request for a PeopleSoft process and monitors its execution. The end of this PeopleSoft process is recognized on the basis of its run status which will be stored in the
PeopleSoft database.
The name and type of a PeopleSoft process refers to the process definitions in the PeopleSoft "Process
Scheduler Manager". The name of the assigned Process Scheduler Batch Server must also correspond to a definition.
Automation Engine 435
OUTPUTDEST, OUTDESTTYPE and OUTDESTFORMAT are additional optional parameters that can be used to specify the output of the PeopleSoft process.
Some parameters of the script element depend on the PeopleSoft version that is used and indicated in the syntax table.
Examples
The first example initializes the PeopleSoft process THR200of the process type SQR Report.
PS_RUN_PROCESS PROCESSNAME='THR200',PROCESSTYPE='SQR
Report',RUNLOCATION='PSUNX',RUNCONTROLID='mlc',OUTPUTDEST='/tmp/'
The second example uses the optional parameters in order to store the output of the PeopleSoft process in a temporary directory as a PDF file.
PS_RUN_PROCESS PROCESSNAME='DDDAUDIT',PROCESSTYPE='SQR
Report',RUNLOCATION='PSNT',RUNCONTROLID='sbb',OUTDESTTYPE='FILE',OUTDESTFOR
MAT='PDF',OUTPUTDEST='c:\temp'
See also:
4.3.7 PS_SET_BINDVAR
Replaces the value of a bind variable in a process definition.
Interface: PROCESSREQUEST_SBB
PeopleSoft Version: 8+
Syntax
PS_SET_BINDVAR
NAME=...
,MODE='V'
,VALUE=...
PS_SET_BINDVAR
NAME=...
,MODE='D'
,RUNCONTROLID=...
Syntax
NAME=
Description/Format
Name of the bind variable that should be replaced.
Format:
436 Chapter 4 UC4 JCL for Applications
MODE=
VALUE=
RUNCONTROLID=
Type of replacement.
Format: script literal
Allowed values: "V" and "D"
"V" - The value is predetermined with the parameter "VALUE=".
"D" - Replacement is made using a Run Control ID with the parameter
"RUNCONTROLID".
Value that should be used for the replacement.
Format: script literal
Specification of a Run Control ID.
Format: script literal
Comments
To use this script element, you must follow the instructions in the "Configuration for using Bind Variables" section in the agent's new installation description. This section describes how you can create process types. Afterwards, you assign the process types to the Process Scheduler Server and then you restart the
Process Scheduler Server in order to assume these modifications.
Examples
The following two examples show how a predetermined value and a Run Control ID can be used in order to replace bind variables:
PS_SET_BINDVAR NAME=':RUN_CNTL_HR.COURSE',VALUE='K014',MODE='V'
PS_RUN_PROCESS PROCESSNAME='TRN023--
',PROCESSTYPE='Crystal',RUNCONTROLID='ang',RUNLOCATION='PSNT'
PS_MODIFY_RUNCONTROL RUNCONTROLID='ang',RECORDNAME='RUN_CNTL_
HR',FIELDNAME='COURSE',FIELDVALUE='K014'
PS_SET_BINDVAR NAME=':RUN_CNTL_
HR.COURSE',VALUE='',MODE='D',RUNCONTROLID='ang'
PS_RUN_PROCESS PROCESSNAME='TRN023--
',PROCESSTYPE='Crystal',RUNCONTROLID='ang',RUNLOCATION='PSNT'
See also:
Using Bind Variables
4.4 SAP
4.4.1 SAP Basis
About SAP JCL
Lines with SAP JCL can be linked with
:JCL_CONCAT_CHAR . A JCL line formed in this way can be a
maximum of 2047 characters long. The maximum length of an individual script line, however, is limited to
Automation Engine 437
1024 characters.
Some of the SAP JCL commands depend on the interface that is used. Refer to the individual script elements to learn about syntax differences in more detail. The script elements that are available for the individual interfaces are found in the chapter Functional Differences .
UC4 submits the properties of all fields to the SAP interface (printer name, program name etc.).
Maximum field lengths, allowed values etc. are NOT described in the UC4 Documentation as these field descriptions are available in the SAP Dictionary for the corresponding versions.
SAP JCL elements: Parameter values must be indicated as
if the relevant value includes blanks. Otherwise, you can optionally use inverted commas regardless whether the value is a number, a character or a string.
R3_ACTIVATE_CM_PROFILE
Activates a profile in the SAP Criteria Manager
Transaction: SM62
Interface: Standard
Syntax
R3_ACTIVATE_CM_PROFILE
ID=...
,TYPE=...
Syntax
ID=
TYPE=
Description/Format
Profile ID
Format: Number
Profile type
Format:
Allowed values: "EVHIRO", "EVTHIS" and "INTERC"
"EVHIRO" - Event History Reorg
"EVTHIS" - Event History
"INTERC" - Job Interception
Comments
Only one profile can be activated per profile type.
Example
The example below activates the profile with the ID "5" for the Job Interception.
R3_ACTIVATE_CM_PROFILE ID="5",TYPE="INTERC"
See also:
438 Chapter 4 UC4 JCL for Applications
R3_ACTIVATE_EXT_COMMAND
Execution of an external command
Transaction: SM36
Interface: Standard
Syntax
R3_ACTIVATE_EXT_COMMAND
COMMAND=...
OPSYSTEM=...
[,PARAMS=...]
,TARGET_SERVER=...
[,STDOUT=...]
[,STDERR=...]
[,TRACE=...]
[,TERM=...]
Syntax
COMMAND=
OPSYSTEM=
PARAMS=
Description/Format
Name of the external command
Format:
Host system in which the command should be executed
Format: script literal
Parameter for the external command
Format: script literal
Default value: " "
TARGET_S[ERVER]= Name of the computer on which the command should be executed
Format: script literal
Control flags
STDOUT= Log external output to job log
Format: script literal
STDERR=
Allowed values: "" (default value) and "X"
"" - No control flag
"X" - External output is assumed to the job log
Log external errors in job log
Format: script literal
Allowed values: "" (default value) and "X"
"" - No control flag
"X" - External errors are assumed to the job log
Automation Engine 439
TRACE=
TERM=
Activate trace
Format: script literal
Allowed values: "" (default value) and "X"
"" - No control flag
"X" - Trace will be activated
Job waiting for ext. termination
Format: script literal
Allowed values: "" (default value) and "X"
"" - No control flag
"X" - Job is waiting for external termination
Example
R3_ACTIVATE_EXT_COMMAND COMMAND='NET_ROUTING',OPSYSTEM='Windows NT',TARGET_
SERVER='NB0053',STDOUT='X',STDERR='X',TERM='X'
See also:
R3_ACTIVATE_EXT_PROGRAM
Execution of an external program.
Transaction: SM36
Interface: Standard
Syntax
R3_ACTIVATE_EXT_PROGRAM
PROGRAM=...
[,PARAMS=...]
,TARGET_SERVER=...
[,STDOUT=...]
[,STDERR=...]
[,TRACE=...]
[,TERM=...]
Syntax
PROGRAM=
PARAMS=
Description/Format
Name of the program that should be executed.
Format:
Parameter for the program.
Format: script literal
Default value: ""
440 Chapter 4 UC4 JCL for Applications
TARGET_S[ERVER]= Name of the computer on which the program should be executed.
Format: script literal
Control flags
STDOUT= Assumes external output to the job log.
Format: script literal
STDERR=
Allowed values: "" (default value) and "X"
"" - No control flag.
"X" - External output is assumed to the job log.
Assumes external errors to the job log.
Format: script literal
TRACE=
TERM=
Allowed values: "" (default value) and "X"
"" - No control flag.
"X" - External errors are assumed to the job log.
Activates a trace.
Format: script literal
Allowed values: "" (default value) and "X"
"" - No control flag.
"X" - Trace will be activated.
Job waits for external termination.
Format: script literal
Allowed values: "" (default value) and "X"
"" - No control flag.
"X" - Job is waiting for external termination.
Example
R3_ACTIVATE_EXT_PROGRAM PROGRAM='dir',PARAMS='*.*',TARGET_
SERVER='NB0053',STDOUT='X',STDERR='X',TERM='X'
See also:
R3_ACTIVATE_INTERCEPTED_JOBS
Processes intercepted jobs under UC4's control. Intercepted jobs that should be started are taken from a selection list.
Transaction: SM37
Interface: Standard (XBP 2.0)
Syntax
R3_ACTIVATE_INTERC[EPTED_JOBS]
Automation Engine 441
NAME=...
[,GROUP=...]
[,USER=...]
[,NOFOUND=...]
[,ERROR=...]
[,SELECT=...]
[,START_DATE=...]
[,START_TIME=...]
[,END_DATE=...]
[,END_TIME=...]
[,JOBCOUNT=...]
[,TARGET_SERVER=...]
[,WAIT=...]
[,REPLICATE=...]
[,ABORTED=...]
[,GET_SPOOL=...]
Syntax
GROUP=
Description/Format
Selection of Intercepted jobs by group (such as "xxx*").
Value format: script literal
USER=
Default value: "*"
Selection of Intercepted jobs by user (such as "xxx*").
Value format: script literal
Default value: "*"
NOFOUND=
Action if no intercepted jobs are selected.
Value format: script literal
ERROR=
SEL[ECT]=
Allowed Values NORMAL (default value) and ABEND
NORMAL - Execution of the script is continued, the UC4 Job ends normally.
ABEND - Execution of the script is stopped, the UC4 Job ends abnormally.
Action if one of the selected Intercepted jobs ends abnormally
Value format: script literal
Allowed Values: ABEND (default value) and IGNORE
ABEND - Script execution stops, the UC4 job ends abnormally.
IGNORE - Script execution continues, the UC4 job ends normally.
Single or permanent selection.
Value format: script literal
Allowed values: ONCE (default value) and EVERY
ONCE - The number of selected jobs are calculated once.
EVERY - The number of selected jobs are calculated after each job release. In doing so, scheduled jobs can be paralleled.
442 Chapter 4 UC4 JCL for Applications
START_D
[ATE]=
Start date of Intercepted job selection
Value format: script literal
Date format: YYYYMMDD
Default value: 20000101
If this parameter is used without the parameter END_DATE=, all scheduled jobs will be selected and start commencing as of the specified start date .
Start time of Intercepted job selection.
Value format: script literal
START_T
[IME]=
Time format: HHMMSS
Default value: 000000
END_D[ATE]
=
If this parameter is used without the parameter END_TIME=, all scheduled jobs will be selected and start commencing as of the specified start time. 11:59pm is the valid end time.
End date of Intercepted job selection.
Value format: script literal
Date format: YYYYMMDD
Default value: current date
END_T[IME]
=
In order to select all jobs scheduled in one day, this parameter must be entered and the same date be used as with the parameter START_DATE=.
End time of Intercepted job selection.
Value format: script literal
Time format: HHMMSS
Default value: 235959
JOBCOUNT= Number of the Intercepted job.
Value format: script literal
NAME=
TARGET_S
[ERVER]=
Default value: "*"
In connection with the NAME (SAP job name), a unique SAP job can be identified.
Selection of one or more Intercepted jobs by name.
Value format:
In connection with the JOBCOUNT (SAP job number), a unique SAP job can be identified.
For the selection of several jobs, the "*" wildcard character can be used (such as
'xxx*').
Target system that should be used by an Intercepted job.
Value format: script literal
Allowed values: KEEP (default value) and ATTRIBUTE
KEEP - The target system that is defined in the original job is kept.
ATTRIBUTE - The target system of the Job's host attributes is used.
Automation Engine 443
WAIT=
Waits for an Intercepted job's children to end.
Value format: script literal
Allowed values: YES and NO (default value)
NO = Do not wait for all children to end.
YES = Wait for all children to end.
Handling the children of intercepted jobs.
Format of the value: script literal
REPL
[ICATE]=
Allowed values: YES and NO (default value)
YES - The children of a Job are replicated in the UC4 system. They are displayed in the
Activity Window of the UserInterface. Statistical records and reports are also generated in the UC4 system.
NO - There is no replication in the UC4 system.
ABORTED=
Reaction to the abnormal end of an Intercepted job's children.
Value format: script literal
GET_
SPOOL=
Allowed values: YES (default value) and NO
YES - The script stops, UC4 Job ends abnormally.
NO - The script continues, UC4 Job ends normally.
Requests the spool list of the started Job.
Format of the value: script literal
Allowed values: YES or NO (default)
YES = The spool list is requested. It is stored as a text file in the directory that has been defined in the SAP Agent's INI file with the parameter Download_dir= (Sektion
[GLOBAL]). The name of this file is structured as follows:
<SAP Job count>_<step number>_<spool number>.txt
This file is also registered as Job output in the UC4 Job.
NO = The spool list is not requested.
Comments
This script element determines all Intercepted jobs according to specified selection criteria. The SAP client specified in the UC4 job's Login object is used for the selection.
Examples
All Intercepted jobs of the following example should be started. The UC4 Job should not abort if no
Intercepted jobs can be found.
R3_ACTIVATE_INTERCEPTED_JOBS NAME='*',GROUP='*',USER='*',NOFOUND='NORMAL'
See also:
444 Chapter 4 UC4 JCL for Applications
R3_ACTIVATE_JOBS
Executes previously scheduled jobs in SAP under the control of UC4. The jobs that should start are taken from a selection.
Transaction: SM37
Interface: UC4 and standard
UC4 interface
[ UC4 ]
Syntax
R3_ACTIVATE_JOB[S]
NAME=...
[,JOBCOUNT=...]
[,GROUP=...]
[,USER=...]
[,NOFOUND=...]
[,ERROR=...]
[,SELECT=...]
[,START=...]
[,NEW_NAME=...]
[,START_D[ATE]=...]
[,START_T[IME]=...]
[,END_D[ATE]=...]
[,END_T[IME]=...]
[,TARGET_S[ERVER]=...]
[,BEG_LOGLINES=...]
[,END_LOGLINES=...]
[,GET_SPOOL=...]
Syntax
NAME=
Description/Format
Selection of one or more jobs by name.
Format:
or
Parameter
UC4 Name
Name and number clearly identify an individual SAP job. The wildcard character "*" can be used (such as 'xxx*') if several jobs are selected.
Further selection criteria in the form of a keyword and an assignment.
Non-specified parameters obtain default values. Formats are applied for the keyword assignment.
Syntax
JOBCOUNT=
GROUP=
USER=
NOFOUND=
ERROR=
SELECT=
START=
NEW_NAME=
START_D[ATE]=
Automation Engine 445
Description/Format
Number of the SAP job.
Format: script literal
Name and number clearly identify an individual SAP job.
Job selection by groups (such as "xxx*").
Format: script literal or UC4 name
Default value: "*"
Job selection by users (such as "xxx*").
Format: script literal or UC4 name
Default value: "*"
Action if no jobs are found.
Format: script literal
Allowed Values NORMAL (default value) and ABEND
NORMAL - Script execution continues, the UC4 job ends normally.
ABEND - Script execution stops, the UC4 job ends abnormally.
Action if one of the selected jobs ends abnormally.
Format: script literal
Allowed values: ABEND (default value) and IGNORE
ABEND - Script execution stops, the UC4 job ends abnormally.
IGNORE - Script execution continues, the UC4 job ends normally.
Single or permanent selection.
Format: script literal
Allowed values: ONCE (default value) and EVERY
ONCE - The number of selected jobs is retrieved once.
EVERY - The number of selected jobs is retrieved after each job release. Released jobs can so be paralleled.
Select whether the original job or a duplicate should start.
Format: script literal
Allowed values: "ORIGINAL" (default value) and "DUPLICATE"
Name of the Job that should start as a duplicate.
Format: script literal
Only used when START=DUPLICATE has been specified. This parameter is ignored if the original job should be started.
Start date of the selected scheduled jobs.
Format: script literal
Date format: YYYYMMDD
Default value: "20000101"
All scheduled jobs will be selected and start commencing as of the specified start date if this parameter is used without the parameter
END_DATE.
446 Chapter 4 UC4 JCL for Applications
Syntax
START_T[IME]=
END_D[ATE]=
END_T[IME]=
TARGET_S[ERVER]=
BEG_LOGLINES=
END_LOGLINES=
Description/Format
End time of the selected scheduled jobs.
Format: script literal
Time format: HHMMSS
Default value: "000000"
If this parameter is used without the parameter END_TIME, all scheduled jobs will be selected and started commencing as of the specified start time. 11:59pm is the end time.
End date of the selected scheduled jobs.
Format: script literal
Date format: YYYYMMDD
Default value: current date
This parameter must be indicated and the same date used with the parameter START_DATE to select all scheduled jobs of a day.
Start time of the selected scheduled jobs.
Format: script literal
Time format: HHMMSS
Default value: "235959"
Target system that should be used by a released SAP job.
Format: script literal
Allowed values: KEEP (default value) and ATTRIBUTE
KEEP - The target system that is specified in the original Job is kept.
ATTRIBUTE - The target system that is specified in the Job's host attributes is used.
Determines the number of lines that should be assumed to the UC4
Job report (starting with the SAP job log's beginning).
Number of lines that should be written to the UC4 job report (starting with the SAP job log's ending).
By default, the complete job log is used if neither the parameter END_
LOGLINES nor BEG_LOGLINES have been specified. If only one of these two parameters is specified, the corresponding job-log lines
(either from the beginning or the end) are read.
No Job log is transferred if the value "0" has been specified in both parameters.
In both parameters, you can only use numeric values.
Syntax
GET_SPOOL=
Automation Engine 447
Description/Format
Requests the spool list of the started Job.
Format of the value: script literal
Allowed values: YES or NO (default)
YES = The spool list is requested. It is stored as a text file in the directory that has been defined in the SAP Agent's INI file with the parameter Download_dir= (Sektion [GLOBAL]). The name of this file is structured as follows:
<SAP Job count>_<step number>_<spool number>.txt
This file is also registered as Job output in the UC4 Job.
NO = The spool list is not requested.
Examples
Releasing all planned jobs of user 'NI':
R3_ACTIVATE_JOBS NAME='*',GROUP='*',USER='NI'
In the second example, all jobs scheduled between 7/1/2001 12:00:00am and 7/2/2001 11:59:59pm are selected and started.
R3_ACTIVATE_JOBS NAME='*',GROUP='*',USER='SUPPORT',START_
DATE='20010701',END_DATE='20010702'
In this example, all jobs scheduled between 7/1/2001 12:30:00pm and 7/2/2001 12:30:00pm are selected and started.
R3_ACTIVATE_JOBS NAME='*',GROUP='*',USER='SUPPORT',START_
DATE='20010701',END_DATE='20010702'
Standard interface
[ standard ]
Syntax
R3_ACTIVATE_JOB[S]
NAME=...
[,JOBCOUNT=...]
[,NOFOUND=...]
[,ERROR=...]
[,SELECT=...]
[,START=...]
[,NEW_NAME=...]
[,START_D[ATE]=...]
[,START_T[IME]=...]
[,END_D[ATE]=...]
[,END_T[IME]=...]
[,TARGET_S[ERVER]=...]
448 Chapter 4 UC4 JCL for Applications
[,MON[ITOR]=...]
[,WAIT=...]
[,ABORTED=...]
[,REPL[ICATE]=...]
[,BEG_LOGLINES=...]
[,END_LOGLINES=...]
[,GET_SPOOL=...]
Syntax
NAME=
Description/Format
Selection of one or more jobs by name.
Format:
or
Parameter
JOBCOUNT=
NOFOUND=
ERROR=
SELECT=
START=
UC4 Name
Name and number clearly identify an individual SAP job. The wildcard character "*" can be used (such as 'xxx*') if several jobs are selected.
Further selection criteria in the form of a keyword and an assignment.
Non-specified parameters obtain default values. Formats are applied for the keyword assignment.
Number of the SAP job.
Format: script literal
Name and number clearly identify an individual SAP job.
Action when no jobs are found.
Format: script literal
Allowed Values "NORMAL" (default value) and "ABEND"
"NORMAL" - Script execution continues, the UC4 job ends normally.
"ABEND" - Script execution stops, the UC4 job ends abnormally.
Action if one of the selected jobs ends abnormally.
Format: script literal
Allowed values: "ABEND" (default value) and "IGNORE"
"ABEND" - Script execution stops, the UC4 job ends abnormally.
"IGNORE" - Script execution continues, the UC4 job ends normally.
Single or permanent selection.
Format: script literal
Allowed values: "ONCE" (default value) and "EVERY"
"ONCE" - The number of selected jobs is retrieved once.
"EVERY" - The number of selected jobs is retrieved after each job release.
Released jobs can so be paralleled.
Selection whether the original job or a duplicate should start.
Format: script literal
Allowed values: "ORIGINAL" (default value) and "DUPLICATE"
Automation Engine 449
Syntax
NEW_NAME=
START_D[ATE]=
START_T[IME]=
END_D[ATE]=
END_T[IME]=
TARGET_S[ERVER]=
MON[ITOR]=
Description/Format
Name of the Job that should start as a duplicate.
Format: script literal
Only used if START=DUPLICATE has been specified. This parameter is ignored if the original job should start.
Start date of the selected scheduled jobs.
Format: script literal
Date format: YYYYMMDD
Default value: "20000101"
All scheduled jobs will be selected and start commencing as of the specified start date if this parameter is used without the parameter END_
DATE.
Start time of the selected scheduled jobs.
Format: script literal
Time format: HHMMSS
Default value: "000000"
If this parameter is used without the parameter END_TIME, all scheduled jobs will be selected and started commencing as of the specified start time.
11:59pm is the end time.
End date of the selected scheduled jobs.
Format: script literal
Date format: YYYYMMDD
Default value: current date
This parameter must be indicated and the same date used with the parameter START_DATE to select all scheduled jobs of a day.
Start time of the selected scheduled jobs.
Format: script literal
Time format: HHMMSS
Default value: "235959"
Target system that should be used by a released SAP job.
Format: script literal
Allowed values: "KEEP" (default value) and "ATTRIBUTE"
"KEEP" - The target system specified in the original Job is kept.
"ATTRIBUTE" - The target system specified in the Job's host attributes is used.
Status monitoring in the activation log.
Format: script literal
Allowed values: "YES" and "NO" (default value)
450 Chapter 4 UC4 JCL for Applications
Syntax
WAIT=
ABORTED=
REPL[ICATE]=
BEG_LOGLINES=
END_LOGLINES=
GET_SPOOL=
Description/Format
Wait for SAP job children to end.
Format: script literal or UC4 name
Allowed values: "YES" or "NO" (default value)
"NO" - Do not wait for all children to end.
"YES" - Wait for all children to end. Children are logged in the activation report.
Reaction to abnormal end of SAP job children.
Format: script literal or UC4 Name
Allowed values: "YES" and "NO" (default value)
"NO" - SAP job (parent) does not abort. The script continues and the UC4 job ends normally.
"YES" - SAP job (parent) aborts. The script does not continue and the UC4 job ends abnormally.
Handling of the children of intercepted jobs.
Format of the value: script literal
Allowed values: "YES" and "NO" (default value)
"YES" - The children of a job are replicated in the UC4 system. They are displayed in the UserInterface's Activity Window and statistical records and reports are generated in the UC4 system.
"NO" - There is no replication in the UC4 system.
Determines the number of lines that should be assumed to the UC4 Job report (starting with the SAP job log's beginning).
Number of lines that should be written to the UC4 job report (starting with the SAP job log's ending).
By default, the complete job log is used if neither the parameter END_
LOGLINES nor BEG_LOGLINES have been specified. If only one of these two parameters has been specified, the corresponding job-log lines (either from the beginning or the end) are read.
No Job log is transferred if the value "0" has been specified in both parameters.
In both parameters, you can only use numeric values.
Queries the spool list of the started Job.
Format of the value: script literal
Allowed values: "YES" or "NO" (default value)
"YES" = Queries the spool list which is stored as a text file in the directory that you define in the SAP Agent's INI file , parameter Download_dir=
(Sektion [GLOBAL]). The name of this file is structured as follows:
<SAP Job count>_<Step number>_<Spool number.txt
This file is also registered as a Job output in the UC4 Job.
"NO" = The spool list is not requested.
Spool entries of children are only requested when the parameter
REPLICATE= is either set to YES or to ALL.
Automation Engine 451
Example
Releasing all planned jobs with job name 'REORG_SPOOL':
R3_ACTIVATE_JOBS NAME='REORG_SPOOL',NOFOUND='ABEND'
See also:
R3_ACTIVATE_REPORT
E xecutes the specified report. If required, you can select a variant and parameters for list controlling matters.
Transaction: SM36, SM37
Interface: UC4 and Standard
UC4 Interface
[ UC4 ]
Syntax
R3_ACTIVATE_REP[ORT]
REPORT=...
[,VARIANT=...]
[,DESTINATION=...]
[,COPIES=...]
[,LIST_NAME=...]
[,LIST_TEXT=...]
[,IMMEDIATELY=...]
[,RELEASE=...]
[,NEW_LIST_ID=...]
[,EXPIRATION=...]
[,LINE_COUNT=...]
[,LINE_SIZE=...]
[,LAYOUT=...]
[,COVERPAGE=...]
[,SAP_COVER_PAGE=...]
[,OS_COVER_PAGE=...]
[,RECEIVER=...]
[,DEPARTMENT=...]
[,AUTHORITY=...]
[,DATA_SET=...]
[,TYPE=...]
[,SPOOL_PRIORITY=...]
[,TEXTONLY=...]
[,FRAMES=...]
[,ARCHIVE_MODE=...]
[,ARCHIVE_SAPOBJECT=...]
452 Chapter 4 UC4 JCL for Applications
[,ARCHIVE_OBJECT=...]
[,ARCHIVE_INFO=...]
[,ARCHIVE_TEXT=...]
[,MONITOR=...]
[,BEG_LOGLINES=...]
[,END_LOGLINES=...]
[,GET_SPOOL=...]
Syntax
REP[ORT]=
VAR[IANT]=
Description/Format
Name of the report.
Format:
Name of the variant.
Format: script literal
Print Parameters
DEST[INATION]=
COPIES=
LIST_N[AME]=
LIST_T[EXT]=
IMM[EDIATELY]=
Output device.
Format: script literal
This parameter specifies the name of the output device. In most cases, this is a printer name but it can also be the name of a fax machine or the like.
Note that the long forms of SAP printer names cannot be used for technical reasons on the part of SAP's XBP interface. Use the 4-digit technical name instead.
Number of copies.
Format: Integer
Default value: 0
Specify the number of document copies that should be printed.
Name of spool request.
Format: script literal
This parameter specifies the name of the spool request. It can consist of any letters, numbers, special characters and blanks. The suggested standard name for a spool request consists of the 8 letters of the report name, the separator '_' and the first 3 letters of the user name.
Text for the cover page.
Format: script literal
This parameter specifies the descriptive text for the spool request. It can consist of any letters, numbers, special characters and blanks.
Print immediately.
Format: script literal
Allowed values: YES and NO (default value)
Syntax
REL[EASE]=
NEW_LIST_ID=
EXPIR[ATION]=
LINE_COUNT=
LINE_SIZE=
LAYOUT=
COVER[PAGE]=
Automation Engine 453
Description/Format
Delete after printing.
Format: script literal
Allowed values: YES and NO (default value)
This parameter specifies whether the spool request is deleted immediately after printing at the output device or only if the spool retention period has expired.
New spool request.
Format: script literal
Allowed Values: YES (default value) and NO
Spool retention period.
Format: Integer
Default value: 0
This parameter specifies the number of days that a spool request is kept in the spool system before it is deleted.
Page length of list.
Format: Integer
Default value: 0
Number of lines per list page. When this field contains a zero or is empty, there is no limit in the number of pages of the particular list
(not allowed for printing). The page length of the list is then only determined by its content. For printing, the maximum number of lines per page depends on the selected format. Choose another format to have the number of lines changed.
Width of list.
Format: Integer
Default value: 0
This parameter contains the current line width of the list. For printing, the maximum line width depends on the selected format.
Select a different format to change the line width.
Print formatting.
Format: script literal
This parameter defines the print format of the spool request. The format mainly defines the page format, i.e. the maximum number of lines and columns on one printed page.
Selection of cover page.
Format: script literal
Allowed values: YES and NO (default value)
This parameter determines if a cover page with report selections is printed at the beginning. When a cover page is created, it will be adopted to the job report. Doing so documents the parameters that have been used for this execution.
454 Chapter 4 UC4 JCL for Applications
Syntax
SAP_COVER[_PAGE]=
OS_COVER[_PAGE]=
RECEIVER=
DEPART[MENT]=
AUTHORITY=
DATA_SET=
TYPE=
SPOOL_PRI[ORITY]=
Description/Format
SAP cover page.
Format: script literal
Allowed values: "" (default value), "X" and "D"
"" - No cover page is printed.
"X" - A cover page is printed.
"D" - It depends on the setting of the particular output device
(printer) whether a cover page is printed.
Host spool cover page.
Format: script literal
Allowed values: "" (default value), "X" and "D"
"" - - No cover page is printed.
"X" - A cover page is printed.
"D" - It depends on the setting of the particular output device
(printer) whether a cover page is printed.
Recipient
Format: script literal
This parameter contains the receiver name of the spool request.
This name is printed on the cover page. The current user name is the standard for the receiver name.
Department on cover page.
Format: script literal
This parameter contains the department name for the spool request.
This name is printed on the cover page.
Authorization
Format: script literal
This parameter contains authorization for the spool request
(maximum of 12 characters). Only authorized users can have content of the spool request displayed.
Name of spool dataset.
Format: script literal
Type of spool request.
Format: script literal
Spool request priority.
Format: Integer
Default value: 5
Syntax
TEXTO[NLY]=
FRAMES=
Archive Parameters
ARCHIVE_M[ODE]=
ARCHIVE_S[APOBJECT]=
ARCHIVE_O[BJECT]=
ARCHIVE_I[NFO]=
ARCHIVE_T[EXT]=
Control Parameters
MON[ITOR]=
Automation Engine 455
Description/Format
Plain text
Format: script literal
Allowed values: YES and NO (default value)
Controls the output of non-ASCII characters of a print list.
Requirements for using this parameter (see also SAP note 777337): l l
SAP Basis Release 6.20 with support package
SAPKB62045
SAP Basis Release 6.40 with support package
SAPKB64010
Frame characters.
Format: script literal
Allowed values: YES (default value) and NO
Handles default framing. The same requirements apply as for the parameter TEXTONLY=.
Archiving mode.
Format: script literal
Allowed values: 1 (default value), 2 and 3
1 - The document should only be printed.
2 - The document should only be saved in the optical archive.
3 - The document should be printed and saved in the optical archive.
Object type of business object.
Format: script literal
SAP objects are classified with object types.
See: Archive Parameters with R3_ACTIVATE_REPORT
Document type.
Format: script literal
Archive objects are classified according to document types.
Info field.
Format: script literal
Information code for the archiving request.
Text information field.
Format: script literal
Descriptive text for the archiving request. It can consist of any letters, numbers, special characters and blanks.
Log status monitoring in the activation log.
Format: script literal
Allowed Values: YES and NO (default value)
456 Chapter 4 UC4 JCL for Applications
Description/Format Syntax
Parameters for parent child relationship
BEG_LOGLINES=
END_LOGLINES=
GET_SPOOL=
Determines the number of lines that should be assumed to the UC4
Job report (starting with the SAP job log's beginning).
Number of lines that should be written to the UC4 job report (starting with the SAP job log's ending).
By default, the complete job log is used if neither the parameter
END_LOGLINES nor BEG_LOGLINES have been specified. If only one of these two parameters has been specified, the corresponding job-log lines (either from the beginning or the end) are read.
No Job log is transferred if the value "0" has been specified in both parameters.
In both parameters, you can only use numeric values.
Requests the spool list of the started Job.
Format of the value: script literal
Allowed values: YES or NO (default)
YES = The spool list is requested. It is stored as a text file in the directory that has been defined in the SAP Agent's INI file with the parameter Download_dir= (Sektion [GLOBAL]). The name of this file is structured as follows:
<SAP Job count>_<step number>_<spool number>.txt
This file is also registered as Job output in the UC4 Job.
NO = The spool list is not requested.
Standard Interface
[ standard ]
Syntax
R3_ACTIVATE_REP[ORT]
REPORT=...
[,VARIANT=...]
[,DESTINATION=...]
[,COPIES=...]
[,LIST_NAME=...]
[,LIST_TEXT=...]
[,IMMEDIATELY=...]
[,RELEASE=...]
[,NEW_LIST_ID=...]
[,EXPIRATION=...]
[,LINE_COUNT=...]
[,LINE_SIZE=...]
Automation Engine 457
[,LAYOUT=...]
[,COVERPAGE=...]
[,SAP_COVER_PAGE=...]
[,OS_COVER_PAGE=...]
[,RECEIVER=...]
[,DEPARTMENT=...]
[,AUTHORITY=...]
[,DATA_SET=...]
[,TYPE=...]
[,SPOOL_PRIORITY=...]
[,ARCHIVE_MODE=...]
[,ARCHIVE_SAPOBJECT=...]
[,ARCHIVE_OBJECT=...]
[,ARCHIVE_INFO=...]
[,ARCHIVE_TEXT=...]
[,MONITOR=...]
[,WAIT=...]
[,ABORTED=...]
[,REPL[ICATE]=...]
[,BEG_LOGLINES=...]
[,END_LOGLINES=...]
[,GET_SPOOL=...]
Syntax
REP[ORT]=
VAR[IANT]=
Description/Format
Name of the report.
Format:
Name of the variant.
Format: script literal
Print Parameters
DEST[INATION]=
COPIES=
Output device.
Format: script literal
This parameter specifies the name of the output device. In most cases, this is a printer name but it can also be the name of a fax machine or the like.
Note that the long forms of SAP printer names cannot be used for technical reasons on the part of SAP's XBP interface. Use the 4-digit technical name instead.
Number of copies.
Format: Integer
Default value: 0
Specify the number of document copies that should be printed.
458 Chapter 4 UC4 JCL for Applications
Syntax
LIST_N[AME]=
LIST_T[EXT]=
IMM[EDIATELY]=
REL[EASE]=
NEW_LIST_ID=
EXPIR[ATION]=
LINE_COUNT=
Description/Format
Name of spool request.
Format: script literal
This parameter can be used to specify the name of the spool request. It can consist of any letters, numbers, special characters and blanks. The suggested standard name for a spool request consists of the 8 letters of the report name, the separator '_' and the first 3 letters of the user name.
Text for the cover page.
Format: script literal
This parameter can be used to specify the descriptive text for the spool request. It can consist of any letters, numbers, special characters and blanks.
Print immediately.
Format: script literal
Allowed values: YES and NO (default value)
Delete after printing.
Format: script literal
Allowed values: YES and NO (default value)
This parameter specifies whether the spool request is deleted immediately after printing at the output device or only if the spool retention period has expired.
New spool request.
Format: script literal
Allowed Values: YES (default value) and NO
Spool retention period.
Format: Integer
Default value: 0
This parameter specifies how many days a spool request is kept in the spool system before it will be deleted.
Page length of list.
Format: Integer
Default value: 0
Number of lines per list page. When this field contains a zero or is empty, there is no limit in the number of pages of the particular list
(not allowed for printing). The page length of the list is then only determined by its content. For printing, the maximum number of lines per page depends on the selected format. Choose another format to have the number of lines changed.
Syntax
LINE_SIZE=
LAYOUT=
COVER[PAGE]=
SAP_COVER[_PAGE]=
OS_COVER[_PAGE]=
RECEIVER=
DEPART[MENT]=
Automation Engine 459
Description/Format
Width of list.
Format: Integer
Default value: 0
This parameter contains the current line width of the list. For printing, the maximum line width depends on the selected format.
Select another format to change the line width.
Print formatting.
Format: script literal
This parameter defines the print format of the spool request. The format mainly defines the page format, i.e. the maximum number of lines and columns on one printed page.
Selection of cover page.
Format: script literal
Allowed values: YES and NO (default value)
This parameter determines if a cover page with report selections is printed at the beginning. When a cover page is created, it will be adopted to the job report. This documents which parameters were used for this execution.
SAP cover page.
Format: script literal
Allowed values: "" (default value), "X" and "D"
"" - No cover page is printed.
"X" - A cover page is printed.
"D" - It depends on the setting of the particular output device
(printer) whether a cover page is printed.
Host spool cover page.
Format: script literal
Allowed values: "" (default value), "X" and "D"
"" - No cover page is printed.
"X" - A cover page is printed.
"D" - It depends on the setting of the particular output device
(printer) whether a cover page is printed.
Recipient
Format: script literal
This parameter contains the receiver name of the spool request.
This name is printed on the cover page. The current user name is the standard for the receiver name.
Department on cover page.
Format: script literal
This parameter contains the department name for the spool request.
This name is printed on the cover page.
460 Chapter 4 UC4 JCL for Applications
Syntax
AUTHORITY=
DATA_SET=
TYPE=
SPOOL_PRI[ORITY]=
Description/Format
Authorization
Format: script literal
This parameter contains authorization for the spool request
(maximum of 12 characters). Only authorized users can have content of the spool request displayed.
Name of spool dataset.
Format: script literal
Type of spool request.
Format: script literal
Spool request priority.
Format: Integer
Default value: 5
Archive Parameters
ARCHIVE_M[ODE]=
ARCHIVE_S[APOBJECT]=
ARCHIVE_O[BJECT]=
ARCHIVE_I[NFO]=
ARCHIVE_T[EXT]=
Archiving mode
Format: script literal
Allowed values: 1 (default value), 2 and 3
1 - The document should only be printed.
2 -The document should only be saved in the optical archive.
3 - The document should be printed and saved in the optical archive.
Object type of business object.
Format: script literal
SAP objects are classified with object types.
See: Archive Parameters with R3_ACTIVATE_REPORT
Document type.
Format: script literal
Archive objects are classified according to document types.
Info field.
Format: script literal
Information code for the archiving request.
Text information field.
Format: script literal
Descriptive text for the archiving request. It can consist of any letters, numbers, special characters and blanks.
Control Parameters
MON[ITOR]=
Log status monitoring in the activation log.
Format: script literal
Allowed Values: YES and NO (default value)
Parameters for parent child relationship
Syntax
WAIT=
ABORTED=
REPL[ICATE]=
BEG_LOGLINES=
END_LOGLINES=
Automation Engine 461
Description/Format
Wait for SAP job children to end.
Format: script literal or UC Name
Allowed values: YES and NO (default value)
YES - Wait for all children to end. Children are logged in the activation report.
NO - Do not wait for all children to end.
Reaction to abnormal end of SAP job children.
Format: script literal or UC4 Name
Allowed values: YES (default value) and NO
YES - SAP job (parent) is aborted. The Script is not continued and the UC4 job ends abnormally.
NO - SAP job (parent) is not aborted. The script is continued and the
UC4 job ends normally.
Handling of children of intercepted jobs.
Format of the value: script literal
Allowed values: YES and NO (default value)
YES - The children of a job are replicated in the UC4 system. They are displayed in the UserInterface's Activity Window. Statistical records and reports are created in the UC4 system.
NO - There is no replication in the UC4 system.
Determines the number of lines that should be assumed to the UC4
Job report (starting with the SAP job log's beginning).
Number of lines that should be written to the UC4 job report (starting with the SAP job log's ending).
By default, the complete job log is used if neither the parameter
END_LOGLINES nor BEG_LOGLINES have been specified. If only one of these two parameters has been specified, the corresponding job-log lines (either from the beginning or the end) are read.
No Job log is transferred if the value "0" has been specified in both parameters.
In both parameters, you can only use numeric values.
462 Chapter 4 UC4 JCL for Applications
Syntax
GET_SPOOL=
Description/Format
Requests the spool list of the started Job.
Format of the value: script literal
Allowed values: YES or NO (default)
YES = The spool list is requested. It is stored as a text file in the directory that has been defined in the SAP Agent's INI file with the parameter Download_dir= (section [GLOBAL]). The name of this file is structured as follows:
<SAP Job count>_<step number>_<spool number>.txt
This file is also registered as Job output in the UC4 Job.
NO = The spool list is not requested.
The spool list is requested for ALL child jobs if you use this script element several times in an SAP Job and if you combine all the individual job steps by using the option "Combine job steps" in the
Connection object even if the parameter GET_SPOOL="YES" is only set for one R3_ACTIVE_REPORT.
Spool entries of children are only requested when the parameter
REPLICATE= is either set to YES or to ALL.
Comments
This script element enables the modification of an ABAP step. The name of the report, variant and various archiving and print parameters for the ABAP step can be reset when the SAP job has been selected.
This parameter corresponds to the SAP Dictionary Structure PRI_PARAMS and ARC_PARAMS fields.
Please use the dictionary or the BAPI Browser to get detailed information about the individual fields.
Instead of using a variant, the selection criteria can also be assigned using the script element
.
Example
R3_ACTIVATE_REPORT REPORT='ZSUSER00',VARIANT='ALL_
USERS',COVERPAGE='YES',DESTINATION='LT77',IMMEDIATELY='YES'
See also:
Sample Collection
Calling an MBean
R3_ACTIVATE_SESSIONS
Processes batch input sessions.
Transaction: SM35
Interface: UC4
Automation Engine 463
Syntax
R3_ACTIVATE_SESSION[S]
NAME=...
[,STATUS=...]
[,NOFOUND=...]
[,ERROR=...]
[,ERRORLEVEL=...]
[,SELECT=...]
[,JOBNAME=...]
[,ORDER_BY=...]
Syntax Description/Format
NAME=
STATUS=
Selection of sessions by name (such as 'xxx*').
Format:
Selection of sessions by status.
Format: script literal
NOFOUND=
Allowed Values: "" (default value) and "E"
"" - Session that should be processed.
"E" - Faulty session.
Action if no sessions have been selected.
Format: script literal
Allowed values: "NORMAL" (default value) and "ABEND"
ERROR=
"NORMAL" - Script execution continues, the UC4 Job ends normally.
"ABEND" - Script execution stops, the UC4 Job ends abnormally.
Action if one of the selected sessions terminates abnormally.
Format: script literal
Allowed values: "ABEND" (default value) and "IGNORE"
ABEND - Script execution stops, the UC4 Job ends abnormally.
IGNORE - Script execution continues, the UC4 Job ends normally.
ERRORLEVEL=
SELECT=
See: ERROR/ERRORLEVEL with R3_ACTIVATE_SESSIONS
Defines the number of erroneous transactions in percent (%).
Format: script literal
Default value: "101"
The job ends abnormally if this number has been exceeded.
Single or permanent selection.
Format: script literal
Allowed values: "ONCE" (default value) and "EVERY"
ONCE - The number of selected session is retrieved once.
EVERY - The number of selected sessions is retrieved after each session release. Therefore, released sessions can be parallelized.
464 Chapter 4 UC4 JCL for Applications
JOBN[AME]=
ORDER[_BY]=
Each session is processed with an SAP job.
Format: script literal
Allowed values: "ATTRIBUTE" (default value) and "SESSION"
"ATTRIBUTE" - Contents of the "Job Name" text field in the host attributes . A standard UC4 job name is created if there is no text.
"SESSION" - Name of the session that should be processed.
Criteria that can be used to sorting the selection of session. All field names of the SAP table APQI can be used. For example: ORDER_BY=GROUPID
This parameter is supported for SAP version 4.6 and later ones.
R3_ACTIVATE_SESSION[S]
[QID=...]
[,NOFOUND=...]
[,ERROR=...]
[,ERRORLEVEL=...]
[,JOBNAME=...]
Syntax Description/Format
QID=
Queue ID that clearly identifies a batch input session.
Format: script literal
NOFOUND=
This parameter can be used to start a single batch input session.
Action if no sessions have been selected.
Format: script literal
ERROR=
Allowed values: "NORMAL" (default value) and "ABEND"
"NORMAL" - Script execution continues, the UC4 Job ends normally.
"ABEND" - Script execution stops, the UC4 Job ends abnormally.
Action if one of the selected sessions terminates abnormally.
Format: script literal
Allowed values: "ABEND" (default value) and "IGNORE"
ABEND - Script execution stops, the UC4 Job ends abnormally.
IGNORE - Script execution continues, the UC4 Job ends normally.
ERRORLEVEL=
JOBN[AME]=
See: ERROR/ERRORLEVEL with R3_ACTIVATE_SESSIONS
Defines the the number of erroneous transactions in percent (%).
Format: script literal
Default value: "101"
The job ends abnormally if this limit has been exceeded.
Each session is processed with an SAP job.
Format: script literal
Allowed values: "ATTRIBUTE" (default value) and "SESSION"
"ATTRIBUTE" - Contents of the "Job Name" text field in the host attributes . A standard UC4 job name is created if there is no text.
"SESSION" - Name of the session to be processed.
Automation Engine 465
Description
The batch input sessions that should be started can be retrieved using a selection. Use the parameter
QID= to start a single batch input session. The selection results of R3_GET_SESSIONS that are stored in the activation report or in a file serve to locate the individual session by queue ID.
The parameter ORDER_BY can be used to define the order in which the batch input sessions should be processed. The selection is sorted according to the criteria that have specified in this parameter.
Examples
Processing all sessions called 'FI*'. The job will end abnormally if it contains invalid transactions.
R3_ACTIVATE_SESSIONS
NAME='FI*',STATUS=,NOFOUND=NORMAL,ERROR=ABEND,ERRORLEVEL=0
In the second example, a single batch input session starts whose queue ID has been specified as a parameter.
R3_ACTIVATE_SESSION QID='20020318171302022315'
See also:
R3_CALL_TRANSACTION
Calls an SAP transaction.
Transaction: -
Interface: UC4
Syntax
R3_CALL_TRANS[ACTION]
CODE=...
[,UPDATE=...]
[,RACOMMIT=...]
[,NOBINPT=...]
Syntax
CODE=
UPDATE=
Description/Format
Twenty-digit transaction code.
Format:
Booking mode for this transaction.
Format: script literal
Allowed values: "A", "L" and "S" (Default)
"A" - Asynchronous
"L" - Local
"S" - Synchronous
466 Chapter 4 UC4 JCL for Applications
RACOMMIT=
NOBINPT=
End of transaction in commit work.
Format: script literal
Allowed values: "" (default value) and "X"
"" - Transaction runs until normal transaction ends
"X" - Transaction ends in SAP as soon as the ABAP script element COMMIT
WORK has run through.
Processing in batch input mode.
Format: script literal
Allowed values: "" (default value) and "X"
"" - Transaction is processed in BDC mode.
"X" - Transaction is processed in SAP in the same way that transactions started by a dialog user are processed.
Comments
This script element calls an SAP transaction. The data required for the transaction has previously been defined with
.
Note: For security reasons, this transaction is not executed using the RFC user rights (CPIC) with which
UC4 usually logs on to SAP and schedules background jobs. For calling the transaction, the Agent logs off of the SAP system and then logs back on under the user listed in the Login object for the corresponding
UC4 Job. UC4 recommends applying a special user in SAP to be used for calling transactions out of UC4.
This user must have transaction rights.
We also recommend using the R3_SET_BDCDATA and R3_CALL_TRANSACTION script elements in separate UC4 jobs. This will prevent the user defined for R3_CALL_TRANSACTION from influencing other SAP JCL script elements (e.g. R3_ACTIVATE_REPORT).
Example
In the following example, the BDC data for the transaction "SA38" is defined. Subsequently, the "SA38" transaction is called in order to execute a data update.
R3_SET_BDCDATA PROGRAM="SAPMS38M", DYNPRO="0101", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="=SSET"
R3_SET_BDCDATA FNAM="RS38M-PROGRAM", FVAL="RSEINB00"
R3_SET_BDCDATA PROGRAM="SAPLSVAR", DYNPRO="0302", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="=CHNG"
R3_SET_BDCDATA FNAM="RSVAR-VARIANT", FVAL="UM-V1"
R3_SET_BDCDATA FNAM="RSVAR-FLAG1", FVAL="X"
R3_SET_BDCDATA PROGRAM="RSEINB00", DYNPRO="1000", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="=SAVE"
R3_SET_BDCDATA FNAM="P_FILE", FVAL="test.txt"
R3_SET_BDCDATA PROGRAM="RSEINB00", DYNPRO="1000", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="=VBAC"
R3_SET_BDCDATA PROGRAM="SAPLSVAR", DYNPRO="0302", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="/EBACK"
R3_SET_BDCDATA PROGRAM="SAPMS38M", DYNPRO="0101", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="=BACK"
R3_CALL_TRANSACTION CODE="SA38", UPDATE="S"
See also:
Automation Engine 467
R3_COPY_VARIANT
This script statement copies a report variant.
Transaction: SA38
Interface: UC4 and Standard
Syntax
R3_COPY_VARIANT
REP[ORT]=...
,S[OURCE]=...
,T[ARGET]=...
[,DELAY=...]
[,MODE=...]
[,OVERWRITE=...]
Syntax Description/Format
REP[ORT]=
S[OURCE]=
T[ARGET]=
DELAY=
MODE=
Name of the report whose variant should be copied.
Format of the value:
Name of the source variant.
Format of the value: script literal
Name of the target variant.
Format of the value: script literal
Period in seconds which the Agent waits after a variant has been copied.
Format of the value: script literal
Default value: "0"
Helps to avoid possible synchronization problems in an
SAP system (a variant that has just been copied cannot be found) by using multiple application servers.
Processing mode.
Format of the value: script literal
Allowed values: "" (default value) and "C"
"" - Copies the variant by duplicating table entries.
"C" - Creates the variant by referring to SAP-internal interfaces.
The parameter MODE=C must be used if you want to copy a system variant. A copy is not automatically included in a transport order.
This parameter is not required if the standard interface is used.
UC4
Interface required
468 Chapter 4 UC4 JCL for Applications
Syntax Description/Format UC4
Interface required
OVERWRITE=
Handling if the variant already exists.
Format of the value: script literal
Allowed values: "YES" and "NO" (default value)
"YES" - The target variant is overwritten.
"NO" - The target variant is not overwritten.
Note for using the XBP3.0 interface: The options Protect variant and Only background processing are not passed on and the copied variant is visible for all users (batch and dialog).
Example
Variant 'DAILY' of report 'RSPO0041' is copied to 'DAILYCOP'.
R3_COPY_VARIANT REPORT='RSPO0041',SOURCE='DAILY',TARGET='DAILYCOP'
See also:
R3_CREATE_OUTPUT_REQUEST
Creates a new output request for an existing spool request
Transaction: SP01
Interface: UC4
Syntax
R3_CREATE_OUTPUT_REQ[UEST]
SPOOLNR=...
[,DESTINATION=...]
[,RECEIVER=...]
[,DEPARTMENT=...]
[,COPIES=...]
[,SPOOL_PRIORITY=...]
[,TITLE=...]
[,PAGE_FROM=...]
[,PAGE_TO=...]
[,ERROR=...]
Syntax
SPOOLNR=
Description/Format
Number of the spool request
Format of the value:
Automation Engine 469
DEST[INATION]=
RECEIVER=
DEPART[MENT]=
COPIES=
Output device
Format of the value: script literal
Recipient
Format of the value: script literal
Department
Format of the value: script literal
Number of copies
Format of the value: number
Default value: "0"
SPOOL_PRI[ORITY]=
Spool priority
Format of the value: script literal or number
TITLE=
PAGE_FROM=
PAGE_TO=
Default value: "0"
Spool title
Format of the value: script literal
From page
Format of the value: number
Default value: "0"
To page
Format of the value: number
ERROR=
Default value: "0"
Handling if an error occurs
Format of the value: script literal
Allowed values: "NORMAL" and "ABEND" (default value)
"NORMAL" - The UC4 job continues.
"ABEND" - The UC4 job ends abnormally.
Example
R3_CREATE_OUTPUT_REQUEST
SPOOLNR='1234',DESTINATION='PRNT',RECEIVER='SMITH',DEPARTMENT='UC4',COPIES=
1,TITLE='Overview December'
See also:
R3_CREATE_VARIANT
Creates a new variant.
Transaction: SA38
Interface: Standard
470 Chapter 4 UC4 JCL for Applications
Syntax
R3_CREATE_VAR[IANT]
REP[ORT]=...
,VAR[IANT]=...
[,TEXT=...]
[,PROTECTED=...]
Syntax
REP[ORT]=
VAR[IANT]=
TEXT=
PROTECTED=
Description/Format
Name of the report.
Format:
Name of the variant.
Format: script literal
Variant short text.
Format: script literal
The text is written in the language that the UC4 administrator has defined in the Agent's INI file. The language can also be defined in the job settings. In this case, they override the INI-file specifications.
The variant's name is used as short text if you do not specify this parameter.
Protection against modifications.
Format: script literal
Allowed values: "YES" and "NO" (default value)
"YES" - Only the CPIC user can modify the variant.
"NO" - There are no limitations to variant modifications.
Comments
UC4 automatically sets the attribute "Variant for background processing" when a variant is created. All other variant properties are set in the same way that properties are created in the SAP GUI.
The function R3_CREATE_VARIANT always creates variants without contents. Use
or
to add entries to these variants. Keep the following order when you call functions if a report should be processed with a new variant:
R3_SET_SELECT_OPTION - Defines the selection criteria.
R3_CREATE_VARIANT - Creates a variant.
R3_ACTIVATE_REPORT - Executes the report with the above variant.
If you want to recreate a variant that already exists, you can delete it by using the function
and then recreate it.
The job aborts if an error occurs while the variant is being created.
The variant's client is automatically the one to which the SAP Agent has logged on because of its Login object. SAP system variants (CUS& and SAP&) can also be created. In this case, the variant's client is automatically set to 0000.
XBP 2.0 or above (SAP Release 4.6+) is required for using R3_CREATE_VARIANT.
Automation Engine 471
Example
The following example defines the value "17" for the parameter "MIN_AGE". This selection criterion is then used to create a variant.
R3_SET_SELECT_OPTION SELNAME='MIN_AGE',KIND='P',LOW='17',SIGN='I'
R3_CREATE_VARIANT REP=REPORT01,VAR=NEW,TEXT='New variant'
See also:
R3_DEACTIVATE_CM_PROFILE
Deactivates a profile in the SAP Criteria Manager
Transaction: SM62
Interface: Standard
Syntax
R3_DEACTIVATE_CM_PROFILE
TYPE=...
[,ERROR=...]
Syntax
TYPE=
ERROR=
Description/Format
Profile type
Format:
Allowed values: "EVHIRO", "EVTHIS" and "INTERC"
"EVHIRO" - Event History Reorg
"EVTHIS" - Event History
"INTERC" - Job Interception
Handling if it is not possible to deactivate the profile
Format of the value: script literal
Allowed values: "ABEND" (default) and "IGNORE"
"ABEND" - The script does not continue, the UC4 job ends abnormally.
"IGNORE" - The script continues, the UC4 job ends normally.
Comments
Only one profile can be activated per profile type. Thus, it is not necessary to specify the ID but only the type.
Example
The example shown below deactivates the active profile of the Event History.
R3_DEACTIVATE_CM_PROFILE TYPE="EVTHIS"
472 Chapter 4 UC4 JCL for Applications
See also:
R3_DELETE_NODE
Deletes a node in the SAP monitor architecture
Transaction: RZ20
Interface: XMW
Syntax
R3_DELETE_NODE
NODE=...
Syntax
NODE=
Description/Format
Name of the node
Format of the value:
Comments
This script element deletes an existing node (attribute, object, sum or context node). If this node includes open alarms, these are closed before the node is deleted.
Format of the parameter NODE=
This parameter describes a complete path. The individual parts are separated by a slash "/".
The path always starts with a context node which can be followed by a sum node, an object node and an attribute node.
Context, object and attribute nodes must only be used once in the path. Sum nodes can be used several times.
Example 1:
"UC4/TestNode/PerfAttributUC4" l l l
"UC4" - context name
"TestNode" - object node
"PerfAttributUC4" - attribute node
Example 2:
"UC4/Summary1/Summary2/TestNode/PerfAttributUC4" l l l l l
"UC4" - context name
"Summary1" - sum node
"Summary2" - sum node
"TestNode" - object node
"PerfAttributUC4" - attribute node
Automation Engine 473
Example
After executing the following example, the node "UC4/TEST" still exists. The sub-node "PerfAttributUC4" was deleted.
R3_DELETE_NODE NODE='UC4/TEST/PerfAttributUC4'
See also:
R3_DELETE_VARIANT
This statement deletes a report's variant.
Transaction: SA38
Interface: UC4 and Standard
Syntax
R3_DELETE_VARIANT
REP[ORT]=...
,VAR[IANT]=...
Syntax
REP[ORT]=
VAR[IANT]=
Description/Format
Name of report whose variant should be deleted
Format:
Name of variant that should be deleted
Format: script literal
Example
Deleting variant 'DAILYCOP' of report 'RSPO0041'.
R3_DELETE_VARIANT REPORT='RSPO0041',VAR='DAILYCOP'
See also:
R3_GET_APPLICATION_RC
Checks the application return code of one or several job steps
Transaction: -
Interface: Standard (XBP 3.0)
474 Chapter 4 UC4 JCL for Applications
Syntax
R3_GET_APPLICATION_RC
NAME=...
,JOBCOUNT=...
[,STEP=...]
[,MAX_APPL_RC=...]
Syntax
NAME=
Description/Format
Name of the SAP job
Format of the value:
By default the SAP job specified in the script of one of the following script elements is used: l l l l
JOBCOUNT=
Number of the SAP job
Format: script literal
STEP=
In combination with NAME=, the SAP job is unique.
Number of the SAP job step
Format of the value: number
MAX_APPL_
RC=
Default value: "1"
Specifying "0" has the effect that the application return codes of all the specified
SAP job steps are checked.
Maximum number of allowed application return codes
Format of the value: number
Default value: "0"
The UC4 Job aborts if the application return code of a job step exceeds the value specified here.
Comments
This script element checks the application return codes of job steps and compares them with the maximum value allowed. If this value is exceeded, the UC4 Job aborts. If not, job execution continues.
The application return code is also available in the report and can be read.
Example
The first example checks the application return code of step "2".
R3_MODIFY_JOB NAME="MYJOB",JOBCOUNT=13541601,STEP=2,MAX_APPL_RC=10
The second example illustrates how to check all application return codes of the job "MYJOB".
R3_MODIFY_JOB NAME="MYJOB",JOBCOUNT=13541601,STEP=0,MAX_APPL_RC=10
Automation Engine 475
See also:
R3_GET_APPLICATIONLOG
Retrieves messages from the application log (transaction SLG1) and writes them to a report or file.
Transaction: SLG1
Interface: UC4
Syntax
R3_GET_APPLICATIONLOG
[OBJECT=...]
[,SUBOBJECT=...]
[,FROM_DATE=...]
[,FROM_TIME=...]
[,TO_DATE=...]
[,TO_TIME=...]
[,USER=...]
[,TAC=...]
[,PROGRAM=...]
[,MESSAGE_CLASS=...]
[,FILE=...]
[,EXTNUMBER=...]
[,LOG_CREATION=...]
[,ENCODING=...]
Syntax
OBJ[ECT]=
SUB[OBJECT]=
FROM_D[ATE]=
FROM_T[IME]=
Description/Format
Object name (application code).
Format:
Default value: "*"
You can use the "*" wildcard for any characters.
Name of an object's sub-object.
Format: script literal
Default value: "*"
You can use the "*" wildcard for any characters.
Start date for message selection in the format "YYYYMMDD".
Format: script literal
Default value: "20010101"
Start time for message selection in the format "HHMMSS".
Format: script literal
Default value: "000000"
476 Chapter 4 UC4 JCL for Applications
TO_D[ATE]=
TO_T[IME]=
USER=
TAC=
PROGRAM=
Completion date for message selection in the format "YYYYMMDD".
Format: script literal
Default value: current date
Completion time for message selection in the format "HHMMSS".
Format: script literal
Default value: "235959"
Name of the user who has triggered a logged event.
Format: script literal
Default value: "*"
You can use the "*" wildcard for any characters.
Name of the transaction that has been used to activate a logged event.
Format: script literal
Default value: "*"
You can use the "*" wildcard for any characters..
Name of the program that has activated a logged event.
Format: script literal
Default value: "*"
You can use the "*" wildcard for any characters.
MESSAGE_CL[ASS]=
Indicator that a message belongs to a problem class.
Format: script literal
Default value: "4"
FILE=
EXTNUMBER=
LOG_C[REATION]=
Message indicators are values between "1" (very important) and "4"
(additional information).
Name of the file in which the result (found messages) should be stored.
Format: script literal
The selection result is not written to the report if this parameter is used.
Application log's external identification number which has been allocated by the application program.
Format: script literal
Operation mode in which the application log has been created.
Format: script literal
Allowed values: "" (default value), "B", "D" and "I"
"" - Any
"B" - Batch
"D" - Dialog
"I" - Batch input
ENCODING=
Automation Engine 477
Encoding for the generated output file (Parameter FILE=).
For example: UTF-8
Default value: ISO-8859-1
When you specify an encoding that is not supported or invalid, the Job will abort with an error message.
The SAP Forms provide an input assistant for this field which lists all the supported encodings.
Comments
This script element can be used to select messages according to particular application log criteria. Located messages are regularly written to the UC4 report. Alternately, you can also write them to a file that has been defined by using the parameter FILE=.
For example, this script element enables access to the SAP Banking Accounts Managements application log. Messages from processes and process networks that were started with
can so be analyzed in UC4.
UC4 recommends using script-element parameters in a way that the number of application-log messages can be handled. You can do so by using precise selection criteria.
By default, the generated files are stored on the computer on which the Agent is installed (for example,
R3_GET_JOB_SPOOL; FILE=).
See also:
R3_GET_EVENT
Waits for an event that is triggered in SAP.
Transaction: SM36 (start condition)
Interface: Standard
Syntax
R3_GET_EVENT
ID=...
[,PARAM=...]
[,TIMEOUT=...]
Syntax
ID=
Description/Format
Name of the event.
Format:
Only one string with a maximum of 32 characters is allowed.
478 Chapter 4 UC4 JCL for Applications
PARAM=
TIMEOUT=
Parameter for the event.
Format: script literal
Only one string with a maximum of 64 characters is allowed.
Waiting time in seconds for an event that is triggered in SAP.
Format: Number
Default value: "0"
Comments
This script element can be used to wait for an event that has been triggered in SAP. This could be a system event, an event that has been predefined in SAP, or a user event. You can specify any content of your choice for the string that is used as the event parameter. Note that the script element waits for the event for an indefinite time if you define zero seconds for the timeout period.
Script processing continues when the event occurs.
Note that this script element can only react if the specified event is available in the SAP Event History.
Adjust the event's criteria profile in SAP accordingly if necessary.
Example
The following example defines that the waiting time for the event "TEST" with the parameter "Myparam" should be 10 seconds.
R3_GET_EVENT ID="TEST",PARAM="Myparam",TIMEOUT=10
See also:
R3_GET_INTERCEPTION
Reads the filter table of intercepted jobs and stores them in the activation report or a file.
Transaction: -
Interface: Standard (XBP 2.0)
Syntax
R3_GET_INTERC[EPTION]
[FILE=...]
[,ENCODING=...]
Syntax
FILE=
Description/Format
Name of the file in which intercepted jobs should be saved.
The result is not shown in the activation report if this parameter is used.
Automation Engine 479
ENCODING= Encoding for the generated output file (Parameter FILE=).
For example: UTF-8
Default value: ISO-8859-1
When you specify an encoding that is not supported or invalid, the Job will abort with an error message.
The SAP Forms provide an input assistant for this field which lists all the supported encodings.
Comments
This script element reads the contents of the SAP system table in which the conditions for batch jobs have been defined. The SAP client specified in the Login object referred to by the UC4 job is used here.
The table's contents are written to the activation report or a specified file which is structured. The first column (4 characters) contains the SAP client, the second column (33 characters) the job name and the third column the user name (12 characters).
By default, created files are stored on the computer on which the Agent has been installed (e.g.: R3_
GET_JOB_SPOOL; FILE=).
Note that this script element is only supported with XBP 2.0.
Example
The defined intercepted jobs are queried and written to a file.
R3_GET_INTERCEPTION FILE='C:\TEMP\IC.TXT'
See also:
R3_GET_JOB_SPOOL
Reads the spool list of an ABAP program step.
Transaction: SM37
Interface: UC4 and Standard
Syntax
R3_GET_JOB_SPOOL
FILE=...
[,NAME=...]
[,JOBCOUNT=...]
[,STEP=...]
[,NOFOUND=...]
[,MAXLINES=...]
[,SPOOLNR=...]
480 Chapter 4 UC4 JCL for Applications
Syntax
FILE=
[,FORMAT=...]
[,PAGES=...]
[,FILTER=...]
[,RAW=...]
[,ENCODING=...]
NAME=
JOBCOUNT=
STEP=
NOFOUND=
MAXLINES=
SPOOLNR=
Description/Format
Name of a file to which the result (step's spool list) should be written.
Format of value:
This file is also registered as Job output in the UC4 Job.
Name of the SAP job that contains the step.
Format of value: script literal
Not defining the job name has the effect that the system automatically uses the name of the last SAP job that has been processed via the UC4
Job that includes this script element.
Job count of the SAP job that contains the step.
Format of value: script literal
Not defining the job count has the effect that the system automatically uses the value of the last SAP job that has been processed via the UC4
Job.
If you use the parameters NAME and JOBCOUNT, keep in mind that the spool cannot be retrieved if the corresponding job has been deleted in the
SAP system (setting "Delete job in CCMS after completion" in the UC4
Job).
Number of steps in SAP job.
Format of value: Integer
Default value: 1
Handling if the spool list could not be found.
Format of value: script literal
Allowed values: NORMAL (default value) and ABEND
NORMAL - The UC4 job continues.
ABEND - The UC4 Job ends abnormally.
Maximum number of lines that are written to the file.
Format of value: Integer
Default value: 9999
The definitions that are made here are not considered if the settings
FORMAT = PDF or BIN have been specified.
Spool-request number.
Format of value: script literal
Not defining NAME, JOBCOUNT or SPOOLNR has the effect that the system automatically uses the last SAP job that has been processed via the UC4 Job.
Syntax
FORMAT=
PAGES=
FILTER=
RAW=
ENCODING=
Automation Engine 481
Description/Format
Output format.
Format of value: script literal
Allowed values: TXT (default), RAW (instead of the parameter RAW - see below), PDF, BIN and HTM
With the settings BIN and PDF being used, the spool list is not converted and transferred in a binary format.
Pages.
Format of value: script literal
Syntax of the parameter: PAGES=page[;page[;...]]
Separate the specifications for the individual page areas by using the character ";".
Examples: l l l
Page 7:
PAGES="7"
Pages 5 to 7:
PAGES="5,7"
Page 2 and the pages 5 to 7:
PAGES="2;5,7"
The symbol $ can be used instead of the last page: l l l l
Pages 1 to 3 and the last page:
PAGES="1,3;$" all pages:
PAGES="1,$" the first and last page:
PAGES="1;$" the last two pages:
PAGES="$-1,$"
The parameters FORMAT( not PDF), SPOOLNR and PAGES are also available for the XBP 3.0 interface (as of version 1.1).
Filter setting.
Format of value: script literal
String according to which a selection should be made. Wildcard characters cannot be used.
Supplies the spool list in untrimmed size.
Format of the value: script literal
Allowed values: YES and NO (default value)
YES - The spool list is supplied in untrimmed size (i.e. including all formatting characters).
NO - The spool list is not supplied in untrimmed size.
UC4 recommends using FORMAT=RAW instead of this parameter.
Encoding for the generated output file (Parameter FILE=).
For example: UTF-8
Default value: ISO-8859-1
When you specify an encoding that is not supported or invalid, the Job will abort with an error message.
The SAP Forms provide an input assistant for this field which lists all the supported encodings.
482 Chapter 4 UC4 JCL for Applications
Comments
This script element can be used with the following parameter combinations: l l l l l
SPOOLNR
NAME, JOBCOUNT, STEP
NAME, JOBCOUNT
STEP
None of these parameters
The parameter FILTER requires the UC4 Interface and the parameter RAW requires the standard interface.
The spool list can only be transferred if the checkbox "Delete job in CCMS after completion" in the
Host
Attributes tab has not been activated. This limitation does not apply if either the parameter SPOOLNR has been defined or the standard XBP 3.0 interface (as of version 1.1) is used without the parameters
NAME, JOBCOUNT and SPOOLNR.
Note for using the standard interface XBP3.0 with a later version than V1.1: standard interface: As a rule, the entire spool list is sent to the SAP Agent. The standard function of the
XBP interface does not allow the user to access parts of the spool list. Note that large spool lists can reduce the performance of the SAP Agent. The parameter MAXLINES= is first read when the entire spool list has already been transferred.
Note that by default, created files are stored on the computer on which the Agent has been installed
(for example, R3_GET_JOB_SPOOL; FILE=).
Examples
A report is activated in the example shown below. The spool list of the step is retrieved without the job name or job count being indicated as parameters.Therefore, the Job last processed by the Agent is automatically used.
R3_ACTIVATE_REPORT REPORT='RSPO0041',VAR='STANDARD',COVERPAGE=YES
R3_GET_JOB_SPOOL FILE='c:\temp\spoollist.txt',NOFOUND=ABEND,MAXLINES=20
See also:
R3_GET_JOBLOG
Retrieves the job log of an SAP job from SAP and writes it to the report.
Transaction: SM37
Interface: UC4 and Standard
Syntax
R3_GET_JOBLOG
NAME=...
,JOBCOUNT=...
Automation Engine 483
,BEG_LOGLINES=...]
[,END_LOGLINES=...]
Syntax
NAME=
JOBCOUNT=
BEG_LOGLINES=
END_LOGLINES=
Description/Format
Name of the SAP job.
Format:
Number of the SAP job.
Format: script literal
In combination with NAME (SAP job name), you can clearly identify an individual SAP job.
Determines the number of lines that should bepassed on to the UC4 Job report (starting with the SAP job log's beginning).
Number of lines that should be written to the UC4 job report (starting with the
SAP job log's ending).
By default, the complete job log is used if neither the parameter END_
LOGLINES nor BEG_LOGLINES are specified. If only one of these two parameters is specified, the corresponding job-log lines (either from the beginning or the end) are read.
No Job log is transferred if the value "0" is specified in both parameters.
Both parameters only accept numeric values.
Comments
This script element is used to determine the job log of an SAP job that has already run and was not started directly with UC4. Therefore, you can access the job log of sub-jobs with IS-U or SARA. The job log is available in the "Report" tab of the UC4 job that uses the script element.
Only the job log of one individual SAP job can be read at a time. It is not possible to use wildcard characters.
Example
The following example retrieves the job log of the job "SWWERRE" and job number "23483501".
R3_GET_JOBLOG NAME='SWWERRE',JOBCOUNT=23483501
The following lines are written to the report:
Date Time MsgId/Nr Message
11.12.2001
00:08:35 00 516 SJob started
11.12.2001
00:08:35 00 550 SStep 001 started (program RSWWERRE, variant, user name NI)
11.12.2001
00:08:35 WI 137 SS0 work items processed
11.12.2001
00:08:35 00 517 SJob finished
See also:
484 Chapter 4 UC4 JCL for Applications
R3_GET_JOBS
Selects SAP jobs and lists the result in the activation report or a file.
Transaction: SM37
Interface: UC4 and Standard
Syntax
R3_GET_JOBS
NAME=...
[,JOBCOUNT=...]
[,GROUP=...]
[,USER=...]
[,START_D[ATE]=...]
[,START_T[IME]=...]
[,END_D[ATE]=...]
[,END_TIME=...]
[,NO_DATE=...]
[,WITH_PRED=...]
[,EVENT_ID=...]
[,EVENT_PARM=...]
[,PRELIM=...]
[,SCHEDUL=...]
[,READY=...]
[,RUNNING=...]
[,FINISHED=...]
[,ABORTED=...]
[,NOFOUND=...]
[,FILE=...]
[,ENCODING=...]
Syntax
NAME=
Description/Format
Selection of one or more jobs by name.
Format:
or
Parameter
UC4 Name
In connection with JOBCOUNT (SAP job number), a unique SAP job can be clearly identified.
The wildcard character "*" can be used to select several jobs (e.g. 'xxx*').
Further selection criteria in the form of a keyword and an assignment.
Non-specified parameters use default values. Formats are valid for the keyword assignment.
JOBCOUNT=
GROUP=
USER=
START_D[ATE]=
START_T[IME]=
END_D[ATE]=
END_TIME=
NO_DATE=
WITH_PRED=
EVENT_ID=
EVENT_PARM=
PRELIM=
SCHEDUL=
Automation Engine 485
Number of the SAP job.
Format: script literal
In combination with the NAME (SAP job name), a unique SAP job can be clearly identified.
Selection of jobs by groups (such as "xxx*").
Format: script literal or UC4 name
Default value: "*"
Selection of jobs by users (such as "xxx*").
Format: script literal or UC4 name
Default value: "*"
Planned start date for the job's execution.
Format: script literal or UC4 name
Date format: YYYYMMDD
Default value: "20010101"
Planned start time for the job's execution.
Format: script literal or UC4 name
Time format: HHMMSS
Default value: "000000"
Planned end date for the job's execution
Format: script literal or UC4 name
Date format: YYYYMMDD
Default value: curent date
Planned end time for the job's execution
Format: script literal or UC4 name
Time format: HHMMSS
Default value: "235959"
Jobs without start date.
Format: script literal or UC4 name
Allowed values: "" (default value) and "X"
Jobs with start after predecessor.
Format: script literal or UC4 name
Allowed Values: "" (default value) and "X"
Jobs that are linked to an event: Name of the event.
Format: script literal or UC4 name
Jobs that are linked to an event: Parameter of the event.
Format: script literal or UC4 name
Jobs of status "Scheduled".
Format: script literal or UC4 name
Allowed Values: "" (default value) or "X"
Jobs of status "Released".
Format: script literal or UC4 Name
Allowed Values: "" (default value) or "X"
486 Chapter 4 UC4 JCL for Applications
READY=
RUNNING=
FINISHED=
ABORTED=
NOFOUND=
FILE=
ENCODING=
Jobs of status "Ready".
Format: script literal or UC4 name
Allowed values: "" (default value) or "X"
Jobs with status "Active".
Format: script literal or UC4 name
Allowed values: "" (default value) or "X"
Jobs of status "Finished".
Format: script literal or UC4 name
Allowed values: "" (default value) or "X"
Jobs of status "Terminated".
Format: script literal or UC4 name
Allowed values: "" (default value) or "X"
Handling if no Jobs are found by selection.
Format: script literal or UC4 Name
Allowed values: "NORMAL" (default value) and "ABEND"
"NORMAL" - Script execution continues, the UC4 Job ends normally.
"ABEND" - Script execution stops, the UC4 Job ends abnormally.
Name of the file in which the result (located SAP Jobs) should be saved.
Format: script literal
The result of the selection is not output to the activation report if this parameter is used.
Encoding for the generated output file (Parameter FILE=).
For example: UTF-8
Default value: ISO-8859-1
When you specify an encoding that is not supported or invalid, the Job will abort with an error message.
The SAP Forms provide an input assistant for this field which lists all the supported encodings.
Description
This script element can be used to select background jobs in SAP. The selection criteria are assigned as parameters. The parameters correspond to the fields of the SAP Dictionary Structure BAPIXMJSEL. Use the dictionary or BAPI Browser for detailed information about the individual fields.
The result of the selection is either written to the activation report or a file. There is a line for each located
SAP Job. The structure of lines between the activation report and the file are different.
The file uses columns. The first line of the file contains information about the column size and contents.
The individual lines correspond to these specifications. The first 33 characters contain the respective SAP job's name, the other 9 characters its number.
In the activation report, all information within a line is separated by a semicolon. Additionally, a time stamp and a UC4 message number is output to the beginning of the line.
Automation Engine 487
The result of the selection can be analyzed by using script functions. In the
Post Process
tab,
PROCESS_REPORT can be used to analyze the activation report.
can be used if the selection result has been saved in a file.
Note that by default, created files are saved on the computer on which the Agent is installed (such as
R3_GET_JOB_SPOOL; FILE=).
Examples
The first example selects all scheduled SAP Jobs that start with "REL".
R3_GET_JOBS NAME="REL*",PRELIM="X"
The result is written to the activation report and can look similar to the following lines:
20000922/134303.567 - U2004943 ;RELEASE;13450801
20000922/134303.567 - U2004943 ;RELEASE;13455501
20000922/134303.567 - U2004943 ;RELEASE;16221501
20000922/134303.567 - U2004943 ;RELEASE;16225101
20000922/134303.567 - U2004943 ;RELEASE;16234801
The second example selects all SAP Jobs of the name "EU_REORG" and the status "Finished". The selection result is saved in a file.
R3_GET_JOBS NAME='EU_REORG',FINISHED='X',FILE='jobs.txt'
The first lines of the file could look as shown below:
COL=LENGTH,LENGTH_TAB='33=JOBNAME,9=JOBCOUNT'
EU_REORG 01404301
EU_REORG 01405401
See also:
R3_GET_MONITOR
Reads data from an SAP monitor.
Transaction: RZ20
Interface: Standard
Syntax
R3_GET_MON[ITOR]
MONITOR_SET=...
,MONITOR=...
,FILE=...
[,ENCODING=...]
Syntax
MONITOR_SET=
Description/Format
Name of monitor set (maximum 60 characters).
Format: Name or
488 Chapter 4 UC4 JCL for Applications
MONITOR=
FILE=
ENCODING=
Name of monitor (maximum 60 characters).
Format: Name or script literal
Name of the file in which the result (current monitor data) should be stored.
Format: Name or script literal
Encoding for the generated output file (Parameter FILE=).
For example: UTF-8
Default value: ISO-8859-1
When you specify an encoding that is not supported or invalid, the Job will abort with an error message.
The SAP Forms provide an input assistant for this field which lists all the supported encodings.
Comments
This script element is used to read data from an SAP monitor and store it in a file.
The SAP Agent puts individual lines that are supplied by an SAP monitor into fixed columns. It stores column names and column size as the first line in the file and provides data for the current monitor. The following columns are available:
PATH - Path specification of a value,
NAME - Name of the value,
VALUE - Current value,
STATUS - Status: 1 = green, 2 = yellow, 3 = red,
DATE - Date of test,
TIME - Time of test,
MESSAGE - Message which is displayed with a protocol attribute.
Note that the time stamp is returned in UTC and can differ from your local time. Use the script element
in order to convert date and time to another TimeZone (see PROP_PROCESS).
You can also prepare and edit monitor data using script elements for the data sequences. R3_GET_
MONITOR is used in the Event job "EVENT.R3MONITOR" in client 0000. You can create a data sequence from an SAP monitor by using the script function
The data sequence is processed by the script statements
and
. In combination with the script function
GET_PROCESS_LINE , you can access each individual line of the
data sequence and its columns.
Note that by default, created files are saved on the computer on which the Agent is installed (for example, R3_GET_JOB_SPOOL; FILE=).
See also:
R3_GET_SESSIONS
Selects batch input sessions and lists the result in the activation report or a file.
Transaction: SM35
Automation Engine 489
Interface: UC4
Syntax
R3_GET_SESSIONS
NAME=...
CREDATE_FROM=...
CREDATE_TO=...
STATUS=...
[,FILE=...]
[,NOFOUND=...]
[,ORDER_BY=...]
[,ENCODING=...]
Syntax
NAME=
CREDATE_FROM=
CREDATE_TO=
STATUS=
FILE=
NOFOUND=
Description/Format
Selection of batch input sessions by name.
Format:
The wildcard characters "*" and "?" can be used. "*" stands for any character,
"?" for exactly one.
Selection of batch input sessions by their date of creation (Start date of the selection).
Format: Scrip literal
Date format: YYYYMMDD
Selection of batch input sessions by their date of creation (End date of the selection).
Format: script literal
Date format: YYYYMMDD
Selection of batch input sessions by their status.
Format: script literal
Allowed values: " " (default value), "R", "F" and "E"
" " - Batch input sessions that are still to be processed.
"R" - Batch input sessions that are currently being processed (Running).
"F" - Batch input sessions that have finished processing (Finished).
"E" - Batch input sessions that resulted in errors during processing (Error).
Name of a file to which the selection results (found batch input session) should be written.
Format: script literal
This parameter can be used to write the result to a specified file (not to the activation report). There is a line for each located batch input session. The first 13 positions contain the names of the sessions and the additional 21 positions the queue ID.
Handling if the batch input sessions have not been found.
Value format: script literal
Allowed values: "NORMAL" (default value) and "ABEND"
"NORMAL" - The script continues, the UC4 Job ends normally.
"ABEND" - The script is aborted, the UC4 Job ends abnormally.
490 Chapter 4 UC4 JCL for Applications
ORDER_BY=
ENCODING=
Criterion according to which selected sessions are sorted. All field names of the SAP table APQI can be used. For example: ORDER_BY=GROUPID
This parameter is available for SAP versions 4.6 and later.
Encoding for the generated output file (Parameter FILE=).
For example: UTF-8
Default value: ISO-8859-1
When you specify an encoding that is not supported or invalid, the Job will abort with an error message.
The SAP Forms provide an input assistant for this field which lists all the supported encodings.
Description
The result of the selection is either written to an activation report or to a file. There is a line for each located
SAP job. Structures of the lines in the activation report differ from those in the file.
Columns are used in the file. The first line of the file contains information about the size and content of the columns. The individual lines are divided according to these specifications. The first 13 positions contain the name of the respective batch input session, the next 21 contain the queue ID - and in the last 13, the creator of the batch input session (user) is output.
The parameter ORDER_BY can be used to sort the selected batch input sessions according to particular criteria.
In the activation report, the information within a line is separated with a semicolon. Additionally, a time stamp and UC4 message number are output at the beginning of the line.
The result of the selection can be analyzed using script functions. In the
Post Process
tab,
PROCESS_REPORT can be used to analyze the activation report.
can be used when the selection result was saved in a file.
With UC4 Version 2.63E, the creator of the batch input session is also output at the end of each line in the activation report or file. This can sometimes cause problems in existing UC4 scripts when the data sequence created with PREP_PROCESS_* is not divided into columns. This can be when the entire line is processed with string functions.
Note that by default, created files are stored on the computer on which the Agent has been installed (for example, R3_GET_JOB_SPOOL; FILE=).
Examples
The first example selects all batch input sessions that should be processed today and show the name
"NI".
: SET &TODAY# = SYS_DATE (YYYYMMDD)
R3_GET_SESSIONS NAME='NI',CREDATE_FROM='&TODAY#',CREDATE_
TO='&TODAY#',STATUS=" "
In the activation report, lines similar to those shown below are output:
20020313/135601.000 - U2004943 ;UC4_TEST;20020312NI;NI
Automation Engine 491
The second example selects all batch input sessions between 1/1/2000 and 1/1/2002 that resulted in errors while they have been processed. The result of the selection is saved in a file.
R3_GET_SESSIONS NAME='*',CREDATE_FROM='20000101',CREDATE_
TO='20020101',STATUS='E',FILE='sessions.txt'
The first lines in the file can look as follows:
COL=LENGTH,LENGTH_TAB='13=GROUPID,21=QID,13=CREATOR'
UC4_TEST
UC4_TEST
UC4_TEST
20020314095728031322 NI
20020314095823023148 NI
20020314100932031323 NI
See also:
R3_GET_SPOOLREQUESTS
Selects spool requests with predefined filters
Transaction: SP01
Interface: UC4
Syntax
R3_GET_SPOOLREQ[UESTS]
[WITHOUT=...]
[,PROCESSING=...]
[,SUCCESSFUL=...]
[,PROBLEM=...]
[,OWNER=...]
[,AUTHORITY=...]
[,NAME=...]
[,SUFFIX1=...]
[,SUFFIX2=...]
[,DESTINATION=...]
[,SPOOLNR_FROM=...]
[,SPOOLNR_TO=...]
[,CREDATE_FROM=...]
[,CREDATE_TO=...]
[,TITLE=...]
[,RECEIVER=...]
[,DEPARTMENT=...]
[,NOFOUND=...]
Syntax Description/Format
492 Chapter 4 UC4 JCL for Applications
WITHOUT=
PROCESSING=
SUCCESSFUL=
PROBLEM=
OWNER=
AUTHORITY=
NAME=
SUFFIX1=
SUFFIX2=
DEST[INATION]=
SPOOLNR_FROM=
SPOOLNR_TO=
CREDATE_FROM=
Selection with request status "without"
Format of the value:
Allowed values: "Y" (default value) and "N"
"Y" - Selection is made.
"N" - No selection is made after request status "without".
Selection after request status "In process"
Format of the value: script literal
Allowed values: "Y" (default value) and "N"
"Y" - Selection is made.
"N" - No selection is made after request status "In process".
Selection after request status "Successful"
Format of the value: script literal
Allowed values: "Y" (default value) and "N"
"Y" - Selection is made.
"N" - No selection is made after request status "Successful".
Selection after request status "Problem"
Format of the value: script literal
Allowed values: "Y" (default value) and "N"
"Y" - Selection is made.
"N" - No selection is made after request status "Problem".
Owner of the spool request
Format of the value: script literal
Spool authorization
Format of the value: script literal
Name of the spool request
Format of the value: script literal
Suffix 1 of the spool request
Format of the values: script literal
Suffix 2 of the spool request
Format of the value: script literal
Output device
Format of the value: script literal from spool number
Format of the value: script literal to spool number
Format of the value: script literal
Creation date of the spool request (from date)
Format of the value: script literal
Format: "YYYYMMDD"
Default value: "20010101"
CREDATE_TO=
TITLE=
RECEIVER=
DEPART[MENT]=
NOFOUND=
Automation Engine 493
Creation date of the spool request (until date)
Format of the value: script literal
Format: "YYYYMMDD"
Default value: current date
Title of the spool request
Format of the value: script literal
Recipient of the spool list
Format of the value: script literal
Recipient of the spool list (department)
Format of the value: script literal
Handling if no spool requests are found
Format of the value: script literal
Allowed values: "NORMAL" (default value) and "ABEND"
"NORMAL" - The UC4 job continues.
"ABEND" - The UC4 job ends abnormally.
Description
This function commences each report line with the character ";".
Example
R3_GET_SPOOLREQUESTS SPOOLNR_FROM='1234',SPOOLNR_
TO='1236',DESTINATION='PRNT',RECEIVER='SMITH'
See also:
R3_GET_SYSTEMLOG
Reads the system log of an SAP system during a specified time period.
Transaction: SM21
Interface: Standard
Syntax
R3_GET_SYSTEMLOG
FILE=...
[,SERVER=...]
[,FROM_DATE=...]
[,FROM_TIME=...]
[,TO_DATE=...]
[,TO_TIME=...]
[,ENCODING=...]
494 Chapter 4 UC4 JCL for Applications
Syntax
FILE=
SERVER=
FROM_DATE=
FROM_TIME=
TO_DATE=
TO_TIME=
ENCODING=
Description/Format
Name of a file to which the read SAP system log should be stored.
Format: Name or
Name of an SAP application server.
Format: Name or script literal
The name of an SAP application server must be specified in the form Host_
SID_SYSNR:
Host = Computer name
SID = System ID from SAP
SYSNR = Number of the SAP Instance
Start date of the selection from the system log.
Format: YYYYMMDD
Default value: "20010101"
Start time of the selection from the system log.
Format: HHMMSS
Default value: "000000"
End date of the selection from the system log.
Format: YYYYMMDD
Default value: current date
End time of the selection from the system log.
Format: HHMMSS
Default value: "235959"
Encoding for the generated output file (Parameter FILE=).
For example: UTF-8
Default value: ISO-8859-1
When you specify an encoding that is not supported or invalid, the Job will abort with an error message.
The SAP Forms provide an input assistant for this field which lists all the supported encodings.
Comments
This script element is used to read the system log of an SAP system as text and saving it to a file. If the name of an application server is specified, the script element supplies this server's system log. Without the name of an application server being entered, the central SAP system log is read.
You can also prepare and edit the system log using the script elements for the data sequences. R3_GET_
SYSTEMLOG is used in the Event job "EVENT.R3SYSLOG" in client 0000. The script function
can be used to create a data sequence with the system log's data.
The data sequence is processed with the script statements
and
individual line of the data sequence and its columns can be accessed with the script function
Note that by default, created files are saved on the computer on which the Agent has been installed
(for example, R3_GET_JOB_SPOOL; FILE=).
Automation Engine 495
Example
The following example reads the central SAP system log of the previous week. The start date for the system log selection is calculated using the script function SUB_DAYS. The current date is the basis of this calculation.
: RSET &TODAY# = SYS_DATE ( 'YYYYMMDD' )
: RSET &LAST_WEEK# = SUB_DAYS ( 'YYYYMMDD:&TODAY#' , 7)
R3_GET_SYSTEMLOG FILE = 'c:\t46_systemlog.txt', SERVER=, FROM_DATE='&LAST_
WEEK#'
See also:
R3_GET_VARIANTS
Lists all available variants in the activation log
Transaction: SA38
Interface: Standard
Syntax
R3_GET_VARIANT[S]
REPORT=...
[,ERROR=...]
[,SELECT_OPTION=...]
Syntax
REP[ORT]=
ERROR=
Description/Format
Name of the ABAP program
Format:
Procedure for further processing if no variants are found.
Format: script literal
Allowed values: "ABEND" (default value) and "IGNORE"
"ABEND" - Script execution stops, the UC4 Job ends abnormally.
"IGNORE" - Script execution continues, the UC4 Job ends normally.
SEL[ECT_OPTION]=
Variant types that should be selected
Format: script literal
Allowed values: "A" (default value) and "B"
"A" - Variants allowed for background processing and dialog operation.
"B" - Variants exclusively allowed for background processing.
Example
R3_GET_VARIANTS REP='RSPO0041'
496 Chapter 4 UC4 JCL for Applications
See also:
R3_GET_VARIANT_CONTENTS
Shows the content of a variant
Transaction: SA38
Interface: UC4 and Standard (XBP 2.0)
Syntax
R3_GET_VARIANT_C[ONTENTS]
REPORT=...
,VARIANT=...
[,SELNAME=...]
[,KIND=...]
[,LOW=...]
[,HIGH=...]
[,SIGN=...]
[,OPTION=...]
[,ERROR=...]
Syntax
REP[ORT]=
Description/Format
Name of the report
Value format:
or
VAR[IANT]=
Name of the variant
Value format: script literal or UC4 name
SELN[AME]=
Name of the parameter
Value format: script literal or UC4 name
KIND=
Type of selection
Format: script literal or UC4 name
LOW=
HIGH=
SIGN=
Possible values: "S" and "P" (default)
"S" - selection criterion
"P" - parameter
Parameter value (LOW)
Value format: script literal or UC4 name
Parameter value (HIGH)
Value format: script literal or UC4 name
Identifier (Include/Exclude)
Value format: script literal or UC4 name
Allowed values: "I" (Default) and "E"
"I" - Include
"E" - Exclude
OPTION=
ERROR=
Automation Engine 497
Option how it should be selected
Value format: script literal or UC4 name
"EQ" - equal (default)
"NE" - not equal
"GT" - greater than
"GE" - equal or greater than
"LT" - less than
"LE" - equal or less than
"CP" - pattern comparison (wild cards are allowed)
"NP" - exclude pattern
"BT" - within interval (specify HIGH too)
"NB" - outside interval (specify HIGH too)
Handling if variant or content are not available
Value format: script literal or UC4 Name
Allowed values: "ABEND" (default) and "IGNORE"
"ABEND" - script execution does not continue, the UC4 Job ends abnormally.
"IGNORE" - script execution continues, the UC4 Job ends normally.
Examples
The variant's entire content is output line by line. The job is not canceled if the variant is not available.
R3_GET_VARIANT_C REP='RSPO0041',VAR='STANDARD',ERROR='IGNORE'
All entries of the tables VARI_VALUES and VALUETAB with the column SELNAME containing the value
'MIN_ALT' are listed. The job is canceled if 'MIN_ALT' or the variant are not available.
R3_GET_VARIANT_C REP='RSPO0041',VAR='STANDARD',SELNAME='MIN_
ALT',ERROR='ABEND'
All entries of the tables VARI_VALUES and VALUETAB with columns containing SELNAME=MIN_ALT,
KIND=P and LOW=10 are output. The Job is canceled if there is no hit.
R3_GET_VARIANT_C REP='RSPO0041',VAR='STANDARD',SELNAME='MIN_
ALT',KIND='P',LOW='10',ERROR='ABEND'
See also:
R3_MODIFY_INTERCEPTION
Modifies the filter table for intercepted jobs.
Transaction: -
Interface: Standard (XBP 2.0
)
Syntax
R3_MODIFY_INTERC[EPTION]
498 Chapter 4 UC4 JCL for Applications
[,NAME=...]
[,USER=...]
[,MODE=...]
Syntax
NAME=
USER=
MODE=
Description/Format
Name of one or more SAP jobs (with the * wildcard character).
Value format:
Default value: "*"
Name of one or more SAP users (with the * wildcard character).
Value format: script literal
Default value: "*"
Processing mode for new table entry.
Value format: script literal
Allowed values: "REPLACE" (default value) and "APPEND"
"REPLACE" - New table entry replaces existing table entries
"APPEND" - New table entry is added to existing table entries
Comments
This Script element modifies the contents of the SAP system table in which the conditions for batch jobs have been defined. The SAP client specified in the Login object referred to by the UC4 job is used here.
If the Script element is used with MODE=REPLACE, all table entries of the SAP client are deleted and replaced by the new table entry. With MODE=APPEND, the new table entry is added to the existing table entries of the SAP client.
Note that this script element is only supported with XBP 2.0.
Example
In this example, all defined intercepted jobs are determined.
R3_GET_INTERCEPTION
The activation report contains the following lines.
20030325/153054.000 - U2004943 ;001;IC*;*
20030325/153054.000 - U2004943 ;001;UC4*;UC4.WG
Now, all table entries are replaced by a new entry and the defined intercepted jobs are queried again.
R3_MODIFY_INTERCEPTION NAME='UC4*',USER='UC4.WG'
R3_GET_INTERCEPTION
The activation report now contains only one line.
20030325/153054.000 - U2004943 ;001;UC4*;UC4.WG
See also:
Automation Engine 499
R3_MODIFY_JOB
Modifies an ABAP step
Transaction: SM36
Interface: Standard
Syntax
R3_MODIFY_JOB
NAME=...
,JOBCOUNT=...
,STEP=...
,REPORT=...
[,VAR[IANT]=...]
[,ARCHIVE_O[BJECT]= ...]
[,ARCHIVE_S[APOBJECT]=...]
[,ARCHIVE_I[NFO]=...]
[,DEST[INATION]=...]
[,IMM[EDIATELY]=...]
[,REL[EASE]=...]
[,COPIES=...]
[,ARCIVE_M[ODE]=...]
[,AUTHORITY=...]
[,SAP_COVER[_PAGE]=...]
[,COVER[PAGE]=...]
[,EXPIR[ATION]=...]
[,RECEIVER=...]
[,LINE_COUNT=...]
[,LINE_SIZE=...]
Syntax
NAME=
Description/Format
Name of the SAP job
Format:
or
JOBCOUNT=
STEP=
RE[PORT]=
UC4 Name
In connection with its job number, an individual SAP job can be clearly identified.
Number of the SAP job
Format: script literal
In connection with the name, an individual SAP job can be clearly identified.
Number of the ABAP Step to be modified
Format: Number without quotations
Name of the report
Format: script literal or UC4 name
500 Chapter 4 UC4 JCL for Applications
Parameter
VAR[IANT]=
ARCHIVE_O[BJECT]
=
ARCHIVE_S
[APOBJECT]=
ARCHIVE_I[NFO]=
DEST[INATION]=
IMM[EDIATELY]=
REL[EASE]=
COPIES=
ARCHIVE_M[ODE]=
Name of the variant
Format: script literal or UC4 name
Archive Parameter: Object
Format: script literal or UC4 name
Archive parameter: SAP Object
Format: script literal or UC4 name
Archive Parameter: Info
Format: script literal or UC4 name
Printer
Format: script literal or UC4 name
Print immediately
Format: script literal or UC4 name
Allowed values: "YES" and "NO" (default value)
Delete after printing
Format: script literal or UC4 name
Allowed values: "YES" and "NO" (default value)
Number of copies
Format: Number without quotations
Default value: "0"
Archive mode
Format: script literal or UC4 name
Allowed values: "1" (default value), "2" or "3"
AUTHORITY=
SAP_COVER[_PAGE]
=
"1" - Print only
"2" - Archive only
"3" - Print and Archive
Authority
Format: script literal or UC4 name
SAP title page
Format: script literal or UC4 name
COVER[PAGE]=
EXPIR[ATION]=
Allowed values: "" (default value), "X" and "D"
"" - No title page
"X" - Print title page
"D" - Title page depends on the printer's settings
Cover Page
Format: script literal or UC4 name
Allowed Values: "YES" and "NO" (default value)
"YES" - Print selections title page
"NO" - Do not print selections title page
Expiration
Format: Number without quotations
Default value: "0"
Automation Engine 501
RECEIVER=
LINE_COUNT=
LINE_SIZE=
Receiver
Format: script literal or UC4 name
Line counter
Format: Number without quotations
Default value: "0"
Line width
Format: Number without quotations
Default value: "0"
Description
This script element can be used to modify ABAP steps. When the SAP job has been selected, you can reset the name of the report, variant and various archiving and print parameters of the ABAP step.
The parameters correspond to the fields of the SAP Dictionary Structure PRI_PARAMS and ARC_
PARAMS. Please use the dictionary or the BAPI Browser to get detailed information about the individual fields.
Example
In the example show below, the SAP job with name "MYJOB" and the number "13541601" is modified. As
Step "2", "RSM04000" is specified as the executing ABAP program.
R3_MODIFY_JOB NAME="MYJOB",JOBCOUNT=13541601,STEP=2,REPORT=RSM04000
See also:
R3_MODIFY_VARIANT
Modifies variant entries.
Transaction: SA38
Interface: UC4 and Standard (XBP 2.0)
Syntax (Parameter)
R3_MODIFY_VARIANT
REPORT=...
,VARIANT=...
,SELNAME=...
,KIND=P
,LOW=...
[,VERIFY=...]
[,DELAY=...]
502 Chapter 4 UC4 JCL for Applications
Syntax
REP[ORT]=
VAR[IANT]=
SELN[AME]=
KIND=P
LOW=
VERIFY=
DELAY=
Description/Format
The name of the report.
Format: name or
The name of the variant.
Format: name or script literal
The name of the parameter.
Format: name or script literal
Parameter type = parameter.
Format: name or script literal
Parameter value.
Format: name or script literal
Verification of modifications that have been made in the variant.
Format: name or script literal
Allowed values: "YES" and "NO" (default value)
"YES" = The modified variant is verified.
"NO" = The modified variant is not verified.
The time span in seconds which the agent waits after a variant modification.
Format: number
Default value: "0"
Following this delay, the buffer synchronization between application servers should be complete if the SAP system runs with multiple application servers.
Syntax (Selection Options)
R3_MODIFY_VARIANT
REPORT=...
,VARIANT=...
,SELNAME=...
,KIND=S
,LOW=...
[,HIGH=...]
[,SIGN=...]
[,OPTION=...]
[,MODE=...]
[,VERIFY=...]
[,DELAY=...]
Syntax
REP[ORT]=
VAR[IANT]=
SELN[AME]=
Description/Format
The name of the report.
Format: name or
The name of the variant.
Format: name or script literal
The name of the selected option.
Format: name or script literal
KIND=S
LOW=
HIGH=
SIGN=
OPTION=
MODE=
VERIFY=
DELAY=
Automation Engine 503
Parameter type = selection option.
Format: name or script literal
Parameter value (LOW).
Format: name or script literal
Value of the parameters (HIGH).
Format: name or script literal
Only to be indicated with the OPTION=BT or NB (Interval).
Identifier (Include/Exclude).
Format: name or script literal
Allowed values: "I" (default value) and "E"
"I" - Include
"E" - Exclude
Selection options.
Format: name or script literal
"EQ" - Equal (default value)
"NE" - Not equal
"GT" - Greater than
"GE" - Equal or greater than
"LT" - Less than
"LE" - Equal or less than
"CP" - Pattern comparison (wildcards are allowed)
"NP" - Exclude pattern
"BT" - Within interval (specify HIGH too)
"NB" - Outside interval (specify HIGH too)
Adds or modifies a selection term.
Format: Name or script literal
Allowed values: "REPLACE" (default value) and APPEND
By doing so, you can create multiple selections.
Verification of modifications that have been made in the variant.
Format: Name or script literal
Allowed values: "YES" and "NO" (default value)
"YES" = The modified variant is verified.
"NO" = The modified variant is not verified.
The time span in seconds which the agent waits after variant modification.
Format: number
Default value: "0"
Following this delay, the buffer synchronization between application servers should be complete if the SAP system runs with multiple application servers.
Comments
Depending on the entry that has been made in the variant, there is a difference between
504 Chapter 4 UC4 JCL for Applications l l
Parameters: They are queried in the report by using PARAMETERS.
Selection options: They are queried in the report by using SELECT OPTIONS.
Note: l l l l l
Non-specified parameters are not changed.
If a selection option has been modified, its value range can only be changed with a new modification. It cannot be reset to its initial value.
Free variant delimitation (with logical databases) cannot be changed by using R3_MODIFY_
VARIANT.
The order that is kept within the variant does not necessarily reflect the specified order if several individual values are assigned for a selection option.
Variant modifications can cause errors in the SAP system (for example, with the logical database
PSJ) if the variant's ABAP program uses a logical database. The reason is that the selection screen of the logical database in the SAP system is dynamically modified. UC4 recommends copying an original variant and modifying the copy in such a case.
Parameter values and the selection options (including intervals from/to) in SAP Basis versions below
7.10 and / or XBP versions below 3.0 are limited to a maximum length of 45 characters. SAP Basis version 7.10 / XBP versions 3.0 and above allow up to 132 characters, which matches the limit of the
SAP GUI.
Examples (Parameters)
R3_MODIFY_VARIANT REPORT=RSUSR002,VAR=SAP_
STANDARD,SELN=TCODE,KIND=P,LOW='SE01'
Examples (Select Options)
Select all users whose names start with "B".
R3_MODIFY_VARIANT REP=RSUSR002,VAR=SAP_
STANDARD,SELN=USER,KIND=S,LOW='B*',SIGN=I,OPTION=CP
Select all users except for those whose names are between "USER100" and "USER199".
R3_MODIFY_VARIANT
...,SELN=USER,KIND=S,LOW='USER100',HIGH='USER199',SIGN=I,OPTION=NB
Select company code 10 and 71-77 - multiple selection.
R3_MODIFY_VARIANT
REP=RF...,VAR=v1,SELN=BUKRS,KIND=S,LOW='10',SIGN=I,OPTION=EQ,MODE=R
R3_MODIFY_VARIANT
REP=RF...,VAR=v1,SELN=BUKRS,KIND=S,LOW='71',HIGH='77',SIGN=I,OPTION=BT,MODE
=A
See also:
Sample Collection
Calling an MBean
Automation Engine 505
R3_RAISE_EVENT
Triggers an event which has been defined in SAP.
Transaction: SM64
Interface: UC4 and Standard (XBP 2.0)
Syntax
R3_RAISE_EVENT
ID=...
[,PARAM=...]
[,TARGET_SERVER=...]
Syntax Description/Format UC4
Interface required
ID= Name of the event
Format:
A string consisting of a maximum of 32 characters is allowed.
PARAM= Parameter for the event
Format: script literal
TARGET_
SERVER
=
A string consisting of a maximum of 64 characters is allowed.
Target system in which the event should be triggered.
Format: script literal
Default value: Field content of "Target system" in the "Host Attributes" tab.
Comments
This script element can be used to trigger an event which has been defined in SAP using the transaction
SM62. This could be a system event ( an event which has been predefined by SAP), or a user event. You can define a string of any content of your choice as the event parameter. The target system which has been defined in the Host Attributes tab will be used if no target system has been assigned to this script element in which the event should be triggered.
Example:
This example triggers the event "Test" and specifies the event parameter "Myparam".
R3_RAISE_EVENT ID="TEST",PARAM="Myparam"
See also:
506 Chapter 4 UC4 JCL for Applications
R3_SCHEDULE_JOB_CANCEL
Resets an already released SAP job to the status "Scheduled".
Transaction: SM37
Interface: UC4
Syntax
R3_SCHEDULE_JOB_CANCEL
NAME=...
,JOBCOUNT=...
Syntax
NAME=
Description/Format
Name of the SAP job.
Format:
or
JOBCOUNT=
Individual SAP jobs can be clearly identified using them in combination with
In connection with the NAME (SAP job name), you can clearly identify individual SAP jobs.
Description
You can retrieve SAP jobs with the status "Released" by using the script element R3_GET_JOBS
. The result is written to the activation report and can be analyzed and processed in the
Post Process
tab.
Example
The following example resets the SAP job "MYJOB" and the number "13541601".The status changes from
"Released" to "Scheduled".
R3_SCHEDULE_JOB_CANCEL NAME="MYJOB",JOBCOUNT=13541601
See also:
Automation Engine 507
R3_SEND_SPOOL_REQUEST
Sends an existing spool request.
Transaction: SP01
Interface: UC4
Syntax
R3_SEND_SPOOL_REQ[UEST]
[JOBNAME=...]
[,JOBCOUNT=...]
[,STEP=...]
[,SPOOLNR=...]
[,RECIPIENT=...]
[,ADDRESSTYPE=...]
[,EXPRESS=...]
[,COPY=...]
[,BLINDCOPY=...]
[,NOFORWARD=...]
[,LINE_FROM=...]
[,LINE_TO=...]
[,TITLE=...]
[,ERROR=...]
[,NOPRINT=...]
[,DELIVER=...]
[,STATUSBYMAIL=...]
Syntax
JOBNAME=
JOBCOUNT=
STEP=
SPOOLNR=
RECIPIENT=
Description/Format
Name of the background job.
Format of the value:
Number of the background job.
Format of the value: script literal
Step number.
Format of the value: number
Spool list number.
Format of the value: script literal
This parameter can be used as an alternative to JOBNAME=, JOBCOUNT= and STEP=.
Recipient.
Format of the value: script literal
508 Chapter 4 UC4 JCL for Applications
ADDRESSTYPE=
EXPRESS=
COPY=
BLINDCOPY=
NOFORWARD=
LINE_FROM=
LINE_TO=
Address type.
Format of the value: script literal
Allowed values:
"B" (default value) - SAP user
"C" - General distribution list
"D" - X.500 address
"F" - Fax number
"G" - Organization object/ID
"H" - Organization department/position
"J" - SAP object
"L" - Telex number
"O" - SAP office user
"P" - Personal distribution list
"R" - SAP user in a different SAP system
"U" - Internet address
"X" - X.400 address
Sends an express message.
Format of the value: script literal
Allowed values: "" (default value) and "X"
"" - No message is sent.
"X" - An express message is sent.
Sends a copy.
Format of the value: script literal
Allowed values: "" (default value) and "X"
"" - No message is sent.
"X" - A copy is sent.
Sends a blind copy.
Format of the value: script literal
Allowed values: "" (default value) and "X"
"" - No message is sent.
"X" - A blind copy is sent.
Forwarding is not allowed.
Format of the value: script literal
Allowed values: "" (default value) and "X"
"" - Forwarding is allowed.
"X" - Forwarding is not allowed.
From line.
Format of the value: Number
Default value: "0"
To line.
Format of the value: Number
Default value: "0"
TITLE=
ERROR=
NOPRINT=
DELIVER=
STATUSBYMAIL=
Automation Engine 509
Mail title (Subject).
Format of the value: script literal
Handling if an error occurs.
Format of the value: script literal
Allowed values: "IGNORE" and "ABEND" (default value)
"IGNORE" - The UC4 job continues.
"ABEND" - The UC4 job ends abnormally.
Printing is not allowed.
Format of the value: script literal
Allowed values: "Y" and "N" (default value)
"Y" - Printing is not allowed.
"N" - Printing is allowed.
Receipt.
Format of the value: script literal
Allowed values: "" (default value), "A", "E" and "N"
"" - As specified in the SAP system
"A" - Always.
"E" - Only in error case
"N" - Never
Receipt by e-mail.
Format of the value: script literal
Allowed values: "" (default value), "A", "E" and "N"
"" - As specified in the SAP system.
"A" - Always
"E" - Only in error case
"N" - Never
Comments
There are three ways of using this function. You can:
1. define the spool by using the parameters JOBNAME= and JOBCOUNT=. The parameter STEP= is optional, the default value is 1.
2. directly specify SPOOLNR=.
3. use none of the above parameters. In this case, the spool of the job that has last been executed via the UC4 Job is used. You can specify a step number.
The following SAP support packages are required in order to use the parameters NOPRINT=,
DELIVER= and STATUSBYMAIL=: l l l l
For 4.6C: SAPKB46C52
For 6.20: SAPKB62059
For 6.40: SAPKB64017
For 7.00: SAPKB70008
510 Chapter 4 UC4 JCL for Applications
Example
R3_SEND_SPOOL_REQUEST
JOBNAME='MYJOB',JOBCOUNT=123,RECIPIENT='Smith',ADDRESSTYPE='O'
See also:
R3_SET_BDCDATA
Defines BDC data
Transaction: -
Interface: UC4
Syntax
R3_SET_BDCDATA
PROGRAM=...
,DYNPRO=...
[,DYBEGIN=...]
Syntax
PROGRAM=
DYNPRO=
DYBEGIN=
Description/Format
Program name, maximum 40 characters
Format:
Four-digit screen number
Format: script literal
Indication that a new screen is starting
Format: script literal
Allowed values: "" (default value), "X"
"" = no new screen.
"X" = new screen.
R3_SET_BDCDATA
,FNAM=...
,FVAL=...
Syntax
FNAM=
FVAL=
Description/Format
Field name, maximum 132 characters
Format: script literal
Value to be assigned to the field, maximum 132 characters
Format: script literal
Automation Engine 511
Comments
This script element serves to define BDC data (Batch Data Communication). It can be used to assign values to screen fields in batch mode. The SAP Agent initially saves these assignments in an internal table.
initiates actual processing. The internal table is subsequently reset.
R3_SET_BDCDATA is initially called with the parameters PROGRAM=, DYNPRO= and DYBEGIN=.
The selected fields are then given values with the parameters FNAM= and FVAL=. The definition of BDC data can be repeated for the same or other screens as often as required.
The names of the screens and individual fields can be determined online in the SAP system. In addition, the transaction can be started over the System - Status menu. Technical information can be called with the
F1 help key. The transaction "SM35" chronicling routine provides the names of screens and fields.
Example
In the following example, screens for the entire transaction "SA38" are supplied with data. The screens are called in a pre-arranged order and the fields provided with values. Subsequently, the transaction "SA38" is started in order to execute a data update.
R3_SET_BDCDATA PROGRAM="SAPMS38M", DYNPRO="0101", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="=SSET"
R3_SET_BDCDATA FNAM="RS38M-PROGRAM", FVAL="RSEINB00"
R3_SET_BDCDATA PROGRAM="SAPLSVAR", DYNPRO="0302", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="=CHNG"
R3_SET_BDCDATA FNAM="RSVAR-VARIANT", FVAL="UM-V1"
R3_SET_BDCDATA FNAM="RSVAR-FLAG1", FVAL="X"
R3_SET_BDCDATA PROGRAM="RSEINB00", DYNPRO="1000", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="=SAVE"
R3_SET_BDCDATA FNAM="P_FILE", FVAL="test.txt"
R3_SET_BDCDATA PROGRAM="RSEINB00", DYNPRO="1000", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="=VBAC"
R3_SET_BDCDATA PROGRAM="SAPLSVAR", DYNPRO="0302", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="/EBACK"
R3_SET_BDCDATA PROGRAM="SAPMS38M", DYNPRO="0101", DYBEGIN="X"
R3_SET_BDCDATA FNAM="BDC_OKCODE", FVAL="=BACK"
R3_CALL_TRANSACTION CODE="SA38", UPDATE="S"
See also:
R3_SET_FREE_SELECTION
Defines a free delimitation
Transaction: SA38
Interface: Standard (XBP 3.0)
Syntax
R3_SET_FREE_SELECTION
,TABLENAME=...
,FIELDNAME=...
512 Chapter 4 UC4 JCL for Applications
,LOW=...
[,HIGH=...]
[,SIGN=...]
[,OPTION=...]
Syntax
TABLENAME=
FIELDNAME=
LOW=
HIGH=
SIGN=
OPTION=
Description/Format
Name of the table
Format:
Name of the field
Format: script literal
Parameter value (LOW)
Format: script literal
Parameter value (HIGH)
Format: script literal
Identifier (Include/Exclude)
Format: script literal
Allowed values: "I" (default) and "E"
"I" = Include
"E" = Exclude
Option used for selection
Format: script literal or UC4 name
"EQ" - equal (default)
"NE" - not equal
"GT" - greater than
"GE" - greater than or equal
"LT" - less than
"LE" - less than or equal
"CP" - pattern comparison (with wildcard characters)
"NP" - exclude pattern
"BT" - interval (specify HIGH too)
"NB" - outside interval (specify HIGH too)
Comments
This script element defines an individual free delimitation. Call it several times in succession to specify several free delimitations. These are collected and assigned to the next
call.
Note that using several R3_ACTIVATE_REPORT calls in the SAP job's script requires that the free delimitations are set individually for each call. Delimitations are not stored for subsequent function calls.
Example
R3_SET_FREE_SELECTION
TABLENAME='TAB01',FIELDNAME='FIELD01',LOW='17',SIGN='I'
R3_ACTIVATE_REPORT
REPORT='ZSUSER00',COVERPAGE=YES,DESTINATION=LT77,IMMEDIATELY=YES
Automation Engine 513
See also:
R3_SET_LOG_ATTR
Sets a log attribute in the SAP monitor architecture
Transaction: RZ20
Interface: XMW
Syntax
R3_SET_LOG_ATTR
NODE=...
,MESSAGE=...
[,VAR1=...]
[,VAR2=...]
[,VAR3=...]
[,VAR4=...]
[,COL_METHOD=...]
[,AN_METHOD=...]
[,AU_METHOD=...]
[,VIEW=...]
[,VIEW_FRAME=...]
[,COLOR=...]
[,SEVERITY=...]
[,MAX_ALERTS=...]
Syntax
NODE=
MESSAGE=
VAR1=
VAR2=
VAR3=
VAR4=
Description/Format
Name of the node
Format of the value:
ID and number of the SAP T100 message (separated by a blank)
Format of the value: script literal
Use "00 398" to have only variable contents displayed
Message variable 1
Format of the value: script literal
Message variable 2
Format of the value: script literal
Message variable 3
Format of the value: script literal
Message variable 4
Format of the value: script literal
514 Chapter 4 UC4 JCL for Applications
COL_
METHOD=
AN_
METHOD=
AU_
METHOD=
VIEW=
VIEW_
FRAME=
COLOR=
SEVERITY=
MAX_
ALERTS=
Data collection method of the node
Format of the value: script literal
Analysis method of the node
Format of the value: script literal
Auto-reaction method of the node
Format of the value: script literal
Determines the log attribute message to be displayed in the current alarm monitor status view.
Format of the value: script literal
Allowed values: "HIGHALERT", "LAST" (default) and "WORST_SINCE"
"HIGHALERT" - highest
"LAST" - latest
"WORST_SINCE" - most severe since
Duration in minutes for displaying the most severe alarm
Format of the value: number
Default value: "0"
Value "0" has the effect that the default value "30" is used in the monitor architecture.
Color
Format of the value: script literal
Allowed values: "AL_VAL_GREEN" (default), "AL_VAL_YELLOW" and "AL_VAL_
RED"
"AL_VAL_GREEN" - green
"AL_VAL_YELLOW" - yellow
"AL_VAL_RED" - red
Degree of severity
Format of the value: number
Default value: "0"
Value "0" has the effect that the default value "255" is used in the monitor architecture
Maximum number of alarms to be stored in the node
Format of the value: number
Default value: "0"
This limit is only applicable if the alarms are stored in the monitor architecture.
Comments
An existing log attribute is changed. If it does not yet exist, the script element creates one including the corresponding message.
Format of the parameter NODE=
Automation Engine 515
This parameter describes a complete path. The individual parts are separated by a slash "/".
The path always starts with a context node which can be followed by a sum node, an object node and an attribute node.
Context, object and attribute nodes must only be used once in the path. Sum nodes can be used several times.
Example 1:
"UC4/TestNode/PerfAttributUC4" l l l
"UC4" - context name
"TestNode" - object node
"PerfAttributUC4" - attribute node
Example 2:
"UC4/Summary1/Summary2/TestNode/PerfAttributUC4" l l l l l
"UC4" - context name
"Summary1" - sum node
"Summary2" - sum node
"TestNode" - object node
"PerfAttributUC4" - attribute node
Example
Executing the following example creates the context node "UC4", the object node "Test" and a log attribute including the message "00 398".
R3_SET_LOG_ATTR NODE="UC4/Test/LogAttribute",MESSAGE="00
398",VAR1="variable1",VAR2="variable2",VAR3="variable3",VAR4="variable4",SE
VERITY="12"
See also:
R3_SET_PERF_ATTR
Sets a performance attribute in the SAP monitor architecture
Transaction: RZ20
Interface: XMW
Syntax
R3_SET_PERF_ATTR
NODE=...
,VALUE=...
[,UNIT=...]
[,COL_METHOD=...]
[,AN_METHOD=...]
516 Chapter 4 UC4 JCL for Applications
[,AU_METHOD=...]
[,ALERT_DIR=...]
[,G2Y=...]
[,Y2R=...]
[,Y2G=...]
[,R2Y=...]
Syntax
NODE=
Description/Format
Name of the node
Format of the value:
VALUE=
UNIT=
Value to be set
Format of the value: number
Unit of the value (short form)
Format of the value: script literal
COL_METHOD=
Data collection method of the node
AN_METHOD=
AU_METHOD=
ALERT_DIR=
Format of the value: script literal
Analysis method of the node
Format of the value: script literal
Auto-reaction method of the node
Format of the value: script literal
Determines that an alarm is generated if the value is above or below the limit.
Allowed values: "ABOVE" (default) and "BELOW"
G2Y=
Y2R=
Y2G=
R2Y=
"ABOVE" - Alarm for a value above the limit
"BELOW" - Alarm for a value below the limit
Limit for a color change from green to yellow
Format of the value: number
Default value: "0"
Limit for a color change from yellow to red
Format of the value: number
Default value: "0"
Limit for a color change from yellow to green
Format of the value: number
Default value: "0"
Limit for a color change from red to yellow
Format of the value: number
Default value: "0"
Comments
An existing performance attribute is changed. If it does not yet exist, the script element creates it with the corresponding value.
Format of the parameter NODE=
This parameter describes a complete path. The individual parts are separated by a slash "/".
Automation Engine 517
The path always starts with a context node which can be followed by a sum node, an object node and an attribute node.
Context, object and attribute nodes must only be used once in the path. Sum nodes can be used several times.
Example 1:
"UC4/TestNode/PerfAttributUC4" l l l
"UC4" - context name
"TestNode" - object node
"PerfAttributUC4" - attribute node
Example 2:
"UC4/Summary1/Summary2/TestNode/PerfAttributUC4" l l l l l
"UC4" - context name
"Summary1" - sum node
"Summary2" - sum node
"TestNode" - object node
"PerfAttributUC4" - attribute node
Example
Executing the following example creates the context node "UC4", the object node "Test" and the performance attribute including the value "150". The color green is assigned because the limit specified in
G2Y has not been exceeded.
R3_SET_PERF_ATTR
NODE="UC4/Test/PerfAttribute",VALUE="150",UNIT="sec",G2Y="160",Y2R="200",Y2
G="160",R2Y="190"
See also:
R3_SET_PRINT_DEFAULTS
Sets default values for the print parameters that are used in order to execute reports.
Transaction: -
Interface: UC4 and Standard
Syntax
R3_SET_PRINT_DEF[AULTS]
[DESTINATION=...]
[,COVERPAGE=...]
[,IMMEDIATELY=...]
[,RELEASE=...]
[,COPIES=...]
[,LIST_NAME=...]
518 Chapter 4 UC4 JCL for Applications
[,LIST_TEXT=...]
[,NEW_LIST_ID=...]
[,EXPIRATION=...]
[,LINE_COUNT=...]
[,LINE_SIZE=...]
[,LAYOUT=...]
[,SAP_COVER_PAGE=...]
[,RECEIVER=...]
[,DEPARTMENT=...]
[,AUTHORITY=...]
[,DATA_SET=...]
[,TYPE=...]
[,OS_COVER_PAGE=...]
[,SPOOL_PRIORITY=...]
[,TEXTONLY=...]
[,FRAMES=...]
[,ARCHIVE_MODE=...]
[,ARCHIVE_SAPOBJECT=...]
[,ARCHIVE_OBJECT=...]
[,ARCHIVE_INFO=...]
[,ARCHIVE_TEXT=...]
[,MONITOR=...]
Syntax
DEST[INATION]=
Description/Format
Output device.
Format:
This parameter specifies the name of the output device. In most cases, this is a printer name but it can also be the name of a fax machine or the like.
Note that the long forms of SAP printer names cannot be used for technical reasons on the part of SAP's XBP interface. Use the 4-digit technical name instead.
Print Parameters
COVER[PAGE]=
IMM[EDIATELY]=
Selection of cover page.
Format: script literal
Allowed values: "YES" and "NO" (default value)
This parameter determines if a cover page with report selections is printed at the beginning. When a cover page is created, it is adopted to the job report.
Doing so documents the parameters that have been used for this execution.
Print immediately.
Format: script literal
Allowed values: "YES" and "NO" (default value)
REL[EASE]=
COPIES=
LIST_N[AME]=
LIST_T[EXT]=
NEW_LIST_ID=
EXPIR[ATION]=
LINE_COUNT=
LINE_SIZE=
Automation Engine 519
Delete after printing.
Format: script literal
Allowed values: "YES" and "NO" (default value)
This parameter specifies whether the spool request is deleted immediately after the printing process at the output device or only if the spool retention period has expired.
Number of copies.
Format: Integer
Default value: "0"
You can specify the number of document copies that should be printed.
Name of spool request.
Format: script literal
This parameter specifies the name of the spool request. It can consist of any letters, numbers, special characters and blanks. The suggested standard name for a spool request consists of the 8 letters of the report name, the separator '_' and the first 3 letters of the user name.
Text for the cover page.
Format: script literal
This parameter specifies the descriptive text for the spool request. It can consist of any letters, numbers, special characters and blanks.
New spool request.
Format: script literal
Allowed Values: "YES" (default value) and "NO"
Spool retention period.
Format: Integer
Default value: "0"
This parameter specifies the number of days that a spool request is kept in the spool system before it is deleted.
Page length of list
Format: Integer
Default value: "0"
Number of lines per list page. If this field contains a zero or is empty, there is no limit in the number of pages of the particular list (not allowed for printing).
The page length of the list is then only determined by its content. For printing, the maximum number of lines per page depends on the selected format.
Choose another format to have the number of lines changed.
Width of list.
Format: Integer
Default value: "0"
This parameter contains the current line width of the list. For printing, the maximum line width depends on the selected format. Select another format to change the line width.
520 Chapter 4 UC4 JCL for Applications
LAYOUT=
Print formatting.
Format: script literal
SAP_COVER[_PAGE]
=
This parameter defines the print format of the spool request. The format mainly defines the page format, i.e. the maximum number of lines and columns on one printed page.
SAP cover page.
Format: script literal
Allowed values: "" (default value), "X" and "D"
RECEIVER=
DEPART[MENT]=
AUTHORITY=
"" - No cover page is printed.
"X" - A cover page is printed.
"D" - It depends on the setting of the particular output device (printer) whether a cover page is printed.
This parameter determines if a cover page that states the receiver name, department name, format used and the like is printed together with the spool request.
Recipient.
Format: script literal
This parameter contains the receiver name of the spool request. This name is printed on the cover page. The current user name is the standard for the receiver name.
Department on cover page.
Format: script literal
This parameter contains the department name for the spool request. This name is printed on the cover page.
Authorization
Format: script literal
DATA_SET=
TYPE=
This parameter contains authorization for the spool request (maximum of 12 characters). Only authorized users can have content of the spool request displayed.
Name of spool dataset.
Format: script literal
Type of spool request.
Format: script literal
OS_COVER[_PAGE]=
Host spool cover page.
Format: script literal
Allowed values: "" (default value), "X" and "D"
"" - No cover page is printed.
"X" - A cover page is printed.
"D" - It depends on the setting of the particular output device (printer) whether a cover page is printed.
SPOOL_PRI[ORITY]=
Spool request priority.
Format: Integer
Default value: "5"
Automation Engine 521
TEXTO[NLY]=
FRAMES=
Archive Parameters
ARCHIVE_M[ODE]=
ARCHIVE_S
[APOBJECT]=
ARCHIVE_O[BJECT]
=
ARCHIVE_I[NFO]=
ARCHIVE_T[EXT]=
Plain text.
Format: script literal
Allowed values: "YES" and "NO" (default value)
Controls the output of non-ASCII characters of a print list.
Requirements for using this parameter (see also SAP note 777337): l l
SAP Basis Release 6.20 with support package SAPKB62045
SAP Basis Release 6.40 with support package SAPKB64010
This parameter requires the UC4 interface.
Frame characters.
Format: script literal
Allowed values: "YES" (default value) and "NO"
Handles default framing. The same requirements apply as for the parameter
TEXTONLY=.
This parameter requires the UC4 interface.
Archive Parameters with R3_ACTIVATE_REPORT
Archiving mode.
Format: script literal
Allowed values: "1" (default value), "2" and "3"
"1" - This document should only be printed.
"2" - This document should only be saved in the optical archive.
"3" - This document should be printed and saved in the optical archive.
Object type of business object.
Format: script literal
SAP objects are classified with object types.
Document type-
Format: script literal
Archive objects are classified according to document types.
Info field-
Format: script literal
Information code for the archiving request.
Text information field.
Format: script literal
Descriptive text for the archiving request. It can consist of any letters, numbers, special characters and blanks.
Control Parameters
MON[ITOR]=
Log status monitoring in the activation log.
Format: script literal
Allowed Values: "YES" and "NO" (default value)
522 Chapter 4 UC4 JCL for Applications
Comments
This script element can be used to assign default values to print parameters. They apply for the whole script or until a new default value is assigned in the script. These values only apply to the job for which they have been set.
Specifying default values increases the clarity of the UC4 script. Problems with the limitation to 1024 characters per script line are avoided because the actual processing instruction is only made in the SAP
Agent.
This script element can exclusively be used for
in order to assign default values to the print parameters.
Example
In the following example, default values are set for the output device and the number of outputs that should be made. During report execution, the number of outputs is changed to "6". This modification only applies for this particular report. The default value ("8") remains unchanged.
R3_SET_PRINT_DEFAULTS DESTINATION=PR01
R3_SET_PRINT_DEFAULTS COPIES=8
R3_ACTIVATE_REPORT REPORT=RSM04000,COPIES=6
See also:
R3_SET_SELECT_OPTION
Defines a selection criterion
Transaction: SA38
Interface: Standard (XBP 3.0)
Syntax
R3_SET_SELECT_OPTION
,SELNAME=...
,KIND=...
,LOW=...
[,HIGH=...]
[,SIGN=...]
[,OPTION=...]
Syntax
SELNAME=
Description/Format
Name of the select option or the parameter
Format:
Automation Engine 523
KIND=
LOW=
HIGH=
SIGN=
OPTION=
Type of selection
Format: script literal
Possible values: "S" and "P"
"S" - selection criterion
"P" - parameter
Parameter value (LOW)
Format: script literal
Parameter value (HIGH)
Format: script literal
Identifier (Include/Exclude)
Format: script literal
Allowed values: "I" (default) and "E"
"I" = Include
"E" = Exclude
Option used for selection
Format: script literal or UC4 name
"EQ" - equal (default)
"NE" - not equal
"GT" - greater than
"GE" - greater than or equal
"LT" - less than
"LE" - less than or equal
"CP" - pattern comparison (with wildcard characters)
"NP" - exclude patterns
"BT" - interval (specify HIGH too)
"NB" - outside interval (specify HIGH too)
Comments
This script element defines an individual selection criterion. Call it several times in succession to determine several selection criteria. These are collected and assigned to the next
or
call.
Note that using several R3_ACTIVATE_REPORT or R3_CREATE_VARIANT calls in the SAP job's script requires that the selection criteria are set individually for each call. They are not stored for subsequent function calls.
Example
The example shown below defines the value "17" for the parameter "MIN_AGE". The selection criterion is then used for the creation of a variant.
R3_SET_SELECT_OPTION SELNAME='MIN_AGE',KIND='P',LOW='17',SIGN='I'
R3_CREATE_VARIANT REP=REPORT01,VAR=NEW,TEXT='New variant'
See also:
524 Chapter 4 UC4 JCL for Applications
R3_SET_STATUS_ATTR
Sets a status attribute in the SAP monitor architecture
Transaction: RZ20
Interface: XMW
Syntax
R3_SET_STATUS_ATTR
NODE=...
,MESSAGE=...
[,VAR1=...]
[,VAR2=...]
[,VAR3=...]
[,VAR4=...]
[,COL_METHOD=...]
[,AN_METHOD=...]
[,AU_METHOD=...]
[,CAUSE_ALERT=...]
[,COLOR=...]
Syntax
NODE=
MESSAGE=
Description/Format
Name of the node
Format of the value:
ID and number of the SAP T100 message (separated by a blank)
Format of the value: script literal
Use "00 398" to have only variable contents displayed.
VAR1=
VAR2=
VAR3=
VAR4=
Message variable 1
Format of the value: script literal
Message variable 2
Format of the value: script literal
Message variable 3
Format of the value: script literal
Message variable 4
Format of the value: script literal
COL_METHOD=
Data collection method of the node
Format of the value: script literal
AN_METHOD=
Analysis method of the node
Format of the value: script literal
AU_METHOD=
Auto-reaction method of the node
Format of the value: script literal
CAUSE_
ALERT=
COLOR=
Automation Engine 525
Determines when an alarm should be triggered
Format of the value: script literal
Allowed values: "ALWAYS" (default), "VALUE_CHG", "MSG_CHG" and "NEVER"
"ALWAYS" - always
"VALUE_CHG" - if the value is changed
"MSG_CHG" - if the message is changed
"NEVER" - never
Color
Format of the value: script literal
Allowed values: "AL_VAL_GREEN" (default), "AL_VAL_YELLOW" and "AL_VAL_
RED"
"AL_VAL_GREEN" - green
"AL_VAL_YELLOW" - yellow
"AL_VAL_RED" - red
Comments
An existing status attribute is changed. If it does not yet exist, the script element creates one with the corresponding message.
Format of the parameter NODE=
This parameter describes a complete path. The individual parts are separated by a slash "/".
The path always starts with a context node which can be followed by a sum node, an object node and an attribute node.
Context, object and attribute nodes must only be used once in the path. Sum nodes can be used several times.
Example 1:
"UC4/TestNode/PerfAttributUC4" l l l
"UC4" - context name
"TestNode" - object node
"PerfAttributUC4" - attribute node
Example 2:
"UC4/Summary1/Summary2/TestNode/PerfAttributUC4" l l l l l
"UC4" - context name
"Summary1" - sum node
"Summary2" - sum node
"TestNode" - object node
"PerfAttributUC4" - attribute node
Example
Executing the following example creates the context node "UC4", the object node "Test" and the status attribute including the message "SY 019".
R3_SET_STATUS_ATTR NODE="UC4/Test/StatusAttribute",MESSAGE="SY 019"
526 Chapter 4 UC4 JCL for Applications
See also:
R3_SET_TEXT_ATTR
Sets a text attribute in the SAP monitor architecture
Transaction: RZ20
Interface: XMW
Syntax
R3_SET_TEXT_ATTR
NODE=...
,TEXT=...
Syntax
NODE=
TEXT=
Description/Format
Name of the node
Format of the value:
Text to be displayed
Format of the value: script literal
Comments
An existing text attribute is changed. If it does not yet exist, the script element creates one including the corresponding text.
Format of the parameter NODE=
This parameter describes a complete path. The individual parts are separated by a slash "/".
The path always starts with a context node which can be followed by a sum node, an object node and an attribute node.
Context, object and attribute nodes must only be used once in the path. Sum nodes can be used several times.
Example 1:
"UC4/TestNode/PerfAttributUC4" l l l
"UC4" - context name
"TestNode" - object node
"PerfAttributUC4" - attribute node
Example 2:
"UC4/Summary1/Summary2/TestNode/PerfAttributUC4"
Automation Engine 527 l l l l l
"UC4" - context name
"Summary1" - sum node
"Summary2" - sum node
"TestNode" - object node
"PerfAttributUC4" - attribute node
Example
Executing the following example creates the context node "UC4", the object node "Test" and the attribute node "TextAttribute" including the content "Value".
R3_SET_TEXT_ATTR NODE='UC4/Test/TextAttribute',TEXT='Value'
See also:
R3_SWITCH_OPMODE
Switches the operation mode in SAP
Transaction: RZ03
Interface: UC4
Syntax
R3_SWITCH_OPMODE
NAME=...
,SERVER=...
Syntax
NAME=
SERVER=
Description/Format
Name of an SAP-defined operation mode
Format:
Lower-case letters are not converted to upper-case letters.
Name of an SAP application server or "*" for all SAP application servers
Format: script literal
The name of a single SAP application server must be specified in the form
Host_SID_SYSNR:
Host - Computer name
SID - SAP system ID
SYSNR - SAP Instance number
Examples
The operation mode "Night Mode" is activated for all SAP application servers.
R3_SWITCH_OPMODE NAME='Night Mode',SERVER='*'
528 Chapter 4 UC4 JCL for Applications
See also:
4.4.2 SAP BCA
BCA_ACTIVATE_PROCESS
Starts and monitors a process running in a separate process network.
Transaction: -
SAP Banking Release: 4.63+
Syntax
BCA_ACTIVATE_PROC[ESS]
ID=...
,REPORT=...
[,VARIANT=...]
[,JOBPREFIX=...]
[,MAX_APPL_RC=...]
[,JOBLOG=...]
[,NETWORK_ID=...]
Syntax
ID=
REP[ORT]=
VAR[IANT]=
JOBPRE[FIX]=
MAX_APPL_RC=
Description/Format
External process identification
Format:
Name of ABAP program to be executed
Format: script literal
Name of an ABAP program variant
Format: script literal
Default value: ""
Prefix for process job names, maximum 18 characters
Format: script literal
Default value: ""
The names of jobs belonging to a process are generated from the specified prefix, the 10-digit RunID of the UC4 Job and a specific 3-digit number.
Highest application return code for a process to end normally
Format: number
Default value: "0"
A process is considered to have ended normally up to the specified application return code. A higher application return code causes the UC4 Job to be aborted.
JOBL[OG]=
NETWORK_ID=
Job logs are written to the UC4 report
Format: script literal
Allowed values: "YES" or "NO" (default value)
"NO" = Job logs are not written to the UC4 report
"YES" = Job logs are written to the UC4 report
Process network name in which a process is running
Format: script literal
Default value: ""
Automation Engine 529
Comments
This script element can be used to start and monitor processes. A particular process is encapsulated in a separate process network so that only this single process runs in this process network. This includes that the end of this process also ends the process network.
The priority of a process depends on the value specified in the Job class which can be selected in the
SAP
tab of the Job. Job class "C" is used by default.
This script element requires the parameters ID= and REPORT=.
All other parameters are optional. If the ABAP to be executed has no variant, you can either leave the parameter VARIANT= empty or omit it. If no prefix is specified for the job name, UC4 automatically generates job names in accordance with the template UC_JOB_<RunID(10)>_<unique_id(3)>. These unique job names facilitate access to job logs when the process has ended. If required, the logs can be written to the Job report in order to be analyzed in detail. The process network name is also automatically generated by UC4 if the parameter NETWORK_ID= remains unused. It is structured in accordance with the template UC_NET_<RunID(10)>.
Script processing is continued when the process has ended normally. Process abortion results in the immediate abortion of the UC4 Job.
Process and process network messages can be read from the application log using the script elements
R3_GET_APPLICATIONLOG . Messages are by default written to the UC4 report. As an alternative, they
can also be written to a specified file.
4.4.3 SAP BW
About SAP BW JCL
Script Elements
Note: The script element SET_INFOPACKAGE_SELECTION has been renamed in Version 3.0 to BW_
SET_INFOPACKAGE_SELECTION. Note that you can still use the old name.
Script Element
Description
Starts a process chain, monitors processing and saves the logs in the activation report.
Schedules one or more InfoPackages for immediate start.
530 Chapter 4 UC4 JCL for Applications
Reads process chains from the BW system. Available process chains are saved in the activation report or in a file.
Reads InfoPackages from the BW system. The available InfoPackages are saved in the activation report or in a file.
Continues an interrupted process chain.
Sets the criterion for the automatic restart of a process chain's child processes.
Sets selection parameters that should be used for reading the InfoPackages from the BW system.
See also:
About UC4 JCL for Applications
BW_ACTIVATE_CHAIN
Starts a process chain, monitors processing and stores the logs in the activation report.
Transaction: RSA1
SAP BW Version: 3.0B and later with Patch SAPKW30B11
Syntax
BW_ACTIVATE_CHAIN
ID=...
[,NOFOUND=...]
[,ERROR=...]
[,PROCESSLOGS=...]
[,RESTART=...]
[,JOBLOGS=...]
[,LONGTEXT=...]
[,REPLICATE=...]
[,STATUSRETRY=...]
[,SCHEDULE=...]
[,SYNCHRONOUS=...]
[,GET_SPOOL=...]
[,COLLECTLOGS=...]
Syntax
ID=
Description / Format
Technical designation of the process chain.
Value format:
Automation Engine 531
NOFOUND=
ERROR=
LONGTEXT=
Handling if a process chain cannot be found.
Value format: script literal
Allowed values: NORMAL or ABEND
Default: NORMAL
NORMAL = Script continues, UC4 job ends normally.
ABEND = Script aborts, UC4 job ends abnormally.
Handling if a process chain ends abnormally
Format: script literal
Allowed values: ABEND, IGNORE or SUSPEND
Default: ABEND
ABEND = The script aborts, the UC4 job ends abnormally.
IGNORE = The script continues, the UC4 job ends normally.
SUSPEND = The Job remains active until a restart of the process chain / its child processes has been successful or the Job has been canceled manually.
You can use this parameter in order to restart process chains or their child processes. The advantage is that the Job does not end which would include that processing continues in a parent (such as a Workflow).
PROCESSLOGS=
Output of a process chain's individual process logs.
Format: script literal
RESTART=
JOBLOGS=
Allowed values: YES, NO or ERROR
Default: YES
YES = Individual process logs are added to the process chain log
NO = Only the process chain log is output
ERROR = Individual process logs are output only in case of error.
Number of attempts for continuation of an interrupted process chain
Format: Integer
Default value: 0
Output of the process background job log
Format: script literal
Allowed values: YES, NO or ERROR
Default: YES
YES = Process background job logs are output
NO = Process background job logs are not output
ERROR = Process background job logs are only output if an error occurs.
Output of a log message's long text (diagnostics text).
Format: script literal
Allowed values: YES, NO or ERROR
Default: ERROR
ERROR = The log message long text is only output if an error occurs.
YES = The log message's long text is output.
NO = The log message's long text is not output.
532 Chapter 4 UC4 JCL for Applications
REPLICATE=
Handling of the children of a process chain
Format of the value: script literal
Allowed values: ALL, YES or NO (Default value)
ALL = Replicates all a Job's child processes in the UC4 system (including skipped ones). They are shown in the UserInterface's Activity Window.
Statistical records and reports are also generated in the UC4 system.
YES = The children of a job are replicated in the UC4 system. They are displayed in the Activity Window of the UserInterface. Statistical records and reports are also generated in the UC4 system.
NO = There is no replication in the UC4 system.
STATUSRETRY=
Number or repeated status checks
Format of the value: number
Default value: 0
SCHEDULE=
Due to a special SAP behavior, process chains can show the status "ended" for a short time but continue afterwards. The Agent reports this process chain as ended if it has retrieved its status exactly at this point in time. Use the parameter
STATUSRETRY= to prevent that the end of a process chain is reported too early.
You can determine the number of repeated status checks with this parameter.
Only after n repetitions, the UC4 Automation Engine will be informed that the process has ended.
New scheduling of process chains
Format of the value: script literal
Allowed values: YES (default) or NO
YES = The process chain is newly scheduled.
NO = There is no new scheduling. Doing so accelerates the process chain's start.
SYNCHRONOUS= Executes process chains synchronously.
Format of the value: script literal
Allowed values: YES or NO (default)
GET_SPOOL=
YES = Synchronous execution. Therefore, the process chain is processed in dialog mode instead of background mode and the individual child processes are completed serially.
NO = No synchronous execution is used.
Requests the spool list of the started Job.
Format of the value: script literal
Allowed values: YES or NO (default)
YES = The spool list is requested. It is stored as a text file in the directory that has been defined in the SAP Agent's INI file with the parameter Download_dir=
(Sektion [GLOBAL]). The name of this file is structured as follows:
<SAP Job count>_<step number>_<spool number>.txt
This file is also registered as Job output in the UC4 Job.
NO = The spool list is not requested.
Spool entries of children are only requested when the parameter REPLICATE= is either set to YES or to ALL.
Automation Engine 533
COLLECTLOGS=
Writes the reports of the activated process chain's child processes to the Job report.
The reports of replicated child processes are by default available in the Job report
AND the task of the child process. Therefore, this information is redundant in the
Job and you can decide not to assume this information here.
Allowed values: YES (default) or NO
YES - Logs of child processes are written to the Job report.
NO - Logs of the process chain's child processes are not assumed to the Job report.
Note that the reports of the child processes are not available if you specify NO in the parameters REPLICATE and COLLECTLOGS.
Description
This script element starts a process chain. First, determine the start conditions. If the process chain does not start immediately but only following an event or at a certain time, these start conditions are logged.
When the process chain starts, it is monitored until it ends. The process chain log is always stored in the activation report. Individual process logs or process background job logs are also output depending on the parameters PROCESSLOGS= and JOBLOGS=.
The parameter RESTART= can be used to trigger repeated attempts for the process chain to continue if it has been interrupted.
Examples
This example activates a process chain which has previously been queried by a user. The values for the relevant script element's parameters also result from this query. These values are assigned to the script element as script variables.
:
:
: BEGINREAD
: READ &CHAIN# , "ZTEST,ZSBB1,ZSBB2" , 'Process chain' , 'ZTEST' ,M
READ
READ
&ERROR# , "IGNORE,ABEND"
&NOFOUND# ,
, 'ERROR='
"NORMAL,ABEND" ,
, 'ABEND'
'NOFOUND=' , 'NORMAL'
: READ <# , "YES,NO,ERROR" , 'LONGTEXT=' , 'YES'
: ENDREAD
BW_ACTIVATE_CHAIN
ID='&CHAIN#',ERROR='&ERROR#',NOFOUND='&NOFOUND#',LONGTEXT='<#'
BW_ACTIVATE_INFOPACKAGE
Schedules one or more InfoPackages for immediate start
Transaction: RSA1
Syntax
BW_ACTIVATE_INFOPACKAGE
[NAME=...]
[,ERROR=...]
534 Chapter 4 UC4 JCL for Applications
[,NOFOUND=...]
[,MAXRUNTIME=...]
Syntax
NAME=
ERROR=
NOFOUND=
MAXRUNTIME=
Description/Format
Technical name of an InfoPackage
Format of value:
Handling when an InfoPackage ends abnormally
Format of the value: script literal
Allowed values: "ABEND" or "IGNORE" (Default: "ABEND")
"ABEND" = Script is aborted, the UC4 Job ends abnormally
"IGNORE" = Script continues, the UC4 Job ends normally
Handling when the InfoPackage was not found
Format of the value: script literal
Allowed values: "NORMAL" or "ABEND" (Default: "NORMAL")
"NORMAL" = Script continues, the UC4 job ends normally
"ABEND" = Script is aborted, the UC4 job ends abnormally
Maximum time in seconds in which the scheduled InfoPackages are monitored
Format of the value: Number
Default value: "86400"
Comments
Using this script element requires that the respective InfoPackage is not scheduled. The technical name of the InfoPackage can be retrieved with
. The script element stays active as long as the loading job in SAP BW has ended. If the loading job does not end normally, the UC4 Job is aborted.
This script element can also be used without the parameter NAME=. In doing so, several InfoPackages can be scheduled for immediate start in one step. The parameters NOFOUND= and ERROR= can be used to specify the reaction of UC4 when InfoPackages are not found or when one of the InfoPackages ends abnormally.
If InfoPackages are manually set to the quality status "Y" (yellow) in the administrator workbench, the
UC4 Job which scheduled them will never end. With the parameter MAXRUNTIME=, it can be specified how long the InfoPackage should be monitored. If this amount of time is exceeded, the parameter
ERROR= is used to either cancel or continue the UC4 job.
A data-transfer process must be started after the loading process if you use BW 7.x DataSources and
Transformation Services (as of SAP NetWeaver 04s). UC4 recommends defining suitable process
chains in the BW which can be handled using BW_ACTIVATE_CHAIN .
Examples
The first example schedules an InfoPackage for immediate start. After a maximum of one hour the waiting time for request ends.
BW_ACTIVATE_INFOPACKAGE NAME="ZPAK_
6LX4XTMC3RJ2DF4F09NFIJW98",MAXRUNTIME=3600
Automation Engine 535
In the second example, all InfoPackages are selected in whose long text the sample "UC4:*Text*" appears. Afterwards, the located InfoPackages are scheduled for immediate start. Each occurring error should cause the UC4 job to abort.
BW_SET_INFOPACKAGE_SELECTION
SELNAME='TEXTLONG',SIGN='I',OPTION='CP',LOW='UC4:*Text*'
BW_ACTIVATE_INFOPACKAGES NOFOUND='ABEND',ERROR='ABEND'
BW_GET_CHAINS
Reads process chains from the BW system. Available process chains are stored in an activation report or a file.
Transaction: RSA1
SAP BW Version: 3.0B and later with Patch SAPKW30B11
Syntax
BW_GET_CHAIN[S]
[FILE=...]
[,ID=...]
[,TEXT=...]
[,ENCODING=...]
Syntax
FILE=
ID=
TEXT=
Description / Format
Name of the file in which the available process chain should be saved
Value format:
Default value: ""
The result is not output in the report if this parameter is used.
Technical designation of the process chain
Value format: script literal
Default value: ""
Wildcard characters can be used for selection.
Description of the process chain
Format of the value: script literal
Default value: ""
Wildcard characters can be used for selection.
ENCODING= Encoding for the generated output file (Parameter FILE=).
For example: UTF-8
Default value: ISO-8859-1
When you specify an encoding that is not supported or invalid, the Job will abort with an error message.
The SAP Forms provide an input assistant for this field which lists all the supported encodings.
536 Chapter 4 UC4 JCL for Applications
Comments
All available process chains are written to the activation report or a specified file. This file is well structured. The first column (25 characters) contains the technical name (ID) of the process chain and the second column (60 characters) its description. The object version is shown in the third column (1 character). Object version codes indicate the following: l l l l
A = Active
M = Revised
D = Content
N = New
Example
Available process chains are queried and written to a file.
BW_GET_CHAINS FILE='..\TEMP\CHAINS.TXT',TEXT='Test*'
BW_GET_INFOPACKAGES
Reads InfoPackages from the BW system. The available InfoPackages are saved in the activation report or a file.
Transaction: RSA1
Syntax
BW_GET_INFOPACK[AGES]
[FILE=...]
Syntax
FILE=
Description/Format
Name of a file with complete path specification in which the available
InfoPackages are stored.
Comments
This script element assumes the InfoPackages have been already selected with
. All available InfoPackages are written to the activation report or a specified file. The file has a textured architecture. The first column (31 characters) contains the technical name of the InfoPackage, the second column (61 characters) its long text.
All selection tables are deleted when the script elements have been processed in the script.
Example
In the example shown below, all InfoPackages with the long text "Land*" except for those with the
InfoSource name "0COUNTRY" are selected and written to a file.
BW_SET_INFOPACKAGE_SELECTION SELNAME="TEXTLONG",LOW="Land*",OPTION=CP
BW_SET_INFOPACKAGE_SELECTION SELNAME="INFOSOURCE",LOW="0COUNTRY",SIGN=E
BW_GET_INFOPACKAGES FILE="c:\temp\infopackages.txt"
Automation Engine 537
BW_RESTART_CHAIN
Continues an interrupted process chain.
Transaction: RSA1
SAP BW Version: 3.0B and later with Patch SAPKW30B11
Syntax
BW_RESTART_CHAIN
ID=...
,LOGID=...
[,NOFOUND=...]
[,ERROR=...]
[,PROCESSLOGS=...]
[,JOBLOGS=...]
[,LONGTEXT=...]
[,REPLICATE=...]
[,GET_SPOOL=...]
[,COLLECTLOGS=...]
Syntax
ID=
LOGID=
NOFOUND=
Description / Format
Technical designation of the process chain.
Value format:
25-digit Log ID.
Value format: script literal
Handling if the process chain cannot be found.
Value format: script literal
ERROR=
Allowed values: NORMAL (default value)or ABEND
Default: NORMAL
NORMAL = The script continues, the UC4 job ends normally.
ABEND = The script aborts, the UC4 Job ends abnormally.
Handling if the process chain ends abnormally.
Value format: script literal
Allowed values: ABEND (default value), IGNORE or SUSPEND
Default: "ABEND"
ABEND = The script aborts, the UC4 job ends abnormally.
IGNORE = The script continues, the UC4 Job ends normally.
SUSPEND = The Job remains active until a restart of the process chain / its child processes has been successful or the Job has been canceled manually.
You can use this parameter in order to restart process chains or their child processes. The advantage is that the Job does not end which would include that processing continues in a parent (such as a Workflow).
538 Chapter 4 UC4 JCL for Applications
PROCESSLOGS= Output of a process chain's individual process logs.
Value format: script literal
JOBLOGS=
Allowed values: YES (default value), NO or ERROR
Default: YES
YES = Individual process logs are added to the process chain log.
NO = Only the process chain log is output.
ERROR = Individual process logs are output only in case of error.
Log output of the process background job.
Value format: script literal
LONGTEXT=
REPLICATE=
Allowed values: YES (default value), NO or ERROR
Default: YES
YES = Process background job logs are output.
NO = Process background job logs are not output.
ERROR = Process background job logs are only output if an error occurs.
Output of a long text (diagnostics text) to a log message.
Value format: script literal
Allowed values: YES, NO or ERROR (default value)
Default: ERROR
ERROR = The log message long text is only output if an error occurs.
YES = The log message long text is output.
NO = The log message long text is not output .
Handling of the children of a process chain.
Format of the value: script literal
GET_SPOOL=
Allowed values: ALL, YES or NO (default value)
ALL = Replicates all a Job's child processes in the UC4 system (including skipped ones). They are shown in the UserInterface's Activity Window. Statistical records and reports are also generated in the UC4 system.
YES = The children of a Job are replicated in the UC4 system. They are displayed in the Activity Window of the UserInterface. Statistical records and reports are also generated in the UC4 system.
NO = There is no replication in the UC4 system.
Requests the spool list of the started Job.
Format of the value: script literal
Allowed values: YES or NO (default)
YES = The spool list is requested. It is stored as a text file in the directory that has been defined in the SAP Agent's INI file with the parameter Download_dir=
(Sektion [GLOBAL]). The name of this file is structured as follows:
<SAP Job count>_<step number>_<spool number>.txt
This file is also registered as Job output in the UC4 Job.
NO = The spool list is not requested.
Spool entries of children are only requested when the parameter REPLICATE= is either set to YES or to ALL.
Automation Engine 539
COLLECTLOGS=
Writes the reports of the activated process chain's child processes to the Job report.
The reports of replicated child processes are by default available in the Job report
AND the task of the child process. Therefore, this information is redundant in the
Job and you can decide not to assume this information here.
Allowed values: YES (default) or NO
YES - Logs of child processes are written to the Job report.
NO - Logs of the process chain's child processes are not assumed to the Job report.
Note that the reports of the child processes are not available if you specify NO in the parameters REPLICATE and COLLECTLOGS.
Description
This script element continues an interrupted process chain. A particular process chain execution is clearly identified with the parameter LOGID=. The Log ID can be determined using
from a UC4 Job report.
If the process chain continues, it is monitored until it ends.The process chain log is always saved in the activation report. Additionally, either individual process logs or process background job logs are output depending on the parameters PROCESSLOGS= and JOBLOGS=.
Examples
This example serves to determine whether the ZSBB1 process chain has been interrupted in a job's post script by using the error number. If so, the 25-digit Log ID is saved in a variable.
: SET &HND# = PREP_PROCESS_REPORT
(,,PLOG, '*U2004111*' , 'COL=DELIMITER' , "DELIMITER =@'@")
: SET &LOGID# = ''
: PROCESS &HND#
: SET &LOGID# = GET_PROCESS_LINE ( &HND# ,4)
: ENDPROCESS
: IF &LOGID# <> ''
: PUT_VAR VARA.CHAINS, 'ZSBB1' , &LOGID#
: ENDIF
An additional job reads the Log ID from the variable and restarts the process chain to continue processing.
: SET &LOGID# = GET_VAR (VARA.CHAINS,ZSBB1)
BW_RESTART_CHAIN ID='ZSBB1',LOGID='&LOGID#',ERROR='ABEND',NOFOUND='NORMAL'
BW_SET_CONSTRAINT
Sets the criteria for the automatic restart of a process chain's child processes.
Syntax
BW_SET_CONSTRAINT
540 Chapter 4 UC4 JCL for Applications
Syntax
TYPE=
[TYPE=...]
[,NAME=...]
,FIELD=...
[,OPERATOR=...]
,VALUE=...
,ACTION=...
[,COUNT=...]
[,DELAY=...]
NAME=
FIELD=
Description/Format
Type of child process.
Format of the value:
You can also use the wildcard character * (placeholder for any number of characters).
For example: ABAP
Name of the child process.
Format of the value: script literal
The wildcard characters * and ? (placeholder for a character of your choice) can also be used.
Location in which the value (parameter VALUE) should be searched.
Format of the value: script literal
Allowed values: STATUS, JOBLOG or PROCESSLOG
STATUS = Status of the child process.
JOBLOG = Job log. Logs of the background job.
PROCESSLOG = Process log. Logs of the child processes.
Note that you can only search in the process log and the Job log if this setting has been specified for the activated or restarted process chain (script element BW_
ACTIVATE_CHAIN / BW_RESTART_CHAIN, parameter JOBLOGS /
PROCESSLOGS).
OPERATOR= Operator for the condition.
Format of the value: script literal
Allowed values: EQ (default), NE, CP or NP
EQ = Equals (only for FIELD=STATUS).
.NE = Does not equal (only for FIELD=STATUS.)
CP = Contains pattern.
NP = Does not contain pattern.
VALUE=
ACTION=
COUNT=
DELAY=
Automation Engine 541
Value that should be searched.
Format of the value: script literal
The following values (corresponding to the RSPC_STATE domain definition in the SAP system) can be used for checking the states of the child processes:
X = Aborted
R = Ended with errors
G = Successfully completed
F = Completed
A = Active
P = Planned
S = Skipped at restart
Q = Released
Y = Ready
= Undefined
Action to be taken for the child process that meets the condition.
Format of the value: script literal
Allowed values: RESTART or ABEND
RESTART = Restarts the relevant child process.
ABEND = Cancels the relevant child process.
Number of restarts that should be made for the relevant child process (only for
ACTION=RESTART).
Format of the value: number
Default value: 1
Time that should be waited (in minutes) between several restarts (only for
ACTION=RESTART).
Format of the value: number
Default value: 1
Description
You can use this script element in order to restart child processes of process chains automatically.
This function determines a criterion which is composed of the condition that should be checked (such as querying a particular status) and an action that should be taken (such as canceling the task). The defined action is executed in all child processes to which these conditions apply.
For example:
The following example defines a restart criterion in which all canceled child processes of ABAP type whose names start with RSM are automatically restarted up to three times in an interval of 5 minutes.
BW_SET_CONSTRAINT
NAME="RSM*",VALUE="X",OPERATOR="EQ",ACTION="RESTART",TYPE="ABAP",DELAY="5",
COUNT="3"
The following definition causes all ABAP child processes whose names start with RSM to be canceled if the background Job's log includes the term error.
BW_SET_CONSTRAINT
NAME="RSM*",VALUE="error",OPERATOR="CP",ACTION="ABEND",TYPE="ABAP",DELAY="5
",COUNT="3",SOURCE="JOBLOG"
542 Chapter 4 UC4 JCL for Applications
BW_SET_INFOPACKAGE_SELECTION
Set selection parameters to be used for reading the InfoPackages of the BW system.
Transaction: RSA1
Syntax
BW_SET_INFOPACKAGE_SELECTION
SELNAME=...
,LOW=...
[,HIGH=...]
[,SIGN=...]
[,OPTION=...]
[,MODE=...]
Syntax
SELNAME=
LOW=
HIGH=
SIGN=
OPTION=
Description/Format
Name of a selection table for the InfoPackages
Allowed values: "TEXTLONG", "INFOSOURCE", "SOURCESYSTEM",
"DATASOURCE"
"TEXTLONG" = Selection for long texts
"INFOSOURCE" = Selection for InfoSources
"SOURCESYSTEM" = Selection for source systems
"DATASOURCE" = Selection for data sources
Lower limit for the chosen selection table
Upper limit for the chosen selection table
Indicator for the selection
Allowed values: "I" (default value), "E"
"I" = Found InfoPackages are included
"E" = Found InfoPackages are excluded
Selection option
Allowed values: "EQ" (default value), "NE", "GT", "GE", "LT", "LE", "CP",
"NP", "BT", "NB"
"EQ" = equal
"NE" = unequal
"GT" = larger
"GE" = larger or equal
"LT" = smaller
"LE" = smaller or equal
"CP"= Model comparison (with wildcards)
"NP" = Exclude model
"BT" = Interval (specify HIGH also)
"NB" =- Exclude Interval (specify HIGH also)
Automation Engine 543
MODE=
Processing mode for the selection
Allowed values: "R" (default value), "A"
"R" - Selection replaced in the selection table
"A" - Selection added to the selection table
Comments
This script element does not cause an SAP function call. It prepares for the subsequent reading of the
InfoPackages from the BW system. InfoPackages can be selected in four different ways: Long text,
InfoSource, Source system and Data source.
The selection tables of each UC4 Job for the target system SAP BW are empty in the beginning. Using this script element several times causes the selection tables to be steadily filled.
Lower and upper limits refer to the chosen selection table. If, for example, "TXTLONG" was specified, these parameters select the long text of the available InfoPackages. For specifying lower and upper limits, you can use the wildcards "*" and "?". "*" stands for any and "?" stand for exactly one character. An upper limit is only reasonable when BT" or "NB" is specified as a selection option.
Upper limit, indicator for the selection, selection option and processing mode are optional parameters for this script element.
The script element SET_INFOPACKAGE_SELECTION has been renamed to BW_SET_
INFOPACKAGE_SELECTION in Version 3.0. Nevertheless, the old name still can be used.
Example
In the example shown below, all InfoPackages are selected with long text "Land*" except for those with the InfoSource name "0COUNTRY".
BW_SET_INFOPACKAGE_SELECTION SELNAME="TEXTLONG",OPTION="CP",LOW="Land*"
BW_SET_INFOPACKAGE_SELECTION SELNAME="INFOSOURCE",LOW="0COUNTRY",SIGN=E
4.4.4 SAP XI
XI_GET_CHANNEL
Lists communication channels
Syntax
XI_GET_CHANNEL
[CHANNEL=...]
[,SERVICE=...]
[,PARTY=...]
[,STATE=...]
[,ACTSTATE=...]
[,NOFOUND=...]
544 Chapter 4 UC4 JCL for Applications
Syntax
CHANNEL=
SERVICE=
PARTY=
STATE=
ACTSTATE=
NOFOUND=
Description/Format
Name of the communication channel
Format of the value: script literal
Default value: "*"
The wildcard character "*" can be used in the channel name.
Name of the service
Format of the value: script literal
Default value: "*"
The wildcard character "*" can be used in the service name.
Name of the partner
Format of the value: script literal
Default value: "*"
The wildcard character "*" can be used in the partner name.
Status of the communication channel
Format of the value: script literal
Allowed values:
"*" (default value)
"ERROR"
"OK"
"INACTIVE"
"UNKNOWN"
"UNREGISTERED"
Status of the communication channel
Allowed values: "*" (default value), "STARTED" and "STOPPED"
Handling if no communication channel could be found which meets the specified filter criteria.
Format of the value: script literal
Allowed values: "NORMAL" (default value) or "ABEND"
"NORMAL" = The UC4 job continues.
"ABEND" = The UC4 job ends abnormally.
Comments
This function lists the communication channels which meet the specified filter criteria in the Job report. By default, the selection of communication channels is not restricted by filter parameters.
The parameter NOFOUND= can be used to cancel a job if the filter criteria do not apply to any communication channel.
T he result is stored in the job report as an XML document. It can be read using the
Example of XML output to the report:
<Report>
<Channels>
<Channel>
<Party/>
<Service>FileListReceiver</Service>
Automation Engine 545
<ChannelName>FileListReceiverChannel</ChannelName>
<ChannelID>85e07c39f9b831d1817f3c4bec0af8ff</ChannelID>
<ActivationState>STARTED</ActivationState>
<ChannelState>OK</ChannelState>
</Channel>
<Channel>
<Party/>
<Service>X64_107</Service>
<ChannelName>GeneratedReceiverChannel_RFC</ChannelName>
<ChannelID>19729e747d023ff7a27d32d3f566ed79</ChannelID>
<ActivationState>STARTED</ActivationState>
<ChannelState>OK</ChannelState>
</Channel>
<Channel>
<Party/>
<Service>SenderList</Service>
<ChannelName>File_Sender_List</ChannelName>
<ChannelID>8bdda1b7041b37efa313219ae7029906</ChannelID>
<ActivationState>STARTED</ActivationState>
<ChannelState>OK</ChannelState>
</Channel>
</Channels>
</Report>
Example
This example lists all inactive communication channels:
XI_GET_CHANNEL STATE='INACTIVE'
All started communication channels whose name starts with "File" are listed in the report:
XI_GET_CHANNEL CHANNEL='File*',ACTSTATE='STARTED'
See also:
XI_SET_CHANNEL
Starts and stops communication channels
Syntax
XI_SET_CHANNEL
ACTION=...
[CHANNEL=...]
[,SERVICE=...]
[,PARTY=...]
[,NOFOUND=...]
[,ERROR=...]
546 Chapter 4 UC4 JCL for Applications
Syntax
ACTION=
CHANNEL=
SERVICE=
PARTY=
NOFOUND=
ERROR=
Description/Format
Action on the communication channel
Allowed values: "START" and "STOP"
Name of the communication channel
Format of the value: script literal
Default value: "*"
The wildcard character "*" can be used in the channel name.
Name of the service
Format of the value: script literal
Default value: "*"
The wildcard character "*" can be used in the service name.
Name of the partner
Format of the value: script literal
Default value: "*"
The wildcard character "*" can be used in the partner name.
Handling if no communication channel could be found which meets the specified filter criteria.
Format of the value: script literal
Allowed values: "NORMAL" (default value) or "ABEND"
"NORMAL" = The UC4 job continues.
"ABEND" = The UC4 job ends abnormally.
Handling if the defined action could not be processed in any of the communication channels.
Allowed values: "IGNORE" and "ABEND" (default value)
"IGNORE" = The UC4 job continues.
"ABEND" = The UC4 job ends abnormally.
Comments
This function starts or stops one or several communication channels. It is possible to specify either a particular communication channel or filters for several ones using the parameters CHANNEL=,
SERVICE= and PARTY=.
The parameter ERROR= can be used to cancel a job if it cannot be started or stopped because of the selected communication channels. Due to the interface behavior, the Agent still applies ACTION= for all other communication channels.
Information about communication channels which could not be controlled is stored in the job report as an
XML document. It can be read using the
.
Example of XML output to the report:
<Report>
<Channels>
<Channel>
<Party/>
<Service>SenderList</Service>
<ChannelName>SenderChannel</ChannelName>
Automation Engine 547
<ChannelID> f2d7791276e8388b995afd2d7a22e1b0</ChannelID>
<ActivationState>STARTED</ActivationState>
<ChannelState>OK</ChannelState>
<ErrorInformation> com.sap.aii.af.service.administration.impl.WrongAutomationModeException:
The channel "/SenderList/SenderChannel (GUID f2d7791276e8388b995afd2d7a22e1b0)" is configured to use an automation mode that is not compatible with the type of the current principal (WSUSER). The channel was not started. Change the channel's automation mode and repeat the administrative action.
</ErrorInformation>
</Channel>
</Channels>
</Report>
Example
This example starts a communication channel which is filtered by name and service.
XI_SET_CHANNEL ACTION='START',CHANNEL=' File_Sender_List',SERVICE='
SenderList',PARTY='*'
A communication channel is stopped:
XI_SET_CHANNEL ACTION='STOP',CHANNEL='SenderChannel',SERVICE='
SenderList',PARTY='*'
See also:
4.5 Siebel
4.5.1 SI_START_TASK
Executes commands in Siebel.
Syntax
SI_START_TASK CMD=Siebel command
Syntax
CMD=
Description / Format
Siebel command.
Format of the value:
548 Chapter 4 UC4 JCL for Applications
Description
Use the script element SI_START_TASK in the Process tab to have commands executed in Siebel. The
Siebel command will be passed on to the Siebel Server Manager (through its parameter /c) and then processed in Siebel.
Each script line with "SI_START_TASK" is an extra task in Siebel. In order to enable task monitoring (e.g.
canceling or restarting tasks), it is essential that the Siebel command starts with "start task". If "run task" is used, the Siebel Job is canceled and an error message is printed.
Example:
SI_START_TASK CMD="start task for component EIM server ESERV01 with
Config=apd_contacts_ok.ifb, LovLang=DEU, ErrorFlags=1, SQLFlags=8,
TraceFlags=1"
See also:
About UC4 JCL for Applications
Automation Engine 549
5 UC4 JCL for JMX
5.1 About the JMX JCL
The following document provides an overview of all JCL script elements for JMX and the corresponding supported data types.
The data types shown below are supported when values are assigned with script elements.
l l l l l l l l l l l l java.lang.String
java.lang.Integer
java.lang.Byte
java.lang.Float
java.lang.Double
java.lang.Short
java.lang.Long
java.lang.BigInteger
java.lang.Boolean
java.lang.BigDecimal
java.lang.Character
javax.management.openmbean.CompositeData
Arrays or the two complex data types shown below can be used for the return codes of the script elements: l l javax.management.openmbean.CompositeData
javax.management.openmbean.TabularData
The results of the script elements are written to the report. They can be read with
Script elements
Script element
Description
Combines values for one parameter
Registers an MBean
Retrieves the Agent ID of the MBean Server
Supplies the value of one or all the attributes of an MBean
Gives information about an MBean
Calls a function of an MBean
Lists registered MBeans
Sets an MBean attribute
Waits for an MBean notification
550 Chapter 5 UC4 JCL for JMX
Removes an already registered MBean
See also:
"Form" (JMX) tab
5.2 JMX_COMPOSITE_ADD
Combines values for one parameter
Syntax
JMX_COMPOSITE_ADD NAME=..., KEY=..., VALUE=...
Syntax
NAME=
KEY=
VALUE=
Description/Format
Parameter name.
Keyword.
The description depends on the MBean to which the parameter should be assigned.
Value to be stored for the keyword.
Comments
Many MBeans require a list of values instead of just one for their parameters. JMX_COMPOSITE_ADD stores several values in one parameter name. These values can only be used within a particular job.
Parameter values exist until the end of a job and can be used for any MBean of your choice.
The following line defines an individual value.
JMX_COMPOSITE_ADD NAME="parameter",KEY="CUSTOMERSTATE",VALUE="Partner"
If a keyword consists of more than one value, these must be separated with ";".
JMX_COMPOSITE_ADD NAME="parameter",KEY="COUNTRY",VALUE="USA;India"
";" can also be used within a value. Add an additional "\" in front of the semicolon in this case. It is not interpreted as a separator.
Areas indicating minimum and maximum values are also separated with ";".
JMX_COMPOSITE_ADD NAME="parameter",KEY="ID",VALUE="33333;44444"
The date format is YYYYMMDD, time format is HHMMSS and date plus time is specified with
YYYYMMDDHHMMSS.
JMX_COMPOSITE_ADD NAME="parameter",KEY="TIME",VALUE="121516"
JMX_COMPOSITE_ADD NAME="parameter",KEY="DATEOPENED",VALUE="19990616120000"
Values of type Boolean are used with "true" or "false".
JMX_COMPOSITE_ADD NAME="parameter",KEY="REQUEST",VALUE="true"
Values of type currency only require the numerical value.
Automation Engine 551
JMX_COMPOSITE_ADD NAME="parameter",KEY="CURRENCY",VALUE="1000.00"
Enter this multi-line value directly in the Process tab. This line should no longer be edited in the Form tab because it does not support multi-line texts and only the first line would be processed in this case.
Avoid using special characters and German umlauts in parameter names and values. The JMX Agent sends all Web Service Requests in UTF-8. Whether or not JCL conversion is successful depends on the encoding specified by the UC4 administrator in the UC4 Variable UC_SYSTEM_SETTINGS in the key XML_ENCODING. The Agent acts on the assumption that "ISO-8859-15" has been specified.
Example
The following example fills the parameter "report" of the MBean for Crystal Reports . It contains values for the date format, the sender and an e-mail subject.
JMX_COMPOSITE_ADD NAME="report",KEY="FORMAT",VALUE="EXCEL"
JMX_COMPOSITE_ADD NAME="report",KEY="MAIL_SUBJECT",VALUE="Customers in
L.A."
JMX_COMPOSITE_ADD NAME="report",KEY="MAIL_FROM",VALUE="[email protected]"
See also:
5.3 JMX_CREATE_MBEAN
Registers an MBean
Syntax
JMX_CREATE_MBEAN CLASSNAME=... [, NAME=...] [, LOADERNAME=...]
[EXISTS=...]
Syntax
CLASSNAME=
NAME=
LOADERNAME=
EXISTS=
Description/Format
Class name of the MBean
Name that should be used for MBean registration.
This parameter does not have to be indicated when the MBeanRegistration
Interface is implemented in the MBean.
Name of the loadingclass
By default, the Default Loader Repository is used for loading the MBean.
Handling of the UC4 Job when the MBean has already been registered.
Allowed values: "IGNORE" and "ABORT" (default values)
"IGNORE" - The script of the JMX job continues.
"ABORT" - The JMX job is canceled.
Comments
This script element creates an instance of the indicated class and registers it in the MBean Server with the object name. The parameter LOADERNAME= can contain an object name of a loading class which should
552 Chapter 5 UC4 JCL for JMX be used to load the indicated class.
Example
JMX_CREATE_MBEAN CLASSNAME=com.uc4.mbeans.DatabaseExample,
NAME=UC4:type=DatabaseExample
See also:
5.4 JMX_GET_AGENT
Retrieves the Agent ID of the MBean Server
Syntax
JMX_GET_AGENT [ALL=...]
Syntax
ALL=
Description/Format
List of agent IDs
Possible values: "YES" and "NO" (default)
"YES" - lists all agent IDs of running MBean Servers.
"NO" - retrieves the agent ID of the existing MBean Server.
Example
JMX_GET_AGENT ALL=YES
See also:
5.5 JMX_GET_ATTRIBUTE
Supplies the value(s) of one or all the attribute(s) of an MBean
Syntax
JMX_GET_ATTRIBUTE MBEAN=... [, ATTRIBUTE=...]
Syntax
MBEAN=
ATTRIBUTE=
Description/Format
Object name of the MBean
Name of the attribute
Automation Engine 553
Comments
Specify a particular attribute whose value should be retrieved. If this parameter is not used, the script function supplies the values of all the MBean's attributes.
In the Agent's INI-file parameter search_all=, the UC4 administrator can specify whether this function searches the MBean on all local MBean Servers or only on those to which the Agent is connected.
Example
JMX_GET_ATTRIBUTE MBEAN="Catalina:type=GlobalRequestProcessor,name=http-
80", ATTRIBUTE=processingTime
See also:
5.6 JMX_GET_INFO
Gives information about an MBean
Syntax
JMX_GET_INFO MBEAN=... [SHORTINFO=...]
Syntax
MBEAN=
SHORTINFO=
Description/Format
Object name of the MBean
Complexity of the information
Allowed values: "YES", "NO" (default)
"YES" - Only short information is retrieved.
"NO" - All the information is output.
Comments
The description of the MBean and a list of its attributes, operations and notifications are retrieved.
In the Agent's INI-file parameter search_all=, the UC4 administrator can specify whether this function searches the MBean on all local MBean Servers or only on those to which the Agent is connected.
Example
JMX_GET_INFO MBEAN="Catalina:type=GlobalRequestProcessor,name=http-80"
See also:
554 Chapter 5 UC4 JCL for JMX
5.7 JMX_INVOKE
Calls a method of an MBean
Syntax
JMX_INVOKE MBEAN=..., OPERATIONNAME=..., PARAMS=... [, SIGNATURE=...]
Syntax
MBEAN=
Description/Format
Object name of the MBean
OPERATIONNAME=
Name of the operation that should be executed
PARAMS=
Parameter list
SIGNATURE=
Several parameters must be separated with commas.
If the indicated MBean contains several methods of the name
OPERATIONNAME= , the signature of the method to be executed must be assigned with this parameter.
Comments
This script element calls the function of an MBean and assigns parameters to it. If the MBean has more than one function, you can address a particular one with SIGNATURE=.
In the Agent's INI-file parameter search_all=, the UC4 administrator can specify whether this function searches the MBean on all local MBean Servers or only on those to which the Agent is connected.
Example
JMX_INVOKE MBEAN=UC4:type=DatabaseExample, OPERATIONNAME=selectInvoice,
PARAMS="1996-07-04,1996-07-10",
SIGNATURE="java.lang.String,java.lang.String"
See also:
Sample Collection
Calling an MBean
5.8 JMX_QUERY_NAMES
Lists registered MBeans
Syntax
JMX_QUERY_NAMES [NAME=...] [, NOTFOUND=...] [, MAXROWS=...]
Syntax Description/Format
Automation Engine 555
NAME=
NOTFOUND=
MAXROWS=
Object name of a particular MBean or filter specification for several MBeans
The wildcard characters "*" and "?" can be used. "*" stands for any number of characters, "?" for exactly one.
Procedure if MBeans were not found
Allowed values: "NORMAL" or "ABORT" (default value)
"NORMAL" = The UC4 job continues.
"ABORT" = The UC4 job ends abnormally.
Maximum number of lines to be listed
The Agent supplies all registered MBeans if this parameter has not been specified.
Comments
There are JMX-specific rules to be adhered to when specifying filters. Wildcard characters can be used in the domain description. They can also be used in the properties provided that the following rules are adhered to: the wildcard character "*" replaces a complete Property=value pair (e.g. description=Printer).
Wildcards must not be used within a property name or value (e.g. description=*).
Examples for valid filters:
"*:*"
"DefaultDomain:*"
"???Domain:description=Printer,*"
"*:description=Printer,type=laser,*"
Example
JMX_QUERY_NAMES NAME=JMImplementation:*, NOTFOUND=ABORT
See also:
5.9 JMX_SET_ATTRIBUTE
Sets an attribute of an MBean
Syntax
JMX_SET_ATTRIBUTE MBEAN=..., ATTRIBUTE=..., VALUE=...
Syntax
MBEAN=
ATTRIBUTE=
VALUE=
Description/Format
Object name of the MBean
Name of the attribute
Value that should be set for the attribute
556 Chapter 5 UC4 JCL for JMX
Comments
In the Agent's INI-file parameter search_all=, the UC4 administrator can specify whether this function searches the MBean on all local MBean Servers or only on those to which the Agent is connected.
Example
JMX_SET_ATTRIBUTE ATTRIBUTE=State, MBEAN=UC4:type=StandardMBean,
VALUE=running
See also:
5.10 JMX_UNREGISTER_MBEAN
Removes an already registered MBean
Syntax
JMX_UNREGISTER_MBEAN MBEAN=...
Syntax
MBEAN=
Description/Format
Object name of the MBean
Example
JMX_UNREGISTER_MBEAN MBEAN=UC4:type=StandardMBean
See also:
5.11 JMX_WAIT_FOR_NOTIFICATION
Waits to be notified by the MBean
Syntax
JMX_WAIT_FOR_NOTIFICATION MBEAN=... [, ENABLE=...] [, FILTER=...]
Syntax
MBEAN=
ENABLE=
Description/Format
Object name of the MBean
List of attributes of notification types
Several parameters must be separated by commas.
Automation Engine 557
FILTER=
Filter for the notifications
Allowed values: "NONE" (default value), "ATTRIBUTE" and "TYPE"
"NONE" - All notifications are accepted.
"ATTRIBUTE" - Filters set on attribute changes are considered.
"TYPE" - Filters set on the notification type are considered.
The attributes or types are specified with the parameter ENABLE=.
Example
JMX_WAIT_FOR_NOTIFICATION MBEAN=JMImplementation:type=MbeanServerDelegate,
ENABLE="JMX.mbean.registered,JMX.mbean.unregistered", FILTER=NONE
See also:
558 Chapter 6 UC4-JCL for SQL
6 UC4-JCL for SQL
6.1 About SQL JCL
UC4 provides specific script elements for SQL jobs. Results are written to a report and can be read using
.
Script element
Script element Description
Executes a Job on the MS SQL Server.
Supplies information about a table's columns.
Supplies a list of all defined Jobs of an MS SQL Server.
Lists all database tables.
Determines the reaction to SQL errors.
Determines the return code if an SQL statement does not supply a hit.
Determines the character that terminates SQL statements.
See also:
Form (SQL)
6.2 SQL_EXECUTE_JOB
Executes a Job on the MS SQL Server.
Syntax
SQL_EXECUTE_JOB JOB=...
Syntax
JOB=
Description/Format
Name of the MS SQL Job.
Comments
The Agent uses the stored procedure sp_start_job in the database msdb in order to start the MS SQL jobs.
The status of the UC4 job depends on the started job's execution:
Status of the MS SQL job
MS SQL job has successfully ended
Status of the UC4 job
ENDED_OK
Automation Engine 559
MS SQL job has aborted
User has canceled the MS SQL job
ENDED_NOT_OK
ENDED_CANCEL
The UC4 Job also aborts if the user is not authorized or if a database other than Microsoft SQL Server has been used.
The Agent calls the stored procedure sp_stop_job if you terminate the UC4 Job while the MS SQL Job is still active. In doing so, the MS SQL job does not abort immediately and is monitored until its end has been defined.
The script element
lists all available MS SQL jobs.
Examples
SQL_EXECUTE_JOB JOB="Integrity Checks Job for DB Maintenance Plan";
See also:
6.3 SQL_GET_COLUMNS
Supplies information about a table's columns.
Syntax
SQL_GET_COLUMNS TABLE=...
Syntax
TABLE=
Description/Format
Name of the table.
Comments
The Agent writes the result to a report. Exactly one line is output per column with the individual values being separated by semicolons.
Structure of the information given in a column:
Foreign key;primary key;column name;(data type)
Value
Foreign key
Primary key
Column name
Description
Indicator for the key.
Allowed values: 0 and 1
0 - The column is not a foreign key.
1 - The column is a foreign key.
Indicator for the key.
Allowed values: 0 and 1
0 - The column is not a foreign key.
1 - The column is a foreign key.
Name of the column.
560 Chapter 6 UC4-JCL for SQL
Data type This is a combination of the vendor's data type and the information whether or not this field permits value NULL. For character types, the length is shown enclosed in parentheses after the data type.
A COMMIT is automatically made before this script function is processed.
Examples
The following call retrieves column information of the Products table.
SQL_GET_COLUMS TABLE="Products";
Result in the report:
0;1;ProductID;(int identity, not null)
0;0;ProductName;(nvarchar(40), not null)
1;0;SupplierID;(int, null)
1;0;CategoryID;(int, null)
0;0;QuantityPerUnit;(nvarchar(20), null)
0;0;UnitPrice;(money, null)
0;0;UnitsInStock;(smallint, null)
0;0;UnitsOnOrder;(smallint, null)
0;0;ReorderLevel;(smallint, null)
0;0;Discontinued;(bit, not null)
See also:
6.4 SQL_GET_JOBS
Supplies a list of all defined jobs of an MS SQL Server.
Syntax
SQL_GET_JOBS
Comments
The Agent uses the stored procedure vsp_help_job in the database msdb to retrieve MS SQL jobs. The report prints each MS SQL Job in a separate line.
The UC4 job aborts if the user is not authorized or if a database other than Microsoft SQL Server is used.
The script element
can execute MS SQL jobs.
Examples
SQL_GET_JOBS;
See also:
Automation Engine 561
6.5 SQL_GET_TABLES
Lists all database tables.
Syntax
SQL_GET_TABLES
Comments
The Agent writes the result to a report. Exactly one line is output per table. If a schema is available, it is written in front of the table name. Schema and table are separated by a dot.
Examples
All tables of the NORTHWIND database are retrieved.
SQL_GET_TABLES;
Result shown in the report: dbo.Categories
dbo.CustomerCustomerDemo
dbo.CustomerDemographics
dbo.Customers
dbo.Employees
dbo.EmployeeTerritories
dbo.Order Details dbo.Orders
dbo.Products
dbo.Region
dbo.Suppliers
dbo.Territories
See also:
6.6 SQL_ON_ERROR
Determines the reaction to SQL errors.
Syntax
SQL_ON_ERROR ACTION=...
Syntax Description/Format
562 Chapter 6 UC4-JCL for SQL
ACTION=
Reaction to SQL errors.
Allowed values: ABEND (default value) and RESUME
ABEND - The job aborts with return code 1 when the first SQL error occurs.
Subsequent SQL statements are not processed.
RESUME - The job continues if SQL errors occur.
The value must be put in inverted commas.
RESUME is used if this parameter is not specified.
Comments
By default, jobs abort if an SQL error occurs. This script element can be used to handle this behavior.
The specification that is made with SQL_ON_ERROR applies for all subsequent SQL statements until the job ends or until the next SQL_ON_ERROR statement is used.
Note that all SQL statements until the last COMMIT are canceled if the job aborts. This means that all
SQL statements are undone if the job does not contain a COMMIT.
Examples
The second INSERT statement results in an error because the table name contains a typing error.
Regardless of this error, the Agent continues the job and writes the data record for Mr. Brown to the database.
SQL_ON_ERROR ACTION="RESUME" insert into person values (1,'Smith'); insert into person values (2,'Brown'); insert into person values (3,'Spencer');
In the following example, the Agent cancels the job because the table name is wrong. As a result of the
COMMIT, the data-record entry for Mr. Smith is kept. Because of the fact that the job is canceled with the second INSERT statement, the data record for Mr. Spencer is not considered although it is syntactically correct.
SQL_ON_ERROR ACTION="ABEND" insert into person values (1,'Smith');
COMMIT; insert into person values (2,'Brown'); insert into person values (3,'Spencer');
See also:
6.7 SQL_ON_ROWCOUNT_ZERO
Determines the return code if an SQL statement does not supply a hit.
Syntax
SQL_ON_ROWCOUNT_ZERO RETCODE=...
Automation Engine 563
Syntax
RETCODE=
Description/Format
Return code
Default value: 1
Comments
This script element can be used to cancel a job with a defined return code if an SQL statement such as
SELECT or UPDATE does not return any hits. The specification made with SQL_ON_ROWCOUNT_
ZERO applies for all subsequent SQL statements until the job ends or until the next SQL_ON_
ROWCOUNT_ZERO statement.
Specify the RETCODE '0'; the number of hits that are found in SQL statements are ignored and the job continues.
SQL_ON_ROWCOUNT_ZERO can only be used for SELECT, UPDATE, INSERT and DELETE.
Other SQL statements such as CREATE TABLE never supply hits. Using lSQL_ON_ROWCOUNT_
ZERO in a job always requires RETCODE being set to 0 before the particular SQL statements are used.
All SQL statements until the last COMMIT are undone if the job is canceled.
Examples
The job is canceled and returns code 1 if one of the three SQL statements returns 0 hits.
SQL_ON_ROWCOUNT_ZERO RETCODE=1; select * from person; insert into person values (1,'Smith'); update person set address = '403 E. Main Street' where name = 'Spencer';
See also:
6.8 SQL_SET_STATEMENT_TERMINATOR
Determines the character which terminates SQL statements
Syntax
SQL_SET_STATEMENT_TERMINATOR TERM=...
Syntax
TERM=
Description/Format
Separator
Default value: ";"
Comments
This script element is automatically inserted in the script when the separator is used within an SQL statement. No manual intervention is required.
The following order is adhered to when a separator is selected:
564 Chapter 6 UC4-JCL for SQL
";", "@", "$", "/", "~", "*", "+", "?", "=", ".", "-", "§", "ë"
Specifications made with SQL_SET_STATEMENT_TERMINATOR apply for all subsequent SQL statements until the job ends or until the SQL_SET_STATEMENT_TERMINATOR statement is used again.
Example
SQL_SET_STATEMENT_TERMINATOR is added to the script because ";" is used within an SQL statement.
SQL_SET_STATEMENT_TERMINATOR TERM='@';
DECLARE v_unit_short varchar2(10); v_description varchar2(40);
BEGIN v_unit_short := 'kg'; v_description := 'Kilogram'; insert into unit (unit_short, description) values (v_unit_short, v_description);
EXCEPTION when DUP_VAL_ON_INDEX then
/* Data record already exists => Reset description */ update unit set description = v_description where unit_short = v_unit_short;
END;
@
See also:
Automation Engine 565
566 Chapter Glossary
Glossary
This glossary lists all UC4-specific technical terms in alphabetical order.
A B C D E F G H I J K L M N O P Q R S T U V W X
Y Z
A
l l l l l l
activation
Through activation, tasks obtain a RunID, are displayed in the Activity Window, and are ready for execution (see also 'Start').
activation log
A report that contains all details about task activation. The details that are included in the log depend on the settings that have been specified (for example, the generated JCL, modified
Variables).
Activity Window
A UserInterface window that displays all activated tasks.
Agent
A program that enables the execution of processes on target systems such as computers or business solutions. A particular UC4 object type.
alias
This refers to the name of Workflow tasks or objects that are activated once or recurring. This name is used instead of the actual object name in the Activity Window, the monitors and the statistics.
AutoForecast
It displays tasks that will run in a predetermined period. Comprehensive forecast for all future activities.
B
l
batch mode
This refers to the sequential background processing of tasks.
C
l l l l l
Calendar
It consists of days using Calendar keywords. A particular UC4 object type.
Calendar condition
The criteria for running a task is based on Calendar keywords.
Calendar keyword
A part of a Calendar object that is used to define days.
CallAPI
A programming interface that can either be called directly or from a different program. It processes a script in the UC4 system.
Child, Children
These are objects that are activated by superordinate tasks (parents).
Automation Engine 567 l l l l l
client
This is a closed environment for the execution of tasks within a UC4 system. A particular UC4 object type.
Cockpit
It visualizes the values and states of UC4 or of the monitored and controlled system. A particular
UC4 object type.
CodeTable
It defines a complete set of characters. A particular UC4 object type.
communication process
A communication process is part of the UC4 Automation Engine. It is responsible for connecting the UC4 components.
context menu
A menu that opens in a particular place when you right-click with the mouse.
D
l l l l
data sequence
An 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.
dialog process
A part of the UC4 Automation Engine and a special form of work process. Is exclusively responsible for UserInterface messages.
Documentation
This refers to the UC4 Guides. It is also a particular UC4 object type that can be used to store information.
dynamic variables
A Variable object with the attributes "Source" - "SQL", "SQL internal", "Multi" or "Filelist". Values are directly retrieved from the data source and not stored in the object.
.
E
l l l l l l
E-mail connection
This is a functionality of Windows and UNIX Agents that is used to send e-mails.
Enterprise Control Center (ECC)
A separate UC4 product. Web application that allows access to the functions of various UC4 applications and products in a quick and easy way.
Available for download from the UC4 Download Center .
Event
Action that is triggered if particular conditions apply. A particular UC4 object type.
Event ID
First RunID of FileSystem and Console Events. Both Event types require communication between
UC4 Automation Engine and Agent. They communicate via the first RunID. Otherwise, Event identification is no longer possible after the first log change.
Explorer
UserInterface window in which objects can be created, edited and administered.
external dependency
A task whose end status is considered when a Workflow is being processed. The task itself, however, does not run within the framework of this Workflow.
568 Chapter Glossary
F
l l l
File transfer
Transfers files from one computer to another. A particular UC4 object type (FileTransfer object).
Forecast
Estimates a task's runtime on the basis of previous executions.
fully qualified FileTransfer
FileTransfers without wildcard characters. One particular file is transferred.
G
l
Group
Integrates tasks so that they can be processed together. A particular UC4 object type.
H
l l l
host
Computer, target system.
host attributes
Platform-independent attributes of the Job object.
HTML help
Microsoft help format for manuals. These help files have the ending .CHM (see also 'WebHelp').
I
l
Include
A script that is often used in several objects. A particular UC4 object type.
J
l l
JCL
Short form of "Job Control Language". It refers to applications that are processing steps executed on computers.
Job
Processing on a target system. A particular UC4 object type.
K
l l
Key
Column in static Variable objects that can be used to access values of a particular line.
Keyword
Part of a Calendar or Variable object (Calendar keyword or key) or parameter of a script element that is used to define values.
Automation Engine 569
L
l l
Login
Login data for target systems. A particular UC4 object type.
logical date
The logical date is used as a comparison date for checking Calendar conditions.
M
l l
Message Window
UserInterface window that displays warnings, information and error messages.
Monitor
Graphical view of a task's execution.
N
l l
nonstop process
Part of the UC4 Automation Engine. Assumes processing if the computer with the active Server processes fails.
Notification
Sends messages to individual Users and UserGroups of the UC4 system. A particular UC4 object type.
O
l l l l
object
UC4-controlled activities and processes are structured in the form of objects (see also 'Task').
object class
There are four classes of objects: executable, active, passive and system objects.
object type
An individual object is provided for the individual activities: User, UserGroup, Notification, Cockpit,
CodeTable, Documentation, Event, Agent, FileTransfer, Group, Include, Job, Workflow, Calendar,
Login, Client, RemoteTaskManager, Schedule, Script, Server, Sync, Variable and TimeZone.
object variables
Placeholder for values that are stored in an object's "Values" tab.
P
l l l l
parent
There are different ways of activating objects. The originator of an activation is referred to as the superordinate task (parent). (See also 'Child', 'Children')
partially qualified FileTransfer
FileTransfers that use wildcard characters in order to transfer several files.
Period Container
Controls the execution of periodical tasks
perspective
Separate functional area of the Enterprise Control Center's (ECC) web interface. The perspectives
570 Chapter Glossary l l l l l l l l
Process Automation and Process Monitoring provide functionalities of the UC4 Automation
Platform.
Process Automation
The old name of the Service Catalog perspective.
Process Assembly
A perspective of the Enterprise Control Centers. You use it to create, define and modify Workflows.
Process Monitoring
A perspective of the Enterprise Control Center. It lists the activities of all users and provides the opportunity to manipulate them (you can cancel or deactivate them).
predefined variables
Fixed variables that can be used in the attributes or the script of executable objects. The values refer to the object or the system.
primary work process
It is responsible for the execution of UC4-internal tasks and work processes.
PromptSet
A user-defined input mask for executable objects. A UC4 object type.
PromptSet element
Fields/control elements that are used to query User values. They are the content of a PromptSet input mask.
PromptSet variable
It stores the value of a PromptSet element. Depending on the situation, a value can be user-defined or a default value. PromptSet variables show the same behavior as object variables.
Q
l
Queue
A Queue determines the maximum number of concurrent tasks, their priorities and the order in which tasks should be executed. A particular UC4 object type.
R
l l l l
Rapid Automation (RA)
A generic technology that can include various solutions. Is composed of an RA Agent and an RA
Solution.
RA Agent
A UC4 Agent that can be connected to a particular RA Solution and thus provide this solution's functionalities to a UC4 system. It is the interface between an external system / application / platform and a UC4 system.
RA Solution
A solution that is based on the Rapid Automation Technology that allows UC4 to access an external system / application / platform. The RA Solution is supplied as a JAR file that must be loaded to the UC4 Database and connected with an RA Agent. The specific RA objects (such as
Jobs, Connections, Agent) are available in the UC4 system as soon as the solution has been loaded.
real date
The date that is used for checking runtime monitoring or time conditions in the properties of
Workflow tasks is referred to as the real date. It complies with the top Workflow's activation time. It is passed on to all subordinate tasks.
Automation Engine 571 l l l l l l l l l
recurring tasks
These tasks are scheduled without using a Schedule object and mostly consist of a period that is less than a day.
registered
This is the status of a task that runs within a group and is waiting for its start.
RemoteTaskManager
It monitors and controls external Jobs that were not started by UC4. A particular UC4 object type.
report
A report provides more detailed information about a task's execution or a UC4 component.
Result column
The first column of dynamic Variable objects with the sources "SQL", "SQL-internal" and "Multi".
The content of this column can be defined with Result format .
restart
A restart refers to the repetition of an object's execution. This action differs from a new start in some parts.
return code
The value that represents the result of tasks and script functions.
RunID
Short 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 UC4 Server.
Runtime
The 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).
S
l l l l l l l l l l l
Schedule
It starts executable objects periodically. A particular UC4 object type.
Script
A script processes statements in UC4's script language. A particular UC4 object type.
A placeholder for a value within a script.
Server process
The core of a UC4 Automation Engine. Different types are available: communication, work and dialog processes, as well as nonstop processes.
ServiceManager
A program that facilitates the starts and stops of UC4 components.
Service Catalog
A perspective of the Enterprise Control Center. It allows users to start the objects in their Favorites folder and generally monitor their execution.
start
This refers to the start of a task's execution (see also 'Activation').
static variables
A Variable object with the setting "Source" - "Static": Variable values are entered by a User or with a script and remain stored in the object.
Statistics
This is a list of a task's previous runs.
status
This represents the condition of a task (such as active, blocked, generating).
Sub-Workflow
A Workflow that is part of a different Workflow.
572 Chapter Glossary l l l
superordinate task
There are various ways of activating objects. The originator of the activation is referred to as the superordinate task (parent).
Sync
It synchronizes executable objects based on defined states and actions. A particular UC4 object type.
System Overview
The UserInterface window that contains information about the UC4 system.
T
l l l
task
An executable object that is running is also referred to as a task.
timeout
Occurs when a particular period of time is over.
TimeZone
It defines a local time. A particular UC4 object type.
U
l l l l l l l l l
UC4 Automation Engine
It drives a UC4 system and consists of different types of Server processes.
UC4 Automation Platform
A separate UC4 product. Includes the components that are required in order to operate a UC4 system (such as the Automation Engine, UserInterface, Agents, WebInterface).
Available for download from the UC4 Download Center .
UC4 ClearView
A separate UC4 product. Graphical analysis tool: Displays the activities, statistical and forecast data per UC4 system client in a bar diagram and can be used to calculate the critical path.
Available for download from th e UC4 Download Center .
UC4 component
Refers to UC4 programs such as UserInterfaces, the Automation Engine, Agents,
ServiceManagers, utilities etc.
UC4 Database
A relational database management system (RDMS) that administers all scheduling data from a central point. It contains object definitions, system specifications, statistical data, job reports, etc.
UC4 Insight
A separate UC4 product. Complex graphical analysis tool for the data of UC4 Automation Platform systems (such as tasks).
Available for download from the UC4 Download Center .
UC4 Policy Orchestrator (
A separate UC4 product. Can be used to define and administer business rules and trigger Events.
Available for download from the UC4 Download Center .
UC4 priority
Affects the order of task execution within a UC4 system.
UC4 Application Release Automation
Separate UC4 product that can be used to define, administer and activate installation and integration processes and to administer the versions and dependencies of various applications. The
Deployment processes run via the UC4 Automation Platform.
Available for download from the UC4 Download Center .
Automation Engine 573 l l l l l l l l l l
UC4's scripting language.
UC4 Server
Old term for UC4 Automation Engine (v8 or lower).
UC4 Service Orchestrator
A UC4 product. The Service Orchestrator is a perspective of the UC4 Enterprise Control Centers
(ECC) and it is used to handle, monitor and analyze the performance of SLAs (Service Level
Agreements).
UC4 system
An environment that is managed by UC4 components.
UC4 Variables
These are Variable objects that include the UC4 system's specifications.
User
A person who uses a UC4 system. A particular UC4 object type.
User group
A group of users who have a common profile of rights. A particular UC4 object type.
UTC
Internally, UC4 uses UTC (Universal Time Coordinated) because UTC is the international time standard and is always precise. Nevertheless, TimeZone objects are available that can be used to show local times in tasks and script elements.
UserInterface
This is UC4's graphical user interface.
utilities
Utilities support the execution of administrative tasks in a UC4 system (such as reorganizing and archiving the UC4 Database).
V
l l
Variable
It stores or retrieves values dynamically at runtime. An individual UC4 object type.
Version Management
This refers to an object version that is stored when you have modified the object.
W
l l l l l
WebHelp
One of the help formats that are provided for manuals. You open it with a Web browser (see also
'HTML Help').
WebInterface
A UC4 user interface that can be called via a Web browser.
wildcard characters
These are placeholders for characters when you specify filters. ? stands for exactly one character, * for any number of characters.
work process
A part of the UC4 Automation Engine. It is responsible for a UC4 system's processes (see also
'Primary work process').
Workflow
It refers to the execution of processes. A particular UC4 object type.
574 Chapter Glossary
X
l
XML file
A format for imports and exports. An XML file contains object structures.
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Questions & Answers
N N Q
How can I set up an email notification based on a report?
How can I handle objects, or read or modify them in UC4 scripts?
How can I write a script that depends on a file in a path on a Unix server?
N N Q
How do I decrypt files and receive an email alert if the decryption fails?
How to use the GET_CONDITION script element in UC4 scripts?
How can I implement an email notification based on a specific report?
How do I create a script that checks for the path and files on a Unix server?
Related manuals
advertisement