Professional Documents
Culture Documents
Administration Guide
Version: 10.0.6
Publication Date: 2015-09
Automic Software GmbH
iiCopyright
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.
Automation Engine
iii
Contents
1 System Client 0000
2 Authorization System
2.1 Introduction
10
2.8 Passwords
11
11
11
14
14
14
15
15
15
25
3.1.3 UserInterface
27
UserInterface
27
Structure of uc4config.xml
27
UserInterface
31
UserInterface (Windows)
33
33
36
36
36
3.1.4 Agents
BS2000 Agent
36
36
37
42
iv
Contents
Database Agent
43
43
48
GCOS8 Agent
49
49
53
JMX Agent
54
Structure of UCXJJMX.INI
54
58
NSK Agent
58
59
64
OS/400 Agent
66
66
71
72
72
77
RA Agent
78
Structure of UCXJCITX.INI
78
82
SAP Agent
82
82
89
Siebel Agent
90
90
94
UNIX Agent
Structure of the INI File UCXJXXX.ini
Example of an INI File
VMS Agent
95
95
105
107
107
114
Windows Agent
115
Automation Engine
z/OS Agent
123
123
133
134
134
139
139
139
143
3.1.5 Utilities
143
AE DB Archive
143
AE DB Change
152
AE DB Client Copy
153
AE DB Load
157
AE DB Reorg
162
162
AE DB Reporting Tool
167
AE DB Revision Report
172
AE DB Unload
175
180
180
181
3.1.6 ServiceManager
ServiceManager - Service
182
182
182
184
184
186
187
3.1.7 CallAPI
Utility for BS2000
188
188
188
189
190
vi
Contents
190
191
191
191
192
192
192
194
194
194
195
196
196
196
197
198
198
199
199
199
201
201
201
202
203
203
204
RFC Server
204
204
207
207
207
210
210
Automation Engine
vii
210
212
213
214
215
215
227
227
228
238
239
242
242
3.2.14 UC_LOGIN_TYPES - Defining Additional Platform and System Types for Login
Objects
244
245
245
247
249
249
250
252
253
253
270
271
272
273
274
274
274
Notes
274
MS SQL Server
275
Notes
275
viii
Contents
Oracle
Notes
Oracle Parameters
276
276
277
301
301
302
4 Database
304
4.1 Overview
304
304
305
308
309
309
312
313
315
Procedure
319
319
319
319
5 Diagnostic Tools
321
5.1 Logging/Trace
321
5.2 LOG_DUMP
322
5.3 TRACE
323
5.4 TRACE_DUMP
325
328
328
330
332
335
335
339
339
350
Automation Engine
ix
350
Introduction
350
General Information
350
UserInterface
351
Requirements
352
Procedure
352
353
355
355
DB2
355
MS SQL Server
357
358
Procedure
358
ORACLE
Utilities
Installing Utilities (UNIX)
Procedure
Installing Utilities (Windows)
359
363
363
364
366
Supplied Files
366
Procedure
368
369
371
371
Requirements
371
Supplied Files
372
Procedure
372
Possible Problems
376
376
Requirements
376
Supplied Files
377
Procedure
377
See also:
378
378
380
Contents
380
385
Supplied Files
385
Procedure
386
Potential Problems
388
389
Help formats
389
Supplied Files
390
392
392
393
394
394
398
402
404
404
406
406
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with RMI Connector
407
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with SOAP Connector
410
414
416
417
421
422
424
425
428
429
431
431
434
441
Automation Engine
xi
444
450
454
455
458
458
459
461
465
Procedure
Installing the Agent for UNIX
Procedure
Installing the Agent for VMS
8.2.3 Special Feature: Logical Name for Agent
Procedure
8.2.4 Automatic Agent Start when Booting the Operating System
Installing the Agent for Windows
Procedure
Installing the Agent for z/OS
8.2.5 Load Module:
Procedure
Installing the ServiceManager
465
466
468
470
471
471
474
474
475
478
478
479
484
484
487
Supplied Files
487
Procedure
488
Potential Problems
489
490
See also:
490
490
490
492
493
494
xii
Contents
495
495
496
501
Supplied Files
501
Procedure
501
502
503
506
507
508
509
510
Supplied File
510
Procedure
511
Installation
514
514
515
516
517
518
E-mail Connection
519
Configuration
521
Cluster
521
521
523
Preparations
523
Configuring AE in a Cluster
523
528
528
529
General
529
Database
529
Settings
529
Automation Engine
xiii
Server
530
530
Auditing
530
User
530
531
531
532
8.3.3 Utilities
532
532
Requirements
533
Supplied Files
533
Procedure
534
535
Supplied Files
535
Procedure
536
537
538
538
Supplied Files
539
Procedure
539
540
Requirements
540
Supplied Files
540
541
541
Requirements
541
Supplied Files
541
Procedure
542
543
Supplied Files
544
Procedure
545
546
546
546
xiv
Contents
Requirements
546
547
548
Supplied Files
Installing the Agent for GCOS8
548
552
Requirements
552
Supplied Files
552
Procedure
552
555
555
555
557
557
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with RMI Connector
558
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with SOAP Connector
561
564
566
567
570
571
Requirements
571
Supplied Files
572
575
Requirements
575
Supplied Files
575
Method 1
577
Method 2
578
579
579
580
Procedure
Setting Up the Agent for Rapid Automation
581
581
Supplied Files
582
Procedure
582
Automation Engine
xv
584
Requirements(UNIX)
584
Supplied Files
584
Procedure
584
585
585
Procedure
586
586
Requirements
586
586
587
Requirements
587
588
590
590
Potential Problems
590
590
Procedure
590
591
Requirements
591
Supplied Files
591
Load Module:
591
595
595
Supplied Files
595
Steps
595
596
Supplied Files
596
597
597
598
598
600
602
xvi
Contents
603
604
609
613
613
613
614
615
9 ServiceManager
616
616
616
10 Start Parameters
621
621
623
624
10.4 ServiceManager
641
11 System Monitoring
646
646
647
12 Utilities
649
12.1 Utilities
649
12.2 AE DB Archive
649
12.2.1 AE DB Archive
649
656
659
Introduction
659
660
Filter
660
Procedure
661
662
663
665
12.3.1 AE DB Change
665
666
Automation Engine
xvii
670
670
674
674
676
676
682
682
684
686
689
691
691
692
694
12.9 AE DB Unload
12.9.1 AE DB Unload
12.10 AE.LogMix
12.10.1 Combining Report, Log and Trace Files
Glossary
696
696
697
697
700
.1 A
700
.2 B
701
.3 C
702
.4 D
702
.5 E
703
.6 F
703
.7 G
704
.8 H
704
.9 I
704
.10 J
704
.11 K
705
.12 L
705
.13 M
705
.14 N
705
xviii
Contents
.15 O
706
.16 P
706
.17 Q
707
.18 R
707
.19 S
709
.20 T
709
.21 U
710
.22 V
711
.23 W
712
.24 X
712
Automation Engine
The system client 0000 includes many system objects such as attribute dialogs, calendars, headers and
trailers for Jobs and variables. You use the variables to configure your AE system. Other important system
objects are the ERP_LOGIN that contains the central login information for SAP and PeopleSoft, and the
individual Agent objects.
Folder
Description
ATTRDIA
CODETABLE
CONNECTIONS
Connection objects
DIV_VARIABLES
Various variables
EX_VARIABLES
HEADER
HOLIDAY_CALE
HOST
HOST_VARIABLES
PREP_PROCESS
Event Jobs
RA_SOLUTIONS
RA Solution objects.
RESTART
STYLESHEETS
TEMPLATE
TRAILER
Do not move the supplied folders. All the supplied objects of system client 0000 will be deleted when
you update your system regardless of where they are stored in the folder structure. A new folder
structure will be created during the updating process that includes the supplied objects. This means
that you cannot permanently change this part of the folder structure.
The system client has a monitoring function. Therefore, you cannot run objects in it. It includes the
following additional functions that can be used to administer your AE system:
l
System Overview
The Users category contains all the AE system's users. This includes that you can process data
and interrupt sessions from one central point. The Client category is only available in the system
client.
Activity Window
This window lists the activities of all clients depending on the specified filters. For clarity reasons,
the Users column also contains the related client number.
Search
It is only in the system client that you can search for Server objects and Agent objects.
Selective Statistics
You can use this function's numerous settings in order to search for statistical records across
clients.
Note that searching and selecting Agent objects and Server objects will only be successful in the
system client.
If you delete or rename an object in the system client, the system will not check whether the affected
object is also used in other clients.
Automation Engine
2 Authorization System
2.1 Introduction
Within an AE system, various tasks are executed on a variety of systems. A well-functioning authorization
system is therefore extremely important. AE provides efficient functions which facilitate the creation of
your own authorization system.
Automic recommends planning your authorization structure thoroughly as this simplifies all the subsequent
assignment of rights. Use naming conventions from the very beginning. You can name objects and
folders by referring to the field of activity, operating system or department, for example.
Identify the people that should have authorization to access your AE system. In the next step you can
decide on who actually performs which activity. Only assign rights that are required. Based on your
findings you can group users in user groups, thereby reducing administrational work.
Agents are also part of the authorization system. Therefore, the first step following installation should be to
assign adequate rights to them.
Rights do not only influence objects. Particular functions in the UserInterface are also affected (e.g. the
System Overview). The application areas of AE Script also depend on them.
Start developing the structure of your authorization system immediately after installation and
before creating the first objects.
Write down areas to be administered by your AE system. As an AE system consists of individual
clients which are not connected to each other, large areas should be administered from extra
clients. Highly sensitive areas can so be excluded and access only be granted to particular users.
Agent rights are also defined on client level. You can decide for which client an agent is assigned
and for which activities it can be used.
Additional partial areas can be defined within clients. As rights are assigned via object names, a
coherent naming convention is extremely important. Administration becomes easier and the risk
of accidentally assigning too many rights can be minimized.
Vice-versa, users who have been assigned unlimited rights can access all functions. They can stop
processing, create or delete any number of objects or view all data listed in reports and statistics. Thus,
users with many or all rights can intervene in your system and in worst case, they could also misuse
their rights.
Automation Engine
Creating UserGroups
You can assign right to Users and UserGroups. By using UserGroups you can reduce your administrative
efforts. UserGroups provide a clear overview from a central point and also increase security within your AE
system.
2.
Assigning privileges
The various functions of the UserInterface can only be used with the appropriate privileges. With newly
created Users or UserGroups, all privileges are inactive.
Be careful when you assign privileges because some functions affect the processing of an AE system
or access security-relevant data.
A list of all privileges is provided in the UserGroup object's tab of the same name. Here you can activate all
or only specific particular privileges.
Privileges given to a particular user and the corresponding UserGroups accumulate. Users are granted
access to all the functions of the UserInterface that have been activated for them and the groups they
belong to.
For example:
User Smith is granted access to the Recycle Bin and to the Transport Case. Because he was granted the
privilege "Logon via CallAPI" in one of the user groups he belongs, he can also use CallAPIs.
3.
Assigning rights
Access to folders, statistics, reports and objects is subject to authorizations. Note that servers and agents
are also objects. Again, newly created Users and UserGroups do not have any rights.
Be careful when you assign authorizations. You can also define access denials!
Authorizations can be allocated in the UserGroup object's tab of the same name. Authorization groups or
denials (NOT) can be assigned in the very first column. Same numbers stand for the same authorization
group and the keyword NOT stands for a denial.
l
For the sake of completeness, this document also describe how you can use different authorization
groups. Nevertheless, Automic recommends using this functionality only in exceptional cases!
Denials
Denials ("Not") are always given preferential attention. If an access denial applies to a User or one
of the corresponding UserGroups, access to the particular section is not granted. The authorization
groups are irrelevant.
For example:
User Smith is authorized to execute Jobs on all hosts. One of the UserGroups he belongs to
contains a "Not" for accessing the agent UNIX01. Therefore, user Smith can not use this agent in
order to execute tasks.
Specify denials in the Authorizations tab with the authorization group "NOT".
4.
Creating Users
After having specified UserGroups, you can create your individual Users. User-object names are
composed of the user name and department, both of which are separated by a slash (such as
SMITH/DEV). A maximum of 200 characters is allowed.
Now fill in the User tab. You can also define that logging on is only allowed at a particular time of the day
(such as between 08:00 am and 06:00 pm).
Only active Users can log on to the AE system. You can set users active by checking the checkbox in the
upper right half of the UserInterface. Removing this flag sets them inactive.
5.
There are two ways of assigning Users to UserGroups. You can either select the groups to which a user
should belong to from within a user, or determine members from within a UserGroup. Both options are
accessible through the UserGroup tab.
6.
You can use the variable UC_CLIENT_SETTINGS to activate the Access Trace Function and decide
upon what it should cover. You can define the category of access monitoring that should be activated - log
on, object access, host access and/or privilege. Additionally, you can also specify whether access denials
and/or access authorizations should be logged to the security messages of the System Overview.
Automation Engine
Folders are objects and therefore, rights can be defined for them. Nevertheless, specifying folder rights
does not prevent access to objects stored in them. A user who is not allowed to access a particular
folder could still access an object in this folder (such as if it is used in a workflow. The command "Edit"
is available from almost anywhere, therefore, also in workflows). Objects that should not be accessed
by particular users should also be protected.
The following example refers to the above Explorer structure and shows how rights can be assigned and
explains the different effects:
Line 1: Users can access the folder "PRODUCTION" but not its corresponding subfolders.
Line 2: Users can - regardless of other authorizations that have been granted - not access the folder
"ADMIN" which is a subfolder of "STRUCTURE".
Line 3: Users can access the folder "STRUCTURE" including its subfolders, except for the subfolder
defined in line 2.
Line 4: Users have access rights to the folder "VARA" but not to its subfolders or to the folder "TEST".
Access to <No Folder>, the Recycle Bin, Transport Case and Version Management is granted through
privileges.
Automation Engine
Object authorizations are called using the Properties command from the File menu or Explorer's context
menu. Access is only granted to users who have a write permission (W) for the particular object.
On object level, you can only define access rights. These rights describe the functions that are available
for a particular user or all members of a user group. As soon as authorizations have been assigned to a
particular object, access is denied to all other users and user groups . At least one user or user group must
have write access to this object as otherwise, authorizations cannot be modified anymore. A dialog
informs about this requirement when authorizations are defined.
The access type can be selected or unselected using the space bar or the mouse button. Click Apply in
order to activate access rights immediately.
Table
column
Description
Access to statistics
10
Access to reports
Allows Service Orchestrator (SVO) users to define Automation Engine SLAs for objects
with the allowed object types.
Problems can arise if objects are transferred to other AE systems or clients which include individual
access rights that are defined in their properties. These transferred objects cannot be accessed unless
all specified users and user groups are also available in the new environment.
If an agent has not been assigned one or more rights, it cannot be selected in the particular objects:
FileTransfers and Jobs.
When assigning rights to Users and UserGroups, you can explicitly deny access to particular agents.
Automation Engine
11
2.8 Passwords
2.8.1 User Passwords
Security is important for every AE system and user passwords are part of this complex area.
The longer and more complex they are structured, the less likely they will be decoded. The criteria to be
adhered to when specifying a password are defined in the variable UC_CLIENT_SETTINGS.
Criteria
Setting
Maximum length
PWD_LENGTH_MAX
Minimum length
PWD_LENGTH_MIN
Numbers
PWD_CONTAINS_NUMBER
PWD_CONTAINS_LOWER_CASE
PWD_CONTAINS_UPPER_CASE
Special characters
PWD_CONTAINS_SPECIAL_CHARACTER
PWD_FORBID_LOGIN
Password history
PWD_GENERATION
PWD_AGE_MAX
PWD_ATTEMPTS_MAX
Special characters are characters other than A-Z, a-z and 0-9.
Special characters do not count as upper-case letters. For example, "a8eq9v1z3" is not a valid
password entry for a password that must contain upper-case characters.
Password criteria apply to AE Users but not to logins via the LDAP connection.
See also:
UC_CLIENT_SETTINGS
Encoding Passwords
Password Exit
12
A global setting activates the LDAP connection for an AE system. Whether a user is checked when
logging on either locally in the AE system or via the Active Directory depends on the settings made in the
particular User object. Thus, AE distinguishes local and LDAP users.
Procedure
First specify the connection data for your Active Directory.
1. Log on to system client 0000.
2. Switch to the folder "DIV_VARIABLES" and duplicate the variable UC_LDAP_EXAMPLE. There
are two methods for configuring the connection to your Active Directory:
l
Method A:Name the copy "UC_LDAP_Domain". If the domain name is "SMITH", the
Variable name must be "UC_LDAP_SMITH".
l
Method B:User object names are composed of name and department. The copy of the
variable can be renamed to "UC_LDAP_department". An extra variable is required for each
department. Using this method requires the domain to be specified in the key DOMAIN_
ALIAS.
3. Open the Variable and enter your connection data.
4. Store and close the Variable.
Now activate the LDAP connection for your AE system.
1. Open the variable UC_SYSTEM_SETTINGS and enter the value "Y" in the key "LDAP". This
global setting can be used to switch the LDAP connection on and off from one central point.
The LDAP connection is immediately active. No AE Server restart is required.
Activating the LDAP connection means that the AE system is ready to communicate with the Active
Directory. User objects have not yet changed. This is done by setting up the LDAP connection in User
objects:
1. Method A: The User object must have the same name as the User in the Active Directory. The
name is composed of the User name and the domain. For example, Mr. Smith uses the domain
"AE". He requires the User object "SMITH/AE". Create a new User object for yourself or rename
your existing one.
2. Open the User object and switch to the User tab.
3. Activate the checkbox "LDAP connection". The input fields whose contents should be checked by
the Active Directory are locked. The user is checked when the next login is made via LDAP
connection. The locked fields are filled with data from the Active Directory.
4. 4. You can test this using the button Synchronize data with LDAP now, but the synchronization
process only works if the operating user has already been synchronized via the LDAP connection.
This requires closing the UserInterface and logging on again.
Information stored in the User object is only updated while logging on or when using the button
Synchronize data with LDAP now. There is no automatic synchronization.
Note that the person who synchronizes the data of a User object with LDAP must also be an
LDAP user. Persons using method B can only synchronize users of the same department.
The Active Directory does not use the second e-mail address. It can be used if required.
Automation Engine
See also:
User
UC_LDAP_EXAMPLE
13
14
Chapter 3 Configuration
3 Configuration
3.1 Structure Of Configuration Files
3.1.1 Notes for Configuration-File Adjustments
Adjustments in INI files represent a significant intervention in the AE system and should therefore
exclusively be made by the administrator. Trace flags (activating program analysis) should only be used in
close cooperation with support and development staff.
All modifications made in INI files are only effective after program restart.Exception: No restart is
required for modifications made in the section [HOST] of the agents' INI files.
At least the parameters shown below must be supplied with values:
l
l
l
l
l
System name
Definition of server processes and assignment of port numbers
Names and port numbers of agents
Names of log, trace and message files
Variables entries
The entries must correspond to your system environment and reflect the requirements of the AE system to
be created. Some general notes are listed below. Additional notes in the documentation of the relevant INI
file is to be considered.
System Name
The system name identifies a complete AE environment. Automation Engines and agents of an AE
environment must use the same system name. It can consist of a maximum of 8 figures. Allowed are the
upper-case letters A to Z, numbers and "_".
If a new system name is used, it must also be modified in all relevant INI files (Automation Engines and
agents). End all running tasks (events, schedules, workflows etc.) before you start your modifications
because otherwise, these tasks will not continue after a system name modification.
Note that there is a peculiarity in using the z/OS agent in combination with SMF technique. The z/OS
Event Monitor converts the character "_" if used in the system name to "#".
Server Processes
AE automatically generates server process names. They consist of the following parts:
l
l
l
l
Example: UC4G#CP001
Automation Engine
15
Server processes including their process numbers are defined in the INI file of the Automation Engine. At
the same time, Server processes are assigned port numbers which must be clearly defined for the entire
AE system.
Agent Names
The agent name is limited to 32 of the following characters: "A-Z", "0-9", "_", ".", "$", "@", "-" and "#". It
can be defined in its INI file using the parameter name=. The host name is used instead if this parameter
remains undefined.
Database Access
If an INI file contains information about the connection to the database (section [ODBC]), the appropriate
password should be encoded. Find the description on how to install and use the particular program
UCYBCRYP.EXE in the document "Encoding Passwords".
Description
[GLOBAL]
system=
AE system name *)
The name can consist of a maximum of 8 characters. Allowed are the
upper-case letters A to Z, numbers and "_".
System names must not contain the character "_"if you use a z/OS
agent in combination with the SMF technique. By default, the job
Includes convert "_" to "#". Should you intend to use "_" despite of this
fact, you can bypass this situation by specifying the system name in
the Event Monitor with "#".
language=
The language in which the logging is processed. Entries for primary and
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no log in the primary language, the system searches for a log in
the secondary language.
16
Chapter 3 Configuration
logging=
logcount=
helplib=
helpcache=
StartMode=
snmp=
SNMP connection.
Allowed value: "0", "1", "2"
"0" = No SNMP connection.
"1" = SNMP connection is active.
"2" = SNMP connection is active. SNMP Traps are additionally logged in
the Windows Event Viewer.
An event is generated in the Winows Event Viewer's application log
(additionally to the trap) if the Automation Engine is interrupted (trap 3410).
This application log entry is even written if snmp=2 has been defined.
nodename=
Automation Engine
PrimaryMode=
17
exception=
SystemStop=
[CPMsgTypes]
srvquery=
[CACHE]
script=
vara=
mqmem=
The maximum cache size (in bytes) for the message queue.
[TRACE]
18
Chapter 3 Configuration
file=
trccount=
tcp/ip=
database=
trc03=
srcall=
memio=
jcl=
memsv=
snmp=
zuxml=
cache=
trc11=
ucds=
xscript=
uc4global=
trc15=
trc16=
[TCP/IP]
pwpport=
bindaddr=
bindlocal=
report=
The time interval in seconds in which the Automation Engine saves the
logging to the database.
Default value: 20 seconds
Automation Engine
connect=
19
chiffre=
retrywait=
The time intervals in seconds during which the server processes attempt
to get a free port number from the port list in [PORTS].
Format: (number, interval)
Default value: (3,10)
number = Maximum number of attempts that should be made in order to
obtain a free port from the port list.
interval = Waiting period in seconds between attempts.
retrywaitpwp=
hostname=
alivetimeout=
snmp=
The port number that the Automation Engine uses in order to connect to the
AE SNMPSubagent.
Ensure that the same port number is specified in the AE SNMP
Subagent's INI-file parameter stream_port=.
snmpreconnect=
The interval in seconds that the system needs in order to reconnect to the
AE SNMP Subagent after a connection loss.
Default value: 500 seconds
20
Chapter 3 Configuration
listenqueue=
maxMsgSize=
serverConnectionVerify=
This checks whether the TCP/IP connection with a partner has been
entered in the AE database table MQSRV and whether the IP address
specified in the database complies with this connection's IP address.
Deactivate this setting if you use computers that have several IP
addresses.
Allowed values: "0" (default), "1"
"0" = The TCP/IP connection and the IP address are not checked.
"1" =Activates the query.
NetArea=
tcp_nodelay=
This defines the use of the Naqgle algorithm for the connections of the
Automation Engine.
Allowed values: "0" (recommended default value) and "1"
"0" - This activates the Nagle algorithm.
"1" - This procedure is not used.
Set this parameter only in close cooperation with Automic Support.
tcp_keepalive_time=
The time interval in seconds in which keep-alive packets are sent in order
to keep connections.
The default value that depends on the system environment is used when
you do not define this setting or when you define the value 0.
Set this parameter only in close cooperation with Automic Support.
SendBufferSize=
The size of the TCP/IP input buffer for the messages that should be sent
(in bytes).
The default value that depends on the system environment is used when
you do not define this setting or when you define the value 0.
Set this parameter only in close cooperation with Automic Support.
Automation Engine
RecvBufferSize=
21
The size of the TCP/IP input buffer for the message that should be
received (in bytes).
The default value that depends on the system environment is used when
you do not define this setting or when you define the value 0.
Set this parameter only in close cooperation with Automic Support.
[PORTS]
cp1= ... cpn=
[ODBC]
22
Chapter 3 Configuration
Automation Engine
[DB_SERVICE]
23
This section contains specific parameters for the database agent which
starts in the mode for resolving Variables. The agent's installation guide
describes how the agent can be started.
The parameter logging= can be used to specify the path and name of
the log files for agent and server processes. Also refer to the specific
notes which are provided in the section [GLOBAL].
Note that this INI file can only be used for database agents. Copy this
configuration file in order to use several database agents for Variables.
name=
tcp/ip=
InitialPackage=
KeyStore=
Path and name of the file that contains information about the authentication
package (see InitialPackage=).
connect=
retention_time=
retry=
24
Chapter 3 Configuration
OPTIMIZE=
Automation Engine
Example of an INI File
[GLOBAL]
system=UC4
language=(E,D)
logging=..\TEMP\$$srv_log_*_##.txt
logcount=10
helplib=uc.msl
helpcache=ALL
StartMode=NORMAL
snmp=1
nodename=UC4_1
PrimaryMode=0
exception=1
SystemStop=NORMAL
[CPMsgTypes]
srvquery=0
[CACHE]
script=1000000
vara=100000
mqmem=1000000
[TRACE]
file=..\TEMP\$$srv_trc_*_##.txt
trccount=10
tcp/ip=
database=
trc03=
srcall=
memio=
jcl=
memsv=
snmp=
zuxml=
cache=
trc11=
ucds=
xscript=
uc4global=
trc15=
trc16=
[TCP/IP]
pwpport=2270
report=20
connect=120
retrywait=(5,60)
retrywaitpwp=(5,60)
alivetimeout=600
snmp=2200
25
26
Chapter 3 Configuration
snmpreconnect=500
listenqueue=2030
[PORTS]
cp1=2217
cp2=2218
wp1=2271
wp2=2272
wp3=2273
wp4=2274
wp5=2275
wp6=2276
wp7=2277
wp8=2278
wp9=2279
[ODBC]
; ODBCVAR xxxxxxxx
;
|||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
Z=DB2/OS390
;
||||||+- R=compress messages and local memory
;
|||||+-- O = with userid, N = without userid
;
||||+--- I=OCI/CLI N=ODBC
;
|||+---- not used
;
||+----- J = compare fieldnames case-insensitiv (in case of
ORACLE !!)
;
|+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
;
+------- S = use Server-Cursor (SQL-SERVER)
;
;
SNNNNNRN for SQL-Server 2000
;
NNNNNNRN for SQL-Server 2005
;
NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
;
NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)
;
NNJNIORZ for DB2/OS390 (7.1) with CLI (Call Level Interface)
; SQL-Server 2000 with ODBC
SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; SQL-Server 2005 with MARS
;SQLDRIVERCONNECT=ODBCVAR=NNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4;Mars_
Connection=Yes
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4
[DB_SERVICE]
name=SQLVAR_01
InitialPackage=
KeyStore=
connect=60
Automation Engine
27
retention_time=60
retry=3
See also:
Notes for Configuration-File Adjustments
3.1.3 UserInterface
UserInterface
The configuration file uc4config.xml is provided by default. It is stored in the same folder as the
UserInterface. You can also enter the path of an alternative configuration file by using the start parameter -I
in the INI file. Therefore, all users can create their own uc4config.xml with all their preferred personal
settings.
Environment variables can also be used in path specifications. Insert the following placeholders:
Windows: %Variable%
UNIX: $(Variable)
The UserInterface replaces the placeholders by the environment variable's value.
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Structure of uc4config.xml
Parameter
Description
<configuration>
<paths>
<docu
type="
format">path</docu>
<browser
type="
name
">path</browser>
28
Chapter 3 Configuration
<logging
count="count">log
file</logging>
<trace count="count"
xml="xml trace"
tcp="TCP/IP trace"
ra="rapid automation
trace">tracefile</trace>
Automation Engine
<SendBufferSize>
count
</SendBufferSize>
29
Maximum number of bytes per block that the UserInterface sends to the
Automation Engine.
"Number" = Maximum block size in bytes
Default value: 1048576
<RecvBufferSize>
count
</RecvBufferSize>
Maximum number of bytes per block that the UserInterface receives from the
Automation Engine.
"Number" = Maximum block size in bytes
Default value: 1048576
<tcp_
nodelay>value</tcp_
nodelay>
Nagle algorithm usage for the connection between the UserInterface and the
AutomationEngine.
</paths>
<colors>
<color r="red
saturation" g="green
saturation" b="blue
saturation"/>
Color definition
This is used to visualize the connection to a client in the UserInterface
(colored line underneath the title bars of windows).
A value between 0 and 255 can be assigned for the colored parts.
Note that a maximum of 8 connections per UserInterface instance is
supported. Therefore, Automic recommends defining8 colors because
each connection is represented by a color.
</colors>
<timeout>
duration</timeout>
<tcpip_
keepalive>connection
receipt</tcpip_
keepalive>
<active_
keepalive>time
interval<active_
keepalive>
<connections>
30
Chapter 3 Configuration
<connection
name="name"
system="system">
<cp ip="DNS/IP"
port="port"/>
</connection>
</connections>
</configuration>
Example of uc4config.xml
<configuration>
<paths>
<docu type="hh">C:\AUTOMIC\Documentation</docu>
<logging count="10">..\temp\UCDJ_LOG_##.TXT</logging>
<trace count="10" xml="0" tcp="0" ra="9">..\temp\UCDJ_TRC_
##.TXT</trace>
</paths>
<colors>
<color b="0" g="0" r="255"/>
<color b="0" g="255" r="0"/>
<color b="255" g="152" r="42"/>
<color b="0" g="255" r="255"/>
<color b="0" g="144" r="255"/>
<color b="255" g="0" r="255"/>
<color b="255" g="255" r="255"/>
<color b="149" g="140" r="170"/>
</colors>
<timeout>60</timeout>
<tcpip_keepalive>0</tcpip_keepalive>
<connections>
<connection name="AE Production" system="AE">
<cp ip="uc4prod" port="2217"/>
</connection>
<connection name="AE Test" system="AET">
<cp ip="testsys" port="2217"/>
</connection>
</connections>
</configuration>
Automation Engine
31
UserInterface
The configuration file login_dat.xml includes general login settings. Having successfully installed the
UserInterface, the system provides a default template from which you can create the templates for the
individual users. This is done when a user logs on to the AE system for the very first time. The values that
are stored in an individual template (including changed settings such as the language or the appearance of
the UserInterfaces) are then used as the particular user's default values and are stored whenever s/he logs
off.
Note that it is not required to adjust the configuration file manually because the individual values are
supplied by the AE system.
You can also specify the path to the file login_dat.xml by using the start parameter -O.
Structure of login_dat.xml
Section/Parameter
Description
<login>
<default>
Beginning of the elements for the default values that are used for logging
on to the AE system for the first time.
An XML element must be available.
<login src="adm">
<system>
system</system>
Alias for the connection to the AE system. This entry is specified in the
file uc4config.xml, parameter <connection name= ....
An XML element must be available.
<client>n</client>
Client number.
XML element must be available.
Allowed values: 0 - 9999
<name>name</name>
User name.
An XML element must be available.
<department>
department</department>
User department.
An XML element must be available.
<language>
language</language>
32
Chapter 3 Configuration
<clientvers>v
ersion</clientvers>
AE system version.
XML element must be available.
<os/>
Operating system.
An XML element must be available.
<hostname>
localhost</hostname>
<color>color:r,g,b</color>
The color definition for visualizing this connection to the client of the AE
system.
r = value between 0 and 255, red color segment
b = value between 0 and 255, blue colo r segment
</default>
<username-Template>
:
:
</username-Template>
</login>
Automation Engine
33
Example of login_dat.xml
<login>
<default>
<login src="adm">
<system>UC4</system>
<client>0</client>
<name>UC</name>
<department>UC</department>
<passw/>
<language>D</language>
<clienttype>D</clienttype>
<clientvers>10.0.0</clientvers>
<os/>
<hostname>dialogpc</hostname>
<color>color:255,255,0</color>
<laf>com.uc4.plaf.uc4.UC4LookAndFeel</laf>
</login>
</default>
<smith-Template>
<login src="adm">
<system>UC4</system>
<client>97</client>
<name>SMITH</name>
<department>UC4</department>
<passw/>
<language>E</language>
<clienttype>D</clienttype>
<clientvers>3.2B</clientvers>
<os/>
<hostname>dialogpc</hostname>
<color>color:42,152,255</color>
</login>
</smith-Template>
</login>
UserInterface (Windows)
You use the UCDJ.INIfile to specify call options to start the UserInterface and the UCDJ.BATfile to call
Java for the UserInterface.
Environment variables can now also be used in path specifications. Insert the following placeholders:
Windows: %Variable%
UNIX: $Variable
The UserInterface then replaces the placeholder with the environment variable's value.
Description
34
Chapter 3 Configuration
cmd=
path=
title=
This parameter serves internal purpose in the UserInterface. The value must
not be changed.
affinity=
Automation Engine
affinityaction=
35
[ENVIRONMENT]
classpath=
Path and file name of the Jar files in the UserInterface and Java functions
library.
JAVA_OPTIONS=
By default these variables are empty. This is done to clear their values and
avoid Java Tools that hook the JVM.
JAVA_TOOL_
OPTIONS=
[SPLASH]
sound=
Name of the WAV file to be played during UserInterface start (Splash screen).
36
Chapter 3 Configuration
[ENVIRONMENT]
classpath=.;.\ucdj.jar.;.\psjoa.jar.;.\ucsjds84.jar
JAVA_OPTIONS=
JAVA_TOOL_OPTIONS=
[SPLASH]
sound=uc4.wav
Description
set JAVA_OPTIONS=
By default these variables are empty. This is done to clear their values and
avoid Java Tools that hook the JVM.
set JAVA_TOOL_
OPTIONS=
set JAVA_TOOL_
OPTIONS=
java
3.1.4 Agents
BS2000 Agent
See also: Notes for Configuration-File Adjustments
Automation Engine
37
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
(GLOBAL)
SYSTEM=
NAME=
LOGGING=
LOGCOUNT=
LANGUAGE=
Language that should be used for the logging. You can specify a primary
and a secondary language.
Allowed values: E, D, F
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, the system searches for a
message in the secondary language.
LICENCE_CLASS=
License class that corresponds to the acquired license and the hardware
and software that is used.
Allowed values: "1" to "9"
"1" to "9" = Agent's license class
JOINREAD=
38
Chapter 3 Configuration
USERID_TYPE=
ft_temp_file=
FileProcessingTimeout=
Automation Engine
InitialPackage=
39
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the companykey file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file
ending *.kstr) or the path of the agent's INIfile. If you define a file name,
the ending *.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You
must not delete, rename or move it subsequently. Regardless of the
authentication method that you use, any attempt to log in will fail if the
agent cannot find this file when it starts. In this case, you must open the
menu item "Renew transfer key" in the affected agent's System Overview.
(USERID)
(VARIABLES)
This section contains the Agent Variables with agent information and
settings.
(TRACE)
FILE=
TRCCOUNT=
TCP/IP=
FILETRANSFER=
UCON=
RFC=
MEMORY=
(TCP/IP)
PORT=
40
Chapter 3 Configuration
BINDADDR=
BINDLOCAL=
CONNECT=
REPORT=
Time interval in seconds in which the agent sends the logging to the
Automation Engine.
Default value: 60 seconds
CONNWAIT=
Time interval in seconds during which the agent waits for a response from
the communication partner (CP or another agent). If the time limit is
exceeded, the connection to the communication partner will be terminated
again.
Default value: 20 seconds
CP=
MAXMSGSIZE=
Automation Engine
(HOSTS)
41
(RFC)
LOGON=
PORT=
Port number that the RFC task uses to establish the connection to the
agent.
TIMEOUT=
ENTERPAR=
TASKTIMEOUT=
(CP_LIST)
42
Chapter 3 Configuration
(AUTHORIZATION)
InitialPackage=
KeyStore=
(USERID)
TSOS=NO_START
(VARIABLES)
UC_HOST_CODE=BS2000_INTERNATIONAL
UC_HOST_JCL_VAR=BS2000
UC_EX_PATH_BIN=$UC4.UCX24.LIB
UC_EX_PATH_TEMP=$UC4.TEMP.
UC_EX_PATH_JOBREPORT=$UC4.JOB.REPORT.
UC_EX_JOB_MD=*MOD(LIBRARY=$UC4.UCX24.LIB,ELEMENT=UCXJB24M,RUNMODE=*ADVANCED)
(TRACE)
FILE=$UC4.L.TRACE.UCXJBXX.##
TRCCOUNT=10
TCP/IP=0
FILETRANSFER=0
UCON=0
RFC=0
(TCP/IP)
PORT=2300
CONNECT=120
REPORT=60
CONNWAIT=20
CP=PC01:2217
(HOSTS)
; <AE-NAME>=<DNS-NAME> OR
; <AE-NAME>=<IP-ADDR>
(RFC)
Automation Engine
43
LOGON=0
PORT=2400
TIMEOUT=90
ENTERPAR=,JOB-PRIORITY=8,START=*STD,RESOURCES=*PAR(RUN-PRIORITY=248)
TASKTIMEOUT=900
(CP_LIST)
2218=PC01
Database Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
name=
system=
language=
Language that is used to log on. Entries for primary and secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary: English, secondary: German)
If there is no message in the primary language, a message in the secondary
language is searched for.
logging=
logcount=
44
Chapter 3 Configuration
LogMaxSize=
max_logging_kb=
log_to_file=
helplib=
[AUTHORIZATION]
InitialPackage=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the companykey file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
Automation Engine
KeyStore=
45
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file
ending *.kstr) or the path of the agent's INIfile. If you define a file name, the
ending *.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You
must not delete, rename or move it subsequently. Regardless of the
authentication method that you use, any attempt to log in will fail if the agent
cannot find this file when it starts. In this case, you must open the menu
item "Renew transfer key" in the affected agent's System Overview.
Java agents (SAP, RA, database and JMX) that run under UNIX create a
keystore file with the following right: "-rw-r--r". In doing so, other OS
users can also access this file.
[TRACE]
file=
trccount=
TraceMaxSize=
tcp/ip=
[TCP/IP]
bindaddr=
46
Chapter 3 Configuration
connect=
cp=
[ORACLE]
enable_output=
buffer_size=
Buffer size in bytes for the outputs that should be written to the job report.
Default value: 8000
vsession_machine=
Determines the value that the agent returns if a SELECT is made to the
MACHINE column of the V$SESSION view.
The MACHINE column is defined as VARCHAR2(64). To define a shorter
value, you can use this parameter.
This setting is only relevant if you use the Avaloq Agent.
[SQL]
connect=
Time interval in seconds during which the job tries to establish a connection
to the database.
retention_time=
type=
Database type.
Allowed values: "MSSQL", "ORACLE", "DB2", "MYSQL",
"INFORMIX","INGRES","HANA" and "SYBASE"
retry=
Automation Engine
newline=
47
useOraClient=
WindowsAuthentication= The Windows user under which the agent has started is used to log on to MS
SQL databases.
Allowed values:"0" (default) and "1"
"0"- SQL Server authentication: Login data used to log on to the database is
retrieved from the Login objects that are used in Database Jobs.
"1" - Windows authentication: The Windows login of the OS user under
which the agent runs is used.
Requirements:
l
l
l
If you install the JDBC driver, you must also copy the file "sqljdbc_
auth.dll" to the database agent's BIN directory. This file's architecture
must comply with the architecture of the Java Virtual Machine that is
used. For example: If you start the agent using a JVM with an x64
architecture, the DLL must also be an x64 file.
In Database Jobs, you must specify a Login object that includes a
suitable entry for the particular agent even if you use the Windows
authentication. The Login object's user and password are neither used
nor checked.
[VARIABLES]
This section contains Agent Variables with agent information and settings.
[CP_LIST]
48
Chapter 3 Configuration
[AUTHORIZATION]
InitialPackage=
KeyStore=
[TRACE]
file=temp/UCXJSQLX_TRACE_##.TXT
trccount=10
max_trace_kb=1000
tcp/ip=0
[TCP/IP]
connect=60
cp=PC01:2217
[ORACLE]
enable_output=1
buffer_size=8000
[SQL]
connect=60
retention_time=60
type=MSSQL
retry=3
newline=1
useOraClient=0
[VARIABLES]
UC_HOST_JCL_VAR=SQL
UC_EX_PATH_JOBREPORT=temp
[CP_LIST]
2218=PC01
See also:
Automation Engine
49
GCOS8 Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
name=
system=
AE system name.
This entry must be identical to the entry in the INI file of the Automation
Engine.
logging=
logcount=
helplib=
licence_class=
License class that complies with the acquired license and the hard and
software that is used.
Allowed values: "1" to "9"
"1" to "9" = Agent's license class
language=
Language that should be used for the logging. You can specify a primary and a
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, the system searches for a
message in the secondary language.
userid_type=
50
Chapter 3 Configuration
RSM=
RSM8 must be installed in order to enable job report transfers to AE. If this
program is not available, the parameter RSM= should be used to avoid
that Jobs remain stuck. Without the use of RSM8, files containing some
basic information are created with the name of the job report.
Allowed values: "N" and "X"
"N" - A file is stored in the OUT catalog.
"X" - The first character of the job report's name is replaced by the letter "X".
The file is then stored in the OUT catalog.
Do not specify this parameter RSM= if RSM8 is used.
active_jobreport_
count=
Maximum number of job reports that can be sent to the Automation Engine at
the same time.
Default value: "10"
ft_temp_file=
[AUTHORIZATION]
InitialPackage=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INIfile. If you define a file name, the ending
*.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You must
not delete, rename or move it subsequently. Regardless of the authentication
method that you use, any attempt to log in will fail if the agent cannot find this
file when it starts. In this case, you must open the menu item "Renew transfer
key" in the affected agent's System Overview.
[USERID]
Automation Engine
[VARIABLES]
This section contains the Agent Variables with agent information and
settings.
SNUMB_SUFFIX=
Character that should be appended to the job's sequence number if the user
did not specify it in the Job object.
51
[MISC]
TRCOPENCLOSE=
[HOSTS]
[TRACE]
file=
trccount=
tcp/ip=
filetransfer=
job=
event=
variable=
controlflow=
message=
dump=
misc=
msgconv=
[TCP/IP]
connwait=
Time interval in seconds during which the agent waits for a response from its
communication partner (CP or another agent). If this time limit is exceeded,
the connection to the communication partner is disconnected.
Default: 10 seconds
52
Chapter 3 Configuration
port=
connect=
report=
Time interval in seconds in which the agent sends the logging to the
Automation Engine.
cp=
job_check_count=
Number of periodical job checks that the agent should wait when the job ends.
Only then the job is reported as vanished (ENDED_VANISHED status).
Allowed values: "0" - "32767"
Default value: "3"
"0" - The agent does not use this parameter.
[CP_LIST]
Automation Engine
Example of an INI File
[GLOBAL]
system=uc4
name=GCOS8
logcount=4
logging=<catalog>/TMP/LOG##
language=(E,D)
helplib=<catalog>/bin/UCMSL
licence_class=1
; USERID Type = INCL/EXCL
userid_type=EXCL
ft_temp_file=yes
[AUTHORIZATION]
InitialPackage=
KeyStore=
[USERID]
;AUSTRIA=NO_START
[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=GCOS8
UC_EX_PATH_BIN=<catalog>/bin
UC_EX_PATH_TEMP=<catalog>/tmp/
UC_EX_PATH_JOBREPORT=<catalog>/out/
UC_EX_JOB_MD=<catalog>/build/UCXJGC8M
[HOSTS]
; <AE-name>=<dns-name> or
; <AE-name>=<ip-addr>
[TRACE]
; DON'T REMOVE THE TRACE FLAGS !!!
file=<catalog>/TMP/TRC##
trccount=4
tcp/ip=9
filetransfer=9
job=9
event=9
variable=9
controlflow=9
message=9
dump=9
misc=9
msgconv=0
[TCP/IP]
53
54
Chapter 3 Configuration
[CP_LIST]
2218=PC01
See also:
Notes for Configuration-File Adjustments
JMX Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.
Structure of UCXJJMX.INI
Section/Parameter
Description
[GLOBAL]
name=
system=
AE system name
This entry must be identical to the Automation Engine's INI-file entry.
language=
logging=
logcount=
max_logging_kb=
helplib=
logToFile=
Automation Engine
loadOnStartup=
55
[AUTHORIZATION]
InitialPackage=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INIfile. If you define a file name, the ending
*.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You must
not delete, rename or move it subsequently. Regardless of the authentication
method that you use, any attempt to log in will fail if the agent cannot find this
file when it starts. In this case, you must open the menu item "Renew transfer
key" in the affected agent's System Overview.
Java agents (SAP, RA, database and JMX) that run under UNIX create a
keystore file with the following right: "-rw-r--r". In doing so, other OS
users can also access this file.
[JMX]
type=
search_all=
56
Chapter 3 Configuration
[WEBSPHERE]
soapTimeout=
Use this parameter to specify the seconds to wait for an MBean call
response. The job aborts if this time span is exceeded.
The agent uses WebSphere's default value if no value or "0" has been
specified.
[TRACE]
file=
trccount=
max_trace_kb=
tcp/ip=
[TCP/IP]
bindaddr=
connect=
cp=
[VARIABLES]
This section contains Agent Variables with agent information and settings.
Automation Engine
[CP_LIST]
57
58
Chapter 3 Configuration
[AUTHORIZATION]
InitialPackage=
KeyStore=
[JMX]
type=
search_all=0
[TRACE]
file=../temp/UCXJJMX_TRACE_##.TXT
trccount=10
max_trace_kb=1000
tcp/ip=0
[TCP/IP]
connect=60
cp=PC01:2217
[VARIABLES]
UC_HOST_JCL_VAR=JMX
UC_EX_PATH_JOBREPORT=.
[CP_LIST]
2218=PC01
See also:
Notes for Configuration-File Adjustments
NSK Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Automation Engine
59
Description
[MISC]
The parameters that are included in this section are required for internal
purposes in the agent. Values must not be changed.
[HOSTS]
[GLOBAL]
system=
name=
logcount=
logging=
Log-file name.
The number signs serve as placeholders for a series in numerical order. When
the agent starts, the log files are renamed and the most current log file is
always the one with number "00".
language=
Language that should be used for the logging. You can specify a primary and a
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, the system searches for a
message in the secondary language.
helplib=
licence_class=
License class that corresponds to the acquired license and the hardware and
software that is used.
Allowed values: "1" to "9"
"1" to "9" = The agent's license class.
60
Chapter 3 Configuration
vhterm=
user_vterm=
The setting user_vterm can be overruled in the Job object and in the script
by using attributes.
Preferably, the virtual terminal "user_vterm" is defined in the NSK job. You
can enter it directly in the Job object or specify it in the script using the
attribute HOME_TERMINAL. An error occurs if the virtual terminal does
neither exist in the job nor in the INI file.
UC4_MACRO_FILE=
NSK-file name (fully qualified) of the file including TACL macros that are
supplied with the AE CD (usually the file name is UC4MACS; the volume and
subvolume are installation-specific).
TACL_TIME_TO_
LIVE=
Time (in 1/100 seconds) that a TACL process that has been started by the
agent is kept available for reuse.
Specifying a value that is too high can result in many TACL processes
that remain in the system and are never used again. If the value is too low,
many job starts cause individual TACL starts which increases system
load. Automic recommends using the value 90000 (15 minutes).
COLLECTOR=
NSK process name of the AE Output Collector process. This name must be
clearly identified throughout the system and must be available at any time.
Recommendation: $UC4OC
COLLECTOR_
PARAMS=
Leave this field blank because it is only relevant for diagnostic purposes.
CPU_MASK=
TACL_TIME_
RESERVED=
Time (in 1/100 seconds) that a TACL that has been started by the agent can
require to start a job process. An error message is sent and the job is
canceled if this period of time is exceeded.
COLLECTOR_PRIO=
COLLECTOR_CPU=
CPU of the Output Collector. Another CPU than the agent's should be
selected here. This increases the system's fault tolerance. The Output
Collector and the agent mutually monitor themselves. If one of the processes
fails (even if this happened because of a CPU failure, for example), the other
one automatically restarts the troubled process (if EXECUTOR_RESTART is
set).
EXECUTOR_
RESTART=
DEFAULT_USER_
FETCH_INTERVAL=
Interval (in seconds) after which the erroneous attempt of logging on to the
default user is repeated by the Server.
Automation Engine
MAX_OPEN_TABLE_
SIZE=
61
The number of files that jobs can open at the same time.
Allowed values: "0" to "32767"
Default value: 21000
This limitation serves to avoid problems that can occur if jobs open files but
do not close them because of an error in their JCL.
MAX_OPENS_PER_
JOBS=
The number of files that an individual job can open at the same time.
Allowed values: "0" to "32767"
Default value: 1000
This limitation serves to avoid problems that c can occur if jobs open files but
do not close them because of an error in their JCL.
ft_temp_file=
ft_temp_file_oss=
tcp_nodelay=
Nagle algorithm usage for file transfers and all the agent's other sockets.
Allowed values: yes (default value) and no
no = Activates the Nagle algorithm.
yes = This procedure is not applied.
Activating the Nagle algorithm can improve the performance of file transfers,
especially if you transfer many small files.
The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.
Note that this parameter should only be set in close cooperation with Automic
Support!
TACL=
Use this parameter in order to specify the TACL Executable that should be
used. The standard TACL environment is used if this parameter is missing or
if no parameter has been specified.
JOBFILE_SEC=
62
Chapter 3 Configuration
CHECK_PW_
ALWAYS=
[AUTHORIZATION]
InitialPackage=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INIfile. If you define a file name, the ending
*.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You must
not delete, rename or move it subsequently. Regardless of the authentication
method that you use, any attempt to log in will fail if the agent cannot find this
file when it starts. In this case, you must open the menu item "Renew transfer
key" in the affected agent's System Overview.
[VARIABLES]
[TRACE]
file=
This section contains Agent Variables with agent information and settings.
Trace files are limited to 200MB. The agent creates a new file if this value
has been reached.
Name of the trace file.
The number signs serve as place holders for a series in numerical order.
When a trace is started, files are renamed and the most current trace file is
always the one with the number "00".
trccount=
tcp/ip=
filetransfer=
job=
event=
controlflow=
message=
dump=
misc=
msgconv=
[TCP/IP]
Automation Engine
connwait=
Time interval in seconds during which the agent waits for a response from its
communication partner (CP or another agent). If this time limit is exceeded,
the connection to the communication partner is disconnected.
Default: 30 seconds
port=
bindaddr=
bindlocal=
connect=
report=
Time interval in seconds in which the agent sends the logging to the
Automation Engine.
Default value: 60 seconds
cp=
buffersize=
63
64
Chapter 3 Configuration
tcp_nodelay=
Nagle algorithm usage for file transfers and all the agent's other sockets.
Allowed values: yes (default value) and no
no = Activates the Nagle algorithm.
yes = This procedure is not applied.
Activating the Nagle algorithm can improve the performance of file transfers,
especially if you transfer many small files.
The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.
Note that this parameter should only be set in close cooperation with Automic
Support!
tcp_keepalive=
[CP_LIST]
[FT-STATUS-STORE]
FILENAME=
DETAIL-FILENAME=
LOG-FILENAME=
HEAD-FILENAME=
Automation Engine
CPU_MASK=11111111111111111
MAX_OPENS_TABLE_SIZE=21000
MAX_OPENS_PER_JOBS=1000
ft_temp_file=yes
ft_temp_file_oss=no
TACL=$DATA01.SYSTEM.TACL
JOBFILE_SEC=JNNNN
[AUTHORIZATION]
InitialPackage=
KeyStore=
[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=NSK
UC_EX_PATH_BIN=$system.uc4
UC_EX_PATH_TEMP=$system.uc4tmp.
UC_EX_PATH_JOBREPORT=$system.uc4tmp.
[TRACE]
file=TRACA##
trccount=10
tcp/ip=0
filetransfer=0
job=0
event=0
controlflow=0
message=0
dump=0
misc=0
msgconv=0
[TCP/IP]
connwait=30
; agent's listen port
port=2300
; try all n seconds to connect to server
connect=30
report=60
cp=PC01:2217
buffersize=33000
[CP_LIST]
2218=PC01
[FT-STATUS-STORE]
FILENAME=$DATA02.UC4V9.UC4F6SST
DETAIL-FILENAME=$DATA02.UC4V9.UC4F6SSD
LOG-FILENAME=$DATA02.UC4V9.UC4F6SSL
HEAD-FILENAME=$DATA02.UC4V9.UC4F6SSH
See also:
Notes for Configuration-File Adjustments
65
66
Chapter 3 Configuration
OS/400 Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment re written in red letters.
Description
(GLOBAL)
SYSTEM=
NAME=
CheckLogon=
logcount=
logging=
language=
The language that should be used for the logging. You can specify a primary
and a secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, the system searches for a
message in the secondary language.
helplib=
LICENCE_CLASS=
The license class that corresponds to the acquired license and the hard and
software that is used.
Allowed values: "1" to "9"
"1" to "9" = License class for the agent.
Automation Engine
spool=
dqname=
67
Default: "DQ"
If several instances of an agent are run from the same library, a data queue
name must be provided for each instance. If this entry is deactivated in the
INI file, the agent sets the data queue name in the form "DQ######" (######
= 6 figure job number).
SBMJOB=
You can specify here whether the submitted job is written to the log file.
Allowed values: "0" and "1" (default value)
"0" - The submitted job is not written to the log file.
"1" - The lines of the submitted job are written to the log file.
SBMMSK=
console=
The name of the message queue that should be monitored with a "Console"
Event type.
userid_type=
ft_temp_file_ifs=
tcp_nodelay=
Nagle algorithm usage for file transfers and all the agent's other sockets.
Allowed values: yes (default value) and no
no = Activates the Nagle algorithm.
yes = This procedure is not applied.
Activating the Nagle algorithm can improve the performance of file transfers,
especially if you transfer many small files.
The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.
Note that this parameter should only be set in close cooperation with Automic
Support!
68
Chapter 3 Configuration
store_type=
You use this parameter to determine the locations where the status store files
of file transfers should be stored.
Allowed values: "QSYS" (default) or "IFS"
"QSYS" - The status store files are directly stored as user space objects in
the agent library.
"IFS" - The status store files are written to the IFS directory that is defined in
the agent variable UC_EX_PATH_TEMP_IFS.
(AUTHORIZATION)
InitialPackage=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INIfile. If you define a file name, the ending
*.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You must
not delete, rename or move it subsequently. Regardless of the authentication
method that you use, any attempt to log in will fail if the agent cannot find this
file when it starts. In this case, you must open the menu item "Renew transfer
key" in the affected agent's System Overview.
(USERID)
(VARIABLES)
This section contains the agent variables which include agent settings and
information.
(TRACE)
file=
trccount=
Automation Engine
tcp/ip=
filetransfer=
job=
event=
CONTROLFLOW=
VARIABLE=
MESSAGE=
DUMP=
MISCELLANEOUS=
memory=
69
(TCP/IP)
port=
bindaddr=
bindlocal=
connect=
The time interval in seconds in which the agent tries to establish connection
to the Automation Engines. This affects the connection setup for a restart or
after a lost connection.
Default: 120 seconds
This parameter is only effective until the first successful logon to the AE
system. Afterwards, you can use the parameter RECONNECT_TIME in
the Host characteristics for this purpose.
maxrepcnt=
maxMsgSize=
SendBufferSize=
The size of the TCP/IP input buffer for messages that should be sent (Byte).
Default value: 1048576 Byte
70
Chapter 3 Configuration
RecvBufferSize=
The size of the TCP/IP input buffer for messages that should be received
(Byte).
Default value: 1048576 Byte
CP=
(HOSTS)
(CP_LIST)
Automation Engine
Example of an INI File
(GLOBAL)
SYSTEM=UC4
NAME=AS400
CheckLogon=1
logcount=10
logging=UC4/TMP(UCXJ_LOG##)
language=(E,D)
helplib=UC4/MSL
LICENCE_CLASS=9
spool=delete
dqname=DQ
console=QSYS/QSYSOPR
userid_type=EXCL
ft_temp_file_ifs=yes
(AUTHORIZATION)
InitialPackage=
KeyStore=
(USERID)
; MEIER=NO_START
(VARIABLES)
UC_HOST_CODE=EBCDIC_00273
UC_HOST_JCL_VAR=OS400
UC_EX_PATH_BIN=UC4
UC_EX_PATH_TEMP=UC4/TMP
UC_EX_PATH_JOBREPORT=UC4/TMP
UC_EX_JOB_MD=UC4/UCXJO41M
(HOSTS)
; <AE-name>=<dns-name> or
; <AE-name>=<ip-addr>
(TRACE)
file=UC4/TMP(UCXJ_TRC##)
trccount=10
tcp/ip=0
filetransfer=0
job=0
event=0
CONTROLFLOW=0
VARIABLE=0
MESSAGE=0
DUMP=0
MISCELLANEOUS=0
(TCP/IP)
71
72
Chapter 3 Configuration
port=2300
connect=120
maxrepcnt=8
CP=PC01:2217
(CP_LIST)
2218=PC01
See also:
Notes for Configuration-File Adjustments
Description
[GLOBAL]
name=
system=
language=
Language that should be used for the logging. You can specify a primary and a
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, the system searches for a
message in the secondary language.
logging=
logcount=
helplib=
Automation Engine
helpcache=
73
userid_type=
You can use this option to allow or reject certain Operator IDs.
Allowed values: INCL, EXCL
"INCL" = Access must be allowed under [USERID] for each individual
Operator ID.
"EXCL" = The Operator IDs under [USERID] are not allowed. You can start
Jobs using one of the other Operator IDs.
UCXPWI3#=
Dynamic link library that complies with the PeopleTools version that is used.
Allowed values: "1"
WRITE=
You can use this parameter in order to specify the type of message transfer
(such as lines in reports). Note that individual transfers that include thousands
of lines negatively affect the performance of the Automation Engine).
Allowed values: "0" (default value), "1"
"0" - Messages are sent separately.
"1" - Messages are sent block by block every second.
WRITE_TIME=
[AUTHORIZATION]
InitialPackage=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INIfile. If you define a file name, the ending
*.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You must
not delete, rename or move it subsequently. Regardless of the authentication
method that you use, any attempt to log in will fail if the agent cannot find this
file when it starts. In this case, you must open the menu item "Renew transfer
key" in the affected agent's System Overview.
[STATUS_CHECK]
74
Chapter 3 Configuration
time=
Internal timer cycle that can be used to check the status of a job compared to
PeopleSoft.
Default value: 1 second
The agent's internal job table is checked in this interval. It depends on a Job's
runtime whether a status check is made. The job is checked while it is running
at constantly increasing time intervals (the "time" value is doubled). These
intervals never exceed the value specified for the agent with JOB_
CHECKINTERVAL in the Host characteristics .
For example: time=1, JOB_CHECKINTERVAL=60
The job table is checked each second
Status check after: 1s, 2s, 4s,..., 60s, 60s....
[USERID]
[TRACE]
file=
trccount=
tcp/ip=
jcl=
database=
[TCP/IP]
port=
bindaddr=
bindlocal=
Automation Engine
connect=
alarm=
75
The PeopleSoft agent for Windows uses the parameter connect= for this
function. For historical reasons, the PeopleSoft agent for UNIX uses the
parameter alarm=.
Time interval in seconds in which the agent tries to establish connection to
the Automation Engines. Effects the connection setup for a start or after a lost
connection.
Default value: 180 seconds
This parameter is only effective until the first successful logon to the AE
system. Afterwards, you can use the parameter RECONNECT_TIME in
the Host characteristics for this purpose.
report=
Time interval in seconds in which the agent sends the logging to the
Automation Engine.
Default value: 60 seconds
CP=
connwait=
Time interval in seconds during which the agent waits for a response from the
communication partner (CP or another agent). If the time limit is exceeded,
the connection to the communication partner will be disconnected again.
Default value: 20 seconds
[VARIABLES]
This section contains the Agent Variables that include agent settings and
information.
[PS]
version=
LANGUAGE_CD=
OPRPSWD=
PID=
APPSERVER=
Name or TCP/IP address of the application server and number of the JOLT
port.
76
Chapter 3 Configuration
LOG2UC4=
You can use this parameter to add log files from processes of the
PeopleTools Process Scheduler Batch Server to the job report.
Allowed values: "0" (default value) and "1"
"0" = No log file is included in the job report.
"1" = Log file is included n the job report.
DOMAIN_
CONNECTION_
PWD=
[PRCS_SBB_JAVA]
ENABLED=
VERSION=
CLASSES=
Path specifications for the PeopleSoft Java Object Adapter Library (psjoa.jar)
Class library and for the supplied Java Classes.
Note that Windows paths are separated with the character";" and in UNIX
with ":".
[PSCONFIG]
Path and file name of the application server's configuration file in the form
Server Name = File.
[GENPRCSTYPE]
Only when the PeopleSoft standard interface is used. You can use it to create
log-file names.
[PSOPRPSWD]
[CP_LIST]
Automation Engine
Example of an INI File
[GLOBAL]
name=HR7TEST
system=UC4
language=(E,D)
logging=..\TEMP\PS_LOGG_##.txt
logcount=5
helplib=uc.msl
helpcache=all
userid_type=EXCL
UCXPWI3#=1
[AUTHORIZATION]
InitialPackage=
KeyStore=
[STATUS_CHECK]
time=20
[USERID]
;PSDEMO=NO_START
[TRACE]
file=..\TEMP\PS_TRACE_##.txt
trccount=8
tcp/ip=0
jcl=0
database=0
[TCP/IP]
port=2545
connect=180
report=60
CP=PC01:2217
connwait=20
[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=PS
UC_EX_PATH_BIN=..\
UC_EX_PATH_TEMP=..\TEMP\
UC_EX_PATH_JOBREPORT=..\TEMP\
UC_EX_JOB_MD=
UC_EX_ERP_CONNECT=
[PS]
version=8.42
LANGUAGE_CD=ENG
77
78
Chapter 3 Configuration
OPRPSWD=0
PID=0
APPSERVER=//psserv01:9100
LOG2UC4=0
[PRCS_SBB_JAVA]
enabled=1
Version=V0.001
classes=\\hostname\Psoft\HR800\web\PSJOA\psjoa.jar;\\hostname\Psoft\HR800\w
eb\PSJOA\
[PSCONFIG]
PSNT=\\psserv01\appserv\prcs\PSHR800\psprcs.cfg
PSUNX=\\psserv01\appserv\prcs\PSHR800\psprcs.cfg
[GENPRCSTYPE]
0=OTH
1=SQR
2=CBL
3=CRW
4=WRD
5=AE
6=CUBE
7=NVS
[PSOPRPSWD]
UC4=UC4
[CP_LIST]
2218=PC01
See also:
Notes for Configuration-File Adjustments
RA Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.
Structure of UCXJCITX.INI
Section/Parameter
[GLOBAL]
Description
Automation Engine
name=
79
system=
AE system name
This entry must be identical to the entry in the INI file of the Automation
Engine.
language=
logging=
logcount=
max_logging_kb=
helplib=
checkRegisteredFile=
This optional field is available for OEBSagents used in a multi node system
with different operating systems. In this case, this variable should be set to 0
and no check will be performed. Therefore, the RA agent can register files that
may not be valid file names on the OS where the RA agent runs.
Allowed values: "0" and "1" (default value)
"0" = Registered files are not checked.
"1" = Registered files are checked.
[AUTHORIZATION]
InitialPackage=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
80
Chapter 3 Configuration
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INIfile. If you define a file name, the ending
*.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You must
not delete, rename or move it subsequently. Regardless of the authentication
method that you use, any attempt to log in will fail if the agent cannot find this
file when it starts. In this case, you must open the menu item "Renew transfer
key" in the affected agent's System Overview.
Java agents (SAP, RA, database and JMX) that run under UNIX create a
keystore file with the following right: "-rw-r--r". In doing so, other OS
users can also access this file.
[RA]
cache_directory=
[TCP/IP]
bindaddr=
connect=
cp=
[VARIABLES]
This section contains Agent Variables with agent information and settings.
[TRACE]
file=
trccount=
max_trace_kb=
Automation Engine
tcp/ip=
81
ra=
[CP_LIST]
82
Chapter 3 Configuration
[AUTHORIZATION]
InitialPackage=
KeyStore=
[RA] cache_directory=cache
[VARIABLES] uc_host_jcl_var=CIT
[CP_LIST]
2218=PC01
See also:
Notes for Configuration-File Adjustments
SAP Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
name=
Agent name.
The agent name is limited to 32 of the following characters: A-Z, 0-9, _, ., $,
@, - and #.
The host name is used if this parameter remains undefined. Lowercase
letters are converted to uppercase letters.
Hyphens ("-") are only allowed in agent names. They must not be used in the
names of any other objects.
Automation Engine
system=
language=
The language that should be used for the logging. You can specify a primary
and a secondary language.
83
logcount=
LogMaxSize=
max_logging_kb=
helplib=
helpcache=
84
Chapter 3 Configuration
lower_case=
maxEventTimeSpan=
The interval in seconds that the agent uses to read previous SAP Events after
it has lost its connection to the SAP system.
Default value: 600 seconds
Console Events monitor Events that have been triggered in SAP. If the agent
loses its connection to the SAP system, several SAP Events can accumulate
that the agent cannot forward to the Console Events. As soon as the
connection has been re-established, the agent checks again and reports
these SAP Events to the relevant Console Events.
The agent does not read all SAP Events at once because a large amount of
data might be involved. Each SAP Event is triggered at a particular point in
time. The agent retrieves all SAP Events that have been triggered during the
connection loss from the SAP Event history. It uses the interval that has been
defined using the parameter maxEventTimeStamp=.
For example:
The value for maxEventTimeStamp= is set to 600. This value corresponds to
10 minutes. The JOB_CHECKINTERVAL is 60 which corresponds to 1
minute. The agent is not connected to the SAP system between 10:00 and
10:30. SAP Events that have been triggered during this time are retrieved as
shown below:
SAP Events between 10:00 and 10:10 are retrieved at 10:30.
SAP Events between 10:10 and 10:20 are retrieved at 10:31.
SAP Events between 10:20 and 10:30 are retrieved at 10:32.
SAP Events between 10:30 and 10:33 are retrieved at 10:33.
SAP Events between 10:33 and 10:34 are retrieved at 10:34
etc.
joblog_blocksize=
Automation Engine
userid_type=
85
SAP_language=
Download_dir=
R3_ACTIVATE_REPORT
R3_ACTIVATE_JOBS
R3_ACTIVATE_INTERCEPTED_JOBS
BW_ACTIVATE_CHAIN
BW_RESTART_CHAIN
The spool lists are stored as text files and the following file name is used:
<SAP job count>_<step number>_<spool number>.txt
The agent's temp directory is used if this parameter is not defined.
[AUTHORIZATION]
InitialPackage=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
86
Chapter 3 Configuration
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INIfile. If you define a file name, the ending
*.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You must
not delete, rename or move it subsequently. Regardless of the authentication
method that you use, any attempt to log in will fail if the agent cannot find this
file when it starts. In this case, you must open the menu item "Renew transfer
key" in the affected agent's System Overview.
Java agents (SAP, RA, database and JMX) that run under UNIX create a
keystore file with the following right: "-rw-r--r". In doing so, other OS
users can also access this file.
[USERID]
[SAP_BW]
Enabled=
Interface usage.
Allowed values: 0 (default value) and 1
0 - The interface is not used.
1 - The interface is used.
[SAP_XI]
Enabled=
Interface usage.
Allowed values: 0 (default value) and 1
0 - The interface is not used.
1 - The interface is used.
[SAP_BCA]
Enabled=
Interface usage.
Allowed values: 0 (default value) and 1
0 - The interface is not used.
1 - The interface is used.
[SAP_BASIS]
Version=
Automation Engine
87
[SAP_SMSE]
WebStartURL=
[TRACE]
Trace flags must only be used in close cooperation with Automic Support
and AE Development.
file=
trccount=
max_trace_kb=
tcp/ip=
jcl=
rfc=
RFC trace.
bindaddr=
88
Chapter 3 Configuration
connect=
report=
The time interval in seconds in which the agent sends the logging to the
Automation Engine.
Default value: 60
CP=
[VARIABLES]
This section includes agent variables that contain agent settings and
information.
[CP_LIST]
Automation Engine
Example of an INI File
[GLOBAL]
name=SAP01
system=UC4
language=(E,D)
logging=..\TEMP\UCXJR3X_LOGG_SID_##.TXT
logcount=10
helplib=uc.msl
helpcache=ALL
lower_case=NO
maxEventTimeSpan=600
joblog_blocksize=0
[AUTHORIZATION]
InitialPackage=
KeyStore=
[SAP_BW]
Enabled=0
[SAP_XI]
Enabled=1
[SAP_BCA]
Enabled=0
[TRACE]
file=..\TEMP\UCXJR3X_TRACE_##.TXT
trccount=10
tcp/ip=0
jcl=
rfc=0
[TCP/IP]
bindaddr=
bindlocal=0
connwait=20
connect=60
report=60
cp=uc4srv01:2217
[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=SAP
UC_EX_PATH_BIN=C:\AUTOMIC\AGENTS\SAP\BIN\
UC_EX_PATH_TEMP=C:\AUTOMIC\AGENTS\SAP\TEMP\
UC_EX_PATH_JOBREPORT=C:\AUTOMIC\AGENTS\SAP\TEMP\
UC_EX_JOB_MD=
[CP_LIST]
22187=PC01
89
90
Chapter 3 Configuration
See also:
Notes for Configuration-File Adjustments
Siebel Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
name=
system=
language=
Language that should be used for the logging. You can specify a primary and a
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, the system searches for a
message in the secondary language.
logging=
logcount=
helplib=
helpcache=
Automation Engine
WRITE=
91
You can use this parameter to specify the type of message transfer (such as
lines in reports). Note that individual transfers that include thousands of lines
will negatively affect the performance of the Automation Engine).
Allowed values: "0" (default value), "1"
"0" - Messages are sent separately.
"1" - Messages are sent block by block every second.
WRITE_TIME=
[AUTHORIZATION]
InitialPackage=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INIfile. If you define a file name, the ending
*.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You must
not delete, rename or move it subsequently. Regardless of the authentication
method that you use, any attempt to log in will fail if the agent cannot find this
file when it starts. In this case, you must open the menu item "Renew transfer
key" in the affected agent's System Overview.
[STATUS_CHECK]
time=
This is the system-internal timer cycle that checks the status of a job
compared to SAP.
Default value: 1 second
The agent's internal job table is checked in this interval. Whether the Job's
status is checked depends on its runtime. The job is checked while it is
running at constantly increasing time intervals (the "time" value is doubled).
However, these intervals never exceed the value that is specified for the
agent in the parameter JOB_CHECKINTERVAL in the Host characteristics.
For example: time=1, JOB_CHECKINTERVAL=60
The job table is checked each second.
Status check after: 1s, 2s, 4s,..., 60s, 60s....
[TRACE]
92
Chapter 3 Configuration
file=
trccount=
tcp/ip=
filetransfer=
mail=
[TCP/IP]
port=
bindaddr=
bindlocal=
connect=
report=
Time interval in seconds in which the agent sends the logging to the
Automation Engine.
Default value: 60 seconds
SendBufferSize=
Size of the TCP/IP input buffer for messages that should be sent.
RecvBufferSize=
Size of the TCP/IP input buffer for messages that should be received.
Automation Engine
cp=
93
connwait=
Time interval in seconds during which the agent waits for a response from the
communication partner (a CP or another agent). If the time limit is exceeded,
the connection to the communication partner will be terminated again.
Default value: 20 seconds
[VARIABLES]
This section contains agent variables that include agent settings and
information.
[SIEBEL]
DELIMITER=
repeat_check=
The number of repeated status checks if the Siebel system does not return
the relevant Job. Only then, the job is deemed to be vanished (ENDED_
VANISHED).
Background information: It can occur that a "list task" command does not list
the Jobs that are active in the Siebel system. Therefore, these Jobs obtains
the status ENDED_VANISHED. Nevertheless, the affected Jobs are still
running in the Siebel system. To avoid this problem, the agent check the
states repeatedly according to the definitions you set in this parameter.
Allowed values: 0 to 2147483647
Default value: 0
report_repeat_check=
[CP_LIST]
94
Chapter 3 Configuration
[AUTHORIZATION]
InitialPackage=
KeyStore=
[STATUS_CHECK]
time=1
[TRACE]
file=siebel_trc##.txt
trccount=10
tcp/ip=4
filetransfer=0
mail=0
[TCP/IP]
port=2509
connect=30
report=60
SendBufferSize=32768
RecvBufferSize=32768
cp=PC01:2217
connwait=120
[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=SIEBEL
UC_EX_PATH_BIN=.
UC_EX_PATH_TEMP=..\temp\
UC_EX_PATH_JOBREPORT=..\temp\
UC_SIEBEL_SRVRMGR=C:\siebel\srvrmgr.exe
UC_SIEBEL_LOGPATH=C:\siebel\siebelLOGS\
[SIEBEL]
DELIMITER=*
Automation Engine
95
[CP_LIST]
2218=PC01
See also:
Notes for Configuration-File Adjustments
UNIX Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
The INI-file sections [USERID] and [UC_USER] only affect UNIX jobs. They do not affect
FileTransfers or FileSystem Event objects.
The following is valid for the target host: Regardless of the parameters that have been set the UNIX
agent also considers links in file paths. The following conditions apply:
l
l
Description
[GLOBAL]
name=
system=
logging=
logcount=
helplib=
96
Chapter 3 Configuration
licence_class=
The license class that corresponds to the acquired AE license and the
hardware and software that you use.
Allowed values: 1-9, S, V
1 - 9 = The agent's license class.
S = The agent that is used for administration tasks on the Server
computer.
V = The agent's virtual license class.
language=
The language that should be used for the logging. You can specify a
primary and a secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, the system searches for a
message in the secondary language.
open_file_max=
Sets the users 'open file descriptor' limit. A value of 0 forces the agent to
set the users soft limit to the existing users hard limit. A value not equal to
0 forces the agent to set the soft limit and the hard limit to that value. If the
value exceeds the users existing hard limit, the agent even sets that value,
if it is operated with root privileges. If the value exceeds the users existing
hard limit and the agent is not operated with root privileges, the agent
cannot exceed the hard limit and sets the users soft limit to the users hard
limit.
Default value: 32768
userid_type=
UC_user_type=
rcv_max=
The time period in seconds during which the agent waits for the rest of a
partially received message. After this period of time, the connection is
considered as interrupted. We recommend keeping this time period short.
Default value: 30 seconds
login_check=
Password check.
Allowed values: yes and no (default value)
See:Description of the settings ANONYMOUS_FT and ANONYMOUS_
JOB in the AE Variable UC_HOSTCHAR_DEFAULT).
Automation Engine
ReportMode=
97
A mask in three octal digits that you can use to assign additional rights to
the job report file.
Default value: 600
The default value is the minimum value. The value 6 is used even if you
specify an owner authorization level below this value.
JobFileMode=
A mask in three octal digits that you can use to assign additional rights to
the job file.
Default value: 700
The default value is the minimum value. The value 7 is used even if you
specify an owner authorization level below this value.
FT_Owner=
ReadUserAlways=
You allow or reject User IDs by using the parameter userid_type= in the
[USERID] section. You can use the parameter ReadUserAlways= in order
to specify whether this section should always be read before a job starts or
only once when the agent starts. Reading this section only once improves
the performance of your system and is therefore the default value.
Allowed values: yes and no (default value)
yes = The agent always reads the [USERID] section before a job starts.
no = The agent reads this section only once when the agent starts.
KillSignal=
The signal that is sent to the job if it is canceled through the UserInterface.
Allowed values: SIGTERM, SIGABRT and SIGKILL (default value)
SIGTERM - The job is terminated (15).
SIGABRT - The job is canceled (6)
SIGKILL - The job ends immediately (9).
ft_temp_file=
98
Chapter 3 Configuration
tcp_nodelay=
Nagle algorithm usage for file transfers and all the agent's other sockets.
Allowed values: yes (default value) and no
no = Activates the Nagle algorithm.
yes = This procedure is not applied.
Activating the Nagle algorithm can improve the performance of file
transfers, especially if you transfer many small files.
The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.
Note that this parameter should only be set in close cooperation with
Automic Support!
FileProcessingTimeout=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the companykey file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
Automation Engine
KeyStore=
99
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file
ending *.kstr) or the path of the agent's INIfile. If you define a file name,
the ending *.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You
must not delete, rename or move it subsequently. Regardless of the
authentication method that you use, any attempt to log in will fail if the
agent cannot find this file when it starts. In this case, you must open the
menu item "Renew transfer key" in the affected agent's System Overview.
[USERID]
[UC_USER]
[FILETRANSFER]
ft_check_free_disk_
space=
This parameter checks the available hard disk space before a file transfer
is processed.
Allowed values:
"yes" - The system checks whether there is sufficient hard disk space for
the files that should be transferred. The files will only be transferred when
there is enough space. Otherwise, the file transfer will abort with an error
message.
"no" (default) - No check is made.
Checking the available space of network drives may occasionally lead
to an incorrect result.
FT_Linkfiles=
By using the parameter FT_Linkfiles you control whether the agent should
transfer linked files of the source or ignore them.
Allowed values:
"yes" - Links will be de-referenced and the files to which the links are
pointing to will be transferred.
"no" (default) - Links will be ignored.
Executing a wildcard file transfer with "no" as a value may result in the
transfer being set to ENDED_EMPTY, in case there are only links in
the source directory.
[VARIABLES]
[TRACE]
This section contains the Agent Variables that include agent settings and
information.
100
Chapter 3 Configuration
file=
trccount=
tcp/ip=
event=
job_debug=
ft_debug=
ex_init=
signal=
mail=
memory=
[HOSTS]
In file transfers, the sending agent obtains the destination agent's internal
address from the Automation Engine. The sending agent replaces this
internal address by the external address that is defined here.
This setting is only required if you run file transfers with agents that cannot
directly establish a TCP/IP connection between each other by using the
address that they have received from the Server. This can happen if the
agents that are involved in the file transfer are located on different
networks or if a firewall is used.
[TCP/IP]
port=
bindaddr=
bindlocal=
Automation Engine
connect=
101
maxrepcnt=
maxMsgSize=
cp=
tcp_keepalive=
tcp_keepalive_time=
SendBufferSize=
Size of the TCP/IP input buffer for messages that should be sent (MB, KB
or bytes).
Bytes are used by default. Alternately, you can also append the letter "K"
or kilobytes or "M" for megabytes to the number. You can use uppercase or
lowercase letters for this purpose.
Examples (the following definitions are identical):
Specification in bytes: 1048576
Specification in Kbytes: 1024K or 1024k
Specification in Mbytes : 1M or 1m
Default value: 1 Mbyte
RecvBufferSize=
Size of the TCP/IP input buffer for messages that should be received (MB,
KB or bytes).
Bytes are used by default. Alternately, you can also append the letter "K"
or kilobytes or "M" for megabytes to the number. You can use uppercase or
lowercase letters for this purpose.
Default value: 1 Mbyte
[MISC]
102
Chapter 3 Configuration
FileBufferSize=
Size of the input buffer for files that are transferred with a FileTransfer
object (MB, KB or bytes).
Bytes are used by default. Alternately, you can also append the letter "K"
or kilobytes or "M" for megabytes to the number. You can use uppercase or
lowercase letters for this purpose.
Examples (the following definitions are identical):
Specification in bytes: 1048576
Specification in Kbytes: 1024K or 1024k
Specification in Mbytes : 1M or 1m
Default value: 0 (The OS setting is used).
authentification=
Authentication method for the login data in the Login objects of the Jobs
and FileTransfers.
Allowed values: local (default) and PAM
local = OS calls
PAM = Pluggable Authentication Modules (see also: parameter Libname=)
PAM authentication is only supported for Agents that run on AIX, Linux
and Sun Solaris.
TraceFileSize=
The maximum size of a trace file. The agent creates a new file if this value
has been reached.
Bytes are used by default. Alternately, you can also append the letter "K"
or kilobytes or "M" for megabytes to the number. You can use uppercase or
lowercase letters for this purpose.
FileEndDelimiter=
This adds a line breack (LF)at the end of text files that have been sent
using a FileTransfer.
Allowed values: "yes" and "no" (default value)
"yes" - The agent always adds an LF to the end of text files in FileTransfers
in which it is the receiving agent.e It is irrelevant whether the files already
end with an LF.
"no" - The files are transferred without any changes.
processinfo=
Automation Engine
MsgStdout=
103
FileRemoveCheck=
[PAM]
Libname=
pam_open_session=
[STARTCMD]
start_type=
Bourne_Shell=
C_Shell=
Korn_Shell=
Other_Shell=
shell_pfad=
104
Chapter 3 Configuration
[CP_LIST]
Automation Engine
Example of an INI File
[GLOBAL]
name = UNIX01
system = AE
logging = ../temp/UCXJxxx.l##
logcount = 10
helplib = ucx.msl
licence_class = V
language = e,d
userid_type = EXCL
UC_user_type = EXCL
; rcv_block = yes
; rcv_max = 30
login_check=yes
ReportMode=600
JobFileMode=700
ReadUserAlways=no
KillSignal=SIGKILL
ft_temp_file=yes
[AUTHORIZATION]
InitialPackage=
KeyStore=
[USERID]
;root = NO_START
[UC_USER]
; 6 = START
; 7 = NO_START
[FILETRANSFER]
; ft_check_free_disk_space=yes
; standard : ft_check_free_disk_space=no
; FT_Linkfiles=yes
; standard FT_Linkfiles=no
[VARIABLES]
UC_HOST_CODE = UC_CODE
UC_HOST_JCL_VAR = UNIX
UC_EX_PATH_BIN = ./
UC_EX_PATH_JOBREPORT = ../out/
UC_EX_PATH_TEMP = ../temp/
UC_EX_JOB_MD = ucxjxxxm
[TRACE]
file = ../temp/UCXJxxx.t##
trccount = 10
tcp/ip = 0
105
106
Chapter 3 Configuration
event = 0
job_debug = 0
ft_debug = 0
ex_init = 0
signal = 0
mail = 0
[HOSTS]
; <name>=<dns-name> or
; <name>=<ip-addr>
[TCP/IP]
port = 2220
alarm = 30
maxrepcnt = 8
cp = PC01:2217
[MISC]
authentification=PAM
FileEndDelimiter=yes
processinfo=yes
[PAM]
Libname=libpam.so
pam_open_session=yes
[STARTCMD]
; start_type = batch
; Bourne-Shell = nohup batch < \`su - &user -c "&jobFile 1>> &jobReport
2>&1"\`&
; C-Shell = nohup batch < \`su - &user -c "&jobFile >>& &jobReport"\`&
; Korn Shell = nohup batch < \`su - &user -c "&jobFile 1>> &jobReport
2>&1"\`&
; Other-Shell = nohup batch < \`su - &user -c "&jobFile 1>> &jobReport
2>&1"\`&
; Only for SunOS 5.4 (US4):
; [STARTCMD]
; Bourne-Shell = batch < \`su - &user -c "nohup &jobFile >> &jobReport
2>&1"\`&
; C-Shell = batch < \`su - &user -c "nohup &jobFile >>& &jobReport"\`&
; Korn Shell = batch < \`nohup su - &user -c "&jobFile >>& &jobReport
2>&1"\`&
; Other-Shell = batch < \`nohup su - &user -c "&jobFile >>& &jobReport
2>&1"\`&
[CP_LIST]
2218=PC01
Automation Engine
107
See also:
Notes for Adjusting Configuration Files
VMS Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
name=
system=
logging=
logcount=
helplib=
licence_class=
The license class that corresponds to the acquired license and the hardware
and software that is used.
Allowed values: "1" to "9"
"1" to "9" = License class of the agent
language=
The language that should be used for the logging. You can specify a primary
and a secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, the system searches for a
message in the secondary language.
108
Chapter 3 Configuration
userid_type=
UC_user_type=
rcv_max=
The time period in seconds in which the agent waits for the rest of a partially
received message. When this time period expires, the connection is
considered interrupted. Note: Ensure that the time period that you specify is
not too long.
Default value: 30 seconds
uc4_logical=
The definition of the logical name (entries are converted to uppercase letters).
If this parameter is not specified, the logical name is created as shown below:
UC4_AE system name_Agent name_Agent
ReadUserAlways=
You can allow or reject User IDs by using the parameter userid_type= in the
[USERID] section. You can use the parameter ReadUserAlways= in order to
specify whether this section should always be read before a job starts or only
once when the agent starts. Reading this section only once improves the
performance of your system and is therefore the default value.
Allowed values: yes and no (default value)
yes = The agent always reads the [USERID] section before a job starts.
no = The agent reads this section only once when the agent starts.
ft_temp_file=
Automation Engine
tcp_nodelay=
109
Nagle algorithm usage for file transfers and all the agent's other sockets.
Allowed values: yes (default value) and no
no = Activates the Nagle algorithm.
yes = This procedure is not applied.
Activating the Nagle algorithm can improve the performance of file transfers,
especially if you transfer many small files.
The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.
Note that this parameter should only be set in close cooperation with Automic
Support!
[AUTHORIZATION]
InitialPackage=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INIfile. If you define a file name, the ending
*.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You must
not delete, rename or move it subsequently. Regardless of the authentication
method that you use, any attempt to log in will fail if the agent cannot find this
file when it starts. In this case, you must open the menu item "Renew transfer
key" in the affected agent's System Overview.
[USERID]
[UC_USER]
110
Chapter 3 Configuration
[VARIABLES]
OpenVMS (IA64):
UC_EX_JOB_MD = UCXJVI8M
Alpha:
UC_EX_JOB_MD = UCXJVA7M
VAX:
UC_EX_JOB_MD = UCXJVV7M
[TRACE]
file=
trccount=
tcp/ip=
event=
job_debug=
ft_debug=
ex_init=
signal=
memory=
[HOSTS]
In file transfers, the sending agent obtains the destination agent's internal
address from the Automation Engine. The sending agent replaces this internal
address by the external address that is defined here.
This setting is only required if you run file transfers with agents that cannot
directly establish a TCP/IP connection between each other by using the
address that they have received from the Server. This can happen if the
agents that are involved in the file transfer are located on different networks or
if a firewall is used.
[TCP/IP]
Automation Engine
port=
111
bindaddr=
bindlocal=
connect=
maxrepcnt=
maxMsgSize=
tcp_keepalive_time=
The time interval in seconds in which packets are sent in order to keep
connections.
The default value that depends on the system environment is used when you
do not define this setting or when you define the value 0.
This parameter has no effect when the agent runs under VAX.
cp=
[STARTCMD]
112
Chapter 3 Configuration
SUBMIT=
VMS command for starting a job in batch mode. You can adjust is userspecifically by using additional SUBMIT parameters:
For example, you can set up and prioritize your own batch queue for AE and
specify it as a parameter Example: /QUEUE=UC4$BATCH
If no queue parameter is specified, Jobs start in the standard queue
SYS$BATCH.
ACCESS=
[JOBREPORT]
reportname=
[MISC]
FileNameLowerCase=
Automation Engine
TraceFileSize=
113
The maximum size of a trace file. The agent creates a new file if this value
has been reached.
Default value: "32M"
Enter a number followed by the letter "K" for kilobytes or "M" for megabytes.
The agent interprets the number as bytes if no measuring unit has been
specified.
FileEndDelimiter=
This appends a line break (LF)to the end of text files that have been
transferred by using a FileTransfer.
In VMS, each text file requires a line break at its end.
Allowed values: "yes" (default value) and "no"
"yes" - In FileTransfers, the agent always appends a LF to the end of text files
when it is the receiving agent. It is irrelevant whether the files already end with
a LF.
"no" - The files are transferred without any changes.
[CP_LIST]
114
Chapter 3 Configuration
[AUTHORIZATION]
InitialPackage=
KeyStore=
[USERID]
;system = NO_START
[UC_USER]
;6 = START
;7 = NO_START
[VARIABLES]
UC_HOST_CODE = UC_CODE
UC_HOST_JCL_VAR = VMS
UC_EX_PATH_BIN = []
UC_EX_PATH_JOBREPORT = [-.out]
UC_EX_PATH_TEMP = [-.temp]
UC_EX_JOB_MD = UCXJVxxM
[TRACE]
file = [-.temp]UCXJVxx.t##
trccount = 10
tcp/ip = 0
event = 0
job_debug = 0
ft_debug = 0
ex_init = 0
signal = 0
[HOSTS]
; <AE-name>=<dns-name> or
; <AE-name>=<ip-addr>
Automation Engine
115
[TCP/IP]
port = 2220
alarm = 30
maxrepcnt = 8
cp = PC01:2217
[STARTCMD]
SUBMIT = submit &jobFile /LOG=&jobReport /USER=&user
ACCESS = alq=5000,deq=5000,mbc=64,mbf=64
[JOBREPORT]
;reportname = [-.report]&vms-jobname_&client_&userid_&AE-jobname_
&runnr.log
;reportname = [uc4.uc100e.exekutor.report.&userid]&vms-jobname.log
[MISC]
FileNameLowerCase=no
TraceFileSize=32M
FileEndDelimiter=yes
[CP_LIST]
2218=PC01
See also:
Notes for Configuration-File Adjustments
Windows Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
name=
system=
116
Chapter 3 Configuration
logon=
language=
The language that should be used for the logging. You can specify a
primary and a secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, the system searches for a
message in the secondary language.
logging=
logcount=
helplib=
helpcache=
licence_class=
The license class that corresponds to the acquired license and the
hardware and software that is used.
Allowed values: "1" to "9", "S", "V"
"1" to "9" = License class of the agent.
"S" = Agent that is used for the administration of tasks on the Server
computer.
"V" = Virtual license class for the agent.
ECPEXE=
The path and the name of the interpreter that processes the script.
ECPEXT=
Automation Engine
userid_type=
117
useJobObject=
The setting Jobs starts in a Windows Job object. The value that are
defined here serves as the default value for all AE Jobs under Windows. A
setting that should apply for a particular job can be specified in the Job tab.
Allowed values: "0" and "1"
"0" - The Windows Job object is not used.
"1" - The Windows Job object is used. More information about the job and
its sub-Jobs is available. The improved restart options are an advantage.
Note that the AE job will only end when all sub-Jobs have ended.
HomeDirCache=
You can use this parameter to determine whether the home directory of the
Login user is stored.
Specify a period of time (in minutes) after which the agent should store the
name of the home directory. This will increase performance. If you use "0",
this information is not stored.
Default value: 10 minutes
Note that any changes that are made in the home directory only
become effective after the specified period of time.
ft_temp_file=
ft_check_free_disk_space
=
This parameter checks the available hard disk space before a file transfer
is processed.
Allowed values:
"y" - The system checks whether there is sufficient hard disk space for the
files that should be transferred. The files will only be transferred when there
is enough space. Otherwise, the file transfer will abort with an error
message.
"n" (default) - No check is made.
Checking the available space of network drives may occasionally lead
to an incorrect result.
118
Chapter 3 Configuration
tcp_nodelay=
Nagle algorithm usage for file transfers and all the agent's other sockets.
Allowed values: yes (default value) and no
no = Activates the Nagle algorithm.
yes = This procedure is not applied.
Activating the Nagle algorithm can improve the performance of file
transfers, especially if you transfer many small files.
The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.
Note that this parameter should only be set in close cooperation with
Automic Support!
FileProcessingTimeout=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the companykey file cannot be found.
When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
Automation Engine
KeyStore=
119
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file
ending *.kstr) or the path of the agent's INIfile. If you define a file name,
the ending *.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You
must not delete, rename or move it subsequently. Regardless of the
authentication method that you use, any attempt to log in will fail if the
agent cannot find this file when it starts. In this case, you must open the
menu item "Renew transfer key" in the affected agent's System Overview.
[STATUS_CHECK]
time=
The internal timing cycle in which the system checks whether the job has
already ended (provided that it runs in a Windows Job object).
Default value: 1 second
The agent's internal job table is checked in this interval. It depends on a
Job's runtime whether a status check is made. The job is checked during
its execution at ever increasing time interval (doubling the value "time").
These intervals never exceed the value specified for the agent with JOB_
CHECKINTERVAL in the Host characteristics.
For example: time=1, JOB_CHECKINTERVAL=60
The job table is checked each second
Status check after: 1s, 2s, 4s,..., 60s, 60s....
[USERID]
[VARIABLES]
This section contains the Agent Variables that include agent settings and
information.
[TRACE]
file=
trccount=
tcp/ip=
filetransfer=
event=
mail=
compress=
memory=
[TCP/IP]
120
Chapter 3 Configuration
port=
bindaddr=
bindlocal=
connect=
report=
The time interval in seconds in which the agent sends the logging to the
Automation Engine.
Default value: 60 seconds
maxMsgSize=
cp=
SendBufferSize=
The size of the TCP/IP input buffer for messages that should be sent
(Byte).
Default value: 1048576 Byte
RecvBufferSize=
The size of the TCP/IP input buffer for messages that should be received
(Byte).
Default value: 1048576 Byte
TcpKeepAliveTime=
Automation Engine
[HOSTS]
121
[CP_LIST]
[BACKEND]
useDesktop=
122
Chapter 3 Configuration
[AUTHORIZATION]
InitialPackage=
KeyStore=
[STATUS_CHECK]
time=1
[USERID]
smith/UC4=START
[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=WINDOWS
UC_EX_PATH_BIN=.
UC_EX_PATH_TEMP=C:\AUTOMIC\AGENT\WINDOWS\TEMP\
UC_EX_PATH_JOBREPORT=C:\AUTOMIC\AGENT\WINDOWS\TEMP\
UC_EX_JOB_MD=C:\AUTOMIC\AGENT\WINDOWS\BIN\UCXJWxxM.EXE
[TRACE]
file=..\TEMP\UCXJWxx_TRACE_##.TXT
trccount=10
tcp/ip=0
filetransfer=0
event=0
mail=0
compress=0
[TCP/IP]
port=2300
connect=60
Automation Engine
123
cp=PC01:2217
TcpKeepAliveTime=yes
[HOSTS]
; <AE-name>=<dns-name> or
; <AE-name>=<ip-addr>
[CP_LIST]
2218=PC01
See also:
Notes for Configuration-File Adjustments
z/OS Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.
Description
(GLOBAL)
system=
name=
language=
Language that should be used for the logging. You can specify a primary and a
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, the system searches for a
message in the secondary language.
124
Chapter 3 Configuration
logging=
logcount=
logpurgeclass=
helplib=
helpcache=
licence_class=
License class that corresponds to the acquired AE license and the hardware
and software that is used.
Allowed values: "1" to "9"
"1" to "9" = Agent's license class
Automation Engine
askRACF=
125
Verification of the access authorizations with RACF for Jos and FileTransfers
before the agent starts (password verification for the User of the
Job/FileTransfer and dataset authorization check in FileTransfers). Doing so
generates more accurate agent error messages and avoids useless task starts
if there is no appropriate authorization. The security system checks the
running job in any case.
You can deactivate this entry with the value "0" if no RACF is installed on this
host.
Allowed values: "0" to "15"
Default value: "7"
Value Login
check
for
jobs
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Login
check for
file
transfers
File-access check
for FileTransfers
with the login's
UserID
File-access check
for FileTransfers
with the agent's
UserID
126
Chapter 3 Configuration
completeJobout=
jobPurge=
relMsgClass=
getMsgClass=
routeMsgClass=
Automation Engine
jes=
127
Job Entry Subsystem (JES) that has been installed on the host.
Allowed values: "JES2" (default value), "JES3"
jobACF2=
userid_type=
jobAccount=
jobCancel=
This is a command that serves to cancel Jobs and is sent to the console.
Allowed values:
$C &01 = The job name is inserted at position &01.
$C &02 = The JobID in JOB12345 format is inserted at the position &02
(default value).
$CJ&03 = The JobID in 12345 or 1234 format is inserted at the position &03.
All settings support 5,6 and 7 digit JobIDs.
jobOutputAllocation=
jobSubmitContext=
vanishedRetry=
128
Chapter 3 Configuration
waitSpoolRetry=
waitSpoolReady=
WaitOnJobEnd=
ignoreEmptyJCL=
ft_temp_file=
Automation Engine
tcp_nodelay=
129
Nagle algorithm usage for file transfers and all the agent's other sockets.
Allowed values: yes (default value) and no
no = Activates the Nagle algorithm.
yes = This procedure is not applied.
Activating the Nagle algorithm can improve the performance of file transfers,
especially if you transfer many small files.
The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.
Note that this parameter should only be set in close cooperation with Automic
Support!
EventCheckIntervall=
The name and the path of the file that includes the authentication package
(company-key file).
This parameter must be specified if you use the authentication methods
"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
When the agent starts, it reads the company-key file and stores its information
in the file that is specified in the parameter KeyStore=. The first file is deleted
afterwards.
KeyStore=
The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INIfile. If you define a file name, the ending
*.kstr is not automatically appended.
The KeyStore file is created when the agent starts for the first time. You must
not delete, rename or move it subsequently. Regardless of the authentication
method that you use, any attempt to log in will fail if the agent cannot find this
file when it starts. In this case, you must open the menu item "Renew transfer
key" in the affected agent's System Overview.
(JCL Exit)
name=
maxJclRecords=
130
Chapter 3 Configuration
(USERID)
(Variables)
(TRACE)
file=
trccount=
tcp/ip=
filetransfer=
status=
joboutput=
event=
memory=
trcmode=
port=
Automation Engine
bindaddr=
131
bindlocal=
connect=
report=
Time interval in seconds in which the agent sends the logging to the
Automation Engine.
Default value: 60 seconds
connwait=
Time interval in seconds during which the agent waits for a communication
partner response (CP or a different agent). If this time limit is exceeded, the
connection to the communication partner is terminated.
Default value: 20 seconds
AsyncConnect=
maxMsgSize=
SendBufferSize=
Size of the TCP/IP input buffer for messages that should be sent (Byte).
Default value: 262144 Byte
RecvBufferSize=
Size of the TCP/IP input buffer for messages that should be received (Byte).
Default value: 262144 Byte
tcp_keepalive=
132
Chapter 3 Configuration
Listen=
(HOSTS)
(CP_LIST)
Automation Engine
Example of an INI File
(GLOBAL)
system=AE
name=MVS01
language=(E,D)
logging='AE.WORK.LOG##'
logcount=10
logpurgeclass=9
helplib='AE.UC.MSL'
helpcache=ALL
licence_class=9
askRACF=7
completeJobout=1
jobPurge=0
relMsgClass=0
getMsgClass=AB
routeMsgClass=CD
jes=JES2
; jobACF2=0
userid_type=EXCL
jobCancel=$C &02
jobOutputAllocation=(1,1)
vanishedRetry=1
waitSpoolRetry=6
waitSpoolReady=50
WaitOnJobEnd=0
ignoreEmptyJCL=1
ft_temp_file=yes
ft_temp_file_uss=no
(AUTHORIZATION)
InitialPackage=
KeyStore=
(JCL Exit)
; name=
; maxJclRecords
(USERID)
; IBMUSER=NO_START
(Variables)
UC_HOST_CODE=IBM_3270_INTERNATIONAL
UC_HOST_JCL_VAR=MVS
UC_EX_PATH_BIN=UC4.UCXJM25.LOAD
UC_EX_PATH_TEMP=UC4.TEMP.
UC_EX_PATH_JOBREPORT=UC4.TEMP.
UC_EX_JOB_MD=UCXJM25M
(TRACE)
133
134
Chapter 3 Configuration
file='AE.WORK.TRC##'
trccount=10
tcp/ip=0
filetransfer=0
status=0
joboutput=0
event=0
(TCP/IP)
cp=PC01:2217
port=2300
connect=120
report=60
connwait=20
AsyncConnect=1
(HOSTS)
; <name>=<dns-name> or
; <name>=<ip-addr>
(CP_LIST)
2218:PC01
See also:
Notes for Configuration-File Adjustments
Description
(GLOBAL)
system=
name=
Automation Engine
language=
135
logging=
logcount=
logpurgeclass=
helplib=
helpcache=
136
Chapter 3 Configuration
EventCheckIntervall=
(TRACE)
file=
trccount=
tcp/ip=
filetransfer=
status=
joboutput=
event=
trcmode=
connect=
Automation Engine
ex2=
Alternative agent address to which the Event Monitor should connect if the
primary agent (parameter ex=) is not available.
exn=
SendBufferSize=
137
tcp_keepalive=
(CONSOLE)
For Console Events:
console=
Console analysis.
Allowed values: "0" (default value), "1"
"0" = The console is not used.
"1" = The console is analyzed.
buffersize=
ModulName=
CADSEyeCatcher=
138
Chapter 3 Configuration
smfStepFilter=
SMFJob=
SMF_Buffersize=
Size of the Common Area Data Space (CADS) in which the SMF Exit stores
Events (in MB).
Allowed values: "1" - "2048"
Default value: 10
About 65000 Events can be stored with 10 MB.
ABENDNUM=
Automation Engine
139
(TRACE)
file='UC4.WORK.TRC##'
trccount=10
tcp/ip=0
filetransfer=0
status=0
joboutput=0
event=0
(TCP/IP)
ex=UC4EX:2300
connect=60
ex2=<addr>:<port>
ex3=<addr>:<port>
(CONSOLE)
console=1
buffersize=1
smfwrite=1
ModulName=SMFE01
CADSEyeCatcher=UC4EYEC
smfStepFilter=0
smfJob=0
SMF_Buffersize=10
Description
140
Chapter 3 Configuration
(GLOBAL)
name=
language=
logging=
logcount=
logpurgeclass=
helplib=
Automation Engine
helpcache=
141
JobFilter=
JobTable=
logJobProtocol=
Writes the logging of all the system's jobs to the log file of the external Job
Monitor.
Allowed values: "0", "1"
Default value: "1"
"0" Job logging is not written to the log file.
"1" Job logging is written to the log file.
(TRACE)
file=
event=
trcmode=
trccount=
(SMFExit)
Modulname=
Name of the SMF Exit module for the external Job Monitor.
142
Chapter 3 Configuration
SMF_Buffersize=
Size of the Common Area Data Space (CADS) in which the SMF Exit stores
Events (in MB).
Allowed values: "1" - "2048"
Default value: 10
About 65000 Events can be stored with 10 MB.
ABENDNUM=
CADSEyeCatcher=
Automation Engine
143
See also:
Notes for Configuration-File Adjustments
3.1.5 Utilities
AE DB Archive
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
helplib=
144
Chapter 3 Configuration
helpcache=
language=
logging=
logcount=
MaxDeadlockCount=
docu_path=
cmd=
path=
title=
This parameter serves internal purpose in the utility. The value must not be
changed.
alloc_size=
The utility processes the data records block by block. This parameter
specifies the block size (number of data records).
Default value: 200 000
[ENVIRONMENT]
classpath=
The path and the file name of the archive for layout files.
[TRACE]
file=
trccount=
database=
Automation Engine
[AH_BODY]
This section serves to specify the data that should be written to the
archiving file.
"1" - Data is included in the archiving process.
"0" - Data is not included in the archiving process.
AH_TimeStamp1=
Activation time.
AH_TimeStamp1=
Start time.
AH_TimeStamp4=
End time.
AH_MsgNr=
AH_LoginDst=
AH_ProcessId=
TNS/Process ID.
AH_CpuTime=
AH_KernelTime=
AH_UserTime=
AH_IOCount=
IO counter.
AH_InfoText=
AH_HostDst=
AH_CodeNameDst=
AH_FileNameDst=
AH_HostSrc=
AH_LoginSrc=
AH_CodeNameSrc=
AH_FileNameSrc=
AH_Count=
AH_FileSize=
AH_Records=
AH_Status=
AH_RetCode=
AH_Restart=
AH_RefNr=
AH_RestartPoint=
AH_LastRP=
AH_EventType=
AH_RepeatType=
Event:
R = repeated
S = single
File transfer: include subdirectories
R = yes
S = no
145
146
Chapter 3 Configuration
AH_TimePeriod=
AH_CheckCount=
AH_OccurCount=
AH_EventSubType=
AH_Operator=
G = greater
L = less
E = equal
N = not equal
AH_Value=
Comparing value
AH_Unit=
AH_Cancel=
AH_Source=
WIN_EVENT: Source
AH_Category=
WIN_EVENT: Category
AH_TExecType=
AH_MaxRetCode=
AH_IntAccount=
AH_Name=
AH_Transferred=
AH_Compress=
AH_Ert=
Estimated runtime.
AH_Archive1=
AH_Archive2=
AH_Info=
AH_ParentAct=
AH_ParentPrc=
AH_DeleteFlag=
Deletion flag.
AH_TaskCount=
Automation Engine
AH_ArchiveFlag=
AH_Rest=
Additional attributes.
AH_TZ=
AH_TimePeriodTZ=
AH_ReuseHostGroup=
AH_HGSrc=
AH_HGDst=
AH_MaxParallelHG=
AH_ChildCnt=
AH_ChildCntFail=
AH_ChildCntFailAll=
AH_ChildCntRestart=
AH_ContainerType=
[ODBC]
147
148
Chapter 3 Configuration
Automation Engine
See:Notes for Configuration-File Adjustments
149
150
Chapter 3 Configuration
[ENVIRONMENT]
classpath=.;.\UC4LAF.jar
[TRACE]
file=..\TEMP\UCYBDBArchiv_TRACE_##.TXT
trccount=10
database=0
[AH_BODY]
AH_TimeStamp1
= 1
AH_TimeStamp4
= 1
AH_MsgNr
= 1
AH_LoginDst
= 1
AH_ProcessId
= 1
AH_CpuTime
= 1
AH_KernelTime
= 1
AH_UserTime
= 1
AH_IOCount
= 1
AH_InfoText
= 1
AH_HostDst
= 1
AH_CodeNameDst
= 1
AH_FileNameDst
= 1
AH_HostSrc
= 1
AH_LoginSrc
= 1
AH_CodeNameSrc
= 1
AH_FileNameSrc
= 1
AH_Count
= 1
of started activities
AH_FileSize
= 1
AH_Records
= 1
AH_Status
= 1
AH_RetCode
= 1
AH_Restart
= 1
AH_RefNr
= 1
AH_RestartPoint
= 1
AH_LastRP
= 1
AH_EventType
= 1
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
;
start time
end time
return code
name of Login object
TSN / process id
used CPU time
used kernel time
used user time
count of I/Os
text from agent
name of the agent or agentgroup
codetable for filetransfer
filename for filetransfer
name of agent (sender)
name of Login object for sender file
codetable for filetransfer (sender)
filename for filetransfer (sender)
filetransfer: bytes transfered
group: number
;
;
;
;
;
;
;
;
;
Automation Engine
151
execution)
AH_RepeatType
= 1
; EV: R=repeated, S=single
FT: include
subdirectories R=yes S=no
AH_TimePeriod
= 1
; period in minutes or HHMM depending on the event
type
AH_CheckCount
= 1
; number of checks
AH_OccurCount
= 1
; number of occourred events
AH_EventSubType
= 1
; event sub type
AH_Operator
= 1
; G = Greater L = Less E = Equal N = NotEqual
AH_Value
= 1
; value to compare
AH_Unit
= 1
; unit of AH_Wert: 0=host specific, 1 = Byte, 2=KB,
3 = MB, 4=GB, 5=TB
AH_Cancel
= 1
; the cancel flag: M=manually
AH_Source
= 1
; WIN_EVENT: Source
AH_Category
= 1
; WIN_EVENT: Category
AH_TExecType
= 1
; EV-TS: start after 'start time' E=Execute
N=NoExecute EV-TT:S=start immediately
FT: 1=filetransfer with wildcard
characters
AH_MaxRetCode
= 1
; up to this retcode the activity is ENDED_OK
AH_IntAccount
= 1
; account
AH_Name
= 1
; name of the object
AH_Transferred
= 1
; Transferred bytes
AH_Compress
= 1
; Compress level
AH_Ert=1;Estimated runtime
AH_Archive1
= 0
; archive key 1
AH_Archive2
= 0
; archive key 2
AH_Info
= 0
; additional information like job number
AH_ParentAct
= 0
; AH_Idnr of activator parent
AH_ParentPrc
= 0
; AH_Idnr of processor parent
AH_DeleteFlag
= 0
; the delete flag
AH_TaskCount
= 0
; number of AJPP
AH_ArchiveFlag
= 0
; archive flag
AH_Rest
= 0
; . additional attributes
AH_TZ
= 0
; Timezone for object and script
AH_TimePeriodTZ
= 0
; Timezone for time period (event) when HHMM is
used
AH_ReuseHostGroup = 0
; reuse agentgroup in workflow
AH_HGSrc
= 0
; name of agentgroup
AH_HGDst
= 0
; name of agentgroup (source)
AH_MaxParallelHG = 0
; agentgroup max parallel
AH_ChildCnt
= 0
; children count
AH_ChildCntFail
= 0
; failed children - successful restarted
AH_ChildCntFailAll= 0
; failed children total
AH_ChildCntRestart= 0
; restarted children
AH_ContainerType = 0
; object type controlled by the container
[ODBC]
; ODBCVAR
;
;
;
;
;
;
xxxxxxxx
|||||||+
||||||+|||||+-||||+--|||+---||+-----
152
Chapter 3 Configuration
ORACLE !!)
;
|+------ D =
Oracle memory leaks)
;
+------- S =
;
;
SNNNNNRN for
;
NNNNNNRN for
;
NNJNINRO for
;
NNJNIORD for
AE DB Change
Structure of the INI File UCYBCHNG.INI
Section/Parameter
Description
[GLOBAL]
Helplib=
Helpcache=
logging=
logcount=
Automation Engine
language=
153
AE DB Client Copy
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
helplib=
Helpcache=
154
Chapter 3 Configuration
language=
docu_path=
logging=
logcount=
WorkTablePath=
DeadlockCnt=
cmd=
path=
title=
This parameter is used internally within the utility. The value must not be
changed.
CommitCntDel=
The number of data records that should be deleted at once when clients are
removed (only for MS SQL Server and Oracle databases). This parameter
can improve the performance of the running system during the deletion
process.
Default value: 0 (all data records are deleted at once)
[ENVIRONMENT]
classpath=
The path and the file name of the archive for layout files.
[TRACE]
file=
trccount=
database=
[SOURCEDB]
Automation Engine
155
156
Chapter 3 Configuration
[TARGETDB]
TargetDB=
CommitCnt=
[ENVIRONMENT]
classpath=.;.\UC4LAF.jar
[TRACE]
file
= ..\TEMP\UCYBCLICPY_TRACE_##.txt
trccount = 10
database = 0
;0=nein
;1=SQL
;2=OPC
;3=BindParam
;4=Datenbereiche
[SOURCEDB]
; ODBCVAR xxxxxxxx
;
|||||||+
;
||||||+;
|||||+-;
||||+--;
|||+---;
||+-----
Automation Engine
ORACLE !!)
;
|+------ D =
Oracle memory leaks)
;
+------- S =
;
;
SNNNNNRN for
;
NNNNNNRN for
;
NNJNINRO for
;
NNJNIORD for
;
NNJNIORZ for
157
[TARGETDB]
TargetDB
CommitCnt
= 1
= 1000
AE DB Load
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
logging=
158
Chapter 3 Configuration
logcount=
language=
Language.
Allowed values: "D", "F" and "E" (default)
"D" = German
"F" = French
"E" = English
The language that you select when you log on affects the utility's interface
and the log-file messages. When you select several languages here, the
first language is used as the default language.
helplib=
helpcache=
INPUT=
cmd=
path=
title=
This parameter serves internal purpose in the utility. The value must not be
changed.
docu_path=
[ENVIRONMENT]
classpath=
The path and the file name of the archive for layout files.
[TRACE]
file=
trccount=
database=
[ODBC]
Automation Engine
159
160
Chapter 3 Configuration
Automation Engine
161
[ENVIRONMENT]
classpath=.;.\UC4LAF.jar
[TRACE]
file=..\TEMP\UCYBDBLD_TRACE_##.TXT
trccount=10
database=0
; 0=no
; 1=SQL
; 2=OPC
; 3=BindParam
; 4=data fields
[ODBC]
; ODBCVAR xxxxxxxx
;
|||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
;
||||||+- R=compress messages and local memory
;
|||||+-- O = with userid, N = without userid
;
||||+--- I=OCI/CLI N=ODBC
;
|||+---- not used
;
||+----- J = compare fieldnames case-insensitiv (in case of
ORACLE !!)
;
|+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
;
+------- S = use Server-Cursor (SQL-SERVER)
;
;
SNNNNNRN for SQL-Server 2000
;
NNNNNNRN for SQL-Server 2005
;
NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
;
NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)
; SQL-Server 2000 with ODBC
SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
162
Chapter 3 Configuration
AE DB Reorg
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
helplib=
Helpcache=
language=
docu_path=
logging=
logcount=
cmd=
path=
title=
This parameter serves internal purpose in the utility. The value must not be
changed.
alloc_size=
The utility processes the data records block by block. This parameter
specifies the block size (number of data records).
Default value: 200 000
[ENVIRONMENT]
Automation Engine
classpath=
163
The path and the file name of the archive for layout files.
[REORG]
no_archive_check=
Archiving check.
"0" = Checks if data has been archived before.
"1" = There is no such check.
auto_reorg=
[TRACE]
file=
trccount=
database=
[ODBC]
164
Chapter 3 Configuration
Automation Engine
See: Notes for Adjusting Configuration Files
165
166
Chapter 3 Configuration
[ENVIRONMENT]
classpath=.;.\UC4LAF.jar
[REORG]
no_archive_check=0
auto_reorg=365
[TRACE]
file=..\TEMP\UC_DBReorg_TRACE_##.TXT
trccount=10
database=0
[ODBC]
; ODBCVAR xxxxxxxx
;
|||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
;
||||||+- R=compress messages and local memory
;
|||||+-- O = with userid, N = without userid
;
||||+--- I=OCI/CLI N=ODBC
;
|||+---- not used
;
||+----- J = compare fieldnames case-insensitive (in case of
ORACLE !!)
;
|+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
;
+------- S = use Server-Cursor (SQL-SERVER)
;
;
SNNNNNRN for SQL-Server 2000
;
NNNNNNRN for SQL-Server 2005
;
NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
;
NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)
; SQL-Server 2000 with ODBC
SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4
Automation Engine
167
See also:
General Procedure - Database Maintenance
Reorganization
AE DB Reporting Tool
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
logging=
logcount=
helplib=
helpcache=
Deadlock_Retry=
It is not possible to determine the period between two attempts. The actual
duration is a random number which lies between several milliseconds and
a maximum of 10 seconds.
[OPTIONS]
fixFieldOrder=
[TRACE]
file=
trccount=
database=
168
Chapter 3 Configuration
reptool=
[ODBC]
Automation Engine
169
170
Chapter 3 Configuration
Automation Engine
171
[OPTIONS]
fixFieldOrder=0
[TRACE]
file=..\TEMP\TRACE_REP_##.TXT
trccount=10
database=1
; 0=no
; 1=SQL
; 2=OPC
; 3=BindParam
; 4=data fields
reptool=9
[ODBC]
; ODBCVAR xxxxxxxx
;
|||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
;
||||||+- R=compress messages and local memory
;
|||||+-- O = with userid, N = without userid
;
||||+--- I=OCI/CLI N=ODBC
;
|||+---- not used
;
||+----- J = compare fieldnames case-insensitive (in case of
ORACLE !!)
;
|+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
;
+------- S = use Server-Cursor (SQL-SERVER)
;
;
SNNNNNRN for SQL-Server 2000
;
NNNNNNRN for SQL-Server 2005
;
NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
;
NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)
; SQL-Server 2000 with ODBC
SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4
See also:
172
Chapter 3 Configuration
Reporting
AE DB Revision Report
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
language=
logging=
logcount=
helplib=
helpcache=
[TRACE]
file=
trccount=
database=
[ODBC]
Automation Engine
173
174
Chapter 3 Configuration
[TRACE]
file
= ..\TEMP\UCYBDBRR_trc_##.txt
trccount = 10
database = 0
; 0=no
; 1=SQL
; 2=OPC
; 3=BindParam
; 4=data fields
trclevel=0
; 0=no
; 2=trace
[ODBC]
; ODBCVAR xxxxxxxx
;
|||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
;
||||||+- R=compress messages and local memory
;
|||||+-- O = with userid, N = without userid
;
||||+--- I=OCI/CLI N=ODBC
;
|||+---- not used
;
||+----- J = compare fieldnames case-insensitiv (in case of
ORACLE !!)
;
|+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
;
+------- S = use Server-Cursor (SQL-SERVER)
;
;
SNNNNNRN for SQL-Server 2000
;
NNNNNNRN for SQL-Server 2005
;
NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
;
NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)
; SQL-Server 2000 with ODBC
SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4
See also:
Revision Report
Automation Engine
175
AE DB Unload
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
Description
[GLOBAL]
logging=
logcount=
OUTPUT=
The path and the name of the file that contains the unloaded data.
helplib=
Helpcache=
Reorg_Commit_Sleep=
The waiting time in milliseconds after the data records have been deleted.
This specification can be used to avoid that the database is permanently
blocked. The number of data records is defined with CommitCount=.
Default value: 100
CommitCount=
language=
Language.
Allowed values: "D", "F" and "E" (default)
"D" = German
"F" = French
"E" = English
The language that you select when you log on affects the utility's interface
and the log-file messages. When you select several languages here, the
first language is used as the default language.
docu_path=
cmd=
The command line command that can be used to start the utility.
path=
title=
This parameter serves internal purpose in the utility. The value must not be
changed.
[ENVIRONMENT]
176
Chapter 3 Configuration
classpath=
The path and the file name of the archive for layout files.
[TRACE]
file=
trccount=
database=
[TRANSPORT]
all_entities=
The setting for the scope of the unloaded data in the Transport Case.
Allowed values: "0" (default value) and "1"
"0" = Only object attributes that contain a value are exported.
"1" = The utility exports all object attributes regardless of their contents.
This setting is important if the unloaded data is subsequently changed by
using AE.DB Change.
Activate this setting if data is unloaded from the system client by
means of a Transport Case which should subsequently be loaded to
other clients.
[REORG]
no_archive_check=
Archiving check.
Allowed values: "0" (default value) and "1"
"0" = Checks if the data has been archived before.
"1" = There is no such check.
reorg_chunk_size=
The number of data records of the relevant top table (such as "AH") that
should be deleted per transaction including all its corresponding entries in
sub-tables.
The system uses the default value when you specify a value that does not
lie within the allowed range of values.
Allowed values: "50" to "5000"
Default value: "1000"
reorg_sleep_time=
The waiting time in milliseconds that the system should wait after each
deletion transaction.
Allowed values: "0" (default) to "10000"
max_deadlock=
[ODBC]
Automation Engine
177
178
Chapter 3 Configuration
Automation Engine
179
[ENVIRONMENT]
classpath=.;.\UC4LAF.jar
[TRACE]
file=..\TEMP\UCYBDBUN_TRACE_##.TXT
trccount=10
database=0
; 0=no
; 1=SQL
; 2=OPC
; 3=BindParam
; 4=data fields
[REORG]
reorg_chunk_size=1000
no_archive_check = 0
max_deadlock
= 100
[TRANSPORT]
all_entities = 1
[ODBC]
; ODBCVAR xxxxxxxx
;
|||||||+
;
||||||+;
|||||+-;
||||+--;
|||+---;
||+----ORACLE !!)
;
|+------
180
Chapter 3 Configuration
NAME=
WAITTIME=
POOLSIZE=
UCON=
LOGGING=
LOGCOUNT=
Automation Engine
LANGUAGE=
181
The language in which the logging is executed. Entries for primary and secondary
language.
Allowed values: "E", "D", "F"
Default: "E,D" (primary English, secondary German)
If there is no message in the primary language, a search is made for a message in
the secondary language.
(TRACE)
FILE=
TRCCOUNT=
TCP/IP=
(TRACE)
FILE=L.TRACE.UCXEB24U.##
TRCCOUNT=5
TCP/IP=0
See also:
Notes for Adjusting Configuration Files
182
Chapter 3 Configuration
3.1.6 ServiceManager
ServiceManager - Service
The ServiceManager serves to start, stop and access components such as the Automation Engine
processes or agents from a central point.
The parameters of the ServiceManager (Service) are the same for Windows and UNIX.
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment at any case are written in red letters.
Description
[GLOBAL]
language=
Language in which logging is carried out. Entries for primary and secondary
language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary language English, secondary language German)
If there is no message in the primary language, the secondary language will
be searched for a message.
logging=
logcount=
helplib=
helpcache=
port=
Automation Engine
restart_limit=
183
password=
[TRACE]
file=
trccount=
cmd=
Trace-flag commands.
Allowed values: "0" to "9"
Default value: "0"
[DestinationPhrase]
deffile=
Name of the SMD file in which the AE services within the starting sequence
are defined.
The path specification "*OWN" designates its own path and is important here
as it has to do with a service.
cmdfile=
184
Chapter 3 Configuration
[TRACE]
file=*OWN\..\temp\SMgr_TRACE_##.txt
cmd=0
[Destination UC01]
deffile=*OWN\UC01.smd
cmdfile=*OWN\UC01.smc
See also:
Setup of the SMD File
Syntax
DEFINE Service; component INI file; Working directory [; -svc%port%] [; LOGON=
(User name, Password, Domain )] [; Start1=() ; Start2=(); Start3=() etc.]
Syntax
Description/Format
Service
Service name.
You can also use blanks.
component
Automation Engine
185
Working directory
-svc%port%
LOGON=
Start1=
Start2=
etc.
186
Chapter 3 Configuration
You can structure variables in order to increase their readability because the individual lines can be very
long.
For example:
VAR Name of the variable;value of the variable
The SMD file is divided in two parts. All VAR statements must be listed in the beginning, then the DEFINE
statements are listed.
Within a DEFINEline, you can insert a variable by specifying a "*" followed by the variable name.
! Server processes
DEFINE UC4 CP1;*CP_STARTCMD;*SRV_PATH
DEFINE UC4 WP1;*WP_STARTCMD;*SRV_PATH;START1=(Coldstart,*WP_START1);START2=
(Systemstop,*WP_START2);START3=(Coldstart with Systemstop,*WP_START3)
! Windows agents
DEFINE WIN01;*OWN\..\..\AgentWin\bin\UCXJWI3.exe;*OWN\..\..\AgentWin\bin\
DEFINEUC4MAIL;C:\AUTOMIC\Agents\win\bin\UCXJWI3.exeUC4MAIL.ini;C:\AUTOMIC
\Agents\win\bin;LOGON=(uc4mail,10D888EA16FE7D2C0FE,)
! SAP agent
DEFINE SAP01;java -jar -Xrs -Xmx256M ucxjr3x.jar;*OWN\..\..\Agents\SAP\bin
Syntax
WAIT Time delay for start in seconds
CREATE Name of the AE service
Automation Engine
187
Description
[GLOBAL]
size=
admin=
port=
[HOST-Name List]
This list is generated automatically. It specifies all the hosts selected in the
Dialog Program. Additionally, the descriptions of the last selected host and
the ServiceManager environment are stored, in order to display them
immediately if the dialog program is restarted.
Hostnn=
LastName=
LastDest=
188
Chapter 3 Configuration
[HOST-Name List]
Host01=dialogpc
Host02=testsys
Host03=uc4prod
LastName=uc4prod
LastDest=UC4
3.1.7 CallAPI
Utility for BS2000
Structure of the INI File x.xxx.UCXBB2?C.INI
Section/Parameter
Description
(GLOBAL)
SYSTEM=
HELPLIB=
LANGUAGE=
The language in which the logging is processed. Entries for primary and
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
TIMEOUT=
The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.
Default value: 60
With the parameter TIMEOUT=0 being used, the CallAPI waits (without
time limit) until the Automation Engine acknowledges.
CODETABLE=
The name of the CodeTable object that should be used by the CallAPI
trace
Trace designation.
Allowed values:
"0" (default) = Deactivate trace
"1" = Activate trace
If the trace parameter is set to 1, additional information is written to STDOUT
Automation Engine
QUEUE=
(USER)
CLIENT=
189
USER=
DEPT=
PASS=
(CP_LIST)
(USER)
CLIENT=
USER=
DEPT=
PASS=
(CP_LIST)
2217=uc4srv01
; 2218=uc4srv02
See also:
Notes for Configuration-File Adjustments
190
Chapter 3 Configuration
Description
[GLOBAL]
system=
helplib=
language=
The language in which the logging is executed. Entries for primary and
secondary language.
Allowed values: "E", "D"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
logcount=
logging=
[USER]
client=
user=
dept=
pass=
[CP_LIST]
Automation Engine
191
[USER]
client=
user=
dept=
pass=
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
Notes for Configuration-File Adjustments
Description
[GLOBAL]
system=
language=
The language in which the logging is processed. Entries for primary and
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
timeout=
The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.
Default value: 60
[USER]
192
Chapter 3 Configuration
client=
user=
dept=
pass=
[CP_LIST]
[USER]
client=3
user=smith
dept=uc4
pass=
[CP_LIST]
2217=uc4srv01
See also:
Notes for Configuration-File Adjustments
Description
[GLOBAL]
system=
helplib=
Automation Engine
language=
193
Language in which the logging is executed. Entries for primary and secondary
language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
logging=
logcount=
timeout=
The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.
Default value: 60
TRACE
Trace designation.
Allowed values:
"0" (default) = Deactivate trace
"1" = Activate trace
If the trace parameter is set to 1, additional information is written to STDOUT
[USER]
client=
user=
dept=
pass=
[CP_LIST]
194
Chapter 3 Configuration
[USER]
client=
user=
dept=
pass=
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
Notes for Configuration-File Adjustments
Description
(GLOBAL)
system=
helplib=
language=
Language in which the logging is executed. Entries for primary and secondary
language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
Automation Engine
timeout=
195
Time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.
Default value: 60
With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
codetable=
queue=
(USER)
client=
user=
dept=
pass=
(CP_LIST)
(USER)
client=
user=
dept=
pass=
(CP_LIST)
2217=uc4srv01
; 2218=uc4srv02
196
Chapter 3 Configuration
See also:
Notes for Configuration-File Adjustments
Description
[GLOBAL]
system=
helplib=
language=
The language in which the logging is processed. Entries for primary and
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
logging=
logcount=
timeout=
The OS/400 CallAPI writes output to JobLog instead of a log file and standard
out. Therefore, these parameters are ignored in the INIfile for OS/400.
The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.
Default value: 60
With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
Automation Engine
queue=
197
TRACE
Trace designation.
Allowed values:
"0" (default) = Deactivate trace
"1" = Activate trace
If the trace parameter is set to 1, additional information is written to STDOUT
[USER]
client=
user=
dept=
pass=
[CP_LIST]
[USER]
client=
user=
dept=
pass=
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
Notes for Configuration-File Adjustments
198
Chapter 3 Configuration
Description
[GLOBAL]
system=
helplib=
language=
The language in which the logging is executed. Entries for primary and
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
logging=
logcount=
timeout=
The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.
Default value: 60
With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
queue=
trace
Trace designation.
Allowed values:
"0" (default) = Deactivate trace
"1" = Activate trace
If the trace parameter is set to 1, additional information is written to STDOUT
[USER]
client=
Automation Engine
user=
dept=
pass=
[CP_LIST]
[USER]
client=
user=
dept=
pass=
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
Notes for Configuration-File Adjustments
Description
[GLOBAL]
system=
helplib=
199
200
Chapter 3 Configuration
language=
The language in which the logging is processed. Entries for primary and
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
logging=
logcount=
timeout=
The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.
Default value: 60
With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
queue=
trace
Trace designation.
Allowed values:
"0" (default) = Deactivate trace
"1" = Activate trace
If the trace parameter is set to 1, additional information is written to STDOUT
[USER]
client=
user=
dept=
pass=
[CP_LIST]
Automation Engine
201
[USER]
client=
user=
dept=
pass=
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
Notes for Configuration-File Adjustments
Description
(GLOBAL)
system=
helplib=
language=
The language in which the logging is processed. Entries for primary and
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
timeout=
The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.
Default value: 60
202
Chapter 3 Configuration
trace
Trace designation.
Allowed values:
"0" (default) = Deactivate trace
"1" = Activate trace
If the trace parameter is set to 1, additional information is written to STDOUT
(USER)
client=
user=
dept=
pass=
(CP_LIST)
(USER)
client=
user=
dept=
pass=
(CP_LIST)
2217=uc4srv01
; 2218=uc4srv02
See also:
Notes for Configuration-File Adjustments
Automation Engine
203
Description
(GLOBAL)
system=
helplib=
language=
The language in which the logging is processed. Entries for primary and
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
timeout=
The time in seconds during which the CallAPI waits for a response from the
Automation Engine. If this is exceeded, the CallAPI ends with a timeout error.
Default value: 60
With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
queue=
(USER)
client=
user=
dept=
pass=
(TRACE)
file=
trccount=
204
Chapter 3 Configuration
(CP_LIST)
[USER]
client=
user=
dept=
pass=
[TRACE]
file=.\trace##.txt
trccount=20
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
Notes for Configuration-File Adjustments
RFC Server
Default values have been specified for the most parameters. They can be changed if needed.
Parameters that must be adjusted to your system environment at any case are written in red letters.
Description
[GLOBAL]
system=
AE system.
This entry must be identical to the entry in the INI file of the Automation
Engine.
Automation Engine
logging=
205
logcount=
language=
The language in which the logging is processed. Entries for primary and
secondary language.
Allowed values: "E", "D", "F"
Default: "E,D" (Primary English, secondary German)
If there is no log in the primary language, a log in the secondary language is
searched for.
Helplib=
CHANGE_LOGGING_
DAYS=
The number of days, after which the log file should be changed.
CHANGE_LOGGING_
MB=
max_logging_kb=
log_to_file=
TimeOut=
The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.
Default value: 60
With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
[USER]
client=
user=
dept=
206
Chapter 3 Configuration
pass=
[RFC]
hostname=
PROGID=
GWSERV=
RFC_TRACE=
unicode=
[CP_LIST]
Automation Engine
207
See also:
Notes for Configuration-File Adjustments
Description
[GLOBAL]
system=
208
Chapter 3 Configuration
language=
logging=
logcount=
helplib=
helpcache=
loglevel=
MaxJobs=
ExecTimeOut=
[TCP/IP]
CP=
connect=
[TRACE]
Automation Engine
file=
209
trccount=
trclevel=
[MQSERIES]
ConnName=
QueueName=
UseLibrary=
210
Chapter 3 Configuration
[TCP/IP]
CP=UC4SRV01:2104
connect=300
[TRACE]
file=..\temp\UCXBMQCS_trc##.txt
trccount=3
trclevel=0
[MQSERIES]
ConnName=MQSRV:1414
; SvrconnChannelName = system.admin.svrconn
QMgrName=queue.manager1
QueueName=UC4CInputQueue
See also:
Notes for Configuration-File Adjustments
Automation Engine
211
For
To be changed by
Client
UC_AGENT_
ASSIGNMENT
Host Assignment
0000
UC_AS_
SETTINGS
Advanced Security
UC_AUTO_
FORECAST
Auto-Forecast data
UC_CALENDAR_
PERIOD
Calendar periods
administrator
xxxx
or
0000
UC_CLIENT_
SETTINGS
administrator
xxxx
UC_EX_ERP_
CONNECT
Connections to
Enterprise Business
Solutions
administrator
0000
UC_EX_
HOSTCHAR
administrator
0000
UC_HOSTCHAR_
DEFAULT
Host characteristics
administrator
0000
UC_ILM_
CONTAINER_*
Partitions in the AE
database
administrator, AE DBLoad
0000
UC_ILM_
SETTINGS
Settings - Partitioning
with ILM
administrator, AE DBLoad
0000
UC_JOB_
Periodical time check in
CHECKINTERVAL the Automation Engine
administrator
0000
UC_LDAP_
EXAMPLE
LDAP connection
administrator
xxxx
or
0000
UC_LOGIN_
TYPES
administrator
0000
UC_OBJECT_
COUNTER
administrator
xxxx
or
0000
administrator, AE DBLoad
AutoForecast (changes automatically
changed when AutoForecast is used)
0000
xxxx
212
Chapter 3 Configuration
UC_OBJECT_
DOCU
Documentation of
objects
administrator
xxxx
or
0000
UC_OBJECT_
TEMPLATE
administrator
xxxx
or
0000
UC_REPORT_
STYLESHEETS
administrator
xxxx
or
0000
UC_SENDTO
UC_SENDTO_
ACT
Internal/external handling
of objects and tasks
administrator
xxxx
or
0000
UC_STATISTIC_
OPTIONS
administrator
xxxx
or
0000
UC_SYSTEM_
SETTINGS
System-wide settings
administrator
0000
UC_USER_
LOGON
administrator
0000
UC_SAP_XJBP_
EVENTTYPES
UC_UTILITY_
ARCHIVE
Specifications for
archiving runs
UC_UTILITY_DB_
UNLOAD
Executed reorganization
runs
0000
UC_UTILITY_
REORG
Specifications for
reorganization runs
xxxx
or
0000
UC_SNMP_
VALUES
SNMP values
UC_USER_HOST
xxxx
or
0000
UC_USER_
LANGUAGE
xxxx
or
0000
0000
Note, that there are some more variables available in AE systems, but they are of minor importance.
The full range of variables you can obtain from Automation Engine Administration Guide.
Value
Restart required
Automation Engine
213
Description
This variable is automatically adjusted when the list of active Agent/Client Assignment objects is changed
in the System Overview. And in reverse, the System Overview is also updated when a modification is
made in the variable.
The order of the Agent/Client Assignment objects is decisive for the assignment of rights if filter
settings overlap.
See also:
Table Overview of all variables
Variable
Agent/Client Assignment
Value
Restart
required
Server
Server
Encryption method
Allowed values:"NO", "AES-128", "AES-192" and "AES-256"
(default)
"NO" - No encryption method
"AES-128" - 128-bit key length
"AES-192" - 192-bit key length
"AES-256" - 256-bit key length
Server
214
Chapter 3 Configuration
Description
This variable is supplied in system client 0000. Its settings are valid throughout the whole AE system. It
can only be changed in client "0000".
It contains advanced security settings.
Ensure that only privileged persons can access this variable in order to avoid that a specified
encryption and authorization method is changed by accident.
See also:
Overview of all variables in Table Form
Variable
Advanced Security
Value
New start
required
No
CREATED
Object name,RunID
No
YYYY-MM-DDTHH:MM:SS
END
No
YYYY-MM-DDTHH:MM:SS
START
No
YYYY-MM-DDTHH:MM:SS
Description
This variable is created with the first use of the Auto Forecast and is updated automatically.
The Auto Forecast - which gives a preview on future activities - uses a predefined period of time for its
calculation. As a result thereof, forecasts are created for all Schedules and Events. The variable "UC_
AUTO_FORECAST" then contains the calculated data.
At the beginning of this variable, all Schedules and Events are listed with their running numbers (RunID).
The corresponding key is a running 16-digit number with leading zeros. The point in time when the last Auto
Forecast was created is noted in the variable, as well as the beginning and the end of the calculation
period. The terms CREATED, END and START are used as keys.
Automation Engine
215
See also:
Overview of all variables in table form
Variable
Auto Forecast
Value
Period name/Year
No
YYYY-MM-DD HH-MM-SS
Description
The variable is supplied with system client 0000. From there it can be copied into your own client and
customized to your requirements.
The variable "UC_CALENDAR_PERIOD" serves to define the periods to be shown when "Period view" is
called. Use a line for each period and its start date. The entries in the column "Key" must be unique. The
name written before the slash is displayed as the period's name in the Calendar view.
A period lasts from its start time until the next period's start time.
The last period ends on the beginning of the day and month of the very first period.
At least two periods should be defined to be able to call the periodic view in the Calendar tab.
Example
As a result of the entries shown below, the periodic view displays the year 2006 in quarters.
Key
Value
Quarter 1/2006
2006-01-01 00:00:00
Quarter 2/2006
2006-04-01 00:00:00
Quarter 3/2006
2006-07-01 00:00:00
Quarter 4/2006
2006-10-01 00:00:00
See also:
Overview of all variables in table form
Variable
Calendar
216
Chapter 3 Configuration
Some settings that are stored in the AE Variables can differ from client to client. They regulate the
system's behavior when a Automation Engine starts, or the authorization system's access control
management, they determine the maximum life-span of user passwords, or log the system status.
The same settings are also available in the Client object and can be edited here.
Key
Value
Restart
required
ALIAS_
SPECIAL_
CHARACTERS
No
Default value: -#
Blanks are ignored.
API_QUEUE
No
No
AUTO_
FORECAST_
PREFIX
CALE_LOOK_
AHEAD_MAX
Server
CALE_WARN_
LEVEL
Server
CLIENT_
PRIORITY
No
CLIENT_
STATUS
UserInterface
DEPLOYMENT_
CLIENT
UserInterface
EH_KICK_
INTERVAL
The refresh interval that can be specified for the task view in the
Activity Window and monitors.
Default value: 3 seconds
No
Automation Engine
ERT_METHOD
No
No
ERT_CORR_
PERCENT
ERT_IGNORE_
PERCENT
ERT_MINIMUM_
COUNT
ERT_
CALCULATION
No
No
217
218
Chapter 3 Configuration
No
"1" - Sunday
"2" - Monday
"3" - Tuesday
"4" - Wednesday
"5" - Thursday
"6" - Friday
"7" - Saturday
FIRST_WEEK_
METHOD
The definition of the week that is regarded the first calendar week
of a year.
No
Allowed values: 1, 4, 7
Default value: "4"
"1" - The week that includes January 1st.
"4" - The first week that includes at least 4 day of the new year.
"7" - The first week that includes 7 days of the new year.
JOBP_SAVE_
INCOMPLETE
UserInterface
MAX_USER_
INTERFACES
No
No
No
No
No
Automation Engine
PROMPT_
TIMEOUT
The time in minutes that the system waits for a user to log on in
order to display a PromptSet dialog.
No
No
PWD_
The number of invalid login attempts.
ATTEMPTS_MAX
No
PWD_
CONTAINS_
LOWER_CASE
You can use this key to force the use of lowercase letters in user
passwords.
No
PWD_
CONTAINS_
NUMBER
You can use this key to force the use of numbers in user
passwords.
PWD_
CONTAINS_
SPECIAL_
CHARACTER
You can use this key to force the use of special characters in user
passwords.
PWD_
CONTAINS_
UPPER_CASE
You can use this key to force the use of uppercase letters in user
passwords.
PWD_FORBID_
LOGIN
You can use this key to forbid user names in user passwords.
PWD_
GENERATION
The number of the last n passwords that must not be used again.
PWD_LENGTH_
MAX
PWD_LENGTH_
MIN
SEARCH_
SCRIPT_FOR_
USAGE
No
No
219
220
Chapter 3 Configuration
SECURITY_
AUDIT_FAILURE
No
SECURITY_
AUDIT_
SUCCESS
SMTP_FROM_
ADDR
No
SMTP_LOGIN
The name of the Login object that is used to log on to the SMTP
Server.
No
SMTP_MAX_
ATTACHMENT_
SIZE
The maximum size (in bytes) for the report file that is sent via
email.
No
Default value:"8000"
Minimum value: "400"
Maximum value:"50000"
In the Notification tab of the Notification object, you can enter the
RunID of a task whose reports should be included in the message.
The setting SMTP_MAX_ATTACHMENT_SIZElimits the reportfile sizes.
When the report file exceeds the maximum value,only the
allowed size is read and sent. The file end includes the
following note: "Truncated through SMTP_MAX_
ATTACHMENT_SIZE limit".
This limitation does not affect files that are sent via email.
SMTP_REPLY_
TO
No
SMTP_SERVER
No
SMTP_TIMEOUT
The maximum time in seconds that the system waits for an SMTP
Server to respond.
No
Server
No
Automation Engine
TEMPLATE_
SHOW_ALL
This key affects the list of object types that is shown when objects
are created.
221
No
No
No
VERSION_
MANAGEMENT_
SUFFIX
The part of the name that is inserted in objects that are created in
the sequel of a Version Management.
No
WAIT_STATE_
RECORDING
Allowed values:
"QUEUE" - Logs information about the waiting condition of all the
Queue's tasks in the database.
This option is deactivated when you specify a different value or no
value (=default value).
XRO_REPORTS
No
Description
The AE Variable is supplied in system client 0000. From here, you can copy it to your own client and
customize it according to your requirements.
ALIAS_SPECIAL_CHARACTERS
The alias name of workflow tasks which can be set in the properties (General tab) is limited to specific
characters. To allow characters in the alias names that are usually not available (such as "-"), you can
make use of this setting.
All the characters that should be allowed must be entered in a row, blanks will be ignored. The order of the
individual characters is irrelevant.
For example: To allow the characters "-", ":" and "+", you must specify the value in the format -:+.
222
Chapter 3 Configuration
API_QUEUE
In the Automation Engine, all tasks start in a Queue object. This also includes the execution of CallAPI
scripts. By default, the Client Queue (CLIENT_QUEUE) is used for CallAPIs. This key can be used to
specify a particular Queue object.
AUTO_FORECAST_DAYS
The Auto Forecast creates forecast data for activities on the basis of the time period that is specified using
this key. The higher the number of days, the longer the time that is required for the AutoForecast
calculation.
AUTO_FORECAST_PREFIX
The Auto Forecast creates forecast data for activities that run in Schedules and Events. A prefix needs to
be defined for these specific forecast data so that they can be distinguished from individually-created
forecasts. The whole forecast name consists of a prefix, the object's name, a date and must not exceed
200 characters.
CALE_LOOK_AHEAD_MAX
The maximum number of days that is considered when you calculate the next valid date using the script
element CALE_LOOK_AHEAD can be specified in this Variable on a client-wide basis. The default value
is "14". Keep this value low if you specify individual values in order to avoid performance losses.
CALE_WARN_LEVEL and CALE_WARN_CALL_OPERATOR
When the Automation Engine starts and when a new day begins, the validity dates of all Calendars are
checked whether they expire within the defined number of days. The specified Notification starts for each
Calendar whose validity date expires. The name of the Calendar can be read in the script using the READ
buffer as shown below:
:READ &UC_CAUSE_NAME,,
No alert is sent for Calendar objects of the system client 0000 because you cannot activate objects in
this client.
CLIENT_PRIORITY
You can specify a priority of AE's internal processing for each client. This includes that you can reduce the
priority of a non-productive client compared to a productive client. The default setting is 200 (see also: AE
priority).
CLIENT_STATUS
You can stop automatic processing and release it within a client. To change the system status, the User
requires the relevant privilege in order to do so. Only the system itself can write to the AE Variable.
DEPLOYMENT_CLIENT
If the client should be used for Application Release Automation, you can use this setting in order to
activate its Deployment functions.
Note that you cannot use the system client 0000 as a Deployment client.
When you activate this setting (Y), the Deployment tab becomes available in Workflows and the General
tab, which is available in the properties of Workflow tasks, includes the option "Run per Patch" .
EH_KICK_INTERVAL
If the properties of a task have changed (for example, start, status, end), the UserInterface receives a
message from the Server and the Activity Window and monitor view can be refreshed. You can specify the
Automation Engine
223
interval in which messages should be sent to the UserInterface in this key. In doing so, messages are sent
in blocks which has positive effects on the performance of your system.
No message is sent to the UserInterface if tasks do not change during an interval.
ERT_*
By deactivating the estimated runtime (ERT) calculation, you can improve the performance of the
Automation Engine. If it is deactivated (ERT_CALCULATION/BATCH), you can determine it
subsequently for all objects in the database. Use the utility AE.DB Load in order to load the file UC_UPD_
ESTIMATE_ERT.TXT. The duration for calculating the expected runtime depends on the number of
objects that is involved.
The file UC_UPD_ESTIMATE_ERT.TXT contains a line at its end that calls the ERT calculation
function. If you specify a client, ERT calculation takes place in this client, otherwise the whole system
is included in the calculation.
For example:
ESTIMATE_ERT 1000
All other validity keys that start with "ERT_" form the default values for calculating the expected runtime
(ERT). You can adjust them in the Runtime tab of each object if needed.
EXT_REPORTS
You can use this entry in order to specify whether extended reports should be created in addition to
standard reports, and which ones.
FIRST_DAY_OF_WEEK and FIRST_WEEK_METHOD
The key FIRST_WEEK_METHOD can be used to define the first calendar week of a new year. By default,
the week that includes at least 4 days of a new year is used as the first calendar week. You can also
determine the starting day of a week using the entry FIRST_DAY_OF_WEEK (default: Monday).
Note that the definitions that are made for the first calendar week influence the results of the script
function WEEK_NR which retrieves the calendar week.
JOBP_SAVE_INCOMPLETE
The tasks of a Workflow must be linked with lines in order to have them executed in the required order. You
can define a predecessor and a successor for each task. You can set storage properties using the
entryJOBP_SAVE_INCOMPLETE if some lines are missing. In this case, you can specify that the
Workflow should be stored (YES) or not (NO), or that it should only be stored after a request (ASK).
MAX_USER_INTERFACES
For each client, you can specify the maximum number of UserInterfaces that can be connected to the AE
system at the same time. If there is no entry, the system uses the value that is defined in the license. You
find this value in the "License" category ("DC" line) of the System Overview.
NOW_MINUS and NOW_PLUS
It is not required to specify a validity period if you create a Calendar keyword. The days are automatically
calculated on the basis of the determined date intervals.You can use these two keys to specify the
number of years that should be calulated to the past and to the future.
OBJECT_AUDIT
This setting can be used to activate object logging and store the results in Revision Reports.
PROMPT_RESPONSETIME, PROMPT_TIMEOUT
224
Chapter 3 Configuration
These settings define the maximum waiting time for a task that includes PromptSets. Depending on the
particular situation, the task aborts if this time is exceeded.
l
PROMPT_RESPONSETIME
Maximum time that the system waits until the user confirms a task's PromptSet input prompt. It is
irrelevant whether the dialog includes one or several PromptSet objects. The task aborts if this time
is exceeded. The time is reset when the input dialog is confirmed with "Done" (this is relevant for
Workflows, that display the PromptSet dialogs of several tasks in succession).
PROMPT_TIMEOUT
If a PromptSet input mask cannot be displayed because the particular user has not logged on, the
corresponding task switches to the waiting condition "Waiting for user input". In this case, the
maximum waiting time is the time that has been determined in PROMPT_TIMEOUT. The task
aborts if this time is exceeded.
The PromptSet dialog is called if the user logs on again within this time period.
The task aborts if the graphical interface is closed (UserInterface) although the PromptSet dialog is still
open.
PWD*
Settings for user passwords:
PWD_AGE_MAX
MAX_PASSWORD_AGE used in the key "Freely selected" serves to define the maximum life span of
user passwords. The value specifies the number of days (as an integer) that a password is valid. If 75% of
the value's life span is over, users are informed that the password will soon expire when they log on. If the
password has already expired, it must be changed the next time a user logs on. If there is no entry for this
key (default value), the system does not check the expiration time.
PWD_ATTEMPTS_MAX
Here you can limit the number of invalid login attempts. Users who exceed the specified value will be
locked. Authorized persons can unlock affected users in the corresponding User object. By default, the
number of invalid login attempts is not limited. The time delay until the message "Access denied" displays
increases as of the third invalid attempt.
PWD_GENERATION
This setting defines the last n passwords that must not be used again. The new password must differ from
these last n passwords. The Automation Engine stores all passwords and this key only determines the
number of passwords that are compared with the new password.
All other keys that start with "PWD" define the criteria that a user password must meet.
If no value is specified for the above settings, the system searches for a default value in the AE
Variable UC_SYSTEM_SETTINGS. It uses the fixed default value if it does not include these PWD
keys.
SEARCH_SCRIPT_FOR_USAGE
When deleting, renaming or manually searching the use of an object, AE checks if this object is used in
other objects as well (for example, in Schedules). If so, you can have a list of all these objects displayed.
With the specification of the key SEARCH_SCRIPT_FOR_USAGE and the values "Y" and "L", objects
that are used in Scripts (for example, ACTIVATE_UC_OBJECT) are included in the search. There are
different search types:
"Y" - The searched string is handled as a word that is enclosed in delimiters such as blanks, left and right
parentheses, equals, commas, single quotations, double quotations, end of lines and script ends.
For example: Searching for MM only lists results in which this term is enclosed in the listed delimiters.
Automation Engine
l
l
l
l
l
225
(MM)
=MM=
'MM'
(MM,
=MM at the end of a line
Underscores are not delimiters. Searching for MM is not successful if you search for _MM_.
Searching by using the option "Y" is more complex and takes longer.
"L" - The searched string must be somewhere in the script as otherwise, it is not displayed as a search
result.
For example: Searching for MM lists results in which this term is included as a whole or partially.
l
l
l
MM
MM.CLOSING
AE.MM.DAY
226
Chapter 3 Configuration
TEMPLATE_SHOW_ALL
The content of the selection dialog that is shown while an object is created depends on the following
factors:
l
l
If value "N" has been specified, only the object types that can be created by the particular user (for
example, the user has a "write" privilege) are listed.
If you specify "Y", the users can see all the object types but can only create objects for which they have
write access. If a filter has been placed in the authorizations (see: user, user groups), this filter is
compared to the name of the template when a new object is created.
VARA_ERROR_ON_REPLACEMENT
In the AE, you can insert values of Variable objects in the attributes of executable objects at runtime. As a
placeholder, specify the Variable name enclosed in {} brackets as and optionally the key and the column.
Notation:
{Variable object [, Key [, Column number ]] }
The placeholder is replaced by the corresponding value when the task is generated. The value of the
Result column (in dynamic variables) or the first Value column (in static variables) of the first entry (Key) is
used if neither a column nor a key have been specified.
The setting VARA_ERROR_ON_REPLACEMENTcan be used in order to determine whether the task
should be canceled if the specified Variable cannot be found. If "N" is used (system settings) and the
Variable object is not available, the attribute value including the invalid placeholder are assumed.
VERSION_MANAGEMENT and VERSION_MANAGEMENT_SUFFIX
The entry VERSION_MANAGEMENT can be used you determine whether the Version Management of
objects should be activated. If so, the entry VERSION_MANAGEMENT_SUFFIX is also important. It is
limited to 8 characters and is inserted in the name part of the object that has been duplicated for the version
management. Entries that include more characters are truncated. Note that the same naming conventions
apply for suffixes as for objects. Allowed are the characters: A-Z, 0-9, $, @, _, . and #. If you use German
Umlauts or do not enter a suffix, the default value "OLD" is used.
WAIT_STATE_RECORDING
This setting is only relevant when you want to monitor the time slot of tasks relating to Queues using the
Automic Product Predictive Analytics and / or Process Analytics.
When you set the value "QUEUE", the details of all tasks that are in a waiting status because of a Queue
stop or a Queue limit will be logged in the AE Database.
XRO_REPORTS
This key permits the activation of a particular logging that facilitates external report analyses of Jobs and
FileTransfers.
See also:
UC_SYSTEM_SETTINGS
Overview of all AE Variables in Table Form
Variable
Automation Engine
227
Value
Agent name
Connection string
Agent
Description
The variable is supplied in the client 0000. Settings made in it apply to the whole AE system.
The predetermined setting for the validity key is "Host - each host name" whose entries contain agent
names. The appropriate connection specifications which are identified by the agent itself are listed in the
column Value. Both information types are especially important to make full use of the Form tab's
functionality of PeopleSoft jobs.
A connection to the particular Enterprise Business Solution can be established when these jobs are
opened. The required data is determined by the selected agent (Attributes tab) and the corresponding
entry in the variable. In the Form tab, script elements and their different parameters can easily be entered
using ready-made forms. Particular values can be taken from the Enterprise Business Solution. If this is
possible, the symbol
data in table-form.
is available next to the control field which can be used to access the existing
If the agent should not retrieve the connection string automatically, you can specify your preferred one
with the parameter UC_EX_ERP_CONNECT in the INI file.
See also:
Overview of all variables in table form
Variable
Value
Name of the agent Name part of the variable which contains host characteristics Agent
Maximum 188 figures
Default value: DEFAULT
228
Chapter 3 Configuration
Description
This variable is provided in client 0000. Its setting applies for the entire AE system and can only be
changed from in client "0000".
It contains the appropriate host characteristics for every agent in the AE system. By default, host
characteristics are retrieved from the variable UC_HOSTCHAR_DEFAULT which is found in the system
client 0000. Duplicate this variable if different settings are required for particular hosts. The name of the
new variable must be composed of UC_HOSTCHAR_ and a user-defined suffix.
When an agent logs on to the Automation Engine, the Variable UC_EX_HOSTCHAR is scanned for an
entry for this host.
l
If there is no entry:
The system automatically creates a new line with the name of the host. The term describing the
host characteristic is DEFAULT. The host characteristic is read from the variable UC_
HOSTCHAR_DEFAULT. Thus, this variable must always be available.
If there is an entry:
The term which describes the host characteristic is read. This term is the suffix of a predefined
variable.
Example: The term is BS2000. The corresponding host characteristic is stored in the variable UC_
HOSTCHAR_BS2000.
Example
The agent UNIX25 uses the standard host characteristic UC_HOSTCHAR_DEFAULT and the agent
WIN01 uses the newly created AE Variable UC_HOSTCHAR_WIN.
Key
Value
UNIX25
DEFAULT
WIN01
WIN
See also:
Overview of all variables in table form
Variable
Automation Engine
229
Value
New
start
requ
ired
FT
prot
ocol
230
Chapter 3 Configuration
ANONYMO The usage of login data for the execution of Jobs and FileTransfers.
US_FT
This setting is only supported for OS/400, UNIX and Windows agents.
ANONYMO
US_JOB
l
ANONYMOUS_FT - for FileTransfers
l
ANONYMOUS_JOB
ANONYMOUS_FT
Windows
[GLOBAL]
logon=0
The login
data that
is stored
in the
Login
object is
used.
UNIX
[GLOBAL]
login_check=no
[GLOBAL]
login_check=yes
OS/400
[GLOBAL]
CheckLogon=0
The login
data that
is stored
in the
Login
object is
used.
Attention: Regardless of the settings that are defined here, the system
always checks when a job starts whether a Login object is available
that includes an entry for the particular platform. If there is no entry, the
job aborts. In FileTransfers, the following privilege is decisive:
Privilege FileTransfer: Start without Login object specified
If this privilege is available, FileTransfers can be processed although no
Login object has been assigned to them. Requirement: ANONYMOUS_
FT=Y and logon=0 (Windows) or login_check=no (UNIX).
Age
nt
Old
and
new
Automation Engine
Age
nt
Age
nt
The backup folder stores the files of the File Rollback of Jobs and
FileTransfers. You can define the backup folder using the Agent
Variable UC_EX_PATH_BACKUP in the agent's INI file.
In the Rollback tab, you can specify the files that should be copied to
the backup folder. They are stored automatically when a Job object or
FileTransfer object is processed.
Only affects Windows and Unix agents.
Allowed values: Valid time in the format HH:MM
Default value: "00:00"
BACKUP_ The life time in days for the content of the backup folder.
RETENTIO
In this key, you can determine how long files and directories will be stored
N_
in the backup folder. The system checks this setting daily at the time that
LIFETIME
is specified in BACKUP_RETENTION_CHECK. All files and directories
that have been stored in the backup folder for more than the specified days
will be deleted.
Age
nt
This entry can be used to define the action that a workflow should take if
one of its jobs changes its status to ENDED_LOST.
Allowed values: YES (default value) and NO
YES - The workflow blocks.
NO - The workflow does not automatically block.
No
231
232
Chapter 3 Configuration
DISCONN
ECT_
AFTER_FT
This defines whether the connection between the agents ends after a
FileTransfer.
Age
nt
EVENT_
CHECKIN
TERVAL
The time interval in seconds during which the agent checks the conditions
FILE_CHANGED and FILE_STABLE in its FileSystem Events.
Allowed values:60 - 100000
Default value: 60
If you select FILE_CHANGED or FILE_STABLE in a FileSystem
Event, this interval is used for all condition checks.
The interval increases automatically if checking a condition takes
longer than the specified interval.
Age
nt
Old
Automation Engine
EXECUT
E_ON_
ASSIGNM
ENT
EXECUT
E_ON_
END
EXECUT
E_ON_
LOST
EXECUT
E_ON_
START
You can use these keys to start any executable object in the following
situations.
If the agent starts and ends:
l
l
EXECUTE_ON_ASSIGNMENT
Age
nt
233
234
Chapter 3 Configuration
FT_
ASYNC_
QUIT_
MAX,
FT_
ASYNC_
QUIT_MIN,
FT_
ASYNC_
QUIT_
NUM
No
New
Age
nt
Old
and
new
Synchronous transfer: Data packages are only sent when the receipt of
sent packages has been confirmed. Sender and receiver adjust their
transmission speeds. A synchronous behavior is achieved when the
setting FT_ASYNC_QUIT_NUM equals FT_ASYNC_QUIT_MAX.
Asynchronous transfer: Data packages are sent although confirmations are
still missing for sent packages. In doing so, data can be transferred faster
because a faster sender or a slower connection are used more efficiently.
The agents' TCP/IP buffer (INI-file parameter: SendBufferSize= and
RecvBufferSize=) should be increased accordingly.
An asynchronous behavior is achieved when FT_ASYNC_QUIT_MAX is a
multiple of FT_ASYNC_QUIT_NUM.
The higher the value of FT_ASYNC_QUIT_MIN, the more the receiving
agent will be unburdened when FT_ASYNC_QUIT_MAXhas been
reached.
These options are only effective in OS/400, NSK, UNIX, Windows and
z/OS agents.
FT_ASYNC_QUIT_MAX
Maximum number of non-confirmed data packages that the sender sends
to the receiving agent.
Minimum value: 1, default value: 60, maximum value: 100
FT_ASYNC_QUIT_MIN
Number of non-confirmed data packages as of which the sender sends
them to the receiver.
Minimum value: 0, default value:30, maximum value: 50
FT_ASYNC_QUIT_NUM
Number of data packages that are confirmed per receipt.
Minimum value: 0, default value: 5, maximum value: 50
Note that the value that is specified as the MIN setting must not exceed
the MAX setting.
For example:
FT_ASYNC_QUIT_MIN / MAX / NUM:
0 / 1 / 1: Synchronous FileTransfer
0 / 10 / 5: Weak asynchronous transfer. The sending agent may send a
maximum of 10 non-confirmed data packages. If the maximum has been
reached, it waits until all receipts have been confirmed before it continues
the sending process.
30 / 60 / 5: Strong asynchronous transfer. The sender may send a
maximum of 60 non-confirmed data packages to the receiver. Receipts are
confirmed per 5 packages. The sender always waits until 30 non-confirmed
data packages are open before it starts the data transfer.
FT_
The compression type for FileTransfers.
COMPRES
Allowed values: NO (default value) and NORMAL
S
Automation Engine
FT_
CONNECT
ION_
TIMEOUT
235
Age
nt
New
Age
nt
New
Age
nt
New
Age
nt
New
Age
nt
New
Age
nt
New
MD5 checksum usage that allows for the files that have been transferred in Age
FileTransfers to be checked. This method ensures that the transferred files nt
comply with the source files if the FileTransfer is restarted.
New
FT_
REPORT_
TIME
FT_
RESTARTI
NFO_
CHECK
The time in UTC at which the life time of FileTransfer restart information is
checked. It is checked on a daily basis.
Minimum value: 1
Default value: 60
This restart information is stored locally in the agents temp directory in the
form of StatusStore files (ending *.sts). These files are deleted after the life
time that has been specified using the key FT_RESTARTINFO_
LIFETIME.
Default value:0:00:00
FT_
RESTARTI
NFO_
LIFETIME
FT_
RESTARTI
NFO_
INTERVAL
The time interval in seconds in which the agents store the restart points
during a FileTransfer.
FT_
STATUS_
INTERVAL
The time interval in seconds in which the agents send the status
information of FileTransfers to the Server.
Minimum value: 1
Default value: 14 days
Minimum value: 1
Default value: 60seconds
FT_USE_
MD5
For performance reasons, the MD5 checksum is not calculated for files
that are smaller than 1MB. This behavior is always valid, regardless of the
definitions that have been made in this setting.
Allowed values:Y (default value) and N
236
Chapter 3 Configuration
JOB_
CHECKIN
TERVAL
Job execution is periodically checked by the agents. You define the time
interval for this check in this entry.
Age
nt
Minimum value: 1
Default value: 60seconds
There is no upper limit for this setting. The default value is used if 0 is
defined.
You may reduce this interval to less than 60 seconds, in case the check
for job statuses shall be executed in shorter intervals.
Be aware though, that a smaller interval than 60 seconds will increase
the load of EXSTAJ messages, thus affecting server performance.
KEEP_
ALIVE
Age
nt
The value that is defined here must not be less than 60 seconds.
Otherwise, the default value is used.
The specified value must also result in complete minutes (such as 60, 120,
180). If you use a different value, it is rounded up to the next minute (for
example, a value of 99 seconds results in 120 seconds).
A fixed value of 60 seconds is always added to the specified value.
Therefore, the actual minimum is 120 seconds. The System Overview
always displays the value that has been set by using KEEP_ALIVE.
(see also: System Overview)
LOG_TO_
DATABAS
E
Age
nt
Y - The agent sends its log-file messages also to the Automation Engine
which stores it in the Agent object's report.
N - The agent does not send log messages to the Automation Engine.
Doing so improves the AE system's performance.
MAX_
FILE_
COUNT
Age
nt
Automation Engine
MAX_
REPORT_
SIZE
This entry contains the maximum number of report blocks that should be
transferred to the AE database.
Age
nt
RECONNE This entry defines the time interval during which the agent tries to establish
CT_TIME
a connection. This refers to the establishment of a connection in case of a
restart or when the connection has been ended.
Age
nt
REPORT_
TIME
You use REPORT_TIME to set the time interval during which the agent
sends the logging to the AE system.
Age
nt
Age
nt
The maximum time in seconds for resolving Variables objects with the
sources BACKEND and SQL.
Backend variables run a command on an OS (such as Windows or UNIX)
and supply the result as values. SQL variables process SQLcommand on
an external database and return its results.
In the setting VAR_TIMEOUT, you determine the time limit for these
actions. If this limit is exceeded, processing and the task that uses the
variable are canceled.
Allowed values: 1 to 600
Default value: 600
Age
nt
237
238
Chapter 3 Configuration
WORKLOA The maximum number of resources that the agent provides for
D_MAX_FT FileTransfers.
No
Age
nt
Value
Restart
required
Container number
No
Description
These variables are supplied in client 0000. Their settings apply globally for the whole AE system and
must only be changed in client "0000".
The data records which are stored with ILM in partitions can be divided into three categories. There is a
separate variable for each of them:
l
l
Automation Engine
l
239
UC_ILM_CONTAINER_MISC - messages, data for the Revision Report and for the Open Interface
to Output Management Systems
The utility AE.DBLoad automatically fills these variables with data during the ILM installation.
A container corresponds to a partition.
Example for UC_ILM_CONTAINER_STATISTICS:
Key
Value
UC4_DATA_STATISTICS_1
UC4_DATA_STATISTICS_2
UC4_DATA_STATISTICS_3
We assume that three partitions should be online. The Automation Engine starts to store the data records
in container "1". After a partition change, the data records are stored in container "2" etc. After container
"3", the Automation Engine starts again with container "1".
The variable UC_ILM_SETTINGS contains the number of the current container in its key ACT_
CONTAINER.
Important notes:
l
All three variables must have the same number of entries. It is not possible to use five partitions for
statistical records but only three for reports.
You can specify the number of online partitions in the variable UC_ILM_SETTINGS, key ONLINE_
PARTITIONS. The number of existing partitions must be at least the same number of partitions that
should be online.
See also:
Overview of all variables in Table Form
Variable
Partitioning with ILM
Value
Restart
required
ACT_
CONTAINER
No
ACT_
PARTITION
The Automation Engine counts the partitions used for installing ILM and
increases this value by "1" with each partition change.
No
240
Chapter 3 Configuration
ACTIVE
ILM status
No
Calendar that includes the days on which the partition should be changed.
No
Format:
Calendar object/Calendar keyword
The partition is changed at 00:00 on the days specified in the Calendar
keyword. The TimeZone of system client 0000 serves as the time basis.
EXECUTE_
ON_
FAILURE
No
The following script variables can be read from the read buffer:
l
l
l
l
l
The object is searched for and activated in all clients except for system
client 0000. No activation is allowed in this client.
EXECUTE_
ON_
SUCCESS
The object is searched for and activated in all clients except for system
client 0000. No activation is allowed in this client.
No
Automation Engine
LOGIN
Name of a Login object that includes the database user to be used for
executing ILM actions.
No
ALL_TAB_PARTITIONS
ALL_CONSTRAINTS
ALL_PART_INDEXES
ALL_INDEXES
ONLINE_
Number of online partitions.
PARTITIONS
Allowed values: "1" - "999"
No
RETRY_
MAX_
COUNT
No
RETRY_
TIME
No
STATISTIC_
TIME
Time delay in minutes for the statistical update after the partition has been
changed (only Oracle).
No
Maximum time in seconds that the Automation Engine is stopped before the
partition is changed.
Allowed values:"60" - "32000"
Default value:"3600"
When it is time to change the partition, processing in the AE system comes
to a halt and waits until all work processes have ended their ongoing
database transactions. The key TIMEOUT is decisive for the maximum
waiting time. No new partition can be created if this period of time is
exceeded.
No
241
242
Chapter 3 Configuration
Description
This variable is supplied in system client 0000. Its settings apply to the whole AE system and can only be
modified in client 0000.
It contains the settings for partitioning with ILM.
See also:
Overview of all variables in Table Form
Variable
Partitioning with ILM
Value
Time interval
Server
Method A:Name the copy "UC_LDAP_domain". If the domain name is "SMITH", the variable name
must be "UC_LDAP_SMITH".
Method B:User object names are composed of name and department. The copy of the variable can
be renamed to "UC_LDAP_department". Each department requires a separate variable. Using this
method requires the domain to be specified in the key DOMAIN_ALIAS. You would use Method B
Automation Engine
243
when the domain name (or fully qualified domain name) does not meet the Automic object naming
conventions. For domain alias, we recommend using the fully qualified domain name.
German umlauts cannot be used in domain names.
By default, the domain indicated in the name of the variable is used. You can also specify the alias in
the key DOMAIN_ALIAS which is then used instead of the domain name.
Indicate Server name and port. The keys that start with "USR" define the LDAP attributes from which the
LDAP connection should read the e-mail address, as well as the first and last name when synchronizing
user data. All three information types are stored in the User object.
Key
Value
New
start
required
No
Domain alias or domain name (if the department has been specified
in the name of the variable)
No
SERVER
No
Format:
Server name:Port number
Separate several LDAP Servers with a semicolon. The
Automation Engine then attempts to establish a connection to
the first LDAP Server. If it fails, a second attempt is made with
the second LDAP Server etc.
244
Chapter 3 Configuration
USE_
DISTINGUISHED_
NAME
No
USR_EMAIL1
No
No
No
Value
Restart
required?
No
Automation Engine
245
Value
No
Description
This variable is available in the client 0000. From there, it can be transferred to the own client and adjusted
upon requirements.
Usually an object newly created in the Explorer obtains a standard name. This name consists of the short
form of the object type, the term "NEW." and a run number (e.g. JOBS.WIN.NEW.5) which indicates the
number of already existing standard names. If you rename or delete the object JOBS.WIN.NEW.5, for
example, the number 5 is available again for the next new Windows Job.
The variable UC_OBJECT_COUNTER can be used to specify a counter whose reading - a 10-digit
number with leading zeros - increments by one with each new object. The resulting number is
automatically appended to the name, thereby replacing the default setting "NEW.n" .
Example:JOBF.0000000100
The object type and starting number of the first counter reading can be specified in the variable. If these
settings are deleted lateron, the standard settings apply once again.
The counter cannot be used for TimeZones (TZ) as their names must not exceed 8 characters!
Example
Key
Value
JOBF
100
See also:
Overview of all variables in table form
Variable
246
Chapter 3 Configuration
Key
Value
New start
required
"*"
or
short name of the object
type
No
Description
The variable is supplied with client 0000. It can be copied into your own client and customized to your
requirements.
Individual documentation tabs can be specified for objects. Enter the object type's short form in the section
key and your preferred tab title in the value. If the same setting should apply for all object types, enter "*" in
the key column.
The system first checks whether a validity key has been specified in the particular object type's
variable. If not, validity key "*" is used.
The name of a regular documentation tab must not exceed 10 characters and the name of a structured
documentation is limited to 9 characters. If you define a longer name, an error message is displayed with
the appropriate message and the name of the tab is truncated. The characters that are included in the
Microsoft Windows Codepage 1252 (Latin I) can be used for the name.
You can also create more than one Documentation tab per object. In this case the corresponding names
are written one after the other, and they are separated from each other by a comma. A structured
documentation tab can be created by adding the additional character "@" in front of its name (for example,
@tasks). All the Documentation tabs are displayed in the objects in the same order as has been specified
in the variable.
The following characters can be used in the names of Documentation tab: A-Z a-z 0-9 . @ _
The @ character must only be used as the first character because it indicates that this is a structured
Documentation tab. If you use characters that are not allowed, an error message is output when you open
the object and the affected Documentation tabs are hidden.
Even if tabs are changed (renamed or deleted) in the variable, the existing tabs are still kept in the objects.
Note that imported objects also keep their own Documentation tabs regardless of the variable's content.
The tabs that are defined in UC_OBJECT_DOCU are displayed additionally.
The Version Management tab displays the saved versions of the objects if this function has been
activated in the variable UC_CLIENT_SETTINGS.
Example
Key
Value
JSCH
General,@Details
Automation Engine
247
If you import a Schedule object that contains the Documentation tab "Contacts", the following tabs are
shown afterwards: "General", "Details" and "Contacts."
See also:
Overview of all variables in table form
Variable
Documentation Tabs
Value
Template object
No
Description
This variable is supplied in client 0000 and can be assumed and adjusted to the particular client.
One way of creating objects is to use the command New in the UserInterface's context menu. In doing so,
a dialog opens which contains a list of the various object types. By default, all object types are displayed.
Adjust the variable if you want to restrict this selection. As it is possible to assume this variable to various
clients (e.g. test client), you can also define individual selection lists.
You can also limit this list on the basis of authorizations. Specify value "N" in TEMPLATE_SHOW_
ALL in the variableUC_CLIENT_SETTINGS and users only see the object types they are allowed to
create.
248
Chapter 3 Configuration
First define an appropriate name in the key that is by default an object-type abbreviation (such as
JOBS.R3). Enter the name of a template in the value section. These object templates are either supplied in
the folder "Template" of system client 0000 or have individually been created.
If you want to create an individual template, simply create an object (such as a FileTransfer). Then enter its
name in the variable UC_OBJECT_TEMPLATE. Automic recommends using significant names and an
extra folder for these templates. If a user creates an object using this template, by default the suggested
name is composed of the template name, the term "NEW" plus a serial number (such as JSCH.NEW.2) or
a counter. It is also possible to define more than one template per object type.
Templates can be adjusted according to your requirements at any time. They should make it easier for
users to create objects (such as a template for an agent in Unix jobs). Note that users can adjust these
templates, the pre-filled lines are only suggestions.
If a client contains its own UC_OBJECT_TEMPLATE, it is also possible to provide a collection of own
templates. A template is always first searched in the particular client. If it is not available in the client, the
corresponding template of system client 0000 is used. If no template is found, the corresponding entry is
not displayed in the selection list.
Pay attention in system client 0000: Entries can be added to the object UC_OBJECT_TEMPLATE but
the supplied standard entries MUST NOT be deleted. Otherwise, problems occur in XML imports.
Example
Excerpt of variable UC_OBJECT_TEMPLATE:
Automation Engine
Key
Value
Cockpit
CPIT
CALL_ALARM
CALL_REQUEST
249
See also:
Overview of all variables in table form
Variable
Value
Restart required
No
Description
This variable is supplied in system client 0000. It can be used in other clients and adjusted accordingly.
It contains the StyleSheets which should be used for the individual report types.
Example
Key
Value
SSPL
XSL.SAP.SPOOLDIRECTORY
SSTC
XSL.FOR.STATISTICS
See also:
Table Overview of all variables
Variable
StyleSheet
250
Chapter 3 Configuration
Description
This variable is supplied in client 0000. Its settings apply for the whole AE system and can only be
changed in client 0000.
It lists the possible Event types of the SAP Java Scheduler. Its entries are displayed for the Event type
selection in AE SAP Console Events (setting "Data source" - "Java Event History"). This makes it
possible to determine a particular Java Scheduler Event type for triggering a Console Event even though
there is no connection to a SAP system.
Note that the content of this variable should not be changed. Otherwise, Console Events that have a
filter for a Java Scheduler Event type might no longer be triggered.
See also:
Table View of all variables
Variable
Value
UserInterface
UserInterface
Description
variables are supplied with client 0000. From there they can be copied into your own client and customized
to your requirements.
In order to allow for easier distinction, the Variable "UC_SENDTO" (context menu of the Explorer) is
available for objects and "UC_SENDTO_ACT" (context menu of the Activity Window) for tasks.
You can handle objects and tasks AE-internally but also externally with your own programs, thereby
transferring object codes. The Send To menu in the context menu of the UserInterface is created
according to your definitions made in the variable. The Send To sub-menu lists all the specified programs
and executable objects in alphabetical order. Highlight one or more objects or tasks to call the menu
command as shown below:
Automation Engine
251
Note that the menu Send to is also available in the context menus of monitors and in the Search function.
Changes made in these two variables only become effective in the UserInterface after a restart.
Internal Handling
Here, object codes are transferred to objects that are able to be activated. The keys you define are used as
menu commands of the Send To menu. In the Value column of the variable you specify the names of the
objects to be called. Note that the specified object is started for each highlighted object/task.
The following variables are automatically supplied in the read/input buffer:
Variable
Description
&OH_IDNR#
Object code
&NAME#
&TYPE#
&LNR#
&PARENT_RUN#
&PARENT_NAME#
&PARENT_TYPE#
Use the script statement :READ to read these variables. The option Generate at runtime , however, must
not be activated (Attributes tab).
Example:
:READ &NAME#,,
:PRINT &NAME#
:READ &TYPE#,,
:PRINT &TYPE#
:READ &PARENT_RUN#,,
:PRINT &PARENT_RUN#
252
Chapter 3 Configuration
External Handling
You can define menu commands in the variables for calling your own programs in order to handle objects
and tasks externally.
The keys you define are used as menu commands for the Send To menu. In the Value column of the
variable you specify the names of the programs followed by the parameter -f%01. This parameter serves to
assign a temporary file (SEND_TO_n.txt) containing the codes of the highlighted objects.
The content of this temporary file is clearly structured. The first line contains the name of the AE system,
the client and the user who started the program call. The object codes are then listed one below the other.
Example:
UC4 - 0150 - SMITH/UC4
3486524
12234
3097486
1512
Example
Key
Value
SCRI_SCHEDULE_DATA
Test system
C:\AUTOMIC\TRANSPORT.EXE -f%01
See also:
Overview of all variables in table form
Variable
Explorer
Activity Window
Value
New start
required
BLOCKING_COUNT
No
CALL_OPERATOR_
COUNT
No
EX_COUNT
No
USER_COUNT
No
Automation Engine
253
Description
This variable is supplied in client 0000. Its content applies to the whole AE system. The Automation
Engine automatically updates it whenever necessary.
No manual interference is required; entries are automatically supplied with values and maintained.
See also:
Overview of all variables in Table Form
Variable
About SNMP
Value
USER_SESSION
No
Description
This variable is supplied with client 0000. From there it can be copied into your own client and customized
to your requirements.
In the validity concept "FREE", you can use the variable USER_SESSION if statistics for user
sessions are created.
By default, a statistics file is created every time you log on to the system. If no statistics should be
recorded, this file is erased as soon as you log off correctly. All security relevant information (password
violation, etc.) will be kept.
The default value is "Y".
See also:
Overview of all variables in table form
Variable
Value
Restart
required
254
Chapter 3 Configuration
AGENT_
COUNT_PER_
IP
AGENT_LOG_
CHANGE_PER_
MINUTE
No
Allowed values: 20 to n
Default value: 60
AGENTGROUP_ The interval in minutes in which tasks are checked that wait for the
CHECK_
host of an agent group.
INTERVAL
Allowed values: 1 to 60
Default value: 10
No
No
The time period in days after which the log files are changed.
No
CHANGE_
LOGGING_MB
The specification of a size in megabytes after which the log files are No
changed.
No
DEFAULT_
REPORT_
SCAN_
MEMORY
DELETE_
CHECKBACK_
LIMIT
Default value: 60
Allowed values:1 to 50
Default value: 2
No
Automation Engine
DISABLE_
No user-defined Includes are called in the Headers and Trailers of
USER_HEADER Job objects that run on the platforms that are defined here.
No
No
EXTERNAL_
CHECK_
INTERVAL
No
GENERIC_
ACTIVITIES_
LIMIT
GENERIC_
AUTO_
FORECAST_
LIMIT
GENERIC_
SEARCH_LIMIT
GENERIC_
STATISTICS_
LIMIT
GET_
PROCESS_
LINE_RTRIM
LAST_USE
The time delay in minutes after which the objects' usage counter is
refreshed.
No
Allowed values: 0 to 10
Default value: 0 (no refresh is made)
LDAP
LDAP connection.
Allowed values: Y and N (default value)
Y - LDAP is used
N - LDAP is not used
No
255
256
Chapter 3 Configuration
LOG_TO_
DATABASE
Server
MAX_EXPORT_
COUNT
No
The maximum size (KB) of the XML file that should be imported.
UserInterface
MAX_REPORT_
SCAN_
MEMORY
MIN_EVENT_
INTERVAL
MQA_COUNT_
BACK
No
No
No
The name including the path of the generated Server program library Server
for an external password check.
Max. 256 characters
PASSWORD_
EXIT_PARAM
Server
Automation Engine
PASSWORD_
CHANGE
RECONNECT_
TIME
UserInterface
Server
Server
SCR_
LOOPCHK_
TIME
SERVER_
OPTIONS
No
No
257
No
258
Chapter 3 Configuration
SNMP_
REFRESH
This setting controls the time interval (in seconds) in which SNMP
refreshes the information about blocked workflows.
No
This allows to create and edit Variable objects of type "SQL internal" and "SQL - internal SECURE".
No
No
No
No
UNREAD_
MESSAGES_
BUFFER
VAR_
SECURITY_
LEVEL
No
No
Automation Engine
VARIABLE_
SERVICE_
CHECK_
INTERVAL
259
No
Minimum: 1
Maximum: 60
Default value: 10
VERSIONS_
SHOW_MAX
No
WP_MIN_
NUMBER
No
XML_
ENCODING_
CHECK
No
Description
This AE Variable is supplied in client 0000. Its settings apply for the whole AE system and can only be
changed in client 0000.
The Automation Engine monitors all the values that this Variable includes. The administrator receives a
message if an attempt is made to store an invalid value in this Variable. This message is also written to the
Automation Engine's log file. The default value is used instead of the invalid value. If the invalid value is a
value range, the system uses the maximum value if the specified maximum value is exceeded. The
minimum value is used if a value that lies below the minimum value has been found. The Variable's
contents remain unchanged.
AGENT_COUNT_PER_IP
260
Chapter 3 Configuration
An agent's license will be checked when it logs on to the Automation Engine system. By default, the
system also verifies whether an agent that is already logged in uses the same IP address. If so, the agent
that has newly logged on does not require a separate license.
Checking numerous agents (approx. 1,000) can increase the time that it takes to log on to the system. For
this reason, you can also deactivate the IP address check by using the setting AGENT_COUNT_PER_
IP.
Every agent that logs on requires its own license when you deactivate this check. Whether or not the
IP address has already been used is irrelevant in this case.
AGENT_LOG_CHANGE_PER_MINUTE
The more agents a AE system contains, the higher is the chance that log-file changes are required for
many agents at the same time. You can use the setting AGENT_LOG_CHANGE_PER_MINUTE in order
to support your system performance by limiting the number of log files that should be changed per minute.
AGENTGROUP_CHECK_INTERVAL
Tasks such as Jobs or FileTransfers can run within an agent group. The task's status changes to "Waiting
for Host" if no agent is available that is part of this agent group. The setting AGENTGROUP_CHECK_
INTERVAL defines the interval in which the system checks whether a particular agent is active and if so, it
initiates the start for the waiting tasks.
The value for this setting should not lie below the interval in which the agent attempts to establish a
connection to the AE system. This value can be specified by using the option RECONNECT_TIME in
the AE VariableUC_HOSTCHAR_DEFAULT.
BACKENDVAR_MAX_ROWS
This setting determines the maximum number of lines that BACKEND-type VARA objects can return.
Note that selecting a high value can have the effect that it takes longer to resolve Backend-type Variables.
CHANGE_LOGGING_DAYS and CHANGE_LOGGING_MB
These files can be changed on a time- and size-dependant basis in order to ensure that the log files can
easily be handled in high workload times for AE servers and agents. You can also archive and reorganize
this data in the AE Database although the AutomationEngine and the agents are active for several months
without interruption in the best case.
You can also specify temporary log-file changes in the Properties tab in the System Overview. Here, you
can directly specify Server settings for the log-file change of work processes. These modifications are
then valid until the system reboots. You can use the script element CHANGE_LOGGING in order to trigger
a forced log-file change.
To avoid endless reports for Event, RemoteTaskManager, Sync and Schedule objects, their reports are
also changed and a new statistical record begins. In this case, only the setting of CHANGE_LOGGING_
DAYS is relevant.
CHANGE_LOGGING_MB only works if the setting LOG_TO_DATABASE is set to the value Y. For
the AutomationEngine, define this setting in the AE Variable UC_SYSTEM_SETTINGS, and for
agents, use the UC_HOSTCHAR_DEFAULT. CHANGE_LOGGING_DAYS does not depend on this
option.
The log files of all work processes are automatically changed if the logging of a work process (WP,
DWP, PWP) changes.
The logging of tasks that start on a recurring basis, is changed on a daily basis or if the period settings
are modified.
Automation Engine
261
CONDITION_CHECK_INTERVAL
ThePreconditions tabwhich is available in the properties of Workflows can be used to define conditions
and statements. These are then regularly checked and executed before the tasks start. This process
(evaluation cycle) is repeated until the latest start time or a final statement has been reached. This key can
be used to change the time interval. By default, an evaluation takes place every 60 seconds.
DEFAULT_REPORT_SCAN_MEMORY and MAX_REPORT_SCAN_MEMORY
Use DEFAULT_REPORT_SCAN_MEMORY to define the memory size that should be requested in order
to read reports using aFilter object. The Automation Engine doubles this size if the report to be read is
larger. For complex reports, the memory is doubled until the value specified in MAX_REPORT_SCAN_
MEMORY has been reached. The task ends with the status FAULT_OTHER if this value is exceeded.
Example:
A report has a size of 10 MB,the default memory is 3 MB, the maximum 30 MB.
The Automation Engine recognizes that 3 MB are not sufficient to read the report and increases the
memory:3 MB -> 6MB -> 12 MB. The maximum value for the memory has not been exceeded and the
report can now be read.
DELETE_CHECKBACK_LIMIT
When you delete an object, the system automatically checks back if this object is also used in other
objects. The whole process can take a little longer than usual if many objects are deleted at the same time.
Use the key DELETE_CHECKBCK_LIMIT in order to have a query displayed starting with the specified
object number in which you can determine whether the usage in other objects should be checked.
DISABLE_USER_HEADER
Job runs also consider Headers and Trailers. These special objects are available in the system client 0000
and can be used to call user-defined Include objects. More detailed information is available in the
documentation aboutJob Includes. If user-defined Include objects should not be used, you can either
specify particular platforms or *ALL. These Include objects are then not searched which avoids
unnecessary database accesses and increases performance.
For example:
Validity
Value
DISABLE_USER_HEADER
BS2000,MVS,WINDOWS
EXECUTE_ON_EXCEPTION
By default, invalid messages which cause a Server process to crash are put toquarantine. This key can be
used to define that an object should start if such a message is sent. Enter its name as the relevant value.
Note that the object is searched and activated in all clients. System client 0000 is exempted because
objects cannot be activated in it.
EXTERNAL_CHECK_INTERVAL
This settings determines the frequency with which the status of external dependencies is checked in
Workflows. The Workflow checks its external dependencies for the first time when it starts. The task
automatically reports its status when it has ended.
GENERIC_ACTIVITIES_LIMIT
Depending on the specified filter settings, the Activity Window displays the corresponding tasks. If it
contains numerous active tasks, performance is affected negatively because refreshing the Activity
Window in small intervals becomes rather complex. Therefore, you can limit the maximum number of
262
Chapter 3 Configuration
Automation Engine
263
MAX_IMPORT_SIZE
This entry can be used to limit the maximum size of an XML file which should be imported. The import
does not take place if the file exceeds the specified value.
MIN_EVENT_INTERVAL
In each Event, you can specify a minimum interval (minutes) for its execution in the corresponding Event
tab. You can define a lower limit with the entry MIN_EVENT_INTERVAL. The interval specified here is
used if an Event contains a value below this limit. The Automation Engine uses the value specified in the
AE Variable UC_JOB_CHECKINTERVAL if 0 is used.
MQA_COUNT_BACK
This key can be used to define the maximum number of Server messages which should be buffered for
further analysis. Only messages are affected which have been sent or received by work processes (PWP,
DWP, WP). These messages are stored in the random access memory (RAM) of the computer on which
the Automation Engine runs.
You can open the latest messages that have been buffered via the System Overview -> Automation
Engine section. Do so by selecting the Workload menu item in a WP's context menu.
MQ_BLOCK_COUNT and MQ_CHECK_TIME
In Oracle databases, the Automation Engine checks in the interval specified with MQ_CHECK_TIMEthe
block size of the message queues MQPWP, MQWP, MQDWP, MWRWP, MQOWP and MQCPnnn. If
the block size exceeds the value specified with MQ_BLOCK_COUNT, the Automation Engine
reorganizes the message queue which improves the performance of your AE system.
PASSWORD_EXIT
This entry serves the realization of a password exit. The value to be specified is the name and path of the
generated program library.
Example: PASSWORD_EXIT c:\ae\pwexit\bin\xuc4pass.dll
PASSWORD_EXIT_PARAM
If parameters should be assigned, do so using the PASSWORD_EXIT_PARAM key.
PASSWORD_CHANGE
This key can be used to define whether the password can be changed.
Example: PASSWORD_CHANGE NO
RECONNECT_TIME
This entry specifies a time interval during which the Server processes try to establish a connection. This
affects the connection attempts for a restart or after a lost connection.
REPORT_BLKSIZE and REPORT_TIME
Use these entries to determine the report size in bytes. You can also specify the interval (seconds) in
which the report will be refreshed.
RESERVED_API_USERS
Every user who uses the CallAPI needs a free dialog license. These dialog licenses are shared with the
users who log on to the Automation Engine via the UserInterface. The number of dialog licenses specified
here is reserved for CallAPI users. In doing so, the CallAPI cannot be blocked due to a lack of free dialog
licenses.
264
Chapter 3 Configuration
Example: Value 5 is entered in the Variable and there are 20 licenses available for the dialog. No further
logins would be allowed after the fifteenth login via UserInterface. It is possible that five additional users
log on to the Automation Engine via the CallAPI. If there are enough available dialog licenses, more users
than defined here can use the CallAPI at the same time.
Logging on to system client 0000 is possible even if all Dialog licenses are in use. The AE administrator
can always log on to the AE system.
SCR_LOOPCHK_TIME
This setting affects scripts whose generation takes longer than specified here. In such cases, script
generation repeatedly pauses for some time in order to avoid unnecessary Automation Engine load.
Endless loops can be avoided with this method.
SCR_LOOPCHK_TIME is used to define the frequency with which the script is interrupted. The
subsequent waiting time is always 1 second in the beginning. This time is doubled after every interruption.
The longest waiting time is 128 seconds. When this value has been reached, the waiting time is always
128. It is no longer doubled.
Example for SCR_LOOPCHK_TIME 3:
Intervals for Script generation
Script starts
Generation starts
after 3 seconds
Generation pauses
Waiting time
Duration: 1 second
Script continues
Generation continues
Generation pauses
Waiting time
Duration: 2 seconds
Script continues
Generation continues
Generation pauses
Waiting time
Duration: 4 seconds
etc.
Script generation always stops every 5 seconds, regardless of the value specified in SCR_LOOPCHK_
TIME. Doing so ensures that the script can be canceled without blocking other tasks. A higher value for
SCR_LOOPCH_TIME affects the waiting time interval (see above).
SERVER_OPTIONS
This key can be used to handle Server settings regarding performance improvements and trace outputs.
Its value is composed of a 15-digit string with each digit representing a particular Server setting. These
values can be read using the script function GET_UC_SETTING.
Position Character Description
1st digit S
Avoids deadlocks especially when starting Workflows with DB2.
This digit is only relevant for DB2.
2nd digit
Automation Engine
3rd digit
265
With this setting, the statistical records are not checked when a server cold
start is performed. This improves the booting performance of large Automation
Engine systems (especially in combination with Oracle databases) because in
most cases, the statistical records remain unchanged.
This is an update statement against the database and using a NULL value
column and as far we know in Oracle databases null values are not within the
index.
This update will set the timestamp4 for all records within AH where we do not
have any EH anymore and the timestamp4 is null.
In large systems, this simple update could take up to 10 minutes on start-up. To
avoid this, it can be turned off. There is no hard and fast definition for a large
system. A large system could consist of tens of thousand sof activities, but it
depends on many factors such as database speed and IO.
4th digit
5th digit
6th digit
7th digit
8th digit
9th digit
10th digit S or A
266
Chapter 3 Configuration
12th digit I
13th digit S
Setting this option has the effect that no report is written for import processes.
14th digit P
This option has the effect that the output of the script statement :PRINTis also
written to the Automation Engine logging if you activate the tasks
Alternative method for Oracle databases in order to read Server messages from
the queue. This method is slower than the default method.
l
l
l
Doing so can result in voluminous reports and log files. Deactivate this Server
option in order to increase the performance of your AE system.
15th digit Y
Affects the naming of wildcard FileTransfers from or to z/OS if the source file
name includes several wildcard characters.
For example:
Source is AE*A.AAA.AA.AAA.A????.A????.A??????
Target is AE*
Y - The target file name is correctly built according to the wildcard characters.
After the transfer, the file AEZZA.AAA.AA.AAA.A1111.A1111.A111111 obtains
the very same name.
N - The characters that start with the first wildcard until the last but one
character are ignored. After the transfer, the file
AEZZA.AAA.AA.AAA.A1111.A1111.A111111 obtains the name AE1.
Whatever you specify, this option is ignored in the new FileTransfer protocol.
Wildcards are always correctly resolved.
Activate the particular settings by inserting the respective letters in the relevant positions. The character N
deactivates a Server option. By default, all Server options are deactivated (NNNNNNNNNNNNNNN).
In the example shown below, options 1, 2, 6 and 8 are activated:
Key
Value
SERVER_OPTIONS
SPNNNUNENNNNNNN
SMGR_PORT_RANGE
Automation Engine
267
If a ServiceManager is used, you can execute its actions directly via the AE system. The relevant
commands can either directly be called from the System Overview (Agents / AutomationEngine) or via the
script element MODIFY_SYSTEM .
This key can be used to specify the port number or a port area for the automatic search for ServiceManager
instances. Doing so is only required if the ServiceManager does not run on the default port 8871.
The system automatically searches for a ServiceManager when the Server processes start for the first
time. Subsequently, this search must be executed manually using the "Refresh ServiceManager Scan"
command in the System Overview. You can also specify the connection settings to the ServiceManager
manually in the agent orServer object.
You can specify a port area by separating the start and end port by a comma. This area must not exceed
10 port numbers. Enclose the value in parentheses ()in this case.
For example: (8871, 8873)
SNMP_REFRESH
You can use this setting to define the interval in which the display for the blocked workflows for SNMP
should be refreshed. The default value is 10 seconds.
SQLVAR_INTERNAL
By default, the creation of Variable objects of type "SQL - internal" / "SQL - internal SECURE" is
deactivated. This setting has been made for reasons of security because the execution of SQL statements
on the AE Database enables system-wide access to objects and other data. Important data records can
also be modified or deleted.
Set SQLVAR_INTERNAL to the value YES in order to create, edit and use internal SQL Variables on a
system-wide basis. To do so, a user requires the"Create and modify SQL-Internal variables" privilege.
NO has the effect that the objects cannot be created anymore. The Variable type SQLI is no longer listed in
the Templates dialog (new object).
The internal SQL variables that are supplied by default in client 0 are not affected by this setting and can
always be used.
SQLVAR_MAX_ROWS
Databases often supply huge amounts of data. Therefore, you can limit the number of lines to be retrieved
by Variable objects with the source SQL and SQLI. Specifying a value which is very high has the effect
that it takes accordingly longer to resolve Variable objects.
This setting does not have any effect on Variables of type Filelist andMulti.
SYNC_BLOCK_COUNT
For performance reasons, the log-file change of Sync objects is made per block. This means that the log
files of a particular number of Sync objects are changed. The log-files of the remaining Sync objects are
changed in the next blocks.
This setting can be used to determine the number of Sync objects whose logging should be changed per
block. The lower the value, the longer the duration of the complete procedure. However, a high value can
negatively affect the performance of the AutomationEngine.
268
Chapter 3 Configuration
TRASHBIN_SHOW_MAX
The value that is specified here determines the maximum number of objects to be shown in theRecycle
Bin. The current date serves as the basis, i.e. the last n objects are visible.
UNREAD_MESSAGES and UNREAD_MESSAGES_BUFFER
The setting here determines the further handling of administrator messages which occur during operation
without a user being logged on who has the privilege to view them. Value N has the effect that they are
written to the database without being displayed again. In this case, use the category messages in the
System Overview to view these messages at a later point in time. Value Y indicates that messages are
kept and displayed in the Message Window for the next user who has the appropriate privilege.
The UNREAD_MESSAGE_BUFFER can be used to determine the number of unread messages that
should be kept. The oldest entry will be overwritten when the number of messages has been exceeded.
When the Message Window has displayed its unread entries to a User, these are marked as read and
removed from the input buffer.
Note that unread messages are lost when:
l
l
l
Messages are always written to the database. Activating this function causes unread entries to be
highlighted so that they can be displayed in the Message Window at a later point in time.
VAR_SECURITY_LEVEL
You can use this key to determine whether variables can be used in VARA objects, and which ones.
Affected is the replacement procedure of variables that are used within SQL statements (VARA type SQL
and SQLI(and OS commands (VARA type: Backend).
The documentation about the dynamic PromptSet dialogs describes the positions where PromptSet
variables can be replaced (security level 3).
The following table lists the variables and the security levels at which they are replaced:
Security level
Variables
Predefined variables
Predefined Placeholder PromptSet
(User cannot directly change the value) variables
for VARA
variables
(User can
objects
change
the value)
0
1
2
3
The security levels of all predefined variables are provided here..
Note for security level 3: You can execute all SQL statements and OScommands that are included in
the value that should be inserted in the specified Variable object
Automation Engine
269
A script is used to change the content of the Variable VARA2 whose value will be inserted in the SQL
statement:
:PUT_VAR VARA2, '*', 'Value; DELETE * FROM x;'
An additional SQL command has been inserted in the SQL Variable VARA1 (value replacement) because
the content of the Variable object VARA2 has been changed. This was possible although VARA1 has not
directly been changed (for example by a User who does not have the corresponding rights) and can also
lead to undesired database accesses (in this case: the deletion of data).
The setting VAR_SECURITY_LEVEL has no effect if you access Variable objects of client 0. In this
case, they can always be used.
VARIABLE_SERVICE_CHECK_INTERVAL
Dynamic variablescan either be used as predefined variables or via script elements in objects. Their
values are dynamically retrieved from the data source (database, Variable object or file-system directory)
at runtime. If the database variable (source: SQL) runs in an error while resolving the variable because the
database is not available or incorrect connection or login data has been specified, the task switches to a
waiting condition ("Waiting for continuation of variable resolving").
Variable resolving can be repeated as soon as the particular error has been removed (for example, the
database name in the Connection object has been corrected). The interval in which this attempt should be
repeated can be determined using the setting VARIABLE_SERVICE_CHECK_INTERVAL.
Note that tasks that you cannot cancel tasks that are in the condition "Waiting for continuation of
variable resolving".
VERSIONS_SHOW_MAX
The value that is specified here determines the maximum number of objects that should be shown in
Version Management. The current date serves as the basis, i.e. the last n objects are visible.
WORKLOAD_DEFAULT_FT and WORKLOAD_DEFAULT_JOB
These two settings determine the resources a file transfer or job uses by default. This value can
individually be specified in the corresponding objects and overrides the default value specified in the AE
Variable.
WP_MIN_NUMBER
Extra Server processes (DWPs) are available for messages sent to the database by UserInterfaces. They
are special forms of work processes (WP). Specify the number of Server processes that should perform as
work processes using the entry WP_MIN_NUMBER. The exceeding number can be used as Dialog
processes (DWP).
Note that the primary work process (PWP) is not included.
Define a node name in the Automation Engines' INI files because Server processes can be distributed
among several computers. The minimum number of work processes is valid per "node name". If you use
the same "node name" on different computers, this setting is valid on a networked basis.
Your AE system can also run without Dialog processes.
XML_ENCODING and XML_ENCODING_CHECK
The XML encoding influences the display of characters in the UserInterface. You can use the key XML_
ENCODING to specify the encoding that should be used for your AE system. The second key influences
the verification of imported XML files.
270
Chapter 3 Configuration
ISO-8859-15 (Latin 9) contains the Euro () character and West-European country-specific special
characters. The table below lists additional differences:
Characters
ISO-885915
A
4
A
6
A
8
B
4
B
8
B
C
B
D
B
E
ISO-8859-1
A
4
A
6
A
8
B
4
B
8
B
C
B
D
B
E
WINDOW
S-1252
80
8
A
9
A
8
E
9
E
8C
9C
9F
A
4
A
6
A
8
B
4
B
8
B
C
B
D
B
E
See also:
UC_CLIENT_SETTINGS
Overview of all AE Variables in table form
Variable
Value
WinNT
AUTO
No
UNIX
AUTO
No
LINUX
AUTO
No
Call
AUTO
No
Description
This variable is supplied in client 0000. Its settings are valid for the whole AE system and can only be
changed in client 0000.
Access to the operating system is granted via the specification a valid user ID and password. Logging on
to the AE system is not required if the variable UC_USER_LOGON is used. In this case, the system
checks if a User object exists in the client and if so, logon is automatic. Otherwise the UserInterface's
login window opens.
When Single Logon is enabled, access control is shifted to the UserInterface's OS. Unattended
screens can become a security risk and must therefore be avoided using the means of the relevant
operating system.
Single Logon can be used for CallAPIs. The benefit is that the password does not have to be stored in
programs or procedures. Therefore, it is not required to change every time the password is changed.
The following steps are required to activate Single Logon:
Automation Engine
271
Description
-Cclient
-Dclient
-SAE
system or
connection
name
It is crucial to indicate the name in order to enable automatic logon because there
can be more than one AE system. The login window is displayed if this parameter
is missing.
You can also enter the connection name which is specified in the configuration file
uc4config.xml, XML element <connection name="Name" system="System">
instead of the AE system name.
See also:
Overview of all variables in table form
Variable
Value
AH
ARCHIVSET Number of archive runs that have been processed so far. This value is also used for the
name of the archive folder.
272
Chapter 3 Configuration
FORMAT
Date format for the output of date and time indications in the archive files.
LASTAHRH
LASTMELD
MELD
PATH
Archive folder
SIZE
Archive size in MB
SIZEAH
SIZEMELD
SIZERH
TIMEAH
TIMEMELD
TIMERH
Data size and duration of the last archiving run. These values serve as the basis for the
forecast calculation of the next archiving run.
Description
The utility AE.DB automatically creates and updates the variable in the client.
Manual intervention is not required as all entries are automatically supplied with values and maintained
by the utility.
See also:
Overview of all variables in Table Form
Variable
Archiving
Value
Description
The utility AE DB Unload automatically creates and updates (if required) this variable.
Automation Engine
273
Manual intervention is not required because the entries are automatically supplied with values and
maintained.
The utility will only maintain this variable if value "0" has been specified in theINI-file parameter suppress_
output=.
See also:
Overview of all variables in Table Form
Variable
Unloading the Database
Value
AH
MELD
OBJECT_AUDIT
RH
274
Chapter 3 Configuration
VERSION_
CONTROL
Description
This variable is automatically created in the client and updated (if required) by the utility AE DB Reorg. It
contains the specifications selected in the utility.
Manual intervention is not required because the entries are automatically supplied with values and
maintained by the utility.
See also:
Overview of all variables in Table Form
Variable
Reorganization
Notes
l
General
Do not limit resource consumption. Aborting transactions due to limitations specified in the
database hamper processing in the AE system. Additionally, inconsistent database contents can
occur which cause subsequent errors or endless loops.
Statistics are essential for achieving top performance with the use of a DB2 database. Please
make sure to refresh them regularly!
Make sure to have the tables dimensioned big enough when creating the database. As the sizes
depend on the actual use of AE, the following overview shows the right span of sizes in percent.
Table
Automation Engine
RT
40% - 60%
AH
20% - 30%
ABLOB
~ 19%
MELD
10% - 20%
AJPP
5%
RH
5%
Other tables
< 1%
DB2 on UNIX/Windows
275
Default settings are optional for the supported DB2 versions. Changing these values does not
improve performance. Automic strongly recommends storing the database's LOG areas on a highperformance disk.
See also:
Setting Up Database - DB2
Technical Maintenance of the AE database
Maintaining Data Records
MS SQL Server
In order to achieve top performance, Automic recommends keeping the following notes in mind when
installing and operating MS SQL Server.
It is important to reorganize the AE database including all clients regularly because an extensive database
affects performance negatively (prolonged access times etc).
Notes
l
l
l
Do not limit resource consumption. Aborting transactions due to limitations specified in the
database hamper processing in the AE system. Additionally, inconsistent database contents can
occur which cause subsequent errors or endless loops.
Use TCP/IP instead of Named Pipes as database connection.
The transaction log, the TEMPDB of the database and the page file should not be filed in a RAID 5
file system. Use RAID 1 or 0 instead.
Do not, by any means, activate the option autoshrink in the database. This might occasionally
cause a standstill of the Automation Engine.
Version 2005
l
276
Chapter 3 Configuration
l
Add the option Mars_Connection=Yes to the database-connection parameters in the INI files of the
Automation Engine and the utilities. This setting ensures optimal database access using the
performance options of MS SQL Server 2005.
Example:
SQLDRIVERCONNECT=ODBCVAR=NNNNNNRN,DSN=UC4;UID=uc4;PWD=-1037B2E22BF022EBE2;Mars_Connection=Yes
Version 2008
l
Activate "Versioning" in order to reduce the occurrence of deadlocks. Doing so has the effect that
the file tempdb increases. Ensure that it is stored on a fast device.
alter database database name set READ_COMMITTED_SNAPSHOT ON
l
l
See also:
Setting Up Database - MS SQL Server
Technical Maintenance of the AE database
Maintaining Data Records
Oracle
For achieving top performance, Automic recommends keeping the following notes in mind when installing
and operating Oracle.
It is important to reorganize the AE database including all clients regularly as an extensive database
affects performance negatively (prolonged access times etc.).
White papers for Oracle usage can be downloaded from the Customer Zone of our website.
Notes
l
Do not limit resource consumption. Aborting transactions due to limitations specified in the
database hamper processing in the AE system. Additionally, inconsistent database contents can
occur which cause subsequent errors or endless loops.
Optimize the TCP/IP connection. For Oracle, the file sqlnet.ora is available. This file and
tnsnames.ora and listener.ora are by default found in the same directory. It contains the following
line:
tcp.nodelay = yes
When a message is longer than a logical transport block, it must be split in several blocks. The
above line causes that this can happen without waiting for a TCP/IP response. Oracle performance
can be increased this way. Enter this line on the Automation Engine and on the DB computer.
When setting up the database, the appropriate table sizes need to be assigned. The following table
provides an overview of values in percent. 2 to 4 GB should be the right database size for a
productive environment. In case of extensive installations, the database size can be 10 to 20 times
as large. Automic strongly recommends extending the tables for a fixed size from the beginning on
and not to limit the extents.
Automation Engine
Table
RT
40% - 60%
AH
20% - 30%
MELD
10% - 20%
AJPP
5%
RH
5%
Other tables
< 1%
277
See also:
OracleParameters
Setting Up Database - Oracle
Technical Maintenance of the AE database
Maintaining Data Records
Oracle Parameters
The following table provides an overview of all Oracle parameters and indicates how they should be set
when you use them AE.
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
DBFIPS_140
No
Enable use of
cryptographic
libraries in FIPS
mode
12
active_
instance_
count
Yes
For AE in the
RAC (alternative
backup via
SERVICE in the
RAC).
10, 11
and 12
aq_tm_
processes
No
10, 11
and 12
archive_lag_
target
No
10, 11
and 12
asm_
diskgroup
No
10, 11
and 12
asm_
diskstring
No
10, 11
and 12
asm_power_
limit
No
10, 11
and 12
asm_
preferred_
read_failure_
groups
No
11 and
12
278
Chapter 3 Configuration
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
audit_file_
dest
D:\ORACLE\ADMIN\O111\ADUMP
No
10, 11
and 12
audit_sys_
operations
FALSE
No
Depending on
your security
guidelines.
10, 11
and 12
audit_syslog_
level
No
Depending on
your security
guidelines.
11gR2
and 12
awr_
snapshot_
time_offset
No
AWR Snapshot
offset to full hour
12
Depending on
your security
guidelines.
10, 11
and 12
audit_trail
DB
No
background_
core_dump
partial
No
background_
dump_dest
D:\ORACLE\DIAG\RDBMS\O111\O111\TRA No
CE
10, 11
and 12
Is deprecated as
of Oracleversion
11; you can use
any path.
10, 11
and 12
backup_tape_ FALSE
io_slaves
No
Relevant for an
RMANbackup.
10, 11
and 12
bitmap_
merge_area_
size
No
10, 11
and 12
blank_
trimming
FALSE
No
10, 11
and 12
buffer_pool_
keep
Yes
Is deprecated and
has been replaced
by db_keep_
cache_size.
10, 11
and 12
buffer_pool_
recycle
Yes
Is deprecated and
has been replaced
by db_recycle_
cache_size.
10, 11
and 12
cell_offload%
No
Cell Offload
configuration for
Exadata only
12
circuits
Yes
AE does not
10, 11
support Shared
and 12
Server operations.
Automation Engine
Parameter
Releva
nt for
AE
Description
Oracle
versio
n
client_result_
cache_lag
Yes
11 and
12
client_result_
cache_size
Yes
11 and
12
clonedb
No
cluster_
database
Yes
TRUE for AE in
the RAC, FALSE
for Single
Instance
Database.
10, 11
and 12
cluster_
database_
instances
Yes
The number of
RAC instances.
10, 11
and 12
cluster_
interconnects
No
RAC interconnect
selection.
10, 11
and 12
Yes
Currently, AE
11 and
does not support
12
the feature
COMMITBATCH
for the Automation
Engine.
commit_
logging
Recommended value
279
IMMEDIATE
commit_
point_strength
commit_wait
No
WAIT
commit_write
10, 11
and 12
Yes
11 and
12
Yes
Is deprecated.
10 and
11
common_
user_prefix
C##
No
Used for
Multitenant
Database
12
compatible
12.1.0.2.0
Yes
This should
contain the
current Oracle
version.
10, 11
and 12
control_file_
record_keep_
time
No
10, 11
and 12
280
Chapter 3 Configuration
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
control_files
No
control_
DIAGNOSTIC+TUNING
management_
pack_access
No
Depending on
your Oracle
Management
Pack Licenses.
11 and
12
core_dump_
dest
No
10, 11
and 12
cpu_count
No
It is automatically
set to the number
of CPUs.
10, 11
and 12
create_
bitmap_area_
size
No
10, 11
and 12
create_
stored_
outlines
No
10, 11
and 12
D:\ORACLE\DIAG\RDBMS\O111\O111\CD
UMP
10, 11
and 12
cursor_
sharing
EXACT
Yes
As of Oracle
version 11, you
can implement
FORCE at your
own risk.
10, 11
and 12
cursor_
space_for_
time
FALSE
No
10, 11
and 12
db_big_table_
cache_
percent_
target
Yes
Do not set,
influence query
performance for
data warehouse
workloads
12
db_block_
buffers
Yes
AE does not
recommend using
this parameter
because it has
been replaced by
the parameter db_
cache_size.
10, 11
and 12
db_block_
checking
FALSE
No
10, 11
and 12
db_block_
checksum
TYPICAL
No
10, 11
and 12
Automation Engine
281
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
db_block_
size
8192
Yes
Automic
recommends a
standard block
size of 8K; the
allowed minimum
is 4K.
10, 11
and 12
db_cache_
advice
ON
Yes
10, 11
and 12
db_cache_
size
Yes
db_create_
file_dest
No
10, 11
and 12
db_create_
online_log_
dest_1
No
10, 11
and 12
db_create_
online_log_
dest_2
No
10, 11
and 12
db_create_
online_log_
dest_3
No
10, 11
and 12
db_create_
online_log_
dest_4
No
10, 11
and 12
db_create_
online_log_
dest_5
No
10, 11
and 12
db_domain
No
10, 11
and 12
db_file_
multiblock_
read_count
32
Yes
The required
buffer cache size
depends on your
database size.
The database
administrator can
change it for
tuning measures.
10, 11
and 12
10, 11
and 12
db_file_
name_convert
No
10, 11
and 12
db_files
No
10, 11
and 12
282
Chapter 3 Configuration
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
db_flash_
cache_file
Yes
11gR2
and 12
db_flash_
cache_size
Yes
11gR2
and 12
db_
flashback_
retention_
target
No
db_keep_
cache_size
Yes
db_lost_
write_protect
No
10, 11
and 12
db_name
No
10, 11
and 12
db_
performance_
profile
No
12
db_recovery_
file_dest
No
10, 11
and 12
db_recovery_
file_dest_size
No
10, 11
and 12
db_recycle_
cache_size
Yes
10, 11
and 12
Automic Supports
the use of
KEEPCACHE
and
RECYCLECAC
HE as tuning
measures.
Automic Supports
the use of
KEEPCACHE
and
RECYCLECAC
HE as tuning
measures.
10, 11
and 12
10, 11
and 12
Automation Engine
283
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
db_securefile
PERMITTED
Yes
The database
administrator can
change it as a
tuning purposes.
11 and
12
db_ultra_safe
OFF
No
db_unique_
name
No
10, 11
and 12
db_
unrecoverabl
e_scn_
tracking
No
12
dbwr_io_
slaves
Yes
10, 11
and 12
db_writer_
processes
Yes
10, 11
and 12
defferred_
segment_
creation
db_16k_
cache_size
TRUE
No
Yes
11gR2
and 12
AE accepts the
use of different
DB block sizes as
a tuning measure
but it does not
explicitly support
it in version
upgrades.
10, 11
and 12
284
Chapter 3 Configuration
Parameter
Releva
nt for
AE
Description
Oracle
versio
n
db_2k_
cache_size
Yes
AE accepts the
use of different
DB block sizes as
a tuning measure
but it does not
explicitly support
it in version
upgrades.
10, 11
and 12
db_32k_
cache_size
Yes
AE accepts the
use of different
DB block sizes as
a tuning measure
but it does not
explicitly support
it in version
upgrades.
10, 11
and 12
db_4k_
cache_size
Yes
AE accepts the
use of different
DB block sizes as
a tuning measure
but it does not
explicitly support
it in version
upgrades.
10, 11
and 12
db_8k_
cache_size
Yes
AE accepts the
use of different
DB block sizes as
a tuning measure
but it does not
explicitly support
it in version
upgrades.
10, 11
and 12
ddl_lock_
timeout
No
11 and
12
No
10
dg_broker_
config_file1
No
10, 11
and 12
dg_broker_
config_file2
No
10, 11
and 12
10, 11
and 12
ddl_wait_for_
locks
Recommended value
FALSE
dg_broker_
start
FALSE
No
diagnostic_
dest
D:\ORACLE
No
11 and
12
Automation Engine
285
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
disk_asynch_
io
TRUE
Yes
Automic
recommends
using TRUE
unless there are
known OS
producer
limitations.
10, 11
and 12
dispatchers
No
10, 11
and 12
distributed_
lock_timeout
No
10, 11
and 12
dml_locks
>= 500
Yes
10, 11
and 12
dnfs_batch_
size
Yes
Max number of
dNFS async I/O
requests queued
per session
11gR2
and 12
drs_start
No
This parameter is
deprecated.
10, 11
and 12
dst_upgrade_
insert_conv
No
12
enable_ddl_
logging
No
11 and
12
enable_
goldengate_
replication
No
12
enable_
pluggable_
database
No
12
exclude_
seed_cdb_
view
No
Related to
12
Multitenant Option
event
Yes
This parameter is
used for
troubleshooting
purposes.
fal_client
No
10, 11
and 12
fal_server
No
10, 11
and 12
fast_start_io_
target
No
This parameter is
deprecated.
10, 11
and 12
10, 11
and 12
286
Chapter 3 Configuration
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
fast_start_
mttr_target
No
10, 11
and 12
fast_start_
parallel_
rollback
No
10, 11
and 12
fileio_
network_
adapters
No
10, 11
and 12
file_mapping
No
10, 11
and 12
filesystemio_
options
SETALL
Yes
Automic
recommends
using SETALL
unless there are
known OS
producer
limitations.
10, 11
and 12
fixed_date
NONE
Yes
This parameter
must be set to
NONE.
10, 11
and 12
gc_files_to_
locks
Yes
This parameter
must not be set
for AE in the
RAC.
10, 11
and 12
gcs_server_
processes
Yes
This parameter
must not be set
for AE in the
RAC.
10, 11
and 12
global_
context_pool_
size
No
This parameter is
deprecated.
10, 11
and 12
global_names
No
10, 11
and 12
global_txn_
processes
No
11 and
12
hash_area_
size
Yes
hi_shared_
memory_
address
No
10, 11
and 12
hs_
autoregister
No
10, 11
and 12
Automic
recommends
using pga_
aggregate_target.
10, 11
and 12
Automation Engine
Parameter
Recommended value
Releva
nt for
AE
Description
287
Oracle
versio
n
ifile
No
instance_
groups
No
instance_
name
No
10, 11
and 12
instance_
number
No
10, 11
and 12
instance_type RDBMS
Yes
This parameter
must be set to
RDBMS.
10, 11
and 12
java_jit_
enabled
No
11 and
12
java_max_
sessionspac
e_size
No
AE doesnot use
JAVAin the
database.
10, 11
and 12
java_pool_
size
No
10, 11
and 12
java_soft_
sessionspac
e_limit
No
AE doesnot use
JAVAin the
database.
10, 11
and 12
job_queue_
processes
No
10, 11
and 12
large_pool_
size
No
10, 11
and 12
TRUE
10, 11
and 12
This parameter is
deprecated.
10, 11
and 12
ldap_
directory_
access
NONE
No
10, 11
and 12
ldap_
directory_
sysauth
No
No
11 and
12
license_max_
sessions
No
10, 11
and 12
license_max_
users
No
10, 11
and 12
license_
sessions_
warning
No
10, 11
and 12
listener_
networks
No
12
288
Chapter 3 Configuration
Parameter
Releva
nt for
AE
Description
Oracle
versio
n
local_listener
Yes
10 and
11
lock_name_
space
No
This parameter is
deprecated.
10, 11
and 12
lock_sga
Recommended value
No
10, 11
and 12
log_archive_
config
No
10, 11
and 12
log_archive_
dest
No
10, 11
and 12
No
10, 11
and 12
log_archive_
dest_%
No
10, 11
and 12
log_archive_
duplex_dest
No
10, 11
and 12
10, 11
and 12
log_archive_
dest_state_%
FALSE
enable
log_archive_
format
ARC%S_%R.%T
No
log_archive_
local_first
TRUE
No
This parameter is
deprecated.
10, 11
and 12
log_archive_
max_
processes
No
10, 11
and 12
log_archive_
1
min_
succeed_dest
No
10, 11
and 12
log_archive_
start
No
log_archive_
trace
No
log_buffer
log_
checkpoint_
interval
5653504
Yes
No
This parameter is
deprecated.
10, 11
and 12
10, 11
and 12
Automic
recommends
using a log buffer
of at least 5 MB
and not more than
20 MB.
10, 11
and 12
10, 11
and 12
Automation Engine
Parameter
Recommended value
Releva
nt for
AE
Description
289
Oracle
versio
n
log_
checkpoints_
to_alert
No
10, 11
and 12
log_
checkpoint_
timeout
No
10, 11
and 12
log_file_
name_convert
No
10, 11
and 12
logmnr_max_
persistent_
sessions
No
This parameter is
deprecated.
10
max_commit_ 0
propagation_
delay
Yes
As of Oracle
version 11g2, this
parameter is
deprecated and
cannot be used
anymore.
10, 11
max_
dispatchers
No
10, 11
and 12
No
10, 11
and 12
max_dump_
file_size
unlimited
max_
enabled_roles
Yes
max_shared_
servers
No
This parameter is
deprecated and
should not be set.
10, 11
and 12
10, 11
and 12
max_string_
size
STANDARD
Yes
Do not change!
12
memory_
max_target
Yes
New Memory
11 and
Management
12
(SGA+PGA). The
required size
depends on the
database size. AE
recommends
using at least 1.5
GB.
290
Chapter 3 Configuration
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
memory_
target
Yes
New Memory
Management
(SGA+PGA). The
required size
depends on the
database size.
Automic
recommends
using at least 1.5
GB.
11 and
12
nls_calendar
nls_comp
No
BINARY
Yes
10, 11
and 12
For performance
reasons, you
should only use
BINARY.
10, 11
and 12
nls_currency
No
10, 11
and 12
nls_date_
format
No
10, 11
and 12
nls_date_
language
No
10, 11
and 12
nls_dual_
currency
No
10, 11
and 12
nls_iso_
currency
No
10, 11
and 12
nls_language
No
10, 11
and 12
nls_length_
semantics
CHAR
Yes
CHAR must be
set in order to
support
UNICODE
databases.
10, 11
and 12
nls_nchar_
conv_excp
No
10, 11
and 12
nls_numeric_
characters
No
10, 11
and 12
nls_sort
Yes
nls_territory
No
For performance
reasons, Automic
recommends
using the default
value BINARY.
10, 11
and 12
10, 11
and 12
Automation Engine
Parameter
Recommended value
Releva
nt for
AE
Description
291
Oracle
versio
n
nls_time_
format
No
10, 11
and 12
nls_
timestamp_
format
No
10, 11
and 12
nls_
timestamp_
tz_format
No
10, 11
and 12
nls_time_tz_
format
No
10, 11
and 12
nocdb_
compatible
FALSE
No
Multitenand
Option
12
object_
cache_max_
size_percent
No
10, 11
and 12
object_
cache_
optimal_size
No
10, 11
and 12
olap_page_
pool_size
No
10, 11
and 12
open_cursors
500
Yes
AE requires at
least 500.
10, 11
and 12
open_links
No
10, 11
and 12
open_links_
per_instance
No
10, 11
and 12
optimizer_
adaptive_
featured
TRUE
Yes
This parameter
can be used for
performance
tuning purposes
12
optimizer_
adaptive_
reporting_only
FALSE
Yes
This parameter
can be used for
performance
tuning purposes
12
optimizer_
capture_sql_
plan_
baselines
FALSE
Yes
This parameter
can be used for
performance
tuning purposes
11 and
12
optimizer_
dynamic_
sampling
Yes
AE requires a
value of >= 2.
Automic
recommends
using 2.
10, 11
and 12
292
Chapter 3 Configuration
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
optimizer_
features_
enable
11.1.0.6
Yes
Automic
recommends
using the current
Oracle version
unless you want
to deactivate
current optimizer
features
intentionally.
10, 11
and 12
optimizer_
index_
caching
Yes
10, 11
and 12
optimizer_
index_cost_
adj
Yes
10, 11
and 12
optimizer_
inmemory_
aware
Yes
12
Yes
AE requires ALL_
ROWS. You can
change this value
for performance
tuning purposes.
10, 11
and 12
optimizer_
mode
ALL_ROWS
optimizer_
secure_view_
merging
No
10, 11
and 12
optimizer_
use_invisible_
indexes
No
11 and
12
optimizer_
use_pending_
statistics
No
11 and
12
optimizer_
use_sql_
plan_
baselines
Yes
os_authent_
prefix
No
10, 11
and 12
os_roles
No
10, 11
and 12
11 and
12
Automation Engine
Parameter
Recommended value
Releva
nt for
AE
o7_
dictionary_
accessibility
FALSE
No
10, 11
and 12
parallel_
adaptive_
multi_user
No
10, 11
and 12
parallel_
automatic_
tuning
No
This parameter is
deprecated.
10, 11
and 12
parallel_
degree%
Parameter
No
Do not adjust
12
parallel_
execution_
message_
size
No
parallel_
force_local
TRUE
No
Description
293
Oracle
versio
n
10, 11
and 12
If parallel query is
used for some
reasons it should
stay on local RAC
node
12
parallel_
instance_
group
No
10, 11
and 12
parallel_io_
cap_enabled
Yes
parallel_max_
servers
No
10, 11
and 12
parallel_min_
percent
No
10, 11
and 12
parallel_min_
servers
No
10, 11
and 12
parallel_
server
No
This parameter is
deprecated.
10, 11
and 12
parallel_
server_
instances
No
This parameter is
deprecated.
10, 11
and 12
parallel_
server_target
No
11 and
12
12
294
Chapter 3 Configuration
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
parallel_
threads_per_
cpu
No
10, 11
and 12
pdb_file_
name_convert
No
pdb_
lockdown
No
12
pdb_os_
credential
No
12
permit_92_
wrap_format
No
12
Multitenand
Option
12
pga_
aggregate_
limit
Some 100 MB
Yes
Automic
recommends a
limit of 4*pga_
aggregate_limit
and a minimum of
2GB
12
pga_
aggregate_
target
Some 100 MB
Yes
Automic
10, 11
recommends
and 12
using pga_
aggregate_target
(or memory_target
as of Oracle
version 11). You
can change this
value for
performance
tuning purposes.
Automic
recommends
using >= 500MB.
plscope_
settings
No
11 and
12
plsql_ccflags
No
10, 11
and 12
plsql_code_
type
No
10, 11
and 12
plsql_
compiler_
flags
No
This parameter is
deprecated.
10
plsql_debug
No
This parameter is
deprecated.
10, 11
and 12
plsql_native_
library_dir
No
10, 11
and 12
Automation Engine
Parameter
Recommended value
Releva
nt for
AE
Description
295
Oracle
versio
n
plsql_native_
library_
subdir_count
No
10, 11
and 12
plsql_
optimize_
level
No
10, 11
and 12
plsql_v2_
compatibility
No
plsql_
warnings
No
10, 11
and 12
pre_page_sga
No
10, 11
and 12
processes
Yes
processes_
group_name
No
12
query_
rewrite_
enabled
No
10, 11
and 12
query_
rewrite_
integrity
No
10, 11
and 12
rdbms_
server_dn
No
10, 11
and 12
read_only_
open_delayed
No
10, 11
and 12
recovery_
parallelism
No
10, 11
and 12
No
10, 11
and 12
redo_
transport_
user
No
11 and
12
remote_
archive_
enable
No
remote_
dependencie
s_mode
No
recyclebin
on
This parameter is
deprecated.
AE requires at
least 150.
This parameter is
deprecated.
10, 11
and 12
10, 11
and 12
10
10, 11
and 12
296
Chapter 3 Configuration
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
remote_
listener
Yes
A reasonable
10, 11
configuration for
and 12
AE in the RACis
required in order to
ensure that the
instance can
communicate with
the Remote
Listeners.
remote_login_
passwordfile
No
remote_os_
authent
No
remote_os_
roles
No
10, 11
and 12
replication_
dependency_
tracking
No
10, 11
and 12
resource_limit FALSE
Yes
No resource limits
must be set for
AE.
10, 11
and 12
resource_
manager_
cpu_
allocation
Yes
11 and
12
resource_
manager_plan
Yes
10, 11
and 12
result_cache_
max_result
Yes
11 and
12
result_cache_
max_size
Yes
11 and
12
result_cache_
mode
Yes
11 and
12
10, 11
and 12
This parameter is
deprecated.
10, 11
and 12
Automation Engine
Parameter
Releva
nt for
AE
Description
Oracle
versio
n
result_cache_
remote_
expiration
Yes
11 and
12
resumable_
timeout
No
rollback_
segments
No
Automic
recommends
using UNDO
management
10, 11
and 12
sec_case_
sensitive_
logon
No
Parameter is
deprecated with
12c
11
sec_max_
failed_login_
attempts
No
11 and
12
sec_protocol_
error_further_
action
No
11 and
12
sec_protocol_
error_trace_
action
No
11 and
12
sec_return_
server_
release_
banner
No
11 and
12
serial_reuse
Recommended value
297
disable
No
10, 11
and 12
This parameter is
deprecated.
10, 11
and 12
service_
names
No
10, 11
and 12
session_
cached_
cursors
No
10, 11
and 12
session_
max_open_
files
No
10, 11
and 12
sessions
Yes
10, 11
and 12
Yes
10, 11
and 12
sga_max_
size
298
Chapter 3 Configuration
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
sga_target
Yes
10, 11
and 12
shadow_
core_dump
No
10, 11
and 12
shared_
memory_
address
No
10, 11
and 12
shared_pool_
reserved_size
Yes
Automic
recommends
using the
parameter sga_
target or memory_
target.
10, 11
and 12
shared_pool_
size
Yes
Automic
recommends
using the
parameter sga_
target or memory_
target.
10, 11
and 12
shared_
servers
No
10, 11
and 12
shared_
server_
sessions
No
10, 11
and 12
skip_
unusable_
indexes
TRUE
Yes
smtp_out_
server
No
sort_area_
retained_size
Yes
10, 11
and 12
10, 11
and 12
Automic
recommends
using the
parameter pga_
aggregate_target
or memory_target
as of Oracle
version 11.
10, 11
and 12
Automation Engine
Parameter
Recommended value
299
Releva
nt for
AE
Description
Oracle
versio
n
sort_area_
size
Yes
Automic
recommends
using the
parameter pga_
aggregate_target
or memory_target
as of Oracle
version 11.
10, 11
and 12
spatial_
vector_
acceleration
No
spfile
No
Automic
recommends
using SPFILEs.
10, 11
and 12
sql_trace
No
This parameter is
deprecated.
10, 11
and 12
sqltune_
category
No
sql_version
No
sql92_
security
No
standby_
archive_dest
No
standby_file_
management
No
12
10, 11
and 12
This parameter is
deprecated.
10, 11
and 12
10, 11
and 12
This parameter is
deprecated.
10, 11
and 12
10, 11
and 12
star_
transformatio
n_enabled
FALSE
Yes
10, 11
and 12
statistics_
level
TYPICAL
Yes
10, 11
and 12
streams_
pool_size
No
10, 11
and 12
tape_asynch_
io
No
10, 11
and 12
thread
No
10, 11
and 12
300
Chapter 3 Configuration
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
timed_os_
statistics
No
10, 11
and 12
timed_
statistics
No
10, 11
and 12
trace_enabled
No
10, 11
and 12
tracefile_
identifier
No
10, 11
and 12
transactions
Yes
10, 11
and 12
transactions_
per_rollback_
segment
No
Automic
recommends
using UNDO
management.
10, 11
and 12
undo_
management
AUTO
Yes
Automic
recommends
using UNDO
management.
10, 11
and 12
undo_
retention
900
Yes
You required an
appropriate size
(depending on the
database size) in
order to archive
data with the
utility
AE.DBArchive
(i.e. without ILM).
10, 11
and 12
undo_
tablespace
No
10, 11
and 12
unified_audit_
sga_queue_
size
No
10, 11
and 12
No
10, 11
and 12
use_indirect_
data_buffers
FALSE
user_dump_
dest
No
utl_file_dir
No
This parameter is
deprecated.
10, 11
and 12
10, 11
and 12
Automation Engine
301
Parameter
Recommended value
Releva
nt for
AE
Description
Oracle
versio
n
workarea_
size_policy
AUTO
Yes
Automic
recommends
using pga_
aggregate_target;
thus the value
AUTO must be
used.
10, 11
and 12
xml_db_
events
enable
No
11 and
12
Hardware
Your Database Computer is the core part of AE and data-center automation. Using adequate performance
and security features is therefore crucial.
Refer to the hardware requirements in the chapter requirements for operating AE.
Software
Make sure the operating system and software is correctly installed on the computer.
Hardware
Your Server computer is the core part of AE and data-center automation. Using adequate performance and
security features is therefore crucial.
Refer to the hardware requirements in the chapter requirements for operating AE.
Deactivate low-current functions and dynamical cycle adjustment in the BIOS on the Automation
Engine computer if x core AMD CPU is used.
302
Chapter 3 Configuration
Software
Make sure the operating system and software is correctly installed on the computer.
Traces
Make sure a trace is only activated when necessary. When writing a trace, the trace file must be open and
closed for each job. This leads to significant performance losses.
Hardware
Refer to the hardware requirements in the chapter requirements for operating the Automation Engine.
Resource requirements: 15 MB hard drive
Software
Make sure the operating system and software are properly installed on this computer.
Automation Engine
In ucdj.bat these parameters should be placed as follows:
java -Dsun.java2d.d3d=false -cp
.;.\ucdj.jar;.\xmlParserAPIs.jar;.\xercesImpl.jar
com/uc4/ucdf/UCDialogFactory -LE
See also:
UserInterface (Windows), Structure of the INI file
303
304
Chapter 4 Database
4 Database
4.1 Overview
This overview shows the documentation chapters that describe the necessary steps for databases using
AE.
Setting up the database
l
l
l
DB2
MS SQL Server
Oracle
Configuration
l
l
l
DB2
MS SQL Server
Oracle
Installation
l
l
l
l
l
Maintenance
l
l
Data
l
Transporting Data
Automation Engine
305
The file PASSWORD.UCC which contains the encoded password is created in the same directory. The
encoded password can now be copied to the INI file.
UCYBCRYP.EXE requires the C++ 2010 Redistributable Package.
Example
ucybcryp -p -n uc4
Note that an encrypted password starts with two leading hyphens. Two exclamation marks are shown
instead of hyphens if the file content of PASSWORD.UCC under Windows is output with the
command TYPE. Thus, always copy the password from the file.
Decide whether you create the data source as a User DSN (user specific) or as a System DSN (once for
all users of this computer). Automic recommends using the System DSN.
A System DSN must be set up if the Automation Engine should be run as a service on this computer.
Call the "System DSN" tab and add a new data source by selecting "SQL Server".
Note that the SQLnative client is required in order to use the AE database with MARS. You can
download it from the Microsoft homepage if it is not yet installed on your computer.
Some basic settings are required in the following dialog box. Enter the name and description of the data
source. Select "local" if the SQL Server is on the same computer, otherwise enter the name of the DB
computer.
306
Chapter 4 Database
Select "SQL Server authentication" and enter the login ID and password in the following dialog box.
Automic recommends creating a separate database user for AE. Do not employ the user "sa".
Automation Engine
Select the required options in the last dialog box. Note that the third check box "Perform translation for
character data" must not be selected.
Potential Problems
l
l
307
308
Chapter 4 Database
MS SQL Server
The database user requires the role "db_owner".
sp_addrolemember 'db_owner','uc4'
Oracle
l
l
l
l
l
l
l
l
l
l
CREATE SESSION
CREATE TABLE
CREATE SEQUENCE
CREATE PROCEDURE
EXECUTEANY PROCEDURE
CREATEVIEW
CREATEPUBLICSYNONYM
DROPPUBLICSYNONYM
ALTER SESSION
Either the system privilege UNLIMITED TABLESPACE or the tablespace quotas for all
tablespaces
The right EXECUTE for the DBMS package (command so set this right: GRANT execute ON
dbms_lock TO <schema_name>). This right can only be set by a user who has the SYSDBA
privilege.
Example commands that can be used to assign the relevant rights to the database user uc4:
GRANT create table, create sequence, create session, create procedure,
execute any procedure, create public synonym, drop public synonym, create
view, alter session TO uc4;
GRANT execute ON dbms_lock TO uc4;
GRANT unlimited tablespace TO uc4;
The following example commands can be used to check the rights:
Step 1: CREATETABLE
CREATE TABLE UCDUMMY (UCDUMMY_PK INTEGER NOT NULL, UCDUMMY_System VARCHAR2
(8) NULL,
CONSTRAINT PK_UCDUMMY PRIMARY KEY
(
UCDUMMY_PK
) USING INDEX TABLESPACE UC4_INDEX
) TABLESPACE UC4_DATA;
Step 2: CREATESEQUENCE
CREATE SEQUENCE SQ_UCDUMMY
INCREMENT BY 1 START WITH 1 MAXVALUE 999999999
MINVALUE 1 CYCLE CACHE 1000 NOORDER;
Step 3: CREATEPROCEDURE
Automation Engine
309
DB2
l
l
l
l
See also:
New Installation - Setting Up The Database
Update Installation - Details
310
Chapter 4 Database
l
l
l
DB2
MS SQL Server
Oracle
Note that data records should also be reorganized. This is easily done using the supplied utilities.
Description
Different areas are available for the tables:
Area
Table name
Object
area
CODE, HACL, HOST, IY, JBA, JFA, JPA, JPOP, JPOV, JPP, JPPA, JPPC, JPPCV,
JPPF, JPPO, JPPV, JPVA, MAND, OACL, OBLOB, OCA, OCV, ODOC, OEA, OET,
OFA, OFC, OFS, OGA, OH, OHA,OHAA, OHAF, OHG, OHGF, OIA, OKA, OKB, OKC,
OKD, OEO, OKG, OKZ, OLC, ONA, OOA, OOI, OPPF, OPSA, OPSE, OPSEA, OPU,
OPUD, OPUDA, OQA, OQT, ORA, ORACL, ORADR, ORB, ORCON, ORET, ORLNK,
ORSYS, OSA, OT, OTA, OTI, OTZC, OUA, OVB, OVC, OVD, OVP, OV, OVT, OVW,
OX, OY, OYD, OYR, OYW, UACL, USG, USR, USRG, USRP
Activities
ECA, ECV, EEC, EEDB, EET, EFC, EH, EJ, EJPCV, EJPFV, EJPOP, EJPOV, EJPP,
EJPPA, EJPPC, EJPPF, EJPPO, EJPPV, EJPVA, EOI, EPD, EPDC, EPPF, EPUD,
EPUDA, EQT, ERB, ERET, ESTP, ETI, EV, EVP, EY
Archive
and
Statistics
ABLOB, ACA, ACMT, ACV, AFC, AH, AHG, AHGH, AJPCV, AJPFV, AJPOP, AJPOV,
AJPP, AJPPA, AJPPF, AJPPO, AJPPC, AJPPV, AJPVA, APD, APDC, APPF, ARB,
AV, AWS, LAH, LLOG, RH, RT, XAO, XRO
Forecast
Messages
MELD
Processing IPH, ISTMT, ITL, MQCP*, MQDWP, MQLS, MQMEM, MQOWP, MQPWP, MQQWP,
MQRWP, MQSRV, MQWP
System
tables
Temporary
tables
non-used
tables
Automation Engine
311
The size of this table depends on the number of objects that have been created. Usually, it grows slowly. If
the Version Management is used or Transport Cases are loaded and clients are copied, these tables grow
rapidly. Use the provided utilities for deleting object versions, Recycle Bin contents or clients that are no
longer used.
Creating statistics is very useful. Reorganize your tables and indexes if major modifications were
made, otherwise do so from time to time.
Activities
The tables of this area contain information about the activities taking place in the AE system. Therefore, its
size depends on the tasks that are shown in the Activity Window. Automic recommends specifying
"Deactivate automatically" in order to keep control over table growth and avoid possible adverse effects on
performance.
It is not possible to work with dynamic statistics because table entries change constantly. Automic
recommends creating one-time statistics instead. Tables and indices must only be reorganized when there
have been atypically large table movements. Usually, they do not have to be reorganized.
Archives and Statistics
This area comprises the largest part of the AE database because it keeps growing slowly but surely. Its
content depends on the ongoing activities and the corresponding reports. The "RT" table is the largest one.
Significant changes in volume occur when clients are copied or deleted. Use the supplied utilities in order
to archive and remove data.
Automic recommends creating statistics whenever data records have been reorganized. Tables and
indices should also be reorganized on a regular basis.
Forecast
Forecasts comprise a small area of the AE database because mostly not many forecasts are available.
Statistics must only be created once.
Messages
The table MELD is relatively large. It includes AE system messages and keeps growing constantly. Use
the supplied utilities in order to reduce data amounts.
Automic recommends creating statistics whenever you have had data records reorganized. Reorganize
tables and indices regularly.
Processing
Because processing is handled on a highly dynamic basis, the corresponding tables are mostly empty.
Creating statistics automatically is not useful. Automic recommends creating statistics once on a
manual basis. Tables and indices must only be reorganized after unusually large table movements but not
regularly. Example: The work processes block because of a database problem. The communication
processes run as usual and write in the corresponding tables. These tables are not processed.
System tables
These tables are almost static; data amounts do not really change.
312
Chapter 4 Database
See also:
Maintaining Data Records
Utilities
Supported
databases
Administrative
effort
Low
Higher
Usage
(the more executions per time the longer (short maintenance run almost
takes the maintenance run)
independent from number of job
executions per time)
Performance
The maintenance run can burden the AE Changing the partition burdens the AE
system if there are numerous data
system only marginally.
records.
Maintenance time
and relevant
settings
Archiving
Automation Engine
313
For
Utilities
Viewing archived
data records
Possible
Not possible
Reports
if just a few tasks run in your AE system. This includes that there are fewer statistical records,
reports and messages.
if lots of tasks run in your AE system. This includes that there are many data records or
if you do not want to archive the data records. Partitions can be deleted quickly and easily.
Note that it is still necessary to run the utilities to reorganize object versions and deleted objects as
they are not covered by partitioning with ILM
Statistical records
Reports
Messages and data for the Revision Reportand the Open Interface toOutput Management Systems
AE.DBArchive
AE.DBReorg
AE.DBUnload
General
The utilities included in the maintenance procedure can be called in batch mode (see Start Parameters).
Use this opportunity and create a Workflow in your AE system, which carries out the individual steps on a
regular basis (see example)! The particular settings need to be specified only once in the utility.
Note that system client 0000 should also be maintained! It can accumulate major amounts of data as it
contains the log files of the servers and agents and other data.
314
Chapter 4 Database
Note that you must not backup the table DIVDB when you use a DB2 database and want to backup it
manually before you run the reorganization process. The reason is that the reorganization process uses
the table DIVDB runnning this statement
ALTER TABLE DIVDB ACTIVATE NOT LOGGED INITIALLY WITH EMPTY TABLE
and you can neither restore the backup data nor run the command ROLLFORWARD anymore.
Procedure
1.
Archiving
The utility AE DB Archive serves to archive messages, statistics and reports. The generated files are
clearly structured in folders organized by clients and archiving runs. As folder names also contain the
corresponding dates, it is easier to locate particular data records.
Archived data can be viewed with the Archive Browser at any time. Set filters to limit the number of
data records to be displayed depending on your requirements.
2.
Reorganizing
Use the utility AE DB Reorg for the subsequent reorganization of data records. These are marked with
deletion markers in this step but are not yet deleted from the database!
3.
Call the utility AE DB Unload to finally erase the data records from the database. Use the option
"Reorganize database". If necessary, this utility can also be used for resetting archive and reorganization
flags.
Performance Improvement
The archiving, reorganizing and unloading processes can take some time if huge amounts of data are
involved. The following tips can help to improve performance by accelerating the above processes:
l
When reorganizing, avoid using the option "Keep the last n statistics." By doing so, the utility AE
DB Reorg does not count all statistical records of all objects but directly starts the reorganization
process using the date as a basis.
Only reorganize reports if they should be reorganized before the statistical records. If this option is
not activated, the utility AE DB Reorg reorganizes reports together with the statistical records.
In the utility AE DB Unload, specify that no REORG files should be generated. The corresponding
parameter suppress_output= is available in the INI file section [REORG].
See also:
Sample Collection - Database Maintenance with Options
Technical Maintenance of the AE database
Automation Engine
315
Statistical records
Reports
Messages and data for the Revision Report and the Open Interface to Output Management
Systems.
One method to maintain the AE database is to utilize partitioning with ILM (Information Lifecycle
Management).
General
Partitioning means that the data referred to above is stored in specific areas. Partitioning simplifies
maintenance because data records of a particular period are stored at the same location and can be
archived and reorganized together.
The starting point is the activation of an object, server process, agent etc. The statistical record which is
created during such a process is stored in the current partition. All corresponding data (e.g. reports) is
stored in the partition in which this statistical record has been stored.
You can specify the number of partitions and where they should be stored. Even the interval for a partition
change can be configured.
Partitioning with ILM is supported for the MSSQLServer (only Enterprise or Developers Edition) and
for Oracle.
The System Overview includes the area ILM in which the partitions are displayed.
Access to this area is protected with a privilege.
Note that object versions and deleted objects must still be reorganized with utilities even if you use
partitioning with ILM.
Functioning
Let us look at the principle of partitioning using an example:
An AE database contains three partitions. A partition change is performed at the beginning of every month.
Thus, partition "P1" contains the data records of activations which took place in September and partition
"P2" those of October. The current month is November and the corresponding partition is "P3". The data of
an object that is activated during this month is stored in P3. A task that has already started in October but
ends now is stored in partition "P2".
The three partitions "P1", "P2" and "P3" are online which means that the Automation Engine can access
data records in them.
316
Chapter 4 Database
Several weeks pass, it is the beginning of December and time has come to change the partition. The newly
created partition "P4" is the most current one. As the number of online partitions can be specified, the
system first checks whether this value has been exceeded. In this example, the specified value is "3"; this
means that the same container (tablespace/filegroup) is used as for partition "P1". The data within partition
P1 will be available until you decide to drop the partition.
Partitions
In the example above, statistical records, reports, messages etc. of a particular period of time are stored in
one container. It is also possible to store reports and messages each in a separate container
(tablespace/filegroup). Three variables are available in which you can determine the storage locations for
partitions:
l
l
Automation Engine
l
317
All three variables must have the same number of entries. It is not possible to use five partitions for
statistical records but only three for reports.
Partition Change
Use a Calendar object to specify the days on which a partition change should take place. Enter the name
of the Calendar object and the keyword in the variable UC_ILM_SETTINGS, key CALENDAR. The
partition changes at 00:00 on the specified days. The TimeZone of system client 0000 serves as the time
basis. Should the Automation Engine not be active at this point in time, the partition will change at its next
start time.
When the time for a partition change has come, processing in the AE system comes to a halt and waits
until all work processes have ended their current database transactions. The key TIMEOUT in the variable
UC_ILM_SETTINGS is decisive for the maximum waiting time. A new partition can only be created if
there are no longer any active database transactions.
Now the system checks whether there are more online partitions than specified in the variable UC_ILM_
SETTINGS, key ONLINE_PARTITIONS. If this is the case (MSSQLServer), the system checks
whether partitions that exceed the specified value contain data records of active tasks.
The Automation Engine's log file includes detailed information about the partition change. This includes
a list of all active tasks of the partition which should no longer be online.
You can check a partition for active tasks at any time via the System Overview, area "ILM". The result
is also supplied in list form.
MSSQL Server: A switch-out is performed if a partition no longer contains data records of active tasks.
During this process, a staging table is created which can be stored, unloaded etc.
Oracle databases: The partition remains the same and you can use Oracle means on partition level to
create backups, exports etc. and then delete them. Oracle only checks for active tasks when an attempt is
made to delete the partition.
A partition remains as it is if it still contains data records of active tasks. This partition is checked again
when the next partition change is performed. You can check the list of active tasks, adjust it and finally
perform a switch-out for the relevant partition or delete it in the System Overview.
Note that you can archive, delete etc. a partition even if it contains active tasks. Automic strongly
recommends contacting Automic Support in this case in order to avoid problems. For example, if a task
ends and its statistical record belongs to a deleted partition, its report cannot be stored and is lost.
You can automatically react to successful or failed partition changes via the variableUC_ILM_SETTINGS
in which you can define the objects to be activated in such a case. The keys EXECUTE_ON_SUCCESS
and EXECUTE_ON_FAILURE serve especially this purpose.
Long-Running Tasks
As described above, active tasks prevent the offline switching of partitions that contain the statistical
records of these active tasks. Automic recommends specifying an interval for the partition change which is
high enough to avoid such a situation. Despite this, there are tasks which run for a very long time or never
end by definition.
A regular log change is made and a new statistical record is created for the following tasks:
318
Chapter 4 Database
l
l
l
Events
RemoteTaskManager
Recurring tasks
Compare the log-change interval with the time interval of the partition change.
In the following tasks, the log changes automatically directly before a partition change takes place:
l
l
Cockpits
One-time tasks
The following tasks require manual interference because no log change is made:
l
l
ALL_TAB_PARTITIONS
ALL_CONSTRAINTS
ALL_PART_INDEXES
ALL_INDEXES
ALL_TABLES
The following rights are also required for the database user for the ILM actions:
l
l
ALTERTABLE
DROPPARTITION
Installation
ILM installation is performed using the utility AE.DBLoad when loading initial data. Install ILM:
l
l
l
The AE database must be maintained using the utilities if you decide not to use partitioning with ILM.
Note that you cannot de-install partitioning with ILM but you can deactivate the ILM functionality. If ILM
is not active, no partition change or switch-out (only MS SQL Server) is performed.
When you use an Oracle database, make sure that there is only one schema of Automation Engine
version 8.00A within an Oracle instance that is used for ILM.
Automation Engine
319
Procedure
1. Think about the number of partitions that your AE system should have and where they should be
stored.
2. Create the files and file groups (MSSQL Server) or tablespaces (Oracle). They should only contain
data of your AE system in order to facilitate the archiving and storage of partitions. The Automation
Engine does not check whether file groups or tablespaces are also used for other purposes.
3. Start the utility AE DB Load and load the initial data. A form is displayed in which you can specify
the main settings for ILM.
4. Activate the checkbox "Install ILM".
5. Enter the number of online partitions.
6. When updating to or within Automation Engine version 8.00A or later, you can activate the
checkbox "Do Switch-In after installation". Doing so has the effect that existing data is stored in the
partitions.
7. Enter the file groups (MSSQL Server) or tablespaces (Oracle).
8. All other settings can be specified as soon as the Automation Engine is active and you have logged
on to the AE system via the UserInterface.
9. Log on to system client 0000.
10. Adjust the variables UC_ILM_SETTINGS and UC_CONTAINER_* (if required).
11. Adjust the setting CHANGE_LOGGING_DAYS within UC_SYSTEM_SETTINGS to fit to the
partition change interval.
12. Automate partition handling (e.g. archiving, storage, deletion etc.).
Script
The script function ILM can be used to control particular functions.
Procedure
1.
Selection
320
Chapter 4 Database
In the first step, select the objects that should be transported in the Explorer and move them to the
Transport Case. Use the "Transport" command or the drag-and-drop function for this purpose. Note that
you need the privilege "Access to Transport Case". You can undo your selections at any time.
2.
Export
In the second step, call the utility AE DB Unload in order to unload the objects from the Transport Case to
a file (by default UC_DATA.TXT). The file name and its place of storage can be individually specified in the
INI file. Start the exporting process by clicking "Unload transport container". A dialog opens in which you
can select whether the export refers to only one particular client or to all clients. Enter "No" if only one
client is concerned, and then enter the client number in the next dialog window. You cannot export
particular object but you can determine whether the objects should be removed from the Transport Case
after they have been transported.
Note that the Transport Case of system client 0000 displays all objects that should be transported.
3.
Adjustment (optional)
You can modify exported data using the program AE DB Change. You can easily adjust this data to a
different AE system or client.
4.
Import
Loaded or modified data can be imported using the utility AE DB Load. It automatically recognizes the
loading type and opens some input dialogs. Specify if you want to keep the same clients (for example, if
you import to a different database) or if the utility should import all objects to one particular client.
Notes
l
l
l
Exports and imports involve a huge amount of data that is moved in the database. Ensure that
sufficient database space is available and note that the whole process can take a while. In some
cases, it can affect the performance of basic operations.
You can also export and import objects in batch mode by using start parameters.
In order to facilitate the import of a data file in batch mode, its name and path must be written to the
INI file of the loading program (input=).
Automation Engine
321
5 Diagnostic Tools
5.1 Logging/Trace
All AE programs write information about their activities to logs. The use of particular settings facilitates the
output of extended information in a trace. This is particularly useful when searching for and/or correcting an
error.
l
l
All logging/trace settings are found in the INI file (see below).
By default, the files (log and trace) are overwritten every time the system is restarted. In order to
keep older files for later use, you can specify the number of history files that should be kept with log
count and trccount. The file name has to contain the string ## . It is replaced by 00 in the actual file
name. The history files are then named 01, 02 etc. They are moved with every restart. The oldest
file (with the highest number) is deleted and all other files are renamed (number is increased by 1).
Logging information is also stored in the AE database and can be retrieved using Statistics/Logging.
INI-file settings:
Section
Name
Description
Required
[GLOBAL]
logging=
Yes
[GLOBAL]
logcount=
No (00)
[Trace]
file=
Yes
[Trace]
trccount=
No (00)
[Trace]
diverse
No (0)
Utility
AR
AE DB Archive
CC
AE DB Client Copy
LD
AE DB Load
RE
AE DB Reorg
UN
AE DB Unload
The same is true if the INI file cannot be found because it does not exist in the specified folder (see start
parameter -I).
Hence a log file is even created if incorrect settings were made.
322
Description
A - Status
ended
E - Status
ended
R - Status
running
This status is written to the log file periodically while the job is being executed.
V - Status
vanished
This status only occurs when the agent cannot find a job anymore that it has started (see
also: Finding Jobs after Agent Downtimes).
W - Status
waiting
See also:
Job - Execution
5.2 LOG_DUMP
Script function: Outputs values of the memory ranges to a log file
Syntax
LOG_DUMP (Memory range [, memory range,...][, additional info])
Syntax
Description/Format
Memory range
Automation Engine
Additional info
323
Return codes
"0" - The trace was successful.
"20209" - The indicated memory range is not supported.
"20210" - The XML handle is wrong.
"20211" - The table does not exist.
Comments
This script function only serves diagnostic purposes and must only be used in close cooperation with
the support team!
The trace output is written to the file specified in the INI file of the Server (see [GLOBAL] section).
The script function TRACE_DUMP works similarly but writes the result to the trace file and considers
the specified trace option and a trace level.
Example
In the following example, a trace for several memory ranges is activated:
:SET &RET# = LOG_DUMP("XML + &xml_hnd#, SCRIPT_VARA, SCRIPT_PRG")
See also:
Script element
Description
TRACE
TRACE_DUMP
About Scripts
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
5.3 TRACE
Script function: Outputs values to a trace file
Syntax
TRACE (Trace option, trace level, trace output)
Syntax
Description/Format
324
Trace option
Trace setting
Format: script variableor number
Allowed values:
"1" - TCP/IP
"2" - Database
"4" - Srcall
"5" - Memio
"6" - JCL
"7" - Memsv
"8" - SNMP
"9" - Zuxml
"10" - Cache
"12" - Ucds
"13" - Xscript
"14" - UC4global
"16" - Minimal
Trace level
Trace size
Format: script variableor number
The allowed values depend on the selected trace option.
Trace output
Return codes
"0" - The trace was successful.
"20208" - The trace level is not within the allowed range.
Comments
This script function only serves diagnostic purposes and must only be used in close cooperation with
the support team!
To enable trace output, keep the following instructions in mind:
l
The indicated trace option must also be activated in the System Overview (in the properties of the
Server processes).
Additionally, the specified trace level must at least be as high as set in the properties.
The trace output is written to the file specified in the INI file of the Server (see [TRACE] section).
Example
In the following example, a trace for the content of a script variable is activated. The trace is successful
when a database trace with at least one of four trace levels was activated in the properties of the Server
processes.
:SET &NUMBER# = 10
:SET &RET# = TRACE(2,4,"The variable NUMBER has the value: &NUMBER#")
See also:
Automation Engine
Script element
Description
LOG_DUMP
TRACE_DUMP
325
About Scripts
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
5.4 TRACE_DUMP
Script function: Supplies the values of the memory range in a trace file.
Syntax
TRACE_DUMP (Trace option, trace level, memory range[, memory range,...][, additional
info])
Syntax
Description/format
Trace option
Trace setting
Format: script variableor number
Allowed values:
"1" - TCP/IP
"2" - database
"4" - Srcall
"5" - Memio
"6" - JCL
"7" - Memsv
"8" - SNMP
"9" - Zuxml
"10" - Cache
"12" - Ucds
"13" - Xscript
"14" - UC4global
"16" - minimal
Trace level
326
Memory range
Additional info
Return codes
"0" - Trace was successful.
"20208" - Trace level is not in the allowed area.
"20209" - The indicated memory range is not supported.
"20210" - The XML handle is wrong.
"20211" - The table does not exist.
Comments
This script function only serves diagnostic purposes and must only be used in close cooperation with
the support team.
To enable trace output, keep the following instructions in mind:
l
The indicated trace option must also be activated in the System Overview (in the properties of the
Server processes).
Additionally, the specified trace level must at least be as high as set in the properties.
The trace output is written to the file specified in the INI file of the Server (see [TRACE] section).
The script function LOG_DUMP works similarly but writes the result to the log file and considers all
values.
Example
In the example below, a trace is activated for several memory ranges. The trace is successful when a
database trace with at least one of four trace levels was activated in the properties of the Server
processes.
:SET &RET# = TRACE_DUMP(2,4, "DB + XAO(XAO_Idnr, XAO_MsgNr), LOCAL_MEMORY,
SCRIPT_VARA", "Various Information")
See also:
Automation Engine
Script element
Description
LOG_DUMP
TRACE
About Scripts
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
327
328
General Information
An AE system consists of various components that are distributed among several computers and
communicate with each other. For example, the Automation Engine sends the JCL to an agent which
processes it on the computer and reports the result back. Encryption is possible for the communication
between the individual components. This prevents potential hackers from reading or modifying transferred
data. In addition, you can use an authentication method in order to avoid a hacker pretending to be a
component.
Data encryption provides security but additional protective mechanisms such as access rights to
sensitive data and physical access protection for the Servers is required in order to ensure the greatest
possible security level.
The connection to the AE database is protected by the database vendor's database client.
Passwords are stored in the database in encrypted form.
Encryption Types
You can define whether communication between the components should be dealt with in encrypted form. If
you opt for encryption, you can determine the encryption strength (AES-128, AES-192 and AES-256 are
available).
Even the greatest possible encryption strength has no negative affects on the AE system's
performance.
Encryption goes hand in hand with authentication. In user sessions, the login data is used for
authentication. The agents confirm their identity differently.
Authentication Methods
The Company Key is very important for the authentication process. Depending on the authentication
method, it is composed of your AE system name or a string you define.
The following three authentication methods are available:
Authentication
method
Description
Automation Engine
329
None
An agent that starts for the first time can immediately log on to the AE
system. The Company Key (a term used in each AE system) is automatically
derived from the AE system's name. It prevents an agent from logging on to
an AE system with a different Company Key afterwards.
Server
The authentication method you select affects the commands shown in the System Overview, category
"Agent".
It is also possible to withdraw an authentication of an Agent. Highlight the relevant agent in the System
Overview of client 0000 and select the corresponding context menu command. The agent can no longer
be used until it has been re-authenticated.
Settings
Encryption
By default, the highest possible encryption strength is activated. Log on to system client 0000 to adjust
this strength or deactivate encryption. The variable UC_AS_SETTINGS includes the key
ENCRYPTIONwhich serves this purpose.
Authentication
You can specify the authentication method while installing the AE system. Subsequent modification is
also possible:
l
l
Compatibility
You can use former agent versions in later versions of AE (such as a 9.0.0 agent can also be used in a
10.0.0 AE system). This requires your AE system to be at the latest hotfix level. The Automation Engine
supports the extended encryption and authentication functions. Use the variable UC_AS_SETTINGS, key
COMPATIBILITY to determine whether former components can participate in the communication.
330
When the compatibility option is deactivated (COMPATIBILITY=NO), the Job Messenger will only
accept encrypted connections. Exempted are only connections from the local IP address and the IP
addresses that are defined as an exception in the Attributes tab of the Agent object. For example,
when you use event monitors on z/OS in LPARs on different computers, you must enter the IP
addresses of these computers in the Attributes tab
The agent retrieves the list of local IP addresses from the local computer name which it obtains from
the OS.
See also:
UC_AS_SETTINGS
Setup installation:
l
l
When loading the file UC_UPD.TXT, the utility AE.DBLoad shows an input mask (similar to the
one in the UserInterface). Use it to select the authentication method.
Agent Installation
Agent installation depends on the selected authentication method.
None:
1.
2.
3.
4.
Install the agent with the UserInterface or use the installation guide.
Start the agent.
An Agent object is automatically created in system client 0000.
Log on to system client 0000 and assign the required client authorizations in the agent object if you
do not use automatic client assignment.
Server:
Automation Engine
331
1. Install the agent with the UserInterface or use the installation guide.
2. Log on to system client 0000 and export the Company Key via the System Overview. Highlight the
node for the client 0000 connection in the tree structure and use the context menu command
"Export company".
You must ensure that both files are stored in a separate protected directory.
Start the Agent.
The agent reads the Company Key file and stores the acquired information in the KeyStore file.
Then it deletes the original file.
An Agent object is automatically created in system client 0000.
Assign the required client authorizations in the Agent object.
Release the agent in the System Overview using the context menu command "Authenticate
Agent".
332
For security reasons, Automic recommends withdrawing the authentication from all agents. The
method "Server" is based upon the principle that the agents will be manually authenticated in the
System Overview in order to ensure that the agent is not a program of a potential hacker. You can
skip this step if you are sure you want to make the changeover without this security measure.
Log on to system client 0000. Open the System Overview and switch to the area agents . Highlight
all agents and use the context menu command "Withdraw authentication".
9. Optional: If you have already deleted the Company Key file and want to write the Company Key to
additional agents (steps 4 to 5), you can do so at any time in the System Overview of client 0000. It
will be exported when you right-click the connection node of client 0. (Step 3 is no longer possible
because the Company Key is added to the database in step 6).
Automation Engine
333
12. If you followed our recommendation and withdrew the authentication from the agents (step 8), all of
them must now be re-authenticated in the System Overview of client 0000. Do so by calling the
corresponding context menu command. Non-authenticated agents cannot log on to the AE system.
For security reasons, Automic recommends withdrawing the authentication from all agents. The
method "Server" is based upon the principle that the agents will be manually authenticated in the
System Overview in order to ensure that the agent is not a program of a potential hacker. You can
skip this step if you are sure you want to make the changeover without this security measure.
Log on to system client 0000. Open the System Overview and switch to the area agents . Highlight
all agents and use the context menu command "Withdraw authentication".
For all agents for which this step is skipped, make sure that you use the Company Key as the
authentication package as of step 8 and skip step 7. You can export the Company Key to the
System Overview of client 0000 at any time by right-clicking client 0's connection node.
7. Now export an authentication package for each individual Agent. Highlight all agents and open the
context menu command "Export authentication package".
8. Transport the files containing the unique authentication packages for each agent individually to the
agents.
9. In the agents' INI-file parameter InitialPackage= (Section [AUTHORIZATION]), enter the path and
name of the authentication package file.
In the parameter KeyStore=, enter the path and name of the file in which the agent should store the
authentication package information.
We highly recommend storing both files in a separate directory which is specially protected.
10. Start all agents.
334
11. The agent reads the authentication package file and stores the included information in the KeyStore
file. The agent will then automatically delete the authentication package file.
AE database access is required for the following step. Ensure the authorized person pays
utmost attention when performing the step. Delete the Company Key from the AE database.
Process the following SQL statement in a transaction:
delete from oha
5. Start all Server processes.
6. Delete the KeyStore file in each Agent. Itspath and name are stored in the INI file, parameter
KeyStore=.
7. Start all agents.
See also:
Specifying the Authentication Method for the First Time
Automation Engine
335
336
An installation and configuration guide for the ECC parts that affect the Automation Engine is available
in the chapter Installation.
Perspectives
Functional areas within the ECC that are responsible for particular tasks are referred to as perspectives.
The perspectives that are available depend on the ECC installation and configuration and the user's rights.
The following table provides an overview of the ECC perspectives and the corresponding Automic
products:
Perspective
Automic product
Functionality
Automation Engine
337
Service Catalog
Automation Engine
Allows users
to start the
objects that
have been
assigned to
them via the
Favorites
folder. Their
general
execution can
be monitored
and the
objects that
have recently
been started
can be listed.
Process Monitoring
Automation Engine
The activities
of all users
can be
monitored and
influenced
(limited
Activity
Window
version).
Process Assembly
Automation Engine
Creating and
defining
Workflows
and folders.
Policy Orchestrator
Policy Orchestrator
Business rules
can be defined
and
administered.
Service Orchestrator
Service Orchestrator
SLA
management,
monitoring and
reporting.
Perspectives are supplied in a file that is referred to as a plug-in and which is available in the particular
Automic product. The Service Catalog, Process Monitoring and Process Assembly perspectives are
both supplied with the Process Automation plug-in.
In the ECC, perspectives can also be displayed with an alternative text. For this purpose, refer to the
ECC Installation Guide (ECC Download Center) which describes the general configuration process.
Login
The ECC uses the authorization system of the AutomationPlatform and/or of the Policy Orchestrator.
This means that users who should use the ECC must be created in the relevant application. The
AutomationPlatform provides specific authorizations/privileges for the ECC that can be used to allow
users to use particular perspectives.
338
Interface
The following illustration shows the Enterprise Control Center's interface. It includes three sections:
l
Navigator:
Panel on the left-hand side of the screen. Can be used to select perspectives and their
functionalities and commands.
Page Header:
Bar at the top of the screen. Displays the current user and can be used to log out. You can also
open the ECC user documentation by clicking the ? button.
Page Content:
Center section. Displays the exact information and commands about the function that has been
selected in the Navigator. You can also open several tabs.
A more detailed description about the interface is available in the ECC's user documentation.
Automation Engine
339
8 Installation
8.1 Supported Platforms
The most recent list of all requirements for the Automation Engine is available on the Automic Download
Center (http://downloads.automic.com)or in our Knowledge Base (https://automationpassion.com).
Introduction
This document lists the requirements for using the individual components of the Automation Platform.
Each section contains information about relevant versions which support databases, operating systems,
business solutions etc. We highly recommend contacting our Support Team if you intend to use versions
which are not included in this document. This is especially important if you update your system only a
short time after the release date.
General Information
The Automation Engine, SNMP Subagent and utilities are only available for 64 bits. All other components
are supplied for 32 bits and some of them for 64 bits. Further information is provided in the documents
describing the requirements for the individual components. No further information means that the particular
component is only available for 32 bits.
The Microsoft Visual C++ 2010 Redistributable Package is required for installing the programs on
Windows. We supply a current version of this package which must be installed on all Windows computers
on which Automation Platform programs run.
Java
Java Software
Some components need a Java JRE/SDK environment.
Operating System
Vendor
Windows
Oracle Java
Linux
z/Linux
Solaris/SPARC
AIX
IBM Java
HP-UX
HP-UX Java
When using 32-bit Java: Always specify the path to the file java.exe in the environment variable.
When using 64-bit Java: No path indication is required. By default, the system searches for the 64bit Java version.
340
Chapter 8 Installation
Network
TCP/IP
All involved computers must be connected via TCP/IP and communicate with each other (check with
PING). TCP/IP addresses must be known and the computers on which Automation Engine processes are
installed must have a fixed TCP/IP address (no dynamic allocation).
Database
Depending on the database in use, either the Oracle Enterprise Edition with Oracle partitioning or the MS
SQL Server Enterprise Edition is required for using ILM.
Database
Version
11.2, 12c
DB2 (Win/Unix)
Automation Engine
For multi-server operation, the computers on which the Server processes are installed must be of the same
platform (e.g. 2 computers with HP/UX). Combining computers with different UNIX derivatives or using a
mixture of UNIX and Windows is not possible.
Operating System Version
Architecture
Windows
Windows
2008 Server, 2008 R2 Server, 2012 Server, 2012 R2 Server x86, x64
Linux
Linux
x64
Linux
x64
Automation Engine
Linux
x64
zLinux
zSeries 64-bit
Solaris
10, 11
Sparc 64
AIX
6.1, 7.1
power
HP-UX
11.31
ia64
341
Unix
Virtual environment
The Automation Engine is supported in a virtual environment.
The Automation Engine can be used on virtual systems without limitations provided that the virtual
system's capacity complies with the recommended minimum requirements. To configure the virtual
system, refer to the corresponding vendor's notes. For VMWare, refer to the following document for more
detailed information: http://www.vmware.com/pdf/vmware_timekeeping.pdf.
Version
VMware ESX Server 3.0, 3.5, 4.0, 4.1, 5.0, 5.1, 5.5
Hyper-V
6.1.7600.16385
SNMP Subagent
For the SNMP subagent, the same requirements apply as for the Automation Engine.
Windows:
l
SNMP service
UNIX:
Use Net-SNMP version 5.x as Master agent if you use the SNMP agent as Subagent.
Net-SNMP is not required if you use the SNMP agent as the master agent.
Requirements
UserInterface
The UserInterface is a Java application program and may run on all platforms for which an Oracle Java
Runtime Environment (Virtual Machine, VM) is available.
Operating System Version
Java Version
342
Chapter 8 Installation
Windows
Linux
l
l
Utilities
Utilities based on Java application platforms may run on all platforms for which an Oracle Java Runtime
Environment (Virtual Machine, VM) is available.
Java Runtime
l
l
Exception: Starting the graphical interface of the DB Reporting Tool requires a 32-bit Java version.
Agents
Platform Agent
The Linux agent is supplied for 32-bit and for 64-bit and was tested against following systems:
l
l
l
Operating
System
Version
Architecture
x86, x64
Linux
x86
Linux
x86, x64
Linux
x86
Linux
x86, x64
Windows
Windows
Linux
Automation Engine
343
Linux
x86, x64
zLinux
zLinux 32-bit
zLinux
zLinux 64-bit
Solaris
10, 11
AIX
6.1, 7.1
HP-UX
11.31
ia64
NSK
G6.18
sSeries
NSK
H06.06
hSeries
NSK
J04.02, J06.15
jSeries
OS400
v5R4 v7R2
iSeries
z/OS
1.8 2.1
zSeries
VMS
7.3.2
VAX
VMS
7.3.2, 8.4
Alpha
VMS
8.3, 8.4
ia64
OSD 4 - OSD 9
BS2000
6.1
GCOS8
5.1
Alpha
Unix
NSK
IBM
VMS
BS2000
BS2000
GCOS8
GCOS8
DEC
DEC
Operating
Sytem
Version Architecture
PeopleSoft
People Tools
Windows
2008
n/a
PeopleSoft
People Tools
AIX
6.1
n/a
PeopleSoft
People Tools
AIX
6.1, 7.1
n/a
PeopleSoft
People Tools
HP-UX
11.31
n/a
PeopleSoft
People Tools
Solaris
10, 11
n/a
PeopleSoft
People Tools
Red Hat
Enterprise Linux
n/a
344
Chapter 8 Installation
SIEBEL
7.5, 8
Windows
2008
x86, x64
SAP
ABAP Stack:
n/a
n/a
n/a
JAVA Stack:
l
l
l
Requirements:
l
l
** If you are running the PeopleSoft agent with 8.53 or higher, the agent and UserInterface require Java 1.7.
Database
Version
MS SQL Server
Oracle
11gR2, 12c
DB 2 Win/Unix
MYSQL
SyBase
15.*
Informix
11.7
SAPHANA
1.00.47
Ingres
10
6, 7
Automation Engine
SAP NetWeaver
Oracle WebLogic
10, 11, 12
IBM WebSphere
7.0, 8.5
JBOSS
6, 7
Installer
Operating System Version
Windows
Java
ServiceManager
The ServiceManager is available for 32-bit and 64-bit.
Operating System Version
Architecture
Windows
Windows
x64
Linux
Linux
SuSE Linux Enterprise Server 10, 11, 11 SP2, 11 SP3, 12 x86, x64
Linux
x86
Linux
x86, x64
Linux
x86, x64
zLinux
zSeries 32-bit
Solaris
10, 11
Sparc 64
AIX
6.1-7.1
power
HP-UX
11.31
ia64
Unix
External Integration
ApplicationInterface
l
Internal Webservice
Architecture
345
346
Chapter 8 Installation
l
l
l
l
Glassfish 2.1, 3
JBoss 6, 7
IBM WebSphere 8
SAP Netweaver 7.1, 7.2, 7.3
ResourceAdapter
l
l
l
l
IBM WebSphere 8
JBoss Version 5
Oracle WebLogic 10, 11, 12
GlassFish 2.1, 3
Windows
2008
HP-UX
11.31
Solaris
2008
11.31
10, 11
Suse Linux
Automation Engine
347
Medium Config
CP
U
Mem
ory
Di
sk
Automat 2 4
Cor
ion
x es
Engine
8 GB
Databas
e
4
Cor
es
Utilities
Agent
Mem
ory
Di
sk
CP
U
51 2 8
2
x Cor
es
GB
32 Gb
1
TB
8 GB
51
2
GB
8
Cor
es
32 Gb
1 1
Cor
x e
n/a
20
Gb
1 1
x Cor
e
n 1
Cor
x e
n/a
20
Gb
Service n 1
Cor
Manager
x e
n/a
Service 1 1
Cor
Manager
x e
Dialog
Mem
ory
CP
U
2 16
Cor
x es
64 GB 1
TB
1
TB
16
Cor
es
64 GB 2
TB
n/a
20
Gb
1 1
Cor
x e
n/a
n 2
x Cor
e
n/a
20
Gb
n 4
Cor
x e
1
Gb
n 1
x Cor
e
n/a
1
Gb
n/a
1
Gb
1 1
x Cor
e
n/a
User
n 1
Cor
Interface
x e
8 GB
20
Gb
n 1
x Cor
e
8 GB
Enterpri
se
Control
Center
8 GB
20
Gb
1 8
x Cor
es
1 4
Cor
x es
CP
U
Big Config
Mem
ory
Di
sk
4 16
Cor
x es
96
GB
1
TB
16
Cor
es
96
GB
2
TB
20
Gb
1 1
Cor
x e
n/a
20
Gb
n/a
20
Gb
n 4
Cor
x es
n/a
20
Gb
n 1
Cor
x e
n/a
1
Gb
n 1
Cor
x e
n/a
1
Gb
1
Gb
1 1
Cor
x e
n/a
1
Gb
1 1
Cor
x e
n/a
1
Gb
20
Gb
n 1
Cor
x e
8 GB
20
Gb
n 1
Cor
x e
8 GB
20
Gb
16 GB 20
Gb
1 8
Cor
x es
16 GB 20
Gb
1 8
Cor
x es
32 GB 20
Gb
Number
of
Users
< 10
< 50
< 200
> 200
Agents
< 20
< 100
< 1 000
> 1 000
Object
definitio
ns
< 1 000
< 50 000
348
Chapter 8 Installation
Total
Executi
ons per
day
Sizing Adjustment
General
Is the expected load distributed over
the day evenly or do you expect high
peaks?
Do you expect many huge job reports to No: be stored in the database (e.g. more
Yes: Add more database storage
then 100.000 lines)?
Do you plan to use ILM?
Fail safe
Is a fail safe system important for you?
No: Yes: Make sure your systems are equipped with redundant
components (power supply, network, etc.) and that you have
an "always-on" database environment.
Automation Engine
349
Example:
A two node system has to be oversized by 100% to be able to
handle the load on the remaining node!
Consider not only cores and memory, but also the amount of
CP's, WP's, DWP's, JWP's, DB-Service agents,...
If fail safe is crucial for you, consider to run on more than two
nodes!
Agents
Do you expect high usage of some
agents?
No: Yes: Add resources to those nodes. Take care that resources
used by your jobs are available.
User
Do you have many users, who are
constantly monitoring activities and
workflows?
No: Yes: Add more resources to dialog work processes and ECC
(run more DWP's and take care that cores and memory are
available for this additional load).
Process Analytics
Process Analytics is the solution that meets your automation management needs. Critical path analysis
helps you to find out which processing steps you need to monitor more closely and helps you to reorganize
and optimize your processing. Graphical Forecasting supports you in planning future workloads and
maintenance windows. Time based Views help you to understand dependencies and to view your
processes from end to end.
For
ProcessAnalytics Admin
ProcessAnalytics
Studio
Operating
System
Windows XP Service
Pack 3
350
Chapter 8 Installation
Database
Java
Oracle 10, 11
Oracle 10, 11
Each of the above areas includes its own set of steps. Individual documents or chapters provide
descriptions of each set of procedures, while also making it easy to maintain a clear overview of each
portion of the process.
Proper use of the Automation Engine requires at least two AE systems to be installed. Read the
guidelines regarding a test and production system before you begin the installation.
Do not use directory names for the Automation Engine and the Agents that include blanks. For further
details, see http://support2.microsoft.com/kb/102739/en
General Information
Important installation notes
Automation Engine
351
User computer
Refers to a computer on which an AE user works.
Host
Is the controlled and monitored computer on which an AE agent is installed.
It is not necessary to have an individual computer for every purpose. Depending on your
environment, the following combinations are possible and useful:
l
l
In the installation instructions, the terms explained above are used to describe the various
computers, whether they refer to one computer serving several purposes or several computers
each serving one particular purpose.
l
Each sub-folder contains a BIN folder in which the program files are stored. Automic recommends
creating a similar structure if you use other operating systems. In UNIX, the BIN folder is created
when the TAR files are unpacked.
l
The installation documents use "AE" as the system name, the description for the database
connection, and the name of the installation directory. This is our recommendation for reasons of
clarity. If other names are used, keep this in mind and adjust them accordingly in each processing
step. See also: Notes for Configuration-File Adjustments
Files that are manually copied from the CD can be write-protected. Change their file attributes to
make them writable.
The programs stored in the directory IMAGE:\Tools\no_supp are diagnosis and test programs, and
should be processed upon request of the Automic Support team.
UserInterface
The UserInterface is helpful during the installation of your AE system because you can use it to set up and
configure basic components. A wizard guides you through the individual steps, installs the corresponding
AE programs and even adjusts the required parameters in the INI files.
The UserInterface is available under Windows and can install a Automation Engine, a UserInterface,
utilities, the ServiceManager, the ServiceManager Dialog program, Automation Engine Documentation
and also files for an SAP or Windows agent on any local computer. you can even load initial data and
licenses to the AE database.
352
Chapter 8 Installation
Whether the interface of the UserInterface is displayed in German or English depends on how the
regional settings are configured in the control panel.
Using the UserInterface is optional. You can also decide to manually install your AE system.
Requirements
l
The UserInterface requires Java Runtime. Make sure that the required version is available on the
computers on which it will be used.
All components that run under Windows require the Microsoft Visual C++ 2010 Redistributable
Package. Install it from the directory IMAGE:CRTS if it is not yet available on your computer. The
UserInterface does not check whether the package is available or not. If it is missing, it does not
install it.
Create a database (DB2, MS SQL Server or Oracle).
Procedure
The document that describes the procedure for a new installation contains a table that lists the individual
work steps. The same procedure applies for using the UserInterface.
1. Do NOT install the UserInterface. It will automatically be installed when you call it for the first time.
Start the AE installationer on the computer on which the components should be installed. The file
name is UC4Setup.exe. It is supplied in the top folder which has the same name as the Automation
Engine version.
Automation Engine
353
2. Specify the root directory for the installation. All components will be installed in this directory. Click
Next.
The UserInterface installs itself in a folder in the root directory.
3. The next step is to specify the name and language of the AE system, the connection data for the
Automation Engine and the database connection. They are automatically inserted in the INI files of
the relevant components that are installed with the UserInterface. The password that is used to
access the AE database is encrypted. Click Next.
4.
5.
6.
7.
8.
9.
The UserInterface stores the parameters. Their values can be modified when the UserInterface
is started at a later time. It then updates all INI files that are found in the root directory.
Select the components that shuld be installed. Because you can call the UserInterface multiple
times, the components that have already been set up in the root directory are displayed in gray.
Click Next.
The selected components begin to install, one after the other. When a component contains other
important INI-file parameters that need to be adjusted to your system environment, the
UserInterface displays the corresponding information. Values can be entered directly; it is not
necessary to adjust the INI file manually.
Start the ServiceManager service in the control panel after the installation.
Some settings must be configured in the AE system before you can use the SAP agent. Further
steps are described in the document New Installation of the SAP Agent (Windows).
Use the UserInterface to install additional required components on other computers.
Manually install any components that cannot be set up with the UserInterface.
Computer
Must UserInterface
Base Components
Setting up the database (DB2)
Setting up the database (MS SQL Server)
Setting up the database (Oracle)
DB/Server/Admin yes
Admin
1)
Admin
yes
Server
2)
(Windows)
Admin/User
1)
(Windows)
Admin/User
yes
(Windows)
(Windows)
354
Chapter 8 Installation
Agents
Installing the agent for BS2000
Host
no
Host
no
Host
no
Host
no
Host
no
Host
no
Host
no
Host
no
Host
no
Host
no
Host
no
Host
no
Host
no
Host
no
Server/Host
no
(Windows)
Additional components
Installing the ServiceManager (UNIX)
Installing the ServiceManager (Windows)
(Windows)
Automation Engine
E-mail connection
Server/Host
no
Host
no
Server/Host
no
Host
no
AE and Cluster
AE system in Windows Cluster
Host
no
355
356
Chapter 8 Installation
Do not limit resource consumption. Transactions that repeatedly abort because of limitations that are
specified in the database can impede processing in your AE system. Inconsistent database contents
can be a result thereof and cause subsequent errors or endless loops.
Note that your database will become inconsistent when you modify database contents.
The following error message might appear if you use DB2 Version 9.6 (or lower), which is no longer
supported:
U0003592 Status: '01605' Native error: '347' Msg: ' SQL0347W The recursive common table
expression "&01" may contain an infinite loop. SQLSTATE=01605'
This message, however, is a warning that you can ignore.
Size required for the initial installation of an AE database
Test systems:
1 GB
Production systems:
Small systems
5 - 20 GB
Medium systems
20 - 50 GB
Large system
more than 50 GB
Procedure
General Requirements:
l
l
l
l
The following scripting example creates a new database with a specific coding:
create db uc4
automatic storage yes
on ...
using codeset <code set> territory <short form of country> ;
The following is a scripting example for the US:
create db uc4 automatic storage yes on ... using codeset iso-8859-1
territory us ;
Automation Engine
357
Special requirements:
SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=DB2CLI;UID=uc4;PWD=-1018A94DA12E7FA991
The following parameters can improve performance for DB2 on UNIX/Windows:
l
l
l
l
l
l
l
l
l
l
l
DLCHKTIME to 1000
This parameter controls the database's deadlock time. The predefined default value is 10
seconds, which negatively impacts the system's performance (1000 corresponds to 1
second).
LOCKLIST to 10240
LOGBUFSZ to 2048
APPLHEAPSZ at least to 2048
APP_CTL_HEAP_SZ to 1024
PCKCACHESZ to 256
CATALOGCACHE_SZ to 128
AUTO_RUNSTATS to OFF. Manually execute the RUNSTATS when the database has
regularly been in use for some time and all tables contain data records. DB2 selects
incorrect access channels if RUNSTATS are processed on empty tables. Deadlock
situations can occur which could eventually result in a complete system standstill. The file
upd_stat.sql. is provided in the folder IMAGE:\db\db2\Automation Engine version. It
contains the relevant statements for the manual RUNSTAT execution.
DB2_EVALUNCOMMITED to ON
DB2_SKIPINSERTED to ON
DB2_SKIPDELETED to ON
These parameters can be called using the command "get dbm cfg" which requires no
authorizations.
l
Definition of tablespaces:
MS SQL Server
This guide includes the individual steps for setting up an MS SQL database for AE usage.
Refer to the reference section of the AE database in order to optimize performance. See:Configuration
& Performance of the Database and the list of supported database versions.
358
Chapter 8 Installation
Do not limit resource consumption. Aborting transactions due to limitations specified in the database
can impede processing in the AE system. Additionally, inconsistent database contents can result,
which can cause subsequent errors or endless loops.
Note that modifying database contents results in an inconsistent database.
Do no activate the option "autoshrink" in the database. This can occasionally cause a Automation
Engine standstill.
Note that it is important to set the SQL cursor (1st digit=S) or to activate MarsConnection in the INI-file
parameter for the ODBC access (SQLDRIVERCONNECT= ) in the particular component (Automation
Engine, utility). Otherwise, the SQL Server database can only process one command at the time which
results in the following errort:
U0003590 DB error: 'SQLExecDirect', 'ERROR ', 'HY000', 'Connection is busy with results for another
command'
You can maintain the AE database by using partitioning with ILM (Information Lifecycle Management).
Automic recommends reading the document about"Maintaining the data records"before you set up the
database.
1 GB
Production systems:
Small systems
5 - 20 GB
Medium systems
20 - 50 GB
Large system
more than 50 GB
Procedure
1.
l
l
l
DB computer
MS SQL Server must be correctly installed and ready to run
Installation settings:
l
Use standard code page "SQL_Latin1_General_CP1_CI_AS" (CP 1252)
l
Use standard Sorting.
l
Terms are case-insensitive (alphabetical order, regardless of case).
l
64-bit client must be installed.
2.
l
l
l
Requirements
DB computer
Start SQL Server if it has not already been started (ServiceManager).
Start the SQL Server Database Management program.
Create a new database for example with the name "AE." The size of the transaction log should be
about 25% of the data-file size (for test systems with truncate log).
Automation Engine
3.
l
l
l
359
DB computer
Create a new user called "AE" in the SQL Server Enterprise Manager (in the "Security" folder).
Select the authentication in the General tab and enter a keyword of your choice. The standard
database is the AE Database.
Automic recommends using SQL Server Authentication.
Ensure that the database password does not include the special characters [] {} () , ; ? * = ! @ \.
Otherwise, the components cannot access the database.
Highlight the AE database in the Database access tab and select public, db_owner, db_ddladmin,
"db_backupoperator, db_datareader and db_datawriter in the database roles.
The Database user must also have permissions to execute Stored Procedures whose names start
with "UC_".
4.
Admin computer
ORACLE
This guide includes the individual steps for setting up an Oracle database for AE usage.
Important: Refer to the relevant documents about optimizing the AE database performance before you
set up the database. See:Configuration & Performance of the Database and the list of supported
database versions.
Do not limit resource consumption. Aborting transactions due to limitations specified in the database
can impede processing in the AE system. Additionally, inconsistent database contents can result,
which can cause subsequent errors or endless loops.
It is important to remember that modifying database content result s in an inconsistent database.
A Automation Engine crash under Oracle is only reliably recognized if the Dead Connection Detection
is activated. This is set with the entry SQLNET.EXPIRE_TIME in the SQLNET.ORA file to a
maximum of 60 seconds.
Visit the Automic website where we provide whitepapers about Oracle usage for download.
One effective way to maintain the AE database is to use partitioning with ILM (Information Lifecycle
Management). Automic recommends reading the document Maintaining the data records before you
start setting up the database.
Size required for the initial installation of an AE database
Test systems:
1 GB
Production systems:
Small systems
5 - 20 GB
Medium systems
20 - 50 GB
Large system
more than 50 GB
360
Chapter 8 Installation
Procedure
1.
l
l
l
l
l
Requirements
DB computer
A 64-bit client must be installed.
Install the appropriate ORACLE client software on the Automation Engine computer in order to
enable access to the database. Note that the ORACLE-client version must correspond to the
ORACLE version in use.
Enter the database name in the file TNSNAMES.ORA.
Change the block size to 8192 bytes when you install the database, and use the character set
WE8ISO8859P15. Other character sets should only be used with prior approval of the Automic
Support team.
Automation Engine
361
The Automation Engine functions using ANSI/ASCII code and supports neither UniCode nor UTF8. If the database needs to operate in UTF-8, the DB client must be configured accordingly, or data
cannot be converted correctly. For Jobs and job reports, AE converts data to ANSI/ASCII
according to the deployed code tables and writes it to the AE Database without changes. AE never
supplies UTF-8 format.
The UserInterface functions using UTF-8, and converts data to ANSI/ASCII according to the
specified code page before it is transported to the Server (see key XML_ENCODING in the variable
UC_SYSTEM_SETTINGS). Only use other character sets in close cooperation with Automic
Support.
The database in UTF-8 only works correctly if the code pages of DB client and UserInterface
correspond to each other. Otherwise, data cannot correctly be converted. In the Connect String, set
the third digit to "1" in order to ignore the check for string data (otherwise the Automation Engine
cannot boot). Logs provide information about the Oracle characters that have been converted to ?
and are not available.
The following requirements are critical:
l
The database must be set with UTF-8 and NLS_LENGTH_SEMANTICS = CHAR.
l
The database client must use WE8ISO8859P15. Define NLS_LENGTH_SEMANTICS =
CHAR.
l
variable UC_SYSTEM_SETTINGS, key XML_ENCODING: Define the same code page as
the one used by the database client.
l
INI-file parameter SQLDRIVERCONNECT= (section [ODBC]: Use the same settings for
the Automation Engine and the utilities.
Oracle client with UTf-8: Note that a code conversion is required for each SQL statement.
RAC
l
The parameter _lm_dd_interval must be set to <= 10 seconds. Value "0" can also be specified for
this parameter in order to recognize deadlocks earlier.
A Database User ID for AE with sufficient authorizations is required.
2.
l
l
Definition of tablespaces
DB computer
Automic recommends facilitating unlimited extensions (MAXEXTENTS) instead of limiting them.
Tablespace sizes can be adjusted individually (minimum 1 GB UC4_DATA, 500 MB UC4_INDEX
for a test environment).
Tablespace administration by ASSM (Automatic Segment Space Management): SEGEMENT_
SPACE_MANAGEMENT=AUTO.
Log on to the ORACLE database using a user ID that has DBA rights, and define the tablespaces:
CREATE TABLESPACE UC4_DATA
DATAFILE 'Path to uc4_data.ora'
SIZE 1024M
AUTOEXTEND ON NEXT ???M MAXSIZE ????M
DEFAULT STORAGE (INITIAL 512K NEXT 2048K MAXEXTENTS UNLIMITED);
CREATE TABLESPACE UC4_INDEX
362
Chapter 8 Installation
DATAFILE 'Path to uc4_index.ora'
SIZE 512M
AUTOEXTEND ON NEXT ??M MAXSIZE ???M
DEFAULT STORAGE (INITIAL 512K NEXT 512K MAXEXTENTS UNLIMITED);
l
Note that changing the name of the tablespaces (UC4_DATA or UC4_INDEX) requires that
these names are also changed in the installation file UC_DDL.SQL. This also applies for every AE
update.
3.
DB computer
Automic recommends creating an additional database user for AE. This user must have therequired
privileges.
4.
DB computer
Initial values should be increased as required for productive environments and large tables. This
applies to the following tables:
INI, MELD, ODOC, OT, AH, AJPP, AJPPA, RH and RT.
Note that the installation file UC_DDL.SQL for the tables shown below must also be adjusted when
the size is changed:
CREATE TABLE MELD (
MELD_Idnr INTEGER NOT NULL,
MELD_USR_Idnr INTEGER NOT NULL,
MELD_Seen SMALLINT NULL,
MELD_TimeStamp DATE NULL,
MELD_MsgNr INTEGER NULL,ucablq.htm
MELD_MsgInsert VARCHAR2 (255) NULL,
MELD_DeleteFlag SMALLINT NULL,
MELD_Client SMALLINT NULL,
MELD_Source INTEGER NULL,
MELD_Category INTEGER NULL,
MELD_Type INTEGER NULL,
MELD_Host VARCHAR2 (200) NULL,
MELD_ArchiveFlag SMALLINT NULL,
CONSTRAINT PK_MELD PRIMARY KEY
(
MELD_Idnr
) USING INDEX TABLESPACE UC4_INDEX
) TABLESPACE UC4_DATA
STORAGE (INITIAL 51200K NEXT 7168K MAXEXTENTS UNLIMITED);
Automic recommends facilitating unlimited extensions (MAXEXTENTS) instead of limiting them.
5.
Automation Engine
l
363
DB computer
Defining a large roll-back segment for the Automation Engine is strongly recommended. The size
should be 10-25% of the Automation Engine data.
Utilities
Installing Utilities (UNIX)
This document guides you through the new installation of the utilities for UNIX.
A three-figure code has been supplied for each supported UNIX platform because the utilities for UNIX are
available for different platforms. The codes are described in the Terminology. This document replaces the
specific codes with the characters "???."
Automic strongly recommends installing the utilities in a separate directory (such as /opt/uc4/utilities).
Requirements
l
Supplied Files
Utility files are supplied in compressed tar-file format (util???.tar.gz), and are found in subdirectories of
IMAGE:UTILITIES\UNIX. The subdirectory names indicate the supported platforms.
*.sh: normal utility start
without file ending: programs for batch call
File name
Description
UCYBDBar.jar
ucybchng
UCYBDBcc.jar
UCYBDBLd.jar
UCYBDBre.jar
UCYBDBRR
UCYBDBUn.jar
UCYBLGMX
ucyrepg.jar
uc.msl
Message library
UC4LAF.jar
*.ini
*.sh
364
Chapter 8 Installation
Runtime libraries
File ending with "a" indicates AIX
File ending with "sl" indicates HP-UX
File ending with "so" indicates Solaris, Linux and zLinux
As of version 8.0, the file names of all utilities have been changed to lowercase letters. For
compatibility reasons, binary links are supplied for UNIX utilities of version 8.0. They link the program
calls from old file names to the new ones. These links are only supplied in version 8.0 and no longer
appear in later versions.
Procedure
1.
This installation step can be ignored if the required version of JRE is already installed.
l
Admin computer
Use the following command to check which version of the Java Virtual Machine (VM) is currently
installed:
java -version
If several JRE or Java SDK versions are installed on your computer, make sure that the specified
directories are in the proper order in the settings of %PATH% and $PATH. The Java Runtime
Environment that is found first in the list of directories is used.
Download the required Java Runtime Environment from http://java.sun.com and install it.
2.
l
l
l
Admin computer
Copy the TAR file util???.tar.gz to a directory (such as UC4/utility) via FTP.
Log on using the user ID UC4.
Switch to the directory used for the utilities:
cd utility
Unpack the tar file:
gzip -d util???.tar.gz or gunzip util???.tar.gz
tar xvfo util???.tar
The files are created in their corresponding directories as the file is unpacked. The tar file can be
deleted after unpacking.
Pay special attention to tar messages, which can result from different owners, and verify that all
files are correctly unpacked.
Check whether all files show the correct owner and group entries. AE must be the owner and the
group must correspond to the identification "UC4. Modifications can only be made by a privileged
Automation Engine
365
DB2DIR=/usr/lpp/db2_06_01;export DB2DIR
DB2INSTANCE=db2inst1;export DB2INSTANCE
UC4=/opt/uc4/utility; export UC4
PATH=.:$DB2DIR/bin[:$PATH]; export PATH
LIBPATH=$UC4/bin:$DB2DIR/lib:usr/lib:/lib[:$LIBPATH]; export LIBPATH
3.
DB2DIR=/opt/IBMdb2/V7.1;export DB2DIR
DB2INSTANCE=db2inst1;export DB2INSTANCE
UC4=/opt/uc4/utility; export UC4
PATH=.:$DB2DIR/bin[:$PATH]; export PATH
LD_LIBRARY_PATH=$UC4/bin:$DB2DIR /lib:/usr/lib:/lib[:$LD_LIBRARY_PATH]; export
LD_LIBRARY_PATH
Adjusting the INI Files to the System Environment
366
Chapter 8 Installation
l
Admin computer
The INI files and the corresponding utilities share the same name. Adjust the INI file entries as
needed.
4.
l
l
AE DB Archive (UCYBDBAR.ini)
AE DB Load (UCYBDBLD.ini)
AE DB Reorg (UCYBDBRE.ini)
AE DB Unload (UCYBDBUN.ini)
Admin computer
The utilities can be called as follows:
o *.sh: Regular utility start
o Without file ending: Program to which start parameters can be assigned for batch calls.
Use the following command to process the start scripts:
For example:
chmod +x UCYBDBar.sh
Note that starting this utility's graphical interface on the platform HP Itanium requires the library
"libstdc++.so.6" to be loaded with the environment variable LD_PRELOAD.
Example of a command loading the library:
export LD_PRELOAD=/uc4/utility/bin/libstdc++.so.6
You can insert this command in the Shell scripts. The library will then automatically be loaded whenever a
utility's GUI is opened.
Shell-script example "ucybdbld.sh" for opening the graphical user inferface of the utility AE DB Load:
export LD_PRELOAD=./libstd++.so.6
java -jar ucybdbld.jar
Supplied Files
The files for the utilities (Windows) are stored in the directory IMAGE:UTILITY\WINDOWS.
*G.EXE - Java loader for utility
*.EXE - Program for batch request
*.BAT - Batch file for utility
Automation Engine
367
File name
Description
UCYBARBR.EXE
AE.Archive Browser
(searches the archive files)
UCYBCHNG.EXE
UCYBDBRR.EXE
UCYBDBCC.JAR
UCYBDBAR.JAR
UCYBDBLD.JAR
UCYBDBRE.JAR
AE DB Reorg (reorganizes
the database)
UCYBDBUN.JAR
UCYBDBRT.EXE
AE DB Reporting Tool
(creates object queries)
AE DB Reporting Tool
(graphical interface for creating
the query files)
UCYBLGMX.EXE
UC.MSL
Message library
UC4LAF.JAR
*.INI
CALLHTMLHELP.DLL,
CBLRTSS.DLL,
UCCACHE.DLL,
UCDBUP.DLL,
UCSBEPM.DLL, UCUCLI.DLL, UCUDB32.DLL, UCUOCI.DLL,
UCUODBC.DLL, UCYBCLICPY.DLL, UCYDBARCHIVE.DLL,
UCYDBREORG.DLL, UCYBDBLD.DLL,
UCYBDBUN.DLL, UCZU01.DLL, ZU00132.DLL, ZUXML1.DLL
COMDLG32.OCX, MSCOMCTL.OCX, RICHTX32.OCX
ActiveX Controls
SETUP.EXE
Installation program
Note that as of Automation Engine version 8.00A, the file names of all utilities have been changed to
lowercase letters.
368
Chapter 8 Installation
Procedure
1.
This installation step can be ignored if the required version of JRE is already installed.
l
Admin computer
You can check the system's current Java Virtual Machine (VM) version by using the command:
java -version
Ensure that the order of the indicated directories is correct in the settings of %PATH% or $PATH if
several JRE or Java SDK Versions have been installed on the computer. The Java Runtime
Environment that is found first in the listing of directories is applied.
Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. It can
be deactivated in the system control because AE does not require it.
2.
This installation step can be ignored if the package is already available in the required version. Refer to
the Control Panel -> Add or Remove Programs to see if the package is installed, and if so, which
version.
l
Admin computer
Admin computer
Admin computer
The INI files and the corresponding utilities share the same name. Adjust the INI file entries as
needed:
l
l
l
l
l
l
l
l
Automation Engine
l
369
Almost all utilities require information about the AE database connection which is specified in the
INI files. Automic recommends creating a new database user for AE. Never create a user that is
called "sa". The appropriate password can be encoded by using the program UCYBCRYP.EXE.
Use the following parameters in order to specify the program via the command line:
UCYBCRYP[.EXE] -p -nPassword
The file Password.ucc is created in the directory of the program that contains the encoded
password.
5.
Admin computer
Utility DLL paths can be changed by making an appropriate entry in the system environment
variables (system control -> system). Enter the variable JAVA_LIBRARY_PATH and the required
path. Libraries are loaded from this directory.
Alternately, you can also use the parameter "-Djava.library.path=Path" in the INI files. Enter it in the
line "cmd=" of the section [GLOBAL].
For example:
cmd="javaw" -Djava.library.path=..\libraries -jar -cp .;.\UC4LAF.jar
UCYBDBAr.jar
6.
l
l
Admin computer
There are three ways to call a utility:
l
*G.EXE: regular utility start (G stands for GUI).
l
*.EXE: program to which start parameters can be assigned for batch calls
l
*.BAT: batch file for the utility
l
To run the Utilities by using an *.EXE file, you must have installed a 32-bit Microsoft Visual CRuntime Library.
See also:
Configuring the Debugger for potential program failures
Admin computer
The files for the AE database are stored in IMAGE:DB. Copy the complete DB folder to the
directory "Utility".
The DB directory must be stored at the location that has been specified using the INI-file
parameter INPUT of the utility AE DB Load. The folder that includes the BIN directory of the utilities
is the default folder.
370
Chapter 8 Installation
Example for Windows:
l
l
Utilities in C:\AUTOMIC\UTILITY\BIN
Database files in C:\AUTOMIC\UTILITY\DB
Utilities - Windows:
The files for the AE database are provided in IMAGE:DB. Copy the complete DB folder to the above
directory.
Utilities - UNIX:
The database files are included in the archive db.tar.gz which is provided in the folder IMAGE:DB.
To unpack the archive, use the following commands:
gzip -d db.tar.gz bzw. gunzip db.tar.gz
tar xvfo db.tar
(Linux: tar -zxvf db.tar.gz)
Copy the unpacked files to the defined directory.
2.
l
l
l
Admin computer
Start the program AE DB Load in order to load the database.
Select the file <DB directory>\DB\GENERAL\<vers>\UC_UPD.TXT
A database scheme is created in the database, and the INITIAL and DEFAULT data are loaded.
3.
Admin computer
As opposed to upgrade installations, new installations of AE DB Load do not display a mask in
which you can select the authentication method. Start the program in batch mode using the
parameters -T (authentication method) and -K (company key) in order to specify the authentication
method.
4.
Admin computer
A mask opens in which you can select the settings for partitioning with ILM. This step is optional.
l
l
Admin computer
Start the program AE DB Load in order to load licenses.
Select the file Customer number.TXT that is provided by Automic Support. The utility enters the
licenses in the AE database.
Automation Engine
371
Potential Problems
l
The code was not correctly converted when the ODBC access was set up. Correct: Ensure that the
code is NOT converted.
Further Files
The directory IMAGE:\DB\database\UC4 version includes several useful SQL script files for your
database that can be used as needed.
Name
Description
DROP_
ALL.SQL
UPD_
For manual statistics updates.
STAT.SQL
Requirements
General:
l
l
l
Root authorization during the installation. Not required for operating the Automation Engine.
After installation, rebooting the UNIX System is NOT necessary.
Own UNIX user ID for the Automation Engine (default: uc4, Home = /opt/uc4, Shell: ksh). The shell
is only necessary during installation.
For Solaris:The most current patch cluster for Sun OS has been installed.
The file syntax.bin must be stored in the same directory as the INI file.
Keep in mind that the size of Core files on AIX must be extended.
372
Chapter 8 Installation
l
l
Supplied Files
Data for the Automation Engine for UNIX is supplied in compressed form. The relevant tar file is found in
one of the appropriate UNIX platform subdirectories: IMAGE:AUTOMATIONENGINE\UNIX\.
UCS???.tar.gz (Automation Engine files).
File name
Description
ucsrvcp
Communication process
ucsrvwp
Work process
uc.msl
Message library
ucsrv.ori.ini
INI file
Runtime libraries
syntax.bin
Description of script
language
Procedure
1.
l
l
l
Automation Engine
l
373
l
l
HP-UX:
l
l
l
l
374
Chapter 8 Installation
l
l
l
l
Repeat the above procedure with ucuoci.so and ucsrvwp. Some missing entries might be
reported that refer to the file ucuoci.so, because it is a library. If these messages refer to the
libraries ucuoci.so, libzu00132.so, or libucudb32.so, they can be disregarded. If an entry
cannot be found in a different library (Oracle, for example), this is an error.
l
l
AE uses $DB2DIR/lib/libdb2.a.
Library check:
dump -H ucsrvcp > wk.txt
Open the created file with a text editor (sed or vi). Verify that all libraries were found.
Repeat the above procedure with ucucli.so and ucsrvwp. Some missing entries might be
reported that refer to the file ucucli.so, because it is a library instead of a main program. If
these messages refer to the libraries ucucli.a, libzu00132.a, or libucudb32.a, they can be
disregarded. If an entry cannot be found in a different library (DB2, for example), this is an
error.
HP-UX:
l
l
l
l
AE uses $DB2DIR/lib/libdb2.sl.
Library check:
ldd -r ucsrvcp > wk.txt
The option -s can be used instead of -r for ldd
Open this file with a text editor (sed or vi). Verify that all libraries were found.
Repeat the above procedure with ucucli.so and ucsrvwp. Some missing entries might be
reported that refer to the file ucucli.so, because it is a library instead of a main program. If
these messages refer to the libraries ucucli.sl, libzu00132.sl, or libucudb32.sl, they can be
Automation Engine
375
disregarded. If an entry cannot be found in a different library (DB2, for example), this is an
error.
Linux, Solaris and zLinux:
AE uses $DB2DIR/lib/libdb2.so.
Library check:
ldd -r ucsrvcp > wk.txt
The option -s can be used instead of -r for ldd
Open the created file with a text editor (sed or vi). Verify that all libraries were found.
Repeat the above procedure with ucucli.so and ucsrvwp. Some missing entries might be
reported that refer to the file ucuoci.so, because it is a library instead of a main program. If
these messages refer to the libraries ucucli.so, libzu00132.so, or libucudb32.so, they can be
disregarded. If an entry cannot be found in a different library (DB2, for example), this is an
error.
l
l
l
l
2.
Server computer
l
l
Server computer
Log on with the AE User ID.
Change to the installation directory of the executable programs:
cd $UC4/bin
Start the communication process in the background:
./ucsrvcp &
Start the work process in the background:
./ucsrvwp &
Verify that the Automation Engine is running:
ps -ef|grep ucsrv or ps -fu uc4
It should now be possible to log on to the active Automation Engine with a UserInterface. The
relevant information about the running Automation Engine is available in the System Overview.
4.
l
l
Server computer
Shutdown:
Find out the Process ID pid:
ps -ef|grep ucsrv
End a server process:
kill -TERM pid
Cancel:
Find out the process ID pid:
End a server process:
kill -KILL pid
376
Chapter 8 Installation
Possible Problems
At program start:
l
If it cannot be found here, it has been deleted. The names of the packages in which the libraries are
available are found at the end of the relevant lines. The best solution in this case is to install the
package again.
Automation Engine drags and/or hangs.
Use
truss -f -p pid 2>&1 | tee -a truss.out
to trace the system calls of a running process. "tee" makes the output available on the screen and
in the file truss.out.
Remove <CR> (^M) from the text files:
vi Text file
%s/<Ctrl-V><Ctrl-M>$//g
:wq!
See also:
Number of Server Processes
Installing the AE SNMP Subagent (UNIX)
Requirements
Requirements for using a DB2 Database
l
The LANG variable of the user who starts the Automation Engine should be identical to the variable
DB2CODEPAGE in order to avoid problems when starting the Server.
Automation Engine
377
Supplied Files
The Automation Engine files are found in the IMAGE:AUTOMATIONENGINE\WINDOWS directory.
File name
Description
UCSRVCP.EXE
Communication
process of the
Automation Engine
for Windows
UCSRVWP.EXE
UC.MSL
Message library
UCSRV.INI
Configuration file of
the Automation
Engine for Windows
AE runtime system
for Windows
Installation program
Procedure
1.
This installation step can be omitted if the required version of the package is already installed. Refer to
the Control Panel -> Add or Remove Programs to see if the package is installed, and if so, which
version.
l
Server computer
l
l
Server computer
If required, install the AE SNMP subagent along with the Automation Engine.
Start the program SETUP.EXE in the corresponding subdirectory of
IMAGE:AUTOMATIONENGINE\WINDOWS.
3.
Server computer
378
Chapter 8 Installation
4.
l
l
l
Server computer
Adjust the INI file UCSRV.INI to the system environment.
Use the database client to create a connection to the database. If you use the MSSQLServer,
create the data source "AE" for ODBCaccess (64 bit ODBC).
5.
Server computer
An AE system requires at least one communication process and one work process. Start them from
the AE program group for testing purposes. The processes are displayed as symbols in the task
bar.
Right-click the Server-process symbol in the task bar and click Close to end one or Shutdown to
end all server processes.
After all other programs have been installed and tested, the Automation Engine should run as a
service. Use the ServiceManager to start the Automation Engine as a service. The server
processes can be started and ended using the ServiceManager Dialog.
For starting the Automation Engine, a 64-bit Microsoft Visual C-Runtime Library is required.
See also:
Number of Server Processes
Configuring the Debugger for potential program failures
Installing the AE SNMP Subagent (Windows)
Procedure
1.
Automation Engine
l
Server computer
Install the Automation Engine on the particular computers as described in the relevant
documentation about new installation.
2.
379
Server computer
Adjust the INI file UCSRV.INI for each computer:
l
Enter the same system name (maximum 8 characters, no special characters) in all INI files.
l
Activate the SNMP connection (if used) with the parameter snmp=.
l
Enter the connection information to the AE database in the section [ODBC].
l
Enter the same port number for the primary work process in all INI files (parameter
pwpport=).
l
Adjust the section [PORTS] in all INI files. The Server processes defined in this section
participate in the AE system's processing. The following rules apply:
l
Port numbers must be unique even if they are distributed among several computers.
l
The same guideline applies to Server process names. Numbers must be used in
ascending order; omitting numbers is not permitted. The following example illustrates
a distributed Server environment with two communication processes and four work
processes (cp1, cp2, wp1, wp2, wp3, wp4).
Leave the original list of Server processes in the INI file. Non-required entries can be commented with a
semi-colon. This can be helpful if you use two INI files; one file can contain even Server process
numbers, the other one the uneven numbers.
Short INI file version of computer A:
[PORTS]
cp1=2217
;cp2=2218
;cp3=2219
;cp4=2220
;cp5=2221
wp1=2271
;wp2=2272
wp3=2273
;wp4=2274
;wp5=2275
;wp6=2276
;wp7=2277
;wp8=2278
;wp9=2279
Short INI file version of computer B:
[PORTS]
;cp1=2217
cp2=2218
;cp3=2219
;cp4=2220
;cp5=2221
;wp1=2271
wp2=2272
;wp3=2273
wp4=2274
380
Chapter 8 Installation
;wp5=2275
;wp6=2276
;wp7=2277
;wp8=2278
;wp9=2279
3.
Server computer
See also:
Number of Server Processes
Requirements
l
Supplied Files
The UserInterface files are found in the directory IMAGE:USERINTERFACE\UNIX. Single files are
combined in the ucdj.tar.gz file.
File name
Description
UCDJ.SH
Start script
for calling the
UserInterface
UCDJ.INI
Call options
for the start
program
Automation Engine
381
UCDJ.BAT
UCDJ.JAR
UserInterface
in Java
UC4CONFIG.XML
Configuration
file for
connecting to
the AE
systems
LOGIN_DAT.XML
Configuration
file for user
login to the
AE system
UC.MSL
Message
library
Files for
calling help
with the F1
key
CONFIGREF.CLASS
Configuration
class
Interface
layout
UC4.WAV
UCXJPS84.JAR
File with
specific Java
classes for
the
PeopleSoft
forms
AE-RA.JAR
RA
Framework
INTELLISENSE.JAR
382
Chapter 8 Installation
Procedure
1.
If the required version of JRE is already available, this step of the installation process can be ignored.
l
Download the required Java Runtime Environment from http://java.sun.com and install it.
2.
l
l
l
l
l
Automation Engine
383
[ENVIRONMENT]
classpath=.;.\psjoa.jar;.\ucdj.jar;.\UCXJPS84.jar
5.
Potential Problems
During installation:
l
384
Chapter 8 Installation
Automation Engine
385
Supplied Files
The UserInterface files are found in the IMAGE:USERINTERFACE\WINDOWS directory.
File name
Description
UCDJ.EXE
Start program
for calling the
UserInterface
UCDJ.INI
Call options
for the start
program
UCDJ.BAT
UCDJ.JAR
UserInterface
in Java
UC4CONFIG.XML
Configuration
file for
connecting to
the AE
systems
LOGIN_DAT.XML
Configuration
file for user
login to the
AE system
UC.MSL
Message
library
Files for
calling help
with the F1
key
CONFIGREF.CLASS
Configuration
class
Interface
layout
386
Chapter 8 Installation
UC4.WAV
SETUP.EXE
Installation
program
UCXJPS84.JAR
File with
specific Java
classes for
the
PeopleSoft
forms
AE-RA.JAR
RA
Framework
INTELLISENSE.JAR
Procedure
1.
If the required version of JRE is already installed, this step can be omitted.
l
Use the following command to check which version of the Java Virtual Machine (VM) is installed.
java -version
If several JRE or Java SDK Versions are installed on the computer, it is important that the
directories indicated in the settings of %PATH% or $PATH are in the proper order. The Java
Runtime Environment that is listed first in the list of directories is used.
Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control. AE does not need it.
2.
Automation Engine
3.
l
l
l
387
To execute the UserInterface, you can either use the file UCDJ.EXE orUCDJ.BAT.
Ensure that there is sufficient memory for the Java application UCDJ.JAR . Otherwise, the
UserInterface might come to a standstill of the UserInterface. Automic recommends increasing the
value of the Java start parameter -Xmx in the file UCDJ.INI (for calls via UCDJ.EXE)or UCDJ.BAT to
1024MB.
To run the UserInterface by using an *.EXE file, you must have installed a 32-bit Microsoft Visual CRuntime Library.
388
Chapter 8 Installation
Potential Problems
During installation:
l
Automation Engine
389
<logging count="10">../temp/UCDJ_LOG_##_%USERNAME%.TXT</logging>
<trace count="10" tcp="3" xml="0">../temp/UCDJ_TRC_
##_%USERNAME%.TXT</trace>
Help formats
WebHelp
390
Chapter 8 Installation
You can run the WebHelp on all platforms with an HTML browser. JavaScript must be enabled in order to
use the complete functional range.
HTML Help
You can only run the HTML help on platforms with a Microsoft HTML Help Viewer (usually Microsoft
Windows).
Please note: A certain update for Windows Server 2003SP1 by Microsoft may make the HTML help
unusable. Please see our knowledge base article on the subject for a solution, where you also find links
to the relevant Microsoft webpages.
PDF
You can open the PDF guides from all platform on which a display program (such as Adobe Reader) is
installed. Note that you cannot open this format through the UserInterface (F1).
Supplied Files
The documentation of the various formats and languages is provided in the directory
IMAGE:DOCUMENTATION.
Directory
Documentation
IMAGE:DOCUMENTATION\GUIDES\WEBHELP
IMAGE:DOCUMENTATION\GUIDES\HTMLHELP
IMAGE:DOCUMENTATION\GUIDES\PDF
IMAGE:DOCUMENTATION\RELEASENOTES
IMAGE:DOCUMENTATION\UC4MSG\WEBHELP
IMAGE:DOCUMENTATION\UC4MSG\HTMLHELP
The Automation Engine Documentation in WebHelp format is also available in compacted form as TAR
files (in the directory IMAGE:DOCUMENTATION\GUIDES\WEBHELP).
Procedure
1.
l
Automation Engine
391
gunzip docu.tar.gz
tar xpvf docu.tar
l
For example:
English HTML Help documentation will be used.
Correct: Create the folder structure
\AUTOMIC\DOCUMENTATION\AUTOMIC\HTMLHELP\ENGLISH and save the CHM files
there.
Incorrect: Copy the CHM files directly to the folder \AUTOMIC\DOCUMENTATION.
You can also store the Automation Engine Documentation at a location that can be accessed by all
users (such as a directory on the server). Note that in this case, the directory of the HTML Help files
(.CHM) must additionally be released via the registry. For further information, refer to the articles
896054 and 896358 on the Microsoft homepage.
In the HTML Help, you can also access the AE Message Documentation. For this purpose, you must
copy the file Messages.chm to the directory DOCUMENTATION\GUIDES\HTMLHELP\ENGLISH (or
GERMAN or FRENCH).
2.
l
Enter the type of the help system that you want to use and the path that should be used in the
configuration file uc4config.xml of the UserInterface. For using the WebHelp, you must also specify
the browser that the UserInterface should use when you click F1.
<docu type="type">path</docu>
<browser type="name">path</browser>
Note that you can keep the default path in the configuration file uc4config.xml when the
DOCUMENTATION folder is a parallel folder of the USERINTERFACE folder.
3.
392
Chapter 8 Installation
l
You can use the F1 key to open the Automation Engine Documentation from anywhere in the
UserInterface. It opens the document that describes the particular window, tab or script element
that is open or in use at that time. To view help on script elements, position the mouse pointer
somewhere within the script element's name (on the Process tab).
You can also open the Automation Engine Documentation manually from the folder to which you
copied it, by double-clicking the start page:
WebHelp: help.htm
HTML Help: help.chm
Requirements
l
l
The User ID $UC4 in BS2000 must be set with approximately 10.000 PAM pages.
The program BS2 TAR has been installed in BS2000. Unpack the TAR file from the supplied
installation CD.
This might not be required when using BS2 TOOLS version 2.00W and later. BS2 TOOLS is used to
receive files in a text archive and to unpack text archives.
Description
x.xxx.UCX2?.LIB
Program Library
Library Elements
UCXBB2?C
CallAPI Utility
Automation Engine
UCXEB2?U
UCXJB2?
Agent
UCXJB2?M
UCYBRFC?
393
x.xxx.UCXJB2?.INI
x.xxx.UCXEB2?U.INI
x.xxx.UCYEBXXZ
x.xxx.E.UCXJB2?
x.xxx.E.UCXEB2?U
x.xxx.UCX.MSL
Message Library
Potential Problems
l
l
l
l
l
TSOS Rights
K, NK
PUBSET Right (Sysout)
BCIN for establishing connection to the UC Server and to file transfer partners
Use of freely-defined port numbers
Procedure
1.
l
l
l
Admin computer
Transfer the TAR file UCXJB2?.TAR or UCXJB2?NK4.TAR via FTP in text mode.
Alternately, the TAR file can be transferred with FTBS2000 or the EDT file transfer (also in text
mode) to BS2000.
2.
Host
The TAR file can be unpacked in two ways:
1. Unpacking with BS2 TAR:
/FILE UCXJB2?.TAR,LINK=TAR or /FILE UCXJB2?NK4.TAR,LINK=TAR
/EXEC BS2-TAR
2. Unpacking with BS2 TOOLS:
Show $UC4. Enter the command TAR into the command field next to the TAR file.
l
l
The actual installation files are created. The TAR file can then be deleted.
Remove the prefix from the installation files.
394
Chapter 8 Installation
l
l
Server computer
Host
Quit the agent using the command /INTR Tsn, END or using the Task Manager of BS2 TOOLS.
Automation Engine
395
Before you start the installation, ensure that the Java agents can only connect to CP port numbers that
are lower than 65536. If they use a higher port number, the agent cannot start and aborts with an error
message. This limitation is caused by Java and affects the agents for JMX, databases, SAP and RA.
Supplied Files
The files that belong to the Database agent are stored in the directory IMAGE:AGENTS\SQL.
File name
Description
UCXJSQLX.JAR
Database agent
UCXJSQLX.INI
UC.MSL
Message library
SETUP.EXE
Additionally, two empty folders (Temp and JDBC) are supplied. The Temp folder stores log files, and the
JDBC driver must be installed in the JDBC folder.
Procedure
1.
If JRE is already available in the required version, this step of the installation process can be ignored.
l
Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control. The Automation Engine does not need it.
2.
Host
Create a separate directory for the agent (such as C:\AUTOMIC\AGENTS\SQL\BIN or
UC4/AGENTS/SQL/BIN).
Copy the content of IMAGE:AGENTS\SQL to the directory you just created. Under Windows, you
can also use the program SETUP.EXE for the installation. It is available in the directory
IMAGE:AGENTS\SQL\WINDOWS.
3.
396
Chapter 8 Installation
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
Host
A suitable JDBC driver must be installed for all databases that the agent will use. Refer to the
particular vendor's installation guide.
Create the folder JDBC in the database agent's BIN folder. Copy the JDBC driver files to this folder
after successful installation.
Microsoft SQL Server
Install the Microsoft JDBC Driver for SQL Server or Microsoft JDBC Driver 4.0 for SQL Server
Copy the file sqljdbc4.jar to the folder's JDBC directory after you have installed the driver.
If several JRE or Java SDK Versions are installed on the computer, make sure that the order of
the directories is correct in the settings of %PATH% or $PATH. The particular Java Runtime
Environment that is found first in the list of directories is used.
When you start the agent under Windows, you can use the corresponding OS user for logging on to
the MS SQL database (Windows authentication). When you install the JDBC driver, you must also
copy the file "sqljdbc_auth.dll" to the database agent's BIN directory. Make sure that this file's
architecture complies with the architecture of the JVM that is used (x64, for example).
Oracle
Install the driver.
Copy the file ojdbc5.jar or ojdbc6.jar to the folder's JDBC directory after you have installed the
driver.
The JDBC driver of version 9.0.1 or earlier cannot be used with this agent due to a program error
in the driver.
The agent searches the relevant jar-file classes in the JDBC folder. The file name is irrelevant. It
is important to use the most current jar file. Automic recommends storing only one jar file in the
JDBC folder.
MySQL
Install the driver.
Copy the file mysql-connector-java-5.0.3-bin.jar to the folder's JDBC directory after you have
installed the driver.
DB2
The JDBC driver is part of the DB2 installation. It is available in the directory SQLLIB/java (under
Windows: C:\Program Files\IBM\SQLLIB\java).
Copy the following two files to the agent's JDBC directory:
l
db2jcc.jar (JDBC Type 4 Driver)
l
db2jcc_license_cu.jar (Server license)
The JDBC driver can be downloaded from IBM's homepage.
Click on the entry "DB2 Personal Developers Edition: Re-distributable JDBC Type 4 Driver."
Sybase
Install the driver (jConnect 5.5/6.05).
Copy the file jconn2.jar or jconn3.jar to the folder's JDBC directory after you have installed the
driver.
Informix
Install the driver (V3.5).
When the driver is installed, copy the files ifxjdbc.jar and ifxlang.jar to the agent's jdbc directory.
Note that the agent requires Informix databases with transaction support.
Due to an Informix error, it is necessary to specify the value for the environment variable DB_
LOCALE in particular versions. The error "Database locale information mismatch" occurs if DB_
Automation Engine
397
l
l
Ingres
Install the jdbc driver.
When the driver is installed, copy the file iijdbc.jar to the agent's JDBC directory.
SAP HANA
Copy the file ngdbc.jar from the HANA client's installation directory to the agent's jdbc directory.
4.
l
l
Oracle RAC
The agent can also be configured so that it can connect to an Oracle database in RAC.
5.
l
l
Host
Adjust the INI file UCXJSQLX.INI to the system environment.
If the agent starts under Windows and accesses an MS SQL database, you can use the relevant
Windows user in order to log on to the database. The following measures are required:
l
Install the JDBC driver as described above.
l
Agent's INI file: WindowsAuthentication=1
l
UC_HOSTCHAR_DEFAULT:ANONYMOUS_JOB = Y
l
In Database Jobs, you must still specify a Login object that includes a suitable entry for
the particular agent even if you use the Windows authentication. The Login object's user and
password are neither used nor checked.
Server computer
Host
398
Chapter 8 Installation
The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation..
l
Supplied Files
The files that belong to the Database Agent are stored in the directory IMAGE:AGENTS\SQL.
File name
Description
Automation Engine
UCXJSQLX.JAR
Database Agent
UCXJSQLX.INI
UC.MSL
Message library
SETUP.EXE
399
Additionally, two empty folders (Temp and JDBC) are supplied. The Temp folder stores log files, and the
JDBC driver must be installed in the JDBC folder.
Procedure
1.
If JRE is already available in the required version, this step of the installation process can be ignored.
l
Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control. AE does not need it.
2.
Host
Create a separate directory for the agent (for example, C:\AUTOMIC\AGENTS\SQL\BIN or
UC4/AGENTS/SQL/BIN).
Copy the content of IMAGE:AGENTS\SQL to the directory you just created. Under Windows, you
can also use the program SETUP.EXE for the installation. It is available in the directory
IMAGE:AGENTS\SQL\WINDOWS.
3.
l
l
l
Host
A suitable JDBC driver must be installed for all databases that the agent will use. Refer to the
particular vendor's installation guide.
Create the folder JDBC in the Database Agent's BIN folder. Copy the JDBC driver files to this
folder after successful installation.
Microsoft SQL Server
Install the Microsoft JDBC Driver for SQL Server or Microsoft JDBC Driver 4.0 for SQL Server
The driver supports MS SQL Server 2005 and 2008 (2008 R2).
400
Chapter 8 Installation
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
Copy the file sqljdbc4.jar to the folder's JDBC directory after you have installed the driver.
If several JRE or Java SDK Versions are installed on the computer, make sure that the order of
the directories is correct in the settings of %PATH% or $PATH. The particular Java Runtime
Environment that is found first in the list of directories is used.
When you start the agent under Windows, you can use the corresponding OS user for logging on to
the MS SQL database (Windows authentication). When you install the JDBC driver, you must also
copy the file "sqljdbc_auth.dll to the database agent's BIN directory. Make sure that this file's
architecture complies with the architecture of the JVM that is used (x64, for example).
Usually one DB Service Agent per system will be sufficient. Please take care to use the same
JDBC driver for any additional instances of the agent, should you want to use more than one!
Oracle
Install the driver.
Copy the file ojdbc5.jar or ojdbc6.jar to the folder's JDBC directory after you have installed the
driver.
The JDBC driver of version 9.0.1 or earlier cannot be used with this agent due to a program error
in the driver.
The agent searches the relevant jar-file classes in the JDBC folder. The file name is irrelevant. It
is important to use the most current jar file. Automic recommends storing only one jar file in the
JDBC folder.
MySQL
Install the driver.
Copy the file mysql-connector-java-5.0.3-bin.jar to the folder's JDBC directory after you have
installed the driver.
DB2
The JDBC driver is part of the DB2 installation. It is available in the directory SQLLIB/java (under
Windows: C:\Program Files\IBM\SQLLIB\java).
Copy the following two files to the Agent's JDBC directory:
l
db2jcc.jar (JDBC Type 4 Driver)
l
db2jcc_license_cu.jar (Server license)
The JDBC driver can be downloaded from IBM's homepage.
Click on the entry "DB2 Personal Developers Edition: Re-distributable JDBC Type 4 Driver."
Sybase
Install the driver (jConnect 5.5/6.05).
Copy the file jconn2.jar or jconn3.jar to the folder's JDBC directory after you have installed the
driver.
Informix
Install the driver (V3.5).
When the driver is installed, copy the files ifxjdbc.jar and ifxlang.jar to the Agent's jdbc directory.
Note that the agent requires Informix databases with transaction support.
Due to an Informix error, it is necessary to specify the value for the environment variable DB_
LOCALE in particular versions. The error "Database locale information mismatch" occurs if DB_
LOCALE has not been correctly set.
In this case, set the corresponding value in the Agent's INI file, section [INFORMIX], using the
parameter db_locale= (use lower case).
For example: [INFORMIX] db_locale=EN_US.CP1252
Automation Engine
l
l
l
l
l
Ingres
Install the jdbc driver.
When the driver is installed, copy the file iijdbc.jar to the Agent's JDBC directory.
SAP HANA
Copy the file ngdbc.jar from the HANA client's installation directory to the agent's jdbc directory.
4.
l
l
Oracle RAC
The agent can also be configured so that it can connect to an Oracle database in RAC.
5.
Server computer
Database Agents for Variables use the INI file of the Automation Engine. Adjust the section [DB_
SERVICE] which contains the specific parameters for the Database Agent. The Agent's INI file is
not required.
Now create a DB-type Connection object in the AE system for each database in use. You can also
create connections for different database types.
If the agent starts under Windows, you can use the Windows user in order to log on to the MS SQL
database. The corresponding DB-type Connection object requires the additional parameter
"IntegratedSecurity" to be specified (value "true").
6.
Server computer
Host
401
In order to start the agent in the mode for Database Variables, specify the parameter -service and
the path and name of the Automation Engine's INI file.
For example:
java -jar -Xrs -Xmx256M ucxjsqlx.jar -service -iC:\uc4\server\bin\ucsrv.ini
An Agent object is automatically created in system client 0000 and stored in the folder HOST.
Note that the storage limit should be set to at least 256MB (or 512MB) for starting Java agents
(Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java applications
by using the start parameter -XmX.
Specifying a value that is too low can cause the agent to crash. The default value depends on the
Java version that is used.
The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation.
402
Chapter 8 Installation
viewed in client 0000. The newly installed agent can now be assigned to clients with the
required rights via the Agent object.
Requirements
RSM8 is required if the Job's output will be transferred to AE.
Supplied Files
The files of the GCOS8 agent are available in binary and ASCII format. They are stored in the directory
IMAGE:AGENTS\GCOS8.
File name
File
type
Description
UCXJGC8
binary
GCOS8 agent
UCXJGC8M
binary
UCMSL
UCXJGC8I
UC4EX, UC4TM,
CANCEL.SPN, UC4, UC4EXEC.DIR, UC4EXEC.SPN,
UC4TERM.DIR, UC4TERM.SPN, UC4SIM
Procedure
1.
l
l
l
Host
Create a catalog for the installation (UC4/version).
The following sub-catalogs are required in it: DATA, EXEC, INSTALL, JCL, OUT and TMP.
2.
Automation Engine
l
403
Admin computer
Transfer the files with FTP or Glink FTP to the corresponding sub-catalogs of the GCOS8
computer.
Subcatalog
File
DATA
UCMSL, UCXJGC8I
EXEC
UCXJGC8, UCXJGC8M
INSTALL
READ_ME
JCL
Host
Host
Host
RSM8 must be installed in order to enable job report transfers to AE. If it has not been installed, the
following settings must be configured or Jobs will remain stuck.
l
l
Set the parameter RSM= in the INI file to either "N" or "X."
The section [VARIABLES] of the INI file must contain the parameter UC_EX_PATH_JCL.
Enter the JCL catalog name in that parameter.
Adjust the file UC4SIM in the JCL catalog so that it contains the catalog in which the agent
has been installed.
Note that files with the same name as the job report are created when RSM8 is not used. These
files contain basic information, such as the job name or sequence number, which can be used to
view the report in GCOS.
Important: Do not set the parameter RSM= when RSM8 is used.
5.
404
Chapter 8 Installation
l
Host
Start the agent with the JCL from the file UC4EX.
$ident
$select
$select
$endjob
<site-ident>
&system/profile.prod/uc4
&uc4cat/jcl/uc4exec.spn
An Agent object will automatically be created in the system client 0000 and stored in the folder
HOST.
Admin computer or Server computer
Verify that the agent has logged on.
l
Start the UserInterface for client 0000. Call the agent information from the System
Overview. Because a newly logged-on agent has not yet been assigned a client, it can only
be viewed in the system client 0000. The newly installed agent can now be assigned to
clients through the Agent object with all the required rights.
6.
Host
Use the JCL from the file UC4TM to close the agent.
$ident
$select
$select
$endjob
<site-ident>
&system/profile.prod/uc4
&uc4cat/jcl/uc4term.spn
Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
Automation Engine
File name
Description
ucxjjmx.jar
ucxjjmx.ini
Configuration file
uc.msl
Message library
setup.exe
Installation program
405
Procedure
1.
This installation step can be omitted if the required version of Java Standard Edition is already
available.
l
Download the required Java Runtime Environment from http://java.sun.com and install it.
2.
Host
Create a separate folder for the JMX agent and copy the supplied files and the subfolder "Logs" to it.
Instead, you can also use the program SETUP.EXE for the installation. It is available in the
supplied directory (Agent).
Several settings are available for adjusting the JMX agent to your system environment. Of note are
the agent and computer name, and the port of the communication process to which the agent
should connect. Configure these settings using the agent's INI file.
3.
Use the following command to start the agent from the command line (UNIX and Windows):
java -jar -Xrs -Xmx256M ucxjjmx.jar
406
Chapter 8 Installation
l
l
Host
Select the option "Local Java VM" in the Job object's JMX tab.
Activate the sub-items "Use existing MBean Server" and "Create new instance..."
Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.jar
ucxjjmx.ini
Configuration file
Procedure
1.
This installation step can be omitted if the required version of JRE is already available.
Automation Engine
l
Use the command shown below to check the system's version of Java Virtual Machine (VM).
407
java -version
Note that if several versions of JRE or Java SDK are installed on the computer, the order of the
indicated directories is relevant when specifying %PATH% or $PATH. The Java Runtime
environment that is listed first is used.
No Java installation is required if the agent runs on the same computer as the WebLogic
Server (recommended).
2.
l
l
l
Host
Create a folder for the JMX agent (bin)and copy the supplied files.
Various settings of the JMX agent can be adjusted to your system environment. Of particular
importance are the agent and computer names and the port of the communication process to which
the agent should connect. Configure these settings using the agent's INI file.
Copy the files wclient.jar and wljmxclient.jar from the WebLogic Server directory to the agent's
installation folder. It must be available in the same folder as the file ucxjjmx.jar.
Start the agent with the file ucxjjmx.exe (Windows) or via the command line (UNIX and Windows)
using the following command:
java -jar ucxjjmx.jar
l
l
l
Host
Select "Remote Java VM" in the Job object's JMX tab.
Enter the term "weblogic" in the field Initial Context Factory .
Specify the WebLogic Server for the server URL in the format shown below:
Name of the WebLogic Server:port of the WebLogic Server
You can also run the agent without a connection to the Oracle WebLogic Server. In this case, select
the option Local Java VM and Use existing MBean Servers in the Job objects.
The WebLogic Server's default port is 7001.
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with RMI Connector
The following guide describes how to install an agent in an AE system in which authentication is not used.
Additional installation steps are required before the agent can be started and used if you intend to use one
of the available authentication methods. More detailed information is provided in the document Advanced
Security.
Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
408
Chapter 8 Installation
File name
Description
ucxjjmx.war
Procedure
1.
l
l
l
Host
Select the menu item Applications -> Install New Application on the WebSphere interface.
Specify the path to ucxjjmx.war in "Local File System." "Context root" can be used to name the
application.
The next window can be used to activate the option Generate Default Bindings." If required, other
settings can also be specified.
Follow the installation procedure as described. In step 4, select the option Everyone? next to
"administrators."
Automation Engine
When all six steps are complete, complete the installation procedure by clicking FINISH. Refer to
the log to verify that the installation was successful. Click "Save to Master Configuration", and then
Click Save.
Click Applications -> Enterprise Applications. The list now also includes the agent. Activate it by
clicking the button of the same name.
The agent can be started via the configuration web interface.
2.
409
Host
The JMX agent has a configuration web interface that can be called with a Web browser using the
following address:
http://Server name:port/context root
Adjust the settings of the JMX agent to your system environment. The most important settings are:
l
Name for the agent
l
Name of the computer on which a communication process is available
l
Port number of a communication process
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
3.
410
Chapter 8 Installation
l
l
l
l
Host
"Remote Java VM" must be selected in the Job object's JMX tab.
Enter the term "websphere" in the field Initial Context Factory .
Specify the Server URL in the following format:
Host name of the WebSphere:port of BOOTSTRAP_ADDRESS
Retrieve the port number as follows: Log on to the administrator console. Click "Servers" ->
"Applications servers", and then click the name of your server. Select "Communications" ->
"Ports." The table contains the entry BOOTSTRAP_ADDRESS. Use the port number shown in the
URL.
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with SOAP Connector
This installation guide applies to WebSphere version 6.0 with activated administrative security.
The following guide describes how to install an agent in an AE system in which authentication is not
used. Additional installation steps are required before the agent can be started and used if you intend to
use one of the available authentication methods. More detailed information is provided in the document
Advanced Security.
1.
l
l
l
Host
Select the menu item Applications-> Install new application on the WebSphere interface.
Enter the path to the file ucxjjmx.war in "Local file system." The "Context root" can be used to name
the application.
Automation Engine
411
In the next window you can activate the option Generate standard connections or configure other
settings.
Follow the installation procedure until the individual steps are displayed. Step 4 requires the
selection of "Everyone?" in "administrators."
412
Chapter 8 Installation
l
l
When all six steps are completed, click Finish to complete the installation process. The log shows
whether the installation was successful.
Click Store in master configuration, and then click Store.
Call the menu item Applications -> Enterprise applications. The list also includes the agent.
2.
Automation Engine
l
l
l
413
Host
Search for the file ucxjjmx.ini in the WebSphere folder.
Open the INI file and append the new section [WEBSPHERE] with the following parameters:
[WEBSPHERE]
javax.net.ssl.trustStore=C:\DummyClientTrustFile.jks
javax.net.ssl.keyStore=C:\DummyClientKeyFile.jks
l
l
Adjust the values for the javax.* properties according to your environment.
Store and close the INI file.
This installation step is optional as of Websphere version 7 optional. Note when you skip this step that
you must enter the value "webshere soap" in the Initial Context Factory field in the JMX tab of the Job
object.
3.
Host
4.
l
Host
The JMX agent has a Web configuration interface that can be called with a Web browser via the
following address:
http://Server name:Port/context root
Adjust the settings of the JMX agents to your system environment. The following are particularly
important:
414
Chapter 8 Installation
Agent name
Name of the computer on which a communication process is available
Port number of a communication process
l
l
l
l
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
Host
The agent now uses the SOAP Connector. Therefore, select "Remote Java VM" in the Job object's
JMX tab.
Enter the term "websphere" in the field Initial Context Factory:
Host name of the WebSphere:SOAP Port
Retrieve the port number as follows: Click Servers -> Application server, and then click the
name of your Server. Select transmittals -> Ports. Use the port number shown here in the URL.
The default value of the SOAP port is 8880.
Enter three passwords separated by commas in the Job's Login object.
l
The 1st password is the user password.
l
The 2nd password is the keystore password.
l
The 3rd password is the truststore password.
Supplied files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.war
Procedure
1.
Automation Engine
l
l
l
415
Host
Copy the file ucxjjmx.war to a folder and use an appropriate program to unpack it.
Then, in the configuration file web.xml, adjust the following two parameters:
<load-on-startup> - Ensure that the value is always set to 1. Otherwise, the agent is not loaded
and cannot be started.
<run-as><role-name> - Adjust this parameter if you intend to use roles. The role must then be
defined (or deleted) in the security section (<security-role>).
Rename the folder in which the agent files are stored. The name must end with the string ".war".
A sample folder name: ucxjjmx.war
Move the folder to the JBoss Deploy directory. The agent is automatically deployed and the
following message is displayed:
445 INFO [TomcatDeployer] deploy, ctxPath=/ucxjjmx,
warUrl=file:/C:/jboss-3.2.7/server/default/deploy/ucxjjmx.war/
2.
l
Host
The JMX agent has a configuration web interface that can be called with a Web browser using the
following address:
http://Server name:Port/ucxjjmx/uc4jmx
The sample address uses the string ucxjjmxbecause that is the string used in the sample folder name,
before the file extension (".war"):ucxjjmx. If you chose a different name, use that name instead.
l
Adjust the settings of the JMX agent to suit your system environment. The most important settings
are:
l
Name of the agent
l
Name of the computer on which a communication process is available
l
Port number of a communication process
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
3.
l
l
l
Host
Select the option "Local Java VM" in the Job object's JMX tab.
Activate the sub-menu "Use existing MB Server".
It is not necessary to select the option "Generate new instance..."
416
Chapter 8 Installation
Supplied Files
The J2EE/JMX agent files are available in the folder IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.war
Procedure
1.
Host
Click Browse and select the file ucxjjmx.war. Then click Next.
Type "uc4" in the text field Application Name, and then click Next.
Host
The JMX agent has a Web configuration interface; it can be called in a Web browser using the
following address:
http://Server name:Port/ucxjjmx/uc4jmx
The above address uses the string "ucxjjmx" because that is the string that was used before ".war" in
the folder name. Adjust this address if you used a different name.
l
Adjust the JMX agent settings to your system environment. The most important settings are:
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
Automation Engine
417
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
3.
Host
In the Job object's JMX tab, select the option Remote Java VM.
Supplied files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.sca
J2EE/JMX agent
Procedure
1.
l
l
l
Host
Copy the file ucxjjmx.sca to the input directory of the Java Support Package Manager (for example
C:\usr\sap\trans\EPS\in).
Start the Java Support Package Manager (JSPM) and log on to the JEE Engine.
JMX agent new installation: In step 1 of Start Deployment, select "New Software Components"
under Select Package Type. Click Next.
418
Chapter 8 Installation
The JMX agent is provided in the input folder and displayed as a new software component under
Specify Queue. Select the agent and click Next.
Automation Engine
419
In the next step, ensure that the JMX agent is in the queue. If it is, click Start to initiate the setup
procedure.
420
Chapter 8 Installation
l
2.
l
Host
Use the program Undeploy View in the SAP Netweaver Developer Studio to remove the JMX
agent.
Select the software component JMX_Agent (automic.com) from the list and click Add to
Undeploy List in the menu that pops up.
Automation Engine
l
Host
A Web configuration interface is available for the JMX agent. It can be called from:
421
This interface can be used to adjust the JMX agent to your system environment. The following are
particularly important:
l
Agent name
l
Name of the computer on which a communication process is available
l
Port number of a communication process
4.
Host
Select JNDI in the JMX tab of the Job object. Enter "jmx" as the object name.
Supplied files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.war
Procedure
1.
l
l
l
Host
Start Tomcat and call the Tomcat Web Application Manager.
Select the file ucxjjmx.war in the section "Install - load local WAR file for installation." The
installation can then be started using the button of the same name.
Note that the role "administrators" must exist. Adjust the file tomcat-users.xml if it does not yet
exist. Enter the role and add it to a user.
Example:
<role rolename="administrators"/>
<user username="admin" password=""
roles="admin,manager,administrators"/>
422
Chapter 8 Installation
l
The JMX agent is displayed in the section "applications" of the Web Application Manager.
2.
Host
A web configuration interface is available for the JMX agent. To call it, click on the available link for
the JMX agent entry in the section "Applications".
Use this interface to adjust the JMX agent to your system environment. It is particularly important
to configure the following:
l
The agent name
l
The name of the computer on which a communication process is available
l
The port number of a communication process
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
Automation Engine
Field/Control element
Description
Status
Start time
Current time
Host
Name
System
CP host
CP port
Language
423
424
Chapter 8 Installation
Log count
A new file is created if the log file reaches the size specified here.
Auto-run
TCP/IP Trace
Encrypted communication
Application Server
The log files can be accessed via a link of the same name.
Requirements
l
l
l
l
l
Supplied Files
The files are packed in an archive file and stored in the subdirectory IMAGE:AGENTS\NSK.
File name
File type
Description
UC4DDL
Text
DDL description for usage in EMS filters to filter Automic related events.
UC4MACS
Text
UC4TMPL
Text
UCMSL
Binary
UCXBNI6C
Binary,
Example program showing usage of call API.
executable
Automation Engine
UCXBNI6O
Binary,
library
425
UCXFTSRV Binary,
Automic server program used for file transfer, will be automatically stopped
executable and started by the agent when using file transfers.
UCXJNI6
Binary,
Automic agent
executable
UCXJNI6M
Binary,
Automic program used to shutdown the agent.
executable
UCXJNI6O
Binary,
Output collector used by the agent.
executable
UCXJNI6R
Binary,
Used for internal purposes only, will simply output command line arguments
executable in certain format.
UCXJNI6T
Binary,
Virtual terminal program, started to be used as a dummy input/output device
executable
UCXSCAN
Binary,
Scan program internally used by the agent if file system scans for file
executable patterns are requested.
UCYBWAIT Binary,
Used for internal purposes only, will simply create a given delay.
executable
CallAPI files and their implementation are described in a separate document.
Procedure
1.
l
l
l
Admin computer
Establish a connection to the host via an FTP client and transfer the two supplied files OINSTALL
and UC4AR to a common sub-volume.
The file OINSTALL must be transferred in text mode (code 101) and UC4AR in binary mode
(code 0).
Automic strongly recommends storing these files in an empty sub-volume.
The file UC4AR is a self-extracting archive that contains all the files that the NSK agent
requires.
2.
l
l
l
Host
Start a terminal emulation program and log on using the user who should be the program owner.
Change to the sub-volume to which the two files have been transferred.
Set the following command in the TACL input line:
O OINSTALL
This unpacks the file INSTINI in the sub-volume. It must remain in the same sub-volume as the
other installation files in order to ensure that the installation can continue.
426
Chapter 8 Installation
3.
Host
The file INSTINI contains several parameters that must be adjusted to your system environment.
l
l
l
Parameter
Description
AE-PROGRAM-SUBVOLUME=
AE-STATUS-STORE-SUBVOLUME=
AE-STATUS-STORE-AUDITED=
AE-TCPIP-PROCESS=
AE-SERVER-PORT
AE-AGENT-PORT=
Automation Engine
427
AE-SERVER-IP-ADDRESS=
AE-AGENT-PROCESS=
AE-OC-PROCESS=
AE-TSIM-PROCESS=
AE-SYSTEM-NAME=
AE-AGENT-NAME=
AE-TEMP-SUBVOLUME=
The agent's INI file is completed using the data that is specified here. After a successful
installation, you can change these values at any time.
4.
Host
You receive notifications about the installation progress and can terminate it at any time. In this
case, a manual cleanup process can be required.
A connection to the Automation Engine is established when the installation is complete.
Host
Change to the agent's subvolume and set the following command in the TACL input line:
O EXSTART
428
Chapter 8 Installation
l
See also:
EMS template file
Requirements
l
TCP/IP
Supplied Files
The OS/400 agent is supplied as a binary SavFile. This file is found in the subdirectory
IMAGE:AGENTS\AS400.
File name AE CD
Description
UCXJO41.BIN
OS/400 agent
(binary SavFile)
Content:
IRSTRJOB
Auxiliary program
for generating
Jobs
UCXBO41C
CallAPI
UCXJO41
Agent
UCXJO41M
Messenger
program for the
OS/400 agent
CLLE
INI
INI file
Automation Engine
429
MSL
Message library
TMP
STRUCAGENT
Program that
starts the agent
ENDUCAGENT
MAKEMSL
Program that
generates the
message library
Service programs
(libraries) for the
agent, the CallAPI
and the
MAKEMSL
program
The CallAPI files and CallAPI implementation are described in a separate document.
Procedure
1.
l
Host
Create a temporary library for Save File:
CRTLIB LIB(UC4TMP)
Create an empty Save File.
CRTSAVF FILE(UC4TMP/UC4)
Create a library for restoring the Save File.
CRTLIB LIB(UC4AUSL) TYPE(*PROD) TEXT('UC4')
Admin computer
Log on to the AS/400 via FTP and transfer UCXJO41.bin to the Save File UC4, library UC4TMP.
Example for FTP via the Windows command prompt:
ftp <MY.AS400>
<USER>
<PASSWORD>
cd UC4TMP
bin
put UCXJO41.bin UC4
quit
2.
Host
Create the library.
RSTOBJ OBJ(*ALL) SAVLIB(UC4AUSL) DEV(*SAVF) SAVF(UC4TMP/UC4)
430
Chapter 8 Installation
l
Server computer
Host
There are two different methods that can be used to start the agent. Variant 1 requires a CL routine per
agent that should start (more complex). Variant 2 starts or ends the agent via separate programs.
Method 1
4.
l
Host
The CL example programs that start and end the agent are provided in the supplied file member
CLLE. They must be adjusted to the installation and the OS before you can compile them.
UC4/CLLE(UCEX_RUN) - starts the agent
UC4/CLLE(UCEX_END) -ends the agent
5.
Host
Method 2
4.
Automation Engine
l
431
Host
The library (UC4) that includes the programs (such as the agent or CallAPI) must be included in the
library list. You can use the following commands for this purpose:
ADDLIBLE UC4
adds the library to the library list
or:
CHGCURLIB UC4
changes the current library for the particular job to UC4
5.
Host
Start the agent by using the command STRUCAGENT.
The following examples explain the agent's starting procedure:
STRUCAGENT LIB(UC4) FILE(UC4/INI) MBR(UCXJO41)
Starts the agent from the library by using the INIfile UC4/INI(UCXJO41).
STRUCAGENT LIB(UC4) PATH('/user/uc4/ucxjo41.ini')
Starts the agent from the library by using an INIfile that is stored in the IFS file system.
432
Chapter 8 Installation
Requirements
l
Supplied Files
The agent files are supplied in compressed form (UCXJPSX.tar.gz) and are found in the
IMAGE:AGENTS\PEOPLESOFT\UNIX subdirectories. The names of the subdirectories indicate the
supported UNIX platforms in accordance with the Terminology:
File Name
Description
UCXJPSX
UCXJPSX.INI
UCX.msl
Message library
psexj.bin
Syntax file
UCXJPS82.jar
UCXJPS84.jar
Java Classes
Technical Implementation
Component Interfaces (Java classes) can be used to connect the agent to PeopleSoft/PeopleTools.
Automation Engine
Job processing is accessed via Java Classes of the UC4_* component interfaces.
Job processing is accessed via Java Classes of the PROCESSREQUEST component interface.
Startup
If a UNIX agent is already installed on the system, its user ID can be used for startup.
433
434
Chapter 8 Installation
Optional
l
l
l
Host
This step is only required if the PeopleSoft system runs in a language other than English. If so, it
ensures that PeopleSoft assumes the value for the parameter OUTDESTTPYE of the AE Script
element PS_RUN_PROCESS. Otherwise, the system uses the default parameter value which is
stored in PeopleSoft.
Start the PeopleSoft Application Designer.
Select File --> Open.
Open the field (Definition: Field) "OUTDESTTYPE" (Name).
Automation Engine
l
Open the "Definition Properties"either via "File" -> "Definition Properties" or use the shortcut ALT
+ ENTER.
In the Translate Values tab, change the table as follows:
Value
Eff Dt
Long Name
Short Name
01.01.1899
Any
Any
01.01.1899
(None)
NONE
01.01.1899
File
FILE
01.01.1899
Printer
PRINTER
01.01.1899
Window
WINDOW
01.01.1899
01.01.1899
Web
WEB
01.01.1899
Default
DEFAULT
l
l
Active
l
l
Host
Transfer the TAR file UCXJPSX.tar.gz to a directory (such as peoplesoft) via FTP.
Change to the PeopleSoft directory:
cd peoplesoft
Unpack the tar file:
gzip -d UCXJPSX.tar.gz
tar xvfo UCXJPSX.tar
The actual files are created in the corresponding directories. Delete the TAR file after unpacking is
complete.
Check for TAR messages (which can be caused by various users) and make sure that all files
have been correctly unpacked.
All files must have the correct owner and group entries. AE must be the owner. The group must
correspond to the identification AE. Only a privileged user, such as root, can make modifications.
chown UC4 * changes the owners of all files to AE
chgrpGroup name * changes user groups of all files
4.
435
Host
Activate the interface in the [PRCS_SBB_JAVA] section of the installed agent's INI file with
ENABLED=1.
Specify the location of the Java library psjoa.jar and the directory of the Java classes in the
parameter CLASSES=. Either create the Java classes yourself or use one of the supplied Java
classes, depending on your version of PeopleTools:
l
UCXJPS82.jar - for 8.1 and 8.2
l
UCXJPS84.jar - for 8.44, 8.45, 8.46, 8.49, 8.50, 8.51, 8.52, 8.53
436
Chapter 8 Installation
Set the environment variable for the agent if an environment variable is used in the PeopleTools
configuration file (Log/Output Directory=).
Admin computer or user computer
5.
l
Host
Make sure that the start script includes the Java Runtime Libraries in the shared library path.
Path names for HP/UX (risc 2.0 Processor) are: /opt/java1.5/jre/lib/PA_RISC2.0/ and
/opt/java1.5/jre/lib/PA_RISC2.0/classic/libjvm.sl.
The $PS_SERVDIR environment variable is required in order to transfer process logs to AE.
Example for HP/UX:
set +vx
UC4_ROOT=$HOME
UC4_BIN=$UC4_ROOT/bin
UC4_TEMP=$UC4_ROOT/temp
#
JAVA_DIR=/opt/java1.3/jre/lib/PA_RISC2.0
UC4_LIB=$UC4_ROOT/lib
export SHLIB_PATH=$JAVA_DIR/classic:$JAVA_DIR:$UC4_LIB
echo "SHLIB_PATH ----> '$SHLIB_PATH'"
#
#PS_HOME=<Home directory of PeopleSoft>
export PS_SERVDIR=$PS_HOME/appserv/HR800/prcs/PSHR800
echo "PS_SERVDIR ----> '$PS_SERVDIR'"
#
nohup $UC4_BIN/UCXJPSX > $UC4_TEMP/UCXJPSX.log 2>&1 &
Set the file rights for the owner and group so that the start script can be executed:
chmod 750start script
Access is denied to all others.
6.
l
l
Automation Engine
l
l
l
l
437
l
l
l
l
Start the UserInterface for the client in which the tasks should be executed.
Enter all required Operator IDs, including the login specifications, in the Login object.
10.
If available, check the connection to the PeopleSoft application server using the program
pscitester. This test program is made available as source code in PeopleSoft SDK. It serves as an
example and can be translated using a C/C++ compiler.
11.
l
l
Functional test
Server computer
The Automation Engine must be running.
Host
Start the agent using the created start script.
An Agent object is automatically created in the system client 0000 and stored in the folder HOST.
Admin computer or Servercomputer
Check whether the agent has logged on to the Automation Engine:
l
Start the UserInterface for client 0000. Call the agent information in the System Overview.
The newly logged-on agent is only shown in client 0000 because it has not yet been
assigned a client. Use the Agent object to assign it to clients with the relevant
authorizations.
438
Chapter 8 Installation
l
l
l
l
l
l
Admin computer/host
Start a test Job.
The PeopleSoft agent is the host. Enter a valid operator ID. Activate the job report transfer to AE. A
PeopleTools process is activated with PS_RUN_PROCESS.
Monitor the process in the UserInterface.
It can take several seconds before AE notices that the PeopleTools process has finished. The
agent checks periodically if the PeopleTools process is still running according to the settings
configured in JOB_CHECKINTERVAL.
Check the job report.
Check the agent's log file.
PeopleSoft online
Verify in PeopleSoft whether the task was correctly executed.
Shut down the PeopleSoft agent.
12.
Include the created start script in the Unix system Autostart procedure so that the PeopleSoft agent
starts with each UNIX system start. A privileged user with administrative rights is required for these
activities, depending on the local environments and operating systems.
13.
l
l
l
Some additional settings must be specified if bind variables will be used in PeopleSoft processes.
AE's interface must be installed in order to use this function.
Copy the PeopleSoft process-type definitions to AE-specific ones. This is done using SQL
commands in the PeopleTools database. It is not required to copy all process-type definitions, but
those that use Bind Variables and are planned by AE should be included.
The following SQL scripts are valid for PeopleTools databases on ORACLE and MSSQL
Server. These scripts should be adjusted if a database of a different producer is used.
ORACLE:
The following SQL script is required if you use PeopleSoft version 8.50 or 8.51:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_'||PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
'UC4_'||PRCSTYPEDESCR,
RESTARTENABLED,
SYSDATE,
'UC4'
FROM PS_PRCSTYPEDEFN;
Automation Engine
0
COMMIT;
The following SQL script is required if you use PeopleSoft version 8.2x or 8.4x:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_'||PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
'UC4_'||PRCSTYPEDESCR,
RESTARTENABLED,
SYSDATE,
'UC4'
FROM PS_PRCSTYPEDEFN;
COMMIT;
Assign execution rights to the new process types:
INSERT INTO PS_SERVERCLASS
SELECT ORIG.SERVERNAME,
ORIG.OPSYS,
'UC4_'||ORIG.PRCSTYPE,
ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG
WHERE 0 =
(SELECT COUNT(*) FROM PS_SERVERCLASS SC
WHERE SC.SERVERNAME=ORIG.SERVERNAME
AND SC.OPSYS=ORIG.OPSYS
AND SC.PRCSTYPE='UC4_'||ORIG.PRCSTYPE )
AND 0 <
(SELECT COUNT(*) FROM PS_PRCSTYPEDEFN PT
WHERE PT.PRCSTYPE='UC4_'||ORIG.PRCSTYPE
AND PT.OPSYS=ORIG.OPSYS );
COMMIT;
MS SQL Server:
The following SQL script is required if you use PeopleSoft version 8.50 or 8.51:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_' + PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
439
440
Chapter 8 Installation
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
LEFT('UC4_' + PRCSTYPEDESCR,30),
RESTARTENABLED,
GETDATE(),
'UC4',
0
FROM PS_PRCSTYPEDEFN;
The following SQL script is required if you use PeopleSoft version 8.2x or 8.4x:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_' + PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
LEFT('UC4_' + PRCSTYPEDESCR,30),
RESTARTENABLED,
GETDATE(),
'UC4'
FROM PS_PRCSTYPEDEFN;
Assign execution rights to the new process types:
INSERT INTO PS_SERVERCLASS
SELECT ORIG.SERVERNAME,
ORIG.OPSYS,'UC4_' + ORIG.PRCSTYPE, ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG WHERE 0 =
(SELECT COUNT(*) FROM PS_SERVERCLASS SC
WHERE SC.SERVERNAME=ORIG.SERVERNAME
AND SC.OPSYS=ORIG.OPSYS
AND SC.PRCSTYPE='UC4_' + ORIG.PRCSTYPE )
AND 0 <
(SELECT COUNT(*) FROM PS_PRCSTYPEDEFN PT
WHERE PT.PRCSTYPE='UC4_' + ORIG.PRCSTYPE
AND PT.OPSYS=ORIG.OPSYS );
l
Automic strongly recommends extensive testing for Jobs that use Bind Variables. More detailed
information is provided in the document Bind Variables.
Automation Engine
14.
l
l
l
l
l
441
Requirements
l
The additional requirements listed below must be fulfilled so that PeopleTools Process Scheduler Batch
server process logs can be added to the AE database:
l
l
l
l
l
Entry in the agent's INI file for transferring the log files to AE
Read permission for PeopleSoft process log files
Read permission for the configuration file of the PeopleSoft Process Scheduler Batch Server
Correct entry in the configuration file at the parameter "Log/Output Directory="
Agent knows the environment variable which might be used for "Log/Output Directory="
The AE interface must have been loaded to the PeopleTools database, validated and authorized for
full access with the Application Designer
The AE Interface must have been activated in the agent's INI file
Supplied Files
The directory IMAGE:AGENTS\PEOPLESOFT\WINDOWS. contains the files listed below:
File name
Description
UCXJPSX.EXE
UCXJPSX2.DLL
442
Chapter 8 Installation
UCXJPSX3.DLL
UCXJPSX4.DLL
UCXJPSX5.DLL
UCXJPSX6.DLL
UCXJPSX.INI
UC.MSL
Message library
ZUSYNCHK.DLL
ZU00132.DLL
UCXJPS82.jar
UCXJPS84.jar
Java classes
SETUP.EXE
Installation program
The other files from this subdirectory are part of the installation program. The files of the AE Interface and
how they are implemented is described in a separate document.
Technical Implementation
Component Interfaces (Java classes) can be used for connecting the agent to PeopleSoft/PeopleTools.
Accesses for job processing are made via the Java Classes of the supplied UC4_* component interfaces.
Automation Engine
Accesses for job processing are made via the Java Classes of the PROCESSREQUEST component
interface.
Optional
443
444
Chapter 8 Installation
This installation step can be ignored if the package is already available in the required version. Refer to
the Control Panel -> Add or Remove Programs to see if and which version of the package is available.
l
Host
Note that PeopleTools Version 8.53 requires at least Java Version 1.7!
If JRE is already available in the required version, this step of the installation process can be ignored.
l
Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control as AE does not need it.
3.
l
l
l
l
Host
This step is only required if the PeopleSoft system runs in a language other than English. If so, it
ensures that PeopleSoft assumes the value for the parameter OUTDESTTPYE of the AE Script
element PS_RUN_PROCESS. Otherwise, the system uses the default parameter value which is
stored in PeopleSoft.
Start the PeopleSoft Application Designer.
Select "File" --> "Open".
Open the field (Definition: Field) "OUTDESTTYPE" (Name).
Then open the "Definition Properties"either via "File" -> "Definition Properties" or use the
shortcut ALT + ENTER.
In the Translate Values tab, change the table as shown below:
Automation Engine
Value
Eff Dt
Long Name
Short Name
01.01.1899
Any
Any
01.01.1899
(None)
NONE
01.01.1899
File
FILE
01.01.1899
Printer
PRINTER
01.01.1899
Window
WINDOW
01.01.1899
01.01.1899
Web
WEB
01.01.1899
Default
DEFAULT
l
l
Active
l
l
l
l
l
445
Host
Start the SETUP.EXE program in the directory IMAGE:AGENTS\PEOPLESOFT\WINDOWS.
Switch drives if necessary. It is essential that the directory
C:\AUTOMIC\AGENTS\PEOPLESOFT is used. Start the installation with the large button
(Computer, Packaging and Diskette).
The AE program group is automatically created or the agent entered.
Adjust the INI file
Set the environment variable for the agent if an environment variable is used in the PeopleTools
configuration file (Log/Output Directory=).
Specify the path to the file jvm.dll in the environment variable path= ! It is stored in the folder
"client" in the installation directory of the Java Runtime Environment. Restart the ServiceManager if
it is running.
The component interface must be activated (ENABLED=1) in the [PRCS_SBB_JAVA] sections.
Enter the location of the Java library and the directory for the Java classes in the parameter
CLASSES=. Either create the Java classes yourself or use one of the supplied Java classes
depending on your version of PeopleTools:
l
UCXJPS82.jar - for 8.1 and 8.2
l
UCXJPS84.jar - for 8.44, 8.45, 8.46, 8.49, 8.50, 8.51, 8.52, 8.53
The file psjoa.jar is stored in the folder "web" in the installation directory of PeopleSoft. If PeopleSoft is
not installed on the same computer as the agent, release the folder "web" as share. The User under
which the agent starts must have computer access rights.
l
446
Chapter 8 Installation
l
The PeopleSoft Java Object Adapter is required for using PS ERP Forms.Copy the "psjoa.jar"file to
the agent's and UserInterface's bin directories.
Enter the agent name and Connect string to the variableUC_EX_ERP_CONNECTwhich is
supplied in client 0.
Adjust the entry "classpath" accordingly (psjoa.jar) in the UserInterface's INI file.
Example:
[ENVIRONMENT]
classpath=.;.\ucdj.jar.;.\psjoa.jar.;.\ucxjps84.jar
7.
l
l
l
l
l
l
l
l
Start the UserInterface for the client in which tasks should be executed.
Enter all required Operator IDs with the login specifications in the Login object.
10.
If available, check the connection to the PeopleSoft application server with the program pscitester.
This test program is made available as source code in PeopleSoft SDK, serves as an example and
can be translated with a C/C++ compiler if required.
Automation Engine
11.
l
l
l
l
l
l
l
l
l
l
Functional
ServerComputer
The Automation Engine must be running.
Host
Start the agent using the created start script.
An Agent object is automatically created in the system client 0000 and stored in the folder "HOST".
Admin computer orServerComputer
Check whether the agent has logged on to the Automation Engine:
l
Start the UserInterface for client 0000. Call the agent information in the System Overview.
As a newly logged-on agent has not yet been assigned a client, it is only available in client
0000. The newly installed agent can now be assigned to clients with the required
authorizations via the Agent object.
AdminComputer/Host
Start a test Job.
The PeopleSoft agent is the host. Enter a valid operator ID. Activate the job report transfer to AE. A
PeopleTools process is activated with PS_RUN_PROCESS.
Monitor the process in the UserInterface.
It can take several seconds until AE notices that the PeopleTools process has finished. The
agent checks periodically if the PeopleTools process is still running according to the settings made
in JOB_CHECKINTERVAL.
Check the job report
Check the agent's log file.
PeopleSoft Online
Verify if the task was correctly executed in PeopleSoft
Close/shut down the PeopleSoft agent
12.
447
Some additional settings need to be specified whenBind Variables should be used in PeopleSoft
processes.
Keep in mind that this function requires the AE interface to be installed.
Copy the PeopleSoft process-type definitions to AE-specific ones. This is done using SQL
commands in the PeopleTools database. It is not required to copy all process-type definitions, but
those which use Bind Variables and are planned by AE should be included.
The SQL scripts listed below are valid for PeopleTools databases on ORACLE and MS SQL
Server. These scripts need to be adjusted if a database of a different producer is used.
ORACLE:
The following SQL script is required if you use PeopleSoft version 8.50 or 8.51:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_'||PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
448
Chapter 8 Installation
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
'UC4_'||PRCSTYPEDESCR,
RESTARTENABLED,
SYSDATE,
'UC4'
FROM PS_PRCSTYPEDEFN;
0
COMMIT;
The following SQL script is required if you use PeopleSoft version 8.2x or 8.4x:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_'||PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
'UC4_'||PRCSTYPEDESCR,
RESTARTENABLED,
SYSDATE,
'UC4'
FROM PS_PRCSTYPEDEFN;
COMMIT;
Assign execution rights to the new process types:
INSERT INTO PS_SERVERCLASS
SELECT ORIG.SERVERNAME,
ORIG.OPSYS,
'UC4_'||ORIG.PRCSTYPE,
ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG
WHERE 0 =
(SELECT COUNT(*) FROM PS_SERVERCLASS SC
WHERE SC.SERVERNAME=ORIG.SERVERNAME
AND SC.OPSYS=ORIG.OPSYS
AND SC.PRCSTYPE='UC4_'||ORIG.PRCSTYPE )
AND 0 <
(SELECT COUNT(*) FROM PS_PRCSTYPEDEFN PT
WHERE PT.PRCSTYPE='UC4_'||ORIG.PRCSTYPE
AND PT.OPSYS=ORIG.OPSYS );
Automation Engine
COMMIT;
MS SQL Server:
The following SQL script is required if you use PeopleSoft version 8.50 or 8.51:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_' + PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
LEFT('UC4_' + PRCSTYPEDESCR,30),
RESTARTENABLED,
GETDATE(),
'UC4',
0
FROM PS_PRCSTYPEDEFN;
The following SQL script is required if you use PeopleSoft version 8.2x or 8.4x:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_' + PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
LEFT('UC4_' + PRCSTYPEDESCR,30),
RESTARTENABLED,
GETDATE(),
'UC4'
FROM PS_PRCSTYPEDEFN;
Assign execution rights to the new process types:
INSERT INTO PS_SERVERCLASS
SELECT ORIG.SERVERNAME,
ORIG.OPSYS,'UC4_' + ORIG.PRCSTYPE, ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG WHERE 0 =
(SELECT COUNT(*) FROM PS_SERVERCLASS SC
449
450
Chapter 8 Installation
WHERE SC.SERVERNAME=ORIG.SERVERNAME
AND SC.OPSYS=ORIG.OPSYS
AND SC.PRCSTYPE='UC4_' + ORIG.PRCSTYPE )
AND 0 <
(SELECT COUNT(*) FROM PS_PRCSTYPEDEFN PT
WHERE PT.PRCSTYPE='UC4_' + ORIG.PRCSTYPE
AND PT.OPSYS=ORIG.OPSYS );
l
We recommend testing Jobs which use Bind Variables extensively. More detailed information is
provided in the document Bind Variables.
13.
l
l
l
l
l
Requirements
The following requirements must be met in order to use the AE interface:
l
l
l
Supplied Files
The files are stored in the directory IMAGE:AGENTS\PEOPLESOFT\_TRANS. It is not required to
change or adjust the enclosed project files before they are imported.
Folder
Description
PT8.21 Directory that contains the project files of the AE Interface for PeopleTools 8.2x
PT8.46 Directory that contains the project files of the AE Interface for PeopleTools 8.42 up to 8.46
PT8.49 Directory that contains the project files of the AE Interface for PeopleTools 8.47, 8.48 and 8.49
Automation Engine
451
Procedure
1.Importing the project to the PeopleTools database
l
l
l
Host
Import the project files that correspond to your version of PeopleTools.
Start the Application Designer from PeopleTools in the "2 Tier Mode" (with direct connection to
database).
Copy the project from the AE CD using the command File->Copy Project from File (8.2x) or Tools>Copy Project->From File... (8.4x) in Application Designer. Select the appropriate
IMAGE:AGENTS\PEOPLESOFT\_TRANS\PTx directory. Click OK tab.
452
Chapter 8 Installation
l
Load all project data into the PeopleTools database. Select all object types and click Copy.
Host
The component interfaces are displayed by double-clicking the folder Component Interface. Select
a component interface and use Tools->Test Component Interface. If you follow this process, you
should avoid errors.
Automation Engine
Host
When the project is imported (such as PT8.4/UC4_V1_02), a permission list called UC4_ALL is
loaded.
Assign the permission list to those Operator IDs by whom jobs should be started and to the
Operator ID for the startup of the AE agent (see ERP LOGIN). There is no permission list for
PeopleTools 8.2x. It must be created manually by a PeopleSoft Security Administrator.
4.Activating the component interface
l
Host
The component interface is activated through an entry in the AE agent's INI file.
453
454
Chapter 8 Installation
See also:
PeopleSoft Agent (Windows), INI-file structure
Manual creation of Java classes is only required if the supplied JAF files are not suitable for your
PeopleTools system or if errors occur.
Procedure
1. Install Java SDK
The Java SDK that is required for the creation of Java Classes can be downloaded from the Internet if it is
not already installed on the computer.
Platform
Link
Microsoft Windows
http://java.sun.com
l
l
Host
Open a component interface (PeopleSoft version 8.1* and 8.2*: SBB_PRCSPARAM, PeopleSoft
version 8.4*: UC4_PROCESSREQUEST) in PeopleTools Application Designer.
From the "Build" menu, select "PeopleSoft APIs."
Check the "Build" check box under "Java Classes" and enter the %PS_HOME%\web\PSJOA
directory as the target directory for the generated files.
Automation Engine
l
455
PeopleSoft.CompIntfcCollection
up to and including
PeopleSoft.TraceSettings
If customer-specific component interfaces exist, Automic recommends that you do not use them.
Customer-specific component interfaces might still be under development and can lead to errors
during Java Classes generation.
l
l
Host
Navigate to the folder %PS_HOME%\web\PSJOA\PeopleSoft\Generated\CompIntfc.
Compile all Java sources with the command:
javac -classpath .;..\..\..\psjoa.jar *.java
It is important that no error messages are displayed.
456
Chapter 8 Installation
Supplied Files
The files that belong to the RA agent are stored in the directory IMAGE:AGENTS\RAPIDAUTOMATION.
File name
Description
ucxjcitx.jar
ucxjcitx.ini
Configuration file
*.jar
Libraries
uc.msl
Message library
setup.exe
Installation program
Procedure
1.
This installation step can be omitted if the required version of Java Standard Edition is already
available.
l
Download the required Java Runtime Environment from http://java.sun.com and install it.
2.
Host
Create an extra folder for the RA agent and copy the supplied files to it. Under Windows, you can
also use the program SETUP.EXE for the installation. It is available in the directory
IMAGE:AGENTS\RAPIDAUTOMATION\WINDOWS.
The RA Solution to be used by the agent will be stored in the folder named "cache." Create this
folder in the installation directory.
Several settings are available for adjusting the RA agent to your system environment. Of note are
the agent and computer name, and the port of the communication process to which the agent
should connect. Adjust the INI file.
3.
Host
Start the utility AE.DBLoad and select the RA Solution's JAR file. The utility will then load it to the
AE database. The JAR file can be loaded via the graphical interface or the Java batch mode
Automation Engine
l
l
(ucybdbld.jar) of the utility AE DB Load. Loading with the AE DB Load in batch mode
(ucybdbld.exe) under Windows is not possible.
After loading the RAsolution, you need to restart the UserInterface.
The RA agent can only connect to one RA Solution. If you intend to use several RA Solutions,
keep in mind that each solution requires its own RA Agent.
Note that you cannot load the same JAR file of an RA Solution to several systems at a time.
Any attempt to do so can cause the utility AE DB Load to abort.
4.
l
l
Host
Log on to system client 0000.
Depending on the RA Solution, one or more templates were generated for the required Connection
objects during the loading process. They are stored in the folder named "TEMPLATE." Create the
required Connection object(s) and fill in the fields in the corresponding tabs. This data is required for
the RA Agent.
5.
l
l
457
Host
The RA agent only starts if an Agent object of the same name exists in system client 0000.
A template for the Agent objects to be used was generated when the RA Solution loaded. It is
stored in the folder named "TEMPLATE." Create an Agent object in the folder HOST and fill in the
relevant fields in its tabs (Connection objects, etc.).
Use the following command to start the agent via the command line (UNIX and Windows):
java -jar -Xrs -Xmx256M ucxjcitx.jar disable_cache
If you load the RAsolution, then start the agent shortly afterward, you may get a cached agent
rather than the one you just loaded. You can avoid this by adding disable_cache to the end of
the start command. That way the loaded version is always started.
You can also start the agent via the ServiceManager.
Note that the storage limit should be set to at least 256MB (or 512MB) for starting Java agents
(Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java applications
by using the start parameter -XmX.
Specifying a value that is too low can cause the agent to crash. The default value depends on the
Java version that is used.
The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation.
6.
l
Host
When the RA Solution is loaded, one or more templates for Job objects are stored in the folder
named "TEMPLATE." Use templates to create jobs for the RA Solution.
458
Chapter 8 Installation
l
RA jobs do not contain Login objects. Login data is stored in one or several Connection objects
during the installation process and can be selected in the Agent object.
Description
Optional Check
Automation Engine
459
Agent name
Name:
AE installationation CD or directory
10
460
Chapter 8 Installation
Before you start the installation, make sure that the Java agents can only connect to CP port numbers
that are lower than 65536. If they use a higher port number, the agent cannot start and aborts with an
error message. This limitation is caused by Java and affects the agents for JMX, Databases, SAP and
RA.
It is not required to install the agent on the same computer as the SAP system.
Requirements
The following SAP support packages are required for using the job options No printing, Report send
status and Report status by mail for spool-list receivers:
l
l
l
l
Supplied Files
The files are found in the directory IMAGE:AGENTS\SAP\UNIX or IMAGE:AGENTS\SAP\WINDOWS.
File name
Description
UCXJR3X.JAR
SAP agent
UCXJR3X.INI
UC.MSL
Message library
SAPRFC.INI
UMSVCP60.DLL
SETUP.EXE
Startup
Check Step
Installing the Microsoft Visual C++ 2010 Redistributable Package
Installing the Java Runtime Environment (JRE)
Installing the agent (UNIX)
Installing the agent (Windows)
Installing SAPJava Connector
Importing the AE Interface
Creating a CPIC User
Optional
Automation Engine
461
This step is only relevant when installing the SAP Agent on Windows.
Starting with JCo 3.0.0, JCo running on Windows requires the Visual Studio 2005 C/C++ runtime libraries.
See SAP note 684106 for details on how to install them.
You can skip this step when the required version of the package is already installed. Refer to the
Control Panel -> Add or Remove Programs to see if the package is available, and if so, which version.
l
Host
If the required version of JRE is already available, you can skip this step.
l
Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control if you prefer; AE does not need it.
3.
l
l
l
Host
Log on using the user AE
Transfer the TAR file UCXJR3X.tar.gz to a directory (such as SAP) via FTP.
Switch to the SAP directory:
cd sap
Unpack the TAR file:
gzip -d UCXJR3X.tar.gz
462
Chapter 8 Installation
l
l
l
l
l
l
l
l
l
l
Host
A detailed configuration and installation guide is provided in the archive of the SAP Java
Connector (<sapjco-install-path>/docs/jco/intro.html). Read this description carefully in order to
ensure that everything works correctly.
To see which Java Connector version is supported, Refer to the requirements of the SAP agent.
Install the 32bit SAP JAVA Connector if you use 32bit Java. 64bit Java requires the 64bit
SAPJava Connector.
Download the SAP Java Connector from the SAPService Marketplace and install it (Support Portal
-> Downloads -> SAPConnectors -> SAPJava Connector -> Tools &Services).
Copy the SAPJava Connector filesto the BINdirectory of the agent.
The SAP note 636912 includes information that can be used to verify that the Java Connector
has correctly been installed.
6.
l
l
l
l
Host
This installation step is only required if you intend to use the AE interface.
Copy the transport files.
Import the transport.
See also: Transporting the AE Interface.
7.
Automation Engine
l
l
l
l
l
Host
Log on to the SAP system using the SAP user administrator.
Create an authorization profile either directly or with a role.
Create the CPIC user and assign the authorization profile or role.
Note that you must create this CPIC user with the same password in each SAP client in which
you want to run Jobs.
8.
l
l
l
SAP
Connection type
ABAP Basis
Java Basis
Internet
Process Integration
Internet
Internet
SAP distinguishes between uppercase and lowercase letters. Keep this in mind when you enter
the password.
9.
l
l
l
l
l
l
l
463
Server computer
Host
464
Chapter 8 Installation
l
Use the commands to start the agent via the command line for your operating system.
l
Windows:
<path to java> -Xrs -Xmx256M -jar ucxjr3x.jar
If java is installed in a folder which contains spaces the command needs to be placed in
quotes.
For example:
If the SAP Java Connector cannot load its native library the parameter -Djava.library.path can be
used to point to a directory which contains the libsapjco3.so.
The agent can also be started by using the ServiceManager.
Note that the storage limit should be set to at least 256MB (or 512MB) for starting Java agents
(Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java applications by
using the start parameter -XmX.
Specifying a value that is too low can cause the agent to crash. The default value depends on the Java
version that is used.
The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation.
l
If it does not already exist, an Agent object is automatically created in system client 0000 and
stored in the folder HOST.
Call information about agents in the System Overview. Newly logged-on agents have not yet
been assigned to a client, therefore they can only be viewed in client 0000. You can now
assign the new agent to clients with the required rights by using the Agent object.
11.
Function Test
Admin computer/host
Start a test job.
The SAP computer is the host. Enter the appropriate UserID. Activate the job report deposit in AE.
The script contains the following script lines:
R3_ACTIVATE_REPORT REP=RSM04000_ALV,COVERPAGE=YES
The current ABAP creates a list of actual users.
Monitor the process in the UserInterface.
It can take a couple of seconds for the system to register that the job is done. The agent checks
at a regular interval whether the job is still running. This interval can be specified in the Host
Characteristics.
Automation Engine
SAP System
465
Check the log entries from the current period with the transaction RZ15 (only when using the
standard interface).
Shut down the agent.
Description
UCXJSLX.EXE
Siebel agent.
UCXJSLX.INI
UC.MSL
Message library.
ZU00132.DLL
ZUSYNCHK.DLL
SETUP.EXE
Installation program.
Additional files in this subdirectory are components of the installation program and the AE runtime system.
See: Knowledge Base.
Procedure
1.
This installation step can be ignored if the required version of the package is already installed.
l
Host
466
Chapter 8 Installation
l
Host
Server computer
Host
Host
Shut down the agent.
Right-click the agent in the task bar. Select Exit.
Automation Engine
467
Automic recommends running the UNIX agent with root rights. Without root rights, the agent cannot
switch to the context of another user and jobs and file transfers must always run under the user under
which the agent has started.
You can define the relevant rights for the agent by starting it under the real "root" user. Another method
is to set the sbit for the agent and to define "root" as the owner. The effect is that every user of the
group that is assigned to the agent can start it.
Requirements
l
l
Automic recommends adding the directory "$HOME/bin" to the system environment variable
PATH.
See step 1: Unloading the TAR files and setting up the system environment.
Read the note referring to processes on AIX.
Note that on AIX, the size for Core files must be extended.
Supplied Files
The files of the UNIX agent are supplied in compressed form:
ucxj???.tar.gz ... files of the actual agent,
ucxb???c.tar.gz ... files for the CallAPI.
Eacht TAR file is found in the subdirectory of IMAGE:AGENTS\UNIX that corresponds with the
appropriate UNIX version.
File name
Description
ucxj???
UNIX agent
ucxj???m
468
Chapter 8 Installation
ucxjxxx.ini
ucx.msl
Message library
ucxe???f
The CallAPI files and their implementation are described in a separate document.
Procedure
0. Rights of the user ID "AE"
l
l
Host
Jobs can either be started with the function fork, or the batch command. Set the agent's INI file
parameter start_type= to the corresponding value. Depending on this setting, the following rules
apply for the agent:
l
"fork" - Jobs can start under any user ID if the agent has been started under a user ID with
root rights. If no root right has been assigned, jobs must run under the user ID under which
the agent has been started.
l
"batch" - The agent must start under a User ID with root rights.
1. Transferring the TAR files to the host and setting up the system environment
l
l
l
l
Host
Register with user ID AE.
Transfer the TAR file ucxj???.tar.gz via FTP.
Unpack the TAR files.
gzip -d ucxj???.tar.gz or gunzip ucxj???.tar.gz
tar -xvf ucxj???.tar
(Linux: tar -zxvf ucs???.tar.gz)
The unpacked files are displayed. The TAR file can be deleted after unpacking.
l
l
Note any TAR messages and verify that all files are unpacked correctly.
Ensure that all files have the correct owner and group entry. AE must be the owner. The group must
correspond with the code "AE". Only a privileged user, such as root, can make these modifications.
chown UC4 * changes the owners of all files to AE.
chgrp Group name * changes the user groups of all files.
Customize the INI file using an editor such as vi. You can also edit andtransfer the INI file on the
Admin computer via FTP. The program ucxj??? and the INI file must be in the same directory.
For actual operation, the program ucxj??? can be given the permissions of a privileged user such as
root.
l
Change owner to root
chown root ucxj???
l
Automation Engine
469
Host
Authentication via (Pluggable Authentication Modules) is now supported for the agents of the
following UNIX platforms: Solaris, Linux and AIX.
Server computer
The AE System must be running.
Host
If you start the agent for testing in the dialog, note the following:
Quitting with the DEL key is only possible as of version 1.20 and when the corresponding parameter
in the INI file has been set. Automic recommends that you do not set this parameter, but quit from
another terminal using the kill -TERM instead.
l
l
An Agent object is automatically created in system client 0000 and stored in the folder HOST.
The backup directory for the filebased rollback is automatically created when you start the
agent. This directory is available for jobs and file transfers. You can define the path for the backup
directory in the Agent Variable UC_EX_PATH_BACKUP. Note that for using the filebased rollback,
470
Chapter 8 Installation
you need the OS user under which the related jobs and file transfers are started, and write access to
the backup directory.
l
Host
Ending the agent normally:
kill-TERM pid
Canceling agent in emergency cases. Network connections are not properly closed.
kill -KILL pid or
kill -9 pid
Requirements
l
The user AE has been created with the privileges CMKRNL, BYPASS, SYSNAM, SYSPRV and
WORLD.
The batch queue SYS$BATCH has been initialized and started. Alternately, you can use a batch
queue that has been specifically created and prioritized for AE Jobs. If a batch file is created for this
purpose, it must be defined in the VMS agent's INI file as the VMS command's parameter for
starting Jobs in batch mode. If you use a different batch queue, note that it must also be initialized
and started.
Automation Engine
471
The job limit must be specified with a number higher than zero in order to enable AE Jobs to be
performed in batch mode.
Description
Destination
directory
File
type
UCXJV??.EXE
VMS agent
BIN
Binary
UCXJV??M.EXE
Messenger Program
BIN
Binary
UCXE???F.EXE
BIN
Binary
UCXJV??.INI
INI file
BIN
Text
UCX.MSL
Message Library
BIN
Text
UC$CRDIR.COM
CMD
Text
UC$START.COM
CMD
Text
UC_START.COM
CMD
Text
UC$STOP.COM
CMD
Text
SYS$STARTUP Text
UC4$STARTUP_
BAT.COM
SYS$STARTUP Text
Procedure
1.
Admin computer
472
Chapter 8 Installation
2.
l
l
l
Host
Register with user ID AE.
Call command file:
$ @UC$CRDIR
CMD
TEMP
OUT
3.
l
Admin computer
The files of the VMS agent (UCXJV??.EXE), for file event (UCXE???F.EXE) and the messenger
program (UCXJV??M.EXE) must be transferred in binary mode. All others are text files.
4.
Host
l
l
l
Use an editor to adjust the command file that closes the agent UC$STOP.COM.
The name of the AE system and the agent name must be adjusted so that the logical name of the
agent can be found.
You can also modify both files on the Admin computer before you transfer them.
If the agent has not been installed in the HOME directory, the command file UC$START.COM
must be adjusted. It contains a variable that indicates the installation directory.
Automation Engine
$rel_dir
473
= ""
If the command file remains unchanged, the HOME directory is by default used to start the agent.
The user IDs under which AE jobs should run should be given TMPMBX and sometimes
NETMBX privileges.
Admin computer or User computer
5.
Server computer
Register using the user AE.
The AE system must be running.
Host
l
l
$ @UC$START
l
An Agent object is created automatically in the system client 0000 and stored in the folder HOST.
l
l
Host
Log on using the user ID UC4.
Call the command file in the CMD directory to shut down the agent normally.
$@UC$STOP
474
Chapter 8 Installation
The command file (1) UC4$STARTUP.COM calls the command file (2) UC4$STARTUP_BAT.COM.
With the help of the command file UC$START.COM, the VMS agent will then start. Adjust the parameter
UC4_COM if the name or directory of this supplied command file has been changed.
Comments
l
l
l
l
The command file (2) UC4$STARTUP_BAT.COM must be started with the agent's user ID.
The batch queue must be initialized and started.
The network environment and administration UCX must be started.
The command file (2) UC4$STARTUP_BAT.COM must have WORLD READ privileges so that
the agent's user ID can be read: $SET FILE /PRIV=(W:R) SYS$STARTUP:UC4$STARTUP_
BAT.COM.
Automation Engine
475
Description
UCXJ???.EXE
Windows agent.
UCXJ???M.EXE
UCXJ???.INI
UC.MSL
Message library.
UCSMTP.DLL
ZU00132.DLL
SETUP.EXE
Other files from this subdirectory are components of the installation program and the AE runtime system.
See: Knowledge Base.
The CallAPI files and CallAPI implementation are described in a separate document.
Potential Problems
l
l
Procedure
1.
This installation step can be ignored if the package is already available in the required version. Refer to
the Control Panel -> Add or Remove Programs to see if the package is installed, and if so, which
version.
l
Host (32-bit)
Host (64-bit)
476
Chapter 8 Installation
2.
l
Host (32-bit)
Host (64-bit)
l
l
l
l
Host
Adjust the INI file UCXJ???.INI to your system environment.
The User who starts the agent must have the following rights if the INI-file parameter logon= has
been set to "1":
l
l
l
l
l
l
l
l
*) This right is only required if you start jobs by using the start option "logon as batch user".
**) This right is necessary for the execution of Job objects.
For the extended FileTransfer object (as of v9) this right is usually optional. It is necessary,
however, when the agent transfers encrypted files with a file transfer because the agent uses the
WinAPI "LoadUserProfile".
In Windows, the Local Security Policy can be called via the Control Panel -> Administrative Tools.
Rights are defined in User Rights Assignment in the Local Security settings.
All Windows users that should execute "BAT"-type Jobs required the right "Read & Execute" for the
agent's "bin" and "temp" directory. Otherwise, an error message occurs when the job starts
(Access denied). Doing so is only necessary if the agent's INI-file parameter LOGON=1 or the UC_
HOSTCHAR_*'s setting ANONYMOUS_JOB is set to "N"..
Admin computer or Server computer
Adjust HEADER.WINDOWS, TRAILER.WINDOWS and RESTART.WINDOWS if necessary.
See: Job - Execution.
4.
Automation Engine
l
Server computer
Host
477
Host
Shut down the agent.
Right-click the agent in the task bar. Click Exit.
Comments
Below you will find more detailed information about additional rights that are required when you install the
Windows agent as described above in the section "Setting up the system environment".
The Windows agent requires certain additional rights under Windows in order to be able to use the
Windows APIs that are listed below.
The agent requires these rights in order to process file transfers and start jobs in different user contexts.
Although users are defined in the Automation Engine jobs, the agent must still be able to log on with the
privileges of the particular user, read user profiles and start Jobs, for example. Therefore, Automic
recommends starting the agent via the Service Manager as a SYSTEM user.
When you start the agent as a regular user, however, you should install it with the recommended additional
rights in order to make sure that it can process the above tasks:
l
l
l
l
l
l
The right 'log on as a batch job' is required when the option "log on as a batch user" has been activated in
the Windows Jobs of the AE system's Job objects.
See also:
Configuring the Debugger for potential program failures
478
Chapter 8 Installation
Requirements
l
l
l
l
l
l
l
JES2 or JES3
TCP/IP V3R2M0 or later
APF authorization for the load library
C runtime library version V1R5M0 or later
An MSGCLASS in HOLD status that does not call a subsequent program (external writer)
UPDATE access for JESSPOOL RACF Class (in order to process Job outputs)
A file qualifier for temporary files, logs and traces
Supplied Files
The following files are available in the directory IMAGE:AGENTS\MVS.
File name AE CD
Description
UCXJM25-IBM.BIN
z/OS agent
UC4.UCXJM25.LOAD
UC4.UCXJM25.INI
UCXEM25.INI
UC4.UCXEM25.INI
UCX.MSL
Message Library.
UC4.UC.MSL
STC25.TXT
UC4JCLE.ASM
UC4EJM.INI
The CallAPI files and their implementation are described in a separate document.
CADSDEL - A utility that can be used to release a Common Dataspace (CADS) allocated by the
Event Monitor.
UC4END - End messenger for the SMF messenger technique (it writes the StepList and return
codes to the JESMSGLG)
UC4RESTR - Restart messenger for the SMF messenger technique (dummy program such as
IEFBR14)
UC4START - Start messenger for the SMF messenger technique (dummy program such as
IEFBR14)
Automation Engine
Procedure
1.
Host
Host
Create the load library using the utility TSO RECEIVE. Bold printed parameters are systemspecific specifications.
//UC4LOAD JOB (ACCT#),'UC4USER',
// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),NOTIFY=UC4USER
//*************************************************
//STEP01 EXEC PGM=IKJEFT01,DYNAMNBR=30
//SYSPRINT DD SYSOUT=*
//SYSTSPRT DD SYSOUT=*
//SYSTSIN DD *
PROFILE NOPREFIX
RECEIVE USERID(UC4USER) INDSN('MYDSN.UCXJ.WORK')
DSNAME('UC4.UCXJM25.LOAD') UNIT(3390) VOLUME(??????)
/*
479
480
Chapter 8 Installation
l
Host
APF authorization is required for the load library. It must be assigned or can dynamically be added
to the system console using the following command:
SETPROG APF,ADD,DSN=UC4.UCXJM25.LOAD, [SMS] [VOLUME=xxx]
4.
Host
The agent runs on the host as a started task. The supplied files include a JCL example. Copy this
JCL to a procedure library and specify the name for the INI file and the load library. The STC user
also requires the following authorizations:
l
GENERAL RESOURCE
Usually, there is a general resource for started tasks (STC). General rights can be assigned
here in order to enable the agent program to run as a STC. You can also define the user that
should be used to run the agent (STDATA).
Required RACF settings for file transfers if the USS file system is used:
FACILITY class BPX.DAEMON profile with UACC(READ)
PROGRAM class * profile, MEMBER(loadlib//NOPADCHK)
Use the STC user or any other user to start the AE jobs and/or file transfers.
Using the STC user for the complete execution:
The STC user requires access to all z/OS resources that are used in Jobs and FileTransfers. This
user must also be specified in the appropriate LOGIN object. Users without a password (batch
users) must be specified in the LOGIN object with no password being indicated. The parameter
askRACF in the agent's INI file must be set to "0" or "4" in order to deactivate the password
verification.
Using different users:
An appropriate OMVS segment must be defined for all users in addition to the required resources in
order to establish a TCP/IP connection to the Automation Engine. Specify the relevant LOGIN
object in the job attributes. If a batch user (user without a password) is used for the execution, the
STC user requires a surrogate authorization for this particular user. In this case, specify the
required user in the LOGIN object without defining a password and deactivate the password
verification (set the parameter askRACF in the agent's INI file to "0" or "4" ).
l
Automation Engine
481
//SYSPRINT DD SYSOUT=*
//STDOUT DD SYSOUT=*
//SYSCPRT DD SYSOUT=*
//JOBOUT DD SYSOUT=(A,INTRDR)
//SYSUDUMP DD SYSOUT=*
//*
l
Apply the following step if the MVS or Language Environment Resolver do not work correctly:
The DD statements must be included in the sarted task. Otherwise, the agent cannot establish a
TCP/IP connection.
Example:
//SYSTCPD DD DSN=TCPIP.SYSTSMS.TCPPARMS(DT20OEDA),DISP=SHR
//PROFILE DD DSN=TCPIP.SYSTSMS.TCPPARMS(DT20VIPA),DISP=SHR
Complete statements are found in the TCP/IP's started task.
The DD statements for TCP/IP must also be included in the Include objectMVS.JOBMD_
DEFINITIONS. Otherwise, the job messenger cannot open a TCP/IP connection and the Jobs will
receive the status ENDED_VANISHED.
OMVS segment
ALTER authorization for own datasets (e.g.: UC4.*)
The started task requires the appropriate authorization in order to read JES lists
482
Chapter 8 Installation
INDEXED VOLUMES(volume) CYLINDERS(10 5) ) DATA (NAME(UC4.UCXJM25.SSTORE.DATA) KEYS(16 0) RECORDSIZE(256 4096) FREESPACE(10 10) )INDEX (NAME(UC4.UCXJM25.SSTORE.INDEX) )
//* Load a dummy record
//DUMMYREC EXEC PGM=IDCAMS
//SYSPRINT DD SYSOUT=*
//OUT1 DD DISP=SHR,DSN=UC4.UCXJM25.SSTORE
//SYSIN DD * REPRO INFILE(IN1) OFILE(OUT1)
//IN1 DD *
DUMMY
/*
Transfer information for every dataset/file is stored as a record in the VSAM dataset. The size of
the information record varies depending on the size of the dataset and file size. 260 bytes is an
average size. The suggested space values are 10,5 cylinders = (10 + 15 * 5) * 849,960 bytes ~
75.553 kilobyte, which should be enough for approximately 282k transfer entries.
5.
l
l
l
Host
Adjust the INI file. The INI file must not use the file attribute NUMBER ON.
Adjust the HEADER.MVS, TRAILER.MVS and RESTART.MVS where necessary. See:Job Execution
6.
Server computer
Host
Automation Engine
l
Host
Quit the agent's started task via the system console using a MODIFY command (such as modify
UC4RUN,end). Alternately, you can also use the STOP command stop UC4RUN.
8.
483
484
Chapter 8 Installation
//SYSPRINT DD SYSOUT=*
//OUT1 DD DISP=SHR,DSN=UC4.UCEVENT.VSAM
//SYSIN DD *
REPRO INFILE(IN1) OFILE(OUT1)
//IN1
DD *
DUMMY
/*
l
Note that the RACF authorization READ is required in order to run the Event monitor if the MVS
Extended Console is protected.
9.
See also:
Agent - Interaction Between the Automation Engine and z/OS
SMF Exit
Event Monitor
Automatic File-System Events
External Job Monitor
Automation Engine
485
Supplied Files
The ServiceManager files are supplied in compressed form (ucsmgr???.tar.gz), and are found in
subdirectories of IMAGE:SERVICEMANAGER\UNIX. The names of the subdirectories indicate the
supported platforms.
File name
Description
libgcc_s.so
GNU C Library
libstdc++.so
Runtime libraries
uc4.smd
uc.msl
Message library
ucybsmcl
ucybsmgr
ServiceManager
ucybsmgr.ori.ini
Procedure
1.
l
l
l
l
l
l
l
l
l
l
Transfer the tar file to the Host and set up the system environment.
Host
Log on using the user ID AE.
Transfer the TAR file ucsmgr??.tar.gz to a directory (such as smgr) via FTP.
Navigate to the ServiceManager directory:
cd servicemanager
Unpack the tar file:
gzip -d ucsmgr???.tar.gz or gunzip ucsmgr???.tar.gz
tar xvfo ucsmgr???.tar
The files will appear in their corresponding directories. The tar file can be deleted after unpacking.
Be sure to note any tar messages (which can be called up by various users) and verify that all
files have been correctly unpacked.
Verify that all files have the correct owner and group entries. AE must be the owner. The group must
correspond to the identification AE. Modifications can only be made by a privileged user, such as
root.
chown UC4 * changes the owner of all files to AE.
chgrpGroup name * changes user group for all files.
Rename the supplied ini file ucybsmgr.ori.ini to ucybsmgr.ini.
Rename the supplied file uc4.ori.smd to uc4.smd.
Adjust the INI file to the system environment.
Set the variable:
AIX: export LIBPATH=Path of the system library directory
486
Chapter 8 Installation
HP-UX: export SHLIB_PATH=Path of the system library directory
Solaris, Linux, zLinux: export LD_LIBRARY_PATH=Path of the system library directory
2.
l
Host
Start the ServiceManager:
nohup ./ucybsmgr [-iPath and Name of the INI file] Phrase &
The phrase is a ServiceManager environment.
For more information about ServiceManager functions (such as starting and stopping agents), see
UCYBSMCL.
Potential Problems
l
When starting the server or the SAP-Agent using the ServiceManager the necessary libraries
cannot be found and an error message is displayed.
Possible solutions:
1. You need two ServiceManagers. Start one of them and assign root rights and the setuid-bit
to it for the owner. You use it for starting and stopping the UNIX agent. Then start the second
ServiceManager without the setuid-bit and use it for starting and stopping programs such as
Automation Engine
487
Supplied Files
The ServiceManager files are stored in two different directories of the supplied AE CD. The files that
provide the ServiceManager service are found in the directory IMAGE:SERVICEMANAGER\WINDOWS.
File name
Description
UCYBSMGR.EXE
ServiceManager
UCYBSMGR.INI
UC4.SMD
ZU00132.DLL
SETUP.EXE
Installation program
The directory IMAGE:SERVICEMANAGERDIALOG\WINDOWS contains the files for the dialog and
command line programs of the ServiceManager.
File name
Description
UCYBSMDI.EXE
UCYBSMDI.INI
UCYBSMCL.EXE
SETUP.EXE
Installation program
Additional files that are included in these sub-directories belong to the installation program and the AE
runtime system. See: Knowledge Base.
488
Chapter 8 Installation
Procedure
Server computer or host computer
1.
This installation step can be omitted if the required version of the package is already installed. Refer to
the Control Panel -> Add or Remove Programs to see if the package is installed , and if so, which
version.
l
l
l
l
l
l
l
Automation Engine
4.
l
l
489
l
l
The ServiceManager is entered in Windows as a service. You can use a string of your choice as the
phrase.
Verify in the Control Panel > Administrative Tools > Services that the service is correctly
entered. The name displayed here is structured - as follows: "Automic ServiceManager [Phrase]".
Set the start type to "Automatic" if needed.
The phrase name is "UC4" by default. If you choose to use a different term, you must adjust the
following section in the INI file UCYBSMGR.INI:
[Destination Phrase]
deffile=Path to the SMD file
cmdfile=Path to the SMC file
Example:
[Destination UC4PROD]
deffile=C:\AUTOMIC\SMgr\bin\UC4PROD.smd
cmdfile=C:\AUTOMIC\SMgr\bin\UC4PROD.smc
The ServiceManager can be installed as a service multiple times. This means that different
ServiceManager environments can be created; one that serves as a test system and one that serves as a
production system, for example. If several of these services are used, they are distinguished by the
ServiceManager environment name (default name: UC4).
Note that the ServiceManager service must be started under a Windows user with administrator rights.
The reason is that the ServiceManager can be used to start components that can start processes for
various different users.
5.
Make sure that the ODBC data source is set up as a system DSN (Data Source Name) so that the
Automation Engines (program UCSRVCP.EXE and UCSRVWP.EXE) are executable as a service.
l
l
l
l
Potential Problems
l
490
Chapter 8 Installation
10 port numbers.
l
Further information can be obtained from the ServiceManager's log file (default name of the latest file:
SMgr_LOGG_00.txt), which is found in the TEMP folder and which contains detailed information on all
procedures.
l
l
See also:
l
l
l
l
ServiceManager - Service
ServiceManager - Dialog Program
ServiceManager - Command Line Program
Configuring the Debugger for potential program failures
Automation Engine
491
You can specify the CodeTable that should be used in the INI file of the BS2000 CallAPI. Enter the
name of the CodeTable object in the section [GLOBAL] of the parameter codetable=.
Supplied Files
The CallAPI files are packed as TAR files. The relevant TAR file is found in the sub-directory of the
appropriate BS2000 variant in IMAGE:AGENTS\BS2000:
l
l
l
Transfer the required TAR file to the BS2000 system using any text file transfer. It can then be extracted
using the utility BS2-TAR or the BS2-TOOLS version 2.00W or later (both are products of Automic
software).
The TAR file contains the files listed below, which are supplied with the BS2000 package. The characters
"x.xxx" replace the part of the file name that shows the current Automation Engine version:
File name
Description
x.xxx.UCXBB2?C.INI
x.xxx.UCXBB2?C.LIB
LMS Plamlibrary
The LMS Plamlibrary contains all elements that are required for programming.
Element name
Description
UCXBB2?C Type L
UCCALL3 Type L
UCCALL3 Type M
UCCALL3.H Type S
UCCALL3.CPY
Type S
SAMPLE.COBOL
Type D
Procedure
1.
l
The CallAPI can be used with no installation required. Its files are included in the agent and installed
when the agent is installed.
Adjust the INI file x.xxx.UCXBB2?C.INI to your system environment.
You can keep your existing INI file even if there is a new Automation Engine version. It might be
required to adjust it. More detailed information is provided in the Release Notes, a collection of
which is found in the manual Release Notes.
492
Chapter 8 Installation
See also:
CallAPI for BS2000
Supplied Files
The files that belong to the CallAPI are found in a sub-directory of IMAGE:CALLAPI\GCOS8.
File name
Description
ucxbgc8c
ucxbxxxc
ucxgc8c.oml
ucxbgc8ci
UCMSL
Message library
callapi
callapi_fc
JCL for calling the CallAPI (INI and SCRIPT files are allocated statically)
callapi_logon
script
AE Script file
uccall3.h
Header file for the sample program with structure and API definition
ucxbxxxc.c
comp_xxx, link_xxx JCL for compiling and creating the sample program
go_xxx
go_xxx_fc
JCL for calling the sample program (INI and SCRIPT files are allocated statically)
go_xxx_logon
JCL for calling the sample program (call with LOGON information)
Procedure
1.
l
l
Automation Engine
493
TMP.
Transfer the files to the relevant sub-catalogs on the GCOS8 computer using FTP or Glink FTP.
SubCatalog
File
DATA
EXEC
INC
uccall3.h
JCL
SRC
ucxbxxxc.c
See also:
CallAPI for GCOS8
Supplied Files
The files are found in the directory IMAGE:CALLAPI\JAVA.
File name
Description
UCCALL3.JAR
UCXBXXXC.INI
UCCALL3.BAT
SCRIPT.TXT
SAMPLE.ZIP
CALLAPI-DOC.ZIP
Procedure
1.
494
Chapter 8 Installation
l
l
See also:
CallAPI for Java
Supplied Files
The files are not packed; they are available as binary files and as ASCII files. They are found in the
subdirectory IMAGE:CALLAPI\NSK.
File name
File
Description
UCXBNS1C
Binary
UCXBNS1I
Text
scrsamp
Text
AE sample script
UCMSL
Text
Message library
Procedure
1.
l
l
l
l
Transferring the supplied file to the host and setting up the system environment
Admin computer
Establish a connection to the HP NonStop Server using an FTP client and log on with the user ID
that is required for the installation.
Transfer text and binary files to the corresponding subvolume.
Host
The utility UCXBNS1C uses the INI file UCXBNS1I. This file must be adjusted to your system
environment. You can also edit it on the Admin computer and transfer it using FTP.
Automation Engine
495
You can keep your existing INI file even if there is a new Automation Engine version. It might be
required to adjust it. More detailed information is provided in the Release Notes, a collection of
which is found in the manual Release Notes.
See also:
CallAPI for NSK
Supplied Files
The CallAPI utility is found in the supplied loadlib for the z/OS agent. The loadlib is stored in the
subdirectory IMAGE:AGENTS\MVS:
l
Procedure
The load library can be transferred with any file transfer (such as IND$FILE without ASCII/EBCDIC
conversion or CR/LF conversion). Create the load library using the utility TSO RECEIVE. The delivery
directory contains a sample sucI file (UCXBM25C.INI), which can be used for any text file transfer to
z/OS. Be sure to adjust it to your installation (Automation Engine data, for example).
You can keep your existing INI file even if there is a new Automation Engine version. It might be
required to adjust it. More detailed information is provided in the Release Notes, a collection of which is
found in the manual Release Notes.
See also:
CallAPI for z/OS
496
Chapter 8 Installation
Supplied Files
The supplied library for OS/400 agents contains the utility for the CallAPI.
Procedure
The supplied library contains a sample INI file which must be adjusted to your installation (e.g. Automation
Engine data).
You can keep your existing INI file even if there is a new Automation Engine version. It might be
required to adjust it. More detailed information is provided in the Release Notes, a collection of which is
found in the manual Release Notes.
See also:
CallAPI for OS/400
Supplied Files
The files that belong to the CallAPI are provided in the subdirectories of the IMAGE:CallAPI\SAP. The
subdirectory \SAMPLE contains examples. These examples are not platform-specific.
Windows
UNIX
Description
ucxsapc.jar
ucxsapc.jar
RFC Server
ucxsapc.ini
ucxsapc.ini
uccall3.jar
uccall3.jar
uc.msl
uc.msl
Message library
Automation Engine
497
Technical Implementation
If JRE is already available in the required version, you can skip this step.
l
Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control, because AE does not need it.
2.
Windows:
l
UNIX:
498
Chapter 8 Installation
l
l
Pay special attention to tar messages (which, for example, can be called up by various users)
and make sure that all files have been correctly unpacked.
The RFC Server requires the RFC library (versions 3.1G and later) for operation:
librfccm.o (AIX), librfccm.so (Solaris, zLinux) or librfccm.sl (HP-UX). Set the variable according to
the RFC library's installation folder and the CallAPI for SAP.
AIX: export LIBPATH=Paths of the installation directories
HP-UX: export SHLIB_PATH=Paths of the installation directories
Solaris, Linux, zLinux: export LD_LIBRARY_PATH=Paths of the installation directories
Example for HP-UX:
The CallAPI for SAP was installed in /opt/uc4/callapi/bin and the RFC library in
/opt/uc4/callapi/rfclib. The environment variable must be set as follows:
export SHLIB_PATH=//opt/uc4/callapi/bin:/opt/uc4/callapi/rfclib
3.
Host
l
l
Install the 32-bit SAP JAVA Connector if you use 32-bit Java. 64-bit Java requires the 64-bit
SAPJava Connector.
Download the SAP Java Connector from the SAPService Marketplace and install it (Support Portal
-> Downloads -> SAPConnectors -> SAPJava Connector -> Tools &Services).
Copy the SAPJava Connector files to the BINdirectory of the agent.
UNIX:To set the environment variables, see the installation folder of the CallAPI for SAP.
AIX: export LIBPATH=path of the installation directory
HP-UX: export SHLIB_PATH=path of the installation directory
Solaris, Linux, zLinux: export LD_LIBRARY_PATH=path of the installation directory
Example for HP-UX:
The CallAPI for SAP is installed in /opt/uc4/callapi/bin. The SAP Java Connector must be stored in
the same directory. Set the environment variable as follows:
export SHLIB_PATH=//opt/uc4/callapi/bin
4.
Automation Engine
499
Adjust the file ucxsapc.ini according to your environment. The sections [CP_LIST] and [RFC] are the
essential parameters. The section [CP_LIST] contains the Automation Engine data. The section [RFC]
determines the SAP Gateway to which the RFC Server registers.
Example for the INI-file section [RFC]:
/*===================================================================*/
/* Register a RFC server program at a SAP gateway
*/
/* or connect to an already registered RFC server program */
/*===================================================================*/
[RFC]
PROGID=uc4call
HOSTNAME=r31
GWSERV=sapgw00
It is not required to use a new INI file with each new Automation Engine version. Just make sure to
update your INI file. The relevant information is provided in the Release Notes, which are available in
the manual Release Notes.
5.
The RFC Server can run as a service under Windows. In UNIX, you can either use the ServiceManager or
start using the command nohup.
The RFC Server can be called with the Java Application Launcher using the following parameters
(optional):
File name
Start parameter
Description
ucxsapc.jar
Path and name of the INI file for the RFC Server
-V
The following command-line call can be used to start the RFC Server:
java -jar ucxsapc.jar
Use the following command to start the RFC Server on a HP-UX platform (64 bit):
java -d64 -jar ucxsapc.jar
5.
Start the transaction "SMGW" with SAPGUI or log on to the Gateway Monitor via Tools -> Administration > System Monitoring -> Gateway-Monitor. Select Jump -> Registered Systems. The started server
program should be shown in system type REGISTER_TP.
Example of an Overview
LU name TP name Host name Host address
R31 sapgw00 R31
193.154.170.111
500
Chapter 8 Installation
wgntw13 uc4call
R31
6.
WGNTW13
R31
193.154.170.13
193.154.170.111
REGISTER_TP 12:11:18
REMOTE_GWY 10:25:14
Start the transaction "SM59" or log on via Tools -> Administration -> Management -> Network -> RFC
Destination. Specify a TCP/IP connection:
l
l
l
Connection type: T
Activation type: Registered Server Program
Program ID: The program ID (case sensitive) that was used in the INI file UCXSAPC.INI.
If the SAP system consists of several application servers, the SAP Gateway on which the RFC Server
registered should also be entered in the RFC destination. Otherwise, ABAP programs can only
establish a connection if they run on the same application server as the one on which the RFC Server
has registered.
Example of a TCP/IP connection
Automation Engine
20 KBytes:
30 KBytes:
501
62 msec
45 msec
A successful test result indicates that the CallAPI is ready for operation.
See also:
CallAPI for SAP
Supplied Files
The files that belong to the CallAPI are packed in TAR files. Each respective TAR file is available in the
subdirectory of the appropriate UNIX version in IMAGE:AGENTS\UNIX.
The following files are supplied with AE and form the contents of the TAR file:
File name
Description
UCXB???C
UCXBXXXC.ini
start_example.???
UCXBXXXC.c
uccall3.h
Header file for the sample program with structure and API definition
makefile_example.???
libucxb???c.a,
libucxb???c.so or
libucxb???c.sl
libssp
UCX.msl
Message library
Procedure
1.
l
l
l
Admin computer
Transfer the tar file UCXB???C.tar.gz using FTP.
Host
502
Chapter 8 Installation
l
See also:
CallAPI for UNIX
Supplied Files
The CallAPI files are found in the appropriate subdirectory of the VMS variant under
IMAGE:CALLAPI\VMS.
File name
Description
UCXBV??C.EXE
UCXBVXXC.INI
API_START.COM
UCXBVXXC.C
UCCALL3.H
Header file for sample program with structure and API definition
MAKEXAMP.COM
UCXBV??C.OLB
Automation Engine
UCX.MSL
503
Message library
Procedure
1.
l
See also:
CallAPI for VMS
504
Chapter 8 Installation
Supplied Files
File name
Description
sample1.jcl
sample2.jcl
ucx.msl
ucxbvse.bin
ucxbvse.ini
Configuration file
ucxbvse.punch
Procedure
Adjust the supplied INI file to the values of your installation.
You can keep your existing INI file even if there is a new Automation Engine version. It might be
required to adjust it. More detailed information is provided in the Release Notes, a collection of which is
found in the manual Release Notes.
First, a library should be created in the VSE. It is called "PRD2.UC4" in this document. You can, of
course, select any name of your choice. The library can be created with a job using the utility LIBR:
* $$JOB JNM=CREATE,CLASS=A,DISP=D
* $$LST CLASS=A,DISP=D
// JOB CREATE
// EXEC LIBR
DEFINE SUB=PRD2.UC4
/*
/&
* $$EOJ
The next step is to transfer the files to the VSE operating system. This is possible with IND$FILE or, if
available, by using FTP on the VSE computer.
If IND$FILE is not possible and no FTP is available, the program must be created using the Punch file
ucxbvse.punch.
Transfer with IND$FILE
Many 3270 emulations support the file-transfer method IND$FILE. In the IBM emulation, there are the
console utilities SEND.IND$FILE and RECEIVE. IND$FILE must be installed on the VSE in order to use
this type of file transfer. Use the following steps to confirm installation:
1. Log on to VSE in CICS.
2. Delete the CICS screen (F9 key = Escape).
3. Enter IND$
IND$FILE has successfully been installed if no error message is displayed. Press the F3 key (end IND$
transaction) and the F3 key (back to CICS menu) to get back.
If you want to execute the transfer, you should be on the deleted CICS screen with the 3270 emulation. If
this is not possible for reasons of security, you can change to a transfer mode using the menu items 3
(Operations), 8 (Personal Computer Move Utilities) and 6 (PC File Transfer).
Automation Engine
505
Now switch to a console window (start CMD) on the PC and transfer the following three files using the
SEND command:
send ucx.msl
b: ucx
msl
(FILE=LIB L=PRD2 S=UC4
send ucxbvse.ini b: ucxbvse ini
(FILE=LIB L=PRD2 S=UC4
send ucxbvse.bin b: ucxbvse phase (FILE=LIB L=PRD2 S=UC4 binary
In this example, the emulation "B" was ready for transfer.
Alternately, the phase can also be created from the PUNCH file. Do so by transferring the file shown
below instead of the file "ucxbvse.bin":
send ucxbvse.punch b: ucxbvse (FILE=PUN binary LRECL=80
Change to the Punch Queue (item 3) when the PUNCH file has been successfully transferred in the
emulation via the menu items 3 (Operations) and 2 (Manage Batch Queues). Copy "UCXBVSE" with 4
(Copy to Primary Library). After a successful copying process, "UCXBVSE" can be deleted from the
Punch Queue.
Then change back to the main menu (F3 key) and move to the Primary Library with menu item 5 (Program
Development) and 1 (Program Development Library). Open the file "UCXBVSE" for editing and insert the
following JCL lines at the beginning of the file:
* $$JOB JNM=CATAL,CLASS=A,DISP=D
* $$LST CLASS=A,DISP=D
// JOB CATAL
// OPTION CATAL
// LIBDEF *,CATALOG=PRD2.UC4
INCLUDE
Add the following JCL lines at the end of the file:
// EXEC LNKEDT
/*
/&
* $$EOJ
Save the modified file and start the created job with 7 (Submit). The phase "UCXBVSE.PHASE" should be
available in the library "PRD2.UC4" if the job has been processed successfully.
FTP Transfer
For an FTP file transfer, it is necessary to have an FTP server installed on the VSE. Open a console
window on the PC and transfer the files by FTP client to the VSE:
ftp vse.mycompany.com
cd PRD2
cd UC4
put ucx.msl
put ucx.bvse.ini
bin
put ucxbvse.bin ucxbvse.phase
quit
Use
If the INI file has not yet been adjusted on the PC, do so by logging on to the CICS with the 3270
emulation. Change to an empty CICS screen with the F9 key. Enter DITTO and change to the "LDL Library Directory List" mask using menu items 5 (Work with VSE libraries) and 2 (List directory). Enter the
library PRD2.UC4. Use the cursor to move to the member "UCXBVSE INI", press the F4 key. The
member can now be edited with menu item 4.
506
Chapter 8 Installation
Enter the server data for the installation (section server). If required, you can specify a default user for the
CallAPI in the USER section.
See also:
CallAPI for VSE
Supplied Files
The files are stored in the directory IMAGE:CALLAPI\WINDOWS.
File name
Description
UCXBWI3C.DLL
CallAPI
UCXBXXXC.EXE
UCXBXXXC.INI
UCCALL3.BAT
UCCALL3.VBS
Example (Visual Basic Script) for using the CallAPI with OLE
UCCALL3.H
UCXBWI3C.LIB
ZU00132.DLL
UC.MSL
Message library
Procedure
1.
This installation step can be ignored if the package is already available in the required version. Go to
Control Panel -> Add or Remove Programs to see if the package is available, and if so, which version.
l
Automation Engine
l
l
507
Using OLE
Install the library UCXBWI3C.DLL using the program REGSVR32. This program is available in the
Windows system directory by default. The following is an example for the command line:
c:\windows\system\regsvr32 c:\AUTOMIC\callapi\bin\ucxbwi3c.dll
See also:
CallAPI for Windows
Requirements
l
l
l
l
WebSphere MQ Queue Manager Server to create queues for the call interface
WebSphere MQ Queue Manager Server for the API calls
WebSphere MQ Queue Manager for MS Windows, Version 5.2.1 or later
License Connect for WebSphere MQ
Supplied Files
Call Interface files are available in the directory IMAGE:FRAMEWORK\MQSERIES\WINDOWS.
File name
Description
UCXBMQCS.EXE
UCXBMQCS.INI
UC.MSL
Message library
ZUXML1.DLL
ZU00132.DLL
For installation, call the installation program SETUP.EXE from the directory of the supplied AE CD. If the
CallAPI should automatically be activated with each system start, Automic recommends using the
Service Manager. Connect can be started and ended as a service in the ServiceManager.
508
Chapter 8 Installation
Technical Implementation
Technical implementation
These applications place their activation requests for an AE script to the AE queue of the WebSphere MQ
Queue Manager. Connect regularly checks the contents of this queue. If there is a request in the queue, it
is forwarded to the Automation Engine. The Automation Engine processes the script and reports the result
to Connect for WebSphere MQ. Connect for WebSphere MQ converts this result and forwards it to the
Message Queue Manager which then updates the corresponding request and reports status and result to
the application.
Starting Operation
Connect for WebSphere MQ must be installed on a system on which an WebSphere MQ Queue Manager
Server is running. A WebSphere MQ Queue Manager Server must be available to set and configure the
CallAPI queue.
Step
1. Set up queues for AE with WebSphere MQ Queue Manager Server.
2. Install Connect for WebSphere MQ using SETUP.EXE from the delivery directory.
3. Adapt Connect for WebSphere MQ's INI file.
4. Start Connect WebSphere MQ.
5. Test request to AE with WebSphere MQ Queue Manager.
6. Enter Connect WebSphere MQ to ServiceManager.
See also:
About the CallAPI
Automation Engine
509
Host
The setup and configuration of WebSphere MQ (Queue Manager, Queues, Channels) components
takes place either with WebSphere MQ Explorer or through command programs.
Set up Queue Manager with the name "queue.manager1."
crtmqm -q queue.manager1
Start the command processor for WebSphere MQ commands. Note: No prompt will be displayed.
runmqsc
Set up the request queue for AE with a maximum message length of 4096 bytes.
define qlocal ('UC4CInputQueue') maxmsgl (4096)
Host
Start the SETUP.EXE program in the IMAGE:FRAMEWORK\MQSERIES\WINDOWS\Wi3_INTL
directory. The drive can be changed if necessary. Enter the installation BIN directory from
WebSphere MQ Queue Manager Server. Start installation by clicking the large button (computer,
package and diskette).
The AE Connector is entered into the AE program group. If no program group is available, a new one
is applied.
3. Adapting the AE Connector INI file
Host
The AE Connector INI file must be re-adjusted according to the WebSphere MQ Queue Manager
and the Automation Engine system environments.
4. Starting the AE Connector
Host
The AE Connector can now be started for testing. The AE Connector can be called from the AE
program group or started directly as a program in the installation directory. If the name of the INI file
has been changed, the AE Connector startup call must be expanded in the AE program group with
510
Chapter 8 Installation
l
l
the file name of the current INI file as a parameter (-I <INI file>). Another way to start AE Connector
is to enter the command directly in the Windows Start menu, after clicking Start, and then by
clicking Run. In order for these methods to work properly, it is required that the absolute file names
of the EXE- and INI files (with complete directory path specification) are entered.
Check the AE Connector log file. It should not contain any error messages.
If the AE Connector cannot be started, check the log file, and, it appropriate, the trace file. To
conduct an extensive error search, set extra trace flags in the AE Connector INI file. Detailed
information in the trace file can help you trace an error to its root cause.
5. Testing a request to AE via WebSphere MQ Queue Manager
l
l
Host
A request to AE can now be written in the request queue, by using either resources in WebSphere
MQ or an application intended for that purpose.
If this request corresponds to a valid AE call, the AE Connector connects to the Automation Engine
and forwards the request.
Execution of the request is logged in the log file and, when necessary, in a more detailed fashion in
the AE Connector trace file. It can be monitored there.
Any errors that occur during processing should be addressed.
If the tests were successful, the AE Connector can be closed.
6. Entering the AE Connector into the ServiceManager
l
l
Host
If it is necessary for the AE Connector to activate automatically when the system starts, it should
be entered into the ServiceManager.
If no ServiceManager is present on the system, it must first be installed.
The simplest way to enter the AE Connector in the ServiceManager is to duplicate an existing
service and modify its settings. To do this, however, special authorization is necessary. It is also
possible to enter the AE Connector in the SMD file of the ServiceManager and then to start or
restart the ServiceManager service.
Because the order in which services start during the Windows boot process cannot be modified,
you must enter enough time in the "Seconds delayed" field in the AE Connector settings to ensure
that the WebSpere MQ Queue Manager is active before the AE Connector starts.
See also:
About the CallAPI
Supplied File
The AE.ResourceAdapter file is found in the folder ApplicationInterface.
File name
Description
AEResourceAdapter.rar
AE.ResourceAdapter
Automation Engine
511
Procedure
1.
l
l
l
l
l
l
Host
Log on to the IBM Integrated Solution Console.
Select the menu item Resources -> Resource Adapters. A list of all installed resource adapters is
displayed.
Click Install RAR. Enter the path to the file AEResourceAdapter.rar and click Next.
Click OK, and then click Save to store your modification in the "master configuration."
The AE.ResourceAdapter is now included in the list of installed resource adapters.
512
Chapter 8 Installation
2.
l
l
l
Host
Select the menu item "J2C connection factories" and then click New in order to create a new
connection factory.
Select the file AEResourceAdapter.rar as provider and complete the fields "name" and "JNDI
name."
Automation Engine
3.
l
513
Host
Click on the connection factory and select the link "Connection pools."
Set the number of "minimum connections" to 0.
In "Purge policy," select the entry "Entire pool."
Confirm OK to confirm your modifications.
Click the link "Custom Properties." The connection factory's AE-specific properties are displayed in
a table. Values can be changed by clicking on them. Adjust the Server name and port number
(computer and port number of one of your AE system's communication processes). The other
properties are used in "Container Managed Sign On."
Click Save to store your modifications.
l
l
l
l
l
514
Chapter 8 Installation
Installation
Installing the AE.Internal Webservice (Glassfish)
The following steps are required for installing and configuring the AE.Internal Webservice on a Glassfish
application server.
Supplied File
The AE.Internal Webservice file is available in the directory IMAGE:WEBSERVICE
File name
Description
UC4WS.WAR
Internal Webservice
Procedure
1.
l
l
l
Host
Log on to the administrator console.
By default, the file Realm is used. Create a new user under Configuration ->Security -> Realms >file.Enter "uc4" as the group.
Select the menu item "Applications" -> "Web Applications" and click "Deploy..." in the right
window.
Under "Location", select the file UC4WS.WAR. By default, the context root is "uc4ws". You can
change it in the area General. Then click OK.
When deployment has been successful, the tree on the left displays the Internal Webservice under
"WebServices".
WSDL is available via the following link:
http://Server name:Port/uc4ws/uc4ws?wsdl
2.
l
l
Host
Call the Configuration Web Interface via the following link:
http://Server name:Port/uc4ws/admin
In "Communication Process(host:port)", specify at least one communication process in the format
"Server name:Port".
You can also store a default user and select the operations that he/she can use on the right.
In the area Session Handling, determine the connection settings to the Internal Webservice.
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
Automation Engine
515
See also:
Using the Webservice
Supplied File
The AE.Internal Webservice file is available in the directory IMAGE:WEBSERVICE
File name
Description
UC4WS.WAR
AE.Internal Webservice
Procedure
1.
l
l
l
l
l
l
l
Host
Log on to the administrator console.
Create the new Group "uc4" under Security -> Users and Groups. Assign one or several users to
this Group.
Click on the link "Deploy new Applications".
Click "Browse" under "Archive" and select the file UC4WS.WAR. Activate the option Start app
after install. Click "Install".
After successful installation, the message "The application started successfully" is output.
WSDL is available via the following link:
http://Server name:Port/uc4ws/uc4ws?wsdl
2.
l
l
Host
Call the Configuration Web Interface using the following link:
http://Server name:Port/uc4ws/admin
In "Communication Process(host:port)", specify at least one communication process in the format
"Server name:Port".
You can also store a default user and select the operations that he/she can use on the right.
In the area "Session Handling", determine the connection settings for the Internal Webservice.
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
516
Chapter 8 Installation
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
See also:
Using the Webservice
Supplied File
The AE.Internal Webservice file is available in the directory IMAGE:WEBSERVICE
File name
Description
UC4WS.WAR
Internal Webservice
Procedure
1.
l
l
l
Host
Assign the role "uc4" to a user. It will be used in the file web.xml. This procedure depends on the
Realm you use. For testing purposes, you can also store the users in a file. Instructions are
available on the JBoss Community Homepage.
Copy the file UC4WS.WAR to the deploy directory.
After deployment, a log message is output which is required in order to register the Internal
Webservice.
WSDL is available via the following link:
http://Server name:Port/uc4ws/uc4ws?wsdl
2.
l
l
Host
Call the Configuration Web Interface using the following link:
http://Server name:Port/uc4ws/admin
In "Communication Process(host:port)", specify at least one communication process in the format
"Server name:Port".
You can also store a default user and select the operations that he/she can use on the right.
In the area "Session Handling", determine the connection settings for the Internal Webservice.
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
Automation Engine
517
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
See also:
Using the Webservice
Supplied Files
The Internal Webservice file is available in the directory IMAGE:WEBSERVICE
File name
Description
UC4WS.SCA
Internal Webservice
Procedure
1.
l
Host
Copy the file "UC4WS.SCA" to the incoming directory of the Java Support Package Manager (for
example, C:\usr\sap\trans\EPS\in).
Start the Java Support Package Manager (JSPM) and log on to the JEE engine.
In "Start Deployment", select the option New Software Components for the item "Select Package
Type" (step 1). Click Next.
In the step "Specify Queue", the AE Webservice is listed under "Select new components to
deploy".
The installation process has been successful if the AE Webservice is displayed and shows the
status "DEPLOYED". Click Exit to end the program.
Open the WSDL file to check whether the AE.Internal Webservice has successfully been set up.
The WSDL is available via the following link:
http://Server name:Port/uc4ws/uc4ws?wsdl
2.
518
Chapter 8 Installation
l
Host
Additional authorizations are required to access the Configuration Web Interface of the AE.Internal
Webservice. Log on to the SAP Netweaver's User Management Configuration.
Create the new role "uc4" and assign it to a user. This role must include the following assigned
actions: "uc4" and "$SAP_J2EE_Engine_Upload" (type: J2EE and J2EE MODULE).
See also:
Using the Webservice
Description
Automation Engine
Field/Element
Description
Communication
Process (host:port)
519
"Server name:Port"
Server name - Name of the computer on which the communication process is
available
Port - Port of the communication process
You can also specify several communication processes. Separate them
with a semicolon.
Example:
"Server1:2217;Server2:2218"
Client
Client
User
User name
Department(optional)
Department
Password
Password
The number of stars does not refer to the password length.
Language
Language
Allowed values:
"E"(English, default value), "D" (German) or "F" (French)
If a not allowed value has been specified for this parameter, the login will fail.
Session Handling
Connection Timeout
Waiting Connections
Open Sessions
Operation
Name of the operation
Select the operations which can be processed with the default user.
The operations logon and logoff are always available.
E-mail Connection
The Email connection facilitates the sending of emails either when a Notification object starts or when the
script function SEND_MAIL is used. This function has been implemented in the Automation Engine and in
520
Chapter 8 Installation
Windows, UNIX and Java agents (SAP, RA, JMX and SQL).
The MAPI2 interface ofWindows agents is no longer available as of version 9.00A.The only supported
email interface now is SMTP.
General Information
Only configure the Email connection for the AutomationEngine, it applies automatically for all agents that
support the sending of emails (Windows, UNIX, SAP, RA, JMX, SQL). The System Overview includes
the value "MAIL" in the "Service" column of all these agents.
Depending on the situation in which you send an email, either the Automation Engine or an agent is used.
Ensure that they can access the relevant directory if you attach files.
Send by using
Email connection
Notification object
(type "Email" or "Alarm", "Request", "Message" with the option "Send E-mail")
The
AutomationEngine
is used to send the
emails.
Exception: If
external job output
files of Jobs are
attached
(Notification tab Attach reports
from), the email is
sent via the agent
on which the job
has been
executed. The
notification aborts
if the agent is not
active, if the files
cannot be found or
if the user does not
have the required
authorizations (the
right "P" for the
autorization types
"JOBS" and
"EXTREP").
Mails are
exclusively sent
via the
AutomationEngine.
Notification objects abort with a corresponding message when the sending of an email fails.
With SEND_MAIL, script processing continues if an error occurs. Despite this fact, you can use the script
function :ON_ERROR and define an appropriate reaction.
Automation Engine
521
The successful sending of emails is logged in the reports of the Notification objects. The script element
SEND_MAIL does not output any information in the activation protocol. However, you can check the
return code of this function and output a corresponding message.
Configuration
Configuring the AE E-mail connection
l
l
Cluster
Automation Engine and Clusters
Clusters group computers in order to achieve increased computer capacity or workload distribution. AE
can also run in a cluster.
Installation and configuration for a cluster are almost the same as they are for an individual computer. The
most important steps are listed below. Other settings in the cluster itself depend on the cluster software in
use.
Automation Engine
It is useful to integrate your Automation Engine in a cluster if it has only been installed on one computer.
1. Install the Automation Engine in a separate directory.
2. Enter the cluster's virtual IP address in the INI-file parameter hostname= (section [TCP/IP]).
3. Install the ServiceManager on all the cluster's computers in order to ensure that the Server
processes can be started if the computer is changed. The ServiceManager must be available as a
cluster service.
Agents
Agents can also run in a cluster.
1. Install the agent in a separate directory.
2. Enter the cluster's virtual IP address in the INI-file parameter UC_EX_IP_ADDR (section
[VARIABLES]).
3. Install the ServiceManager on all the cluster's computers in order to ensure that the agents can be
started if the computer is changed. The ServiceManager must be available as a cluster service.
Example: Microsoft Cluster
Keep the following instructions in mind when installing a Windows agent in a cluster:
522
Chapter 8 Installation
There are two different installation types. The ServiceManager and the agent are either installed on a
shared disk (Type 1) or the ServiceManager is installed on a local disk and the agent on a shared disk
(Type 2).
Type 2 does not require you to switch the cluster group during the installation. The ServiceManager must
be installed on each node.
Type 1:
l
l
l
l
Install the Windows agent and the ServiceManager on a shared disk of the Microsoft Cluster.
Perform the installation first on the primary node and, after switching the disk, on the secondary
node in the same directory.
Enter the cluster's virtual IP address in the agent's INI-file section [VARIABLES]. Do so using the
variable UC_EX_IP_ADDR.
Register the ServiceManager as a service (command "UCYBSMGR install Phrase"). Leave the
start type set to "Manually"; do not set it to "Automatically". Start this procedure on the computer on
which the second installation was made, then switch the disk and continue on the primary node.
In the MSCS, define the Automic ServiceManager.Phrase as resource type "Generic Service".
Select the dependencies' shared disk and, if required, the IP address assigned to the group.
If the agent needs to use particular settings, use an extra variable for the Host characteristics.
Type 2:
l
l
l
l
l
l
l
l
l
l
l
See also:
AE system in a Windows Cluster
Automation Engine
523
Preparations
l
l
l
l
l
l
l
l
Configuring AE in a Cluster
1.
l
AE Service
524
Chapter 8 Installation
Definition of dependencies:
The AE Service starts depending on disk S (SQL Server) and X (AE), TCP/IP and the SQL Server's
services.
Service name:
Automation Engine
525
Enter the exact name of the service here (see service name in the Windows Service's properties).
Start parameters are not required.
2.
l
File share:
File sharing is defined in the cluster in order to provide central access to the AE CD via the two
cluster nodes. Create a new resource of type "File Share." Name used in order to release the
Automation Engine Documentation: AEDOCU.
526
Chapter 8 Installation
Definition of dependencies:
The AE service starts depending on disk S (SQL Server) and X (AE), TCP/IP and the SQL Server's
services.
Automation Engine
3.
l
The following illustration shows an overview of the cluster configuration in the Cluster
Administrator. The cluster group "AE SQL" contains the group members' current states and
resources.
Active resources:
See also:
AE and Cluster
527
528
Chapter 8 Installation
Procedure
1.
l
l
Admin computer
Log on to system client 0000 with the supplied AE User (name: UC, department: UC, password:
UC).
This user is supplied with all rights. It is therefore crucial to change the password immediately in
order to avoid unauthorized logons to your AE system.
AE considers time zones in its processes. The system client already contains TimeZone objects.
You can create additional ones if needed. These objects can then also be used in other clients you
create.
Create a new client by clicking on the button in the toolbar. A window that displays all the
available object types opens. Select the type Client (CLNT).
Do not assign a name but open the Client object. Several specifications can be made in
theAttributes tab (such as TimeZone).
An object's attributes can be modified later. The object can either be modified in the client itself
(folder <No folder>) or via the system client's System Overview.
Store the Client object and assign a name to it. Select a number between 0001 and 9999. This is
then the client number that is used to log on to the system.
Note that the Client object is moved to the client environment immediately after it is renamed.
After it is moved, the client can only be deleted using the utility AE.DB ClientCopy.
Create additional clients if required. A user must be available in each client in order to log on to it.
2.
l
l
l
Admin computer
The first user of a newly created client must be created in the system client.
Click the
button in the toolbar and a window that displays all the available object types opens.
Select type User (USER).
Assign a name for the User object. This name also serves as the user's login name. The name of
the User object is a combination of the user name and the user department, separated by a slash. A
maximum of 200 characters is allowed for this combination (for example, SMITH/AE).
Open the User object and assign the appropriate rights and privileges. Then save and close the
object.
Assign the new user to a client. Click Move User to Client... in the context menu. Enter the client
number in the window that opens. The User object is moved to the client.
Additional users can be created in the client when the user is logged in and authorized.
3.
Automation Engine
l
l
529
Admin computer
AE provides a comprehensive authorization system that consists of several areas that can be
adjusted to your system environment as required.
The authorization system is not based on folder authorizations but rather on object names.
Automic recommends using naming conventions for objects that your create in your AE system.
You can assign limited rights for objects that have names that start with a particular string, for
example. Assigning and limiting rights and privileges this way makes it easier to set up a clear
authorization structure.
Automic strongly recommends reading the chapter about the AE authorization system in order to
become familiar with all possible settings.
General
Function
Description
Getting Started
Utilities
Database
Function
Description
Database Maintenance
Database - Overview
Settings
Function
Description
Settings in
variables
Various settings can be used to adjust AE to your environment. The most important ones
affect the whole AE system (UC_SYSTEM_SETTINGS), individual clients (UC_
CLIENT_SETTINGS) and agents (UC_HOSTCHAR).
Using
AE processing considers TimeZones.
TimeZones
in AE
Changing
the Time
530
Chapter 8 Installation
Server
Function
Description
Multi-Server
Operation
Number of Server
Processes
Dialog Process
Description
System Overview
ServiceManager
Handling Agents
Agent Variables
Start Parameters
CallAPI
Auditing
Function
Description
Revision Report
User
Function
Description
Automation Engine
531
Authorization System
Procedure
1.
l
Downloading a Hotfix
Log on to the Customer Zone of the Automic homepage (www.automic.com/4customer). The first
page includes a link to the latest hotfix. You can either use FTP or http to download it.
Open the folder that corresponds with your Automation Engine version. Download the hotfix for the
relevant component.
2.
l
l
l
l
Installing a Hotfix
532
Chapter 8 Installation
l
l
l
l
l
l
Automic recommends installing one common hotfix version for initial data, Server processes and
UserInterfaces.
l
l
l
l
l
l
l
8.3.3 Utilities
Installing Utilities (UNIX)
This document describes the hotfix installation procedure for the utilities.
Because all AE OperationsManager utilities are programmed in Java, Sun Java 2 JRE (Java Runtime
Environment) is a prerequisite for utility installation.
Automation Engine
533
A three-figure code is supplied for each supported UNIX platform because the utilities for UNIX are
available for different platforms. The codes are described in the Terminology. In this document, thespecific
code is replaced using the characters "???."
Requirements
l
Supplied Files
The utility files are supplied in compressed form (util???.tar.gz) and are stored in subdirectories of
IMAGE:UTILITIES\UNIX. Subdirectory names represent the supported platforms.
*.sh: normal utility start
Without file ending: programs for batch call
File name
Description
UCYBDBar.jar
AE DB Archive
(archiving the
database)
ucybchng
AE.DB Change
(editing exported
data)
UCYBDBcc.jar
AE DB Client
Copy (copying and
deleting clients)
UCYBDBLd.jar
AE DB Load
(loading the
database)
UCYBDBre.jar
AE DB Reorg
(reorganizing the
database)
UCYBDBRR
AE.DB Revision
Report (creating
revision reports)
UCYBDBUn.jar
AE DB Unload
(unloading the
database)
UCYBLGMX
AE.LogMix
(combination of log
and trace files)
ucyrepg.jar
AE.Reporting
Tool (defining
queries)
uc.msl
Message library
UC4LAF.jar
534
Chapter 8 Installation
*.ini
Initialization files
for the utilities
*.sh
Runtime libraries
File ending with"a"
indicates AIX
File ending with"sl"
indicates HP-UX
File ending with
"so" indicates
Solaris, Linux and
zLinux
Procedure
1.
This installation step can be ignored if the required version of JRE is already installed.
l
Admin computer
Use the following command to check which version of the Java Virtual Machine (VM) is currently
installed:
java -version
If multiple JRE or Java SDK Versions are installed on the computer, make sure that the directories
are in the proper order in the settings of %PATH% or $PATH. The Java Runtime Environment that
is first in the list of directories is used.
Download the required Java Runtime Environment from http://java.sun.com and install it.
2.
l
l
l
Admin computer
Log on using the user ID AE.
Transfer the TAR file util???.tar.gz via FTP.
Be sure to rename your INI files if you did not rename them during the first-time installation. The
INI files are overwritten when the TAR file is unpacked.
Unpack the tar file:
gzip -d util???.tar.gz or gunzip util???.tar.gz
tar xvfo util???.tar
Adjust the INI files to your system environment. Compare your INI files to those supplied with the
installation and refer to the Release Notes to obtain further information about adjustments that
might be required.
Automation Engine
535
Supplied Files
The utility files (Windows) are stored in the directory IMAGE:UTILITY\WINDOWS.
*G.EXE - Java loader for the utility
*.EXE - Program for batch request
*.BAT - Batch file for utilities
File name
Description
UCYBARBR.EXE
AE.Archive Browser
(searching the archive
files)
UCYBCHNG.EXE
UCYBDBRR.EXE
AE.DB Revision
Report (creating
revision reports)
UCYBDBCC.JAR
AE DB Client Copy
(copying and deleting
clients)
UCYBDBAR.JAR
AE DB Archive
(archiving the database)
UCYBDBLD.JAR
AE DB Load (loading
the database)
UCYBDBRE.JAR
AE DB Reorg
(reorganizing the
database)
UCYBDBUN.JAR
AE DB Unload
(unloading the database)
UCYBDBRT.EXE
AE.DBReporting Tool
(defining object queries)
AE DB Reporting Tool
(graphical interface for
creating the query files)
UCYBLGMX.EXE
AE.LogMix (combines
log and trace files)
UC.MSL
Message library
UC4LAF.JAR
536
Chapter 8 Installation
*.INI
CALLHTMLHELP.DLL,
CBLRTSS.DLL,
UCCACHE.DLL,
UCDBUP.DLL,
UCSBEPM.DLL, UCUCLI.DLL, UCUDB32.DLL, UCUOCI.DLL,
UCUODBC.DLL, UCYBCLICPY.DLL, UCYDBARCHIVE.DLL,
UCYDBREORG.DLL, UCYBDBLD.DLL,
UCYBDBUN.DLL, UCZU01.DLL, ZU00132.DLL, ZUXML1.DLL
COMDLG32.OCX, MSCOMCTL.OCX, RICHTX32.OCX
ActiveX Controls
SETUP.EXE
Installation program
Procedure
1.
This installation step can be skipped if the required version of JRE is already installed.
l
Admin computer
Use the following command to check which version of the Java Virtual Machine (VM) is installed:
java -version
Ensure that the order of the indicated directories is correct in the settings of %PATH% or $PATH if
several JRE or Java SDK Versions have been installed on the computer. The Java Runtime
Environment that is found first in the listing of directories is applied.
Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. It can
be deactivated in the system control because AE does not require it.
2.
Admin computer
Start the program SETUP.EXE in the directory IMAGE:UTILITY\WINDOWS. The utilities including
the relevant INI files and the runtime system are written to the installation directory.
3.
l
l
Admin computer
Data source AE must be set for ODBC access (ODBC32).
Adjust the utility's INI files if recommended in the current Release Notes. Refer to the INI files that
are supplied with the update installation.
Automation Engine
537
Each utility has only one INI file that includes the parameters. The INI file names are:
AE DB Archive (UCYBDBAR.ini)
AE DB Change (UCYBCHNG.INI)
l
AE DB Client Copy (UCYBDBCC.ini)
l
AE DB Load (UCYBDBLD.ini)
l
AE DB Reorg (UCYBDBRE.ini)
l
AE DB Unload (UCYBDBUN.ini)
l
AE.Reporting Tool (UCYBDBRT.INI)
The INI files have the same name as the appropriate utility
l
l
l
l
A security check (single logon) is made if the utilities AE DB Client Copy, AE DB Archive and
AE DB Reorg are called in batch mode. The utility aborts if the target client of the AE system does
not include a User object for the user who has logged on to the OS. Note that this happens
regardless of any specifications that may have been made in the AE variable UC_USER_LOGON.
For example: The user Smith of the AE domain requires the User object SMITH/AE in the target
client.
Procedure
1.
l
l
Changing the database scheme and loading new initial data to the database
Server computer
All server processes must be stopped. Pay special attention if server processes run on
several computers. The following steps must only be processed when all server processes
have been stopped.
Admin computer
538
Chapter 8 Installation
The directory containing the database files must be stored at the location that has been specified
in the INI-file parameter INPUT of the utilityAE DB Load. The folder that includes the BIN directory
of the utilities is the default folder.
Windows example:
Utility in C:\AUTOMIC\UTILITY\BIN
Utilities - Windows:
The files for the AE database are provided in IMAGE:DB. Copy the complete DB folder to the above
directory
Utilities - UNIX:
The database files are included in the archive db.tar.gz which is provided in the folder IMAGE:DB.
To unpack the archive, use the following commands:
gzip -d db.tar.gz bzw. gunzip db.tar.gz
tar xvfo db.tar
(Linux: tar -zxvf db.tar.gz)
Copy the unpacked files to the defined directory.
Start the program AE DB Load to update the database.Select the file <DB
directory>\GENERAL\<vers>\UC_UPD.TXT
The current database version is identified and the database updated. As this happens, the database
structure and data are changed. Objects of client 0000 are automatically replaced or amended.
2.
Admin computer
The utility AE.DBLoad displays a mask in which you must select an authentication method.
This mask is only displayed if the database is updated to a new Automation Engine version.
3.
Admin computer
A mask opens in which you can select the settings for partitioning with ILM. This step is optional.
Automation Engine
539
General Requirements
l
l
l
Root authorization during installation. Not required in order to operate the Automation Engine.
After installation, no reboot of the UNIX System is necessary.
Your own UNIX user ID for the Automation Engine (Default: uc4, Home = /opt/uc4/server, Shell:
ksh). The shell is only necessary during installation.
Supplied Files
The files of the Automation Engine for UNIX are supplied in compressed form. The TAR file is found in its
respective UNIX platform subdirectory in IMAGE:AUTOMATIONENGINE\UNIX\.
UCS???.tar.gz ... Files of the Automation Engine
File name
Description
ucsrvcp
Communication
process of the
Automation Engine for
UNIX
ucsrvwp
uc.msl
Message library
ucsrv.ori.ini
Runtime libraries
syntax.bin
Procedure
1.
l
l
l
Server Computer
Note that all Server processes must be ended before the updating process starts. This
is particularly important when Server processes run on several computers.
Log on as AE.
Transfer file ucs???.tar.gz from /cdrom/cdrom0/<version>/Server/unix/<platform> using FTP
(binary).
540
Chapter 8 Installation
l
Server Computer
If necessary according to the current Release Notes, adjust the Automation Engine's INIfile. Refer
to the ini file ucsrv.ori.ini, which is supplied with the update installation.
Requirements
l
Supplied Files
The Automation Engine files are found in the IMAGE:AUTOMATIONENGINE\WINDOWS directory.
File name
Description
UCSRVCP.EXE
Communication
process of the
Automation Engine
for Windows
UCSRVWP.EXE
UC.MSL
Message library
UCSRV.INI
Configuration file of
the Automation
Engine for Windows
AE runtime system
for Windows
Installation program
Automation Engine
541
Procedure
1.
l
l
l
Server computer
Note that all server processes must be ended before you start the updating process. Special
attention is required when server processes run on several computers.
The folders BIN and TEMP already exist from the previous installation.
Start the program SETUP.EXE in the directory IMAGE:AUTOMATIONENGINE\WINDOWS.
2.
l
Server computer
If recommended in the current Release Notes, adjust the Automation Engine's INI file. Refer to the
INI file UCSRV.ORI.INI, which is supplied with the update installation.
Requirements
l
Supplied Files
The UserInterface files are found in the directory IMAGE:USERINTERFACE\UNIX. The individual files
are combined in the ucdj.tar.gz file.
File name
Description
UCDJ.SH
Start script
for calling the
UserInterface
UCDJ.INI
Call options
for the start
program
UCDJ.BAT
542
Chapter 8 Installation
UCDJ.JAR
UserInterface
in Java
UC4CONFIG.XML
Configuration
file for
connecting to
the AE
systems
LOGIN_DAT.XML
Configuration
file for user
login to the
AE system
UC.MSL
Message
library
Files for
calling help
with the F1
key
CONFIGREF.CLASS
Configuration
class
Interface
layout
UC4.WAV
UCXJPS84.JAR
File with
specific Java
classes for
the
PeopleSoft
forms
AE-RA.JAR
RA
Framework
INTELLISENSE.JAR
Procedure
1.
Automation Engine
543
Skip this installation step if the required version of JRE is already installed.
l
Download the required Java Runtime Environment from http://java.sun.com and install it.
2.
l
l
544
Chapter 8 Installation
Supplied Files
The UserInterface files are found in the IMAGE:USERINTERFACE\WINDOWS directory.
File name
Description
UCDJ.EXE
Start program
for calling the
UserInterface
UCDJ.INI
Call options
for the start
program
UCDJ.BAT
UCDJ.JAR
UserInterface
in Java
UC4CONFIG.XML
Configuration
file for
connecting to
the AE
systems
LOGIN_DAT.XML
Configuration
file for user
login to the
AE system
UC.MSL
Message
library
Files for
calling help
with the F1
key
CONFIGREF.CLASS
Configuration
class
Interface
layout
UC4.WAV
SETUP.EXE
Installation
program
Automation Engine
545
UCXJPS84.JAR
File with
specific Java
classes for
the
PeopleSoft
forms
AE-RA.JAR
RA
Framework
INTELLISENSE.JAR
Procedure
1.
If the required version of JRE is already installed, this installation step can be omitted.
l
Use the following command to check which version of the Java Virtual Machine (VM) is installed.
java -version
If several JRE or Java SDK Versions are installed on the computer, make sure that the order of the
directories in the settings of %PATH% or $PATH is correct. The Java Runtime Environment that is
found first in the list of directories is used.
Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can disable it in the system control; AE does not need it.
2.
546
Chapter 8 Installation
4..
To execute the UserInterface, you can either use the file UCDJ.EXE orUCDJ.BAT.
Ensure that there is sufficient memory for the Java application UCDJ.JAR . Otherwise, the
UserInterface might come to a standstill of the UserInterface. Automic recommends increasing the
value of the Java start parameter -Xmx in the file UCDJ.INI (for calls via UCDJ.EXE)or UCDJ.BAT to
1024MB.
To run the UserInterface by using an *.EXE file, you must have installed a 32-bit Microsoft Visual CRuntime Library.
The path of this directory must be entered in the configuration files of all Dialog Programs. The
default value "..\..\DOCUMENTATION" only points to the correct location when the documentation
is installed in the local AE directory.
Requirements
l
l
Automation Engine
547
Description
x.xxx.UCX2?.LIB
Program Library
Library Elements
UCXBB2?C
CallAPI Utility
UCXEB2?U
UCXJB2?
Agent
UCXJB2?M
UCYBRFC?
x.xxx.UCXJB2?.INI
x.xxx.UCXEB2?U.INI
x.xxx.UCYEBXXZ
x.xxx.E.UCXJB2?
x.xxx.E.UCXEB2?U
x.xxx.UCX.MSL
Message Library
The CallAPI files and CallAPI implementation are described in a separate document.
Procedure
1.
l
l
l
Admin computer
Transfer the TAR file UCXJB2?.TAR or UCXJB2?NK4.TAR via FTP in text mode.
As an alternative, the TAR file can also be transferred to BS2000 with FTBS2000 or the EDT file
transfer (also in text mode).
2.
Host
The TAR file can be unpacked in two ways:
1. Unpack with BS2 TAR:
548
Chapter 8 Installation
/FILE UCXJB2?.TAR,LINK=TAR or /FILE UCXJB2?NK4.TAR,LINK=TAR
/EXEC BS2-TAR
2. Unpack with BS2 TOOLS:
Show $UC4. Enter the command TAR into the command field next to the TAR file.
l
l
l
l
The actual installation files are then created (with the version number as a prefix). The TAR file can
be deleted after the files are unpacked.
Delete or rename existing files from the previous version (except for INI and Enter files).
Usually, the already adjusted enter job is not to be overwritten by the supplied sample job.
Changes that might be necessary in the job are recorded in the Modification Archive.
Likewise, the INI file is only to be adjusted if recommended in the Release Notes.
Remove the prefix from the installation files.
Old files might still exist after the file names are changed. Check the Release Notes for old files.
The UCXJB2?M file must be shareable and the User ID and file name must correspond to the
entry UC_EX_JOB_MD in the INI file.
The UCYBRFC? file must be shareable when the RFC mechanism is activated.
Admin computer or User computer
Adjust HEADER.BS2000, TRAILER.BS2000 and RESTART.BS2000 if necessary. See: Job Execution.
Supplied Files
The files that belong to the Database Agent are stored in the directory IMAGE:AGENTS\SQL.
Automation Engine
File name
Description
UCXJSQLX.JAR
Database Agent
UCXJSQLX.INI
UC.MSL
Message library
SETUP.EXE
549
Additionally, two empty folders (Temp and JDBC) are supplied. The Temp folder stores log files, and the
JDBC driver must be installed in the JDBC folder.
Procedure
1.
If JRE is already available in the required version, this step of the installation process can be ignored.
l
Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control. AE does not need it.
2.
Host
Create a separate directory for the agent (for example, C:\AUTOMIC\AGENTS\SQL\BIN or
UC4/AGENTS/SQL/BIN).
Copy the content of IMAGE:AGENTS\SQL to this new directory. Under Windows, you can also
use the program SETUP.EXE for the installation. It is available in the directory
IMAGE:AGENTS\SQL\WINDOWS.
3.
l
l
Host
A suitable JDBC driver must be installed for all databases the agent should use. Refer to the
particular vendor's installation guide.
Create the folder JDBC in the Database Agent's BIN folder. Copy the JDBC driver files to this
folder after successful installation.
Microsoft SQL Server
Install the driver.
550
Chapter 8 Installation
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
l
Copy the file sqljdbc.jar to the folder's JDBC directory after you have installed the driver.
The SQL Server 2000 JDBC driver cannot be used with this agent because of a program error in
the driver.
If the agent starts under Windows, you can use the OS user in order to log on to the MS SQL
database (Windows authentication). If you install the JDBC driver, you must copy the file "sqljdbc_
auth.dll" to the Agent's BIN directory. Ensure that this file's architecture complies with the
architecture of the JVM that is used (for example, x64).
Oracle
Install the driver.
Copy the file ojdbc14.jar to the folder's jdbc directory after you have installed the driver.
The JDBC driver of version 9.0.1 or earlier cannot be used with this agent because of a program
error in the driver.
MySQL
Install the driver.
Copy the file mysql-connector-java-5.0.3-bin.jar to the folder's JDBC directory after you have
installed the driver.
DB2
The JDBC driver is part of the DB2 installation. It is available in the directory SQLLIB/java (under
Windows: C:\Program Files\IBM\SQLLIB\java).
Copy the following two files shown below to the Agent's JDBC directory:
l
db2jcc.jar (JDBC Type 4 Driver)
l
db2jcc_license_cu.jar (Server license)
The JDBC driver can be downloaded from IBM's homepage.
Click the entry "DB2 Personal Developers Edition: Re-distributable JDBC Type 4 Driver."
Sybase
Install the driver (jConnect 5.5/6.05).
Copy the file jconn2.jar or jconn3.jar to the folder's JDBC directory after you have installed the
driver.
Informix
Install the driver (V3.5).
When the driver is installed, copy the files ifxjdbc.jar and ifxlang.jar to the Agent's JCDBC
directory.
Note that the agent requires Informix databases with transaction support.
Because of an Informix error, you must specify the value for the environment variable DB_
LOCALE in particular versions. The error "Database locale information mismatch" occurs if DB_
LOCALE has not been correctly set.
In this case, set the corresponding value in the Agent's INI file, section [INFORMIX], using the
parameter db_locale= (use lower case).
Example: [INFORMIX] db_locale=EN_US.CP1252
Ingres
Install the JDBC driver.
When the driver is installed, copy the file iijdbc.jar to the Agent's JDBC directory.
SAP HANA
Copy the file ngdbc.jar from the HANA client's installation directory to the agent's jdbc directory.
4.
Automation Engine
l
l
551
Oracle RAC
The agent can also be configured so that it can connect to an Oracle database in RAC.
5.
l
l
Host
Adjust the INI file UCXJSQLX.INI to the system environment.
If the agent starts under Windows and accesses an MS SQL database, you can use the relevant
Windows user in order to log on to the database. The following measures are required:
l
Install the JDBC driver as described above.
l
Agent's INI file: WindowsAuthentication=1
l
UC_HOSTCHAR_DEFAULT: ANONYMOUS_JOB=Y
l
In Database Jobs, you must specify a Login object that includes a suitable entry for the
particular agent even if you use the Windows authentication. The Login object's user and
password are neither used nor checked.
Server computer
Database Agents for Variables use the INI file of the Automation Engine. Adjust the section [DB_
SERVICE] which contains the specific parameters for the Database Agent. The Agent's INI file is
not required.
Now create a DB-type Connection object in the AE system for each database in use. You can also
create connections for different database types.
If the agent starts under Windows, you can use the Windows user in order to log on to the MS SQL
database. The corresponding DB-type Connection object requires the additional parameter
"IntegratedSecurity" to be specified (value "true").
6.
Server computer
Host
552
Chapter 8 Installation
by using the start parameter -XmX.
Specifying a value that is too low can cause the agent to crash. The default value depends on the
Java version that is used.
The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation.
l
l
Requirements
RSM8 is required if the Job's output will be transferred to AE.
Supplied Files
The GCOS8 agent files are available in binary and ASCII format. They are stored in the directory
IMAGE:AGENTS\GCOS8.
File name
File
type
UCXJGC8
UCXJGC8M
UCMSL
ascii
Message library
UCXJGC8I
ascii
Initialization file
UC4EX, UC4TM,
CANCEL.SPN, UC4, UC4EXEC.DIR, UC4EXEC.SPN,
UC4TERM.DIR, UC4TERM.SPN
ascii
Procedure
1.
Description
Automation Engine
l
l
l
Host
Create a catalog for the installation (UC4/version).
The following subcatalogs are required: DATA, EXEC, INSTALL, JCL, OUT and TMP.
2.
Admin computer
Transfer the files with FTP or Glink FTP to the corresponding sub-catalogs of the GCOS8
computer.
Subcatalog
File
DATA
UCMSL, UCXJGC8I
EXEC
UCXJGC8, UCXJGC8M
INSTALL
READ_ME
JCL
553
Host
Adapt the INI file to the system environment.
It is important to define an agent name (maximum of 32 characters) no special characters!) and to
enter the system name. Also be sure to enter the address of the primary communication process in
the section [TCP/IP] of the AE system to which the agent will connect. Use the following format:
cp=DNS name:port number or cp=TCP/IP address:port number.
Host
Host
RSM8 must be installed in order to transfer job reports to the Automation Engine. If it is not
installed, it is important to configure the following settings in order to allow the job report file to be
stored in the TMP subcatalog, because otherwise, job report transfer is not possible.
Host
RSM8 must be installed in order to enable job report transfers to the Automation Engine. If it is not
installed, the following settings must be configured, otherwise Jobs will remain stuck.
554
Chapter 8 Installation
l
l
Set the parameter RSM= in the INI file to either "N" or "X."
The section [VARIABLES] of the INI file must contain the parameter UC_EX_PATH_JCL.
Enter the JCL catalog name in that parameter.
Adjust the file UC4SIM in the JCL catalog so that it contains the catalog in which the agent
has been installed.
Note that files with the same name as the job report are created when RSM8 is not used. These
files contain basic information, such as the job name or sequence number, that can be used to view
the report in GCOS.
Important: Do not set the parameter RSM= when RSM8 is used.
5.
Host
Start the agent with the JCL from the file UC4EX.
$ident
$select
$select
$endjob
<site-ident>
&system/profile.prod/uc4
&uc4cat/jcl/uc4exec.spn
An Agent object is automatically created in the system client 0000 and stored in the folder HOST.
Host
Use the JCL from the file UC4TM to close the agent.
$ident
$select
$select
$endjob
<site-ident>
&system/profile.prod/uc4
&uc4cat/jcl/uc4term.spn
Automation Engine
555
Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.jar
ucxjjmx.ini
Configuration file
ucxbo.jar.ucc
MBean "CrystalReports"
uc.msl
Message library
setup.exe
Installation program
Procedure
1. Installing Java Standard Edition
This installation step can be omitted if the required version of Java Standard Edition is already
available.
l
Download the required Java Runtime Environment from http://java.sun.com and install it.
2. Setting up the Agent
556
Chapter 8 Installation
l
Host
Create a separate folder for the JMX agent and copy the supplied files and the subfolder "Logs" to it.
Alternatively, you can also use the program SETUP.EXE for the installation. It is available in the
supplied directory (Agent).
Several settings can be configured in order to adjust the JMX agent to your system environment. Of
particular importance are the agent and computer name, and the port of the communication process
to which the agent should connect. Configure these settings using the Agent's INI file.
3. Setting up the MBean for Business Objects XI R2 (optional)
The result is the packed file ucxbo.jar. Copy it to the folder in which the file ucxjjmx.jar is stored.
4. Starting the Agent
Use the following command to start the agent via the command line (UNIX and Windows):
java -jar -Xrs -Xmx256M ucxjjmx.jar
l
l
Host
Select the option Local Java VM in the Job object's JMX tab.
Activate the sub-items "Use existing MBean Server" and "Create new instance..."
Automation Engine
557
Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.jar
ucxjjmx.ini
Configuration file
Procedure
1.
This installation step can be omitted if the required version of JRE is already available.
l
Use the command shown below to check the system's version of Java Virtual Machine (VM).
java -version
Note that if several versions of JRE or Java SDK are installed on the computer, the order of the
indicated directories is relevant when specifying %PATH% or $PATH. The Java Runtime
Environment that is listed first is used.
No Java installation is required if the agent runs on the same computer as the WebLogic
Server (recommended).
2.
l
l
Host
Create a folder for the JMX agent (bin)and copy the supplied files.
Various settings of the JMX agent can be adjusted to your system environment. Of particular
importance are the agent and computer names and the port of the communication process to which
the agent should connect. Configure these settings using the Agent's INI file.
Copy the files wclient.jar and wljmxclient.jar from the WebLogic Server directory to the Agent's
installation folder. It must be available in the same folder as the file ucxjjmx.jar.
Start the agent with the file ucxjjmx.exe (Windows) or via the command line (UNIX and Windows)
using the following command:
558
Chapter 8 Installation
java -jar ucxjjmx.jar
l
l
l
Host
Select "Remote Java VM" in the Job object's JMX tab.
Enter the term "weblogic" in the field "Initial Context Factory."
Specify the WebLogic Server for the server URL in the format shown below:
Name of the WebLogic Server:port of the WebLogic Server
You can also run the agent without a connection to the Oracle WebLogic Server. In this case, select
the option Local Java VM and "Use existing MBean Servers" in the Job objects.
The WebLogic Server's default port is 7001.
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with RMI Connector
The following document includes information about installing and configuring J2EE/JMX agents with an
IBM WebSphere Application Server.
Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.war
Procedure
1.
l
l
l
Host
Select the menu item Applications -> Install New Application on the WebSphere interface.
Specify the path to ucxjjmx.war in "Local File System." "Context root" can be used to name the
application.
Automation Engine
559
The next window can be used to activate the option Generate Default Bindings. If required, other
settings can also be specified.
Follow the installation procedure as described. At step 4, select the option "Everyone?" in
"administrators."
560
Chapter 8 Installation
When all six steps have been completed, click Finish to complete the installation procedure. Refer
to the log to see if the installation was successful. Click Save to Master Configuration and then
click Save.
Call the menu item Applications -> Enterprise Applications. The list now also includes the Agent.
Activate it by clicking the button of the same name.
The agent can be started by using the configuration Web interface.
2.
Host
The JMX agent has a configuration Web interface which can be called with a Web browser using
the following address:
http://Server name:port/context root
Adjust the settings of the JMX agent to your system environment. The most important ones are:
l
Name for the Agent
l
Name of the computer on which a communication process is available
l
Port number of a communication process
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
3.
Automation Engine
l
l
l
l
561
Host
"Remote Java VM" must be selected in the Job object's JMX tab.
Enter the term "websphere" in the field "Initial Context Factory."
Specify the Server URL in the following format:
Host name of the WebSphere:port of BOOTSTRAP_ADDRESS
Retrieve the port number: Log on to the administrator console. Click Servers -> Applications
servers and then click on the name of your Server. Select "Communications" -> "Ports." The table
contains the entry BOOTSTRAP_ADDRESS. Use the port number shown here in the URL.
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with SOAP Connector
The following document includes information about installing and configuring J2EE/JMX agents with an
IBM WebSphere Application Server.
This installation guide applies to WebSphere version 6.0 with activated administrative security.
1.
l
l
l
Host
Select the menu item Applications -> Install new application on the WebSphere interface.
Enter the path to the file ucxjjmx.war in "Local file system." The "Context root" can be used to name
the application.
562
Chapter 8 Installation
l
l
l
In the next window you can activate the option Generate standard connections or configure other
settings.
Follow the installation procedure until the individual steps are displayed. Step 4 requires the
selection of "Everyone?" in the administrators field.
When all six steps are completed, click Finish to complete the installation process. The log shows
whether the installation was successful.
Click Store in master configuration, and then click Store.
Call the menu item Applications -> Enterprise applications. The list also includes the Agent.
Automation Engine
2.
l
l
l
563
Host
Search for the file ucxjjmx.ini in the WebSphere folder.
Open the INI file and append the new section [WEBSPHERE] with the following parameters:
[WEBSPHERE]
javax.net.ssl.trustStore=C:\DummyClientTrustFile.jks
javax.net.ssl.keyStore=C:\DummyClientKeyFile.jks
l
l
Adjust the values for the javax.* properties according to your environment.
Store and close the INI file.
This installation step is optional as of Websphere version 7 optional. Note when you skip this step that
you must enter the value "webshere soap" in the Initial Context Factory field in the JMX tab of the Job
object.
3.
Host
4.
l
Host
The JMX agent has a Web configuration interface which can be called with a Web browser via the
following address:
http://Server name:Port/context root
564
Chapter 8 Installation
l
Adjust the settings of the JMX agents to your system environment. The following are particularly
important:
l
Agent name
l
Name of the computer on which a communication process is available
l
Port number of a communication process
l
l
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
Host
The agent now uses the SOAP Connector. Therefore, select "Remote Java VM" in the Job object's
JMX tab.
Enter the term "websphere" in the field "Initial Context Factory."
Host name of the WebSphere:SOAP Port
Retrieve the port number as follows: Click Servers -> Application server, and then click on the
name of your Server. Select "transmittals" -> "Ports." Use the port number shown here in the URL.
The default value of the SOAP port is 8880.
Enter three passwords separated by commas in the Job's Login object.
l
The 1st password is the user password.
l
The 2nd password is the keystore password.
l
The 3rd password is the truststore password.
Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.war
Procedure
1.
Automation Engine
l
l
l
565
Host
Copy the file ucxjjmx.war to a folder and unpack it with an appropriate program.
Adjust the following two parameters in the configuration file web.xml:
<load-on-startup> - Ensure that the value is always set to 1. Otherwise, the agent does not load
and cannot be started.
<run-as><role-name> - Adjust this parameter if you intend to use roles. The role must then be
defined (or deleted) in the section security (<security-role>).
Rename the folder in which the agent files are stored. The folder name must end with ".war".
The following is an example of an appropriate folder name: ucxjjmx.war
Move the folder to the JBoss Deploy directory. The agent is automatically deployed and the
following message is displayed:
445 INFO [TomcatDeployer] deploy, ctxPath=/ucxjjmx,
warUrl=file:/C:/jboss-3.2.7/server/default/deploy/ucxjjmx.war/
2.
l
Host
The JMX agent has a configuration Web interface which can be called with a Web browser using
the following address:
http://Server name:Port/ucxjjmx/uc4jmx
This example uses the term ucxjjmx in the address because it is also used in step one as part of the
folder name (".war"). If you opted for a different name, use this name instead.
l
Adjust the settings of the JMX agent to your system environment. The most important ones are:
l
Name for the Agent
l
Name of the computer on which a communication process is available
l
Port number of a communication process
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
3.
l
l
l
Host
Select the option "Local Java VM" in the Job object's JMX tab.
Activate the sub-menu "Use existing MB Server."
It is not necessary to select the option "Generate new instance..."
566
Chapter 8 Installation
Supplied Files
The J2EE/JMX agent files are available in the folder IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.war
Procedure
1.
Host
Select the Applications tab and click Deploy. Click Browse and select the file ucxjjmx.war. Then
click Next.
Enter "uc4" in the text field Application Name. Then click Next.
Host
The JMX agent has a Web configuration interface; it can be called in a Web browser using the
following address:
http://Servername:Port/ucxjjmx/uc4jmx
The above address uses the string ucxjjmx because that is the string that appears in the folder name
before ".war." Adjust this address if you used a different name.
l
Adjust the JMX agent settings to your system environment. The most important settings are:
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
Automation Engine
3.
567
Host
In the Job object's JMX tab, select the option Remote Java VM.
Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.sca
J2EE/JMX agent
Procedure
1.
l
l
l
Host
Copy the file ucxjjmx.sca to the input directory of the Java Support Package Manager (for example,
C:\usr\sap\trans\EPS\in).
Start the Java Support Package Manager (JSPM) and log on to the JEE Engine.
JMX agent update installation: In step 1, "Select Package Type," select "Single Support Packages
and Patches (advanced user only)."
568
Chapter 8 Installation
Next.
In step 2, "Specify Queue", all available Support Packages are displayed. If a version number is
displayed in the column "Target Release.SPLevel.PatchLevel", that indicates that a new
component version is available in the input folder. "Not found" indicates that there is no new version
in the directory.
Automation Engine
569
Next.
In the next step, you will verify that the JMX agent is in the queue. If it is, you can initiate the update
procedure by clicking Start.
When this process has been completed, click Exit to end the JSPM.
2.
Host
Use the program "Undeploy View" from the SAP NetWeaver Developer Studio to remove the JMX
Agent.
570
Chapter 8 Installation
l
Select the software component JMX_Agent (automic.com) from the list and click Add to
Undeploy List in the context menu.
Host
A Web configuration interface is available for the JMX Agent; it can be called from:
http://Sap server name:Port/ucxjmx
This interface can be used to adjust the JMX agent to your system environment. The following are
particularly important:
l
Agent name
l
Name of the computer on which a communication process is available
l
Port number of a communication process
4.
Host
Select "JNDI" in the JMX tab of the Job object. Enter the object name "jmx."
Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
File name
Description
ucxjjmx.war
Automation Engine
571
Procedure
1.
l
l
l
Host
Start Tomcat and call the Tomcat Web Application Manager.
Select the file ucxjjmx.war in the section "Install - load local WAR file for installation." Start the
installation by clicking the button of the same name.
You must ensure that the role "administrators" exists. If it does not yet exist, adjust the file tomcatusers.xml. Enter the role and add it to a user.
Example:
<role rolename="administrators"/>
<user username="admin" password=""
roles="admin,manager,administrators"/>
The JMX agent is displayed in the section "applications" of the Web Application Manager.
2.
Host
A Web configuration interface is available for the JMX Agent; it can be called by clicking the link for
the JMX agent entry in the section "applications".
Use this interface to adjust the JMX agent to your system environment. The following are
particularly important:
l
Agent name
l
Name of the computer on which a communication process is available
l
Port number of a communication process
l
Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
Requirements
l
l
l
l
572
Chapter 8 Installation
Ensure that the agent runs with the SUPER.SUPER user in order to avoid problems when
processes are canceled.
Supplied Files
The files are packed in an archive file and stored in the subdirectory IMAGE:AGENTS\NSK.
File name
File type
Description
UC4DDL
Text
DDL description for usage in EMS filters to filter Automic related events.
UC4MACS
Text
UC4TMPL
Text
UCMSL
Binary
UCXBNI6C
Binary,
Example program showing usage of call API.
executable
UCXBNI6O
Binary,
library
UCXFTSRV Binary,
Automic server program used for file transfer, will be automatically stopped
executable and started by the agent when using file transfers.
UCXJNI6
Binary,
Automic agent
executable
UCXJNI6M
Binary,
Automic program used to shutdown the agent.
executable
UCXJNI6O
Binary,
Output collector used by the agent.
executable
UCXJNI6R
Binary,
Used for internal purposes only, will simply output command line arguments
executable in certain format.
UCXJNI6T
Binary,
Virtual terminal program, started to be used as a dummy input/output device
executable
UCXSCAN
Binary,
Scan program internally used by the agent if file system scans for file
executable patterns are requested.
UCYBWAIT Binary,
Used for internal purposes only, will simply create a given delay.
executable
The CallAPI files and their implementation are described in a separate document.
Procedure
1.
l
Admin computer
Establish a connection to the host via an FTP client and transfer the two supplied files OINSTALL
and UC4AR to a common sub-volume.
Automation Engine
l
l
The file OINSTALL must be transferred in text mode (code 101) and UC4AR in binary mode
(code 0).
Automic stronlgy recommends storing these files in an empty sub-volume.
The file UC4AR is a self-extracting archive that contains all the files that the NSK agent
requires.
2.
l
l
l
573
Host
Start a terminal emulation program and log on using the user who should be the program owner.
Change to the sub-volume to which the two files have been transferred.
Set the following command in the TACL input line:
O OINSTALL
This unpacks the file INSTINI in the sub-volume. It must remain in the same sub-volume as the
other installation files so that the installation can proceed.
3.
Host
The file INSTINI contains several parameters that must be adjusted to your system environment.
l
l
l
Parameter
Description
UC4-PROGRAM-SUBVOLUME=
UC4-STATUS-STORE-SUBVOLUME=
574
Chapter 8 Installation
UC4-STATUS-STORE-AUDITED=
UC4-TCPIP-PROCESS=
UC4-SERVER-PORT
UC4-AGENT-PORT=
UC4-SERVER-IP-ADDRESS=
UC4-AGENT-PROCESS=
UC4-OC-PROCESS=
UC4-TSIM-PROCESS=
UC4-SYSTEM-NAME=
UC4-AGENT-NAME=
UC4-TEMP-SUBVOLUME=
The agent's INI file is completed with the data specified here. After the installation, you can
change these values at any time.
4.
Host
Automation Engine
575
RUN INSTALL
You receive notifications about the installation progress and can terminate it at any time. In this
case, a manual cleanup process can be required.
A connection to the Automation Engine is established when the installation is complete.
Host
Change to the agent's subvolume and set the following command in the TACL input line:
O EXSTART
See also:
EMS template file
Requirements
l
TCP/IP
Supplied Files
The OS/400 agent is supplied as a binary SavFile. This file is found in the subdirectory
IMAGE:AGENTS\AS400.
File name AE CD
Description
UCXJO41.BIN
OS/400 agent
(binary SavFile)
576
Chapter 8 Installation
Content:
IRSTRJOB
UCXBO41C
CallAPI
UCXJO41
Agent
UCXJO41M
Messenger
program for the
OS/400 agent
CLLE
INI
INI file
MSL
Message library
TMP
STRUCAGENT
Program that
starts the agent
ENDUCAGENT
MAKEMSL
Program that
generates the
message library
Service programs
(libraries) for the
agent, the CallAPI
and the
MAKEMSL
program
The CallAPI files and its implementation are described in a separate document.
Procedure
1.
l
Host
Create a temporary library for Save File:
CRTLIB LIB(UC4TMP)
Create an empty Save File.
CRTSAVF FILE(UC4TMP/UC4)
Create a library for restoring the Save File.
CRTLIB LIB(UC4AUSL) TYPE(*PROD) TEXT('Automation Engine version
10.0.0')
Admin computer
Automation Engine
l
577
Log on to AS/400 via FTP and transfer UCXJO41.bin to the Save File UC4, UC4TMP library.
Example for FTP via the Windows command prompt:
ftp <MY.AS400>
<USER>
<PASSWORD>
cd UC4TMP
bin
put UCXJO41.bin UC4
quit
2.
Host
Create the library.
RSTOBJ OBJ(*ALL) SAVLIB(UC4AUSL) DEV(*SAVF) SAVF(UC4TMP/UC4)
Delete the temporary library.
DLTLIB LIB(UC4TMP)
Rename the library.
RNMOBJ OBJ(QSYS/UC4AUSL) OBJTYPE(*LIB) NEWOBJ(UC4)
3.
Host
The AE system must be running.
Host
Adjust the INI file UC4/INI(UCXJO41).
Admin computer or User computer
Adjust the HEADER.OS400, TRAILER.OS400 and RESTART.OS400 if necessary. See: Job Execution.
There are two different methods that can be used to start the agent. Variant 1 requires a CL routine per
agent that should start (more complex). Variant 2 starts or ends the agent via separate programs.
Method 1
4.
l
Host
The CL example programs that start and end the agent are provided in the supplied file member
CLLE. They must be adjusted to the installation and the OS before you can compile them.
UC4/CLLE(UCEX_RUN) - starts the agent
UC4/CLLE(UCEX_END) -ends the agent
5.
Host
You can use the program UCEX_RUN to start the agent.
An Agent object is automatically created in the system client 0000 and stored in the HOST folder.
578
Chapter 8 Installation
l
Method 2
4.
l
Host
The library (UC4) that includes the programs (such as the agent or CallAPI) must be included in the
library list. You can use the following commands for this purpose:
ADDLIBLE UC4
adds the library to the library list
or:
CHGCURLIB UC4
changes the current library for the particular job to UC4
5.
Host
Start the agent by using the command STRUCAGENT.
The following examples explain the agent's starting procedure:
STRUCAGENT LIB(UC4) FILE(UC4/INI) MBR(UCXJO41)
Starts the agent from the library by using the INIfile UC4/INI(UCXJO41).
STRUCAGENT LIB(UC4) PATH('/user/uc4/ucxjo41.ini')
Starts the agent from the library by using an INIfile that is stored in the IFS file system.
Automation Engine
579
Requirements
l
Supplied Files
Agent files are packed in UCXJPSX.tar tar files, and can be found in the
IMAGE:AGENTS\PEOPLESOFT\UNIX subdirectories. The names of the subdirectories indicate the
respective UNIX platforms, as described in the terminology.
File Name
Description
UCXJPSX
UCXJPSX.INI
UCX.msl
Message library
psexj.bin
Syntax file
UCXJPS82.jar
UCXJPS84.jar
Java Classes
Procedure
Transferring the tar file and setting up the system environment
l
Host
580
Chapter 8 Installation
l
Requirements
l
The following additional requirements must be fulfilled so that PeopleTools Process Scheduler Batch
Server process logs can be added to the AE database:
l
l
l
l
l
Entry in the INI file of the agent that allows the transfer of the log files to AE.
Read permissions for the PeopleSoft process log files
Read permissions for the configuration file of the PeopleSoft Process Scheduler Batch Server
Correct entry for the parameter "Log/Output Directory=" in this configuration file
Agent knows the environment variable that might be used for "Log/Output Directory="
Project SBB_PRCS has been loaded in the PeopleSoft Database, validated and authorized for full
access
AE Interface has been activated in the INI file of the agent
Supplied Files
These files are found in the directory IMAGE:AGENTS\PEOPLESOFT\WINDOWS.
File name
Description
UCXJPSX.EXE
UCXJPSX0.DLL
UCXJPSX1.DLL
UCXJPSX2.DLL
UCXJPSX3.DLL
Runtime library for PeopleTools Version 8.2x (AE Interface, Java API)
Automation Engine
UCXJPSX4.DLL
Runtime library for PeopleTools Version 8.2x (Standard Interface, Java API)
UCXJPSX5.DLL
Runtime library for PeopleTools Version 8.4x (Standard Interface, Java API)
UCXJPSX6.DLL
Runtime library for PeopleTools Version 8.4x (AE Interface, Java API)
UCXJPSX.INI
UC.MSL
Message library
UCUDB32.DLL
UCUODBC.DLL
UCUOCI.DLL
UCUCLI.DLL
ZUSYNCHK.DLL
ZU00132.DLL
UCXJPS82.jar
UCXJPS84.jar
Java classes
SETUP.EXE
Installation program
581
Other files from this subdirectory are components of the installation program. The files that relate to the AE
Interface and its implementation are described separately.
Procedure
Installing the Agent and setting up the system environment
l
Host
Start the SETUP.EXE program in the directory IMAGE:AGENTS\PEOPLESOFT\WINDOWS.
Choose the directory and start installation by clicking the large button (Computer, Packaging and
Diskette).
If recommended in the current Release Notes, adjust the INI file. Refer to the INI file
UCXJPSX.ORI.INI, which is supplied with the update installation.
582
Chapter 8 Installation
Supplied Files
The files that belong to the RA agent are stored in the directory IMAGE:AGENTS\RAPIDAUTOMATION.
File name
Description
ucxjcitx.jar
ucxjcitx.ini
Configuration file
*.jar
Libraries
uc.msl
Message library
setup.exe
Installation program
Procedure
1.
This installation step can be omitted if the required version of Java Standard Edition is already
available.
l
Download the required Java Runtime Environment from http://java.sun.com and install it.
2.
Host
Create a separate folder for the RA agent and copy the supplied files to it. Under Windows, you can
also use the program SETUP.EXE for the installation. It is available in the directory
IMAGE:AGENTS\RAPIDAUTOMATION\WINDOWS.
The RA Solution that should be used by the agent is stored in the folder named "cache." Create this
folder in the installation directory.
Several settings are available for adjusting the RA agent to your system environment. Of note are
the agent and computer name, and the port of the communication process to which the agent
should connect. Adjust the INI file.
3.
Host
Start the utility AE.DBLoad and select the RA Solution's JAR file. The utility will then load it to the
AE database. The JAR file can be loaded via the graphical interface or the Java batch mode
Automation Engine
583
(ucybdbld.jar) of the utility AE DB Load. Loading with the AE DB Load in batch mode
(ucybdbld.exe) under Windows is not possible.
l
The RA agent can only connect to one RA Solution. If you intend to use several RA Solutions,
each solution requires its own RA Agent.
Note that you cannot load the same JAR file of an RA Solution to several systems at a time. Any
attempt to do so can cause the utility AE DB Load to abort.
4.
l
l
Host
Log on to system client 0000.
Depending on the RA Solution, one or more templates are generated for the required Connection
objects and stored in the folder named "TEMPLATE." Create the required Connection object(s) and
complete the tab fields that are subsequently required for the RA Agent.
5.
Host
The RA agent can only start when the system client 0000 contains an Agent object of the same
name. The authentication method is irrelevant in this case.
A template for the Agent objects to be used is created when the RA Solution loads. It is available in
the folder named "TEMPLATE." Create an Agent object in the folder HOST and complete its tab
fields (enter Connection objects, etc.).
Use the following command to start the agent via the command line (UNIX and Windows):
java -jar -Xrs -Xmx256M ucxjcitx.jar
The agent can also be started via the ServiceManager.
Note that the storage limit should be set to at least 256MB (or 512MB) for starting Java agents
(Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java applications
by using the start parameter -XmX.
Specifying a value that is too low can cause the agent to crash. The default value depends on the
Java version that is used.
The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation.
6.
Host
When the RA Solution loads, one or more Job object templates are stored in the folder named
"TEMPLATE." These templates can be used to create Jobs for the RA Solution.
RA Jobs do not contain Login objects. During the installation process, Login data is stored in one or
several Connection objects which can be selected in the Agent object.
584
Chapter 8 Installation
Requirements(UNIX)
l
Supplied Files
The files are provided in the directory IMAGE:AGENTS\SAP\UNIX or
IMAGE:AGENTS\SAP\WINDOWS.
File name
Description
UCXJR3X.JAR
UCXJR3X.INI
UC.MSL
SAPRFC.INI
UMSVCP60.DLL
SETUP.EXE
Procedure
1.
l
l
l
l
Host
Transfer the TAR file UCXJR3X.tar.gz via FTP.
Log in using the user AE.
Unpack the transferred TAR file.
gzip -d UCXJR3X.tar.gz
tar xvfo UCXJR3X.tar
If recommended in the current Release Notes, adjust the ini file. Refer the INI file
UCXJ3RX.ORI.INI, which is supplied with the installation.
2.
Host
Automation Engine
All files must be installed on the local hard drive of the computer because the agent runs as a
service except when it is used for testing. A service does not have access to the network
resources.
If recommended in the current Release Notes, adjust the INI file. Refer to the INI file
UCXJR3X.INI, which is supplied with the update installation.
Admin computer or user computer
Adjust HEADER.SAP, TRAILER.SAP and RESTART.SAP if necessary. See also: Job Execution.
3.
l
l
l
Host
This installation step is only necessary if you use the AE interface.
Copy the transport files.
Import the transport.
4.
585
Use the following command to start the agent via the command line (UNIX and Windows):
java -jar ucxjr3x.jar
You can also use the ServiceManager to start the agent.
Note that the storage limit should be set to at least 256MB (or 512MB) when you start Java
agents (Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java
applications via the start parameter -XmX.
Example for a start with 256MB: java -Xmx256M -jar ucxjr3x.jar.
Specifying a value that is too low can cause the agent to crash. The default value depends on the
Java version that you use.
Description
UCXJSLX.EXE
Siebel agent
UCXJSLX.INI
UC.MSL
Message library
ZU00132.DLL
ZUSYNCHK.DLL
SETUP.EXE
Installation program
586
Chapter 8 Installation
The other files in this subdirectory belong to the installation program and the AE runtime system.
See: Knowledge Base.
Procedure
1.
l
Host
Start the program SETUP.EXE in the directory IMAGE:AGENTS\SIEBEL\WINDOWS.
Choose the directory and start the installation by clicking the large button (computer, packing and
disk).
2.
Host
If recommended by the current Release Notes, adjust the INI File. Refer to the INI file
UCXJSLX.ORI.INI, which is supplied with the update installation.
Admin computer or User computer
Adjust HEADER.SIEBEL, TRAILER.SIEBEL and RESTART.SIEBEL if needed. See: Job Execution
Requirements
l
l
l
Description
Automation Engine
ucxj???
UNIX agent
ucxj???m
ucxjxxx.ini
ucx.msl
Message library
ucxe???f
587
The CallAPI files and CallAPI implementation are described in a separate document.
Procedure
1.
l
l
l
l
Host
Transfer the TAR file ucxj???.tar.gz via FTP.
Log on using the user AE.
It is important to save your INI file if you did not rename it during the first-time installation.
Otherwise, when the files are unpacked, the ucxjxxx.ini will be overwritten.
Unpack transferred TAR file.
gzip -d ucxj???.tar.gz or gunzip ucxj???.tar.gz
tar xvf ucxj???.tar
(Linux: tar -zxvf ucs???.tar.gz)
Requirements
l
The user AE has been given the privileges CMKRNL, BYPASS, SYSNAM, SYSPRV and
WORLD.
588
Chapter 8 Installation
l
The batch queue SYS$BATCH must be initialized and started. As an alternative, you can use a
specially customized and prioritized batch queue for AE Jobs. This must be defined in the INI file of
theVMS agent as a parameter of the VMS command for starting Jobs in batch mode. Working with
an individual batch queue requires that is it initialized and started beforehand.
In order to ensure that AE Jobs are performed in batch mode, the job limit must be set with a
number greater than zero.
Description
Destination
directory
File
type
UCXJV??.EXE
VMS agent
BIN
Binary
UCXJV??M.EXE
Messenger program
BIN
Binary
UCXE???F.EXE
BIN
Binary
UCXJV??.INI
INI file
BIN
Text
UCX.MSL
Message library
BIN
Text
UC$CRDIR.COM
CMD
Text
UC$START.COM
CMD
Text
UC_START.COM
CMD
Text
UC$STOP.COM
CMD
Text
SYS$STARTUP Text
UC4$STARTUP_
BAT.COM
SYS$STARTUP Text
The CallAPI files and CallAPI implementation are described in a separate document.
Procedure
1.
Admin computer
Host
Automation Engine
l
589
CMD
TEMP
OUT
Admin computer
The files of the VMS agent (UCXJV??.EXE), for file event (UCXE???F.EXE) and the messenger
program (UCXJV??M.EXE) must be transferred in binary mode. All others are text files.
4.
Host
If recommended in the current Release Notes, adjust the INI file. Refer to the INI file
UCXJV??.INI, which is supplied with the update installation.
Change to the CMD directory:
$SET DEF [-.CMD]
Use an editor to adjust the command file for shutting down the agent UC$STOP.COM.
The name of the AE system and the agent name must be adjusted in order to find the logical name
of the agent.
You can also modify both files on the Admin computer before you transfer them.
l
590
Chapter 8 Installation
Description
UCXJ???.EXE
Windows agent
UCXJ???M.EXE
UCXJ???.INI
UC.MSL
Message library
UCSMTP.DLL
ZU00132.DLL
SETUP.EXE
The other files in this subdirectory belong to the installation program and the AE runtime system.
See: Knowledge Base.
The CallAPI files and CallAPI implementation are described in a separate document.
Potential Problems
l
l
Procedure
1.
l
Host (32-bit)
Start the program SETUP.EXE in the directory IMAGE:AGENTS\WINDOWS\X86.
Choose the directory and start the installation with the large button (computer, packing and disc).
Automation Engine
l
l
l
Host (64-bit)
Important: Be sure to save the INI file UCXJWI6.INI.
Copy all files from IMAGE:AGENTS\WINDOWS\X64 or IMAGE:AGENTS\WINDOWS\IA64.
2.
591
Host
If recommended in the current Release Notes, adjust the INI File. Refer to the INI file
UCXJ???.ORI.INI, which is supplied with the update installation.
Admin computer or User computer
Adjust HEADER.WINDOWS, TRAILER.WINDOWS and RESTART.WINDOWS if needed.
See:Job - Execution
Requirements
l
l
l
l
l
JES2 or JES3
TCP/IP V3R2M0 or later
C runtime library version V1R5M0 or later
An MSGCLASS in HOLD status that does not call a subsequent program (external writer)
UPDATE access for JESSPOOL RACF Class (in order to process Job outputs)
Supplied Files
The files are stored in the directory IMAGE:AGENTS\MVS.
File name AE CD
Description
UCXJM25-IBM.BIN
z/OS agent
UC4.UCXJM25.LOAD
INI file.
UC4.UCXJM25.INI
UCX.MSL
Message Library.
UC4.UC.MSL
STC25.TXT
UC4JCLE.ASM
The CallAPI files and their implementation are described in a separate document.
Load Module:
l
CADSDEL - A utility that can be used to release a Common Dataspace (CADS) allocated by the
Event Monitor.
592
Chapter 8 Installation
l
UC4END - End messenger for the SMF messenger technique (it writes the StepList and return
codes to the JESMSGLG)
UC4RESTR - Restart messenger for the SMF messenger technique (dummy program such as
IEFBR14)
UC4START - Start messenger for the SMF messenger technique (dummy program such as
IEFBR14)
Procedure
1.
Host
Host
Create the LOAD library using the utility TSO RECEIVE. Parameters shown in bold are systemspecific specifications.
//UC4LOAD JOB (ACCT#),'UC4USER',
// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),NOTIFY=UC4USER
//*************************************************
//STEP01 EXEC PGM=IKJEFT01,DYNAMNBR=30
//SYSPRINT DD SYSOUT=*
//SYSTSPRT DD SYSOUT=*
//SYSTSIN DD *
PROFILE NOPREFIX
RECEIVE USERID(UC4USER) INDSN('UC4.UCXJM25.BIN')
DSNAME('UC4.UCXJM25.LOAD') UNIT(3390) VOLUME(??????)
/*
Automation Engine
593
l
l
Host
STEPLIB libraries require APF authorization.
Example for a started task:
//UC4RUN PROC
//UCEX EXEC PGM=UCXJM25,PARM='TRAP(OFF),HEAP(4M,4M,ANY,FREE)
/UC4.UCXJM25.INI',REGION=4M
//STEPLIB DD DISP=SHR,DSN=UC4.UCXJM25.LOAD
//SSTORE DD DISP=SHR,DSN=UC4.UCXJM25.SSTORE
//SYSPRINT DD SYSOUT=*
//STDOUT DD SYSOUT=*
//SYSCPRT DD SYSOUT=*
//JOBOUT DD SYSOUT=(A,INTRDR)
//SYSUDUMP DD SYSOUT=*
//*
Apply the following step if either the MVS or Language Environment Resolver does not work
correctly:
The DD statements for TCP/IP must be included in the started t so that the agent can establish a
TCP/IP connection.
Example:
//SYSTCPD DD DSN=TCPIP.SYSTSMS.TCPPARMS(DT20OEDA),DISP=SHR
//PROFILE DD DSN=TCPIP.SYSTSMS.TCPPARMS(DT20VIPA),DISP=SHR
The exact statements are found in the TCP/IP's started task.
The DD statements for TCP/IP must also be included in the Include object MVS.JOBMD_
DEFINITIONS . Otherwise, the job messenger cannot open a TCP/IP connection and the Jobs
change to status ENDED_VANISHED.
OMVS segment
ALTER authorization for own datasets (e.g.: UC4.*)
594
Chapter 8 Installation
l
The started task requires the appropriate authorization to read JES lists
4.
l
Host
If recommended by the current Release Notes, adjust the INI file. Also refer to the INI file
UCXJ???.ORI.INI which is supplied with the update installation. The INI file must not use the file
attribute NUMBER ON.
Admin computer or User computer
Adjust HEADER.MVS, TRAILER.MVS and RESTART.MVS where necessary. See: Job Execution.
Automation Engine
595
Supplied Files
The ServiceManager files are supplied in compressed form, and are found in subdirectories of
IMAGE:SERVICEMANAGER\UNIX. The names of the subdirectories indicate the supported platforms.
File name
Description
libgcc_s.so
GNU C Library
libstdc++.so
Runtime libraries
uc4.smd
uc.msl
Message library
ucybsmcl
ucybsmgr
ServiceManager
ucybsmgr.ori.ini
Steps
1.
l
l
l
l
Host
Transfer the TAR file ucsmgr???.tar.gz using FTP.
Log on using the user ID AE.
Navigate to the directory for the ServiceManager:
cd servicemanager
Unpack the tar file
gzip -d ucsmgr???.tar.gz or gunzip ucsmgr???.tar.gz
tar xvfo ucsmgr???.tar
If recommended by the current Release Notes, adjust the ServiceManager's INI file. Refer to the
INI file ucybsmgr.ori.ini, which is supplied with the update installation.
596
Chapter 8 Installation
Supplied Files
ServiceManager files are provided on two different directories on the AE CD. The files for the
ServiceManager service are stored in the directory IMAGE:SERVICEMANAGER\WINDOWS.
File name
Description
UCYBSMGR.EXE
ServiceManager
UCYBSMGR.INI
UC4.SMD
ZU00132.DLL
SETUP.EXE
Installation program
Description
UCYBSMDI.EXE
UCYBSMDI.INI
UCYBSMCL.EXE
SETUP.EXE
Installation program
Additional files in these subdirectories are components of the installation program and the AE runtime
system. See:Knowledge Base.
Procedure
On the corresponding Server computer or host computer.
1.
l
l
Automation Engine
l
597
l
l
See also:
ServiceManager - Service
ServiceManager - Dialog Program
ServiceManager - Command Line Program
Example
UCCMPMSL.EXE -oC:\AUTOMIC\uc.msl -nC:\AUTOMIC\uccmpmsl\uc.msl pC:\AUTOMIC\uccmpmsl\
598
Chapter 8 Installation
General
It is very important that you follow a structured procedure when you update an AE system because it
guarantees that processing can be continued as soon as possible. The following guidelines explain the
required steps in detail and especially address areas that need special attention.Follow the recommended
steps for a smooth conversion process and you will soon be able to use all the new functions of your new
Automation Engine version.
When changing the version of the Automation Engine, the utility AE DB Load processes and monitors all
the required steps for changing the database. This is necessary because it also modifies data that cannot
be changed with SQL. All steps that the utility processes during the updating process are logged in the file
uc_upd.txt. The file chngdb.sql also informs about the database-relevant statements that were set. These
statements must be processed by the utility. Refer to the Release Notes of the relevant Automation
Engine version for changing the database and preparing the necessary steps.
The updating process comprises of several stages:
1. Installation and comprehensive testing in a test environment
2. Planning the conversion time and creating a plan for a possible re-conversion.
Never change to a new Automation Engine version without having planned a re-conversion
scenario.
3. Make a backup of the AE database and all the components' directories.
4. Update your system step by step WITHOUT using the new functions.
5. Only use the new functions when every component has been converted to the new version and after
a particular system-monitoring period.
Each stage consists of many small steps. Your AE system is not updated at once but step by step. The
old components are not overwritten and the new files are installed in separate directories. Only the AE
database is directly updated with the utility AE DB Load. This method has two main advantages:
1. You can quickly re-convert to the old AE-component version if problems occur in your system
environment. Therefore, there is almost no risk for your processing.
2. Depending on the size of your AE system, the complete updating process can take some time. The
advantage of updating step by step is that you can do so in individual and shorter periods of time
which makes it easier to coordinate the updating process with other departments and processes.
And it is also easier to locate errors that might occur.
Automation Engine
599
First update your test system. Possible problems can so be recognized and solved before they occur in
your productive system. Test the individual updating steps, thereby setting up a plan for updating your
productive system.
The AE system is not available while the database is upgraded.
After each step of the update installation, it is essential to monitor the new components for some time.
Only continue the updating procedure when they have proven to run stably.
Note that the updating process Automic recommends enables production to be continued in the old
Automation Engine version at any time. The only requirements are a parallel installation of the
components and the provision of a second database instance.
Use the message-comparing program if you require a list of all changed messages.
Our consultants are experts in updating AE systems. Contact Automic, our experts will be pleased to
assist you whenever it is necessary.
Requirements
Check Condition
Carefully read the Release Notes of the relevant Automation Engine version. They include
information that must be taken into account during the updating process.
The most important requirement is a test system. Comprehensive tests in a separate system
are necessary before the new Automation Engine version is used in your productive system.
The test system helps you to get used to the necessary steps for updating your productive
system and even to optimize them.
Has your database been maintained on a regular basis? Automic recommends starting a
reorganization run with AE utilities and database means before you update the database. The
smaller the database, the quicker the updating process. Note that it will still take some time to
update the AE database and that you will need sufficient disk space for having tables
duplicated.
Authorizations for the affected computers, databases, ERP systems etc. are required during
the various update phases. Ensure that the responsible administrators are available during the
particular work steps.
You can request assistance from consultants, developers or even 24x7 support when you
update your system. Our experts are trained in providing excellent support when action is taken
in critical and sensitive areas of your AE system. Contact your Account Manager or the
Technical Support Team as soon as you know when you are going to start the updating
process.
Ensure that you have the phone number and e-mail address of Technical Support and your login
data for the Download Center.
Procedure
Check
Work steps
Preparations
Reading Release Notes
Last modifications in processing
Preparing the updating process of core components
600
Chapter 8 Installation
Updating UserInterfaces
Maintaining the AE database
Duplicating the AE database
Updating the core components
Installing utilities
Installing the Automation Engine and ServiceManager
Installing Framework Integration (optional)
Updating UserInterfaces (if they have not yet been updated)
Installing the WebInterface (optional)
Stopping all clients
Stopping the Automation Engine
Saving the AE database
Updating the AE database
Starting the Automation Engine and clients
Monitoring the AE system
Updating all other components
Installing the Agent
Installing the remaining components
Using the new functions
See also:
Updating an AE System - Details
Automation Engine
601
Direct modifications that are made in database contents without using AE programs result in an
inconsistent database.
Always make a database backup before you process any work steps.
This process can take a while depending on the database size and upgrading complexity.
Ensure there is sufficient disk space for the \AUTOMIC\DB directory and that the database's LOG
section can store all this data.
Schemes that provide access to the database should be removed after the updating process in order
to avoid unintended database modifications.
DB2: After updating the AE database, check the size of the tablespaces and if required, run the
following SQL statement:
alter tablespace <UC4 tablespace name> reduce max;
8.00A
Note for updating from UC4 version 6.00A to version 8.00A
In order to start the utility AE DB Load, users of an ORACLE database require additional rights.
Notes for updating a DB2/ OS390 database from version 6.00A to 8.00A:
If the table AH is stored in a 4K tablespace, it will be copied to a larger tablespace of 8K during the
upgrade process. Automic recommends providing the corresponding memory before starting to update.
No copying process takes place if this table is already available in a bigger tablespace. In this case, use
the line "process_sql_file2 chngdb_ah.sql" instead of "process_sql_file2 copy_ah.sql" in the file "UC_
UPD_FOR_DB2.OS390.txt".
By default, the table will be copied.
Excerpt from the file "UC_UPD_FOR_DB2.OS390.txt":
message ----------------------------------------------------------------message Apply chngdb_ah.sql if Table AH is already in an 8K Tablespace!!!
message process_sql_file2 chngdb_ah.sql
message ----------------------------------------------------------------message ----------------------------------------------------------------message Remove copy_ah.sql if Table AH is already in an 8K Tablespace!!!!
process_sql_file2 copy_ah.sql
message -----------------------------------------------------------------
602
Chapter 8 Installation
Update the database without storing the reports. Data is deleted and no additional space is
required.
Convert the reports during the updating process.
Note that this process can take some time depending on the amount of data involved. You
system is offline during this time.
Convert the reports after the update installation - only possible for MSSQL Server and Oracle.
The utility AE DBLoad now checks whether all Server processes share the same AE system name
(e.g. UC4PROD#WP001). If not, the loading process is canceled. Thus, the AE database can only be
updated to the new version if all Server processes share the same AE system name. Log on to system
client 0000 and search for Server objects. Delete all Server objects whose names do not start with the
AE system name.
9.00A
To update a DB2 database to version 9.00A, you need the EXECUTE right for SYSPROC.ADMIN_
CMD.
AE Server, AE SNMP Subagent and the utilities are now only available for 64-bit platforms.
The utilities and the UserInterface require at least Java 1.6 and the Java-based agents (JMX,
Database, SAP) require at least Java 1.5.
The utilities and the AE Server can only be used with particular versions of the Oracle Instant
Client, depending on the platform that is used. The versions are available in the Requirements Checklist, section Database - Oracle.
Release Notes
Automic strongly recommends reading the Release Notes of version 8.00A.
Automation Engine
Advanced Security
Read about the extended security mechanisms in chapter Advanced Security before starting the
updating process. When updating the AE database, the utility AE.DBLoad displays a mask in which
you must select an authentication method.
Subsequent changing of the authentication method involves considerable effort. Automic
recommends determining the required variant during the updating process.
Release Notes
Automic strongly recommends reading the Release Notes of version 9.00A.
The Automation Engine version numbers are described in a corresponding document.
603
604
Chapter 8 Installation
Preparations
The following preparatory work is required before you can start the actual updating process:
1.
l
Start off by reading the Release Notes of the Automation Engine version to which you intend to
update. They are available in the "Release Notes" chapter of the Automation Engine
documentation.
The section "Notes for the Update Installation" is extremely important. It contains information
about incompatibilities and points out additional work steps that can be required during or even
before the installation. Automic recommends preparing your AE system and your system
environment accordingly.
2.
Processing must not be changed during the whole updating procedure. If a problem occurs in
your system environment during a particular step, you can either restore the AE database or directly
use the original one if you made a copy. In doing so, there is almost no risk for your processing.
Note that statistical data, reports, and modifications made to Variable object and Sync object
contents are lost.
Inform all affected persons about the updating process and make sure that processing is not
changed.
Create a user group that explicitly denies everything and assign all users to this group. If the Revision
Report is activated in your AE system, the assignment to the user group must be made in the User
object because the tab is locked in the UserGroup object in this case.
3.
l
Determine a point in time for updating the core components. Note that the Automation Engine must
temporarily be stopped which interrupts processing. For this reason Automic recommends
determining a time during which only a few activities take place. The duration of the updating
process depends on the size of your AE system. Your experiences when updating the test system
will help you estimate the required time to update your productive system.
Ensure that you have the phone number and e-mail address of Automic Support and your login data
for the Automic Automation Support zone. Carefully think about requesting temporary 24x7 Support
Automation Engine
if sensitive systems should be updated or if the update is not made during the regular business
hours of our support team.
Our experts are trained in providing excellent on-site support in updating your AE system. Contact
your Account Manager or the Automic Support Team. Your request is forwarded to the relevant
expert in order to make an appointment.
During the updating process, you require access to the AE database and to all computers with AE
core components (such as the Automation Engine, utilities etc.). Access to all affected computers
is required if you work in a distributed Server environment. Ensure that the responsible
administrators are available and that the login data (such as passwords) is correct.
The UserInterfaces can already be updated. If you update them together with the core components,
access to the relevant computers is required.
4.
Automic recommends using UserInterfaces in a preceding AE system only for a few days when
converting to a later version. As of version 9.00A, UserInterfaces can also be used in the particular
preceding version. For example: A 9.00A UserInterface can also log on to an 8.00A AE system.
The only requirement is that your AE system has the latest hotfix version. Be informed that the
UserInterface is not completely downwards compatible. Some functions are not fully available.
Changes made in the UserInterface's interface only become visible when the core components
have been updated to the new version.
Older UserInterfaces cannot be used with AE systems of a newer version. They must be
updated at least when the core components are updated.
This does NOT apply to agents which function the other way round. Later agent versions
CANNOT be used in former AE systems. But former agent versions can also be used in the
succeeding Automation Engine version (this means that an 8.00A agent can also be used in a
9.00A AE system). This requires the most current hotfix version to be installed on your AE system.
5.
605
Automic generally recommends that you maintain your AE database with our utilities and databasespecific tools on a regular basis. However, reorganize your database before you update it. The
smaller the database, the faster the updating process to the new Automation Engine version.
Carefully read the AE scripts that refer to the AE database and prepare adjustments (e.g.,
tablespaces). In doing so, you see the actions that will take place and respond to them in the
database and on the computer on which the database has been installed (e.g., by providing disk
space).
For company-critical processing in the AE system Automic recommends duplicating and backing
up your database. In doing so, you can leave one of the databases unchanged and easily re-access
your old database if any problems occur in your system environment.
The database can be duplicated in several ways. You can duplicate it in offline mode which is
especially suitable for smaller databases and can be done during the updating process of the core
components. During this time, the AE system is not available anyway. Complex databases,
however, can be updated in online mode before the core components are updated. Inform your
database-administration group because the current log files must be stored in the duplicated
database.
606
Chapter 8 Installation
l
l
Always use a separate directory in order to avoid mixing files of the different Automation Engine
versions. Depending on the computer, you will either install one or several components. First create
a folder whose name represents the Automation Engine version. Then create an individual subfolder for each component. An example is shown in the chapter about new installations.
Do not remove or overwrite the installation directories of your utilities. Back up the
corresponding folders in order to make sure that you can quickly return to your old version if any
problems occur.
Install the utilities (UNIX or Windows).
Copy the folder "DB" from the CD to the directory of the utilities. It includes the files for loading the
AE database. The DB folder must be a parallel folder of the utilities' BIN directory.
Example for Windows:
Utility in C:\AUTOMIC\UTILITY\BIN
Database files in C:\AUTOMIC\UTILITY\DB
2.
l
l
Do not remove or overwrite the installation directories of your Automation Engine and the
ServiceManager. Back up the corresponding folder in order to make sure that you can quickly return
to your old version.
Install the Automation Engine (UNIX or Windows) to a new directory.
Install the new ServiceManager version. Use a new name for the ServiceManager environment
(phrase).
3.
Alternately, you can carry out this step after the core components have been updated. The function
Framework Integration is not available until it has been installed.
Do not remove or overwrite the installation directories of your utilities. Back up the
corresponding folders in order to make sure that you can quickly return to your old version if any
problems occur.
If you use a Framework Integration such as "AE Smart Plug-In for HP OpenView", Automic
recommends installing it in the new Automation Engine version.
4.
Updating the UserInterfaces (if they have not yet been updated)
Do not remove or overwrite the installation directories of the UserInterfaces. Back up the
corresponding folder in order to make sure that you can quickly return to your old version.
Automation Engine
l
At least one UserInterface must be updated to the new Automation Engine version. Use a separate
directory for each UserInterface. Older UserInterface versions can no longer log on when the core
components have been updated.
5.
Stop all Server processes. If you work in a distributed Server environment, note that all Server
processes on all participating computers are de-activated.
Pay attention to programs such as Watchdogs, cluster monitoring etc. before ending the Server
processes. They might raise an alarm or re-start the Automation Engine.
7.
l
l
Automic strongly recommends reading the notes concerning database modifications for the
relevant Automation Engine version before starting the updating process.
Update your AE database using the utility AE DB Load.The relevant guide is provided in the
chapterHotfix Installation.
If you have created a duplicate, Automic recommends updating it now in order to make sure that the
original instance remains operable. Keep in mind to enter the correct database connection in the INI
files of the utilities.
The statistics and reports (database table RT/FH) are specifically converted during the updating
process to version 8.00. It can take several hours because of the huge amount of data that is
involved. If you do not want to shut down your system for such a long time, you can skip this
process and execute it later on. The following document includes a detailed description: Converting
Reports after Updating to 8.00A.
9.
Starting with this step, your AE system is no longer available until the database has
successfully been updated.
Stop all clients when the updating time is ripe. This is easily done in the system control of client
0000.
6.
607
Cold-start the Server processes when all installation and configuration step have successfully been
completed. Do so in the INI file of the Server processes by setting the parameter StartMode= to
COLD. Now the processes can start.
All clients can be started from the System Overview of client 0000.
10.
608
Chapter 8 Installation
l
Do not yet replace the agents. Older agent versions run smoothly with newer Automation Engine
versions.
Do not change anything in your processing and carefully monitor your AE system over an
extended period of time. A few hours or days are not enough. It can take a while before problems
occur, especially if they are the result of a particular constellation in your processing.
Do not remove or overwrite the installation directories of your agents. Back up the corresponding
folder in order to make sure that you can quickly return to your old version.
The new agents must also be installed in a separate directory. An adequate monitoring period is
essential. Automic recommends not replacing all agents by the new version. Replace one platform
after the other, for example. First replace UNIX and only replace the next one when the agents have
proven to run stably for some time.
As of version 9, the UNIX agent files will be supplied in lowercase letters. To ensure that jobs
call the new job messenger, follow the steps below:
1) Automic recommends: Correct the file name of the job messenger in the INI file when you update
the agent (Variable UC_EX_JOB_MD).
2) Important: When you install the new agent in the same directory as the old one, you must delete
the old job messenger after the installation process.
3) Instead of adjusting the INI file during the updating process, you can also create a link (with the
old messenger names in uppercase letters) that points to the new messenger
Example for Linux:ln -s ucxjli3m UCXJLI3M
2.
Do not remove or overwrite the installation directories of the remaining components. Back up the
corresponding folder in order to make sure that you can quickly return to your old version.
Now you can replace components such as the CallAPIs. Keep in mind to monitor the newly
installed version for some time.
3.
Monitor your updated AE system for a time. The updating process is complete if no problems
occur.
Now you can update your productive system. Repeat the steps made when updating your test
system. Updating a test system optimally prepared you for updating your productive system.
Again read the Release Notes of the new Automation Engine version after having updated your
productive system. They list all new functions. Use them and extend your processing. Automic
Support will be pleased to help you with any problem that may occur.
Enjoy using your new Automation Engine version.
See also:
Automation Engine
609
Procedure
1.
l
l
l
l
Attention:Verify that there is sufficient space and that the RT/RH tables can be stored in the
database before you convert the reports. RH stores the records of reports and RT stores the report
610
Chapter 8 Installation
l
l
text.
Log on to the database with the user that has all the required rights.
Manually execute the content of the file "do_report.sql" which was previously skipped. It converts
the report data. The conversion process includes two stored procedures that have been created
with the script "switch_report.sql".
Execute the stored procedure UC_PREPARE_COPY_REP using the following command:
Oracle:EXECUTE UC_PREPARE_COPY_REP;
MSSQL Server: exec UC_PREPARE_COPY_REP
In doing so, the temporary RH_TEMP and RH_TEMP2 tables are created. RH_TEMP is filled with
the contents of the RH_OLD table which includes the original report records. All agent records that
have already been converted using the stored procedures UC_GET_LAST_AGENT_LOG and UC_
WRITE_LAST_AGENT_LOG are deleted from RH_TEMP.
Call the stored procedure UC_WRITE_OLD_REP. Enter the number of records that should be
copied at once followed by the subsequent waiting time in seconds.
Oracle: EXECUTE UC_WRITE_OLD_REP(10000,1);
MS SQL Server: exec UC_WRITE_OLD_REP '10000', '00:00:01'
In doing, the first 10000 records of the RH_TEMP table are loaded to RH_TEMP2. These records
are copied from RH_OLD / RT_OLD to RH /RT which already has the new dataset of version
8.00A. The procedure then deletes the copied records from the temporary tables. If no error occurs,
this procedure continues until all data has been copied.
3.
Repair procedures can only be executed if the reports have been subsequently manually
converted.
Follow the steps below if the error message "ah for rh not found - use repair procedures" occurs in the
stored procedure UC_WRITE_OLD_REP.
l
Follow the steps that are described below if the error message "rh for rt not found - use repair procedures"
occurs in the stored procedure UC_WRITE_OLD_REP.
l
Execute the stored procedure UC_REPAIR_FILL_TEMP2. Enter the number of records that have
already been used for UC_WRITE_OLD_REP.
Oracle: EXECUTE UC_REPAIR_FILL_TEMP2(10000);
MSSQL Server: exec UC_REPAIR_FILL_TEMP2 10000
The temporary RH_TEMP2 table is filled with the records that caused an error.
Automation Engine
l
Erroneous records of the RH_TEMP2 table are removed from RT/RH. The RH_TEMP2 table is
emptied.
Use the following command again:
Oracle: EXECUTE UC_WRITE_OLD_REP(10000,1);
MS SQL Server: exec UC_WRITE_OLD_REP '10000', '00:00:01'
611
The temporary tables can be deleted from the database if the procedure has successfully been
completed (stored procedure UC_WRITE_OLD_REP). Doing so is important because it creates
disk space.
The file "do_report.sql" includes some commented DROP commands. Remove the comments and
execute the required lines manually in the AE database.
The following commands are available:
Oracle:
drop table ah_temp;
drop table rh_temp;
drop table rh_temp2;
drop table rt_old;
drop table rh_old;
MS SQL Server:
drop table ah_temp
GO
drop table rh_temp
GO
drop table rh_temp2
GO
drop table rt_old
GO
drop table rh_old
GO
612
Chapter 8 Installation
Automation Engine
613
Procedure
The table below contains the individual steps involved in changing the database. The steps are described
in detail in their own documents. The specified steps must be followed.
Close all components. Close all active tasks as well (Events, Schedule...). The table "EH" should
contain no data sets.
Check
Step
Computer
Required
any
yes
DB/Admin
yes
Admin
yes
Data of the existing database are unloaded with the utility AE DB Unload in order to assume them to the
newly set-up database.
Be sure to check if there is sufficient free space on the DB computer (maximal double the size of the
database).
l
Admin computer
614
Chapter 8 Installation
l
Adapt the INI file UCYBDBUN.ini to your environment. The entry OUTPUT= is very important, with
which you specify the path and the file name in which data are stored with it (Default:
OUTPUT=..\DB\UC_DATA.TXT).
Now start the service program AE DB Unload to unload the database.
l
The left half shows a listing of all database tables. With the button "Select All" you select all
tables and then you may start the process with "Export All Data".
l
The processing time depends on the database size.
Save the file after unloading.
l
l
DB computer
MS SQL Server must be correctly installed and ready to run
Installation settings:
l
Use standard code page
l
Standard Sorting, case insensitive (alphabetical order, regardless of case)
2.
l
l
DB computer
Create directory structure \AUTOMIC\DB
Start SQL Server if it has not already been started (ServiceManager)
3.
l
l
Requirements
DB computer
Start the SQL Server Database Management Program
Create the new database "AE". The size of the transaction log should be about 25% of the data-file
size (for test systems with truncate log).
4.
Admin computer
Create data source "AE" for ODBC access (64 bit ODBC)
Automation Engine
615
Admin computer
Copy all subdirectories from IMAGE:DB to \AUTOMIC\DB.
2.
l
l
l
Admin computer
Start the SQL Query Analyzer and select your newly created database.
Now open the file \AUTOMIC\DB\SQL_8\<vers>\UC_DDL.SQL and execute it.
3.
l
l
l
l
l
Admin computer
Change the ODBC data source to the new database.
Enter the connection information of the new database to the INI file of the utility AE DB Load. The
password can be encoded with the program UCYBCRYP.EXE.
Then start AE.DB Load and select the previously unloaded file (from the database used up to now standard: \DB\UC_DATA.TXT).
The loading process depends on the size of the database.
Now enter the new database in the INI files of the other utilities and Automation Engines.
Possible Problems
l
The code conversion was not set correctly when setting up ODBC access. Correct: No code
conversion takes place.
616
Chapter 9 ServiceManager
9 ServiceManager
9.1 ServiceManager- Service
The ServiceManager serves to start, stop and access components such as the Automation Engine
processes or agents from a central point.
You can specify the particular components in the definition file SMD. The ServiceManager starts the
programs in the background, grants access to particular properties and ends the program if necessary. It is
available for Windows and UNIX.
Install the ServiceManager program in Windows as a service. The AE components can then be
automatically started in the background during Windows system start-up without having to be entered as a
service.
A ServiceManager must be available on the same computer as the components which it uses. If the
components are installed on different hosts, you must install a ServiceManager on each of these
computers.
Select the start type "Automatic" in the service properties if the ServiceManager should be started together
with Windows,.
See also:
ServiceManager - Dialog Program
ServiceManager - Command Line Program
Automation Engine
617
The dialog program shows the states of all a ServiceManager environment's components (phrase). The
dialog program also provides access to ServiceManagers that run on other computers within the network.
Therefore, you can access Windows- and UNIX-based AE programs throughout the system. Access to
remote computers requires access rights which are also checked.
Dialog-program contents are periodically refreshed. All fields (except for the Computer Name field) are
empty if a ServiceManager is not active on the selected computer. An error message is displayed and the
fields remain empty if this computer has no access rights.
ServiceManager Window
Field/Column Description
Computer
Name
Input field for the name of the computer on which the ServiceManager is installed. You
can also select from existing entries.
Optionally, you can specify the ServiceManager's port number (for example,
PC01:8871).
Phrase
Service
Status
618
Chapter 9 ServiceManager
Start Time
Runtime
ProcID
CPU Time
Adding Components
First select a computer, then the phrase. The table displays the components you selected. components
must be added to this table in order to be displayed by the dialog program. By default, some entries (such
as work and communication processes) are already included.
Right-click on an existing table entry and select the Duplicate command. A new line is immediately
created. Assign a suitable name so that this component can easily be found in the list. Now reopen the
context menu and select the Properties... command. Enter the start path and other parameters in the
dialog.
Field/Column Description
Automation Engine
Command
619
Text field
below
Command
This area can be used to define several start methods for server processes. Select
them by right-clicking the server process. The following parameters can be used to
define a start method that executes a cold start; the INIfile remains unchanged.
Highlight the top line of the text field and right-click it. Use the Insert command to insert
lines. Assign a name for the start method. The name you selected here is then
displayed in the context menu. The Command field content corresponds to the
Command field that is described above. You can also enter the file name, the path to
the INI file if needed, and the start parameter -svc%port%. The following parameters
are also available:
Syntax:
-parm"StartMode=value;SystemStop=Value"
Allowed values for StartMode=: "NORMAL" (regular start) and "COLD" (cold start)
Allowed values for SystemStop=: "NORMAL" (client status remains unchanged) and
"YES" (all clients are stopped)
The default value for both arguments is "NORMAL".
Both arguments are also available in the INI file. The values that are specified in the
ServiceManager dialog are given priority.
You can specify one or both arguments.
Start Path
Log On As
User name
Password
Domain
620
Chapter 9 ServiceManager
Start
automatically
...
Check box for the automatic start of the service along with the system.
Seconds
delayed
If this check box is selected, the service automatically starts when the system
launches. If the service is only needed temporarily (such as for tests), the program can
be started and stopped via the popup menu.
If the service appears in the first line of the dialog program, the indicated value is the
waiting time for the start of the first service after the ServiceManager has been
activated. In other cases, it represents the time lag until the service that is listed in the
line above it has started.
The command file Phrase.SMC is automatically created as soon as properties are changed for the first
time. The file name corresponds to the ServiceManager environment. This file must not be changed
manually.
See also:
ServiceManager - Service
ServiceManager - Command Line Program
Starting and Ending Server Processes
Automation Engine
621
10 Start Parameters
10.1 Start Parameters - Automation Engine and
UserInterface
Program
Start Parameter
Description
Automation Engine
Communication process
UCSRVCP.EXE
Work process
UCSRVWP.EXE
The start parameters for the UserInterface can be used:
l
l
l
Program
Start
Parameter
UserInterface -V
UCDJ.JAR
Description
Prints the Automation Engine version and hotfix number in the following
format:
"AE OM-UserInterface AE Version plus hotfix number"
-VPath and
file name
This prints the Automation Engine version and hotfix. number to the
specified file in the following format:
"AE OM-UserInterface AE Version plus hotfix number"
-IFile name
The INI file path and name or the configuration file uc4config.xml.
You can use the parameter -l directly in the INI file in the line cmd= in
order to specify a particular configuration file for the UserInterface. Each
user can individually create his/her own uc4config.xml with all the
particular preferential settings.
-OFile
name
-LLanguage Language
Allowed values: "D", "E", "F"
"D" = German, "E" = English, "F" = French
-Cmmmm
-Dmmmm
622
-SAE
System
-UUser
name
Program
Start
Description
Parameter
Java loader
-F0
of the
UserInterface
UCDJ.EXE
-IPath and
file name
J
Parameter
For example:
The adequate language should be specified using User shortcuts.
INI-file abstract:
cmd="javaw" -Xmx1024m com.uc4.ucdf.UCDialogFactory U%User%
A shortcut serves to pre-determine the language:
ucdj.exe -F0 -J"-LD"
Automation Engine
623
See also:
Start Parameters - Agents
Start Parameters - Utilities
Start Parameters - ServiceManager
Start
Description
Parameter
BS2000 agent
-IFile
name
PSagent
Xmx256m
UNIX agent
File name
VMS agent
/INI=File
name
/VER
Windows agent
-IFile
name
-v
-V
See also:
Start Parameters - Automation Engine and UserInterface
Start Parameters - Utilities
Start Parameters - ServiceManager
624
Start Parameters
Start parameters can also be assigned to the utility via the Java loader:
Program Start
Description
Parameter
Java
loader of
the utility
-F0
-IPath and
file name
The path and name of the INI file for the Java loader.
Automation Engine
J
Parameter
625
Examples:
The required language should be specified via a shortcut.
INI file abstract:
cmd="javaw" -jar -cp .;.\UC4LAF.jar UCYBDBar.jar
The language is predetermined via a shortcut:
UCYBDBarg.exe -F0 -J"-LD"
If an INI file is specified for the utility, the parameter -I must be used twice.
This is also necessary if the Java loader and the utility use the same INI
file.
Examples:
Both use the same INI file:
ucybdbccg -IUCYBDBCC.ini -J"-IUCYBDBCC.ini"
Different INI files are used:
ucybdbccg -IUCYBDBCC.ini -J"-Iclientcopy.ini"
AE DB Archive
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE.DB
Revision Report] [AE DB Unload] [AE.LogMix]
Syntax
Archiving mode:
UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm
Report mode:
UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm -XMode
UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm -Xlist [-OPath and
Filename][-YNumber]
UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm -Xunload [-OPath and
Filename] [-YNumber] -RRunID [-TTimezone] [-TYReport type]
UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm -Xmark -RRunID [TYReport type]
626
UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Xreport -NObject [T1yyyymmddhhmmss] [-T2yyyymmddhhmmss] [-PPath and file prefix]
Program
Start Parameter
Utility for
-V
database
archiving
UCYBDBAR.JAR
-VPath and file name
Description
Prints the Automation Engine version and hotfix number in
the following format:
"UCYBDBar version Automation Engine version plus hotfix
number"
Prints the Automation Engine version and hotfix number to
the specified file in the following format:
"UCYBDBar version Automation Engine version plus hotfix
number"
-IFile name
-LLanguage
Language
Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French
The language that is specified in the INI file is used if you
do not specify this parameter.
-B
Batch mode.
Archiving mode
-Smmmm
-Dmmmm
Report mode
-Smmmm
-Dmmmm
Automation Engine
-XMode
627
-YNumber
-YNumber
-RRunID
-TTimeZone
-TYReport type
-TYReport type
628
T1
yyyymmddhhmmss
The start date and the time for the Server reports that
should be selected.
T2
yyyymmddhhmmss
The end date and the time for the Server reports that should
be selected.
The path and the file prefix for the target file.
AEDB Change
[AE DB Archive] [AEDB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE.DB
Revision Report] [AE DB Unload] [AE.LogMix]
Syntax
UCYBCHNG [-V[Path and file name]] -B -1Script File -2Transport File [-3Output File] [-LLanguage]
Automation Engine
Program
Start Parameter
629
Description
Prints the Automation Engine version and the
hotfix number in the following format:
"UCYBChng version Automation Engine
version plus hotfix number"
-B
Batch mode.
-1Script File
-2Transport File
-3Output File
-LLanguage
Language
Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" =
French
The language that is specified in the INI file is
used if you do not specify this parameter.
For example:
ucybchng -b -1c:\AUTOMIC\uc_change.txt -2c:\AUTOMIC\uc_
transport.txt -3c:\AUTOMIC\uc_transport_new.txt
AE DB Client Copy
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE DB
Revision Report] [AE DB Unload] [AE.LogMix]
Syntax
Copy mode:
UCYBDBCC [-V[Path and file name]] [-IFile name] [-LLanguage] -B -C -Smmmm -Tmmmm -O [-M][-A][R] [-V] [-W]
Delete mode:
UCYBDBCC [-V[Path and file name]] [-IFile name] [-LLanguage] -B -E -Smmmm
UCYBDBCC [-V[Path and file name]] [-IFile name] [-LLanguage] -B -E -Tmmmm
Program
Start
Parameter
Description
630
Prints the Automation Engine version and the hotfix number in the
following format:
"UCYBDBcc version Automation Engine version plus hotfix number"
Prints the Automation Engine version and hotfix number to the
specified file in the following format:
"UCYBDBcc version Automation Engine version plus hotfix number"
-IFile name
-LLanguage Language
Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French
The language that is specified in the INI file is used if you do not
specify this parameter.
-B
-V
Copy mode
-C
-Smmmm
-Dmmmm
-Tmmmm
-O
Copies objects.
-M
Copies messages.
-A
-R
Resets password.
-V
-W
Automation Engine
631
Deletion
mode
-E
-Smmmm
-Dmmmm
-Tmmmm
You can define different databases for the source and the target in
the INI file. When you use the parameters -S or -D, the client in the
source database will be deleted; -T deletes the target database.
The same requirements apply for these parameters as in copy mode.
Examples:
Copy client:
The objects, statistics and reports of client 38 are copied to the new client number
2:
UCYBDBcc -B -C -S0038 -T0002 -O -A
Delete client:
Client 2 is deleted in the target database.
UCYBDBcc -B -E -T0002
AE DB Load
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE.DB
Revision Report] [AE DB Unload] [AE.LogMix]
Syntax
Loading the Transport Case / Initial Data:
UCYBDBLD [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Cmmmm [-EMode] [UName/Department] [-GName] [-AAccess] [-MAccess] -XFile name
Setting the authentication method:
UCYBDBLD [-V[Path and file name]] [-IFile name] [-LLanguage] -B -TAuthentication method-KCompany
key string
Program
Start Parameter
Description
Prints the Automation Engine version and the hotfix number in
the following format:
"UCYBDBld version Automation Engine version plus hotfix
number"
Prints the Automation Engine version and hotfix number to
the specified file in the following format:
"UCYBDBld version Automation Engine version plus hotfix
number"
-IFile name
632
-LLanguage
Language
Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French
The language that is specified in the INI file is used if you do
not specify this parameter.
-B
Batch mode
-Cmmmm
-EMode
U
Name/Department
-GName
If the user does not have access rights on object level, the
default user can be used instead.
If the user does not have access rights on object level, the
default group can be used instead.
-AAccess
-MAccess
-XFile name
The name of the file that should be loaded. Note that this start
parameter is obligatory.
Automation Engine
-TAuthentication
method
-KCompany key
string
633
Authentication details.
Only call the utility with these start parameters if the new
installation is made without using the UserInterface.
Both parameters should be used together.
Allowed values for -T: "NO", "LOCAL", "LOCAL_REMOTE"
and "PACKAGE"
The authentication method is specified with "NO", "LOCAL"
and "LOCAL_REMOTE". If you use "PACKAGE" you will
obtain a file that includes the company key.
Allowed values for -K:any characters (maximum 32
characters)
The company key is composed of this string.
Always specify a string for the company key even if
authentication (-TNO) is not used. Automic recommends
using the AE system name as company key.
Note that using these start parameters results in an error
when the initial data is loaded for the first time. Call the
utility in order to create the schema and then restart it in
order to set the authentication details.
For example:
Step 1: java -jar ucybdbld -B X/uc4/9.00A/Utility/db/general/9.00A/UC_UPD.TXT
Step 2: java -jar ucybdbld -B -TNO -Kabc
Alternately, you can also use the utility's graphical interface.
AE DB Reorg
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE.DB
Revision Report] [AE DB Unload] [AE.LogMix]
634
Syntax
UCYBDBRE [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm
Program
Start
Description
Parameter
Utility for
-V
database
reorganization
UCYBDBRE.JAR
-VPath
and file
name
-IFile
name
L
Language
Language
-B
Batch mode.
-Smmmm
-Dmmmm
Examples:
Client 98 is reorganized.
UCYBDBre -B -S0098
AE DB Reporting Tool
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE.DB
Revision Report] [AE DB Unload] [AE.LogMix]
Syntax
UCYBDBRT [-IFile name] [-LLanguage] [-Cmmmm]-XPath and filename [-Ryyyymmdd[hhmm]] [-S] [OPath and filename] [-TFile type]
Automation Engine
Program
Start Parameter
635
Description
The client number for processing.
Overwrites the client specified in the query
definition.
-LLanguage
Language
Allowed values: "D", "E", "F"
"D" = German, "E" = English, "F" = French
-Ryyyymmdd[hhmm]
-S
-TFile type
For example:
The analysis defined in the file jobtop10.d.xml is created for client 100.
UCYBDBRT -C0100 XC:\AUTOMIC\Utilities\analyses\jobtop10.d.xml
Syntax
UCYBDBRR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Cmmmm[-OPath and filename] [FType1,Type2,...] [-D1yyyymmddhhmmss] [-D2yyyymmddhhmmss] [-A] [-X]
Program
Start Parameter
Description
Prints the Automation Engine version and hotfix number in
the following format:
"UCYBDBRR version Automation Engine version plus
hotfix number"
636
-IPath and file name The path and the name of the INI file.
-LLanguage
Language
Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" = French
The language that is specified in the INI file is used if you do
not specify this parameter.
-B
Batch mode.
-Cmmmm
-FType1,Type2,...
Allowed values:
"ACCESS" - Unauthorized access
"CANCEL" - Aborts tasks
"CREATE" - Creates new objects
"DELETE" - Deletes objects
"IMPORT" - Imports objects
"MOVE" - Moves objects
"OBJ_MOD" - Object modifications
"RENAME" - Renames objects
"RESTART" - Restarts tasks
"RESTORE" - Restores objects
"RUN_MOD" - Modifies at runtime
"START" - Starts tasks
"TRNSPRT" -Transports objects
"USER" - Successful user logons and logoffs
The utility outputs all contents to the revision report if this
parameter is omitted or if -F* is used.
The start date and time for logging.
D1
Note that by default, the selection is not limited by a start
yyyymmddhhmmss
time. Automic strongly recommends specifying a start
time, as otherwise the Revision Report becomes very
voluminous.
The client's time zone is used. If there is no time zone
specification, the time zone of system client 0000 is
used. If there is also no time zone specification, UTC is
used.
Automation Engine
637
-X
Examples:
All revision information of client 1 between 01.05 00:00 and the current date are
output to a report.
UCYBDBRR -B -C0001 -O/uc4/reports/report01.txt D120040501000000
All start and restart points between 01.10. 08:00 and 01.10. 12:00 are output in a
report.
UCYBDBRR -B -LD -C0100 -FSTART,RESTART -D120041001080000 D220041001200000
AE DB Unload
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE.DB
Revision Report] [AE DB Unload] [AE.LogMix]
Syntax
UCYBDBUN [-V[Path and file name]] [-IFile name] [-LLanguage] -BMode [-D][-Cmmmm] [-XFile name] [K]
Program
Start Parameter
Utility for
-V
unloading the
database
UCYBDBUN.JAR
Description
Prints the Automation Engine version and
hotfix number in the following format:
"UCYBDBun version Automation Engine
version plus hotfix number"
638
-IFile name
-LLanguage
Language
Allowed values: "D", "E", "F"
"D" = German (Deutsch), "E" = English, "F" =
French
The language that is specified in the INI file is
used if you do not specify this parameter.
-BMode
-D
Automation Engine
-Cmmmm
639
-XFile name
-K
Examples:
The AE database is reorganized.
UCYBDBun -BREORG
Client 100 is reorganized. The utility can process this call because the parameter
suppress_output=1 has been specified in its INI file.
UCYBDBun -BREORG -C0100
The Transport Case of client 11 is unloaded and the utility uses the path and file
names that have been specified in the OUTPUT= section of the utility's INI file.
The Transport Case is cleared afterwards.
UCYBDBun -BTRANSPORT -D -C0011
With message U0021148, the utility reported an error in the folder structure of a
client. Therefore, the correction function is called.
UCYBDBun -BREPAIR
AE.LogMix
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE.DB
Revision Report] [AE DB Unload] [AE.LogMix]
640
Syntax
UCYBLGMX [-V[Path and filename]] -B-LPaths and names of log and trace file -FPath and name of the
target file
Program
Start Parameter
Description
-V
-B
Batch mode
For example:
Log files with the prefix "server" are combined in the target file uc4.txt.
UCYBLGMX -B -L"C:\AUTOMIC\report\server*" F"C:\AUTOMIC\report\uc4.txt"
See also:
l
l
l
Automation Engine
641
10.4 ServiceManager
This document lists and describes the start parameters of the Automic ServiceManager.
General
UNIX:
Starting the ServiceManagers: nohup ./ucybsmgr [-ipath and name of the INI file] phrase&
Windows:
Installing the service: UCYBSMGR[.EXE] -install phrase [-ipath and name of the INI file]
De-installing the service: UCYBSMGR[.EXE] -remove phrase
Syntax
Windows:
UCYBSMCL[.EXE] -cGET_PROCESS_LIST-hcomputer name-nphrase
UCYBSMCL[.EXE] -cSTART_PROCESS-hcomputer name-nphrase -sname of the service [ppassword]
UCYBSMCL[.EXE] -cSTOP_PROCESS-hcomputer name-nphrase -sname of the service [-m stop
mode] [-ppassword]
Unix:
ucybsmcl -cGET_PROCESS_LIST-hcomputer name:port number-nphrase
ucybsmcl -cSTART_PROCESS-hcomputer name:port number -nphrase -sname of the service [ppassword]
ucybsmcl -cSTOP_PROCESS-hcomputer name:port number-nphrase -sname of the service [-m
password] [-ppassword]
Parameter Descriptions
Start
Parameter
Assignment
-c
Description
Command that is to be processed.
This parameter must always be specified.
GET_PROCESS_
LIST
START_
PROCESS
Starts a service
642
Computer
This parameter must always be specified.
Computer name
Port number
-n
Phrase
-s
Name of the
service
End mode.
This parameter is optional for STOP_PROCESS.
Stop mode
-p
Password.
This parameter is optional for START_PROCESS and STOP_
PROCESS. For information on encrypting passwords, see
Encoding Passwords.
Password
Automation Engine
-sm
643
When you call the command line program using incorrect or missing parameters, a short help text will be
displayed that shows correct parameters and return codes.
Output
When you call the command line program with the GET_PROCESS_LIST command, the requested
information will be displayed line by line. It corresponds to the view of the ServiceManager Dialog program.
Output format
"Service""Status"["ProcID""Start time""Runtime""CPU Time"]
Column/Field
Description
Service
Status
Service status.
"R" = Running. Service is active.
"S" = Stopped. Service ended.
644
ProcID
Starttime
Runtime
CPU Time
Return Codes
Return code
Description
Examples
The first example retrieves all services that belong to the computer "WINW2K01" and the ServiceManager
environment "UC4P".
UCYBSMCL.EXE -c GET_PROCESS_LIST -h WINW2K01 -n UC4P
Output:
"UC4 CP1""R""1588""2004-04-0521:39""0/01:11""0/00:00:22.69"
"UC4 WP1" "R""3388""2004-04-0521:39""0/01:11""0/00:00:22.69"
"UC4 WP2" "R""1576""2004-04-0521:39""0/01:11""0/00:00:22.69"
"Win32-AgentWIN01""R""2708""2004-04-0521:40""0/01:11""0/00:00:01.31"
Automation Engine
645
"Win32-AgentWIN21""R""2392""2004-04-0521:40""0/01:10""0/00:00:01.30"
"Win32-AgentUC4MAIL""R""2932""2004-040521:40""0/01:10""0/00:00:01.31"
"SAPAgentC46""S"
"PeopleSoft-AgentPS01""S"
The second example terminates a UNIX agent normally.
./ucybsmcl -c STOP_PROCESS-hunixw2k01:8871-nuc4p-sunix01-mClose
See also:
l
l
l
l
l
l
l
ServiceManager - Service
ServiceManager - Dialog program
Starting and ending Server processes
Start Parameters - AE Server and UserInterface
Start Parameters - Agents
Start Parameters - Utilities
Encoding Passwords
646
11 System Monitoring
11.1 Changing the System Status
System Status Stop
The automatic processing of a client can be stopped. The status of the active tasks such as workflows,
Schedules and events changes and finally, these tasks show the status "STOP - Automatic processing
has been stopped.
While a client is being stopped, you can still activate tasks. Tasks such as Schedules, workflows, events,
groups or recurring tasks also obtain the status STOP. Individual tasks without superordinate tasks are
processed.
You can use the Go command in the Activity Window's context menu in order to release tasks. In this
case, they are processed although the system is stopped.
Handling
Description
UserInterface menu
To stop the system for a local client, select the Client Stop command in the
System menu.
You can change the system status of any client in the System Overview of
client 0000. Select the Client Stop command in a client's the context menu.
TOGGLE_SYSTEM_
STATUS
This script element is used to change the system status (parameter STOP)
from within a script.
The current status is stored in the variable UC_CLIENT_SETTINGS in the global value CLIENT_
STATUS.
System Status Go
A global start of automatic processing has the effect that all active tasks start that are in a STOP status.
The system does not distinguish whether they have individually been stopped or through a system-wide
stop.
l
l
l
Handling
Description
UserInterface menu
To start the system for a local client, select the Client Go command in the
System menu.
You can change the system status of any client in the System Overview of
client 0000. Select the Client Go command in the particular client's context
menu.
Automation Engine
TOGGLE_SYSTEM_
STATUS
647
This script element is used to change the system status (parameter GO) from
within a script.
The current status is stored in the variable UC_CLIENT_SETTINGS in the global value CLIENT_
STATUS.
Starting an Agent
General
l
Refer to the Installation Guide for more details about starting a certain agent.
ServiceManager
l
A ServiceManager is additionally available for starting agents on Windows and UNIX. You can
either use the graphical interface of the ServiceManager-Dialog Program or the Command Line
Program for this purpose.
Monitoring an Agent
System Overview
l
The System Overview provides a separate "Agents" category. Symbols show whether a
particular agent is active and information is provided about the computer on which the agent has
been installed.
ServiceManager
l
The ServiceManager Dialog Program also informs whether the agents are running or have been
stopped.
Script Element
l
You can also use the script element SYS_HOST_ALIVE to check if an agent is active.
Host Characteristics
l
In the host characteristics (UC_HOSTCHAR_DEFAULT), you can define the executable object
that should be activated when an agent is starts or ends (keys EXECUTE_ON_START and
EXECUTE_ON_END).
Stopping an Agent
System Overview
l
The "Agents" category of the System Overview provides the opportunity to stop agents.
ServiceManager
l
The ServiceManager Dialog Program or the Command Line Program can also be used to stop
agents.
648
Script Element
l
See also:
Agent
Automation Engine
649
12 Utilities
12.1 Utilities
Several utilities are available which support the handling of administrative tasks in AE. In batch mode,
these programs can be activated with start parameters. The table shown below describes the functions of
each utility. More detailed information is provided in the corresponding documents.
Utility
Description
AE DB Archive
AE DB Change
AE DB Client Copy
AE DB Load
Loads data
AE DB Reorg
AE DB Revision Report
AE DB Unload
AE LogMix
AE Reporting Tool
See also:
Installing Utilities (Windows)
Installing Utilities (UNIX)
12.2 AE DB Archive
12.2.1 AE DB Archive
Archiving
The utility AE DB Archive can be used to remove the increasing amounts of data from the AE database.
Archived data is still available for years, it is stored in 7 bit ASCII code and can be displayed using the
Archive Browser.
Log on to the utility using the client that should be archived. You can also archive the relevant data in batch
mode (see Start Parameters). The settings that are specified in the utility apply. End the utility and a dialog
displays in which you can store the particular settings.
650
Chapter 12 Utilities
Database fields that are written to archive files are separated by semicolons. If semicolons are also
used in the archive keywords, the separation of database fields is no longer unique. Therefore, the
utility AE DB Archive converts the semicolons that are used in archive keywords to commas.
Note that the INI file of the archiving program must also be adjusted.
External report analyses can also be made using the utility AE DB Archive.
Field/Control
Description
Table
Last
archiving
Current
number
Archiving Current specification of archiving criteria including the starting date for the
criteria
archiving process.
Number
after
archiving
Reset archive
flags
Number of data records that are not archived because of the specified criteria.
Automation Engine
Forecast
Archive
651
The window's status line displays how the archiving process is progressing. The
name of the current table, the total number of data records, the progress in percent
etc. are shown.
After a successful archiving run, the data records are marked with a flag. Before you start to reorganize
the data stock, you can specify that only data records should be taken into account that show the
archive flag. Use the parameter no_archive_check= for this purpose. It is available in theINI file of the
utility AE DB Reorg.
Settings
Use the menu command Settings to define the archiving parameters or double-click the particular entry in
the table.
Note that these settings only apply for the client that is logged on to the utility.
A particular period of time can be specified for all data records that should be archived. The hour 00:00
is the time format that is used in order to ensure that complete days are considered in calculations.
Messages Tab
Description
Field/Control
Element
Description
Archive
messages
Check this checkbox in order to signal that client messages should be archived.
Readmessages All read messages that are older than the specified number of days are archived.
Additionally, the date that corresponds to the specified number of days is displayed.
Unread
messages
All non-read messages that are older than the specified number of days are archived.
Additionally, the date that corresponds to the specified number of days is displayed.
652
Chapter 12 Utilities
Statistics Tab
Note that reports that correspond to the statistical data are also archived.
Description
Field/Control Description
Element
Archive
statistics
Check this checkbox to signal that the client's statistics should be archived.
Archive
statistics
older ...
All statistical data that is older than the specified number of days is archived.
Additionally, the date that corresponds to the specified number of days is displayed.
Archive Tab
The specified value applies to statistical and report data. The statistics and report data
of all deleted objects are also archived, regardless of the defined time period.
Automation Engine
653
Description
Field/Control Description
Element
Archive
directory
Selection field for the directory in which the archived data should be stored. Ensure that
the specified drive exists at the time of activation and that sufficient memory is
available.
Size of
Archive
654
Chapter 12 Utilities
Date format
Specification of the required date format (mask) for the output of date and time
specifications in the archived files.
If no particular date format is indicated, the format "Y.m.d H/M/S" is used (for example,
"2005.Aug.17 08/25/10").
Allowed date formats:
d Displays the day of the month as a two-figure number (01 31).
j
Forecast
A forecast can be created before the actual archiving process starts. The data records that should be
archived are counted in according with the specified settings and the results are displayed in tables. If data
Automation Engine
655
has already been archived for this client, the estimated amount of data and the estimated duration
(hours:minutes:seconds) of the archiving process is forecasted on the basis of this information.
As forecasts are created on the basis of the information that has been accumulated in previous archiving
processes, forecasts become more exact with each archiving process and the growing number of data
records that has already been archived.
See also:
General Procedure - Database Maintenance
Archive Browser
Structure of the Archived Folder
Start Parameters
Structure of the INI file, AE DB Archive
656
Chapter 12 Utilities
The maximum folder size (presetting = 650 megabytes) can also be defined in the Archive tab. If the data
to be archived exceeds the specified value, a new folder with the next consecutive number is created and
the archiving run is continued in this folder.
Numbering facilitates the filing of large archive stocks and makes it easier to retrieve data records. The
archiving number is also shown in the index file.
Use the Archive Browser to view the contents of archive folders.
Index-File Structure
Index files are generated when the statistic al records of the tables AH and RH are archived in order to
simplify searching and filtering data records in archive files Each index line refers to a data record in the
archive.
Description
Client
User
Department
Automation Engine
AType
SType
RunID
Host name
10
Parent ACT
11
Parent PRC
12
Archive Key 1
13
Archive Key 2
14
Object name
15
16
17
Archive number
18
Example
H2;1;LF;PROG;JPAK;GRP;1302137;;28.08.1998
10:31:42;0;0;;;LF.JP.GROUP;73837;2555;7;148
Description
Client
Report type
Object name
RunID
10
Archive number
11
Example
H3;98;JE01;MM.CHECK.FREE.SPACE;1000020;24.05.2000 12:56:03;24.05.2000
12:56:10;2820;39;12;151
657
658
Chapter 12 Utilities
Description
Client
User
Department
Source
Category
Type
Host
10
Message Text
Example
M;1;LF;PROG;15.03.99 09:43:54;Automation Engine;Report;Error;;U0011021 Host
'LFT40' is not active!
Description
Client
User/Department
Object name
RunID
Message Text
Example
M;100;MH/PROG;TESTJOB;454711222;15.03.99 09:43:54;nnn;This task was
modified by (MH).
See also:
General Procedure - Database Maintenance
Archive Browser
Archiving
Structure of the INI file, AE DB Archive
Automation Engine
659
The entry area Browser Filter contains fields for selecting the archive file folder and specifying search
criteria. The table area displays the data records that have been found. If a particular table line is selected,
the details are outputted in the data record area below.
The search progress and search results are displayed in the status bar (bottom window edge).
This Archive Browser contains the basic functions for analyzing AE archive files. You can modify this
program if you require additional functions. The source code of the Archive Browser is provided on the
AE CD in the folder "IMAGE:TOOLS\SOURCE\UCYBARBR". The source code is available in
Microsoft Visual Basic. The Archive Browser will be adjusted to the requirements of new versions but
no further development is planned.
See also:
660
Chapter 12 Utilities
Filter
You can define various filter criteria in the Archive Browser's upper area, depending on whether you intend
to search for statistical, report, message or comment data.
Column
Description
Client
User
Department
RunID/Add.
Info
Parent
(PROC)
Host
Name of an agent.
This entry is converted to upper-case
letters before the search starts.
Type
Subtype
Archive Key
1
Archive Key
2
Automation Engine
661
Type of report.
Procedure
1. Firstly, select the folder to be searched by the Archive Browser. Then specify the main folder (e.g.
C:\Archiving), a particular folder of a client (e.g. C:\Archiving\0098) or one of a particular archiving
run (C:\Archiving\0098\UC_ARCHIV_20060621_25). The search automatically includes all
subfolders.
2. Define whether statistical, report, message or comment data should be searched for.
3. You can limit the search result by specifying a maximum value for the lines that are found. Values
up to 9999 are possible.
4. Numerous filter criteria are provided which facilitate a selective search for data records. Some
fields can be inactive depending on whether you search for statistical, report, message or comment
data.
5. Press the button Refresh or the F5 key to start your search.
All data records that correspond to the specified criteria are displayed in the table area. The search stops if
the specified maximum number of hits is reached. The searching procedure can take a while, depending on
the amount of data to be searched and the specified maximum number of hits. You can cancel this
procedure using the "ESC" key. Thus, only the data records found before the search was ended are
displayed.
662
Chapter 12 Utilities
Clicking on a line in the table area lists detailed information in the data area. The table area additionally
provides a context menu which can be used to export the area's content to a text file or to search for a
content via the "Find" window:
Enter the term to be searched for in the data area. All specified terms are stored until the Archive Browser
is restarted. You can also specify the search direction (up, down, all) and whether or not upper and lower
case and only whole words should be considered.
See also:
Introduction
Automation Engine
663
664
Chapter 12 Utilities
Description
XRO_Client
Client
XRO_AH_Idnr
XRO_RType
Report type
XRO_System
XRO_OType
XRO_Object
XRO_HostDst
XRO_LoginDst
XRO_HostScr
XRO_LoginSrc
XRO_TimeStamp1
XRO_TimeStamp4
XRO_RetCode
XRO_Status
XRO_RRetCode
XRO_ReportSize
XRO_UserTime
XRO_KernelTime
XRO_CpuTime
XRO_Archive1
XRO_Archive2
XRO_CusStatus
Automation Engine
665
See also:
About Reports
Start Parameters
Procedure
1.
2.
3.
4.
666
Chapter 12 Utilities
The parameter -B starts the program in batch mode. -I serves to specify the INI file's path and name.
Complete path specifications are required for the files. The parameter -L is used to determine the log file's
language.
l
l
l
If the third parameter remains undefined, the name of the output file is the same as the name of the
input file plus the ending "_New" or "_Neu", depending on the language specified with the parameter -L.
Example: "uc_transport" (input file) becomes "uc_transport_New" (output file).
Example
ucybchng -b -1c:\transport\uc_change.txt -2c:\transport\uc_transport.txt 3c:\transport\uc_transport_new.txt
Return Codes
When processing has ended, the utility supplies a specific return code depending on the occurred
situation.
Return code
Description
The transport and the script file do not exist or cannot be opened.
See also:
Syntax of the script file
General procedure - Transport Case
Modifiable attributes
Start parameters
Structure of the INI file, AE.DB Change
Description/Format
Automation Engine
667
Object
type
Name
New
Value
The script file can contain comment lines. These lines must start with a semicolon.
You cannot assign abbreviations to AE DB Change. Always use complete attribute names (such as
"INT_ACCOUNT" instead of " INT_ACC").
Please note that you cannot change Pre- or Postconditions (or their values) of tasks inside of a
Workflow object with UC4.DB Change.
668
Chapter 12 Utilities
Apostrophes can be used instead of quotation marks to specify Old Value and New Value. This is
important when replacing strings containing quotation marks.
When you use the command REPLACE in combination with the attribute SCRIPT, you can only
replace complete scripting lines. The utility will not replace parts of scripts. REPLACE_PART can be
used for this purpose.
Job attributes
Workflow task's when they have been "JPCVALUE" followed by a colon and the name of the RA
overridden.
attribute for the Attribute.
If you change attributes for all Rapid Automation jobs or workflows by specifying * as the Name for the
change, the AE DB Change utility will make the changes you specify for all jobs or workflows that meet
the requirements you specify; even if they belong to different agents or agent types.
Many Rapid Automation agents include:
l
Tooltip text that displays attribute names when you hover the mouse over a field in the
UserInterface.
A list of attributes in the agent's documentation. Rapid Automation job attributes are not
documented in the Automation Engine documentation, because they each agent is versioned
separately and released on a different schedule than the Automation Engine.
Another way to retrieve the Rapid Automation attribute names including their values is to run the following
command in the AE database (replace the JOBNAME by the job's actual object name):
select OCV_VName,ocv_value from OCV,oh where OCV_OH_Idnr=OH_Idnr and oh_
name='JOBNAME'
Automation Engine
669
To change the connection and the login of SQL type Variable objects, you can use the keywords "SQL_
CONNECTION" and "SQL_LOGIN" for Attribute. You can either change the complete value (REPLACE)
or only part of the value (REPLACE_PART).
If a scripting file changes the same attribute several times, you must always use the original value as
the "Old Value". When an attributes is modified, the system reads the lines always from the source
transport file and not from the output file.
Use the attribute PSCRIPT in order to change the !Process of events.
Examples
In the job SAP.Job.2, the SAP target system changes from SAP1 to SAP2.
REPLACE JOBS, SAP.JOB.2, SAP_DST_SYSTEM, "SAP1", "SAP2"
The target host changes from FSU to FSB in all file transfers of the name FT*.
REPLACE JOBF, FT*, FT_DST_HOST, "FSU", "FSB"
The string TEST is replaced by REAL in all scripts of objects with the name EM*.
REPLACE_PART *, EM*, SCRIPT, "TEST", "REAL"
The modifiable attribute UC100T is replaced by UC100E in all objects.
REPLACE *, *, *, "UC100T", "UC100E"
The value of the workflow's object variable "HOST#" changes from "unix01" to "unix02".
REPLACE JOBP, MM.DAY, VALUE:HOST#, "unix01", "unix02".
In the job JOB.TEST.1, C:\Temp is replaced by D:\Temp.
REPLACE_PART JOBS, JOB.TEST.1, WIN_CMD, "C:\Temp", "D:\Temp"
670
Chapter 12 Utilities
See also:
General Procedure - Transport Case
Modifying Exported Data
Structure of the INI file, AE DB Change
Automation Engine
671
Copy
[Copy] [Delete]
You can use this utility to copy clients to the same or a different database. Objects, messages, statistics,
reports and Version Control objects that have not yet been deleted in the source client are copied.
Database connections to a different database server can be specified in the INI file. It is possible to copy
clients from an MS-SQL Server to an Oracle or DB2 database. Ensure that both AE databases are of the
same version. Only one log file is used for this process. It contains the message "U0036000 database
change to source" or "U0036000 database change to destination" so that entries can be distinguished.
Note that the value of the database trace must be set to at least 1 as otherwise, this message is not
inserted.
Control
Description
Copying objects
All objects without a deletion flag are copied. If host definitions are not available in
the destination client, these are logged in the log file.
Copying AE
Messages
Resetting
password
Copying AE
statistics/report
Copy VC
Objects
672
Chapter 12 Utilities
Objects are only assumed to a new client when they are copied for the first time. You can also specify that
messages, statistics, reports and Version Control objects are copied as well. Version Control objects can
only be assumed with the first copying process.Version Control objects cannot be copied subsequently.
This does not apply to messages, statistics and reports because the utility creates work files for them.
These files are saved in xml format and their names are composed of the client numbers of the source and
destination client (connected with an underscore). Copying from client 0003 to 0333 would create a file of
the name 0003_0333.xml, for example. Therefore, it is possible to copy messages, statistics and reports
subsequently. The work files can be deleted afterwards.
XML files are stored in the folder specified in theINI file using the parameter WorkTablePath=. The
utility does not create XML files if the indicated folder does not exist.
The following applies for subsequent copying processes:
l
l
l
Because objects are only assumed when they are copied for the first time, they are not considered
in subsequent copying processes.
In subsequent copying processes, the utility copies all messages that are available in the source
client when the process starts.
The statistics and reports are only assumed for objects that are copied for the first time. The utility
again copies the data records that are available in the source client at this point in time.
AE DB Client Copy skips data that is already available in the destination client.
Copying data subsequently is possible at any time.
Procedure
Copying a clients for the first time:
1.
2.
3.
4.
5.
The Log tab supplies more detailed information during the execution. A status bar shows the progress of
the client copying process in percent. All information shown in the log is also available in the log file.
Message U0036176 is a warning message that serves mere information purposes and can be ignored.
It is displayed when an object is no longer available or has been reorganized (e.g.: missing parent
statistics).
The destination client automatically stops while the utilty AE.DB ClientCopy is copying data even if
only the statistics and report data are assumed.
Delete
[Copy[Delete]
Automation Engine
673
The utility AE DB Client Copy can also be used to delete existing clients. The contents of all AE database
tables of the particular client are then deleted at once. Doing so blocks the database for quite some time
and affects system performance negatively. Automic strongly recommends unloading all reorganized data
before you start the deletion process. Once a client has been deleted, it cannot be restored because no
backup files are created for the database.
Highlight the client that should be deleted in the database list. Use the optional buttons in the Settings to
switch between source and destination database. Click "Delete client" to start the deletion process.
The Log tab provides more detailed information during the execution. A status bar shows the progress of
the deletion process in percent. All log information is also available in the log file.
See also:
Start Parameters
Structure of the INI file, AE DB Client Copy
Create Clients and Users
674
Chapter 12 Utilities
12.5 AE DB Load
12.5.1 AE DB Load
Loading Databases
The utility AE DB Load (UCYBDBLD) can be used to load data to the AE database for various purposes.
Start the program and select the file whose content should be loaded.
AE DB Load automatically identifies the loading type and provides the following functions:
l
During the installation process the utility creates the database scheme and loads INITIAL and
DEFAULT data. Selectthe file UC_UPD.TXT of the required version in the directory
DB\GENERAL.
Subsequently, you can also load the licenses to the database in the same way.
You can also load data has previously been unloaded by using AE DB Unload (such as the contents
of Transport cases or of selected tables) to the same or a different AE database. When converting
the Transport Case, the system creates the file UC_DATA.TXT_CONVERTED .
The utility AE DB Load can also be used for calculating the expected runtime (ERT). This can be
the case if "BATCH" has been specified for the calculation in the variable UC_CLIENT_
SETTINGS, entry "ERT_CALCULATION". The delivery directory includes the folder
DB\GENERAL\<version>. You can use the file UC_UPD_ESTIMATE_ERT.TXT which
automatically calculates the runtime and load it to your database.
Automation Engine
675
The file UC_UPD_ESTIMATE_ERT.TXT contains a line in the end which calls the ERT
calculation function. If you specify a particular client, the ERT calculation is made for this client.
For example:
ESTIMATE_ERT 1000
Loading a Transport Case requires that the target system has the same ServicePack version as the
source system or a later one.
The status line shows how the unloading process is proceeding. It displays the remaining time and
information about the data records.
Format:
Number of data records that have already been processed / total number of data records / (number of
subordinate data records)
A dialog displays if AE DB Load causes an SQL error while the database is updated (loading the initial
data). It includes the following buttons: Retry, Ignore and Cancel.
"Retry" repeats processing the SQL commands starting at the position where the error has occurred.
Processing continues if the problem does not occur again.
"Ignore" and "Cancel" can result in an inconsistent database condition. In this case, a corresponding
message displays. Confirm it if processing should be continued.
"Cancel" ends the process and the utility. Ignore skips the command that resulted in an error.
The utility displays the message U0038128 if a Transport Case should be loaded and revisioning has
been activated in the AE system. Do not cancel the utility AE DB Load. It starts loading as soon as the
data that is required for revisioning has been processed. This procedure ensures that no data that is
relevant for the revisioning process is lost even if objects are loaded several times. Depending on the
size of objects that should be loaded, this process can take some time.
An input mask displays in which you can select an authentication method if you use this utility in order to
update the database to version 8.00A or later. Enter the pass phrase in the text fields of the options Server
and Server and Agent. It is used to generate the CompanyKey. You can also specify the authentication
method subsequently. Refer to the chapter "Advanced Security" for more detailed information.
Whenever you load initial data to the AE database, a dialog displays in which you can configure ILM.
See also:
Starting in Batch Mode
Structure of the INI file, AE DB Load
676
Chapter 12 Utilities
12.6 AE DB Reorg
12.6.1 AE DB Reorg
Reorganization
Data can be reorganized by using the utility AE DB Reorg. It marks data records with a deletion flag in
accordance with the settings that have been specified.
You can use the parameter no_archive_check= in the program's INI file in order to define that only data
records are reorganized that have already been archived.
Log on to the utility using the client that should be reorganized. You can also reorganize in batch mode
(see Start Parameters).
Before you start this service program in batch mode, note that you must start it in regular mode at least
once in order to specify the settings you require.
Use the utility AE DB Unload to remove the marked data records from the database. This data is then
deleted throughout the AE system and in all clients.
Only have the utility AE DB Reorg reorganize reports if they should be reorganized before the statistical
records are reorganized. If this option is not activated, the utility reorganizes reports and statistical
records together.
Automation Engine
Field/Control
Description
Table
Last reorganization.
Date and time of the last reorganization run that has been made by
using the utility AE DB Unload.
Current number.
Criteria for
reorganization.
Number after
reorganization.
677
Forecast
This button activates the creation of a Forcast for the current data
stock
Reorganization
Settings
You can specify the reorganization parameters by using the menu command Settings. You can also
double-click the table entry in order to open the window in which you can specify your settings.
Note that these settings only apply to the client that you used to log on to the utility.
Note that the setting of the INI-file parameter auto_reorg= overrules the setting of the graphical
interface which determines a period of time (such as messages that are older than x days) provided
that the INI-file value is the lower value. The system always uses the lower value.
A particular period of time can be specified for all data records that should be reorganized. The hour
00:00 is the time that is used to ensure that complete days are considered in calculations.
678
Chapter 12 Utilities
Messages Tab
Description
Field/Control
Element
Description
Reorg messages
Use this checkbox to specify that the messages of the client are reorganized.
Unreadmessages All messages that have not yet been read and are older than the specified number
of days are reorganized. Additionally, the date that corresponds to the number of
days displays.
Read messages
All read messages that are older than the specified number of days are reorganized.
Additionally, the date thatcorresponds to the number of days displays.
Statistics Tab
Description
Field/Control Description
Element
Automation Engine
679
Reorg
statistics
You can use this check box to specify that the statistics of the client are reorganized.
Reorg
statistics
older ...
All statistical data that is older than the specified number of days will be reorganized.
Additionally, the date that corresponds to the number of days displays. Statistical data
that shows this or a more recent date is kept.
Keep last...
By using this option, you can specify that the last n statistical records of each object
that should be reorganized will be kept. This is useful for executable objects because in
doing so, you can keep statistical data and reports of processings that have run some
time ago.
At least the defined number of statistical records will be kept for all objects that should
be reorganized. All statistical records that are older or exceed the specified number will
be flagged for deletion
Note that the deletion flag is always set if you reorganize the reports that are related to the statistics
(RH/RT). It is set even if the reorganization of reports is not activated.
Reports Tab
Description
Field/Control Description
Element
Report
With this check box you can specify that the reports of the client are reorganized.
reorganization
Reorg reports
older ...
All reports that are older than the specified number of days are reorganized.
Additionally, the date that corresponds to the number of days displays.
Keep last...
You can also specify that the last n statistics of the object are not reorganized. This
function is suitable for tasks that have not been executed very often.
"Keep last..." refers to the reorganization period. It does not imply that all reports but
the last n reports are reorganized. In fact, the utility checks the number of reports
that lie within the reorganization period and keeps the last n reports.
680
Chapter 12 Utilities
Description
Field/Control Description
Element
Version
You can use this check box to specify that Version-Control objects of the client are
management reorganized.
object
reorganization
Reorg objects
older than ...
All Version-Control objects that are older than the specified number of days are
reorganized.
Additionally, the date that corresponds to the number of days displays.
You can also specify that the last n Version-Control objects are not reorganized. This
function is suitable for tasks that have not been changed very often.
"Keep last..." refers to the reorganization period. It does not imply that all versions
but the last n versions are reorganized. In fact, the utility checks the number of
versions that lie within the reorganization period and keeps the last n versions.
Automation Engine
681
Description
Field/Control
Element
Description
You can use this check box to specify that Object Audits of the client are
reorganized.
Reorg Object
All Object Audits that are older than the specified number of days are reorganized.
Audits older than ... Additionally, the date that corresponds to the number of days displays.
Only reorg revised
Object Audits
Using this option reorganizes only data that has previously been put out in reports
by using therevisioning program (UCYBDBRR.EXE).
Forecast
You can create a Forcast before you start the reorganization process. The data records that should be
reorganized are counted according to the specified settings and the results are displayed in tables.
Note that the setting "Keep last ..." is not included in Forcast calculations. It does not consider the
setting no_archive_check=1 which the utility uses to flag only the previously archived data records
with a deletion flag.
682
Chapter 12 Utilities
Technical aspects
l
Automic strongly recommends checking your database and log-file backups and database
consistency on a regular basis. You can do so by using the means that are available for the
particular database.
Indices should regularly be reorganized. Doing so increases performance and results in database
space that can be used more efficiently. You can also reorganize indices by using the means that
are available for the particular database (such as the Database Wizard for MS SQL Server).
See also:
General Procedure - Database Maintenance
Start Parameters
Structure of the INI file, AE DB Reorg
Object contents
Future executions
Past executions
You can define the contents and dimensions of your queries. For example, you can list all jobs that were
processed in a particular period of time or were created by a particular user. Queries always refer to one
client.
Automation Engine
683
Usage
The utility can be used via its graphical interface or in batch mode. The interface serves to generate and
store evaluation definitions (queries). Subsequently, the utility can be started by using start parameters
and the evaluation reports can be created. Data is retrieved from the client in which the query is defined. If
this should be done regularly, Automic recommends using an AE job which calls the utility. In doing so, the
further processing of report files becomes even easier. The formats CSV and HTML are available. A style
sheet of your choice can be specified for HTML, which is then integrated in the report file.
Important Notes
l
l
l
l
l
See also:
Graphical Interface of the Reporting Tool
Creating Evaluation Reports
684
Chapter 12 Utilities
Your queries for the evaluation reports are listed below the three main areas.
The right side of the view supplies information about your queries and can be used for the subsequent
modification of the corresponding criteria.
Depending on the language settings specified on your computer, the interface is displayed either in
German, English or French.
UNIX: Start the ReportingTool's interface via the Java Application Launcher using a console
command. The required file ucyrepg.jar is available in the utility folder.
Windows: Under Windows, you can start the interface by using the file "ucyrepg.exe" or
"ucyrepg.jar". They are both stored in the utility folder.
Note for Windows: A 32-bit Java version is required if you start the Reporting Tool's interface via the
file "ucyrepg.exe". This limitation does not apply if you use the file "ucyrepg.jar".
You can use the following command in order to start the utility (UNIX and Windows):
java -jar ./ucyrepg.jar
Automation Engine
685
Creating Queries
Call the required evaluation area by using the menu File -> New query or right-click the corresponding
submenu item in the left window half. An assistant opens and guides you through the various
specifications that can be made.
1. Assign a significant name for the query and a client. A period must be assigned in forecasts and
statistics. If you select the option "Today", the utility uses the current date for creating the report. If
you select "Now", the current date plus the time are used.
The specified client's time zone is used for evaluations. If it does not include any time-zone
specifications, the system uses the time zone of client 0.
2. Select the fields that should be shown in the evaluation report. Click the arrow buttons in order to
sort the columns.
Note that the utility automatically sorts columns if the parameter fixFieldOrder=1 has been
specified in the INI file.
3. Use the next mask in order to specify the filter criteria that should be used as the basis for the
evaluation.
Specify the object type Job in the filter criteria if the fields that should be shown in the evaluation
report occur in jobs. For example: Login object. The utility automatically inserts this filter criterion.
4. Determine the report name, the maximum number of lines that should be output and the output
order. The report format can also be specified. In HTML, you can also integrate a style sheet.
686
Chapter 12 Utilities
The Finish button stores the specified evaluation criteria. Specifications can be changed subsequently by
double-clicking the query. Stored queries are listed in the left window area below the corresponding
evaluation area. The right window then shows a list of all forms. Modify the settings if necessary and store
your modifications by using the shortcut CTRL-S or the corresponding command in the menu bar.
You can open several queries at a time. The tabs at the upper edge can be used to navigate between
the individual form sheets.
Query Files
The utility stores your queries in the subfolder "queries" in the form of XML files. The file endings depend
on the area that has been queried:
l
l
l
*.d.xml - definition
*.f.xml - forecast
*.s.xml - statistics
By calling the utility in batch mode using the specified evaluation criteria, you can create reports.
Example
The following example shows a query that returns a list of all a client's Jobs that use a particular host
(WIN01) in the evaluation report.
1. Create a new query, assign a suitable name and select a client.
2. Select the following fields that should be displayed in the output file: object name, object type, host
and host type.
3. Selection criteria: After selecting "Host" as a field in the evaluation report, the filter "Object type
corresponds to JOBS" is automatically inserted. You can select a particular host by adding the
criterion "Host corresponds to WIN01".
4. Determine a name for the output file and the maximum number of lines.
Call the utility (UCYBDBRT) in batch mode and indicate the created query file as a parameter in order to
create the evaluation report.
See also:
Task Evaluations
Creating Evaluation Reports
Automation Engine
687
In batch mode, this utility reads the information for the evaluation report directly from the AE database. You
can specify the parameters for the database in the corresponding configuration file UCYBDBRT.ini.
The following line shows an example. An evaluation report is created from the query defined for client 100
in the file jobtop10.d.xml.
UCYBDBRT -C0100 -XC:\AUTOMIC\Utilities\evaluation_reports\jobtop10.d.xml
The information that is provided in the report depends on the fields defined in your query. The fields shown
below are available:
Field
Description
Archive 1
Archive 2
Calendar in
the Workflow
Calendar in
the Schedule
Calendar
Name of the Calendar keyword in the Workflow.
keyword in the
Workflow
Calendar
Name of the superordinate Schedule's Calendar
keyword in the keyword.
Schedule
Changed by
Changed on
Created by
Earliest start
time
End time
Expected end
Expected
runtime
Expected start
time
Host
Host type
Job type.
Allowed values: "BS2000", "GCOS8", "JMX",
"MPE", "MVS", "NSK", "OA", "OS400", "R3",
"SIEBEL", "UNIX", "VMS" and "WINDOWS"
Int. account
Internal account.
Interval
688
Chapter 12 Utilities
Job content
Workflow
Last used on
Login object
Login: user
Object name
Object type
Output device
(R3_
ACTIVATE_
REPORT)
Report (R3_
ACTIVATE_
REPORT)
Return code
RunID
Runtime
SAP client
SAP user
Schedule
Start time in
the Schedule
Start time
Status
Time Event
Title
Version
Automation Engine
689
See also:
Task Evaluations
Graphical Interface of the Reporting Tool
XML Files of Queries
Start Parameters
Description
<?xml version="1.0"
encoding="UTF-8"
standalone="no"?>
XML Declaration
<QUERY
version="Automation Engine
version">
Automation Engine version of the utility which created the query file
Evaluation report
"style sheet" = directory and name of the style sheet that should be
integrated in the HTML file
"format" = file format of the report
Allowed values: "HTML" and "CSV"
Report file = directory and name of the file in which the evaluation
information is written. The directory must be an existing one.
<client>client</client>
<max_rows>lines</max_
rows>
<date>date</date>
<offset>time range</offset>
</reference>
<selection>
<include name="criterion"
value="value" />
</selection>
690
Chapter 12 Utilities
<output order="order"
sort="sorting">
</output>
</QUERY>
See also:
Evaluations about Tasks in the AE system
Graphical Interface of the Reporting Tool
Creating Evaluation Reports
Start Parameters
Automation Engine
691
Task starts
Modifications at runtime
Task abortions
Imported objects
Deleted objects
Object modifications
Accesses of any kind
Note that logging takes place internally. The collected data can be structured in a revision report using the
utility UCYBDBRR.EXE. These specific report files contain chronologically ascending lists which indicate
the point in time, the type of monitoring (e.g. task start) and the particular object. The individual columns
are separated by tabulators.
The revision program can be started from the command line with the corresponding parameters. You can
specify the period of time and areas should to be written in the revision report.
The utility AE DB Reorg also serves the reorganization of revised data (object audits).
No users can be added or removed from a UserGroup when the logging for revision reports has been
activated in the client. In this case, memberships can directly be specified in the User object.
692
Chapter 12 Utilities
Version Management is automatically activated when the logging for the Revision Report is activated.
It is required in order to compare objects and cannot be deactivated.
See also:
Monitored areas
Moving Objects
Source and target folder are recorded when objects are moved.
Automation Engine
693
Modifications at Runtime
Modifications at runtime are logged. This includes modifications made via monitors or concerning states.
In the case of JCL modifications, the JCL is not written to the revision report. It can be viewed in the object
report.
Task Abortion
Aborted tasks are registered.
Object Modifications
Changes of object definitions are logged (e.g. modifications of priority, start type etc.).
Exemptions:
l
l
l
l
The Revision Report informs about changes. You can also view the new and old values. The particular part
of the object's XML structure which contains the modified attribute is output for this purpose.
694
Chapter 12 Utilities
Note that accesses made to AE can only be logged if the entries SECURITY_AUDIT_FAILURE and
SECURITY_AUDIT_SUCCESS are activated in the variableUC_CLIENT_SETTINGS.
User Login/Logoff
Times of individual user logins and logoffs are also logged.
Note that manual modifications as well as modifications made via script elements are logged
(exemption: see "Object modifications").
See also:
Revision Report
Structure of XML Files for Imports and Exports
Automation Engine
695
Description
U5005005 Processing was canceled. The date definition is either invalid or does not have the
correct format (YYYYMMDDhhmmss).
10
U5005012 Processing was canceled. Versioning is in progress in client '&01'. Waiting for its
end is not possible because the Automation Engine is not active.
See also:
Revision Report
Monitored Areas
696
Chapter 12 Utilities
12.9 AE DB Unload
12.9.1 AE DB Unload
Unloading the Database
You can use the utility AE DB Unload (UCYBDBUN) in order to unload data from the AE database. Use
the various options that are available
The tables of the AE database are listed in the left half of the window. You can unload particular ones or all
of them. The utility generates a text file with the corresponding data. Define the output directory and file
name with the entry OUTPUT= in the INI file. These files can then be loaded to the database of another AE
system with the utility AE DB Load, for example.
Actions
Description
Selects or deselects the database tables that are listed in the left window.
Reorganize database
Removes all data that has been marked with a deletion marker using the utility
AE DB Reorg.
Automation Engine
Unload transport
container
697
AE DB Unload can also be used to reorganize the database. Data that has previously been marked with an
archive flag by the utility AE DB Archive or with a deletion marker by AE DB Reorg will then be deleted
from the database. This is a system-wide process applying for all clients. You can accelerate the
unloading process by avoiding the creation of REORG files with the parameter suppress_output=1 in the
INI file.
Note that reorganizing the database also includes reorganizing the objects that are in the Explorer's
Recycle Bin, statistical data and the corresponding reports.
Archive and reorg flags can also be reset AE system-wide and client-wide.
You can also unload objects that have been put to the Transport Case. A dialog is displayed in which you
can select whether the export refers to only one particular client or to all of them. If only one client is
concerned, select it from the list. Furthermore, you can also unload all objects (either from all clients or
from a particular one) without moving them to the Transport Case before.
A status line shows how the unloading process is proceeding. The remaining time as well as
information about the data records is provided.
Format:
Number of the data records that have already been processed / total number of data records / (number of
subordinate data records)
After the unloading process, you must restart the service program in order to facilitate further unloading
processes.
The utility AE DB Unload checks the Explorer's folder structure. It prints the message U0021148 to the
log file if it finds corrupt folder connections. Call the utility with the start parameter -BREPAIR in such
situations in order to have the folder structure automatically corrected.
See also:
Start Parameters
Structure of the INI file, AE DB Unload
Transport Case
12.10 AE.LogMix
12.10.1 Combining Report, Log and Trace Files
All components write information about their activities to reports, log and trace files. There is no common
overview which makes analyses more difficult. This becomes obvious in Server processes which are
698
Chapter 12 Utilities
Procedure
Unloading reports upon request
AE DB Archive provides parameters which can be used to limit the report selection. You can filter by
object names, server processes or agents, or the period of report creation. The utility searches reports that
were completely or partially created during the specified interval and unloads the respective complete
report content to a log file.
A separate file is created for each report.
The generated files obtain special names. The prefix can be freely selected and AE.LogMix retrieves the
files to be combined on the basis of this name prefix. The full name also includes the object name and time
of report creation.
Example:
server_UC4#WP001_20070215_123045.txt
The utility aborts if the output directory already contains a file of the same name.
To unload the reports, call the utility AE DB Archive with the following command-line syntax:
UCYBDBAR -B -Xreport -CClient -NServer names [-D1Start date and time] [-D2End date and time] [PPath and file prefix]
More detailed information is provided in the documentation about start parameters.
The progress of file creation is output in the utility's log file in percent.
As a result, the directory specified when calling the utility now contains several report files.
Generating a common file
AE.LogMix is able to integrate several report, log or trace files into one file.
Use the following command-line syntax to call the utility AE.LogMix:
UCYBLGMX -B [-LPath and name of the files ] [-FPath and file name of the target file ]
The advantage of a defined name prefix now becomes obvious when selecting the files.
More detailed information about start parameters is provided in the documentation.
The result of this generation is a common file which contains the selected files in chronological order. This
file starts with a list of all files including numbers in order to ensure that the original files are traceable
although all entries have been rearranged. Each line starts with the number of the file from which the entry
has been taken.
Automation Engine
699
There can be time differences between the computers on which the components run. A message entry is
made in the report, log or trace file when such a time difference has been identified. AE.LogMix considers
this deviation in time in its chronological order. The entry's time stamp is not changed but a "T" is used to
flag the relevant lines.
Example:
Trace 01: C:\AUTOMIC\REPORTS\TRACES\WPSRV_TRC_001_##.TXT
Trace 02: C:\AUTOMIC\REPORTS\TRACES\WPSRV_TRC_002_##.TXT
Trace 03: C:\AUTOMIC\REPORTS\TRACES\WPSRV_TRC_003_##.TXT
02 - 20060620/163723.373 - U0003450 TRACE file was opened using the
switches '2400090000000000'.
01 - 20060620/163723.373 - U0003491 Time difference '0/00:02:11' or '131'
seconds to the Primary Server
03 T 20060620/163723.373 - U0009909 TRACE: (BINDPAR: MQSRV_System
)
F074F57D 000008
Time-difference calculations are always based on the primary work process (PWP). The first PWP found
in file processing counts. This first identified time difference is used for the chronological order even if there
is a PWP change to a different work process within the files.
Return Codes
AE DB Archive:
Return code Description
1
Parameter -C is missing
Parameter -N is missing
The file cannot be created because the name is too long on account of the defined prefix.
AE.LogMix:
Return code
Description
The parameter -L has not been specified and no INI-file values have been defined.
700
Chapter Glossary
Glossary
This glossary lists all specific technical terms in alphabetical order.
ABCDEFGHIJKLMNOPQRSTUVWXYZ
.1 A
l
AE Script
The Automation Engine's scripting language.
AE Variables
These are Variable objects that include the AE system's specifications.
AE component
Refers to AE programs such as UserInterfaces, the AutomationEngine, Agents, ServiceManagers,
utilities etc.
AE 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.
AE priority
Affects the order of task execution within an AE system.
AE system
An environment that is managed by AE components.
Action Definition Editor
An Editor for <Actions>
Action Service
A service which is able to respond (send) information to other systems, in contrast to the
<Response Service>, the service is configured using the incoming <event object>
Activity Window
A UserInterface window that displays all activated tasks.
AgentGroup
An AgentGroup combines agents of the same platform. The agents that shoulg be included in an
AgentGroup are specified by entering the agent name or via filters. A task which runs in an
AgentGroup is processed on one or all of the AgentGroup's agents, depending on the specified
mode.
Auto Forecast
It displays tasks that will run in a predetermined period. Comprehensive forecast for all future
activities.
Automation Engine
This component drives a AE system and consists of different types of server processes.
Automation Engine
A separate Automic product that can be used to control, administer and operate an AE system. You
can define and schedule objects that run processes and activities on different hosts.
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
Automation Engine
depend on the settings that have been specified (for example, the generated JCL, modified
Variables).
activity
An activity (or task) is an entity, which can be planned, assigned to a user or a team and tracked
with respect to their plan and state (started, cancelled, suspended, completed).
agent
A program that enables the de-centralized execution of processes (e.g. deployments) on target
systems (computers or business solutions) or a service that provides connectivity to a target
system (e.g. for databases or middleware). A particular AE 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.
.2 B
l
701
batch mode
This refers to the sequential background processing of tasks.
702
Chapter Glossary
.3 C
l
Calendar
It consists of days using Calendar keywords. A particular AE object type.
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 AE system.
CallOperator
Deprecated Term. Replaced by: Notification
Client Queue
Queue object which is available inside every client.
Cockpit
It visualizes the values and states of the AE or of the monitored and controlled system. A particular
AE object type.
CodeTable
It defines a complete set of characters. A particular AE object type.
calendar condition
The criteria for running a task is based on calendar keywords.
child / children
These are objects that are activated by superordinate tasks (parents).
client
This is a closed environment for the execution of tasks within an AE system. A particular AE object
type.
communication process
A communication process is part of the component Automation Engine. It is responsible for
connecting the AE components.
.4 D
l
Deployment
The creation of infrastructure for a specific set of <EventBases> on a <worker>
DevOps
DevOps is the combination of development and operations in a single role.
DialogClient
Deprecated Term. Replaced by: UserInterface
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 Automation Engine component and a special form of work process. Is exclusively
responsible for UserInterface messages.
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.
Automation Engine
703
.5 E
l
E-mail connection
This is a functionality of Windows and UNIX Agents that is used to send e-mails.
Enterprise Control Center
A separate Automic product. Web application that allows access to the functions of various
Automation Engine applications and products in a quick and easy way. Available for download from
the Automic Download Center.
Event
Action that is triggered if particular conditions apply. A particular Automation Engineobject type.
Event ID
First RunID of FileSystem and Console Events. Both Event types require communication between
the component Automation Engine and Agent. They communicate via the first RunID. Otherwise,
Event identification is no longer possible after the first log change.
Event Pattern Editor
An Editor for <Event Patterns>
Event Transformer
A <component> which is able to transform raw data to <event objects>
Exception Events View
View to observe occurred <exception events>
Executor
Deprecated Term. Replaced by: agent
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.
.6 F
l
FileTransfer
Transfers files from one computer to another. A particular AE object type (FileTransfer object).
Forecast
Estimates a task's runtime on the basis of previous executions.
fully qualified FileTransfer
File transfers without wildcard characters. One particular file is transferred (as opposed to partially
qualified file transfers).
704
Chapter Glossary
.7 G
l
Generic Socket
A <Socket> which both senses (receives) events from its predecessors as well as responds
(sends) evens to its successors
Graphical Workload Analyzer
Deprecated Term. Replaced by: UC4 ClearView
Group
Integrates tasks so that they can be processed together. A particular AE object type.
Group Monitor
Window that shows the state of tasks assigned to a group object.
.8 H
l
HTML Help
Microsoft help format for manuals. These help files have the ending .CHM (see also 'WebHelp').
host
Computer, target system.
host attributes
Platform-independent attributes of the Job object.
.9 I
l
Include
A script that is often used in several objects. A particular AE object type.
.10 J
l
Job
Processing on a target system. A particular AE object type.
Job Control Language
Short form of "Job Control Language". It refers to applications that are processing steps executed
on computers.
JobPlan
Deprecated Term. Replaced by: Workflow
Automation Engine
705
.11 K
l
Key column
Column in static Variable objects that can be used to access values of a particular line.
.12 L
l
Login
Login Objects store account credentials used by agents on target systems. A particular AE object
type.
logical date
The logical date is used as a comparison date for checking Calendar conditions.
.13 M
l
Message Window
UserInterface window that displays warnings, information and error messages.
Modelling Studio
An application which allows modeling of <EventBases> and managing the infrastructure of the
Policy Orchestrator and the associated <EventBases>
main types
Release, Package, Package Dependency, Applications, Applications Versions, Host, Host Role,
Component, Activity, Environment, Reservation and Workflow.
.14 N
l
706
Chapter Glossary
.15 O
l
Orchestration Editor
Editor to orchestrate EventBase components such as Maps and Sockets
object
Automation Engine 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 "Variables & Prompts" tab.
.16 P
l
Predictive Analytics
A separate UC4 product. It is a complex graphical analysis tool that produces various interactive
graphical representations, called visualizations, of a data set. The visualizations can show both
individual data values or aggregations, depending on which functions and features that you use. If
the special eventBase for SLA results data is implemented in your company, you can retrieve and
view advanced analytics that show you patterns and trends in SLA historical performance.
Available for download from the UC4 Download Center.
Process Assembly
A perspective of the Enterprise Control Center. You use it to create, define and modify workflows.
Process Automation
The old name of the Service Catalog perspective.
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).
ProcessFlow
Deprecated Term. Replaced by: Workflow
PromptSet
A user-defined input mask for executable objects. A AE 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.
package content
A package may reference applications, components and related packages.
package dependency
A package milestone may depend upon another package to have passed a specific milestone.
Automation Engine
l
707
package milestone
Since packages define a state machine, they need some sort of timely order. Milestones are used
for this.
packages
Delivery package, a bundle of functionality.
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
File transfers that use wildcard characters in order to transfer several files (as opposed to fully
qualified file transfers)..
period container
Controls the execution of periodical tasks.
perspective
Separate functional area of the Enterprise Control Center's (ECC) web interface. The perspectives
Process Automation and Process Monitoring provide functionalities of the Automation Platform.
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 AE-internal tasks and work processes.
.17 Q
l
Queue
A particular AE object type. In AE, a Queue determines the maximum number of concurrent tasks,
their priorities and the order in which tasks should be executed. In ARA, queues are containers for
workflow executions. Queues are intended to run repeatedly within a planned timeframe. The
assigned workflow executions are grouped together and are processed when the current queue run
starts.
QueueManager
Deprecated Term. Replaced by: RemoteTaskManager
.18 R
l
RA Agent
An agent that can be connected to a particular RA Solution and thus provide this solution's
functionalities to an AE system. It is the interface between an external system / application /
platform and an AE system.
RA Solution
A solution that is based on the Rapid Automation Technology that allows the AE to access an
external system / application / platform. The RA Solution is supplied as a JAR file that must be
loaded to the AE database and connected with an RA agent. The specific RA objects (such as
Jobs, Connections, Agent) are available in the AE system as soon as the solution has been loaded.
708
Chapter Glossary
l
Rapid Automation
A generic technology that can include various solutions. Is composed of an RA Agent and an RA
Solution.
Release Manager
Deprecated Term. Replaced by: Application Release Automation
Release Notes
Release Notes contain information about highlights, new functions, improvements, and corrections
for various versions and releases of the Automic procuct family.
Release Orchestrator
The Application Release Automation is split into the two products Release Orchestrator and
Deployment Manager. The Release Orchestrator can be used to manage release plans and release
content for single or multiple application releases etc.
RemoteTaskManager
It monitors and controls external Jobs that were not started by the Automation Engine. A particular
AE object type.
Response Service
A service which is able to respond (send) information back to other systems, in contrast to the
Action service, most of its configuration has to be done manually in advance.
Rule Editor
An editor for <Rules>
Rule Space Editor
An editor for <Rule Spaces>
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 Automation Engine component .
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.
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.
report
A report provides more detailed information about a task's execution or an AE component.
restart
A restart refers to the repetition of an object's execution. This action differs from a new start in
some parts.
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.
return code
The value that represents the result of tasks and script functions.
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).
Automation Engine
709
.19 S
l
Schedule
It starts executable objects periodically. A particular AE object type.
Schedule Monitor
Graphical view of the execution of Schedule objects.
Scheduler
A <component> which is able to send events in regular fashion or at specific points in time
Script
A script processes statements in the AE's script language. A particular AE object type.
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.
Service Orchestrator
An Automic product. The Service Orchestrator is a perspective of the Enterprise Control Centers
(ECC) and it is used to handle, monitor and analyze the performance of SLAs (Service Level
Agreements).
ServiceManager
A program that facilitates the starts and stops of AE components.
Sync
It synchronizes executable objects based on defined states and actions. A particular AE object
type.
Sync Monitor
Window which contains the state of a Sync object and the assigned tasks.
System Overview
The UserInterface window that contains information about the AE system.
script variable
A placeholder for a value within a script.
server process
The core of the component Automation Engine. Different types are available: communication, work
and dialog processes, as well as nonstop processes.
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.
superordinate task
There are various ways of activating objects. The originator of the activation is referred to as the
superordinate task (parent).
.20 T
l
TimeZone
It defines a local time. A particular AE object type.
710
Chapter Glossary
l
task
An executable object that is running. Tasks are also referred to as activities.
.21 U
l
Automation Engine
l
.22 V
l
711
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.
712
Chapter Glossary
.23 W
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.
Workflow
It refers to the execution of processes. A particular UC4 object type.
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 component Automation Engine. It is responsible for a UC4 system's processes (see
also 'Primary work process').
workflow monitor
Graphical view of a workflow's execution. It shows the workflow structure and the progress of the
child tasks.
.24 X
l
XML file
A format for imports and exports. An XML file contains object structures.