Automation - Engine Administration Guide en

Automation Engine 11
ONE Automation Platform
Administration Guide
Version: 11.2.2
Publication Date: 2016-10
Automic Software GmbH
ii Copyright
Copyright
Automic® and the Automic logo® are trademarks owned by Automic Software GmbH (Automic). All such
trademarks can be used by permission only and are subject to the written license terms. This
software/computer program is proprietary and confidential to Automic Software and is only available for
access and use under approved written license terms.
This software/computer program is further protected by copyright laws, international treaties and other
domestic and international laws and any unauthorized access or use gives rise to civil and criminal
penalties. Unauthorized copying or other reproduction of any form (in whole or in part), disassembly,
decompilation, reverse engineering, modification, and development of any derivative works are all strictly
prohibited, and any party or person engaging in such will be prosecuted by Automic.
No liability is accepted for any changes, mistakes, printing or production errors. Reproduction in whole or
in part without permission is prohibited.
© Copyright Automic Software GmbH. All rights reserved.

Automation Engine iii
Contents
1 System Client 0000 1
2 Authorization System 3
2.1 Introduction 3
2.2 Planning an Authorization System 3
2.3 Newly Created Users 4
2.4 Creating Users and User Groups 5
2.5 Assigning Access Rights for Folders 7
2.6 Access to Objects 8
2.7 Agent Rights 10
2.8 Passwords 11
2.8.1 User Passwords 11
2.9 LDAP Connection Setup 12
2.9.1 General 12
Importing and Installing SSL Certificates 12
Activate the LDAP connection for your AE system. 12
LDAP Synchronization with Technical User Credentials 12
2.9.2 Procedure Active Directory 13
Specify the connection data: 13
Setting up the LDAP connection in User objects: 13
2.9.3 Procedure Oracle Directory Server 14
Specify the connection data: 14
Setting up the LDAP connection in User objects: 14
2.9.4 Comments 15
3 Configuration 16
3.1 Structure Of Configuration Files 16
3.1.1 Notes for Configuration-File Adjustments 16
3.1.2 Automation Engines 17
Structure of the Automation Engine INI File 17
Structure of the INI File UCSRV.INI 17
Example of an INI File 27
3.1.3 UserInterface 29
UserInterface 29
iv Contents
Structure of uc4config.xml 29
UserInterface 33
UserInterface (Windows) 35
Structure of the INI File UCDJ.INI 35
Structure of the BAT File UCDJ.BAT 38
Example of a BAT File 38
3.1.4 Agents 38
BS2000 Agent 38
Structure of the INI File x.xxx.UCXJB2?.INI 39
Database Agent 45
Structure of the INI File UCXJSQLX.INI 45
GCOS8 Agent 51
Structure of the INI File UCXJGC8I 51
JMX Agent 56
Structure of UCXJJMX.INI 56
NSK Agent 60
Structure of the INI File UCXJNS1I 61
OS/400 Agent 68
Structure of the INI File UCXJO41 68
People Soft Agent 74
Structure of the INI File UCXJPSX.INI 74
RA Agent 80
Structure of UCXJCITX.INI 80
SAP Agent 84
Structure of the INI File UCXJR3X.INI 84

Automation Engine v
Siebel Agent 92
Structure of the INI File UCXJSLX.INI 92
UNIX Agent 97
Structure of the INI File UCXJXXX.ini 97
VMS Agent 109
Structure of the INI File UCXJV??.INI 109
Windows Agent 117
z/OS Agent 126
Structure of the INI File UCXJM25.INI 126
z/OS - Event Monitor 138
Structure of the INI File UCXEM25.INI 138
z/OS - External Job Monitor 143
Structure of the INI File UC4EJM.INI 143
3.1.5 Utilities 147
AE DB Archive 147
AE DB Change 156
AE DB Client Copy 157
AE DB Load 162
AE DB Reorg 167
Structure of the INI File UCYBDBRE.ini 167
AE DB Reporting Tool 172
AE DB Revision Report 177
AE DB Unload 180
Utility for the Console Event (UCON Connection) 186
Structure of the INI File x.xxx.UCXEB2?U.INI 186
3.1.6 ServiceManager 188

vi Contents
ServiceManager - Service 188
Structure of the INI File UCYBSMGR.INI 188
Example of an INI File (Windows) 190
Setting Up an SMD File 190
Setting Up an SMC File 193
ServiceManager - Dialog Program 194
3.1.7 CallAPI 195
Utility for BS2000 195
Structure of the INI File x.xxx.UCXBB2?C.INI 195
Utility for GCOS8 196
Structure of the INI File UCXBGC8CI 196
Utility for Java 198
Structure of the INI File UCXBXXXC.INI 198
Example INI File 199
Utility for NSK 199
Structure of the INI File UCXBNS1I 199
Utility for z/OS 201
Structure of the INI File UCXBM25C.INI 201
Activating Trace for z/OS CallAPI Utility 202
Utility for OS/400 202
Structure of the INI File 202
Utility for UNIX 204
Structure of the INI File UCXBXXXC.ini 204
Utility for VMS 206
Structure of the INI File UCXBVXXC.INI 206
Utility for VSE 208
Structure of the INI File UCXBVSE.INI 208

Automation Engine vii
Utility for Windows 210
Structure of the INI File UCXBXXXC.INI 210
Example INI File 211
RFC Server 211
Structure of the INI File UCXSAPC.INI 211
Connect for WebSphere MQ Queue Manager (Windows) 214
Structure of the INI File UCXBMQCX.INI 214
3.1.8 EMI - External Monitoring Interface 217
External Monitoring Interface Configuration 217
Structure of the File emi.ini 217
Comments 220
3.2 Settings in Variables 221
3.2.1 Settings in Variables 221
3.2.2 UC_AGENT_ASSIGNMENT - Agent Assignment 223
3.2.3 UC_AS_SETTINGS - Advanced Security 224
3.2.4 UC_AUTO_FORECAST - Auto Forecast Data 225
3.2.5 UC_CALENDAR_PERIOD - Calendar Periods 225
3.2.6 UC_CLIENT_SETTINGS - Various Client Settings 226
3.2.7 UC_CUSTOM_ATTRIBUTES 247
3.2.8 UC_EX_ERP_CONNECT - Connection to Enterprise Business Solutions 250
3.2.9 UC_EX_HOSTCHAR - Assigning Agents to Host Characteristics 251
3.2.10 UC_EXT_INTERPRETERS_* - Register External Interpreters 252
3.2.11 UC_HOSTCHAR_DEFAULT - Host Characteristics 254
3.2.12 UC_ILM_CONTAINER_* - Automation Engine Database Partitions 264
3.2.13 UC_ILM_SETTINGS - Settings for Partitioning with ILM 265
3.2.14 UC_JOB_CHECKINTERVAL - Periodic Time Check in the Automation Engine 268
3.2.15 UC_KDC_SETTINGS - Single Sign-On 268
3.2.16 UC_LDAP_EXAMPLE - LDAP Connection Variable 269
3.2.17 UC_LOGIN_TYPES - Defining Additional Platform and System Types for Login
Objects 272
3.2.18 UC_OBJECT_COUNTER - Counter Reading in Object Name 272

viii Contents
3.2.19 UC_OBJECT_DOCU - Object Documentation 273
3.2.20 UC_OBJECT_TEMPLATE - Object Types and Templates 274
3.2.21 UC_REPORT_STYLESHEETS - Style Sheets for XML Reports 276
3.2.22 UC_SAP_JXBP_EVENTTYPES - Event Types of the Java Scheduler in SAP 277
3.2.23 UC_SENDTO and UC_SENDTO_ACT - Handling Objects and Tasks

Internally/Externally 277
3.2.24 UC_SNMP_VALUES - SNMP Values 279
3.2.25 UC_STATISTIC_OPTIONS - Controlling the Statistics Functions 280
3.2.26 UC_SYSTEM_SETTINGS - System-Wide Settings 280
3.2.27 UC_USER_LOGON - Single Logon 298
3.2.28 UC_UTILITY_ARCHIVE - Archiving Specifications 300
3.2.29 UC_UTILITY_DB_UNLOAD - Executed Reorganization Runs 301
3.2.30 UC_UTILITY_REORG - Reorganization Specifications 301
3.3 Configuration & Performance 302
3.3.1 Configuration & Performance of the Database 302
DB2 302
Notes 303
MS SQL Server 303
Notes 304
Oracle 304
Notes 305
Oracle Parameters 305
3.3.2 Configuration & Performance of the DB Server 329
3.3.3 Configuration & Performance of the Automation Engine 329
3.3.4 Configuration & Performance of the UserInterface 330
4 Database 332
4.1 Overview 332
4.2 Encoding Passwords 332
4.3 Creating an ODBC Data Source 333
4.4 Database Rights for the Automation Engine 336
4.5 Database Maintenance 337
4.5.1 Technical Maintenance of the AE Database 337
4.5.2 Maintaining Data Records 340
4.5.3 Maintaining Data Records 341

Automation Engine ix
4.5.4 Partitioning with ILM 343
Procedure 347
Important Note for MS SQL Server 347
4.6 Transporting Data 348
4.6.1 General Procedure 348
5 Diagnostic Tools 350
5.1 Logging/Trace 350
5.2 LOG_DUMP 351
5.3 TRACE 352
5.4 TRACE_DUMP 354
6 Encryption and Authentication 357
6.1 Advanced Security 357
6.2 Specifying the Authentication Method for the First Time 359
6.3 Changing the Authentication Method 361
7 Enterprise Control Center 364
7.1 Enterprise Control Center (ECC) 364
8 Installation 368
8.1 Supported Platforms 368
8.2 New Installation 371
8.2.1 ONE Installer - Single-Box Installation 371
8.2.2 Prior to Installation 380
Introduction 380
General Information 380
Computers in the Automation Engine Environment 380
File Structure 381
New Installation Procedure 381
8.2.3 Installation Procedure 383
Setting Up the Database 383
DB2 383
MS SQL Server 385
Disk Space Required 386
Procedure 386
ORACLE 387
Utilities 391
x Contents
Installing Utilities (UNIX) 391
Procedure 391
Installing Utilities (Windows) 394
Supplied Files 394
Procedure 394
Loading the AE Database 396
Installing the Automation Engine 397
Installing the Automation Engine for UNIX 397
Requirements 398
Supplied Files 398
Procedure 398
Possible Problems 402
Installing the Automation Engine for Windows 402
Requirements 403
Supplied Files 403
Procedure 403
See also: 404
Distributed Server Environment 404
JWP Installation 406
General 406
Files Provided 406
Installation 406
Unpack the files 406
MS SQL Server 407
Oracle 408
DB2 408
Add certificates for SSL 409
Start the JWP 409
Installing the UserInterface 410
Installing the UserInterface (UNIX) 410
Installing the UserInterface (Windows) 413
Supplied Files 414
Procedure 414
Potential Problems 415

Automation Engine xi
Setting up Single Sign-On 417
Generate key tab file 419
Installing the Online Documentation 423
WebHelp Browser Compatibility 423
Documentation Formats 423
Documentation Types 424
Supplied Files 425
Deciding on a Location for Your Documentation 425
Installing the Automation Engine Guides in WebHelp Format 425
Copying the Automation Engine PDF Guides 426
Copying and Unzipping the Automation Engine Messages in WebHelp Format 426
Copying and Unzipping the Automation Engine Release Notes 426
Using the WebHelp format online on docs.automic.com with F1-key 426
Installing the Agents 427
Installing the Agent for BS2000 427
Procedure 428
Installing the Agent for Databases 429
Installing the Agent for Database Jobs and Events 429
Installing the Agent for Database Variables 433
Installing the Agent for GCOS8 436
Installing the Agent for J2EE/JMX 438
Setting Up the Agent for J2EE/JMX 438
Usage with Application Server 440
Setting Up the Agent for J2EE/JMX (Oracle WebLogic) 440
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with RMI Connector 441
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with SOAP Connector 444
Setting Up the Agent for J2EE/JMX (JBoss) 447
Setting up the Agent for J2EE/JMX (Oracle Containers for J2EE) 449
Setting up the Agent for J2EE/JMX (SAP NetWeaver) 450
Setting Up the Agent for J2EE/JMX (Tomcat) 454
Web Configuration Interface for the J2EE/JMX Agent 455
Installing the Agent for NSK 457
Procedure 457
Installing the Agent for OS/400 460

xii Contents
Procedure 461
Installing the Agent for PeopleSoft 463
Installing the Agent for People Soft (UNIX) - Basics 463
Installing the Agent for People Soft (UNIX) - Details 465
Installing the Agent for People Soft (Windows) - Basics 472
Installing the Agent for People Soft (Windows) - Details 475
Automation Engine Interface 481
Creating Java Classes 485
Setting Up the Agent for Rapid Automation 486
Installing the Agent for SAP 488
Preparing Installation - Check List 488
Installing the Agent for SAP - Basics 490
Installing the Agent for SAP - Details 491
Installing the Agent for Siebel (Windows) 495
Procedure 496
Installing the Agent for UNIX 497
Procedure 498
Installing the Agent for VMS 500
Procedure 501
Installing the Agent for Windows 504
Procedure 505
Installing the Agent for z/OS 507
8.2.4 Load Module: 508
Procedure 508
Installing the ServiceManager 514
Installing the ServiceManager (UNIX) 514
Installing the ServiceManager (Windows) 515
Supplied Files 515
Procedure 516
Uninstalling the ServiceManager 518
See also: 518
Installing the CallAPIs 518
Installing the CallAPI for BS2000 518

Automation Engine xiii
Installing the CallAPI for GCOS8 519
Installing the CallAPI for Java 520
Installing the CallAPI for NSK 521
Installing the CallAPI for z/OS 522
Installing the CallAPI for OS/400 522
Installing the CallAPI for SAP 523
Installing the CallAPI for UNIX 528
Supplied Files 528
Procedure 528
Installing the CallAPI for VMS 529
Installing the CallAPI for VSE 530
Installing the CallAPI for Windows 532
Connect for WebSphere MQ (Windows) 533
Steps for Starting Operation 534
CallAPI for WebSphere MQ (Windows) 534
Installing the AE.ResourceAdapter (IBM WebSphere) 536
Supplied File 536
Procedure 536
Installation 539
Installing the AE Internal Webservice (Glassfish) 539
Installing the AE Internal Webservice (IBM WAS CE) 540
Installing the AE Internal Webservice (JBoss) 541
Installing the Internal Webservice (SAP Netweaver) 542
Installing the AE Internal Webservice (Tomcat) 543
Configuration WebInterface for the Internal Web Service 544
E-mail Connection 546
Configuration 547
Cluster 547
Automation Engine and Clusters 547
An Automation Engine System in a Windows Cluster 549
Preparations 549
Configuring AE in a Cluster 549
8.2.5 After Installation 554
Creating AE Clients and Users 554

xiv Contents
Comments 555
Configuring your AE System 555
General 555
Database 555
Settings 556
Server 556
Monitoring and Control 556
Auditing 556
User 557
8.3 Hotfix Installation 557
8.3.1 Installing Hotfixes 557
8.3.2 Shutting Down and Storing Automation Engine 558
8.3.3 Utilities 559
Installing Utilities (UNIX) 559
Requirements 559
Supplied Files 559
Procedure 559
Installing Utilities (Windows) 560
Supplied Files 560
Procedure 560
8.3.4 Changing the Database 561
8.3.5 Installing the Automation Engines 563
Installing the Automation Engine for UNIX 563
Supplied Files 563
Procedure 563
Installing the Automation Engine for Windows 564
Requirements 564
Supplied Files 564
8.3.6 Installing the UserInterface 564
Installing the UserInterface (UNIX) 564
Requirements 564
Supplied Files 565
Procedure 565
Installing the UserInterface (Windows) 566

Automation Engine xv
Supplied Files 566
Procedure 566
8.3.7 Installing the Online Documentation 567
8.3.8 Installing the Agents 567
Installing the Agent for BS2000 567
Requirements 567
Supplied Installation Files 568
Installing the Agent for Databases 569
Supplied Files 569
Installing the Agent for GCOS8 573
Requirements 573
Supplied Files 573
Procedure 573
Installing the Agent for J2EE/JMX 575
Stand-alone 575
Setting Up the Agent for J2EE/JMX 575
Usage with Application Server 577
Setting Up the Agent for J2EE/JMX (Oracle WebLogic) 577
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with RMI Connector 578
Setting Up the Agent for J2EE/JMX (IBM WebSphere) with SOAP Connector 580
Setting Up the Agent for J2EE/JMX (JBoss) 584
Setting Up the Agent for J2EE/JMX (Oracle Containers for J2EE) 585
Setting Up the Agent for J2EE/JMX (SAP NetWeaver) 586
Setting Up the Agent for J2EE/JMX (Tomcat) 589
Installing the Agent for NSK 590
Requirements 590
Supplied Files 590
Installing the Agent for OS/400 594
Requirements 594
Supplied Files 594
Method 1 595
Method 2 596
Installing the Agent for PeopleSoft 596
Installing the Agent for People Soft (UNIX) 596

xvi Contents
Installing the Agent for People Soft (Windows) 597
Procedure 598
Setting Up the Agent for Rapid Automation 598
Supplied Files 598
Procedure 598
Installing the Agent for SAP 600
Requirements (UNIX) 600
Supplied Files 600
Procedure 600
Installing the Agent for Siebel (Windows) 601
Procedure 602
Installing the Agent for UNIX 602
Requirements 602
Installing the Agent for VMS 603
Requirements 603
Installing the Agent for Windows 605
Windows Agent for System-Wide E-mail Connection 605
Procedure 605
Installing the Agent for z/OS 606
Requirements 606
Supplied Files 606
Load Module: 606
8.3.9 Installing the ServiceManager 609
Installing the ServiceManager (UNIX) 609
Supplied Files 609
Steps 610
Installing the ServiceManager (Windows) 610
Supplied Files 610
Uninstalling the ServiceManager 611

Automation Engine xvii
8.3.10 Comparing Messages 611
8.4 Upgrade Installation 612
8.4.1 Zero Downtime Upgrade 612
Upgrade Process 612
Overview 612
Comments 613
Preliminary Steps 614
The Upgrading Steps 619
Rollback Option 622
FAQ - Zero Downtime Upgrade 624
8.4.2 Upgrading an AE System from Version 11.1 626
Preliminary Information 626
The Installation Steps 628
General 637
Files Provided 637
Installation 637
MS SQL Server 637
Oracle 637
DB2 637
Start the JWP 637
8.4.3 Upgrading an AE System from Version 10 639
General 658
Files Provided 658
Installation 658
MS SQL Server 658
Oracle 658
DB2 658
Start the JWP 658

xviii Contents
8.4.4 Upgrading an AE System from Version 9 660
General 682
Files Provided 682
Installation 682
MS SQL Server 682
Oracle 682
DB2 682
Start the JWP 682
8.5 Changing the Database 684
8.5.1 About Changing the Database 684
8.5.2 Unloading the Database 685
8.5.3 Setting Up the Database 685
8.5.4 Loading Database 686
9 ServiceManager 687
9.1 ServiceManager - Service 687
9.2 ServiceManager - Dialog Program 687
10 Start Parameters 692
10.1 Start Parameters - Automation Engine and UserInterface 692
10.2 Start Parameters - Agents 694
10.3 Start Parameters - Utilities 695
10.4 ServiceManager 712
11 System Monitoring 717
11.1 Changing the System Status 717
11.2 Handling Agents 718
11.3 EMI - External Monitoring Interface 719
11.3.1 EMI- External Monitoring Interface 719
What is JMX 719
Monitoring 720
Connection Failover Behavior 722
MBeans provided 722

Automation Engine xix
11.3.2 External Monitoring Interface Configuration 724
12 Utilities 728
12.1 Utilities 728
12.2 AE DB Archive 728
12.2.1 AE DB Archive 728
12.2.2 Archived Folder Structure 735
12.2.3 Archive Browser 738
Introduction 738
Searching for Archived Data 739
Filter 739
Procedure 740
Navigating in the Search Result 741
12.2.4 Open Interface to Output Management Systems 742
12.3 AE DB Change 744
12.3.1 AE DB Change 744
12.3.2 Syntax of Scripting Files 745
12.4 AE DB Client Copy 750
12.4.1 AE DB Client Copy 750
12.5 AE DB Load 754
12.5.1 AE DB Load 754
12.6 AE DB Reorg 756
12.6.1 AE DB Reorg 756
12.7 AE DB Reporting Tool 762
12.7.1 AE DB Reporting Tool 762
12.7.2 Graphical Interface of the Reporting Tool 764
12.7.3 Creating Evaluation Reports 766
12.7.4 XML Files of Queries 768
12.8 AE DB Revision Report 770
12.8.1 AE DB Revision Report 770
12.8.2 Monitored Areas 771
12.8.3 Creating Revision Reports 774
12.9 AE DB Unload 775
12.9.1 AE DB Unload 775
12.10 AE.LogMix 777

xx Contents
12.10.1 Combining Report, Log and Trace Files 777
Glossary 780
A 780
C 780
D 780
G 780
I 781
J 781
P 781
R 781
S 782
T 782
U 782
V 782
W 782
Chapter1 System Client 0000 | 1
1 System Client 0000

An AE system's client 0000 is also referred to as the system client. It is used to administer system-internal
objects and central settings. Some settings affect all existing clients if there are no local specifications
that have been made. Only the administrator is authorized to make modifications and extensions.
When you log in to the to the system client for the very first time, you use the user "UC" (department and
password are also "UC"). This user has all authorizations and privileges. For security reasons Automic
recommends changing the password immediately.
When you have logged on, you can create new clients and their first users only in the system client.
Then you use the context menu command Move user to client ... and assign the users to the related
clients. Provided that the individual user has sufficient rights, s/he can create all other users directly in
the relevant client.
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 Attribute dialogs for file transfers and jobs.
CODETABLE CodeTables for file transfers and jobs.
CONNECTIONS Connection objects
DIV_VARIABLES Various variables
EX_VARIABLES variables especially for agents.
HEADER Header includes for jobs.
HOLIDAY_CALE Calendars that include holidays and other useful calendar keywords.
HOST Objects of the installed agents and standard templates.
HOST_VARIABLES variables especially for computers.
PREP_PROCESS Event jobs
2 | Chapter 1 System Client 0000
RA_SOLUTIONS RA Solution objects.

RESTART Restart includes for jobs.
STYLESHEETS Stylesheets for XML reports.
TEMPLATE Templates for objects.
TRAILER Trailer includes for jobs.
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.
l 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.
l Search
It is only in the system client that you can search for Server objects and Agent objects.
l 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.
Chapter2 Authorization System | 3
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.
2.2 Planning an Authorization System

Before we start to explain details about where rights can be specified, this document lists some basic
matters about right assignment.
The following tips and tricks serve to support you in setting up your own authorization system:
l Start developing the structure of your authorization system immediately after installation and
before creating the first objects.
l 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.
l 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.
l 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.
4 | Chapter 2 Authorization System
l A naming convention can be based upon execution processes that should be handled by AE.
Names can include task areas, computer names, operating systems or company-internal terms.
Administrative rights can exclusively be assigned to objects whose names start with "ADMIN", for
example.
l Users play a crucial role in an authorization system. They should be administered via user groups
as this saves time, is more comprehensible and significantly increases your AE system's safety.
Authorizations that can be assigned to users are available in the form of rights for objects and
privileges for UserInterface functions (e.g. access to Transport Case).
l Folders are objects and therefore rights can be assigned to 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 of this folder (e.g. if it is used in a workflow. The "Edit"
command is available from almost anywhere, hence also in workflows). Therefore, objects that
should not be accessed by particular users should also be protected.
l Exclusively assign rights referring to object names and types.
2.3 Newly Created Users

The following applies for a newly created active (=can log on to the AE system) user who has not yet been
assigned any rights:
This user can ...

l view tasks in the Activity Window
l call Detail Windows of tasks
l create and delete forecasts of tasks
l export contents of the Activity Window in the form of lists
The user must not ...

l access any folder
l create or modify objects
l influence tasks (e.g. cancel them, change priorities, etc.)
l view statistics or reports of tasks
l call any commands of the context menu in the Activity Window
l import objects
l call the System Overview
l log on via a CallAPI
l view messages in the Message Window (except for those sent with :SEND_MSG)
l use the search function
l export the Explorer content as a list
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.
2.4 Creating Users and User Groups

Automic strongly recommends that you thoroughly plan your authorization system in a first step. Who
actually requires access to the AE system and which actions are required. Write down your findings -
doing so makes a lot easier to create users and user groups.
1. Creating user groups
You can assign right to users and user groups. By using user groups you can reduce your administrative
efforts. User groups 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 user groups, 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 user groups 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 user groups 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 Same authorization group:
Rights assigned to a user and the corresponding user groups accumulate.
For example:
User Smith is allowed to read and execute all objects whose names start with "MM" and to call their
statistics. Because the access rights write and delete were additionally defined for these "MM"
objects in one of his UserGroups, he is also allowed to write and delete them.
l Different authorization group:
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!
Whenever you define different authorization groups, the user is only granted the rights that are
granted in all of the groups.
Take the same example as described above:

User Smith is allowed to read and execute all objects whose names start with "MM" and call their
statistics. In one of the user groups he belongs to, the access rights read, execute, write and delete
have been defined for these objects. In total, user Smith can only read and execute these objects
(logical AND connection).
l Denials
Denials ("Not") are always given preferential attention. If an access denial applies to a user or one
of the corresponding user groups, 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 user groups 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 user groups, 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. Allocating users to UserGoups
There are two ways of assigning users to user groups. You can either select the groups to which a user
should belong to from within a user, or determine members from within a user group. Both options are
accessible through the UserGroup tab.
6. Access Trace Function
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.
2.5 Assigning Access Rights for Folders

When assigning access rights to folders, it is necessary to indicate a path which always starts with a
backslash ("\"). Note that subfolders are only included in the assigned access rights when the specified
path ends with a star ("*").
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.
2.6 Access to Objects

Authorizations for users and user groups can be defined on object level. By doing so, users and user
groups obtain exclusive access rights to a particular object.
This is a very restrictive function and should only be used in exceptional cases. If no access rights
have been defined for an object, it can be accessed by all authorized users. Objects including their
properties play an important role in the authorization system.
When accessing an object, the system first checks whether the user has the relevant right in the User
object. If so, the access rights are subsequently checked on object level.
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 Description
column
R Access type: Read
W Access type: Write
X Access type: Execute
D Access type: Delete
C Access type: Cancel
S Access to statistics
P Access to reports
M Access type: Modify at runtime
L 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.
2.7 Agent Rights

For reasons of security, a newly installed agent does not have any rights. It also cannot execute tasks and
cannot be selected in the objects of a client of the AE system.
The agent logs on to the AE system with an Agent object created in the folder HOST of the system client
0000. In each agent, you can define the clients that should be given access rights (Authorizations tab).
The access rights Read, Write and Execute are available:
l "Read" - The agent can send files (file transfer).

l "Write" - The agent can receive files (file transfer).
l "Execute" - The agent can execute jobs.
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 user groups, you can explicitly deny access to particular agents.
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
Lower case letters PWD_CONTAINS_LOWER_CASE
Upper case letters PWD_CONTAINS_UPPER_CASE
Special characters PWD_CONTAINS_SPECIAL_
CHARACTER
Forbid user name PWD_FORBID_LOGIN
Password history PWD_GENERATION
Interval in which passwords must be changed PWD_AGE_MAX
Number of login attempts PWD_ATTEMPTS_MAX
Default password for new users defined without a PWD_DEFAULT
password
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
2.9 LDAP Connection Setup

AE provides a client which authenticates login data using LDAP via the Microsoft Active Directory or, as of
version 11 also on Oracle Directory Server. The client is part of the Automation Engine. When logging on,
users are not authenticated in the Automation Engine but rather in Active Directory if the LDAP connection
is activated in the User object.
The LDAP connection supports the Microsoft Active Directory and, as of version 11, the Oracle
Directory Server.
As of version 11, you may synchronize LDAP data via SSL.
By default, the LDAP connection is not active.
An LDAP login via the AE is only possible, if the password includes characters of the code table you
use in your respective database.
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 or Oracle Directory Server, depends
on the settings made in the particular User object. Thus, AE distinguishes local and LDAP users.
Below you find the installation and configuration, differentiated by general setup and installation steps
required either for Active Directory or Oracle Directory Server respectively.
2.9.1 General
Importing and Installing SSL Certificates
In order to be able to use an Active Directory or Oracle Directory Server with LDAP over SSL, you will
have to be able to use a JWP (Java based Work Process). Details on the installation and import of the
necessary certificates you find in the JWP Installation section.
1. Import the certificates, as described in the JWP Installation section.

2. Create an LDAP Connection Variable with the following settings:
VERSION = 2
TLS = Y
USE_DISTINGUISHED_NAME = Y
SERVER = <hostname>:<sslport>
The default port for SSL is 636.
3. Open the User object, set the distinguished name for the user and activate the "LDAP connection"
checkbox.
Activate the LDAP connection for your AE system.

l 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.
LDAP Synchronization with Technical User Credentials

As of version 11 it is possible to have an additional LDAP technical user, who would be able to perform an
LDAP synchronization, in case the current user has not the permissions to do so.
Automic recommends this method over the individual User objects solution, since in the latter case a
user does not have the necessary credentials and therefore would be forced to log off the system and
log in again to enable the data synchronization.
Log in and log off will not be required, if the technical user credentials solution is used.
Create a technical user by creating and using a Login object.

Follow these steps:
l Create a Login object with specific credentials as technical user credentials.

l Register this Login object in the already existing UC_LDAP_Domain variable (s.a.), using the key
SYNC_LOGIN.
This Login object's credentials will be used instead of the current user's credentials for synchronizing
the LDAP information.
If the key SYNC_LOGIN is not specified in the variable or the Login object does not exist, the
credentials of the current user apply.
2.9.2 Procedure Active Directory

Specify the connection data:
1. Log on to system client 0000.
2. Switch to the folder "DIV_VARIABLES" and duplicate the variable UC_LDAP_EXAMPLE.
3. Name the copy "UC_LDAP_Domain". If the domain name is "SMITH", the variable would be called
"UC_LDAP_SMITH".
4. Open the variable and enter your connection data.
5. Store and close the variable.
Setting up the LDAP connection in User objects:

1. The User object must have the same name as the user in the Active Directory, in case the
distinguished name (DN) is not used. 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 theUser tab.
3. Activate the checkbox "LDAP connection". The input fields "First name", "Last name" and "Email1"
are locked, as their contents should be filled by the LDAP data in the Active Directory or on the
Oracle Directory Server. The locked fields are filled with data from the respective server, when the
synchronization is started.
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.
Logging off and in again to synchronize data is not required, if the technical user credentials
solution in the special Login object (register via SYNC_LOGIN in UC_LDAP_Domain variable) is
used, as described above in the "General" section.
The person who synchronizes the data of a User object with LDAP would also have to be an
LDAP user, if the Login object solution and technical user described above is not used.
The Active Directory does not use the second e-mail address. It can be used if required.
5. Store and close the User object.

6. Repeat all steps for additional users.
2.9.3 Procedure Oracle Directory Server

Specify the connection data:
2. Switch to the folder "DIV_VARIABLES" and duplicate the variable UC_LDAP_EXAMPLE.
3. 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.
4. Open the variable and enter your connection data.
5. Store and close the variable.
Setting up the LDAP connection in User objects:

1. The User object must have the same name as the user's distinguished name. Create a new User
object for yourself or rename your existing one.
The synchronization of data only works, if the "uid" and the User object's name are identical.
Example: uid=nga, ou=people, dc=example,dc=com. Thus the User object would have to be
named NGA/DEPARTMENT
2. Open the User object and switch to theUser tab.
3. Activate the checkbox "LDAP connection". The input fields "First name", "Last name", "Email1"
and "Email2" are locked, as their contents should be filled by the LDAP data in the respective
server directory. The locked fields are filled with data from the Oracle Directory Server, when the
synchronization is started.
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.
Logging off and in again to synchronize data is not required, if the technical user credentials
solution in the special Login object (register via SYNC_LOGIN in UC_LDAP_Domain variable) is
used, as described above in the "General" section.
The person who synchronizes the data of a User object with LDAP would also have to be an
LDAP user, if the Login object solution and technical user described above are not used.
5. Store and close the User object.

6. Repeat all steps for additional users.
2.9.4 Comments
The System Overview shows for each user whether or not the LDAP connection is active. You can
activate or deactivate it for individual users via the corresponding context menu command.
The checkbox "LDAP connection" is automatically deactivated, if User objects are exported,
transported or duplicated.
External password checks made via the AE Program Exit are called prior to the LDAP connection.
User data is stored in the object during the synchronization process with the LDAP server directory.
See also:
User
UC_LDAP_EXAMPLE
16 | 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 System name
l Definition of server processes and assignment of port numbers
l Names and port numbers of agents
l Names of log, trace and message files
l 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 Name of the AE system (system name)

l Wildcard character (#)
l Type of server process (WP for work process, CP for communication process)
l Three-digit process number which has been clearly defined for each process type
Example: UC4G#CP001
Chapter3 Configuration | 17
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".
3.1.2 Automation Engines

Structure of the Automation Engine INI File
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 the INI File UCSRV.INI
Section/Parameter 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.
logging= The path and the file name of the log file.
Any file name for a text file with several place holders for current system
information:
$$ is replaced by server process type (WP or CP).

* is replaced by the three-digit process number.
## is replaced by 00 after the existing log files' corresponding numbers have
been raised by one during startup. During server process startup, the log
files are given a temporary file name until the process number can be
determined.
The following rules apply for log-file names if a database agent is used for
variables and accesses this INI file (see section [DB_SERVICE] ):
$$ is replaced by "DB_SERVICE".
* has no functionality and is ignored (no character in the log-file name).
## is replaced by 00 when the agent starts, the number of the old log files
increases by one.
For relative path indications, the system uses the agent's installation
directory when it creates the database agent's log file.
logcount= Number of the stored log file.
helplib= Name of the message file.
helpcache= Availability of the messages and language dependent strings.
Allowed values: "ALL" (default value), "NONE", "CONTROLS"
"ALL" = The complete message file is held in the RAM.

"NONE" = Always read from the hard drive.
"CONTROLS" = All language dependant strings that are necessary in order
to display the dialog program are held in the RAM (not relevant for the
Automation Engine).
StartMode= AE system startup mode.
Allowed values: "NORMAL" (default value), "COLD"
"NORMAL" = Normal AE start

"COLD" = AE cold start. All task queues are cleared.
This parameter can also be handled via the ServiceManager Dialog. INI-
file values are ignored in this case.
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= The description of the dialog process environment.
Default value: UC4_1

PrimaryMode= The mode of the primary work process (PWP).

The primary work process serves to process special messages. This
parameter can be used to specify whether it should also serve as work
process.
Allowed values: "1" and "0" (default value)
"1" - The PWP processes only own messages. This is only possible if a
further work process is active.
"0" - The PWP also processes messages which can generally be
processed by work processes.
exception= Checks internal messages for valid contents.
"0" - Internal message check has been deactivated.

"1" - Messages are checked and put in quarantine if necessary.
With this option being activated, messages that caused a server process
crash are intercepted. Doing so protects your AE system because these
messages cannot affect your server processes.
Note that this setting can negatively affect performance on UNIX.

SystemStop= Client handling after Server-process start.
Allowed values: "NORMAL" (default value) and "YES"
"NORMAL" - Client status remains unchanged.

"YES" - All clients are stopped after Server-process start.
Note that the value "YES" overrides the settings that have been made in
the key STARTUP_ACTION of the variable UC_CLIENT_SETTINGS.
This parameter can also be handled via the ServiceManager Dialog. The
value specified in the INI file is ignored in this case.
[CPMsgTypes]
srvquery= Performance optimization if many (several thousand) agents log on at the
same time.
Allowed values: "0" (default value) and "1"
"0" - The primary work process responds to the agents' live messages.
"1" - The communication processes can process these specific messages
and in doing so, they increase the AE system performance.
[CACHE]
script= The maximum cache size (bytes) for script.
vara= The maximum cache size (bytes) for variables.
mqmem= The maximum cache size (in bytes) for the message queue.
[TRACE]
file= The path and the file name of the trace file.
Any file name for a text file with several place holders for current system
information:
$$ is replaced by server process type (WP or CP).

* is replaced by the three-digit process number.
## is replaced by 00 after the available trace files' corresponding numbers
have been raised by one during startup of a trace.
trccount= The number of stored trace files.
tcp/ip= Trace flags of the Automation Engine.
database=
Set trace flags only in close cooperation with Automic Support.
trc03=
srcall=
memio=
jcl=
memsv=
snmp=
zuxml=
cache=
trc11=
ucds=
xscript=
uc4global=
trc15=
trc16=
[TCP/IP]
pwpport= The port number of the primary work process.
bindaddr= The IP address or host name for Server-process connection.
Use this parameter if a connection should be established via a particular IP

address (for example, the computer has more than one network interface
card).
All work processes including the primary work process must be bound
to the same IP address.
You can also specify the IP address or host name in pwpport= and in all
parameters of section [PORTS] (Format: pwpport=IP address:port or
DNS name:port). Specifications that have been made in bindaddr= are
then ignored.
bindlocal= Consideration of local host (127.0.0.1).
Use this parameter together with bindaddr=.
Allowed values: "0", "1" (default value)
"0" - No listen socket is created.

"1" - An additional listen socket is created on the local host.
report= The time interval in seconds in which the Automation Engine saves the
logging to the database.
Default value: 20 seconds

connect= The time interval in seconds for reorganization of server process links
following a loss of connection.

chiffre= Encryption for transfer.
"0" = Non-encrypted transfer.

"1" = Transfers are encrypted.
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= This parameter is exclusively used by work processes. They cyclically try
to connect to primary-work-process port at system start or when the
connection has been lost.
Format: (number, interval)

number = Maximum number of PWP connection attempts to the port.

interval = Waiting time from one attempt to the next one in seconds.
hostname= If you use this parameter, the UserInterfaces, CallAPIS and agents receive
the information about the CPs that are known in the system via host name
and port and not via the IP address and port during the CP selection phase
while the connection to the Automation Engine is being established. In
doing so, you can avoid firewall and other NATproblems.
Set hostname=*OWN if you want the operating system to retrieve the host
name on which the CP is running.
alivetimeout= The duration in seconds in which the AE.Nonstop-Server expects a
message from the primary work process. If this time span is exceeded, the
AE.Nonstop-Server becomes the primary work process.
Be careful when you change this parameter. The selected time span
should be high enough because the primary work process is busy for
quite some time if comprehensive database transactions take place and
cannot send keep-alive messages.
snmp= The port number that the Automation Engine uses in order to connect to the
AE SNMP Subagent.
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.

listenqueue= The maximum number of login requests in the list queue.
A request is stored in a list queue from the point in time that a component's
login request is received until the login is acknowledged. This parameter
can be used to determine the maximum number of requests that can be
stored in the queue at the same time.
Default value : 2030

maxMsgSize= Maximum length of messages (in bytes) that a CP (Server communication
process) accepts.
Default value: 3 145 728 (3 Mbytes)

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= The name of the net area of the server processes.
Default value: Name of the AE system
This value affects the CP selection of components such as agents. For

more detailed information about this parameter, see Net Areas in AE.
Note that only CPs can use different net areas. All an AE system's
WPs must use the same NetArea definition.
The name of the net areas is shown in the System Overviewof the
server processes.
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.

SendBufferSize= The size of the TCP/IP input buffer for the messages that should be sent (in
bytes).

RecvBufferSize= The size of the TCP/IP input buffer for the message that should be received
(in bytes).

[PORTS]
cp1= ... cpn= Assignment of communication processes and port numbers.
The port number within an AE system must be explicit, even if the system
is distributed over several computers.
wp1= ... wpn= Assignment of work processes and port numbers.
The port number within an AE system must be explicit, even if the system
is distributed over several computers.
[ODBC]
SQLDRIVERCONNECT Connection for the database.

=
ODBCVAR - Eight figure command field for controlling database accesses.
1. Position = N - Do not use server cursor.

1. Position = S - Use server cursor (MS SQL Server 2000).
2. Position = N - Do not reestablish database connection after 1000
commits.
2. Position = D - Disconnect database after 1000 commits (perhaps
due to memory problems).
3. Position = N - Field names are compared case-sensitively
(Oracle).
3. Position = J - Field names are compared case-insensitively
(Oracle).
4. Position = N - Not used.
5. Position = N - Type of database connection: ODBC.
5. Position = I - Type of database connection: OCI/CLI.
6. Position = N - Database access without User ID.
6. Position = O - Database access with User ID.
7. Position = N - Compression is deactivated.
7. Position = R - Compression is activated.
8. Position = Type of SQL Syntax; N - MS SQL Server.
8. Position = Type of SQL Syntax; O - Oracle.
8. Position = Type of SQL Syntax; D - DB2.
DSN - Alias name of the database connection.

UID - User ID for database access.
PWD - Password for database access. Should always (also "") be
encoded.See: Encoding passwords
Only for MS SQL Server 2005:

For optimal performance values, Automic strongly recommends using the
option MARS_CONNECTION=Yes.
For example:
(Two lines are used for the connection parameters for reasons of space. In
the INI file, you should only use one line).
SQLDRIVERCONNECT=ODBCVAR=NNNNNNRN,DSN=UC4;UID=uc4;
PWD=--1037B2E22BF022EBE2;Mars_Connection=Yes
Set the first digit of ODBCVAR to "S" if you do not use this option.
Note that the native client of SQL Server 2005 must be used if MARS is
applied. Create a new ODBC data source using the native client. MARS
is a function that requires the SQL Server 2005 on client and server
side.
Only for ORACLE:

Code-page settings must correspond to those of the database. AE
recommends using the variable NLS_LANG or the parameter SP=.
Syntax:
SP=NLS_LANGUAGE=language,NLS_
TERRITORY=area,CODESET=character set,RECONNECT=interval
RECONNECT refers to the frequency that should be used to re-establish

the database connection. This parameter is given priority even if a "D" is
specified in the 2nd digit of ODBCVAR (see above).
For example:
(Two lines are used for the connection parameters for reasons of space. In
the INI file, you should only use one line).
SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=uc4;PWD
[DB_SERVICE] 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.
cp= Address of the AE system's communication process to which the agent
should connect.
Allowed formats:
DNS name:port number
TCP/IP address:port number
name= Name of the database agent that should be used to resolve variables.
The name of the agent computer (host name) is used if nothing has been
defined.
The agent name is limited to 32 characters. The following characters are

allowed: A-Z, 0-9, $, @, _, -, .
A hyphen ( "-") can be used for the agent name in the configuration file for
reasons of compatibility to former Automation Engine versions. Newly
created agents must not include hyphens in their names.
tcp/ip= Trace flags of the agent.
Allowed values: "0" (default value) to "9"

InitialPackage= Path and name of the file that contains theauthentication package.
When it starts, the agent reads this file and stores the information it
includes in the file specified in the parameter KeyStore=. The original file is
then deleted.
KeyStore= Path and name of the file that contains information about the authentication
package (see InitialPackage=).
connect= Time interval in seconds in which the agent attempts to establish
connection to the Automation Engines. This affects the connection setup
for a restart or after a lost connection.
This parameter is only effective until the first successful logon to the AE
system. Afterwards, the parameter RECONNECT_TIME can be used
in the host characteristics.
retention_time= Number of seconds after which an unused database connection should be
terminated.
retry= Number of connection attempts to the database.
The number that is specified in this parameter determines how often the
agent attempts to connect to the database. After the nth failed attempt, the
job ends with status ENDED_NOT_OK.
The agent continues to connect to the database if this parameter has not
been specified in the INI file. The job remains active until the database is
available again or until it is canceled.
OPTIMIZE= Database optimization, optimization means, that if you select data with a
key, the db-service automatically optimizes the query to a new statement
where the given key is part of the statement. If the query does not return
any data or results in an error, the original query is executed.
"0" - Database optimization off.

"1" - Database optimization on.
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
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
;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
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.
Structure of uc4config.xml
Parameter Description
<configuration> Beginning of the configuration.
<paths> Beginning of the elements for index and file definitions.
<docu Definitions for online documentation.
type="
"format" = Help system that should open when you press the F1 key.
format">path</docu>
Allowed values: "wh"
"wh" = WebHelp
"path" = Directory in which the help system has been installed.

<browser This parameter is required in order to use WebHelp documentation.
type="
"name" = Name of the Web browser
name">path</browser>
Allowed values: "Mozilla Firefox", "Internet Explorer", "Netscape Browser"
"path" = Web browser's directory and file name (example for UNIX:
/users/uc4/firefox/firefox)
<logging Log file definitions.

count="count">log
"count" = Maximum number of log files. Depending on the value, the number
file</logging>
is included in the logfile's name.
Allowed value: "-1", "0", "1 - 99"

"-1" = The computer name and current time is appended to the log file in the
format HHMMSSSSS.
"0" = Log-file writing is deactivated.
"1 - 99" = Number of log file generations that should be kept.
"log file" = Directory and name of the file to which log information should be
written.
The number characters ## can be used in file names. They serve as

place holders for an ascending order of trace files. When the
UserInterface starts, the log files are renamed in a way that the most
recent log file always has the number 00.
<trace count="count" Trace file definitions.
xml="xml trace"
"count" = Maximum number of trace files. Depending on the value, the
tcp="TCP/IP trace"
number is included in the trace-file name.
ra="rapid automation
trace">tracefile</trace> Allowed values: "-1", "0", "1 - 99"
"-1" = The computer name and current time is appended to the trace-file
name in the format HHMMSSSSS.
"0" = Trace-file writing is deactivated.
"1 - 99" = Number of trace file generations that should be kept.
"xml trace" = Trace flag for logging XML operations.
Allowed values: "0", "1", "2", "3"

"0" = No logging is made
"1" = Sending calls
"2" = Receiving calls
"3" = Sending and receiving calls
"TCP/IP trace" = trace flag for the logging of TCP/IP data traffic.
Allowed values: "0", "1", "2", "3"

"0" = No logging is made
"1" = Sending calls
"2" = Receiving calls
"3" = Sending and receiving calls
"rapid automation trace" = trace flag for Rapid Automation agents.
Allowed values: "0", "9"

"0" = Rapid Automation trace-file writing is deactivated.
"9" = Rapid Automation trace-file writing is activated.
"trace file" = Directory and name of the file to which trace information should
be written. The directory must be available.
The number characters ## can be used in file names. They serve as

place holders for an ascending order of trace files. When the agent
starts, trace files are renamed in a way that the most current trace file
always has the number 00.
<SendBufferSize> Maximum number of bytes per block that the UserInterface sends to the
count</SendBufferSize> Automation Engine.
"Number" = Maximum block size in bytes
Default value: 1048576

<RecvBufferSize> Maximum number of bytes per block that the UserInterface receives from
count</RecvBufferSize> the Automation Engine.
"Number" = Maximum block size in bytes

<tcp_ Nagle algorithm usage for the connection between the UserInterface and the
nodelay>value</tcp_ AutomationEngine.
nodelay>
Allowed values: "0" or "1" (default value)
</paths> End of the XML element <paths>
<colors> Beginning of elements for color definitions
<color r="red saturation" Color definition
g="green saturation" This is used to visualize the connection to a client in the UserInterface
b="blue saturation"/> (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> End of the XML element <colors>.
<timeout> "duration" = Waiting period in seconds during which the communication
duration</timeout> process is expected to respond. An error message is output if the
communication process does not respond within the expected period of
time.

<tcpip_ Setting of keep alive packets in order to keep a connection (e.g. in WAN).
keepalive>connection
receipt</tcpip_
keepalive> "1" - Keep alive packets are sent
"0" - Keep alive packets are not sent
The UserInterface loses its connection to the Automation Engine if there

is no user action for a longer period of time (about 2 hours).Set this
parameter to "1" to avoid a connection loss. The connection is then kept
because keep-alive packets are sent.
<active_keepalive>time Time in minutes in which the UserInterface sends messages to the
interval<active_ Automation Engine in order to keep the connection.
keepalive>
This parameter does not depend on <tcpip_keepalive>. The setting <tpcip_
keepalive> activates and keeps the connection on socket level which
means that the time interval of keep-alive packages cannot be influenced.
<active_keepalive> addresses the program level.
<connections> Beginning of the elements for the connections to the AE systems
<connection Definition of the connection to an AEAE system.

name="name"
"name" = Alias for the connection to an AE system. In the login window, the
system="system">
connection can be selected using this name.
"system" = name of the AE systems to which a connection should be

established. This entry must be identical to the specification made in the
Automation Engine's INI file.
Note that different AE systems must not have the same name!
<cp ip="DNS/IP" Definition of the connection to the AE system's communication process.
port="port"/>
"DNS/IP" = Either the DNS name or the TCP/IP address of the computer on
which the addressed communication process is running.
"port" = port number of an AE system's communication process

</connection> Completion of the XML element <connection>
</connections> Completion of the XML element <connections>
</configuration> Completion of the XML element <configuration>
Example of uc4config.xml
<configuration>
<paths>
<docu type="wh">C:\AUTOMIC\Documentation</docu>
<browser type="Internet Explorer">"C:\Program Files\Internet
Explorer\iexplore.exe"</browser>
<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>
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
<login> This marks the beginning of this file.
An XML element must be available.
<default> Beginning of the elements for the default values that are used for logging
on to the AE system for the first time.
<login src="adm"> The definition for logging on to an AE system.
The attribute src= adm must be specified.

<system> Alias for the connection to the AE system. This entry is specified in the
system</system> file uc4config.xml, parameter <connection name= ....

<client>n</client> Client number.
XML element must be available.
Allowed values: 0 - 9999

<name>name</name> User name.
<department> User department.
department</department> An XML element must be available.
<language> The language affects the display of the UserInterface.
language</language> An XML element must be available.
Allowed values: E (default value), D, F

E = English
D = German
F = French
<clienttype>D</clienttype> Client type.
Allowed value: D
D = Dialog
<clientvers>v AE system version.

ersion</clientvers> XML element must be available.
<os/> Operating system.
<hostname> The name of the local host computer.
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> Completion of XML element <default>.
XML element must be available.
<username-Template> The user-specific login template.
It contains login information of the last login.

An individual template will automatically be created for each OS user
when they log on to the system for the first time and it will be refreshed
(when the data has been changed) when the individual user logs off.
username refers to the name that the user has entered in order to log on to
the local computer.
You can also create templates manually and assign any name of your
choice. In this case, you can refer to this template name by using the start
parameter -U.
: The structure and contents of the user-specific login information complies
: with the structure and contents of the XML element <default>.
</username-Template> Completion of the XML element <username template>.
</login> Completion of the XML element <login>.
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>11.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.INI file to specify call options to start the UserInterface and the UCDJ.BAT file 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.
Structure of the INI File UCDJ.INI
[GLOBAL]
cmd= Command line call command for starting the UserInterface.

path= Start path for the UserInterface.
title= This parameter serves internal purpose in the UserInterface. The value must
not be changed.
affinity= Uses particular processors of the computer on which the UserInterface runs.
Specify one or several processors here and separate them by commas.
Examples:
affinity=0
affinity=(0,1)
affinity=(1,3,5)
Default value: "0"

affinityaction= Connection assignment to the processors
Allowed values: "no" (default values) and "next"
"no" - The connection is assigned to the processors in turn.
Example for affinity=(1,3,5):

1. Connection to CPU1
etc.
"next" - Here, the same rules apply as for the value "no". Additionally, the
processor assignment rotates because 1 is added to each processor number.
Example for affinity=(1,3,5):

etc.
After CPU31, counting continues at 0.



etc.
[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_
Removing these parameters or setting values for the may negatively
OPTIONS=
influence the UserInterface.
[SPLASH]
sound= Name of the WAV file to be played during UserInterface start (Splash screen).
[GLOBAL]
cmd="javaw" -Xmx1024m com.uc4.ucdf.UCDialogFactory -U%User% -
IC:\AUTOMIC\uc4config.xml
path=.
title=B008 -
affinity=(0,1)
affinityaction=no
[ENVIRONMENT]
classpath=.;.\ucdj.jar.;.\psjoa.jar.;.\ucsjds84.jar
JAVA_OPTIONS=
JAVA_TOOL_OPTIONS=
[SPLASH]
sound=uc4.wav
Structure of the BAT File UCDJ.BAT
Setting 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= Removing these parameters or setting values for the may negatively
set JAVA_TOOL_ influence the UserInterface.
OPTIONS=
java Calls Java for the UserInterface with the parameters specified.
Example of a BAT File
set CLASSPATH=
set JAVA_OPTIONS=
set JAVA_TOOL_OPTIONS=
java -Xmx512m -XX:+UseG1GC -XX:MinHeapFreeRatio=40 -XX:MaxHeapFreeRatio=70
-XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=../temp -
Dsun.locale.formatasdefault=true -cp .;.\ucdj.jar
com/uc4/ucdf/UCDialogFactory
See also:
Configuration & Performance of the UserInterface

Start Parameters
3.1.4 Agents
BS2000 Agent
See also: Notes for Configuration-File Adjustments
Structure of the INI File x.xxx.UCXJB2?.INI
(GLOBAL)
SYSTEM= Name of the AE system.
This entry must comply with the entry in the Automation Engine's INI file.
NAME= Name of the agent.
The agent name is limited to 32 of the following characters: A-Z, 0-9, _, .,

$, @, - and #.
The host name is used instead 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.
LOGGING= Name of the log file.
You can enter the user ID here. If the User ID has not been specified, the
log file is written to the User ID under which the job has been executed.
The number signs serve as placeholders for a series in numerical order.

When you start the agent, the log files are renamed so that the most
current log file is always the one with the number "00".
LOGCOUNT= Number of stored log files.
LANGUAGE= Language that should be used for the logging. You can specify a primary
and a secondary language.
Allowed values: E, D, F
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= Parameter that determines the password in BS2000 if there is no password
in the Login object.
"0" = Do not determine password.

"1" = Determine password.
USERID_TYPE= Additional way for the OS to allow or reject access to certain users.
Allowed values: INCL, EXCL
"INCL" = Access must be granted for every single user specified in

(USERID).
"EXCL" = Access is denied to the users that are specified in (USERID).
All other users can start jobs.
ft_temp_file= Creates temporary files in file transfers.
Allowed values: "yes" (default value) and "no"
"yes" - The file obtains a temporary name that is composed of the letter "T"
and an alphabetic string that stems from the RunID. The new file transfer
protocol additionally appends a file ID in order to obtain a unique file name
because basically, only a RunID is provided.The file is renamed after it has
successfully been transferred.
"no" - The agent assigns the final file name when the file transfer starts.
FileProcessingTimeout= The time limit in second for the file search
The file search aborts when the specified time limit is reached.
No time limit applies when you either define the setting "0" (default) or "-1".
This parameter is relevant for FileSystem events and the script

element GET_FILESYSTEM.
FileProcessingMaxDepth= The maximum level of sub-directories for FileSystem events.
You use this setting in order to determine the extent to which the directory
structure is included in your search for FileSystem event files. The search
directory serves as the basis for the maximum sub-directory level.
By limiting the directory level, you can improve the performance of

FileSystem events especially when their folder structure is deeply
nested and includes numerous files.
Allowed values:
"0" (default) = There is no limitation.
"1" = The files are only searched in the search directory. Sub-directories
are not included in this search.
"2" = With this setting being used, the search for files includes the search
directory and one directory level below.
"3" = The search includes the directory plus two sub-directory levels.
etc.

(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 afterward.
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 INI file. 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) Entry of authorized BS2000 users in the format:
User name=START
Entry of unauthorized BS2000 users in the format:

User name=NO_START
(VARIABLES) This section contains the agent variables with agent information and
settings.
(TRACE)
FILE= Name of the trace file.
You can enter the user ID here. If it is not entered, the trace file is written to
the User ID under which the job has been executed.

When you start a trace, the trace files will be renamed so that the most
current trace file is always the one with the number "00".
TRCCOUNT= Number of stored trace files.
TCP/IP= Trace flags of the agent.
FILETRANSFER=
UCON=
RFC= Trace flags should only be used in close cooperation with Automic
MEMORY= Support.
(TCP/IP)
PORT= Port number of the agent.
Other agents and the Job Messenger establish a connection with the agent
by using this port number.
BINDADDR= IP address or host name for the connection to the agent.
Use this parameter if the connection should be established via a particular

IP address (for example, the computer has more than one network
interface card).
Alternately, you can also specify the IP address or host name in

PORT=
(Format: PORT=IP address:port or DNS name:port). Specifications made

in BINDADDR= are then ignored.
BINDLOCAL= Consideration of local host (127.0.0.1).
Use this parameter together with BINDADDR=.
Allowed values: "0" (default value), "1"

CONNECT= Time interval in seconds during which the agent tries to establish a
connection to the Automation Engines. Affects the connection attempt for
a restart or after a lost connection.
This parameter is only effective until the first successful logon to the
AE system. Afterwards, the parameter RECONNECT_TIME can be
used in the host characteristics.
REPORT= Time interval in seconds in which the agent sends the logging to the
Automation Engine.

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.

CP= Address of the communication process in the AE system to which the
agent should connect.
Allowed formats:
DNS Name:Port number
TCP/IP Address:Port number
MAXMSGSIZE= Maximum length of messages (in bytes) that the agent accepts.
Default value: 500 000

(HOSTS) Assignment of an agent's name to its address (DNS name or TCP/IP

address) if it cannot directly be accessed through the address that is
stored in the server. Specify several assignments line by line, there is no
upper limit for the number of assignments.
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.
(RFC)
LOGON= File transfer: Evaluation of the User ID from the "File Transfer Parameters"
tab .
"0" = The User ID is not evaluated. The file transfer runs with the agent's
rights. Note that AE cannot ensure full auditing ability when you use this
function because theoretically you can specify any user - even an invalid
user.
"1" = UserID is evaluated.

For this purpose the agent starts an additional Enter (RFC task) with the
respective UserID.
This task only checks the access rights for the affected file. The
FileTransfer itself runs on the agent and the access rights of its user. For
this reason the agent as well needs access rights for the file in question.
PORT= Port number that the RFC task uses to establish the connection to the
agent.
TIMEOUT= Agent's maximum waiting time for the RFC task (seconds).
ENTERPAR= Additional parameters for the RFC task (see Enter command).
TASKTIMEOUT= Time period in seconds after which an RFC task stops.
An RFC task that is started by an agent can handle multiple file-transfers

orders. It ends if it does not receive a task for the time period that is defined
here.
(CP_LIST) List of communication processes.
This list is created when the agent starts and is extended when new
communication processes are activated. You will find more detailed
information about establishing a connectiond in the chapter Multi-Server
Operation.
The communication process that is defined in the parameter cp=

(section [TCP/IP]) is not included in the cp list.
Format:
Port number=DNS name
or
Port number=TCP/IP address
(GLOBAL)
SYSTEM=UC4
NAME=BS2000
LOGGING=$UC4.L.LOGG.UCXJBXX.##
LOGCOUNT=10
LANGUAGE=(E,D)
LICENCE_CLASS=6
JOINREAD=1
USERID_TYPE=EXCL
ft_temp_file=yes
(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,RUN-
MODE=*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)
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
Structure of the INI File UCXJSQLX.INI
[GLOBAL]
name= Name of the agent.
The agent name is limited to 32 of the following characters: "A-Z", "0-9", "_",
".", "$", "@", "-" and "#"
Hyphens ("-") are only allowed in agent names. They must not be used in the
names of any other objects.
system= Name of the AE system.
This entry must be identical to the entry in the Automation Engine's INI file.
language= Language that is used to log on. Entries for primary and secondary language.

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= Path and file name of the log file.
The number signs serve as placeholders for a series in numerical order. If

you start the agent, the log files are renamed so that the most current log file
is always the one with the number 00.
logcount= Number of stored log files.

LogMaxSize= The maximum size of the log file in bytes.
A new log file will be created when the limit that has been defined here is
reached.
Default value: 10 MB
The default value will be used when you set the value "0".
You can use one of the following prefixes with this value:
k...kilo, M...mega, G...giga
Examples: 100k corresponds to 100 kilobytes, 20M to 20 megabytes and 1G

to 1 gigabyte.
The agent reads LogMaxSize, if a value is set, and is not 0, the value is
used. If LogMaxSize doesn't exist, or is 0, the agent uses the max_
logging_kb setting.
max_logging_kb= The maximum size of the log file.
A new log file is created when the size that you specify here has been
reached.
Default value: 1000 KB
logging_kb setting.
log_to_file= Creation of log files.
Allowed values: "0", "1" (default values)
"0" = No log files are created.

"1" = Log files are created.
Logging contents are always sent to the Automation Engine regardless

of the specifications made here. These contents are available in the
System Overview.
[AUTHORIZATION]
(company-key file).

ending *.kstr) or the path of the agent's INI file. If you define a file name, the
ending *.kstr is not automatically appended.
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= Path and file name of the trace file.

When you start a trace, the trace files are renamed so that the most current
trace file is always the one with the number 00.
trccount= Number of stored trace files.
TraceMaxSize= The maximum size of the trace file in bytes.
A new trace file will be created when the limit that has been defined here is
reached.

to 1 gigabyte

[TCP/IP]
bindaddr= IP address or host name for communication process connection.
Use this parameter if the connection should be established via a particular

IP address (for example, the computer has more than one network interface
card).
connect= Time interval in seconds during which the agent attempts to establish
connection to the Automation Engines. Affects the connection setup for a
restart or after a lost connection.
system has been made. Afterwards, you can use the parameter
RECONNECT_TIME in the Host Characteristics for this purpose.
should connect.
Allowed formats:
[ORACLE]
enable_output= Transfer of outputs that are made by stored procedures.
Allowed values: "0" and "1" (default)
"0" - The output is not written to the job report.

"1" - The agent writes outputs to the job report.
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= Number of seconds after which an unused database connection should be
terminated.
type= Database type.
Allowed values: "MSSQL", "ORACLE", "DB2", "MYSQL",

"INFORMIX", "INGRES", "HANA" and "SYBASE", "POSTGRESQL",
"EXASOL"
retry= Number of connection attempts to the database.
The number that is specified in this parameter determines how often the
agent tries to connect to the database. After the nth failure, the job ends with
status ENDED_NOT_OK.
The agent continues to connect to the database if this parameter is not

specified in the INI file. The job remains active until the database is available
again or until it is canceled.
newline= Output of blank lines after tables that are used in reports.
"0" - The agent does not insert a blank line after a table.
"1" - A blank line is inserted after each table.
useOraClient= Connection method to Oracle databases.
Allowed values: "0" (default) and "1"
"0" - The agent can only connect to an Oracle Database Instance. The Job
object contains the relevant connection data.
"1" - The agent can connect to Oracle RAC nodes. The Oracle file
tnsnames.ora contains the relevant connection data.
The agent's connection information itself has to be defined by using

Connection objects (e.g. in SQL variables). In the Connection object you
would use Oracle or Oracle OCI as connection type.
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 An MS SQL Server database is used (type=MSSQL).

l The database agent runs on a Windows operating system.
l UC_HOSTCHAR_DEFAULT: ANONYMOUS_JOB = "Y"
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] List of communication processes.
This list is created when the agent starts and extended when new
communication processes are activated. More detailed information about
establishing a connection is provided in the chapter Multi-Server Operation.
The communication process that has been defined in the parameter cp=
Format:
or
[GLOBAL]
name=SQL01
system=UC4
language=E
logging=temp/UCXJSQLX_LOGG_##.TXT
logcount=10
max_logging_kb=1000
log_to_file=1
helplib=uc.msl
[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:

GCOS8 Agent
which must be adjusted to your system environment are written in red letters.
Structure of the INI File UCXJGC8I
[GLOBAL]
name= The name of the agent.
The agent name is limited to 32 of the following characters: A-Z, 0-9, _, ., $,

@, - and #.

system= AE system name.
This entry must be identical to the entry in the INI file of the Automation
Engine.
logging= Path and log-file name.
The number signs serve as placeholders for a series in numerical order. Log
files are renamed when the agent starts and the most current log file is
always the one with the number "00".
helplib= Path and name of message file.
licence_class= License class that complies with the acquired license and the hard and
software that is used.

language= Language that should be used for the logging. You can specify a primary and a
secondary language.


userid_type= This parameter can be used to allow or reject certain users.
Allowed values: "INCL", "EXCL"
"INCL" = Access authorization must be specified for every particular user in

the [USERID] section.
"EXCL" = Access is denied for users specified in [USERID]. All other users
can start jobs.
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_ Maximum number of job reports that can be sent to the Automation Engine at
count= the same time.
Default value: "10"

"yes" - The file obtains a temporary name which is composed of the letter "T"
and an alphabetic string originating from the RunID. The new file transfer
protocol additionally appends a file ID in order to obtain a unique file name
because basically, only a RunID is provided. The file is renamed after it has
[AUTHORIZATION]
(company-key file).

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.
If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's INI file. 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] Specification of authorized GCOS8 users in the format:
User name=START
Specification of non-authorized GCOS8 users in the format:

User name=NO_START
[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.
[MISC]
TRCOPENCLOSE= Setting for the handling of trace files.
"0" - The file opens when a trace is set and closes when the trace or the agent
is closed (highly recommended).
"1" - The file opens and closes when there is information that should be
recorded.
[HOSTS] Assignment of an agent's name to its address (DNS name or TCP/IP
address) if it cannot directly be accessed through the address that is stored in
the server. Specify several assignments line by line, there is no upper limit for
the number of assignments.
address from the Automation Engine. The sending agent replaces this internal
address by the external address that is defined here.
agents that are involved in the file transfer are located on different networks or
if a firewall is used.
[TRACE]
The number signs serve as place holders for a series in numerical order.
filetransfer=
job=
event= Trace flags must only be used in close cooperation with Automic Support.
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
port= The agent's port number.
Other agents and the Job Messenger establish connection with the agent via
this port number.
connect= Time interval in seconds during which the agent tries to establish a
connection to the Automation Engine. This affects the connection attempt for
a restart or after a lost connection.
This parameter only works until the agent's first successful logon to the
AE system. After that, the parameter RECONNECT_TIME in the Host
Characteristics serves this purpose.
report= Time interval in seconds in which the agent sends the logging to the
Automation Engine.
should connect.
Allowed formats:
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.

information about establishing a connection in the chapter Multi-Server
Operation.
The communication process that is defined in the parameter cp= (section

[TCP/IP]) is not included in the cp list.
Format:
or
[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]
; Agent's listen port

port=2017
; try all n seconds to connect to server
connect=20
report = 60
cp=PC01:2217
job_check_count=5
[CP_LIST]
2218=PC01
See also:
JMX Agent
Structure of UCXJJMX.INI
[GLOBAL]
name= Name of the agent
".", "$", "@", "-" and "#".
system= AE system name
This entry must be identical to the Automation Engine's INI-file entry.
language= Language for the logging
Allowed values: "E" (default value), "D" (German), "F"

logging= Path and file name of the log file
The number signs serve as placeholders for a series in numerical order. When
starting the agent, the log files are renamed so that the most current log file is
logcount= Number of stored log files
max_logging_kb= Maximum size of the log file
A new log file is created when the size specified here has been reached.
helplib= Path and name of message file
logToFile= Creating log files
"0" = No log files are created.

"1" = Log files are created.
loadOnStartup= Start specification for the agent
"0" - The agent must be started manually.

"1" - The agent starts when the Oracle WebLogic Server is started.
[AUTHORIZATION]
(company-key file).

[JMX]
type= Type of the JMX agent
Allowed values: "JBOSS", "NETWEAVER", "TOMCAT", "WEBLOGIC" and

"WEBSPHERE".
Enter one of the above values, depending on your license. The JMX agent is
used in mode "stand alone" (default value) if this parameter remains
undefined.
search_all= Consideration of local MBean Servers
Possible values: "0" (default) and "1"
"0" - The agent only searches the MBeans of the Server to which it is
connected (to be specified in the Job object's JMX tab).
"1" - The agent searches all local MBean Servers if the functions JMX_
INVOKE, JMX_GET_ATTRIBUTE, JMX_SET_ATTRIBUTE and JMX_
GET_INFO are used. JMX_QUERY_NAMES (including the Mbean Browser)
only supply the MBeans of the current MBean Server. The first hit is taken if
an MBean of the same name is available on several MBean Servers.
Note that this parameter is ineffective when a remote connection is

established to the MBean Server.
[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= Path and file name of the trace file
starting a trace, the trace files will be renamed so that the most current trace
file is always the one with the number "00".
trccount= Number of stored trace files
max_trace_kb= Maximum size of the trace file
A new trace file is created when the size specified here has been reached.
tcp/ip= Trace flags of the agent
Set trace flags only in close cooperation with our support team.
[TCP/IP]
bindaddr= IP address or host name for communication process connection
Use this parameter when the connection should be established via a

particular IP address (e.g. the computer has more than one network interface
card).
connect= Time interval in seconds in which the agent attempts to establish connection
to the Automation Engines. Effects the connection setup for a restart or after
a lost connection.
system. Afterwards, the parameter RECONNECT_TIME can be used in
the host characteristics.
cp= Address of the communication process in the AE system to which the agent
should connect itself.
Allowed formats:
[CP_LIST] List of communication processes
The communication process which has been defined in the parameter cp=
Format:
or
[GLOBAL]
name=JMX01
system=UC4
language=E
logging=../temp/UCXJJMX_LOGG_##.TXT
logcount=10
max_logging_kb=1000
helplib=uc.msl
log_to_file=1
loadonstartup=0
[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:
NSK Agent
Structure of the INI File UCXJNS1I
[MISC] The parameters that are included in this section are required for internal
purposes in the agent. Values must not be changed.
[HOSTS] Assignment of an external address (DNS name or TCP/IP address of an
agent) to the agent's AE name.
In a file transfer, the Automation Engine sends the partner agent's internal
address to an agent. This address is replaced by the external address that is
defined here.
Every agent that participates in the file transfer should be entered here in order
to avoid problems that might occur when you convert network addresses (for
example, with a firewall).
[GLOBAL]

@, - and #.

logging= Log-file name.
the agent starts, the log files are renamed and the most current log file is
always the one with number "00".
secondary language.


licence_class= License class that corresponds to the acquired license and the hardware and

"1" to "9" = The agent's license class.
vhterm= Process name of the virtual terminal emulation.

user_vterm=
l vhterm belongs to the agent
l user_vterm belongs to the particular job
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_ Time (in 1/100 seconds) that a TACL process that has been started by the
LIVE= 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_ Leave this field blank because it is only relevant for diagnostic purposes.
PARAMS=
CPU_MASK= A chain of up to 16 0/1 values (such as 0001111). This parameter indicates
the CPUs that AE can use for batch processing. The first position refers to
CPU 0, the second to CPU 1 etc. AE starts processes only in these CPUs ,
thereby facilitating the separation of online and batch applications. If no CPUs
of value 1 are available, AE also uses other CPUs (processing is given
priority over resource protection).
TACL_TIME_ Time (in 1/100 seconds) that a TACL that has been started by the agent can
RESERVED= 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= Priority of the Output Collector.
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_ 0 or 1 indicates whether the automatic restart of the agent by the Output
RESTART= Collector should be allowed (value 1). Value 0 indicates that manual
interference is necessary if troubles occur that affect the agent.
DEFAULT_USER_ Interval (in seconds) after which the erroneous attempt of logging on to the
FETCH_INTERVAL= default user is repeated by the Server.
MAX_OPEN_TABLE_ The number of files that jobs can open at the same time.
SIZE=
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_ The number of files that an individual job can open at the same time.
JOBS=
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= This parameter creates temporary files in file transfers.
ft_temp_file_oss=
and an alphabetic string that originates from the RunID. The new file transfer
protocol additionally appends a file ID in order to ensure a unique file name
because only a RunID is available. The file is renamed after it has
The OSS file system requires the parameter file_temp_file_oss to be

used.
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= Security string for job files-
Allowed values: "N" or "JSecurity string"
"N" - Job files should be created with the user who has started the agent. The
agent user's default security is used.
"JSecurity string" - Job files should be created with the user of the job's Login
object. Specify the security string that should be used.
For example:
JOBFILE_SEC=JNNNN
CHECK_PW_ Password check for jobs.

ALWAYS=
Allowed values: "Y" (default) and "N"
"Y" - For each job, the agent checks the password in the Login object.
"N" - The agent does not check the passwords of jobs. This setting is useful if
the agent runs under super.super and passwords of job users are unknown,
users are inactive or when passwords are often changed.
[AUTHORIZATION]
(company-key file).

[TRACE] Trace files are limited to 200MB. The agent creates a new file if this value
has been reached.
file= Name of the trace file.
When a trace is started, files are renamed and the most current trace file is
tcp/ip= Agent's trace flags.
filetransfer=
job=
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: 30 seconds
port= Agent's port number.
Other agents and the Job Messenger connect to the agent via this port
number.
bindaddr= IP address or host name for Server-process connection.
Use this parameter if a connection should be established via a particular IP

card).
Alternately, you can also specify the IP address or host name in port=
(Format: port=IP address:port or DNS name:port). Specifications made in

bindaddr= are then ignored.

connect= Time interval in seconds in which the agent attempts to establish a
connection to the Automation Engines. This affects the connection setup for
restarts or after a lost connection.
Default: 120 seconds
system. Afterwards, the parameter RECONNECT_TIME in the host
characteristics is used for this purpose.
Automation Engine.

Allowed formats:
buffersize= Input-buffer size in bytes for file transfers.
For the input buffer, Automic recommends specifying 33000 bytes in

combination with TCP/IPv6 and 20000 bytes for the standard TCP/IP.

Support!
tcp_keepalive= This sends keep-alive packets in order to keep the agent connections.
Allowed values: "N" and "Y" (default value)

"Y" - Keep-alive packets are sent.
"N" - Keep-alive packets are not sent.
Format:
or
[FT-STATUS-STORE]
FILENAME= Name of the StatusStore files that store the restart information.
DETAIL-FILENAME=
The name of the sub-volume is already specifed in the file INSTINI during the
LOG-FILENAME=
installation process and generated in the agent's INI file using the default file
HEAD-FILENAME=
names (UC4SST, UC4SSD, UC4SSL, UC4SSH).
[GLOBAL]
system=UC4
name=TGUARD
logcount=10
logging=LOGA##
language=(E,D)
helplib=UCMSL
licence_class=9
vhterm=$tsim
;user_vterm=$ZTN0.#PTNTB46
UC4_MACRO_FILE=$DATA01.UC4.UC4MACS
TACL_TIME_TO_LIVE=90000
COLLECTOR=$UC4OC
COLLECTOR_PARAMS=
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_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:

OS/400 Agent
that must be adjusted to your system environment re written in red letters.
Structure of the INI File UCXJO41
(GLOBAL)
SYSTEM= The name of the AE system.
This entry must comply with the entry in the INI file of the Automation Engine.
NAME= The name of the agent.

@, - and #.
The host name is used instead if this parameter is not defined. Lowercase
letters are converted to uppercase letters.
CheckLogon= This parameter checks the user data in the Login object.
Allowed value: "0" and "1" (default value)
"0" - The Login object is not checked.

"1" - The user data in the Login object is checked before the task runs.
OS/400 jobs: The User ID that is specified in the Login object must also
be activated on the OS/400 platform as otherwise, you will not be able to
start jobs.
logcount= The number of stored log files.
logging= The name of the log file.
The number signs are used as placeholders for a numbering in ascending

order. When you start starting the agent, log files are renamed so that the
most current log file is always the one with the number "00".
If no file name is specified, the logging is written to the spool file of the agent's
job.
language= The language that should be used for the logging. You can specify a primary


helplib= The name of the message file.
LICENCE_CLASS= The license class that corresponds to the acquired license and the hard and

"1" to "9" = License class for the agent.
spool= This parameter refers to the spool files of a job run:

"delete" = The spool files should be deleted.
"keep" = The spool files should be kept in the spool.
dqname= The name of the data queue of the agent's job.
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.
"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= The start parameter for the submitted job.
console= The name of the message queue that should be monitored with a "Console"
event type.
userid_type= An alternative to the OS that can be used to allow or reject certain users.
"INCL" = Access must be allowed to each individual user under (USERID).

"EXCL" = Users who are specified under (USERID) are not authorized. All
other users can start jobs.
ft_temp_file_ifs= This parameter creates temporary files in file transfers .
This setting can only be specified if IFS is used as the file system.
Allowed values: "yes" and "no" (default)
"yes" - The file obtains a name that is composed of a "T" and the RunID which
has been converted to letters. The new file transferr additionally appends a file
ID to obtain a unique file name because basically, only a RunID is provided.
The file is renamed after it has successfully been transferred.

Support!
store_type= You use this parameter to determine the locations where the StatusStore files
of file transfers should be stored.
Allowed values: "QSYS" (default) or "IFS"

"QSYS" - The StatusStore files are directly stored as user space objects in
the agent library.
"IFS" - The StatusStore files are written to the IFS directory that is defined in
the agent variable UC_EX_PATH_TEMP_IFS.
(AUTHORIZATION)
(company-key file).

(USERID) Specification of authorized OS/400 users in the format:
User name=START
Specification of non-authorized OS/400 users in the format:

User name=NO_START
(VARIABLES) This section contains the agent variables which include agent settings and
information.
(TRACE)
file= The file name of the trace file.
The number signs are used as placeholders for a numbering in ascending

order. When you deactivate a trace, the trace files are renamed so that the
most current trace file is always the one with the number "00".
tcp/ip= The trace flags of the agent.

filetransfer=
job=
CONTROLFLOW=
VARIABLE=
MESSAGE=
DUMP=
MISCELLANEOUS=
memory=
(TCP/IP)
port= The port number of the agent.
Other agents and the Job Messenger establish a connection with the agent by
using this port number.
bindaddr= The IP address or host name for the connection to the agent.
You can usse this parameter when the connection should be established with
a particular IP address (for example, the computer has more than one network
interface card).

bindlocal= Consideration of the local host (127.0.0.1).

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
system. Afterwards, you can use the parameter RECONNECT_TIME in
the host characteristics for this purpose.
maxrepcnt= The maximum number of report blocks that should be transferred to the
Automation Engine at the same time.
Default: 8 blocks
maxMsgSize= Maximum length of messages (in bytes) that the agent accepts.

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).

CP= The address of the communication process in the AE system to which the
Allowed formats:
(HOSTS) Assignment of an agent's name to its address (DNS name or TCP/IP
(CP_LIST) A list of communication processes.
Operation.
The communication process that has been defined in the parameter cp= in
section (TCP/IP) is not included in the cp list.
Format:
or
(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)
(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)
port=2300
connect=120
maxrepcnt=8
CP=PC01:2217
(CP_LIST)
2218=PC01
See also:
People Soft Agent

Structure of the INI File UCXJPSX.INI
[GLOBAL]

@, - and #.

secondary language.


is always the one with the number "00".
helpcache= Availability of the messages and language dependant strings.
Allowed values: ALL (default value), NONE, CONTROLS

"CONTROLS" = All language dependant strings that are necessary for the
display of the dialog program are held in the RAM (not relevant for the agent).
userid_type= You can use this option to allow or reject certain Operator IDs.
"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).
"0" - Messages are sent separately.

"1" - Messages are sent block by block every second.
WRITE_TIME= Interval in seconds during which blocks are sent.
[AUTHORIZATION]
(company-key file).

[STATUS_CHECK]
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_
CHECKINTERVALin 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] Specification of the allowed PeopleTools user in the format:
User name=START
Specification of the non-permitted PeopleTools user in the format:

User name=NO_START
[TRACE]
you start a trace, the trace files are renamed so that the most current trace file
tcp/ip= Trace flag for the agent's TCP/IP communication.
jcl=
Trace flags must only be used in close cooperation with Automic Support.
database=
[TCP/IP]
port= Port number of the agent.
Other agents and the Job Messenger establish their connections to the agent
by using this port number.
bindaddr= IP address or host name for the connection to the agent.
Use this parameter if the connection should be established with a particular IP

card).


connect= The PeopleSoft agent for Windows uses the parameter connect= for this
alarm= 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.
Automation Engine.

CP= Address of the primary communication process in the AE system to which the
agent should connect itself.
Allowed formats:
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.

[VARIABLES] This section contains the agent variables that include agent settings and
information.
[PS]
version= PeopleTools version that is used.
LANGUAGE_CD= Language indicator for the PeopleSoft messages.
Allowed values: see PeopleSoft

Default: "ENG" = English
OPRPSWD= Source of the Operator ID passwords.
Allowed values: "0" and "1"

"0" = Passwords are stored in the Login object.
"1" = Passwords are defined in the [PSOPRPSWD] section of this INI file.
PID= Process information that should be displayed for a PeopleSoft job in the
activity and detail windows and in the statistics.
"0" = Session ID
"1" = Process instance number
APPSERVER= Name or TCP/IP address of the application server and number of the JOLT
port.
LOG2UC4= You can use this parameter to add log files from processes of the
PeopleTools Process Scheduler Batch Server to the job report.
"0" = No log file is included in the job report.

"1" = Log file is included n the job report.
DOMAIN_ You can indicate the Domain Connection password here if it is used in
CONNECTION_ PeopleSoft.
PWD=
Note that the password must be encrypted.
[PRCS_SBB_JAVA]
ENABLED= Java Class usage for the PROCESSREQUEST_SBB component interface.

"0" = Not used.
"1" = Used.
VERSION= PROCESSREQUEST_SBB component interface version.
Allowed values:
"V0.002" for PeopleTools Version 8.2x
"V1.03" for PeopeTools Version 8.4x
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] Passwords for the Operator IDs in the form Operator ID = Password.
Only used if the parameter OPRPSWD is set to "1" in the [PS] section.
This list is created when the agent starts and it is extended if new
Operation.
Format:
or
[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_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
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:
RA Agent
Structure of UCXJCITX.INI
[GLOBAL]
name= Name of the agent
".", "$", "@", "-" and "#".
Although agent names are limited to 32 characters, you should keep them
under 25 characters. The last seven characters are used for adding the
suffix '.NEW.nn' when a new agent is created from its template.
system= AE system name
Engine.
language= Language for the logging
Allowed values: "E" (default value), "D" (German), "F"

max_logging_kb= Maximum size of the log file
helplib= Path and name of message file
checkRegisteredFile= This optional field is available for OEBS agents 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.
"0" = Registered files are not checked.

"1" = Registered files are checked.
[AUTHORIZATION]
(company-key file).

[RA]
cache_directory= Directory to which the agent should store the RA Solutions.
[TCP/IP]
bindaddr= IP address or host name for communication process connection

card).
connect= Time interval in seconds in which the agent attempts to establish connection
to the Automation Engines. Affects the connection setup for a restart or after
a lost connection.
system. Afterwards, the parameter RECONNECT_TIME can be used in
Allowed formats:
[TRACE]
starting a trace, the trace files will be renamed so that the most current trace
max_trace_kb= Maximum size of the trace file
A new trace file is created when the size specified here has been reached.
tcp/ip= Trace flag of the agent
ra= Trace flag of the Rapid Automation agent
"0" = Rapid Automation trace-file writing is deactivated.

"1" - "9" = Rapid Automation trace-file writing is activated at the specified
level. "1" is the lowest level, "9" is full trace. When you need to set Rapid
Automation agent trace, you almost always set it to "9".
"10" - "12" = Full trace is set, additionally third-party library trace is set if it
exists. The Web Service agent has third-party trace. Third-party library trace
can only be done in this file. It cannot be set through the UserInterface like for
other agents.
[CP_LIST] List of communication processes
The communication process which has been defined in the parameter cp=
Format:
or
[GLOBAL]
system=AE name=RA01 logcount=10 logging=../temp/CIT_LOGG_##.TXT max_
logging_kb=50 language=E helplib=uc.msl
[AUTHORIZATION]
InitialPackage=
KeyStore=
[RA] cache_directory=cache
[TCP/IP] connect=20 cp=localhost:2217
[VARIABLES] uc_host_jcl_var=CIT
[TRACE] file=../temp/CIT_TRACE_##.TXT trccount=10 max_trace_kb=1000

tcp/ip=0 ra=12
[CP_LIST]
2218=PC01
See also:
SAP Agent
Structure of the INI File UCXJR3X.INI
[GLOBAL]
name= Agent name.

@, - and #.
The host name is used if this parameter remains undefined. Lowercase

letters are converted to uppercase letters.
system= The name of the AE system.

This entry must comply with the entry that is made in the Automation
Engine's INI file.


logging= The path and file name of the log file.
is always the one with the number 00.
Default value: 1
LogMaxSize= The maximum size of the log file in bytes.
A new log file will be created when the limit that has been defined here is
reached.

to 1 gigabyte.
logging_kb setting.
A new log file is created when the size that you specify here has been
reached.
logging_kb setting.
helpcache= The availability of messages and language dependent strings.
ALL = The complete message file is held in the RAM.

NONE = Always read the message file from the hard drive.
CONTROLS = All language dependent strings that are required to display a
dialog program are held in the RAM (does not apply to agents).
lower_case= This parameter converts entries in the attributes of a workflow into uppercase
letters.
Allowed values: "YES", "NO" (default value)
"YES" = Entries must be written in uppercase letters. Lowercase letters are

not automatically converted to uppercase letter.
"NO" = Lowercase letters are automatically converted to upper case letters.
maxEventTimeSpan= The interval in seconds that the agent uses to read previous SAP events after
it has lost its connection to the SAP system.
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:33 and 10:34 are retrieved at 10:34
etc.
joblog_blocksize= The number of report lines that should be transferred to AE in blocked form.
Default value: 0 lines
Value 0 signals that the job report should be transferred as a whole.
This parameter has been implemented in response to a memory problem

of the SAP RFC library on AIX (for further information, see the note
792767). In SAP, you can limit job reports. This solution is not suitable for
customers who use a job scheduler such as AE because the whole job
report should be transferred. Therefore, AE provides a workaround in the
form of this parameter. Large job reports are transferred to AE block by
block, thereby avoiding memory problems because doing so consumes
less memory. Note that more SAP resources are required in this case.
This workaround applies only for the AE interface because AE has no
influence on SAP's XBP interface.
userid_type= This is an additional parameter that allows to allow or reject particular users.
INCL = Access must be granted to each individual user under [USERID].

EXCL = Users that are specified under [USERID] are excluded. All other
users can start jobs.
SAP_language= You must re-logon to SAP if the language has been changed.
Allowed values: 0 (default value), 1
0 = The languages that are specified in language= are used.

1 = The agent uses the language that is defined in the job in order to log on to
SAP.
Download_dir= The directory in which the spool lists should be stored.
This parameter affects the following script elements in which the spool-list
request has been activated by using the parameter GET_SPOOL:
l R3_ACTIVATE_REPORT
l R3_ACTIVATE_JOBS
l R3_ACTIVATE_INTERCEPTED_JOBS
l BW_ACTIVATE_CHAIN
l 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]
(company-key file).

[USERID] Specification of authorized SAP users in the format:
Client number/User name=START
Specification of non-authorized SAP users in the format:

Client number/User name=NO_START
[SAP_BW] The parameters for 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]

[SAP_BCA]

[SAP_BASIS]
Version= The SAP system's software version.
By default, this parameter and section are not included in the INI file. This
parameter is used to set the agent variable UC_HOST_SW_VERS. The
value that is specified here is shown in the System Overview's "SW version"
column of the relevant agent.
For example: The agent runs on an SAP platform using the software version
7.0:
[SAP_BASIS]
Version=7.00
[SAP_SMSE]
WebStartURL= The URL of the Web application that includes the UserInterface.
To call the UserInterface directly via the SAP Solution Manager, you must
specify this parameter. For more information about installing this functionality,
see Integrating AE to the SAP Solution Manager.
[TRACE] Trace flags must only be used in close cooperation with Automic Support
and AE Development.
file= The path and file name of the trace file.
Default value: 1
max_trace_kb= The maximum size of the trace file.
A new trace file is created when the size that is specified here has been
reached.

tcp/ip= The trace flag for TCP/IP communication of the agent.
jcl=
Allowed values: 0 (default value) to 9
rfc= RFC trace.
Use the following SAP parameter in order to prevent that the SAP system's
trace is accepted:
rdisp/accept_remote_trace_level = 0
This parameter can also be of interest in this connection: gw/accept_remote_

trace_level (see SAP note 357683).
[TCP/IP] The IP address or host name for Server-process connection.
You use this parameter if the connection should be established with a

particular IP address (for example, the computer has more than one network
interface card).
bindaddr=
connect= The time interval in seconds in which the agent attempts to establish
connection to the Automation Engines affects the connection setup for a
Default value: 60
system. Afterwards, you can use the parameter RECONNECT_TIME of
report= The time interval in seconds in which the agent sends the logging to the
Automation Engine.
Default value: 60
CP= The address of the primary communication process in the AE system to
which the agent should connect itself.
Allowed formats:
[VARIABLES] This section includes agent variables that contain agent settings and
information.
[CP_LIST] A list of communication processes.
Operation.
Format:
or
[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_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
See also:
Siebel Agent
Structure of the INI File UCXJSLX.INI
[GLOBAL]

@, - and #.

This entry must comply with the entry in the INI file of the Automation Engine.
secondary language.


The xx characters in the file name are placeholders. They stand for the two-
character abbreviation of the respective Windows version. See:Terminology.

"CONTROLS" = All language-dependant strings that are necessary for the
display of the dialog program are held in the RAM (not relevant for the agent).
WRITE= 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).
"0" - Messages are sent separately.

"1" - Messages are sent block by block every second.
WRITE_TIME= Interval in seconds during which blocks are sent.
[AUTHORIZATION]
(company-key file).

[STATUS_CHECK]
time= This is the system-internal timer cycle that checks the status of a job
compared to SAP.
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.
The job table is checked each second.

[TRACE]
The xx characters in the file name are placeholders. They stand for the two-
digit abbreviation of the particular Windows version. See: Terminology
is always the one with the number "00"
tcp/ip= Trace flags for TCP/IP communication of the agent.
filetransfer=
mail=
[TCP/IP]
port= Port number of the agent.
this port number.
bindaddr= IP address or host name for Server-process connection.
You can use this parameter when the connection should be established via a
card).
Alternately, you can also specify the IP address or host name in port=.


connect= Time interval in seconds in which the agent triets to establish connection to
the Automation Engines. This affects the connection setup for a restart or
after a lost connection.
Automation Engine.

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.
should connect.
Allowed formats:
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.

[VARIABLES] This section contains agent variables that include agent settings and
information.
[SIEBEL]
DELIMITER= Separator for the log-file content.
Siebel log files are structured in tables. You can use this parameter to define a
column separator (such as *).
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= Logging if the job could not be found in the Siebel system.
"1" - Each of the agent's repeated status checks causes a message that is
written to the job report.
"0" - A message is only output if the maximum number of repetitions specified
in "repeat_check" has been reached and the AE job changes to the status
"ENDED_VANISHED".
Operation.
Format:
or
[GLOBAL]
name=SI8
system=UC4
language=(D,E)
logging=..\temp\siebel_log##.txt
logcount=10
helplib=uc.msl
helpcache=all
WRITE=1
WRITE_TIME=120
[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_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=*
[CP_LIST]
2218=PC01
See also:
UNIX Agent
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 Part of the path's directories are links: Files will be transferred.

l The file part of the path is a link:
l If the file already exists in the target, it will be overwritten (if "Overwrite" is activated).
l If the linked file does not exist, the link will be overwritten.
The behavior of the source host is controlled by the parameter FT_Linkfiles.
Structure of the INI File UCXJXXX.ini
[GLOBAL]

$, @, - and #.

This entry must comply with the entry in the Automation Engine's INI file.
The xxx characters in the file name are placeholders. They stand for the
three-digit abbreviation of the respective UNIX version. See: Terminology

current log file is always the one with the number 00.
licence_class= The license class that corresponds to the acquired 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.


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.

userid_type= You use this parameter to allow or reject certain users.
Allowed values: INCL, EXCL (default value)
INCL = Access must be granted to every single user in the [USERID]

section.
EXCL = No access is granted to the users who are specified in [USERID].
All other users can start jobs.
UC_user_type= The option that can be used to allow or reject particular AE users.
Allowed values: INCL, EXCL (default value)
INCL = Access must be granted to every single user in the [UC_USER]

section.
EXCL = No access is granted to the AE users who are specified in the
[UC_USER] section. All other AE users can start jobs
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. Automic recommends keeping this time period
short.

login_check= Password check.
Allowed values: yes and no (default value)
See: Description of the settings ANONYMOUS_FT and ANONYMOUS_

JOB in the variable UC_HOSTCHAR_DEFAULT).
ReportMode= 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= The owner of file transfer files.
Allowed values: "user" (default value) and "directory"
"user" - The user who is defined in the Login object is the file owner (User
ID) of the transferred file(s). The owner of existing files that might be
overwritten is kept."directory" - The transferred file(s) obtein the owner of
the target folder. The same rule applies for existing files that are
overwritten.
This parameter does not affect file rights or the group.
The new file transfer protocol (source and target agent are of version 9
or later) ignores this parameter. In this case, the owner is always the
user who is defined in the Login object.
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.
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= This parameter creates temporary files in file transfers.
yes = The file obtains a temporary name which is composed of the letter T
and an alphabetic string that originates from the RunID. The new file
transfer protocol additionally appends a file ID in order to obtain a unique
file name because basically, only a RunID is provided. The file is renamed
after it has successfully been transferred.
no = The agent assigns the final file name when the file transfer starts.

Activating the Nagle algorithm can improve the performance of file

transfers, especially if you transfer many small files.
Note that this parameter should only be set in close cooperation with
Automic Support!


Allowed values:
etc.

[AUTHORIZATION]
(company-key file).

[USERID] The definition of the authorized UNIX users in the format:
User name=START
Definition of the non-authorized UNIX users in the format:

User name=NO_START
Default value: root=NO_START

[UC_USER] The definition of the authorized AE users in the format:
User ID=START
The definition of the non-authorized AE users in the format:

User ID=NO_START
The User ID (OH_IDNR) of each user is registered in the AE database in

the OH table.
[FILETRANSFER]
ft_check_free_disk_ This parameter checks the available hard disk space before a file transfer
space= 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, if the agent should
transfer linked files of the source or ignore them.
Allowed values:
"yes" - Links will be dereferenced and files the links are pointing to, will be
transferred.
"no" (default) - Links will be ignored.
Executing a Wildcard-FileTransfer with "no" as value, may result in the

transfer being set to ENDED_EMPTY, in case there are only links in
the source directory.
[VARIABLES] This section contains the agent variables agent variables that include
agent settings and information.
[TRACE]
The xxx characters in the file name are placeholders. They stand for the
three-digit abbreviation of the respective UNIX version. See:Terminology

current trace file is always the one with the number 00.
trccount= Number of the stored trace files.
tcp/ip= The trace flags of the agent.
event=
job_debug=
ft_debug= Trace flags must only be used in close cooperation with Automic
ex_init= Support.
signal=
mail=
memory=
[TCP/IP]
port= The port number of the agent.
Other agents and the Job Messenger use this port number in order to
establish a connection.
bindaddr= The IP address or host name for the connection to the agent.
You can use this parameter if a specific IP address should be used for the
connection (if the computer has more than one network interface card).
(Format: port=IP address:port or DNS name:port). Specifications that are

made in bindaddr= are ignored in this case.
bindlocal= The consideration of the local host (127.0.0.1).
This parameter must be used in combination with bindaddr=.
Allowed values: 0 (default value), 1
0 = No listen socket is created.

1 = An additional listen socket is created on the local host.
connect= The ime interval in seconds in which the agent tries to establish a
connection to the Automation Engine. This setting affects the connection
establishment for a restart of when the connection has been lost.
The former parameter name agent= is still valid for compatibility reasons.

Automation Engine at the same time.
Default value: 8 blocks


cp= The address of the communication process in the AE system to which the
Allowed formats:
tcp_keepalive= This sends keep-alive packets in order to keep the agent connections.
Allowed values: "N" and "Y" (default value)

"Y" - Keep-alive packets are sent.
This parameter is only checked when the agent runs under Linux.
tcp_keepalive_time= The time interval in seconds in which packages for keeping the
connections are sent.
The default value that depends on the system environment is used if you
do not specify this parameter or use the value 0.
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).
Default value: 1 Mbyte

[MISC]
FileBufferSize= Size of the input buffer for files that are transferred with a FileTransfer
object (MB, KB or bytes).
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
file transfers.
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.
FileEndDelimiter= This adds a line breack (LF) at the end of text files that have been sent
using a file transfer.
Allowed values: "yes" and "no" (default value)
"yes" - The agent always adds an LF to the end of text files in file transfers
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= Collection of process information.
Allowed values: yes (default) and no
yes = The agent retrieves the process information of all AE processes and
sends it to the Automation Engine for the periodic job check. By doing so,
the consumed CPU time is refreshed in the UserInterface. Note that this
can negatively affect CPU and performance if many active processes are
involved.
no = No process information is collected. The consumed CPU time is
retrieved when the job has ended and then sent to the Automation Engine.
This parameter is not available for AIX.

MsgStdout= Logging output in the terminal that is used to start the agent.
Allowed values: yes and no (default)
yes = The agent's logging data is output in the console. An additional log
file is written.
no = Logging data is only written to the log file.
FileRemoveCheck= Authorization check before the source file is deleted.
Allowed value: yes (default value) and no
yes - The user's authorization to delete the source file is verified.

no - The authorization is not verified and the file is deleted. The UNIX user
under which the agent runs is used (usually this is root).
[PAM]
Libname= Path and filename of the PAM library.
Specify the library name if the PAM authentication methodshould be used

(see also parameter authentication=)
By default, the file libpam.so is searched in the agent's directory.
This parameter is only relevant for AIX, Linux and Sun Solaris agents.
pam_open_session= If turned on and PAM authentication is used, a PAM user session is
opened for each job also applying the session credentials by PAM (e.g.
limits defined in /etc/security/limits.conf). This setting applies to jobs, but
not FileTransfers or file events.
Allowed value: yes and no (default value)

[STARTCMD]
start_type= Method that is applied to start jobs.
Allowed values: fork (default value), batch
fork = The job starts with fork function.

batch = The job starts with a batch command.
Bourne_Shell= Shell options for starting jobs under Bourne Shell.
You can use this line if jobs should be started with a batch command.
C_Shell= Shell options for starting jobs under C Shell.
Korn_Shell= Shell options for starting jobs under Korn Shell.
Other_Shell= Shell options for starting jobs under any Shell.
shell_pfad= The specification of a specific Shell path.
The environment variable PATH is used if you do not specify this

parameter. If this variable is not available, the system uses the "/bin"
directory.
This list is created when the agent starts and it is extended when new
Operation.
The communication process that is defined in the parameter cp= (

[TCP/IP] section) is not included in the cp list.
Format:
or
[GLOBAL]
name = UNIX01
system = UC4
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
event = 0
job_debug = 0
ft_debug = 0
ex_init = 0
signal = 0
mail = 0
[HOSTS]
[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
See also:
VMS Agent
Structure of the INI File UCXJV??.INI
[GLOBAL]

@, - and #.

Engine.
The characters xx in the file names are placeholders. They stand for the two-
digit abbreviation of the respective VMS version. See: Terminology.
When starting the agent, the log files are renamed so that the most current log
helplib= The name of message file.
licence_class= The license class that corresponds to the acquired license and the hardware
and software that is used.

"1" to "9" = License class of the agent


userid_type= Additional possibility of the operating system to allow or reject certain users.
"INCL" = The access must be allowed for every single user that is specified in
(USERID).
"EXCL" = Access is denied to the users that are specified in (USERID). All
UC_user_type= You can allow or reject certain AE users.
"INCL" = The access must be allowed for every single user that is specified in
[UC_USER].
"EXCL" = Access is denied to AE users that are specified in [UC_USER]. All
other AE users can start jobs.
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.

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.
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= This creates temporary files in file transfers.
and an alphabetic string that stems from the RunID.The new file transferr
additionally appends a file ID to obtain a unique file name because basically,
only a RunID is provided. The file is renamed after it has successfully been
transferred.

Support!
[AUTHORIZATION]
(company-key file).

[USERID] Entry of authorized VMS users in the format:
User name=START
Entry of unauthorized VMS users in the format:

User name=NO_START
[UC_USER] Entry of authorized AE users in the format:
User ID=START
Entry of unauthorized AE users in the format:

User ID=NO_START
[VARIABLES] This section contains agent variables containing agent settings and
information.
The variable UC_EX_JOB_MD is decisive for the name of the Job

Messenger program (by default: UCXJVxxM).
xx stands for the relevant platform's short form. In VMS, the correct Job
Messenger is not automatically found via this placeholder (as opposed to
UNIX). Therefore, set this agent variable in the INI file depending on the
VMS system on which the agent is used:
l OpenVMS (IA64):
UC_EX_JOB_MD = UCXJVI8M
l Alpha:
UC_EX_JOB_MD = UCXJVA7M
l VAX:
UC_EX_JOB_MD = UCXJVV7M
[TRACE]
The characters xx in the file name are place holders. They stand for the two-
digit abbreviation of the respective VMS version. See:Terminology.
When starting a trace, the trace files will be renamed so that the most current
trace file is always the one with the number "00".
tcp/ip= Trace flags of the agent
event=
job_debug=
ft_debug= Trace flags must only be used in close cooperation with Automic Support.
ex_init=
signal=
memory=
[TCP/IP]
this port number.
bindaddr= The IP address or host name for Server-process connection.
Use this parameter if the connection should be established via a particular IP

card).


connect= The time interval in seconds in which the agent attempts to establish a
connection to the Automation Engine. This affects the connection
specifications when restarting or connection is cut off.
The former parameter name agent= is still valid for compatibility reasons.

Automation Engine simultaneously.


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.
Allowed formats:
[STARTCMD]
SUBMIT= VMS command for starting a job in batch mode. You can adjust is user-
specifically 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= Indication of file attributes for file transfers
Allowed values: "alq", "deq", "mbc", "mbf" and "fop"
"alq" = Number of disk blocks used for the file transfer by default (1 block =
512 Byte)
"deq" = Number of disk blocks for extending the required memory
"mbc" = Specifies the number of blocks allocated to the I/O buffer
"mbf" = Indicates the number of I/O buffers that are to be allocated
"fop" = This file attribute currently supports the following parameters: cbt
(contiguous-best-try), ctg (contiguous) and tef (truncate at end-of-file). They
are separated by commas (e.g. fop=ctg,tef).
Automic recommends using the following values:

alq=5000,deq=5000,mbc=64,mbf=64
Note that the INI file parameter is read with each file transfer execution. File
attributes can be changed while the agent is running.
If you specify the file attributes directly in the file transfer, these attributes are
used instead of the attributes that are defined in the INI file.
[JOBREPORT]
reportname= The definition of the job-report's name.
Allowed placeholders in the file name are: "&userid", "&vms-jobname", "&AE-

jobname", "&client" and "&runnr"
"&userid" = User ID of the job execution.

"&vms-jobname" = Name of the job in VMS.
"&AE-jobname" = Name of the AE Job object.
"&client" = Number of the client in which the job has been started.
"&runnr" = RunID (run number) of the job.
With the agent variable UC_EX_PATH_JOBREPORT, you can specify the

directory in which the job reports should be stored.
[MISC]
FileNameLowerCase= The file name is important for the script functions PREP_PROCESS_
FILENAME and wildcard file transfers. Use this parameter in order to specify
whether the agent should leave the file name unchanged or convert it to
lowercase letters.
"yes" - File names are always converted to lowercase letters.

"no" - The agent does not adjust the file name's spelling.
TraceFileSize= 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 file transfer.
In VMS, each text file requires a line break at its end.
"yes" - In file transfers, 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.
Operation.

Format:
or
[GLOBAL]
name = VMS01
logging = [-.temp]UCXJVxx.l##
logcount = 6
helplib = ucx.msl
licence_class = 9
language = e,d
userid_type = EXCL
UC_user_type = EXCL
; rcv_block = yes
; rcv_max = 30
ReadUserAlways=no
ft_temp_file=yes
[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]
[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:
Windows Agent
Structure of the INI File UCXJWI3.INI (32-bit) / UCXJWX6.INI (64-bit)
[GLOBAL]

$, @, - and #.

logon= The settings for the execution of jobs / file transfers.
See: Description of the settings ANONYMOUS_FT and ANONYMOUS_

JOB in the variable UC_HOSTCHAR_DEFAULT.
language= The language that should be used for the logging. You can specify a
primary and a secondary language.


The xx characters in the file name are placeholders. They stand for the
two-character abbreviation of the respective Windows version.
See:Terminology

helpcache= The availability of the messages and language dependent strings.

"CONTROLS" = All language-dependent strings that are required in order
to display the dialog program are held in the RAM (not relevant for the
agent).
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.
Default value: powershell.exe -NonInteractive -ExecutionPolicy bypass -

NoLogo -file
With the default setting, Windows jobs, starting with "Interpreter" selection
are able to execute PowerShell commands. The parameter " -
ExecutionPolicy bypass " guarantees that the generated script (Windows
job) will run regardless of security settings setup by the administrator.
When this parameter is not set, the Windows administrator must explicitly
allow starting Powershell scripts on host. Otherwise Powershell jobs won't
be able to start.
Also refer to the information contained on Microsoft's website regarding

Powershell execution policies:
https://technet.microsoft.com/library/hh847748.aspx
ECPEXT= The extension of the file that is passed on to the interpreter.
This file contains the job script.
File ends should be specified without dot.
Default value: ps1

userid_type= An additional opportunity for the OS to allow or reject access to certain
users.
"INCL" = Access must be allowed for every single user that is specified in
[USERID]
"EXCL" = Access is denied to users that are specified in [USERID]. All
INCL only evaluates entries with "START" in the [USERID] section.

EXCL only evaluates entries with "NO_START" in the [USERID]
section.
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.
"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= This parameter creates temporary files in FileTransfers.
"yes" - The file obtains a temporary name which is composed of the letter
"T" and an alphabetic string originating from the RunID. The new file
transfer additionally appends a file ID to obtain a unique file name because
basically, only a RunID is provided. The file is renamed after it has
ft_check_free_disk_ This parameter checks the available hard disk space before a file transfer
space= 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.
ft_omit_user_home= When this parameter is set, the Windows Agent skips NetGetDCName()
and NetUserGetInfo() to determine the user home.
Allowed values:
"yes"
"no" (default)

Activating the Nagle algorithm can improve the performance of file

transfers, especially if you transfer many small files.
Note that this parameter should only be set in close cooperation with
Automic Support!


Allowed values:
etc.

ft_suppress_report= Determines whether you suppress file transfer reports.
The setting has to be done on the source agent and is only available for
Windows agents.
Allowed values:
"yes" - The agent doesn't send any report for all FileTransfers.
"no" (default): The agent sends reports as usual.
[AUTHORIZATION]
(company-key file).

[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).
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.

The job table is checked each second
[USERID] The specification of authorized Windows users in the format:
User name/Domain=START
Specification of unauthorized Windows users in the format:

User name/Domain=NO_START
[VARIABLES] This section contains the agent variables that include agent settings and
information.
[TRACE]
The xx characters in the file name are placeholders. They stand for the
two-digit abbreviation of the particular Windows version. See: Terminology

current trace file is always the one with the number "00"
tcp/ip= The trace flags for the TCP/IP communication of the agent .
filetransfer=
event=
mail= Trace flags must only be used in close cooperation with Automic
compress= Support.
memory=
[TCP/IP]
Other agents and the Job Messenger establish their connections to the
agent by using this port number.
bindaddr= The IP address or the host name for communication to the agent.

particular IP address (for example, the computer has more than one
network interface card).

Use this parameter together with bindaddr=

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.
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.
report= The time interval in seconds in which the agent sends the logging to the
Automation Engine.


cp= Address of the communication process in the AE system to which the
Allowed formats:
SendBufferSize= The size of the TCP/IP input buffer for messages that should be sent
(Byte).

RecvBufferSize= The size of the TCP/IP input buffer for messages that should be received
(Byte).

TcpKeepAliveTime= Used to set TcpKeepAlive on socket level of the operating system.
Default value: yes


[CP_LIST] The list of communication processes.
information about establishing a connectionin the chapter Multi-Server
Operation.
The communication process that is defined in the parameter cp=

Format:
or
[BACKEND]
useDesktop= Definition of whether the execution of the Windows commands of
backend-type Variable objects should be shown on the desktop.
Allowed values:
"0" (default) or "1"
"0" - Commands of backend-type variables run in the background.

"1" - Commands are shown on the desktop.
This function is only available when the Windows agent has not been
started via a ServiceManager (the option "Show job on desktop" of
Windows jobs reacts in the same way). The commands are shown on
the agent desktop.
Activating this parameter is only useful when the agent has not been
started with the system user.
[GLOBAL]
name=WIN01
system=UC4
logon=1
language=(E,D)
logging=..\TEMP\UCXJWI3_LOGG_##.TXT
logcount=10
helplib=uc.msl
helpcache=ALL
licence_class=V
;ECPEXE=
;ECPEXT=
userid_type=INCL
useJobObject=1
HomeDirCache=10
ft_temp_file=yes
[AUTHORIZATION]
InitialPackage=
KeyStore=
[STATUS_CHECK]
time=1
[USERID]
smith/UC4=START
[VARIABLES]
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
cp=PC01:2217
TcpKeepAliveTime=yes
[HOSTS]
[CP_LIST]
2218=PC01
See also:
z/OS Agent
Structure of the INI File UCXJM25.INI
(GLOBAL)
This entry must be identical to the entry made in the Automation Engine's INI
file.

@, - and #.

secondary language.


logging= Name of the log file.
The number signs serve as placeholders for a series in numerical order. Log
files are renamed at agent start so that the most current log file always has the
number "00".
If you comment this parameter, the log file is stored in JES. Refer to the
parameter logpurgeclass= which is described below.
The following parameters can be added when the log is written to a dataset
(after the dataset name and separated by semicolons):
"recfm" = (all 27 z/OS plus * and A record formats are valid)

"lrecl" = (0, each positive number up to 32760 and X for each reclen)
"blksize" = (0, each positive number up to 32760)
"space" = ([CYL,TRK],(prim,sec,directory))
logpurgeclass= MVS Sysout class for log files.
Allowed values: A-Z and 0-9

Default value: "A"
This parameter can be used to route log files to the specified MVS Sysout
class.
The Sysout class is only considered when the parameter logging= is

commented (";").
The parameter logcount= is important for the routing log files. The number of
log files that is defined in this parameter is created. The oldest log file is routed
to the Sysout class if this number is exceeded.
For example:
The parameter logcount= is set to 3. The first log file is routed to the Sysout
class when the fourth log file is created.
helpcache= Availability of messages and language dependent strings.

"NONE" = Always read message file from the hard drive.
"CONTROLS" = All language dependent strings that are necessary for
displaying a dialog program are held in the RAM (does not apply to agents).
licence_class= License class that corresponds to the acquired license and the hardware and

askRACF= Verification of the access authorizations with RACF for jobs and file transfers
before the agent starts (password verification for the user of the job/file
transfer and dataset authorization check in file transfers). 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.

Default value: "7"
Value Login Login File-access check File-access check

check check for for file transfers for file transfers
for file with the login's with the agent's
jobs transfers UserID UserID
0
1
10
11
12
13
14
15
completeJobout= This parameter determines the complexity of the job protocol.
"0" = Only JES statistics (JESMSGLG, JESJCL and JESYSMSG) are stored
in AE.
"1" = The entire job protocol (JES statistics+ job output) is stored in AE.
This setting can be overruled in the Job object and in the script using
attributes. More detailed information is provided in the document that
describes message classes.
jobPurge= Job-log deletion in the JES spool.
"0" = The job log remains in the JES without changes.

"1" = The job log is deleted from the JES.
describes the message classes.
relMsgClass= This parameter releases the job log for printing.
"0" = The job log is not released.

"1" = The job log is released for printing.
describes message classes.
getMsgClass= Message classes that should be read and routed.
Enter one or several message classes. Examples: "A", "ABC", "X1". You can
use any order.
routeMsgClass= Message classes to which the class should be routed.
After the transfer to the AE, the job log can also be routed to the specified
message classes (e.g., for an Output Management System).
Enter one or the number of message classes specified in the parameter

getMsgClass=. The correct order is significant.
For example:
The following message classes are read: "ABC"

and routed to: "DEF"
Class "A" is routed to "D", "B" to "E" and "C" to "F".
This setting can be overruled in the Job object and in the script by using
jes= Job Entry Subsystem (JES) that has been installed on the host.
Allowed values: "JES2" (default value), "JES3"

jobACF2= This parameter generates the job card in ACF2 format.
"0" = There is no job-card generation in ACF2 format.

"1" = The job card is generated in ACF2 format.
userid_type= This parameter provides an additional way of allowing or rejecting access to
certain users.
"INCL" = Access must be granted to each individual user under [USERID].

"EXCL" = Users who are specified under [USERID] are excluded. All other
users can start jobs.
jobAccount= Indicates whether the accounting information should be enclosed in
parentheses.
Allowed values: "0", "1" (Default value)
"0" = No parentheses are used for the accounting information

"1" = Parentheses are used for the accounting information
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= Allocation of the job's output (first extent cylinders, secondary cylinders).
Format: (number of cylinders, number of cylinders)

jobSubmitContext= The parameter "jobSubmitContext=" can be set to one of these values:
AGENT (default): The Job is submitted to the internal reader in the agent
context.
USER: The Job is submitted to the internal reader in the context of the Job
user specified in the Login object used in the Job.
Format: string
vanishedRetry= If the agent runs across a status change or an erroneous attempt to retrieve
the status while checking a job (rarely occurs), the job's status cannot clearly
be determined. This parameter can be used to specify how often the agent
retries to check the status before it reports the status "ENDED_VANISHED".

Default value: "6"
waitSpoolRetry= Repetition of the waiting time (see parameter waitSpoolReady)
Allowed values: 0 – 99
Default value: "6"
waitSpoolReady= Waiting time for the spool in hundredths of seconds.
Occasionally, it can take a while until the spool is available. This happens
when the agent runs in a Parallel Sysplex on a different LPAR. You can use
this parameter to extend the waiting time.
Allowed values: 0 – 9999

Default value: "50"
WaitOnJobEnd= Waiting for the job's end.
By default, the agent waits until the job is available in the output queue or
disappears. Occasionally, the job has already ended but cannot be found in the
output queue because it is still waiting for a system event (e.g. tape
swapping). Use this parameter to define whether the agent should check the
job's end status after it has ended. If the job is not found in the output queue, it
is monitored via the periodical job checking.
"0" - The agent does not wait.

"1" - The agent waits for the job to end.
ignoreEmptyJCL= Handling of blanks in JCL.
Allowed values: "0" and "1" (default values)
"0" - The JCL remains the same

"1" - The agent automatically removes blanks in the JCL before it is
processes.
"yes" - The file obtains a temporary name which is composed of the dataset
name of the file to be transferred plus a suffix. The suffix includes the letter"T"
and an alphabetic string originating from the RUN#. The new file transfer
additionally appends a file ID to obtain a unique file name because basically,
only a RunID is provided. The file is renamed after it has been transferred.
The file immediately obtains its final name if the temporary file name would
exceed the z/OS maximum of 44 characters.
The USS file system requires the parameter file_temp_file_uss to be used.


Support!
EventCheckIntervall= Periodical event check in seconds
Default value: 3600
Do not specify the value too low in order to avoid a high server workload.
PasswordMixedCase= Usage of uppercase and lowercase letters in passwords.
Allowed values "0" (default) and "1"
"0" - The agent converts all passwords into upper-case letters.

"1" - The password remains unchanged.
Ensure that the password settings comply with those on your system as
otherwise, the agent's login attempt will fail.
[AUTHORIZATION]
(company-key file).

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
afterward.
ft_thread_level_ Default value: "No"

security=
Allowed values: "Yes" or "No"
l Value "No": The authorization of the user starting the FileTransfer will
be checked, but the FileTransfer will be executed with the authorization
of the user starting the agent.
l Value "Yes": On starting the FileTransfer a switch inside the
FileTransfer's thread will be executed to the user context of the user,
whose data has been entered in the Login object, which is referenced in
the FileTransfer object. Any input and output will be executed with the
permissions of the user starting the FileTransfer.
(JCL Exit)
name= Name of the JCL-Exit module based on Assembler.
The Assembler-based module is used when you do not specify the c-based
JCL Exit (the parameter ExitModul= is missing or does not contain any value).
maxJclRecords= Size of the output area.
ExitModul= Name of the DLL file of the JCL Exit module based on the programming
language C.
The Assembler-based JCL Exit is used when you do not specify this
parameter or when it does not include a value.
ExitFunction= Name of the module's function that implements the JCL Exit.
It refers to the JCL Exit module that is specified in the parameter ExitModul=.
The agent calls this function before it runs the job JCL. If this function returns a
code other than 0, the JCL will not be processed and the job aborts.
Default value: "jcl_exit"

InitFunction= Function that initializes the JCL Exit module (allocating memory, for example)
and is called when the agent starts.
If this function returns a code other than 0, the c-based JCL Exit is

deactivated.
This parameter is optional and refers to the JCL Exit module that is specified in
the parameter ExitModul=.
CloseFunction= Function that should be called when the agent ends in order to run final
processes such as releasing memory).
This parameter is optional and refers to the JCL Exit module that is specified in
the parameter ExitModul=.
(USERID) Specification of authorized z/OS users in the format:
User name=START
Specification of non-authorized z/OS users in the format:

User name=NO_START
(Variables) This section contains agent variables with agent information and settings.
(TRACE)
always has the number "00".
The following parameters can be added (after the dataset name and separated
by semicolons) if the log is written to a dataset:
"recfm" = (all 27 record formats of z/OS plus * and A are valid)

tcp/ip= The agent's trace flags for the TCP/IP communication.
filetransfer=
status=
joboutput= Trace flags must only be used in close cooperation with Automic Support.
event=
memory=
trcmode= Method used for the trace files.

Default value: "1"
"0" - The trace file is normally written.

"1" - All file buffers are written to the disk after each trace line.
"2" - Close/Open is used for the trace file after each trace line. Do not use this
option in combination with FileSystem events because it causes an event for
each line which can lead to recursive endless loops.
"3" - Trace outputs are also written to the log file.
(TCP/IP)
cp= The address of the AE system's communication process to which the agent
should connect.
Allowed formats:
port= The agent's port number .
Other agents and the Job Messenger use this port number to establish a
connection to the agent.
bindaddr= IP address or host name for the agent connection.
Use this parameter if the connection should be established via a particular IP

address (e.g., if the computer has more than one network interface card).
This parameter is to be used in combination with bindaddr=.

connect= Time interval in seconds in which the agent tries to establish a connection to
the Automation Engines (when rebooting or lost connection).
This parameter only applies until the agent has successfully logged on to
the AE system. Afterwards, the parameter RECONNECT_TIME (see host
characteristics) is used.
Automation Engine.

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.

AsyncConnect= The agent tries to connect to a communication process if the connection was
lost. If it is not successful, it tries to log on to a different communication
system after a particular waiting period. Automic recommends specifying
AsyncConnect=1 which causes the waiting period to be reduced.

SendBufferSize= Size of the TCP/IP input buffer for messages that should be sent (Byte).

RecvBufferSize= Size of the TCP/IP input buffer for messages that should be received (Byte).

tcp_keepalive= Setting of keep-alive packets in order to maintain the connection between the
agent and the event monitor.
Allowed values: "n" and "y" (default value)
"y" - Keep alive packets are sent.

"n" - Keep alive packets are not sent.
Listen= Specifies the maximum number of connection requests queued for the
listening socket of the agent.
This parameter cannot be used to provide a higher number than the system
parameter SOMAXCONN.
For example, if Listen=500 is set here, and the system parameter

SOMAXCONN is set to 10, the maximum of 10 is used.
Therefore, it makes the most sense to set both parameters to the same value.
The value depends on the number of parallel connections of messengers and
file transfers. However, the recommended technique is to use the SMF based
messaging technique rather than IP messenger.
For more information on the SOMAXCONN statement in the system's TCP/IP

profile, see http://www-01.ibm.com/support/knowledgecenter/SSLTBW_
2.1.0/com.ibm.zos.v2r1.halz001/somaxconnstatement.htm.
(HOSTS) Assignment of an agent's name to its address (DNS name or TCP/IP address)
if it cannot directly be accessed through the address that is stored in the
server. Specify several assignments line by line, there is no upper limit for the
number of assignments.
(CP_LIST) List of communication processes.
This list is created when the agent starts and it is extended when new

Format:
or
(GLOBAL)
system=UC4
name=MVS01
language=(E,D)
logging='UC4.WORK.LOG##'
logcount=10
logpurgeclass=9
helplib='UC4.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)
file='UC4.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)
(CP_LIST)
2218:PC01
See also:
z/OS - Event Monitor
Structure of the INI File UCXEM25.INI
This is the INI file for the Event Monitor, which runs as a started task.
(GLOBAL)
This entry must comply with the entry that has been specified in the
Automation Engine's INI file.
name= Name of the Event Monitor
This name must be unique.
language= Language in which the logging is made. Specification of primary and

secondary language.
Allowed values: "E", "D" and "F"
Default: "E,D" (primary language English, secondary German)
If the message is not available in the primary language, the system searches
for it in the secondary language.
If you comment this parameter, this log file is stored in JES. Also refer to the
The following parameters can be added if the log is written to a dataset (after
the dataset name and separated by semicolons):

logpurgeclass= MVS Sysout class for log files.

Default value: "A"
class.
The Sysout class is only considered if the parameter logging= has been
commented using ";".
The parameter logcount= is important when you route log files. The number of
log files that has been defined in this parameter is created. The oldest log file
is routed to the Sysout class if this number is exceeded.
Example:

"CONTROLS" = All language dependent strings that are necessary in order to
display a dialog program are held in the RAM (does not apply to agents).
EventCheckIntervall= Periodical event check in seconds.
Default value: 3600
In order to avoid a high Server workload, do not specify a value that is too low.
(TRACE)
The following parameters can be added (after the dataset name and separated
by semicolons) if the log is written to a dataset:
"recfm" = (all 27 record formats of z/OS plus * and A are valid)

tcp/ip= Agent's trace flags for TCP/IP communication
filetransfer=
status=
joboutput= Trace flags must only be used in close cooperation with Automic Support.
event=
trcmode= Method that should be used for the trace files.

Default value: "1"
"0" - Trace file is written normally.

option in combination with FileSystem events as it causes an event for each
line, which can lead to recursive endless loops.
(TCP/IP)
ex= Address of the agent to which the Event Monitor should connect.
Allowed formats:
connect= Time interval in seconds in which the Event Monitor tries (cyclically) to
establish a re-connection to the agent.
The Console command "MODIFY ..., EX=<addr>,:<port> serves to

facilitate a new connection immediately. In this case, the attempt to re-
connect to the specified agent is made immediately. A reconnection is
established, even if the Event Monitor already has a connection to another
agent. A new connection is then established. The old connection is ended
if the new connection has successfully been established.
ex2= Alternative agent address to which the Event Monitor should connect if the
primary agent (parameter ex=) is not available.
exn= An additional alternative agent address to which the Event Monitor should
connect if the primary agent (parameter ex=) is not available.
SendBufferSize= Size of the TCP/IP input buffer for messages to be sent (Byte).

RecvBufferSize= Size of the TCP/IP input buffer for messages to be received (Byte).

tcp_keepalive= Setting of keep-alive packets in order to maintain the connection between the
agent and the Event Monitor.
Allowed values: "n" and "y" (default value)
"y" - Keep-alive packets are sent.

"n" - Keep-alive packets are not sent.
(CONSOLE)
For Console events:
console= Console analysis.
"0" = The console is not used.

"1" = The console is analyzed.
buffersize= Size of the input buffer for Console events.
Default value: 1 MB
For SMF-based events
(e.g. Job ends,
FileSystem events
etc.):
smfwrite= Evaluation of SMF records.
"0" = SMF records are not used.

"1" = SMF records are analyzed.
To be able to monitor the closing of files and especially for using

Generation Data Groups, this parameter must be activated.
ModulName= Name of the SMF Exit.
Default value: "UC4EXIT"
The selected name must be unique if several Event Monitors are used per
LPAR.
CADSEyeCatcher= Eyecatcher name that should be used as a parameter to call the utility
CADSDEL.
Maximum 8 characters
Default value: LPAR name

smfStepFilter= Analyzes SMF records in automated FileSystem events.
"0" - The Event Monitor only analyzes the SMF records of job ends. Normal
and abnormal endings are distinguished.
"1" - The Event Monitor also analyzes the SMF records for STEP endings.
The highest return code is assumed. The disadvantage of this specification
lies in increased performance usage.
SMFJob= Message about a Job or STEP end.
"0" - The job end is exclusively monitored by the Job Messenger.

"1" - The job end is identified by SMF records.
Make sure that the SMF module logs the SMF record 30 and that your
system permits the Exit IEFU84.
SMF_Buffersize= Size of the Common Area Data Space (CADS) in which the SMF Exit stores
events (in MB).

Default value: 10
About 65000 events can be stored with 10 MB.

ABENDNUM= Number of allowed SMF Exit abnormal ends.
Default value: 2
The agent deactivates the SMF Exit if it aborts more often than is defined
here. A message is sent to the Console.
Message filter: *CSVDYNEX DELETE(EN=*,ROUTINE=*)*
This message is also sent if the agent has ended because in this case, the
SMF Exit has also been deactivated.
Further messages and filters for the SMF Exit:
Ordered SMF Exit abend: *UC4 IEFU83 EXIT ABENDED*

System message if the SMF Exit fails: *CSV430I MODULE * FOR EXIT *
HAS BEEN MADE INACTIVE*
(GLOBAL)
system=UC4
name=EM01
language=(E,D)
logging='UC4.WORK.EMLOG##'
logcount=10
logpurgeclass=9
helpcache=ALL
(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
z/OS - External Job Monitor
Structure of the INI File UC4EJM.INI
Description of the INI file of the external Job Monitor which is operated as an independent task (started
task).
(GLOBAL)
name= Name of the external Job Monitor.
This name must be unique.
language= Language in which the logging is carried out. Specification of primary and
secondary language.
Allowed values: "E", "D" and "F"
Default: "E,D" (primary language English, secondary German)
If the message is not available in the primary language, the system searches
for it in the secondary language.
If you comment this parameter, this log file is stored in JES. Also refer to the
The following parameters can be added when the log is written to a dataset
(after the dataset name and separated by semicolons):

logpurgeclass= MVS Sysout class for log files

Default value: "A"
class.
The Sysout class is only considered if the parameter logging= has been
commented using ";".
The parameter logcount= is important if you route log files. The number of log
files that has been defined in this parameter is created. The oldest log file is
routed to the Sysout class if this number is exceeded.
For example:

"CONTROLS" = All language dependent strings that are necessary in order to
display a dialog program are held in the RAM (does not apply to agents).
JobFilter= Name of the filter file (job filter dataset).
JobTable= Name of the job table dataset.
The job table dataset is written if the external Job Monitor has been ended
with the option END. It is used to store the states of active jobs. The SMF
Exit continues and checks whether an active job that is part of the job table
dataset has ended. The job table dataset is deleted whenever the external Job
Monitor starts.
Each external Job Monitor on an LPAR requires its own job table dataset.
In contrast, all EJMs within a sysplex can use the job filter dataset.
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)
The number signs serve as placeholders for ascending numbering. The log
files are renamed when a trace is activated. The latest trace file is always the
one with the number "00".
event= TraceFlag of the external Job Monitor.

trcmode= Method used for the trace files

Default value: "1"
"0" - Trace file is written normally.

option in combination with FileSystem events as it causes an event for each
line which can lead to recursive endless loops.
trccount= Number of trace files that are kept.
(SMFExit)
Modulname= Name of the SMF Exit module for the external Job Monitor.
SMF_Buffersize= Size of the Common Area Data Space (CADS) in which the SMF Exit stores
events (in MB).

Default value: 10
About 65000 events can be stored with 10 MB.

ABENDNUM= Number of allowed SMF Exit abnormal ends.
Default value: 2
The agent deactivates the SMF Exit if it aborts more often than is defined
here. A message is sent to the Console.
Message filter: *CSVDYNEX DELETE(EN=*,ROUTINE=*)*
This message is also sent if the agent has ended because in this case, the
SMF Exit has also been deactivated.
Further messages and filters for the SMF Exit:
Ordered SMF Exit abend: *UC4 IEFU83 EXIT ABENDED*

System message if the SMF Exit fails: *CSV430I MODULE * FOR EXIT *
HAS BEEN MADE INACTIVE*
CADSEyeCatcher= Eyecatcher name that should be used as a parameter for calling the utility
CADSDEL.
Default value: LPAR name

(GLOBAL)
name=UC4EJM
;lpar=LPAR1
language=(D,E)
;logging='UC4.EJM.LOG##'
logcount=2
logPurgeClass=9
helplib='UC4.UCX.MSL'
helpcache=ALL
jobfilter='UC4.EJM.JOBFLTR'
jobtable='UC4.EJM.JOBTABLE'
(TRACE)
;file='UC4.EJM.TRC##';space=(CYL,(10,5))
trccount=10
event=0
trcmode=3
(CONSOLE)
modulname=UC4EJM
smf_buffersize=10
;AbendNum=2
CADSEyeCatcher=UC4EJM
See also:
3.1.5 Utilities
AE DB Archive
Structure of the INI File UCYBDBAR.ini
[GLOBAL]
helpcache= The availability of message and language dependent strings.
"ALL" = The entire message file is kept in the RAM.

"NONE" = The message file is always read from the hard drive.
"CONTROLS" = All language dependent strings required for displaying a
dialog program are held in the RAM.
language= The default language that is used for login.
Allowed values: "E" (default value), "D", "F"

"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.
The number characters are used as place holders for consecutive

numbering. When you start the utility the log files are renamed so that the
current log file always shows the number "00".
MaxDeadlockCount= The maximum number of deadlocks per operation.
docu_path= The directory in which the help system is installed.
cmd= The command-line command for starting the utility.
path= The start path for the utility.
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).

[ENVIRONMENT]
classpath= The path and the file name of the archive for layout files.
[TRACE]

numbering. When you start the agent, the log files are renamed so that the
database= The trace flag for the utility's database access.
Trace flags must only be used in close cooperation with Automic

Support. AE does not recommend setting trace flags because the
logging of database accesses decreases performance.
[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= The message number and the message inserts.
AH_LoginDst= The name of the Login object for file transfer (destination).
AH_ProcessId= TNS/Process ID.
AH_CpuTime= Used CPU time.
AH_KernelTime= Used system time.
AH_UserTime= Used user time.
AH_IOCount= IO counter.
AH_InfoText= Text from the agent.
AH_HostDst= The host name for the file transfer (destination).
AH_CodeNameDst= The code table for the file transfer (destination).
AH_FileNameDst= The file name for the file transfer (destination).
AH_HostSrc= The host name for the file transfer (source).
AH_LoginSrc= The name of the Login object for the file transfer (source).
AH_CodeNameSrc= The code table for the file transfer (source).
AH_FileNameSrc= The file name for the file transfer (source).
AH_Count= The number of transferred bytes (for file transfer) or started tasks (for a
group).
AH_FileSize= The bytes of the complete file.
AH_Records= The number of records in the file.
AH_Status= Status of the activity.
AH_RetCode= The task's return code .
AH_Restart= The restarted activation.
AH_RefNr= The RunID of the reference task for a restart.
AH_RestartPoint= The restart point of the restarted task .
AH_LastRP= The last processed restart point.
AH_EventType= TT - Time event (timer).
TS - Time event (time of execution).
AH_RepeatType= Event:
R = repeated
S = single
File transfer: include subdirectories
R = yes
S = no
AH_TimePeriod= The period in minutes or HHMM depending on the event type.

AH_CheckCount= The number of checks.
AH_OccurCount= The number of occurred events.
AH_EventSubType= The event's subtype
AH_Operator= G = greater
L = less
E = equal
N = not equal
AH_Value= Comparing value
AH_Unit= The unit of the comparing value:
0 = host specific
1 = Byte
2 = Kilobyte
3 = Megabyte
4 = Gigabyte
5 = Terabyte
AH_Cancel= Cancels the flag:
M = manually
AH_Source= WIN_EVENT: Source
AH_Category= WIN_EVENT: Category
AH_TExecType= Time event with a start time:
E = execute
N = do not execute
Time event with an interval:
S = start immediately
File transfer:
1 = File transfer with wildcard characters
AH_MaxRetCode= The return code settings of the Runtime tab.
AH_IntAccount= The internal account of the Attributes tab.
AH_Name= The name of the object.
AH_Transferred= The transferred number of bytes.
AH_Compress= The compression type
"0" - None
"1" - Normal
"2" - Strong
AH_Ert= Estimated runtime.
AH_Archive1= The archive key 1 of the Header tab.
AH_Archive2= The archive key 2 of the Header tab.
AH_Info= Additional information, such as job number.
AH_ParentAct= The parent's ID (Activator).
AH_ParentPrc= The parent's ID (Processor).
AH_DeleteFlag= Deletion flag.
AH_TaskCount= The number of tasks.
AH_ArchiveFlag= The archive flag.

AH_Rest= Additional attributes.
AH_TZ= The TimeZone for object and script.
AH_TimePeriodTZ= The TimeZone for the event.
AH_ReuseHostGroup= Re-using the agent group calculation in workflows.
AH_HGSrc= The name of an agent group.
AH_HGDst= The name of an agent group as the destination of file transfers.
AH_MaxParallelHG= The maximum number of parallel tasks in agent groups.
AH_ChildCnt= The number of subordinated tasks.
AH_ChildCntFail= The number of subordinated tasks that have been canceled and
successfully repeated.
AH_ChildCntFailAll= The umber of subordinated tasks that have been canceled.
AH_ChildCntRestart= The number of subordinated tasks that have been repeated.
AH_ContainerType= The object type of the related container.
[ODBC]
SQLDRIVERCONNECT The database connection.

=
ODBCVAR - Eight-digit command field for controlling database accesses.

commits.
2. Position = D - Disconnects the database after 1000 commits
(perhaps due to memory problems).
(Oracle).
(Oracle).
5. Position = N - The type of the database connection: ODBC
5. Position = I - The type of the database connection: OCI/CLI.
6. Position = N - Database access without the User ID.
6. Position = O - Database access with the User ID.
8. Position = The type of SQL syntax; N - MS SQL Server
8. Position = The type of SQL syntax; O - Oracle
8. Position = The type of SQL syntax; D - DB2
DSN - The alias name of the database connection.

UID - The User ID for the database access.
PWD - The password for the database access. Should always (also "") be
encoded. See: Encoding passwords
Only for ORACLE:

The code-page settings must correspond to those of the database. Automic
Syntax:
TERRITORY=area,CODESET=character
set,RECONNECT=interval,commit_write='BATCH,NOWAIT'
RECONNECT refers to the frequency that is used to re-establish the

database connection. This parameter is given priority even if a "D" is set in
the 2nd digit of ODBCVAR (see above).
Automic recommends using the parameter commit_

write='BATCH,NOWAIT' in order to increase performance.
For example:
(Two lines are used for the connection parameters for lack of space. In the
INI file, you should only use one line).
=--1037B2E22BF022EBE2;
SP=NLS_LANGUAGE=AMERICAN,NLS_
TERRITORY=AMERICA,CODESET=WE8ISO8859P15,commit_
write='BATCH,NOWAIT'
See also: Setting up ORACLE databases
Only for DB2:
Use "N" on the 6. position in the connection string, when the UID for
database access is a domain user.
See: Notes for Configuration-File Adjustments

[GLOBAL]
helplib=uc.msl
Helpcache=all
language=E
logging=..\TEMP\UCYBDBArchiv_LOGG_##.TXT
logcount=10
MaxDeadlockCount = 2
docu_path=C:\AUTOMIC\Documentation
cmd="javaw" -jar -cp .;.\UC4LAF.jar UCYBDBAR.jar
path=.
title=UC4 DB-
[ENVIRONMENT]
classpath=.;.\UC4LAF.jar
[TRACE]
file=..\TEMP\UCYBDBArchiv_TRACE_##.TXT
trccount=10
database=0
[AH_BODY]
AH_TimeStamp1 = 1 ; start time
AH_TimeStamp4 = 1 ; end time
AH_MsgNr = 1 ; return code
AH_LoginDst = 1 ; name of Login object
AH_ProcessId = 1 ; TSN / process id
AH_CpuTime = 1 ; used CPU time
AH_KernelTime = 1 ; used kernel time
AH_UserTime = 1 ; used user time
AH_IOCount = 1 ; count of I/Os
AH_InfoText = 1 ; text from agent
AH_HostDst = 1 ; name of the agent or agentgroup
AH_CodeNameDst = 1 ; codetable for filetransfer
AH_FileNameDst = 1 ; filename for filetransfer
AH_HostSrc = 1 ; name of agent (sender)
AH_LoginSrc = 1 ; name of Login object for sender file
AH_CodeNameSrc = 1 ; codetable for filetransfer (sender)
AH_FileNameSrc = 1 ; filename for filetransfer (sender)
AH_Count = 1 ; filetransfer: bytes transfered group: number
of started activities
AH_FileSize = 1 ; bytes of the complete file
AH_Records = 1 ; number of records
AH_Status = 1 ; state of the activity
AH_RetCode = 1 ; return code
AH_Restart = 1 ; was this a restarted activation?
AH_RefNr = 1 ; reference job number
AH_RestartPoint = 1 ; restart point from where the task was restarted
AH_LastRP = 1 ; last processed restart point
AH_EventType = 1 ; TT time event(timer), TS time event(time of
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
; |||+---- not used
; ||+----- J = compare fieldnames case-insensitive (in case of
ORACLE !!)
;

; Oracle with OCI
; DB2 with CLI
See also:
General Procedure - Database Maintenance

Archive Browser
Archiving
Structure of the Archived Folder
AE DB Change
Structure of the INI File UCYBCHNG.INI
[GLOBAL]
Helplib= The name of the message file.
Helpcache= The availability of message and language dependent strings.

"CONTROLS" = All language dependent strings which are required for
displaying a dialog program are held in the RAM.
logging= The log-file path and the name .
The number characters are used as place holders for consecutive numbering.
When your start the utility, the log files are renamed so that the current log file
always shows the number "00".
language= Language that is used to write the messages to the log file.
Allowed values: "D", "F" and "E" (default)

"D" = German
"F" = French
"E" = English
When you select several languages here, the first language is used as the
default language.
[TRACE]
The characters are used as place holders for consecutive numbering. When
the agent starts, the log files are renamed in order to ensure that the current
log file always shows the number "00".
level= The trace level for the program flow of the utility.
See: Notes for Adjusting Configuration Files
[GLOBAL]
Helplib=uc.msl
Helpcache=all
language=E
logging=..\TEMP\UCYBCHNG_LOGG_##.TXT
logcount=10
[TRACE]
file=..\temp\ucybchng_trace_##.txt
trccount=10
level=0
; 0=no
; 1=Basic trace
; 2=Function level
; 3=Section level
; 4=everything
See also:
General Procedure - Transport Case

Modifying Exported Data
AE DB Client Copy
Structure of the INI File UCYBDBCC.ini
[GLOBAL]
Helpcache= The availability of the message and language-dependent strings.

"CONTROLS" = All the language-dependent strings that are required for
displaying a dialog program are held in the RAM.
language= The language that the login window suggests by default.
Allowed values: "E" (default), "D", "F"

"D" = German
"F" = French
"E" = English
the utility starts, the log files are renamed in order to ensure that the current
WorkTablePath= The directory in which the worktable files are created.
DeadlockCnt= The maximum number of deadlocks per operation.
cmd= Command line call command to start the utility.
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]
[TRACE]
the agent starts, the log files are renamed in order to ensure that the current

Support.
[SOURCEDB]

=

commits.
2. Position = D - Disconnects database after 1000 commits
(Oracle).
(Oracle).

UID - The user ID for database access.
PWD - The password for database access. It should always (also "") be
Only for ORACLE:

Syntax:
RECONNECT refers to the frequency with which the database connection

should be re-established. This parameter is given priority even if a "D" was
set in the 2nd digit of ODBCVAR (see above).

For example:
=--1037B2E22BF022EBE2;
Only for DB2:
[TARGETDB]
TargetDB= The use of the destination database.
0 = The destination database is the same as the source database.

1 = For the destination database data of the entry
SQLDRIVERCONNECT= is used.
CommitCnt= Number of database actions after which a commit to the database is
necessary.
SQLDRIVERCONNECT The connection to the destination database.
=
Will only be considered if TargetDB=1 is set.
See: Notes for Adjusting INI files
[GLOBAL]
helplib = uc.msl
Helpcache = ALL
language = E
docu_path = C:\AUTOMIC\Documentation
logging = ..\TEMP\UCYBCLICPY_LOGG_##.txt
logcount = 5
WorkTablePath = C:\AUTOMIC\UTILITY
DeadlockCnt = 25
cmd="javaw" -jar -cp .;.\UC4LAF.jar UCYBDBCC.jar
path=.
title=UCYBDBCliCpy
[ENVIRONMENT]
[TRACE]
file = ..\TEMP\UCYBCLICPY_TRACE_##.txt
trccount = 10
database = 0
;0=nein
;1=SQL
;2=OPC
;3=BindParam
;4=Datenbereiche
[SOURCEDB]
; ODBCVAR xxxxxxxx
; |||+---- not used
ORACLE !!)
;
; NNJNIORZ for DB2/OS390 (7.1) with CLI (Call Level Interface)

; Oracle with OCI
; DB2 with CLI
[TARGETDB]
TargetDB = 1
CommitCnt = 1000

SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4_test;UID=uc4;PWD=--
1037B2E22BF022EBE2
; Oracle with OCI
; DB2 with CLI
See also:
Copying and Deleting Clients
AE DB Load
Structure of the INI File UCYBDBLD.ini
[GLOBAL]

numbering. When you start the utility, the log files are renamed so that the

language= Language.

"D" = German
"F" = French
"E" = English
helpcache= The availability of the message and language dependent strings.

displaying a Dialog program are held in the RAM.
INPUT= The path of the DB directory.
The path of your database directory must be specified so that the utility can
access the required data during the loading process.
Default value: "..\DB" for Windows or "../DB" for UNIX
This path is also decisive for the folder that should be opened in the file-
selection dialog which is displayed when you call the utility.
cmd= Command-line command for starting the utility.
changed.
[ENVIRONMENT]
[TRACE]


Support.
[ODBC]
SQLDRIVERCONNECT The connection for the database.

=

commits.
(Oracle).
(Oracle).

UID - The User ID for database access.
Only for ORACLE:

Syntax:
RECONNECT refers to the frequency with which the database connection

should be re-established. This parameter is given priority even if a "D" was

For example:
=--1037B2E22BF022EBE2;
Only for DB2:

[GLOBAL]
logging=..\TEMP\UCYBDBLD_LOGG_##.TXT
logcount=10
language=E
helplib=uc.msl
helpcache=ALL
INPUT=..\DB\
cmd="javaw" -jar -cp .;.\UC4LAF.jar UCYBDBLD.jar
path=.
title=UCYBDBLd
[ENVIRONMENT]
[TRACE]
file=..\TEMP\UCYBDBLD_TRACE_##.TXT
trccount=10
database=0
; 0=no
; 1=SQL
; 2=OPC
; 3=BindParam
; 4=data fields
[ODBC]
; ODBCVAR xxxxxxxx
; |||+---- not used
ORACLE !!)
;

; Oracle with OCI
; DB2 with CLI

See also:
Loading Databases
AE DB Reorg
Structure of the INI File UCYBDBRE.ini
[GLOBAL]
Helpcache= The availability of the message and language dependent strings.

"CONTROLS" = All language dependent strings which are required . for
displaying a Dialog program are held in the RAM .

"D" = German
"F" = French
"E" = English

cmd= The command line command for starting the utility.
changed.
alloc_size= The utility processes the data records block by block. This parameter
specifies the block size (number of data records).

[ENVIRONMENT]
[REORG]
no_archive_check= Archiving check.
"0" = Checks if data has been archived before.

"1" = There is no such check.
auto_reorg= The maximum age of the data records in days.

Default value: 365 days
All data records that are older than specified in this parameter are
reorganized except the parameter no_archive_check= has been set to
value "0". In this case, the utility only reorganizes the data records which
have previously been archived.
In both cases, auto_reorg= overrules the settings that are made in the
utility's interface (such as the reorganization of messages that are older
than n days) when fewer days are specified in the INI-file parameter. The
lower value always overrules the higher value.
For example:
auto_reorg = 183
All data records will be reorganized when you use the value "0".
[TRACE]

trccount= The number of the stored trace files.
Trace flags must only be used in close cooperation with

Automic Support.
[ODBC]

=
ODBCVAR - Eight-digit command field for controlling database accesses

commits.
(Oracle).
(Oracle).
5. Position = N - The type of the database connection: ODBC.
8. Position = The type of SQL syntax; N - MS SQL Server.
8. Position = The type of SQL syntax; O - Oracle.
8. Position = The type of SQL syntax; D - DB2.

Only for ORACLE:

Syntax:
RECONNECT refers to the frequency that should be used to re-establish

the database connection. This parameter is given priority even if a "D" is

For example:
=--1037B2E22BF022EBE2;
Only for DB2:

[GLOBAL]
helplib=uc.msl
Helpcache=all
language=E
logging=..\TEMP\UC_DBReorg_LOGG_##.TXT
logcount=10
cmd="javaw" -jar -cp .;.\UC4LAF.jar UCYBDBRE.jar
path=.
title=UC4 DB-
[ENVIRONMENT]
[REORG]
no_archive_check=0
auto_reorg=365
[TRACE]
file=..\TEMP\UC_DBReorg_TRACE_##.TXT
trccount=10
database=0
[ODBC]
; ODBCVAR xxxxxxxx
; |||+---- not used
ORACLE !!)
;

; Oracle with OCI
; DB2 with CLI
See also:

Reorganization
AE DB Reporting Tool
Structure of the INI File UCYBDBRT.INI
[GLOBAL]
The number characters are used as placeholders for consecutive


"CONTROLS" = All language dependent strings that are required in order to
display a dialog program are held in the RAM.
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= Order in which the fields are listed in the analysis report.
"0" - The order results from the specification made in the utility's analysis
definition.
"1" - The utility automatically selects the order in which the data is logically
grouped.
[TRACE]

database= Trace flag for the utility's database access.

reptool= Trace flag for the Reporting Tool.

Support.
[ODBC]

=
ODBCVAR - Eight-figure command field to control database accesses.

commits.
2. Position = D - Disconnect database after 1000 commits (perhaps
due to memory problems).
(Oracle).
(Oracle).
5. Position = N - Type of database connection: ODBC
5. Position = I - Type of database connection: OCI/CLI.
8. Position = Type of SQL Syntax; N - MS SQL Server.
8. Position = Type of SQL Syntax; O - Oracle.
8. Position = Type of SQL Syntax; D - DB2.
DSN - Alias name of the database connection.

UID - User ID for database access.
PWD - Password for database access. Should always (also "") be
Only for ORACLE:

Code page settings must correspond to those of the database. AE therefore
Syntax:

database connection. This parameter is given priority even if a "D" was set
in the 2nd digit of ODBCVAR (see above).

Example:
INI file, you should use only one line.)
SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=uc4;UID=uc4;PWD
=--1037B2E22BF022EBE2;
Only for DB2:

[GLOBAL]
logging=..\TEMP\LOGG_REP_##.TXT
logcount=10
helplib=uc.msl
helpcache=ALL
[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
; |||+---- not used
ORACLE !!)
;

; Oracle with OCI
; DB2 with CLI
See also:
Reporting
AE DB Revision Report
Structure of the INI File UCYBDBRR.ini
[GLOBAL]

"D" = German
"F" = French
"E" = English
and the log-file messages. If you select several languages here, the first
language is used as the default language.

helpcache= The availability of the message and language dependent strings.

[TRACE]

trccount= The number of the stored trace files.
database= The trace flag for database access of the utility.

Support.
[ODBC]

=

commits.
2. Position = D - Disconnects database after 1000 commits
(Oracle).
(Oracle).
6. Position = N - The database access without User ID.
6. Position = O - The database access with User ID.
8. Position = The type of SQL Syntax; N - MS SQL Server
8. Position = The type of SQL Syntax; O - Oracle
8. Position = The type of SQL Syntax; D - DB2

UID - The user ID for database access.
PWD - the password for database access. Should always (also "") be
encoded. See: Encoding Passwords
Only for ORACLE:

Code page settings must correspond to those of the database. Automic
Syntax:


For example:
(Two lines are used for the connection parameters for lack of space. You
should only use one line in the INI file.)
=--1037B2E22BF022EBE2;
Only for DB2:
[GLOBAL]
language=(D,E,F)
logging = ..\TEMP\UCYBDBRR_log_##.txt
logcount =10
helplib = uc.msl
helpcache=ALL
[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
; |||+---- not used
ORACLE !!)
;

; Oracle with OCI
; DB2 with CLI
See also:
Revision Report
AE DB Unload
Structure of the INI File UCYBDBUN.ini
[GLOBAL]

OUTPUT= The path and the name of the file that contains the unloaded data.
Helpcache= The availability of the message and language dependent strings.

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= The number of data records that should be deleted at once.
Default value: 100

language= Language.

"D" = German
"F" = French
"E" = English
cmd= The command line command that can be used to start the utility.
changed.
[ENVIRONMENT]
[TRACE]


Support.
level= The trace level for the program flow of the utility.

Support.
[TRANSPORT]
all_entities= The setting for the scope of the unloaded data in the Transport Case.
"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.
"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.

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= The maximum number of deadlocks per operation.

[ODBC]

=

commits.
(Oracle).
(Oracle).
8. Position = The type of SQL syntax; N - MS SQL Server.
8. Position = The type of SQL syntax; O - Oracle.
8. Position = The type of SQL syntax; D - DB2.

Only for ORACLE:

Syntax:


For example:
=--1037B2E22BF022EBE2;
Only for DB2:

[GLOBAL]
logging=..\TEMP\UCYBDBUN_LOGG_##.TXT
logcount=10
OUTPUT=..\DB\UC_DATA.TXT
helplib=uc.msl
helpcache=ALL
;wait time in milliseconds (only in case of Reorg)
;Reorg_Commit_Sleep=500
CommitCount=100
language=E
cmd="javaw" -jar -cp .;.\UC4LAF.jar UCYBDBUN.jar
path=.
title=UCYBDBUN
[ENVIRONMENT]
[TRACE]
file=..\TEMP\UCYBDBUN_TRACE_##.TXT
trccount=10
database=0
; 0=no
; 1=SQL
; 2=OPC
; 3=BindParam
; 4=data fields
level =0
; 0=no
; 1=Basic trace
; 2=Function level
; 3=Section level
; 4=everything
[REORG]
reorg_chunk_size=1000
no_archive_check = 0
max_deadlock = 100
[TRANSPORT]
all_entities = 1
[ODBC]
; ODBCVAR xxxxxxxx

; |||+---- not used
ORACLE !!)
;

; Oracle with OCI
; DB2 with CLI
See also:
Unloading Databases
Utility for the Console Event (UCON Connection)

Structure of the INI File x.xxx.UCXEB2?U.INI
(GLOBAL)
NAME= The name of the utility.
WAITTIME= The interval (seconds) in which the utility checks incoming messages.
POOLSIZE= The size of the input buffer for messages (memory page).
1 memory page = 4K
UCON= The name of the operator console and the corresponding password.
LOGGING= The name of the log file.
User ID entry is possible here. If the User ID is not entered, however, the log file
is written to the User ID under which the job has been executed.
The number signs serve as place holders for a series in numerical order. When
LOGCOUNT= The number of stored log files
LANGUAGE= The language in which the logging is executed. Entries for primary and secondary
language.
If there is no message in the primary language, a search is made for a message in

the secondary language.
(TRACE)
FILE= The name of the trace file.
User ID entry is possible here. If the User ID is not entered, however, the trace
file is written to the User ID under which the job has been executed.
The number signs serve as place holders for a series in numerical order. When
starting a trace, the trace files will be renamed so that the most current trace file is
TRCCOUNT= The number of stored trace files.
TCP/IP= Trace flag for agent TCP/IP communication

Default: "0"
Trace flags must only be used in close cooperation with support and development
staff.
(GLOBAL)
SYSTEM=AE
NAME=EVENTCON
WAITTIME=4
POOLSIZE=4
UCON=(CON?,???)
LOGGING=L.LOGG.UCXEB24U.##
LOGCOUNT=5
LANGUAGE=(E,D)
(TRACE)
FILE=L.TRACE.UCXEB24U.##
TRCCOUNT=5
TCP/IP=0
See also:
Notes for Adjusting Configuration Files
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.
which must be adjusted to your system environment at any case are written in red letters.
Structure of the INI File UCYBSMGR.INI
[GLOBAL]
language= Language in which logging is carried out. Entries for primary and secondary
language.

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.
When starting the ServiceManager, the log files are renamed so that the most
helplib= Path and name of the message file.
Allowed values: "ALL", "NONE", "CONTROLS"

Default: "ALL"

"CONTROLS" = All language-dependant strings which are necessary for the
display of the dialog program are held in the RAM (not relevant for the
ServiceManager).
port= Port number of the ServiceManager.
restart_limit= Maximum number of automatic start attempts which are processed for a
server process within a particular time span.
When the ServiceManager runs on UNIX, an automatic restart takes place for
all specified programs (server processes, agents) that end with SIGABRT.
The limitation to server processes does not apply in this case.
Format: (<period in seconds>, <number of start attempts>)
If the second of these two values is "0", no restart will be attempted.
The ServiceManager attempts to restart the server process which has

been ended after the occurrence of an invalid message. This parameter
specifies the maximum number of attempts within a time span.
restart_delay= This parameter introduces an additional delay for the restart time defined in
restart_limit= The delay defined here will take effect as soon as the
process's actually scheduled execution time has been reached.
Format: Delay in seconds.
Allowed values: >0
Default value: 60
password= Encrypted password of the ServiceManager dialog program
This parameter stores the password you determine via the ServiceManager
dialog program's interface in encrypted form.
reuseaddr= If you set this parameter to "1" the ServiceManager on restart can reuse a port
it previously had connected to. Thus restarting the ServiceManager will be
faster.
Allowed values: "1"
Default value: "0"

[TRACE]
When starting a trace, the trace files will be renamed so that the most current
trace file is always the one with the number "00".
cmd= Trace-flag commands.

Default value: "0"
[Destination Phrase] Section for definition of a ServiceManager environment.
Default value: "UC4"

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= Name of the file which contains commands for the ServiceManager.
This file is automatically applied by the ServiceManager during initial startup

and also updated later on. This file is not to be edited manually!
"*OWN" must be used here as a path specification as well.
Example of an INI File (Windows)
[GLOBAL]
language=(D,E)
logging=*OWN\..\temp\SMgr_LOGG_##.txt
helplib=*OWN\uc.msl
helpcache=all
port=8871
restart_limit=(60,3)
password=-106E1B857FA6B1280E
[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
Setting Up an SMD File

Note that modifications that have been made in the ServiceManager dialog program are automatically
adjusted in this file. No manual adjustment is required.
The definition file (UC4.SMD by default) contains all start parameters for AE services. For each service
there is a line that starts with the keyword DEFINE. The individual start parameters are separated by
semicolons, and comment lines start with an exclamation mark.
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 Path and file name of the AE program that should start.
You can use absolute or relative path specifications. "*OWN" means that the
program must be listed in the directory of the calling ServiceManager.
Agents for SAP, JMX, databases and Rapid Automation require a Java
call.
For example: java -jar ucxjr3x.jar
Java agents: Also specify the Java path because the ServiceManager
under UNIX does not read all environment variables.
Example: /usr/java/latest/bin/java -jar ucxjsqlx.jar
Insert a blank between the parameters component and INI file.
INI file File name of the INI file that should be used.
You can also specify an absolute or relative path (relative refers to the
program that should be started).
Working directory Working directory for the program that should start.
If the program to be started is a Java-based agent (SAP, Databases,

JMX, Rapid Automation), the working directory must be the path to the
JAR file.
-svc%port% Additional display option for server processes.
With this start parameter being specified, the ServiceManager dialog program
displays the name of the server process and the number of connections in
addition to the name of the service.
LOGON= Login data for the AE program.
This parameter only applies for the ServiceManager on Windows.

Start1= Several start methods for a server process (WP).

Start2=
Syntax:
etc.
START1=(name,command)
Name = The name of the start mode that you can define using the
ServiceManager start parameter -sm.
Command = The complete start command of a WP (path and file name)
including the start mode parameter(-parm).
To start the WP with a specific mode, you must append the following
parameter:
-parm"StartMode=value;SystemStop=value"
The allowed values for StartMode= are "NORMAL" (regular start) and
"COLD" (cold start).
The allowed values for SystemStop= are "NORMAL" (the client status
remains the same) and "YES" (all clients are stopped).
For example:
The following is an extraxt of an SMD file that includes the definition of a
service that you can use to start a WP with a different start mode.
VAR SRV_STARTPATH;*OWN\..\..\Server\bin
VAR WP_STARTCMD;*SRV_STARTPATH\UCsrvwp.exe *SRV_
STARTPATH\ucsrv.ini -svc%port%
VAR WP_STARTCMD_COLD;*WP_STARTCMD -parm"StartMode=Cold"
VAR WP_STARTCMD_STOP;*WP_STARTCMD -parm"SystemStop=Yes"
VAR WP_STARTCMD_COLDSTOP;*WP_STARTCMD -
parm"StartMode=Cold;SystemStop=Yes"
DEFINE UC4 WP2;*WP_STARTCMD;*SRV_STARTPATH;START1=

(Coldstart,*WP_STARTCMD_COLD);START2=(Systemstop,*WP_
STARTCMD_STOP);START3=(Coldstart with Systemstop,*WP_
STARTCMD_COLDSTOP)
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 DEFINE line, you can insert a variable by specifying a "*" followed by the variable name.
Example of an SMD File
! Variables
VAR SRV_PATH;*OWN\..\..\Server\bin\
VAR CP_STARTCMD;*OWN\..\..\Server\bin\UCsrvcp.exe
*OWN\..\..\Server\bin\ucsrv.ini -svc%port%
VAR WP_STARTCMD;*OWN\..\..\Server\bin\UCsrvwp.exe
*OWN\..\..\Server\bin\ucsrv.ini -svc%port%
VAR WP_START1;*WP_STARTCMD -parm"StartMode=COLD"
VAR WP_START2;*WP_STARTCMD -parm"SystemStop=YES"
VAR WP_START3;*WP_STARTCMD -parm"StartMode=COLD;SystemStop=YES"
! 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\
DEFINE UC4MAIL;C:\AUTOMIC\Agents\win\bin\UCXJWI3.exe UC4MAIL.ini;C:\AUTOMIC
\Agents\win\bin;LOGON=(uc4mail,-
10D888EA16FE7D2C0FE,)
! SAP agent
DEFINE SAP01;java -jar -Xrs -Xmx256M ucxjr3x.jar;*OWN\..\..\Agents\SAP\bin
Setting Up an SMC File

The following document describes the ServiceManager's SMC file structure.
Note that the file is automatically adjusted if you make modifications in the ServiceManager Dialog
Program. Manual interference is not necessary.
The SMC file contains a list of AE services. Each service is displayed in two lines. The first line describes
the number of seconds to be waited until the corresponding service starts. The second line contains the
name of the service.
Syntax
WAIT Time delay for start in seconds

CREATE Name of the AE service
Example of an SMC File
WAIT 10
CREATE UC4 CP1
WAIT 0
CREATE UC4 WP1
WAIT 20
CREATE WIN01
WAIT 20
CREATE UC4MAIL
WAIT 20
CREATE UC4 SAP Agent
ServiceManager - Dialog Program

Default values have been specified for the most parameters. They can be changed if required.
Parameters that must be adjusted to your system environment at any case are written in red letters.
Structure of the INI File UCYBSMDI.INI
[GLOBAL]
size= Size of the dialog program
admin= Access to the properties of the services
"0" - Only the automatic start and delay in seconds can be set.
"1" - All properties of the services can be modified.
port= Port number through which a connection to the ServiceManager is
established
You can also enter a section which must not exceed 10 port numbers.
[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= Description of selectable hosts followed by two-figure numbers (Host01=...,
Host02=... etc.)
LastName= Name of the last selected host
LastDest= Description of the last selected ServiceManager environment
[GLOBAL]
size=20
admin=1
port=(8871,8880)
[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
(GLOBAL)
Engine.
HELPLIB= The name of the message file.
LANGUAGE= The language in which the logging is processed. Entries for primary and
secondary language.

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
QUEUE= The specification of a particular Queue object in which the CallAPI should be
executed.
This parameter overrides the setting API_QUEUEin the variable UC_

CLIENT_SETTINGS.
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= Login specifications: Client.
Login data from this section is used when no logon data is specified at
service-program call
USER= Login specifications: Name of the user.
DEPT= Login specifications: Department of the user.
PASS= Login specifications: Password (optional).
(CP_LIST) The address of the communication processes in the AE system.
Allowed formats:
Port number=DNS Name
Port number=TCP/IP Address
(GLOBAL)
SYSTEM=UC4
HELPLIB=$UC4.UCX.MSL
LANGUAGE=(E,D)
TIMEOUT=60
;QUEUE=
trace=1
(USER)
CLIENT=
USER=
DEPT=
PASS=
(CP_LIST)
2217=uc4srv01
; 2218=uc4srv02
See also:
Utility for GCOS8
Structure of the INI File UCXBGC8CI
[GLOBAL]
Engine.
language= The language in which the logging is executed. Entries for primary and
secondary language.
Allowed values: "E", "D"


searched for.
logging= Thename of the log file.
[USER]
client= Login specifications: Client.
Login data from this section is used when no login data is specified at service-
program call
user= Login specifications: Name of the user.
dept= Login specifications: Department of the user.
pass= Login specifications: Password (optional).
[CP_LIST] The address of the communication processes in the AE system.
Allowed formats:
[GLOBAL]
system=UC4
logcount=4
logging=uc4/callapi/tmp/LOG##
language=(E,D)
helplib=uc4/callapi/data/UCMSL
[USER]
client=
user=
dept=
pass=
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
Utility for Java
Structure of the INI File UCXBXXXC.INI
[GLOBAL]
Engine.
secondary language.


searched for.
timeout= The time in seconds during which the CallAPI waits for a response from AE. If
Default value: 60
[USER]
program call
Allowed formats:
Example INI File
[GLOBAL]
system=UC4
language=(E,D)
timeout=60
[USER]
client=3
user=smith
dept=uc4
pass=
[CP_LIST]
2217=uc4srv01
See also:
Utility for NSK
Structure of the INI File UCXBNS1I
[GLOBAL]
Engine.
helplib= The name of the message file,
language= Language in which the logging is executed. Entries for primary and secondary
language.


searched for.
logging= The name of the log file.
Default value: 60
TRACE Trace designation.
Allowed values:

[USER]
program call
Allowed formats:
[GLOBAL]
system=UC4
helplib=UCMSL
language=E,D
logging=$data01.uc4.LOGA##
logcount=10
timeout=60
TRACE=1
[USER]
client=
user=
dept=
pass=
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:

Utility for z/OS
Structure of the INI File UCXBM25C.INI
(GLOBAL)
system= Name of the AE system
Engine.
helplib= Name of the message file
language= Language in which the logging is executed. Entries for primary and secondary
language.


searched for.
timeout= Time in seconds during which the CallAPI waits for a response from AE. If
Default value: 60
With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
codetable= Name of the CodeTable object that should be used by the CallAPI
The IBM standard code table is used if nothing is specified in this parameter.
queue= Specification of a particular Queue object in which the CallAPI should be
executed.

CLIENT_SETTINGS.
(USER)
client= Logon specifications: Client
Logon data from this section is used when no logon data is specified at
user= Logon specifications: Name of the user
dept= Logon specifications: Department of the user
pass= Logon specifications: Password (optional)
(CP_LIST) Address of the communication processes in the AE system
Allowed formats:
(GLOBAL)
system=UC4
language=(E,D)
timeout=60
;queue=
(USER)
client=
user=
dept=
pass=
(CP_LIST)
2217=uc4srv01
; 2218=uc4srv02
Activating Trace for z/OS CallAPI Utility
CallAPI trace for z/OS agents is set activated/deactivated on the command line.
Allowed values:
"N" (default) = Deactivate trace
"Y" = Activate trace
For example:
TRACE=Y
Once tracing has been activated with TRACE=Y, the CallAPI writes the trace to the location specified in
the TRACE DD card:
//TRACE DD SYSOUT=*
or
//TRACE DD DSN=datsetname,....
See also:
Utility for OS/400
Structure of the INI File
[GLOBAL]
Engine.
secondary language.


searched for.
logging= The OS/400 CallAPI writes output to JobLog instead of a log file and standard
out. Therefore, these parameters are ignored in the INI file for OS/400.
logcount=
Default value: 60
queue= The specification of a particular Queue object in which the CallAPI should be
executed.

CLIENT_SETTINGS.
TRACE Trace designation.
Allowed values:

[USER]
Login data from this section is used when no logon data is specified at
user= Login specifications: The name of the user.
dept= Login specifications: The department of the user.
[CP_LIST] or [CPLIST] The address of the communication processes in the AE system.
Allowed formats:
[GLOBAL]
system=UC4
helplib=UC4/MSL
language=E,D
timeout=60
;queue=
TRACE=1
[USER]
client=
user=
dept=
pass=
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
Utility for UNIX
Structure of the INI File UCXBXXXC.ini
[GLOBAL]
Engine.
language= The language in which the logging is executed. Entries for primary and
secondary language.


searched for.
The characters xxx in the file name are place holders. They stand for the
three-digit abbreviation of the respective UNIX version. See: Terminology.
Default value: 60
executed.

CLIENT_SETTINGS.
Allowed values:

[USER]
program call
Allowed formats:
[GLOBAL]
system=UC4
helplib=ucx.msl
language=E,D
logging = ../temp/UCXCxxx.l##
logcount = 10
timeout=60
;queue=
trace=1
[USER]
client=
user=
dept=
pass=
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
Utility for VMS
Structure of the INI File UCXBVXXC.INI
[GLOBAL]
Engine.
secondary language.


searched for.
The characters xx in the file names are place holders. They stand for the two-
digit abbreviation of the respective VMS version. See: Terminology.
Default value: 60
executed.

CLIENT_SETTINGS.
Allowed values:

[USER]
program call
Allowed formats:
[GLOBAL]
system=UC4
helplib=ucx.msl
language=E,D
logging = [-.temp]UCXCVxx.l##
logcount = 6
timeout=60
;queue=
trace=1
[USER]
client=
user=
dept=
pass=
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
Utility for VSE
Structure of the INI File UCXBVSE.INI
(GLOBAL)
This entry must be identical to the entry in the INI file of theAutomation
Engine
secondary language.


searched for.
Default value: 60
Allowed values:

(USER)
client= Login specifications: Client
program call
user= Login specifications: The name of the user.
dept= Login specifications: The department of the user.
pass= Login specifications: Password (optional)
(CP_LIST) The address of the communication processes in the AE system
Allowed formats:
(GLOBAL)
system=UC4
helplib=DD:PRD2.UC4(UCX.MSL)
language=(E,D)
timeout=60
trace=1
(USER)
client=
user=
dept=
pass=
(CP_LIST)
2217=uc4srv01
; 2218=uc4srv02
See also:

Utility for Windows
Structure of the INI File UCXBXXXC.INI
(GLOBAL)
Engine.
secondary language.


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
executed.

CLIENT_SETTINGS.
(USER)
program call
(TRACE)
you start a trace, the trace files will be renamed so that the most current trace
file is always the one with the number "00"
(CP_LIST) The address of the communication processes in the AE system.
Allowed formats:
Example INI File
[GLOBAL]
system=UC4
helplib=uc.msl
language=(E,D)
timeout=60
;queue=
[USER]
client=
user=
dept=
pass=
[TRACE]
file=.\trace##.txt
trccount=20
[CP_LIST]
2217=uc4srv01
; 2218=uc4srv02
See also:
RFC Server
Default values have been specified for the most parameters. They can be changed if needed.
Structure of the INI File UCXSAPC.INI
[GLOBAL]
system= AE system.
Engine.
secondary language.


searched for.
Helplib= The name of the message file.
CHANGE_LOGGING_ The number of days, after which the log file should be changed.
DAYS=
Default value: 365
CHANGE_LOGGING_ The size in MB, when the log file should be changed.
MB=
Default value: 100
The parameter "max_logging_kb" is used for log-file changes if this parameter

is not specified.

log_to_file= This refers to the creation of log files.
"0" = No log files are created

"1" = Log files are created
Logging contents are always sent to the Automation Engine regardless of

the specifications made here. These contents are available in the System
Overview.
TimeOut= The time in seconds during which the CallAPI waits for a response from AE. If
Default value: 60
[USER]
client= Login specifications: Client
program call
user= Login specifications: Name of the user
dept= Login specifications: Department of the user
pass= Login specifications: Password (optional)
The password can be encrypted using the programUCYBCRYP.

[RFC]
hostname= These parameters are required for the RFC Server connection.
PROGID=
hostname: Name of the computer on which the SAP Gateway runs.
GWSERV=
PROGID: Program ID. Any ID of your choice is possible.
GWSERV: Gateway Service Number (e.g.: sapgw00).
This data must comply with the RFC destination data in transaktion SM59 on
the SAP system. Example: If you selected "SAP_TEST" in the created
destination in SM59, this ID must also be specified in the INI file.
RFC_TRACE= Creates an RFC Trace
"0" = RFC Trace is created.
"1" = No RFC Trace is created.

unicode= Use of "Unicode"- coding in the SAP system.
"0" = Unicode is not used in the SAP system.
"1" = The SAP system to which a connection is established is a Unicode

system.
This information can also be retrieved via the SAP system's RFC
connection. In this case, the INI-file parameter must only be specified if
there is no RFC connection parameter.
[CP_LIST] A list of communication processes.
Format:
Port number= DNS name
Port number= TCP/IP Address
[TRACE]
you start a trace, the trace files will be renamed so that the most current trace
file is always the one with the number "00"
xml= Creates an XML Trace
"0" = No XML Trace is created.
"1" = XML Trace is created.

[GLOBAL]
helplib=c:\AUTOMIC\bin\uc.msl
;logging=C:\AUTOMIC\CallAPI\SAP\temp\ucxsapc_logg##.txt
logcount=10
;helpcache=ALL
TimeOut=60
system=UC4
language=(E,D)
CHANGE_LOGGING_MB=100
CHANGE_LOGGING_DAYS=1
log_to_file=0
max_logging_kb=1000
[USER]
client=1
user=test
dept=dept
pass=pw
[RFC]
hostname=sap01
PROGID=TEST
GWSERV=sapgw00
RFC_TRACE=1
unicode=1
[CP_LIST]
2217=fsu
[TRACE]
file=../temp/sapc_trace##.txt
trccount=10
xml=0
See also:
Connect for WebSphere MQ Queue Manager (Windows)

Default values have been specified for the most parameters. They can be changed if required.
Structure of the INI File UCXBMQCX.INI
[GLOBAL]
system= Name of the AE system. *
Engine.
language= Language in which the logging is executed. Entries for primary and
secondary language.

If there is no message in the primary language, a message in the secondary

language is searched for.
When starting the AE Connector, the log files are renamed so that the most
helpcache= Availability of the messages and language-dependent strings.
Allowed values: "ALL", "NONE", "CONTROLS"

Default: "ALL"
"CONTROLS" = All language-dependant strings which are necessary for
the display of the dialog program are held in the RAM (not relevant for the
AE Connector).
loglevel= Level of message output in the log file.

Default: "1"
"0" = No messages in the log file. Furthermore, no log file will be created.
"1" = Normal log file.
"2" = Detailed log file. All available log information is displayed.
MaxJobs= Maximal number of requests which can be run simultaneously.
Allowed values: n
Default: "10"
n = Number of requests run parallel.
ExecTimeOut= Boundary of maximum runtime in seconds for processing a script through
the Automation Engine. If runtime is exceeded, a timeout error is sent to the
reply queue.
Allowed values: n
Default: "300"
n = Maximum runtime in seconds.
[TCP/IP]
CP= Connection specifications: Name or TCP/IP address of the computer and
port number of the listener on which the Automation Engine is running.
connect= Time interval in seconds in which the AE Connector attempts to establish
connection to the Automation Engines. Effects the connection setup for a
[TRACE]
When starting a trace, the trace files will be renamed so that the most
trclevel= Amount of messages output in the trace file.

Default: "1"
"0" = No messages in the trace file. Furthermore, no trace file will be
created.
"1" = Normal trace file.
"2" = Detailed trace file. All available trace information is displayed.
[MQSERIES]
ConnName= Connection name and port number of the WebSphere MQ Queue Manager
Server. The contents are equivalent to setup values when the MQSC
DEFINE CHANNEL command is used.
Allowed values: <mqsrv>:<port>

Default: The client connection table or contents of "MQSERVER"
environment variable.
<mqsrv> = Connection name
<port> = Port number of the connection
SvrconnChannelName= Server connection name of WebSphere MQ Queue Manager. The
parameter is only analyzed when the ConnName= Parameter is also used.
Allowed values: <srvchannel>

Default: "SYSTEM.DEF.SVRCONN"
<srvchannel> = Server connection name
QMgrName= Name of the queue manager.
Allowed values: <mqmanager>

Default: ""
<mqmanager> = Name of the queue manager
QueueName= Name of the request queue (SIQ).
Allowed values: <siq>

Default: "UC4CInputQueue"
<siq> = Name of the request queue
UseLibrary= Type of connection to MQSeries
Allowed values: "C" (default) and "S"
"C" - Client
"S" - Server
[GLOBAL]
system=UC4
language=(D,E)
logging=..\temp\UCXBMQCS_log##.txt
Helplib=uc.msl
HELPCache=ALL
logcount=3
loglevel=2
MaxJobs=10
ExecTimeOut=300
[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:
3.1.8 EMI - External Monitoring Interface

External Monitoring Interface Configuration
Structure of the File emi.ini
[GLOBAL]
client= Client number which is monitored.
user= User name of the monitoring user, i.e., the user whose context the
monitoring will run under.
password= User's password.
Can also be provided encrypted. To encrypt passwords use

ucybcryp.exe.
language= Language, which will be used for message translations.
Value: D, E or F
In version 11.2 the messages are available in English only, regardless of

the values defined here. Other languages will be available in future
versions.
Allowed formats:
reconnect= Reconnect interval.
When a connection to the AE cannot be established, the EMI will retry in
periodic intervals defined by this parameter.
Unit: seconds
Format: integer
The number characters serve as placeholders for a series in numerical

order.
When starting the EMI, the log files are renamed so that the most current
log file is always the one with the number "00".
[COLLECTIONS] This section contains poll intervals for specific monitoring areas. The
intervals are defined in seconds.
Format: integer
Example: 5 means, the status of all agents in EMI is refreshed every 5

seconds.
agents= Polling interval for the Agents section in SystemOverview.
Default: 15
cache= Polling interval for Cache section in the System Overview.
Default: 10
client= Polling interval for Clients section in System Overview.
Default: 60
database= Polling interval for Database section in System Overview and MQs.
Default: 10
licenses= Polling interval for Licenses section in System Overview.
Default: 60
queues= Polling interval for Queues section in System Overview.
Default: 5
servers= Polling interval for Automation Engine servers section in System Overview.
Default: 5
tasks= Polling interval for activities. If set to 0, activities are not monitored. If
greater 0, the TASKS section is used to filter activities.
Default: 0
usage= Polling interval for system Usage section in System Overview.
Default: 1500
users= Polling interval for Users section in System Overview.
60
[TASKS] Filter criteria for activities to be monitored.
Polling of activities can be turned on or off with the parameter tasks= in

the section [COLLECTIONS]
state= Comma separated list of ranges of states in the format [from-to[,from-to
[...]]].
Default: 1560-1564,1800-1899
object= Sets the filter for the object name. With the default entry "*", all objects are
listed. Use the wild card characters "*" and "?" to set a filter. "*" stands for
any number of characters, "?" for exactly one character.
Default: *
type= Comma separated list of object types. The "*" is not allowed. E.g.,
JOBS,JOBP,SCRI
Default: JOBP
user= Sets the filter for the user name. The wildcard character "*" matches all
users
Default: *
queue= Sets a filter for a Queue. Has no effect in client zero.
Default: All Queues

[TRACE] In version 11.2 the following four parameters are not yet considered, as
the EMI creates a log file only.
Traces will be available in future versions.
Default: ./temp/trace_##.log
Default: 10
tcp/ip= Trace flags of the EMI
emi= Trace options for EMI processing
Default: "0"
[JMX] This section contains basic settings relevant for the MBeanServer.
usePlatformBeanServer= Indicates, whether the MBeanServer is visible for local connections.
Allowed values: "1" or "0" (or "Y" or "N")
Default: "1"
jxmPort= TCP-port for RMI connection
You may reach the MBeanServer on this default address:
service:jmx:rmi:///jndi/rmi://hostname:jmxPort/Automic
Default port value (jmxPort): 9091
[CP_LIST] This section is maintained automatically by the EMI. The list of known
CPs is stored here.
Comments
The user needs these privileges in the respective User object to be able to access the monitoring
functions of the EMI:
l Always required: "Access system overview"

l For monitoring the MessageBox alias for receiving the Notifications it is necessary to grant one or
more or all of the following privileges:
l "View messages from own User Group"
l "View messages from Administrators"
l "View all messages from own client"
l "View security messages"
l For monitoring the System Workload (WorkloadBean) the privilege "View usage of all clients" has
to be granted.
See also:
EMI - External Monitoring Interface
3.2 Settings in Variables
3.2.1 Settings in Variables

Ready-to-use variables are provided in system client 0000 which can be used to define various settings in
your AE system. Please refer to the overview in the table shown below. It provides information about
possible uses and also if the particular variable can be used in other clients. The general rule is: if the
variable is not available in its own client, the one of the system client is used.
If a variable can be used in a user-defined client, you can transfer it to other clients by using one of the
methods that are described below:
1. Open two connections in the UserInterface: One to the system client, and the other one to the client
to which the variable should be transported. You can do so by dragging and dropping from the
system client 0000 to the Explorer window of the other client.
2. Use the Export/Import function in the UserInterface.
3. Use the Transport Casefor the transfer.
Now you can adjust your entries.
Note that for transferring AE variable objects to other clients, you must make sure that the Access
option is not set to Read only in the Attributes tab.
The other options allow transfers to take place: Referenceable means that copies of the AE variable
always refer to the object in client 0000. This includes that any change in the copied variable will
always affect the AE variable in the system client.
The option Not shareable stores a separate copy to the user-defined client.
Changes made in the settings of a variable can take effect immediately or require the UserInterface, agent
or server to be restarted. Refer to the list below which describes the variables to get more detailed
information.
Variable For To be changed by Client

UC_AGENT_ Host Assignment Changes automatically 0000
ASSIGNMENT when the System Overview
area "Host Assignment" is
used
UC_AS_SETTINGS Advanced Security administrator, AE 0000
DB Load
UC_AUTO_FORECAST Auto forecast data AutoForecast (changes xxxx
automatically changed
when AutoForecast is used)
UC_CALENDAR_ Calendar periods administrator xxxx
PERIOD or
0000
UC_CLIENT_SETTINGS Various client settings administrator xxxx
UC_CUSTOM_ Grouping criteria for tasks in the administrator xxxx

ATTRIBUTES Activity Window or
0000
UC_EX_ERP_CONNECT Connections to Enterprise administrator 0000
Business Solutions
UC_EX_HOSTCHAR Assigning agents to host administrator 0000
characteristics
UC_EXT_ Registering external interpreters for administrator 0000
INTERPRETERS_ use with Job object (JOBS) and
WINDOWS and UC_EXT_ Storage object (Windows and
INTERPRETERS_UNIX UNIX)
UC_HOSTCHAR_ Host characteristics administrator 0000
DEFAULT
UC_ILM_CONTAINER_* Partitions in the AE database administrator, AE 0000
DB Load
UC_ILM_SETTINGS Settings - Partitioning with ILM administrator, AE 0000
DB Load
UC_JOB_ Periodical time check in the administrator 0000
CHECKINTERVAL Automation Engine
UC_KDC_SETTINGS Single Sign-on administrator 0000
UC_LDAP_EXAMPLE LDAP connection administrator xxxx

or
0000
UC_LOGIN_TYPES Additional types for Login objects administrator 0000
UC_OBJECT_COUNTER Counter reading is part of the administrator xxxx

object name or
0000
UC_OBJECT_DOCU Documentation of objects administrator xxxx
or
0000
UC_OBJECT_TEMPLATE Object types and their templates administrator xxxx
or
0000
UC_REPORT_ StyleSheets for XML reports administrator xxxx
STYLESHEETS or
0000
UC_SENDTO Internal/external handling of administrator xxxx
UC_SENDTO_ACT objects and tasks or
0000
UC_STATISTIC_ Controls the statistics administrator xxxx
OPTIONS or
0000
UC_SYSTEM_SETTINGS System-wide settings administrator 0000
UC_USER_LOGON Single Logon (automatic logon) administrator 0000
UC_SAP_XJBP_ Event types of the Java Scheduler This variable is supplied in 0000
EVENTTYPES in SAP the system client and
should not be changed
manually.
UC_UTILITY_ARCHIVE Specifications for archiving runs This variable is maintained xxxx
by AE DB Archive and must or
not be changed. 0000
UC_UTILITY_DB_ Executed reorganization runs This variable is maintained 0000
UNLOAD by AE DB Unload and must
not be changed.
UC_UTILITY_REORG Specifications for reorganization This variable is maintained xxxx
runs by AE DB Reorg and must or
not be changed. 0000
UC_SNMP_VALUES SNMP values This variable is maintained 0000
by the Automation Engine
and must not be changed.
UC_USER_HOST Host name for the UserInterface Automatically with login xxxx
or
0000
UC_USER_LANGUAGE Language character for the Automatically with login xxxx
UserInterface or
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.
3.2.2 UC_AGENT_ASSIGNMENT - Agent Assignment

This variable contains the active Agent/Client Assignment objects.
Key Value Restart required

Running number that begins with "0" Name of the Agent/Client Assignment object No
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
3.2.3 UC_AS_SETTINGS - Advanced Security

This variable can be used to specify particular encryption and authentication methods.
Key Value Restart

required
AUTHENTICATION Authentication method Server
Allowed values: "NO" (default), "LOCAL" and "LOCAL_REMOTE"
"NO" - None
"LOCAL" - Server
"LOCAL_REMOTE" - Server and agent
Note that additional work steps are required for changing the
authentication method. Refer to the chapter Encryption for more
details.
COMPATIBILITY Compatibility with components of former versions Server
Allowed values: "YES" (default) and "NO"
"YES" - components of versions older than 8.00A can log on to the

AE system.
"NO" - Logon attempts of older components are rejected.
ENCRYPTION Encryption method Server
Allowed values: "NO", "AES-128", "AES-192" and "AES-256"

(default)
"NO" - No encryption method

"AES-128" - 128-bit key length
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
3.2.4 UC_AUTO_FORECAST - Auto Forecast Data

This variable contains the results of the Auto Forecast calculation.
Key Value New start

required
16-digit number with Task in the format: No
leading zeros
Object name,RunID
CREATED Date and time of the last Auto Forecast calculation in the No
format:
YYYY-MM-DDTHH:MM:SS
END End of the period of time which served as the basis for No
data calculation.
YYYY-MM-DDTHH:MM:SS
START Beginning of the period which served as the basis for No
data calculation.
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.
See also:
Overview of all variables in table form

Variable
Auto Forecast
3.2.5 UC_CALENDAR_PERIOD - Calendar Periods

The specific periods of the calendar are defined in the variable that has the same name as the view in
which it can be located.
Key Value New start required

Period name/Year Start date in the format: 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:

Variable
Calendar
3.2.6 UC_CLIENT_SETTINGS - Various Client Settings
Some settings that are stored in the 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 Description

required
ALIAS_ The indication of No The alias name of workflow tasks which

SPECIAL_ specific characters can be set in the properties ( General tab)
CHARACTERS that are allowed to be is limited to specific characters. To allow
used in the alias characters in the alias names that are
names of workflow usually not available (such as "-"), you
tasks. can make use of this setting.
Default value: -# All the characters that should be allowed

must be entered in a row, blanks will be
Blanks are ignored.
ignored. The order of the individual
characters is irrelevant.
For example: To allow the characters "-",

":" and "+", you must specify the value in
the format -:+.
API_QUEUE The Queue object that No In the Automation Engine, all tasks start
is used to execute in a object. This also includes the
CallAPI scripts. execution of CallAPI scripts. By default,
the Client Queue (CLIENT_QUEUE) is
Default value:
used for CallAPIs. This key can be used
"CLIENT_QUEUE"
to specify a particular Queue object.
ARA_WS_INT Full URL (including No Full URL of an Application Release
protocol and port) of an Automation(ARA) instance that contains
Application Release both port and protocol (such as https). For
Automation instance. example:
http://devhost01.test.spoc.global:80/AR
A
This setting is required if ARA workflows
should be started via the Automation
Engine.
AUTO_ The number of days No The creates forecast data for activities
FORECAST_ that are included in the that run in Schedule objects and Event
DAYS AutoForecast objects. Depending on the active
calculation. Schedule and Event objects in the client,
a forecast will be created for these
Default value: "1"
objects for a previously defined number of
days.
AUTO_ The beginning of the No The creates forecast data for activities
FORECAST_ names of forecasts that run in Schedule objects and Event
PREFIX that are created by the objects. A prefix needs to be defined for
AutoForecast. 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_ The maximum number No The maximum number of days that is

AHEAD_MAX of days that is considered when you calculate the next
considered for valid date using the script element C
calculating the next ALE_LOOK_AHEAD can be specified in
valid date based on this variable on a client-wide basis. The
calendar conditions. default value is "14". Keep this value low
if you specify individual values in order to
Allowed values: "0 -
avoid performance losses.
9999"
Default value: "14"
CALE_WARN_ The notification that is Server When the Automation Engine starts and
NOTIFICATION activated if the when a new day begins, the validity dates
advance expiration of all calendars are checked whether they
warning occurs. 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
CALE_WARN_ The number of days Server script using the READ buffer as shown
LEVEL prior to a calendar's below:
expiration date that
triggers an advance :READ &UC_CAUSE_NAME,,
warning. No alert is sent for Calendar objects of
the system client 0000 because you
cannot activate objects in this client.
CLIENT_ The priority of the No You can specify a priority of AE's internal
PRIORITY client. processing for each client. This includes
that you can reduce the priority of a non-
Allowed values: "200"
productive client compared to a
- "255"
productive client. The default setting is
200
CLIENT_ "GO" - Automatic UserInterface You can stop automatic processing and
STATUS processing is active. release it within a client. To change the
"STOP" - Automatic system status, the user requires the
processing is stopped. relevant privilege in order to do so. Only
the system itself can write to the variable.
DEACT_FAULT_ Allowed values: "Y" or No "N[o]": The jobs with status FAULT_
OTHER "N" (default) OTHER shall be kept in the Activity
Window.
If the status FAULT_OTHER in the

UserInterface is selected in the
dropdown box of the job, this means,
the radio-button 'After error-free
execution' is also selected. Therefore
the job will be removed from the
Activity Window, even if the value is
set to "N".
"Y[es]": Remove jobs with status

FAULT_OTHER from Activity Window.
DEACTIVATIO Allowed values: No Deactivation time in minutes

N_DELAY_TIME Integers only. (This value corresponds with the one in
the "Time delay" field in the Attributes tab
Valid value range:
of the respective objects.)
[0,999999]
If the following applies, no client-wide
delay time will be considered:
l Key is not set or

l key has no value or
l key has no valid value.
For certain executable objects,

deactivation options can be set in two
ways: By using this key or setting the
corresponding value in the
UserInterface field of the relevant
object. This applies to Workflow,
Event (Console, Time, Database,
File, Time), Notification (Alarm, Mail,
Standard), Group, Script, Job and
FileTransfer. Please refer to the
respective object's parameter
descriptions for detailed information.
DEPLOYMENT_ This activates the UserInterface If the client should be used for the
CLIENT client's deployment Release Manager, you can use this
functionality. setting in order to activate its deployment
functions.
Allowed values: "Y"
and "N" (default value) Note that you cannot use the system
client 0000 as a deployment client.
"Y" - This activates the
deployment When you activate this setting (Y), the
functionalities. Deployment tab becomes available in
"N" - This deactivates workflows and the General tab, which is
the deployment available in the properties of workflow
functionalities. tasks, includes the option "Run per
Patch" .
EH_KICK_ The refresh interval No If the properties of a task have changed
INTERVAL that can be specified (for example, start, status, end), the
for the task view in the UserInterface receives a message from
Activity Window and the Server and the Activity Window and
monitors. monitor view can be refreshed. You can
specify the interval in which messages
Default value: 3
should be sent to the UserInterface in this
seconds
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_ADAPTIVE Activation/deactivatio No Settings for the adaptive calculation of the

n of adaptive ERT expected runtime (ERT).
calculation for the
The adaptive calculation can be
entire client.
activated/deactivated for the entire client
Permitted values: "Y" using the ERT_ADAPTIVE setting. If the
(default value) or "N" adaptive calculation is deactivated, the
tasks that the dynamic ERT method
"Y" - Adaptive ERT
"Adaptive" was defined for ( "Runtime"
calculation is active.
tab) use the alternative method (ERT_
"N" - Deactivation of
ADAPTIVE_FALLBACK_METHOD).
adaptive ERT
calculation. The setting ERT_ADAPTIVE_
FALLBACK_METHOD defines the
ERT_ Information which No
alternative ERT method to be used if
ADAPTIVE_ should be taken into
either the JWP is not available (Java-
DEFAULT_ account in the
based work process, takes over the
CONTEXT adaptive ERT
adaptive ERT calculation), or if the overall
calculation.
calculation has been deactivated (ERT_
You can also specify ADAPTIVE="N").
object attributes; these
With ERT_ADAPTIVE_DEFAULT_
must be separated by
CONTEXT, you can define factors to be
semicolons (;) .
taken into account in the adaptive ERT
Default calculation. You can also specify any
value: "PARENT_ object attributes; these must be
ALIAS;HOST;FT_ separated by semicolons. The following
DST_HOST;FT_ factors are taken into account by default:
SRC_HOST;START_
l Parent Alias
TIME"
l Parent Name
ERT_ Alternative method for No l Agent (for file transfers: target
ADAPTIVE_ calculating the ERT if and source agent)
FALLBACK_ adaptive calculation is l Start time
METHOD not possible.
Permitted values:
"FIXED,"
"MAXIMUM,"
"AVERAGE,"
"LINEAR_
REGRESSION"
(default value)
"FIXED" - Static
predefined value
"AVERAGE" -
Dynamically
determined average
"LINEAR_
REGRESSION" -
Dynamically based
linear regression
"MAXIMUM" -
Dynamically longest
actual runtime.
ERT_METHOD The method to No By deactivating the estimated runtime

evaluate the estimated (ERT) calculation, you can improve the
runtime (ERT). performance of the Automation Engine. If
it is deactivated (ERT_
Allowed values:
CALCULATION/BATCH), you can
FIXED, MAXIMUM,
determine it subsequently for all objects in
AVERAGE, LINEAR_
the database. Use the utility AE DB Load
REGRESSION
in order to load the file UC_UPD_
"FIXED" - Static ESTIMATE_ERT.TXT. The duration for
predefined value. calculating the expected runtime depends
"AVERAGE" - on the number of objects that is involved.
Dynamically
The file UC_UPD_ESTIMATE_
determined average.
ERT.TXT contains a line at its end
"LINEAR_
that calls the ERT calculation
REGRESSION" -
function. If you specify a client, ERT
Dynamically based
calculation takes place in this client,
linear regression.
otherwise the whole system is
"MAXIMUM" -
included in the calculation.
Dynamically longest
actual runtime. For example:
"ADAPTIVE" -
ESTIMATE_ERT 1000
Intelligent calculation
of the ERT taking into All other validity keys that start with
account various "ERT_" form the default values for
factors and runtime calculating the expected runtime (ERT).
parameters. You can adjust them in the Runtime tab
Default value: of each object if needed.
"LINEAR_
REGRESSION"
ERT_FRT The fixed value for the No

estimated runtime in
seconds.
Three-digit value,
default: "0"
ERT_CHECK_ The number of No
COUNT calculated runs.
Two-digit value
between "1" and "25",
default: "20"
ERT_CORR_ The positive correction No
PERCENT value in percent.
Three-digit value,
default: "0"
ERT_IGNORE_ The deviation in No
PERCENT percent.
Three-digit value,
default: "0"
ERT_MINIMUM_ The minimum number No
COUNT of runs that should be
counted for deviation.
Two-figure value
between "1" and
"ERT_CHECK_
COUNT", default
value: "0"
ERT_ The determination of No
CALCULATION the estimated runtime
(ERT) by the
Automation Engine.
Allowed value:
BATCH, IMMEDIATE
Default:
"IMMEDIATE"
"BATCH" =
Determination of the
estimated runtime
(ERT) is inactive
"IMMEDIATE" =
Determination of the
estimated runtime is
active
EXT_REPORTS Creates extended task No You can use this entry in order to specify
reports. whether extended reports should be
created in addition to standard reports,
Allowed values:
and which ones.
SCRIPT, JCL,
HOST_JCL,
OBJECT_ACCESS
separated by commas.
"SCRIPT" = Log of the
entire script.
"JCL" = Log of all job
attributes and the
generated JCL.
"HOST_JCL" = JCL is
taken from the target
host (platform-
specific).
"OBJECT_ACCESS"
= Log of access to
objects.
FIRST_DAY_OF_ The starting day of the No The key FIRST_WEEK_METHOD can
WEEK week. 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
Default value: "2"
used as the first calendar week. You can
"1" - Sunday also determine the starting day of a week
"2" - Monday using the entry FIRST_DAY_OF_WEEK
"3" - Tuesday (default: Monday).
"4" - Wednesday
Note that the definitions that are made
"5" - Thursday
for the first calendar week influence
"6" - Friday
the results of the script function
"7" - Saturday
WEEK_NR which retrieves the
FIRST_WEEK_ The definition of the CP and WP calendar week.
METHOD week that is regarded processes
the first calendar week
of a year.
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_ This is the setting for UserInterface The tasks of a workflow must be linked
INCOMPLETE saving workflows. with lines in order to have them executed
in the required order. You can define a
Allowed values: YES,
predecessor and a successor for each
NO or ASK (default)
task. You can set storage properties
"YES" - The workflow using the entry JOBP_SAVE_
will always be saved. INCOMPLETE if some lines are missing.
"NO" - The workflow In this case, you can specify that the
cannot be saved workflow should be stored (YES) or not
because there are still (NO), or that it should only be stored after
tasks that have no a request (ASK).
predecessors and/or
successors.
"ASK" - A query
displays and asks
whether the workflow
should be saved.
KDC_LOGIN_ Forces authentication The authentication via Kerberos is forced
FORCED via Kerberos for all users of a client at once.
Distribution Center. The advantage of this method is that User
(optional) objects have not to be changed one by
one.
Allowed values: "Y
[es]" or "N[o]" If this parameter is set to "N" or is not
set, the KDC_LOGIN_FORCED has
no effect.
MAX_USER_ The maximum number No For each client, you can specify the
INTERFACE of UserInterfaces that maximum number of UserInterfaces that
can be logged on at the can be connected to the AE system at the
same time. same time. If there is no entry, the
system uses the value that is defined in
Allowed values: "1" to
the license. You find this value in the
max. license count
"License" category ("DC" line) of the
System Overview.
NOW_MINUS The number of years No It is not required to specify a validity
that is considered in period if you create a calendar keyword.
dynamic calendar The days are automatically calculated on
calculation. the basis of the determined date
intervals. You can use these two keys to
Allowed values: "1" to
specify the number of years that should
"5"
be calculated to the past and to the future.
Default value: "1"
NOW_PLUS The number of years No
that is considered in
dynamic calendar
calculation.
Allowed values: "1"

to"10"
Default value: "6"
OBJECT_AUDIT The logging for the No This setting can be used to activate
revision report. object logging and store the results in
Revision Reports.
Allowed values: "Y"
and "N" (default value)
"Y" - Logging for the

revision report is
made.
"N" - There is no
logging.
PROMPT_ The time in minutes No These settings define the maximum
RESPONSETIM that the system waits waiting time for a task that includes
E for a task's PromptSet PromptSets. Depending on the particular
dialog to be confirmed. situation, the task aborts if this time is
The task aborts if this exceeded.
time is exceeded.
l PROMPT_RESPONSETIME
Default value: 0 (= Maximum time that the system
unlimited) 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_ The time in minutes No
TIMEOUT that the system waits l PROMPT_TIMEOUT
for a user to log on in If a PromptSet input mask cannot
order to display a be displayed because the
PromptSet dialog. particular user has not logged on,
The task aborts if this the corresponding task switches to
time is exceeded. the waiting condition "Waiting for
Default value: 0 (= user input". In this case, the
unlimited) 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 although the PromptSet dialog is
still open.
PWD_AGE_MAX The life span of the No Settings for user passwords:

user passwords in
PWD_AGE_MAX
days.
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_DEFAULT
This setting specifies the default
password for new users defined without a
password. You might want to use this
setting to specify a default password that
complies with your configured password
policy. If you specify a default password
here, you must let new users know what it
is so they can use it the first time they log
into this client. When a password is
specified here, users will use this
password when logging into the client for
the first time. They will then be prompted
to change their password. If nothing is
specified here, the default password for
new users defined without a password
will be "pass".
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 variable UC_
PWD_ The number of invalid No

ATTEMPTS_ login attempts.
MAX
PWD_ You can use this key No

CONTAINS_ to force the use of
LOWER_CASE lowercase letters in
user passwords.
Allowed values: "Y"


NUMBER numbers in user
passwords.
Allowed values: "Y"


SPECIAL_ special characters in
CHARACTER user passwords.
Allowed values: "Y"

UPPER_CASE uppercase letters in
user passwords.
Allowed values: "Y"

PWD_DEFAULT Specifies the default No
password for new
users defined without
a password.
PWD_FORBID_ You can use this key No
LOGIN to forbid user names in
user passwords.
Allowed values: "Y"

PWD_ The number of the last No
GENERATION n passwords that must
not be used again.
Allowed values: "1" -

"99"
Default value: "0"
"0" signals that the

password is not
checked against older
passwords
PWD_LENGTH_ The maximum length No
MAX of user passwords.

"32"
Default value: "32"
PWD_LENGTH_ The minimum length of No
MIN user passwords.

"32"
Default value: "0"
SEARCH_ The search for object No When deleting, renaming or manually

SCRIPT_FOR_ use in script. searching the use of an object, AE
USAGE checks if this object is used in other
Allowed values: "Y",
objects as well (for example, in Schedule
"L" and "N" (default
objects). If so, you can have a list of all
value)
these objects displayed. With the
"Y" - Search for specification of the key SEARCH_
objects used in scripts SCRIPT_FOR_USAGE and the values
(with regular "Y" and "L", objects that are used in
expressions). scripts (for example, ACTIVATE_UC_
"L" - Search for objects OBJECT) are included in the search.
used in scripts (normal There are different search types:
search without regular
"Y" - The searched string is handled as a
expressions).
word that is enclosed in delimiters such
"N" - No search for
as blanks, left and right parentheses,
object usage in
equals, commas, single quotations,
scripts.
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.
l (MM)
l =MM=
l 'MM'
l (MM,
l =MM at the end of a line
Underscores are not delimiters.

Searching for MM is not successful if
you search for _MM_.
Note that this search specification is

only supported for the MS SQL Server
and Oracle version 10g and beyond.
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 MM
l MM.CLOSING
l AE.MM.DAY
SECURITY_ The authorization No The authorization system's access trace

AUDIT_FAILURE system's access function can be defined for each individual
control management. client. You can log authorized and/or
denied accesses in the categories login,
"HOST_ACCESS" -
privilege, host access and object access.
All the denied attempts
Single assignments to variable values
to access a host will
must be separated by commas. Specify
be logged.
the variable values exactly as described
"LOGON" - All the
(case sensitive). Single assignments to
denied login attempts
values are not case sensitive.
will be logged.
"OBJECT_ACCESS" The access trace function can be
- The denied attempts reviewed in the System Overview
to access an object (provided that the required privileges are
will be logged. assigned). Each access results in a
"USER_ security message that informs about the
PRIVILEGES" - All access time, user, access category, host
denied user privileges and the actual access. Host information
will be logged. is only available if the user is logged on to
the UserInterface. Usually, you cannot
SECURITY_ The authorization No
retrieve host information for tasks that are
AUDIT_ system's access
activated at runtime.
SUCCESS control management.
If an unknown user makes an attempt to
"HOST_ACCESS" -
log on to the system, the access denial is
Authorized host
logged in client 0000 provided that the
accesses will be
access trace function is activated in the
logged.
variable of client 0000.
"LOGON" - Authorized
logins will be logged.
"OBJECT_ACCESS"
- Authorized object
accesses will be
logged.
"USER_
PRIVILEGES" -
Authorized user
privilege uses will be
logged.
SEND_MAIL_ Key for setting the No (optional) This key sets the default values
DEFAULT parameters Agent and for the agent to be used to send emails
Login used in SEND_ and the Login object containing the
MAIL script functions desired login data for sending emails and
client-wide. attachments.
Format: SEND_MAIL_ If the parameters Agent and Login are

DEFAULT = <agent specified in individual SEND_MAIL
object>,<login object> script functions anywhere throughout
the client, those script statement
values will be overridden by this
setting.
SMTP_FROM_ The sender's email No These settings are part of the Automation
ADDR address. Engine's E-mail connection.
Using the Automation Engine's Email

connection requires the keys SMTP_
SERVER and SMTP_FROM_ADDR to
be specified. All other settings are
optional.
SMTP_LOGIN The name of the Login No

object that is used to
log on to the SMTP
Server.
SMTP_MAX_ The maximum size (in No
ATTACHMENT_ bytes) for the report file
SIZE that is sent via email.
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_
SIZE limits the report-
file 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_ The email address for No
TO the response.
SMTP_SERVER The name of the No
SMTP Server.
SMTP_TIMEOUT The maximum time in No
seconds that the
system waits for an
SMTP Server to
respond.

"999"
Default value: "20"
STARTUP_ "STOP" - The system Server By using the entry STARTUP_ACTION

ACTION stops after the in the scope "Freely selected", you can
Automation Engine influence the behavior of the system after
has started. the Automation Engine has started. The
"WAIT x" - The client can either stop automatic
system waits x processing when the Automation Engine
seconds after the starts or suspend it specified period of
Automation Engine time. By default, automatic processing is
has started. immediately active when the Automation
Engine has started.
Note that the parameter

SystemStop=YES in the Automation
Engine's INI file overrides the settings
that have been made in STARTUP_
ACTION.
TASK_PRIORITY The priority of tasks. No 1 stands for the highest, 255 for the
lowest priority. If 0 is selected for
executable objects in the Attributes tab,
"255"
the priority that is defined for the client in
this entry is used. If no default priority is
specified, or the variable is not available
in the local client, the priority is 200
Note that 0 is the highest possible task

priority. It can only be specified here.
TEMPLATE_ This key affects the No The content of the selection dialog that is
SHOW_ALL list of object types that shown while an object is created depends
is shown when objects on the following factors:
are created.
l The configuration of the variable
Allowed values: "Y" UC_OBJECT_TEMPLATE.
(default) and "N" l The specification that has been
made in TEMPLATE_SHOW_
"Y" - The selection
ALL.
dialog shows all object
types. If value "N" has been specified, only the
"N" - The selection object types that can be created by the
dialog only lists the particular user (for example, the user has
object types that can a "write" privilege) are listed.
be created by the
particular user. 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 , this filter is compared to
the name of the template when a new
object is created.
VARA_ERROR_ Here you can specify No In AE, you can insert values of Variable
ON_ the required behavior if objects in the attributes of executable
REPLACEMENT Variable objects objects at runtime. As a placeholder,
cannot be found specify the variable name enclosed in { }
whose value should be brackets as and optionally the key and the
used to replace column.
placeholders in
Notation:
attributes at runtime.
{ Variable object [, Key [, Column number
Allowed values: "Y" ]] }
(default value) and "N"
The placeholder is replaced by the
"Y" - An error occurs
corresponding value when the task is
and processing aborts.
generated. The value of the result column
"N" - Processing
(in dynamic variables) or the first Value
continues. The value
column (in static variables) of the first
is assigned as
entry (Key) is used if neither a column nor
specified and no
a key have been specified.
replacement takes
place. 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_ "Y" - The version No The entry VERSION_MANAGEMENT
MANAGEMENT control of objects is can be used you determine whether the
activated Version Management of objects should be
"N" - No version activated. If so, the entry VERSION_
control takes place MANAGEMENT_SUFFIX is also
(default setting) important. It is limited to 8 characters and
is inserted in the name part of the object
VERSION_ The part of the name No
that has been duplicated for the Version
MANAGEMENT_ that is inserted in
Management. Entries that include more
SUFFIX objects that are
characters are truncated. Note that the
created in the sequel
same naming conventions apply for
of a Version
suffixes as for objects. Allowed are the
Management.
characters: A-Z, 0-9, $, @, _, -, . If you
Default value: "OLD" use German Umlauts or do not enter a
Maximum 8 characters suffix, the default value "OLD" is used.
WAIT_STATE_ Stores specific No This setting is only relevant when you

RECORDING information about want to monitor the time slot of tasks
tasks that are in a relating to queues using the Automic
waiting status product Predictive Analytics and / or
because of a queue in Process Analytics.
the AE database.
When you set the value "QUEUE", the
Allowed values: details of all tasks that are in a waiting
"QUEUE" - Logs status because of a queue stop or a
information about the queue limit will be logged in the AE
waiting condition of all database.
the queue's tasks in
the database.
This option is
deactivated when you
specify a different
value or no value
(=default value).
XRO_REPORTS External report No This key permits the activation of a
analysis. particular logging that facilitates external
report analyses of jobs and file transfers.
Allowed values: "Y"
"Y" - Report data of

jobs and file transfers
are logged.
"N" - Reports are not
logged.
See also:
UC_SYSTEM_SETTINGS
Variable
3.2.7 UC_CUSTOM_ATTRIBUTES
This AE variable is for defining entries that can be used as grouping criteria for tasks in the Activity
Window.
Use the Header tab of executable objects to assign grouping criteria including a value. An object variable
belongs to each grouping criterion which you can access in the object in read-only mode. Select the
grouping criteria in the Activity Window and filter the activity list according to the grouping criteria values.
Key Value1 Value2 Restart

necessary
The name of the The name of the VARA object that The name of the grouping No
object variable. supplies the reference values. criterion.
It is irrelevant You can specify static or dynamic If the variable includes

whether the VARA objects. If you use a static multiple entries with the
variable name is reference variable, the system uses same grouping criterion,
specified with or the Key column; if you use a the system always uses
without a dynamic reference variable, the the first entry that is finds
preceding '&' system uses the result column (or (the variables are
character. the first value column if there is no processed from top to
result column). bottom). Values of the
Example: &TEST# same grouping criteria are
You must define a value when you
Use this variable to not combined.
assign a grouping criterion to an
read the grouping executable object (Header tab).
criterion's value in Either enter this manually or select
the object. Note it from the reference values.
that you cannot Alternatively, read the value directly
change this from the object variable.
variable in the
object (for example, The grouping criterion can be
by using a script). selected in the Grouping combo
box in the Activity Window. The left
area lists all reference values and
user-defined values of the grouping
criterion according to which you can
filter your tasks.
No reference values are

available when there is no
reference VARA object. This
means that you cannot use the
grouping criterion in the Activity
Window. The same applies
when you use a dynamic
variable that cannot be resolved
(incorrect login info or invalid
SQL).
The system first searches the

reference VARA object in the
current client even if you use
the system client's UC_
CUSTOM_ATTRIBUTES
variable. If the reference VARA
object is not available in the
current client, the system
searches for it in client 0000.
Description
By default, this AE variable is supplied in the system client 0000 but you can also transport it to other
clients. If the current client already includes this AE variable, the client's variable is used. Otherwise, the
system client's AE variable is used.
Assigning Grouping Criteria to an Object
To assign grouping criteria to an executable object, use the Header tab (Custom Metadata section).
Two combo boxes are available here:
l The grouping criterion that is defined in UC_CUSTOM_ATTRIBUTES - value column 2 - is

selected in the first combo box.
l The matching value is defined in the second combo box. This value is used when you filter your
tasks in the Activity Window. You can either enter the value manually or select it from the drop-
down list. The drop-down list includes the reference values from the reference VARA object, which
is defined in UC_CUSTOM_ATTRIBUTES - value column 1.
Next, click the Add button in order to assign the grouping criterion with the defined value and the object
variable to the object.
If the same grouping criterion is assigned to an object multiple times, the defined values are combined.
The object variable returns all the grouping criterion's values separated by commas. When you filter the
Activity Window, you will find the object (task) under each of these values.
Object variables derived from this variable are always inherited to the subordinate tasks (regardless of
the setting that is defined in the Variables and Prompts tab). If there is an object variable in the
subordinate task that is derived from the same grouping criterion, its values are not overwritten but
summarized instead (the entries are separated by commas).
The object variables are read-only and cannot be changed at runtime (script). The value is set once by
using the Header tab.
Examples
Definition in UC_CUSTOM_ATTRIBUTES:
Key Value1 Value2

&BU# VARA.BU Business Unit
Reference VARA object:
Assignment via the Header tab of executable objects:

Activity Window - Grouping:
Also see:
Tabular Overview of all AE Variables

Variable
3.2.8 UC_EX_ERP_CONNECT - Connection to Enterprise

Business Solutions
The variable contains connection specifications to the particular Enterprise Business Solution.

Agent name Connection string Agent
Format for PeopleSoft:
appserver=//host name:Port,version=PeopleTools version
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 is available next to the control field which can be used to access the existing
data in table-form.
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:

Variable
3.2.9 UC_EX_HOSTCHAR - Assigning Agents to Host

Characteristics
This variable can be used to assign agents to particular host characteristics.

Name of the agent Name part of the variable which contains host characteristics Agent
Maximum 188 figures
Default value: DEFAULT
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.
l 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:

Variable
3.2.10 UC_EXT_INTERPRETERS_* - Register External

Interpreters
The UC_EXT_INTERPRETERS_WINDOWS and UC_EXT_INTERPRETERS_UNIX system variable
objects are used to define external interpreters for use with the respective agent, they are available for
Windows and UNIX agents respectively.
These rules apply to Windows and UNIX respectively.
Key Description
Key Interpreter identifier, unique within the Automation Engine system. This key is used to
specify an external interpreter section.
Value1 Desired file extension of the script file passed to the external interpreter
Value2 Variant 1 - single line: Use this Variant to call the external interpreter stating only parameters.
Variant 2 - multi-line: The static Variable object may contain several lines and can be edited
in two ways: In the Variable Tab you may edit the cell in the value column directly or use the
cell editor of the static Variable object
The value column cells should only contain commands that are processed each time this
interpreter is called. In all other cases you should place the commands in the job's script.
The UC_EXT_INTERPRETERS_WINDOWS and UC_EXT_INTERPRETERS_UNIX variable

objects should be configured in the system client 0000. Thus the external interpreters will be available
to all users in all clients of the Automation Engine system.
The system variable object UC_SHELL_UNIX lists all registered shells of an operating system. It
should not be used for registering external interpreters. UC_SHELL_UNIX is delivered together with
the Automation Engine software and maintained by the system administrator in the system client 0000.
Description
In Job (JOBS) objects for Windows and UNIX you may use an external interpreter script in the Process
tab. To be able to use such scripts, the external interpreters have to be registered first by using these
variables.
The Storage object is another object directly affected by this variable. As the files contained in the Storage
object may be used in Windows and UNIX agents, you have to register the external interpreters using UC_
EXT_INTERPRETERS.WINDOWS and/or UC_EXT_INTERPRETERS.UNIX.
Example:
Key Value 1 Value 2 Value 3 Value 4

PERL1 .pl perl.exe <FILE> -k
PERL2 .pl perl.exe <FILE>
GROOVY .groovy groovy.exe <FILE>
The term "<FILE>" will be replaced by the generated script file. This term is fixed and has to be upper
case.
For PERL1 the following call would be the result of using the example values above:
perl myprog.pl -k
See Also
Variables
Settings in Variables
Variable Tab (Cell configuration)
Storage
REGISTER_VARIABLE.* - Register Variables or External Interpreters
How to use an External Interpreter
3.2.11 UC_HOSTCHAR_DEFAULT - Host Characteristics

This variable is used to define the settings of one or more agents.
For file transfer settings, the FT Protocol column indicates whether the settings apply for the old
and/or the new protocol.
The variable is supplied with the system client 0000. Its settings are valid for the entire AE system and can
only be changed from within system client 0000.
The standard host characteristics variable UC_HOSTCHAR_DEFAULT is supplied in the HOST_

VARIABLES folder. It is valid for all agents. If an agent uses a different configuration, you can create
individual variables that contain any term except for the term DEFAULT.
Agents are assigned to host characteristics in the variable UC_EX_HOSTCHAR.
Key Value New FT

start prot
req ocol
uire
d
ANONYM Influences usage of login data for the execution of jobs, FileSystem Events Age Old
OUS_FE and file transfers. nt and
ANONYM new
This setting is only supported for OS/400, z/OS, UNIX and Windows
OUS_FT
agents.
ANONYM
OUS_JOB The Key ANONYMOUS_FE is not supported on z/OS systems.
l ANONYMOUS_FE - for FileSystem Events

l ANONYMOUS_FT - for file transfers
l ANONYMOUS_JOB - for jobs
Allowed values: Y and N (default)
Regardless of the settings that are defined here, the Automation Engine
system always checks at the beginning of a job's execution, whether a
Login object is available including an entry for the particular platform. If
there is no corresponding entry, the job aborts.
This setting can be used to define whether the login data that is stored in the
Login object should be used to execute jobs, FileSystem Events and file
transfers. The behavior also depends on the settings that are defined in the
following INI-file parameters of the agent:
INI file ANONYMOUS_FE

ANONYMOUS_FT
ANONYMOUS_JOB
Windows Y N
[GLOBAL] Jobs and/or file transfers and/or The
logon=0 FileSystem Events start under login
the agent's OS user. The login data that
data that is available in the Login is stored
object is not checked. in the
Login
Attention: AE does not
object is
recommend using this
used.
setting.
[GLOBAL] The login data that is stored in
logon=1 the Login object is used.
UNIX
login_check=no FileSystem Events run with the login
OS user that is stored in the data that
Login object. The password is is stored
not checked. in the
Login
Requirement: The agent must
object is
run under a privileged user.
used.
Attention: AE does not
recommend using this
setting.
[GLOBAL] The login data that is stored in
login_check=yes the Login object is used.
OS/400 Y N
CheckLogon=0 FileSystem Events start under login
the agent's OS user. The login data that
data that is available in the Login is stored
object is not checked. in the
APPLICAT The name of a Login object. Age

ION_ nt
The login data of the Login object is used for:
LOGIN
l PS agents: Login data for PeopleSoft
l Windows and UNIX agents: E-mail connection through SMTP
Default value: ERP_LOGIN

BACKUP_ The time at which the backup folder's lifetime will be checked. Age
RETENTI nt
All files and directories that have been stored longer than is specified in
ON_
BACKUP_RETENTION_LIFETIME will be deleted.
CHECK
The backup folder stores the files of the file rollback of jobs and file
transfers. 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:00"
BACKUP_ The life time in days for the content of the backup folder. Age
RETENTI nt
In this key, you can determine how long files and directories will be stored in
ON_
the backup folder. The system checks this setting daily at the time that is
LIFETIME
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.
Only affects Windows and Unix agents.

Default value: "14"
BLOCK_ This entry can be used to define the action that a workflow should take if one No
ON_LOST 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.
DISCONN This defines whether the connection between the agents ends after a file Age Old
ECT_ transfer. nt
AFTER_
YES - The connection ends after the file transfer (default value).
FT
NO - The connection does not end after file transfer.
This parameter only affects the connection but not the execution of the
file transfer. The system always checks whether there is a connection to
the destination agent BEFORE the file transfer starts. A connection is
established if it is not available.
In the 32-bit UNIX agent for SunSolaris, the number of filter descriptors
(open connections and files) is limited to 253. Keep this in mind when
you execute jobs / file transfers and when you use the setting
DISCONNECT_AFTER_FT = "NO". Automic recommends using the
value "YES".
This setting is only checked if you use the old file transfer protocol.
Using the new protocol means that the connection is always
automatically terminated.
EVENT_ The time interval in seconds during which the agent checks the conditions Age
CHECKIN FILE_CHANGED and FILE_STABLE in its FileSystem events. nt
TERVAL
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.
EXECUT You can use these keys to start any executable object in the following Age
E_ON_ situations. nt
ASSIGNM
If the agent starts and ends:
ENT
EXECUT l EXECUTE_ON_END - agent ends
E_ON_ l EXECUTE_ON_START - agent starts
END
EXECUT For tasks with undefined ends:
E_ON_
l EXECUTE_ON_LOST - Task ended with ENDED_LOST
LOST
EXECUT If you change an agent's client rights:
E_ON_
START l EXECUTE_ON_ASSIGNMENT
Default value: No object starts.
The object is searched and activated in all objects in which the agent is
authorized to do so. System client 0000 is exempted, objects must not
be activated in it. EXECUTE_ON_ASSIGNMENT searches all clients in
which an authorization has been changed.
The object starts under the user UC/UC which is available in system client
0000. Therefore, do not assign authorizations at the object level.
The object that is defined here for agents should wait the time specified
in RECONNECT_TIME using the script statement :WAIT. Afterwards
you can use SYS_HOST_ALIVE in order to verify whether the agent has
logged on again and react accordingly.
Note that EXECUTE_ON_START and EXECUTE_ON_END can be

used by the object to read the script variable &uc_ex_host from the read
buffer. This variable contains the name of the agent and can be used in
the object's script.
For example:
:READ &uc_ex_host,,
:PRINT &uc_ex_host
EXECUTE_ON_ASSIGNMENT can be used to read the following
variables:
l &uc_ex_host - agent name

l &uc_ex_auth_mode# - Type of modification
Allowed values:
"AUTO" - The modification was made using an Agent/Client
Assignment object.
"MANUAL" - The modification was made directly in the Agent object.
l &uc_ex_auth# - New rights in the form of a 3-digit string (missing
rights are displayed with "n").
Example: "RnX" - The agent now possesses the right to read and
execute.
Use the script function STR_CUT to access the individual digits.
FE_ Sets the version of the file event functionality of the AE system, which
VERSION determines the capabilities of the system's agents.
Allowed values: "1" or "2"
Default value: "2"
In order to execute a FileSystem Event object with a UNIX agent under a

different user specified in a Login object, this key has to be set to "2".
FT_ The settings for synchronous / asynchronous transfers between a sending No New
ASYNC_ and a receiving agent of file transfers. Asynchronous transfers are the
QUIT_ default setting.
MAX,
Synchronous transfer: Data packages are only sent when the receipt of sent
FT_
packages has been confirmed. Sender and receiver adjust their
ASYNC_
transmission speeds. A synchronous behavior is achieved when the setting
QUIT_
FT_ASYNC_QUIT_NUM equals FT_ASYNC_QUIT_MAX.
MIN,
FT_ Asynchronous transfer: Data packages are sent although confirmations are
ASYNC_ still missing for sent packages. In doing so, data can be transferred faster
QUIT_ because a faster sender or a slower connection are used more efficiently.
NUM 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_MAX has 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.
FT_ASYNC_QUIT_NUM
Number of data packages that are confirmed per receipt.
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 file transfer
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 file transfers. Age Old
COMPRE nt and
Allowed values: NO (default value) and NORMAL
SS new
FT_ The duration in seconds after which an unused file transfer connection Age New
CONNEC between two agents is automatically terminated. nt
TION_
TIMEOUT
Automic recommends increasing this setting's default value (5 min) if
you transfer huge files (> 3,8 GB) from NSK. Otherwise, the connection
could end prematurely.
FT_ Time interval in seconds in which the agent sends report blocks. Age New
REPORT_ nt
Minimum value: 1
TIME
Default value: 60
FT_ The time in UTC at which the life time of file transfer restart information is Age New
RESTART checked. It is checked on a daily basis. nt
INFO_
This restart information is stored locally in the agents temp directory in the
CHECK
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_ The number of days the restart information of file transfers is stored (life Age New
RESTART time). nt
INFO_
Minimum value: 1
LIFETIME
Default value: 14 days
FT_ The time interval in seconds in which the agents store the restart points Age New
RESTART during a file transfer. nt
INFO_
Minimum value: 1
INTERVAL
FT_ The time interval in seconds in which the agents send the status information Age New
STATUS_ of file transfers to the Server. nt
INTERVAL
The status of file transfers is displayed in the task's detail window.
Minimum value: 1
FT_USE_ MD5 checksum usage that allows for the files that have been transferred in Age New
MD5 file transfers to be checked. This method ensures that the transferred files nt
comply with the source files if the file transfer is restarted.
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

JOB_ Job execution is periodically checked by the agents. You define the time Age
CHECKIN interval for this check in this entry. nt
TERVAL
Minimum value: 1
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_ The time interval for the periodic Automation Engine check. Age
ALIVE nt
Allowed values: 60 and above
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_ This stores agent logs to the AE database. Age
DATABAS nt
E
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_ The maximum number of files that should be retrieved in FileSystem events. Age
FILE_ nt
COUNT
Default value: 1000
0 - The number of files to be found is not limited.
If wildcard characters are used or sub-directories are included in the search,

a file can be found several times. For performance reasons, you can specify
a maximum number of files that should be found.
For example: 100 files
The agent only checks in the first 100 found files whether the specified
condition applies and, if applicable, triggers !Process.
MAX_ This entry contains the maximum number of report blocks that should be Age
REPORT_ transferred to the AE database. nt
SIZE
The key REPORT_BLKSIZE can be used to specify the maximum number

of bytes used in a block.
For example:
Block size: 8000 bytes

Report blocks: 120 blocks
This definition results in a maximum report size of 937 KB.
Define whether the agent should store the report in the AE database and/or
in a file in the host-specific tabs of jobs. The report is truncated and stored to
the database if it exceeds the maximum specified number of blocks. If only
the option "Job report" - "Database" has been selected, the file is deleted on
the agent computer after it has successfully been transferred.
An incomplete report is stored in the database if it exceeds the maximum

number of blocks. The specification that has been made in MAX_
REPORT_SIZE is not considered when the job report is stored as a file.
In this case, the complete report is stored in the file system.
(see also: System Overview)

RECONN This entry defines the time interval during which the agent tries to establish Age
ECT_TIME a connection. This refers to the establishment of a connection in case of a nt
restart or when the connection has been ended.

This setting has a different impact on the Windows and OS/400 agents.
These two platform agents always only after the RECONNECT _TIME
will try to reconnect.
All other agents the first time will try to reconnect immediately.
REPORT_ This entry contains the size of a report block. Age
BLKSIZE nt
Default value: 8000 Bytes
REPORT_ You use REPORT_TIME to set the time interval during which the agent Age
TIME sends the logging to the AE system. nt

VAR_ The maximum time in seconds for resolving Variables objects with the Age
TIMEOUT sources BACKEND and SQL. nt
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.

Default value: 600
WORKLO The maximum number of resources that the agent provides for file transfers. No
AD_MAX_
Allowed values: -1 to 100000
FT
Default values: -1
The value -1 corresponds to UNLIMITED which means that the resource

settings are ignored when the file transfer is processed.
Values above 100000 are read as -1.
The value for WORKLOAD_MAX_FT can also temporarily be set in the

System Overview.
WORKLO The maximum number of resources that the agent provides for jobs. Age
AD_MAX_ nt
Allowed values: -1 to 100000
JOB
Default value: -1
The value -1 corresponds to "UNLIMITED", which means that resource

settings are ignored when the job is processed.
Values above 100000 are read as -1.
The value for WORKLOAD_MAX_JOB can also temporarily be set in

the System Overview.
See also:

Variable
3.2.12 UC_ILM_CONTAINER_* - Automation Engine

Database Partitions
The table shown below describes the XML file structure of a Variable object and explains the individual
elements.
Key Value Restart

required
Container number MS SQL Server: Name of a file group No
Allowed values: "1" - "999" The file group name must not exceed 200
characters.
Value must start with "1" and be
ascending. Oracle: Name of a tablespace
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 UC_ILM_CONTAINER_STATISTICS - statistical records

l UC_ILM_CONTAINER_REPORT - reports
l UC_ILM_CONTAINER_MISC - messages, data for the Revision Report and for the Open Interface
to Output Management Systems
The utility AE.DB Load automatically fills these variables with data during the ILM installation.
A container corresponds to a partition.
Example for UC_ILM_CONTAINER_STATISTICS:
Key Value
1 UC4_DATA_STATISTICS_1
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.
l 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:

Variable
Partitioning with ILM
3.2.13 UC_ILM_SETTINGS - Settings for Partitioning with

ILM
This variable includes the settings for ILM functionality.
Key Value Restart

required
ACT_ Number of the active container No

CONTAINER
ACT_ Current partition number No
PARTITION
The Automation Engine counts the partitions used for installing ILM and
increases this value by "1" with each partition change.
ACTIVE ILM status No
Allowed values: "Y" and "N"
"Y" - ILM is active, i.e. new partitions are created and switch-outs (only MS
SQL Server) are performed.
"N" - ILM is not active, i.e. no partition change or switch-out (only MS SQL
Server) is made.
CALENDAR 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_ Object that should be activated if an error occurs. No
ON_
The following script variables can be read from the read buffer:
FAILURE
l ILM_ACTION# - action in which an error occurred
The script variable can contain the following values:
"ADD_PARTITION": partition change
"CHECK": check for data records of active tasks in the partition
"DROP": deletion of a partition
"SWITCH_OUT": switch-out of the oldest partition (only
MS SQL Server)
l ILM_PARTITION_NAME# - name of the affected partition
l ILM_ERROR_MSGNR# - AE error number
l ILM_ERROR_MSG_INSERT# - variable part of the message text
l ILM_DB_ERROR_MSG# - error message of the database
The object is searched for and activated in all clients except for system
client 0000. No activation is allowed in this client.
EXECUTE_ Object that should be activated if an ILM action was successful No
ON_
The following script variables can be read from the read buffer:
SUCCESS
l ILM_ACTION# - action in which an error occurred
The script variable can contain the following values:
"ADD_PARTITION": partition change
"CHECK": check for data records of active tasks in the partition
"DROP": deletion of a partition
"SWITCH_OUT": switch-out of the oldest partition (only
MS SQL Server)
l ILM_PARTITION_NAME# - name of the affected partition
The object is searched for and activated in all clients except for system
client 0000. No activation is allowed in this client.
LOGIN Name of a Login object that includes the database user to be used for No
executing ILM actions.
In the Login object, select the host type "DB".
The Login object must be stored in system client 0000.
The database user specified in the Login object must have permission to
read the following system tables:
l ALL_TAB_PARTITIONS
l ALL_CONSTRAINTS
l ALL_PART_INDEXES
l ALL_INDEXES
ONLINE_ Number of online partitions. No
PARTITIONS
RETRY_ Maximum number of attempts to change the partition until ILM is No
MAX_ automatically deactivated.
COUNT
Default value: "3"
RETRY_ Time (in minutes) to wait between attempts to change the partition No
TIME (RETRY_MAX_COUNT).

Default value: "10"
SCHEMA_ Name of the user who created the AE database. No
OWNER
This parameter is required for Oracle databases only.
Note that this parameter is case-sensitive.
The Automation Engine assumes that there is no further AE installationation

within the Oracle instance and that all tables within this instance are unique
if no user is indicated.
STATISTIC_ Time delay in minutes for the statistical update after the partition has been No
TIME changed (only Oracle).

Default value: "15"
Value "0" has the effect that no statistical update is made.

TIMEOUT Maximum time in seconds that the Automation Engine is stopped before the No
partition is changed.

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

Variable
Partitioning with ILM
3.2.14 UC_JOB_CHECKINTERVAL - Periodic Time Check in

the Automation Engine
This variable contains the interval time for the periodic time control of the Automation Engine.
The variable is supplied with client 0000. Its setting is globally valid for the whole system of AE. These
settings can only be changed from within client 0000.
Certain functions of objects, i.e. the time entry in the dependencies feature of a workflow or the starting
time of a Schedule object, require a periodic checking of the actual time. This variable defines the interval
for this check and so defines the accuracy of the system. The entry contains the number of seconds
between the periodic checks. We suggest to choose a value between 10 and 60.

* Time interval Server
Default value: 20 Seconds
See also:

Variable
3.2.15 UC_KDC_SETTINGS - Single Sign-On

Variable for configuring the KDC Single Sign-on mechanism.
Key Value1 Restart

necessary
Fully-qualified domain of the OS user Department of the Automation Engine No
system's user
KEYTAB Path and file name of the keytab file Yes
HTTP Name of the host the web interface is Yes
installed upon.
Description
Logging in via KDC (Key Distribution Center) Single Sign-on to the Automation Engine system requires a
suitable configuration via the variable object UC_KDC_SETTINGS.
The full instructions for Setting up Single Sign-On can be found in the Administrator Guide.
The variable is located in client 0000 and must be modified there. Transfer to another client is not
possible since the settings apply to the entire system.
The following three definitions must be implemented in this variable:
1. Specify keytab file

Authentication is performed in Single Sign-on mode using the Keytab file. This value is therefore
mandatory.
Define a variable item using the "KEYTAB" key. Enter the path and name of the Keytab file in the
associated value column.
2. Specify domain
The operating system users, which are for authentication, are searched for via Automation Engine
users. If the Automation Engine client contains one or more users with the same name but a
different department, a corresponding assignment must be defined via the variable object. The fully-
qualified domain name of the operating system user (Key column) must be assigned to the AE
user's department (Value1 column).
3. Specify HTTP as Service Principal Name
In order to implement Single Sign-on for web applications (such as Enterprise Control Center or
Application Release Automation), a keytab file with HTTP as Service Principal Name is required.
The SPN name must also be entered in this variable using the "HTTP" key. If several ECC/ARA
installations are available for an Automation Engine system, then other names separated by a semi
colon can be added. For details refer to the Setting up Single Sign-on page.
Also see:
Tabular Overview of all Variables

Variable
3.2.16 UC_LDAP_EXAMPLE - LDAP Connection Variable

This variable contains the specifications for the LDAP connection.
This variable is supplied in client 0000. Its settings are applied globally for the whole AE system. The
variable contains all specifications for the connection to the Active Directory or Oracle Directory Server.
As of version 11, LDAP over SSL may be used.
The folder "DIV_VARIABLES" contains the variable UC_LDAP_EXAMPLE which can be used as a
template. Duplicate this variable. There are two methods for configuring the connection to your LDAP
server (Active Directory or Oracle Directory Server):
l Method A, rather used for Active Directory: Name the copy "UC_LDAP_domain". If the domain
name is "SMITH", the variable name must be "UC_LDAP_SMITH".
l Method B, rather used for Oracle Directory Server: 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 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.
Key Value New

start
required
AUTHENTICATION_ Authentication method No
METHOD
Depending on the LDAP Server configuration, authentication
requires realm data or the domain name.
Allowed values: "0", "1" (default value) and "2"
"0" - Authentication first uses the LDAP Server's realm data. A

second attempt to log on is made with the domain name if the first
attempt fails. The LDAP connection remembers the successful login
method and uses this one first for future logins. Each attempt to
authenticate is regarded as a login attempt. Whether an attempt to
log on failed because of incorrect user data or due to a wrong login
type is irrelevant. Thus, entering an incorrect password several
times has the effect that a user is locked earlier.
"1" - The response to the LDAP Server is sent with the
LDAP Server's realm data. This is the default method which should
be accepted by every LDAP Server.
"2" - The domain name is used to respond to the LDAP Server.
DOMAIN_ALIAS Domain alias or domain name (if the department has been specified No
in the name of the variable)
SERVER Name and port number of the LDAP 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.
SYNC_LOGIN (optional) This key defines a UC_LDAP_Domain variable used for
synchronizing LDAP data.
If a current AE user shall use a specially created Login object

that contains credentials allowing the LDAP synchronization,
use this key. Necessary only, if the existing permissions are not
sufficient.
Key Value New

start
required
USE_ Access via DN (distinguished name) No
DISTINGUISHED_
Allowed values: "Y" and "N" (default value)
NAME
"Y" - The connection to the LDAP system is established via DN.
"N" - DN is not used.
The password remains unencrypted when using DN.

As of version 11 this function is dependent on the parameter
VERSION (see below). If it is set to "1", the password remains
unencrypted.
For VERSION = "2", the connection as well as the password will
be encrypted, since LDAP over SSL is used.
The LDAP connection uses the domain name when a user logs

on for the first time. By doing so, it retrieves the corresponding
Distinguished Name (DN). For all subsequent login attempts it
uses the DN because this method is the quicker one. If it fails,
the LDAP connection automatically continues using the domain
name.
On Oracle Directory servers, the DN (distinguished name) is

always used.
USR_EMAIL1 LDAP attribute from which the e-mail address should be read No
E.g.: "mail" in the Microsoft Active Directory

USR_FIRSTNAME LDAP attribute from which the first name should be read No
E.g.: "givenName" in the Microsoft Active Directory
On Oracle Directory servers this setting is irrelevant, as

attributes there are always "givenName" and "sn".
USR_LASTNAME LDAP attribute from which the last name should be read No
E.g.: "sn" in the Microsoft Active Directory
On Oracle Directory servers this setting is irrelevant, as

attributes there are always "givenName" and "sn".
VERSION Defines, if an existing C-Modul or the Java based Work process No
(JWP) is used in order to enable LDAP over SSL.
Allowed values: "1" (default) and "2".
"1" = uses the C-based LDAP connection, SSL is not possible.

"2" = uses JWP, LDAP over SSL is possible
TLS Allowed values: "Y[es]" and "N[o]" No
This parameter is used only in case the parameter VERSION is set

to "2".
If the parameter is set to "N", the Java based Work Process (JWP)
creates a connection to the LDAP server without SSL.
* 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.

Variable
3.2.17 UC_LOGIN_TYPES - Defining Additional Platform

and System Types for Login Objects
You can use this variable in order to define additional platform and system types for Login objects.
This variable is supplied in the client "0000". Its setting applies throughout the whole AE system when
changed in the client "0000".
It is possible to export the object from client "0000" and import it in another client. When you do, the list
in the Login objects will then take the settings from the UC_LOGIN_TYPES variable in that client.
By default, you can only select the platform types of agents in the Type column of Login objects. You can
use the variable UC_LOGIN_TYPES in order to define additional types which will then be listed in the
dropdown field of the Type column.
Note that a Type name that exceeds the maximum length of 32 characters will be shown in a truncated
form in the Login objects.
Key Value Restart

required?
The name of the type. A description of the type (optional) No
Maximum value: 32 characters
See also:
Overview Table of all variables

Variable
3.2.18 UC_OBJECT_COUNTER - Counter Reading in Object

Name
This variable contains a counter whose reading - a run number - is appended to the name of newly created
objects.

Short form of the object type Number ranging from 0 to 2147483647 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:

Variable
3.2.19 UC_OBJECT_DOCU - Object Documentation

objects can contain Documentation tabs. The type and number of these tabs can be defined per client
and object type in the variable "UC_OBJECT_DOCU."
Key Value New start

required
"*" Title of the documentation tabs No
or Each tab is limited to 10 characters
short name of the object
Tabs of structured documentations are limited to 9
type
characters.
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
If you import a Schedule object that contains the Documentation tab "Contacts", the following tabs are
shown afterwards: "General", "Details" and "Contacts."
See also:

Variable
Documentation Tabs
3.2.20 UC_OBJECT_TEMPLATE - Object Types and

Templates
This variable is used to specify the templates that can be used in order to create particular object types.

Name of the object type 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 variable UC_CLIENT_SETTINGS and users only see the object types they are allowed to
create.
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 file transfer). 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:
Key Value
Cockpit CPIT
Notification for alarm messages CALL_ALARM
Notification for requests CALL_REQUEST
See also:

Variable
3.2.21 UC_REPORT_STYLESHEETS - Style Sheets for XML

Reports
This variable can be used to specify the StyleSheets for XML reports.
Key Value Restart required

Short name of the report type Name of the StyleSheet object 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
3.2.22 UC_SAP_JXBP_EVENTTYPES - Event Types of the

Java Scheduler in SAP
This variable stores the possible event types of the SAP Java Scheduler.
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
3.2.23 UC_SENDTO and UC_SENDTO_ACT - Handling

Objects and Tasks Internally/Externally
In these two variables, you can define commands for calling external programs and internal objects.

Description of the menu command Path and name of the program -f%01 UserInterface
Description of the menu command Name of an executable object 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:
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# Name of the object/task
&TYPE# Type of the object/task
Additionally for tasks:
&RUN# Run number (RunID) of the task
&LNR# Placement in workflows and schedule
&PARENT_RUN# Run number (RunID) of the superordinate task
&PARENT_NAME# Name of the superordinate task
&PARENT_TYPE# Object type of the superordinate task
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#
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
Determining Schedule data (Script) SCRI_SCHEDULE_DATA
Test system C:\AUTOMIC\TRANSPORT.EXE -f%01
See also:

Variable
Explorer
Activity Window
3.2.24 UC_SNMP_VALUES - SNMP Values

This variable contains particular SNMP values.
Key Value New start

required
BLOCKING_COUNT Number of blocked tasks No
CALL_OPERATOR_ Number of active notifications No
COUNT
EX_COUNT Number of active agents No
USER_COUNT Number of UserInterfaces connected to the Automation No
Engine
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:

Variable
About SNMP
3.2.25 UC_STATISTIC_OPTIONS - Controlling the Statistics

Functions
This variable controls the extent of the statistics.

USER_SESSION "J" or "Y" - Statistics for user sessions will be created. No
"N" - Statistics for user sessions will not be created.
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:

Variable
3.2.26 UC_SYSTEM_SETTINGS - System-Wide Settings

This variable contains settings that apply throughout an entire AE system.
Validity Value Restart

required
AGENT_ This setting defines whether the IP address of agents should be No

COUNT_PER_ used for checking the license.
IP
"Y" - The IP address is used for checking the agent's license. The
license is not counted if an agent of the same IP address is already
logged on.
"N" - The IP address in not checked when the agent logs on. This
saves time when numerous agents log on. Note that every agents
requires its own license in this case.
AGENT_LOG_ The maximum number of log-file changes for agents (per minute). No
CHANGE_PER_
Allowed values: 20 to n
MINUTE
Default value: 60
AGENTGROUP_ The interval in minutes at which tasks that are waiting for the host No
CHECK_ of an agent group are checked.
INTERVAL
Default value: 10
BACKENDVAR_ The maximum number of lines that a BACKEND-type Variable No
MAX_ROWS object returns.

Default value: 200
CHANGE_ The time period in days after which the log files are changed. No
LOGGING_
DAYS
Default value: 14
CHANGE_ The size in MB after which the log files are changed. No
LOGGING_MB
Default value: 20
CONDITION_ The time interval in seconds at which the Preconditions tab of No
CHECK_ workflows is rechecked.
INTERVAL
Default value: 60
DEFAULT_ The size in MB which is requested by default for the output analysis No
REPORT_ when you read a report.
SCAN_
MEMORY
Default value: 2
DELETE_ The number of objects to be deleted for which the search-for-use No
CHECKBACK_ function should be executed without a check-back being made.
LIMIT
Default value: 10
DISABLE_ No user-defined Include objects are called in the Headers and No

USER_HEADER Trailers of Job objects that run on the platforms that are defined
here.
Allowed values: BS2000, CIT, GCOS8, JMX, MPE, MVS, NSK,

OS400, PS, SAP, SAPBW, SIEBEL, UNIX, VMS, WINDOWS or
*ALL.
Separate values by using commas.
By default, all available Includes are executed.

ERT_ The time in minutes after a system start that the system spends No
ADAPTIVE_ waiting for the availability of a JWP in order to calculate the
JWP_TIMEOUT adaptive ERT.
Default value: 5
EXECUTE_ON_ The object to start if a message is put into quarantine. No
EXCEPTION
EXTERNAL_ Interval in minutes at which external workflow dependencies are No
CHECK_ checked.
INTERVAL
Default value: 10
EXT_DEP_ Handling of tasks in external dependencies. No
ENDED_LOST_ The following values are possible:
RUNNING
N(o): Tasks with status ENDED_LOST are ignored in external
dependencies.
Y(es): Tasks with status ENDED_LOST are handled like every
other task in external dependencies.
Allowed values: "N" or "Y".
Default value: "N"

GENERIC_ The maximum number of activities to be displayed. No
ACTIVITIES_
LIMIT
Default value: 5000
GENERIC_ The maximum number of Auto Forecast results to be displayed. No
AUTO_
FORECAST_
Default value: 5000
LIMIT
GENERIC_ The maximum number of search results to be displayed. No
SEARCH_LIMIT
Default value: 5000
GENERIC_ The maximum number of statistical records to be displayed. No
STATISTICS_
LIMIT
Default value: 5000
GET_ The handling of blanks in a line that is read by using the script No
PROCESS_ function GET_PROCESS_LINE.
LINE_RTRIM
Allowed values: 0 and 1 (default)
0 - GET_PROCESS_LINE leaves blanks at the end unchanged.

1 - GET_PROCESS_LINE truncates blanks at the end.
KDC Enables or disables Kerberos Distribution Center (KDC) No
authentication for a whole system.
Allowed values: "Y[es]" or "N[o]"
If this switch is not set, an internal default value of "N[o]" is

assumed.
LAST_USE The time delay in minutes after which the objects' usage counter is No
refreshed.
Default value: 0 (no refresh)
LDAP LDAP connection. No
Allowed values: Y and N (default value)

Y - LDAP is used
N - LDAP is not used
LOG_TO_ This saves the server log in the AE database. Server
DATABASE
Y - The Automation Engine's log messages are saved in the AE

database.
N - The Automation Engine's log messages are not saved in the AE
database.
MAX_EXPORT_ The maximum number of objects to be exported at the same time. No
COUNT
Default value: 1000
MAX_IMPORT_ The maximum size (KB) of the XML file to be imported. UserInterface
SIZE
To use this setting correctly, you need also to set the
maxMsgSize= setting in the [TCP/IP] section of the
UCSRV.INI file for the Automation Engine.

MAX_REPORT_ The maximum size in MB which is requested for reading an Output No
SCAN_ Analysis report.
MEMORY
Default value: 10
MAXIMUM_ The maximum size of resources attached to the Storage object, in UserInterface
STORE_ bytes.
RESOURCE_
Allowed values: 0 to 71 MB (74448896 bytes)
SIZE
Default value: 71 MB (74448896 bytes)
MIN_EVENT_ The minimum interval (minutes) at which events are executed. No

INTERVAL
Default value: 1
MQA_COUNT_ The number of server messages to be buffered in the server No
BACK computer's random access memory.

Default value: 0
MQ_BLOCK_ The number of blocks after which the message queue is to be No
COUNT reorganized (Oracle databases only).

Default value: 64
MQ_CHECK_ The interval (seconds) at which message queues are checked No
TIME (Oracle databases only).

Default value: 600
Value 0 means that no check is made.

OBJECT_ Determines user access to objects in the system client from other No
ACCESS_ clients in the Automation Engine system.
CLIENT_ZERO
Allowed values: "Y[es]" or "N[o]"
Default value: "Y"

PASSWORD_ The name including the path of the generated server program library Server
EXIT for an external password check.
Max. 256 characters
PASSWORD_ This serves to assign parameters for a password check. Server
EXIT_PARAM Max. 256 characters
PASSWORD_ Modifies the password. UserInterface
CHANGE
Allowed values: Y (default) and N
Y - The password can be changed.
N - The password must not be changed.
RECONNECT_ The interval (seconds) at which the server processes attempt to Server
TIME establish a connection.

Default value: 60
REPORT_ The maximum size of the logging block (bytes) to be transferred at Server
BLKSIZE the same time.

Default value: 8000
REPORT_TIME The interval (seconds) at which the server processes send the log Server
to the AE system.

Default value: 30
RESERVED_ The number of licenses reserved for CallAPI users. No

API_USERS
Default values: 0
RESOLVE_ Determines the behavior of the script function GET_VAR, which No
GET_VAR was changed in version 9SP4 of the Automation Engine.
Allowed values: "Y"(es) and "N"(o)
"Y"(es) (default): The script function GET_VAR will show the

variable's value, i.e. the variable will be resolved (as of version
9SP4).
"N"(o): GET_VAR will not resolve the variable, but show the
variable's name, for example: &var# (as customary in versions
prior to version 9SP4)
SCR_ The time period in seconds after which an endless loop is assumed No
LOOPCHK_ in a script.
TIME
Default value: 5
SERVER_ Various server settings for performance improvement and trace No
OPTIONS outputs.
Format: 15-digit string
By default, all options are deactivated.

SHOW_ By using this parameter, you can display reports as subordinate No
REPORT_ tasks in the Activity Window.
HIERARCHICAL
"Y" - The Activity Window displays the report of a task as its child.
"N" - The Activity Window displays reports as individual tasks.
Use the Hierarchical view of the Activity Window in order to

have reports displayed as subordinate tasks.
This setting does not affect the statistical information as it

always displays reports as child tasks.
SMGR_PORT_ Indication of a port number or a port area to be searched for No
RANGE ServiceManager services.
Default value: 8871 (default port of the ServiceManager)

Port area: maximum of 10 port numbers
SNMP_ This setting controls the time interval (in seconds) at which SNMP No
REFRESH refreshes the information about blocked workflows.
Allowed values: 0 (= always) to 600

Default value: 10
SQLVAR_ This permits the creation and editing of Variable objects of the No
INTERNAL types "SQL - internal" and "SQL - internal SECURE".
Allowed values: YES and NO (default value)

YES - Internal SQL variables can be created, edited and used.
NO - It is not allowed to create variables that access the AE
database. The use of internal SQL variables is not allowed.
SQLVAR_MAX_ The maximum number of lines that can be returned by SQL-type No

ROWS and SQLI-type variables.

Default value: 200
SYNC_BLOCK_ The number of Sync objects whose log is to be changed per block. No
COUNT
Default value: 100
SYNC_CHECK_ Determines whether Sync objects are checked when restarting a No
RESTART canceled job without an Abend action.
Allowed values: Y and N

Y - Sync object is checked when restarting a canceled job without
an Abend action.
N - Sync object is not checked, a job is restarted immediately.
Default value: Y
TRASHBIN_ The maximum number of objects to be displayed in the Recycle No
SHOW_MAX Bin.

Default value: 5000
UNREAD_ The output of unread administrator and security messages. No
MESSAGES
Allowed values: Y and N
Y - Messages are displayed in the Message Window.
N - Messages are written to the database without being displayed.
UNREAD_ The maximum number of unread messages to be kept. No
MESSAGES_
BUFFER
Default value: 500
VAR_ Security level for the replacement of variables in dynamic Variable No
SECURITY_ objects.
LEVEL
Allowed values: "0" (default), "1", "2" or "3"
0 - Variables in VARA objects are not replaced.
1 - Predefined variables can be used provided that they cannot be
modified (such as the system date or the RunIND).
2 - Predefined variables can be used provided that their values can
be influenced by the user (such as a client's title).
3 - Placeholder for Variable objects, PromptSet variables (in
dynamic PromptSet elements).
VARIABLE_ The interval in minutes at which the resolving of SQL variables is No
SERVICE_ repeated if their values are not available due to an error (for
CHECK_ example, the database is not available or incorrect data is specified
INTERVAL in the Connection or Login object). The tasks that use these
variables are in a waiting condition.
Minimum: 1
Maximum: 60
Default value: 10
VERSIONS_ The maximum number of objects to be displayed in Version No

SHOW_MAX Management.

Default value: 5000
WORKLOAD_ The resources that a file transfer or job is to use by default. No
DEFAULT_FT
WORKLOAD_
Default value: 1
DEFAULT_JOB
WP_MIN_ The minimum number of server processes per node name to be No
NUMBER used as work processes (WP).
Format: node name1=number;node name2=number etc.
Allowed values for the numbers: 2 up to the maximum number of

work processes.
Default value: 5
XML_ The encoding of the XML files. No
ENCODING
Allowed values: ISO-8859-15 (default value), ISO-8859-1 and
WINDOWS-1252
XML_ This checks the encoding during the import process. No
ENCODING_
Allowed values: "Y" or "N"
CHECK
Default value: "Y"
Y - The import files must have the encoding which was assigned
with the key XML_ENCODING.
N - Encoding of the XML files is not checked.
ZERO_ Enables or disables a mode, which prepares the system for a
DOWNTIME_ version upgrade without system downtime.
UPGRADE
Allowed values: "Y" or "N"
Default value: "N"
Y - A database upgrade is allowed while the system is fully up and

running. New CPs/WPs can be started for working in a
compatibility mode, with their peers of a pre-installed version.
N - Database upgrade not possible, if the system is running. All
CPs/WPs must have the same version.
During the period of time where, ZERO_DOWNTIME_

UPGRADE = Y the system performance will be reduced,
because certain system optimizations are not possible in this
mode.
Description
This variable is supplied in client 0000. Its settings apply for the whole AE system and can only be
AE 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
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 an AE system contains, the higher the chance is that log-file changes are required for a
large number of agents at the same time. Use the setting AGENT_LOG_CHANGE_PER_MINUTE to
improve system performance by limiting the number of log files to be changed per minute.
AGENTGROUP_CHECK_INTERVAL
Tasks such as jobs or file transfers 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 at 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 at which the agent attempts to establish a
connection to the AE system. This value can be specified with the option RECONNECT_TIME in the
variable UC_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 result in a longer time taken to resolve backend-type variables.
CHANGE_LOGGING_DAYS and CHANGE_LOGGING_MB

These files can be changed on a time- and size-dependent basis in order to ensure that the log files can be
handled smoothly during high workload times for Automation Engines and agents. You can also archive
and reorganize this data in the AE database, although the Automation Engine 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
valid until the system reboots. Use the script element CHANGE_LOGGING in order to trigger a forced log-
file change.
To avoid endless reports for events, RemoteTaskManagers, Sync objects, 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 Automation Engine, define this setting in the variable UC_SYSTEM_SETTINGS, and for agents,
use 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.
CONDITION_CHECK_INTERVAL
The Preconditions tab, which is available in the properties of workflows, can be used to define conditions
and statements. These are regularly checked and executed before the tasks start. This process
(evaluation cycle) is repeated until the last start time or a final statement has been reached. Use this key 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 to be requested in order to read
reports using a Filter 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 is 30 MB.
The Automation Engine recognizes that 3 MB is not sufficient to read the report and increases the
memory: 3 MB -> 6 MB -> 12 MB. The maximum value for 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 process as a whole can take a little longer than usual when many objects are deleted
simultaneously. Use the key DELETE_CHECKBCK_LIMIT in order to have a query displayed starting
with the specified object number, letting you 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 system client 0000 and
can be used to call user-defined Include objects. More detailed information is available in the
documentation about job includes. If user-defined Include objects should not be used, you can either
specify particular platforms or *ALL. Resultantly, these Include objects are not searched, which avoids
unnecessary database accesses and improves performance.
Example:
Validity Value
DISABLE_USER_HEADER BS2000,MVS,WINDOWS
ERT_ADAPTIVE_JWP_TIMEOUT
A Java-based work process (JWP) calculates the adaptive expected runtime. If there is no JWP, the ERP
cannot be calculated by using this adaptive method.
Use the setting ERT_ADAPTIVE_JWP in order to determine the time in seconds after a system start that
the system spends waiting for the adaptive ERT calculations until a JWP is active. After this period of time
and when there still is no JWP, the system uses the alternative ERT calculation method which is specified
with the setting ERT_ADAPTIVE_FALLBACK_METHOD (UC_CLIENT_SETTINGS).
If the JWP becomes available at a later point, the system will apply the adaptive ERT calculation again.
Note that this setting is only relevant when you intend to calculate the ERT by using the "adaptive"
calculation method.
At least one active JWP is needed for the adaptive ERT calculation method.
EXECUTE_ON_EXCEPTION
By default, invalid messages which cause a server process to crash are put into quarantine. Use this key
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
no objects can be activated in it.
EXTERNAL_CHECK_INTERVAL
This setting determines the frequency at which the status of external dependencies is checked in
workflows. The workflow first checks its external dependencies 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 at short intervals is very CPU-intensive. Therefore, you can limit the maximum number of
activities to be displayed using the entry GENERIC_ACTIVITIES_LIMIT. A message in the Activity
Window's status line indicates that there are more active tasks than displayed. Limit the Activity Window
filter so that non-displayed tasks can also be viewed.
GENERIC_AUTO_FORECAST_LIMIT
Auto Forecast filter criteria are very complex. The entry GENERIC_AUTO_FORECAST_LIMIT can be
used to limit the maximum number of search results.
GENERIC_SEARCH_LIMIT
In the Explorer, you can search for objects or particular folders. Include the various options in your search.
Complex selection criteria can result in a large amount of results and cause long searching times.
Therefore, Automic recommends limiting the number of results to be displayed with the entry GENERIC_
SEARCH_LIMIT. If the search result is above the value defined here, a message is displayed and only the
specified maximum number of results is output.
GENERIC_STATISTICS_LIMIT
Statistical records are automatically created when objects are processed. Selective statistics can be used
to search for objects using various options. Complex selection criteria can result in a large amount of
results and cause long searching times. To specify a maximum number of records to be displayed, use the
entry GENERIC_STATISTICS_LIMIT. A message is displayed if the search result exceeds the value
defined here.
GET_PROCESS_LINE_RTRIM
The script functionGET_PROCESS_LINE reads a line of a data sequence (such as a report). Use the
entry GET_PROCESS_LINE_RTRIM to determine whether blanks used at the end of the line should be
truncated.
LAST_USE
The Header tab of each object contains information about the object's creation and last modification time.
It is also possible to display the date of its last use and the total number of executions. The entry in LAST_
USE indicates the time in minutes since the last refresh. Executions are not counted if no value or 0 has
been specified.
LDAP
LDAP can be used to query information from a directory service such as the Microsoft Active Directory.
Users logging in to the AE system can authenticate themselves using this directory service.
LOG_TO_DATABASE
This setting can be used to determine whether the Automation Engine also writes log-file messages to the
AE database. Value Y indicates that log messages are saved in the Server object's report. Value N
indicates that logging is only performed in the log file. This setting improves the performance of your AE
system.
The variable UC_HOSTCHAR_DEFAULT contains a setting of the same name which can be used to
specify the agent's log behavior.
MAX_EXPORT_COUNT
During the exporting process, information about the objects highlighted in the Explorer (name, attributes,
etc...) is written to a common XML file. To limit the maximum number of objects that can be exported at the
same time, use the entry MAX_EXPORT_COUNT. Exceeding this value means that the process has
failed. A corresponding error message indicates this.
MAX_IMPORT_SIZE
Use this entry 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
For each event, you can specify a minimum interval (minutes) for its execution in the corresponding Event
tab. To define a lower limit, use the entry MIN_EVENT_INTERVAL. The interval specified here is applied
if an event contains a value below this limit. AE uses the value specified in the variable UC_JOB_
CHECKINTERVAL if 0 is entered here.
MQA_COUNT_BACK
Use this key to define the maximum number of server messages to be buffered for further analysis. Only
messages which have been sent or received by work processes (PWP, DWP, WP) are affected. These
messages are saved in the random access memory (RAM) of the computer on which the Automation
Engine is running.
Open the latest messages that have been buffered via the System Overview -> Automation Engine
section. Here, select the Workload menu item in a WP's context menu.
MQ_BLOCK_COUNT and MQ_CHECK_TIME

In Oracle databases, the Automation Engine checks the block size of the message queues MQPWP,
MQWP, MQDWP, MWRWP, MQOWP and MQCPnnn at the interval specified in MQ_CHECK_TIME . If
the block size exceeds the value specified in MQ_BLOCK_COUNT, the Automation Engine reorganizes
the message queue, improving the performance of your AE system.
PASSWORD_EXIT
This entry facilitates a password exit. The value to be specified is the name and path of the generated
program library.
Example: PASSWORD_EXIT c:\AUTOMIC\pwexit\bin\xuc4pass.dll
PASSWORD_EXIT_PARAM
If parameters need to be assigned, do so using the PASSWORD_EXIT_PARAM key.
PASSWORD_CHANGE
Use this key 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) at
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 in to AE 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.
Example: "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 the UserInterface. It is possible for five additional users to log
in 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 in to system client 0000 is possible even if all dialog licenses are in use. The administrator can
always log in 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 in order to avoid unnecessary Automation Engine loads. Use this method
to avoid endless loops.
Use SCR_LOOPCHK_TIME to define the frequency at which the script is interrupted. The subsequent
waiting time is always 1 second at the start. This time is doubled after every interruption. The longest
waiting time is 128 seconds. After 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
after further 3 seconds Generation pauses
Waiting time Duration: 2 seconds
Script continues Generation continues
after further 3 seconds 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 P Avoids deadlocks especially when deactivating workflows with DB2.
This setting is ignored, the behavior always corresponds to the value "P".

3rd digit S 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 M Extends traces so that memory leaks are found more easily.
5th digit X XML messages (for example, OS messages) can contain invalid characters.
With this setting, an additional message and the relevant XML message
(memory dump) are written to the server log file.
6th digit U An additional way to avoid deadlock, especially for DB2.

7th digit G Configuration for the restart behavior of tasks.
In manual restarts, the "Generate at runtime" setting is ignored. Therefore, the
processing in Script objects and Sync objects that use this setting is swapped
over. This option prevents the "Generate at runtime" setting from being
deactivated.
8th digit E Avoids DB2 database problems especially when activating file transfers.
9th digit D If you activate this option, agents are no longer disconnected. Instead, a
warning is printed to the log in the frequency of KEEP_ALIVE as long as this
connection is inactive. The value KEEP_ALIVE is taken from UC_
HOSTCHAR_*.
10th digit S or A Configuration for report lengths in Sync object reports.
Checks, accesses, and modifications of Sync objects are described in detail in
the task's reports. Exact logging can negatively affect performance when many
Sync objects are in use. Use this server option to handle report lengths, thereby
improving performance. It is used to reduce the amount of LOGGING=IO for the
database to increase the speed of the Automation Engine.
S - The Automation Engine does not create Sync object reports.

N - Only Sync object modifications are logged.
A - The Automation Engine logs Sync object modifications and unsuccessful
Sync object checks in the report.
11th digit Number Extended output of time-critical database accesses in the log file.
The Automation Engine logs the bind parameters of all time-critical database
accesses whose select statements take more seconds than specified in this
server option. Any number between 1 and 9 can be specified.
Note that regardless of this setting, bind parameters will not be logged in
insert statements.
When this option is used, 3 is often recommended. This way the bind
parameter of all selects that take more than 3 seconds will be logged.
Therefore, the Automation Engine logs the BIND VARIABLES for long
running SQL statements within the LOG file without the need for a trace.
12th digit I Setting this option has the effect that no report is written for import processes.
13th digit S Alternative method for Oracle databases in order to read server messages from
the queue. This method is slower than the default method.
14th digit P This option has the effect that the output of the script statement :PRINT is also
written to the Automation Engine log if you activate the tasks
l using the "Generate at runtime" setting,

l via the script function ACTIVATE_UC_OBJECT, or
l as an alarm object.
Doing so can result in extensive 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 file transfers from or to z/OS if the source file
name includes several wildcard characters.
For example:
Source is UC4*A.AAA.AA.AAA.A????.A????.A??????
Target is UC4*
Y - The target file name is correctly built according to the wildcard characters.
After the transfer, the file UC4ZZA.AAA.AA.AAA.A1111.A1111.A111111 is
given exactly the same name.
N - The characters that start with the first wildcard until the last character minus
one are ignored. After the transfer, the file
UC4ZZA.AAA.AA.AAA.A1111.A1111.A111111 is given the name UC41.
Whatever you specify, this option is ignored in the new file transfer protocol.
Wildcards are always correctly resolved.
Activate the particular settings by inserting the respective letters in the relevant positions. The character N
is used to deactivate 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
If a ServiceManager is used, you can execute its actions directly via the AE system. The relevant
commands can either be called directly 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 for the ServiceManager
manually in the agent or Server 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
Use this setting to define the interval at which the display for the blocked workflows for SNMP is
refreshed. The default value is 10 seconds.
SQLVAR_INTERNAL
By default, the creation of Variable objects of the type "SQL - internal" / "SQL - internal SECURE" is
deactivated. This is due to security reasons, as 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 must have 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 very high value has the effect that it takes
correspondingly longer to resolve Variable objects.
This setting does not have any effect on variables of the types Filelist and Multi.
SYNC_BLOCK_COUNT
For performance reasons, log-file changes of Sync objects are performed by block. This means that the log
files of a specified 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 logs are to be changed per block.
The lower the value, the longer the process will take as a whole. However, a value that is too high can
negatively affect the performance of the AutomationEngine.
TRASHBIN_SHOW_MAX
The value that is specified here determines the maximum number of objects to be shown in the Recycle
Bin. The current date serves as the basis for this, 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 in with the privilege to view them. "N" means that the messages 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. "Y" indicates that messages are kept and displayed in
the Message Window for the next user with a suitable privilege.
Use the UNREAD_MESSAGE_BUFFER to determine the number of unread messages to be kept. The
oldest entry will be overwritten once the number of messages is 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 the AE system reboots

l the primary work process is changed
l messages are re-organized with the utility AE DB Reorg.
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.
This affects the replacement procedure of variables that are used within SQL statements (VARA types:
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
The security levels of all predefined variables are provided here.
Note for security level 3: You can execute all SQL statements and OS commands that are included in
the value to be inserted in the specified Variable object.
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 without the corresponding rights) and can also lead to
unintended 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 variables can 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 into an error while resolving the variable because
the database is not available or due to incorrect connection or login data, 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 cleared (for example, the
database name in the connection object has been corrected). The interval at which this attempt is to be
repeated is specified by the setting VARIABLE_SERVICE_CHECK_INTERVAL.
Note 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 to be shown in Version
Management. The current date serves as the basis for this, 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 be
individually specified in the corresponding objects and overrides the default value specified in the variable.
WP_MIN_NUMBER
Extra server processes (DWPs) are available for messages sent to the database by UserInterfaces.
These are special types of work processes (WP). Specify the number of server processes to act as work
processes using the entry WP_MIN_NUMBER. The remaining processes 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, as 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 for the network.
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. Use the key XML_
ENCODING to specify the encoding to be used for your AE system. The second key affects the
verification of imported XML files.
ISO-8859-15 (Latin 9) contains the Euro (€) character and Western-European country-specific special
characters. The table below lists additional differences:
Characters € Š š Ž ž Œ œ Ÿ ¤ ¦ ¨ ´ ¸ ¼ ½ ¾
ISO-8859-15 A4 A6 A8 B4 B8 BC BD BE - - - - - - - -
ISO-8859-1 - - - - - - - - A4 A6 A8 B4 B8 BC BD BE
WINDOWS-1252 80 8A 9A 8E 9E 8C 9C 9F A4 A6 A8 B4 B8 BC BD BE
OBJECT_ACCESS_CLIENT_ZERO
Setting this key's flag to Y allows users to access system client objects in READ ONLY mode. By using
the context menu in a Script object or the UserInterface you can open those objects in READ ONLY mode
to check their reports or statistics.
Also see:
UC_CLIENT_SETTINGS
Overview of all the variables in table format
Variable
3.2.27 UC_USER_LOGON - Single Logon

This variable can be used to define whether automatic logon (Single Logon) is allowed.

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

2. Specify the keys for your operating systems in the variable UC_USER_LOGON. A list of keys is
provided above. The value to be specified is always AUTO written in upper-case letters.
3. For all persons allowed to log on via Single Logon, there must be a client with a User object. User
object names must be the same as used for logging on to the operating system. Example for
Windows:
User name: Smith
Domain: UC4
In this case, the name of the User object must be "SMITH/DEV".
4. Parameters are required to start the UserInterface. These can be stored in various places (e.g. as a
link) and include the client and the AE system.
-Cclient For Windows and UNIX or Linux:
The user name is taken from the operating system. The system then searches an
AE user with that name. The department is not taken into consideration. There can
only be one user with this name, regardless of the department. If the user is found,
logon is accepted without password verification.
-Dclient Alternative parameter for -C under Windows:
The user name is taken from the operating system. The particular Windows domain
is used as the department. If the user is found, logon is accepted without password
verification.
-SAE It is crucial to indicate the name in order to enable automatic logon because there
system or can be more than one AE system. The login window is displayed if this parameter
connection is missing.
name
You can also enter the connection name which is specified in the configuration
fileuc4config.xml, XML element <connection name="Name" system="System">
instead of the AE system name.
See also:

Variable
3.2.28 UC_UTILITY_ARCHIVE - Archiving Specifications

The variable contains specifications and information concerning the archive process.
Key Value
AH Specifications for archiving statistical data
Format: flag days
Flag1 - archive statistics (TRUE - yes, FALSE - no)

Days - archive old statistics
ARCHIVSET Number of archive runs that have been processed so far. This value is also used for the
name of the archive folder.
FORMAT Date format for the output of date and time indications in the archive files.
LASTAHRH Last archiving date of statistics and reports in the format YYYYMMDD.
LASTMELD Last archiving date of messages in the format YYYYMMDD.
MELD Specifications for archive messages
Format: flag days1 days2
Flag - archive messages (TRUE - yes, FALSE - no)

Days1 - archive read messages older than specified here
Days2 - archive unread messages older than specified here
PATH Archive folder
SIZE Archive size in MB
SIZEAH Data size and duration of the last archiving run. These values serve as the basis for the
SIZEMELD forecast calculation of the next archiving run.
SIZERH
TIMEAH
TIMEMELD
TIMERH
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:

Variable
Archiving
3.2.29 UC_UTILITY_DB_UNLOAD - Executed

Reorganization Runs
This variable contains dates of the unloading process of reorganized data records.
Key Value
Running 7-digit number with leading zeros Date of executed reorganization runs
YYMMDD REORG ;tables
Affected tables: MELD,OH,AH,RH and XAO
Description
The utility AE DB Unload automatically creates and updates (if required) this variable.
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:

Variable
Unloading the Database
3.2.30 UC_UTILITY_REORG - Reorganization

Specifications
This variable contains specifications and information for reorganization.
Key Value
AH Specifications for the reorganization of statistics
Format: flag1 days flag2 number
Flag1 - reorganizes statistics (TRUE - yes, FALSE - no)

Days - reorganizes statistics that are older than the specified number of days
Flag2 - cancels statistics (TRUE - yes, FALSE - no)
Number - cancels statistics per object
MELD Specifications for the reorganization of messages
Format: flag days1 days2
Flag - reorganizes messages (TRUE - yes, FALSE - no)

Days1 - reorganizes read messages that are older than specified here
Days2 - reorganizes unread messages that are older than specified here
OBJECT_AUDIT Specifications for the reorganization of Revision Reports
Format: flag1 days flag2
Flag1 - reorganizes Revision Reports (TRUE - yes, FALSE - no)

Days - reorganizes Revision Reports that are older than specified here
Flag2 - reorganizes only audited Revision Reports (TRUE - yes, FALSE - no)
RH Specifications for the reorganization of reports
Flag1 - reorganizes reports (TRUE - yes, FALSE - no)

Days - reorganizes reports that are older than specified here.
Flag2 - cancels reports (TRUE - yes, FALSE - no)
Number - cancels reports per object
VERSION_ Specifications for the reorganization of duplicated objects
CONTROL
Flag1 - reorganizes duplicated objects (TRUE - yes, FALSE - no)

Days - reorganizes versions that are older than specified here (TRUE - yes,
FALSE - no)
Number - cancels versions per object
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:

Variable
Reorganization
3.3 Configuration & Performance
3.3.1 Configuration & Performance of the Database

DB2
Automic recommends keeping the following notes in mind when installing and operating DB2 in order to
achieve top performance.
It is important to reorganize the AE database including all clients on a regular basis. An extensive
database affects performance negatively (prolonged access times etc.).
Notes
l General
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.
l Statistics in DB2: We recommend to turn off automatic runstats in DB2 (every version) and run
runstats manually at a point in time where a typical load and a typical mix of activities are in the
system. Never run runstats when no or only a few activities are present. This would lead to
wrong/not optimal access plans and therefore to less throughput or in the worst case to deadlocks.
If you encounter deadlocks, run runstats exactly on those tables where the deadlocks occurring,
and at a point in time when you have deadlocks. In most cases this will solve the deadlocks.
l 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 Approximate size in percent

RT 40% - 60%
AH 20% - 30%
ABLOB ~ 19%
MELD 10% - 20%
AJPP 5%
RH 5%
Other tables < 1%
l Indices should regularly be reorganized.
l DB2 on UNIX/Windows
l 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 high-
performance 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 Use TCP/IP instead of Named Pipes as database connection.

l 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.
l 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 Activate "Versioning" to reduce possible deadlocks. Automic recommends storing "tempdb" on a

quick device which becomes bigger as a result of using "Versioning"
alter database database name set READ_COMMITTED_SNAPSHOT ON
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 Do not use computers with hyper-threading or deactivate hyper-threading.

l Split the database to as many files as there are CPUs.
See also:
Setting Up Database - MS SQL Server

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 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.
l 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.
Table Approximate size in percent

RT 40% - 60%
AH 20% - 30%
MELD 10% - 20%
AJPP 5%
RH 5%
Other tables < 1%
l Indices should regularly be reorganized.
See also:
Oracle Parameters
Setting Up Database - Oracle
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 Description Oracle

nt for versio
AE n
DBFIPS_140 No Enable use of 12
cryptographic
libraries in FIPS
mode

nt for versio
AE n
active_ Yes For AE in the 10, 11
instance_ RAC (alternative and 12
count backup via
SERVICE in the
RAC).
aq_tm_ No 10, 11
processes and 12
archive_lag_ No 10, 11
target and 12
asm_ Only for an ASM instance No 10, 11
diskgroup and 12
asm_ Only for an ASM instance No 10, 11
diskstring and 12
asm_power_ Only for an ASM instance No 10, 11
limit and 12
asm_ Only for an ASM instance No 11 and
preferred_ 12
read_failure_
groups
audit_file_ D:\ORACLE\ADMIN\O111\ADUMP No You can use any 10, 11
dest path. and 12
audit_sys_ FALSE No Depending on 10, 11
operations your security and 12
guidelines.
audit_syslog_ No Depending on 11gR2
level your security and 12
guidelines.
awr_ No AWR Snapshot 12
snapshot_ offset to full hour
time_offset
audit_trail DB No Depending on 10, 11
your security and 12
guidelines.
background_ partial No 10, 11
core_dump and 12
background_ D:\ORACLE\DIAG\RDBMS\O111\O111\TRA No Is deprecated as 10, 11
dump_dest CE of Oracle version and 12
11; you can use
any path.
backup_tape_ FALSE No Relevant for an 10, 11
io_slaves RMAN backup. and 12
bitmap_ No AE does not use 10, 11
merge_area_ bitmap indexes. and 12
size

nt for versio
AE n
blank_ FALSE No 10, 11
trimming and 12
buffer_pool_ Yes Is deprecated and 10, 11
keep has been replaced and 12
by db_keep_
cache_size.
buffer_pool_ Yes Is deprecated and 10, 11
recycle has been replaced and 12
by db_recycle_
cache_size.
cell_offload% No Cell Offload 12
configuration for
Exadata only
circuits Yes AE does not 10, 11
support Shared and 12
Server operations.
client_result_ Yes AE does not yet 11 and
cache_lag support the 12
feature Result
Cache.
client_result_ Yes AE does not yet 11 and
cache_size support the 12
feature Result
Cache.
clonedb No
cluster_ Yes TRUE for AE in 10, 11
database the RAC, FALSE and 12
for Single
Instance
Database.
cluster_ Yes The number of 10, 11
database_ RAC instances. and 12
instances
cluster_ No RAC interconnect 10, 11
interconnects selection. and 12
commit_ Do not set or IMMEDIATE Yes Currently, AE 11 and
logging does not support 12
the feature
COMMIT BATCH
for the Automation
Engine.
commit_ No 10, 11
point_strength and 12

nt for versio
AE n
commit_wait Do not set or WAIT Yes AE does not yet 11 and
support the 12
feature COMMIT
NOWAIT for the
Automation
Engine.
commit_write Yes Is deprecated. 10 and
11
common_ C## No Used for 12
user_prefix Multitenant
Database
compatible 12.1.0.2.0 Yes This should 10, 11
contain the and 12
current Oracle
version.
control_file_ 7 No 10, 11
record_keep_ and 12
time
control_files No 10, 11
and 12
control_ DIAGNOSTIC+TUNING No Depending on 11 and
management_ your Oracle 12
pack_access Management
Pack Licenses.
core_dump_ D:\ORACLE\DIAG\RDBMS\O111\O111\CD No You can use any 10, 11
dest UMP path. and 12
cpu_count No It is automatically 10, 11
set to the number and 12
of CPUs.
create_ No AE does not use 10, 11
bitmap_area_ bitmap indexes. and 12
size
create_ No AE does not use 10, 11
stored_ Stored Outlines. and 12
outlines
cursor_ EXACT Yes As of Oracle 10, 11
sharing version 11, you and 12
can implement
FORCE at your
own risk.
cursor_ FALSE No You can use it for 10, 11
space_for_ performance and 12
time tuning measures.

nt for versio
AE n
db_big_table_ Yes Do not set, 12
cache_ influence query
percent_ performance for
target data warehouse
workloads
db_block_ Yes AE does not 10, 11
buffers recommend using and 12
this parameter
because it has
been replaced by
the parameter db_
cache_size.
db_block_ FALSE No 10, 11
checking and 12
db_block_ TYPICAL No 10, 11
checksum and 12
db_block_ 8192 Yes Automic 10, 11
size recommends a and 12
standard block
size of 8K; the
allowed minimum
is 4K.
db_cache_ ON Yes 10, 11
advice and 12
db_cache_ Yes The required 10, 11
size buffer cache size and 12
depends on your
database size.
db_create_ No 10, 11
file_dest and 12
online_log_ and 12
dest_1
online_log_ and 12
dest_2
online_log_ and 12
dest_3
online_log_ and 12
dest_4
online_log_ and 12
dest_5

nt for versio
AE n
db_domain No 10, 11
and 12
db_file_ 32 Yes The database 10, 11
multiblock_ administrator can and 12
read_count change it for
tuning measures.
db_file_ No 10, 11
name_convert and 12
db_files No 10, 11
and 12
db_flash_ Yes Used for Smart 11gR2
cache_file Flash Cache and 12
within Oracle
Buffer Cache,
currently not
supported by AE
may be used at
own risk
db_flash_ Yes Used for Smart 11gR2
cache_size Flash Cache and 12
within Oracle
Buffer Cache,
currently not
supported by AE
may be used at
own risk
db_ No 10, 11
flashback_ and 12
retention_
target
db_keep_ Yes Automic Supports 10, 11
cache_size the use of and 12
KEEP CACHE
and
RECYCLE CAC
HE as tuning
measures.
db_lost_ No 10, 11
write_protect and 12
db_name No 10, 11
and 12
db_ No 12
performance_
profile

nt for versio
AE n
db_recovery_ No 10, 11
file_dest and 12
db_recovery_ No 10, 11
file_dest_size and 12
db_recycle_ Yes Automic Supports 10, 11
cache_size the use of and 12
KEEP CACHE
and
RECYCLE CAC
HE as tuning
measures.
db_securefile PERMITTED Yes The database 11 and
administrator can 12
change it as a
tuning purposes.
db_ultra_safe OFF No Note that you 11 and
should only 12
change this value
(other than OFF)
for
troubleshooting
purposes because
doing so can
affect the
performance of
your system
negatively.
db_unique_ No 10, 11
name and 12
db_ No 12
unrecoverabl
e_scn_
tracking
dbwr_io_ Yes For tuning the 10, 11
slaves DBWR process, and 12
you can either use
dbwr_io_slaves or
db_writer_
processes.
db_writer_ Yes For tuning the 10, 11
processes DBWR process, and 12
you can either use
dbwr_io_slaves or
db_writer_
processes.

nt for versio
AE n
defferred_ TRUE No 11gR2
segment_ and 12
creation
db_16k_ Yes AE accepts the 10, 11
cache_size use of different and 12
DB block sizes as
a tuning measure
but it does not
explicitly support
it in version
upgrades.
DB block sizes as
a tuning measure
but it does not
explicitly support
it in version
upgrades.
DB block sizes as
a tuning measure
but it does not
explicitly support
it in version
upgrades.
DB block sizes as
a tuning measure
but it does not
explicitly support
it in version
upgrades.
DB block sizes as
a tuning measure
but it does not
explicitly support
it in version
upgrades.
ddl_lock_ No 11 and
timeout 12
ddl_wait_for_ FALSE No 10
locks

nt for versio
AE n
dg_broker_ No 10, 11
config_file1 and 12
dg_broker_ No 10, 11
config_file2 and 12
dg_broker_ FALSE No 10, 11
start and 12
diagnostic_ D:\ORACLE No You can use any 11 and
dest path. 12
disk_asynch_ TRUE Yes Automic 10, 11
io recommends and 12
using TRUE
unless there are
known OS
producer
limitations.
dispatchers No 10, 11
and 12
distributed_ No 10, 11
lock_timeout and 12
dml_locks >= 500 Yes You can increase 10, 11
this value in large and 12
AE
installationations.
dnfs_batch_ Yes Max number of 11gR2
size dNFS async I/O and 12
requests queued
per session
drs_start No This parameter is 10, 11
deprecated. and 12
dst_upgrade_ No 12
insert_conv
enable_ddl_ No 11 and
logging 12
enable_ No 12
goldengate_
replication
enable_ No 12
pluggable_
database
exclude_ No Related to 12
seed_cdb_ Multitenant Option
view

nt for versio
AE n
event Yes This parameter is 10, 11
used for and 12
troubleshooting
purposes.
fal_client No 10, 11
and 12
fal_server No 10, 11
and 12
fast_start_io_ No This parameter is 10, 11
target deprecated. and 12
fast_start_ No 10, 11
mttr_target and 12
fast_start_ No 10, 11
parallel_ and 12
rollback
fileio_ No 10, 11
network_ and 12
adapters
file_mapping No 10, 11
and 12
filesystemio_ SETALL Yes Automic 10, 11
options recommends and 12
using SETALL
unless there are
known OS
producer
limitations.
fixed_date NONE Yes This parameter 10, 11
must be set to and 12
NONE.
gc_files_to_ Yes This parameter 10, 11
locks must not be set and 12
for AE in the
RAC.
gcs_server_ Yes This parameter 10, 11
processes must not be set and 12
for AE in the
RAC.
global_ No This parameter is 10, 11
context_pool_ deprecated. and 12
size
global_names No 10, 11
and 12

nt for versio
AE n
global_txn_ No 11 and
processes 12
hash_area_ Yes Automic 10, 11
size recommends and 12
using pga_
aggregate_target.
hi_shared_ No 10, 11
memory_ and 12
address
hs_ No 10, 11
autoregister and 12
ifile No 10, 11
and 12
instance_ No This parameter is 10, 11
groups deprecated. and 12
instance_ No 10, 11
name and 12
instance_ No 10, 11
number and 12
instance_type RDBMS Yes This parameter 10, 11
must be set to and 12
RDBMS.
java_jit_ TRUE No AE does not use 11 and
enabled JAVA in the 12
database.
java_max_ No AE does not use 10, 11
sessionspac JAVA in the and 12
e_size database.
java_pool_ No AE does not use 10, 11
size JAVA in the and 12
database.
java_soft_ No AE does not use 10, 11
sessionspac JAVA in the and 12
e_limit database.
job_queue_ No AE does not use 10, 11
processes DBMS_JOBS. and 12
large_pool_ No 10, 11
size and 12
ldap_ NONE No 10, 11
directory_ and 12
access

nt for versio
AE n
ldap_ No No 11 and
directory_ 12
sysauth
license_max_ No 10, 11
sessions and 12
license_max_ No 10, 11
users and 12
license_ No 10, 11
sessions_ and 12
warning
listener_ No 12
networks
local_listener Yes Make sure that 10 and
this parameter is 11
correctly
configured for AE
in order to register
the database to
the listener.
lock_name_ No This parameter is 10, 11
space deprecated. and 12
lock_sga FALSE No 10, 11
and 12
log_archive_ No 10, 11
config and 12
dest and 12
log_archive_ enable No 10, 11
dest_state_% and 12
dest_% and 12
duplex_dest and 12
log_archive_ ARC%S_%R.%T No 10, 11
format and 12
log_archive_ TRUE No This parameter is 10, 11
local_first deprecated. and 12
max_ and 12
processes
log_archive_ 1 No 10, 11
min_ and 12
succeed_dest

nt for versio
AE n
log_archive_ No This parameter is 10, 11
start deprecated. and 12
trace and 12
log_buffer 5653504 Yes Automic 10, 11
recommends and 12
using a log buffer
of at least 5 MB
and not more than
20 MB.
log_ No 10, 11
checkpoint_ and 12
interval
log_ No 10, 11
checkpoints_ and 12
to_alert
log_ No 10, 11
checkpoint_ and 12
timeout
log_file_ No 10, 11
name_convert and 12
logmnr_max_ No This parameter is 10
persistent_ deprecated.
sessions
max_commit_ 0 Yes As of Oracle 10, 11
propagation_ version 11g2, this
delay parameter is
deprecated and
cannot be used
anymore.
max_ No 10, 11
dispatchers and 12
max_dump_ unlimited No 10, 11
file_size and 12
max_ Yes This parameter is 10, 11
enabled_roles deprecated and and 12
should not be set.
max_shared_ No 10, 11
servers and 12
max_string_ STANDARD Yes Do not change! 12
size

nt for versio
AE n
memory_ 2/3 of the Server memory Yes New Memory 11 and
max_target Management 12
(SGA+PGA). The
required size
depends on the
database size. AE
recommends
using at least 1.5
GB.
memory_ 2/3 of the Server memory Yes New Memory 11 and
target Management 12
(SGA+PGA). The
required size
depends on the
database size.
Automic
recommends
using at least 1.5
GB.
nls_calendar No 10, 11
and 12
nls_comp BINARY Yes For performance 10, 11
reasons, you and 12
should only use
BINARY.
nls_currency No 10, 11
and 12
nls_date_ No 10, 11
format and 12
nls_date_ No 10, 11
language and 12
nls_dual_ No 10, 11
currency and 12
nls_iso_ No 10, 11
currency and 12
nls_language No 10, 11
and 12
nls_length_ CHAR Yes CHAR must be 10, 11
semantics set in order to and 12
support
UNICODE
databases.
nls_nchar_ No 10, 11
conv_excp and 12

nt for versio
AE n
nls_numeric_ No 10, 11
characters and 12
nls_sort Yes For performance 10, 11
reasons, Automic and 12
recommends
using the default
value BINARY.
nls_territory No 10, 11
and 12
nls_time_ No 10, 11
format and 12
nls_ No 10, 11
timestamp_ and 12
format
nls_ No 10, 11
timestamp_ and 12
tz_format
nls_time_tz_ No 10, 11
format and 12
nocdb_ FALSE No Multitenand 12
compatible Option
object_ No 10, 11
cache_max_ and 12
size_percent
object_ No 10, 11
cache_ and 12
optimal_size
olap_page_ No 10, 11
pool_size and 12
open_cursors 500 Yes AE requires at 10, 11
least 500. and 12
open_links No 10, 11
and 12
open_links_ No 10, 11
per_instance and 12
optimizer_ TRUE Yes This parameter 12
adaptive_ can be used for
featured performance
tuning purposes
optimizer_ FALSE Yes This parameter 12
adaptive_ can be used for
reporting_only performance
tuning purposes

nt for versio
AE n
optimizer_ FALSE Yes This parameter 11 and
capture_sql_ can be used for 12
plan_ performance
baselines tuning purposes
optimizer_ 2 Yes AE requires a 10, 11
dynamic_ value of >= 2. and 12
sampling Automic
recommends
using 2.
optimizer_ 11.1.0.6 Yes Automic 10, 11
features_ recommends and 12
enable using the current
Oracle version
unless you want
to deactivate
current optimizer
features
intentionally.
optimizer_ Yes You can use this 10, 11
index_ parameter for and 12
caching performance
tuning purposes.
optimizer_ Yes You can use this 10, 11
index_cost_ parameter for and 12
adj performance
tuning purposes.
optimizer_ Yes You can use this 12
inmemory_ parameter for
aware performance
tuning purposes -
In-Memory
Database Cache
Option
optimizer_ ALL_ROWS Yes AE requires ALL_ 10, 11
mode ROWS. You can and 12
change this value
for performance
tuning purposes.
optimizer_ No 10, 11
secure_view_ and 12
merging
optimizer_ No 11 and
use_invisible_ 12
indexes

nt for versio
AE n
optimizer_ No 11 and
use_pending_ 12
statistics
optimizer_ Yes You can use this 11 and
use_sql_ parameter for 12
plan_ performance
baselines tuning purposes.
os_authent_ No 10, 11
prefix and 12
os_roles No 10, 11
and 12
o7_ FALSE No 10, 11
dictionary_ and 12
accessibility
parallel_ No 10, 11
adaptive_ and 12
multi_user
parallel_ No This parameter is 10, 11
automatic_ deprecated. and 12
tuning
parallel_ No Do not adjust 12
degree%
Parameter
parallel_ No 10, 11
execution_ and 12
message_
size
parallel_ TRUE No If parallel query is 12
force_local used for some
reasons it should
stay on local RAC
node
parallel_ No 10, 11
instance_ and 12
group
parallel_io_ Yes You can use this 11 and
cap_enabled parameter as a 12
tuning measure in
combination with
I/O calibration.
parallel_max_ No 10, 11
servers and 12
parallel_min_ No 10, 11
percent and 12

nt for versio
AE n
parallel_min_ No 10, 11
servers and 12
server deprecated. and 12
server_ deprecated. and 12
instances
parallel_ No 12
server_target
parallel_ No 10, 11
threads_per_ and 12
cpu
pdb_file_ No Multitenant Option 12
name_convert
pdb_ No 12
lockdown
pdb_os_ No 12
credential
permit_92_ No 12
wrap_format
pga_ Some 100 MB Yes Automic 12
aggregate_ recommends a
limit limit of 4*pga_
aggregate_limit
and a minimum of
2GB
pga_ Some 100 MB Yes Automic 10, 11
aggregate_ recommends and 12
target 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_ No 11 and
settings 12
plsql_ccflags No 10, 11
and 12

nt for versio
AE n
plsql_code_ No 10, 11
type and 12
plsql_ No This parameter is 10
compiler_ deprecated.
flags
plsql_debug No This parameter is 10, 11
deprecated. and 12
plsql_native_ No 10, 11
library_dir and 12
plsql_native_ No 10, 11
library_ and 12
subdir_count
plsql_ No 10, 11
optimize_ and 12
level
plsql_v2_ No This parameter is 10, 11
compatibility deprecated. and 12
plsql_ No 10, 11
warnings and 12
pre_page_sga No 10, 11
and 12
processes Yes AE requires at 10, 11
least 150. and 12
processes_ No 12
group_name
query_ No 10, 11
rewrite_ and 12
enabled
query_ No 10, 11
rewrite_ and 12
integrity
rdbms_ No 10, 11
server_dn and 12
read_only_ No 10, 11
open_delayed and 12
recovery_ No 10, 11
parallelism and 12
recyclebin on No 10, 11
and 12
redo_ No 11 and
transport_ 12
user

nt for versio
AE n
remote_ No This parameter is 10
archive_ deprecated.
enable
remote_ No 10, 11
dependencie and 12
s_mode
remote_ Yes A reasonable 10, 11
listener configuration for and 12
AE in the RAC is
required in order to
ensure that the
instance can
communicate with
the Remote
Listeners.
remote_login_ No 10, 11
passwordfile and 12
remote_os_ No This parameter is 10, 11
authent deprecated. and 12
remote_os_ No 10, 11
roles and 12
replication_ No 10, 11
dependency_ and 12
tracking
resource_limit FALSE Yes No resource limits 10, 11
must be set for and 12
AE.
resource_ Yes You can use 11 and
manager_ resource 12
cpu_ management
allocation without resource
limits for AE.
resource_ Yes You can use 10, 11
manager_plan resource and 12
management
without resource
limits for AE.
result_cache_ Yes AE does not yet 11 and
max_result support the new 12
feature Result
Cache.
max_size support the new 12
feature Result
Cache.

nt for versio
AE n
mode support the new 12
feature Result
Cache.
remote_ support the new 12
expiration feature Result
Cache.
resumable_ No 10, 11
timeout and 12
rollback_ No Automic 10, 11
segments recommends and 12
using UNDO
management
sec_case_ No Parameter is 11
sensitive_ deprecated with
logon 12c
sec_max_ No 11 and
failed_login_ 12
attempts
sec_protocol_ No 11 and
error_further_ 12
action
sec_protocol_ No 11 and
error_trace_ 12
action
sec_return_ No 11 and
server_ 12
release_
banner
serial_reuse disable No This parameter is 10, 11
deprecated. and 12
service_ No 10, 11
names and 12
session_ No 10, 11
cached_ and 12
cursors
session_ No 10, 11
max_open_ and 12
files
sessions Yes The default value 10, 11
depends on the and 12
parameter
processes.

nt for versio
AE n
sga_max_ Max. 2/3 of the Server memory Yes You can use this 10, 11
size parameter for and 12
performance
tuning purposes.
sga_target Max. 2/3 of the Server memory Yes You can use this 10, 11
parameter for and 12
performance
tuning purposes.
shadow_ No 10, 11
core_dump and 12
shared_ No 10, 11
memory_ and 12
address
shared_pool_ Yes Automic 10, 11
reserved_size recommends and 12
using the
parameter sga_
target or memory_
target.
shared_pool_ Yes Automic 10, 11
using the
parameter sga_
target or memory_
target.
shared_ No 10, 11
servers and 12
shared_ No 10, 11
server_ and 12
sessions
skip_ TRUE Yes This value must 10, 11
unusable_ be set to TRUE. and 12
indexes
smtp_out_ No 10, 11
server and 12
sort_area_ Yes Automic 10, 11
retained_size recommends and 12
using the
parameter pga_
aggregate_target
or memory_target
as of Oracle
version 11.

nt for versio
AE n
sort_area_ Yes Automic 10, 11
using the
parameter pga_
aggregate_target
or memory_target
as of Oracle
version 11.
spatial_ No 12
vector_
acceleration
spfile No Automic 10, 11
recommends and 12
using SPFILEs.
sql_trace No This parameter is 10, 11
deprecated. and 12
sqltune_ No 10, 11
category and 12
sql_version No This parameter is 10, 11
deprecated. and 12
sql92_ No 10, 11
security and 12
standby_ No This parameter is 10, 11
archive_dest deprecated. and 12
standby_file_ No 10, 11
management and 12
star_ FALSE Yes You can use this 10, 11
transformatio parameter for and 12
n_enabled performance
tuning purposes.
statistics_ TYPICAL Yes You can use this 10, 11
level parameter for and 12
performance
tuning purposes.
Automic
recommends
using TYPICAL or
ALL.
streams_ No 10, 11
pool_size and 12
tape_asynch_ No 10, 11
io and 12
thread No 10, 11
and 12

nt for versio
AE n
timed_os_ No 10, 11
statistics and 12
timed_ No 10, 11
statistics and 12
trace_enabled No 10, 11
and 12
tracefile_ No 10, 11
identifier and 12
transactions Yes The default value 10, 11
depends on the and 12
parameter
processes.
transactions_ No Automic 10, 11
per_rollback_ recommends and 12
segment using UNDO
management.
undo_ AUTO Yes Automic 10, 11
management recommends and 12
using UNDO
management.
undo_ 900 Yes You required an 10, 11
retention appropriate size and 12
(depending on the
database size) in
order to archive
data with the
utility
AE.DB Archive
(i.e. without ILM).
undo_ No 10, 11
tablespace and 12
unified_audit_ No 10, 11
sga_queue_ and 12
size
use_indirect_ FALSE No 10, 11
data_buffers and 12
user_dump_ No This parameter is 10, 11
dest deprecated. and 12
utl_file_dir No 10, 11
and 12

nt for versio
AE n
workarea_ AUTO Yes Automic 10, 11
size_policy recommends and 12
using pga_
aggregate_target;
thus the value
AUTO must be
used.
xml_db_ enable No 11 and
events 12
3.3.2 Configuration & Performance of the DB Server

This document informs about performance optimization settings and general requirements for using the DB
Server.
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.
3.3.3 Configuration & Performance of the Automation

Engine
This document informs about performance optimization settings and general requirements for using the
Automation Engine.
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.
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.
3.3.4 Configuration & Performance of the UserInterface

This document informs about performance optimization settings and general requirements for using the
UserInterface.
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.
Parameters of the Command Line Program
Direct3D/DirectDraw under Windows
Java uses various DirectDraw- and Direct3D functions under Windows. With some graphic cards this can
cause refresh problems characterized by streaks or blurred edges when moving windows or scrolling
window information. Access to these functions can be partly or completely deactivated with the following
command line parameters.
In ucdj.ini:
Direct3D is not used:

cmd="javaw" -Dsun.java2d.d3d=false com.uc4.ucdj.UCDialogFactory -LE -
U%User%
Direct3D and DirectDraw is not used to buffer, for example, Swing:

cmd="javaw" -Dsun.java2d.ddoffscreen=false com.uc4.ucdj.UCDialogFactory -LE
-U%User%
Direct3D and DirectDraw are not used:

cmd="javaw" -Dsun.java2d.noddraw=true com.uc4.ucdj.UCDialogFactory -LE -
U%User%
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
Important note for the use of pcAnywhere
Set the following parameter in order to avoid adverse effects on the UserInterface's performance when
using pcAnywhere:
java -Dsun.java2d.noddraw=true -Xmx1024m -cp .;.\ucdj.jar
com/uc4/ucdf/UCDialogFactory
See also:
UserInterface (Windows), Structure of the INI file

332 | 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 DB2
l MS SQL Server
l Oracle
Configuration
l DB2
l MS SQL Server
l Oracle
Installation
l Loading Data to New Installations
l Updating the Database to a new Automation Engine version
l Changing the Database
l Encoding Passwords
l Creating an ODBC Data Source
Maintenance
l Technical Maintenance of the AE database
l Maintaining Data Records
Data
l Transporting Data
4.2 Encoding Passwords

Enter the user name and the password for database access in the INI files' section [ODBC] of Automation
Engines and utilities. For safety reasons, the password should always be encoded. This is what the
program UCYBCRYP.EXE is for.
The file UCYBCRYP.EXE is stored in the directory IMAGE:TOOLS\ENCRYPT. Use the following
parameters to enter the program via the command line:
UCYBCRYP[.EXE] -p -n Password
Chapter4 Database | 333
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.
4.3 Creating an ODBC Data Source

You can create an ODBC data source for 64 bit on a server computer, dmin computer or user computer
according to the following instructions. Call the appropriate system program via the control panel. If this
program is not available install it from the SQL Server CD.
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 SQL native 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.
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".
Now select the database.

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 32-Bit ODBC is used instead of 64-Bit ODBC.
l The check box "Use ANSI nulls, paddings and warnings" is not activated.
4.4 Database Rights for the Automation Engine

Specific database rights are required for new installations and update installations of an AE system.
After the installation process, you can remove the schema rights that are required for the database user
in order to avoid unintended database modifications.
MS SQL Server
The database user requires the role "db_owner".
sp_addrolemember 'db_owner','uc4'
Oracle
l CREATE SESSION
l CREATE TABLE
l CREATE SEQUENCE
l CREATE PROCEDURE
l EXECUTE ANY PROCEDURE
l CREATE VIEW
l CREATE PUBLIC SYNONYM
l DROP PUBLIC SYNONYM
l ALTER SESSION
l Either the system privilege UNLIMITED TABLESPACE or the tablespace quotas for all
tablespaces
l 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: CREATE TABLE
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: CREATE SEQUENCE
CREATE SEQUENCE SQ_UCDUMMY
INCREMENT BY 1 START WITH 1 MAXVALUE 999999999
MINVALUE 1 CYCLE CACHE 1000 NOORDER;
Step 3: CREATE PROCEDURE
create or replace PROCEDURE DUMMY_PROCEDURE

as
BEGIN
dbms_output.enable(buffer_size => NULL);
dbms_lock.sleep(5);
dbms_output.put_line('could start procedure');
END;
Step 4:
set serveroutput on;
ALTER SESSION:
ALTER SESSION SET NLS_DATE_LANGUAGE = American;
EXECUTE PROCEDURE, EXECUTE for the DBMS package:

execute dummy_procedure;
Use the following commands to delete the test data that has been created:
DROP TABLE UCDUMMY;
DROP SEQUENCE SQ_UCDUMMY;
DROP PROCEDURE DUMMY_PROCEDURE;
Read the White Paper "UC4.Oracle Database Security Recommendations" if you intend to use several
schema users with different rights.
DB2
l Read access to system tables such as SYSIBM.SYSTABLES,...
l Right to create tablespaces
l Right to create indexes
l Full access to the tables
Use the following command to set these rights:

grant dbadm on database UC4DB to <user>;
See also:
New Installation - Setting Up The Database

Update Installation - Details
4.5 Database Maintenance
4.5.1 Technical Maintenance of the AE Database

The AE database is a Relational Database Management System (RDMS) that administers all scheduling
data from a central point.
It contains objects, statistical data, job reports etc. In order to keep a well-performing AE database,
Automic strongly recommends maintaining it regularly.
Specific database-configuration advices are provided in the following documents:

l DB2
l MS SQL Server
l 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 CODE, HACL, HOST, IY, JBA, JFA, JPA, JPOP, JPOV, JPP, JPPA, JPPC, JPPCV,
area 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,
OVX, 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 ABLOB, ACA, ACLNT, ACMT, ACTEX, ACV, AFC, AH, AHG, AHGH, AJPCV, AJPFV,
and AJPOP, AJPOV, AJPP, AJPPA, AJPPF, AJPPO, AJPPC, AJPPV, AJPVA, APD,
Statistics APDC, APPF, ARB, AUSR, AV, AWS, LAH, LLOG, RH, RT, XAO, XRO
Forecast FE, FH, FJPP, FJPPA, FJPPC, FJPPF
Messages MELD
Processing IPH, ISTMT, ITL, MQLS, MQMEM, MQSRV, MQ1CP001, MQ1CP0.N, MQ1WP,
MQ2DWP, MQ2JWP, MQ2OWP, MQ2PWP, MQ2QWP, MQ2RWP, MQ2WP
System FIFO, IDS, INI, UC_ACLB, UC_ACLK, UC_ACLT, UC_AKTX, UC_ATYP, UC_CAR,
tables UC_CHCK, UC_DBSYN, UC_HTYP, UC_INDEX, UC_JOBQ, UC_JOBQE, UC_
JOBQT, UC_LIC, UC_MTYP, UC_OREF, UC_OTTYP, UC_OTYP, UC_OVFMT, UC_
OVGB, UC_OVTYP, UC_PLATF, UC_REST, UC_RTYP, UC_SGRP, UC_STYP, UC_
SVAL, UC_SVALF, UC_SVALM, UC_SVALU, UC_SVALV, UC_SYS, UC_TABLE,
UC_VERSI, UC_XERR, UC_ZDU, UC_ZUTYP, VERSION, XREQ
Temporary BH, BT, DIVDB, UC_TEMP, UC_TEMP1, UC_TEMP2, UC_TEMP3
tables
non-used APA, PC, UC_JBA_REST, UC_SYNTX
tables
The IMAGE:\DB\_STRUCTURE\ACCESS folder of the delivery directory contains the database

UC2003.mdb. It includes the AE database's structure and a description of the individual tables and
columns.
The AE database's structural description is also available in the form of HTML files (IMAGE:\DB\_
STRUCTURE\HTML).
Object area
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.
Statistics must only be created once. Tables do not have to be reorganized.
Temporary tables
This area is mostly empty because the tables are only filled when data has been searched and the
contents are deleted subsequently.
Do not create access statistics. Tables and indices must only be reorganized if there have been large
table movements. No regular reorganization is necessary.
Creating Statistics Once
Statistics should be created when notable data records are available. Usually, this is done with several
different data constellations. Check the effects of statistics in order to find out which ones are optimal for
your AE database.
See also:
4.5.2 Maintaining Data Records

Maintaining a database includes that data records are regularly archived and reorganized (statistics,
reports, messages etc.). The involved process has direct impact on the size of the AE database and
positively affects the performance of your AE system.
For maintaining your data records, you can either use the utilities or partitioning with ILM. The table shown
below lists the differences between these two methods:
For Utilities Partitioning with ILM

Supported MS SQL Server, Oracle and DB2 MS SQL Server and Oracle (Enterprise
databases Editions with Partitioning Feature
required)
Administrative Low Higher
effort
Usage Ideal for smaller AE databases Ideal for complex AE databases
(the more executions per time the longer (short maintenance run almost
takes the maintenance run) independent from number of job
executions per time)
For Utilities Partitioning with ILM

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 Individual configuration per client is Same configuration for all clients of the
and relevant possible AE system
settings
Archiving Via the utility AEDB Archive Via the utility AEDB Archive or Backup
of partitions
Viewing archived Via the Archive Browser Via the Archive Browser or the AE DB
data records Reporting Tool
It is also possible to transfer

partitions to a separate database
and use utilities.
Keeping the last n Possible Not possible
data records per
object
Reports Reports can be deleted before Reports are reorganized together with
statistical records are deleted the corresponding statistical records
because they are both in the same
partition.
Use exclusively utilities:
l if just a few tasks run in your AE system. This includes that there are fewer statistical records,
reports and messages.
Use partitioning with ILM:
l if lots of tasks run in your AE system. This includes that there are many data records or
l if you do not want to archive the data records. Partitions can be deleted quickly and easily.
It is still necessary to run the utilities to reorganize object versions and deleted objects as they are not
covered by partitioning with ILM.
See also:
Graphical Interface of the Reporting Tool
4.5.3 Maintaining Data Records

A lot of data accumulates during daily operation of an AE system.
This includes:
l Statistical records
l Reports
l Messages and data for the Revision Reportand the Open Interface toOutput Management Systems
Onemethod to maintain the AE database is using the following utilities:

l AE.DB Archive
l AE.DB Reorg
l AE.DB Unload
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.
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 running the 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. Unloading the data records
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.
l 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.
l 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

4.5.4 Partitioning with ILM

A remarkable amount of data accumulates during the daily operation process of an AE system.
This includes:
l Statistical records
l Reports
l 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 MS SQL Server (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.
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 UC_ILM_CONTAINER_STATISTICS for statistical records

l UC_ILM_CONTAINER_REPORT for reports
l UC_ILM_CONTAINER_MISC for messages etc.
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 (MS SQL Server), 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.
MS SQL 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. For Oracle the AE 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 variable UC_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:
l Events
l RemoteTaskManager
l 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 Cockpits
l One-time tasks
The following tasks require manual interference because no log change is made:
l Active Notification objects

l Tasks in a waiting condition (e.g. Waiting for host)
Database Rights for ILM
A database user with schema rights is required for the database actions that are necessary in order to use
partitioning with ILM. For security reasons, Automic recommends using a separate database user for ILM
actions. Create a Login object in system client 0000 and enter the database user's login data. Select the
host type "DB" and enter the Login object's name in the variable UC_ILM_SETTINGS, key LOGIN.
The database user for the ILM actions and the database user specified in the Automation Engine's INI-file
section [ODBC] need to have permission to read the following system tables:
l ALL_TAB_PARTITIONS
l ALL_CONSTRAINTS
l ALL_PART_INDEXES
l ALL_INDEXES
l ALL_TABLES
The following rights are also required for the database user for the ILM actions:
l ALTER TABLE
l DROP PARTITION
Installation
ILM installation is performed using the utility AE.DB Load when loading initial data. Install ILM:
l Through a new installation

l Through an update to Automation Engine version 8.00A or later
l Subsequently, through any initial-data hotfix within version 8.00A or later
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.
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 (MS SQL 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".
When ILM is installed, a "switch in" of records in the EH database table takes place. Do not
uncheck the "do switch in after installation" option if there are records in the EH table.
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 (MS SQL 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.
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.).
Important Note for MS SQL Server
A partition change and the corresponding switch-outs require that all indexes have been defined locally i.e.
with exactly the same rules as those used to partition the tables. Globally-defined indexes prevent switch-
outs and switch-ins.
Script
The script function ILM can be used to control particular functions.

4.6 Transporting Data
4.6.1 General Procedure

A Transport Case can be used to exchange objects between different AE systems or between clients of
the same system. The individual steps are explained below.
Procedure
1. Selection
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. You also
have the option whether or not to clean the transport folder.
Notes
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.
l You can also export and import objects in batch mode by using start parameters.
l 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=).
350 | Chapter 5 Diagnostic Tools
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 All logging/trace settings are found in the INI file (see below).
l 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).
l 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= Name of the log file Yes
[GLOBAL] logcount= Number of historical log files No (00)
[Trace] file= Name of the trace file Yes
[Trace] trccount= Number of historic trace files No (00)
[Trace] diverse Control of the trace extent No (0)
Log Files of the Utilities

If the parameter logging= is not defined, the utilities create the following log files by default:
Windows: .\UCYBDBxx_LOG_##.TXT
UNIX: ./UCYBDBxx_LOG_##.TXT
xx stands for the particular utility.
Abbreviation 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.
Chapter5 Diagnostic Tools | 351
Job States in Log Files

During the execution of jobs, messages providing information about job states are written to the logs. The
following states exist:
Job Status Description

A - Status Job ended with a return code that is not equal 0.
ended
E - Status Job ended on status ENDED_OK.
ended
R - Status This status is written to the log file periodically while the job is being executed.
running
V - Status This status only occurs when the agent cannot find a job anymore that it has started (see
vanished also: Finding Jobs after Agent Downtimes).
W - Status Job has not yet started and is in a waiting condition.
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])
Memory range Memory range to be recorded
Format: script literal or script variable
Allowed values:
"WORK_MEMORY"
"LOCAL_MEMORY"
"XML + XML Handle"
"DB + Table name( column name;column name;...)"
"DB + Table name"
"SCRIPT_VARA"
"SCRIPT_PRG"
"USER_TAB"
"CLNT_TAB"
"EX_TAB"
"*_TAB"
"GIVE_ME_ALL"
Separate several memory ranges that are to be recorded with commas.

Additional info Any text providing additional information
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 Outputs values to a trace file
TRACE_DUMP Outputs values of the memory range to a trace file
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)
Trace option Trace setting

Format: script variable or 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
The allowed values depend on the selected trace option.

Trace output Any text that serves as trace output
Return codes
"0" - The trace was successful.
"20208" - The trace level is not within the allowed range.
Comments
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).
l 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:

LOG_DUMP Outputs values of the memory range to a log file
TRACE_DUMP Outputs values of the memory range to a trace file
About Scripts
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
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 Size of the trace
The allowed values depend on the selected trace option.

Memory range Memory range that is to be recorded
Allowed values:
"WORK MEMORY"
"LOCAL MEMORY"
"XML + XML-Handle"
"DB + Table name(column name;column name;...)"
"DB + Table name"
"SCRIPT_VARA"
"SCRIPT_PRG"
"USER_TAB"
"CLNT_TAB"
"EX_TAB"
"*_TAB"
"GIVE_ME_ALL"
Separate several memory ranges that are to be recorded with commas.

Additional info Any additional text or information
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
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).
l 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:

LOG_DUMP Outputs values of the memory range to a log file
TRACE Outputs values to a trace file
About Scripts
Chapter6 Encryption and Authentication | 357
6 Encryption and Authentication
6.1 Advanced Security

The Automation Engine provides several mechanisms that can be used to protect your AE system from
unauthorized usage.
Two categories of mechanisms can be distinguished:
1. Authorization system
2. Data encryption
A detailed description of the first one is available in the Administration Guide. This document contains
detailed information about encryption.
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 Description
method
358 | Chapter 6 Encryption and Authentication
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 Company Key must be determined during the Automation Engine
installation. Subsequently, it can be exported to a file and used during agent
installation. The agents can log on to the AE system when they start the first
time but they cannot automatically be used. The administrator must release
them in the System Overview of client 0000. By doing so, the Automation
Engine automatically transfers the authentication package via the line to the
relevant agent. Only then is the agent authenticated and ready to use.
Server and agent The Company Key must be determined during the Automation Engine
installation. Some preparatory work is required to make sure that the agents
can log on to the AE system. Create an Agent object for each agent in system
client 0000. Subsequently, export an authentication package and store it on
the agent's computer for the installation. Now the agent is ready to use.
In order guarantee a top secure installation, Automic recommends

transferring the authentication package to the agent either manually or via
a secure line. Doing so ensures that potential hackers never obtain
access to the authentication package via the network.
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
ENCRYPTION which serves this purpose.
Authentication
You can specify the authentication method while installing the AE system. Subsequent modification is
also possible:
l Specifying the Authentication Method for the First Time

l Changing the Authentication Method
Compatibility
You can use former agent versions in later versions of AE (such as a 10.0.0 agent can also be used in a
11.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.
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
6.2 Specifying the Authentication Method for

the First Time
During AE system installation, you can determine the authentication method to be used in your AE
system. The utility AE.Load automatically adds the selected option to the variable UC_AS_SETTINGS,
key AUTHENTICATION.
Selecting the Authentication Method

UserInterface installation:
l Select the authentication method to be used in your AE system (wizard).
Setup installation:
l Load the initial data using the utility AE DB Load.

l Call the utility using the start parameters -T and -K in order to specify the authentication method
and the string from which the Company Key should be derived.
Updating an AE system to version 8.00A or later:
l When loading the file UC_UPD.TXT, the utility AE.DB Load 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. Install the agent with the UserInterface or use the installation guide.
2. Start the agent.
3. An Agent object is automatically created in system client 0000.
4. 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:
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".
3. Transport the file containing the Company Key to all agents.

4. Enter the path and the name for the Company Key file in the agent's INI-file parameter
InitialPackage= (Section [AUTHORIZATION]).
In the parameter KeyStore=, enter the path and name of the file in which the agent should store the
Company Key information.
You must ensure that both files are stored in a separate protected directory.
5. Start the agent.
6. The agent reads the Company Key file and stores the acquired information in the KeyStore file.
Then it deletes the original file.
7. An Agent object is automatically created in system client 0000.
8. Assign the required client authorizations in the Agent object.
9. Release the agent in the System Overview using the context menu command "Authenticate
Agent".
Server and agent:
1. Install the agent using the UserInterface or refer to the installation guide.
2. Log on to system client 0000 and create an Agent object. Its name must be the same as the one
defined in the INI-file parameter name= (Section [GLOBAL]) .
3. Assign the required client authorizations in the Agent object.
The AE.ApplicationInterface can be used to create Agent objects and assign client
authorizations very easily.
4. Open the System Overview and highlight the agent. Open the context menu command "Export
authentication package".
As of version 11, the action "Export Authentication Package" has been restricted to users in the
System client 0. Additionally a user needs the "W" permission for the Agent object to be able to
export an authentication package.
5. Transport the file containing the authentication package to the agent's computer.
6. Enter the path to the authentication package file in the agent's INI-file parameter InitialPackage=
(Section [AUTHORIZATION]).
information acquired from the authentication package.
You must ensure that both files are stored in a separate protected directory.
7. Start the agent.
8. The agent reads the authentication package file and stores the acquired information in the KeyStore
file. Then the agent automatically deletes the authentication package file.
See also:
Changing the Authentication Method

6.3 Changing the Authentication Method

Subsequent changing of the authentication method involves considerable effort. The Automation Engine
and all agents must be restarted regardless of the authentication method you select.
From "None" to "Server"

For the authentication method "Server", the agents require a file which includes the Company Key. It must
be made available to the agents' individual computers.
Procedure in detail:
1. End all agents.

2. End all server processes.
3. Call the utility AE.DB Load in batch mode in order to export the Company Key to a file. The
Company Key has not yet been set in the database.
Example: UCYBDBld -B -TPACKAGE -KUC4PROD
4. Transfer this file to all agents.
5. In the agents' INI-file parameter InitialPackage= (Section [AUTHORIZATION]), enter the path and
name of the Company Key file.
Company Key information.
We highly recommend storing both files in a separate directory which is specially protected.
6. Now set the authentication method "Server" and the Company Key in the database:
This is done by calling the utility AE.DB Load in batch mode.
Example: UCYBDBld -B -TLOCAL -KUC4PROD
7. Start all server processes.
8. 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).
10. Start all agents.

11. The agents read the Company Key file and store the included information in the KeyStore file. The
agent will then automatically delete the Company Key file.
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.
From "None" to "Server and Agent"

For the authentication method "Server and Agent", the agents require a file in which the authentication
package is stored. As this file differs for each agent, it must be generated individually and transferred to
the corresponding computers.
1. End all agents.

3. Open the utility AE.DB Load in batch mode and set the authentication method to "Server and
Agent":
Example: UCYBDBld -B -TLOCAL_REMOTE -KUC4PROD
The Company Key is now written to the database. Note that subsequently changing the Company
Key is a very complex procedure.
5. Log on to system client 0000. Open the System Overview and switch to "Agents".
6. 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".
As of version 11 the action "Export Authentication Package" has been restricted to users in the
System client 0. Additionally a user needs the "W" permission for the Agent object to be able to
export an 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.
authentication package information.
We highly recommend storing both files in a separate directory which is specially protected.
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.
Switching from "Server" to "Server and Agent"

As the agents have already been authenticated, you can easily switch from "Server" to "Server and Agent"
and vice versa.
1. Log on to system client 0000. Open the variable UC_AS_SETTINGS and set the value "LOCAL" or
"LOCAL_REMOTE" in the key AUTHENTICATION.
Agents will automatically connect after the time (in seconds) specified in the parameter
RECONNECT_TIME (see: UC_HOSTCHAR_DEFAULT).
From "Server" or "Server and Agent" to "None"

For the authentication method "None", the agents no longer require the Company Key which is stored in
the AE database. Therefore, the agents' keystore files must be deleted.
1. End all agents.

2. Log on to system client 0000. Open the variable UC_AS_SETTINGS and set the value "NO" in the
key AUTHENTICATION.
4. 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
6. Delete the KeyStore file in each agent. Its path and name are stored in the INI file, parameter
KeyStore=.
See also:
Specifying the Authentication Method for the First Time

364 | Chapter 7 Enterprise Control Center
7 Enterprise Control Center
7.1 Enterprise Control Center (ECC)

The Enterprise Control Center is an intuitive and easy-to-use web interface that can be used to access the
functionalities of various Automic applications and products.
The ECC is an individual Automic product and is available for download from the Automic Download
Center.
It is supplied as a Web application that must be integrated in a Web application server (Apache Tomcat).
Similar to the AE web interface, it is also started via the Web application server. After a successful
installation and configuration process, the ECC Web application can connect to particular components
(such as Automation Engine and the Policy Orchestrator) and execute particular commands or retrieve
information.
This concept allows users to log on to the ECC via the Web by using any computer and control and
monitor various processes in an easy way.
Examples
The following illustration describes a network structure that includes computers that use various
applications. The ECC is also used on a computer within this structure and is connected to the
applications. User 1 has logged on to the ECC via the Web and starts a task via the Service Catalog
perspective. The effect is that job JOB01 starts in the AE system "AE" and runs on the computer WIN01.
Chapter7 Enterprise Control Center | 365
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

366 | Chapter 7 Enterprise Control Center
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 Automation Platform and/or of the Policy Orchestrator.
This means that users who should use the ECC must be created in the relevant application. The
Automation Platform provides specific authorizations/privileges for the ECC that can be used to allow
users to use particular perspectives.
Chapter7 Enterprise Control Center | 367
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.
l 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.
l 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.
368 | Chapter 8 Installation
8 Installation
8.1 Supported Platforms

The first step in preparing to install or upgrade your Automic Workload Automation system is making sure
that you have the necessary infrastructure ready and required components and versions installed.
Automic Compatibility Checker

In order to install and run your intended system or update an existing one successfully you have to check
requirements and prerequisites.
Use the Automic Compatibility Checker online at this URL: http://docs.automic.com/compatibility

You will find the latest details about supported versions and other information regarding the setup or
prerequisites there.
It is a database we constantly maintain and keep up-to-date.
Please check all Automic components and prerequisites for vendor, version or setup information.
Details on necessary preparations and prerequisites you find on the pages New Installation or Upgrade
Installation.
Sizing of Automic Workload Automation Systems

Sizing an AWA system is no easy task, as a number of aspects have to be considered. To help you make
your decisions, below you find a table for different workload options and a second table containing the
most important considerations as Q&A.
The first table is meant to help you to make a quick rough estimate for your system setup. It shows
conservative results to be on the safe side.
Database systems and database storage have always to be fail safe and redundant. This section does
not deal with that question.
Modules Small Config Medium Config Big Config High End Config
CP Mem Di CP Mem Di CP Mem Di CP Mem Di
U ory sk U ory sk U ory sk U ory sk
Automat 2 4 8 GB 51 2 8 32 Gb 1 2 16 64 GB 1 4 16 96 1
ion Cor 2 x Cor TB Cor TB Cor GB TB
Engine x es GB es x es x es
Databas 4 8 GB 51 8 32 Gb 1 16 64 GB 2 16 96 2
e Cor 2 Cor TB Cor TB Cor GB TB
es GB es es es
Utilities 1 1 n/a 20 1 1 n/a 20 1 1 n/a 20 1 1 n/a 20
Cor Gb x Cor Gb Cor Gb Cor Gb
x e e x e x e
Agent n 1 n/a 20 n 2 n/a 20 n 4 n/a 20 n 4 n/a 20
Cor Gb x Cor Gb Cor Gb Cor Gb
x e e x e x es
Chapter8 Installation | 369
Service n 1 n/a 1 n 1 n/a 1 n 1 n/a 1 n 1 n/a 1

Manager Cor Gb x Cor Gb Cor Gb Cor Gb
x e e x e x e
Service 1 1 n/a 1 1 1 n/a 1 1 1 n/a 1 1 1 n/a 1
Manager Cor Gb x Cor Gb Cor Gb Cor Gb
Dialog x e e x e x e
User n 1 8 GB 20 n 1 8 GB 20 n 1 8 GB 20 n 1 8 GB 20
Interface Cor Gb x Cor Gb Cor Gb Cor Gb
x e e x e x e
Enterpri 1 4 8 GB 20 1 8 16 GB 20 1 8 16 GB 20 1 8 32 GB 20
se Cor Gb x Cor Gb Cor Gb Cor Gb
Control x es es x es x es
Center
Number
of
Users < 10 < 50 < 200 > 200
Agents < 20 < 100 < 1 000 > 1 000
Object < 1 000 < 50 000 < 100 000 > 100 000
definitio
ns
Total < 350 000 < 700 000 < 1 500 000 > 1 500 000
Executi
ons per
day
Adjustments - Questions and Answers
After you have got a rough estimation of what to expect, there are some additional aspects to be taken into
consideration, which may affect the sizing. Below you find a list of possible questions and the appropriate
answers concerning system sizing for different scenarios.
Question Sizing Adjustment

General
Is the expected load distributed over Normal: -
the day evenly or do you expect high Even: Reduce resources
peaks? High Peaks: Add resources (cores, WP's)
Is excellent performance important No: -
even in periods of peak load? Yes: Add resources (cores, WP's)
Is the expected load constant or do you Constant: -
expect growth? Growth: Consider next sizing level
How long do you need to hold data > 12 month: Add more database storage
(statistics, job reports, revision reports) < 3 month: Reduce database storage
in the database?
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? Yes: Plan how to deal with switched out data
No: Run the UC4.DB Reorg Utility as near as possible to the
database and add storage for output data (if generated)
Do you plan to use Oracle as database Yes: Add resources on the database node(s) (faster CPU's,
system? faster network, ... )
What hardware to you plan to use for Linux/Windows on Intel x64: -
the AE system? Others: Add resources
Do you plan to run the AE/database on Yes: Make sure that computing power is guarantied for you
virtual nodes? systems and other Virtual Machines do not detract from the
computing power/bandwidth.
Is logging and trace ability over a longer Y: -
period important for you? N: Reduce local disk storage on AE
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.
Performance during a failure situation Example:
(e.g. one node fails): Are the remaining A two node system has to be oversized by 100% to be able to
node(s) able to handle the load? 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 No: -
agents? Yes: Add resources to those nodes. Take care that resources
used by your jobs are available.
Do you plan to run many agents on a No: -
single node (e.g. SAP, WebService,...) Yes: Add approximately 1 GB per Java based agent to those
nodes. (An average used java agent will need between 512-
1024 MB, but in some cases this may be more.)
User
Do you have many users, who are No: -
constantly monitoring activities and Yes: Add more resources to dialog work processes and ECC
workflows? (run more DWP's and take care that cores and memory are
available for this additional load).
Do you expect huge workflows (> 1000 No: -
tasks per workflow)? Yes: Add memory to AE/UI/ECC (expect 1-2 GB per DWP)
Do you expect huge xml No: -
imports/exports? Yes: Add memory to AE/UI/ECC (expect 1-2 GB per DWP)
Do you expect to have users in different No: -
locations (long distance)? Yes: Run multiple ECC instances at every location (e.g. on
every continent, where users are located).
8.2 New Installation
8.2.1 ONE Installer - Single-Box Installation

The ONE Installer allows a fast single-box setup for demonstrations, testing, or feature previews on-site.
Prerequisites are kept to a minimum (for example a database and user, a local login and free local ports are
required).
The installer is available for Automic Workload Automation (AWA) as well as for Application Release
Automation (ARA).
The following contains an overview of the steps the ONE Installer will pass and the necessary user
interactions for a few individual steps.
Updating from previous AE or ARA versions is not supported.
Requirements
Component Requirement
Operating Systems Windows: Windows Server 2012, 2012 R2
Linux: RedHat Enterprise Linux 5, 6
SuSE Linux Enterprise Server 11
Database Microsoft SQL Server 2012, 2014

Oracle 11.2, 12c
Ports The following ports and port ranges need to be free respectively:
2217-2221 (for CP connections)

2270-2279 (for WP connections)
8005, 8009, 8080 (for Tomcat connections used by the ECC)
8871 (ServiceManager)
Prerequisites
You have to prepare the following before starting the ONE Installer:
l Store the Automic license file on your machine and point the installer to it as soon as it is requested.
l Install the database driver for the database that you will use on the same host that the installer will
be executed on:
l Oracle: Oracle Database Client
l MS SQL: SQL Server Native Client 11
l Download the JDBC driver for the database you are using (Oracle, MS SQL Server).
l Create AE databases and users: You need a new, empty AE database and a new, dedicated user
with dbowner permissions.
Please observe database pre-requisites described in MS SQL Server or ORACLE.
l In the profile configuration of an Oracle DB (SQLNET.ORA) in the parameter
NAMES.DIRECTORY_PATH enter ezconnect to the list of values.
l The AE connects to the database via TCP/IP, so you need to make sure that your server and client
have TCP/IP connection enabled. For an MS SQL Server, use the MS SQL Configuration Manager
to configure this.
l User name and password of a local user account.
On Windows: Make sure you do not have a Windows service for the ServiceManager registered prior to
running the installation.
On UNIX: You must execute the installer with root privileges.
On Windows: You require administrative rights to execute the installer.
On UNIX: Executing the installer from network shares with NFS is not recommended.
The Automation Engine utility is linked against 11G OCI client. If you are using a different Oracle client
version, you must create a SYM LINK for 11G like ln -s libclntsh.so.xx.x libclntsh.so.11.1, where
xx.x is your Oracle client version.
Installed Packages and Components:

Additional Action packs and/or RA solutions will be installed, if present. The contents of packages is
determined by Automic and may vary between releases.
The ONE Installer installation provides the following:
l AE (5xWP/2xCP/1xJWP)
l ServiceManager (all processes will be managed through the ServiceManager)
l ServiceManager dialog (Windows only)
l UserInterface
l ECC
l Utilities
l Oracle Java
l Tomcat
l Package Manager
l Local OS Agent
l RA WebService, FTP, JMS (will be installed, if present)
The installation will set up an AE system with additional client and user account besides the system
client.
During the attended mode and the CLI mode installation you will be asked to enter the necessary
information.
The ONE Installer creates a log file in the root installation folder (e.g., C:\Automic\install.log).
Post-installation Task (Optional)

As a performance enhancing task you can change Max Perm Size and Heap Size of your Tomcat prepared
by the ONE Installer as described in Installing and Preparing the Apache Tomcat Web Server.
Available Installation Modes

I. Attended installation using the graphical user interface.
II. Unattended installation using a file containing the required information.
III. Command line interface installation
I. Attended Mode:
1. Unzip the delivered files to a local directory of your choice and start the installer using
install.exe /install.sh
The installer will automatically install all components you downloaded and unpacked, depending
on the packages present.
2. After starting the installer, the second screen will display the installation overview.
3. The ONE Installer checks, if the preconditions are fulfilled.

On the left hand side of the pane you see a short list of the installation steps.
If the ONE Installer finds discrepancies, it will attempt to fix the preconditions.
4. You will be asked to define the database you chose to install (MS SQL or Oracle).
5. The installer will then check whether the necessary database drivers are present.
6. You will be asked to point the installer to the JDBC driver of your database.
Use the provided download link, if you need to download the latest version.
Point to JDBC (example for Microsoft, if MS SQL has been selected as database before).
7. Enter the database connection values for the AE database.

You can test the connection using the button provided. ONE Installer will test the connection
automatically as soon as you click 'Next'.
8. Decide in which directory the files should be installed. The default is C:\Automic, but you can
change that to any local path.
Spaces in paths are not allowed, so take care to define a path without spaces.
9. Point to the path of your license file you got from Automic.
10. You will be asked to confirm the license information pertaining to the external software (e.g. Oracle
Java) that will be installed.
11. Enter the client data for the first client the ONE Installer will create.
Choose a client number between 0001 and 9999 (0000 is reserved for the system client), a user
name, the department and a password.
12. Enter the credentials which the agent should use to execute jobs on the machine on which the
ONE Installer is running and the Automation Engine will be installed.
Take care to enter the correct user credentials, as the information will not be checked in this
step.
13. The installation will start and a progress bar and information about the installation progress will be
visible.
After successful installation, the ECC login page opens in your default Internet browser. Log in with
the user credentials that you specified during the installation.
II. Unattended Mode

In order to use the installer in unattended mode, you can start the installation and use a
configuration file.
Call it by using the following arguments in the directory you extracted the files to:
On Windows: install.exe –q –varfile <path-to-varfile> -dir <path-to-installation-directory>

On Linux: install.sh –q –varfile <path-to-varfile> -dir <path-to-installation-directory>
You can choose name and extension of the varfile. Defining an installation directory path is
optional.
Special characters have to be escaped out, as shown below.
The parameters have to be entered and used as shown in the example.
Example .varfile
JDBC_DRIVER_JAR=C\:\\app\\oracle12c\\product\\12.1.0\\dbhome_
1\\jdbc\\lib\\ojdbc7.jar
DB_SERVER$Integer=1
DB_CODESET$Integer=0
DB_DATABASE=aedb
DB_HOST=localhost
DB_PORT=1521
DB_USER=aedbuser
DB_PASSWORD=aedbpassword
CLIENT=100
USERNAME=AUTOMIC
DEPARTMENT=AUTOMIC
PASSWORD=AUTOMIC
LOGIN_USER=automationuser
LOGIN_PASSWORD=automationpassword
LICENSE_FILE=C\:\\path\\path\\licence.txt
The .varfile Parameters:
Name Description
DB_SERVER Type of the database server to use.
0 : Microsoft SQL-Server

1 : Oracle
DB_HOST Name or address of the database server that the new AE installation
should use.
DB_PORT IP port that is used to connect to the AE database.
DB_DATABASE Name of the database (MSSQL) or SID/Service-Name (Oracle) that the AE
installation should use.
DB_ This setting is only used for installations that use an Oracle database (DB_
CODESET$Integer Server = 1).
0 : UTF-8
1 : ISO-8859-15
DB_USER Name of the database user in the AE database.
DB_PASSWORD Password of the database user in the AE database.
JDBC_DRIVER_ Location of a JDBC driver file that should be used to connect to the AE
JAR (and Application Release Automation) database.
This file has to match the choice in DB_SERVER and the installed
database and Java versions.
LICENSE_FILE Location of the Automic license file that should be used by the newly
installed system.
CLIENT Client number of the AE client that is created by the installer.
USERNAME User name of the AE user that is created by the installer. (Use AE allowed
characters.)
DEPARTMENT Department of the AE user that is created by the installer. (Use AE allowed
characters.)
PASSWORD Password of the AE user that is created by the installer.
LOGIN_USER User name for a login object that will be used by the OS agent. This should
match an user account on your local system.
LOGIN_ Password for the user account specified in LOGIN_USER.
PASSWORD
III. Command Line Mode

The installation steps will be the same as in GUI mode. You will have to enter the required information
or confirm actions, using the displayed commands or options.
1. In order to start the installer, in Windows (or Linux) open a command line window in the directory
you unpacked the files to and then use the following commands:
Windows: start /wait install.exe -c
Linux: install.sh -c
2. A short installation overview will be displayed.
3. The installer then will check if preconditions have been fulfilled and attempt to fix them, if
discrepancies exist.
4. Define the database that you installed (MS SQL or Oracle).
5. Point the installer to the JDBC driver of your database.
6. Enter the connection values for the database.
7. Choose the installation path. Default is C:\Automic, but you can define a path of your choice.
Spaces in paths are not allowed so take care that the installation path does not contain spaces.
8. Point the installer to your license file you received from Automic.
9. Confirm the license information pertaining to the external software (Oracle Java) that will be
installed.
10. Enter the client data for the first client the ONE Installer will create.
Choose a client number between 0001 and 9999 (0000 is reserved for the system client), a user
name, the department and a password.
11. Enter the agent's credentials to execute jobs on the machine on which the ONE Installer is running
and the Automation Engine will be installed.
Take care to enter the correct user credentials, as the information will not be checked in this
step.
12. The installation will start, and after successful installation, the ECC login page opens in your default
Internet browser.
Login with the user credentials that you specified during the installation.
The system that has been installed is a basic Automation Engine system.
For high redundancy or more sophisticated setups please continue with the additional pages of the
installation chapter.
Comments
The installation sets up the ServiceManager to be started automatically on system boot as a Windows
Service or Linux daemon script. All other Automic processes are then automatically started by the
ServiceManager. It is possible that not all processes can be started at boot time.
Example:
Tomcat cannot start because another process has already reserved the required port 8080, which
results in the ECC not being available. In order to check that all processes could be started, do one of
the following:
l Start the ServiceManager Dialog and check if any processes are marked red.
l Open the ServiceManager log file and look for errors.
The Service Manager log file can be found in the ServiceManager ./temp directory.
8.2.2 Prior to Installation

Introduction
Welcome to the AE installationation Guide. The following chapter explains the installation and operation
principles of your AE system.
Different environments will require use of different components, each with its own installation procedure.
The main installation areas are:
1. Installing the components

2. Creating Clients and Users
3. Configuring the AE system
4. Creating an Authorization System
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
Information about the computers in the Automation Engine environment and their file structure are included
below.
Computers in the Automation Engine Environment
The following computers are required to install Automation Engine:
l DB computer: The computer where the database is installed.

l Server computer: The computer where the Automation Engine Server processes are installed.
l Admin computer: The computer used by an administrator. Database administration must also be
installed on this computer (such as utilities, including the SQL Enterprise Manager and ISQL_w for
MS SQL Servers).
l User computer(s): Computers where Automation Engine users work.
l Host(s): The controlled and monitored computers where Automation Engineagents are 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 DB computer = Server computer (recommended)

l DB computer = Server computer = Admin computer
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.
Automic strongly recommends installing the individual components (such as Automation Engine,
UserInterface, utilities, and particular agents) in separate directories, in order to avoid conflicting library
files.
File Structure
The file structure shown below is created by default if you use the folders that are suggested in the
Windows setup programs:
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.
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:
Files that are downloaded from the Automic Download Center 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.
New Installation Procedure

The following table lists the individual steps that are required for a new installation of the Automation
Platform. The list is lengthy because of the numerous systems and platforms that are supported. Automic
recommends printing this table and highlighting the components that are required in your AE system.
Base components must be installed in any case. Keep the order shown below.
Check Step Computer Must UserInterface

Base Components
Setting up the database (DB2) DB/Server/Admin yes
Setting up the database (MS SQL Server)
Setting up the database (Oracle)
Installing the utilities (UNIX) Admin 1) (Windows)
Installing the utilities (Windows)
Loading the database and license Admin yes
Installing the Automation Engine for UNIX Server 2) (Windows)

Installing the Automation Engine for Windows
Distributed Server Environment

Installing the UserInterface (UNIX) Admin/User 1) (Windows)
Installing the UserInterface (Windows)
Installing the online documentation Admin/User yes (Windows)
Agents
Installing the agent for BS2000 Host no
Installing the agent for Databases Host no
Installing the agent for GCOS8 Host no
Setting up the agent for Java EE/JMX Host no
Setting up the agent for Java EE/JMX (Oracle

WebLogic)
Setting up the agent for Java EE/JMX (IBM
WebSphere) with RMI Connector
Setting up the agent for Java EE/JMX (IBM
WebSphere) with SOAP Connector
Setting up the agent for Java EE/JMX (JBoss)
Setting up the agent for Java EE/JMX (Oracle
Containers for Java EE)
Setting up the agent for Java EE/JMX (SAP
NetWeaver)
Setting up the agent for Java EE/JMX (Tomcat)
Installing the agent for NSK Host no
Installing the agent for OS/400 Host no
Installing the agent for PeopleSoft (UNIX) - Basics Host no

Installing the agent for PeopleSoft (UNIX) - Details
Installing the agent for PeopleSoft (Windows) -
Basics
Installing the agent for PeopleSoft (Windows) -
Details
Installing the agent for Rapid Automation Host no
Installing the agent for SAP (Windows) - Basics Host no (Windows)

Installing the agent for SAP (Windows) - Details
Installing the agent for Siebel (Windows) Host no
Installing the agent for UNIX Host no
Installing the agent for VMS Host no
Installing the agent for Windows Host no

Installing the agent for z/OS Host no
Additional components
Installing the ServiceManager (UNIX) Server/Host no (Windows)
Installing the ServiceManager (Windows)
E-mail connection Server/Host no
Installing the CallAPI for BS2000 Host no

Installing the CallAPI for GCOS8
Installing the CallAPI for Java
Installing the CallAPI for NSK
Installing the CallAPI for z/OS
Installing the CallAPI for OS/400
Installing the CallAPI for SAP
Installing the CallAPI for UNIX
Installing the CallAPI for VMS
Installing the CallAPI for VSE
Installing the CallAPI for Windows
AE.Connect for WebSphere MQ (Windows) Server/Host no
Installing the AE.ResourceAdapter Host no

(IBM WebSphere)
AE and Cluster Host no
AE system in Windows Cluster
1) To be installed on at least one platform (UNIX or Windows).

2) Either on UNIX or on Windows. The computers on which the server processes are installed must use
the same platform in order to facilitate multi-server operation (e.g. 2 computers with HP/UX). A
combination of computers with different UNIX derivatives or a mixture of UNIX and Windows is not
possible.
8.2.3 Installation Procedure

Setting Up the Database
DB2
This guide includes the individual steps that are required to set up an DB2 database for AE usage.
Important: Automic recommends carefully reading the relevant notes about optimizing the AE
database's performance before you start setting up the database.
See:Configuration & Performance of the Database, the Automic Compatibility Checker for details on
supported versions and platforms and the general information in Supported Platforms.
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.
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 A 64-bit client must be installed.

l Install the appropriate DB2 client software on the Automation Engine computer in order to enable
access to the database. It is important to note that the CAE version must correspond to the
database version.
l Install DB2 for UNIX and Windows with the following options:
l 8, 16 and 32 KB page size for specific codes
l USER temp and system space must be 8K and 32K
l Create the AE database with an ASCII code table (code set 819 for ISO8859-1, code set 923
for ISO8859-15) instead of a Unicode table. Note that the default is UTF-8 (Unicode).
l Create a buffer pool of 8K and one of 32K. For each of the two page sizes, set up a system
temp and a regular tablespace.
l A temporary system tablespace of 32k must be available.
l Set up the ODBC string in a way that the database can only be accessed by using a valid user ID.
l The module DBMS_LOB has to be installed.
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 ;
DB2 for UNIX or Windows

l Special requirements:
SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=DB2CLI;UID=uc4;PWD=--
1018A94DA12E7FA991
The following parameters can improve performance for DB2 on UNIX/Windows:

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).
l LOCKLIST to 10240
l LOGBUFSZ to 2048
l APPLHEAPSZ at least to 2048
l PCKCACHESZ to 256
l CATALOGCACHE_SZ to 128
l 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.
l DB2_EVALUNCOMMITTED to ON
l DB2_SKIPINSERTED to ON
l DB2_SKIPDELETED to ON
These parameters can be called using the command "get dbm cfg" which requires no
authorizations.
l Setting up DB2 alias on CAE client:
l Setting for the DB2 code page:
db2set db2codepage=819
Login with DB2 Admin:

db2
catalog tcpip node <servername> remote <servername> server 50000
catalog database <db-name> as <alias-name> at node <servername>
quit
l Definition of tablespaces:
l Create tablespaces of page size 8, 16 and 32 KB.
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.
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.
Disk Space Required

Test systems: 1 GB
Production systems:
Procedure
1. Requirements
l DB computer
l MS SQL Server must be correctly installed and ready to run
l 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. Setting up the database
l DB computer
l Start SQL Server if it has not already been started (ServiceManager).
l Start the SQL Server Database Management program.
l 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).
3. Creating a database user
l DB computer
l Create a new user called "AE" in the SQL Server Enterprise Manager (in the "Security" folder).
l 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.
l 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.
l The Database user must also have permissions to execute Stored Procedures whose names start
with "UC_".
4. Setting up the Data Source
l Admin computer
l Set data source AE for ODBC access (64 bit ODBC)
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.

Test systems: 1 GB
Production systems:
Code-Page setting
The code-page setting of the DB client must comply with the settings made in the database.
You can choose from either of the following three code pages, whichever best fits your needs:
WE8ISO8859P1, WE8ISO8859P15 and WE8MSWIN1252.
The choice depends on the characters you need to store in the database.
As WE8ISO8859P1 doesn't support the euro sign (€), WE8ISO8859P15 seems the better choice.
WE8MSWIN1252 supports not only the euro sign, but additional characters as well. So if you set your
database up from scratch, this would be the recommended code page.
Please also refer to ORACLE's own support document no. 264294.1 dealing with the choice of code
pages.
If you have your database already set up using WE8ISO8859P1 and you don't need the additional
characters, there is no need to convert the database to a new character set.
Database settings can be queried as follows:
SELECT * FROM NLS_DATABASE_PARAMETERS
Specifying code-page setting:
Windows: Set HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\...\NLS_LANG in the registry

according to the database setting.
UNIX: The environment variable NLS_LANG can be set as shown below:

NLS_LANG =<NLS_LANGUAGE>_<NLS_TERRITORY>.<CHARACTER SET>;export NLS_
LANG
For example:
NLS_LANG=AMERICAN_AMERICA.WE8ISO8859P15;export NLS_LANG
Code-page settings can also be specified in the INI files of components (section [ODBC]).
Procedure
1. Requirements
l DB computer
l A 64-bit client must be installed.
l 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.
l Enter the database name in the file TNSNAMES.ORA.
l 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.
l The package DBMS_LOB has to be installed.
Oracle UTF-8 and the Automation Engine

l The Automation Engine functions using ANSI/ASCII code and supports neither UniCode nor UTF-
8. 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.
l A database User ID for AE with sufficient authorizations is required.
2. Definition of tablespaces
l DB computer
l Automic recommends facilitating unlimited extensions (MAXEXTENTS) instead of limiting them.
l Tablespace sizes can be adjusted individually (minimum 1 GB UC4_DATA, 500 MB UC4_INDEX
for a test environment).
l Tablespace administration by ASSM (Automatic Segment Space Management): SEGEMENT_
SPACE_MANAGEMENT=AUTO.
l 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

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.
l Automic strongly recommends using the tablespaces UC_INDEX and UC_DATA only, as
otherwise you would have to manually adjust all SQL files during the upgrade process.
3. Creating a database user
l DB computer
l Automic recommends creating an additional database user for AE. This user must have the
required privileges.
4. Amending storage parameters for large tables
l DB computer
l 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.
l 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,
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. Defining the roll-back segment

l DB computer
l 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 Valid user ID for installation (UC4)
Supplied Files
Utility files are supplied in compressed tar-file format (util???.tar.gz), and can be 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
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. Installing the Java Runtime Environment (JRE)
This installation step can be ignored if the required version of JRE is already installed.
l Admin computer
l 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.
l Download the required Java Runtime Environment from http://java.sun.com and install it.
2. Unpacking theTAR file and setting up the system environment
l Admin computer
l Copy the TAR file util???.tar.gz to a directory (such as UC4/utility) via FTP.
l Log on using the user ID UC4.
l Switch to the directory used for the utilities:
cd utility
l Unpack the tar file:
gzip -d util???.tar.gz or gunzip util???.tar.gz
tar xvfo util???.tar
l The files are created in their corresponding directories as the file is unpacked. The tar file can be
deleted after unpacking.
l Pay special attention to tar messages, which can result from different owners, and verify that all
files are correctly unpacked.
l 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
user (such as root).
chown UC4 * changes the owner of all files to UC4.
chgrp Group name * changes the user group of all files.
l Setting environment variables in $HOME/.profile. For Oracle:
Sample for AIX:
l ORACLE_HOME=/usr/oracle; export ORACLE_HOME

UC4=/opt/uc4/utility; export UC4
PATH=.:$ORACLE_HOME/bin[:$PATH]; export PATH
LIBPATH=.:$UC4/bin:$ORACLE_HOME/lib:/usr/lib:/lib[:$LIBPATH]; export LIBPATH
Sample for HP-UX:
l ORACLE_HOME=/opt/Oracle; export ORACLE_HOME

SHLIB_PATH=.:$UC4/bin:$ORACLE_HOME/lib:/usr/lib:/lib[:$SHLIB_PATH]; export
SHLIB_PATH
Sample for Linux, Solaris and zLinux:
l ORACLE_HOME=/oracle/product/9.0.1; export ORACLE_HOME

LD_LIBRARY_PATH=.:$UC4/bin:$ORACLE_HOME/lib:/usr/lib:/lib[:$LD_LIBRARY_
PATH]; export LD_LIBRARY_PATH
l Set environment variables in $HOME/.profile. For DB2:
Sample for AIX:
l DB2DIR=/usr/lpp/db2_06_01;export DB2DIR
DB2INSTANCE=db2inst1;export DB2INSTANCE
PATH=.:$DB2DIR/bin[:$PATH]; export PATH
LIBPATH=$UC4/bin:$DB2DIR/lib:usr/lib:/lib[:$LIBPATH]; export LIBPATH
Sample for HP-UX:
l DB2DIR=/opt/IBMdb2/V6.1; export DB2DIR

SHLIB_PATH=$UC4/bin:$DB2DIR/lib:/usr/lib:/lib[:$SHLIB_PATH]; export SHLIB_PATH
Sample for Linux, Solaris and zLinux:
l DB2DIR=/opt/IBMdb2/V7.1;export DB2DIR
DB2INSTANCE=db2inst1;export DB2INSTANCE
LD_LIBRARY_PATH=$UC4/bin:$DB2DIR /lib:/usr/lib:/lib[:$LD_LIBRARY_PATH]; export
LD_LIBRARY_PATH
3. Adjusting the INI Files to the System Environment
l Admin computer
l The INI files and the corresponding utilities share the same name. Adjust the INI file entries as
needed.
l AE DB Archive (UCYBDBAR.ini)
l AE DB Client Copy (UCYBDBCC.ini)
l AE DB Load (UCYBDBLD.ini)
l AE DB Reorg (UCYBDBRE.ini)
l AE DB Revision Report (UCYBDBRR.ini)
l AE DB Unload (UCYBDBUN.ini)
l AE DB Reporting Tool (UCYBDBRT.INI)
4. Starting the Utilities
l Admin computer
l 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
Installing Utilities (Windows)
This document guides you through the new installation of the utilities (Windows).
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
Note that as of Automation Engine version 8.00A, the file names of all utilities have been changed to
lowercase letters.
Procedure
l Admin computer
l 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.
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. It can
be deactivated in the system control because AE does not require it.
2. Installing the Microsoft Visual C++ 2010 Re-distributable Package
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
l Install the package from the IMAGE:CRTS directory.
3. Installing the utilities

l Admin computer
l Start the program SETUP.EXE in the corresponding subdirectory of IMAGE:UTILITY\WINDOWS.
l Automic strongly recommends installing the utilities in a separate directory (such as

C:\AUTOMIC\UTILITIES).
4. Adjusting the INI files and setting up the system environment
l Admin computer
l The INI files and the corresponding utilities share the same name. Adjust the INI file entries as
needed:
l AE.DB Archive: UCYBDBAR.ini

l 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 Reporting Tool: UCYBDBrt.ini
l AE.DB Revision Report: UCYBDBRR.ini
l AE.DB Unload: UCYBDBUN.ini
l 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.
l Use the following parameters in order to specify the program via the command line:
UCYBCRYP[.EXE] -p -nPassword
l The file Password.ucc is created in the directory of the program that contains the encoded
password.
5. Calling the DLL from a freely selected path (optional)
l Admin computer
l 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.
l 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. Starting the utilities
l Admin computer
l 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 C-
Runtime Library.
See also:
Configuring the Debugger for potential program failures
Loading the AE Database

The delivery directory provides many versions of SQL scripts and database files in the DB directory. If the
term <vers> is shown in the document, select the version you want to install.
1. Copying files in order to load the database
l Admin computer
l The files for the AE database are stored in IMAGE:DB. Copy the complete DB folder to the
directory "Utility".
l The DB directory must be stored at the location that has been specified using the INI-file
parameter INPUT of the utilityAE DB Load. The folder that includes the BIN directory of the utilities
is the default folder.
Example for Windows:
l Utilities in C:\AUTOMIC\UTILITY\BIN
l Database files in C:\AUTOMIC\UTILITY\DB
l Utilities - Windows:
The files for the AE database are provided in IMAGE:DB. Copy the complete DB folder to the above
directory.
l 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. Generating the database
l Admin computer
l Start the program AE DB Load in order to load the database.

l Select the file <DB directory>\DB\GENERAL\<vers>\UC_UPD.TXT
l A database scheme is created in the database, and the INITIAL and DEFAULT data are loaded.
3. Selecting the authentication method
l Admin computer
l 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. Installing partitioning with ILM (optional)
l Admin computer
l A mask opens in which you can select the settings for partitioning with ILM. This step is optional.
l Note that you cannot undo an AE database partitioning process.
5. Loading the licenses
l Admin computer
l Start the program AE DB Load in order to load licenses.

l Select the file Customer number.TXT that is provided by Automic Support. The utility enters the
licenses in the AE database.
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_ Deletes all AE tables.
ALL.SQL
Use this SQL file when the installation could not complete successfully (for example, if
there was not enough hard drive space). If not all tables could be created, this file deletes
all tables that cause error messages. Check them or ignore them if no action is required.
UPD_ For manual statistics updates.
STAT.SQL
Installing the Automation Engine
Installing the Automation Engine for UNIX
This document guides you through the new installation of a Automation Engine for UNIX.
The Automation Engine for UNIX is available for different platforms; a three-figure code is supplied for
each supported UNIX platform. The codes are the same as for agents and are described in the
terminology. In this document, the specific code is replaced by the characters "???." This document
describes the installation of the Automation Engine for Oracle and DB2 databases. Specific differences
are described in the individual processing steps.
Automic strongly recommends installing the Automation Engine in a separate directory (such as
/opt/uc4/server).
Requirements
General:
l Root authorization during the installation. Not required for operating the Automation Engine.
l After installation, rebooting the UNIX System is NOT necessary.
l Own UNIX user ID for the Automation Engine (default: uc4, Home = /opt/uc4, Shell: ksh). The shell
is only necessary during installation.
l For Solaris: The most current patch cluster for Sun OS has been installed.
l The file syntax.bin must be stored in the same directory as the INI file.
l Adhere to the note that describes processes on AIX.
l Keep in mind that the size of Core files on AIX must be extended.
When using an Oracle Database:
l Functioning Oracle installation (sqlplus access to the database must be possible)

l User ID for the Oracle database
When using a DB2 Database:
l Functioning DB2 installation

l User ID for the DB2 database
l Check or assign authorizations:
Open the Control Center and select the right host. Select the database for AE and click "User and
Group objects." Selecting "User" lists all users in the window on the right. Use the context menu to
open the authorization window of the required user.
At least the following options should be activated in the Database tab:
l Connect database
l Create tables
l Create packages
l Create schemas implicitly.
l The LANG variable of the user who starts the Automation Engine should be identical to the variable
DB2CODEPAGE in order to avoid problems at Server start.
Supplied Files
Data for the Automation Engine for UNIX is supplied in compressed form. The relevant tar file can be found
in one of the appropriate UNIX platform subdirectories: IMAGE:AUTOMATIONENGINE\UNIX\.
UCS???.tar.gz ( Automation Engine files).
Procedure
1. Installing the Automation Engine

l Server computer used with an Oracle database

l Log on as "AE".
l Create the directory /opt/uc4/server.
l Transfer file ucs???.tar.gz from /cdrom/cdrom0/<version>/AutomationEngine/unix/<platform> with
ftp (binary) to the created directory.
l Unpack the tar file using one of the following commands:
gzip -d ucs???.tar.gz
gunzip ucs???.tar.gz
tar xvf ucs???.tar
l Set the environment variables in $HOME/.profile if the Automation Engine does not run on the
same computer as the utilities. Further details, including an example, are available in the
installation guide for the utilities.
l Rename the file ucsrv.ori.ini to ucsrv.ini:
mv ucsrv.ori.ini ucsrv.ini
l Adjust the INI file ucsrv.ini to your system environment. The following list shows the INI file entries
which must be adjusted in all cases. All other parameters can be configured as needed.
l Name of the AE system (system= )
l Activate the SNMP connection (snmp= ) if used.
l Port number of the primary work process (pwpport= )
l Assignment of communication processes and port numbers (cp1= ... cpn= )
l Assignment of work processes and port numbers (wp1= ... wpn= )
l Connection for the database (SQLDRIVERCONNECT= )
l Remove the AE IMAGE:
umount /cdrom or eject cdrom
l Check the libraries:
AIX:
l Check the Oracle library libclntst9.a (see setting up an Oracle database).

l Library check:
dump -H ucsrvcp > wk.txt (use a blank after "dump").
l Open the created file with a text editor (sed or vi). Verify that all libraries were found.
l Repeat the above procedure with ucuoci.a and ucsrvwp. Some missing entries might be
reported that refer to the file ucuoci.a, because it is a library instead of a main program. If
these messages refer to the libraries ucuoci.a, libzu00132.a and libucudb32.a, they can be
disregarded. If an entry cannot be found in a different library (Oracle, for example), this is an
error.
HP-UX:
l Check the Oracle library libclntsh.so.9.0 (see Setting up an Oracle database).

l Library check:
ldd -r ucsrvcp > wk.txt
The option -s can be used instead of -r for ldd.
l Repeat the above procedure with ucuoci.sl and ucsrvwp. Some missing entries might be
reported that refer to the file ucuoci.sl, because it is a library instead of a main program. If
these messages refer to the libraries ucuoci.sl, libzu00132.sl, or libucudb32.sl, they can be
disregarded. If an entry cannot be found in a different library (Oracle, for example), this is an
error.
Linux, Solaris and zLinux:

l Check the Oracle library libclntsh.so.9.0 (see Setting up an Oracle database).

l Library check:
The option -s can be used instead of -r for ldd.
l Open this file with a text editor (sed or vi). Verify that all libraries were found.
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 Server computer used with a DB2 database

l Log on as "AE."
l Create the directory /opt/uc4/server.
l Transfer the file ucs???.tar.gz from /cdrom/cdrom0/<version>/AutomationEngine/unix/<platform>
with ftp (binary) to the created directory.
l Unpack the transferred TAR file:
gunzip ucs???.tar.gz
tar xvf ucs???.tar
l Set the environment variables in $HOME/.profile if the Automation Engine does not run on the
same computer as the utilities. More details, including an example, are available in the installation
guide for the utilities.
l Rename the file ucsrv.ori.ini to ucsrv.ini:
mv ucsrv.ori.ini ucsrv.ini
l Adjust the INI file ucsrv.ini to your system environment. The following list shows the INI file entries
which must be adjusted in all cases. All other parameters can be configured as needed.
l Name of the AE system (system= )
l Activate the SNMP connection (snmp= ) if used.
l Port number of the primary work process (pwpport= )
l Assignment of communication processes and port numbers (cp1= ... cpn= )
l Assignment of work processes and port numbers (wp1= ... wpn= )
l Connection for the database (SQLDRIVERCONNECT= )
l Remove the AE IMAGE:
umount /cdrom or eject cdrom
l DB2 library check:
AIX:
l AE uses $DB2DIR/lib/libdb2.a.
l Library check:
dump -H ucsrvcp > wk.txt
l 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 AE uses $DB2DIR/lib/libdb2.sl.
l Library check:
The option -s can be used instead of -r for ldd
l Open this file with a text editor (sed or vi). Verify that all libraries were found.
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
error.
Linux, Solaris and zLinux:
l AE uses $DB2DIR/lib/libdb2.so.
l Library check:
The option -s can be used instead of -r for ldd
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
error.
2. Installing the AE SNMP subagent (optional)
l Server computer
l Install the AE SNMP subagent if you intend to use its functions.
3. Starting the Automation Engine
Manually start the Automation Engine for a test.
l Server computer
l Log on with the AE User ID.
l Change to the installation directory of the executable programs:
cd $UC4/bin
l Start the communication process in the background:
./ucsrvcp &
l Start the work process in the background:
./ucsrvwp &
l Verify that the Automation Engine is running:
ps -ef|grep ucsrv or ps -fu uc4
l 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. Shutting down the Automation Engine
l Server computer
Shutdown:
l Find out the Process ID pid:
ps -ef|grep ucsrv
l End a server process:
kill -TERM pid
Cancel:
l Find out the process ID pid:
l End a server process:
kill -KILL pid
Use the ServiceManager to start and end server processes.
Possible Problems
At program start:
l Automation Engine ends when starting up:

Activate traces (the database trace is the most important).
Missing libraries or other errors are best found by starting the Automation Engine using:
truss 2>truss.out -f ucsrvcp
The resulting file, truss.out, contains all system calls of the Automation Engine and all attempts to
load shared objects.
If a library is missing, the problem can be that it exists in the system, but its path has not been
specified in the environment variable (LIBPATH, SHLIB_PATH or LD_LIBRARY_PATH). Search
the library as "root" by using:
find / -name 'library' -print
(wildcard characters are allowed).
Add the located path to the environment variable. If the library cannot be found, it has not been
installed on this system or it has been deleted. Search the library to check whether it is available:
AIX, Linux, Solaris and zLinux: /var/sadm/install/contents

HP-UX: /var/adm/sw/ sw install.log and /var/adm/sw/ sw remove.log
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.
l 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.
l 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)
This document guides you through the new installation of a Automation Engine for Windows.
Automic strongly recommends installing the Automation Engine in a separate directory (such as
C:\AUTOMIC\SERVER).
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.
Supplied Files
The Automation Engine files can be found in the IMAGE:AUTOMATIONENGINE\WINDOWS directory.
Procedure
1. Installing the Microsoft Visual C++ 2010 Redistributable Package
This installation step can be omitted if the required version of the package is already installed. Refer to
version.
l Server computer
l Server computer
l If required, install the AE SNMP subagent along with the Automation Engine.
l Start the program SETUP.EXE in the corresponding subdirectory of
IMAGE:AUTOMATIONENGINE\WINDOWS.
3. Installing the AE SNMP subagent (optional)
l Server computer
l Install the AE SNMP subagent if you intend to use its functions.
4. Setting up the system environment
l Server computer
l Adjust the INI file UCSRV.INI to the system environment.
l Use the database client to create a connection to the database. If you use the MS SQL Server,
create the data source "AE" for ODBC access (64 bit ODBC).
5. Starting and ending the Automation Engine
l Server computer
l 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.
l Right-click the Server-process symbol in the task bar and click Close to end one or Shutdown to
end all server processes.
l 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:

Installing the AE SNMP Subagent (Windows)
Distributed Server Environment
Server processes can be installed on several computers in order to increase system stability.
This requires some extra specifications, which are described below:
The computer that contains the work process that connects to the AE system first becomes the active
Automation Engine if AE.Nonstop-Server is licensed. Without this special license, all server processes
participate in processing.
The computers on which the server processes are installed must have the same platform for operating
with multiple Servers (for example, two computers with HP/UX). It is not possible to use computers
with different UNIX derivatives or a mixture of UNIX and Windows.
The database scheme has been designed to support five communication processes. Additional tables
must be prepared if more communication processes are required. Contact theTechnical Support Team
for more information about additional tables.
Procedure
1. Installing the Automation Engines
l Server computer
l Install the Automation Engine on the particular computers as described in the relevant
documentation about new installation.
l Server computer
l 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
;wp5=2275
;wp6=2276
;wp7=2277
;wp8=2278
;wp9=2279
3. Starting and stopping the Automation Engine
l Server computer
l Use the ServiceManager Dialog to start or stop server processes.
See also:
JWP Installation
The following document contains the installation instructions for the Java-based work process (JWP).
General
The JWP is a component of the Automation Engine which is required for the following functions:
l Single Sign-on (via KDC)

l Adaptive ERT calculation
l Function Export with references
l Application Release Automation Integration
l ECC Global Search
Files Provided
The JWP is provided in the same directory as all the other Automation Engine files.
File / Directory Description

ucsrvjp.jar File for starting the JWP.
/lib/ Directory with OSGI implementation and JDBC driver.
/plugins/com.automic.database.jar File for database access.
/plugins/com.automic.ara.jar Opens the ARA WebService.
/plugins/com.automic.ert.jar (Adaptive) ERT calculation.
/plugins/com.automic.kernel.jar JWP kernel.
/plugins/com.automic.network.jar TCP/IP connections.
/plugins/com.automic.sso.jar Single Sign-on.
/plugins/com.automic.util.logging.jar Logging / Trace.
/plugins/org.apache* Additional OSGI bundles for console and services.
/plugins/org.eclipse*
The directory /configuration/ is created automatically when the JWP is first started and contains the OSGI
bundle's cache.
Installation
Unpack the files
In Windows, the JWP files are automatically copied from the SETUP.EXE program to the BIN directory. In
UNIX, the files are located in the respective TAR archive.
Copy the provided "plugin" and "lib" directories into the BIN directory of the Automation Engine.
The subsequent installation steps depend on the database type used.

MS SQL Server
1) Install JDBC driver
Download Microsoft JDBC Driver 4.0 for SQL servers.
After downloading, copy the file "sqljdbc4.jar" into the lib directory of the Automation Engine.
2) Activate TCP/IP in the MS SQL server
Now check whether the MS SQL server instance used allows access via TCP/IP.
Open the SQL Server Configuration Manager and select Protocols for MSSQLSERVER under SQL
Server Network Configuration. The item "TCP/IP" must be set to "Enabled" in the right-hand section.
3) Determine the MS SQL server port
The default port of the MS SQL server port is 1433.
If you are not sure of the port of your MS SQL server instance, you can find this out from its log file. The
message "Server is listening on [ 'any'<ipv4> port number]" should be found in the current log file, which
contains the port.
4) Modify the Automation Engine configuration file
The JWP uses the same configuration file (ucsrv.ini) as the other work processes of the Automation
Engine system.
The database connection must be modified in the configuration file for the JWP. There are 2 different
options for this:
1) DSN-less ODBC Connection
Please note that with this option, the same database connection string that is also used by all the other
WPs in the Automation Engine system must be changed in the configuration file. When installing a
JWP for an existing system, all WPs must be subsequently restarted.
A connection string is required in the [ODBC] section of the configuration file, the syntax of which does not
require DSN. The server and database name must be specified directly in this case.
SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,Driver={SQL Server Native Client

VERSION};Server=tcp:SRVNAME,PORT;Database=DBNAME;Uid=DBUSER;Pwd=DBPWD
l VERSION- Version of SQL Server Native Client. Is displayed in the SQL Server Configuration
Manager.
l SRVNAME - Name of the database computer.
l PORT - port of the MS SQL server instance.
l DBNAME - Database name.
l DBUSER - Database user.
l DBPWD - Database password.
Example:
[ODBC]
SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,Driver={SQL Server Native Client
11.0};Server=tcp:dbsrv01,1433;Database=AEV10;Uid=user;Pwd=password
The entry should be on one line (no break).
2) Separate connection string for the JWP
With this option, a separate database connection string for the JWP is defined in the [JDBC] section.
Example:
[JDBC]
SQLDRIVERCONNECT=jdbc:sqlserver://dbsrv01;databaseName=AEV10
The name and password of the database user are used by the [ODBC] item.
The advantage of this method is that the connection string of the other WPs ([ODBC] section) does not
need to be changed or restarted.
Oracle
Copy the JDBC driver "ojdbc6.jar" from the Oracle database client installation to the "lib" folder of the
JWP.
The file is located here: ORACLE_HOME/jdbc/lib/ojdbc6.jar
2) Configuring the database connection
There are 2 options:
1) Connection via OCI
Modification of the INI file "ucsrv.ini" is not necessary in this option. However, the JWP requires access to
the Oracle database libraries in the same way as a WP. In UNIX, the environment variables LD_
LIBRARY_PATH or SHLIB_PATH must therefore be selected accordingly, depending on the platform.
More information on installing the JDBC driver can be found in the JDBC installation instructions from
Oracle.
2) Direct connection to the database
You can connect directly to the database using the Oracle JDBC Thin driver.
The [JDBC] section in the ucsrv.ini file must be configured accordingly. Example:
[JDBC]
SQLDRIVERCONNECT=jdbc:oracle:thin:@dbserver:1521/service_name
The name and password of the database user can be found in the [ODBC] item.
DB2
Copy the file "db2jcc4.jar" (JDBC driver) into the "lib" directory of the JWP.
This file is part of the DB2 client and is located in the sub-directory "SQLLIB/java".
2) Configuring the database connection
Modification of the ucsrv.ini file is not necessary.
However, if required, the database connect string can be defined in the [JDBC] section of the INI file.
Example:
[JDBC]
SQLDRIVERCONNECT=jdbc:db2://server:<port>/database
The user name and password for database access can be found in the [ODBC] item.
Add certificates for SSL

In order to use SSL, the certificate(s) of the LDAP server must be available to the Java Work Process.
The JWP uses the default keystore file "cacerts" in the lib/security directory of the JRE.
Two options are available to add the certificates:
1 Add certificates with the keytool
l Go to the jre\lib\security folder of the Java installation and import the certificate with the keytool
command:
keytool -keystore cacerts -importcert -alias ldapServer -file

certficate.cer
l When prompted to trust this certificate respond by typing "Y".
2 Add certificates via download
Another option to install the certificate is the command line parameter -installcert of the Java Work
Process.
java -jar ucsrvjp.jar -installcert <host>:<sslport>
l This assumes that the Java Work Process has write access to the cacerts file of the Java
installation.
l This command detects the path of cacerts, connects to the specified host and port and tries to
create an SSL connection.
If a certificate is missing, the message "unable to find valid certification path to requested target" is
printed and the missing certificate is downloaded and stored in the cacerts file.
Start the JWP

Use this kind of command to start the JWP via the command line:
java -Xmx512M -jar ucsrvjp.jar -IC:\temp\ucsrv.ini
The file "ucsrvjp.jar" is provided in the same directory as the other Automation Engine files. It is used
exclusively to start the JWP.
The JWP can also be started via ServiceManager.

java -Xmx512M -jar ucsrvjp.jar -svc%port% -IC:\temp\ucsrv.ini
The -svc parameter should be omitted when starting directly via the command line.
The parameter -I to specify the INI file is optional. If the parameter is missing, the JWP attempts to find the
file "ucsrv.ini" in the current working directory (= directory in which the file "ucsrvjp.jar" is located).
Installing the UserInterface
Installing the UserInterface (UNIX)
This document guides you through the new installation of a UserInterface.
The Automation Engine UserInterface is programmed in Java. Therefore, Java 2 JRE (Java Runtime
Environment) is a prerequisite for installing the UserInterface.
Always install the UserInterfaces on your local hard disk in order to ensure optimal performance. We do
not recommend installing them on a network as this can result in a UserInterface crash if the network fails.
UserInterface communication happens exclusively through the communication processes of the AE

system. Therefore, no database interfaces are necessary.
Automic strongly recommends installing the UserInterface in a separate directory.
Requirements
l Valid user ID for installation (AE)
Supplied Files
The UserInterface files can be found in the directory IMAGE:USERINTERFACE\UNIX. Single files are
combined in the ucdj.tar.gz file.
Procedure
If the required version of JRE is already available, this step of the installation process can be ignored.
l Admin computer and/or user computer

installed.
java -version
If several JRE or Java SDK Versions are installed on the computer, make sure that the directories
are in the appropriate order in %PATH% or $PATH. The Java Runtime Environment that is found
first in the list will be used.
2. Installing the UserInterface

l Log in using the user ID AE.
l Create a directory for the UserInterface (default: /opt/globalDC).
l Transfer the ucdj.tar.gz directory from IMAGE:UserInterface/<unix platform> to /opt/globalDC
using the binary FTP.
l Unpack the transferred tar files in the current directory (/opt/globalDC)
gzip -d ucdj.tar.gz or gunzip ucdj.tar.gz
tar xvf ucdj.tar
(Linux: tar -zxvf ucs???.tar.gz).
3. Adapting the configuration files

l Most of the values in the configuration files are supplied by the UserInterface. You must configure
the following, however:
l Modify the uc4config.xml as follows:
l Enter the connection name and system in the <connection name="name"
system="system"> parameter.
l Enter the DNS name or the TCP/IP address of the computer on which it runs, along with the
port number. You can find this information in the INI file of the Automation Engine (Section
[PORTS]).
4. Using ERP Forms (optional)
l PeopleSoft:
l The PeopleSoft Java Object Adapter and specific Java classes (UCXJPS84.jar) are required in
order to use PS ERP Forms
l Modify the entry "classpath" (psjoa.jar) in the INI file of the UserInterface as needed.
Example:
[ENVIRONMENT]
classpath=.;.\psjoa.jar;.\ucdj.jar;.\UCXJPS84.jar
5. Starting the UserInterface

l The following command executes the start script:
chmod +x ucdj.sh
Potential Problems
During installation:
l Insufficient disk space:
Around 20 MB is required. Availability of disk space is checked by the installation program
During program start:
l No connection to the AE system:
l Check the entries in the file uc4config.xml:
Enter the name of the AE system to which the UserInterface should connect. It is also
important to correctly indicate the port and computer name or IP address on which the
communication process runs.
l AE system is not running:
Make sure the server processes are activ.
Recommended parameterization for Citrix

l Java must be installed on the Citrix server.
l At least the memory that is specified for the Java call in the INI file (ucdj.ini) should be available for
each UserInterface that is used.
For example: cmd="javaw" -Xmx512m ...
l To ensure that the correct Java version is used, you can specify the absolute Java path in the INI
file.
For example: cmd="C:\Program Files\Java\jre\bin\javaw" -Xmx512m ...
l You should separate the log and trace files and the configuration files uc4config.xml and login_
dat.xml user specifically (see the details below).
l You can use the following Java parameter in order to optimize the JVM's memory management:
-XX:+UseConcMarkSweepGC
Separating the UserInterface's log and trace files user

specifically
In the file uc4config.xml, you can use environment variables in order to store the log and trace files on
different places depending on the OS user.
Examples of the relevant section in the file uc4config.xml (Windows):
The log and trace files are created in the Windows user's directory which stores the temporary application
files. The user name is appended to the file name.
<logging count="10">%APPDATA%/temp/UCDJ_LOG_##_%USERNAME%.TXT</logging>
<trace count="10" tcp="3" xml="0">%APPDATA%/temp/UCDJ_TRC_
##_%USERNAME%.TXT</trace>
The following example stores the log and trace files in the UserInterface's Temp folder. The name of the
Windows user is also appended:
<logging count="10">../temp/UCDJ_LOG_##_%USERNAME%.TXT</logging>
<trace count="10" tcp="3" xml="0">../temp/UCDJ_TRC_
Starting the UserInterface user specifically

The configuration files uc4config.xml and login_dat.xml must be available for each OS user who uses
the UserInterface. Automic recommends using a descriptive name such as uc4config_TEST.xml and
login_dat_TEST.xml.
Option 1:
Calling the UserInterface with the start parameters -I and -J, the user name can be appended dynamically
by using environment variables.
For example, the start command for the UserInterface under Windows:
C:\AUTOMIC\UserInterface\bin\UCDJ.EXE -J"-OC:\AUTOMIC\UserInterface\bin\login_
dat_%USERNAME%.xml –IC:\AUTOMIC\UserInterface\bin\uc4config_%USERNAME%.xml"
Option 2:
The UserInterface is called in the same way as described above. The user-dependent configuration files
are specified in the INI file. For this purpose, you use environment variables for the Java call (cmd=...).
Example that shows the relevant INI-file section:

[GLOBAL]
I./uc4config_%USERNAME%.xml -O./login_dat_%USERNAME%.xml
When the name and the path to the XML files should be user dependent, you must define a separate
environment variable for the path before you use the start command. For example:
INI file:
[GLOBAL]
cmd="javaw" -Xmx256m com.uc4.ucdf.UCDialogFactory -U%User% -I%UI_
XML%/UC4CONFIG_%USERNAME%.xml -O%UI_XML%/login_dat_%USERNAME%.xml
UserInterface call:
Set UI_XML=C:\UI_XML_Files
C:\AUTOMIC\UserInterface\bin\UCDJ.EXE -F0 -IUCDJ_individualized.ini
This document guides you through the new installation of the UserInterface (Windows).
Always install the UserInterfaces on your local hard disk in order to ensure optimal performance. AE does
not recommend installing them on a network, because the UserInterface can crash if the network fails.
UserInterface communication occurs exclusively using the communication processes of the AE system.
Therefore, no database interfaces (ODBC, OCI or CLI) are required.
Automic strongly recommends installing the UserInterface in a separate directory (e.g.

C:\AUTOMIC\USERINTERFACE).
Supplied Files
The UserInterface files can be found in the IMAGE:USERINTERFACE\WINDOWS directory.
Procedure
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.
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.

l Start the program SETUP.EXE in the IMAGE:USERINTERFACE\WINDOWS directory.
All files required for UserInterface operation are copied into the specified directory. The default
directory is C:\AUTOMIC\USERINTERFACE\BIN.
3. Modifying the configuration files

l Most values of the configuration files are supplied by the UserInterface, but the following
modifications are still necessary:
l Adapt the uc4config.xml file.
l Enter the connection name and system in the <connection name="name"
system="system"> parameter.
l Enter the connection data that is required by the communication process (DNS name or
TCP/IP address of the computer on which this process runs, and port number). This
information is provided in the INI file of the Automation Engine (Section [PORTS]).

l PeopleSoft:
l In order to use PS ERP Forms, the PeopleSoft Java Object Adapter and specific Java classes
(UCXJPS84.jar) are required.
l Adjust the entry "classpath" (psjoa.jar) in the INI file of the UserInterface, as needed.
Example:
[ENVIRONMENT]
classpath=.;.\psjoa.jar;.\ucdj.jar;.\UCXJPS84.jar
5. Calling the DLL from a freely selected path (optional)

l Change the path for CALLHTMLHELP.DLL with the appropriate entry in the system environment
variables (system control -> system). Enter the variable JAVA_LIBRARY_PATH and the required
path. The library CALLHTMLHELP.DLL will be loaded from this directory.
l 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].
Example:
cmd="javaw" -Djava.library.path=..\libraries -jar -cp .;.\UC4LAF.jar
UCDJ.jar

l To execute the UserInterface, you can either use the file UCDJ.EXE or UCDJ.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 C-
Runtime Library.
Potential Problems
During installation:
l Insufficient disk space:
Approximately 30 MB is required. Availability of disk space is checked by the installation program.
During program start:
l No connection to the AE system:
l Check the entries in the file uc4config.xml:
Enter the name of the AE system to which the UserInterface should connect. It is also
important to correctly indicate the port and computer name or IP address on which the
communication process runs.
l AE system is not running:
Ensure the server processes are active.
Recommended parameterization for Citrix

l Java must be installed on the Citrix server.
l At least the memory that is specified for the Java call in the INI file (ucdj.ini) should be available for
each UserInterface that is used.
For example: cmd="javaw" -Xmx512m ...
l To ensure that the correct Java version is used, you can specify the absolute Java path in the INI
file.
For example: cmd="C:\Program Files\Java\jre\bin\javaw" -Xmx512m ...
l You should separate the log and trace files and the configuration files uc4config.xml and login_
dat.xml user specifically (see the details below).
l You can use the following Java parameter in order to optimize the JVM's memory management:
-XX:+UseConcMarkSweepGC
Separating the UserInterface's log and trace files user

specifically
In the file uc4config.xml, you can use environment variables in order to store the log and trace files on
different places depending on the OS user.
Examples of the relevant section in the file uc4config.xml (Windows):
The log and trace files are created in the Windows user's directory which stores the temporary application
files. The user name is appended to the file name.
<logging count="10">%APPDATA%/temp/UCDJ_LOG_##_%USERNAME%.TXT</logging>
<trace count="10" tcp="3" xml="0">%APPDATA%/temp/UCDJ_TRC_
The following example stores the log and trace files in the UserInterface's Temp folder. The name of the
Windows user is also appended:
<logging count="10">../temp/UCDJ_LOG_##_%USERNAME%.TXT</logging>
<trace count="10" tcp="3" xml="0">../temp/UCDJ_TRC_
Starting the UserInterface user specifically

The configuration files uc4config.xml and login_dat.xml must be available for each OS user who uses
the UserInterface. Automic recommends using a descriptive name such as uc4config_TEST.xml and
login_dat_TEST.xml.
Option 1:
Calling the UserInterface with the start parameters -I and -J, the user name can be appended dynamically
by using environment variables.
For example, the start command for the UserInterface under Windows:
C:\AUTOMIC\UserInterface\bin\UCDJ.EXE -J"-OC:\AUTOMIC\UserInterface\bin\login_
dat_%USERNAME%.xml –IC:\AUTOMIC\UserInterface\bin\uc4config_%USERNAME%.xml"
Option 2:
The UserInterface is called in the same way as described above. The user-dependent configuration files
are specified in the INI file. For this purpose, you use environment variables for the Java call (cmd=...).
Example that shows the relevant INI-file section:

[GLOBAL]
I./uc4config_%USERNAME%.xml -O./login_dat_%USERNAME%.xml
When the name and the path to the XML files should be user dependent, you must define a separate
environment variable for the path before you use the start command. For example:
INI file:
[GLOBAL]
cmd="javaw" -Xmx256m com.uc4.ucdf.UCDialogFactory -U%User% -I%UI_
XML%/UC4CONFIG_%USERNAME%.xml -O%UI_XML%/login_dat_%USERNAME%.xml
UserInterface call:
Set UI_XML=C:\UI_XML_Files
C:\AUTOMIC\UserInterface\bin\UCDJ.EXE -F0 -IUCDJ_individualized.ini
See also:
Setting up Single Sign-On

The following document contains detailed instructions on how to set up Single Sign-on (SSO) for the
Automation Engine system. Single Sign-on makes it possible to login without having to enter login details.
Kerberos KDC (Key Distribution Center) is used for Single Sign-on. If Single Sign-on is configured
correctly, it is possible to login (UserInterface, Enterprise Control Center) to the Automation Engine
system without having to enter login details (user, department and password). The operating system user
under which the UserInterface has been launched will be used for authentication.
These installation instructions apply to Windows and UNIX.
General Requirements
l JWP:
At least one JWP (Java-based work process) must be active.
l Time differences
Times on the client computer (UserInterface, Java API) and server computer (JWP) must not differ
significantly. A difference of 5-10 minutes is permissible depending on the setting. If the difference
is too great, you may see the error message "Clock skew too great" on login.
l Access to KDC
UserInterface and JWP require access to the KDC (for example, Active Directory in Windows). It is
not sufficient for the UserInterface to have access to just the CP, for example.
l Supported JVM
Currently, only Oracle Java is supported for Single Sign-on. If a component (JWP, UserInterface,
Java API) runs in IBM Java, login will be aborted.
Installation steps for the UserInterface and Automation Engine
1) Registry key for TGT access
This step is required only if the UserInterface runs in Windows.
This registry key is required so that Kerberos Java implementation can use an existing TGT (Ticket
Granting Ticket). The TGT will be generated by logging in to the operating system.
[HKEY_LOCAL_
MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\Kerberos\Parameters]
"allowtgtsessionkey"=dword:00000001
2) Installation of Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction

Policy
The JCE Unlimited Strength Jurisdiction Policy has to be installed on the machines where:
l The UserInterface and/or the ECC runs.

l The Automation Engine (JWP) runs.
Download under Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy
The Readme file contains the installation instructions. If there are multiple Java installations on the same
computer, setting up a policy file for all installations is recommended.
3) Kerberos configuration file
This step can be omitted if the UserInterface runs in Windows with Java Version 1.7. With Java 1.7, the
settings will be identified immediately in Windows.
The krb5.conf file should be created in all other cases. The location of the configuration file is <java-
home>/lib/security.
The exact search sequence is described under

http://download.java.net/jdk8/docs/technotes/guides/security/jgss/tutorials/KerberosReq.html in the
section "Locating the krb5.conf Configuration File". The Kerberos documentation describes how to set up
this file.
Example:
[libdefaults]
default_realm = DOMAIN.SAMPLE
[domain_realm]
.domain.sample = DOMAIN.SAMPLE
[realms]
DOMAIN.SAMPLE = {
kdc = servername.domain.sample
admin_server = servername.domain.sample
}
4) Enable KDC in the AE system-wide settings
In the UC_SYSTEM_SETTINGS file, set KDC to Y to enable Kerberos Distribution Center (KDC)
authentication for a whole system.
Installation steps for the JWP
Generate key tab file
The following steps must be performed by the KDC administrator (for each CP host):
1) Create a service user in the KDC
Create a new service user in the KDC (for example, in the Active Directory in Windows) which is to be
used for authentication. The user password should not expire.
2) Create Service Principal Name (SPN)
Service Principal Names (SPN) must then be created with the following description:
<AE System Name>/<CP Host Name>[@<Realm>]
<AE System Name>/<Fully qualified Domain Name of the CP Host>[@<Realm>]
Automic recommends creating SPNs for each CP host (one SPN with the host name and one with the
fully qualified domain name).
Make sure you pay attention to upper and lower case letters when creating SPNs. Otherwise, the name
may not be found in the Kerberos database.
The realm is optional. If this is not specified, the default value from the configuration file krb5.conf will be
used. In Windows, <Realm> always corresponds to the domain name (DNS suffix) in upper case letters
(for example: DOMAIN.SAMPLE)
Also see: Detailed description of Kerberos principals.
Example:
AEServer01/winhost01.domain.sample@DOMAIN.SAMPLE
The SPNs must be assigned to the previously created KDC service user.
In Microsoft's Active Directory, the command "setspn" can be used to create SPNs. As stated above,
creating an entry for the host name and one for the fully qualified domain name is recommended.
Example:
setspn -s AEServer01/winhost01.sample.host@SAMPLE.DOMAIN ServiceAccount01
setspn -s AEServer01/winhost01@DOMAIN.SAMPLE ServiceAccount01
3) Generate keytab file
A keytab file must be generated in this step.
In Microsoft Active Directory, the command "ktpass" can be used for this. The SPN, KDC user, KDC
user's password, and path/file name of the keytab file must be specified.
Example:
ktpass /princ AEServer01/winhost01.domain.sample@DOMAIN.SAMPLE /mapuser
ServiceAccount01@DOMAIN.SAMPLE /pass UXTY5rdx+!1245.qw /mapop set /crypto
all /out c:\temp\ae.keytab -ptype krb5_nt_principal
The keytab file C:\temp\ae.keytab will then be created.
Details of "ktpass" command syntax: http://technet.microsoft.com/en-us/library/cc753771.aspx
In case you get an error message, when trying to generate the .keytab-file, you should use the following
additional switch with the example above:
-ptype KRB5_NT_PRINCIPAL
Reason for this error would be the fact, that you are not mapping the SPN to a principal. KRB5_NT_
PRINCIPAL is the general principal type (recommended) as documented by Microsoft.
Multiple CPs on Different Hosts

If the communication processes of the Automation Engine system run on different hosts, then the steps for
generating the keytab file (steps 2 and 3) must be performed for each host name.
This will result in additional keytab files. However, the JWP requires exactly one file, which means the
entries must be merged into one file.
On UNIX you can use the application 'ktutil' with the following commands:
ktutil
rkt keytab1.keytab
rkt keytab2.keytab
wkt merged.keytab
Thereby a new file named "merged.keytab" is being created, which contains the entries of keytab1 and
keytab2.
Since the Oracle Java for Windows has no merge parameter, the simplest solution is to merge the two
files using 'ktutil' on a UNIX system and then transfer the merged file to your Windows installation.
4) Specify the keytab file
Now enter the path and file name of the generated keytab file in the Variable object UC_KDC_SETTINGS,
which is located in client 0.
Specify the value "KEYTAB" in the Key column of the Variable object and the key tab file in the column
"Value 1".
The JWP must be restarted following a change of variable.
If there are multiple JWPs on different hosts, the keytab file must be located in the same directory on all
hosts. If the file is missing on one or more hosts, then login will not always work.
5) SSO configuration for web applications
In order to implement Single Sign-on for web applications (such as Enterprise Control Center or Application
Release Automation), a keytab file with HTTP as Service Principal Name is required.
For example:
HTTP/winhost01.domain.sample
In this example, winhost01 is the host on which, for example, the Enterprise Control Center (Tomcat) is
installed.
The SPN name must also be entered in the variable UC_KDC_SETTINGS using the "HTTP" key. If
several ECC/ARA installations are available for an Automation Engine system, then other names
separated by a semi colon can be added.
Example:
HTTP/winhost01.domain.sample;HTTP/winhost02.domain.sample
Users for Authentication
Following successful completion of the configuration, corresponding users must be created in the clients
of the Automation Engine system.
The user names must correspond to those of the operating system users, who should be granted access
via Single Sign-on.
The department is irrelevant as long as the user name is unique for each client. If there are two or more
users with the same name but a different department, each of these departments must be assigned to a
domain in the variable UC_KDC_SETTINGS.
Single Sign-on login will fail if no User object exists in the selected client with the same name as the
operating system user, such as the one used for launching the UserInterface.
Example:
The UserInterface is launched in Windows under the user "test\local".

AE system TEST, client: 100
If no user object with the name "TEST\*" (department irrelevant) exists in client 100, Single Sign-on login is
not possible.
If there are several users in client 100 with the name "TEST\*" (for example, "TEST\DEV" and
"TEST|LOCAL"), the departments (as described above) must be assigned to the domains of the operating
system users. If departments are not assigned, login will also fail.
Installing the Online Documentation

The WebHelp format is available for the UserInterface in the form of an online documentation/context
sensitive help (F1 key).
As of version 11, help is delivered only in English for major version releases. German and French
versions are delivered with the first service pack.
In order to use the context-sensitive help, you should copy the English version files into the folder for
French or German respectively.
This ensures that the documentation topic describing the active window, tab, or script element in the
UserInterface will open when you press F1.
In this document you find the following sections to help you decide on the help format and guide you
through installation and copy&paste procedures:
l WebHelp Browser Compatibility

l Documentation Formats
l Documentation Types
l Supplied Files
l Deciding on a Location for Your Documentation
l Installing the Automation Engine Guides in WebHelp Format
l Copying and Unzipping the Automation Engine Messages in WebHelp Format
l Copying and Unzipping the Automation Engine Release Notes
l Using the WebHelp format online on docs.automic.com with F1-key
WebHelp Browser Compatibility
For Automic WebHelp in HTML5 format the same browser compatibility applies as for the ECC. Please
check our Automic Compatibility Checker for details.
JavaScript must be enabled in order to use the complete functional range.
Documentation Formats
Automation Engine documentation is available in the following formats:
l WebHelp: You can run the WebHelp on all platforms with an HTML browser.
l PDF: You can open the PDF guides from all platforms on which a display program (such as Adobe
Reader) is installed.
You cannot use PDF files as context sensitive help in the UserInterface (F1 key).
Documentation Types
The documentation Is available in the following That you:

type: format(s):
Guides WebHelp Install by:
l Copying language-specific .zip file(s).

l Unzipping the contents of the .zip file
(s).
l Configuring the uc4config.xml files for
each UserInterface.
PDF Can copy
Messages WebHelp Install by:

(s).
Release Notes WebHelp Install by:

(s).
PDF Can copy
You can install each documentation type in the language(s) of your choice. In the image below,
documentation in all formats, types, and languages are installed in a Windows directory.
Supplied Files
The documentation in each type, formats, and languages are provided in the directory
IMAGE:DOCUMENTATION.
The Automation Engine documentation in WebHelp format is also available in compressed format as TAR
files (in the directory IMAGE:DOCUMENTATION\GUIDES\WEBHELP).
Deciding on a Location for Your Documentation
Automation Engine documentation can either reside locally on the machine where each UserInterface is
installed or at a shared location that can be accessed by all users.
Installing the Automation Engine Guides in WebHelp Format
To install the Automation Engine guides in WebHelp format:
1. From IMAGE:DOCUMENTATION\GUIDES\WEBHELP, navigate to the language(s) you wish to

add WebHelp documentation for.
In each language's sub-directory, there is a .zip file.
2. Copy and unzip the contents of the .zip file(s) to the location(s) you want them (usually
\DOCUMENTATION\WEBHELP\<language>).
In the image below, the contents of the .zip file are unzipped in the
\DOCUMENTATION\WEBHELP\ENGLISH directory.
3. Edit the <docu type="format">path</docu> and <browser type="name">path</browser>

parameters in the uc4config.xml configuration file for each UserInterface.
Text from a sample uc4config.xml is shown below with the necessary edits shown in bold.
<configuration>
<paths>
<docu type="wh">C:\AUTOMIC\Documentation</docu>
<browser type="Internet Explorer">"C:\Program Files\Internet
Explorer\iexplore.exe"</browser>
<logging count="10">..\temp\UCDJ_LOG_##.TXT</logging>
<trace count="10" xml="0" tcp="0" ra="9">../temp/UCDJ_TRC_
##.TXT</trace>
</paths>
To open the Automation Engine WebHelp documentation: Do this:

To a topic that describes the particular window, tab, or script element that is Press the F1 key.
open or in use in the UserInterface
Manually from the Windows directory where you copied it Double-click the start
page help.htm.
As of version 11, help is delivered only in English for major version releases. German and French
versions are delivered with the first service pack.
In order to use the context-sensitive help, you should copy the English version files into the folder for
French or German respectively.
This ensures that the documentation topic describing the active window, tab, or script element in the
UserInterface will open when you press F1.
Copying the Automation Engine PDF Guides
To copy the Automation Engine release notes, go to IMAGE:DOCUMENTATION\GUIDES\PDF, and

copy the directories for the PDF files for the desired language(s) to the location you want them (usually
\DOCUMENTATION\PDF\<language>).
Copying and Unzipping the Automation Engine Messages in WebHelp Format
To copy and unzip the Automation Engine messages in WebHelp format:
1. From IMAGE:DOCUMENTATION\MESSAGES\WEBHELP, navigate to the language(s) you wish

to add messages in WebHelp format for.
In each language's sub-directory, is a .zip file.
2. Copy and unzip the contents of the .zip file(s) to the location(s) you want them (usually
\DOCUMENTATION\MESSAGES\<language>).
Copying and Unzipping the Automation Engine Release Notes
To copy and unzip the Automation Engine release notes:
1. From IMAGE:DOCUMENTATION\RELEASE NOTES, navigate to the language(s) you wish to

add Release Notes for.
In each language's sub-directory, there is a PDF file and .zip file.
2. Copy the PDF and .zip file(s) to the location(s) you want them (usually
\DOCUMENTATION\RELEASE NOTES\<language>).
3. Unzip the contents of the .zip file(s).
Using the WebHelp format online on docs.automic.com with F1-key
At this point this workaround for using WebHelp on our documentation site exists. In future AE
versions the use of the F1-key with the documentation on the net will be implemented.
To use the online documentation in WebHelp format on docs.automic.com as context-sensitive help when
pressing F1, configure the uc4config.xml as described above, but take care to make the following
changes:
1. Create a help.htm file in the path configured for WebHelp (see above).
2. Paste the following script lines into this help.htm and save it:
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<script type="text/javascript">
var href = window.location.href;
var deeplink = href.split("/");
window.location =
"http://docs.automic.com/documentation/AE/11.1/english/AE_WEBHELP/" +
deeplink[deeplink.length-1];
</script>
<title>Page Redirection</title>
</head>
<body>
If you are not redirected automatically, follow this <a
href='http://docs.automic.com/documentation/AE/11.1/english/AE_
WEBHELP/help.htm'>link to example</a>
</body>
</html>
Installing the Agents
Installing the Agent for BS2000
This document guides you through the new installation of a BS2000 agent.
Various BS2000 versions require their own agent; a one-character code is assigned to each supported
version. This code is part of the agent's file name and is described in the terminology. In this document, the
specific code is replaced by the character "?."
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. For more information, see Advanced Security.
Requirements
l The User ID $UC4 in BS2000 must be set with approximately 10.000 PAM pages.
l 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.
Supplied Installation Files

The files are packed in TAR files. Each respective TAR file is stored in a subdirectory of
IMAGE:AGENTS\BS2000, depending on the BS2000 variant. The file name indicates the current
Automation Engine version. In the table shown below, the version is represented by the characters
"x.xxx."
TAR files that contain "NK4" in their names are for NK4 pubsets and can also be unpacked using the BS2-
TAR program.
CalAPI files and their implementation are described in a separate document.
Potential Problems
l TSOS Rights
l K, NK
l PUBSET Right (Sysout)
l BCIN for establishing connection to the UC Server and to file transfer partners
l Use of freely-defined port numbers
Procedure
1. Transferring TAR files to the host
l Admin computer
l Transfer the TAR file UCXJB2?.TAR or UCXJB2?NK4.TAR via FTP in text mode.
l Alternately, the TAR file can be transferred with FTBS2000 or the EDT file transfer (also in text
mode) to BS2000.
2. Unpacking the TAR files and setting up the system environment
l Host
l 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 The actual installation files are created. The TAR file can then be deleted.
l Remove the prefix from the installation files.
l Adjust the INI file and Enter job.
l Adjust HEADER.BS2000, TRAILER.BS2000 and RESTART.BS2000 if necessary. See: Job -
Execution.
The file UCXJB2?M must be shareable, and the user ID and file name must correspond to the
INI-file entry UC_EX_JOB_MD.
The UCYBRFC? file must be shareable if the RFC mechanism is activated.

3. Starting the Agent
l Server computer
l The AE system must be running.
l Host
l Start the agent under $TSOS.
Set priority and category.

An agent object is automatically created in system client 0000 and stored in the folder HOST.
l Admin computer or Server computer

l Verify whether the agent is logged on.
l Start the UserInterface for client 0000. More detailed information about agents is provided in
the System Overview. Because a newly logged-on agent has not yet been assigned a client,
it can only be viewed in client 0000. The new agent can now be assigned to clients with the
required rights using the Agent object.
4. Shutting down the Agent
l Host
l Quit the agent using the command /INTR Tsn, END or using the Task Manager of BS2 TOOLS.
Installing the Agent for Databases
Installing the Agent for Database Jobs and Events
The following guide describes the installation process for the agent that is used to execute database jobs
and events.
This installation guide can be used for Windows and for Unix.
The database agent for jobs and events is only available for a particular database type (such as MS SQL)
and can be set in the agent's INI file. A separate agent must be installed for each database type that can
be accessed by jobs or events. Database and server names must be defined in the particular Job or Event
object.
use one of the available authentication methods. More detailed information is provided in the document
Advanced Security.
Automic strongly recommends installing the agent in a separate directory.
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.
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
If JRE is already available in the required version, this step of the installation process can be ignored.

l The Version of the current Java Virtual Machine (VM) of the system can be checked with the
following command:
java -version
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
can deactivate it in the system control. The Automation Engine does not need it.
2. Installing the Agent
l Host
l Create a separate directory for the agent (such as C:\AUTOMIC\AGENTS\SQL\BIN or
UC4/AGENTS/SQL/BIN).
l 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. Installing the JDBC driver
l Host
l A suitable JDBC driver must be installed for all databases that the agent will use. Refer to the
particular vendor's installation guide.
l Create the folder JDBC in the database agent's BIN folder. Copy the JDBC driver files to this folder
after successful installation.
l Microsoft SQL Server

l Install the Microsoft JDBC Driver for SQL Server or Microsoft JDBC Driver 4.0 for SQL Server
l Copy the file sqljdbc4.jar to the folder's JDBC directory after you have installed the driver.
l 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
l 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).
l Oracle
l Install the driver.
l Copy the file ojdbc5.jar or ojdbc6.jar to the folder's JDBC directory after you have installed the
driver.
l The JDBC driver of version 9.0.1 or earlier cannot be used with this agent due to a program error
in the driver.
l 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.
l MySQL
l Copy the file mysql-connector-java-5.0.3-bin.jar to the folder's JDBC directory after you have
installed the driver.
l DB2
l 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).
l 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)
l The JDBC driver can be downloaded from IBM's homepage.
Click on the entry "DB2 Personal Developers Edition: Re-distributable JDBC Type 4 Driver."
l Sybase
l Install the driver (jConnect 5.5/6.05).
l Copy the file jconn2.jar or jconn3.jar to the folder's JDBC directory after you have installed the
driver.
l Informix
l Install the driver (V3.5).
l When the driver is installed, copy the files ifxjdbc.jar and ifxlang.jar to the agent's jdbc directory.
l Note that the agent requires Informix databases with transaction support.
l 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
l Ingres
l Install the jdbc driver.
l When the driver is installed, copy the file iijdbc.jar to the agent's JDBC directory.
l SAP HANA
l Copy the file ngdbc.jar from the HANA client's installation directory to the agent's jdbc directory.
4. Additional important notes

l Oracle RAC
l The agent can also be configured so that it can connect to an Oracle database in RAC.
l Host
l Adjust the INI file UCXJSQLX.INI to the system environment.
l 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.

l Adjust HEADER.WINDOWS, TRAILER.WINDOWS and RESTART.WINDOWS if necessary.
See: Job - Execution.
l Server computer
l Host
l Start the agent with the following command:
java -jar -Xrs -Xmx256M ucxjsqlx.jar
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..
l Verify that the agent is logged on to the AE system.
l Start the UserInterface for client 0000. Call the information about agents in the System
Overview. Newly logged-on agents have not yet been assigned to a client; they can only be
viewed in client 0000. The newly installed agent can now be assigned to clients with the
required rights via the Agent object.
Use the ServiceManager to start or end the agent as a service.

Installing the Agent for Database Variables
The following guide describes the installation process of the database agent for Variable objects with the
source SQL. This agent is also referred to as the DB Service Agent.
The agent for SQL variables (DB Service Agent) can access each supported database type. This type
must be determined in a DB-type Connection object that can be assigned to Variable objects with the
source SQL. In doing so, only one DB Service Agent is required for all SQL variables.
In this Connection object, you can also determine the database name and the connection parameters
(such as Server name and port number). The agent is configured in the AutomationEngine's INI file and not
in its own INI file.
The agent is only required for Variable objects with the source SQL. SQLI variables do not require an agent
because they access the AE database directly via the Automation Engine.
The DB Service Agent must be installed on the same computer as the Automation Engine.
This includes that you can only log on to MS SQL Server databases via Windows authentication when
the Automation Engine does not run on UNIX. The reason for this is that the library "sqljdbc_auth.dll"
cannot be loaded under UNIX.
A DB Service Agent may always be used throughout the whole system, regardless of the authorization
settings (Agent object > Authorizations tab).
Advanced Security.
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.
Procedure

following command:
java -version
l Host
l Create a separate directory for the agent (for example, C:\AUTOMIC\AGENTS\SQL\BIN or
l 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
l Host
l A suitable JDBC driver must be installed for all databases that the agent will use. Refer to the

l The driver supports MS SQL Server 2005 and 2008 (2008 R2).
l Copy the file sqljdbc4.jar to the folder's JDBC directory after you have installed the driver.
l 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
l 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).
l 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!
l Oracle
l Copy the file ojdbc5.jar or ojdbc6.jar to the folder's JDBC directory after you have installed the
driver.
l The JDBC driver of version 9.0.1 or earlier cannot be used with this agent due to a program error
in the driver.
l 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.
l MySQL
l DB2
l Copy the following two files to the agent's JDBC directory:
Click on the entry "DB2 Personal Developers Edition: Re-distributable JDBC Type 4 Driver."
l Sybase
driver.
l Informix
l When the driver is installed, copy the files ifxjdbc.jar and ifxlang.jar to the agent's jdbc directory.
l Due to an Informix error, it is necessary to specify the value for the environment variable DB_
For example: [INFORMIX] db_locale=EN_US.CP1252
l Ingres
l Install the jdbc driver.
l SAP HANA
l Oracle RAC
l Server computer
l 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.
l 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.
l 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
"IntegratedSecuirty" to be specified (value "true").
l Server computer
l Host
l 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
More detailed information is provided in the Java documentation.
l Start the UserInterface for client 0000. Call information about agents in the System
Overview. Newly logged-on agents have not yet been assigned to a client; they can only be
viewed in client 0000. The newly installed agent can now be assigned to clients with the
Installing the Agent for GCOS8
This document guides you through the new installation of a GCOS8 agent.
use one of the available authentication methods. For more information, see Advanced Security.
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.
Procedure
1. Creating the required catalogs
l Host
l Create a catalog for the installation (UC4/version).
l The following sub-catalogs are required in it: DATA, EXEC, INSTALL, JCL, OUT and TMP.
2. Transferring the files to the host
l Admin computer
l 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 CANCEL.SPN, UC4, UC4EX, UC4EXEC.DIR, UC4EXEC.SPN,
UC4TERM.DIR, UC4TERM.SPN, UC4TM, UC4SIM
l Host
l Adapt the INI file to the system environment.
l Important: Do not remove trace flags.
l Automic recommends setting the parameter TRCOPENCLOSE to "0" in order to ensure consistent
agent performance.
l Host
l Adjust the files UC4EX and UC4TM to the system environment.
l Admin computer or user computer

l Adjust HEADER.GCOS8 and TRAILER.GCOS8 as needed.
4. Transferring the job report
l Host
l 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 Set the parameter RSM= in the INI file to either "N" or "X."
l The section [VARIABLES] of the INI file must contain the parameter UC_EX_PATH_JCL.
Enter the JCL catalog name in that parameter.
l Adjust the file UC4SIM in the JCL catalog so that it contains the catalog in which the agent
has been installed.
l 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.
l Important: Do not set the parameter RSM= when RSM8 is used.
l Host
l Start the agent with the JCL from the file UC4EX.
$ ident <site-ident>
$ select &system/profile.prod/uc4
$ select &uc4cat/jcl/uc4exec.spn
$ endjob
l An Agent object will automatically be created in the system client 0000 and stored in the folder
HOST.

l 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.
l Host
l Use the JCL from the file UC4TM to close the agent.
$ select &uc4cat/jcl/uc4term.spn
$ endjob
Installing the Agent for J2EE/JMX
Setting Up the Agent for J2EE/JMX
The JMX agent can be run outside of an application server. This installation guide describes the required
steps.
Advanced Security.
Automic strongly recommends installing the agent in a separate directory (such as UC4/Agent/jmx or
C:\AUTOMIC\Agent\jmx).
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.
Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
Procedure
1. Installing Java Standard Edition
This installation step can be omitted if the required version of Java Standard Edition is already
available.

l Check the current version of your system's Java Virtual Machine (VM) using the following
command:
java -version
Note that the order of the indicated directories is relevant when specifying %PATH% or $PATH if
several versions of JRE or Java SDK are installed on your computer. The Java Runtime
Environment listed first is used.
2. Setting up the Agent
l Host
l 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).
l 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.
l Use the following command to start the agent from the command line (UNIX and Windows):
java -jar -Xrs -Xmx256M ucxjjmx.jar

The agent can also be started by using the ServiceManager.
(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.
4. Important notes for creating jobs
l Host
l Select the option "Local Java VM" in the Job object's JMX tab.
l Activate the sub-items "Use existing MBean Server" and "Create new instance..."
Usage with Application Server
Setting Up the Agent for J2EE/JMX (Oracle WebLogic)
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
Procedure
1. Installing Java Runtime Environment (JRE)
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. Setting up the JMX Agent
l Host
l Create a folder for the JMX agent (bin) and copy the supplied files.
l 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.
l 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.
l 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
You can also start the agent using the ServiceManager.
l Host
l Select "Remote Java VM" in the Job object's JMX tab.
l Enter the term "weblogic" in the field Initial Context Factory .
l 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
Security.
Supplied Files
Procedure
l Host
l Select the menu item Applications -> Install New Application on the WebSphere interface.
l Specify the path to ucxjjmx.war in "Local File System." "Context root" can be used to name the
application.
l The next window can be used to activate the option Generate Default Bindings." If required, other
settings can also be specified.
l Follow the installation procedure as described. In step 4, select the option Everyone? next to
"administrators."
l 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.
l Click Applications -> Enterprise Applications. The list now also includes the agent. Activate it by
clicking the button of the same name.
l The agent can be started via the configuration WebInterface.
2. Using the configuration WebInterface
l Host
l 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
l 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.
l Host
l "Remote Java VM" must be selected in the Job object's JMX tab.
l Enter the term "websphere" in the field Initial Context Factory .

l Specify the Server URL in the following format:
Host name of the WebSphere:port of BOOTSTRAP_ADDRESS
l 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.
Advanced Security.
l Host
l Select the menu item Applications-> Install new application on the WebSphere interface.
l Enter the path to the file ucxjjmx.war in "Local file system." The "Context root" can be used to name
the application.
l In the next window you can activate the option Generate standard connections or configure other
settings.
l Follow the installation procedure until the individual steps are displayed. Step 4 requires the
selection of "Everyone?" in "administrators."
l When all six steps are completed, click Finish to complete the installation process. The log shows
whether the installation was successful.
l Click Store in master configuration, and then click Store.
l Call the menu item Applications -> Enterprise applications. The list also includes the agent.
2. Configuring the INI file

l Host
l Search for the file ucxjjmx.ini in the WebSphere folder.
l 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 Adjust the values for the javax.* properties according to your environment.
l 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.
l Host
l Start the agent application via the WebSphere console.
4. Using the Web configuration interface
l Host
l 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
l Adjust the settings of the JMX agents to your system environment. The following are particularly
important:
l Agent name
l Start the agent.

l Click the link View log files and select the most current log file (it has the number "00"). The
section [WEBSPHERE] must be included in the log file.
5. Important notes for the creation of jobs
l Host
l The agent now uses the SOAP Connector. Therefore, select "Remote Java VM" in the Job object's
JMX tab.
l Enter the term "websphere" in the field Initial Context Factory:
Host name of the WebSphere:SOAP Port
l 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.
l 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.
Setting Up the Agent for J2EE/JMX (JBoss)
Security.
Supplied files
Procedure
l Host
l Copy the file ucxjjmx.war to a folder and use an appropriate program to unpack it.
l 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>).
l Rename the folder in which the agent files are stored. The name must end with the string ".war".
A sample folder name: ucxjjmx.war
l 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. Using the web configuration interface
l Host
l 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 Host
l Activate the sub-menu "Use existing MB Server".
l It is not necessary to select the option "Generate new instance..."
Setting up the Agent for J2EE/JMX (Oracle Containers for J2EE)
Security.
Supplied Files
The J2EE/JMX agent files are available in the folder IMAGE:AGENTS\JMX.
Procedure
l Host
l Log on to the Enterprise Manager (http://localhost:8888/em).
l Select the Applications tab and click Deploy.
l Click Browse and select the file ucxjjmx.war. Then click Next.
l Type "uc4" in the text field Application Name, and then click Next.
l Click Deploy. Messages referring to the deploy procedure are displayed.
l Host
l The JMX agent has a Web configuration interface; it can be called in a Web browser using the
following address:
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:
l Name of the agent

l Host
l In the Job object's JMX tab, select the option Remote Java VM.
l In the field Initial Context Factory , enter the term "oc4j."
service:jmx:rmi://Host name of the Oracle J2EE Server:Port/oc4j
Setting up the Agent for J2EE/JMX (SAP NetWeaver)
Additional installation steps are required before the agent can be started and used, if you intend to use one
Security.
The agent creates an additional log file in SAP format. This file is automatically stored in the agent's
subfolder "log" in the installation directory. It can easily be processed with SAP Tools.
Setting up the J2EE/JMX agent is only possible with a SAP NetWeaver Composition Environment 7.1
Application Server.
Supplied files
Procedure
l Host
l Copy the file ucxjjmx.sca to the input directory of the Java Support Package Manager (for example
C:\usr\sap\trans\EPS\in).
l Start the Java Support Package Manager (JSPM) and log on to the JEE Engine.
l JMX agent new installation: In step 1 of Start Deployment, select "New Software Components"
under Select Package Type. Click Next.
l 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.
l In the next step, ensure that the JMX agent is in the queue. If it is, click Start to initiate the setup
procedure.
l When this process is complete, click Exit to end the JSPM.
2. Removing the JMX Agent
l Host
l Use the program Undeploy View in the SAP Netweaver Developer Studio to remove the JMX
agent.
l Select the software component JMX_Agent (automic.com) from the list and click Add to
Undeploy List in the menu that pops up.
l Now execute the Undeploy function in order to remove the agent.

l Host
l A Web configuration interface is available for the JMX agent. It can be called from:
http://Sap server name:Port/ucxjmx
l This interface can be used to adjust the JMX agent to your system environment. The following are
particularly important:
l Agent name
l Host
l Select JNDI in the JMX tab of the Job object. Enter "jmx" as the object name.
Setting Up the Agent for J2EE/JMX (Tomcat)
Security.
Supplied files
Procedure
l Host
l Start Tomcat and call the Tomcat Web Application Manager.
l 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.
l 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"/>
Restart Tomcat to apply the roles.
l The JMX agent is displayed in the section "applications" of the Web Application Manager.

l Host
l 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".
l 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
Web Configuration Interface for the J2EE/JMX Agent
A web configuration interface is available for adjusting the JMX agent to your system environment.
It can be accessed with a Web browser using the address shown below:
http://Server name:Port/ucxjjmx
When Tomcat is used, the configuration interface can be called directly by using the Web Application
Manager.
Field/Control element Description

Status Indicates whether a JMX agent is currently running
Start time JMX agent's start date and time
Current time The current date and time
Host Computer on which the application server is available
Name Name of the agent
(maximum 32 characters)
System Name of the AE system
CP host Name of the computer on which a communication process is available
CP port Port number of the communication process
Language Language used for logging
Allowed values: "E" (English), "D" (German), "F" (French)

Write agent log to disk The log file is stored as a text file.
Log count Number of stored log files
Change logging every A new file is created if the log file reaches the size specified here.
Auto-run The JMX agent is started automatically.

TCP/IP Trace Activates the TCP/IP Trace.
Set trace flags only in close cooperation with our support team!
Encrypted communication Activates encryption for transfers
Application Server Type of application server on which the JMX agent runs
The log files can be accessed via a link of the same name.
Installing the Agent for NSK
This document guides you through the new installation of an NSK agent.
used.
Security.
A three-character code is assigned to each supported NSK version. It is shown in the agent's file name
and described in the Terminology (NS1 for NSK, Version D40 and later).
Requirements
l Network protocol TCP/IP is available.
l A User ID has been created for the installation.
l Entry #set #informat tacl in the TACLCSTM file for each user who executes jobs in AE.
l OSS and NetBatch must be installed in order to be used for job executions.
l 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.
CallAPI files and their implementation are described in a separate document.
Procedure
l Admin computer
l Establish a connection to the host via an FTP client and transfer the two supplied files OINSTALL
and UC4AR to a common sub-volume.
l The file OINSTALL must be transferred in text mode (code 101) and UC4AR in binary mode
(code 0).
l Automic strongly recommends storing these files in an empty sub-volume.

l The file UC4AR is a self-extracting archive that contains all the files that the NSK agent
requires.
2. Starting the installation procedure
l Host
l Start a terminal emulation program and log on using the user who should be the program owner.
l Change to the sub-volume to which the two files have been transferred.
l Set the following command in the TACL input line:
O OINSTALL
l 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.
3. Adjusting the configuration file INSTINI
l Host
l The file INSTINI contains several parameters that must be adjusted to your system environment.
l Lines that start with the characters with %% are comments.
l Blanks can be ignored, they are irrelevant.
l Specify the parameters in the following format: <parameter name>=<value>.
The parameter name is predefined and cannot be changed. Its corresponding value depends on
your system.
l The file INSTINI must be stored in the same sub-volume as all other installation files
(OINSTALL, INSTALL).
l Automic strongly recommends using empty sub-volumes for volume specifications in order to
avoid conflicts with other programs.
AE-PROGRAM-SUBVOLUME= Sub-volume for the executable agent files.
AE-STATUS-STORE-SUBVOLUME= Sub-volume for the StatusStore files of file
transfers.
The agent automatically created StatusStore files.

They store the restart information of active file
transfers. This mechanism ensures that aborted
file transfers can be restarted from a particular file
position (= last restart point). Restart points are
created in regular intervals (setting FT_
RESTART_INTERVAL in the variable UC_
HOSTCHAR_DEFAULT). On Nonstop systems,
the StatusStore files are the following 4 Enscribe
Files with the default names: UC4SST, UC4SSD,
UC4SSL, UC4SSH. You can subsequently
change these file names in the agent's INI file.
AE-STATUS-STORE-AUDITED= Stores StatusStore files of file transfers as

Audited Files (TMF protection).
Allowed values: "Y" (recommended default value)

or "N"
AE-TCPIP-PROCESS= Name of the NonStop TCP/IP process name that
the agent should use. By default, $ZTC0 is
specified (system standard).
If you specify a different process name, the

required ADD DEFINE TACL statement is
automatically inserted in the startup obey file.
AE-SERVER-PORT Port number of the Automation Engine's
communication process to which the agent should
connect. Ensure that all affected firewalls are
configured for this port.
AE-AGENT-PORT= Port number that the agent should use in order to
contact other agents. This port cannot be used by
other programs.
AE-SERVER-IP-ADDRESS= IP address or computer name of the Automation
Engine.
AE-AGENT-PROCESS= Process name of the agent process.
AE-OC-PROCESS= Process name of the AE output collector process.
AE-TSIM-PROCESS= Process name of the AE terminal simulator
process.
AE-SYSTEM-NAME= Logical name of the AE system (Automation
Engine)
AE-AGENT-NAME= Logical name of the agent instance.
By default, the system name of the NonStop

Server without "\" is used as the agent name:
AE-AGENT-NAME=%NODENAME%
You can also extend the agent name using pre- or

postfixes.
For example:
AE-AGENT-NAME=UC4%NODENAME%EXE
AE-TEMP-SUBVOLUME= All temporary files, such as job reports and job
files, are stored in this sub-volume.
l 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. Continuing the installation
l Host
RUN INSTALL
l You receive notifications about the installation progress and can terminate it at any time. In this
case, a manual cleanup process can be required.
l A connection to the Automation Engine is established when the installation is complete.

l Verify that the agent is logged on.
l Start the UserInterface for client 0000. Information about agents is available in the System
Overview. Newly logged-on agents have not been assigned a client, so they can only be
viewed in client 0000. The newly installed agent can then be assigned to clients using the
5. Starting and stopping the Agent
l Host
l Change to the agent's subvolume and set the following command in the TACL input line:
O EXSTART
l The following command stops the agent:
O EXSTOP
See also:
EMS template file
Installing the Agent for OS/400
This document guides you through the new installation of an OS/400 agent.
used.
Security.
A three-figure abbreviation is provided for each supported OS/400 version. It is part of the agent's file name
and is described in the Terminology.
Requirements
l TCP/IP
Supplied Files
The OS/400 agent is supplied as a binary SavFile. This file can be found in the subdirectory
IMAGE:AGENTS\AS400.
The CallAPI files and CallAPI implementation are described in a separate document.
Procedure
1. Transferring the file to the host
l Host
l Create a temporary library for Save File:
CRTLIB LIB(UC4TMP)
l Create an empty Save File.
CRTSAVF FILE(UC4TMP/UC4)
l Create a library for restoring the Save File.
CRTLIB LIB(UC4AUSL) TYPE(*PROD) TEXT('UC4')
l Admin computer
l 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. Creating the library
l Host
l Create the library.
RSTOBJ OBJ(*ALL) SAVLIB(UC4AUSL) DEV(*SAVF) SAVF(UC4TMP/UC4)
l Delete the temporary library.
DLTLIB LIB(UC4TMP)
l Rename the library.
RNMOBJ OBJ(QSYS/UC4AUSL) OBJTYPE(*LIB) NEWOBJ(UC4)
l Server computer
l Host
l Adjust the INI file UC4/INI(UCXJO41).
l 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. Creating the start and end programs
l Host
l 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. Starting or ending down the Agent
l Host
l 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.
l The program UCEX_END ends the agent.
Overview. A newly logged-on agent is only visible in client 0000 because it has not yet been
assigned to a client. Via the Agent object, you can now assign the new agent including the
required rights to the particular clients.
Method 2
4. Including the library in the library list
l Host
l 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. Starting or ending the Agent

l Host
l 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 INI file UC4/INI(UCXJO41).
STRUCAGENT LIB(UC4) PATH('/user/uc4/ucxjo41.ini')

Starts the agent from the library by using an INI file that is stored in the IFS file system.
l The command ENDUCAGENT ends the agent.
ENDUCAGENT LIB(UC4) OPTION(*CNTRLD)

Ends the agent that has been started from the library in a controlled manner.
ENDUCAGENT LIB(UC4) OPTION(*IMMED)

Aborts the agent that has been started from the library with ENDJOB.
l For further information about commands, see: KnowledgeBase.
Installing the Agent for PeopleSoft
Installing the Agent for People Soft (UNIX) - Basics
This document guides you through the new installation of a PeopleSoft agent.
Process scheduling in PeopleSoft uses components of PeopleTools. The PeopleSoft agent can be
implemented for all PeopleTools versions that are supported by AE. See:Requirements for Operating AE.
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.
Automic strongly recommends installing the agent in a separate directory (such as

UC4/Agent/peoplesoft).
Requirements
l Valid Operator IDs for executing tasks in PeopleTools
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:
Technical Implementation
Component Interfaces (Java classes) can be used to connect the agent to PeopleSoft/PeopleTools.
1) People Tools with AE Interface (Java Classes)
Job processing is accessed via Java Classes of the UC4_* component interfaces.
2) People Tools with Standard Interface (Java Classes)
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.
Steps for Starting Up

Check Step Optional
Installing the AE Interface
Transferring the Agent's tar file to the Host and unpacking it
Adjusting the Agent's configuration file
Creating start script
Using ERP Forms
Shortening the interval for task checking in PeopleSoft
Editing ERP Login
Defining operator IDs in AE
Testing the PeopleSoft connection
Functional test
Entering the Agent's start script for system start
Configuration for using Bind Variables
Configuration for using the RemoteTaskManager
Installing the Agent for People Soft (UNIX) - Details
1. Installing the AE Interface
The complete installation process of the AE interface is described in a separate document.
AE's interface is required in order to use bind variables.
2. Adjusting values in the field OUTDESTTYPE (PeopleSoft)
l Host
l 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.
l Start the PeopleSoft Application Designer.
l Select File --> Open.
l Open the field (Definition: Field) "OUTDESTTYPE" (Name).
l Open the "Definition Properties"either via "File" -> "Definition Properties" or use the shortcut ALT
+ ENTER.
l In the Translate Values tab, change the table as follows:
Value Active Eff Dt Long Name Short Name

0 01.01.1899 Any Any
1 01.01.1899 (None) NONE
2 01.01.1899 File FILE
3 01.01.1899 Printer PRINTER
4 01.01.1899 Window WINDOW
5 01.01.1899 Email EMAIL
6 01.01.1899 Web WEB
7 01.01.1899 Default DEFAULT
l Click OK tab to close the properties window.

l Store the field: File --> Save .
3. Transferring the Agent's tar file to the host and unpacking it
l Host
l Transfer the TAR file UCXJPSX.tar.gz to a directory (such as peoplesoft) via FTP.
l Change to the PeopleSoft directory:
cd peoplesoft
gzip -d UCXJPSX.tar.gz
tar xvfo UCXJPSX.tar
l The actual files are created in the corresponding directories. Delete the TAR file after unpacking is
complete.
l Check for TAR messages (which can be caused by various users) and make sure that all files
have been correctly unpacked.
l 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. Adjusting the Agent's configuration file
l Host
l Activate the interface in the [PRCS_SBB_JAVA] section of the installed agent's INI file with
ENABLED=1.
l 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, 8.54
l Set the environment variable for the agent if an environment variable is used in the PeopleTools
configuration file (Log/Output Directory=).
The psjoa.jar file's content was changed as of People Soft version 8.54. Some Java classes are
missing from it. They may be found in the People Soft 8.54 Internet Architecture installation in the
following directory:
<PS_HOME>\webserv\peoplesoft\applications\peoplesoft\PORTAL.war\WEB-
INF\classes
You have to add the psjoa.jar and the missing classes to the CLASSPATH of the following
components:
1. People Soft Agent (to enable job execution)

2. UserInterface (to order to be able to use FORMS, when defining People Soft Jobs).

l Adjust HEADER.PS, TRAILER.PS and RESTART.PS if required. See: Job - Execution.
5. Creating the start script
l Host
l 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.
l 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 &
l 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.

l The PeopleSoft Java Object Adapter is required in order to use PS ERP Forms.
l Adjust the UserInterface's INI-file entry "classpath" accordingly (psjoa.jar).
Example:
[ENVIRONMENT]
classpath=.;.\psjoa.jar;.\ucdj.jar
7. Shortening the interval for checking tasks in PeopleSoft
Automic recommends reducing the frequency with which jobs are checked. This requires creation
and installation of a separate variable for the host characteristics of the installed agent.
l Start the UserInterface for client 0000.

l Duplicate the variable UC_HOSTCHAR_DEFAULT and rename it to UC_HOSTCHAR_<Agent
name>.
l Reduce the entry JOB_CHECKINTERVAL from 60 to 15 seconds in this new variable.
l Change the entry for the PeopleSoft agent from DEFAULT to <Agent name> in the variable UC_
EX_HOSTCHAR.
8. Editing ERP Login
For the agent's start-up phase, you need a login for the PeopleSoft application (Operator ID,
password). This information is stored in client 0000, Login object ERP_LOGIN.
l Start the UserInterface and log on to client 0000.

l Create a Login object using the name ERP_LOGIN.
(If you use a different name, adjust the variable UC_HOSTCHAR_* with the key APPLICATION_
LOGIN.)
l Enter your login data (host type = "PS", login info = operator Id, password).
9. Defining operator IDs in AE
Operator IDs are required in order to execute tasks in PeopleSoft. AE must know the passwords for
these user IDs. Enter the operator ID and password in the Login object of the client that is used to
execute the tasks.
l Start the UserInterface for the client in which the tasks should be executed.
l Enter all required Operator IDs, including the login specifications, in the Login object.
10. Testing the PeopleSoft connection
l 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. Functional test
l Server computer
l The Automation Engine must be running.
l Host
l 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.
l Admin computer or Servercomputer
l 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.
l Admin computer/host
l 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.
l 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.
l Check the job report.
l Check the agent's log file.
l PeopleSoft online
l Verify in PeopleSoft whether the task was correctly executed.
l Shut down the PeopleSoft agent.
12. Entering the Agent's start script for system start
l 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. Configuration for using bind variables (optional)
l Some additional settings must be specified if bind variables will be used in PeopleSoft processes.
l AE's interface must be installed in order to use this function.
l 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 MS SQL
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;
0
COMMIT;
The following SQL script is required if you use PeopleSoft version 8.2x or 8.4x:
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
RESTARTENABLED,
SYSDATE,
'UC4'
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:
SELECT 'UC4_' + PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
LEFT('UC4_' + PRCSTYPEDESCR,30),
RESTARTENABLED,
GETDATE(),
'UC4',
0
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
RESTARTENABLED,
GETDATE(),
'UC4'

ORIG.OPSYS,'UC4_' + ORIG.PRCSTYPE, ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG WHERE 0 =
AND SC.PRCSTYPE='UC4_' + ORIG.PRCSTYPE )
AND 0 <
WHERE PT.PRCSTYPE='UC4_' + ORIG.PRCSTYPE
l Automic strongly recommends extensive testing for jobs that use bind variables. More detailed
information is provided in the document bind variables.
14. Configuration for using the RemoteTaskManager (optional)
l Using a RemoteTaskManager object requires the prior generation of an SQL View.

l Start the Application Designer.
l Open the project that was supplied by AE.
l Select "Build," the "Project." Select the setting "Create Views."
l Generate the SQL View.
Installing the Agent for People Soft (Windows) - Basics
Process scheduling in PeopleSoft is executed via PeopleTools components. The PeopleSoft agent can
be implemented for all versions of PeopleTools supported by AE. See:Requirements for Operating AE.
Advanced Security.

C:\AUTOMIC\AGENTS\PEOPLESOFT).
Requirements
l Valid Operator ID's for executing tasks in PeopleSoft
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 Entry in the agent's INI file for transferring the log files to AE
l Read permission for PeopleSoft process log files
l Read permission for the configuration file of the PeopleSoft Process Scheduler Batch Server
l Correct entry in the configuration file at the parameter "Log/Output Directory="
l Agent knows the environment variable which might be used for "Log/Output Directory="
These are the requirements for using AE's Interface:
l The AE interface must have been loaded to the PeopleTools database, validated and authorized for
full access with the Application Designer
l The AE interface must have been activated in the agent's INI file
Supplied Files
The directory IMAGE:AGENTS\PEOPLESOFT\WINDOWS. contains the necessary files.
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.
Component Interfaces (Java classes) can be used for connecting the agent to PeopleSoft/PeopleTools.
1) People Tools with AE Interface (Java Classes)
Accesses for job processing are made via the Java Classes of the supplied UC4_* component interfaces.
2) People Tools with Standard Interface (Java Classes)
Accesses for job processing are made via the Java Classes of the PROCESSREQUEST component
interface.
Steps for Starting Up

Check Step Optional
Installing the Microsoft Visual C++ 2010 Redistributable Package
Installing the AE Interface
Installing the agent and setting up the system environment
Using ERP Forms
Shortening the interval for task checking in PeopleSoft
Editing ERP Login
Defining operator ID's in AE
Testing the PeopleSoft connection
Functional test
Configuration for using Bind Variables
Configuration for using the RemoteTaskManager

Installing the Agent for People Soft (Windows) - Details
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!

command.
java -version
If several JRE or Java SDK Versions are installed on the computer, the order of the directories
indicated in the settings of %PATH% or $PATH is relevant. The particular Java Runtime
Environment that is first found in the listing of directories is applied.
can deactivate it in the system control as AE does not need it.
3. Installing the AE Interface
The AE interface installation process is described in a separate document.
AE's interface is required or use bind variables.
4. Adjusting values in the field OUTDESTTYPE (PeopleSoft)
l Host
l 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.
l Start the PeopleSoft Application Designer.
l Select "File" --> "Open".
l Open the field (Definition: Field) "OUTDESTTYPE" (Name).
l Then open the "Definition Properties"either via "File" -> "Definition Properties" or use the
shortcut ALT + ENTER.
l In the Translate Values tab, change the table as shown below:
Value Active Eff Dt Long Name Short Name

0 01.01.1899 Any Any
1 01.01.1899 (None) NONE
2 01.01.1899 File FILE
3 01.01.1899 Printer PRINTER
4 01.01.1899 Window WINDOW
5 01.01.1899 Email EMAIL
6 01.01.1899 Web WEB
7 01.01.1899 Default DEFAULT
l Click "OK" to close the properties window.

l Store the field: "File" --> "Save" to assume the modifications you made.
5. Installing the Agent and setting up the System Environment
l Host
l 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).
l The AE program group is automatically created or the agent entered.
l Adjust the INI file
l Set the environment variable for the agent if an environment variable is used in the PeopleTools
configuration file (Log/Output Directory=).
l 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.
l The component interface must be activated (ENABLED=1) in the [PRCS_SBB_JAVA] sections.
l 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, 8.54
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.
The psjoa.jar file's content was changed as of People Soft version 8.54. Some Java classes are
missing from it. They may be found in the People Soft 8.54 Internet Architecture installation in the
following directory:
<PS_HOME>\webserv\peoplesoft\applications\peoplesoft\PORTAL.war\WEB-
INF\classes
You have to add the psjoa.jar and the missing classes to the CLASSPATH of the following
components:
1. People Soft Agent (to enable job execution)

2. UserInterface (to order to be able to use FORMS, when defining People Soft Jobs).

l Adjust HEADER.PS, TRAILER.PS and RESTART.PS as required. See: Job - Execution
Please use the ServiceManager to start the agent as a service.
6. Using ERP Forms(optional)
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.
l Enter the agent name and Connect string to the variableUC_EX_ERP_CONNECTwhich is
supplied in client 0.
l Adjust the entry "classpath" accordingly (psjoa.jar) in the UserInterface's INI file.
Example:
[ENVIRONMENT]
classpath=.;.\ucdj.jar.;.\psjoa.jar.;.\ucxjps84.jar
7. Shortening the Interval for Task checking in PeopleSoft
We recommend shortening the interval for job checking. This required that a separate variable is
created for the host characteristic and assigned to the installed agent.
l Start the client "0000" UserInterface

l Duplicate the variable UC_HOSTCHAR_DEFAULT and rename it to UC_HOSTCHAR_<Agent
name>.
l Reduce the entry in JOB_CHECKINTERVAL from 60 (seconds) to 15 in this new variable.
l Change the entry for the PeopleSoft agent in the variable UC_EX_HOSTCHAR from DEFAULT to
<Agent name>.
8. Editing ERP Login
The agent's start-up phase requires login data for the PeopleSoft application (operator ID,
password). This information is stored in client 0000, Login object "ERP_LOGIN"
l Start the UserInterface and log on to client "0000".

l Set up the Login object using the name "ERP_LOGIN".
(If you prefer using a different name for the Login object, adjust it in the variable UC_HOSTCHAR_*
using the key APPLICATION_LOGIN.)
l Enter your login data (host type = "PS", login info = operator Id, password).
9. Defining Operator IDs in AE

Operator IDs are required for the execution of tasks in PeopleSoft. AE must know the passwords
for these user IDs. The operator ID and password is assigned in the Login object of the client used
to execute tasks.
l Start the UserInterface for the client in which tasks should be executed.
l Enter all required Operator IDs with the login specifications in the Login object.
10. Testing the PeopleSoft Connection
l 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.
11. Functional
l Server computer
l The Automation Engine must be running.
l Host
l 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".
l Admin computer or server computer
l 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.
l 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.
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.
l Check the job report
l Check the agent's log file.
l PeopleSoft Online
l Verify if the task was correctly executed in PeopleSoft
l Close/shut down the PeopleSoft agent
12. Configuration for using Bind Variables (optional)
l Some additional settings need to be specified when bind variables should be used in PeopleSoft
processes.
l Keep in mind that this function requires the AE interface to be installed.
l 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:
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
RESTARTENABLED,
SYSDATE,
'UC4'
0
COMMIT;
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
RESTARTENABLED,
SYSDATE,
'UC4'
COMMIT;


ORIG.OPSYS,
'UC4_'||ORIG.PRCSTYPE,
ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG
WHERE 0 =
AND SC.PRCSTYPE='UC4_'||ORIG.PRCSTYPE )
AND 0 <
WHERE PT.PRCSTYPE='UC4_'||ORIG.PRCSTYPE
COMMIT;
MS SQL Server:
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
RESTARTENABLED,
GETDATE(),
'UC4',
0
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
RESTARTENABLED,
GETDATE(),
'UC4'

ORIG.OPSYS,'UC4_' + ORIG.PRCSTYPE, ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG WHERE 0 =
AND SC.PRCSTYPE='UC4_' + ORIG.PRCSTYPE )
AND 0 <
WHERE PT.PRCSTYPE='UC4_' + ORIG.PRCSTYPE
l We recommend testing jobs which use bind variables extensively. More detailed information is
provided in the document bind variables.
13. Configuration for using the RemoteTaskManager (optional)
l Using a RemoteTaskManager object requires the prior generation of an SQL View.

l Start the Application Designer.
l Open the supplied project.
l Select the Project item in the Build menu. The setting "Create Views" must be selected.
l Generate the SQL View.
Automation Engine Interface
AE offers efficient component interfaces for integrating PeopleTools processes into AE job processing.
The component interfaces work independently of the PeopleTools Database in use. It also offers an
extended range of functions, such as script elements. The collection of all UC4_* Component Interfaces is
called AE interface.
Requirements
The following requirements must be met in order to use the AE interface:
l PeopleTools Application Designer

l Authorization to import projects into the PeopleTools Database
l Authorization to set access authorizations in PeopleSof.
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.
Procedure
1. Importing the project to the PeopleTools database
l Host
l Import the project files that correspond to your version of PeopleTools.

l Start the Application Designer from PeopleTools in the "2 Tier Mode" (with direct connection to
database).
l 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.
l Select the project and click Copy (8.2x).
l Load all project data into the PeopleTools database. Select all object types and click Copy.
2. Testing the component interfaces
l Host
l 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.
3. Setting Access Authorization
l Host
l 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
l The component interface is activated through an entry in the AE agent's INI file.
See also:
PeopleSoft Agent (Windows), INI-file structure
Creating Java Classes
Windows can access the AE interface and the PeopleTools PROCESSREQUEST Component Interface
through Java Classes. A Java Development Kit (SDK) is required in order to create Java Classes. You
can use a Java Runtime Environment (JRE) to call the PROCESSREQUEST_SBB component interface
using the PeopleSoft agent. This document describes the creation of required Java Classes.
AE supplies completely created Java classes.
l UCXJPS82.jar - for PeopleTools versions 8.1 and 8.2

l UCXJPS84.jar - for PeopleTools versions 8.44, 8.45, 8.46 and 8.49
Manual creation of Java classes is only required if the supplied JAR 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
Install Java SDK according to the manufacturer's instructions.
Enter the path for the JAVA VM in the Windows path variable. Note that the file JVM.DLL must not be
stored in the BIN directory of the agent.
l Host
l Open a component interface (PeopleSoft version 8.1* and 8.2*: SBB_PRCSPARAM, PeopleSoft
version 8.4*: UC4_PROCESSREQUEST) in PeopleTools Application Designer.
l From the "Build" menu, select "PeopleSoft APIs."
l Check the "Build" check box under "Java Classes" and enter the %PS_HOME%\web\PSJOA
directory as the target directory for the generated files.
l Select the following APIs and confirm by clicking OK.

l CompIntfc.CompIntfcPropertyInfo
l CompIntfc.CompIntfcPropertyInfoCollection
l CompIntfc.UC4*
and all APIs from

l PeopleSoft.CompIntfcCollection
up to and including
l 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.
As a result, all Java Classes are found in the folder %PS_

HOME%\web\PSJOA\PeopleSoft\Generated\CompIntfc as sources.
3. Compile Java Classes
l Host
l Navigate to the folder %PS_HOME%\web\PSJOA\PeopleSoft\Generated\CompIntfc.
l Compile all Java sources with the command:
javac -classpath .;..\..\..\psjoa.jar *.java
It is important that no error messages are displayed.
l The following JAR command packs the classes in a file:
jar -cvf ae.jar *.class
Setting Up the Agent for Rapid Automation
Security.

UC4/Agent/rapidautomation or C:\AUTOMIC\Agent\rapidautomation).
RA.
Supplied Files
The files that belong to the RA agent are stored in the directory IMAGE:AGENTS\RAPIDAUTOMATION.
Procedure
available.

command:
java -version
l Host
l 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.
l The RA Solution to be used by the agent will be stored in the folder named "cache." Create this
folder in the installation directory.
l Several settings are available for adjusting the RA agent to your system environment. Of note are
should connect. Adjust the INI file.
3. Loading the RA Solution
l Host
l Start the utility AE.DB Load 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
(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 After loading the RA solution, you need to restart the UserInterface.
l 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.
l 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. Creating Connection objects

l Host
l Log on to system client 0000.
l 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.
l Host
l The RA agent only starts if an Agent object of the same name exists in system client 0000.
l 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.).
l 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 RA solution, 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.
(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. Important notes for Job creation
l Host
l 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.
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.
Installing the Agent for SAP
Preparing Installation - Check List
The following table lists the requirements for installing an SAP agent.
Ensure that you have the following information ready before you start the installation:
Step Description Optional Check

1 Access to the SAP Service Marketplace (http://service.sap.com)
Name:
Password:
2 SAP user administrator
Name:
Password:
3 SAP Transport-system administrator (when using the AE interface)
Knowledge of how to use the transport system at the operating system

level, depending on the operating system
SAP System administrator
Name:
Password:
SAP Transport-system administrator (when operating the system with

SAP GUI)
Name:
Password:
4 Parameter for RFC access to the particular SAP system
SAP System name
Name=
Computer name of an SAP Instance or SAP Router String
host name=
SAP System number
sysnr=
Computer name or SAP Router String of the Message Server (optional)
lb_host=
Logon group (optional)
lb_group=
5 SAP Presentation CD (depending on the operating system)
6 Access to the operating system
7 TCP/IP access to the Automation Engine
8 Agent name
Name:
9 AE installationation CD or directory
10 Access to the AE system client 0000
Name:
Password:
Installing the Agent for SAP - Basics
This document guides you through the new installation of an SAP agent.

C:\AUTOMIC\AGENT\SAP).
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 For 4.6C: SAPKB46C52

l For 6.20: SAPKB62059
Supplied Files
The files can be found in the directory IMAGE:AGENTS\SAP\UNIX or
IMAGE:AGENTS\SAP\WINDOWS.
Startup
Check Step Optional
Installing the Microsoft Visual C++ 2010 Redistributable Package
Installing the Java Runtime Environment (JRE)
Installing the agent (UNIX)
Installing the agent (Windows)
Installing SAP Java Connector
Importing the AE Interface
Creating a CPIC User
Creating Connection objects
Setting up the Agent object
Starting the agent
Function testing
Installing the Agent for SAP - Details
This document guides you through the new installation of an SAP agent.
1. Installing the Microsoft Visual C++ 2010 Redistributable Package (Windows)
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
l Install the package from the directory IMAGE:CRTS.
If the required version of JRE is already available, you can skip this step.

l Use the following command to check the version of the Java Virtual Machine (VM) that is currently
installed:
java -version
If several JRE or Java SDK Versions are installed on the computer, the order of the directories
indicated in the settings of %PATH% or $PATH is important. The Java Runtime Environment that
is first in the list is used.
can deactivate it in the system control if you prefer; AE does not need it.
3. Installing the Agent (UNIX)
l Host
l Log on using the user AE
l Transfer the TAR file UCXJR3X.tar.gz to a directory (such as SAP) via FTP.
l Switch to the SAP directory:
cd sap
l Unpack the TAR file:
gzip -d UCXJR3X.tar.gz
tar xvfo UCXJR3X.tar
Through this process, the files are created. The TAR file can be deleted after unpacking.
l Note: Make sure that all files are correctly unpacked and be sure to note of all TAR messages,
which can come from various owners.
l Check to make sure that all files have the correct owner and group entries. AE must be the owner.
The group entry must correspond to the user AE. Modifications can only be made by a privileged
user, such as root.
chown UC4 * changes the owners of all files to AE.
chgrpGroup name * changes the user group of all files.
l Rename the supplied INI file UCXJxxx.ori.ini to UCXJR3X.ini.
l Adjust the INI file to your system environment.
4. Installing the Agent (Windows)
l Switch to the subdirectory IMAGE:AGENTS\SAP\WINDOWS.

l Start the program SETUP.EXE.
l Adjust the INI file to your system environment.
l Adjust HEADER.SAP, TRAILER.SAP, RESTART.SAP or HEADER.SAPBW,
TRAILER.SAPBW and RESTART.SAPBW, as necessary. See: Job - Execution.
l The SAP agent is an AE background program. It is generally started as a service in the Service
Manager.
5. Installing the SAP Java Connector
l Host
l 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.
l To see which Java Connector version is supported, Refer to the requirements of the SAP agent.
l Install the 32bit SAP JAVA Connector if you use 32bit Java. 64bit Java requires the 64bit
SAP Java Connector.
l Download the SAP Java Connector from the SAP Service Marketplace and install it (Support Portal
-> Downloads -> SAP Connectors -> SAP Java Connector -> Tools & Services).
l Copy the SAP Java Connector filesto the BIN directory of the agent.
l The SAP note 636912 includes information that can be used to verify that the Java Connector
has correctly been installed.
6. Importing the AE Interface
l Host
l This installation step is only required if you intend to use the AE interface.
l Copy the transport files.
l Import the transport.
l See also: Transporting the AE Interface.
7. Creating a CPIC User
l Host
l Log on to the SAP system using the SAP user administrator.
l Create an authorization profile either directly or with a role.
l Create the CPIC user and assign the authorization profile or role.
l Note that you must create this CPIC user with the same password in each SAP client in which
you want to run jobs.
8. Creating Connections Objects
l The SAP agent requires login data to log on to the various SAP areas.
l Start the UserInterface and log on to system client 0000.
l Create an extra Connection object for the SAP areas to be used with the SAP agent (see table
below). At least one Connection object for the SAP basis is required in which you specify the CPIC
user. All other Connection objects are optional.
l In the Connection object, select the type and enter your login data.
SAP Connection type

ABAP Basis Remote Function Call
Java Basis Internet
Process Integration Internet
System Landscape Directory Internet
l SAP distinguishes between uppercase and lowercase letters. Keep this in mind when you enter
the password.
9. Setting up the Agent Object

l Switch to the folder HOST.
l Create an Agent object.
l As agent name, use the same name as specified in the SAP agent's INI-file parameter name=.
l Open the Agent object and switch to the agent tab.
l Select the Connection objects you created previously.
l Store and close the Agent object.
l You can choose to omit this installation step and start the agent immediately (see next step). In
this case, an Agent object is automatically created, but it is necessary to end it afterwards. Select
the Connection object and restart it.
10. Start the Agent
l Server computer
l Host
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:
"C:\Program Files (x86)\Java\jre7\bin\java" -jar -Xrs -Xmx256M
ucxjr3x.jar
l UNIX:
<path to java> -Xmx256M -jar ucxjr3x.jar
Example:
/usr/bin/java -jar -Xmx256M ucxjr3x.jar
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.
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.
l Verify that the agent for SAP BW has logged on.

l 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

l 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.
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.
l Check the job report.
l Check the agent logins in the log file.
l SAP System
l Check the log entries from the current period with the transaction RZ15 (only when using the
standard interface).
l Shut down the agent.
Installing the Agent for Siebel (Windows)
This document guides you through the new installation of a Siebel agent.
to use one of the available authentication methods. For more information, see Advanced Security.
Automic strongly recommends installing the agent in a separatedirectory (such as

C:\AUTOMIC\Agent\SIEBEL).

The files are found in the directory IMAGE:AGENTS\SIEBEL\WINDOWS.
File name Description

UCXJSLX.EXE Siebel agent.
UCXJSLX.INI INI file for Siebel agent.
UC.MSL Message library.
ZU00132.DLL Runtime library for shared functions.
ZUSYNCHK.DLL Runtime library for syntax checks.
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. Installing the Microsoft Visual C++ 2010 redistributable package
This installation step can be ignored if the required version of the package is already installed.
l Host
2. Installing the Agent and setting up the system environment
l Host
l Start the program SETUP.EXE in the directory IMAGE:AGENTS\SIEBEL\WINDOWS.
You can change the drive if necessary. For the installation target, you must use the directory
C:\AUTOMIC\AGENTS\SIEBEL. Start installation by clicking the big button (computer, packaging
and diskette).
l The AE program group is automatically created and the agent is entered.
l Adjust the INI file UCXJSLX.INI to the system environment.
l Adjust HEADER.SIEBEL, TRAILER.SIEBEL and RESTART.SIEBEL if necessary. See: Job -
Execution.
l Server computer
l Host
l Start the agent from the AE program group.
l Start the UserInterface for client 0000. Call information about agents in the System
Overview. Newly logged-on agents have not yet been assigned to a client, so they can only
be viewed in client 0000. The newly installed agent can now be assigned to clients with the
required rights through the Agent object.
l Host
Right-click the agent in the task bar. Select Exit.
Installing the Agent for UNIX
This document guides you through the new installation of a UNIX agent.
Each supported UNIX variant is assigned a three-character code. This code appears in all of the agent's
file names and is described in the terminology. In this document the specific code is replaced by "???."
64-bit UNIX platforms: Automic recommends using a 64-bit agent in order to start 64-bit programs and
applications. Problems may occur when you use a 32-bit agent for this purpose.
Advanced Security.
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 User ID AE has been created.
l The following authorizations are required for the directories "out" and "temp":
For owner: right to read and execute

For group: right to execute
For world: right to execute
Note that authorizations must not be changed while the agent is running.
When a login is specified in the script element PREP_PROCESS, the event file is created in
the HOME directory of the user for security reasons. If no login is specified, the system
assumes that the succeeding event job runs with agent rights. Therefore, PREP_PROCESS
creates the file name with the temp path of the agent.
At the time when PREP_PROCESS is being processed, the system does not know whether
the job will use a login or not. From a technical perspective, this cannot currently be determined,
because the event job could also specify the login dynamically (with a PUT_ATT script
statement). There are two possible solutions:
1. Specify a login in PREP_PROCESS (recommended by Automic and secure solution).

2. Assign read and write access to the temp directory of the agent to the user who is defined in
the Event job.
Authorizations for jobreport files are specified using the INI-file parameter ReportMode=.
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.
Each TAR file can be found in the subdirectory of IMAGE:AGENTS\UNIX that corresponds with the
appropriate UNIX version.
The CallAPI files and their implementation are described in a separate document.
Procedure
0. Rights of the user ID "AE"
l Host
l 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 Host
l Register with user ID AE.
l Transfer the TAR file ucxj???.tar.gz via FTP.
l 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 Note any TAR messages and verify that all files are unpacked correctly.
l 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.
l Customize the INI file using an editor such as vi. You can also edit and transfer the INI file on the
Admin computer via FTP. The program ucxj??? and the INI file must be in the same directory.
l 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 Set S-Bit (Set-Userid)
chmod 4755 ucxj???

l Adjust the HEADER.UNIX, TRAILER.UNIX and RESTART.UNIX if necessary. See: Job -
Execution
2. Configuring authentication via PAM (optional)
l Host
l Authentication via (Pluggable Authentication Modules) is now supported for the agents of the
following UNIX platforms: Solaris, Linux and AIX.
1. PAM library installation

The PAM library must be installed on your system (depends on the platform you use).
2. PAM library configuration

The configuration process depends on the UNIX platform that you use. Typically, you will handle it
by using the files /etc/pam.d or /etc/pam.conf
The name of the service complies with the name of the executable agent file (ucxj???).
3. Configuring the agent

In the INI file of the UNIX agent, set the parameter authentication= ([MISC] section) to "pam". In
the parameter libname= ([PAM] section), you must specify the path and the file name of the PAM
library:
[MISC]
authentication=pam
[PAM]
libname=/usr/lib/libpam32.o
l Server computer
l The AE System must be running.
l Host
l 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 Start the agent in the background from the directory $HOME/bin.
Enter the following if the directory $HOME/bin has been set in the system environment PATH:
nohup ucxj??? 1> ucxj???.log 2>&1 &
Enter the following if the directory $HOME/bin has not been set in the system environment PATH:
nohup ./ucxj??? 1> ucxj???.log 2>&1 &
Note displayed process ID pid.
Information about this process with ps -ppid. Not always available.
Information about all UCX processes with ps -ef | grep ucx.
Information about all processes with ps -e.
l An Agent object is automatically created in system client 0000 and stored in the folder HOST.
l 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,
you need the OS user under which the related jobs and file transfers are started, and write access to
the backup directory.
l Verify whether the agent is logged on.
be viewed in the client 0000. The new agent can now be assigned to clients with the required
rights via the Agent object.
Use the ServiceManager to start or end agents.
4. Ending the Agent
l Host
l Ending the agent normally:
kill-TERM pid
l Canceling agent in emergency cases. Network connections are not properly closed.
kill -KILL pid or

kill -9 pid
Installing the Agent for VMS
This document guides you through the new installation of a VMS agent.
A two-character code is assigned to each supported VMS version. This code then appears in all agent file
names and is described in the terminology. In this document, the characters "??" are used to represent this
code.
In VMS, text strings that call and identify items such as commands and files are not case-sensitive. Any
combination of uppercase or lowercase letters is acceptable. In this document, capital letters are used
with only one exception: Commands of the program FTP.EXE can only be entered in lowercase.
Tip: The VMS agent can be started automatically when booting the operating system. Refer to the
configuration details that are described at the end of this document. The required command files
UC4$STARTUP.COM and UC4$STARTUP_BAT.COM must be transferred to the directory
SYS$STARTUP. Their names meet the requirements of the 8.3 conventions of the AE CD and are freely
definable. Note that names that have been changed must also be modified in the command files.
Requirements
l The user AE has been created with the privileges CMKRNL, BYPASS, SYSNAM, SYSPRV and
WORLD.
l 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.
The job limit must be specified with a number higher than zero in order to enable AE jobs to be
performed in batch mode.

The files are found in the subdirectory of IMAGE:AGENTS\VMS that corresponds with the particular VMS
variant.
The CallAPI files and their implementation are described separately.
Special Feature: Logical Name for Agent

VMS often uses global variables, also called logical names, to transfer information.
AE's VMS agent also uses this kind of global variable.

By default, its name is structured as follows: UC4_AE system name_Agent_name_AGENT. The names
that have been defined in the INI file are used. You can, however, also define a different logical name,
using the parameter uc4_logical= in the INI file.
The global variable is automatically created when the agent starts and deleted when it ends. The value of
the variable is "OK" by default. The agent can be ended by changing the variable content to "TERM" using
the command file UC$STOP.COM. Within 20 seconds the agent reacts and ends normally.
Procedure
1. Transferring the command file to the host
l Admin computer
l Transfer the file UC$CRDIR.COM via FTP (ASCII).
2. Determining directories and authorizations
l Host
l Register with user ID AE.
l Call command file:
$ @UC$CRDIR
l Delete command file:
$DELETE UC$CRDIR.COM;*
The command file UC UC$CRDIR.COM creates all required directories and authorizations.
Directory Authorization
BIN SYSTEM: RE, OWNER: RWED, GROUP: E, WORLD: E
CMD SYSTEM: RWE, OWNER: RWED, GROUP: R, WORLD:
-
TEMP SYSTEM: RE, OWNER: RWED, GROUP: WE, WORLD:
WE
OUT SYSTEM: RW, OWNER: RWD, GROUP: RW, WORLD:
RWE
3. Transferring more files to the host
l Admin computer
l 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.
l Host
l Change from the login directory to the BIN directory:
$SET DEF [.BIN]
l Adjust INI file with the editor.

l Adjust HEADER.VMS, TRAILER.VMS and RESTART.VMS if necessary. See:Job - Execution
l Change to the CMD directory:
$SET DEF [-.CMD]
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.
l 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.
$ rel_dir = ""
If the command file remains unchanged, the HOME directory is by default used to start the agent.
l The user IDs under which AE jobs should run should be given TMPMBX and sometimes
NETMBX privileges.
l Adjust HEADER.VMS, TRAILER.VMS and RESTART.VMS if needed. See:Job - Execution

l Server computer
l Register using the user AE.
l Host
l Call command file in the CMD directory:
$ @UC$START
l The agent's task can be identified by its process ID or process name.
Information about the task can be obtained in two ways:

1. The process name is created at the start of the agent: UC4_User ID.
By default, the process name is UC4_UC4.

$ SHOW PROC UC4_UC4
2. The process ID is displayed at agent start.
$ SHOW PROC/ID=Process ID
l An Agent object is created automatically in the system client 0000 and stored in the folder HOST.
be viewed in the client 0000. The newly installed agent can be assigned to clients with the
required rights through the agent object.
l Host
l Log on using the user ID UC4.
l Call the command file in the CMD directory to shut down the agent normally.
$ @UC$STOP
l Emergency shutdown of agent: network connections are not closed properly.

1. Cancel with process name:
$ STOP UC4_UC4
or
2. Cancel with process ID:
$ STOP PROC/ID=Process-ID
Automatic Agent Start when Booting the Operating System

The command file SYS$MANAGER:SYSTARTUP_VMS.COM is executed when the operating system
boots. In order to start the VMS agent automatically with VMS, the agent's startup script is appended to
the end of this command file. The command file (1) UC4$STARTUP.COM (if it exists) is called in the
startup script.
Example startup script

$!
$ FILE = F$SEARCH("SYS$STARTUP:UC4$STARTUP.COM")
$ IF FILE .NES. ""
$ THEN
$ @SYS$STARTUP:UC4$STARTUP.COM
$ ENDIF
$!
The following parameters must be adjusted to the system environment in the supplied command file (1)
UC4$STARTUP.COM:
l UC4_BAT - command file (2) UC4$STARTUP_BAT.COM

l UC4_LOG - directory in which the log files of the agent are stored
l UC4_USER - agent's user ID
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 The command file (2) UC4$STARTUP_BAT.COM must be started with the agent's user ID.
l The batch queue must be initialized and started.
l The network environment and administration UCX must be started.
l 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.
Installing the Agent for Windows
This document guides you through the new installation of a Windows agent.
The Windows agent can be used for 32-bit and 64-bit. Each version is identified using a three-digit
abbreviations. These abbreviations are used in the agents' file names, and are described in
theTerminology. In this document, the specific abbreviation is replaced by "???."
64-bit Windows platforms: Automic recommends installing a 64-bit agent if you intend to start 64-bit
programs and applications through it. Using a 32-bit agent for this purpose may cause problems.

C:\AUTOMIC\AGENT\WINDOWS).

You find the files of the Windows agent in the directory IMAGE:AGENTS\WINDOWS.
Other files from this subdirectory are components of the installation program and the AE runtime system.
Potential Problems
l Uppercase and lowercase letters used in the host name.
l IP address with leading zeros.
Windows Agent for System-Wide E-mail Connection

Automic's system-wide email connection can be implemented using a Windows agent. Detailed
information about setting up this email connection is provided in the Knowledge Base.
Procedure
version.
l Host (32-bit)
l Install the package from the IMAGE:CRTS\WINDOWS\X86 directory.
l Host (64-bit)
l Install the package from the IMAGE:CRTS\WINDOWS\X64 or IMAGE:CRTS\WINDOWS\IA64
directory.
l Host (32-bit)
l Start the program SETUP.EXE in the directory IMAGE:AGENTS\WINDOWS\X86.
l Select a separate directory for the agent (such as C:\AUTOMIC\AGENT\WINDOWS). Click the
large button (computer, packing and disc) to start the installation.
l The AE program group is automatically created and the agent specified.
l Host (64-bit)
l Start the program SETUP.EXE in the directory IMAGE:AGENTS\WINDOWS\X64 or
IMAGE:AGENTS\WINDOWS\IA64.
l Select a separate directory for the agent (such as C:\AUTOMIC\AGENT\WINDOWS). Click the
large button (computer, packing and disc) to start the installation.
l The AE program group is automatically created and the agent specified.
l Host
l Adjust the INI file UCXJ???.INI to your system environment.
l The user who starts the agent must have the following rights if the INI-file parameter logon= has
been set to "1":
l Act as part of the operating system

l Adjust memory quotas for a process
l Allow log on locally
l Back up files and directories **)
l Logon as batch job *)
l Logon as service
l Replace a process level token
l Restore files and directories
*) 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"..
l Server computer
l Host
l Start the agent from the AE program group.
An agent object is automatically created in system client 0000 and stored in the folder HOST.
Overview. Newly logged-on agents have not yet been assigned to a client, so they are only
shown in client 0000. The newly installed agent can now be assigned to clients including the
l Host
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 on 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
authorizations in order to make sure that it can process the above tasks:
l act as part of the operating system

l log on as a service
l restore files and directories
l create backups of files and directories
l adjust memory quotas for a process
l replace a process level token.
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.
Powershell configuration - File Backup or Rollback

In order to be able to execute Powershell commands for file backup or rollback refer to the settings in
the Windows agent's INI file, keys ECPEXE= and ECPEXT=.
See also:
Installing the Agent for z/OS
This document guides you through the new installation of a z/OS agent.
Advanced Security.
Requirements
l JES2 or JES3
l TCP/IP V3R2M0 or later
l APF authorization for the load library
l C runtime library version V1R5M0 or later
l An MSGCLASS in HOLD status that does not call a subsequent program (external writer)
l UPDATE access for JESSPOOL RACF Class (in order to process Job outputs)
l A file qualifier for temporary files, logs and traces
Supplied Files
The necessary files are available in the directory IMAGE:AGENTS\MVS.
8.2.4 Load Module:

l CADSDEL - A utility that can be used to release a Common Dataspace (CADS) allocated by the
Event Monitor.
l UC4END - End messenger for the SMF messenger technique (it writes the StepList and return
codes to the JESMSGLG)
l UC4RESTR - Restart messenger for the SMF messenger technique (dummy program such as
IEFBR14)
l UC4START - Start messenger for the SMF messenger technique (dummy program such as
IEFBR14)
Procedure
1. Transferring files to the host
l Host
l Transfer the appropriate files from IMAGE:AGENTS\MVS\ using a file transfer.
open Host
Use an FTP user with the appropriate rights
User name = UC4
Password = <as set>
bin
quote site recfm=fb lrecl=80 blksize=6080
quote site pri=1 sec=1 CY
put UCXJM25-???.bin 'UC4.UCXJX.WORK'
asci
put UCXJM25.ini 'UC4.UCXJM25.INI'
put UCXEM25.ini 'UC4.UCXEM25.INI'
quote site recfm=vb lrecl=500 blksize=27998
put ucx.msl 'UC4.UC.MSL'
quit
2. Creating the Load Library
l Host
l Create the load library using the utility TSO RECEIVE. Bold printed parameters are system-
specific 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(??????)
/*
Alternately, you can create it as follows:
On the z/OS host:

TSO RECEIVE indsn('MYDSN.UCXJ.WORK')
Press Enter and type the following line:
dsname('UC4.UCXJM25.LOAD')
3. APF authorization for the Load Library
l Host
l 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. Creating the Started Task for the Agent
l Host
l 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 User, groups and data set profiles

The user under which the agent runs requires the appropriate rights for data sets via the user
or group definition. Use the data set profiles to assign the relevant rights.
Alter right for the AE dataset qualifier is required.
Note that the agent requires rights for all data sets that it will use.
l OMVS Segment (TCP/IP authorization)

Ensure that the rights for OMVS are specified in the user and default group.
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).
l 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 file transfers. 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 ask RACF in the agent's INI file to "0" or "4" ).
l Example for a started task:

//UC4RUN PROC
//UCEX EXEC PGM=UCXJM25,PARM='TRAP(OFF),HEAP
(4M,4M,ANY,FREE)/UC4.UCXJM25.INI',
// REGION=4M,TIME=1440
//STEPLIB DD DISP=SHR,DSN=UC4.UCXJM25.LOAD
//SSTORE DD DISP=SHR,DSN=UC4.UCXJM25.SSTORE
//STDOUT DD SYSOUT=*
//SYSCPRT DD SYSOUT=*
//JOBOUT DD SYSOUT=(A,INTRDR)
//SYSUDUMP DD SYSOUT=*
//*
l The started task must be authorized to read JES lists.
l The following files must also be in included in the link chain:
CEE.V1R5M0.SCEERUN - (Language Environment dynamic runtime library)

CEE.V1R5M0.SCEELKED - (Language Environment linkage editor library)
TCPIP.V3R1.SEZACMTX - (TCP/IP runtime library)
There is an alternative solution if you do not want to interfere with your system as described
above. You can specify the LOAD library in the STEPLIB, but also in the C-environment's DD card
EDCMTF. Further information is available in the IBM documentation - STEPLIB DD statement.
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 object MVS.JOBMD_
DEFINITIONS. Otherwise, the Job Messenger cannot open a TCP/IP connection and the jobs will
receive the status ENDED_VANISHED.
l Copy the procedure UC4RUN to a procedure library such as SYS1.PROCLIB.

l Required authorizations for the STC user in RACF:
l OMVS segment
l ALTER authorization for own datasets (e.g.: UC4.*)
l The started task requires the appropriate authorization in order to read JES lists
l Generate the datasets for the StatusStore
Example:
//CREATESS EXEC PGM=IDCAMS

//SYSIN DD *
DEFINE -
CLUSTER ( -
NAME(UC4.UCXJM25.SSTORE) -
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
//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.
l Host
l Adjust the INI file. The INI file must not use the file attribute NUMBER ON.
l Adjust the HEADER.MVS, TRAILER.MVS and RESTART.MVS where necessary. See: Job -
Execution

l Server computer
l Host
l Start using start UC4RUN via the system console.
l Start the UserInterface for client 0000. Refer to the System Overview in order to obtain
information about agents. Newly logged-on agents have not yet been assigned to a client;
they can only be viewed in client 0000. The new agent can now be assigned to clients with
the required rights via the Agent object.
7. Quitting the Agent
l Host
l 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. The Event Monitor as independent Started Task
l Adjust the INI file

l Create the AE started task for the Event Monitor.
Example:
//UC4EMRUN PROC
//EVENTM EXEC PGM=UCXEM25,REGION=0M,
// PARM='TRAP(OFF),HEAP(4M,4M,ANY,FREE)/UC4.UCXJM25.EM.INI'
//STEPLIB DD DISP=SHR,DSN=UC4.UCXJM25.LOADLIB
//UCEVENT DD DISP=SHR,DSN=UC4.UCEVENT.VSAM
//UCFILTER DD DISP=SHR,DSN=UC4.UCFILTER
l Create the datasets (UCFILTER and UCEVENT).
Example:
//CRTEMDS JOB ####,'XXX',NOTIFY=&SYSUID,MSGLEVEL=(1,1)

//* Create Datasets for UC4 EventMonitor
//UCFILTER EXEC PGM=IEFBR14
//UCFILTER DD DISP=(NEW,CATLG,CATLG),DSN=UC4.UCFILTER,
// RECFM=VB,LRECL=1024,BLKSIZE=8192,SPACE=(CYL,(1,1))
//UCEVENT EXEC PGM=IDCAMS
//SYSIN DD *
DEFINE -
CLUSTER ( -
NAME(UC4.UCEVENT.VSAM) -
INDEXED -
VOLUMES(DSK30D) -
TRACKS(1 1) -
) -
DATA ( -
NAME(UC4.UCEVENT.VSAM.DATA) -
KEYS(20 0) -
FREESPACE(10 5) -
) -
INDEX ( -
NAME(UC4.UCEVENT.VSAM.INDEX) -
)
/*
l Create dataset initialization
Example:
//INITEMDS JOB ####,'XXX',NOTIFY=&SYSUID,MSGLEVEL=(1,1)

//INITVSAM EXEC PGM=IDCAMS
//OUT1 DD DISP=SHR,DSN=UC4.UCEVENT.VSAM
//SYSIN DD *
REPRO INFILE(IN1) OFILE(OUT1)
//IN1 DD *
DUMMY
/*
l Start the event monitor with start UC4EMRUN.

l End the event monitor with modify UC4EMRUN,end.
l Note that the RACF authorization READ is required in order to run the event monitor if the MVS
Extended Console is protected.
9. The External Job Monitor as independent Started Task
l Adjust the INI file.

l Create the AE started task for the external Job Monitor.
Example:
//UC4EJM PROC
//UCZEJM EXEC PGM=UC4EJM,PARM='TRAP(OFF)/ ZUC800A1.EJM.INI',REGION=0M
//STEPLIB DD DISP=SHR,DSN=UC800A.LOADLIB
l Start the external Job Monitor using start UC4EJM.

l End the external Job Monitor using modify UC4EJM,end.
See also:
Agent - Interaction Between the Automation Engine and z/OS

SMF Exit
Event Monitor
Automatic File-System Events
External Job Monitor
Installing the ServiceManager
Installing the ServiceManager (UNIX)
This document guides you through the new installation of a ServiceManager.
Because the ServiceManager for UNIX is available for different platforms, a three-figure code has been
supplied for each supported UNIX platform. The codes are described in the Terminology. In this document,
the specific code is replaced with the characters "???."
Automic strongly recommends installing the ServiceManager in a separate directory (such as

UC4/smgr).
Supplied Files
The ServiceManager files are supplied in compressed form (ucsmgr???.tar.gz), and can be found in
subdirectories of IMAGE:SERVICEMANAGER\UNIX. The names of the subdirectories indicate the
supported platforms.
Procedure
1. Transfer the tar file to the Host and set up the system environment.
l Host
l Log on using the user ID AE.
l Transfer the TAR file ucsmgr??.tar.gz to a directory (such as smgr) via FTP.
l Navigate to the ServiceManager directory:
cd servicemanager
gzip -d ucsmgr???.tar.gz or gunzip ucsmgr???.tar.gz
tar xvfo ucsmgr???.tar
l The files will appear in their corresponding directories. The tar file can be deleted after unpacking.
l Be sure to note any tar messages (which can be called up by various users) and verify that all
files have been correctly unpacked.
l 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.
l Rename the supplied ini file ucybsmgr.ori.ini to ucybsmgr.ini.
l Rename the supplied file uc4.ori.smd to uc4.smd.
l Adjust the INI file to the system environment.
l Set the variable:
AIX: export LIBPATH=Path of the system library directory
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. Start and stop services with the ServiceManager
l Host
l Start the ServiceManager:
nohup ./ucybsmgr [-iPath and Name of the INI file] Phrase &
The phrase is a ServiceManager environment.

l For more information about ServiceManager functions (such as starting and stopping agents), see
UCYBSMCL.
Potential Problem
l A service cannot be started:
l Note that for Automation Engines on UNIX, the file "syntax.bin" is in the same directory as
the INI files.
See also:
ServiceManager - Command Line Program
This document describes the hotfix installation procedure for the ServiceManager (Windows).
Automic strongly recommends installing the ServiceManager and its dialog program in separate
directories (for example, C:\AUTOMIC\SERVICEMANAGER\BIN and
C:\AUTOMIC\SERVICEMANAGERDIALOG\BIN).
Supplied Files
The ServiceManager files are stored in two different directories of the supplied AE CD. The files that
provide the ServiceManager service can be found in the directory
IMAGE:SERVICEMANAGER\WINDOWS.
The directory IMAGE:SERVICEMANAGERDIALOG\WINDOWS contains the files for the dialog and
command line programs of the ServiceManager.
Additional files that are included in these sub-directories belong to the installation program and the AE
runtime system.
Procedure
Server computer or host computer
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 Host (32 bit)

l Install the package from the IMAGE:CRTS\WINDOWS\X86 directory.
l Host (64 bit)

l Install the package from the IMAGE:CRTS\WINDOWS\X64 or IMAGE:CRTS\WINDOWS\IA64
directory.
2. Installing the ServiceManager
l Host (32 bit)

IMAGE:SERVICEMANAGER\WINDOWS\X86.
l Adjust the INI file UCYBSMGR.INI to your system environment.
l Adjust the definition file (SMD file)
l Host (64 bit)

IMAGE:SERVICEMANAGER\WINDOWS\X64 or
IMAGE:SERVICEMANAGER\WINDOWS\IA64.
l Adjust the INI file UCYBSMGR.INI to your system environment.
l Adjust the definition file (SMD file)
3. Installing the Dialog and Command Line Programs of the ServiceManager
l Host (32 bit)

IMAGE:SERVICEMANAGERDIALOG\WINDOWS\X86.
l Adjust the INI file UCYBSMDI.INI according to your system environment.
l These programs can also be installed on computers where no ServiceManager runs, which enables
the ServiceManager to be operated from these computers.
l Host (64 bit)

IMAGE:SERVICEMANAGERDIALOG\WINDOWS\X64 or
IMAGE:SERVICEMANAGERDIALOG\WINDOWS\IA64.
l Adjust the INI file UCYBSMDI.INI according to your system environment.
l These programs can also be installed on computers where no ServiceManager runs, thereby
facilitating that the ServiceManager can be operated from these computers.
4. Installing the ServiceManager as a service
l Open an MS DOS window

l Start the program UCYBSMGR.EXE using the command:
UCYBSMGR[.EXE] -install Phrase [-iPath and name of the INI file]
l The ServiceManager is entered in Windows as a service. You can use a string of your choice as the
phrase.
l 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]".
l Set the start type to "Automatic" if needed.
l 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
l Start the service
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. Starting services using the ServiceManager
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 Start the dialog program of the ServiceManager.

l Select the computer and the ServiceManager environment (phrase).
l All provided services are displayed (status "stopped").
l Right-click to start the service or to change a particular service's properties (such as starting
automatically when the system starts or delaying its start).
Potential Problems
l Not all ServiceManager environments (phrases) are displayed:

A port number range must be specified in order for more than one ServiceManager to be selectable
in the dialog program. Enter this range in the INI file of the utility, keeping in mind that it is limited to
10 port numbers.
l Not all services are displayed:

Ensure that the correct instructions are given in the definition file (SMD file). Each service should be
displayed in an extra line. Also enter the path of the SMD file in the INI file of the ServiceManager.
l A service cannot be started:

l Verify that the path specified in the properties is correct (to be opened via the context menu
in the dialog program).
l Automation Engines on UNIX: the file "syntax.bin" must be in the same directory as the INI
file.
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.
Uninstalling the ServiceManager
In some cases it is necessary to uninstall a specific ServiceManager environment (Phrase).
l Open an MS DOS window.

l Start the program UCYBSMGR.EXE with thecommand:
UCYBSMGR -remove Phrase
l This command uninstalls the ServiceManager environment as a service under Windows.

l Check the Control Panel - Administrative Tools - Services in order to verify that the service has
been removed.
See also:
l ServiceManager - Service
l ServiceManager - Dialog Program
l ServiceManager - Command Line Program
l Configuring the Debugger for potential program failures
Installing the CallAPIs
Installing the CallAPI for BS2000
This document guides you through the new installation of a CallAPI for BS2000.
A CallAPI for BS2000 is supplied with AE. This interface enables calls in AE from your own programs,
which can be written in programming languages such as C, COBOL, or Assembler. UCXBB2?C serves as
a utility that can be called from a procedure or enter job, for example.
A one-character code has been assigned for each supported BS2000 variant. This code is used in some
CallAPI file names. Details are described in "terminology". In this document, the specific code is replaced
by "?."
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 IMAGE:AGENTS\BS2000\SIEMENS\UCXJB24.TAR for BS2000 Sockets Version 1.3

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 LMS Plamlibrary contains all elements that are required for programming.
Procedure
l The CallAPI can be used with no installation required. Its files are included in the agent and installed
when the agent is installed.
l 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.
See also:
CallAPI for BS2000
Installing the CallAPI for GCOS8
This document guides you through the new installation of a CallAPI for GCOS8.
AE also supplies a CallAPI for GCOS8. This interface is used to execute calls in AE from your own
programs, which can be written in programming languages such as C and COBOL, for example.
Additionally, the utility ucxbgc8c is available, and can be called from within a job, for example.
Supplied Files
The files that belong to the CallAPI are found in a sub-directory of IMAGE:CALLAPI\GCOS8.
Procedure
1. Transferring the files and setting up the system environment
l Create a catalog for the CallAPI.

l This catalog should include the following sub-catalogs: DATA, EXEC, INC, JCL, OBJ, SRC and
TMP.
l Transfer the files to the relevant sub-catalogs on the GCOS8 computer using FTP or Glink FTP.
Sub- File
Catalog
DATA script, UCMSL, ucxbgc8ci
EXEC ucxbgc8c, ucxbxxxc, ucxgc8c.oml
INC uccall3.h
JCL callapi, callapi_fc, callapi_logon, comp_xxx, go_xxx, go_xxx_fc, go_xxx_logon,
link_xxx
SRC ucxbxxxc.c
l Adjust the INI file ucxbgc8ci to your system environment.
See also:
CallAPI for GCOS8
Installing the CallAPI for Java
This document guides you through the new installation of a CallAPI for Java.
A CallAPI for Java is supplied with AE. This interface enables calls from your own programs in AE, but can
also be used through the command line or a batch file.
Supplied Files
The files are found in the directory IMAGE:CALLAPI\JAVA.
Procedure
l Copy the supplied files to a separate directory (e.g. C:\AUTOMIC\CALLAPI\WINDOWS).

l If required, adjust the INI file UCXBXXXC.INI.
See also:
CallAPI for Java
Installing the CallAPI for NSK
This document guides you through the new installation of a CallAPI for NSK.
A CallAPI for NSK is supplied with AE. This interface can be installed under the D4n.nn series of NSK.
UCXBNS1C is a utility that can be called from the command line of the operating system, from a script or
a job.
A three-character code is assigned to each supported NSK variant. It is shown in some file names of the
CallAPI and described in the terminology (NS1 for HP NonStop Server Guardian NSK Version D40).
Supplied Files
The files for the NSK CallAPI are included with the NSK agent found in IMAGE:Agent/nsk in a PAK
archive.
Procedure
1. Transferring the supplied file to the host and setting up the system environment
l Admin computer
l 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.
l Transfer text and binary files to the corresponding subvolume.
l Host
l 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.
See also:
CallAPI for NSK

Installing the CallAPI for z/OS
This document guides you through the new installation of a CallAPI for z/OS.
A CallAPI for z/OS is supplied with AE. It enables calls in AE from your own programs that were written in
a particular programming language (C, for example). Additionally, the utility UCXBM25C is available. It
can be used to call the CallAPI from a job, for example.
You can specify the CodeTable that is to be used in the INI file of the z/OS CallAPI. Enter the name of
the CodeTable object in the section [GLOBAL] of the parameter codetable=. The IBM standard code
table is used if nothing is specified in this parameter.
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 UCXJM25-IBM.BIN (bound with the standard IBM TCP/IP Library)
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).
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
Installing the CallAPI for OS/400
This document guides you through the new installation of a CallAPI for OS/400.
A CallAPI for OS/400 is supplied with AE. So far, it is not possible to call this CallAPI in your program. The
utility UCXBO41C, however, is available and can be used via CL script call.
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).
See also:
CallAPI for OS/400
Installing the CallAPI for SAP
This document guides you through the new installation of a CallAPI for SAP.
AE supplies a CallAPI for SAP. You can use this interface to directly run AE Scripts from ABAP programs.
The CallAPI is represented by an RFC Server that includes the function module "AE." You call this module
directly from ABAP.
The CallAPI for SAP is available under UNIX and Windows.
A three-character code is assigned to each supported UNIX variant. This code appears in some file names
and is described in the terminology (AP6 for AIX, for example). Throughout this document the specific
code is replaced by "???."
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.
Diagram of the technical implementation
Putting into Operation

Note that a sound knowledge of SAP's RFC technology is required put the RFC Server into operation.
If JRE is already available in the required version, you can skip this step.

l You check the version of the system's current Java Virtual Machine (VM) with the following
command.
java -version
If several JRE or Java SDK versions are installed on the computer, the order of the directories that
is indicated in the settings of %PATH% or $PATH is relevant. The particular Java Runtime
Environment that is listed first in the list of directories is applied.
can deactivate it in the system control, because AE does not need it.
2. Transferring the files
Windows:
l Transfer the supplied files of the CallAPI for SAP.
UNIX:
l Transfer the TAR file ucxsapc.tar.gz via ftp.

gzip -d ucxsapc.tar.gz or gunzip ucxsapc.tar.gz
tar xvf ucxsapc.tar
The files that are supplied appear in their corresponding directories. The tar file can then be deleted
after unpacking.
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.
l 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. Installing the SAP Java Connector
l Host
l The RFC Server requires the SAP Java Connector.
l Install the 32-bit SAP JAVA Connector if you use 32-bit Java. 64-bit Java requires the 64-bit
SAP Java Connector.
l Download the SAP Java Connector from the SAP Service Marketplace and install it (Support Portal
-> Downloads -> SAP Connectors -> SAP Java Connector -> Tools & Services).
l Copy the SAP Java Connector files to the BIN directory of the agent.
l 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. Adjusting the INI file for the RFC Server program

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. Starting the RFC Server
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 -IPath and file name Path and name of the INI file for the RFC Server
-V Outputs the Automation Engine version including the
hotfix number in the following format:
"ucxsapc version Automation Engine version plus hotfix

number"
-VPath and file name Outputs the Automation Engine version including the
hotfix number to the file in the following format:
"ucxsapc version Automation Engine version plus hotfix

number"
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. Checking the registration in the SAP system
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 System type Request
R31 sapgw00 R31 193.154.170.111 LOCAL_R3 16:33:07
wgntw13 uc4call WGNTW13 193.154.170.13 REGISTER_TP 12:11:18

R31 R31 193.154.170.111 REMOTE_GWY 10:25:14
6. Defining the RFC destination in the SAP system
Start the transaction "SM59" or log on via Tools -> Administration -> Management -> Network -> RFC
Destination. Specify a TCP/IP connection:
l Connection type: T
l Activation type: Registered Server Program
l 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
Test the connection using the button Test Connection.
Example of a test result

Connection type: TCP/IP connection
Logon: 1,360 msec
0 KBytes: 264 msec
10 KBytes: 39 msec
20 KBytes: 62 msec
30 KBytes: 45 msec
A successful test result indicates that the CallAPI is ready for operation.
See also:
CallAPI for SAP
Installing the CallAPI for UNIX
This document guides you through the new installation of a CallAPI for UNIX.
A CallAPI for UNIX is supplied with AE. This interface enables the execution of calls in AE from your own
programs or procedures. These programs can be written in programming languages such as C, C++, and
COBOL. The utility UCXB???C is also available, and can be used for command-line calls or in executable
files.
A three-character short form is available for each supported UNIX variant. This short form is used in some
CallAPI file names and is described in the terminology. In this document, the appropriate abbreviation is
replaced by the characters "???."
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.
Procedure
1. Transferring the supplied files and setting up the system environment
l Admin computer
l Transfer the tar file UCXB???C.tar.gz using FTP.
l Host
l Unpack the TAR file.
gzip -d UCXB???C.tar.gz or gunzip UCXB???C.tar.gz

tar xvf UCXB???C.tar
(Linux: tar -zxvf UCXB???C.tar.gz)
When unpacked, the actual files are automatically created in the directories /bin, /lib and /src, if
they do not yet exist. The packed file can be deleted afterwards.
l If required, adjust the INI file UCXBXXXC.ORI.INI
l Set the variable:

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
See also:
CallAPI for UNIX
Installing the CallAPI for VMS
This document guides you through the new installation of a CallAPI for VMS.
A CallAPI for VMS is supplied with AE. This interface enables calls in AE from your own programs. These
programs can be written in programming languages such as C, C++, or COBOL. For example,
UCXBV??C serves as a utility that can be used via command-line call.
A two-character code is assigned for each supported VMS variant. This code is part of some CallAPI file
names and is described in the Terminology. In this document, the specific code has been replaced by
"??."
Supplied Files
The CallAPI files can be found in the appropriate subdirectory of the VMS variant under
IMAGE:CALLAPI\VMS.
Procedure
1. Transferring the supplied files to the host
l Transfer the files using FTP.
openIP address
User name = UC4
Password = <as specified>
cd SRC
pwd(check directory)
put MAKEXAMP.COM
put UCXBVXXC.C
put UCCALL3.H
bin
put UCXBV??C.OLB
cd ../BIN
pwd(check directory)
putUCXBV??C.EXE
ascii
put API_START.COM
put UCXBVXXC.INI
put UCX.MSL
bye
l If required, adjust the INI file UCXBVXXC.ORI.INI.
which is found in the chapter Release Notes.
See also:
CallAPI for VMS
Installing the CallAPI for VSE
This document guides you through the new installation of a CallAPI for VSE.
TCP/IP for VSE is required in order to use the CallAPI for VSE. Communication to the Automation Engine
is established using TCP/IP sockets. The configuration must allow a connection to the Automation
Engine, in other words, it must be possible for the VSE to access the IP address and port number of the
Automation Engine.
Procedure
Adjust the supplied INI file to the values of your installation.
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).
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.
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
Installing the CallAPI for Windows
This document guides you through the new installation of a CallAPI for Windows.
A CallAPI for Windows is supplied with AE. This interface can be used under Windows on Intel
computers. The CallAPI enables calls in AE from other programs or procedures. These programs can be
written in programming languages such as C, C++, COBOL, Java, Visual Basic, VBA, or VBS.
Additionally, the utility UCXBXXXC.EXE is supplied, which can be used for calls from the command line,
in an MS DOS box or in a batch file.
Supplied Files
The files are stored in the directory IMAGE:CALLAPI\WINDOWS.
Procedure
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 Copy the files to a separate directory (C:\AUTOMIC\CALLAPI\WINDOWS).

l If required, adjust the INI file UCXBXXXC.INI.
which is available in the chapter Release Notes.
3. Using OLE
l 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
Connect for WebSphere MQ (Windows)

Along with AE, a CallAPI is supplied for IBM's WebSphere MQ Queue Manager (known formally as
WebSphere MQ is MQSeries). The CallAPI facilitates the execution of AE Scripts directly from
WebSphere MQ Queue Manager via the API interface.
Requirements
l WebSphere MQ Queue Manager Server to create queues for the call interface
l WebSphere MQ Queue Manager Server for the API calls
l WebSphere MQ Queue Manager for MS Windows, Version 5.2.1 or later
l License Connect for WebSphere MQ
Supplied Files
Call Interface files are available in the directory IMAGE:FRAMEWORK\MQSERIES\WINDOWS.
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.
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.
Steps for Starting Operation
Check 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
CallAPI for WebSphere MQ (Windows)

This document describes the installation and configuration process for the Connect for WebSphere MQ on
a Windows platform.
1. Setting up queues for AE with WebSphere MQ Queue Manager Server
l Host
l The setup and configuration of WebSphere MQ (Queue Manager, Queues, Channels) components
takes place either with WebSphere MQ Explorer or through command programs.
l Set up Queue Manager with the name "queue.manager1."
crtmqm -q queue.manager1
l Start Queue Manager.
strmqm queue.manager1
l Start the command processor for WebSphere MQ commands. Note: No prompt will be displayed.
runmqsc
l Set up the request queue for AE with a maximum message length of 4096 bytes.
define qlocal ('UC4CInputQueue') maxmsgl (4096)
l Set up reply queue for applications.
define qlocal ('UC4CReplyQueue')
2. Installing AE Connector using SETUP.EXE from the delivery directory
l Host
l 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).
l 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
l Host
l 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
l Host
l 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
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.
l Check the AE Connector log file. It should not contain any error messages.
l 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 Host
l 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.
l If this request corresponds to a valid AE call, the AE Connector connects to the Automation Engine
and forwards the request.
l 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.
l Any errors that occur during processing should be addressed.

l If the tests were successful, the AE Connector can be closed.
6. Entering the AE Connector into the ServiceManager
l Host
l If it is necessary for the AE Connector to activate automatically when the system starts, it should
be entered into the ServiceManager.
l If no ServiceManager is present on the system, it must first be installed.
l 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.
l 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
Installing the AE.ResourceAdapter (IBM WebSphere)

The following document describes how to install and set up an AE.ResourceAdapter for IBM WebSphere.
Supplied File
The AE.ResourceAdapter file is found in the folder ApplicationInterface.

AEResourceAdapter.rar AE.ResourceAdapter
Procedure
1. Setting up the AE.ResourceAdapter
l Host
l Log on to the IBM Integrated Solution Console.
l Select the menu item Resources -> Resource Adapters. A list of all installed resource adapters is
displayed.
l Click Install RAR. Enter the path to the file AEResourceAdapter.rar and click Next.
l Click OK, and then click Save to store your modification in the "master configuration."
l The AE.ResourceAdapter is now included in the list of installed resource adapters.
2. Creating a new connection factory
l Host
l Select the menu item "J2C connection factories" and then click New in order to create a new
connection factory.
l Select the file AEResourceAdapter.rar as provider and complete the fields "name" and "JNDI
name."
l Click OK, and then click Save to store your modifications.

l The newly created connection factory is now displayed in the table.
3. Configuring the connection pool
l Host
l Click on the connection factory and select the link "Connection pools."
l Set the number of "minimum connections" to 0.
l In "Purge policy," select the entry "Entire pool."
l Confirm OK to confirm your modifications.
l 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."
l Click Save to store your modifications.
l The AE.ResourceAdapter can now be used by Enterprise JavaBeans.
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

UC4WS.WAR Internal Webservice
Procedure
1. Installing the Webservice
l Host
l Log on to the administrator console.
l By default, the file Realm is used. Create a new user under Configuration -> Security -> Realms -
> file.Enter "uc4" as the group.
l Select the menu item "Applications" -> "Web Applications" and click "Deploy..." in the right
window.
l 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.
l When deployment has been successful, the tree on the left displays the Internal Webservice under
"Web Services".
l WSDL is available via the following link:
http://Server name:Port/uc4ws/uc4ws?wsdl
2. Configuring the Webservice
l Host
l Call the Configuration WebInterface via the following link:
http://Server name:Port/uc4ws/admin
l In "Communication Process (host:port)", specify at least one communication process in the format
"Server name:Port".
l You can also store a default user and select the operations that he/she can use on the right.
l In the area Session Handling, determine the connection settings to the Internal Webservice.
See also:
Using the Webservice
Installing the AE Internal Webservice (IBM WAS CE)
The following steps are required for installing and configuring the AE Internal Webservice on an IBM WAS
CE application server.
Supplied File

UC4WS.WAR AE Internal Webservice
Procedure
l Host
l Log on to the administrator console.
l Create the new group "uc4" under Security -> Users and Groups. Assign one or several users to
this group.
l Click on the link "Deploy new Applications".
l Click "Browse" under "Archive" and select the file UC4WS.WAR. Activate the option Start app
after install. Click "Install".
l After successful installation, the message "The application started successfully" is output.
l Host
l Call the Configuration WebInterface using the following link:
"Server name:Port".
l In the area "Session Handling", determine the connection settings for the Internal Webservice.
See also:
Installing the AE Internal Webservice (JBoss)
The following steps are required for installing and configuring the AE Internal Webservice on a JBoss
application server.
Supplied File

UC4WS.WAR Internal Webservice
Procedure
l Host
l 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.
l Copy the file UC4WS.WAR to the deploy directory.
l After deployment, a log message is output which is required in order to register the Internal
Webservice.
l Host
"Server name:Port".
See also:
Installing the Internal Webservice (SAP Netweaver)
The following steps are required to successfully install and configure the Internal Webservice on a SAP
Netweaver application server:
Supplied Files
The Internal Webservice file is available in the directory IMAGE:WEBSERVICE
Procedure
l Host
l Copy the file "UC4WS.SCA" to the incoming directory of the Java Support Package Manager (for
example, C:\usr\sap\trans\EPS\in).
l Start the Java Support Package Manager (JSPM) and log on to the JEE engine.
l In "Start Deployment", select the option New Software Components for the item "Select Package
Type" (step 1). Click Next.
l In the step "Specify Queue", the AE Webservice is listed under "Select new components to
deploy".
l The installation process has been successful if the AE Webservice is displayed and shows the
status "DEPLOYED". Click Exit to end the program.
l Open the WSDL file to check whether the AE Internal Webservice has successfully been set up.
The WSDL is available via the following link:
l Host
l Additional authorizations are required to access the Configuration WebInterface of the AE Internal
Webservice. Log on to the SAP Netweaver's User Management Configuration.
l 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).
l Use the following link to call the Configuration WebInterface:

l Enter the communication process to which a connection should be established (format: "Server
name:Port").
l No "Default user" is required.
See also:
Installing the AE Internal Webservice (Tomcat)
The following steps are required for installing and configuring the AE Internal Webservice on a Tomcat
application server.
Compatibility Matrix:
Incompatible versions are excluded from this view.
Java Tomcat 7 Tomcat 8

Java 7
Java 8
Procedure
l Host
l Assign the role "uc4" to a user by adapting <tomcat>/conf/tomcat-users.xml. Instructions are
available on the Tomcat Website.
l Copy the file uc4ws_tomcat.war, rename it into uc4ws.war and paste it into deploy directory of
tomcat (<tomcat>/webapps)
l Download the Zip-Distribution of JAX-WS Reference Implementation (RI) from http://jax-
ws.java.net/, paste the content of <jaxws>/lib into <tomcat>/webapps/<internal_
webservice>/WEB-INF/lib
When copying jars (dependencies) in Tomcat libs, no other web application using similar
libraries should be deployed in the same Tomcat.
l After deployment, no error log message should be shown in tomcat-log

l WSDL is available via the following link: http://Server name:Port/uc4ws/uc4ws?wsdl
l Host
"Server name:Port".
See also:
Configuration WebInterface for the Internal Web Service
The pushbutton Save Settings can be used to store the settings to the file uc4ws.ini.
Field/Element Description
Connect information
and Default User
Communication Connection to the Automation Engine in the format:
Process (host:port)
"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 Timeout for connections (in minutes)
The Internal Web Service closes connections to Web clients automatically if

the last request they sent dates back longer than the number of minutes
defined here.
Waiting Connections Number of open connections to Web clients (display field only)
The pushbutton Close all can be used to close all open Web client
connections.
Open Sessions Number of open Web client sessions (display field only)
Sessions will only be created if the Web client logs on with the operation
logon. Using the default user has the effect that a connection is
established but no session is created.
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
Windows, UNIX and Java agents (SAP, RA, JMX and SQL).
The MAPI2 interface of Windows 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 The
(type "Email" or "Alarm", "Request", "Message" with the option "Send E-mail") 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").
Script function SEND_MAIL 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.
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 Open the variable UC_CLIENT_SETTINGS and fill in the keys that have names that start with
"SMTP."
l Other settings for individual clients: Assign the above variable to the particular clients and adjust it
accordingly. The settings that are made in system client 0000 apply for clients without SMTP
settings in their variable UC_CLIENT_SETTINGS.
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:
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 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.
l Enter the cluster's virtual IP address in the agent's INI-file section [VARIABLES]. Do so using the
variable UC_EX_IP_ADDR.
l 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.
l In the MSCS, define the Automic ServiceManager.Phrase as resource type "Generic Service".
l Select the dependencies' shared disk and, if required, the IP address assigned to the group.
l If the agent needs to use particular settings, use an extra variable for the host characteristics.
Type 2:
l Install the ServiceManager on each node on a local disk unit.

l Register the ServiceManager as a service on each node (command "UCYBSMGR –install
Phrase"). Leave the start type set to "Manually"; do not set it to "Automatically."
l Install the Windows agent on a shared disk of the Microsoft Cluster.
l Enter the virtual IP address of the cluster or of the group in the agent's INI-file section
[VARIABLES]. Do so using the variable UC_EX_IP_ADDR.
l In the MSCS, define the Automic ServiceManager.Phrase as resource type "Generic Service."
l Select the shared disk as a dependency and, if required, select the IP address assigned to the
group.
l The group can now be started on a node.
l Use the ServiceManagerDialog to adjust the services (such as agent properties, automatic start).
l Copy the updated *.smd and *.smc files to the other nodes (from the ServiceManager's installation
folder).
l If the agent should use particular settings, create a separate variable for the host characteristics.
l The key that is used to communicate to the Server is entered in the Keystore file when the agent
starts on the first node for the first time. Define the name and path of the Keystore file in the agent's
INI file.
l A copy of the first node's Keystore file must be available on the second node on which the agent
should run using the same name. Otherwise, you cannot start an agent of the same name on a
different computer if it is already registered on the system. This procedure is always required
regardless of the authentication method that is used.
See also:
AE system in a Windows Cluster

An Automation Engine System in a Windows Cluster
The following document describes how to configure a Windows Cluster for AE system usage.
Preparations
l Create a new MS SQL Server Database using the Enterprise ServiceManager.

l Install theutilities.
l Load initial data and licenses to the database.
l Install the following components on node 1:

l Automation Engine
l UserInterface
l ServiceManager
l Register the ServiceManager on node 1 (example: Automic ServiceManager.AEHP).

l Switch to node 2 within the Windows cluster.
l Install the following components on node 2:
l Automation Engine
l UserInterface
l ServiceManager
l Register the ServiceManager on node 2 (example: Automic ServiceManager.UC4HP).

l If agents are used on cluster computers, enter the cluster's IP address in the corresponding INI-file
parameter UC_EX_IP_ADDR (section [VARIABLES]).
l Enter the AE Service as Generic Service in the Windows cluster using the Cluster Administrator.
Pay attention to dependencies to disks, TCP/IP and SQL Server. The AE Service starts as the last
service.
l Test the system and check the start of the components in the ServiceManager.
Configuring AE in a Cluster
1. AE Service
l Create a new resource:
After installation, the ServiceManager is integrated in the cluster as a new resource. Enter it in the
group "AE SQL." Replace the provided entries "AE" with the appropriate entry for the system that is
to be installed (such as AEHPor UC4WT).
l Possible resource owners:
Enter the Servers here.
l Definition of dependencies:
The AE Service starts depending on disk S (SQL Server) and X (AE), TCP/IP and the SQL Server's
services.
l Service name:
Enter the exact name of the service here (see service name in the Windows Service's properties).
Start parameters are not required.
l Registry entries for both cluster nodes:
The integration of the ServiceManager in the cluster is now complete.
2. AE – File Share (Automation Engine Documentation / AE CD)
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.
l Possible resource owners:
l Definition of dependencies:
The AE service starts depending on disk S (SQL Server) and X (AE), TCP/IP and the SQL Server's
services.
l Parameters for file sharing:

Enter the path for the release and access authorizations for UC4DOCU here.
3. Cluster Administrator - overview
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.
l Active resources:
See also:
AE and Cluster
8.2.5 After Installation

Creating AE Clients and Users
A newly installed AE system already contains a client. It is called system client and bears the number
0000. This client is your starting point for the creation of additional user-defined clients.
Procedure
1. Creating a new client
l Admin computer
l Log on to system client 0000 with the supplied AE user (name: UC, department: UC, password:
UC).
l 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.
l 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.
l 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).
l Do not assign a name but open the Client object. Several specifications can be made in
theAttributes tab (such as TimeZone).
l 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.
l 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.
l 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.
l Create additional clients if required. A user must be available in each client in order to log on to it.
2. Creating a new user
l Admin computer
l The first user of a newly created client must be created in the system client.
l Click the button in the toolbar and a window that displays all the available object types opens.
Select type User (USER).
l 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).
l Open the User object and assign the appropriate rights and privileges. Then save and close the
object.
l 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.
l Additional users can be created in the client when the user is logged in and authorized.
l User objects in the system client may not start with an "X_" in their names, since that
combination is reserved for internal system objects.
3. Setting up an authorization system
l Admin computer
l AE provides a comprehensive authorization system that consists of several areas that can be
adjusted to your system environment as required.
l 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.
l Automic strongly recommends reading the chapter about the AE authorization system in order to
become familiar with all possible settings.
Comments
In the variable UC_CLIENT_SETTINGS the key PWD_DEFAULT exists, which lets you define a
client-wide default password for any new User object that is created without setting an individual
password.
Thus creating new User objects in a client or copying them contained in a client with the client copy
utility will use the default password defined in this key.
If no password has been defined there, the system default password for new users (User objects)
"pass" will be used.
Configuring your AE System

Automic Supports your processes in several ways. The following list provides an overview of the
information and functions that are available.
It is important to plan how you will use the various functions. You can use the standard default values
that are preset, or you can change them as desired.
General
Function Description
Getting Started This chapter introduces the basic principles of AE.
Utilities Utilities are provided for administrator activities.
Database
Database Maintenance Regular database maintenance is essential after AE system installation.
Database - Overview Additional database maintenance activities are described here.
Settings
Settings in Various settings can be used to adjust AE to your environment. The most important ones
variables 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 Some important details should be noted.
the Time
Server
Multi-Server Several server processes can be operated at once, thereby increasing system
Operation stability and distributing the workload.
Number of Server The number of server processes can be adjusted to your environment.
Processes
Dialog Process This type of server process is exclusively responsible for UserInterface
messages.
AE.Nonstop Server This feature focuses on system stability.
Monitoring and Control
System Client 0000 This client serves to administer system-internal objects and central
settings.
System Overview Includes information about your AE system.
Changing the System Status Can be used to stop and restart processing.
ServiceManager Use the ServiceManager to start and stop components manually or
via batch call.
Starting and Ending Server Start and stop the AE system in a controlled manner.
Processes
Handling Agents Can be used to start, stop and monitor agents.
Agent Variables Contain the agent settings.
Start Parameters components can also be started via the command line.
CallAPI Can be used to trigger external processes in your AE system via
CallAPIs.
Auditing
Version Management for Stores object modifications so that they can easily be traced.
Objects
Revision Report Contains detailed information about object modifications and accesses.
Querying Tasks in your AE Provides an overview about tasks.
system
Open Interface to Output Information about task executions and report contents can be
Management Systems transferred to external Output Management Systems.
User
Authorization System Provides controlled access to your AE system for users and components.
External Password Check You can check, admit or reject AE system logins.
8.3 Hotfix Installation
8.3.1 Installing Hotfixes

Hotfixes are released with each sub-release. They serve to remove possible malfunctions and defects.
Please note that the most current hotfix always includes the modifications of previous hotfixes. It is
therefore not necessary to install all previous hotfixes in order to have all modifications included in your AE
system.
Use the guidelines for upgrading an AE system if you intend to upgrade to a new version of AE.
Messages and message numbers can also change within hotfixes. Adjust them if they have a control
function in your AE system. The message-comparing program UCCMPMSL.EXE lists all messages
that have changed.
Procedure
1. Downloading a Hotfix
l Log on to the Automic Download Center (http://downloads.automic.com).

l Select "Automation Engine" from the Application drop-down optionally filter with any of the other
fields.
A list of applicable downloads will be listed at the bottom of the screen.
l Download the Hotfix.
2. Installing a Hotfix
The installation procedure depends on the component that is to be updated.

l Hotfix for initial data:

l Copy the whole database directory to the computer on which the utilities are installed.
The DB directory must be a parallel directory of the utilities' BIN directory.
l Shut all server processes down. This is especially important if server processes are
distributed among several computers. Then load the file UC_UPD.TXT to the database
using the utility AE.DB Load.
l If necessary, load the server processes (see Hotfix for Servers).
Set the parameter StartMode =COLD in the INI-file UCSRV.INI of the server process
that starts first (in other words, the one that will be the primary work process). Restart
this server process and then restart all other server processes.
If you intend to update the server as well, a coldstart is only required after the server
hotfix installation.
l Hotfix for Autmation Engine: Stop the server processes on all computers. Install the hotfix files
and restart the server processes.
l Hotfix for UserInterfaces: Install the hotfix files for UserInterfaces.
Automic recommends installing one common hotfix version for initial data, server processes
and UserInterfaces.
When updating the UserInterface to a new hotfix version, make sure that you use the current
Online Documentation. If your version is not up to date it can happen that an incorrect document
opens when you open the help in the UserInterface via the F1 key. This can also happen if you
install the Online Documentation with a hotfix but use an older version of the UserInterface.
l Hotfix for utilities, agents and other components: Stop the component and install the hotfix
files.
8.3.2 Shutting Down and Storing Automation Engine

This document describes how to shut down and store the existing AE
l Admin computer, user computer, server computer, hosts

l Close all UserInterfaces.
l Close all agents.
l Close all Automation Engines.
l If necessary: close the service that started the ServiceManager.
l Store all directories in which AE has been installed.
l Store the database.
Make sure to store the database with database utilities.

8.3.3 Utilities
This document describes the hotfix installation procedure for the utilities.
Because all AE Operations Manager utilities are programmed in Java, Sun Java 2 JRE (Java Runtime
Environment) is a prerequisite for utility installation.
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
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
Procedure
l Admin computer
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.
2. Transferring the tar File to the Host
l Admin computer
l Transfer the TAR file util???.tar.gz via FTP.
l 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.

gzip -d util???.tar.gz or gunzip util???.tar.gz
tar xvfo util???.tar
l 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.

This document describes the hotfix installation procedure for the utilities (Windows).
Sun Java 2 JRE (Java Runtime Environment) is required in order to install utilities because all Automation
Engine utilities are programmed in Java.
You can start the utilities via the appropriate EXE or BAT file.
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
Procedure
This installation step can be skipped if the required version of JRE is already installed.
l Admin computer
l 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.
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. Installing the utilities
l Admin computer
l 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. Adjusting the INI files and setting up the system environment

l Admin computer
l Data source AE must be set for ODBC access (ODBC32).
l 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.
Each utility has only one INI file that includes the parameters. The INI file names are:
lAE DB Archive (UCYBDBAR.ini)

lAE 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)
l The INI files have the same name as the appropriate utility
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.
8.3.4 Changing the Database

The DB directory of the installation CD can include several versions of SQL scripts and database files.
They are required if you update several versions. Be sure to use the correct version if <vers> is indicated in
the document.
Automic strongly recommends reading the notes for updating the AE database.
Modifications that should be made are available in the special_rt.sql file. Also execute the new_mq.sql file.
Search the UC_UPD.TXT file for the lines shown below and remove the comment "message" at the
beginning.
Extract of the adjusted UC_UPD.TXT file:

process_sql_file new_mq.sql
process_sql_file special_rt.sql
The special_rt.sql file converts the stored reports in the database. Depending on the number of report data
records that are affected by the conversion it is important to ensure that there is sufficient memory and a
transaction log of the appropriate size. Because the table is copied, it exists twice for a while which also
prolongs the conversion process. Automic recommends reorganizing the reports before you execute the
UC_UPD.TXT file in order to minimize the number of report data records.
Procedure
1. Changing the database scheme and loading new initial data to the database
l Server computer
l 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.
l Admin computer
l 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:
l Utility in C:\AUTOMIC\UTILITY\BIN
l Database files in C:\AUTOMIC\UTILITY\DB
l Utilities - Windows:
The files for the AE database are provided in IMAGE:DB. Copy the complete DB folder to the above
directory
l 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.
l Start the program AE DB Load to update the database.Select the file <DB
directory>\GENERAL\<vers>\UC_UPD.TXT
l 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. Selecting the authentication method
l Admin computer
l The utility AE.DB Load displays a mask in which you must select an authentication method.
l This mask is only displayed if the database is updated to a new Automation Engine version.
3. Installing partitioning with ILM (optional)
l Admin computer
l A mask opens in which you can select the settings for partitioning with ILM. This step is optional.
l Note that you cannot undo an AE database partitioning process.

8.3.5 Installing the Automation Engines

Installing the Automation Engine for UNIX
This document describes the hotfix installation procedure for the Automation Engine.
Because the Automation Engine for UNIX is available for different platforms, a three-figure code has been
supplied for each supported UNIX platform. The codes correspond to agent codes, and are described in
the Terminology. In this document, the specific code is replaced with the characters "???."
General Requirements
l Root authorization during installation. Not required in order to operate the Automation Engine.
l After installation, no reboot of the UNIX System is necessary.
l 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 can be found
in its respective UNIX platform subdirectory in IMAGE:AUTOMATIONENGINE\UNIX\.
UCS???.tar.gz ... Files of the Automation Engine
Procedure
1. Transfer the tar file
l Server Computer
l Note that all server processes must be ended before the updating process starts. This is
particularly important when server processes run on several computers.
l Log on as AE.
l Transfer file ucs???.tar.gz from /cdrom/cdrom0/<version>/Server/unix/<platform> using FTP
(binary).
l Unpack the transferred tar file in the current directory.
tar xvf ucs???.tar
or
tar -zxvf ucs???.tar.gz
2. Adapting the INI file
l Server Computer
l 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.

This document describes the hotfix installation procedure for the Automation Engine .
Requirements
l Database connection already exists from the former installation
Supplied Files
The Automation Engine files can be found in the IMAGE:AUTOMATIONENGINE\WINDOWS directory.
Procedure
l Server computer
l 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.
l The folders BIN and TEMP already exist from the previous installation.
l Start the program SETUP.EXE in the directory IMAGE:AUTOMATIONENGINE\WINDOWS.
2. Adjusting the INI file
l Server computer
l 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.
8.3.6 Installing the UserInterface

Installing the UserInterface (UNIX)
This document describes the hotfix installation procedure for the UserInterface.
The Automation Engine UserInterface is programmed in Java. Therefore, Java 2 JRE (Java Runtime
Environment) must be installed on the computers on which the UserInterface is to be installed.
Requirements

Supplied Files
The UserInterface files can be found in the directory IMAGE:USERINTERFACE\UNIX. The individual
files are combined in the ucdj.tar.gz file.
Procedure
1. Installing the current Java Runtime Environment (JRE) version
Skip this installation step if the required version of JRE is already installed.

l Use the following command to check which version of Java Virtual Machine (VM) is currently
installed.
java -version
Make sure that the directories are in the appropriate order in %PATH% or $PATH if several JRE or
Java SDK versions are installed on the computer. The Java Runtime Environment that is found first
in the list will be used.

l Log on using the user ID uc4.
l Transfer the ucdj.tar.gz directory from IMAGE:UserInterface/unix to /opt/globalDC using the binary
FTP.
l Unpack the transferred tar files in the current directory (/opt/globalDC).
gzip -d ucdj.tar.gz or gunzip ucdj.tar.gz
tar xvf ucdj.tar

l The existing configuration files are not overwritten; supplied files are saved in
UC4CONFIG.ORI.XML or LOGIN_DAT.ORI.XML. If necessary according to the current Release
Notes, adjust the configuration file uc4config.xml.

l Use the following command in order to execute the start script:
chmod +x ucdj.sh

This document describes the hotfix installation procedure for the UserInterface (Windows).
The Automation Engine's UserInterface is programmed completely in Java. This means that Java 2 JRE
(Java Runtime Environment) is required on the computers on which the UserInterface must be installed.
Always install the UserInterface on your local hard disk in order to ensure optimal performance. AE does
not recommend installing UserInterfaces on a network, because if the network fails, the UserInterface can
crash.
Supplied Files
The UserInterface files are found in the IMAGE:USERINTERFACE\WINDOWS directory.
Procedure
1. Installing the current Java Runtime Environment (JRE) version
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
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.
can disable it in the system control; AE does not need it.

l Start the program SETUP.EXE in the IMAGE:DIALOG\WINDOWS directory.
All files required for UserInterface operation are copied to the specified directory. The default
directory is C:\AUTOMIC\DIALOG\BIN.

l The existing configuration files are not overwritten. The files that are provided are stored in
UC4CONFIG.ORI.XML or LOGIN_DAT.ORI.XML. Adjust the configuration file UC4CONFIG.XML
if recommended in the current Release Notes.
4.. Starting the UserInterface

l To execute the UserInterface, you can either use the file UCDJ.EXE or UCDJ.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 C-
Runtime Library.
8.3.7 Installing the Online Documentation

This document describes the hotfix installation procedure for the online documentation.
1. Installing the Online Documentation
l Delete the previous version of the Automation Engine Documentation.

l Copy the current Automation Engine Documentation from IMAGE:DOCUMENTATION to the
required documentation directory.
l Save the documentation to a location to which all users have access, such as a shared directory
on the server.
l 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.
8.3.8 Installing the Agents

Installing the Agent for BS2000
This document describes the hotfix installation procedure for the BS2000 agent.
Because each BS2000 version requires its own agent, a one-character code has been assigned to each
supported version. This code is used in the agent's file name and is described in the Terminology . In this
document, the specific code has been replaced by the character "?."
Close the agent before you start the update installation.
Requirements
l The code $UC4 exists from the previous version.

l The TAR file on the installation CD can be unpacked using the already installed programs BS2 TAR
or BS2 TOOLS (version 2.00W and later).
The files are packed in TAR files. The corresponding TAR file for each BS2000 version is found in the
subdirectory IMAGE:AGENTS\BS2000. The file names indicate the current Automation Engine version. In
the table below, the version has been replaced by the characters "x.xxx."
TAR files that contain "NK4" in their names are for NK4 pubsets and can also be unpacked with the BS2-
TAR program.
Procedure
1. Transferring the TAR files to the host
l Admin computer
l Transfer the TAR file UCXJB2?.TAR or UCXJB2?NK4.TAR via FTP in text mode.
l As an alternative, the TAR file can also be transferred to BS2000 with FTBS2000 or the EDT file
transfer (also in text mode).
2. Unpacking the TAR files and setting up the system environment
l Host
l The TAR file can be unpacked in two ways:
1. Unpack with BS2 TAR:
/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 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.
l 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.
l Remove the prefix from the installation files.
l Old files might still exist after the file names are changed. Check the Release Notes for old files.
l 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.
l The UCYBRFC? file must be shareable when the RFC mechanism is activated.

l Adjust HEADER.BS2000, TRAILER.BS2000 and RESTART.BS2000 if necessary. See:Job -
Execution.
Installing the Agent for Databases

The following document describes the hotfix installation process for database agents.
Agents for Databases can be used either to execute jobs and events or to retrieve values of dynamic
Variable objects (source: SQL). Note that different configuration and start parameters are required
depending on the intended use.
l Database Agent for Jobs and Events

The database agent for jobs and event is only available for a particular database type (such as MS
SQL) which can be specified in the agent's INI file. A separate agent must be installed for each
database type that should be accessed by using jobs or events. The names of the database, Server
etc. must be determined in the particular Job or Event object.
l Database Agent for Variables
The agent for SQL variables can access any supported database type. The particular type must be
defined in the Connection object for databases that is assigned to the variables. Therefore, you
must only install one agent for variables. The database name and the connection parameters
(Server name, port number etc.) are also defined in the DB-type Connection object. Note that the
agent is configured in the Automation Engine's INI file.
The agent is only required for Variable objects that use the source SQL. SQLI variables do not
require an agent.
Supplied Files
The files that belong to the database agent are stored in the directory IMAGE:AGENTS\SQL.
Procedure

l The version of the current Java Virtual Machine (VM) of the system can be checked using the
following command:
java -version
l Host
l Create a separate directory for the agent (for example, C:\AUTOMIC\AGENTS\SQL\BIN or
l 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
l Host
l A suitable JDBC driver must be installed for all databases the agent should use. Refer to the

l Copy the file sqljdbc.jar to the folder's JDBC directory after you have installed the driver.
l The SQL Server 2000 JDBC driver cannot be used with this agent because of a program error in
the driver.
l 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).
l Oracle
l Copy the file ojdbc14.jar to the folder's jdbc directory after you have installed the driver.
l The JDBC driver of version 9.0.1 or earlier cannot be used with this agent because of a program
error in the driver.
l MySQL
l DB2
l Copy the following two files shown below to the agent's JDBC directory:
Click the entry "DB2 Personal Developers Edition: Re-distributable JDBC Type 4 Driver."
l Sybase
driver.
l Informix
l When the driver is installed, copy the files ifxjdbc.jar and ifxlang.jar to the agent's JCDBC directory.
l Because of an Informix error, you must specify the value for the environment variable DB_
Example: [INFORMIX] db_locale=EN_US.CP1252
l Ingres
l Install the JDBC driver.
l SAP HANA
l EXASOL
l Download the driver from EXASOL.
l Copy the JDBC driver exajdbc.jar to the agent's JDBC directory.
l Set the database type in the configuration file to EXASOL.
l Set the values for
connect=60
and
retention_time=180
l PostgreSQL
l Download the driver from PostgreSQL.
l Copy the JDBC driver to the agent's JDBC directory (postgresql-9.3-1100.jdbc4.jar for example).
l Set the database type in the configuration file to POSTGRESQL.
l Set the values for
connect=60
and
retention_time=180
l Oracle RAC
Database Agent for Jobs and Events

l Host
l Adjust the INI file UCXJSQLX.INI to the system environment.
l 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.

Database Agent for Variables

l Server computer
l 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.
l 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.
l 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").
l Server computer
l Host
l Start the agent for jobs or events:
java -jar ucxjsqlx.jar
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.
Example: java -jar ucxjsqlx.jar -iC:\AUTOMIC\server\bin\ucsrv.ini -service

l Check that the agent is logged on to the AE system.
l Start the UserInterface for client 0000. Call information about agents in the System Overview.
Newly logged-on agents have not yet been assigned to a client; they can only be viewed in client
0000. The newly installed agent can now be assigned to clients with the required rights via the
Agent object.

Installing the Agent for GCOS8

This document describes the hotfix installation procedure for the GCOS8 agent.
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.
Procedure
1. Creating the required catalogs
l Host
l Create a catalog for the installation (UC4/version).
l The following subcatalogs are required: DATA, EXEC, INSTALL, JCL, OUT and TMP.
l Admin computer
l 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 CANCEL.SPN, UC4, UC4EX, UC4EXEC.DIR, UC4EXEC.SPN,
UC4TERM.DIR, UC4TERM.SPN, UC4TM
3. Setting the system environment
l Host
l 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.
l Important: Do not remove trace flags.
l Automic recommends setting the parameter TRCOPENCLOSE to "0" in order to ensure consistent
agent performance.
l Host
l Adjust the files UC4EX and UC4TM to the system environment.

l Adjust HEADER.GCOS8 and TRAILER.GCOS8 as needed.
4. Transferring the job report
l Host
l 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.
l Host
l 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.
l Set the parameter RSM= in the INI file to either "N" or "X."
l The section [VARIABLES] of the INI file must contain the parameter UC_EX_PATH_JCL.
Enter the JCL catalog name in that parameter.
l Adjust the file UC4SIM in the JCL catalog so that it contains the catalog in which the agent
has been installed.
l 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.
l Important: Do not set the parameter RSM= when RSM8 is used.
l Host
l Start the agent with the JCL from the file UC4EX.
$ select &uc4cat/jcl/uc4exec.spn
$ endjob
l An Agent object is automatically created in the system client 0000 and stored in the folder HOST.
l Admin computer or Server Computer

l Verify that the agent has logged on.
l Start the UserInterface for client 0000. Call the agent information from the System
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.

l Host
l Use the JCL from the file UC4TM to close the agent.
$ select &uc4cat/jcl/uc4term.spn
$ endjob
Installing the Agent for J2EE/JMX
Stand-alone
Setting Up the Agent for J2EE/JMX
The JMX agent can be run outside of an application server. This installation guide describes the required
steps.
Supplied Files
Procedure
available.

command:
java -version
Note that the order of the indicated directories is relevant when you specify %PATH% or $PATH if

l Host
l 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).
l 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)
l AE supports the generation of automated reports. This function is provided by MBean

"CrystalReports", which is supplied by Automic. It is called with the Agent for J2EE/JMX.
l Use the program UCYBCRYP.EXE to decode the file ucxbo.jar.ucc. It is stored in the folder
CD:\TOOLS\ENCRYPT of the AE CD. Now call the program via the command line using the
following parameters:
UCYBCRYP.EXE -d -f ucxbo.jar.ucc -lLicense file
The license file is supplied by UC4 Support (customer_number.TXT).
l The result is the packed file ucxbo.jar. Copy it to the folder in which the file ucxjjmx.jar is stored.
java -jar -Xrs -Xmx256M ucxjjmx.jar
The agent can also be started using the ServiceManager.
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 Host
l Select the option Local Java VM in the Job object's JMX tab.
l Activate the sub-items "Use existing MBean Server" and "Create new instance..."
Usage with Application Server
Setting Up the Agent for J2EE/JMX (Oracle WebLogic)
The following document includes information about installing and configuring J2EE/JMX agents with an
Oracle WebLogic Application Server.
Supplied Files
Procedure
1. Installing Java Runtime Environment (JRE)
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
No Java installation is required if the agent runs on the same computer as the WebLogic
Server (recommended).
l Host
l Create a folder for the JMX agent (bin) and copy the supplied files.
l 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.
l 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.
l 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
You can also start the agent using the ServiceManager.

l Host
l Select "Remote Java VM" in the Job object's JMX tab.
l Enter the term "weblogic" in the field "Initial Context Factory."
l 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
IBM WebSphere Application Server.
Supplied Files
Procedure
l Host
l Select the menu item Applications -> Install New Application on the WebSphere interface.
l Specify the path to ucxjjmx.war in "Local File System." "Context root" can be used to name the
application.
l The next window can be used to activate the option Generate Default Bindings. If required, other
settings can also be specified.
l Follow the installation procedure as described. At step 4, select the option "Everyone?" in
"administrators."
l 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.
l Call the menu item Applications -> Enterprise Applications. The list now also includes the agent.
Activate it by clicking the button of the same name.
l The agent can be started by using the configuration WebInterface.
2. Using the configuration WebInterface
l Host
l The JMX agent has a configuration WebInterface which can be called with a Web browser using the
following address:
http://Server name:port/context root
l Adjust the settings of the JMX agent to your system environment. The most important ones are:
l Host
l "Remote Java VM" must be selected in the Job object's JMX tab.
l Enter the term "websphere" in the field "Initial Context Factory."
Host name of the WebSphere:port of BOOTSTRAP_ADDRESS
l 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
IBM WebSphere Application Server.
This installation guide applies to WebSphere version 6.0 with activated administrative security.
l Host
l Select the menu item Applications -> Install new application on the WebSphere interface.
l Enter the path to the file ucxjjmx.war in "Local file system." The "Context root" can be used to name
the application.
l In the next window you can activate the option Generate standard connections or configure other
settings.
l Follow the installation procedure until the individual steps are displayed. Step 4 requires the
selection of "Everyone?" in the administrators field.
l When all six steps are completed, click Finish to complete the installation process. The log shows
whether the installation was successful.
l Click Store in master configuration, and then click Store.
l Call the menu item Applications -> Enterprise applications. The list also includes the agent.
2. Configuring the INI file
l Host
l Search for the file ucxjjmx.ini in the WebSphere folder.
l 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 Adjust the values for the javax.* properties according to your environment.
l 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.
l Host
l Start the agent application via the WebSphere console.
l Host
l 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
l Adjust the settings of the JMX agents to your system environment. The following are particularly
important:
l Agent name
l Start the agent

l Click View log files and select the most current log file (it has the number "00"). The section
[WEBSPHERE] must be included in the log file.
5. Important notes for the creation of jobs
l Host
l The agent now uses the SOAP Connector. Therefore, select "Remote Java VM" in the Job object's
JMX tab.
l Enter the term "websphere" in the field "Initial Context Factory."
Host name of the WebSphere:SOAP Port

l 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.
l 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.
Setting Up the Agent for J2EE/JMX (JBoss)
The following document includes information about installing and configuring J2EE/JMX agents with a
JBoss ApplicationServer.
Supplied Files
Procedure
l Host
l Copy the file ucxjjmx.war to a folder and unpack it with an appropriate program.
l 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>).
l 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
l 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/
l Host
l The JMX agent has a configuration WebInterface which can be called with a Web browser using the
following address:
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 Host
l Activate the sub-menu "Use existing MB Server."
l It is not necessary to select the option "Generate new instance..."
Setting Up the Agent for J2EE/JMX (Oracle Containers for J2EE)
Oracle Containers for J2EE ApplicationServer.
Supplied Files
The J2EE/JMX agent files are available in the folder IMAGE:AGENTS\JMX.
Procedure
l Host
l Log on to the Enterprise Manager (http://localhost:8888/em).
l Select the Applications tab and click Deploy. Click Browse and select the file ucxjjmx.war. Then
click Next.
l Enter "uc4" in the text field Application Name. Then click Next.
l Click Deploy. Messages referring to the deploy procedure are displayed.
l Host
l 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:
l Name of the agent
l Host
l In the Job object's JMX tab, select the option Remote Java VM.
l In the field Initial Context Factory, enter the term "oc4j."
service:jmx:rmi://Host name of the Oracle J2EE Server:Port/oc4j
Setting Up the Agent for J2EE/JMX (SAP NetWeaver)
SAP NetWeaver ApplicationServer.
The agent creates an additional log file in SAP format. This file is automatically stored in the agent's
sub-folder, named "log", in the installation directory. It can easily be processed with SAP Tools.
Setting up the J2EE/JMX agent is only possible with a SAP NetWeaver Composition Environment 7.1
Application Server.
Supplied Files
Procedure
l Host
l Copy the file ucxjjmx.sca to the input directory of the Java Support Package Manager (for example,
C:\usr\sap\trans\EPS\in).
l Start the Java Support Package Manager (JSPM) and log on to the JEE Engine.
l JMX agent update installation: In step 1, "Select Package Type," select "Single Support Packages
and Patches (advanced user only)."
Click Next.
l 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.
Click Next.
l 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.
l When this process has been completed, click Exit to end the JSPM.
2. Removing the JMX Agent
l Host
l Use the program "Undeploy View" from the SAP NetWeaver Developer Studio to remove the JMX
agent.
l Select the software component JMX_agent (automic.com) from the list and click Add to
Undeploy List in the context menu.
l Now execute the function Undeploy in order to remove the agent.
l Host
l A Web configuration interface is available for the JMX agent; it can be called from:
http://Sap server name:Port/ucxjmx
l This interface can be used to adjust the JMX agent to your system environment. The following are
l Agent name
l Host
l Select "JNDI" in the JMX tab of the Job object. Enter the object name "jmx."
Setting Up the Agent for J2EE/JMX (Tomcat)
Tomcat Application Server.
Supplied Files
Procedure
l Host
l Start Tomcat and call the Tomcat Web Application Manager.
l 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.
l You must ensure that the role "administrators" exists. If it does not yet exist, adjust the file tomcat-
users.xml. Enter the role and add it to a user.
Example:
<role rolename="administrators"/>
<user username="admin" password=""
roles="admin,manager,administrators"/>
Restart Tomcat to apply the roles.
l The JMX agent is displayed in the section "applications" of the Web Application Manager.
l Host
l 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".
l Use this interface to adjust the JMX agent to your system environment. The following are
l Agent name
Installing the Agent for NSK

This document describes the hotfix installation procedure for the NSK agent.
A three-character code is assigned to each supported NSK Version. It is shown in the file name of the
agent and described in the terminology (NS1 for NSK, Version D40 and later).
Requirements
l Network protocol TCP/IP is available.

l A User ID has been created for the installation.
l Entry #set #informat tacl in the TACLCSTM file for each user who executes jobs in AE.
l OSS and NetBatch must be installed in order to be used for job executions.
l 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.
Procedure
l Admin computer
l Establish a connection to the host via an FTP client and transfer the two supplied files OINSTALL
and UC4AR to a common sub-volume.
l The file OINSTALL must be transferred in text mode (code 101) and UC4AR in binary mode
(code 0).
l Automic stronlgy recommends storing these files in an empty sub-volume.
l The file UC4AR is a self-extracting archive that contains all the files that the NSK agent
requires.
2. Starting the installation procedure
l Host
l Start a terminal emulation program and log on using the user who should be the program owner.
l Change to the sub-volume to which the two files have been transferred.
O OINSTALL
l 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. Adjusting the configuration file INSTINI
l Host
l The file INSTINI contains several parameters that must be adjusted to your system environment.
l Lines that begin with the characters %% are comments.
l Blanks can be ignored, they are irrelevant.
l Specify the parameters in the following format: <parameter name>=<value>.
The parameter name is predefined and cannot be changed. Its corresponding value depends on
your system.
l The file INSTINI must be stored in the same sub-volume as all other installation files
(OINSTALL, INSTALL).
l Automic strongly recommends using empty sub-volumes for volume specifications in order to
avoid conflicts with other programs.
UC4-PROGRAM-SUBVOLUME= Sub-volume for the executable agent files.
UC4-STATUS-STORE-SUBVOLUME= Sub-volume for the StatusStore files of file

transfers.
The agent automatically created StatusStore files.

They store the restart information of active file
transfers. This mechanism ensures that aborted
file transfers can be restarted from a particular file
position (= last restart point). Restart points are
created in regular intervals (setting FT_
RESTART_INTERVAL in the variable UC_
HOSTCHAR_DEFAULT). On Nonstop systems,
the StatusStore files are the following 4 Enscribe
Files with the default names: UC4SST, UC4SSD,
UC4SSL, UC4SSH. You can subsequently
change these file names in the agent's INI file.
UC4-STATUS-STORE-AUDITED= Stores StatusStore files of file transfers as
Audited Files (TMF protection).
Allowed values: "Y" (recommended default value)

or "N"
UC4-TCPIP-PROCESS= Name of the NonStop TCP/IP process name that
should be used by the agent. By default, $ZTC0 is
specified (system standard).
If you specify a different process name, the

required ADD DEFINE TACL statement is
automatically inserted in the startup obey file.
UC4-SERVER-PORT Port number of the Automation Engine's
communication process to which the agent should
connect. Ensure that all affected firewalls are
configured for this port.
UC4-AGENT-PORT= Port number that should be used by the agent in
order to contact other agents. This port cannot be
used by other programs.
UC4-SERVER-IP-ADDRESS= IP address or computer name of the Automation
Engine.
UC4-AGENT-PROCESS= Process name of the agent process.
UC4-OC-PROCESS= Process name of the AE output collector process.
UC4-TSIM-PROCESS= Process name of the AE terminal simulator
process.
UC4-SYSTEM-NAME= Logical name of the AE system (Automation
Engine).
UC4-AGENT-NAME= Logical name of the agent instance.
By default, the system name of the NonStop

Server without "\" is used as the agent name:
AE-AGENT-NAME=%NODENAME%
You can also extend the agent name using pre- or

postfixes.
For example:
AE-AGENT-NAME=UC4%NODENAME%EXE
UC4-TEMP-SUBVOLUME= All temporary files, such as job reports and job
files, are stored in this sub-volume.
l The agent's INI file is completed with the data specified here. After the installation, you can
change these values at any time.
4. Continuing the installation
l Host
RUN INSTALL
l You receive notifications about the installation progress and can terminate it at any time. In this
case, a manual cleanup process can be required.
l A connection to the Automation Engine is established when the installation is complete.

Overview. Newly logged-on agents have not been assigned a client, so they can only be
viewed in client 0000. The newly installed agent can then be assigned to clients with the
5. Starting and stopping the Agent
l Host
l Change to the agent's subvolume and set the following command in the TACL input line:
O EXSTART
l The following command stops the agent:
O EXSTOP
See also:
EMS template file

Installing the Agent for OS/400

This document describes the hotfix installation procedure for the OS/400 agent.
A three-figure abbreviation is provided for each supported OS/400 version. It is part of the agent's file name
and is described in the Terminology (O41 for OS/400 version V4R1M0 and later).
Terminate the agent before you start the update installation.
Requirements
l TCP/IP
Supplied Files
The OS/400 agent is supplied as a binary SavFile. This file can be found in the subdirectory
IMAGE:AGENTS\AS400.
The CallAPI files and its implementation are described in a separate document.
Procedure
1. Transferring the file to the host
l Host
l Create a temporary library for Save File:
CRTLIB LIB(UC4TMP)
l Create an empty Save File.
CRTSAVF FILE(UC4TMP/UC4)
l Create a library for restoring the Save File.
CRTLIB LIB(UC4AUSL) TYPE(*PROD) TEXT('Automation Engine version
11.0.0')
l Admin computer
l 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. Creating the library

l Host
l Create the library.
RSTOBJ OBJ(*ALL) SAVLIB(UC4AUSL) DEV(*SAVF) SAVF(UC4TMP/UC4)
l Delete the temporary library.
DLTLIB LIB(UC4TMP)
l Rename the library.
RNMOBJ OBJ(QSYS/UC4AUSL) OBJTYPE(*LIB) NEWOBJ(UC4)
l Host
The AE system must be running.
l Host
Adjust the INI file UC4/INI(UCXJO41).

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. Creating the start and end programs
l Host
l 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
l Host
l 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.
l The program UCEX_END ends the agent.
Overview. A newly logged-on agent is only visible in client 0000 because it has not yet been
assigned to a client. Via the Agent object, you can now assign the new agent including the
required rights to the particular clients.
Method 2
4. Including the library in the library list
l Host
l 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
l Host
l 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 INI file UC4/INI(UCXJO41).
STRUCAGENT LIB(UC4) PATH('/user/uc4/ucxjo41.ini')

Starts the agent from the library by using an INI file that is stored in the IFS file system.
l The command ENDUCAGENT ends the agent.
ENDUCAGENT LIB(UC4) OPTION(*CNTRLD)

Ends the agent that has been started from the library in a controlled manner.
ENDUCAGENT LIB(UC4) OPTION(*IMMED)

Aborts the agent that has been started from the library with ENDJOB.
l For further information about commands, see: KnowledgeBase.
Installing the Agent for PeopleSoft
Installing the Agent for People Soft (UNIX)
This document describes the hotfix installation procedure for the PeopleSoft agent.
Process scheduling is executed in PeopleSoft by components of PeopleTools. The PeopleSoft agent can
be implemented for all PeopleTools versions that are supported by AE.
Requirements
l Valid Operator IDs that can execute tasks in PeopleTools
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.
Procedure
Transferring the tar file and setting up the system environment
l Host
l Transfer the TAR file UCXJPSX.tar.gz using FTP.
l Navigate to the directory for PeopleSoft:
cd peoplesoft
gzip -d UCXJPSX.tar.gz or gunzip UCXJPSX.tar.gz
tar xvfo UCXJPSX.tar
l If recommended in the current Release Notes, adjust the INI file. Refer to the INI file UCXJXXX.ini,
which is supplied with the installation.
l Admin computer oruser computer

l If needed, adjust HEADER.PS, TRAILER.PS and RESTART.PS. See: Job - Execution.
Installing the Agent for People Soft (Windows)
This document describes the hotfix installation procedure for the PeopleSoft agent.
Process scheduling is executed in PeopleSoft by components of PeopleTools. The PeopleSoft agent can
be implemented for all versions of PeopleTools that are supported by AE.
It is important to ensure that the agent is closed before you start the update installation.
Requirements
l Valid Operator ID that can execute tasks in PeopleSoft
The following additional requirements must be fulfilled so that PeopleTools Process Scheduler Batch
Server process logs can be added to the AE database:
l Entry in the INI file of the agent that allows the transfer of the log files to AE.
l Read permissions for the PeopleSoft process log files
l Read permissions for the configuration file of the PeopleSoft Process Scheduler Batch Server
l Correct entry for the parameter "Log/Output Directory=" in this configuration file
l Agent knows the environment variable that might be used for "Log/Output Directory="
In order to use the AE interface, the following is required:
l Project SBB_PRCS has been loaded in the PeopleSoft Database, validated and authorized for full
access
l AE interface has been activated in the INI file of the agent
Supplied Files
These files can be found in the directory IMAGE:AGENTS\PEOPLESOFT\WINDOWS.
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
l 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).
l 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.

l Adjust HEADER.PS, TRAILER.PS and RESTART.PS as needed. See: Job - Execution.
Setting Up the Agent for Rapid Automation

Security.

UC4/Agent/rapidautomation or C:\AUTOMIC\Agent\rapidautomation).
Supplied Files
The files that belong to the RA agent are stored in the directory IMAGE:AGENTS\RAPIDAUTOMATION.
Procedure
available.

command:
java -version
Environment listed first is used.
l Host
l 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.
l The RA Solution that should be used by the agent is stored in the folder named "cache." Create this
folder in the installation directory.
l Several settings are available for adjusting the RA agent to your system environment. Of note are
should connect. Adjust the INI file.
3. Loading the RA Solution
l Host
l Start the utility AE.DB Load 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
(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.
l 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. Creating Connection objects
l Host
l 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.
l Host
l 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.
l 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.).
java -jar -Xrs -Xmx256M ucxjcitx.jar
The agent can also be started via the ServiceManager.
l Host
l 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.
l 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.
Installing the Agent for SAP

This document describes the hotfix installation procedure for a SAP agent.
Should any problems arise during the installation process, see Knowledge Base.
Ensure that the agent is closed before you start the update installation.
Requirements (UNIX)
l The user identification AE must be set.
Supplied Files
The files are provided in the directory IMAGE:AGENTS\SAP\UNIX or

IMAGE:AGENTS\SAP\WINDOWS.
Procedure
1. Installing the Agent (UNIX)
l Host
l Transfer the TAR file UCXJR3X.tar.gz via FTP.
l Log in using the user AE.
l Unpack the transferred TAR file.
gzip -d UCXJR3X.tar.gz
tar xvfo UCXJR3X.tar
l 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. Installing the Agent (Windows)
l Host
l Start the program SETUP.EXE in the directory IMAGE:AGENTS\SAP\WINDOWS.
l 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.
UCXJR3X.INI, which is supplied with the update installation.

l Adjust HEADER.SAP, TRAILER.SAP and RESTART.SAP if necessary. See also: Job -
Execution.
3. Import the AE Interface
l Host
l This installation step is only necessary if you use the AE interface.

l Copy the transport files.
l Import the transport.
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.
Installing the Agent for Siebel (Windows)

This document describes the hotfix installation procedure for the Siebel agent.
Important: Close the agent before you start the update installation.
The files are found in the directory IMAGE:AGENTS\SIEBEL\WINDOWS.
The other files in this subdirectory belong to the installation program and the AE runtime system.
Procedure
l Host
l 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. Setting the System Environment
l Host
l 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.

l Adjust HEADER.SIEBEL, TRAILER.SIEBEL and RESTART.SIEBEL if needed. See: Job -
Execution
Installing the Agent for UNIX

This document describes the hotfix installation procedure for the UNIX agent.
Each supported UNIX version is assigned a three-character code. This code appears in all file names of
the agent and is described in the Terminology. Throughout this document the specific code will be
represented by "???."
Requirements
l The user ID "UC4" already exists from the former version.

l The directories $HOME/temp, $HOME/bin and $HOME/out exist from the previous version.
l The directory $HOME/temp has write permission (W) for Group and Other.
The files of the agent are supplied in compressed form:

ucxj???.tar.gz ... Files of the actual agent,
ucxb???c.tar.gz ... Files for the Call interface.
Each respective TAR file is found in the subdirectory of IMAGE:AGENTS\UNIX that matches the
particular UNIX version.
Procedure
1. Transferring the TAR file and setting up the system environment

l Host
l Transfer the TAR file ucxj???.tar.gz via FTP.
l Log on using the user AE.
l 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.
l Unpack transferred TAR file.
gzip -d ucxj???.tar.gz or gunzip ucxj???.tar.gz
tar xvf ucxj???.tar
l Adjust the INI file to the system environment.

Refer to the INI file ucxjxxx.ini which is supplied with the installation. Refer to the Release Notes to
find out which adjustments might be required.

l Adjust HEADER.UNIX, TRAILER.UNIX and RESTART.UNIX if needed. See:Job - Execution.
Installing the Agent for VMS

This document describes the hotfix installation procedure for the VMS agent.
Each supported VMS version is assigned a two-character code. This code appears in all file names of the
agent and is described in the Terminology. Throughout this document the specific code will be represented
by "??."
In VMS, text strings that are used to enter commands and call files, for example, are case-insensitive. Any
combination of uppercase or lowercase letters is acceptable. In this document, uppercase letters are used,
except when describing commands of the program FTP.EXE, which can only be entered in lower case.
Requirements
l The user AE has been given the privileges CMKRNL, BYPASS, SYSNAM, SYSPRV and
WORLD.
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
the VMS 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.
The files that match each VMS version are found in the respective subdirectory of IMAGE:AGENTS\VMS
.
Procedure
1. Transferring the command file to the host
l Admin computer
l Transfer the file UC$CRDIR.COM via FTP (ascii).
2. Setting up the directories and authorizations
l Host
l Log on using user ID "AE".
l Call command file:
$ @UC$CRDIR
l Delete command file:
$DELETE UC$CRDIR.COM;*
The command file UC UC$CRDIR.COM creates all the necessary directories and authorizations.
Directory Authorization
BIN SYSTEM: RE, OWNER: RWED, GROUP: E, WORLD: E
CMD SYSTEM: RWE, OWNER: RWED, GROUP: R, WORLD:
-
TEMP SYSTEM: RE, OWNER: RWED, GROUP: WE, WORLD:
WE
OUT SYSTEM: RW, OWNER: RWD, GROUP: RW, WORLD:
RWE
3. Transferring other files to the host
l Admin computer
l 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.
l Host
l Change from the login directory to the BIN directory:
$SET DEF [.BIN]
UCXJV??.INI, which is supplied with the update installation.
l Change to the CMD directory:
$SET DEF [-.CMD]

l 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 Adjust HEADER.VMS, TRAILER.VMS and RESTART.VMS if needed. See: Job - Execution.
Installing the Agent for Windows

This document describes the hotfix installation procedure for the Windows agent.
The Windows agent can be used for 32-bit and 64-bit. Each version is identified using a three-digit
abbreviation. These abbreviations are used in the agents' file names, and are described in the
Terminology. In this document, the specific abbreviation is replaced by "???."
The files are found in the directory IMAGE:AGENTS\WINDOWS.
The other files in this subdirectory belong to the installation program and the AE runtime system.
Potential Problems
l A combination of uppercase and lowercase letters in the host name.

l IP address with leading zeros.
Windows Agent for System-Wide E-mail Connection
The system-wide AE email connection can be implemented using a Windows agent. Detailed information
on setup of the email connection is to be found in the Knowledge Base.
Procedure
l Host (32-bit)
l 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).
l Host (64-bit)
l Important: Be sure to save the INI file UCXJWI6.INI.

l Copy all files from IMAGE:AGENTS\WINDOWS\X64 or IMAGE:AGENTS\WINDOWS\IA64.
l Host
l 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.

l Adjust HEADER.WINDOWS, TRAILER.WINDOWS and RESTART.WINDOWS if needed. See:
Job - Execution
Installing the Agent for z/OS

This document describes the hotfix installation procedure for the z/OS agent.
It is important to ensure that the agent is closed before you start the update installation.
Requirements
l JES2 or JES3
l TCP/IP V3R2M0 or later
l C runtime library version V1R5M0 or later
l An MSGCLASS in HOLD status that does not call a subsequent program (external writer)
l UPDATE access for JESSPOOL RACF Class (in order to process Job outputs)
Supplied Files
The files are stored in the directory IMAGE:AGENTS\MVS.
Load Module:
l CADSDEL - A utility that can be used to release a Common Dataspace (CADS) allocated by the
Event Monitor.
l UC4END - End messenger for the SMF messenger technique (it writes the StepList and return
codes to the JESMSGLG)
l UC4RESTR - Restart messenger for the SMF messenger technique (dummy program such as
IEFBR14)
l UC4START - Start messenger for the SMF messenger technique (dummy program such as
IEFBR14)
Procedure

l Host
l Transfer the appropriate files from IMAGE:AGENTS\MVS\ by file transfer.
openHost
Use an FTP user with the appropriate rights
User name = UC4
Password = <as set>
bin
quote site recfm=fb lrecl=80 blksize=6080
quote site pri=1 sec=1 CY
put UCXJM25-???.bin 'UC4.UCXJM25.BIN'
asci
put UCXJM25.ini 'UC4.UCXJM25.INI'
quote site recfm=vb lrecl=500 blksize=27998
put ucx.msl 'UC4.UC.MSL'
2. Creating the Load Library
l Host
l Create the LOAD library using the utility TSO RECEIVE. Parameters shown in bold are system-
specific specifications.
//UC4LOAD JOB (ACCT#),'UC4USER',
// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),NOTIFY=UC4USER
//*************************************************
//STEP01 EXEC PGM=IKJEFT01,DYNAMNBR=30
//SYSTSPRT DD SYSOUT=*
//SYSTSIN DD *
PROFILE NOPREFIX
RECEIVE USERID(UC4USER) INDSN('UC4.UCXJM25.BIN')
DSNAME('UC4.UCXJM25.LOAD') -
UNIT(3390) VOLUME(??????)
/*
Alternately, it can be created as follows:
On the z/OS host:

TSO RECEIVE indsn('UC4.UCXJM25.BIN')
Press Enter and tpye the following line:
dsname('UC4.UCXJM25.LOAD')
3. Creating the AE Started Task
l Host
l STEPLIB libraries require APF authorization.
l 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
//SYSCPRT DD SYSOUT=*
//JOBOUT DD SYSOUT=(A,INTRDR)
//*
l The following files must also be in included in the link chain:
CEE.V1R5M0.SCEERUN
CEE.V1R5M0.SCEELKED
TCPIP.V3R1.SEZACMTX
There is an alternative solution if you do not want to configure your system as described above.
You can specify the AE LOAD library in the STEPLIB, but also in the C-environment's DD card
EDCMTF. Further information is available in the IBM documentation - STEPLIB DD statement.
l 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.
l Copy the procedure 'UC4RUN' into a procedure library such as 'SYS1.PROCLIB'.
l Required authorizations for the STC user in RACF:
l OMVS segment
l ALTER authorization for own datasets (e.g.: UC4.*)
l The started task requires the appropriate authorization to read JES lists
l Generate the datasets for the StatusStore
Example:
//CREATESS EXEC PGM=IDCAMS

//SYSIN DD *
DEFINE -
CLUSTER ( -
NAME(UC4.UCXJM25.SSTORE) -
INDEXED -
VOLUMES(volume) -
CYLINDERS(10 5) -
) -
DATA ( -
NAME(UC4.UCXJM25.SSTORE.DATA) -
KEYS(16 0) -
FREESPACE(10 10) -
)-
INDEX ( -
NAME(UC4.UCXJM25.SSTORE.INDEX) -
)
//* Load a dummy record
//DUMMYREC EXEC PGM=IDCAMS
//OUT1 DD DISP=SHR,DSN=UC4.UCXJM25.SSTORE
//SYSIN DD * REPRO INFILE(IN1) OFILE(OUT1)
//IN1 DD *
DUMMY
/*
l Host
l 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.

l Adjust HEADER.MVS, TRAILER.MVS and RESTART.MVS where necessary. See: Job -
Execution.
8.3.9 Installing the ServiceManager

Installing the ServiceManager (UNIX)
This document describes the hotfix installation procedure for the ServiceManager.
Because the ServiceManager for UNIX is available for different platforms, a three-figure code has been
supplied for each supported UNIX platform. The codes are described in the terminology. In this document,
the specific code is replaced with the characters "???."
Supplied Files
The ServiceManager files are supplied in compressed form, and can be found in subdirectories of
IMAGE:SERVICEMANAGER\UNIX. The names of the subdirectories indicate the supported platforms.
Steps
1. Transfer the tar file and set up the system environment
l Host
l Transfer the TAR file ucsmgr???.tar.gz using FTP.
l Navigate to the directory for the ServiceManager:
cd servicemanager
l Unpack the tar file
gzip -d ucsmgr???.tar.gz or gunzip ucsmgr???.tar.gz
tar xvfo ucsmgr???.tar
l 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.

This document describes the hotfix installation procedure for the Automation Engine.
ServiceManager programs are updated when the directories IMAGE:SERVICEMANAGER\WINDOWS

and IMAGE:SERVICEMANAGERDIALOG\WINDOWS are set up.
The existing INI and SMD files are not overwritten during update installation. Thus, the steps for their
configuration can be omitted. Check the references in the Release Notes to see if manual changes are
required.
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.
The directory IMAGE:SERVICEMANAGERDIALOG\WINDOWS contains the files for the
ServiceManager's dialog and command line programs.
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. Installing the ServiceManager
l Start the program SETUP.EXE in the directory IMAGE:SERVICEMANAGER\WINDOWS.

UCYBSMGR.ORI.INI which is supplied with the update installation.
2. Installing the ServiceManager's dialog and command-line programs

l Start the program SETUP.EXE in the directory

IMAGE:SERVICEMANAGERDIALOG\WINDOWS.
UCYBSMDI.ORI.INI which is supplied with the update installation.
Uninstalling the ServiceManager
In some cases, it is necessary to uninstall a specific ServiceManager environment (Phrase).
l Open an MS-DOS window.

l Start the program UCYBSMGR.EXE with the statement:
UCYBSMGR -remove Phrase
l This uninstalls the ServiceManager environment as a service under Windows.

l Check the Control Panel - Administrative Tools - Services to verify that the service was removed.
See also:
8.3.10 Comparing Messages

Messages provide information about the status of the AE system and its activities. They are written to log
files, reports or the Message Window of the UserInterface for example. Because there can be new,
changed or deleted messages from one Automation Engine version to the next, it is important that you
understand these adaptations.
The message-comparing program lists all changes in detail. It compares the message libraries (UC.MSL)
of both Automation Engine versions and prints the result, sorted by language, in HTML files.
The program UCCMPMSL.EXE is stored in the directory IMAGE:TOOLS\UCCMPMSL. Copy the whole
folder to the AE installationation directory.
Call the program via the command line with the following parameters:
UCCMPMSL[.EXE] -opath of the original UC.MSL -npath of the new UC.MSL -pdestination path
There will be 5 files in your destination directory, including RESULT_ENGLISH.HTML, RESULT_

GERMAN.HTML and RESULT_FRENCH.HTML, which provide an overview of the message changes.
Each of these three files contains a list that can be sorted by changed, deleted and new messages.
Additionally, a style sheet for templates (UC4STD.CSS) and the log file COMPARE_ZUHELP_
LOGG.TXT are copied to this destination directory.
Example
UCCMPMSL.EXE -oC:\AUTOMIC\uc.msl -nC:\AUTOMIC\uccmpmsl\uc.msl -

pC:\AUTOMIC\uccmpmsl\
8.4 Upgrade Installation
8.4.1 Zero Downtime Upgrade

Upgrade Process
As of version 11.2 of the Automation Engine you can use the Zero Downtime Upgrade (ZDU) to upgrade
your AE system with no downtime.
A wizard is provided to guide you through the whole process. There is no need for scripting or use of AE
internals. You only need to follow the steps that are visible in the UserInterface at each step.
Below you find a description of the steps necessary for upgrading your system without any downtime
using the ZDU wizard.
This process equally applies to an upgrade of a major or minor version or a service pack.
Our consultants are experts in upgrading AE systems. Contact Automic, our experts will be pleased to
assist you whenever it is necessary.
Overview
l ZDU is a special function in the Automation Engine as of version 11.2. It is meant to enable
system upgrades between major or minor versions without closing down the AE system.
l You can use this function to upgrade from a previous version and / or service pack to the
next, but you cannot not skip a major version.
l The ZDU needs certain prerequisites in order to work properly.
Among others you should install two separate environments, either on separate hosts or on the
same host.
Refer to the detailed description below to prepare your setup accordingly.
l Two special modes exist for this upgrade function, the compatibility mode and the parallel mode.
Compatibility mode: This mode is started as soon as you choose the option BEGIN from the ZDU
wizard. In this mode, in effect until you choose the option FINALIZE, certain system optimization
functions are not available. System performance will be reduced noticeably.
Parallel mode: A mode during the upgrade when base and target version processes are active at
the same time.
l You will start the process by choosing the option BEGIN in the wizard. That way the system
will be set into the compatibility mode.
This mode will persist during the whole time, even if you should conduct a rollback, until you choose
the option FINALIZE to use the new target version.
In this mode the system will use base version and target version CPs and WPs as the upgrade
process advances, but base version WPs may slow down until the upgrade is complete.
l In the course of the upgrade you will be asked to test (even for a few days), if all things work
smoothly before finalizing the upgrade.
l If you encounter errors, you will be able to perform a rollback by using the Rollback option,
also described further down this page.
Although a rollback option has been implemented, database changes will persist. The rollback is
a temporary measure only.
Automic strongly recommends to start an upgrade only if the necessary preparations for setup and
testing have been taken care of.
The ROLLBACK option will only be visible in the wizard, after the option UPGRADE has been
successfully processed.
l The whole upgrade process is finished by the option FINALIZE in the final step.
The compatibility mode is ended and the system will then run under ordinary conditions.
Once you have selected and confirmed the option FINALIZE, a rollback will no longer be
possible!
Comments
l It is possible to set the privilege for this kind of upgrade for any User object, but Automic
recommends that upgrading will be coordinated and conducted by the system's administrators only.
l You have to conduct the upgrade from start to finish in the same client.
You cannot use the system client for the upgrade.
It is not possible to start in one client and finish in another.
l Automation Engine utilities are external applications.
As administrator ensure that no utilities run during the ZDU process.
l Utilities cannot be rolled back once the database has been upgraded (step 4 of the upgrade
process). You will have to use the target version utilities from then on.
l System performance will be reduced considerably once the upgrade has been started and the
compatibility mode is active.
As long as the compatibility mode is active, the performance will be about two thirds of ordinary
runs.
l As two processing lines have been introduced, the following script elements might fail and throw
a script error message (no. 20909), when you switch to parallel mode or initiate a ZDU rollback:
l CHANGE_LOGGING() for agent
l SYS_INFO(MQ*,*)
l MODIFY_SYSTEM(SMGR_LOOKUP)
To prevent this error, take care not to have these elements in use, when switching modes and
restart jobs as necessary.
Flowchart of upgrade and rollback steps:
Preliminary Steps
Requirements
A. System Setup
l In order to be able to conduct the ZDU properly, you have to use two separate environments. These
environments can either be situated on two separate hosts or two separate installations on the
same host, but in different bin directories.
l In the course of the upgrade description shown below there is a reference to either the base or the
target system, which also represent the base and target version in the upgrade scenario.
l Should you use a PROXY and a firewall in the systems used for the upgrade, ports will have to be
configured accordingly.
In a UNIX environment do not overwrite the existing installation, which is possible without warning on
UNIX, even if the binaries are currently in use.
B. Set User Privilege

In order to upgrade your system you have to make sure that the respective user or users (usually the
AE's administrators) have the necessary permissions.
The user (administrator) conducting the upgrade needs the privilege Execute Zero Downtime
Upgrade to be set in the corresponding User object.
For details on how to set privileges in User objects see Privileges Tab
C. Upgrade the UserInterface

In case you upgrade to a major or minor version, upgrade the UserInterface before you start the Zero
Downtime Upgrade process found below.
The UI upgrade is necessary for the administrator conducting the upgrade.

Other users may upgrade their UI at some point while the compatibility mode is active and they log on
to the upgraded system for the first time.
As administrator you should prepare the seamless roll out of the new UI for the average users in
advance.
Should a service pack contain UserInterface fixes, please conduct this step as well.
This is the only case a UserInterface upgrade for installing service packs is necessary.
Upgrade UserInterfaces
l In order to upgrade, start the program SETUP.EXE in the IMAGE:USERINTERFACE\WINDOWS
directory.
All files required for UserInterface operation are copied into the specified directory. The default
directory is C:\AUTOMIC\USERINTERFACE\BIN.
l On UNIX follow the steps as described in the new installation of the UserInterface (UNIX).
Notes:
l When you execute the setup.exe, the installation will find and keep existing configuration files from
the previous installation.
l 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. The only
requirement is that your AE system has the latest hotfix version.
The UserInterface is not completely downwards compatible, though. Some functions are not fully
available.
l Changes made in the UserInterface's interface only become visible when the core components
have been upgraded to the new version.
l Older UserInterfaces cannot be used with AE systems of a newer version. They must be
upgraded at the latest when the core components are upgraded.
l 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 10.x agent can also be used in a 11.x
AE system). This requires the most current hotfix version to be installed on your AE system.
D. Upgrade the Enterprise Control Center

You have to install a new ECC instance every time you upgrade to a major or minor version of the
Automation Engine.
For installing a service pack this step is only necessary if the SP contains changes or fixes for the
ECC.
Upgrading from ECC 2.1 or 11.1 to 11.2

Upgrading an existing ECC installation to a new release upgrades the ECC framework and all its
plug-ins at the same time. Use the same steps to install hot fix packages between releases.
Overview
To upgrade from Enterprise Control Center 2.1.x or 11.0 to 11.2 .x.x involves the following steps:
1. Stopping the Apache Tomcat web server

2. Backing up your current files
3. Upgrading Apache Tomcat
4. Restarting the Apache Tomcat service
5. Deploying the new ECC WAR file
6. Configuring the new ECC version
7. Starting the new ECC
No data migration is needed.
Stopping the Apache Tomcat Service

1. Open your Windows Services manager.
2. Stop the Apache Tomcat service.
Backing Up Current Files

These steps are optional. You can make a safety copy of your entire ECC installation, or just the
configuration files. Although, you can use very little of the previous configurations in the new version, you
might find it helpful to have a copy for later reference when you configure the upgrade.
1. To backup your whole ECC installation, go to your Tomcat installation, open the webapps folder
and make a backup copy of the entire Enterprise.Control.Center folder.
2. To backup only the configuration files, go to the folder where you have the current ECC version
installed, and make a backup copy of the folder webapps/<ECC>/config.
Upgrading Apache Tomcat

Upgrade the Apache Tomcat web application server where you have ECC currently installed to the latest
version that complies with the new release.
1. Check the System Requirements in our online database, the Automic Compatibility Checker to see
which version of Tomcat you need.
2. Go to the Tomcat home page and then download and install the required version. You will find the
installation instructions and other relevant information on their home page.
http://tomcat.apache.org/index.html
For Windows: Download the package called "32-bit/64-bit Windows Service Installer." This
will install Tomcat and a Windows service for it.
3. Increase the memory that Tomcat can allocate to ECC to the amount described in the table that
follows..
Reason: By default Tomcat allocates a low amount of memory to an application. This is not
sufficient for ECC, which keeps a lot of UI state data in memory.
Memory Parameter Amount to Allocate

PermGen Space 256m
Heap size As much as possible (at the very least 2GB)
On Windows:
a. Go to the "bin" folder in your Tomcat installation (...Apache Software Foundation\Tomcat

7.0\bin).
b. Right-click the file tomcat7w.exe and from the context menu select Run as administrator.
c. On the Java tab make the following changes:
o In the Java Options, set the PermGenSpace by adding the parameter
"-XX:MaxPermSize=256m". (Attention: Case sensitive parameter!)

o Set the heap size by setting the Maximum memory pool to the maximum possible
on your system, for example 8192MB, as shown below.
On Linux: In the CATALINA_OPTS environment variable, set the permGen size to 256MB and the
heap space to the maximum possible on your system. In this example, the heap space is set to
8192MB:
-XX:MaxPermSize=256m -Xmx8192m
Restarting the Apache Tomcat Service

2. Stop and restart the Apache Tomcat service.
Deploying the New ECC WAR File

Deploy the new version of the ECC on Tomcat.
1. (Optional) Rename the ECC WAR file, keeping the "war" extension. The name of the WAR file will
also be the context path of your ECC installation.
2. On the server where you have Tomcat installed, copy the WAR file to the webapps folder of the
Tomcat installation. If Tomcat is running, the WAR file will be deployed automatically, creating a
folder with the same name.
Do not delete the WAR file! If you do, Tomcat will also remove the corresponding
subfolder,which also undeploys the ECC!
Configuring the New ECC Version

1. Configure your upgraded ECC using the file descriptions under Configuring ECC as a guide.
If you made a backup before you started the upgrade, then you can retrieve the following files and
settings from the backup files from the previous webapps/<ECC>/config folder:
In the new Configuration from ECC 2.1 that can be used for ECC 11.2
webapps/<ECC>/config
uc4config.xml You can replace the new file with your backup. However, if you have
more than one AE system connection defined, be aware that if the
configuration.properties file has the setting the
automationengine.index=0, then users will be able to log into only the
first connection that is defined in the file. If you want to keep these
settings in both files, then make sure to move the preferred
connection to the first place in the uc4config.xml.
configuration.properties Do not replace the file in your new installation with your backup.
Instead, define the file as described in this guide. However, you
can refer to your backup files for the following two parameters,
which may have optionally been defined in ECC 2.1:
l defaultHomeDashboard (This would be the

"dashboard" attribute in the navigation.xml file.)
l customHomeDashboardsFolder (This would be from the
previous configuration.properties file.)
logback.xml If you had changed the default setting for the severity level of ECC
event messages (DEBUG) for the root element, then you might want
to make the same change for ECC 11.2.
The "theme" folder If you had customized the color or banner logo in ECC 2.1, then copy
the contents of your backed up webapps/<ECC>/config/theme
folder to the folder of the same name in ECC 11.2.
For more information see the topics "Customizing the ECC User

Interface" and "colors.properties."
Starting the New ECC

1. Enter the following URL in the address bar of your internet browser:
http://host name:8080/webapp name/ where:
host name = the name of the computer on which the Apache Tomcat web server runs
8080= the default port for Apache Tomcat
webapp name = the name of the WAR file (without the file extension).
2. Login to the ECC with your user name and password.
See the section Tips for Internet Browsers on ECC Clients for tips about how to ensure that users see
all parts of the ECC user interface correctly.
The Upgrading Steps
In the course of the steps below you can leave the process (close the dialog by clicking Cancel) any
time and return to it later at the step you left off by using the System menu.
Once you have finished the whole upgrade process by confirming the option FINALIZE in the final
step, a rollback will no longer be possible!
Procedure
1. Logon to the UserInterface
If you granted the privilege Execute Zero Downtime Upgrade to a user for the first time in the
preliminary step, that user will have to log off and restart and then log on to the UserInterface of the
AE with those credentials.
2. Open the System menu, select Zero Downtime Upgrade Wizard.
3. In the following dialog select BEGIN from the drop down menu and confirm,
clicking Done.
This will start the compatibility mode and enables upgrading the database with the target version's
schema and initial data.
The dialog will close momentarily.
4. After a few moments the dialog will open again.

Leave the dialog open and use the external DB Load Utility to upgrade the
database.
When this step has been processed, the AE system has loaded the target version database
schema and initial data.
DB Load Utility in this step checks the following:
Running System Check:

l Should ZERO_DOWNTIME_UPGRADE be set to N and the system be running, DB Load
will end the loading process with a corresponding message.
Version Check:
l DB Load checks, if the correct version for the ZDU function is installed and used. If the
version is not correct, a message to that effect will be returned.
New DB Schema and Initial Data - Check and Load:

l If the key ZERO_DOWNTIME_UPGRADE is set to N and the system is not running, DB
Load will load the new DB schema and initial data. For future reference records are written
into the appropriate database table.
l If the key UC_SYSTEM_SETTINGS / ZERO_DOWNTIME_UPGRADE = Y and the
system is running, DB Load will also load the new DB schema and initial data, if a record of a
previous load attempt is found in the database. Otherwise DB Load aborts and returns the
corresponding message.
l In addition DB Load checks, if CPs and WPs of the target version are already active. In case
active CPs/WPs of the target version are found, DB Load will end and return the
corresponding message.
5. After DB Load has finished, select the option CHECKDB from the drop down
menu and confirm, clicking Done.
The dialog closes.
This action verifies that the target version was successfully loaded and registered in the
system.
6. After a few moments the dialog will open again.

Install and start communication processes and work processes from the target
version parallel to the already running ones.
Use the second environment (see preliminary steps) for installing the new processes from the
target version. Make sure not to use recurring names for processes you install. Best practice is the
setup of two separate installations.
The new processes at this point are not yet in use.
7. Select the option UPGRADE from the drop down menu and confirm, clicking
Done.
The system is now running with the target version initial data and processes, while the base
version processes will be subsequently phased out.
This parallel mode should last as long as needed for proper testing.
Use it for testing the system to determine, if the upgrade has been successful and all processes or
tasks run smoothly.
This is necessary in order for you to decide, if you want to finish the upgrade by using the
FINALIZE option. For details refer to the ZDU FAQ page.
At this point the option ROLLBACK will be available as well, which is not visible in the previous
steps.
During this period of time the following tasks have to be executed by the administrator:
l Inform users with active sessions established before the UPGRADE that
they have to re-login in order to free base version CPs from active
connections.
l Disconnect agents connected with base version CPs manually so that they
reconnect automatically with the new CP generation. Make sure that agents
can be disconnected without interruption of running executions.
8. If you are ready after testing to use the new setup, select the option FINALIZE
from the drop down menu and confirm, clicking Done.
This will end the parallel as well as the compatibility mode.

FINALIZE will only be possible, if no base version processes are active anymore.
When you click Done, the following error message may be displayed:
"ZERO_DOWNTIME_UPGRADE - 'FINALIZE' not possible. Workprocesses to shut down are not

idle yet./Please try FINALIZE again later."
In that case scheduled tasks may be active.

Wait for the scheduled tasks to change their execution period (usually the next day), then return to
the wizard and try executing the option FINALIZE again.
Once you have finished the whole upgrade by confirming FINALIZE in this final step, a rollback
will no longer be possible!
Rollback Option
This rollback function is meant for a possible troubleshooting. Certain tasks or processes may not be
running quite as expected while testing the new installation. Choosing this option allows you to check on
those tasks or processes.
The option will be visible in the Zero Downtime Upgrade, as soon as the option UPGRADE has been
performed successfully.
Using this option will roll back the processing to the base version.
Once you have finished the whole upgrade by clicking the option FINALIZE in the final step above, a
rollback will no longer be possible!
Conduct a Rollback
1. Open the System menu and select the option Zero Downtime Upgrade Wizard.
2. Select the option ROLLBACK from the drop down menu and confirm, clicking
Done.
The system now switches back using CPs/WPs from the base version you started from while the
new processes are subsequently phased out.
Exception: The primary role (PWP) remains with a new WP until FINALIZE_ROLLBACK has been
executed.
3. Use this stage for analyzing the reason which caused you to execute the
ROLLBACK.
Two possible main scenarios are identified by Automic, which may cause a rollback:
a. Something in AE object definitions or environment settings has to be adapted in order to
work correctly with the target version. In this case get the necessary work done and
continue afterward with the upgrade procedure step UPGRADE
b. The new processes / initial data from the target version have not been working as expected.
In this case contact Automic Support for assistance in finding out what has to be done.
If new components have to be installed to solve the issue, execute the option FINALIZE_
ROLLBACK.
This will end the parallel mode.
It will switch back the PWP role to base version and shut down running components of the
target version so that they can be replaced.
Install components you may have received from AE Support and continue with the upgrade
procedure step CHECKDB.
When you click Done, the following error message may be displayed:
"ZERO_DOWNTIME_UPGRADE - 'FINALIZE_ROLLBACK' not possible. Workprocesses

to shut down are not idle yet./Please try FINALIZE_ROLLBACK again later."
In that case scheduled tasks may be active.

Wait for the scheduled tasks to change their execution period (usually the next day), then
return to the wizard and try executing the option FINALIZE_ROLLBACK again.
See Also:
Zero Downtime Upgrade

New Installation
Upgrade Installation
FAQ - Zero Downtime Upgrade

As of version 11.2 of the Automation Engine you can upgrade your AE system without any downtime using
the Zero Downtime Upgrade (ZDU).
Here you find answers to the most common questions concerning this mode as FAQ.
FAQ
Q: I'm on a version prior to 11.2 (for example 10 or 11.1). Can I upgrade with ZDU to 11.2?
A: No, version 11.2 is the minimum base version for Zero Downtime Upgrade.
Q: I want to install a 11.2 hotfix or service pack into my 11.2 system in future. Can I do that with
Zero Downtime Upgrade?
A: Yes, service pack upgrades with ZDU are supported as of version 11.2.
Q: Can I use the new features already during the compatibility mode?
A: Yes, if you are logged in with a new UI in a new session after upgrade.
Q: Are users forced to re-login to the new system?
A: They have to re-login with a new UI at any time during parallel mode for freeing base version CPs and
being able to use target version features.
Q: How do we know that jobs from the base version are completed?
A: In 11.2 the action FINALIZE returns a message, if base version work processes are not idle yet. In later
versions a monitoring view will be available in the ECC.
Q: How long do I have to stay in compatibility mode?
A: As long as you need to test the target version to feel comfortable with it and to free base version CPs
from active connections.
Q: Are there performance impacts, while the Automation Engine system is being upgraded?
A: Yes, base version processes will slow down to about two-thirds of their normal performance.
Q: Is there a lot of database load to be expected while the upgrade is in progress?
A: No
Q: Are there possibilities to optimize load balancing during the upgrade?
A: With a completely duplicated environment/infrastructure. See best practice.
Q: Do I need a separate database for the compatibility mode?
A: No
Q: Do I need to duplicate my infrastructure during the upgrade (including ports for CPs, network
connections, etc.)?
A: Possible, depending on your choice how to setup the second environment. See best practice.
Q: Can I install the new version onto the same infrastructure?
A: Yes, depending on your choice on how to setup your upgrade environment. See best practice.
Q: By default, Automic supports 5 CPs. If I have to double that, what do I have to do?
A: You follow the same steps as in previous versions.
Q: Will the database contents be duplicated?
A: No
Q: Can I rollback my database, if the upgrade is not successful?
A: A system rollback is possible, but a rollback of the database is not necessary, as all base version data
will be retained.
Q: What happens, if for example a new field or option gets added to an object type in a new
product version?
How is that handled in each state of the compatibility mode during upgrade?
A: New fields or tabs are not visible as long as the user is connected via a base version UI. Default values
will be used for invisible options. New values will be ignored in case of a rollback.
Q: What happens if the system is in compatibility mode, still running with the base version
CPs/WPs as active environment, and a user logs on to a new UserInterface. Will he see the new
features already?
A: No, new features will not be visible before processing was upgraded to the target version and a re-login
has been performed.
Q: What happens with my long running jobs, if I switch to the new version while the job is
running? Will the target version WPs/CPs or the base version WPs/CPs continue the
processing?
A: As far as possible target version WPs take over processing. If necessary for technical reasons, for
example for a task in status "Generating", base version processes are used.
Q: If I have an extremely long running job and I want to finalize the upgrade, what should I do
with that job? Can I restart the job in the target version system?
A: It is not necessary to cancel active jobs, as they do not block the step FINALIZE.
Q: A job is started with 11.2 and execution failed, for example. Can I restart the job with the new
version? Is there a difference, if I press "Restart" in the base version UI or in the target version
UI?
A: A Restart is possible at any point in time and will not differ across versions.
Q: Can I monitor jobs from both UserInterface versions?

(For example, can I monitor jobs running on the old WPs/CPs from within the new UI? Can I
monitor jobs running on the target version WPs/CPs from within the base version UI?)
A: Yes, you can.
Q: Can I see, what currently gets processed in which WP/CP versions?
A: This will be possible in future versions.
Q: If I am a user in the recently updated UserInterface during compatibility mode, would I be able
to use the new feature already?
A: Yes, based on the assumption that the option UPGRADE was executed successfully beforehand,
which starts the parallel mode.
Q: If I log on to the base version UserInterface during parallel mode, will I be able to see the jobs
started in the target version UI as well?
A: Yes.
See Also:
Zero Downtime Upgrade

New Installation
Upgrade Installation
8.4.2 Upgrading an AE System from Version 11.1

Guidelines for upgrading to a new Automation Engine version.
Below you find the necessary steps for upgrading your system to the latest version.
To help you follow the individual steps of an upgrade process of your AE system meticulously, this topic is
divided into several steps.
Preliminary Information
Notes
To ensure that your upgrading process is successful Automic recommends that you strictly follow
the steps that are described in this guide.
Never upgrade a productive AE system without having it tested extensively in a separate

environment.
For details about installing hotfixes, see the related topic hotfix installation.
General Information
It is very important that you follow a structured procedure when you upgrade 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 upgrading 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 upgrading 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. Upgrade 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 upgraded all 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 upgraded 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 upgrading process can take some time.
The advantage of upgrading step by step is that you can do so in individual and shorter periods of
time which makes it easier to coordinate the upgrading process with other departments and
processes. And it is also easier to locate errors that might occur.
First upgrade your test system. Possible problems can so be recognized and solved before they
occur in your production system. Test the individual upgrading steps, thereby setting up a plan for
upgrading your production system.
The AE system is not available while the database is upgraded.
After each step of the upgrade installation, it is essential to monitor the new components for some
time. Only continue the upgrading procedure when they have proven to run stably.
Note that the upgrading 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 upgrading AE systems. Contact Automic, our experts will be pleased
to assist you whenever it is necessary.
Requirements
Done Condition
Carefully read the Release Notes of the relevant Automation Engine version. They include
information that must be taken into account during the upgrading 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 production system.
The test system helps you to get used to the necessary steps for upgrading your production
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 upgrade the database. The
smaller the database, the quicker the upgrading process. Note that it will still take some time to
upgrade 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 upgrade 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
upgrade 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 TeamTechnical Support Team as soon as you know when you are going to
start the upgrading process.
Ensure that you have the phone number and e-mail address of Technical Support and your login
data for the Download Center.
The Installation Steps
1. Check Incompatibilities between Version 11.1 and 11.2

The table below lists new features that might lead to compatibility issues or should be taken care of
when upgrading - it does not list all new features of this AE version.
New features are described in full in the release notes.
Description of the table columns:
l Topic - Name of the general topic or new feature

l Changed behavior - What has been changed
l Possible incompatibilities - Impact the change may have
l Actions/Countermeasures - What can be done to identify and/or remove possible
incompatibilities
Topic Changed behavior Possible Actions/Countermeasures

incompatibilities
General DB The DB scheme/structure Custom SQL queries l Check chngdb.sql for
change has been changed. on AE DB do not work general changes
anymore. l Check and adapt relevant
Informati
SQL/SQLI/SQLJOBS
on and
objects accordingly
the
l Check and adapt relevant
checking
DB queries used in
instructio
external tools/programs
ns apply
to all
versions,
between
your
existing
installatio
n and the
latest you
want to
upgrade
to,
respectiv
ely.
Release The Release Packaging Possibly automated If there are scripts relying on the
Packaging (zip files, folder structure installation routines old package structure, you have
and its content) have been using release images to adapt the paths.
changed. will not work.
The following files and

folders have been
removed:
l Folder ./11/ (the

content, e.g.
UserInterface,
AutomationEngine)
are now directly in
the base directory
and no longer in the
sub folder.
l The uc4setup files
and the CD image
files have been
removed.
l There is a new
installer available
for single box
installation in the
product bundles.
CP/WP FORMS request routing to When you edit RA Assign an RA agent for relevant
routing RA agents has been connection objects, a clients.
changed. corresponding RA
agent has to be active
in the same client to
retrieve data.
Third party The new state-of-the-art There is no Integrate third party monitoring
monitoring JMX interface EMI incompatibility, but the systems via the new EMI instead.
via External (External Monitoring integration with BMC
Monitoring Interface) has been Patrol, HP OpenView,
Interface introduced. and Tivoli is not
available anymore.
The existing SNMP
interface is still available,
but the third party
integration with BMC
Patrol, HP OpenView,
and Tivoli has been de-
supported.
Doubled MQ MQ tables have been MQ tables might not Adapt DB Reorg scripts.
tables doubled and renamed. be considered when
you use DB Reorg and
existing scripts might
fail due to changed
table names.
Proxy INI file Parameters and the You will not be able to Adapt INI file parameters
extensions format of some parameter reuse INI files of Proxy according to the Proxy user
values have been versions prior to v2 documentation.
changed in the INI file due without adaptions.
to functionality
improvements.
2. Prepare for Upgrade
Don System Work steps

e availabl
e:
Read Release Notes
l Start off by reading the Release Notes of the Automation Engine version to
which you intend to upgrade. They are available in the "Release Notes"
chapter of the Automation Engine documentation.
l The section "Check Incompatibilities between Version X and Y" is very
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.
Deny New Job Starts
l Processing must not be changed during the whole upgrading 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.
l Inform all affected persons about the upgrading process and make sure that
processing is not changed.
l 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
user group object in this case.
Prepare the Upgrading Process of Core Components

l Determine a point in time for upgrading 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 upgrading process depends on
the size of your AE system. Your experiences when upgrading the test
system will help you estimate the required time to upgrade your productive
system.
l Ensure that you have the phone number and e-mail address of Automic
Support and your login data for the Automic Automation Support zone ready.
Carefully think about requesting temporary 24x7 support, if sensitive systems
should be upgraded or if the upgrade is not made during the regular business
hours of our support team.
l Our experts are trained in providing excellent on-site support in upgrading your
AE system. Contact your Account Manager or the Automic Support Team.
Your request will be forwarded to the relevant expert in order to make an
appointment.
l During the upgrade 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.
l The UserInterfaces may already be upgraded. If you upgrade them together
with the core components, access to the relevant computers is required.
l In order to upgrade, start the program SETUP.EXE in the
IMAGE:USERINTERFACE\WINDOWS directory.
All files required for UserInterface operation are copied into the specified
directory. The default directory is C:\AUTOMIC\USERINTERFACE\BIN.
l On UNIX follow the steps as described in the new installation of the
UserInterface (UNIX).
Notes:
l When you execute the setup.exe, the installation will find and keep existing
configuration files from the previous installation.
l 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. 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.
l Changes made in the UserInterface's interface only become visible when
the core components have been upgraded to the new version.
l Older UserInterfaces cannot be used with AE systems of a newer version.
They must be upgraded at least when the core components are upgraded.
l 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 9.00A agent can also be used in a 10.x AE system). This
requires the most current hotfix version to be installed on your AE system.
Upgrade the Enterprise Control Center

Upgrading an existing ECC installation to a new release upgrades the
ECC framework and all its plug-ins at the same time. Use the same steps to
install hot fix packages between releases.
Overview
To upgrade from Enterprise Control Center 2.1.x or 11.0 to 11.2 .x.x involves the
following steps:



These steps are optional. You can make a safety copy of your entire
ECC installation, or just the configuration files. Although, you can use very little of
the previous configurations in the new version, you might find it helpful to have a
copy for later reference when you configure the upgrade.
1. To backup your whole ECC installation, go to your Tomcat installation, open

the webapps folder and make a backup copy of the entire
Enterprise.Control.Center folder.
2. To backup only the configuration files, go to the folder where you have the
current ECC version installed, and make a backup copy of the folder
webapps/<ECC>/config.

Upgrade the Apache Tomcat web application server where you have ECC currently
installed to the latest version that complies with the new release.
1. Check the System Requirements in our online database, the Automic

Compatibility Checker to see which version of Tomcat you need.
2. Go to the Tomcat home page and then download and install the required
version. You will find the installation instructions and other relevant
information on their home page.
For Windows: Download the package called "32-bit/64-bit Windows

Service Installer." This will install Tomcat and a Windows service for it.
3. Increase the memory that Tomcat can allocate to ECC to the amount
described in the table that follows..
Reason: By default Tomcat allocates a low amount of memory to an

application. This is not sufficient for ECC, which keeps a lot of UI state
Maintain the AE database

l Automic generally recommends that you maintain your AE database with our
utilities and database-specific tools on a regular basis. However, reorganize
your database before you upgrade it. The smaller the database, the faster the
upgrading process to the new Automation Engine version will be.
l 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).
These scripts are provided in the directories IMAGE:DB\GENERAL\<version>

and IMAGE:DB\<database type>\<version>. The files uc_upd.txt and
chngdb.sql are especially important.
Duplicate the AE database
l For company-critical processing in the AE system Automic recommends
duplicating and backing up your database.
In doing so, you may leave one of the databases unchanged and easily re-
access your old database, if any problems occur in your system environment.
l The database can be duplicated in several ways:
l For smaller databases: Dduplicate the database in offline mode. This
can be done during the upgrading process of the core components.
During this time, the AE system is not available anyway.
l For larger/complex databases: Upgrade in online mode before the core
components are upgraded.
Inform your database-administration group because the current

log files must be stored in the duplicated database.
3. Upgrade the core components

e availabl
e:
Upgrade Utilities
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 sub-folder for each
component. An example is shown in the chapter about new installations.
l 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.
l Install the utilities (UNIX or Windows).
l 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.
Utility in C:\AUTOMIC\UTILITY\BIN
Database files in C:\AUTOMIC\UTILITY\DB

Upgrade AE and ServiceManager
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.
l Install the Automation Engine (UNIX or Windows) to a new directory.
l Install the new ServiceManager version. Use a new name for the
ServiceManager environment (phrase).
Upgrade Framework Integration (optional)

l Alternately, you can carry out this step after the core components have been
upgraded. The function Framework Integration is not available until it has been
installed.
l 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.
Upgrade UserInterfaces (if they have not yet been upgraded)

If you didn't upgrade during the preparation process, do so now.
Details you find above under "Prepare for Upgrade > Upgrade UserInterfaces".
Upgrade the Enterprise Control Center (if it has not yet been
upgraded)

Details you find above under "Prepare for Upgrade > Upgrade the Enterprise Control
Center".
Stop all clients
l Starting with this step, your AE system is no longer available until the
database has successfully been upgraded.
l Stop all clients when the upgrading time is ripe. This is easily done in the
system control of client 0000.
Stop the Automation Engine
l Stop all server processes. If you work in a distributed Server environment,

note that all server processes on all participating computers are deactivated.
l Pay attention to programs such as Watchdogs, cluster monitoring etc.
before ending the server processes. They might raise an alarm or restart the
Automation Engine.
Back up the AE database
l Back up your AE database.

l As already described in the section on preparations, creating a database copy
provides many advantages. Duplicate it now if you have opted for this step but
have not yet executed it. If a database duplicate was already made at an earlier
point in time, check if this duplicate must be upgraded.
Upgrade the AE database

l Automic strongly recommends reading the notes concerning database
modifications below before starting the upgrading process.
l Upgrade your AE database using the utility AE DB Load. The individual steps
you find below.
l If you have created a duplicate, Automic recommends upgrading 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.
Notes on Upgrading the AE Database
Important Notes:
Automic recommends that a database administrator execute the following

steps.
Direct modifications that are made in database contents without using AE

programs will 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;
Database Upgrade with AE DB Load Utility
Notes:
l The DB directory of the installation CD can include several versions of

SQL scripts and database files. They are required if you upgrade several
versions. Be sure to use the correct version if <vers> is indicated in the
document.
l Automic strongly recommends you also read the notes for upgrading the
AE database above.
l Modifications that should be made are available in the special_rt.sql file.
Also execute the new_mq.sql file. Search the UC_UPD.TXT file for the
lines shown below and remove the comment "message" at the beginning.
l Extract of the adjusted UC_UPD.TXT file:
l The special_rt.sql file converts the stored reports in the database.
Depending on the number of report data records that are affected by the
conversion it is important to ensure that there is sufficient memory and a
transaction log of the appropriate size. Because the table is copied, it exists
twice for a while which also prolongs the conversion process. Automic
recommends reorganizing the reports before you execute the UC_UPD.TXT
file in order to minimize the number of report data records.
Procedure:
Configure and start the Java Work Process (JWP)

l As of version 11.2 of the Automation Engine the function Export with
references and the full text search in the ECC require a JWP.
General
The JWP is a component of the Automation Engine which is required for the following
functions:

l ECC Global Search
Files Provided

/lib/ Directory with OSGI implementation and
JDBC driver.
/plugins/org.apache* Additional OSGI bundles for console and
/plugins/org.eclipse* services.
The directory /configuration/ is created automatically when the JWP is first started
and contains the OSGI bundle's cache.
Installation
Unpack the files
In Windows, the JWP files are automatically copied from the SETUP.EXE program to
the BIN directory. In UNIX, the files are located in the respective TAR archive.
Copy the provided "plugin" and "lib" directories into the BIN directory of the
Automation Engine.
MS SQL Server

Start the Automation Engine and clients

l 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.
l All clients can be started from the System Overview of client 0000.
Monitor the AE system

l Do not yet replace the agents. Older agent versions run smoothly with newer
Automation Engine versions.
In order to take advantage of new features to the full make sure to upgrade
agents as well.
l 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.
4. Upgrade all other components
Done System Work steps

available:
Install the Agents
l 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.
l 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.
l 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 upgrade 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 upgrading 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
Install the remaining components
l 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.
l Now you can replace components such as the CallAPIs. Keep in mind to
monitor the newly installed version for some time.
Use the new functions
l Monitor your upgraded AE system for a time. The upgrading process is

complete if no problems occur.
l Now you can upgrade your production system. Repeat the steps made when
upgrading your test system. Upgrading a test system optimally prepared you
for upgrading your production system.
l Again read the Release Notes of the new Automation Engine version after
having upgraded 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.
l Enjoy using your new Automation Engine version.
8.4.3 Upgrading an AE System from Version 10

To help you follow the individual steps of an upgrade process of your AE system meticulously, this page is
Notes

environment.
General Information

scenario.
Requirements
Done Condition
duplicated.


incompatibilities

incompatibilities
Informati
SQL/SQLI/SQLJOBS
on and
objects accordingly
the
checking
DB queries used in
instructio
ns apply
to all
versions,
between
your
existing
installatio
n and the
latest you
want to
upgrade
to,
respectiv
ely.

folders have been
removed:
l Folder ./11/ (the

content, e.g.
UserInterface,
AutomationEngine)
are now directly in
the base directory
sub folder.
and the CD image
files have been
removed.
l There is a new
installer available
for single box
installation in the
product bundles.
retrieve data.
available anymore.
The existing SNMP
but the third party
supported.
fail due to changed
table names.
to functionality
improvements.
2. Check Incompatibilities between Version 10 and 11.1


incompatibilities
Topic Changed Possible incompatibilities Actions/Counterme

behavior asures
Message nu Message Filtering on Unnnnnn numbers won't work l Find out script
mbers numbers are with functions
now eight digits PREP_
(For detailed l PREP_PROCESS_REPORT
long, instead of PROCESS_
information l PREP_PROCESS_FILE
seven. REPORT and
on individual l Output scan filter PREP_
possible Old format: Log scan scripts or custom tools
l
PROCESS_
impact see Unnnnnn Job reports of old java-based agents
l FILE in scripts
also the topic New format contain 7 and 8 digit messages via search
Message Unnnnnnn Agents of older versions send/log 7
l function e.g.
number digit message numbers change
changes)
PREP_
PROCESS_
REPORT
(,,’ACT’,’*U12
34567*’) to
PREP_
PROCESS_
REPORT
(,,’ACT’,’*U01
234567*’)
l Check filter
objects
manually or
use a SQL
statement
such as
e.g. SELECT
OH_Name
FROM
OH,OFC
WHERE OH_
Idnr=OFC_
OH_Idnr AND
OFC_Filtertext
LIKE 'U001%'
AND OH_
DeleteFlag = 0
Text l 1024 l Oracle DBMS_LOB Package must be Check queries on

variable valu characte installed to handle CLOB tables with changed
es r limit for l Results on string based operations fields (VARCHAR ->
text can exceed 1024 characters instead of CLOB)
based string truncation or output error
e.g. search for
fields/va messages
"OVW_Value1":
riables l Queries of SQL/SQLI objects might
SELECT OH_Name
has been operate on tables with text fields of
FROM OH WHERE
removed changed data types -> refer to
OH_Idnr IN (SELECT
l Data chngdb.sql
OVD_OH_Idnr FROM
type of
OVD WHERE OVD_
DB
SQL like '%OVW_
fields
Value1%' OR OVD_
has been
SQLOra like '%OVW_
changed
Value1%' OR OVD_
from
SQLDB2 like
VARCH
'%OVW_Value1%')
AR
(1024) to
CLOB
(unlimite
d)
Script The second Objects using this script function with the Check all script tabs
function parameter client specified parameter client will abort. for this function and
GET_OH_ was removed remove the parameter
IDNR from this / correct the function
Automic script call.
function due to
security
reasons.
Login A new privilege New privilege is checked and used per l On upgrade the
Objects for has been default after AE version upgrade. new default is
File Events introduced for used and no
on Windows, user objects actions are
Unix, zOS necessary.
l But if user
objects are
loaded via
Transport
Case or XML
data is
imported for
example, this
privilege may
not be set. It
must be set
manually, if
necessary.
zOS: The value of Currently no incompatibility, the old value is No checks/adaptions

Replacing attribute MVS_ still compatible. needed
Job line in JOBTYPE has
JCL been
deprecated.
XML l The l The "Oracle Full Client" must be No checks/adaptions
Variables "Oracle installed (instead of "Oracle Instant needed, part of the AE
(VARA.XML) Instant Client"). DB installation
Client" l The "Oracle XML DB Package" must
is no be installed.
longer
supporte
d.
l "Oracle
XML DB
Packag
e" has to
be
installed.
FAULT_ Deactivation l In previous AE versions, tasks have Check deactivation
OTHER behavior of been deactivated in activities list by options accordingly.
tasks tasks with default. As of version 11 their
(If needed, they can
status FAULT_ deactivation is bound to the
be set to archive the
OTHER has deactivation options of the task.
behavior of previous
been changed. l Consequently more tasks will remain
AE version)
in the activities window, than in
previous AE versions.
Script In previous AE Error occurs on empty call text.
function versions, at
GET_ATT_ least a blank
SUBSTR was returned.
(call_text) As of version
11, no value in
case of missing
call text is
returned.
RA agents Shared third You have to obtain all needed shared third Download Oracle
party libraries party libraries and ensure that they are JDBC driver and copy
were removed installed properly. it to the lib directory of
from the RA the RA core.
agent core.
This is only
required for an RA
agent that needs
an Oracle DB
connection (via
JDBC) - e.g. RA
Banner, RA Oracle
EBS, RA JDE or
RA Oracle Retail.
GET_VAR GET_VAR From version v9 SP4 to v10 SP4, GET_VAR Potentially all scripts
(Upgrade does not resolves recursively. This means, if a value that use GET_VAR
from resolve contains an "&", the script processor tries to and a variable value
versions recursively resolve this. This has been changed. that contains "&"
between v9 anymore. Example: characters, are
SP4 and Static variable 'MYVAR', Key = 1 Value = 'Sc affected.
v10) hmidt&Partners' Affected
Script scripts/variables are
:set &partners = 'no' not easy to determine,
:set &value# = get_var especially with
('MYVAR','1') dynamic variables.
Automic suggests
The variable &value# will contain therefore:
that you apply
v9 SP4 to v10: Schmidtno
comprehensive tests.
V11 : Schmidt&Partners
To determine affected
With version v10 SP4 HF1 the behavior was
Variable objects, you
configurable (key RESOLVE_GET_VAR in
may use this SQL
UC_SYSTEM_SETTINGS).
query:
In v11 the configuration option was removed. select oh_
As a conclusion all variable values, that client, oh_name
should be resolved recursively, must use the from oh where
Script function RESOLVE_VAR. oh_idnr in
(select ovw_oh_
idnr from ovw
where
ovw_value1 like
'%&%'
or OVW_Value2
like '%&%'
or ovw_value3
like '%&%'
or ovw_value4
like '%&%'
or ovw_value5
like '%&%'
) order by OH_
Client, OH_Name
asc
The Script function
RESOLVE_VAR may
be used to recursively
resolve a static
Variable object.
Script Script variables You can use GET_VAR to check for a non-
functions have been existing key, which returns a blank, as shown
GET_VAR changed to in this example:
and STR_ unlimited :SET &test# = GET_VAR
MATCH length. (‚VARA.TEST‘,‘KEY_DOES_NOT_
EXIST‘)
If you use STR_MATCH() following on this,

with an empty string for the script variable
&test#, like this:
:SET &true# = STR_MATCH(&test#,"")
in v10 of the Automation Engine the return

value for &true# will be "Y"
In V11 it will be "N".
Explanation:
In STR_MATCH() a variable of length 0 is
expected (""). Since the variable &test#
contains a blank (" "), the return value for
&true# is "N".
The v11 behavior thus is correct.

Script The result of the Scripts that contain a space as part of their Check scripts for
statement following script numeric value will return an error message. possible spaces and
:SET - is different in remove before using
Spaces not v10 and v11.1: them with v11.2.
allowed as
:
part of SET&TEST#='
numeric 0000000050'
values of :IFFORMAT
script (&TEST#, "0")
variables. =50
:P"valid"
:ENDIF
In v10 it will
result in the
output "valid" in
the report.
In v11.1 you will

receive an error
message about
not allowed
non-numeric
line input.

e availabl
e:
Read Release Notes

Deny New Job Starts

this group.

system.
appointment.
Notes:

Overview
following steps:











4. Upgrade the Core Components


e availabl
e:
Upgrade Utilities



installed.
version.

upgraded)

Center".
Stop all clients

Automation Engine.


you find below.
Important Notes:

steps.

complexity.
Notes:

document.
AE database above.
Procedure:

General
functions:

l ECC Global Search
Files Provided

JDBC driver.
Installation
Unpack the files
Automation Engine.
MS SQL Server


can start.

agents as well.
5. Upgrade all Other Components

available:
Install the Agents



8.4.4 Upgrading an AE System from Version 9

To help you follow the individual steps of an upgrade process of your AE system meticulously, this page is
Notes

environment.
General Information

scenario.
Requirements
Done Condition
duplicated.


incompatibilities

incompatibilities
Informati
SQL/SQLI/SQLJOBS
on and
objects accordingly
the
checking
DB queries used in
instructio
ns apply
to all
versions,
between
your
existing
installatio
n and the
latest you
want to
upgrade
to,
respectiv
ely.

folders have been
removed:
l Folder ./11/ (the

content, e.g.
UserInterface,
AutomationEngine)
are now directly in
the base directory
sub folder.
and the CD image
files have been
removed.
l There is a new
installer available
for single box
installation in the
product bundles.
retrieve data.
available anymore.
The existing SNMP
but the third party
supported.
fail due to changed
table names.
to functionality
improvements.
2. Check Incompatibilities between Version 10 and 11.1

incompatibilities?
Topic Changed Possible incompatibilities Actions/Counterme

behavior asures
Message nu Message Filtering on Unnnnnn numbers won't work l Find out script
mbers numbers are with functions
now eight digits PREP_
(For detailed l PREP_PROCESS_REPORT
long, instead of PROCESS_
information l PREP_PROCESS_FILE
seven. REPORT and
on individual l Output scan filter PREP_
possible Old format: Log scan scripts or custom tools
l
PROCESS_
impact see Unnnnnn Job reports of old java-based agents
l FILE in scripts
also the topic New format contain 7 and 8 digit messages via search
Message Unnnnnnn Agents of older versions send/log 7
l function e.g.
number digit message numbers change
changes)
PREP_
PROCESS_
REPORT
(,,’ACT’,’*U12
34567*’) to
PREP_
PROCESS_
REPORT
(,,’ACT’,’*U01
234567*’)
l Check filter
objects
manually or
use a SQL
statement
such as
e.g. SELECT
OH_Name
FROM
OH,OFC
WHERE OH_
Idnr=OFC_
OH_Idnr AND
OFC_Filtertext
LIKE 'U001%'
AND OH_
DeleteFlag = 0
Text l 1024 l Oracle DBMS_LOB Package must be Check queries on

variable valu characte installed to handle CLOB tables with changed
es r limit for l Results on string based operations fields (VARCHAR ->
text can exceed 1024 characters instead of CLOB)
based string truncation or output error
e.g. search for
fields/va messages
"OVW_Value1":
riables l Queries of SQL/SQLI objects might
SELECT OH_Name
has been operate on tables with text fields of
FROM OH WHERE
removed changed data types -> refer to
OH_Idnr IN (SELECT
l Data chngdb.sql
OVD_OH_Idnr FROM
type of
OVD WHERE OVD_
DB
SQL like '%OVW_
fields
Value1%' OR OVD_
has been
SQLOra like '%OVW_
changed
Value1%' OR OVD_
from
SQLDB2 like
VARCH
'%OVW_Value1%')
AR
(1024) to
CLOB
(unlimite
d)
Script The second Objects using this script function with the Check all script tabs
function parameter client specified parameter client will abort. for this function and
GET_OH_ was removed remove the parameter
IDNR from this / correct the function
Automic script call.
function due to
security
reasons.
Login A new privilege New privilege is checked and used per l On upgrade the
Objects for has been default after AE version upgrade. new default is
File Events introduced for used and no
on Windows, user objects actions are
Unix, zOS necessary.
l But if user
objects are
loaded via
Transport
Case or XML
data is
imported for
example, this
privilege may
not be set. It
must be set
manually, if
necessary.
zOS: The value of Currently no incompatibility, the old value is No checks/adaptions

Replacing attribute MVS_ still compatible. needed
Job line in JOBTYPE has
JCL been
deprecated.
XML l The l The "Oracle Full Client" must be No checks/adaptions
Variables "Oracle installed (instead of "Oracle Instant needed, part of the AE
(VARA.XML) Instant Client"). DB installation
Client" l The "Oracle XML DB Package" must
is no be installed.
longer
supporte
d.
l "Oracle
XML DB
Packag
e" has to
be
installed.
FAULT_ Deactivation l In previous AE versions, tasks have Check deactivation
OTHER behavior of been deactivated in activities list by options accordingly.
tasks tasks with default. As of version 11 their
(If needed, they can
status FAULT_ deactivation is bound to the
be set to archive the
OTHER has deactivation options of the task.
behavior of previous
been changed. l Consequently more tasks will remain
AE version)
in the activities window, than in
previous AE versions.
Script In previous AE Error occurs on empty call text.
function versions, at
GET_ATT_ least a blank
SUBSTR was returned.
(call_text) As of version
11, no value in
case of missing
call text is
returned.
RA agents Shared third You have to obtain all needed shared third Download Oracle
party libraries party libraries and ensure that they are JDBC driver and copy
were removed installed properly. it to the lib directory of
from the RA the RA core.
agent core.
This is only
required for an RA
agent that needs
an Oracle DB
connection (via
JDBC) - e.g. RA
Banner, RA Oracle
EBS, RA JDE or
RA Oracle Retail.
GET_VAR GET_VAR From version v9 SP4 to v10 SP4, GET_VAR Potentially all scripts
(Upgrade does not resolves recursively. This means, if a value that use GET_VAR
from resolve contains an "&", the script processor tries to and a variable value
versions recursively resolve this. This has been changed. that contains "&"
between v9 anymore. Example: characters, are
SP4 and Static variable 'MYVAR', Key = 1 Value = 'Sc affected.
v10) hmidt&Partners' Affected
Script scripts/variables are
:set &partners = 'no' not easy to determine,
:set &value# = get_var especially with
('MYVAR','1') dynamic variables.
Automic suggests
The variable &value# will contain therefore:
that you apply
v9 SP4 to v10: Schmidtno
comprehensive tests.
V11 : Schmidt&Partners
To determine affected
With version v10 SP4 HF1 the behavior was
Variable objects, you
configurable (key RESOLVE_GET_VAR in
may use this SQL
UC_SYSTEM_SETTINGS).
query:
In v11 the configuration option was removed. select oh_
As a conclusion all variable values, that client, oh_name
should be resolved recursively, must use the from oh where
Script function RESOLVE_VAR. oh_idnr in
(select ovw_oh_
idnr from ovw
where
ovw_value1 like
'%&%'
or OVW_Value2
like '%&%'
or ovw_value3
like '%&%'
or ovw_value4
like '%&%'
or ovw_value5
like '%&%'
) order by OH_
Client, OH_Name
asc
The Script function
RESOLVE_VAR may
be used to recursively
resolve a static
Variable object.
Script Script variables You can use GET_VAR to check for a non-
functions have been existing key, which returns a blank, as shown
GET_VAR changed to in this example:
and STR_ unlimited :SET &test# = GET_VAR
MATCH length. (‚VARA.TEST‘,‘KEY_DOES_NOT_
EXIST‘)
If you use STR_MATCH() following on this,

with an empty string for the script variable
&test#, like this:
:SET &true# = STR_MATCH(&test#,"")
in v10 of the Automation Engine the return

value for &true# will be "Y"
In V11 it will be "N".
Explanation:
In STR_MATCH() a variable of length 0 is
expected (""). Since the variable &test#
contains a blank (" "), the return value for
&true# is "N".
The v11 behavior thus is correct.

Script The result of the Scripts that contain a space as part of their Check scripts for
statement following script numeric value will return an error message. possible spaces and
:SET - is different in remove before using
Spaces not v10 and v11.1: them with v11.2.
allowed as
:
part of SET&TEST#='
numeric 0000000050'
values of :IFFORMAT
script (&TEST#, "0")
variables. =50
:P"valid"
:ENDIF
In v10 it will
result in the
output "valid" in
the report.
In v11.1 you will

receive an error
message about
not allowed
non-numeric
line input.
3. Check Incompatibilities between Version 9 and 10

incompatibilities
Topic Changed behavior Possible Actions/Countermeasure

incompatibil s
ities
IT environment Make sure that your IT
requirements environment complies with
the system requirements
of the Automation Engine
version in question before
you start the installation
process.
You will find all necessary
information on supported
platforms and versions in
our online database, the
Automic Compatibility
Checker.
Microsoft As of v10, components
Visual C++ that run under Windows
Redistributable require the Microsoft
Package Visual C++ Redistributable
Package Version 2010.
Agent for As of Version 10, the agent
OracleApplication for OracleApplications will
s discontinued no longer be supplied.
The job templates will still
be available.
File Transfers As of v10, will be processed In v9, the To change this behavior,
asynchronously, which improves default values you need to specify the
performance. of these required settings in the
This improvement has been settings had variable UC_
achieved by changing the default the effect that HOSTCHAR_*.
values of the settings FT_ASYNC_ file transfers
QUIT_* in the variable UC_ were
HOSTCHAR_*. processed
synchronousl
y.
They will
still be
processed
synchronously
after an
update to v10.
The AE.WebInterface is no longer For handling the
AE.WebInterface supplied or supported as of v10. All Automation Engine via a
the related documentation topics web browser, you can now
have been removed. use Enterprise Control
Center.
Oracle Oracle versions 9, 10 and 11g1 are For the
Database no longer supported. Automation
Versions Engine and
the utilities,
this means
that the library
ucuoci is only
provided for
Oracle version
11g2. Thus
there is no
need for you to
rename this
during the
installation
process.
IBM DB2 IBM DB2 versions 9.1 and 9.5 are no
longer supported for the AE
database and the Database Agent.
UNIX agent The UNIX agent and the utilities for
and the utilities for HP-UX are no longer provided for the
HP-UX PA-risc architecture.
UNIX agent The UNIX agent is no longer

supported for SCO Unixware.
INI-file As of version 10, the INI-file So far, you

parameters parameters "reorg_mode=", could define
"suppress_output=", "max_rt_ the method for
number=" and "show_stats=" of the deleting data
utility AE DB.Unload are by using the
meaningless. INI-file
The reason is that this utility now parameter
uses only the new deletion method. reorg_mode=
In the new deletion method it is ([REORG]
essential that no REORG files are section; old
created during the database method:
reorganization process. This is the reorg_
same behavior as with the parameter mode=0, new
setting suppress_output=1 which method:
always suppresses the generation of reorg_
REORG files. mode=1). The
old deletion
method
consumed a
lot of memory
and could
eventually
cause
performance
problems.
The folder structure of the supplied
Documentation documentation has changed. The
Folder Structure folders "uc4" (this includes
"htmlhelp") and "unix" are now
located in the directory "Guides" .
The new folder "Release Notes"
includes the Release Notes for
Automation Engine and the UI plug-
in as PDFs.
MS SQL As of v10, MS SQL Server 2005 is
Server 2005 no longer supported for the AE
database, the utilities, and the
Database Agents.
MBean for The MBean for SAP ACC is no
SAP ACC longer supplied or supported. The
related documentation topics have
been removed.
Microsoft The databases Microsoft Access
Access and and SAP MaxDB are no longer
SAP MaxDB supported for the Database Agent.
The components AutomationEngine,

AutomationEngin ServiceManager, agents and utilities
e, for Windows and Linux are no longer
ServiceManager, supported on Itanium processors.
agents and
utilities for
Windows and
Linux
Workflow Workflow tasks that are waiting for
tasks their starting time now appear blue in
the monitor.
Java Java Application Interface: The To indicate a delay of one
Application measurement unit for the method day, you must now specify
Interface DeactivateCondition.setDelay(n) the value 1440 instead of
has been changed from days to 1.
minutes. Keep in mind that you must
adjust existing Java codes
correspondingly.
The names of the files that are used
Documentation to access the documentation have
File Names changed. The new names are as
follows:
l HtmlHelp: help.chm
l WebHelp: help.htm
l Message documentation:
Messages.chm/Messages.ht
m
Object When Automic recommends
variables (:PSET, upgrading setting such workflows
PASS_VALUES) from v8 to inactive before starting the
v10, object upgrade process.
variables
(:PSET,
PASS_
VALUES)
may not
correctly be
inherited when
the workflow-
or task-
generation
process has
already
started in v8
and continues
in v10
(generating at
runtime, for
example).
Rollback Rollback function restricted: Since

function "Deactivate (forced)" has now been
enabled for sub-workflows, a
workflow's rollback function will fail
for sub-workflows, which have
already been deactivated by the
"Deactivate (forced)" function, as
the sub-workflow is no longer
available in activities.
CANCEL_ In previous releases, the CANCEL_ l Use search function
UC_OBJECT UC_OBJECT script function could to find objects using
script function be used for ended tasks to triggered the function
a deactivation. This is not possible CANCEL_UC_
any more. OBJECT in process
tabs (go to Further
options / [x] Search
in Process, Text:
CANCEL_UC_
OBJECT)
l Replace function
CANCEL_UC_
OBJECT with
DEACTIVATE_
UC_OBJECT in
cases where a task
has to be
deactivated but not
cancelled by the
function.
Now you need to use the

DEACTIVATE_UC_
OBJECT script function
instead.
PromptSets Use PromptSets within an activity As of v10, users have to
have "X" execute
permissions defined for
PromptSet objects in their
User objects'
Authorizations tab.
As of v10, the Webhelpsplitter tool is
Webhelpsplitter no longer supplied or supported.
tool
Task sync As of v10, if a task uses a sync and
has a START and END action
defined, but no ABEND action, then
during a restart on abend, it does not
execute the START action again.
This is because no END action has
been executed.
Term Instead of the former term

"Modification "Modification Archive", AE now uses
Archive" "Release Notes" in all languages.
This applies to the Automation
Engine documentation, the supplied
files, and the Automic Download
Center.
Folder Name The folder "Docu", which is part of
Documentation the supplied disk image, has been
renamed to "Documentation".
Object As of v10, object variables and
variables and PromptSet variables can be used
PromptSet within the bind parameters of SQL
variables SECURE-type and SQLI SECURE-
type VARA objects.

e availabl
e:
Read Release Notes
Deny New Job Starts

this group.

system.
appointment.
Notes:

Overview
following steps:











5. Upgrade the core components

e availabl
e:
Upgrade Utilities



installed.
version.

upgraded)

Center".
Stop all clients

Automation Engine.


you find below.
Important Notes:

steps.

complexity.
Notes:

document.
AE database above.
Procedure:

General
functions:

l ECC Global Search
Files Provided

JDBC driver.
Installation
Unpack the files
Automation Engine.
MS SQL Server


can start.

agents as well.
6. Upgrade all other components

available:
Install the Agents



8.5 Changing the Database
8.5.1 About Changing the Database

This document is a manual for changing the AE database. In this part of the documentation it is assumed
that a functioning AE environment is already installed.
The following symbols are used in the documentation:
Indicates a procedural step of the installation.
Indicates possible problems during installation and gives instructions.
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

Unloading the Database any yes
Setting Up the Database DB/Admin yes
Loading the Database Admin yes

8.5.2 Unloading the Database

In this step, unload the current database
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
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).
l 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.
l Save the file after unloading.
8.5.3 Setting Up the Database

The following document guides you through changing the database and setting up a new one.
Please refer to the advices of performance optimization before setting up the database (Configuration &
Performance of the Database).
All the described working steps refer to the installation of the MS SQL Server. Apply the adequate utilities
and functions for Oracle or DB2 if these databases are used. Oracle uses two tablespaces (UC4_DATA
and UC4_INDEX).
For Oracle Automic strongly recommends using the tablespaces UC_INDEX and UC_DATA only, as
otherwise you would have to manually adjust all SQL files during an update process.
1. Requirements
l DB computer
l MS SQL Server must be correctly installed and ready to run
l Installation settings:
l Use standard code page
l Standard Sorting, case insensitive (alphabetical order, regardless of case)
2. Creating directory structure and starting the SQL Server
l DB computer
l Create directory structure \AUTOMIC\DB
l Start SQL Server if it has not already been started (ServiceManager)
3. Setting up the database

l DB computer
l Start the SQL Server Database Management Program
l 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. Creating the Data Source
l Admin computer
l Create data source "AE" for ODBC access (64 bit ODBC)
8.5.4 Loading Database

Many versions of SQL scripts and database files are provided on the delivery directory. You will find them
in the subdirectory of IMAGE:DB. If <vers> is specified in this document, select the appropriate folder of
the Automation Engine version that you are using. If there is no separate folder of your version, the
database structure has not been changed since the last version. In this case, you can use the previous
version.
Example:
You are using the Automation Engine version 11.0.0 and the MS SQL server 8.0.
In this case the appropriate directory is IMAGE:DB\SQL_8\11.0.0.
1. Copying files for loading the database
l Admin computer
l Copy all subdirectories from IMAGE:DB to \AUTOMIC\DB.
2. Loading database structure
l Admin computer
l Start the SQL Query Analyzer and select your newly created database.
l Now open the file \AUTOMIC\DB\SQL_8\<vers>\UC_DDL.SQL and execute it.
3. Loading the current database
l Admin computer
l Change the ODBC data source to the new database.
l 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.
l Then start AE.DB Load and select the previously unloaded file (from the database used up to now -
standard: \DB\UC_DATA.TXT).
l The loading process depends on the size of the database.
l 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.
Chapter9 ServiceManager | 687
9 ServiceManager
9.1 ServiceManager - Service

The ServiceManager serves to start, stop and access components such as the Automation Engine
You can specify the particular components in thedefinition 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:

9.2 ServiceManager - Dialog Program

The ServiceManager's dialog program is a graphical interface that can be used to start and stop
components. Use this utility to monitor your AE system from a central point.
components can be handled manually or by using the command line.

688 | Chapter 9 ServiceManager
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 Input field for the name of the computer on which the ServiceManager is installed. You
Name can also select from existing entries.
Optionally, you can specify the ServiceManager's port number (for example,
PC01:8871).
Fully qualified domain names are not supported.

Phrase Entry field for the ServiceManager environment.
When the computer name has been selected, a familiar ServiceManager environment
displays. Users can switch between ServiceManager environments (use dropdown
list) if several of them are available.
Service Name of the service.
You can select any name of your choice and change it at any time.
Status The current status of the service.
"running" = Program has been started and is running.

"stopped" = Program has stopped.
Start Time Start time of the service.
During the start-up phase, the remaining waiting time is displayed in seconds.
Runtime The current runtime of the active service.
ProcID The process number of the active service.
CPU Time The currently used CPU time of the active service.
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
690 | Chapter 9 ServiceManager
Command File name of the program including the complete path specifications.
You can also specify the name and path of a different INI file if if the default INI file
should not be used for the start. Separate this definition from the path and file name
using a blank.
Example of a Windows agent's command field:
C:\AUTOMIC\Agents\win\bin\UCXJWI3.exe C:\AUTOMIC\ini\win\UCXJWI3.ini
Note that Java agents require the parameter -I in front of the INI-file path.
There is an additional display option for server processes. Enter the parameter -
svc%port% and the server process name plus the number of connections displays in
addition to the service name.
Java agents (SAP, JMX, Databases and Rapid Automation) must be started via
the JAR file. Peculiarities and notes are described below in "Adding Java agents."
Text field This area can be used to define several start methods for server processes. Select
below them by right-clicking the server process. The following parameters can be used to
Command define a start method that executes a cold start; the INI file 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 Program's working directory.
Log On As User ID under which the program should be processed.
UNIX ignores this setting and the program always starts using the
ServiceManager's user ID.
User name User under whose name the program should run.
Password Password for this user.
The entry is not shown and the password is saved in encrypted form.
Domain Domain to which the user belongs.
Required if the user is not a local user.

Start Check box for the automatic start of the service along with the system.
automatically
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.
Seconds Waiting time in seconds during which startup is delayed.
delayed
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:
Starting and Ending Server Processes
692 | Chapter 10 Start Parameters
10 Start Parameters
10.1 Start Parameters - Automation Engine and

UserInterface
Program Start Parameter Description
Automation Engine -IPath and File name The name of the INI file.
Communication process
UCSRVCP.EXE
Work process
UCSRVWP.EXE
The start parameters for the UserInterface can be used:
l with the Java loader

l via the UserInterface itself
l in the INI file UCDJ.INI using the parameter cmd=
Program Start Description

Parameter
UserInterface -V Prints the Automation Engine version and hotfix number in the following
UCDJ.JAR format:
"AE OM-UserInterface AE Version plus hotfix number"

-VPath and This prints the Automation Engine version and hotfix. number to the
file name 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 The path and the name of the configuration file login_dat.xml.
name
You can use this parameter to specify a path for the configuration file
login_dat.xml that is to be used. It contains the general settings for
logging on to the UserInterface.
-LLanguage Language
Allowed values: "D", "E", "F"

"D" = German, "E" = English, "F" = French
-Cmmmm The number of the client for a single logon.
The user who is automatically used for logging on must only belong to one
department.
-Dmmmm The number of the client for a single logon.
The Windows domain is used as department.
Chapter10 Start Parameters | 693
-SAE The name of the AE system for a single logon.

System The logon dialog is shown if this parameter is missing.
-UUser In the file login_dat.xml of the UserInterface automatically stores a
name template profile of each OS user who logs on to the UserInterface. This
template includes the login data of the last UserInterface login and has the
name of the OS user. In this configuration file, you can also manually
create templates and name them as you want.
You can use the parameter -U to indicate the name of such a template.
The login dialog of the started UserInterface will then be pre-completed
with the login data that this template includes.
It is helpful to use environment variables for this parameter in order to

obtain the correct template for the OS user who has currently logged on
automatically:
Unix: -U$USER
Windows: -U%USERNAME%
The default template will be used if you do not specify this parameter or if
the specified template is not available.

Parameter
Java loader -F0 This suppresses the splash screen.
of the
UserInterface
UCDJ.EXE
-IPath and The path and the name of the INI file UCDJ.INI.
file name
- The parameter of the UserInterface (see above).
J
You can also assign parameters to the UserInterface via the Java loader.
Parameter
They will then be added to the cmd command in the INI file. In doing so,
you can determine a default setting in the INI file and control special
options via the Java loader.
Keep in mind that:
l The parameter chain must be written in double quotations.

l Path specifications which contain blanks must additionally be
written in double quotations (such as -J"-I""C:\AUTOMIC\my
DC\uc4config.xml""").
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"
See also:
Start Parameters - Agents

Start Parameters - Utilities
Start Parameters - ServiceManager
10.2 Start Parameters - Agents

This document lists and describes the start parameters of the AE agent.

Parameter
BS2000 agent -IFile Name of the INI file
name INI files are assigned with /FILE...,LINK=INI
Java agents (JMX, SAP (Windows and -IFile Name of the INI file
UNIX), RA, Database) name
PS agent - Increases the memory of the Java Virtual
Xmx256m Machine
UNIX agent File name Name of the INI file
The name of the INI file is specified without -I
VMS agent /INI=File Name of the INI file
name
/VER Prints the Automation Engine version and hotfix
number in the following format:
"Agent file name version Automation Engine

version plus hotfix number"
Windows agent -IFile Name of the INI file
name
All agents which run on UNIX -v Prints the Automation Engine version and hotfix

All agents which run on Windows -V Prints the Automation Engine version and hotfix

See also:
Start Parameters - Automation Engine and UserInterface

Start Parameters - Utilities
Start Parameters - ServiceManager
10.3 Start Parameters - Utilities

This document lists and describes the start parameters of the AE Utilities.
A security check is made whenever the utilities AE DB Client Copy, AE DB Archive or AE DB Reorg
are called in batch mode (single logon). A utility is canceled if the AE system does not contain a User
object for the user who logged on to the OS. Note that this happens regardless of any entries that have
been made in the variable UC_USER_LOGON.
Single Logon provides increased security in batch mode. If a program starts with a graphical
UserInterface, Single Logon increases the ease of use.
Utilities are usually called in batch mode via the corresponding *.EXE files. Files that end on *G.EXE
start the utilities in normal mode. Start parameters can also be assigned to *G.EXE files in order to call
a particular INI file. The utility starts in normal mode. Note that the parameter -B must not be used in
such a case.
Start Parameters
Start parameters can also be assigned to the utility via the Java loader:

Parameter
Java -F0 Suppresses the splash screen.
loader of
the utility
-IPath and The path and name of the INI file for the Java loader.
file name
- The parameter of the utility.

J
You can also assign parameters to the utility via the Java loader (see below).
Parameter
These are added to the cmd section in the INI file. In doing so, you can specify
a default setting for the INI file and control special options via the Java loader.
Note that:
l The parameter chain must be written in double quotations.

l Path indications that include blanks must also be written in double
quotations (for example: -J"-I""C:\AUTOMIC\my
utilities\UCYBDBAR.ini""").
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]
UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Xreport -NObject [-
T1yyyymmddhhmmss] [-T2yyyymmddhhmmss] [-PPath and file prefix]

Utility for -V Prints the Automation Engine version and hotfix number in
database the following format:
archiving
"UCYBDBar version Automation Engine version plus hotfix
UCYBDBAR.JAR
number"
-VPath and file name 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 The path and the name of the INI file.
-LLanguage Language

"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 The number of the client that should be archived.
This client must include a User object for the user who
starts this utility in batch mode.
For example: There must be the User object

"SMITH/department name for the OS user Smith. Note that
no other User object must start with "SMITH" (for example,
SMITH/UC4 and SMITH/TEST is not possible).
-Dmmmm The number of the client that should be archived (only
Windows).
This client must include a User object for the user who
For example: There must be the User object "SMITH/UC4"

for the OS user SMITH of the domain UC4.
Report mode
-Smmmm A client must always be specified in report mode (except
-Dmmmm for -Xreport). The same rules apply for the two parameters
as in archiving mode.
Depending on the report mode that is used, the client

specification can have a different meaning:
"-Xlist" - Client whose reports should be listed.
"-Xunload" and "-Xmark" - The client is used for checking

login data. A User object must be available, as otherwise
the utility cancels the process.
-XMode The type of report handling.
For Output Management systems:
"list" - Reports are listed.

"unload" - Report is unloaded.
"mark" - Report is marked archived and removed from the
database table "XRO".
For the combination of log and trace files:
"report" - Files are generated from the log entries of server

processes.
Parameters for -
Xlist
-OPath and file name The path and the name of the CSV file.
The name "uc_XROlist.csv" is used if you do not specify a

file name. If you do not specify a path, the file is stored in
the folder in which the utility is stored.
-YNumber The filter for the report selection.
Parameters for -
Xunload
-OPath and file name The path and the name of the text file.
A file with the additional prefix "_Report type" is created in

the specified folder for each report of the task.
The name "uc_XROreport.txt_Report type" is used if you

do not specify a file name. By default, the files are stored in
the folder in which the utility is stored.
-YNumber This sets a number for later filtering.
-RRunID The RunID of the task.
-TTimeZone The name of a TimeZone object.
By default, Universal Time (UTC) is used in unloaded

reports. The parameter can be used to convert the time
specifications to other time zones.
UTC is used if this TimeZone object does not exist in the

specified client.
-TYReport type The type of the report (such as ACT).
All reports of the task are exported to a separate file if you

do not specify a report type.
Parameters for -
Xmark
-RRunID The RunID of the task.
-TYReport type The type of the report (such as ACT).
All report types are archived if this parameter has not

been specified. A separate file is created for each report
type (names end with _report type, for example, _ACT).
Parameters for -
Xreport
-NObject The name of an object or filter using "*" for several objects.
Several specifications that should be separated with

commas.
- The start date and the time for the Server reports that
T1 should be selected.
yyyymmddhhmmss
Standard value: current date and time 00:00:00
- The end date and the time for the Server reports that should
T2 be selected.
yyyymmddhhmmss
Standard value: Current date and time
-PPath and file prefix The path and the file prefix for the target file.
By default, the target files obtain the prefix "unload". They

are stored in the utility folder.
The file name is composed as follows:

Prefix.object name_date_time.txt
Examples:
Client 1 is archived.
UCYBDBar -B -S0001
The utility creates a report list and writes it to the file report01.csv.
UCYBDBar -B -Xlist -S1000 -OC:\AUTOMIC\REPORT\report01.csv
Report number 1791029 is unloaded to a text file and obtains status 123.
UCYBDBar -B -Xunload -S1000 -R1791029 -Y123
AE DB Archive marks the report as archived using the number 1791029 and
removes it from the database table.
UCYBDBar -B -Xmark -S1000 -R1791029
All Server reports of March 15th, 2007 should be unloaded.

UCYBDBar -B -Xreport -N"UC4#CP*,UC4#WP*" -T120070315000000
-T220070315235959 -P"C:\AUTOMIC\report\server"
The utility should only unload reports of the work processes "WP001" and
"WP002".
UCYBDBar -B -Xreport -N"UC4#WP001,UC4#WP002" -
T120070315000000 -T220070315235959
AE DB Change
Syntax
UCYBCHNG [-V[Path and file name]] -B -1Script File -2Transport File [-3Output File] [-LLanguage]

Utility for the -V Prints the Automation Engine version and the
modification of hotfix number in the following format:
exported data
"UCYBChng version Automation Engine
UCYBCHNG.EXE
-VPath and file name Prints the Automation Engine version and the
hotfix number to the specified file in the
following format:
"UCYBChng version Automation Engine

-B Batch mode.
-1Script File This file contains modification instructions
(REPLACE).
-2Transport File Contains the original export data (UC_
DATA.TXT by default).
-3Output File Modified data is written to this file.
-LLanguage Language

"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
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

Parameter
Utility for copying -V Prints the Automation Engine version and the hotfix number in the
and deleting following format:
clients
"UCYBDBcc version Automation Engine version plus hotfix number"
UCYBDBCC.JAR
-VPath and Prints the Automation Engine version and hotfix number to the
file name specified file in the following format:
"UCYBDBcc version Automation Engine version plus hotfix number"

-LLanguage Language

The language that is specified in the INI file is used if you do not
specify this parameter.
-B Start in batch mode, single logon is used.
-V Outputs the Automation Engine version and hotfix number.
Copy mode
-C Copies the client; the OS user must exist as an AE user in both
databases in system client 0000. Otherwise, the process aborts with
an error message.
-Smmmm The number of the source client.
The system client 0000 must include a User object for the user who
For example: There must be the User object "SMITH/department

name for the OS user Smith. Note that no other User object must
start with "SMITH" (for example, SMITH/AE and SMITH/TEST is
not possible).
-Dmmmm The number of the source client (only Windows).
Note that the parameters -D and -S must not be used together.
The system client 0000 must include a User object for the user who
For example: There must be the User object "SMITH/AE" for the OS
user SMITH of the domain AE.
-Tmmmm The number of the target client.
The same requirements apply to the user as described for the

parameter -S.
-O Copies objects.
-M Copies messages.
-A Copies statistics and reports.
-R Resets password.
-V Copies version objects.
-W Deletes the work files after a successful copying process.
Deletion
mode
-E Deletes a client; the OS user must exist as an AE user in both
databases in the system client 0000. Otherwise, the process aborts
with an error message.
-Smmmm You can define different databases for the source and the target in
-Dmmmm the INI file. When you use the parameters -S or -D, the client in the
-Tmmmm 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
Syntax
Loading the Transport Case / Initial Data:
UCYBDBLD [-V[Path and file name]] [-IFile name] [-FFolder handling] [-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

Utility for loading -V Prints the Automation Engine version and the hotfix number in
the database the following format:
UCYBDBLD.JAR
"UCYBDBld version Automation Engine version plus hotfix
number"
-VPath and file Prints the Automation Engine version and hotfix number to
name the specified file in the following format:
"UCYBDBld version Automation Engine version plus hotfix

number"
-FFolder handling Defines the behavior of DB Load regarding folders. When

objects or linked objects are being replaced, the data of the
home folder and the linked objects of the Transport Case are
preserved.
Allowed value = "OT"
When this value is set, the data contained in the data file of
the Transport Case will overwrite already existing objects in
the Automation Engine database.
-LLanguage Language

The language that is specified in the INI file is used if you do

not specify this parameter.
-B Batch mode
-Cmmmm The number of the client for processing.
-C-1, retains clients, -Cmmmm loads the Transport Case to

client mmmm
-EMode Processing mode for objects that exist already.
Only in the batch mode
Allowed values: "IGNORE", "ABEND", "REPLACE"

"IGNORE" = The object is skipped (default).
"ABEND" = Processing is canceled.
"REPLACE" = The existing object is replaced.
Note that the setting "IGNORE" requires that the original

object and the object to be loaded are of the same type, as
otherwise processing will abort before the loading process
has started.
- The name and the department of a default user.
U
If the user does not have access rights on object level, the
Name/Department
default user can be used instead.
-GName The name of the default user group.
If the user does not have access rights on object level, the
default group can be used instead.
-AAccess Loads access authorizations on object level.
Allowed values: "Y", "N"

"Y" = Loads access authorizations on object level (default).
"N" = No loading of access authorizations on object level.
-MAccess Ignores access authorizations that refer to missing users and
user groups.
Allowed values: "Y", "N"

"Y" = Ignores access authorizations for missing users and
user groups. They are not loaded.
"N" = Cancels the loading process for access authorization of
missing users and user groups (default value).
-XFile name The name of the file that should be loaded. Note that this start
parameter is obligatory.
-TAuthentication Authentication details.
method
Only call the utility with these start parameters if the new
-KCompany key
installation is made without using the UserInterface.
string
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.
The string must be specified in inverted commas, if it

contains special characters. If you intend to use an
inverted comma within the string, set an additional
inverted comma before it (under Windows) or a "\" (under
Unix).
Examples:
The file UC_DATA.TXT is loaded to client 11 and the existing objects are replaced.
UCYBDBld -B -C0011 -XC:\AUTOMIC\UTILITY\temp\UC_DATA.TXT -
EREPLACE
Authentication method "Server and Agent" should be specified in the AE system.

UCYBDBld -B -TLOCAL_REMOTE -KUC4PROD
AE DB Reorg
Syntax
UCYBDBRE [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm

Parameter
Utility for -V Prints the Automation Engine version and hotfix number in the
database following format:
reorganization
"UCYBDBre version Automation Engine version plus hotfix number"
UCYBDBRE.JAR
-VPath Prints the Automation Engine version and hotfix number to the
and file specified file in the following format:
name
"UCYBDBre version Automation Engine version plus hotfix number"
-IFile The path and the name of the INI file.
name
- Language
L
Language
The language that is specified in the INI file is used if you do not
specify this parameter.
-B Batch mode.
-Smmmm The number of the client that should be reorganized.
This client must include a User object for the user who starts this
utility in batch mode.
For example: There must be the User object "SMITH/department

name for the OS user Smith. Note that no other User object must start
with "SMITH" (for example, SMITH/AE and SMITH/TEST is not
possible).
-Dmmmm The number of the client that should be reorganized (only Windows).
This client must include a User object for the user who starts this
utility in batch mode.
For example: There must be the User object "SMITH/AE" for the OS
user SMITH of the domain AE.
Examples:
Client 98 is reorganized.
UCYBDBre -B -S0098
AE DB Reporting Tool
Syntax
UCYBDBRT [-IFile name] [-LLanguage] [-Cmmmm]-XPath and filename [-Ryyyymmdd[hhmm]] [-S] [-
OPath and filename] [-TFile type]

Utility for defining -Cmmmm The client number for processing.
queries
Overwrites the client specified in the query
UCYBDBRT.EXE
definition.
-XPath and file name The path and the name of the XML file.
-IPath and file name The path and the name of the INI file.
-LLanguage Language

"D" = German, "E" = English, "F" = French
-Ryyyymmdd[hhmm] The reference date for the analysis of statistics
and forecasts.
Overwrites the query definition.
Note that the entries of the AE database are

stored in UTC. Therefore, Automic
recommends using this time zone also for
specifying the reference time.
-S This returns the number of output lines.
-OPath and file name The path and the name of the output file.
-TFile type The type of the output file.
Allowed values: "CSV" and "HTML"

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
AE. Revision Report

Syntax
UCYBDBRR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Cmmmm [-OPath and filename] [-
FType1,Type2,...] [-D1yyyymmddhhmmss] [-D2yyyymmddhhmmss] [-A] [-X]

Utility for creating -V Prints the Automation Engine version and hotfix number in
a revision report the following format:
UCYBDBRR.EXE
"UCYBDBRR version Automation Engine version plus
hotfix number"
-VPath and file Prints the Automation Engine version and hotfix number to
name the specified file in the following format:
"UCYBDBRR version Automation Engine version plus

hotfix number"
-IPath and file name The path and the name of the INI file.
-LLanguage Language

The language that is specified in the INI file is used if you do

not specify this parameter.
-B Batch mode.
-Cmmmm The client number for processing.
-OPath and file The path and the name of the revision report.
name
By default, the report is stored as UCYBDBRRoutput.txt in
the utility folder.
-FType1,Type2,... This handles the required contents of the auditing report.
Indicate your preferred content types separated by commas.
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.
- The end date and the time for logging.

D2
Default value: current date and time
yyyymmddhhmmss
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.
All modification data is written to the report if the two time parameters are not
used. The filters -F and -X are taken into account.
-A Archive flags are set when you use this parameter It is
closely connected to the parameter -X.
Note that the start of tasks (see start parameter -

FSTART) is retrieved from the statistical records.
Therefore, the utility cannot set archive flags for these
data records.
-X You can use this parameter to have only modification entries
that have never been output by the utility before (for
example, because they have no archive flag) written to the
report.
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
Syntax
UCYBDBUN [-V[Path and file name]] [-IFile name] [-LLanguage] -BMode [-D][-Cmmmm] [-XFile name] [-
K]

Utility for -V Prints the Automation Engine version and
unloading the hotfix number in the following format:
database
"UCYBDBun version Automation Engine
UCYBDBUN.JAR
-VPath and file name Prints the Automation Engine version and
hotfix number to the specified file in the
following format:
"UCYBDBun version Automation Engine

-LLanguage Language

"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 Batch mode and processing mode.
AE system-wide:
"NORMAL" = All data from all database tables
is unloaded.
"INITIAL" = Data is taken from client 0.
However, not all of client 0 is unloaded, only
the initial data, eg. XREQs.
"DEFAULT" = Default data of the system is
unloaded, eg. client 0, initial User and User
group.
"REPAIR" = The Explorer's folder structure is
checked and repaired.
AE system-wide and client-wide:

"REORG" = The database is reorganized.
"TRANSPORT" = The Transport Case is
unloaded.
"TRANSPORTALL" = All objects are
transported. To remove objects from the
Transport Case after the unloading process,
use the -D option.
"RESETARCHIVE" = Archive flags are reset
(AE DB Archive).
"RESETREORG" = Deletion flags are reset
(AE DB Reorg).
-D This start parameter removes all objects from
the Transport Case after the unloading
process.
-Cmmmm The number of the client in order to unload the

Transport Case.
All clients are unloaded if no client has been

specified.
Specify value "1" in the INI file parameter

suppress_output= and the parameter -C
can also be used to reorganize individual
clients.
You cannot unload client 0. When you

specify the parameter -C0 despite of this
fact, all clients will be unloaded except for
client 0.
-XFile name The name of the file that should receive the
data that should be unloaded.
The utility uses the name and path of the

file specified in the INI file (output=) if this
parameter is not specified.
Note that this parameter cannot be used

with the mode -BREORG because these
specific files are subject to a given naming
convention.
-K Setting this parameter has the effect that
deleted objects are still available in the
UserInterface's Recycle Bin after the unloading
process.
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
Syntax
UCYBLGMX [-V[Path and filename]] -B-LPaths and names of log and trace file -FPath and name of the
target file

Utility for combining log -V Outputs the Automation Engine version including
and trace files the hotfix number in the following format:
UCYBLGMX
"UCYBLGMX version Automation Engine version
plus hotfix number"
-VPath and file name Prints the Automation Engine version and hotfix
number to the specified file in the following
format:
"UCYBLGMX version Automation Engine version

plus hotfix number"
-B Batch mode
-LPaths and names of The log files and the trace files that should be
log and trace file integrated in a target file.
The files can be specified in two ways:
"Path file1, file2, file3"
The path that is used for the first file is also used
for the subsequent files.
"Path and file1, path and file2, path and file3"
You can also indicate the path for each individual

file.
The wildcard character "*" can be used in file

names.
The folder from which the utility is called (working

directory) is used if no path has been specified.
-FPath and name of the The path and the name of the target file.
target file
The path can be omitted if the target file has been
stored in the same folder as the utility.
Existing files of the same name are

overwritten.
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 Start Parameters - Automation Engine and UserInterface

l Start Parameters - Agents
l Start Parameters - ServiceManager
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
Command Line Program

With the command line program UCYBSMCL, the ServiceManager can be managed through batch
processing. Services can be started and ended with this program. A list of all services of a computer
belonging to a ServiceManager environment can also be called up. The command line program is available
for Windows and for UNIX.
Please mind the correct spelling as upper and lower case are distinguished.
Syntax
Windows:
UCYBSMCL[.EXE] -c GET_PROCESS_LIST -h computer name -n phrase

UCYBSMCL[.EXE] -c START_PROCESS -h computer name -n phrase -s name of the service [-
p password]
UCYBSMCL[.EXE] -c STOP_PROCESS -h computer name -n phrase -s name of the service [-m stop
mode] [-p password]
Unix:
ucybsmcl -c GET_PROCESS_LIST -h computer name:port number -n phrase

ucybsmcl -c START_PROCESS -h computer name:port number -n phrase -s name of the service [-
p password]
ucybsmcl -c STOP_PROCESS -h computer name:port number -n phrase -s name of the service [-m
password] [-p password]
Parameter Descriptions
Start Assignment Description
Parameter
-c Command that is to be processed.
This parameter must always be specified.
GET_PROCESS_ Requests a list of all services belonging to a ServiceManager
LIST environment on a computer together with the available information.
START_ Starts a service
PROCESS
STOP_PROCESS Stops a service

-h Computer
Computer name Name of the computer on which the ServiceManager is to be
handled.
A remote computer can also be used. This computer must be

available from the computer which is calling it. The user must be
authorized to access services on this remote computer.
Port number In UNIX, the port number of the ServiceManager must additionally
be indicated.
-n ServiceManager environment.
Phrase Name of the ServiceManager environment which
summarizes/outlines the various AE services on a computer. In
the dialog program of the ServiceManager, this is designated as a
phrase.
-s Service.
This parameter must always be specified, with the sole exception
of GET_PROCESS_LIST.
Name of the Specification of the name of a service
service
Available in the following places:
l it is shown in the "Service" column of the dialog program

l it is listed in the definition file Phrase.SMD
l in the output of the command GET_PROCESS_LIST
Since a service name can also contain spaces, it should always be

entered within quotation marks.
-m End mode.
This parameter is optional for STOP_PROCESS.
Stop mode Way in which a service should be ended
Allowed values: "C" (default value), "S", "A"

"C" = Close. The service ends normally.
"S" = Shutdown. The service stops immediately independent of
ongoing tasks.
"A" = Abnormally. The service is immediately stopped by the
ServiceManager through a system call (kill). Use this command
only when attempts by the service to stop itself were not
successful.
-p Password.
This parameter is optional for START_PROCESS and STOP_
PROCESS. For information on encrypting passwords, see
Encoding Passwords.
Password Password for service start and stop authorization.
-sm The start mode of server work processes (WPs)
The values that are allowed for the parameter -sm depend on the
service definition in the ServiceManager's SMD configuration file.
To ensure that a specific start mode can be assigned to the WP
when it starts, you must set START1=, START2=, START3= ... in
the SMD file for each DEFINE of a WP service. The supplied SMD
file UC4.SMD includes some sample definitions.
Start mode For example, the definition of a WP service in an SMD file
(including variables):
VAR SRV_STARTPATH;*OWN\..\..\Server\bin
VAR WP_STARTCMD;*SRV_STARTPATH\UCsrvwp.exe
*SRV_STARTPATH\ucsrv.ini -svc%port%
VAR WP_STARTCMD_COLD;*WP_STARTCMD -
parm"StartMode=Cold"
VAR WP_STARTCMD_STOP;*WP_STARTCMD -
parm"SystemStop=Yes"
VAR WP_STARTCMD_COLDSTOP;*WP_STARTCMD -
parm"StartMode=Cold;SystemStop=Yes"
DEFINE UC4 WP2;*WP_STARTCMD;*SRV_

STARTPATH;START1=(Coldstart,*WP_STARTCMD_
COLD);START2=(Systemstop,*WP_STARTCMD_
STOP);START3=(Coldstart with Systemstop,*WP_
STARTCMD_COLDSTOP)
For this WP service, the following values can be used for the
parameter -sm
"Coldstart" = Cold start mode

"Systemstop" = Normal start. The system is stopped for this
purpose.
"Coldstart with Systemstop" = Cold start including a system stop.
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 The name of the service.
Status Service status.
"R" = Running. Service is active.
"S" = Stopped. Service ended.
ProcID Process number of a service

Only information pertaining to active services (Status = R) will be displayed.
Starttime The start date and time of a service.
Format: "YYYY-MM-DD HH:MM"
Runtime The runtime of a service.
Format: "DD/HH:MM"
CPU Time The CPU time that a service requires.
Format: "DD/HH:MM:SS:HS"
HS represents hundredths of seconds
Only information of active services (Status = R) will be displayed.
Return Codes
Return code Description
0 A command has been processed without an error.
1 An incorrect command has been entered.
2 No active ServiceManager has been located on the specified computer.
Possible reason:
Either the name of the computer was not entered, or no ServiceManager is
active on this computer.
3 The ServiceManager reacts to a command in an unexpected way.
Possible reason:
The ServiceManager version is not up to date.
4 Errors occurred with the ServiceManager connection.
5 The specified ServiceManager environment is not present on the
corresponding computer.
Possible reason:
The ServiceManager for the specified ServiceManager environment is either
not installed or not started.
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-05 21:39" "0/01:11" "0/00:00:22.69"
"UC4 WP1" "R" "3388" "2004-04-05 21:39" "0/01:11" "0/00:00:22.69"
"UC4 WP2" "R" "1576" "2004-04-05 21:39" "0/01:11" "0/00:00:22.69"
"Win32-Agent WIN01" "R" "2708" "2004-04-05 21:40" "0/01:11" "0/00:00:01.31"
"Win32-Agent WIN21" "R" "2392" "2004-04-05 21:40" "0/01:10" "0/00:00:01.30"
"Win32-Agent UC4MAIL" "R" "2932" "2004-04-
05 21:40" "0/01:10" "0/00:00:01.31"
"SAP Agent C46" "S"
"PeopleSoft-Agent PS01" "S"
The second example terminates a UNIX agent normally.

./ucybsmcl -c STOP_PROCESS -h unixw2k01:8871 -n uc4p -s unix01 -m Close
See also:
l ServiceManager - Service
l ServiceManager - Dialog program
l Starting and ending Server processes
l Start Parameters - AE Server and UserInterface
l Start Parameters - Agents
l Start Parameters - Utilities
l Encoding Passwords
Chapter11 System Monitoring | 717
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.
Right-click the client 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_ This script element is used to change the system status (parameter STOP)
STATUS 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 Workflow - changes its status to "Active"

l Group/Queue - changes its status to "Active"
l Schedule - changes its status to "Active". Missed start times are not made up, instead they switch
to "Timeout",
l Event - changes its status to "Sleeping". The times are recalculated. Missed events are not made
up.
l Recurring tasks - change their status to "Sleeping".
Handling Description
UserInterface menu To start the system for a local client, select the Client Go command in the
System menu.
Right-click the 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.
718 | Chapter 11 System Monitoring
TOGGLE_SYSTEM_ This script element is used to change the system status (parameter GO) from
STATUS within a script.
The current status is stored in the variable UC_CLIENT_SETTINGS in the global value CLIENT_
STATUS.
11.2 Handling Agents

The Automation Engine offers various ways of starting, stopping and monitoring agents.
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.
Script Element
l The script element :TERMINATE is the third way of stopping an agent.
See also:
Agent
11.3 EMI - External Monitoring Interface
11.3.1 EMI- External Monitoring Interface

The External Monitoring Interface may replace the older SNMP-based monitoring technology. The EMI is
based on the JMX technology, providing MBeans for all concerned components of the AE system.
General
The External Monitoring Interface (EMI) is a tool which is used for monitoring the technical status of the
AE. The EMI is based on the JMX protocol. JMX is a Java technology that supplies tools for managing and
monitoring applications, system objects, devices and service-oriented networks.
The main idea for this JMX based solution is its possible use as a standalone application (monitoring can
be done with each JMX based client, for example with Java Mission Control - the free JMX console) or
integration into existing monitoring environments, that support JMX (for example HP-OpenView or IBM
Tivoli).
Automic strongly recommends using this JMX-based monitoring solution instead of the older SNMP-
based monitoring. JMX represents state-of-the-art technology, enabling easy integration with existent
monitoring solutions. In addition, JMX has the following advantages upon SNMP:
l JMX is based on a secured network protocol (TCP, instead of UDP)

l JMX can make use of modern security mechanisms (e.g. SSL, Proxy)
l The JMX solution allows interaction with the AE system, thus enabling actions like starting
components, etc.
What is JMX
JMX: The Java Management Extension, a set of specifications for application and network management in
the Java development and application environment.
MBean: JMX facilitates the centralized management of managed objects (called MBeans), which acts as
Java wrappers for applications, services, components and devices in a distributed network.
MBean Server: The spine of the JMX architectural frame, allowing server components to plug in and
discover all manageable objects.
Details
The EMI solution gathers information from the AE system and makes it available to JMX clients via Java
Beans. As the MBeans only represent information from the AE system, these contents (the MBeans) are
write protected. The original state and information can only be modified within the AE system.
The EMI utilizes two types of monitoring - active and proactive:
l The active type is used for notifications.

Notification is a JMX-functionality, which enables MBeans to generate notifications, e.g. for signal
state changes or detecting problems.
l In the so-called proactive type the status of MBeans may proactively be queried, .
On start, the EMI solution connects to an AE system and logs on to a defined client with a defined user.
Once connected, EMI exports certain information from the AE system for monitoring purposes.
Monitoring
A monitoring solution based on EMI allows to monitor selected components of the AE's System Overview
(for example Usage, Clients, Automation Engine, Queues, Users, etc.) as well as activities and messages
(errors and warnings).
Components (MBeans) are grouped with so-called side names, e.g., all Agents are grouped in the side
"Agents", all users are grouped in the side "Users".
Controlling MBeans
For each side name an additional so-called controlling MBean exists having the same name as the side.
These controlling MBeans are not associated to a side name. They provide general information for the
groups, such as the name of the side they are associated with, the number of elements provided in a side
or the polling interval used for the side. E.g., the controlling MBean "Agents" (which has no side name
itself) provides additional information for all elements grouped by the side name "Agents".
Additional controlling MBeans are dedicated to the status of the EMI itself and the MessageBox (send
notifications only), where MessageBox represents the Message Window in the UserInterface of the AE.
This image shows the MBean content displayed in Java Mission Control:
On the left you see the tree of all available MBeans, on the right the attributes, type and description of the selected
MBean are shown.
Controlling MBean MessageBox
Messages shown in the message window can be subscribed to with the controlling MBean
"MessageBox". In the Java Mission Control Center this can be done by checking the 'Subscribe' check
box in the "Notification" tab. Notifications are listed below.
The MessageBox represents the Message Window of the AE system, where system's messages are displayed.
Each Notification is a single message sent from the AE. It is a record containing the time stamp, severity
type, the message sequence number, and the message text itself.
The record also contains in the field User Data the raw data of the message: the message sequence
number and its so-called insertion texts, whereas the message number identifies the message text in the
MSL file and the insertion texts are used for the placeholders in the message text.
The :SEND_MSG command generates messages in the AE, which are broadcast to the MessageBox
MBean as Notification. Thus, these messages can be monitored via the EMI as well.
Monitoring Activities
Monitoring of activities optionally can be enabled in the configuration file with the parameter tasks=. If this
parameter is set to zero, activities are not monitored. If this parameter is greater than zero, it specifies an
interval where tasks are monitored . Only tasks matching the tasks filter criteria are considered. The task
filter criteria are provided in the TASKS section in the configuration file. For example, if tasks=20, every 20
seconds the MBeans for each activities matching the filter criteria provided in the TASKS section of the
configuration file are updated.
Connection Failover Behavior
When the connection to the AE system is lost, the EMI solution automatically tries to reconnect to the AE
system selecting one of the available communication processes.
l When connections to the AE system are established or lost, the EMI MBean is notified and
updated.
l Additionally, when the connection to the AE system is lost, all MBeans (except EMI and
MessageBox) are removed from the server.
l After a connection has been re-established, the MBeans will be rebuilt automatically.
Requirements
l Java SE version 1.7 or later.
Supplied Files
The EMI solution is delivered with the files you need for installation and configuration.
You will find these files in the directory: IMAGE:MONITORING
MBeans provided
AgentBean - represents the Agent object on the system
CacheBean - represents the statistics information for a single system cache instance
ClientBean - represents the monitored client ( With one instance of the EMI one AE client can be
monitored at a time)
CollectionBean - describes several MBeans registered as one group on the MBeanServer. For example,
Users represents a collection of UserBeans.
EMIBean - describes the status of the EMI solution, provides information about the connection and the
connection status and displays this information in its Notification tab.
DatabaseBean - represents the DB information used in an AE system. The Mbean instance will have the
same name as the DB on the DB system.
LicenceBean - represents the instance of a single license in the System Overview

MQEntryBean - represents a single message queue table used by the AE for message flow. The
attributes of this Mbean can be used for the basic KPI of the AE.
QueueBean - represents the Queue object
ServerBean - represents an AE Server instance, equivalent to the Automation Engine entry in the System
Overview
WorkloadBean - describes one row in the System Workload Table
UserBean - represents an instance of one user present in the AE system
Installation
1. Installation of files
l Install Java SE on the host system.

l Unpack the delivered files to a directory of your choice.
l Adjust the relevant parameters in the INI file.
2. Starting the EMI Solution
l In order to start the EMI solution, use the following command. In case you stored the INI file in a
different location, you can define a path here:
l java -jar emi.jar [path/to/ini/file/emi.ini]
Testing
1. Install the Java JDK
2. Start Java Mission Control using jmc.exe, which you find in JDK_HOME\bin\
3. Find the EMI solution, …\emi.jar and its process MBean Server.
4. In the context menu click Start JMX Console.
5. Select the tab MBean Browser, so that you are able to see all the Beans and attributes.
6. In the group Automic you will find the AE system monitored and its Beans which are exported by
EMI
7. Now you can browse and monitor the Beans (data), where each of them will be updated with the
next polling interval configured in the INI file.
You can also click on MessageBox and Subscribe for notifications. After that you will receive the
System messages automatically, without polling.
See also:
External Monitoring Interface Configuration

11.3.2 External Monitoring Interface Configuration
Structure of the File emi.ini
[GLOBAL]
client= Client number which is monitored.
user= User name of the monitoring user, i.e., the user whose context the
monitoring will run under.
password= User's password.
Can also be provided encrypted. To encrypt passwords use

ucybcryp.exe.
language= Language, which will be used for message translations.
Value: D, E or F
In version 11.2 the messages are available in English only, regardless of

the values defined here. Other languages will be available in future
versions.
Allowed formats:
reconnect= Reconnect interval.
When a connection to the AE cannot be established, the EMI will retry in
periodic intervals defined by this parameter.
Unit: seconds
Format: integer
The number characters serve as placeholders for a series in numerical

order.
When starting the EMI, the log files are renamed so that the most current
log file is always the one with the number "00".
[COLLECTIONS] This section contains poll intervals for specific monitoring areas. The
intervals are defined in seconds.
Format: integer
Example: 5 means, the status of all agents in EMI is refreshed every 5

seconds.
agents= Polling interval for the Agents section in SystemOverview.
Default: 15
cache= Polling interval for Cache section in the System Overview.
Default: 10
client= Polling interval for Clients section in System Overview.
Default: 60
database= Polling interval for Database section in System Overview and MQs.
Default: 10
licenses= Polling interval for Licenses section in System Overview.
Default: 60
queues= Polling interval for Queues section in System Overview.
Default: 5
servers= Polling interval for Automation Engine servers section in System Overview.
Default: 5
tasks= Polling interval for activities. If set to 0, activities are not monitored. If
greater 0, the TASKS section is used to filter activities.
Default: 0
usage= Polling interval for system Usage section in System Overview.
Default: 1500
users= Polling interval for Users section in System Overview.
60
[TASKS] Filter criteria for activities to be monitored.
Polling of activities can be turned on or off with the parameter tasks= in

the section [COLLECTIONS]
state= Comma separated list of ranges of states in the format [from-to[,from-to
[...]]].
Default: 1560-1564,1800-1899
object= Sets the filter for the object name. With the default entry "*", all objects are
listed. Use the wild card characters "*" and "?" to set a filter. "*" stands for
any number of characters, "?" for exactly one character.
Default: *
type= Comma separated list of object types. The "*" is not allowed. E.g.,
JOBS,JOBP,SCRI
Default: JOBP
user= Sets the filter for the user name. The wildcard character "*" matches all
users
Default: *
queue= Sets a filter for a Queue. Has no effect in client zero.
Default: All Queues

[TRACE] In version 11.2 the following four parameters are not yet considered, as
the EMI creates a log file only.
Traces will be available in future versions.
Default: ./temp/trace_##.log
Default: 10
tcp/ip= Trace flags of the EMI
emi= Trace options for EMI processing
Default: "0"
[JMX] This section contains basic settings relevant for the MBeanServer.
usePlatformBeanServer= Indicates, whether the MBeanServer is visible for local connections.
Allowed values: "1" or "0" (or "Y" or "N")
Default: "1"
jxmPort= TCP-port for RMI connection
You may reach the MBeanServer on this default address:
service:jmx:rmi:///jndi/rmi://hostname:jmxPort/Automic
Default port value (jmxPort): 9091
[CP_LIST] This section is maintained automatically by the EMI. The list of known
CPs is stored here.
Comments
The user needs these privileges in the respective User object to be able to access the monitoring
functions of the EMI:
l Always required: "Access system overview"

l For monitoring the MessageBox alias for receiving the Notifications it is necessary to grant one or
more or all of the following privileges:
l "View messages from own User Group"
l "View messages from Administrators"
l "View all messages from own client"

l "View security messages"
l For monitoring the System Workload (WorkloadBean) the privilege "View usage of all clients" has
to be granted.
See also:
EMI - External Monitoring Interface

728 | Chapter 12 Utilities
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 Archives messages, reports and statistics
AE DB Change Changes objects (transport with Transport Case)
AE DB Client Copy Copies and deletes clients
AE DB Load Loads data
AE DB Reorg Reorganizes messages, reports, statistics and object versions
AE DB Revision Report Creates revision reports
AE DB Unload Unloads data
AE LogMix Integrates log and trace files
AE Reporting Tool Facilitates user-defined AE queries
See also:

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
theArchive 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.
Chapter12 Utilities | 729
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 List of the possible data that can be archived.
Table Data area including database tables.
Last Date of the last archiving process.
archiving
Current Number of data records that can be archived.
number
Archiving Current specification of archiving criteria including the starting date for the
criteria archiving process.
Number Number of data records that are not archived because of the specified criteria.
after
archiving
Reset archive Enables the client's archive flags to be reset.
flags
The utility AE DB Unload can be used to reset the archive flags of several
clients.
Forecast This button creates a forecast using the current data stock.
Archive You can start the archiving process using this button.
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 the INI 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
Element
Archive Check this checkbox in order to signal that client messages should be archived.
messages
Read messages 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 All non-read messages that are older than the specified number of days are archived.
messages Additionally, the date that corresponds to the specified number of days is displayed.
Statistics Tab
Note that reports that correspond to the statistical data are also archived.
Description
Element
Archive Check this checkbox to signal that the client's statistics should be archived.
statistics
Archive All statistical data that is older than the specified number of days is archived.
statistics Additionally, the date that corresponds to the specified number of days is displayed.
older ...
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.
Archive Tab
Description
Element
Archive Selection field for the directory in which the archived data should be stored. Ensure that
directory the specified drive exists at the time of activation and that sufficient memory is
available.
Size of Determines the maximum size of an archived file.
Archive
If required, archived data is stored in several files, thereby using the specified archive
size.
Note that the maximum size of the archive file must not exceed 2048 MB.
Otherwise, the utility will abort with a corresponding error message.
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 Displays the day of the year as a three-figure number (001 -
366).
m Displays the month as a two-figure number (01 - 12).
b Displays the month in abbreviated form (Jan - Dec).
B Displays the month in full form (January - December).
y Displays the year as a two-figure number (00 - 99).
Y Displays the year as a four-figure number (0000 - 9999).
w Displays the day of the week as a number (0 - 6, Sunday is
0).
a Displays the day in abbreviated form (Mon - Sun).
A Displays the day in full form (Monday - Sunday).
W Displays the week of the year as a two-figure number (00 -
53),
starting with Monday as the first day of the week.
U Displays the week of the year as a two-figure number (00 -
53),
starting with Sunday as the first day of the week.
x Displays the date depending on the date format specified in
the system control panel.
H Displays the hour in a 24-hour format (00 - 23).
I Displays the hour in a 12-hour format (01 - 12).
M Displays the minute with a leading zero (00 - 59).
S Displays the seconds with a leading zero (00 - 59).
p Displays the time with the 12-hour time specification a.m.
and p.m.
X Displays the time depending on the time format specified in
the system control panel.
z Displays the TimeZone. If it is not known, nothing is
displayed.
c Displays the date and time depending on the format specified
in the system control panel.
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
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:

Archive Browser
Structure of the Archived Folder
Start Parameters
Structure of the INI file, AE DB Archive
12.2.2 Archived Folder Structure

Archived data is stored in an archive folder which is to be defined in the Archive tab. All a client's archiving
runs are collected in a folder which shows the four-digit client number. A subfolder is created with each
archiving run. It contains all archived data and the corresponding index files. The subfolder name is
composted of the prefix "UC_ARCHIV_", the current date in the format "YYYYMMDD", and a consecutive
number (e.g. 0001\UC_ARCHIV_20030520_3).
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.
Index for AH: UC_AH.IDX
Position Description
1 Block code "H2"
2 Client
3 User
4 Department
5 AType
6 SType
7 RunID
8 Host name
9 Start time/start date
10 Parent ACT
11 Parent PRC
12 Archive Key 1
13 Archive Key 2
14 Object name
15 Byte position in the archive
16 Line position in the archive
17 Archive number
18 Record length in bytes
Example
H2;1;LF;PROG;JPAK;GRP;1302137;;28.08.1998
10:31:42;0;0;;;LF.JP.GROUP;73837;2555;7;148
Index for RH: UC_RH.IDX
1 Block code "H3"
2 Client
3 Report type
4 Object name
5 RunID
6 Time the report was created
7 Time of last report update
8 Byte position in the archive
9 Line position in the archive
10 Archive number
11 Record length in bytes
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
Message Archive: UC_MELD.TXT
1 Block code "M"
2 Client
3 User
4 Department
5 Time that message was generated
6 Source
7 Category
8 Type
9 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!
Comment Archive: UC_ACMT.TXT
1 Block code "M"
2 Client
3 User/Department
4 Object name
5 RunID
6 Time that message was generated
7 Record length in Bytes
8 Message Text
Example
M;100;MH/PROG;TESTJOB;454711222;15.03.99 09:43:54;nnn;This task was
modified by (MH).
See also:

Archive Browser
Archiving
Structure of the INI file, AE DB Archive
12.2.3 Archive Browser

Introduction
The Archive Browser shows information of archived data records. Thus, AE processes can easily be
traced even after the database has been archived and reorganized. Filters serve to limit the displayed data
records according to your requirements.
The file name of the Archive Browser, UCYBARBR.EXE, is stored in the group of utilities.
The Archive Browser's user interface is always displayed in English.
This utility's user interface consists of three areas:
l the entry area

l the table area
l the data record area
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:
Searching for archived data
Searching for Archived Data

The Archive Browser is at your disposal in order to search for and find archived data.
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 Statistics Report Messages Comments

Client Number of the client.
User Name of the user.

This entry is converted to upper-case
letters before the search starts.
Department Name of the department.
Parent (ACT) Run number (RunID) of a superordinate
task (Activator)
Date Date of activation, report or message
creation.
RunID/Add. Run number (RunID) of a task or
Info additional information.
Leading zeros are left out before the
search starts.
Parent Run number (RunID) of a superordinate
(PROC) task (Processor)
Host Name of an agent.
Type Specification of the activation type.
Subtype Specification of the activation type's
subtype.
There is no automatic check for
whether the combination with the
activation type is appropriate.
Archive Key First archive keyword and second
1 archive keyword.
Archive Key
2
Object Name Name of the task that is searched or

or Message string in message text.
Text This entry is converted to upper-case
Report Type 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.
Navigating in the Search Result
The table area contains several columns which provide general data-record information. Clicking on a
column title lists its entries in ascending or descending order. Double-clicking on the end of a column title
aligns the column width to the column's longest field content. The column titles shown in the table area
correspond to the search fields of the upper area. Additionally, the following information is displayed:
l Statistical records: date and time of activation

l Report records: date and time of report creation and size (in bytes)
l Message records: date and time of the message, component that has created the message,
message category and type
l For comment records: none
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
12.2.4 Open Interface to Output Management Systems

With AE, information about the execution of tasks can also be exported to files so that object names,
states and return codes are available. The execution report is additionally available in form of a text file.
Structured data allows for quick and easy report analyses.
You can access information about job executions, reports and file transfers.
Report data can either be edited with the utility AE DB Archive or directly by accessing the database table
"XRO" which supports your self-developed programs.
This special form of report editing is by default not active and must be activated for each client. Do so with
the key XRO_REPORTS in the variable UC_CLIENT_SETTINGS.
An entry containing the object names, time of execution and a reference to the report is written for each job
runs or file transfer that takes place. This data can be edited with the utility AE DB Archive
Note that XRO entries should regularly be removed from the tables in order to reduce the ever growing
amount of data in the database. Details are described in the section "Removing Table Entries".
Listing Reports
Start AE DB Archive in batch mode with the syntax shown below. As a result, a CSV file listing all non-
archived task executions is supplied:
UCYBDBAR -B -Xlist -Sclient/-Dclient [-Opath and file name] [-Ystatus]
If no path is indicated, the file "uc_XROlist.csv" is created in the folder of this utility.
The file content is exactly the same as the content of the database table "XRO". Its structure is
described at the end of this document.
The utility cancels the procedure if a file of the same name already exists.
If the result file should not contain all table entries, the start parameter _Y can be used. Hence, only the
lines with the indicated status (Column "XRO_CusStatus") are selected. Any value (a number) of your
choice can be used and specified when the report is unloaded.
AE DB Archive creates an empty file if there is no report data.
Unloading Reports
Call AE DB Archive in batch mode using the following syntax to export reports to text files:
UCYBDBAR -B -Xunload -Sclient/-Dclient -RRunID of the task [-TYReport type] [-Opath and file name]
[-Ystatus]
Specify a task's RunID and the report type to unload a particular report. Only specifying the RunID and no
report type has the effect that all reports of the particular execution are supplied.
If no path is specified, the file "uc_XROreport.txt" is created in the folder of this utility. This text file
contains the report data content.
The utility cancels the procedure if a file of the same name already exists.
The start parameter -Y can be used to set a report status. Specify any number of your choice and enter it in
the column XRO_CusStatus. This value can then be used to filter the report list.
Unloading a report does not delete the report entries in the table "XRO". This is done in the next step.
Removing Table Entries
There are two ways of reorganizing table entries:
1. Start AE DB Archive with the syntax shown below in order to flag the reports as being archived,
thus removing their entries from the database table "XRO":
UCYBDBAR -B Xmark -Sclient/-Dclient -RRunID of the task [-TYReport type]

2. Use the utility AE DB Reorg. When reports are reorganized, the table XRO is automatically
included in this process.
Structure of the Database Table XRO
The exported CSV file contains the content and structure of the database table "XRO". Both have the
following columns:
Column name Description

XRO_Client Client
XRO_AH_Idnr Run number (RunID) of the task execution
XRO_RType Report type
XRO_System Name of the AE system
XRO_OType Object type (JOBS, JOBF)
XRO_Object Name of the object
XRO_HostDst Name of the agent on the target host
XRO_LoginDst User name under which the object is processed
XRO_HostScr Name of the agent on the source host (only for file transfers)
XRO_LoginSrc User name for the source host (only for file transfers)
XRO_TimeStamp1 Start time of the execution
XRO_TimeStamp4 End time of the execution
XRO_RetCode Return code of the task
XRO_Status Status of the task
XRO_RRetCode Return code of the report transfer
"0" - Report was successfully transferred

"4" - Report is incomplete
"8" - Report transfer failed
XRO_ReportSize Report size in bytes
Note that file transfers always contain "0" in this column.

XRO_UserTime Consumed user time
XRO_KernelTime Consumed Kernel time
XRO_CpuTime Consumed CPU time
XRO_Archive1 First archive key of the object
XRO_Archive2 Second archive key of the object
XRO_CusStatus User-defined number for filter usage
See also:
About Reports
Start Parameters
12.3 AE DB Change
12.3.1 AE DB Change
Most of the objects which have been exported from the database using the Transport Case can then be
modified with the utility AE DB Change. Selected attributes of objects can be changed and strings in their
scripts be replaced. Doing so simplifies the process of adjusting data to a different AE system or client.
The documents about attributes contain the column Accesses. If this column includes "Change Program",
the particular attribute can be changed with the utility using a script file which assigned at program call.
This file contains the statements which serve to adjust the attributes which are included in the transport
file.
Folder names can also be changed with AE DB Change. The relevant attribute is FOLDER_NAME in
this case.
Ensure that the transport file contains all attributes which should be changed. This is done by setting
the parameter shown below to "1" in the utility AE DB Unload's INI file:
[TRANSPORT]
all_entities=1
The effect is that attributes which do not contain values are also exported.
Procedure
1. Move all objects which should be adjusted to the Transport Case

2. Unload the Transport Case using the utility AE.DB Unload
3. Write one or several script files which contain the statements for attribute modifications
4. Call the utility AE DB Change with the corresponding start parameters
Calling the Program
Start the utility AE DB Change in batch mode which also provides for the background processing of large
data amounts. Processing and results are logged. The logfile name is specified in the program's INI file.
Start the program from the command line using the following parameters:
UCYBCHNG[.EXE] [-B] [-IPath and name of the INI file] -1Script File-2Transport file[-3Output file]
[-LE]
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 Script file - contains the modification commands

l Transport file - contains the objects to be modified (by default UC_DATA.TXT)
l Output file - includes the modified data
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.

0 The utility has successfully ended processing.
1 The transport file does not exist or cannot be opened.
2 The script file does not exist or cannot be opened.
3 The transport and the script file do not exist or cannot be opened.
4 The output file cannot be opened.
5 The script file includes an error (see log file).
21400 EXIT_CODE_NOT_A_TRANSPORT_FILE
21424 EXIT_CODE_NO_DATA_IN_TRANSPORT_FILE
21432 EXIT_CODE_INVALID_VERSION_TRANSPORT_CASE
21433 EXIT_CODE_TOO_FEW_PARAMETERS
See also:
Syntax of the script file

General procedure - Transport Case
Modifiable attributes
Start parameters
Structure of the INI file, AE DB Change
12.3.2 Syntax of Scripting Files

AE provides the REPLACE and REPLACE_PART statements to create scripting files for the AE DB
Change utility.
REPLACE Object Type, Name, Attribute, Old Value, New Value

REPLACE_PART Object Type, Name, Attribute, Part of the old Value, New Value
Object The short name of the object type.
type Format: Specification without quotation marks.
You can use the wildcard characters "*" and "?" here. "*" stands for any number of characters
and "?" for exactly one character. In doing so the REPLACE statement can operate on all
object types.
Name The name of the object that should be modified.
Format: Specification without quotation marks
Automic recommends specifying the whole path in folders (such as \TEST\Workflow).
Note that it is not allowed to indicate a path for objects. Object names are unique within a
client.
Attribute The name of the attribute that should be modified.
Format: Specification without quotation marks
You can use the wildcard character "*" here. In doing so the REPLACE statement can
operate on all attributes.
For a list of all object attributes including their allowed values, refer to the User Guide.
For Rapid Automation attributes, see Changing Rapid Automation Job Attributes below.
Old The attribute value that should be changed.
Value Format: Specification in apostrophes (') or double (") quotation marks
You cannot use wildcard characters here.
Note that uppercase and lowercase letters used in the value are distinguished. No
distinction is made if they are replaced within a script.
New The attribute value that should replace the old value.
Value You cannot use wildcard characters here.
Format: Specification in apostrophes (') or double (") quotation marks
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 AE DB Change.
Using REPLACE vs. REPLACE_PART

Use either the REPLACE or REPLACE_PART script elements for your script replacements. The
differences are described below.
REPLACE
Old Value is only replaced by New Value if Old Value exactly equals the old value. An exception to this rule
are modifications that are made in an object's script. This is similar to the Search/Replace function of
common text editors. Every string that is located within a text line is replaced.
Apostrophes can be used instead of quotation marks in order to specify Old Value and New Value. This is
important when you replace strings that contain quotation marks.
REACE_PART
REPLACE_PART can be used to replace parts of Old Value. The specified New Value is then inserted
instead of the old value.
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.
Changing Attribute Values for "Y" and "N"

An exception applies for attributes permitting the values "Y" and "N". These two letters cannot be assigned
to the utility AE DB Change. In this case Automic recommends using the number "1" instead of "Y" and "0"
instead of "N".
Changing Object Variables

The utility can also be used to modify object variables. For this purpose, you enter the term "VALUE"
followed by a colon and the name of the object variable with a leading "&" character in the parameter
Attribute.
Changing Rapid Automation Job Attributes

You can also change the specific attributes of all Rapid Automation jobs using the utility AE DB Change.
In this case, you use one of the following:
To change the value of: Enter the attribute name as:

Job attributes "CVALUE" followed by a colon and the name of the RA
attribute of the Attribute.
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.
l 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'
Changing Object Assignments

The parameter OBJECT_USE of the utility AE DB Change can also be used to replace object uses. You
can replace used objects in the following object types: CALL, JOBS, EVNT, JOBP, JOBF, JSCH, JOBG,
SCRI, JOBI, JOBQ, DOCU, VARA, SYNC, FILTER, CALE, LOGIN, CPIT.
The old value is the name of the object that is currently used and the new value is the name of the object
that should be used instead.
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.
Changing Folder Names

This utility can also change the names and paths of folders. For this purpose, you would use REPLACE_
PART in combination with the attribute FOLDER_NAME and for the name, you would specify the
complete path of the folder that should be changed. For the old and new value, you can either specify an
individual folder name or part of the path.
As of version 9, you can use folder titles. In the transport file, it will be displayed in curly brackets within
the path (for example: \OBJECTS{TITLE}\TEST{}\
The curly brackets will be empty if you do not use a title.
Note that you cannot change folder titles by using the utility AE DB Change.
When you change a folder within the path by replacing one or several folders, the titles will still be used at
the old folder level.
For example:
Old path: \OBJECTS{TITLE1}\TEST{}\JOBS{TITLE2}
Script command: REPLACE_PART FOLD, \OBJECTS\TEST\JOBS, FOLDER_NAME, "OBJECTS",
"ARCHIV\OBJ"
New path: \ARCHIV{TITLE1}\OBJ{}\TEST{TITLE2}\JOBS{}
In the new path, the titles are still used at the old folder level. The folder "TEST" now has a title (TITLE")
although it had no title in the beginning.
Note that in the script file, you must specify the complete path (Name) without curly brackets.
Otherwise, your modifications will be ignored.
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"
The calendar changes from FIRM_CALENDAR_2003 to FIRM_CALENDAR_2004 in all Notification

object names that start with MM*,.
REPLACE_PART CALL, MM*, CALENDAR, "2003", "2004"
The name of the folder SCHEDULE changes to SCHEDULE_WEEKDAYS.

REPLACE_PART FOLD, \MM\SCHEDULE, FOLDER_NAME, "SCHEDULE", "SCHEDULE_
WEEKDAYS"
The following example switches the folder SCHEDULE to the path TEST\JSCH.
REPLACE_PART FOLD, \MAWI\SCHEDULE, FOLDER_NAME, "SCHEDULE", "TEST\JSCH"
The specific parameter "OBJECT_USE" of the utility AE DB Change can be used to replace used objects.
The following example replaces the Sync object "SYNC1" by "SYNC2" in all workflows that use this Sync
object.
REPLACE_PART JOBP, *, OBJECT_USE, "SYNC1", "SYNC2"
The following example replaces the connection and login data of an SQL Variable object.
REPLACE VARA, VARA.SQL.TEST, SQL_CONNECTION, "CONNECTION.OLD",
"CONNECTION.NEW"
REPLACE VARA, VARA.SQL.TEST, SQL_LOGIN, "LOGIN.OLD", "LOGIN.NEW"
The following examples change the value of the JMS queue from "test.tibco.queue" to "prod.tibco.queue".
The first line overrides it in JMS jobs. The second line overrides it when JMS jobs are included as tasks in
workflows. This syntax works for jobs of any Rapid Automation agent, you just switch out the Attribute
name after "CVALUE:" and/or "JPCVALUE:" and specify appropriate Old Value and New Value.
REPLACE JOBS, *, CVALUE:queueName ,"test.tibco.queue","prod.tibco.queue"
REPLACE JOBP, *, JPCVALUE:queueName ,"test.tibco.queue","prod.tibco.queue"
The following example changes the SAP start mode parameter from 1 for Immediate to 0 for As Soon As
Possible.
REPLACE JOBS,*,SAP_STARTMODE,"1","0"
See also:
General Procedure - Transport Case

Structure of the INI file, AE DB Change
12.4 AE DB Client Copy
12.4.1 AE DB Client Copy

Copying and Deleting Clients
The utility AE DB Client Copy (UCYBDBCC) can be used to copy and delete clients. For reasons of
security, log on to the system client 0000 at the beginning. The relevant login window opens automatically
when the program starts.
Note that the utility AE DB Client Copy only displays clients that have already been renamed to a four-digit
client number. For clients that have still the default name (such as CLIENT.NEW.2), a warning is written
to the log file when the utility starts.
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 All messages without a deletion flag are copied.
Messages
Resetting All user passwords are reset to "pass".
password
Copying AE All statistics and reports without an erase symbol are copied.
statistics/report
Copy VC Version management objects are also copied.
Objects
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 the INI 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 Because objects are only assumed when they are copied for the first time, they are not considered
in subsequent copying processes.
l In subsequent copying processes, the utility copies all messages that are available in the source
client when the process starts.
l 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.
l AE DB Client Copy skips data that is already available in the destination client.
l Copying data subsequently is possible at any time.
In the variable UC_CLIENT_SETTINGS you may use the key PWD_DEFAULT to set a client-wide
default password for new User objects, which are created without an individual password. When using
the client copy utility, all User objects contained in the copied client will be set to the default password
defined in that key.
If no password has been defined there, the default system password "pass" will be set at the copying
process.
Users will have to change their password in both cases when they log in to the system the next time.
Procedure
Copying a clients for the first time:
1. Start the utility AE.DB ClientCopy.

2. Highlight the client that should be copied in the source database list.
3. Select an unused client number in the destination database (displayed with a green hand symbol).
4. Decide whether messages, statistics etc. should also be copied or not.
5. Start the copying process by clicking "copy client".
Copying messages and statistics subsequently:
1. Start the utility AE.DB ClientCopy.

2. Select the previously copied client and the corresponding destination client.
3. Select whether messages, statistics, reports should be copied subsequently or not.
4. Start the copying process by clicking "copy client".
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]
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
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. Select the 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.
l 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.
l 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.
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
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.
Table Lists the possible data areas that can be reorganized.
Table Data area with a specification of the relevant tables.
Last reorganization. Date and time of the last reorganization run that has been made by
using the utility AE DB Unload.
Current number. Number of data records that can be reorganized.
Criteria for Current setting of the reorganization criteria including a display of the
reorganization. corresponding date.
Number after Number of data records that are not reorganized because of the
reorganization. specified criteria.
Reset deletion flags Enables the resetting of the client's deletion flags.
You can also use the utility AE DB Unload to reset the deletion
flags of several clients.
Forecast This button activates the creation of a Forcast for the current data
stock
Reorganization Click this button in order to start the reorganization process.
You can view the progress of the reorganization run in the window's
status line. It displays the name of the current table, the entire number
of data records and the progress in percent.
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.
Messages Tab
Description
Element
Reorg messages Use this checkbox to specify that the messages of the client are reorganized.
Unread messages 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 that corresponds to the number of days displays.
Statistics Tab
Description
Element
Reorg You can use this check box to specify that the statistics of the client are reorganized.
statistics
Reorg All statistical data that is older than the specified number of days will be reorganized.
statistics Additionally, the date that corresponds to the number of days displays. Statistical data
older ... 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
Element
Report With this check box you can specify that the reports of the client are reorganized.
reorganization
Reorg reports All reports that are older than the specified number of days are reorganized.
older ... 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.
Version Management Tab
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 All Version-Control objects that are older than the specified number of days are
older than ... reorganized.
Additionally, the date that corresponds to the number of days displays.
Keep last ... 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.
Object Audit Tab
Description
Element
Reorg Object Audit 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 Using this option reorganizes only data that has previously been put out in reports
Object Audits 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.
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.
l 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:

Start Parameters
Structure of the INI file, AE DB Reorg
12.7 AE DB Reporting Tool
12.7.1 AE DB Reporting Tool

Task Evaluations
The utility AE DB Reporting Tool can be used to query tasks in your AE system.
Results are supplied as a report file.

You can query:
l Object contents
l Future executions
l 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.
Any number of queries can be defined.
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 Extensive queries require more time and affect performance negatively.

l AutoForecast records are required for querying future executions.
l AE Script considers only lines in the !Process tab of Time events which contain the script function
ACTIVATE_UC_OBJECT.
l If an Include object is not available in the client to be queried, it is searched for in system client
0000.
l Script variables and Variable objects are not queried.
l Ensure that the general entry for agent specifications (e.g. <WIN>) is selected in objects when
setting the host using the script statement :PUT_ATT. Otherwise, the result can be a distorted one
because it is not possible to see in which objects the host was changed.
l The time and date entries in the AE database comply with the UTC time zone. For the evaluations,
this data is converted to the time zone of the client in which the query is defined. It it does not
include time-zone specifications, the system uses the time zone of client 0.
See also:

Creating Evaluation Reports
12.7.2 Graphical Interface of the Reporting Tool

You can define evaluation criteria by using the utility's graphical interface.
This view consists of two halves. The left side shows a tree structure which includes the three areas of
evaluation:
l Definition (object contents)

l Forecast (future executions)
l Statistics (past executions)
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.
Starting the Reporting Tool's Interface
This utility's graphical interface is available on UNIX and Windows.
You can use the following command in order to start the utility (UNIX and Windows):
java -jar ./ucyrepg.jar
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.
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 *.d.xml - definition
l *.f.xml - forecast
l *.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
12.7.3 Creating Evaluation Reports

The utility creates reports in batch mode.
It can be called from the command line by using the following parameters:
UCYBDBRT -Xquery file [-Cclient -IINI file-Llanguage -Rreference date -S-Ooutput file-Tfile type]
All parameters are optional, except for the query file. A list of all values and a description is provided in the
document that describes the start parameters.
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 Definition Forecast Statistic

Archive 1 First archive key.
Archive 2 Second archive key.
Calendar in Name of the workflow's Calendar object.

the workflow
Calendar in Name of the superordinate Schedule's Calendar
the schedule object.
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 Name of the User object.
Changed on Date of last object modification.
Format: YYYY-MM-DD [HH:[MM:[SS]]]

Created by Name of the User object.
Earliest start Earliest start time in the format YYYY.MM.DD

time HH:MM:SS.
End time End time in the format HH:MM:SS.
Expected end Expected end time in the format YYYY.MM.DD

HH:MM:SS.
Expected Expected runtime in seconds.
runtime
Expected start Expected start time in the format YYYY.MM.DD
time HH:MM:SS.
Host Name of the agent in jobs.
Host type Job type.
Allowed values: "BS2000", "GCOS8", "JMX",

"MPE", "MVS", "NSK", "OS400", "R3",
"SIEBEL", "UNIX", "VMS" and "WINDOWS"
Int. account Internal account.
Interval Interval of the Time-Event object.
Job content Text contained in the script.
Workflow Name of the superordinate workflow.
Last used on Date of last object usage.
Format: YYYY-MM-DD [HH:[MM:[SS]]]

Login object Name of the Login object in jobs.
Login: user Login information of the Login object in jobs.
Object name Name of the object.
Object type Short form of the object type (e.g.: JOBP)
Output device Name of the output device.

(R3_
ACTIVATE_
REPORT)
Report (R3_ Name of the report.
ACTIVATE_
REPORT)
Return code Return code of the task.
RunID Number of the execution.
Runtime Duration of the execution in seconds.
SAP client Client in SAP in Login objects of jobs.

SAP user Name of the SAP user in Login objects of jobs.
Schedule Name of the superordinate Schedule object.
Start time in Start time in the format HH:MM:SS.

the schedule
Start time Start time in the format HH:MM:SS.
Status For filter criteria:
One or more system return codes are separated

by commas (for example, 1900, 1920).
In the analysis report:
The long texts are output instead of the numbers

(for example, ENDED_OK).
Time event Name of the Time-Event object.
Title Title of the object.
Type of parent Object type of the parent object.

object
Variant (R3_ Name of the variant.
ACTIVATE_
REPORT)
Version Version number of the object.
See also:
Task Evaluations
XML Files of Queries
Start Parameters
12.7.4 XML Files of Queries

Queries are stored in the sub-folder "queries" in the form of XML files.
The utility generates the XML files. No manual adjustment is required for the entries.
Parameters Description
<?xml version="1.0" XML Declaration
encoding="UTF-8"
standalone="no"?>
<QUERY Automation Engine version of the utility which created the query file
version="Automation Engine
version">
<file css="style sheet" Evaluation report

type="format">report
"style sheet" = directory and name of the style sheet that should be
file</file>
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> Client in which the evaluation should be made
<max_rows>lines</max_ Maximum number of lines the report can have
rows>
<source>query type</source> Evaluation area
Allowed values: "DEFINITION", "FORECAST" and "STATISTIC"
<reference> Period for statistical and forecasting evaluations

<date>date</date> Date in the format YYYY-MM-DD or the special value TODAY. If
TODAY is used, the utility uses the latest date for report creation.
<offset>time range</offset> Number of hours to be added to the date (forecasts) or subtracted from
it (statistics). Therefore, this value includes an algebraic sign (+/-).
</reference> Ending of the XML element <reference>
<selection> Beginning of the elements about evaluation criteria
<include name="criterion" The individual evaluation criteria are listed as a value pair.
value="value" />
</selection> Ending of the XML element <selection>
<output order="order" Beginning of the elements for the output columns in the report
sort="sorting">
"order" - ascending or descending order
Allowed values: "ascending" and "descending"
"sorting" - column determining how elements are sorted
<field name="column" /> Output columns to be included in the report

</output> Ending of the XML element <output>
</QUERY> Ending of the XML element <QUERY>
Example of a Query File
<?xml version="1.0" encoding="UTF-8" ?>

<QUERY version="11.0.0">
<file type="CSV">Output_SAPjobs.html</file>
<client>0098</client>
<max_rows>1000</max_rows>
<source>DEFINITION</source>
<selection>
<include name="OBJECT_TYPE" value="JOBS" />
<include name="JOB_TYPE" value="R3" />
<include name="OBJECT_NAME" value="*T01*" />
</selection>
<output order="ascending" sort="OBJECT_NAME">
<field name="OBJECT_NAME" />
<field name="LOGIN" />
<field name="SAP_CLIENT" />
<field name="SAP_USER" />
<field name="MODIFIED_DATE" />
<field name="LAST_USE_DATE" />
</output>
</QUERY>
See also:
Evaluations about Tasks in the AE system

Start Parameters
12.8 AE DB Revision Report
12.8.1 AE DB Revision Report

Revision Report
Modification reports can be created in each AE system. These reports include detailed information about
object modifications and accesses. Logging for these reports can be activated in the variable UC_
CLIENT_SETTINGS of the particular clients using the key OBJECT_AUDIT.
The following areas can be logged:
l Task starts
l Modifications at runtime
l Task abortions
l Imported objects
l Deleted objects
l Object modifications
l 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 user group when the logging for revision reports has been
activated in the client. In this case, memberships can directly be specified in the User object.
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
12.8.2 Monitored Areas

The following areas are logged and can be stored in Revision Reports either completely or sorted by
categories.
Creating and Renaming Objects
The creation and renaming of objects are logged.

Moving Objects
Source and target folder are recorded when objects are moved.
Imported and Transported Objects
Import time and transportation time are stored. Contents of the XML and transport files are not written to
the Revision Report.
Task Starts and Restarts
The start time (i.e. the activation time) is stored.
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.

Deleted or Restored Objects
Deletion and restoring processes of objects are recorded.
Object Modifications
Changes of object definitions are logged (e.g. modifications of priority, start type etc.).
Exemptions:
l Modifications made by using AE Script,

l Status modifications of Sync objects,
l Contents of Variable objects,
l Modifications of Calendar objects.
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.
Accesses of Any Kind
Accesses to objects and folders are recorded. This includes successful accesses and access violations
which occurred due to restricted AE authorizations.
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
12.8.3 Creating Revision Reports

The utility AE DB Revision Report is called via the command line. Its complexity and content can be
defined with parameters.
The following syntax should be applied:
UCYBDBRR -B -Cclient [-Farea -Ooutput file-D1start time-D2end time-X -A-IINI file-Llanguage]
The order of the parameters is freely selectable.
The line shown below serves as an example. All starting times and runtime modifications of client 3 which
take place between 01.04. 20:00 and 02.04. 06:30 are output to the file C:\revision\report01.txt.
UCYBDBRR -B -C0003 -FSTART,RUN_MOD -OC:\revision\report01.txt -
D120050401200000 -D220050402063000
All parameters except for -B and -C are optional. Hence, particular default values are used for the non-
specified parameters in program calls. A list of these values including their descriptions is available in the
document Start parameters.
Depending on the situation that has occurred, this utility supplies a particular return code when the process
has finished.
Return Message Description

code number
0 - The utility has successfully ended processing.
1 U0036139 Error occurred when loading INI-file settings
2 U0036138 Error: not possible to allocate memory for PCX
3 U0021004 Cannot find INI file
4 U5005000 No batch mode - please use parameter -B!
5 U5005001 No client has been defined!
6 U0003301 Could not allocate memory
7 U5005008 Processing was canceled. The output file cannot be opened.
8 U0036134 Error: cannot connect to AE source database
9 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
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
Select all / Unselect Selects or deselects the database tables that are listed in the left window.
all
Export selected table Exports the selected database table(s).
Export all data Exports all database tables.
Reorganize database Removes all data that has been marked with a deletion marker using the utility
AE DB Reorg.
Reset archive flags Resets the archive flags of one or all clients.
Reset reorg flags Resets the reorg flags of one or all clients.
Unload transport Unloads the transport case of one or all clients.
container
Unload all objects Unloads the objects of one or all clients.
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
usually distributed among several computers.
The utility AE.LogMix supports the generation of one common file from several report, log or trace files.
The individual file entries are newly arranged in chronological order.
Trace files are only to be activated by the Automic Support team.
Reports of objects or log entries of server processes and agents can be unloaded from the AE database
using the utility AE DB Archive. AE.LogMix is able to process these reports, log and trace files.
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.
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
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:

1 Parameter -C is missing
2 Parameter -N is missing
3 A wrong date has been specified.
4 The file cannot be created because the name is too long on account of the defined prefix.
5 A file of the same name already exists.
6 More than 99 statistical records were found in the specified period.
AE.LogMix:

1 None of the files meets the selection criteria.
2 More than 99 files were found.
3 The parameter -L has not been specified and no INI-file values have been defined.
780 | Chapter Glossary
Glossary
This glossary lists all specific technical terms in alphabetical order.
ABCDEFGHIJKLMNOPQRSTUVWXYZ
A
l ARA Client
Refers to a computer on which a ARA/Deployment Manager/Automation Engine user works.
l admin computer
Admin computer refers to the computer that is used by an administrator for e.g. Automation Engine
or database administration purposes.
C
l configuration
A set of constituent components that make up a system. This includes information on how the
components are connected including the settings applied.
D
l Download Center
The Download Center (http://downloads.automic.com/) is the place where you find everything you
need to know about your Automic solution to make sure you are using our products to their fullest
potential.
l database
A database is an organized collection of data including relevant data structures.
l department
Department name to which the Automation Engine user belongs.
G
l graphical user interface
A graphical user interface (GUI) is a human to machine interface based on windows, icons and
Chapter Glossary | 781
menus which can be operated by a computer mouse in addition to a keyboard. In contrast to

command line interface (CLI).
I
l ILM
Stands for Information Lifecycle Management, which refers to a wide-ranging set of strategies for
administering storage systems on computing devices.
J
l Java work process
The Java work process, implemented in Java, is used to host special services, which have been
developed in Java.
P
l package module
A package module is a group of related package types, e.g. Feature, Change Request, or Bug. It
defines how the packages are displayed in the GUI and the features enabled for each package type.
l password
A secret combination of characters for a Automation Engine user.
R
l RichClient
Deprecated Term. Replaced by: UserInterface
l rollback scope
The scope of a workflow to roll back. For a rollback on a job the scope is this single task while for a
rollback on a workflow the scope is this workflow and all sub-workflows in arbitrary depth.
782 | Chapter Glossary
S
l Service Manager
The Service Manager serves to start, stop and access components such as the Automation Engine
T
l token
A token is used for authentication within a session between a client and a server. A (soft) token is a
unique identifier which is generated and sent from a central server to a client software. The client
uses the token to authenticate each request.
U
l user name
Name of the Automation Engine user.
V
l vSphere
vSphere is a virtualization platform for building cloud infrastructures by VMware.
W
l web application
A web application is an application that is accessible over a network (Internet or intranet) and is
typically coded in a programming language like Java or JavaScript, combined with a markup
language like HTML. Web applications are provided on web servers and web browsers are used as
GUI on client computers.

Automation - Engine Administration Guide en

Diunggah oleh

Informasi Dokumen

Judul Asli

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

Automation - Engine Administration Guide en

Diunggah oleh

Hak Cipta:

Format Tersedia

Automation Engine 11

ONE Automation Platform

© Copyright Automic Software GmbH. All rights reserved.

2.2 Planning an Authorization System 3

2.3 Newly Created Users 4

2.4 Creating Users and User Groups 5

2.5 Assigning Access Rights for Folders 7

2.6 Access to Objects 8

2.7 Agent Rights 10

2.8.1 User Passwords 11

2.9 LDAP Connection Setup 12

Importing and Installing SSL Certificates 12

Activate the LDAP connection for your AE system. 12

LDAP Synchronization with Technical User Credentials 12

2.9.2 Procedure Active Directory 13

Specify the connection data: 13

Setting up the LDAP connection in User objects: 13

2.9.3 Procedure Oracle Directory Server 14

Specify the connection data: 14

Setting up the LDAP connection in User objects: 14

3.1 Structure Of Configuration Files 16

3.1.1 Notes for Configuration-File Adjustments 16

3.1.2 Automation Engines 17

Structure of the Automation Engine INI File 17

Structure of the INI File UCSRV.INI 17

Example of an INI File 27

Structure of the INI File UCDJ.INI 35

Example of an INI File 38

Structure of the BAT File UCDJ.BAT 38

Example of a BAT File 38

Structure of the INI File x.xxx.UCXJB2?.INI 39

Example of an INI File 44

Structure of the INI File UCXJSQLX.INI 45

Example of an INI File 50

Structure of the INI File UCXJGC8I 51

Example of an INI File 55

Example of an INI File 60

Structure of the INI File UCXJNS1I 61

Example of an INI File 66

Structure of the INI File UCXJO41 68

Example of an INI File 73

People Soft Agent 74

Structure of the INI File UCXJPSX.INI 74

Example of an INI File 79

Example of an INI File 84

Structure of the INI File UCXJR3X.INI 84

Example of an INI File 91

Structure of the INI File UCXJSLX.INI 92

Example of an INI File 96

Structure of the INI File UCXJXXX.ini 97

Example of an INI File 107

VMS Agent 109

Structure of the INI File UCXJV??.INI 109

Example of an INI File 116

Windows Agent 117

z/OS Agent 126

Structure of the INI File UCXJM25.INI 126

Example of an INI File 137

z/OS - Event Monitor 138

Structure of the INI File UCXEM25.INI 138

Example of an INI File 143

z/OS - External Job Monitor 143

Structure of the INI File UC4EJM.INI 143