Automation Engine 10

ONE Automation Platform

Administration Guide

Version: 10.0.7
Publication Date: 2016-01
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 6

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 11

3 Configuration 14

3.1 Structure Of Configuration Files 14

3.1.1 Notes for Configuration-File Adjustments 14

3.1.2 Automation Engines 15

Structure of the Automation Engine INI File 15

Structure of the INI File UCSRV.INI 15

Example of an INI File 25

3.1.3 UserInterface 27

UserInterface 27

Structure of uc4config.xml 27

UserInterface 31

UserInterface (Windows) 33

Structure of the INI File UCDJ.INI 33

Example of an INI File 36

Structure of the BAT File UCDJ.BAT 36

Example of a BAT File 36

3.1.4 Agents 36

BS2000 Agent 36

Structure of the INI File x.xxx.UCXJB2?.INI 37

Example of an INI File 42

iv Contents

Database Agent 43

Structure of the INI File UCXJSQLX.INI 43

Example of an INI File 48

GCOS8 Agent 49

Structure of the INI File UCXJGC8I 49

Example of an INI File 53

JMX Agent 54

Structure of UCXJJMX.INI 54

Example of an INI File 58

NSK Agent 58

Structure of the INI File UCXJNS1I 59

Example of an INI File 64

OS/400 Agent 66

Structure of the INI File UCXJO41 66

Example of an INI File 71

People Soft Agent 72

Structure of the INI File UCXJPSX.INI 72

Example of an INI File 77

RA Agent 78

Structure of UCXJCITX.INI 78

Example of an INI File 82

SAP Agent 82

Structure of the INI File UCXJR3X.INI 82

Example of an INI File 89

Siebel Agent 90

Structure of the INI File UCXJSLX.INI 90

Example of an INI File 94

UNIX Agent 95

Structure of the INI File UCXJXXX.ini 95

Example of an INI File 105

VMS Agent 107

Structure of the INI File UCXJV??.INI 107

Example of an INI File 114

Windows Agent 115

 Automation Engine v

z/OS Agent 123

Structure of the INI File UCXJM25.INI 123

Example of an INI File 133

z/OS - Event Monitor 134

Structure of the INI File UCXEM25.INI 134

Example of an INI File 139

z/OS - External Job Monitor 139

Structure of the INI File UC4EJM.INI 139

Example of an INI File 143

3.1.5 Utilities 143

AE DB Archive 143

AE DB Change 152

AE DB Client Copy 153

AE DB Load 158

AE DB Reorg 163

Structure of the INI File UCYBDBRE.ini 163

AE DB Reporting Tool 168

AE DB Revision Report 173

AE DB Unload 176

Utility for the Console Event (UCON Connection) 181

Structure of the INI File x.xxx.UCXEB2?U.INI 181

Example of an INI File 182

3.1.6 ServiceManager 183

ServiceManager - Service 183

Structure of the INI File UCYBSMGR.INI 183

Example of an INI File (Windows) 185

Setting Up an SMD File 185

Setting Up an SMC File 187

ServiceManager - Dialog Program 188

3.1.7 CallAPI 189

Utility for BS2000 189

Structure of the INI File x.xxx.UCXBB2?C.INI 189

Example of an INI File 190

Utility for GCOS8 191

vi Contents

Structure of the INI File UCXBGC8CI 191

Example of an INI File 192

Utility for Java 192

Structure of the INI File UCXBXXXC.INI 192

Example INI File 193

Utility for NSK 193

Structure of the INI File UCXBNS1I 193

Example of an INI File 195

Utility for z/OS 195

Structure of the INI File UCXBM25C.INI 195

Example of an INI File 196

Activating Trace for z/OS CallAPI Utility 197

Utility for OS/400 197

Structure of the INI File 197

Example of an INI File 198

Utility for UNIX 199

Structure of the INI File UCXBXXXC.ini 199

Example of an INI File 200

Utility for VMS 200

Structure of the INI File UCXBVXXC.INI 200

Example of an INI File 202

Utility for VSE 202

Structure of the INI File UCXBVSE.INI 202

Example of an INI File 203

Utility for Windows 204

Structure of the INI File UCXBXXXC.INI 204

Example INI File 205

RFC Server 205

Structure of the INI File UCXBRXXC.INI 205

Example of an INI File 208

Connect for WebSphere MQ Queue Manager (Windows) 208

Structure of the INI File UCXBMQCX.INI 208

Example of an INI File 211

3.2 Settings in Variables 211

 Automation Engine vii

3.2.1 Settings in Variables 211

3.2.2 UC_AGENT_ASSIGNMENT - Agent Assignment 213

3.2.3 UC_AS_SETTINGS - Advanced Security 214

3.2.4 UC_AUTO_FORECAST - Auto Forecast Data 215

3.2.5 UC_CALENDAR_PERIOD - Calendar Periods 216

3.2.6 UC_CLIENT_SETTINGS - Various Client Settings 216

3.2.7 UC_EX_ERP_CONNECT - Connection to Enterprise Business Solutions 228

3.2.8 UC_EX_HOSTCHAR - Assigning Agents to Host Characteristics 228

3.2.9 UC_HOSTCHAR_DEFAULT - Host Characteristics 229

3.2.10 UC_ILM_CONTAINER_* - AE Database Partitions 239

3.2.11 UC_ILM_SETTINGS - Settings for Partitioning with ILM 240

3.2.12 UC_JOB_CHECKINTERVAL - Periodic Time Check in the Automation Engine 243

3.2.13 UC_LDAP_EXAMPLE - LDAP Connection Variable 243

3.2.14 UC_LOGIN_TYPES - Defining Additional Platform and System Types for Login
Objects 245

3.2.15 UC_OBJECT_COUNTER - Counter Reading in Object Name 246

3.2.16 UC_OBJECT_DOCU - Object Documentation 246

3.2.17 UC_OBJECT_TEMPLATE - Object Types and Templates 248

3.2.18 UC_REPORT_STYLESHEETS - Style Sheets for XML Reports 250

3.2.19 UC_SAP_JXBP_EVENTTYPES - Event Types of the Java Scheduler in SAP 250

3.2.20 UC_SENDTO and UC_SENDTO_ACT - Handling Objects and Tasks

Internally/Externally 251

3.2.21 UC_SNMP_VALUES - SNMP Values 253

3.2.22 UC_STATISTIC_OPTIONS - Controlling the Statistics Functions 254

3.2.23 UC_SYSTEM_SETTINGS - System-Wide Settings 254

3.2.24 UC_USER_LOGON - Single Logon 271

3.2.25 UC_UTILITY_ARCHIVE - Archiving Specifications 272

3.2.26 UC_UTILITY_DB_UNLOAD - Executed Reorganization Runs 273

3.2.27 UC_UTILITY_REORG - Reorganization Specifications 274

3.3 Configuration & Performance 275

3.3.1 Configuration & Performance of the Database 275

DB2 275

Notes 275

MS SQL Server 276

Notes 276
viii Contents

Oracle 277

Notes 277

Oracle Parameters 278

3.3.2 Configuration & Performance of the DB Server 302

3.3.3 Configuration & Performance of the Automation Engine 302

3.3.4 Configuration & Performance of the UserInterface 303

4 Database 305

4.1 Overview 305

4.2 Encoding Passwords 305

4.3 Creating an ODBC Data Source 306

4.4 Database Rights for the Automation Engine 309

4.5 Database Maintenance 310

4.5.1 Technical Maintenance of the AE Database 310

4.5.2 Maintaining Data Records 313

4.5.3 Maintaining Data Records 314

4.5.4 Partitioning with ILM 316

Procedure 320

Important Note for MS SQL Server 320

4.6 Transporting Data 320

4.6.1 General Procedure 320

5 Diagnostic Tools 322

5.1 Logging/Trace 322

5.2 LOG_DUMP 323

5.3 TRACE 324

5.4 TRACE_DUMP 326

6 Encryption and Authentication 329

6.1 Advanced Security 329

6.2 Specifying the Authentication Method for the First Time 331

6.3 Changing the Authentication Method 333

7 Enterprise Control Center 336

7.1 Enterprise Control Center (ECC) 336

8 Installation 340

8.1 Supported Platforms 340

8.2 New Installation 346

 Automation Engine ix

8.2.1 Prior to Installation 346

Introduction 346

General Information 347

Computers in the Automation Engine Environment 347

File Structure 347

UserInterface 348

Requirements 349

Procedure 349

New Installation Procedure 349

8.2.2 Installation Procedure 352

Setting Up the Database 352

DB2 352

MS SQL Server 354

Disk Space Required 354

Procedure 355

ORACLE 355

Utilities 359

Installing Utilities (UNIX) 359

Procedure 360

Installing Utilities (Windows) 363

Supplied Files 363

Procedure 364

Loading the Database 366

Installing the Automation Engines 367

Installing the Automation Engine for UNIX 367

Requirements 368

Supplied Files 368

Procedure 369

Possible Problems 372

Installing the Automation Engine for Windows 373

Requirements 373

Supplied Files 373

Procedure 374

See also: 374

x Contents

Distributed Server Environment 375

Installing the UserInterface 376

Installing the UserInterface (UNIX) 376

Installing the UserInterface (Windows) 381

Supplied Files 381

Procedure 382

Potential Problems 383

Installing the Online Documentation 385

Help formats 385

Supplied Files 386

Installing the Agents 388

Installing the Agent for BS2000 388

Procedure 389

Installing the Agent for Databases 390

Installing the Agent for Database Jobs and Events 390

Installing the Agent for Database Variables 394

Installing the Agent for GCOS8 398

Installing the Agent for J2EE/JMX 400

Setting Up the Agent for J2EE/JMX 400

Usage with Application Server 402

Setting Up the Agent for J2EE/JMX (Oracle WebLogic) 402

Setting Up the Agent for J2EE/JMX (IBM WebSphere) with RMI Connector 403

Setting Up the Agent for J2EE/JMX (IBM WebSphere) with SOAP Connector 406

Setting Up the Agent for J2EE/JMX (JBoss) 410

Setting up the Agent for J2EE/JMX (Oracle Containers for J2EE) 412

Setting up the Agent for J2EE/JMX (SAP NetWeaver) 413

Setting Up the Agent for J2EE/JMX (Tomcat) 417

Web Configuration Interface for the J2EE/JMX Agent 418

Installing the Agent for NSK 420

Procedure 421

Installing the Agent for OS/400 424

Procedure 425

Installing the Agent for PeopleSoft 427

Installing the Agent for People Soft (UNIX) - Basics 427

 Automation Engine xi

Installing the Agent for People Soft (UNIX) - Details 430

Installing the Agent for People Soft (Windows) - Basics 437

Installing the Agent for People Soft (Windows) - Details 440

Automation Engine Interface 446

Creating Java Classes 450

Setting Up the Agent for Rapid Automation 451

Installing the Agent for SAP 454

Preparing Installation - Check List 454

Installing the Agent for SAP - Basics 455

Installing the Agent for SAP - Details 457

Installing the Agent for Siebel (Windows) 461

Procedure 461

Installing the Agent for UNIX 462

Procedure 464

Installing the Agent for VMS 466

8.2.3 Special Feature: Logical Name for Agent 467

Procedure 467

8.2.4 Automatic Agent Start when Booting the Operating System 470

Installing the Agent for Windows 470

Procedure 471

Installing the Agent for z/OS 474

8.2.5 Load Module: 474

Procedure 475

Installing the ServiceManager 480

Installing the ServiceManager (UNIX) 480

Installing the ServiceManager (Windows) 482

Supplied Files 482

Procedure 483

Potential Problems 485

Uninstalling the ServiceManager 485

See also: 485

Installing the CallAPIs 486

Installing the Call API for BS2000 486

Installing the Call API for GCOS8 487

xii Contents

Installing the Call API for Java 488

Installing the Call API for NSK 489

Installing the Call API for z/OS 490

Installing the Call API for OS/400 491

Installing the Call API for SAP 491

Installing the Call API for UNIX 496

Supplied Files 497

Procedure 497

Installing the Call API for VMS 498

Installing the Call API for VSE 499

Installing the Call API for Windows 502

Connect for WebSphere MQ (Windows) 503

Steps for Starting Operation 504

Call API for WebSphere MQ (Windows) 505

Installing the AE.ResourceAdapter (IBM WebSphere) 506

Supplied File 506

Procedure 507

Installation 510

Installing the AE.Internal Webservice (Glassfish) 510

Installing the AE.Internal Webservice (IBM WAS CE) 511

Installing the AE.Internal Webservice (JBoss) 512

Installing the Internal Webservice (SAP Netweaver) 513

Configuration Web Interface for the Internal Web Service 514

E-mail Connection 515

Configuration 517

Cluster 517

Automation Engine and Clusters 517

An Automation Engine System in a Windows Cluster 519

Preparations 519

Configuring AE in a Cluster 519

8.2.6 After Installation 524

Creating Clients and Users 524

Configuring your AE System 525

General 525
 Automation Engine xiii

Database 525

Settings 525

Server 526

Monitoring and Control 526

Auditing 526

User 526

8.3 Hotfix Installation 527

8.3.1 Installing Hotfixes 527

8.3.2 Shutting Down and Storing Automation Engine 528

8.3.3 Utilities 528

Installing Utilities (UNIX) 528

Requirements 529

Supplied Files 529

Procedure 530

Installing Utilities (Windows) 530

Supplied Files 531

Procedure 532

8.3.4 Changing the Database 533

8.3.5 Installing the Automation Engines 534

Installing the Automation Engine for UNIX 534

Supplied Files 535

Procedure 535

Installing the Automation Engine for Windows 536

Requirements 536

Supplied Files 536

8.3.6 Installing the UserInterface 537

Installing the UserInterface (UNIX) 537

Requirements 537

Supplied Files 537

Procedure 538

Installing the UserInterface (Windows) 539

Supplied Files 540

Procedure 541

8.3.7 Installing the Online Documentation 542

xiv Contents

8.3.8 Installing the Agents 542

Installing the Agent for BS2000 542

Requirements 542

Supplied Installation Files 543

Installing the Agent for Databases 544

Supplied Files 544

Installing the Agent for GCOS8 548

Requirements 548

Supplied Files 548

Procedure 548

Installing the Agent for J2EE/JMX 551

Stand-alone 551

Setting Up the Agent for J2EE/JMX 551

Usage with Application Server 553

Setting Up the Agent for J2EE/JMX (Oracle WebLogic) 553

Setting Up the Agent for J2EE/JMX (IBM WebSphere) with RMI Connector 554

Setting Up the Agent for J2EE/JMX (IBM WebSphere) with SOAP Connector 557

Setting Up the Agent for J2EE/JMX (JBoss) 560

Setting Up the Agent for J2EE/JMX (Oracle Containers for J2EE) 562

Setting Up the Agent for J2EE/JMX (SAP NetWeaver) 563

Setting Up the Agent for J2EE/JMX (Tomcat) 566

Installing the Agent for NSK 567

Requirements 567

Supplied Files 568

Installing the Agent for OS/400 571

Requirements 571

Supplied Files 571

Method 1 573

Method 2 574

Installing the Agent for PeopleSoft 575

Installing the Agent for People Soft (UNIX) 575

Installing the Agent for People Soft (Windows) 576

Procedure 577

Setting Up the Agent for Rapid Automation 577

 Automation Engine xv

Supplied Files 578

Procedure 578

Installing the Agent for SAP 580

Requirements (UNIX) 580

Supplied Files 580

Procedure 580

Installing the Agent for Siebel (Windows) 581

Supplied Installation Files 581

Procedure 582

Installing the Agent for UNIX 582

Requirements 582

Supplied Installation Files 582

Installing the Agent for VMS 583

Requirements 583

Supplied Installation Files 584

Installing the Agent for Windows 586

Supplied Installation Files 586

Potential Problems 586

Windows Agent for System-Wide E-mail Connection 586

Procedure 586

Installing the Agent for z/OS 587

Requirements 587

Supplied Files 587

Load Module: 587

8.3.9 Installing the ServiceManager 591

Installing the ServiceManager (UNIX) 591

Supplied Files 591

Steps 591

Installing the ServiceManager (Windows) 592

Supplied Files 592

Uninstalling the ServiceManager 593

8.3.10 Comparing Messages 593

8.4 Update Installation 594

8.4.1 Updating an AE System - Basics 594

xvi Contents

8.4.2 Notes for Updating the AE Database 596

8.4.3 Requirements - Updating to Version 8.00A 598

8.4.4 Requirements - Updating to Version 9.00A 599

8.4.5 Updating an AE System - Details 600

8.4.6 Converting Reports After Updating to 8.00A 605

8.5 Changing the Database 609

8.5.1 About Changing the Database 609

8.5.2 Unloading the Database 609

8.5.3 Setting Up the Database 610

8.5.4 Loading Database 611

9 ServiceManager 612

9.1 ServiceManager - Service 612

9.2 ServiceManager - Dialog Program 612

10 Start Parameters 617

10.1 Start Parameters - Automation Engine and UserInterface 617

10.2 Start Parameters - Agents 619

10.3 Start Parameters - Utilities 620

10.4 ServiceManager 637

11 System Monitoring 642

11.1 Changing the System Status 642

11.2 Handling Agents 643

12 Utilities 645

12.1 Utilities 645

12.2 AE DB Archive 645

12.2.1 AE DB Archive 645

12.2.2 Archived Folder Structure 652

12.2.3 Archive Browser 655

Introduction 655

Searching for Archived Data 656

Filter 656

Procedure 657

Navigating in the Search Result 658

12.2.4 Open Interface to Output Management Systems 659

12.3 AE.DB Change 661

 Automation Engine xvii

12.3.1 AE DB Change 661

12.3.2 Syntax of Scripting Files 662

12.4 AE DB Client Copy 667

12.4.1 AE DB Client Copy 667

12.5 AE DB Load 671

12.5.1 AE DB Load 671

12.6 AE DB Reorg 673

12.6.1 AE DB Reorg 673

12.7 AE DB Reporting Tool 679

12.7.1 AE DB Reporting Tool 679

12.7.2 Graphical Interface of the Reporting Tool 681

12.7.3 Creating Evaluation Reports 683

12.7.4 XML Files of Queries 686

12.8 AE.DB Revision Report 688

12.8.1 AE DB Revision Report 688

12.8.2 Monitored Areas 689

12.8.3 Creating Revision Reports 691

12.9 AE DB Unload 693

12.9.1 AE DB Unload 693

12.10 AE.LogMix 694

12.10.1 Combining Report, Log and Trace Files 694

Glossary 697

A 697

B 698

C 699

D 699

E 700

F 700

G 701

H 701

I 701

J 701

K 702

L 702
xviii Contents

M 702

N 702

O 703

P 703

Q 704

R 704

S 706

T 706

U 707

V 708

W 709

X 709
 Automation Engine 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 authorizationsauthorizations and privilegesprivileges. 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 dialogsAttribute dialogs for FileTransfers and Jobs.
CODETABLE CodeTablesCodeTables for FileTransfers and Jobs.
CONNECTIONS Connection objectsConnection objects
DIV_VARIABLES Various variablesvariables
EX_VARIABLES variables especially for agents.
HEADER Header IncludesHeader Includes for Jobs.
HOLIDAY_CALE CalendarsCalendars 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 JobsEvent Jobs
2 Chapter 1 System Client 0000

RA_SOLUTIONS RA SolutionRA Solution objects.

RESTART Restart IncludesRestart Includes for Jobs.
STYLESHEETS StylesheetsStylesheets for XML reports.
TEMPLATE Templates for objects.
TRAILER Trailer IncludesTrailer 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.
 Automation Engine 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 UserGroups
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.
 Automation Engine 5

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 UserGroups

You can assign right to Users and UserGroups. By using UserGroups you can reduce your administrative
efforts. UserGroups provide a clear overview from a central point and also increase security within your AE
system.

2. Assigning privileges

The various functions of the UserInterface can only be used with the appropriate privileges. With newly
created Users or UserGroups, all privileges are inactive.

Be careful when you assign privileges because some functions affect the processing of an AE system
or access security-relevant data. 

A list of all privilegesprivileges is provided in the UserGroup object's tab of the same name. Here you can
activate all or only specific particular privileges.

Privileges given to a particular user and the corresponding UserGroups accumulate. Users are granted
access to all the functions of the UserInterface that have been activated for them and the groups they
belong to.

For example:
User Smith is granted access to the Recycle Bin and to the Transport Case. Because he was granted the
privilege "Logon via CallAPI" in one of the user groups he belongs, he can also use CallAPIs.

3. Assigning rights

Access to folders, statistics, reports and objects is subject to authorizations. Note that servers and agents
are also objects. Again, newly created Users and UserGroups do not have any rights.

Be careful when you assign authorizations. You can also define access denials!

AuthorizationsAuthorizations 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 UserGgroups, 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!
6 Chapter 2 Authorization System

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 UserGroups 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 UserGroups, access to the particular section is not granted. The authorization
groups are irrelevant.

For example:
User Smith is authorized to execute Jobs on all hosts. One of the UserGroups he belongs to
contains a "Not" for accessing the agent UNIX01. Therefore, user Smith can not use this agent in
order to execute tasks.

Specify denials in the Authorizations tab with the authorization group "NOT".

4. Creating Users

After having specified UserGroups, you can create your individual Users. User-object names are
composed of the user name and department, both of which are separated by a slash (such as
SMITH/DEV). A maximum of 200 characters is allowed.

Now fill in the User tabUser 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 UserGroups. You can either select the groups to which a user
should belong to from within a user, or determine members from within a UserGroup. Both options are
accessible through the UserGroup tab.

6. 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 OverviewSystem
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
 Automation Engine 7

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:
8 Chapter 2 Authorization System

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 UserGroups 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.
 Automation Engine 9

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
10 Chapter 2 Authorization System

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

l "Write" - The agent can receive files (FileTransfer).
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 UserGroups, you can explicitly deny access to particular agents.
 Automation Engine 11

2.8 Passwords

2.8.1 User Passwords

Security is important for every AE system and user passwords are part of this complex area.

The longer and more complex they are structured, the less likely they will be decoded. The criteria to be
adhered to when specifying a password are defined in the variable UC_CLIENT_SETTINGS.

Criteria Setting
Maximum length PWD_LENGTH_MAX
Minimum length PWD_LENGTH_MIN
Numbers PWD_CONTAINS_NUMBER
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

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

AE provides a client which authenticates login data using LDAP via the Microsoft Active Directory. 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 currently supports the Microsoft Active Directory.

By default, the LDAP connection is not active.

Note that an LDAP login via the AE is not possible if the password includes characters that are not part
of the ISO 8859-15 code table (such as Chinese characters).
12 Chapter 2 Authorization System

A global setting activates the LDAP connection for an AE system. Whether a user is checked when
logging on either locally in the AE system or via the Active Directory depends on the settings made in the
particular User object. Thus, AE distinguishes local and LDAP users.

Procedure
First specify the connection data for your Active Directory.

1. Log on to system client 0000.

2. Switch to the folder "DIV_VARIABLES" and duplicate the variable UC_LDAP_EXAMPLE. There
are two methods for configuring the connection to your Active Directory:
l Method A: Name the copy "UC_LDAP_Domain". If the domain name is "SMITH", the
Variable name must be "UC_LDAP_SMITH".
l Method B: User object names are composed of name and department. The copy of the
variable can be renamed to "UC_LDAP_department". An extra variable is required for each
department. Using this method requires the domain to be specified in the key DOMAIN_
ALIAS.
3. Open the Variable and enter your connection data.
4. Store and close the Variable.

Now activate the LDAP connection for your AE system.

1. Open the variable UC_SYSTEM_SETTINGS and enter the value "Y" in the key "LDAP". This
global setting can be used to switch the LDAP connection on and off from one central point.

The LDAP connection is immediately active. No AE Server restart is required.

Activating the LDAP connection means that the AE system is ready to communicate with the Active
Directory. User objects have not yet changed. This is done by setting up the LDAP connection in User
objects:

1. Method A: The User object must have the same name as the User in the Active Directory. The
name is composed of the User name and the domain. For example, Mr. Smith uses the domain
"AE". He requires the User object "SMITH/AE". Create a new User object for yourself or rename
your existing one.
2. Open the User object and switch to the User tabUser tab.
3. Activate the checkbox "LDAP connection". The input fields whose contents should be checked by
the Active Directory are locked. The user is checked when the next login is made via LDAP
connection. The locked fields are filled with data from the Active Directory.
4. 4. You can test this using the button Synchronize data with LDAP now, but the synchronization
process only works if the operating user has already been synchronized via the LDAP connection.
This requires closing the UserInterface and logging on again.

 Information stored in the User object is only updated while logging on or when using the button
Synchronize data with LDAP now. There is no automatic synchronization.

Note that the person who synchronizes the data of a User object with LDAP must also be an
LDAP user. Persons using method B can only synchronize users of the same department.

The Active Directory does not use the second e-mail address. It can be used if required.
 Automation Engine 13

5. Store and close the User object.

6. Repeat all steps for other users.

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 checksExternal 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 Active Directory. When
you log on, the utility checks the data in the User object and not via the LDAP connection.

See also:

User
UC_LDAP_EXAMPLE
14 Chapter 3 Configuration

3 Configuration

3.1 Structure Of Configuration Files

3.1.1 Notes for Configuration-File Adjustments

Adjustments in INI files represent a significant intervention in the AE system and should therefore
exclusively be made by the administrator. Trace flags (activating program analysis) should only be used in
close cooperation with support and development staff.

All modifications made in INI files are only effective after program restart. Exception: No restart is
required for modifications made in the section [HOST] of the agents' INI files.

At least the parameters shown below must be supplied with values:

l 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
 Automation Engine 15

Server processes including their process numbers are defined in the INI file of the Automation Engine. At
the same time, Server processes are assigned port numbers which must be clearly defined for the entire
AE system.

Agent Names

The agent name is limited to 32 of the following characters: "A-Z", "0-9", "_", ".", "$", "@", "-" and "#". It
can be defined in its INI file using the parameter name=. The host name is used instead if this parameter
remains undefined.

Database Access

If an INI file contains information about the connection to the database (section [ODBC]), the appropriate
password should be encoded. Find the description on how to install and use the particular program
UCYBCRYP.EXE in the document "Encoding Passwords".

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.
16 Chapter 3 Configuration

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

 Automation Engine 17

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.

Allowed values: "0" and "1" (default value)

"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 keySTARTUP_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]
18 Chapter 3 Configuration

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

 Automation Engine 19

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

Default value: 120 seconds

chiffre= Encryption for transfer.

Allowed values: "0", "1" (default value)

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

Default value: (3,10)

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

Default value: 600 seconds

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.

Default value: 500 seconds

20 Chapter 3 Configuration

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.

Set this parameter only in close cooperation with Automic Support.

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

The default value that depends on the system environment is used when
you do not define this setting or when you define the value 0.

Set this parameter only in close cooperation with Automic Support.

 Automation Engine 21

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

The default value that depends on the system environment is used when
you do not define this setting or when you define the value 0.

Set this parameter only in close cooperation with Automic Support.

[PORTS]
cp1=  ... cpn= 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]
22 Chapter 3 Configuration

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).
 Automation Engine 23

[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.
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", "_", ".", "$", "@", "-" and "#".

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"

Set trace flags only in close cooperation with Automic Support.

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.

Default value: 60 seconds

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.
24 Chapter 3 Configuration

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.

Allowed values: "0", "1" (default value)

"0" - Database optimization off.

"1" - Database optimization on.
 Automation Engine 25

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
26 Chapter 3 Configuration

snmpreconnect=500
listenqueue=2030

[PORTS]
cp1=2217
cp2=2218
wp1=2271
wp2=2272
wp3=2273
wp4=2274
wp5=2275
wp6=2276
wp7=2277
wp8=2278
wp9=2279

[ODBC]
; ODBCVAR xxxxxxxx
; |||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
Z=DB2/OS390
; ||||||+- R=compress messages and local memory
; |||||+-- O = with userid, N = without userid
; ||||+--- I=OCI/CLI N=ODBC
; |||+---- not used
; ||+----- J = compare fieldnames case-insensitiv (in case of
ORACLE !!)
; |+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
; +------- S = use Server-Cursor (SQL-SERVER)
;
; SNNNNNRN for SQL-Server 2000
; NNNNNNRN for SQL-Server 2005
; NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
; NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)
; NNJNIORZ for DB2/OS390 (7.1) with CLI (Call Level Interface)

; SQL-Server 2000 with ODBC

SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; SQL-Server 2005 with MARS
;SQLDRIVERCONNECT=ODBCVAR=NNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4;Mars_
Connection=Yes
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4

[DB_SERVICE]
name=SQLVAR_01
InitialPackage=
KeyStore=
connect=60
 Automation Engine 27

retention_time=60
retry=3

See also:

Notes for Configuration-File Adjustments

3.1.3 UserInterface
UserInterface
The configuration file uc4config.xml is provided by default. It is stored in the same folder as the
UserInterface. You can also enter the path of an alternative configuration file by using the start parameter -I
in the INI file. Therefore, all users can create their own uc4config.xml with all their preferred personal
settings.

Environment variables can also be used in path specifications. Insert the following placeholders:

Windows: %Variable%
UNIX: $(Variable)

The UserInterface replaces the placeholders by the environment variable's value.

Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of uc4config.xml

Parameter Description
<configuration> 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", "hh"
"wh" = WebHelp
"hh" = HTML Help (only for Microsoft Windows)

"path" =  Directory in which the help system has been installed.

<browser This parameter is only required if you intend to use WebHelp.
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)
28 Chapter 3 Configuration

<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.
 Automation Engine 29

<SendBufferSize> Maximum number of bytes per block that the UserInterface sends to the
count Automation Engine.
</SendBufferSize>
"Number" = Maximum block size in bytes

Default value: 1048576

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

Default value: 1048576

<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 Color definition
saturation" g="green This is used to visualize the connection to a client in the UserInterface
saturation" b="blue (colored line underneath the title bars of windows).
saturation"/>
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.

Default value: 60 seconds

<tcpip_ Setting of keep alive packets in order to keep a connection (e.g. in WAN).
keepalive>connection
Allowed values: "0" and "1" (default value)
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_ Time in minutes in which the UserInterface sends messages to the
keepalive>time Automation Engine in order to keep the connection.
interval<active_
This parameter does not depend on <tcpip_keepalive>. The setting <tpcip_
keepalive>
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
30 Chapter 3 Configuration

<connection Definition of the connection to an AE 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="hh">C:\AUTOMIC\Documentation</docu>
        <logging count="10">..\temp\UCDJ_LOG_##.TXT</logging>
        <trace count="10" xml="0" tcp="0" ra="9">..\temp\UCDJ_TRC_
##.TXT</trace>
   </paths>
    <colors>
        <color b="0" g="0" r="255"/>
        <color b="0" g="255" r="0"/>
        <color b="255" g="152" r="42"/>
        <color b="0" g="255" r="255"/>
        <color b="0" g="144" r="255"/>
        <color b="255" g="0" r="255"/>
        <color b="255" g="255" r="255"/>
        <color b="149" g="140" r="170"/>
    </colors>
    <timeout>60</timeout>
    <tcpip_keepalive>0</tcpip_keepalive>
    <connections>
        <connection name="AE Production" system="AE">
            <cp ip="uc4prod" port="2217"/>
        </connection>
        <connection name="AE Test" system="AET">
            <cp ip="testsys" port="2217"/>
        </connection>
    </connections>
</configuration>
 Automation Engine 31

UserInterface
The configuration file login_dat.xml includes general login settings. Having successfully installed the
UserInterface, the system provides a default template from which you can create the templates for the
individual users. This is done when a user logs on to the AE system for the very first time. The values that
are stored in an individual template (including changed settings such as the language or the appearance of
the UserInterfaces) are then used as the particular user's default values and are stored whenever s/he logs
off.

Note that it is not required to adjust the configuration file manually because the individual values are
supplied by the AE system.

You can also specify the path to the file login_dat.xml by using the start parameter -O.

Structure of login_dat.xml

Section/Parameter Description
<login> 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.
An XML element must be available.
<login src="adm"> The definition for logging on to an AE system.
An XML element must be available.

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

An XML element must be available.

<client>n</client> Client number.
XML element must be available.

Allowed values: 0 - 9999

<name>name</name> User name.
An XML element must be available.
<department> 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.
An XML element must be available.

Allowed value: D
D = Dialog
32 Chapter 3 Configuration

<clientvers>v AE system version.

ersion</clientvers> XML element must be available.
<os/> Operating system.
An XML element must be available.
<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>.
An XML element must be available.
 Automation Engine 33

Example of login_dat.xml

<login>
<default>
<login src="adm">
<system>UC4</system>
<client>0</client>
<name>UC</name>
<department>UC</department>
<passw/>
<language>D</language>
<clienttype>D</clienttype>
<clientvers>10.0.0</clientvers>
<os/>
<hostname>dialogpc</hostname>
<color>color:255,255,0</color>
<laf>com.uc4.plaf.uc4.UC4LookAndFeel</laf>
</login>
</default>
<smith-Template>
<login src="adm">
<system>UC4</system>
<client>97</client>
<name>SMITH</name>
<department>UC4</department>
<passw/>
<language>E</language>
<clienttype>D</clienttype>
<clientvers>3.2B</clientvers>
<os/>
<hostname>dialogpc</hostname>
<color>color:42,152,255</color>
</login>
</smith-Template>
</login>

UserInterface (Windows)
You use the UCDJ.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

Section/Parameter Description
[GLOBAL]
34 Chapter 3 Configuration

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"

 Automation Engine 35

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
2. Connection to CPU3
3. Connection to CPU5

4. Connection to CPU1
5. Connection to CPU3
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):

1. Connection to CPU1
2. Connection to CPU3
3. Connection to CPU5

4. Connection to CPU2
5. Connection to CPU4
6. Connection to CPU6

7. Connection to CPU3
8. Connection to CPU5
etc.

After CPU31, counting continues at 0.

79. Connection to CPU27

80. Connection to CPU29
81. Connection to CPU31

82. Connection to CPU28

83. Connection to CPU30
84. Connection to CPU0

85. Connection to CPU29

86. Connection to CPU31
87. Connection to CPU1
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).
36 Chapter 3 Configuration

Example of an INI File

[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
 Automation Engine 37

 Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File x.xxx.UCXJB2?.INI

Section/Parameter Description
(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
Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
LICENCE_CLASS= License class that corresponds to the acquired license and the hardware
and software that is used.

Allowed values: "1" to "9"

"1" to "9" = Agent's license class
JOINREAD= Parameter that determines the password in BS2000 if there is no password
in the Login object.

Allowed values: "0" and "1" (default value)

"0" = Do not determine password.

"1" = Determine password.
38 Chapter 3 Configuration

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

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

This parameter is relevant for FileSystem events and the script

element GET_FILESYSTEM.
(AUTHORIZATION)
 Automation Engine 39

InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-
key file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file
ending *.kstr) or the path of the agent's 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 VariablesAgent 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.

The number signs serve as placeholders for a series in numerical order.

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=
Allowed values: "0" (default value) to "9"
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.
40 Chapter 3 Configuration

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"

"0" - No listen socket is created.

"1" - An additional listen socket is created on the local host.
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.

Default value: 240 seconds

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.

Default value: 60 seconds

CONNWAIT= Time interval in seconds during which the agent waits for a response from
the communication partner (CP or another agent). If the time limit is
exceeded, the connection to the communication partner will be terminated
again.

Default value: 20 seconds

CP= 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

 Automation Engine 41

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

Allowed values: "0" (default value) and "1"

"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" = User ID is evaluated. File Transfer is executed with the user's rights.
An additional Enter (RFC task) is also started in the respective User ID.
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 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:
Port number=DNS name
or
Port number=TCP/IP address
42 Chapter 3 Configuration

Example of an INI File

(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)
 Automation Engine 43

LOGON=0
PORT=2400
TIMEOUT=90
ENTERPAR=,JOB-PRIORITY=8,START=*STD,RESOURCES=*PAR(RUN-PRIORITY=248)
TASKTIMEOUT=900

(CP_LIST)
2218=PC01

Database Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCXJSQLX.INI

Section/Parameter Description
[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.

Allowed values: "E", "D", "F"

Default: "E,D" (primary: English, secondary: German)

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

language is searched for.
logging= 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.
44 Chapter 3 Configuration

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

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.
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.
helplib= Name of the message file.
[AUTHORIZATION]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-
key file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
 Automation Engine 45

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.

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.

The number signs serve as placeholders for a series in numerical order.

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.

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
tcp/ip= Trace flags of the agent.

Allowed values: "0" (default value) to "9"

Set trace flags only in close cooperation with Automic Support.

[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).
46 Chapter 3 Configuration

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.

Default value: 60 seconds

This parameter is only effective until the first successful logon to the AE
system has been made. Afterwards, you can use the parameter
RECONNECT_TIME in the Host Characteristics for this purpose.
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
[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"
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.
 Automation Engine 47

newline= Output of blank lines after tables that are used in reports.

Allowed values: "0" and "1" (default value)

"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.
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=
(section [TCP/IP]) is not included in the cp list.

Format:
Port number=DNS name
or
Port number=TCP/IP address
48 Chapter 3 Configuration

Example of an INI File

[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:
 Automation Engine 49

Notes for Configuration-File Adjustments

GCOS8 Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.

Structure of the INI File UCXJGC8I

Section/Parameter Description
[GLOBAL]
name= The 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.
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".
logcount= Number of stored log files.
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.

Allowed values: "1" to "9"

"1" to "9" = Agent's license class
language= Language that should be used for the logging. You can specify a primary and a
secondary language. 

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
userid_type= 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.
50 Chapter 3 Configuration

RSM= RSM8 must be installed in order to enable job report transfers to AE. If this
program is not available, the parameter RSM= should be used to avoid
that Jobs remain stuck. Without the use of RSM8, files containing some
basic information are created with the name of the job report.

Allowed values: "N" and "X"

"N" - A file is stored in the OUT catalog.

"X" - The first character of the job report's name is replaced by the letter "X".
The file is then stored in the OUT catalog.

Do not specify this parameter RSM= if RSM8 is used.

active_jobreport_ Maximum number of job reports that can be sent to the Automation Engine at
count= the same time.

Default value: "10"

ft_temp_file= Creates temporary files in file transfers.

Allowed values: "yes" (default value) and "no"

"yes" - The file obtains a temporary name which is composed of the letter "T"
and an alphabetic string originating from the RunID. The new FileTransfer
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.
[AUTHORIZATION]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's 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
 Automation Engine 51

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

Allowed values: "0" (default value) and "1"

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

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.

[TRACE]
file= Path and file name of the trace file.

The number signs serve as place holders for a series in numerical order.
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=
Allowed values: "0" (default value) to "9"
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
52 Chapter 3 Configuration

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.

Default value: 20 seconds

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.
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
job_check_count= Number of periodical job checks that the agent should wait when the job ends.
Only then the job is reported as vanished (ENDED_VANISHED status).

Allowed values: "0" - "32767"

Default value: "3"

"0" - The agent does not use this parameter.

[CP_LIST] 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 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:
Port number=DNS name
or
Port number=TCP/IP address
 Automation Engine 53

Example of an INI File

[GLOBAL]
system=uc4
name=GCOS8
logcount=4
logging=<catalog>/TMP/LOG##
language=(E,D)
helplib=<catalog>/bin/UCMSL
licence_class=1
; USERID Type = INCL/EXCL
userid_type=EXCL
ft_temp_file=yes

[AUTHORIZATION]
InitialPackage=
KeyStore=

[USERID]
;AUSTRIA=NO_START

[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=GCOS8
UC_EX_PATH_BIN=<catalog>/bin
UC_EX_PATH_TEMP=<catalog>/tmp/
UC_EX_PATH_JOBREPORT=<catalog>/out/
UC_EX_JOB_MD=<catalog>/build/UCXJGC8M

[HOSTS]
; <AE-name>=<dns-name> or
; <AE-name>=<ip-addr>

[TRACE]
; DON'T REMOVE THE TRACE FLAGS !!!

file=<catalog>/TMP/TRC##
trccount=4
tcp/ip=9
filetransfer=9
job=9
event=9
variable=9
controlflow=9
message=9
dump=9
misc=9
msgconv=0

[TCP/IP]
54 Chapter 3 Configuration

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

Notes for Configuration-File Adjustments

JMX Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.

Structure of UCXJJMX.INI

Section/Parameter Description
[GLOBAL]
name= 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= 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
always the one with the number "00".
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

Allowed values: "0", "1" (default values)

"0" = No log files are created.

"1" = Log files are created.
 Automation Engine 55

loadOnStartup= Start specification for the agent

Allowed values: "0", "1" (default value)

"0" - The agent must be started manually.

"1" - The agent starts when the Oracle WebLogic Server is started.
[AUTHORIZATION]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's 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.

Java agents (SAP, RA, database and JMX) that run under UNIX create a
keystore file with the following right: "-rw-r--r—". In doing so, other OS
users can also access this file.
[JMX]
type= 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.
56 Chapter 3 Configuration

[WEBSPHERE]
soapTimeout= Use this parameter to specify the seconds to wait for an MBean call
response. The job aborts if this time span is exceeded.

The agent uses WebSphere's default value if no value or "0" has been
specified.
[TRACE]
file= Path and file name of the trace file

The number signs serve as placeholders for a series in numerical order. 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".
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

Allowed values: "0" (default value) to "9"

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.

Default value: 60 seconds

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

Allowed formats:
DNS Name:Port number
TCP/IP Address:Port number
[VARIABLES] This section contains Agent Variables with agent information and settings.
 Automation Engine 57

[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 which has been 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
58 Chapter 3 Configuration

Example of an INI File

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

Notes for Configuration-File Adjustments

NSK Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.
 Automation Engine 59

Structure of the INI File UCXJNS1I

Section/Parameter Description
[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 FileTransfer, 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 FileTransfer should be entered here in

order to avoid problems that might occur when you convert network
addresses (for example, with a firewall).
[GLOBAL]
system= Name of the AE system.
This entry must be identical to 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.
logcount= Number of stored log files.
logging= Log-file name.

The number signs serve as placeholders for a series in numerical order. When
the agent starts, the log files are renamed and the most current log file is
always the one with number "00".
language= Language that should be used for the logging. You can specify a primary and a
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
helplib= Name of the message file.
licence_class= License class that corresponds to the acquired license and the hardware and
software that is used.

Allowed values: "1" to "9"

"1" to "9" = The agent's license class.
60 Chapter 3 Configuration

vhterm= 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.
 Automation Engine 61

MAX_OPEN_TABLE_ The number of files that jobs can open at the same time.
SIZE=
Allowed values: "0" to "32767"
Default value: 21000

This limitation serves to avoid problems that can occur if jobs open files but
do not close them because of an error in their JCL.
MAX_OPENS_PER_ The number of files that an individual job can open at the same time.
JOBS=
Allowed values: "0" to "32767"
Default value: 1000

This limitation serves to avoid problems that c can occur if jobs open files but
do not close them because of an error in their JCL.
ft_temp_file= This parameter creates temporary files in FileTransfers.
ft_temp_file_oss=
Allowed values: "yes" (default value) and "no"

"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 FileTransfer
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
successfully been transferred.
"no" - The agent assigns the final file name when the FileTransfer starts.

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
62 Chapter 3 Configuration

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]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's 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.
[VARIABLES] This section contains Agent Variables with agent information and settings.
[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.

The number signs serve as place holders for a series in numerical order.
When a trace is started, files are renamed and the most current trace file is
always the one with the number "00".
trccount= Number of stored trace files.
tcp/ip= Agent's trace flags.
filetransfer=
Allowed values: "0" (default value) to "9"
job=
event= Trace flags must only be used in close cooperation with Automic Support.
controlflow=
message=
dump=
misc=
msgconv=
[TCP/IP]
 Automation Engine 63

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

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"

"0" - No listen socket is created.

"1" - An additional listen socket is created on the local host.
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

This parameter is only effective until the first successful logon to the AE
system. Afterwards, the parameter RECONNECT_TIME in the Host
characteristics is used for this purpose.
report= Time interval in seconds in which the agent sends the logging to the
Automation Engine.

Default value: 60 seconds

cp= Address of the communication process in the AE system to which the agent
should connect itself.

Allowed formats:
DNS name:port number
TCP/IP address:port number
buffersize= Input-buffer size in bytes for file transfers.

Default value: 33000

For the input buffer, Automic recommends specifying 33000 bytes in

combination with TCP/IPv6 and 20000 bytes for the standard TCP/IP.
64 Chapter 3 Configuration

tcp_nodelay= Nagle algorithm usage for file transfers and all the agent's other sockets.

Allowed values: yes (default value) and no

no = Activates the Nagle algorithm.

yes = This procedure is not applied.

Activating the Nagle algorithm can improve the performance of file transfers,
especially if you transfer many small files.

The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.

Note that this parameter should only be set in close cooperation with Automic
Support!
tcp_keepalive= 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.
[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=
(section [TCP/IP]) is not included in the cp list.

Format:
Port number=DNS name
or
Port number=TCP/IP address
[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).

Example of an INI File

[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=
 Automation Engine 65

CPU_MASK=11111111111111111
MAX_OPENS_TABLE_SIZE=21000
MAX_OPENS_PER_JOBS=1000
ft_temp_file=yes
ft_temp_file_oss=no
TACL=$DATA01.SYSTEM.TACL
JOBFILE_SEC=JNNNN

[AUTHORIZATION]
InitialPackage=
KeyStore=

[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=NSK
UC_EX_PATH_BIN=$system.uc4
UC_EX_PATH_TEMP=$system.uc4tmp.
UC_EX_PATH_JOBREPORT=$system.uc4tmp.

[TRACE]
file=TRACA##
trccount=10
tcp/ip=0
filetransfer=0
job=0
event=0
controlflow=0
message=0
dump=0
misc=0
msgconv=0

[TCP/IP]
connwait=30
; agent's listen port
port=2300
; try all n seconds to connect to server
connect=30
report=60
cp=PC01:2217
buffersize=33000

[CP_LIST]
2218=PC01

[FT-STATUS-STORE]
FILENAME=$DATA02.UC4V9.UC4F6SST
DETAIL-FILENAME=$DATA02.UC4V9.UC4F6SSD
LOG-FILENAME=$DATA02.UC4V9.UC4F6SSL
HEAD-FILENAME=$DATA02.UC4V9.UC4F6SSH

See also:

Notes for Configuration-File Adjustments

66 Chapter 3 Configuration

OS/400 Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment re written in red letters.

Structure of the INI File UCXJO41

Section/Parameter Description
(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. 

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 is not defined. 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.
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
and a secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
helplib= The name of the message file.
LICENCE_CLASS= The license class that corresponds to the acquired license and the hard and
software that is used.

Allowed values: "1" to "9"

"1" to "9" = License class for the agent.
 Automation Engine 67

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.

Allowed values: "0" and "1" (default value)

"0" - The submitted job is not written to the log file.

"1" - The lines of the submitted job are written to the log file.
SBMMSK= 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.

Allowed values: "INCL", "EXCL"

"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 FileTransfersFileTransfers.

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

"no" - The agent assigns the final file name when the FileTransfer starts.
tcp_nodelay= Nagle algorithm usage for file transfers and all the agent's other sockets.

Allowed values: yes (default value) and no

no = Activates the Nagle algorithm.

yes = This procedure is not applied.

Activating the Nagle algorithm can improve the performance of file transfers,
especially if you transfer many small files.

The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.

Note that this parameter should only be set in close cooperation with Automic
Support!
68 Chapter 3 Configuration

store_type= You use this parameter to determine the locations where the status store files
of file transfers should be stored.

Allowed values: "QSYS" (default) or "IFS"

"QSYS" - The status store files are directly stored as user space objects in
the agent library.
"IFS" - The status store files are written to the IFS directory that is defined in
the agent variableagent variable UC_EX_PATH_TEMP_IFS.
(AUTHORIZATION)
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's 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 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 variablesvariables 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".
trccount= The number of stored trace files.
 Automation Engine 69

tcp/ip= The trace flags of the agent.

filetransfer=
Allowed values: "0" (default value) to "9"
job=
event= Trace flags must only be used in close cooperation with Automic Support.
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).

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 the local host (127.0.0.1).

Use this parameter together 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 time interval in seconds in which the agent tries to establish connection
to the Automation Engines. This affects the connection setup for a restart or
after a lost connection.

Default: 120 seconds

This parameter is only effective until the first successful logon to the AE
system. Afterwards, you can use the parameter RECONNECT_TIME in
the Host characteristics for this purpose.
maxrepcnt= 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.

Default value: 500 000

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

Default value: 1048576 Byte

70 Chapter 3 Configuration

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

Default value: 1048576 Byte

CP= The 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
(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.

(CP_LIST) A 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 connection in the chapter Multi-Server
Operation.

The communication process that has been 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
 Automation Engine 71

Example of an INI File

(GLOBAL)
SYSTEM=UC4
NAME=AS400
CheckLogon=1
logcount=10
logging=UC4/TMP(UCXJ_LOG##)
language=(E,D)
helplib=UC4/MSL
LICENCE_CLASS=9
spool=delete
dqname=DQ
console=QSYS/QSYSOPR
userid_type=EXCL
ft_temp_file_ifs=yes

(AUTHORIZATION)
InitialPackage=
KeyStore=

(USERID)
; MEIER=NO_START

(VARIABLES)
UC_HOST_CODE=EBCDIC_00273
UC_HOST_JCL_VAR=OS400
UC_EX_PATH_BIN=UC4
UC_EX_PATH_TEMP=UC4/TMP
UC_EX_PATH_JOBREPORT=UC4/TMP
UC_EX_JOB_MD=UC4/UCXJO41M

(HOSTS)
; <AE-name>=<dns-name> or
; <AE-name>=<ip-addr>

(TRACE)
file=UC4/TMP(UCXJ_TRC##)
trccount=10
tcp/ip=0
filetransfer=0
job=0
event=0
CONTROLFLOW=0
VARIABLE=0
MESSAGE=0
DUMP=0
MISCELLANEOUS=0

(TCP/IP)
72 Chapter 3 Configuration

port=2300
connect=120
maxrepcnt=8
CP=PC01:2217

(CP_LIST)
2218=PC01

See also:

Notes for Configuration-File Adjustments

People Soft Agent

Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCXJPSX.INI

Section/Parameter Description
[GLOBAL]
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.
system= Name of the AE system.
This entry must be identical to the entry in the Automation Engine's INI file.
language= Language that should be used for the logging. You can specify a primary and a
secondary language. 

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
logging= Path and file name of the log file

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.
helplib= Name of the message file.
 Automation Engine 73

helpcache= Availability of the messages and language dependant 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 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.

Allowed values: INCL, EXCL

"INCL" = Access must be allowed under [USERID] for each individual

Operator ID.
"EXCL" = The Operator IDs under [USERID] are not allowed. You can start
Jobs using one of the other Operator IDs.
UCXPWI3#= Dynamic link library that complies with the PeopleTools version that is used.

Allowed values: "1"

WRITE= You can use this parameter in order to specify the type of message transfer
(such as lines in reports). Note that individual transfers that include thousands
of lines negatively affect the performance of the Automation Engine).

Allowed values: "0" (default value), "1"

"0" - Messages are sent separately.

"1" - Messages are sent block by block every second.
WRITE_TIME= Interval in seconds during which blocks are sent.
[AUTHORIZATION]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's 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.
[STATUS_CHECK]
74 Chapter 3 Configuration

time= Internal timer cycle that can be used to check the status of a job compared to
PeopleSoft.

Default value: 1 second

The agent's internal job table is checked in this interval. It depends on a Job's
runtime whether a status check is made. The job is checked while it is running
at constantly increasing time intervals (the "time" value is doubled). These
intervals never exceed the value specified for the agent with JOB_
CHECKINTERVAL in the Host characteristics .

For example: time=1, JOB_CHECKINTERVAL=60

The job table is checked each second
Status check after: 1s, 2s, 4s,..., 60s, 60s....
[USERID] 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]
file= Path and file name of the trace file.

The number signs serve as placeholders for a series in numerical order. 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.
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

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 the local host (127.0.0.1).

Use this parameter together 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.
 Automation Engine 75

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.

Default value: 180 seconds

This parameter is only effective until the first successful logon to the AE
system. Afterwards, you can use the parameter RECONNECT_TIME in
the Host characteristics for this purpose.
report= Time interval in seconds in which the agent sends the logging to the
Automation Engine.

Default value: 60 seconds

CP= Address of the primary communication process in the AE system to which the
agent should connect itself.

Allowed formats:
DNS Name:Port number
TCP/IP Address:Port number
connwait= Time interval in seconds during which the agent waits for a response from the
communication partner (CP or another agent). If the time limit is exceeded,
the connection to the communication partner will be disconnected again.

Default value: 20 seconds

[VARIABLES] This section contains the Agent VariablesAgent 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.

Allowed values: "0" (default value) and "1"

"0" = Session ID
"1" = Process instance number
APPSERVER= Name or TCP/IP address of the application server and number of the JOLT
port.
76 Chapter 3 Configuration

LOG2UC4= You can use this parameter to add log files from processes of the
PeopleTools Process Scheduler Batch Server to the job reportjob report.

Allowed values: "0" (default value) and "1"

"0" = No log file is included in the job report. 

"1" = Log file is included n the job report.
DOMAIN_ 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.

Allowed values: "0" and "1"

"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.
[CP_LIST] List of communication processes.

This list is created when the agent starts and it is extended if new
communication processes are activated. You will find more detailed
information about establishing a connection in the chapter Multi-Server
Operation.

The communication process that has been 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
 Automation Engine 77

Example of an INI File

[GLOBAL]
name=HR7TEST
system=UC4
language=(E,D)
logging=..\TEMP\PS_LOGG_##.txt
logcount=5
helplib=uc.msl
helpcache=all
userid_type=EXCL
UCXPWI3#=1

[AUTHORIZATION]
InitialPackage=
KeyStore=

[STATUS_CHECK]
time=20

[USERID]
;PSDEMO=NO_START

[TRACE]
file=..\TEMP\PS_TRACE_##.txt
trccount=8
tcp/ip=0
jcl=0
database=0

[TCP/IP]
port=2545
connect=180
report=60
CP=PC01:2217
connwait=20

[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=PS
UC_EX_PATH_BIN=..\
UC_EX_PATH_TEMP=..\TEMP\
UC_EX_PATH_JOBREPORT=..\TEMP\
UC_EX_JOB_MD=
UC_EX_ERP_CONNECT=

[PS]
version=8.42
LANGUAGE_CD=ENG
78 Chapter 3 Configuration

OPRPSWD=0
PID=0
APPSERVER=//psserv01:9100
LOG2UC4=0

[PRCS_SBB_JAVA]
enabled=1
Version=V0.001
classes=\\hostname\Psoft\HR800\web\PSJOA\psjoa.jar;\\hostname\Psoft\HR800\w
eb\PSJOA\

[PSCONFIG]
PSNT=\\psserv01\appserv\prcs\PSHR800\psprcs.cfg
PSUNX=\\psserv01\appserv\prcs\PSHR800\psprcs.cfg

[GENPRCSTYPE]
0=OTH
1=SQR
2=CBL
3=CRW
4=WRD
5=AE
6=CUBE
7=NVS

[PSOPRPSWD]
UC4=UC4

[CP_LIST]
2218=PC01

See also:

Notes for Configuration-File Adjustments

RA Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.

Structure of UCXJCITX.INI

Section/Parameter Description
[GLOBAL]
 Automation Engine 79

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.

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
This entry must be identical to the entry in the INI file of the Automation
Engine.
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
always the one with the number "00".
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
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.

Allowed values: "0" and "1" (default value)

"0" = Registered files are not checked.

"1" = Registered files are checked.
[AUTHORIZATION]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
80 Chapter 3 Configuration

KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's 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.

Java agents (SAP, RA, database and JMX) that run under UNIX create a
keystore file with the following right: "-rw-r--r—". In doing so, other OS
users can also access this file.
[RA]
cache_directory= Directory to which the agent should store the RA SolutionsRA Solutions.
[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. Affects the connection setup for a restart or after
a lost connection.

Default value: 60 seconds

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

Allowed formats:
DNS Name:Port number
TCP/IP Address:Port number
[VARIABLES] This section contains Agent VariablesAgent Variables with agent information
and settings.
[TRACE]
file= Path and file name of the trace file

The number signs serve as placeholders for a series in numerical order. 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".
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.
 Automation Engine 81

tcp/ip= Trace flag of the agent

Allowed values: "0" (default value) to "9"

Set trace flags only in close cooperation with our support team.
ra= Trace flag of the Rapid Automation agent

Allowed values: "0" (default value) to "12"

"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

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 which has been 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
82 Chapter 3 Configuration

Example of an INI File

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

Notes for Configuration-File Adjustments

SAP Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCXJR3X.INI

Section/Parameter Description
[GLOBAL]
name= Agent name.

The agent name is limited to 32 of the following characters: A-Z, 0-9, _, ., $,

@, - and #.

The host name is used if this parameter remains undefined. Lowercase

letters are converted to uppercase letters.
Hyphens ("-") are only allowed in agent names. They must not be used in the
names of any other objects.
 Automation Engine 83

system= The name of the AE system.

This entry must comply with the entry that is made in the Automation
Engine's INI file.
language= The language that should be used for the logging. You can specify a primary
and a secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
logging= The path and file name of the log file.

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= The number of stored log files.

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.

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

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.
helplib= The name of the message file.
helpcache= The availability of 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 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).
84 Chapter 3 Configuration

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.

Default value: 600 seconds

Console Events monitor Events that have been triggered in SAP. If the agent
loses its connection to the SAP system, several SAP Events can accumulate
that the agent cannot forward to the Console Events. As soon as the
connection has been re-established, the agent checks again and reports
these SAP Events to the relevant Console Events.

The agent does not read all SAP Events at once because a large amount of
data might be involved. Each SAP Event is triggered at a particular point in
time. The agent retrieves all SAP Events that have been triggered during the
connection loss from the SAP Event history. It uses the interval that has been
defined using the parameter maxEventTimeStamp=.

For example:

The value for maxEventTimeStamp= is set to 600. This value corresponds to

10 minutes. The JOB_CHECKINTERVAL is 60 which corresponds to 1
minute. The agent is not connected to the SAP system between 10:00 and
10:30. SAP Events that have been triggered during this time are retrieved as
shown below:

SAP Events between 10:00 and 10:10 are retrieved at 10:30.

SAP Events between 10:10 and 10:20 are retrieved at 10:31.
SAP Events between 10:20 and 10:30 are retrieved at 10:32.
SAP Events between 10:30 and 10:33 are retrieved at 10:33.
SAP Events between 10:33 and 10:34 are retrieved at 10:34
etc.
joblog_blocksize= 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.
 Automation Engine 85

userid_type= This is an additional parameter that allows to allow or reject particular users.

Allowed values: INCL, EXCL

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]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
86 Chapter 3 Configuration

KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's 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.

Java agents (SAP, RA, database and JMX) that run under UNIX create a
keystore file with the following right: "-rw-r--r—". In doing so, other OS
users can also access this file.
[USERID] 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]
Enabled= Interface usage.

Allowed values: 0 (default value) and 1

0 - The interface is not used.

1 - The interface is used.
[SAP_BCA]
Enabled= Interface usage.

Allowed values: 0 (default value) and 1

0 - The interface is not used.

1 - The interface is used.
[SAP_BASIS]

Version= 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
 Automation Engine 87

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

The number signs serve as placeholders for a series in numerical order. 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= The number of stored trace files.

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.

Default value: 1000 KB

tcp/ip= The trace flag for TCP/IP communication of the agent.
jcl=
Allowed values: 0 (default value) to 9

rfc= RFC trace.

Allowed values: 0 (default value) to 9

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=
88 Chapter 3 Configuration

connect= The 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.

Default value: 60

This parameter is only effective until the first successful logon to the AE
system. Afterwards, you can use the parameter RECONNECT_TIME of
the Host characteristics for this purpose.
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:
DNS Name:Port number
TCP/IP Address:Port number
[VARIABLES] This section includes agent variables that contain agent settings and
information.
[CP_LIST] A list of communication processes.

This list is created when the agent starts and extended when new
communication processes are activated. You will find more detailed
information about establishing a connection in the chapter Multi-Server
Operation.

The communication process that has been 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
 Automation Engine 89

Example of an INI File

[GLOBAL]
name=SAP01
system=UC4
language=(E,D)
logging=..\TEMP\UCXJR3X_LOGG_SID_##.TXT
logcount=10
helplib=uc.msl
helpcache=ALL
lower_case=NO
maxEventTimeSpan=600
joblog_blocksize=0

[AUTHORIZATION]
InitialPackage=
KeyStore=

[SAP_BW]
Enabled=0

[SAP_XI]
Enabled=1

[SAP_BCA]
Enabled=0

[TRACE]
file=..\TEMP\UCXJR3X_TRACE_##.TXT
trccount=10
tcp/ip=0
jcl=
rfc=0

[TCP/IP]
bindaddr=
bindlocal=0
connwait=20
connect=60
report=60
cp=uc4srv01:2217

[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=SAP
UC_EX_PATH_BIN=C:\AUTOMIC\AGENTS\SAP\BIN\
UC_EX_PATH_TEMP=C:\AUTOMIC\AGENTS\SAP\TEMP\
UC_EX_PATH_JOBREPORT=C:\AUTOMIC\AGENTS\SAP\TEMP\
UC_EX_JOB_MD=

[CP_LIST]
22187=PC01 
90 Chapter 3 Configuration

See also:

Notes for Configuration-File Adjustments

Siebel Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCXJSLX.INI

Section/Parameter Description
[GLOBAL]
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.
system= Name of the AE system.
This entry must comply with the entry in the INI file of the Automation Engine.
language= Language that should be used for the logging. You can specify a primary and a
secondary language. 

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
logging= Path and file name of the log file.

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

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.
helplib= Name of the message file.
helpcache= Availability of the messages and language dependant 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 for the
display of the dialog program are held in the RAM (not relevant for the agent).
 Automation Engine 91

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

Allowed values: "0" (default value), "1"

"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]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's 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.
[STATUS_CHECK]
time= This is the system-internal timer cycle that checks the status of a job
compared to SAP.

Default value: 1 second

The agent's internal job table is checked in this interval. Whether the Job's
status is checked depends on its runtime. The job is checked while it is
running at constantly increasing time intervals (the "time" value is doubled).
However, these intervals never exceed the value that is specified for the
agent in the parameter JOB_CHECKINTERVAL in the Host characteristics.

For example: time=1, JOB_CHECKINTERVAL=60

The job table is checked each second.

Status check after: 1s, 2s, 4s,..., 60s, 60s....

[TRACE]
92 Chapter 3 Configuration

file= Path and file name of the trace file.

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

The number signs serve as placeholders for a series in numerical order. 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.
tcp/ip= Trace flags for TCP/IP communication of the agent.
filetransfer=
Allowed values: "0" (default value) to "9"
mail=
Trace flags must only be used in close cooperation with Automic Support.
[TCP/IP]
port= Port number of the agent.
Other agents and the job messenger establish connection with the agent via
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
particular IP address (e.g. 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"

"0" - No listen socket is created.

"1" - An additional listen socket is created on the local host.
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.

Default value: 60 seconds

This parameter is only effective until the first successful logon to the AE
system. Afterwards, you can use the parameter RECONNECT_TIME in
the Host characteristics.
report= Time interval in seconds in which the agent sends the logging to the
Automation Engine.

Default value: 60 seconds

SendBufferSize= Size of the TCP/IP input buffer for messages that should be sent.
RecvBufferSize= Size of the TCP/IP input buffer for messages that should be received.
 Automation Engine 93

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
connwait= Time interval in seconds during which the agent waits for a response from the
communication partner (a CP or another agent). If the time limit is exceeded,
the connection to the communication partner will be terminated again.

Default value: 20 seconds

[VARIABLES] This section contains agent variablesagent 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.

Allowed values: "0" and "1"

"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".
[CP_LIST] List of communication processes.

This list is created when the agent starts and extended when new
communication processes are activated. You will find more detailed
information about establishing a connection in the chapter Multi-Server
Operation.

The communication process that has been 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
94 Chapter 3 Configuration

Example of an INI File

[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_CODE=UC_CODE
UC_HOST_JCL_VAR=SIEBEL
UC_EX_PATH_BIN=.
UC_EX_PATH_TEMP=..\temp\
UC_EX_PATH_JOBREPORT=..\temp\
UC_SIEBEL_SRVRMGR=C:\siebel\srvrmgr.exe
UC_SIEBEL_LOGPATH=C:\siebel\siebelLOGS\

[SIEBEL]
DELIMITER=*
 Automation Engine 95

[CP_LIST]
2218=PC01

See also:

Notes for Configuration-File Adjustments

UNIX Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

The INI-file sections [USERID] and [UC_USER] only affect UNIX jobs. They do not affect
FileTransfers or FileSystem Event objects.

The following is valid for the target host: Regardless of the parameters that have been set the UNIX
agent also considers links in file paths. The following conditions apply:

l 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

Section/Parameter Description
[GLOBAL]
name= The 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.
system= The name of the AE system.
This entry must comply with the entry in the Automation Engine's INI file.
logging= The path and file name of the log file.

The xxx characters in the file name are placeholders. They stand for the
three-digit abbreviation of the respective UNIX version. See: Terminology

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= The number of stored log files.
helplib= The name of the message file.
96 Chapter 3 Configuration

licence_class= The license class that corresponds to the acquired AE license and the
hardware and software that you use.

Allowed values: 1-9, S, V

1 - 9 = The agent's license class.
S = The agent that is used for administration tasks on the Server
computer.
V = The agent's virtual license class.
language= The language that should be used for the logging. You can specify a
primary and a secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
open_file_max= Sets the users 'open file descriptor' limit. A value of 0 forces the agent to
set the users soft limit to the existing users hard limit. A value not equal to
0 forces the agent to set the soft limit and the hard limit to that value. If the
value exceeds the users existing hard limit, the agent even sets that value,
if it is operated with root privileges. If the value exceeds the users existing
hard limit and the agent is not operated with root privileges, the agent
cannot exceed the hard limit and sets the users soft limit to the users hard
limit.

Default value: 32768

userid_type= 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. We recommend keeping this time period short.

Default value: 30 seconds

login_check= Password check.

Allowed values: yes and no (default value)

See: Description of the settings ANONYMOUS_FT and ANONYMOUS_

JOB in the AE Variable UC_HOSTCHAR_DEFAULT).
 Automation Engine 97

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

Allowed values: yes and no (default value)

yes = The agent always reads the [USERID] section before a job starts.
no = The agent reads this section only once when the agent starts.
KillSignal= The signal that is sent to the job if it is canceled through the UserInterface.

Allowed values: SIGTERM, SIGABRT and SIGKILL (default value)

SIGTERM - The job is terminated (15).

SIGABRT - The job is canceled (6)
SIGKILL - The job ends immediately (9).
ft_temp_file= This parameter creates temporary files in FileTransfers.

Allowed values: yes (default value) and no

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
FileTransfer 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 FileTransfer starts.
98 Chapter 3 Configuration

tcp_nodelay= Nagle algorithm usage for file transfers and all the agent's other sockets.

Allowed values: yes (default value) and no

no = Activates the Nagle algorithm.

yes = This procedure is not applied.

Activating the Nagle algorithm can improve the performance of file

transfers, especially if you transfer many small files.

The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.

Note that this parameter should only be set in close cooperation with
Automic Support!
FileProcessingTimeout= The 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.

This parameter is relevant for FileSystem events and the script

element GET_FILESYSTEM.
[AUTHORIZATION]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-
key file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
 Automation Engine 99

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] 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 whether the agent should
transfer linked files of the source or ignore them.

Allowed values:
"yes" - Links will be de-referenced and the files to which the links are
pointing to will be transferred.
"no" (default) - Links will be ignored.

Executing a wildcard file transfer with "no" as a value may result in the
transfer being set to ENDED_EMPTY, in case there are only links in
the source directory.
[VARIABLES] This section contains the Agent Variables that include agent settings and
information.
[TRACE]
100 Chapter 3 Configuration

file= The path and the file name of the trace file.

The xxx characters in the file name are placeholders. They stand for the
three-digit abbreviation of the respective UNIX version. See:Terminology

The number signs serve as placeholders for a series in numerical order.

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 the stored trace files.
tcp/ip= The trace flags of the agent.
event=
Allowed values: 0 (default value) to 9
job_debug=
ft_debug= Trace flags must only be used in close cooperation with Automic
ex_init= Support.
signal=
mail=
memory=
[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.

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

Alternately, you can also specify the IP address or host name in port=

(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.
 Automation Engine 101

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.

Default value: 60 seconds

maxrepcnt= The maximum number of report blocks that should be transferred to the
Automation Engine at the same time.

Default value: 8 blocks

maxMsgSize= Maximum length of messages (in bytes) that the agent accepts.

Default value: 500 000

cp= The 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
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).

Bytes are used by default. Alternately, you can also append the letter "K"
or kilobytes or "M" for megabytes to the number. You can use uppercase or
lowercase letters for this purpose.

Default value: 1 Mbyte

[MISC]
102 Chapter 3 Configuration

FileBufferSize= Size of the input buffer for files that are transferred with a FileTransfer
object (MB, KB or bytes).

Bytes are used by default. Alternately, you can also append the letter "K"
or kilobytes or "M" for megabytes to the number. You can use uppercase or
lowercase letters for this purpose.

Examples (the following definitions are identical):

Specification in bytes: 1048576
Specification in Kbytes: 1024K or 1024k
Specification in Mbytes : 1M or 1m

Default value: 0 (The OS setting is used).

authentification= Authentication method for the login data in the Login objects of the Jobs
and FileTransfers.

Allowed values: local (default) and PAM

local = OS calls
PAM = Pluggable Authentication Modules (see also: parameter Libname=)

PAM authentication is only supported for Agents that run on AIX, Linux
and Sun Solaris.
TraceFileSize= The maximum size of a trace file. The agent creates a new file if this value
has been reached.

Bytes are used by default. Alternately, you can also append the letter "K"
or kilobytes or "M" for megabytes to the number. You can use uppercase or
lowercase letters for this purpose.
FileEndDelimiter= This adds a line breack (LF) at the end of text files that have been sent
using a FileTransfer.

Allowed values: "yes" and "no" (default value)

"yes" - The agent always adds an LF to the end of text files in FileTransfers
in which it is the receiving agent.e It is irrelevant whether the files already
end with an LF.
"no" - The files are transferred without any changes.
processinfo= 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.

 Automation Engine 103

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= The name of the PAM library.

Specify the library name if the PAM authentication method should 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.
You can use this line if Jobs should be started with a batch command.
Korn_Shell= Shell options for starting Jobs under Korn Shell.
You can use this line if Jobs should be started with a batch command.
Other_Shell= Shell options for starting Jobs under any Shell.
You can use this line if Jobs should be started with a batch command.
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.
104 Chapter 3 Configuration

[CP_LIST] List of communication processes.

This list is created when the agent starts and it is extended when new
communication processes are activated. You will find more detailed
information about establishing a connection in the chapter Multi-Server
Operation.

The communication process that is defined in the parameter cp= (  

[TCP/IP] section) is not included in the cp list.

Format:
Port number=DNS name
or
Port number=TCP/IP address
 Automation Engine 105

Example of an INI File

[GLOBAL]
name = UNIX01
system = AE
logging = ../temp/UCXJxxx.l##
logcount = 10
helplib = ucx.msl
licence_class = V
language = e,d
userid_type = EXCL
UC_user_type = EXCL
; rcv_block = yes
; rcv_max = 30
login_check=yes
ReportMode=600
JobFileMode=700
ReadUserAlways=no
KillSignal=SIGKILL
ft_temp_file=yes

[AUTHORIZATION]
InitialPackage=
KeyStore=

[USERID]
;root = NO_START

[UC_USER]
; 6 = START
; 7 = NO_START

[FILETRANSFER]
; ft_check_free_disk_space=yes
; standard : ft_check_free_disk_space=no
; FT_Linkfiles=yes
; standard FT_Linkfiles=no

[VARIABLES]
UC_HOST_CODE = UC_CODE
UC_HOST_JCL_VAR = UNIX
UC_EX_PATH_BIN = ./
UC_EX_PATH_JOBREPORT = ../out/
UC_EX_PATH_TEMP = ../temp/
UC_EX_JOB_MD = ucxjxxxm

[TRACE]
file = ../temp/UCXJxxx.t##
trccount = 10
tcp/ip = 0
106 Chapter 3 Configuration

event = 0
job_debug = 0
ft_debug = 0
ex_init = 0
signal = 0
mail = 0

[HOSTS]
; <name>=<dns-name> or
; <name>=<ip-addr>

[TCP/IP]
port = 2220
alarm = 30
maxrepcnt = 8
cp = PC01:2217

[MISC]
authentification=PAM
FileEndDelimiter=yes
processinfo=yes

[PAM]
Libname=libpam.so
pam_open_session=yes

[STARTCMD]
; start_type = batch
; Bourne-Shell = nohup batch < \`su - &user -c "&jobFile 1>> &jobReport
2>&1"\`&
; C-Shell = nohup batch < \`su - &user -c "&jobFile >>& &jobReport"\`&
; Korn Shell = nohup batch < \`su - &user -c "&jobFile 1>> &jobReport
2>&1"\`&
; Other-Shell = nohup batch < \`su - &user -c "&jobFile 1>> &jobReport
2>&1"\`&
; Only for SunOS 5.4 (US4):
; [STARTCMD]
; Bourne-Shell = batch < \`su - &user -c "nohup &jobFile >> &jobReport
2>&1"\`&
; C-Shell = batch < \`su - &user -c "nohup &jobFile >>& &jobReport"\`&
; Korn Shell = batch < \`nohup su - &user -c "&jobFile >>& &jobReport
2>&1"\`&
; Other-Shell = batch < \`nohup su - &user -c "&jobFile >>& &jobReport
2>&1"\`&

[CP_LIST]
2218=PC01
 Automation Engine 107

See also:

Notes for Adjusting Configuration Files

VMS Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCXJV??.INI

Section/Parameter Description
[GLOBAL]
name= The 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.
system= The name of the AE system.
This entry must be identical to the entry in the INI file of the Automation
Engine.
logging= The path and the file name of the log file.

The characters xx in the file names are placeholders. They stand for the two-
digit abbreviation of the respective VMS version. See: Terminology.

The number signs serve as place holders for a series in numerical order.
When starting the agent, the log files are renamed so that the most current log
file is always the one with the number "00".
logcount= The number of stored log files.
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.

Allowed values: "1" to "9"

"1" to "9" = License class of the agent
language= The language that should be used for the logging. You can specify a primary
and a secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
108 Chapter 3 Configuration

userid_type= Additional possibility of the operating system to allow or reject certain users.

Allowed values: "INCL", "EXCL"

"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
other users can start Jobs.
UC_user_type= You can allow or reject certain AE Users.

Allowed values: "INCL", "EXCL"

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

Default value: 30 seconds

uc4_logical= The definition of the logical name (entries are converted to uppercase letters).

If this parameter is not specified, the logical name is created as shown below:
UC4_AE system name_Agent name_Agent
ReadUserAlways= You can allow or reject User IDs by using the parameter userid_type= in the
[USERID] section. You can use the parameter ReadUserAlways= in order to
specify whether this section should always be read before a job starts or only
once when the agent starts. Reading this section only once improves the
performance of your system and is therefore the default value. 

Allowed values: yes and no (default value)

yes = The agent always reads the [USERID] section before a job starts.
no = The agent reads this section only once when the agent starts.
ft_temp_file= This creates temporary files in FileTransfersFileTransfers.

Allowed values: "yes" (default value) and "no"

"yes" - The file obtains a temporary name which is composed of the letter "T"
and an alphabetic string that stems from the RunID.The new FileTransferr
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.
"no" - The agent assigns the final file name when the FileTransfer starts.
 Automation Engine 109

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!
[AUTHORIZATION]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's 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 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
110 Chapter 3 Configuration

[VARIABLES] This section contains Agent VariablesAgent 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]
file= The path and the file name of the trace file.

The characters xx in the file name are place holders. They stand for the two-
digit abbreviation of the respective VMS version. See:Terminology.

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 always the one with the number "00".
trccount= The number of stored trace files.
tcp/ip= Trace flags of the agent
event=
Allowed values: "0" (default value) to "9"
job_debug=
ft_debug= Trace flags must only be used in close cooperation with Automic Support.
ex_init=
signal=
memory=
[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.

[TCP/IP]
 Automation Engine 111

port= The agent's port number.

Other agents and the job messenger establish connection with the agent via
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

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"

"0" - No listen socket is created.

"1" - An additional listen socket is created on the local host.
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.

Default value: 60 seconds

maxrepcnt= The maximum number of report blocks that should be transferred to the
Automation Engine simultaneously.

Default value: 8 blocks

maxMsgSize= Maximum length of messages (in bytes) that the agent accepts.

Default value: 500 000

tcp_keepalive_time= The time interval in seconds in which packets are sent in order to keep
connections.

The default value that depends on the system environment is used when you
do not define this setting or when you define the value 0.

This parameter has no effect when the agent runs under VAX.
cp= Address of the communication process in the AE system to which the agent
should connect itself.

Allowed formats:
DNS Name:Port number
TCP/IP Address:Port number
[STARTCMD]
112 Chapter 3 Configuration

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 FileTransfers

Allowed values: "alq", "deq", "mbc", "mbf" and "fop"

"alq" = Number of disk blocks used for the FileTransfer 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 FileTransfer execution. File
attributes can be changed while the agent is running.

If you specify the file attributes directly in the FileTransferFileTransfer, 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_
FILENAMEPREP_PROCESS_FILENAME and wildcard FileTransfer. Use
this parameter in order to specify whether the agent should leave the file name
unchanged or convert it to lowercase letters.

Allowed values: "yes" and "no" (default value)

"yes" - File names are always converted to lowercase letters.

"no" - The agent does not adjust the file name's spelling.
 Automation Engine 113

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

In VMS, each text file requires a line break at its end.

Allowed values: "yes" (default value) and "no"

"yes" - In FileTransfers, the agent always appends a LF to the end of text files
when it is the receiving agent. It is irrelevant whether the files already end with
a LF.
"no" - The files are transferred without any changes.
[CP_LIST] 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 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:
Port number=DNS name
or
Port number=TCP/IP address
114 Chapter 3 Configuration

Example of an INI File

[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]
; <AE-name>=<dns-name> or
; <AE-name>=<ip-addr>
 Automation Engine 115

[TCP/IP]
port = 2220
alarm = 30
maxrepcnt = 8
cp = PC01:2217

[STARTCMD]
SUBMIT = submit &jobFile /LOG=&jobReport /USER=&user
ACCESS = alq=5000,deq=5000,mbc=64,mbf=64

[JOBREPORT]
;reportname = [-.report]&vms-jobname_&client_&userid_&AE-jobname_
&runnr.log
;reportname = [uc4.uc100e.exekutor.report.&userid]&vms-jobname.log

[MISC]
FileNameLowerCase=no
TraceFileSize=32M
FileEndDelimiter=yes

[CP_LIST]
2218=PC01

See also:

Notes for Configuration-File Adjustments

Windows Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCXJWI3.INI (32-bit) / UCXJWX6.INI (64-bit)

Section/Parameter Description
[GLOBAL]
name= The 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.
system= The name of the AE system.
This entry must be identical to the entry in the Automation Engine's INI file.
116 Chapter 3 Configuration

logon= The settings for the execution of jobs / file transfers.

Allowed values: "0", "1" (default value)

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.

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
logging= The path and the file name of the log file.

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

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= The number of stored log files.
helplib= The name of the message file.
helpcache= The 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-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.
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.

 Automation Engine 117

userid_type= An additional opportunity for the OS to allow or reject access to certain

users.

Allowed values: INCL, EXCL

"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
other users can start jobs.
useJobObject= The setting Jobs starts in a Windows Job object. The value that are
defined here serves as the default value for all AE Jobs under Windows. A
setting that should apply for a particular job can be specified in the Job tab.

Allowed values: "0" and "1"

"0" - The Windows Job object is not used.

"1" - The Windows Job object is used. More information about the job and
its sub-Jobs is available. The improved restart options are an advantage.
Note that the AE job will only end when all sub-Jobs have ended.
HomeDirCache= You can use this parameter to determine whether the home directory of the
Login user is stored.

Specify a period of time (in minutes) after which the agent should store the
name of the home directory. This will increase performance. If you use "0",
this information is not stored.

Default value: 10 minutes

Note that any changes that are made in the home directory only
become effective after the specified period of time.
ft_temp_file= This parameter creates temporary files in FileTransfers.

Allowed values: "yes" (default value) and "no"

"yes" - The file obtains a temporary name which is composed of the letter
"T" and an alphabetic string originating from the RunID. The new
FileTransferr 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.
"no" - The agent assigns the final file name when the FileTransfer starts.
ft_check_free_disk_space This parameter checks the available hard disk space before a file transfer
= is processed.

Allowed values:
"y" - The system checks whether there is sufficient hard disk space for the
files that should be transferred. The files will only be transferred when there
is enough space. Otherwise, the file transfer will abort with an error
message.
"n" (default) - No check is made.

Checking the available space of network drives may occasionally lead

to an incorrect result.
118 Chapter 3 Configuration

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)
tcp_nodelay= Nagle algorithm usage for file transfers and all the agent's other sockets.

Allowed values: yes (default value) and no

no = Activates the Nagle algorithm.

yes = This procedure is not applied.

Activating the Nagle algorithm can improve the performance of file

transfers, especially if you transfer many small files.

The BS2000 agent always uses the Nagle algorithm. Therefore, it does not
include this INI-file parameter.

Note that this parameter should only be set in close cooperation with
Automic Support!
FileProcessingTimeout= The 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.

This parameter is relevant for FileSystem events and the script

element GET_FILESYSTEM.
[AUTHORIZATION]
 Automation Engine 119

InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-
key file cannot be found.

When the agent starts, it reads the company-key file and stores its
information in the file that is specified in the parameter KeyStore=. The first
file is deleted afterwards.
KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file
ending *.kstr) or the path of the agent's 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.
[STATUS_CHECK]
time= The internal timing cycle in which the system checks whether the job has
already ended (provided that it runs in a Windows Job object).

Default value: 1 second

The agent's internal job table is checked in this interval. It depends on a

Job's runtime whether a status check is made. The job is checked during
its execution at ever increasing time interval (doubling the value "time").
These intervals never exceed the value specified for the agent with JOB_
CHECKINTERVAL in the Host characteristics.

For example: time=1, JOB_CHECKINTERVAL=60

The job table is checked each second
Status check after: 1s, 2s, 4s,..., 60s, 60s....
[USERID] 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]
file= The path and the file name of the trace file.

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

The number signs serve as placeholders for a series in numerical order.

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= The number of stored trace files.
120 Chapter 3 Configuration

tcp/ip= The trace flags for the TCP/IP communication of the agent .
filetransfer=
Allowed values: "0" (default value) to "9"
event=
mail= Trace flags must only be used in close cooperation with Automic
compress= Support.
memory=
[TCP/IP]
port= The agent's port number.
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.

Use this parameter when 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 the local host (127.0.0.1).

Use this parameter together 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 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 value: 60 seconds

This parameter is only effective until the first successful logon to the
AE system. Afterwards, you can use the parameter RECONNECT_
TIME in the Host characteristics.
report= The time interval in seconds in which the agent sends the logging to the
Automation Engine.

Default value: 60 seconds

maxMsgSize= Maximum length of messages (in bytes) that the agent accepts.

Default value: 500 000

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
SendBufferSize= The size of the TCP/IP input buffer for messages that should be sent
(Byte).

Default value: 1048576 Byte

 Automation Engine 121

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

Default value: 1048576 Byte

TcpKeepAliveTime= Used to set TcpKeepAlive on socket level of the operating system.

Default value: yes

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

[CP_LIST] The 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 connectionin 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
[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.
122 Chapter 3 Configuration

Example of an INI File

[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_CODE=UC_CODE
UC_HOST_JCL_VAR=WINDOWS
UC_EX_PATH_BIN=.
UC_EX_PATH_TEMP=C:\AUTOMIC\AGENT\WINDOWS\TEMP\
UC_EX_PATH_JOBREPORT=C:\AUTOMIC\AGENT\WINDOWS\TEMP\
UC_EX_JOB_MD=C:\AUTOMIC\AGENT\WINDOWS\BIN\UCXJWxxM.EXE

[TRACE]
file=..\TEMP\UCXJWxx_TRACE_##.TXT
trccount=10
tcp/ip=0
filetransfer=0
event=0
mail=0
compress=0

[TCP/IP]
port=2300
connect=60
 Automation Engine 123

cp=PC01:2217
TcpKeepAliveTime=yes

[HOSTS]
; <AE-name>=<dns-name> or
; <AE-name>=<ip-addr>

[CP_LIST]
2218=PC01

See also:

Notes for Configuration-File Adjustments

z/OS Agent
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.

Structure of the INI File UCXJM25.INI

Section/Parameter Description
(GLOBAL)
system= Name of the AE system.
This entry must be identical to the entry made 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.
language= Language that should be used for the logging. You can specify a primary and a
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a

message in the secondary language.
124 Chapter 3 Configuration

logging= 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))
logcount= Number of stored log files.
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.
helplib= Name of the message file.
helpcache= Availability of 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 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 AE license and the hardware
and software that is used.

Allowed values: "1" to "9"

"1" to "9" = Agent's license class
 Automation Engine 125

askRACF= Verification of the access authorizations with RACF for Jos and FileTransfers
before the agent starts (password verification for the User of the
Job/FileTransfer and dataset authorization check in FileTransfers). Doing so
generates more accurate agent error messages and avoids useless task starts
if there is no appropriate authorization. The security system checks the
running job in any case.

You can deactivate this entry with the value "0" if no RACF is installed on this
host.

Allowed values: "0" to "15"

Default value: "7"

Value Login Login File-access check File-access check

check check for for FileTransfers for FileTransfers
for file with the login's with the agent's
jobs transfers UserID UserID
0
1

10

11

12

13

14

15
126 Chapter 3 Configuration

completeJobout= This parameter determines the complexity of the job protocol.

Allowed values: "0" (default value), "1"

"0" = Only JES statistics (JESMSGLG, JESJCL and JESYSMSG) are stored
in the AE.
"1" = The entire job protocol (JES statistics+ job output) is stored in the 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.

Allowed values: "0" (default value), "1"

"0" = The job log remains in the JES without changes.

"1" = The job log is deleted from the JES.

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 the message classes.
relMsgClass= This parameter releases the job log for printing.

Allowed values: "0" (default value), "1"

"0" = The job log is not released.

"1" = The job log is released for printing.

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.
getMsgClass= Message classes that should be read and routed.

Enter one or several message classes. Examples: "A", "ABC", "X1". You can
use any order.

 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 the message classes.
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 using
attributes. More detailed information is provided in the document that
describes themessage classes.
 Automation Engine 127

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.

Allowed values: "0" (default value), "1"

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

Allowed values: "INCL", "EXCL"

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

Default value: (1,1)

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

Allowed values: 0 - 9999

Default value: "6"
128 Chapter 3 Configuration

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.

Allowed values: "0" and "1" (default value)

"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.
ft_temp_file= Creates temporary files in FileTransfers.

Allowed values: "yes" and "no" (default value)

"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 FileTransferr
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.

"no" - The agent assigns the final file name when the FileTransfer starts.

The USS file system requires the parameter file_temp_file_uss to be used.

 Automation Engine 129

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!
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]
InitialPackage= The name and the path of the file that includes the authentication package
(company-key file).

This parameter must be specified if you use the authentication methods

"Server" or "Server and Agent". Any attempt to log in fails if the company-key
file cannot be found.

When the agent starts, it reads the company-key file and stores its information
in the file that is specified in the parameter KeyStore=. The first file is deleted
afterwards.
KeyStore= The name and the path of the file that includes the information of the
authentication package (see parameter InitialPackage=).

If no file name and/or path is specified, the system uses the name (file ending
*.kstr) or the path of the agent's 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.
(JCL Exit)
name= Name of the JCL-Exit module.
maxJclRecords= Size of the output area.
130 Chapter 3 Configuration

(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 Variableswith agent information and settings.
(TRACE)
file= Name of the trace file.

The number signs serve as placeholders for a series in numerical order. When
you start a trace, the trace files are renamed so that the most current trace file
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)

"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))
trccount= The number of stored trace files.
tcp/ip= The agent's trace flags for the TCP/IP communication.
filetransfer=
Allowed values: "0" (default value) to "9"
status=
joboutput= Trace flags must only be used in close cooperation with Support.
event=
memory=
trcmode= Method used for the trace files.

Allowed values: "0" to "3"

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:
DNS Name:Port number
TCP/IP Address:Port number
port= The agent's port number .

Other agents and the job messenger use this port number to establish a
connection to the agent.
 Automation Engine 131

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

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 the local host (127.0.0.1).

This parameter is to 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= Time interval in seconds in which the agent tries to establish a connection to
the Automation Engines (when rebooting or lost connection).

Default value: 120 seconds

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

Default value: 60 seconds

connwait= Time interval in seconds during which the agent waits for a communication
partner response (CP or a different agent). If this time limit is exceeded, the
connection to the communication partner is terminated.

Default value: 20 seconds

AsyncConnect= 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. We recommend specifying
AsyncConnect=1 which causes the waiting period to be reduced.
maxMsgSize= Maximum length of messages (in bytes) that the agent accepts.

Default value: 500 000

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

Default value: 262144 Byte

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

Default value: 262144 Byte

tcp_keepalive= 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.
132 Chapter 3 Configuration

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.

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.

(CP_LIST) List of communication processes.

This list is created when the agent starts and it is 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 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
 Automation Engine 133

Example of an INI File

(GLOBAL)
system=AE
name=MVS01
language=(E,D)
logging='AE.WORK.LOG##'
logcount=10
logpurgeclass=9
helplib='AE.UC.MSL'
helpcache=ALL
licence_class=9
askRACF=7
completeJobout=1
jobPurge=0
relMsgClass=0
getMsgClass=AB
routeMsgClass=CD
jes=JES2
; jobACF2=0
userid_type=EXCL
jobCancel=$C &02
jobOutputAllocation=(1,1)
vanishedRetry=1
waitSpoolRetry=6
waitSpoolReady=50
WaitOnJobEnd=0
ignoreEmptyJCL=1
ft_temp_file=yes
ft_temp_file_uss=no

(AUTHORIZATION)
InitialPackage=
KeyStore=

(JCL Exit)
; name=
; maxJclRecords

(USERID)
; IBMUSER=NO_START

(Variables)
UC_HOST_CODE=IBM_3270_INTERNATIONAL
UC_HOST_JCL_VAR=MVS
UC_EX_PATH_BIN=UC4.UCXJM25.LOAD
UC_EX_PATH_TEMP=UC4.TEMP.
UC_EX_PATH_JOBREPORT=UC4.TEMP.
UC_EX_JOB_MD=UCXJM25M

(TRACE)
134 Chapter 3 Configuration

file='AE.WORK.TRC##'
trccount=10
tcp/ip=0
filetransfer=0
status=0
joboutput=0
event=0

(TCP/IP)
cp=PC01:2217
port=2300
connect=120
report=60
connwait=20
AsyncConnect=1

(HOSTS)
; <name>=<dns-name> or
; <name>=<ip-addr>

(CP_LIST)
2218:PC01

See also:

Notes for Configuration-File Adjustments

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.

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.

Section/Parameter Description
(GLOBAL)
system= Name of the AE system.

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.
 Automation Engine 135

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.
logging= Name of the log file.

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
always has the number "00".

If you comment this parameter, this log file is stored in JES. Also refer to the
parameter logpurgeclass= which is described below.

The following parameters can be added if 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))
logcount= Number of stored log files.
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 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:

The parameter logcount= is set to 3. The first log file is routed to the Sysout
class when the fourth log file is created.
helplib= Name of the message file.
helpcache= Availability of 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 message file from the hard drive.
"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).
136 Chapter 3 Configuration

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)
file= Name of the trace file.

The number signs serve as placeholders for a series in numerical order. When
you start a trace, the trace files are renamed so that the most current trace file
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)

"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))
trccount= Number of stored trace files.
tcp/ip= Agent's trace flags for TCP/IP communication
filetransfer=
Allowed values: "0" (default value) to "9"
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.

Allowed values: "0" to "3"

Default value: "1"

"0" - Trace file is written normally.

"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 as 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)
ex= Address of the agent to which the Event Monitor should connect.

Allowed formats:
DNS name:port number
TCP/IP address:port number
connect= Time interval in seconds in which the Event Monitor tries (cyclically) to
establish a re-connection to the agent.

Default value: 120 seconds

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.
 Automation Engine 137

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

Default value: 262144 Byte

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

Default value: 262144 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.

Allowed values: "0" (default value), "1"

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

Allowed values: "0" (default value), "1"

"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

138 Chapter 3 Configuration

smfStepFilter= Analyzes SMF records in automated FileSystem Events.

Allowed values: "0" (default value) and "1"

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

Allowed values: "0" (default value) and "1"

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

Allowed values: "1" - "2048"

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*
 Automation Engine 139

Example of an INI File

(GLOBAL)
system=UC4
name=EM01
language=(E,D)
logging='UC4.WORK.EMLOG##'
logcount=10
logpurgeclass=9
helplib='UC4.UC.MSL'
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 monitorexternal Job monitor which is operated as an
independent task (Started Task).

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.

Section/Parameter Description
140 Chapter 3 Configuration

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

logging= Name of the log file.

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
always has the number "00".

If you comment this parameter, this log file is stored in JES. Also 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))
logcount= Number of stored log files.
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 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:

The parameter logcount= is set to 3. The first log file is routed to the Sysout
class when the fourth log file is created.
helplib= Name of the message file.
 Automation Engine 141

helpcache= Availability of 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 message file from the hard drive.
"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)
file= Path and file name of the trace file.

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.

Allowed values: "0" (default value) to "9"

Set trace flags only in close cooperation with Automic Support.

trcmode= Method used for the trace files

Allowed values: "0" to "3"

Default value: "1"

"0" - Trace file is written normally.

"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 as it causes an Event for each
line which can lead to recursive endless loops.
"3" - Trace outputs are also written to the log file.
trccount= Number of trace files that are kept.
(SMFExit)
Modulname= Name of the SMF Exit module for the external Job Monitor.
142 Chapter 3 Configuration

SMF_Buffersize= Size of the Common AREA SpaceCommon Area Data Space (CADS) in
which the SMF Exit stores Events (in MB).

Allowed values: "1" - "2048"

Default value: 10

About 65000 Events can be stored with 10 MB.

ABENDNUM= 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 CADSDELCADSDEL.

Maximum 8 characters

Default value: LPAR name

 Automation Engine 143

Example of an INI File

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

Notes for Configuration-File Adjustments

3.1.5 Utilities
AE DB Archive
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCYBDBAR.ini

Section/Parameter Description
[GLOBAL]
helplib= The name of the message file.
144 Chapter 3 Configuration

helpcache= The availability of message and language dependent strings.

Allowed values: "ALL" (default value), "NONE", "CONTROLS"

"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.
logging= The path and the file name of the log file.

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".
logcount= The number of stored log files.
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).

Default value: 200 000

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

The number characters are used as place holders for consecutive

numbering. When you start the agent, the log files are renamed so that the
current log file always shows the number "00".
trccount= The number of stored trace files.
database= The trace flag for the utility's database access.

Allowed values: "0" (default value) to "9"

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.
 Automation Engine 145

[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 FileTransfer (destination).
AH_CodeNameDst= The code table for the FileTransfer (destination).
AH_FileNameDst= The file name for the FileTransfer (destination).
AH_HostSrc= The host name for the FileTransfer (source).
AH_LoginSrc= The name of the Login object for the FileTransfer (source).
AH_CodeNameSrc= The code table for the FileTransfer (source).
AH_FileNameSrc= The file name for the FileTransfer (source).
AH_Count= The number of transferred bytes (for FileTransfer) 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
146 Chapter 3 Configuration

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
FileTransfer:
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.
 Automation Engine 147

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 AgentGroup calculation in workflows.
AH_HGSrc= The name of an AgentGroup.
AH_HGDst= The name of an AgentGroup as the destination of FileTransfers.
AH_MaxParallelHG= The maximum number of parallel tasks in AgentGroups.
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]
148 Chapter 3 Configuration

SQLDRIVERCONNECT= The database connection.

ODBCVAR - Eight-digit 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 - Disconnects the 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 - 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.
7. Position = N - Compression is deactivated.
7. Position = R - Compression is activated.
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 recommends using the variable NLS_LANG or the parameter
SP=.

Syntax:
SP=NLS_LANGUAGE=language,NLS_
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).
SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=uc4;
PWD=--1037B2E22BF022EBE2;
SP=NLS_LANGUAGE=AMERICAN,NLS_
TERRITORY=AMERICA,CODESET=WE8ISO8859P15,commit_
write='BATCH,NOWAIT'

See also: Setting up ORACLE databases

 Automation Engine 149

See:Notes for Configuration-File Adjustments

150 Chapter 3 Configuration

Example of an INI File

[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
 Automation Engine 151

execution)
AH_RepeatType = 1 ; EV: R=repeated, S=single FT: include
subdirectories R=yes S=no
AH_TimePeriod = 1 ; period in minutes or HHMM depending on the event
type
AH_CheckCount = 1 ; number of checks
AH_OccurCount = 1 ; number of occourred events
AH_EventSubType = 1 ; event sub type
AH_Operator = 1 ; G = Greater L = Less E = Equal N = NotEqual
AH_Value = 1 ; value to compare
AH_Unit = 1 ; unit of AH_Wert: 0=host specific, 1 = Byte, 2=KB,
3 = MB, 4=GB, 5=TB
AH_Cancel = 1 ; the cancel flag: M=manually
AH_Source = 1 ; WIN_EVENT: Source
AH_Category = 1 ; WIN_EVENT: Category
AH_TExecType = 1 ; EV-TS: start after 'start time' E=Execute
N=NoExecute EV-TT:S=start immediately FT: 1=filetransfer with wildcard
characters
AH_MaxRetCode = 1 ; up to this retcode the activity is ENDED_OK
AH_IntAccount = 1 ; account
AH_Name = 1 ; name of the object
AH_Transferred = 1 ; Transferred bytes
AH_Compress = 1 ; Compress level
AH_Ert = 1; Estimated runtime
AH_Archive1 = 0 ; archive key 1
AH_Archive2 = 0 ; archive key 2
AH_Info = 0 ; additional information like job number
AH_ParentAct = 0 ; AH_Idnr of activator parent
AH_ParentPrc = 0 ; AH_Idnr of processor parent
AH_DeleteFlag = 0 ; the delete flag
AH_TaskCount = 0 ; number of AJPP
AH_ArchiveFlag = 0 ; archive flag
AH_Rest = 0 ; . additional attributes
AH_TZ = 0 ; Timezone for object and script
AH_TimePeriodTZ = 0 ; Timezone for time period (event) when HHMM is
used
AH_ReuseHostGroup = 0 ; reuse agentgroup in workflow
AH_HGSrc = 0 ; name of agentgroup
AH_HGDst = 0 ; name of agentgroup (source)
AH_MaxParallelHG = 0 ; agentgroup max parallel
AH_ChildCnt = 0 ; children count
AH_ChildCntFail = 0 ; failed children - successful restarted
AH_ChildCntFailAll= 0 ; failed children total
AH_ChildCntRestart= 0 ; restarted children
AH_ContainerType = 0 ; object type controlled by the container

[ODBC]
; ODBCVAR xxxxxxxx
; |||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
; ||||||+- R=compress messages and local memory
; |||||+-- O = with userid, N = without userid
; ||||+--- I=OCI/CLI N=ODBC
; |||+---- not used
; ||+----- J = compare fieldnames case-insensitive (in case of
152 Chapter 3 Configuration

ORACLE !!)
; |+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
; +------- S = use Server-Cursor (SQL-SERVER)
;
; SNNNNNRN for SQL-Server 2000
; NNNNNNRN for SQL-Server 2005
; NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
; NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)

; SQL-Server 2000 with ODBC

SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4

See also:

General Procedure - Database Maintenance

Archive Browser
Archiving
Structure of the Archived Folder

AE DB Change

Structure of the INI File UCYBCHNG.INI

Section/Parameter Description
[GLOBAL]
Helplib= The name of the message file.
Helpcache= The availability of message and language dependent strings.

Allowed values: "ALL" (default value), "NONE", "CONTROLS"

"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 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".
logcount= The number of stored log files.
 Automation Engine 153

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]
file= The path and file name of the trace file.

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".
trccount= The number of stored trace files.
level= The trace level for the program flow of the utility.

Allowed values: "0" (default value) to "4"

Trace flags must only be used in close cooperation with Automic Support.

See: Notes for Adjusting Configuration Files

Example of an INI File

[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
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.
154 Chapter 3 Configuration

Structure of the INI File UCYBDBCC.ini

Section/Parameter Description
[GLOBAL]
helplib= The name of the message file.
Helpcache= The availability of the message and language-dependent strings.

Allowed values: "ALL" (default value), "NONE", "CONTROLS"

"ALL" = The entire message file is kept in the RAM.

"NONE" = The message file is always read from the hard drive.
"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 language that you select when you log on affects the utility's interface
and the log-file messages. When you select several languages here, the
first language is used as the default language.
docu_path= The directory in which the help system is installed.
logging= The path and the file name of the log file.

The characters are used as place holders for consecutive numbering.

When the utility starts, the log files are renamed in order to ensure that the
current log file always shows the number "00".
logcount= The number of stored log files.
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.
path= The start path for 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]
classpath= The path and the file name of the archive for layout files.
[TRACE]
 Automation Engine 155

file= The path and file name of the trace file.

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".
trccount= The number of stored trace files.
database= The trace flag for the utility's database access.

Allowed values: "0" (default value) to "9"

Trace flags must only be used in close cooperation with Automic

Support.
[SOURCEDB]
156 Chapter 3 Configuration

SQLDRIVERCONNECT= Connection for the database.

ODBCVAR - Eight-digit 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 - Disconnects 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 - The type of the database connection: ODBC
5. Position = I - The type of the 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 = 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 database access.
PWD - The password for database access. It should always (also "") be
encoded. See: Encoding passwords

Only for ORACLE:

The code-page settings must correspond to those of the database.
Automic recommends using the variable NLS_LANG or the parameter
SP=.

Syntax:
SP=NLS_LANGUAGE=language,NLS_
TERRITORY=area,CODESET=character
set,RECONNECT=interval,commit_write='BATCH,NOWAIT'

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

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).
SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=uc4;
PWD=--1037B2E22BF022EBE2;
SP=NLS_LANGUAGE=AMERICAN,NLS_
TERRITORY=AMERICA,CODESET=WE8ISO8859P15,commit_
write='BATCH,NOWAIT'

See also: Setting up ORACLE databases

 Automation Engine 157

[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

Example of an INI File

[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]
classpath=.;.\UC4LAF.jar

[TRACE]
file = ..\TEMP\UCYBCLICPY_TRACE_##.txt
trccount = 10
database = 0
;0=nein
;1=SQL
;2=OPC
;3=BindParam
;4=Datenbereiche

[SOURCEDB]
; ODBCVAR xxxxxxxx
; |||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
; ||||||+- R=compress messages and local memory
; |||||+-- O = with userid, N = without userid
; ||||+--- I=OCI/CLI N=ODBC
; |||+---- not used
; ||+----- J = compare fieldnames case-insensitiv (in case of
158 Chapter 3 Configuration

ORACLE !!)
; |+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
; +------- S = use Server-Cursor (SQL-SERVER)
;
; SNNNNNRN for SQL-Server 2000
; NNNNNNRN for SQL-Server 2005
; NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
; NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)
; NNJNIORZ for DB2/OS390 (7.1) with CLI (Call Level Interface)

; SQL-Server 2000 with ODBC

SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4

[TARGETDB]
TargetDB = 1
CommitCnt = 1000

; SQL-Server 2000 with ODBC

SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4_test;UID=uc4;PWD=--
1037B2E22BF022EBE2
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4

See also:

Copying and Deleting Clients

AE DB Load
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCYBDBLD.ini

Section/Parameter Description
[GLOBAL]
logging= The path and the file name of the log file.

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".
 Automation Engine 159

logcount= The number of stored log files.

language= Language.

Allowed values: "D", "F" and "E" (default)

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

The language that you select when you log on affects the utility's interface
and the log-file messages. When you select several languages here, the
first language is used as the default language.
helplib= The name of the message file.
helpcache= The availability of the message and language dependent strings.

Allowed values: "ALL" (default value), "NONE", "CONTROLS"

"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 which are required for
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.
path= The start path for the utility.
title= This parameter serves internal purpose in the utility. The value must not be
changed.
docu_path= The directory in which the help system is installed.
[ENVIRONMENT]
classpath= The path and the file name of the archive for layout files.
[TRACE]
file= The path and the file name of the trace file.

The number characters are used as place holders for consecutive

numbering. When you start the agent, the log files are renamed so that the
current log file always shows the number "00".
trccount= The number of stored trace files.
database= The trace flag for the utility's database access.

Allowed values: "0" (default value) to "9"

Trace flags must only be used in close cooperation with Automic

Support.
[ODBC]
160 Chapter 3 Configuration

SQLDRIVERCONNECT= The connection for the database.

ODBCVAR - Eight-digit 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 - Disconnects the 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 - The type of the database connection: ODBC
5. Position = I - The type of the 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 = 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 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 recommends using the variable NLS_LANG or the parameter
SP=.

Syntax:
SP=NLS_LANGUAGE=language,NLS_
TERRITORY=area,CODESET=character
set,RECONNECT=interval,commit_write='BATCH,NOWAIT'

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

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).
SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=uc4;
PWD=--1037B2E22BF022EBE2;
SP=NLS_LANGUAGE=AMERICAN,NLS_
TERRITORY=AMERICA,CODESET=WE8ISO8859P15,commit_
write='BATCH,NOWAIT'

See also: Setting up ORACLE databases

 Automation Engine 161

See: Notes for Adjusting Configuration Files

162 Chapter 3 Configuration

Example of an INI File

[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
docu_path=C:\AUTOMIC\Documentation

[ENVIRONMENT]
classpath=.;.\UC4LAF.jar

[TRACE]
file=..\TEMP\UCYBDBLD_TRACE_##.TXT
trccount=10
database=0
; 0=no
; 1=SQL
; 2=OPC
; 3=BindParam
; 4=data fields

[ODBC]
; ODBCVAR xxxxxxxx
; |||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
; ||||||+- R=compress messages and local memory
; |||||+-- O = with userid, N = without userid
; ||||+--- I=OCI/CLI N=ODBC
; |||+---- not used
; ||+----- J = compare fieldnames case-insensitiv (in case of
ORACLE !!)
; |+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
; +------- S = use Server-Cursor (SQL-SERVER)
;
; SNNNNNRN for SQL-Server 2000
; NNNNNNRN for SQL-Server 2005
; NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
; NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)

; SQL-Server 2000 with ODBC

SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
 Automation Engine 163

; DB2 with CLI

;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4

See also:

Loading Databases

AE DB Reorg
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCYBDBRE.ini

Section/Parameter Description
[GLOBAL]
helplib= The name of the message file.
Helpcache= The availability of the message and language dependent strings.

Allowed values: "ALL" (default value), "NONE", "CONTROLS"

"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 which 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 language that you select when you log on affects the utility's interface
and the log-file messages. When you select several languages here, the
first language is used as the default language.
docu_path= The directory in which the help system is installed.
logging= The path and the file name of the log file.

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".
logcount= The number of stored log files.
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).

Default value: 200 000

[ENVIRONMENT]
164 Chapter 3 Configuration

classpath= The path and the file name of the archive for layout files.
[REORG]
no_archive_check= Archiving check.

"0" = Checks if data has been archived before.

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

Allowed values: "0" to "32767"

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]
file= The path and the file name of the trace file.

The number characters are used as place holders for consecutive

numbering. When you start the agent, the log files are renamed so that the
current log file always shows the number "00".
trccount= The number of the stored trace files.
database= The trace flag for the utility's database access.

Allowed values: "0" (default value) to "9"

Trace flags must only be used in close cooperation with

Automic Support.
[ODBC]
 Automation Engine 165

SQLDRIVERCONNECT= The connection for the database.

ODBCVAR - Eight-digit 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 - Disconnects the 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 - 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.
7. Position = N - Compression is deactivated.
7. Position = R - Compression is activated.
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 recommends using the variable NLS_LANG or the parameter
SP=.

Syntax:
SP=NLS_LANGUAGE=language,NLS_
TERRITORY=area,CODESET=character
set,RECONNECT=interval,commit_write='BATCH,NOWAIT'

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
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).
SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=uc4;
PWD=--1037B2E22BF022EBE2;
SP=NLS_LANGUAGE=AMERICAN,NLS_
TERRITORY=AMERICA,CODESET=WE8ISO8859P15,commit_
write='BATCH,NOWAIT'

See also: Setting up ORACLE databases

166 Chapter 3 Configuration

See: Notes for Adjusting Configuration Files

 Automation Engine 167

Example of an INI File

[GLOBAL]
helplib=uc.msl
Helpcache=all
language=E
docu_path=C:\AUTOMIC\Documentation
logging=..\TEMP\UC_DBReorg_LOGG_##.TXT
logcount=10
cmd="javaw" -jar -cp .;.\UC4LAF.jar UCYBDBRE.jar
path=.
title=UC4 DB-

[ENVIRONMENT]
classpath=.;.\UC4LAF.jar

[REORG]
no_archive_check=0
auto_reorg=365

[TRACE]
file=..\TEMP\UC_DBReorg_TRACE_##.TXT
trccount=10
database=0

[ODBC]
; ODBCVAR xxxxxxxx
; |||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
; ||||||+- R=compress messages and local memory
; |||||+-- O = with userid, N = without userid
; ||||+--- I=OCI/CLI N=ODBC
; |||+---- not used
; ||+----- J = compare fieldnames case-insensitive (in case of
ORACLE !!)
; |+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
; +------- S = use Server-Cursor (SQL-SERVER)
;
; SNNNNNRN for SQL-Server 2000
; NNNNNNRN for SQL-Server 2005
; NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
; NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)

; SQL-Server 2000 with ODBC

SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4
168 Chapter 3 Configuration

See also:

General Procedure - Database Maintenance

Reorganization

AE DB Reporting Tool
Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment are written in red letters.

Structure of the INI File UCYBDBRT.INI

Section/Parameter Description
[GLOBAL]
logging= Path and file name of the log file.

The number characters are used as placeholders for consecutive

numbering. When you start the utility, the log files are renamed so that the
current log file always shows the number "00".
logcount= Number of stored log files.
helplib= Name of the message file.
helpcache= Availability of messages and language dependent strings.

Allowed values: "ALL" (default value), "NONE", "CONTROLS"

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

Allowed values: "0" (default value) and "1"

"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]
file= Path and file name of the trace file.

The number characters are used as placeholders for consecutive

numbering. When you start the agent, the log files are renamed so that the
current log file always shows the number "00".
trccount= Number of stored trace files.
database= Trace flag for the utility's database access.

Allowed values: "0" (default value) to "9"

 Automation Engine 169

reptool= Trace flag for the Reporting Tool.

Allowed values: "0" (default value) to "9"

Trace flags must only be used in close cooperation with Automic

Support.
[ODBC]
170 Chapter 3 Configuration

SQLDRIVERCONNECT= Connection for the database.

ODBCVAR - Eight-figure command field to control 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 ORACLE:

Code page settings must correspond to those of the database. AE
therefore recommends using the variable NLS_LANG or the parameter
SP=.

Syntax:
SP=NLS_LANGUAGE=language,NLS_
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" was set
in the 2nd digit of ODBCVAR (see above).

Automic recommends using the parameter commit_

write='BATCH,NOWAIT' in order to increase performance.

Example:
(Two lines are used for the connection parameters for lack of space. In the
INI file, you should use only one line.)
SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=uc4;UID=uc4;
PWD=--1037B2E22BF022EBE2;
SP=NLS_LANGUAGE=AMERICAN,NLS_
TERRITORY=AMERICA,CODESET=WE8ISO8859P15,commit_
write='BATCH,NOWAIT'

See also: Setting up ORACLE databases

 Automation Engine 171

See: Notes for Configuration-File Adjustments

172 Chapter 3 Configuration

Example of an INI File

[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
; |||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
; ||||||+- R=compress messages and local memory
; |||||+-- O = with userid, N = without userid
; ||||+--- I=OCI/CLI N=ODBC
; |||+---- not used
; ||+----- J = compare fieldnames case-insensitive (in case of
ORACLE !!)
; |+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
; +------- S = use Server-Cursor (SQL-SERVER)
;
; SNNNNNRN for SQL-Server 2000
; NNNNNNRN for SQL-Server 2005
; NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
; NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)

; SQL-Server 2000 with ODBC

SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4

See also:
 Automation Engine 173

Reporting

AE DB Revision Report
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCYBDBRR.ini

Section/Parameter Description
[GLOBAL]
language= The language that the login window suggests by default.

Allowed values: "E" (default), "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. If you select several languages here, the first
language is used as the default language.
logging= The path and file name of the log file.

The number characters are used as placeholders for consecutive

numbering. When you start the utility, the log files are renamed so that the
current log file always shows the number "00".
logcount= The number of stored log files.
helplib= The name of the message file.
helpcache= The availability of the message and language dependent strings.

Allowed values: "ALL" (default value), "NONE", "CONTROLS"

"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 which are required for
displaying a Dialog program are held in the RAM. 
[TRACE]
file= The path and file name of the trace file.

The number characters are used as placeholders for consecutive

numbering. When you start the agent, the log files are renamed so that the
current log file always shows the number "00".
trccount= The number of the stored trace files.
database= The trace flag for database access of the utility.

Allowed values: "0" (default value) to "9"

Trace flags must only be used in close cooperation with Automic

Support.
[ODBC]
174 Chapter 3 Configuration

SQLDRIVERCONNECT= The connection for the database.

ODBCVAR - Eight-digit 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 - Disconnects 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 - The type of the database connection: ODBC
5. Position = I - The type of the database connection: OCI/CLI.
6. Position = N - The database access without User ID.
6. Position = O - The database access with User ID.
7. Position = N - Compression is deactivated.
7. Position = R - Compression is activated.
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 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
recommends using the variable NLS_LANG or the parameter SP=.

Syntax:
SP=NLS_LANGUAGE=language,NLS_
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" was 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. You
should only use one line in the INI file.)
SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=uc4;
PWD=--1037B2E22BF022EBE2;
SP=NLS_LANGUAGE=AMERICAN,NLS_
TERRITORY=AMERICA,CODESET=WE8ISO8859P15,commit_
write='BATCH,NOWAIT'

See also: Setting up ORACLE databases

See: Notes for Adjusting Configuration Files

 Automation Engine 175

Example of an INI File

[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
; |||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
; ||||||+- R=compress messages and local memory
; |||||+-- O = with userid, N = without userid
; ||||+--- I=OCI/CLI N=ODBC
; |||+---- not used
; ||+----- J = compare fieldnames case-insensitiv (in case of
ORACLE !!)
; |+------ D = DB-Disconnect after 1000 commits (perhaps in case of
Oracle memory leaks)
; +------- S = use Server-Cursor (SQL-SERVER)
;
; SNNNNNRN for SQL-Server 2000
; NNNNNNRN for SQL-Server 2005
; NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
; NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)

; SQL-Server 2000 with ODBC

SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4

See also:

Revision Report
176 Chapter 3 Configuration

AE DB Unload
Default values have been specified for most parameters. They can be changed if required. Parameters
that must be adjusted to your system environment are written in red letters.

Structure of the INI File UCYBDBUN.ini

Section/Parameter Description
[GLOBAL]
logging= The path and the file name of the log file.

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".
logcount= The number of stored log files.
OUTPUT= The path and the name of the file that contains the unloaded data.
helplib= The name of the message file.
Helpcache= The availability of the message and language dependent strings.

Allowed values: "ALL" (default value), "NONE", "CONTROLS"

"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 which are required for
displaying a Dialog program are held in the RAM. 
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.

Allowed values: "D", "F" and "E" (default)

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

The language that you select when you log on affects the utility's interface
and the log-file messages. When you select several languages here, the
first language is used as the default language.
docu_path= The directory in which the help system is installed.
cmd= The command line command that can be used to start the utility.
path= The start path for the utility.
title= This parameter serves internal purpose in the utility. The value must not be
changed.
[ENVIRONMENT]
 Automation Engine 177

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

The number characters are used as place holders for consecutive

numbering. When you start the agent, the log files are renamed so that the
current log file always shows the number "00".
trccount= The number of stored trace files.
database= The trace flag for the utility's database access.

Allowed values: "0" (default value) to "9"

Trace flags must only be used in close cooperation with Automic

Support.
[TRANSPORT]
all_entities= The setting for the scope of the unloaded data in the Transport Case.

Allowed values: "0" (default value) and "1"

"0" = Only object attributes that contain a value are exported.

"1" = The utility exports all object attributes regardless of their contents.

This setting is important if the unloaded data is subsequently changed by

using AE.DB Change.

Activate this setting if data is unloaded from the system client by

means of a Transport Case which should subsequently be loaded to
other clients.
[REORG]
no_archive_check= Archiving check.

Allowed values: "0" (default value) and "1"

"0" = Checks if the data has been archived before.

"1" = There is no such check.
reorg_chunk_size= The number of data records of the relevant top table (such as "AH") that
should be deleted per transaction including all its corresponding entries in
sub-tables.

The system uses the default value when you specify a value that does not
lie within the allowed range of values.

Allowed values: "50" to "5000"

Default value: "1000"
reorg_sleep_time= The waiting time in milliseconds that the system should wait after each
deletion transaction.

Allowed values: "0" (default) to "10000"

max_deadlock= The maximum number of deadlocks per operation.

Default value: "100"

[ODBC]
178 Chapter 3 Configuration

SQLDRIVERCONNECT= The connection for the database.

ODBCVAR - Eight-digit 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 - Disconnects the 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 - 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.
7. Position = N - Compression is deactivated.
7. Position = R - Compression is activated.
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 recommends using the variable NLS_LANG or the parameter
SP=.

Syntax:
SP=NLS_LANGUAGE=language,NLS_
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" was 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).
SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=uc4;
PWD=--1037B2E22BF022EBE2;
SP=NLS_LANGUAGE=AMERICAN,NLS_
TERRITORY=AMERICA,CODESET=WE8ISO8859P15,commit_
write='BATCH,NOWAIT'

See also: Setting up ORACLE databases

 Automation Engine 179

See: Notes for Configuration-File Adjustments

180 Chapter 3 Configuration

Example of an INI File

[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
docu_path=C:\AUTOMIC\Documentation
cmd="javaw" -jar -cp .;.\UC4LAF.jar UCYBDBUN.jar
path=.
title=UCYBDBUN

[ENVIRONMENT]
classpath=.;.\UC4LAF.jar

[TRACE]
file=..\TEMP\UCYBDBUN_TRACE_##.TXT
trccount=10
database=0
; 0=no
; 1=SQL
; 2=OPC
; 3=BindParam
; 4=data fields

[REORG]
reorg_chunk_size=1000
no_archive_check = 0
max_deadlock = 100

[TRANSPORT]
all_entities = 1

[ODBC]
; ODBCVAR xxxxxxxx
; |||||||+ type of SQL-Syntax N=SQL-SERVER O=ORACLE D=DB2
; ||||||+- R=compress messages and local memory
; |||||+-- O = with userid, N = without userid
; ||||+--- I=OCI/CLI N=ODBC
; |||+---- not used
; ||+----- J = compare fieldnames case-insensitiv (in case of
ORACLE !!)
; |+------ D = DB-Disconnect after 1000 commits (perhaps in case of
 Automation Engine 181

Oracle memory leaks)

; +------- S = use Server-Cursor (SQL-SERVER)
;
; SNNNNNRN for SQL-Server 2000
; NNNNNNRN for SQL-Server 2005
; NNJNINRO for Oracle 8.x with OCI (Oracle Call Interface)
; NNJNIORD for DB2/NT/UNIX with CLI (Call Level Interface)

; SQL-Server 2000 with ODBC

SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=10BFDC349F38156A22
; SQL-Server 2005 with ODBC
;SQLDRIVERCONNECT=ODBCVAR=SNNNNNRN,DSN=UC4;UID=uc4;PWD=UC4
; Oracle with OCI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORO,DSN=UC4;UID=scott;PWD=tiger
; DB2 with CLI
;SQLDRIVERCONNECT=ODBCVAR=NNJNIORD,DSN=UC4;UID=uc4;PWD=UC4

See also:

Unloading Databases

Utility for the Console Event (UCON Connection)

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 x.xxx.UCXEB2?U.INI

Section/Parameter Description
(GLOBAL)
SYSTEM= The name of the AE system.

This entry must be identical to the entry in the Automation Engine's INI file.
NAME= The name of the utility.

Maximum 32 characters
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
starting the agent, the log files are renamed so that the most current log file is
always the one with the number "00".
LOGCOUNT= The number of stored log files
182 Chapter 3 Configuration

LANGUAGE= The language in which the logging is executed. Entries for primary and secondary
language.

Allowed values: "E", "D", "F"

Default: "E,D" (primary English, secondary German)

If there is no 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
always the one with the number "00".
TRCCOUNT= The number of stored trace files.
TCP/IP= Trace flag for agent TCP/IP communication

Allowed values: "0" to "9"

Default: "0"

Trace flags must only be used in close cooperation with support and development
staff.

Example of an INI File

(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

 Automation Engine 183

3.1.6 ServiceManager
ServiceManager - Service
The ServiceManager serves to start, stop and access components such as the Automation Engine
processes or agents from a central point.

The parameters of the ServiceManager (Service) are the same for Windows and UNIX.

Default values have been specified for most parameters. They can be changed if required. Parameters
which must be adjusted to your system environment at any case are written in red letters.

Structure of the INI File UCYBSMGR.INI

Section/Parameter Description
[GLOBAL]
language= Language in which logging is carried out. Entries for primary and secondary
language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary language English, secondary language German)

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

be searched for a message.
logging= Path and file name of the log file.

The number signs serve as place holders for a series in numerical order.
When starting the ServiceManager, 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.
helplib= Path and name of the message file.
helpcache= Availability of the messages and language dependant strings.

Allowed values: "ALL", "NONE", "CONTROLS"

Default: "ALL"

"ALL" = The complete message file is held in the RAM.

"NONE" = Always read from the hard drive.
"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.
184 Chapter 3 Configuration

restart_limit= Maximum number of automatic start attempts which are processed for a
server process within a particular time span.

When the ServiceManager runs under 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 minutes,number of start attempts)

Default value: (60,3)

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.
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]
file= Path and file name of the trace file.

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 always the one with the number "00".
trccount= Number of stored trace files.
cmd= Trace-flag commands.

Allowed values: "0" to "9"

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.

 Automation Engine 185

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
186 Chapter 3 Configuration

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)
START2=(name,command)
START3=(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)
 Automation Engine 187

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
188 Chapter 3 Configuration

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

Section/Parameter Description
[GLOBAL]
size= Size of the dialog program
admin= Access to the properties of the services

Allowed values: "0" and "1"

"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
 Automation Engine 189

Example of an INI File

[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

Section/Parameter Description
(GLOBAL)
SYSTEM= The name of the AE system.

This entry must be identical to the entry in the INI file of the Automation
Engine.
HELPLIB= The name of the message file.
LANGUAGE= The language in which the logging is processed. Entries for primary and
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

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

searched for.
TIMEOUT= The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.

Default value: 60

With the parameter TIMEOUT=0 being used, the CallAPI waits (without
time limit) until the Automation Engine acknowledges.
CODETABLE= The name of the CodeTable object that should be used by the CallAPI
trace Trace designation.

Allowed values:
"0" (default) = Deactivate trace
"1" = Activate trace

If the trace parameter is set to 1, additional information is written to STDOUT

190 Chapter 3 Configuration

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

Example of an INI File

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

Notes for Configuration-File Adjustments

 Automation Engine 191

Utility for GCOS8

Structure of the INI File UCXBGC8CI

Section/Parameter Description
[GLOBAL]
system= The name of the AE system.

This entry must be identical to the entry in the INI file of the Automation
Engine.
helplib= The name of the message file.
language= The language in which the logging is executed. Entries for primary and
secondary language.

Allowed values: "E", "D"

Default: "E,D" (Primary English, secondary German)

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

searched for.
logcount= The number of stored log files.
logging= Thename of the log file.

The number signs serve as place holders for a series in numerical order.
When starting the agent, the log files are renamed so that the most current log
file is always the one with the number "00".
[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:
Port number=DNS Name
Port number=TCP/IP Address
192 Chapter 3 Configuration

Example of an INI File

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

Notes for Configuration-File Adjustments

Utility for Java

Structure of the INI File UCXBXXXC.INI

Section/Parameter Description
[GLOBAL]
system= The name of the AE system.

This entry must be identical to the entry in the INI file of the Automation
Engine.
language= The language in which the logging is processed. Entries for primary and
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

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

searched for.
timeout= The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.

Default value: 60
[USER]
 Automation Engine 193

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:
Port number=DNS Name
Port number=TCP/IP Address

Example INI File

[GLOBAL]
system=UC4
language=(E,D)
timeout=60
TRACE=1

[USER]
client=3
user=smith
dept=uc4
pass=

[CP_LIST]
2217=uc4srv01

See also:

Notes for Configuration-File Adjustments

Utility for NSK

Structure of the INI File UCXBNS1I

Section/Parameter Description
[GLOBAL]
system= The name of the AE system.

This entry must be identical to the entry in the INI file of the Automation
Engine.
helplib= The name of the message file,
194 Chapter 3 Configuration

language= Language in which the logging is executed. Entries for primary and secondary
language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

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

searched for.
logging= The name of the log file.

The number signs serve as place holders for a series in numerical order.
When starting the agent, the log files are renamed so that the most current log
file is always the one with the number "00".
logcount= The number of stored log files.
timeout= The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.

Default value: 60
TRACE Trace designation.

Allowed values:
"0" (default) = Deactivate trace
"1" = Activate trace

If the trace parameter is set to 1, additional information is written to STDOUT

[USER]
client= 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:
Port number=DNS Name
Port number=TCP/IP Address
 Automation Engine 195

Example of an INI File

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

Notes for Configuration-File Adjustments

Utility for z/OS

Structure of the INI File UCXBM25C.INI

Section/Parameter Description
(GLOBAL)
system= Name of the AE system

This entry must be identical to the entry in the INI file of the Automation
Engine.
helplib= Name of the message file
language= Language in which the logging is executed. Entries for primary and secondary
language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

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

searched for.
196 Chapter 3 Configuration

timeout= 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= Name of the CodeTable objectCodeTable 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 QueueQueue object in which the CallAPI should
be executed.

This parameter overrides the setting API_QUEUE in the variable UC_

CLIENT_SETTINGS.
(USER)
client= Logon specifications: Client

Logon data from this section is used when no logon data is specified at
service-program call
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:
Port number=DNS Name
Port number=TCP/IP Address

Example of an INI File

(GLOBAL)
system=UC4
helplib='UC4.UC.MSL'
language=(E,D)
timeout=60
;queue=

(USER)
client=
user=
dept=
pass=

(CP_LIST)
2217=uc4srv01
; 2218=uc4srv02
 Automation Engine 197

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:

Notes for Configuration-File Adjustments

Utility for OS/400

Structure of the INI File

Section/Parameter Description
[GLOBAL]
system= The name of the AE system.

This entry must be identical to the entry in the INI file of the Automation
Engine.
helplib= The name of the message file.
language= The language in which the logging is processed. Entries for primary and
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

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

searched for.
logging= 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=
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.
198 Chapter 3 Configuration

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: The name of the user.
dept= Login specifications: The department of the user.
pass= Login specifications: Password (optional).
[CP_LIST] or [CPLIST] The address of the communication processes in the AE system.

Allowed formats:
Port number=DNS Name
Port number=TCP/IP Address

Example of an INI File

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

Notes for Configuration-File Adjustments

 Automation Engine 199

Utility for UNIX

Structure of the INI File UCXBXXXC.ini

Section/Parameter Description
[GLOBAL]
system= The name of the AE system.

This entry must be identical to the entry in the INI file of the Automation
Engine.
helplib= The name of the message file.
language= The language in which the logging is executed. Entries for primary and
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

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

searched for.
logging= The path and file name of the log file.

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

The number signs serve as place holders for a series in numerical order.
When starting the agent, the log files are renamed so that the most current log
file is always the one with the number "00".
logcount= The number of stored log files.
timeout= The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.

Default value: 60

With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
queue= 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 login data is specified at service-
program call
200 Chapter 3 Configuration

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

Example of an INI File

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

Notes for Configuration-File Adjustments

Utility for VMS

Structure of the INI File UCXBVXXC.INI

Section/Parameter Description
[GLOBAL]
system= The name of the AE system.

This entry must be identical to the entry in the INI file of the Automation
Engine.
helplib= The name of the message file.
 Automation Engine 201

language= The language in which the logging is processed. Entries for primary and
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

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

searched for.
logging= The path and file name of the log file.

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

The number signs serve as place holders for a series in numerical order.
When starting the agent, the log files are renamed so that the most current log
file is always the one with the number "00".
logcount= The number of stored log files.
timeout= The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.

Default value: 60

With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
queue= 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 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:
Port number=DNS Name
Port number=TCP/IP Address
202 Chapter 3 Configuration

Example of an INI File

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

Notes for Configuration-File Adjustments

Utility for VSE

Structure of the INI File UCXBVSE.INI

Section/Parameter Description
(GLOBAL)
system= The name of the AE system.

This entry must be identical to the entry in the INI file of theAutomation
Engine
helplib= The name of the message file.
language= The language in which the logging is processed. Entries for primary and
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

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

searched for.
timeout= The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.

Default value: 60
 Automation Engine 203

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 login data is specified at service-
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:
Port number=DNS Name
Port number=TCP/IP Address

Example of an INI File

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

Notes for Configuration-File Adjustments

204 Chapter 3 Configuration

Utility for Windows

Structure of the INI File UCXBXXXC.INI

Section/Parameter Description
(GLOBAL)
system= The name of the AE system.

This entry must be identical to the entry in the INI file of the Automation
Engine.
helplib= The name of the message file.
language= The language in which the logging is processed. Entries for primary and
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

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

searched for.
timeout= The time in seconds during which the CallAPI waits for a response from the
Automation Engine. If this is exceeded, the CallAPI ends with a timeout error.

Default value: 60

With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
queue= The specification of a particular QueueQueue object in which the CallAPI
should be executed.

This parameter overrides the setting API_QUEUEin the variable UC_

CLIENT_SETTINGS.
(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).
(TRACE)
file= The path and the file name of the trace file.

The number signs serve as placeholders for a series in numerical order. 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= The number of stored trace files.
 Automation Engine 205

(CP_LIST) The address of the communication processes in the AE system.

Allowed formats:
Port number=DNS Name
Port number=TCP/IP Address

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:

Notes for Configuration-File Adjustments

RFC Server
Default values have been specified for the most parameters. They can be changed if needed.
Parameters that must be adjusted to your system environment at any case are written in red letters.

Structure of the INI File UCXBRXXC.INI

Section/Parameter Description
[GLOBAL]
system= AE system.

This entry must be identical to the entry in the INI file of the Automation
Engine.
206 Chapter 3 Configuration

logging= The path and file name of the log file.

The number signs serve as place holders for a series in numerical order.
When starting the agent, the log files are renamed so that the most current log
file is always the one with the number "00".
logcount= The number of stored log files.
language= The language in which the logging is processed. Entries for primary and
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

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

searched for.
Helplib= 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.
max_logging_kb= The maximum size of the log file.

A new log file is created when the size specified here has been reached.

Default value: 1000 KB

log_to_file= This refers to the 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.
TimeOut= The time in seconds during which the CallAPI waits for a response from AE. If
this is exceeded, the CallAPI ends with a timeout error.

Default value: 60

With the parameter timeout=0 being used, the CallAPI waits (without time
limit) until the Automation Engine acknowledges.
[USER]
client= 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
 Automation Engine 207

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

Allowed values: "0" (default), "1"

"0" = RFC Trace is created

"1" = No RFC Trace is created.

unicode= Use of "Unicode"- coding in the SAP system.

Allowed values: "0" (default), "1"

"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
208 Chapter 3 Configuration

Example of an INI File

[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

See also:

Notes for Configuration-File Adjustments

Connect for WebSphere MQ Queue Manager (Windows)

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 UCXBMQCX.INI

Section/Parameter Description
[GLOBAL]
system= Name of the AE system. *
This entry must be identical to the entry in the INI file of the Automation
Engine.
 Automation Engine 209

language= Language in which the logging is executed. Entries for primary and
secondary language.

Allowed values: "E", "D", "F"

Default: "E,D" (Primary English, secondary German)

If there is no 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 place holders for a series in numerical order.
When starting the AE Connector, 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.
helplib= Name of the message file.
helpcache= Availability of the messages and language-dependent strings.

Allowed values: "ALL", "NONE", "CONTROLS"

Default: "ALL"
"ALL" = The complete message file is held in the RAM.
"NONE" = Always read from the hard drive.
"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.

Allowed values: "0" - "2"

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
restart or after a lost connection.
[TRACE]
210 Chapter 3 Configuration

file= Path and file name of the trace file.

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 always the one with the number "00".
trccount= Number of stored trace files.
trclevel= Amount of messages output in the trace file.

Allowed values: "0" - "2"

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
 Automation Engine 211

Example of an INI File

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

Notes for Configuration-File Adjustments

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.
212 Chapter 3 Configuration

2. Use the Export/Import functionExport/Import function in the UserInterface.

3. Use the Transport CaseTransport Case for 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 AttributesAttributes 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 when the System 0000
ASSIGNMENT overview area "Host Assignment" is used
UC_AS_ Advanced Security administrator, AE DB Load 0000
SETTINGS
UC_AUTO_ Auto-Forecast data AutoForecast (changes automatically xxxx
FORECAST changed when AutoForecast is used)
UC_CALENDAR_ Calendar periods administrator xxxx
PERIOD or
0000
UC_CLIENT_ Various client settings administrator xxxx
SETTINGS
UC_EX_ERP_ Connections to administrator 0000
CONNECT Enterprise Business
Solutions
UC_EX_ Assigning agents to host administrator 0000
HOSTCHAR characteristics
UC_HOSTCHAR_ Host characteristics administrator 0000
DEFAULT
UC_ILM_ Partitions in the AE administrator, AE DB Load 0000
CONTAINER_* database
UC_ILM_ Settings - Partitioning administrator, AE DB Load 0000
SETTINGS with ILM
UC_JOB_ Periodical time check in administrator 0000
CHECKINTERVAL the Automation Engine
UC_LDAP_ LDAP connection administrator xxxx
EXAMPLE or
0000
UC_LOGIN_ Additional types for Login administrator 0000
TYPES objects
UC_OBJECT_ Counter reading is part of administrator xxxx
COUNTER the object name or
0000
 Automation Engine 213

UC_OBJECT_ Documentation of administrator xxxx

DOCU objects or
0000
UC_OBJECT_ Object types and their administrator xxxx
TEMPLATE templates or
0000
UC_REPORT_ StyleSheets for XML administrator xxxx
STYLESHEETS reports or
0000
UC_SENDTO Internal/external handling administrator xxxx
UC_SENDTO_ of objects and tasks or
ACT 0000
UC_STATISTIC_ Controls the Statistics administrator xxxx
OPTIONS or
0000
UC_SYSTEM_ System-wide settings administrator 0000
SETTINGS
UC_USER_ Single Logon (automatic administrator 0000
LOGON logon)
UC_SAP_XJBP_ Event types of the Java This variable is supplied in the system client 0000
EVENTTYPES Scheduler in SAP and should not be changed manually.
UC_UTILITY_ Specifications for This variable is maintained by AE DB Archive xxxx
ARCHIVE archiving runs and must not be changed. or
0000
UC_UTILITY_DB_ Executed reorganization This variable is maintained by AE DB Unload 0000
UNLOAD runs and must not be changed.
UC_UTILITY_ Specifications for This variable is maintained by AE DB Reorg xxxx
REORG reorganization runs and must not be changed. or
0000
UC_SNMP_ SNMP values This variable is maintained by the Automation 0000
VALUES Engine and must not be changed.
UC_USER_HOST Host name for the Automatically with login xxxx
UserInterface or
0000
UC_USER_ Language character for Automatically with login xxxx
LANGUAGE the 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
214 Chapter 3 Configuration

Description

This variable is automatically adjusted when the list of active Agent/Client Assignment objects is changed
in the System OverviewSystem 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
"AES-192" - 192-bit key length
"AES-256" - 256-bit key length
 Automation Engine 215

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.
216 Chapter 3 Configuration

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:

Overview of all variables in table form

Variable
Calendar

3.2.6 UC_CLIENT_SETTINGS - Various Client Settings

 Automation Engine 217

Some settings that are stored in the AE Variables can differ from client to client. They regulate the
system's behavior when a Automation Engine starts, or the authorization system's access control
management, they determine the maximum life-span of user passwords, or log the system status.

The same settings are also available in the Client object and can be edited here.

Key Value Restart

required
ALIAS_ The indication of specific characters that are allowed to be used in No
SPECIAL_ the alias names of workflow tasks.
CHARACTERS
Default value: -#

Blanks are ignored.

API_QUEUE The Queue object that is used to execute CallAPI scripts. No

Default value: "CLIENT_QUEUE"

AUTO_ The number of days that are included in the AutoForecast No
FORECAST_ calculation.
DAYS
Default value: "1"
AUTO_ The beginning of the names of Forecasts that are created by the No
FORECAST_ AutoForecast.
PREFIX
CALE_LOOK_ The maximum number of days that is considered for calculating the No
AHEAD_MAX next valid date based on Calendar conditions.

Allowed values: "0 - 9999"

Default value: "14"
CALE_WARN_ The Notification that is activated if the advance expiration warning Server
CALL_ occurs.
OPERATOR
CALE_WARN_ The number of days prior to a calendar's expiration date that Server
LEVEL triggers an advance warning.
CLIENT_ The priority of the client. No
PRIORITY
Allowed values: "200" - "255"
CLIENT_ "GO" - Automatic processing is active. UserInterface
STATUS "STOP" - Automatic processing is stopped.
DEPLOYMENT_ This activates the client's deployment functionality. UserInterface
CLIENT
Allowed values: "Y" and "N" (default value)

"Y" - This activates the deployment functionalities.

"N" - This deactivates the deployment functionalities.
EH_KICK_ The refresh interval that can be specified for the task view in the No
INTERVAL Activity Window and monitors.

Default value: 3 seconds

218 Chapter 3 Configuration

ERT_METHOD The method to evaluate the estimated runtime (ERT). No

Allowed values: FIXED, MAXIMUM, AVERAGE, LINEAR_

REGRESSION

"FIXED" - Static predefined value.

"AVERAGE" - Dynamically determined average.
"LINEAR_REGRESSION" - Dynamically based linear regression.
"MAXIMUM" - Dynamically longest real runtime.

Default value: "LINEAR_REGRESSION"

ERT_FRT The fixed value for the estimated runtime in seconds. No

Three-digit value, default: "0"

ERT_CHECK_ The number of calculated runs. No
COUNT
Two-digit value between "1" and "25", default: "20"
ERT_CORR_ The positive correction value in percent. No
PERCENT
Three-digit value, default: "0"
ERT_IGNORE_ The deviation in percent. No
PERCENT
Three-digit value, default: "0"
ERT_MINIMUM_ The minimum number of runs that should be counted for deviation. No
COUNT
Two-figure value between "1" and "ERT_CHECK_COUNT",
default value: "0"
ERT_ The determination of the estimated runtime (ERT) by the No
CALCULATION 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 reports. No

Allowed values: 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 AE objects.
 Automation Engine 219

FIRST_DAY_OF_ The starting day of the week. No

WEEK
Allowed values: 1 - 7
Default value: "2"

"1" - Sunday
"2" - Monday
"3" - Tuesday
"4" - Wednesday
"5" - Thursday
"6" - Friday
"7" - Saturday
FIRST_WEEK_ The definition of the week that is regarded the first calendar week No
METHOD 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 saving Workflows. UserInterface
INCOMPLETE
Allowed values: YES, NO or ASK (default)

"YES" - The workflow will always be saved.

"NO" - The workflow cannot be saved because there are still tasks
that have no predecessors and/or successors.
"ASK" - A query displays and asks whether the workflow should be
saved.
MAX_USER_ The maximum number of UserInterfaces that can be logged on at No
INTERFACES the same time.

Allowed values: "1" to max. license count

NOW_MINUS The number of years that is considered in dynamic Calendar No
calculation.

Allowed values: "1" to "5"

Default value: "1"
NOW_PLUS The number of years that is considered in dynamic Calendar No
calculation.

Allowed values: "1" to"10"

Default value: "6"
OBJECT_AUDIT The logging for the revision report. No

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 that the system waits for a task's PromptSet No
RESPONSETIME dialog to be confirmed.
The task aborts if this time is exceeded.

Default value: 10080 minutes (= 1 week)

220 Chapter 3 Configuration

PROMPT_ The time in minutes that the system waits for a user to log on in No
TIMEOUT order to display a PromptSet dialog.

Default value: 10080 minutes (= 1 week)

PWD_AGE_MAX The life span of the user passwords in days. No
PWD_ The number of invalid login attempts. No
ATTEMPTS_MAX
PWD_ You can use this key to force the use of lowercase letters in user No
CONTAINS_ passwords.
LOWER_CASE
Allowed values: "Y" and "N" (default value)
PWD_ You can use this key to force the use of numbers in user No
CONTAINS_ passwords.
NUMBER
Allowed values: "Y" and "N" (default value)
PWD_ You can use this key to force the use of special characters in user No
CONTAINS_ passwords.
SPECIAL_
Allowed values: "Y" and "N" (default value)
CHARACTER
PWD_ You can use this key to force the use of uppercase letters in user No
CONTAINS_ passwords.
UPPER_CASE
Allowed values: "Y" and "N" (default value)
PWD_FORBID_ You can use this key to forbid user names in user passwords. No
LOGIN
Allowed values: "Y" and "N" (default value)
PWD_ The number of the last n passwords that must not be used again. No
GENERATION
Allowed values: "1" - "99"
Default value: "0"

"0" signals that the password is not checked against older

passwords
PWD_LENGTH_ The maximum length of user passwords. No
MAX
Allowed values: "0" - "32"
Default value: "32"
PWD_LENGTH_ The minimum length of user passwords. No
MIN
Allowed values: "0" - "32"
Default value: "0"
SEARCH_ The search for object use in script. No
SCRIPT_FOR_
Allowed values: "Y", "L" and "N" (default value)
USAGE
"Y" - Search for objects used in scripts (with regular expressions).
"L" - Search for objects used in scripts (normal search without
regular expressions).
"N" - No search for object usage in scripts.
 Automation Engine 221

SECURITY_ The authorization system's access control management. No

AUDIT_FAILURE
"HOST_ACCESS" - All the denied attempts to access a host will
be logged.
,"LOGON" - All the denied login attempts will be logged.
"OBJECT_ACCESS" - The denied attempts to access an object
will be logged.
"USER_PRIVILEGES" - All denied user privileges will be logged.
SECURITY_ The authorization system's access control management. No
AUDIT_
"HOST_ACCESS" - Authorized host accesses will be logged.
SUCCESS
"LOGON" - Authorized logins will be logged.
"OBJECT_ACCESS" - Authorized object accesses will be logged.
"USER_PRIVILEGES" - Authorized user privilege uses will be
logged.
SMTP_FROM_ The sender's email address. No
ADDR
SMTP_LOGIN The name of the Login object that is used to log on to the SMTP No
Server.
SMTP_MAX_ The maximum size (in bytes) for the report file that is sent via No
ATTACHMENT_ email.
SIZE
Default value: "8000"
Minimum value: "400"
Maximum value: "50000"

In the Notification tab of the Notification object, you can enter the
RunID of a task whose reports should be included in the message.
The setting SMTP_MAX_ATTACHMENT_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 the response. No
TO
SMTP_SERVER The name of the SMTP Server. No
SMTP_TIMEOUT The maximum time in seconds that the system waits for an SMTP No
Server to respond.

Allowed values: "0" - "999"

Default value: "20"
STARTUP_ "STOP" - The system stops after the Automation Engine has Server
ACTION started.
"WAIT x" - The system waits x seconds after the Automation
Engine has started.
TASK_PRIORITY The priority of tasks. No

Allowed values: "1" - "255"

222 Chapter 3 Configuration

TEMPLATE_ This key affects the list of object types that is shown when objects No
SHOW_ALL are created.

Allowed values: "Y" (default) and "N"

"Y" - The selection dialog shows all AE object types.

"N" - The selection dialog only lists the object types that can be
created by the particular user.
VARA_ERROR_ Here you can specify the required behavior if Variable objects No
ON_ cannot be found whose value should be used to replace
REPLACEMENT placeholders in attributes at runtime.

Allowed values: "Y" (default value) and "N"

"Y" - An error occurs and processing aborts.
"N" - Processing continues. The value is assigned as specified and
no replacement takes place.
VERSION_ "Y" - The version control of objects is activated No
MANAGEMENT "N" - No version control takes place (default setting)
VERSION_ The part of the name that is inserted in objects that are created in No
MANAGEMENT_ the sequel of a Version Management.
SUFFIX
Default value: "OLD"
Maximum 8 characters
WAIT_STATE_ Stores specific information about tasks that are in a waiting status No
RECORDING because of a Queue in the AE Database.

Allowed values:
"QUEUE" - Logs information about the waiting condition of all the
Queue's tasks in the database.

This option is deactivated when you specify a different value or no

value (=default value).
XRO_REPORTS External report analysis. No

Allowed values: "Y" and "N" (default value)

"Y" - Report data of Jobs and FileTransfers are logged.

"N" - Reports are not logged.

Description

The AE Variable is supplied in system client 0000. From here, you can copy it to your own client and
customize it according to your requirements.

ALIAS_SPECIAL_CHARACTERS
The alias name of workflow tasks which can be set in the properties ( General tab) is limited to specific
characters. To allow characters in the alias names that are usually not available (such as "-"), you can
make use of this setting.

All the characters that should be allowed must be entered in a row, blanks will be ignored. The order of the
individual characters is irrelevant.

For example: To allow the characters "-", ":" and "+", you must specify the value in the format -:+.
 Automation Engine 223

API_QUEUE
In the Automation Engine, all tasks start in a Queue object. This also includes the execution of CallAPI
scripts. By default, the Client Queue (CLIENT_QUEUE) is used for CallAPIs. This key can be used to
specify a particular Queue object.

AUTO_FORECAST_DAYS
The Auto Forecast creates forecast data for activities on the basis of the time period that is specified using
this key. The higher the number of days, the longer the time that is required for the AutoForecast
calculation.

AUTO_FORECAST_PREFIX
The Auto Forecast creates forecast data for activities that run in Schedules and Events. A prefix needs to
be defined for these specific forecast data so that they can be distinguished from individually-created
forecasts. The whole forecast name consists of a prefix, the object's name, a date and must not exceed
200 characters.

CALE_LOOK_AHEAD_MAX
The maximum number of days that is considered when you calculate the next valid date using the script
element CALE_LOOK_AHEAD can be specified in this Variable on a client-wide basis. The default value
is "14". Keep this value low if you specify individual values in order to avoid performance losses.

CALE_WARN_LEVEL and CALE_WARN_CALL_OPERATOR

When the Automation Engine starts and when a new day begins, the validity dates of all Calendars are
checked whether they expire within the defined number of days. The specified Notification starts for each
Calendar whose validity date expires. The name of the Calendar can be read in the script using the READ
buffer as shown below:
:READ &UC_CAUSE_NAME,,
No alert is sent for Calendar objects of the system client 0000 because you cannot activate objects in
this client.

CLIENT_PRIORITY
You can specify a priority of AE's internal processing for each client. This includes that you can reduce the
priority of a non-productive client compared to a productive client. The default setting is 200 (see also: AE
priority).

CLIENT_STATUS
You can stop automatic processing and release it within a client. To change the system status, the User
requires the relevant privilege in order to do so. Only the system itself can write to the AE Variable.

DEPLOYMENT_CLIENT 

If the client should be used for Application Release Automation, you can use this setting in order to
activate its Deployment functions.

Note that you cannot use the system client 0000 as a Deployment client.

When you activate this setting (Y), the Deployment tab becomes available in Workflows and the General
tab, which is available in the properties of Workflow tasks, includes the option "Run per Patch" .

EH_KICK_INTERVAL
If the properties of a task have changed (for example, start, status, end), the UserInterface receives a
message from the Server and the Activity Window and monitor view can be refreshed. You can specify the
224 Chapter 3 Configuration

interval in which messages should be sent to the UserInterface in this key. In doing so, messages are sent
in blocks which has positive effects on the performance of your system. 

No message is sent to the UserInterface if tasks do not change during an interval.

ERT_*
By deactivating the estimated runtime (ERT) calculation, you can improve the performance of the
Automation Engine. If it is deactivated (ERT_CALCULATION/BATCH), you can determine it
subsequently for all objects in the database. Use the utility AE.DB Load in order to load the file UC_UPD_
ESTIMATE_ERT.TXT. The duration for calculating the expected runtime depends on the number of
objects that is involved.

The file UC_UPD_ESTIMATE_ERT.TXT contains a line at its end that calls the ERT calculation
function. If you specify a client, ERT calculation takes place in this client, otherwise the whole system
is included in the calculation.

For example:
ESTIMATE_ERT 1000

All other validity keys that start with "ERT_" form the default values for calculating the expected runtime
(ERT). You can adjust them in the Runtime tab of each object if needed.

EXT_REPORTS
You can use this entry in order to specify whether extended reports should be created in addition to
standard reports, and which ones.

FIRST_DAY_OF_WEEK and FIRST_WEEK_METHOD

The key FIRST_WEEK_METHOD can be used to define the first calendar week of a new year. By default,
the week that includes at least 4 days of a new year is used as the first calendar week. You can also
determine the starting day of a week using the entry  FIRST_DAY_OF_WEEK (default: Monday).

Note that the definitions that are made for the first calendar week influence the results of the script
function WEEK_NR which retrieves the calendar week.

JOBP_SAVE_INCOMPLETE
The tasks of a Workflow must be linked with lines in order to have them executed in the required order. You
can define a predecessor and a successor for each task. You can set storage properties using the
entry JOBP_SAVE_INCOMPLETE if some lines are missing. In this case, you can specify that the
Workflow should be stored (YES) or not (NO), or that it should only be stored after a request (ASK).

MAX_USER_INTERFACES
For each client, you can specify the maximum number of UserInterfaces that can be connected to the AE
system at the same time. If there is no entry, the system uses the value that is defined in the license. You
find this value in the "License" category ("DC" line) of the System Overview.

NOW_MINUS and NOW_PLUS

It is not required to specify a validity period if you create a Calendar keyword. The days are automatically
calculated on the basis of the determined date intervals. You can use these two keys to specify the
number of years that should be calulated to the past and to the future.

OBJECT_AUDIT
This setting can be used to activate object logging and store the results in Revision Reports.

PROMPT_RESPONSETIME, PROMPT_TIMEOUT
 Automation Engine 225

These settings define the maximum waiting time for a task that includes PromptSets. Depending on the
particular situation, the task aborts if this time is exceeded.

l PROMPT_RESPONSETIME
Maximum time that the system waits until the user confirms a task's PromptSet input prompt. It is
irrelevant whether the dialog includes one or several PromptSet objects. The task aborts if this time
is exceeded. The time is reset when the input dialog is confirmed with "Done" (this is relevant for
Workflows, that display the PromptSet dialogs of several tasks in succession).

l PROMPT_TIMEOUT
If a PromptSet input mask cannot be displayed because the particular user has not logged on, the
corresponding task switches to the waiting condition "Waiting for user input". In this case, the
maximum waiting time is the time that has been determined in PROMPT_TIMEOUT. The task
aborts if this time is exceeded.
The PromptSet dialog is called if the user logs on again within this time period.

The task aborts if the graphical interface is closed (UserInterface) although the PromptSet dialog is still
open.

PWD*
Settings for user passwords:

PWD_AGE_MAX
MAX_PASSWORD_AGE used in the key "Freely selected" serves to define the maximum life span of
user passwords. The value specifies the number of days (as an integer) that a password is valid. If 75% of
the value's life span is over, users are informed that the password will soon expire when they log on. If the
password has already expired, it must be changed the next time a user logs on. If there is no entry for this
key (default value), the system does not check the expiration time.

PWD_ATTEMPTS_MAX
Here you can limit the number of invalid login attempts. Users who exceed the specified value will be
locked. Authorized persons can unlock affected users in the corresponding User object. By default, the
number of invalid login attempts is not limited. The time delay until the message "Access denied" displays
increases as of the third invalid attempt.

PWD_GENERATION
This setting defines the last n passwords that must not be used again. The new password must differ from
these last n passwords. The Automation Engine stores all passwords and this key only determines the
number of passwords that are compared with the new password.

All other keys that start with "PWD" define the criteria that a user password must meet.

If no value is specified for the above settings, the system searches for a default value in the AE
Variable UC_SYSTEM_SETTINGS. It uses the fixed default value if it does not include these PWD
keys.

SEARCH_SCRIPT_FOR_USAGE
When deleting, renaming or manually searching the use of an object, AE checks if this object is used in
other objects as well (for example, in Schedules). If so, you can have a list of all these objects displayed.
With the specification of the key SEARCH_SCRIPT_FOR_USAGE and the values "Y" and "L", objects
that are used in Scripts (for example, ACTIVATE_UC_OBJECT) are included in the search. There are
different search types:

"Y" - The searched string is handled as a word that is enclosed in delimiters such as blanks, left and right
parentheses, equals, commas, single quotations, double quotations, end of lines and script ends.

For example: Searching for MM only lists results in which this term is enclosed in the listed delimiters.
226 Chapter 3 Configuration

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

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_AUDIT_FAILURE and SECURITY_AUDIT_SUCCESS

The Authorization System's access trace function can be defined for each individual client. You can log
authorized and/or denied accesses in the categories login, privilege, host access and object access.
Single assignments to variable values must be separated by commas. Specify the variable values exactly
as described (case sensitive). Single assignments to values are not case sensitive.

The access trace function can be reviewed in the System Overview (provided that the required privileges
are assigned). Each access results in a security message that informs about the access time, user,
access category, host and the actual access. Host information is only available if the user is logged on to
the UserInterface. Usually, you cannot retrieve host information for tasks that are activated at runtime.

If an unknown user makes an attempt to log on to the system, the access denial is logged in client 0000
provided that the access trace function is activated in the AE Variable of client 0000.

SMTP_*
These settings are part of the Automation 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.

STARTUP_ACTION
By using the entry STARTUP_ACTION in the scope "Freely selected", you can influence the behavior of
the system after the Automation Engine has started. The client can either stop automatic processing when
the AE Server starts or suspend it specified period of time. By default, automatic processing is
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
1 stands for the highest, 255 for the lowest priority. If 0 is selected for executable objects in the Attributes
tab, 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 (see also: AE priority).

Note that 0 is the highest possible task priority. It can only be specified here.
 Automation Engine 227

TEMPLATE_SHOW_ALL
The content of the selection dialog that is shown while an object is created depends on the following
factors:

l The configuration of the AE Variable UC_OBJECT_TEMPLATE.

l The specification that has been made in TEMPLATE_SHOW_ALL.

If value "N" has been specified, only the object types that can be created by the particular user (for
example, the user has a "write" privilege) are listed.

If you specify "Y", the users can see all the object types but can only create objects for which they have
write access. If a filter has been placed in the authorizations (see: user, user groups), this filter is
compared to the name of the template when a new object is created.

VARA_ERROR_ON_REPLACEMENT

In the AE, you can insert values of Variable objects in the attributes of executable objects at runtime. As a
placeholder, specify the Variable name enclosed in { } brackets as and optionally the key and the column. 

Notation:
{ Variable object [, Key [, Column number ]] }

The placeholder is replaced by the corresponding value when the task is generated. The value of the
Result column (in dynamic variables) or the first Value column (in static variables) of the first entry (Key) is
used if neither a column nor a key have been specified.

The setting VARA_ERROR_ON_REPLACEMENTcan be used in order to determine whether the task

should be canceled if the specified Variable cannot be found. If "N" is used (system settings) and the
Variable object is not available, the attribute value including the invalid placeholder are assumed.

VERSION_MANAGEMENT and VERSION_MANAGEMENT_SUFFIX

The entry VERSION_MANAGEMENT can be used you determine whether the Version Management of
objects should be activated. If so, the entry VERSION_MANAGEMENT_SUFFIX is also important. It is
limited to 8 characters and is inserted in the name part of the object that has been duplicated for the version
management. Entries that include more characters are truncated. Note that the same naming conventions
apply for suffixes as for objects. Allowed are the characters: A-Z, 0-9, $, @, _, . and #. If you use German
Umlauts or do not enter a suffix, the default value "OLD" is used.

WAIT_STATE_RECORDING

This setting is only relevant when you want to monitor the time slot of tasks relating to Queues using the
Automic Product Predictive Analytics and / or Process Analytics.

When you set the value "QUEUE", the details of all tasks that are in a waiting status because of a Queue
stop or a Queue limit will be logged in the AE Database.

XRO_REPORTS
This key permits the activation of a particular logging that facilitates external report analyses of Jobs and
FileTransfers.

See also:

UC_SYSTEM_SETTINGS
Overview of all AE Variables in Table Form
Variable
228 Chapter 3 Configuration

3.2.7 UC_EX_ERP_CONNECT - Connection to Enterprise

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

Key Value New start required

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:

Overview of all variables in table form

Variable

3.2.8 UC_EX_HOSTCHAR - Assigning Agents to Host

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

Key Value New start required

Name of the agent Name part of the variable which contains host characteristics Agent
Maximum 188 figures

Default value: DEFAULT

 Automation Engine 229

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:

Overview of all variables in table form

Variable

3.2.9 UC_HOSTCHAR_DEFAULT - Host Characteristics

This variable is used to define the settings of one or more agents.

For FileTransfer 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.
230 Chapter 3 Configuration

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
requ ocol
ired
 Automation Engine 231

ANONYMO The usage of login data for the execution of Jobs and FileTransfers. Age Old
US_FT nt and
This setting is only supported for OS/400, UNIX and Windows agents.
ANONYMO new
US_JOB l ANONYMOUS_FT - for FileTransfers
l ANONYMOUS_JOB - for Jobs

Allowed values: Y and N (default)

This setting can be used to define whether the login data that is stored in
the Login object should be used to execute Jobs and FileTransfers. The
behavior also depends on the settings that are defined in the following INI-
file parameters of the agent:

INI file ANONYMOUS_JOB

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

Attention: Regardless of the settings that are defined here, the system
always checks when a job starts whether a Login object is available
that includes an entry for the particular platform. If there is no entry, the
job aborts. In FileTransfers, the following privilege is decisive:

Privilege FileTransfer: Start without Login object specified

If this privilege is available, FileTransfers can be processed although no

Login object has been assigned to them. Requirement: ANONYMOUS_
FT=Y and logon=0 (Windows) or login_check=no (UNIX).
232 Chapter 3 Configuration

APPLICATI The name of a Login object. Age

ON_LOGIN nt
The login data of the Login object is used for:

l PS agents: Login data for PeopleSoft

l OA agents: Login data for Oracle Applications
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
RETENTIO nt
All files and directories that have been stored longer than is specified in
N_CHECK
BACKUP_RETENTION_LIFETIME will be deleted.

The backup folder stores the files of the File Rollback of Jobs and
FileTransfers. You can define the backup folder using the Agent
Variable UC_EX_PATH_BACKUP in the agent's INI file.

In the Rollback tab, you can specify the files that should be copied to
the backup folder. They are stored automatically when a Job object or
FileTransfer object is processed.

Only affects Windows and Unix agents.

Allowed values: Valid time in the format HH:MM

Default value: "00:00"
BACKUP_ The life time in days for the content of the backup folder. Age
RETENTIO nt
In this key, you can determine how long files and directories will be stored
N_
in the backup folder. The system checks this setting daily at the time that
LIFETIME
is specified in BACKUP_RETENTION_CHECK. All files and directories
that have been stored in the backup folder for more than the specified days
will be deleted.

Only affects Windows and Unix agents.

Allowed values: "0" - "99"

Default value: "14"
BLOCK_ This entry can be used to define the action that a workflow should take if No
ON_LOST one of its jobs changes its status to ENDED_LOST.

Allowed values: YES (default value) and NO

YES - The workflow blocks.

NO - The workflow does not automatically block.
 Automation Engine 233

DISCONN This defines whether the connection between the agents ends after a Age Old
ECT_ FileTransfer. nt
AFTER_FT
YES - The connection ends after the FileTransfer (default value).
NO - The connection does not end after FileTransfer.

This parameter only affects the connection but not the execution of the
FileTransfer. The system always checks whether there is a connection
to the destination agent BEFORE the FileTransfer 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 / FileTransfers 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 FileTransfer 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
Allowed values: 60 - 100000
Default value: 60

If you select FILE_CHANGED or FILE_STABLE in a FileSystem

Event, this interval is used for all condition checks.

The interval increases automatically if checking a condition takes

longer than the specified interval.
234 Chapter 3 Configuration

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.
 Automation Engine 235

FT_ The settings for synchronous / asynchronous transfers between a sending No New
ASYNC_ and a receiving agent of FileTransfers. Asynchronous transfers are the
QUIT_ default setting.
MAX,
Synchronous transfer: Data packages are only sent when the receipt of
FT_
sent packages has been confirmed. Sender and receiver adjust their
ASYNC_
transmission speeds. A synchronous behavior is achieved when the
QUIT_MIN,
setting FT_ASYNC_QUIT_NUM equals FT_ASYNC_QUIT_MAX.
FT_
ASYNC_ Asynchronous transfer: Data packages are sent although confirmations are
QUIT_ still missing for sent packages. In doing so, data can be transferred faster
NUM because a faster sender or a slower connection are used more efficiently.
The agents' TCP/IP buffer (INI-file parameter: SendBufferSize= and
RecvBufferSize=) should be increased accordingly.
An asynchronous behavior is achieved when FT_ASYNC_QUIT_MAX is a
multiple of FT_ASYNC_QUIT_NUM.

The higher the value of FT_ASYNC_QUIT_MIN, the more the receiving

agent will be unburdened when FT_ASYNC_QUIT_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.
Minimum value: 0, default value: 30, maximum value: 50

FT_ASYNC_QUIT_NUM
Number of data packages that are confirmed per receipt.
Minimum value: 0, default value: 5, maximum value: 50

Note that the value that is specified as the MIN setting must not exceed
the MAX setting.

For example:

FT_ASYNC_QUIT_MIN / MAX / NUM:

0 / 1 / 1: Synchronous FileTransfer
0 / 10 / 5: Weak asynchronous transfer. The sending agent may send a
maximum of 10 non-confirmed data packages. If the maximum has been
reached, it waits until all receipts have been confirmed before it continues
the sending process.
30 / 60 / 5: Strong asynchronous transfer. The sender may send a
maximum of 60 non-confirmed data packages to the receiver. Receipts are
confirmed per 5 packages. The sender always waits until 30 non-confirmed
data packages are open before it starts the data transfer.
FT_ The compression type for FileTransfers. Age Old
COMPRES nt and
Allowed values: NO (default value) and NORMAL
S new
236 Chapter 3 Configuration

FT_ The duration in seconds after which an unused FileTransfer connection Age New
CONNECT between two agents is automatically terminated. nt
ION_
Default value: 300 seconds
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 FileTransfer restart information is Age New
RESTARTI checked. It is checked on a daily basis. nt
NFO_
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 FileTransfers is stored (life Age New
RESTARTI time). nt
NFO_
Minimum value: 1
LIFETIME
Default value: 14 days
FT_ The time interval in seconds in which the agents store the restart points Age New
RESTARTI during a FileTransfer. nt
NFO_
Minimum value: 1
INTERVAL
Default value: 60 seconds
FT_ The time interval in seconds in which the agents send the status Age New
STATUS_ information of FileTransfers to the Server. nt
INTERVAL
The status of FileTransfers is displayed in the task's detail window.

Minimum value: 1
Default value: 60 seconds
FT_USE_ MD5 checksum usage that allows for the files that have been transferred in Age New
MD5 FileTransfers to be checked. This method ensures that the transferred files nt
comply with the source files if the FileTransfer 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

 Automation Engine 237

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
Default value: 60 seconds

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
Default value: 600 seconds

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
Allowed values: Y (default value) and N
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 Age
FILE_ Events. nt
COUNT
Allowed values: 0 - 100000
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.
238 Chapter 3 Configuration

MAX_ This entry contains the maximum number of report blocks that should be Age
REPORT_ transferred to the AE database. nt
SIZE
Allowed values: 1 - 10000
Default value: 120 blocks

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)

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

Allowed values: 1 - 3600

Default value: 600 seconds
REPORT_ This entry contains the size of a report block. Age
BLKSIZE nt
Allowed values: 1 - 8000
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

Allowed values: 1 - 3600

Default value: 60 seconds
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.

Allowed values: 1 to 600

Default value: 600
 Automation Engine 239

WORKLOA The maximum number of resources that the agent provides for No
D_MAX_FT FileTransfers.

Allowed values: -1 to 100000

Default values: -1

The value -1 corresponds to UNLIMITED which means that the resource

settings are ignored when the FileTransfer is processed.

Values above 100000 are read as -1.

The value for WORKLOAD_MAX_FT can also temporarily be set in the

System Overview.
WORKLOA The maximum number of resources that the agent provides for Jobs. Age
D_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:

Overview of all variables in Table Form

Variable

3.2.10 UC_ILM_CONTAINER_* - AE 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
240 Chapter 3 Configuration

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
2 UC4_DATA_STATISTICS_2
3 UC4_DATA_STATISTICS_3

We assume that three partitions should be online. The Automation Engine starts to store the data records
in container "1". After a partition change, the data records are stored in container "2" etc. After container
"3", the Automation Engine starts again with container "1".

The variable UC_ILM_SETTINGS contains the number of the current container in its key ACT_
CONTAINER.

Important notes:

l All three variables must have the same number of entries. It is not possible to use five partitions for
statistical records but only three for reports.
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:

Overview of all variables in Table Form

Variable
Partitioning with ILM

3.2.11 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
Allowed values: "1" - "999"
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.
 Automation Engine 241

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.
242 Chapter 3 Configuration

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
Allowed values: "1" - "999"
RETRY_ Maximum number of attempts to change the partition until ILM is No
MAX_ automatically deactivated.
COUNT
Allowed values: "1" - "3200"
Default value: "3"
RETRY_ Time (in minutes) to wait between attempts to change the partition No
TIME (RETRY_MAX_COUNT).

Allowed values: "1" - "3200"

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

Allowed values: "0" - "1400"

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.

Allowed values: "60" - "32000"

Default value: "3600"

When it is time to change the partition, processing in the AE system comes

to a halt and waits until all work processes have ended their ongoing
database transactions. The key TIMEOUT is decisive for the maximum
waiting time. No new partition can be created if this period of time is
exceeded.
 Automation Engine 243

Description

This variable is supplied in system client 0000. Its settings apply to the whole AE system and can only be
modified in client 0000.

It contains the settings for partitioning with ILM.

See also:

Overview of all variables in Table Form

Variable
Partitioning with ILM

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

Key Value New start required

* Time interval Server

Default value: 20 Seconds

See also:

Overview of all variables in table form

Variable

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

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

l Method A: Name the copy "UC_LDAP_domain". If the domain name is "SMITH", the variable name
must be "UC_LDAP_SMITH".
l Method B: User object names are composed of name and department. The copy of the variable can
be renamed to "UC_LDAP_department". 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
244 Chapter 3 Configuration

when the domain name (or fully qualified domain name) does not meet the Automic object naming
conventions. For domain alias, we recommend using the fully qualified domain name.

German umlauts cannot be used in domain names.

By default, the domain indicated in the name of the variable is used. You can also specify the alias in
the key DOMAIN_ALIAS which is then used instead of the domain name.

Indicate Server name and port. The keys that start with "USR" define the LDAP attributes from which the
LDAP connection should read the e-mail address, as well as the first and last name when synchronizing
user data. All three information types are stored in the User object.

Key Value New

start
required
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.
 Automation Engine 245

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.

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

USR_LASTNAME LDAP attribute from which the last name should be read No

E.g.: "sn" in the Microsoft Active Directory

See also:

Overview of all variables in Table Form

Variable

3.2.14 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 objectsLogin
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 TypeType 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:
246 Chapter 3 Configuration

Overview Table of all variables

Variable

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

Key Value New start required

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:

Overview of all variables in table form

Variable

3.2.16 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."
 Automation Engine 247

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
248 Chapter 3 Configuration

If you import a Schedule object that contains the Documentation tab "Contacts", the following tabs are
shown afterwards: "General", "Details" and "Contacts."

See also:

Overview of all variables in table form

Variable
Documentation Tabs

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

Key Value New start required

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 variableUC_CLIENT_SETTINGS and users only see the object types they are allowed to
create.
 Automation Engine 249

First define an appropriate name in the key that is by default an object-type abbreviation (such as
JOBS.R3). Enter the name of a template in the value section. These object templates are either supplied in
the folder "Template" of system client 0000 or have individually been created.

If you want to create an individual template, simply create an object (such as a FileTransfer). Then enter its
name in the variable UC_OBJECT_TEMPLATE. Automic recommends using significant names and an
extra folder for these templates. If a user creates an object using this template, by default the suggested
name is composed of the template name, the term "NEW" plus a serial number (such as JSCH.NEW.2) or
a counter. It is also possible to define more than one template per object type.

Templates can be adjusted according to your requirements at any time. They should make it easier for
users to create objects (such as a template for an agent in Unix jobs). Note that users can adjust these
templates, the pre-filled lines are only suggestions.

If a client contains its own UC_OBJECT_TEMPLATE, it is also possible to provide a collection of own
templates. A template is always first searched in the particular client. If it is not available in the client, the
corresponding template of system client 0000 is used. If no template is found, the corresponding entry is
not displayed in the selection list.

Pay attention in system client 0000: Entries can be added to the object UC_OBJECT_TEMPLATE but
the supplied standard entries MUST NOT be deleted. Otherwise, problems occur in XML imports.

Example

Excerpt of variable UC_OBJECT_TEMPLATE:

250 Chapter 3 Configuration

Key Value
Cockpit CPIT
Notification for alarm messages CALL_ALARM
Notification for requests CALL_REQUEST

See also:

Overview of all variables in table form

Variable

3.2.18 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 typereport 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 StyleSheetsStyleSheets 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.19 UC_SAP_JXBP_EVENTTYPES - Event Types of the

Java Scheduler in SAP
This variable stores the possible Event types of the SAP Java Scheduler.
 Automation Engine 251

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 EventsSAP 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.20 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.

Key Value New start required

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:
252 Chapter 3 Configuration

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#
 Automation Engine 253

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:

Overview of all variables in table form

Variable

Explorer
Activity Window

3.2.21 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
254 Chapter 3 Configuration

Description

This variable is supplied in client 0000. Its content applies to the whole AE system. The Automation
Engine automatically updates it whenever necessary.

No manual interference is required; entries are automatically supplied with values and maintained.

See also:

Overview of all variables in Table Form

Variable
About SNMP

3.2.22 UC_STATISTIC_OPTIONS - Controlling the Statistics

Functions
This variable controls the extent of the statistics.

Key Value New start required

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:

Overview of all variables in table form

Variable

3.2.23 UC_SYSTEM_SETTINGS - System-Wide Settings

This AE variable contains settings that apply throughout a whole AE system.

Validity Value Restart

required
 Automation Engine 255

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

COUNT_PER_ used for checking the license.
IP
Allowed values: "Y" (default) and "N"
"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 in which tasks are checked that wait for the No
CHECK_ host of an agent group.
INTERVAL
Allowed values: 1 to 60
Default value: 10
BACKENDVAR_ The maximum number of lines that a BACKEND-type Variable No
MAX_ROWS object returns.

Allowed values: 0 to 20000

Default value: 200
CHANGE_ The time period in days after which the log files are changed. No
LOGGING_
Allowed values: 1 to 32767
DAYS
Default value: 14
CHANGE_ The specification of a size in megabytes after which the log files are No
LOGGING_MB changed.

Allowed values: 1 to 32767

Default value: 20
CONDITION_ The time interval in seconds in which the Preconditions tab of No
CHECK_ workflows is rechecked.
INTERVAL
Default value: 60
DEFAULT_ The size in MB which is requested for the output analysis by default No
REPORT_ when you read a report.
SCAN_
Allowed values: 1 to 50
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
Allowed values: 0 to 100
Default value: 10
256 Chapter 3 Configuration

DISABLE_ No user-defined Includes are called in the Headers and Trailers of No

USER_HEADER Job objects that run on the platforms that are defined here.

Allowed values: BS2000, CIT, GCOS8, JMX, MPE, MVS, NSK,

OA, OS400, PS, SAP, SAPBW, SIEBEL, UNIX, VMS,
WINDOWS or *ALL.

Separate values by using commas.

By default, all available Includes are executed.

EXECUTE_ON_ The object that should start if a message is put to quarantine. No
EXCEPTION
EXTERNAL_ Interval in minutes in which external workflow dependencies are No
CHECK_ checked.
INTERVAL
Allowed values: 1 to 1440
Default value: 10
GENERIC_ The maximum number of activities that should be displayed. No
ACTIVITIES_
Allowed values: 0 to 20000
LIMIT
Default value: 5000
GENERIC_ The maximum number of AutoForecast results that should be No
AUTO_ displayed.
FORECAST_
Allowed values: 0 to 20000
LIMIT
Default value: 5000
GENERIC_ The maximum number of search results that should be displayed. No
SEARCH_LIMIT
Allowed values: 0 to 20000
Default value: 5000
GENERIC_ The maximum number of statistical records that should be No
STATISTICS_ displayed.
LIMIT
Allowed values: 0 to 20000
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.
LAST_USE The time delay in minutes after which the objects' usage counter is No
refreshed.

Allowed values: 0 to 10
Default value: 0 (no refresh is made)
LDAP LDAP connection. No

Allowed values: Y and N (default value)

Y - LDAP is used
N - LDAP is not used
 Automation Engine 257

LOG_TO_ This stores the Server log in the AE Database. Server

DATABASE
Allowed values: Y (default value) and N

Y - The Automation Engine's log messages are stored in the AE

Database.
N - The Automation Engine's log messages are not stored in the AE
Database.
MAX_EXPORT_ The maximum number of objects that should be exported at the No
COUNT same time.

Allowed values: 0 to 1000000

Default value: 1000
MAX_IMPORT_ The maximum size (KB) of the XML file that should 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.

Allowed values: 0 to 30720

Default value: 1024
MAX_REPORT_ The maximum size in MB which is requested for reading an Output No
SCAN_ Analysis report.
MEMORY
Allowed values: 1 to 100
Default value: 10
MIN_EVENT_ The minimum interval (minutes) in which events are executed. No
INTERVAL
Allowed values: 0 to 9999
Default value: 1
MQA_COUNT_ The number of Server messages that should be buffered in the No
BACK Server computer's random access memory.

Allowed values: 0 to 1000

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

Allowed values: 0 to 100000

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

Allowed values: 0 to 1000000

Default value: 600

Value 0 means that no check is made.

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
258 Chapter 3 Configuration

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) in which the Server processes attempt to Server
TIME establish a connection.

Allowed values: 10 to 3600

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

Allowed values: 3600 to 8000

Default value: 8000
REPORT_TIME The interval (seconds) in which the Server processes send the Server
logging to the AE system.

Allowed values: 5 to 3600

Default value: 30
RESERVED_ Te number of licenses reserved for CallAPI users. No
API_USERS
Allowed values: 0 to 32767
Default values: 0
SCR_ The time period in seconds after which an endless loop is assumed No
LOOPCHK_ in a script.
TIME
Allowed values: 1 to 32767
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 displays reports as subordinate No
REPORT_ tasks in the Activity Window.
HIERARCHICAL
Allowed values: "Y" (default) and "N"
"Y" - The Activity Window displays the report of a task as its child.
"N" - The Activity Window displays reports as individual tasks.

You need to 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

displays reports always as child tasks.
SMGR_PORT_ The indication of a port number or a port area that should be No
RANGE searched for ServiceManager services.

Default value: 8871 (default port of the ServiceManager)

Port area: maximum 10 port numbers
 Automation Engine 259

SNMP_ This setting controls the time interval (in seconds) in which SNMP No
REFRESH refreshes the information about blocked workflows.

Allowed values: 0 (= always) to 600

Default value: 10
SQLVAR_ This allows to create and edit Variable objects of type "SQL - No
INTERNAL 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 Variables No
ROWS with the type SQL and SQLI.

Allowed values: 0 to 20000

Default value: 200
SYNC_BLOCK_ The number of Sync objects whose logging should be changed per No
COUNT block.

Allowed values: 1 - 1000

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 that should be displayed in the No
SHOW_MAX Recycle Bin.

Allowed values: 0 - 20000

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 that should be kept. No
MESSAGES_
Allowed values: 10 to 5000
BUFFER
Default value: 500
260 Chapter 3 Configuration

VAR_ The security level for the replacement of variables in dynamic No

SECURITY_ Variable 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 in which the resolving of SQL variables is No
SERVICE_ repeated if their values are not available because of 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 that should be displayed in No
SHOW_MAX Version Management.

Allowed values: 0 - 20000

Default value: 5000
WORKLOAD_ The resources that a file transfer or job should use by default. No
DEFAULT_FT
Allowed values: 1 to 100000
WORKLOAD_
Default value: 1
DEFAULT_JOB
WP_MIN_ The minimum number of Server processes per node name that No
NUMBER should be 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 for 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 (default value) and N
CHECK
Y - The import files must have the encoding which was assigned
with the key XML_ENCODING.
N - The encoding in XML files is not checked.

Description

This AE Variable is supplied in client 0000. Its settings apply for the whole AE system and can only be
changed in client 0000.
 Automation Engine 261

The Automation Engine monitors all the values that this Variable includes. The administrator receives a
message if an attempt is made to store an invalid value in this Variable. This message is also written to the
Automation Engine's log file. The default value is used instead of the invalid value. If the invalid value is a
value range, the system uses the maximum value if the specified maximum value is exceeded. The
minimum value is used if a value that lies below the minimum value has been found. The Variable's
contents remain unchanged.

AGENT_COUNT_PER_IP

An agent's license will be checked when it logs on to the Automation Engine system. By default, the
system also verifies whether an agent that is already logged in uses the same IP address. If so, the agent
that has newly logged on does not require a separate license.

Checking numerous agents (approx. 1,000) can increase the time that it takes to log on to the system. For
this reason, you can also deactivate the IP address check by using the setting AGENT_COUNT_PER_
IP.

Every agent that logs on requires its own license when you deactivate this check. Whether or not the
IP address has already been used is irrelevant in this case.

AGENT_LOG_CHANGE_PER_MINUTE
The more agents a AE system contains, the higher is the chance that log-file changes are required for
many agents at the same time. You can use the setting AGENT_LOG_CHANGE_PER_MINUTE in order
to support your system performance by limiting the number of log files that should be changed per minute. 

AGENTGROUP_CHECK_INTERVAL
Tasks such as Jobs or FileTransfers can run within an agent group. The task's status changes to "Waiting
for Host" if no agent is available that is part of this agent group. The setting AGENTGROUP_CHECK_
INTERVAL defines the interval in which the system checks whether a particular agent is active and if so, it
initiates the start for the waiting tasks.

The value for this setting should not lie below the interval in which the agent attempts to establish a
connection to the AE system. This value can be specified by using the option RECONNECT_TIME in
the AE 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 have the effect that it takes longer to resolve Backend-type Variables.

CHANGE_LOGGING_DAYS and CHANGE_LOGGING_MB

These files can be changed on a time- and size-dependant basis in order to ensure that the log files can
easily be handled in high workload times for AE servers and agents. You can also archive and reorganize
this data in the AE Database although the AutomationEngine and the agents are active for several months
without interruption in the best case.

You can also specify temporary log-file changes in the Properties tab in the System Overview. Here, you
can directly specify Server settings for the log-file change of work processes. These modifications are
then valid until the system reboots. You can use the script element CHANGE_LOGGING in order to trigger
a forced log-file change.

To avoid endless reports for Event, RemoteTaskManager, Sync and Schedule objects, their reports are
also changed and a new statistical record begins. In this case, only the setting of CHANGE_LOGGING_
DAYS is relevant.
262 Chapter 3 Configuration

CHANGE_LOGGING_MB only works if the setting LOG_TO_DATABASE is set to the value Y. For
the AutomationEngine, define this setting in the AE Variable UC_SYSTEM_SETTINGS, and for
agents, use the UC_HOSTCHAR_DEFAULT. CHANGE_LOGGING_DAYS does not depend on this
option.

The log files of all work processes are automatically changed if the logging of a work process (WP,
DWP, PWP) changes.

The logging of tasks that start on a recurring basis, is changed on a daily basis or if the period settings
are modified.

CONDITION_CHECK_INTERVAL
ThePreconditions tabwhich is available in the properties of Workflows can be used to define conditions
and statements. These are then regularly checked and executed before the tasks start. This process
(evaluation cycle) is repeated until the latest start time or a final statement has been reached. This key can
be used to change the time interval. By default, an evaluation takes place every 60 seconds.

DEFAULT_REPORT_SCAN_MEMORY and MAX_REPORT_SCAN_MEMORY

Use DEFAULT_REPORT_SCAN_MEMORY to define the memory size that should be requested in order
to read reports using aFilter object. The Automation Engine doubles this size if the report to be read is
larger. For complex reports, the memory is doubled until the value specified in MAX_REPORT_SCAN_
MEMORY has been reached. The task ends with the status FAULT_OTHER if this value is exceeded.

Example:

A report has a size of 10 MB, the default memory is 3 MB, the maximum 30 MB.

The Automation Engine recognizes that 3 MB are not sufficient to read the report and increases the
memory: 3 MB -> 6 MB -> 12 MB. The maximum value for the memory has not been exceeded and the
report can now be read.

DELETE_CHECKBACK_LIMIT
When you delete an object, the system automatically checks back if this object is also used in other
objects. The whole process can take a little longer than usual if many objects are deleted at the same time.
Use the key DELETE_CHECKBCK_LIMIT in order to have a query displayed starting with the specified
object number in which you can determine whether the usage in other objects should be checked.

DISABLE_USER_HEADER
Job runs also consider Headers and Trailers. These special objects are available in the system client 0000
and can be used to call user-defined Include objects. More detailed information is available in the
documentation about Job Includes. If user-defined Include objects should not be used, you can either
specify particular platforms or *ALL. These Include objects are then not searched which avoids
unnecessary database accesses and increases performance.

For example:

Validity Value
DISABLE_USER_HEADER BS2000,MVS,WINDOWS

EXECUTE_ON_EXCEPTION
By default, invalid messages which cause a Server process to crash are put to quarantine. This key can be
used to define that an object should start if such a message is sent. Enter its name as the relevant value.

Note that the object is searched and activated in all clients. System client 0000 is exempted because
objects cannot be activated in it.
 Automation Engine 263

EXTERNAL_CHECK_INTERVAL
This settings determines the frequency with which the status of external dependencies is checked in
Workflows. The Workflow checks its external dependencies for the first time when it starts. The task
automatically reports its status when it has ended.

GENERIC_ACTIVITIES_LIMIT
Depending on the specified filter settings, the Activity Window displays the corresponding tasks. If it
contains numerous active tasks, performance is affected negatively because refreshing the Activity
Window in small intervals becomes rather complex. Therefore, you can limit the maximum number of
activities to be displayed using the entry GENERIC_ACTIVITIES_LIMIT. A message in the Activity
Window's status line informs 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
AutoForecast 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 including long searching times. Therefore,
we recommend 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 them using various options. Complex selection criteria can result in a large amount of results
including long searching times. You can specify a maximum number of records to be displayed with 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 (e.g. a report). The entry GET_
PROCESS_LINE_RTRIM can be used 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 have the date of its last use and the total number of executions displayed. The entry in
LAST_USE indicates the time delay in minutes after which a refresh is made. 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 on to the AE system can authenticate using this directory service.

LOG_TO_DATABASE
This setting can be used to determine whether the Automation Engine writes log-file messages also to the
AE Database. Value Y indicates that log messages are stored in the Server object's report. Value N
indicates that logging is only made in the log file. This setting improves the performance of your AE
system.
264 Chapter 3 Configuration

The AE Variable UC_HOSTCHAR_DEFAULTcontains a setting of the same name which can be used
to specify the agent's log behavior.

MAX_EXPORT_COUNT
During the export process, information about the objects highlighted in the Explorer (name, attributes,
etc...) is written in a common XML file. You can limit the maximum number of objects that can be exported
at the same time with the entry MAX_EXPORT_COUNT. Exceeding this value implies that the whole
process does not take place. A corresponding error message informs about this fact.

MAX_IMPORT_SIZE
This entry can be used to limit the maximum size of an XML file which should be imported. The import
does not take place if the file exceeds the specified value.

MIN_EVENT_INTERVAL
In each Event, you can specify a minimum interval (minutes) for its execution in the corresponding Event
tab. You can define a lower limit with the entry MIN_EVENT_INTERVAL. The interval specified here is
used if an Event contains a value below this limit. The Automation Engine uses the value specified in the
AE Variable UC_JOB_CHECKINTERVAL if 0 is used.

MQA_COUNT_BACK 

This key can be used to define the maximum number of Server messages which should be buffered for
further analysis. Only messages are affected which have been sent or received by work processes (PWP,
DWP, WP). These messages are stored in the random access memory (RAM) of the computer on which
the Automation Engine runs.

You can open the latest messages that have been buffered via the System Overview -> Automation
Engine section. Do so by selecting the Workload menu item in a WP's context menu.

MQ_BLOCK_COUNT and MQ_CHECK_TIME

In Oracle databases, the Automation Engine checks in the interval specified with MQ_CHECK_TIME the
block size of the message queues MQPWP, MQWP, MQDWP, MWRWP, MQOWP and MQCPnnn. If
the block size exceeds the value specified with MQ_BLOCK_COUNT, the Automation Engine
reorganizes the message queue which improves the performance of your AE system.

PASSWORD_EXIT
This entry serves the realization of a password exit. The value to be specified is the name and path of the
generated program library.
Example: PASSWORD_EXIT c:\ae\pwexit\bin\xuc4pass.dll

PASSWORD_EXIT_PARAM
If parameters should be assigned, do so using the PASSWORD_EXIT_PARAM key.

PASSWORD_CHANGE
This key can be used to define whether the password can be changed.
Example: PASSWORD_CHANGE NO

RECONNECT_TIME

This entry specifies a time interval during which the Server processes try to establish a connection. This
affects the connection attempts for a restart or after a lost connection.

REPORT_BLKSIZE and REPORT_TIME

 Automation Engine 265

Use these entries to determine the report size in bytes. You can also specify the interval (seconds) in
which the report will be refreshed.

RESERVED_API_USERS
Every user who uses the CallAPI needs a free dialog license. These dialog licenses are shared with the
users who log on to the Automation Engine via the UserInterface. The number of dialog licenses specified
here is reserved for CallAPI users. In doing so, the CallAPI cannot be blocked due to a lack of free dialog
licenses.

Example: Value 5 is entered in the Variable and there are 20 licenses available for the dialog. No further
logins would be allowed after the fifteenth login via UserInterface. It is possible that five additional users
log on to the Automation Engine via the CallAPI. If there are enough available dialog licenses, more users
than defined here can use the CallAPI at the same time.

Logging on to system client 0000 is possible even if all Dialog licenses are in use. The AE administrator
can always log on to the AE system.

SCR_LOOPCHK_TIME
This setting affects scripts whose generation takes longer than specified here. In such cases, script
generation repeatedly pauses for some time in order to avoid unnecessary Automation Engine load.
Endless loops can be avoided with this method.

SCR_LOOPCHK_TIME is used to define the frequency with which the script is interrupted. The
subsequent waiting time is always 1 second in the beginning. This time is doubled after every interruption.
The longest waiting time is 128 seconds. When this value has been reached, the waiting time is always
128. It is no longer doubled.

Example for SCR_LOOPCHK_TIME 3:

Intervals for Script generation

Script starts Generation starts
after 3 seconds Generation pauses
Waiting time Duration: 1 second
Script continues Generation continues
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

266 Chapter 3 Configuration

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

This digit is only relevant for DB2.

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.

This digit is only relevant for DB2.

7th digit G Configuration for the restart behavior of tasks.
In manual restarts, the "Generate at runtime" setting is ignored. Thus, Script and
Sync processing in objects using this setting is exchanged. This Server option
prevents that the "Generate at runtime"setting is deactivated.
8th digit E Avoids DB2 database problems especially when activating FileTransfers.
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.
 Automation Engine 267

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 logging if you activate the tasks

l using the "Generate at runtime" setting,

l via the script function ACTIVATE_UC_OBJECT,
l as an alarm object.

Doing so can result in voluminous reports and log files. Deactivate this Server
option in order to increase the performance of your AE system.
15th digit Y Affects the naming of wildcard FileTransfers from or to z/OS if the source file
name includes several wildcard characters.

For example:

Source is AE*A.AAA.AA.AAA.A????.A????.A??????
Target is AE*

Y - The target file name is correctly built according to the wildcard characters.
After the transfer, the file AEZZA.AAA.AA.AAA.A1111.A1111.A111111 obtains
the very same name.

N - The characters that start with the first wildcard until the last but one
character are ignored. After the transfer, the file
AEZZA.AAA.AA.AAA.A1111.A1111.A111111 obtains the name AE1.

Whatever you specify, this option is ignored in the new FileTransfer protocol.
Wildcards are always correctly resolved.

Activate the particular settings by inserting the respective letters in the relevant positions. The character N
deactivates a Server option. By default, all Server options are deactivated (NNNNNNNNNNNNNNN).

In the example shown below, options 1, 2, 6 and 8 are activated:

Key Value
SERVER_OPTIONS SPNNNUNENNNNNNN

SMGR_PORT_RANGE
268 Chapter 3 Configuration

If a ServiceManager is used, you can execute its actions directly via the AE system. The relevant
commands can either directly be called from the System Overview (Agents / AutomationEngine) or via the
script element MODIFY_SYSTEM .

This key can be used to specify the port number or a port area for the automatic search for ServiceManager
instances. Doing so is only required if the ServiceManager does not run on the default port 8871.

The system automatically searches for a ServiceManager when the Server processes start for the first
time. Subsequently, this search must be executed manually using the "Refresh ServiceManager Scan"
command in the System Overview. You can also specify the connection settings to the ServiceManager
manually in the agent orServer object.

You can specify a port area by separating the start and end port by a comma. This area must not exceed
10 port numbers. Enclose the value in parentheses ( ) in this case.

For example: (8871, 8873)

SNMP_REFRESH

You can use this setting to define the interval in which the display for the blocked workflows for SNMP
should be refreshed. The default value is 10 seconds.

SQLVAR_INTERNAL

By default, the creation of Variable objects of type "SQL - internal" / "SQL - internal SECURE" is
deactivated. This setting has been made for reasons of security because the execution of SQL statements
on the AE Database enables system-wide access to objects and other data. Important data records can
also be modified or deleted.

Set SQLVAR_INTERNAL to the value YES in order to create, edit and use internal SQL Variables on a
system-wide basis. To do so, a user requires the "Create and modify SQL-Internal variables" privilege.

NO has the effect that the objects cannot be created anymore. The Variable type SQLI is no longer listed in
the Templates dialog (new object).

The internal SQL variables that are supplied by default in client 0 are not affected by this setting and can
always be used.

SQLVAR_MAX_ROWS

Databases often supply huge amounts of data. Therefore, you can limit the number of lines to be retrieved
by Variable objects with the source SQL and SQLI. Specifying a value which is very high has the effect
that it takes accordingly longer to resolve Variable objects.

This setting does not have any effect on Variables of type Filelist and Multi.

SYNC_BLOCK_COUNT

For performance reasons, the log-file change of Sync objects is made per block. This means that the log
files of a particular number of Sync objects are changed. The log-files of the remaining Sync objects are
changed in the next blocks.

This setting can be used to determine the number of Sync objects whose logging should be changed per
block. The lower the value, the longer the duration of the complete procedure. However, a high value can
negatively affect the performance of the AutomationEngine.
 Automation Engine 269

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, i.e. the last n objects are visible.

UNREAD_MESSAGES and UNREAD_MESSAGES_BUFFER

The setting here determines the further handling of administrator messages which occur during operation
without a user being logged on who has the privilege to view them. Value N has the effect that they are
written to the database without being displayed again. In this case, use the category messages in the
System Overview to view these messages at a later point in time. Value Y indicates that messages are
kept and displayed in the Message Window for the next user who has the appropriate privilege.

The UNREAD_MESSAGE_BUFFER can be used to determine the number of unread messages that
should be kept. The oldest entry will be overwritten when the number of messages has been exceeded.

When the Message Window has displayed its unread entries to a User, these are marked as read and
removed from the input buffer.

Note that unread messages are lost when:

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

Affected is the replacement procedure of variables that are used within SQL statements (VARA type SQL
and SQLI( and OS commands (VARA type: Backend).

The documentation about the dynamic PromptSet dialogs describes the positions where PromptSet
variables can be replaced (security level 3).

The following table lists the variables and the security levels at which they are replaced:

Security level Variables

Predefined variables Predefined Placeholder PromptSet
(User cannot directly change the value) variables for VARA variables
(User can objects
change
the value)
0
1

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 that should be inserted in the specified Variable object
270 Chapter 3 Configuration

A script is used to change the content of the Variable VARA2 whose value will be inserted in the SQL
statement:
:PUT_VAR VARA2, '*', 'Value; DELETE * FROM x;'

An additional SQL command has been inserted in the SQL Variable VARA1 (value replacement) because
the content of the Variable object VARA2 has been changed. This was possible although VARA1 has not
directly been changed (for example by a User who does not have the corresponding rights) and can also
lead to undesired database accesses (in this case: the deletion of data).

The setting VAR_SECURITY_LEVEL has no effect if you access Variable objects of client 0. In this
case, they can always be used.

VARIABLE_SERVICE_CHECK_INTERVAL
Dynamic variablescan either be used as predefined variables or via script elements in objects. Their
values are dynamically retrieved from the data source (database, Variable object or file-system directory)
at runtime. If the database variable (source: SQL) runs in an error while resolving the variable because the
database is not available or incorrect connection or login data has been specified, the task switches to a
waiting condition ("Waiting for continuation of variable resolving").

Variable resolving can be repeated as soon as the particular error has been removed (for example, the
database name in the Connection object has been corrected). The interval in which this attempt should be
repeated can be determined using the setting VARIABLE_SERVICE_CHECK_INTERVAL.

Note that tasks that you cannot cancel tasks that are in the condition "Waiting for continuation of
variable resolving".

VERSIONS_SHOW_MAX
The value that is specified here determines the maximum number of objects that should be shown in
Version Management. The current date serves as the basis, i.e. the last n objects are visible.

WORKLOAD_DEFAULT_FT and WORKLOAD_DEFAULT_JOB

These two settings determine the resources a file transfer or job uses by default. This value can
individually be specified in the corresponding objects and overrides the default value specified in the AE
Variable.

WP_MIN_NUMBER
Extra Server processes (DWPs) are available for messages sent to the database by UserInterfaces. They
are special forms of work processes (WP). Specify the number of Server processes that should perform as
work processes using the entry WP_MIN_NUMBER. The exceeding number can be used as Dialog
processes (DWP).

Note that the primary work process (PWP) is not included.

Define a node name in the Automation Engines' INI files because Server processes can be distributed
among several computers. The minimum number of work processes is valid per "node name". If you use
the same "node name" on different computers, this setting is valid on a networked basis.

Your AE system can also run without Dialog processes.

XML_ENCODING and XML_ENCODING_CHECK

The XML encoding influences the display of characters in the UserInterface. You can use the key XML_
ENCODING to specify the encoding that should be used for your AE system. The second key influences
the verification of imported XML files.
 Automation Engine 271

ISO-8859-15 (Latin 9) contains the Euro (€) character and West-European country-specific special
characters. The table below lists additional differences:

Characters € Š š Ž ž Œ œ Ÿ ¤ ¦ ¨ ´ ¸ ¼ ½ ¾
ISO-8859- A A A B B B B B - - - - - - - -
15 4 6 8 4 8 C D E

ISO-8859-1 - - - - - - - - A A A B B B B B
4 6 8 4 8 C D E

WINDOW 80 8 9 8 9 8C 9C 9F A A A B B B B B
S-1252 A A E E 4 6 8 4 8 C D E

See also:

UC_CLIENT_SETTINGS
Overview of all AE Variables in table form
Variable

3.2.24 UC_USER_LOGON - Single Logon

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

Key Value New start required

WinNT AUTO No
UNIX AUTO No
LINUX AUTO No
Call AUTO No

Description

This variable is supplied in client 0000. Its settings are valid for the whole AE system and can only be
changed in client 0000.

Access to the operating system is granted via the specification a valid user ID and password. Logging on
to the AE system is not required if the variable UC_USER_LOGON is used. In this case, the system
checks if a User object exists in the client and if so, logon is automatic. Otherwise the UserInterface's
login window opens.

When Single Logon is enabled, access control is shifted to the UserInterface's OS. Unattended
screens can become a security risk and must therefore be avoided using the means of the relevant
operating system.

Single Logon can be used for CallAPIs. The benefit is that the password does not have to be stored in
programs or procedures. Therefore, it is not required to change every time the password is changed.

The following steps are required to activate Single Logon:

272 Chapter 3 Configuration

1. Log on to system client 0000.

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

Parameter Description
-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 file
uc4config.xml, XML element <connection name="Name" system="System">
instead of the AE system name.

See also:

Overview of all variables in table form

Variable

3.2.25 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.
 Automation Engine 273

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:

Overview of all variables in Table Form

Variable
Archiving

3.2.26 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.
274 Chapter 3 Configuration

Manual intervention is not required because the entries are automatically supplied with values and
maintained.

The utility will only maintain this variable if value "0" has been specified in theINI-file parameter suppress_
output=.

See also:

Overview of all variables in Table Form

Variable
Unloading the Database

3.2.27 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

Format: flag1 days flag2 number

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
 Automation Engine 275

VERSION_ Specifications for the reorganization of duplicated objects

CONTROL
Format: flag1 days flag2 number

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:

Overview of all variables in Table Form

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 are essential for achieving top performance with the use of a DB2 database. Please
make sure to refresh them regularly!
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

276 Chapter 3 Configuration

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

 Automation Engine 277

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

Technical Maintenance of the AE database
Maintaining Data Records

Oracle
For achieving top performance, Automic recommends keeping the following notes in mind when installing
and operating Oracle.

It is important to reorganize the AE database including all clients regularly as an extensive database
affects performance negatively (prolonged access times etc.).

White papers for Oracle usage can be downloaded from the Customer Zone of our website.

Notes

l Do not limit resource consumption. Aborting transactions due to limitations specified in the
database hamper processing in the AE system. Additionally, inconsistent database contents can
occur which cause subsequent errors or endless loops.

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.
278 Chapter 3 Configuration

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
Technical Maintenance of the AE database
Maintaining Data Records

Oracle Parameters
The following table provides an overview of all Oracle parameters and indicates how they should be set
when you use them AE.

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
DBFIPS_140 No Enable use of 12
cryptographic
libraries in FIPS
mode
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
 Automation Engine 279

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
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.
280 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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_ 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
commit_wait 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
 Automation Engine 281

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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.
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
282 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
db_create_ No 10, 11
online_log_ and 12
dest_1
db_create_ No 10, 11
online_log_ and 12
dest_2
db_create_ No 10, 11
online_log_ and 12
dest_3
db_create_ No 10, 11
online_log_ and 12
dest_4
db_create_ No 10, 11
online_log_ and 12
dest_5
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
 Automation Engine 283

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
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.
284 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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.
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.
 Automation Engine 285

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
db_2k_ 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_32k_ 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_4k_ 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_8k_ 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.
ddl_lock_ No 11 and
timeout 12
ddl_wait_for_ FALSE No 10
locks
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
286 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
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
 Automation Engine 287

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
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
288 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
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
 Automation Engine 289

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
log_archive_ No 10, 11
dest and 12
log_archive_ enable No 10, 11
dest_state_% and 12
log_archive_ No 10, 11
dest_% and 12
log_archive_ No 10, 11
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
log_archive_ No 10, 11
max_ and 12
processes
log_archive_ 1 No 10, 11
min_ and 12
succeed_dest
log_archive_ No This parameter is 10, 11
start deprecated. and 12
log_archive_ No 10, 11
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
290 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
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.
 Automation Engine 291

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
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
292 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
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.
 Automation Engine 293

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
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
294 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
parallel_min_ No 10, 11
servers and 12
parallel_ No This parameter is 10, 11
server deprecated. and 12
parallel_ No This parameter is 10, 11
server_ deprecated. and 12
instances
parallel_ No 12
server_target
 Automation Engine 295

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
parallel_ No 10, 11
threads_per_ and 12
cpu
pdb_file_ No Multitenand 12
name_convert Option

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
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
296 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
remote_ No This parameter is 10
archive_ deprecated.
enable
remote_ No 10, 11
dependencie and 12
s_mode
 Automation Engine 297

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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.
result_cache_ Yes AE does not yet 11 and
max_size support the new 12
feature Result
Cache.
result_cache_ Yes AE does not yet 11 and
mode support the new 12
feature Result
Cache.
298 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
result_cache_ Yes AE does not yet 11 and
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.
sga_max_ Max. 2/3 of the Server memory Yes You can use this 10, 11
size parameter for and 12
performance
tuning purposes.
 Automation Engine 299

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
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
size recommends and 12
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.
300 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

nt for versio
AE n
sort_area_ Yes Automic 10, 11
size recommends and 12
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
 Automation Engine 301

Parameter Recommended value Releva Description Oracle

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
302 Chapter 3 Configuration

Parameter Recommended value Releva Description Oracle

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.
 Automation Engine 303

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%
304 Chapter 3 Configuration

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

 Automation Engine 305

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
306 Chapter 4 Database

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, Admin 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.
 Automation Engine 307

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.

308 Chapter 4 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.
 Automation Engine 309

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
310 Chapter 4 Database

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:

 Automation Engine 311

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,
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, ACMT, ACV, AFC, AH, AHG, AHGH, AJPCV, AJPFV, AJPOP, AJPOV,
and AJPP, AJPPA, AJPPF, AJPPO, AJPPC, AJPPV, AJPVA, APD, APDC, APPF, ARB,
Statistics AV, AWS, LAH, LLOG, RH, RT, XAO, XRO
Forecast FE, FH, FJPP, FJPPA, FJPPC, FJPPF
Messages MELD
Processing IPH, ISTMT, ITL, MQCP*, MQDWP, MQLS, MQMEM, MQOWP, MQPWP, MQQWP,
MQRWP, MQSRV, MQWP
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_ZUTYP, VERSION
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
312 Chapter 4 Database

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.
 Automation Engine 313

 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:

Maintaining Data Records

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)
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
314 Chapter 4 Database

For Utilities Partitioning with ILM

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.

Note that it is still necessary to run the utilities to reorganize object versions and deleted objects as
they are not covered by partitioning with ILM

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
 Automation Engine 315

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 runnning this statement

ALTER TABLE DIVDB ACTIVATE NOT LOGGED INITIALLY WITH EMPTY TABLE

and you can neither restore the backup data nor run the command ROLLFORWARD anymore.

Procedure

1. Archiving

The utility AE DB Archive serves to archive messages, statistics and reports. The generated files are
clearly structured in folders organized by clients and archiving runs. As folder names also contain the
corresponding dates, it is easier to locate particular data records.

Archived data can be viewed with the Archive Browser at any time. Set filters to limit the number of
data records to be displayed depending on your requirements.

2. Reorganizing

Use the utility AE DB Reorg for the subsequent reorganization of data records. These are marked with
deletion markers in this step but are not yet deleted from the database!

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

Technical Maintenance of the AE database
316 Chapter 4 Database

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.
 Automation Engine 317

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
318 Chapter 4 Database

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. Oracle only checks for active tasks when an attempt is
made to delete the partition.

A partition remains as it is if it still contains data records of active tasks. This partition is checked again
when the next partition change is performed. You can check the list of active tasks, adjust it and finally
perform a switch-out for the relevant partition or delete it in the System Overview.

Note that you can archive, delete etc. a partition even if it contains active tasks. Automic strongly
recommends contacting Automic Support in this case in order to avoid problems. For example, if a task
ends and its statistical record belongs to a deleted partition, its report cannot be stored and is lost.

You can automatically react to successful or failed partition changes via the 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:
 Automation Engine 319

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.
320 Chapter 4 Database

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.
9. Log on to system client 0000.
10. Adjust the variables UC_ILM_SETTINGS and UC_CONTAINER_* (if required).
11. Adjust the setting CHANGE_LOGGING_DAYS within UC_SYSTEM_SETTINGS to fit to the
partition change interval.
12. Automate partition handling (e.g. archiving, storage, deletion etc.).

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
 Automation Engine 321

In the first step, select the objects that should be transported in the Explorer and move them to the
Transport CaseTransport Case. Use the "Transport" command or the drag-and-drop function for this
purpose. Note that you need the privilege "Access to Transport Case". You can undo your selections at
any time.

2. Export

In the second step, call the utility AE DB Unload in order to unload the objects from the Transport Case to
a file (by default UC_DATA.TXT). The file name and its place of storage can be individually specified in the
INI file. Start the exporting process by clicking "Unload transport container". A dialog opens in which you
can select whether the export refers to only one particular client or to all clients. Enter "No" if only one
client is concerned, and then enter the client number in the next dialog window. You cannot export
particular object but you can determine whether the objects should be removed from the Transport Case
after they have been transported.

Note that the Transport Case of system client 0000 displays all objects that should be transported.

3. Adjustment (optional)

You can modify exported data using the program AE DB Change. You can easily adjust this data to a
different AE system or client.

4. Import

Loaded or modified data can be imported using the utility AE DB Load. It automatically recognizes the
loading type and opens some input dialogs. Specify if you want to keep the same clients (for example, if
you import to a different database) or if the utility should import all objects to one particular client.

Notes

l 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=).
322 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.
 Automation Engine 323

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

Syntax Description/Format
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.

324 Chapter 5 Diagnostic Tools

Additional info Any text providing additional information

Format: script literal or script variable

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)

Syntax Description/Format
 Automation Engine 325

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
Format: script variable or number

The allowed values depend on the selected trace option.

Trace output Any text that serves as trace output

Format: script literal or script variable

Return codes
"0" - The trace was successful.
"20208" - The trace level is not within the allowed range.

Comments
This script function only serves diagnostic purposes and must only be used in close cooperation with
the support team!

To enable trace output, keep the following instructions in mind:

l The indicated trace option must also be activated in the System Overview (in the properties of the
Server processes).
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:
326 Chapter 5 Diagnostic Tools

Script element Description

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
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function

5.4 TRACE_DUMP
Script function: Supplies the values of the memory range in a trace file.

Syntax
TRACE_DUMP (Trace option, trace level, memory range[, memory range,...][, additional
info])

Syntax Description/format
Trace option Trace setting
Format: script 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 Size of the trace
Format: script variable or number

The allowed values depend on the selected trace option.

 Automation Engine 327

Memory range Memory range that is 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 additional text or information

Format: script literal or script variable

Return codes
"0" - Trace was successful.
"20208" - Trace level is not in the allowed area.
"20209" - The indicated memory range is not supported.
"20210" - The XML handle is wrong.
"20211" - The table does not exist.

Comments
This script function only serves diagnostic purposes and must only be used in close cooperation with
the support team.

To enable trace output, keep the following instructions in mind:

l The indicated trace option must also be activated in the System Overview (in the properties of the
Server processes).
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:
328 Chapter 5 Diagnostic Tools

Script element Description

LOG_DUMP Outputs values of the memory range to a log file
TRACE Outputs values to a trace file

About Scripts
Script Elements - Alphabetical Listing
Script Elements - Ordered by Function
 Automation Engine 329

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
330 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 9.0.0 agent can also be used in a
10.0.0 AE system). This requires your AE system to be at the latest hotfix level. The Automation Engine
supports the extended encryption and authentication functions. Use the variable UC_AS_SETTINGS, key
COMPATIBILITY to determine whether former components can participate in the communication.
 Automation Engine 331

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:
332 Chapter 6 Encryption and Authentication

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".
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]).
In the parameter KeyStore=, enter the path and name of the file in which the agent should store the
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

 Automation Engine 333

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.
In the parameter KeyStore=, enter the path and name of the file in which the agent should store the
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.
334 Chapter 6 Encryption and Authentication

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.

Procedure in detail:

1. End all agents.

2. End all Server processes.
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.
4. Start all Server processes.
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".
8. Transport the files containing the unique authentication packages for each agent individually to the
agents.
9. In the agents' INI-file parameter InitialPackage= (Section [AUTHORIZATION]), enter the path and
name of the authentication package file.
In the parameter KeyStore=, enter the path and name of the file in which the agent should store the
authentication package information.
We highly recommend storing both files in a separate directory which is specially protected.
10. Start all agents.
 Automation Engine 335

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.

Procedure in detail:

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.
2. End all Server processes.
3. Start all Server processes.
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.

Procedure in detail:

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.
3. End all Server processes.
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
5. Start all Server processes.
6. Delete the KeyStore file in each Agent. Its path and name are stored in the INI file, parameter
KeyStore=.
7. Start all agents.

See also:

Specifying the Authentication Method for the First Time

336 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 WebInterface, 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.
 Automation Engine 337

An installation and configuration guide for the ECC parts that affect the Automation Engine is available
in the chapter InstallationInstallation.

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

338 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
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.
 Automation Engine 339

This means that users who should use the ECC must be created in the relevant application. The
Automation Platform provides specific authorizationsauthorizations/privilegesprivileges for the ECC that
can be used to allow users to use particular perspectives.

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.
340 Chapter 8 Installation

8 Installation

8.1 Supported Platforms

The first step in preparing to install or upgrade the Automation Engine is making sure that you have the
necessary infrastructure ready and required components and versions installed.

Make sure that you review the infrastructure and product requirements, and the recommendations and
considerations that are covered below in the following sections:

l Automic Compatibility Checker

l General Information
l Java
l Network
l Database
l Automation Engine
l UserInterface
l Utilities
l Agents
l ServiceManager and ServiceManager Dialog
l External Integration
l Sizing of AWA Systems
l Supported Platforms

Automic Compatibility Checker

First check the latest requirements for the Automation Engine in the Automic Compatibility Checker.

Go to the web page and choose "Automation.Engine", the version you want to install, and the relevant sub-
component. In the three columns of information you will find the versions that you need for your
installation. This document provides additional background information.

General Information
The Automation Engine, SNMP Subagent and utilities are only available for 64 bits.
All other components are supplied for 32 bits and some of them for 64 bits.
Further information is provided in the documents describing the requirements for the individual
components. No further information means that the particular component is only available for 32 bits.

Java
Java Software

Some components need a Java JRE/SDK environment. For detailed information, which components are
affected and what Java version you should use, call the Automic Compatibility Checker.
 Automation Engine 341

Network
TCP/IP

All involved computers must be connected via TCP/IP and communicate with each other (check with
PING). TCP/IP addresses must be known and the computers on which Automation Engine processes are
installed must have a fixed TCP/IP address (no dynamic allocation).

Database
Details on requirements for the supported databases DB2, MS SQL and Oracle find online using the
Automic Compatibility Checker.

Distance Between the Database and Automation Engine

We recommend that the database is in the same data center as the Automation Engine. The maximum
distance between the two should not exceed 20 kilometers/12 miles. Otherwise we cannot guarantee
timely responses and you may experience delays such as user interface lagging.

Requirements for the DB Computer

The size of the Automation Engine Database highly depends on the size of the system and its capacity. It
may range from 20 GB to several hundred GBs.

For details see the section "Sizing" below.

Automation Engine
Supported Platforms

For the latest information on supported platforms please refer to the Automic Compatibility Checker.

Hardware Requirements for the AE Computer

For details refer to the Automic Compatibility Checker.

Virtual environment

Automic offers support for the Automation Platform in a virtual environment.

For the latest information on the virtual systems the Automation Platform was tested against refer to the
online available Automic Compatibility Checker.

SNMP Subagent

For the SNMP subagent, the same requirements apply as for the Automation Engine.

l Windows: SNMP service

l UNIX: The particulars UNIX environments require also can be found online, using the Automic
Compatibility Checker.

UserInterface
The UserInterface is a Java application program and may run on all platforms for which a Java Runtime
Environment (Virtual Machine, VM) is available.

Details you find online using our Automic Compatibility Checker.

342 Chapter 8 Installation

If you are running the PeopleSoft agent with 8.53 or higher, the UserInterface requires Java 1.7 (the
same Java version which is also required on the agent side).

Details on the following subjects concerning the UserInterface you find online as well using our Automic
Compatibility Checker:

l Recommended Screen Resolution

l Hardware Requirements for the UserInterface Computer

Utilities
Utilities based on Java application platforms may run on all platforms for which a Java Runtime
Environment (Virtual Machine, VM) is available.

The particular supported Java versions you find online in the Automic Compatibility Checker.

Agents
Platform Agent
The Linux agent is supplied for 32-bit and for 64-bit and was tested against the following systems:

l SuSE Linux Enterprise Server

l Red Hat Enterprise Linux
l Oracle Enterprise Linux

Details on operating system versions and architecture you find online in the Automic Compatibility
Checker.

Agent for Enterprise Business Solutions

All information concerning the agent for Enterprise Business Solutions can also be found online, in the
Automic Compatibility Checker.

Agent for Databases

To connect to a database system, the appropriate JDBC driver classes are needed. The JDBC driver
classes are not part of the product and must be purchased separately by the database vendor.

The JDBC driver classes must be compatible with Java.

Particulars about the Java version the JDBC driver classes must be compatible with you can find online in
the Automic Compatibility Checker.

Agent for EE/JMX

The agent must be running on a Java supported environment. Details on supported versions you find online
in the Automic Compatibility Checker.

ServiceManager and ServiceManager Dialog

The ServiceManager and the Dialog are used to monitor and start and end the main processes of the
Automation Engine.
Both are available for 32-bit and 64-bit.
 Automation Engine 343

Details about supported platforms you find online in the Automic Compatibility Checker.

External Integration
ApplicationInterface, Internal Webservice, ResourceAdapter and Connect for WebSphere MQ,
Connect for HP OpenView NNM, Smart Plug-In for HP OpenView Operations, Connect for
WebSphere MQ, Knowledge Module for BMC Patrol, PlusModule for Tivoli

Details on the supported platforms and versions find online in the Automic Compatibility Checker.

Sizing of AWA 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
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
344 Chapter 8 Installation

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 
 Automation Engine 345

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

Process Analytics
Process Analytics is the solution that meets your automation management needs. Critical path analysis
helps you to find out which processing steps you need to monitor more closely and helps you to reorganize
and optimize your processing. Graphical Forecasting supports you in planning future workloads and
maintenance windows. Time based Views help you to understand dependencies and to view your
processes from end to end.

For Process Analytics Admin Process Analytics

Studio
346 Chapter 8 Installation

Operating Windows Vista x64/x86 Windows Vista x64/x86

System
Windows XP Service Pack 3 Windows XP Service
Pack 3
Unix/Linux Platform – for which an Oracle Java Runtime -
Environment is available.
Database Oracle 10, 11 Oracle 10, 11
Microsoft SQL Server 2005, 2008 Microsoft SQL Server
2005, 2008
DB2 9.5, 9.7 (Automation Engine DB only) -
Java Oracle JRE 1.5 – 1.7 Oracle JRE 1.5 – 1.6

8.2 New Installation

8.2.1 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 tes tand production systemtest 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
 Automation Engine 347

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.
348 Chapter 8 Installation

The installation documents use "AE" as the system name, the description for the database connection,
and the name of the installation directory. This is our recommendation for reasons of clarity. If other
names are used, keep this in mind and adjust them accordingly in each processing step. See also:
Notes for Configuration-File Adjustments

Files that are 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.

UserInterface
The UserInterface is helpful during the installation of your AE system because you can use it to set up and
configure basic components. A wizard guides you through the individual steps, installs the corresponding
AE programs and even adjusts the required parameters in the INI files.

The UserInterface is available under Windows and can install a Automation Engine, a UserInterface,
utilities, the ServiceManager, the ServiceManager Dialog program, Automation Engine Documentation
and also files for an SAP or Windows agent on any local computer. you can even load initial data and
licenses to the AE database.

Whether the interface of the UserInterface is displayed in German or English depends on how the
regional settings are configured in the control panel.

Using the UserInterface is optional. You can also decide to manually install your AE system.
 Automation Engine 349

Requirements

l The UserInterface requires Java Runtime. Make sure that the required version is available on the
computers on which it will be used.
l All components that run under Windows require the Microsoft Visual C++ 2010 Redistributable
Package. Install it from the directory IMAGE:CRTS if it is not yet available on your computer. The
UserInterface does not check whether the package is available or not. If it is missing, it does not
install it.
l Create a database (DB2, MS SQL Server or Oracle).

Procedure

The document that describes the procedure for a new installation contains a table that lists the individual
work steps. The same procedure applies for using the UserInterface.

1. Do NOT install the UserInterface. It will automatically be installed when you call it for the first time.
Start the AE installationer on the computer on which the components should be installed. The file
name is UC4Setup.exe. It is supplied in the top folder which has the same name as the Automation
Engine version.
2. Specify the root directory for the installation. All components will be installed in this directory. Click
Next.
 The UserInterface installs itself in a folder in the root directory.
3. The next step is to specify the name and language of the AE system, the connection data for the
Automation Engine and the database connection. They are automatically inserted in the INI files of
the relevant components that are installed with the UserInterface. The password that is used to
access the AE database is encrypted. Click Next.
 The UserInterface stores the parameters. Their values can be modified when the UserInterface
is started at a later time. It then updates all INI files that are found in the root directory.
4. Select the components that shuld be installed. Because you can call the UserInterface multiple
times, the components that have already been set up in the root directory are displayed in gray.
Click Next.
5. The selected components begin to install, one after the other. When a component contains other
important INI-file parameters that need to be adjusted to your system environment, the
UserInterface displays the corresponding information. Values can be entered directly; it is not
necessary to adjust the INI file manually.
6. Start the ServiceManager service in the control panel after the installation.
7. Some settings must be configured in the AE system before you can use the SAP agent. Further
steps are described in the document New Installation of the SAP Agent (Windows).
8. Use the UserInterface to install additional required components on other computers.
9. Manually install any components that cannot be set up with the UserInterface.

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.

Some components can be set up using the UserInterface.

Base components must be installed in any case. Keep the order shown below.
350 Chapter 8 Installation

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
 Automation Engine 351

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 AE.Connect for HP OpenView NNM

(UNIX)
Installing AE.Connect for HP OpenView NNM
(Windows)

Installing AE Smart Plug-In for HP OpenView

Operations (UNIX)
Installing AE Smart Plug-In for HP OpenView
Operations (Windows)

Installing AE.KnowledgeModule for BMC Patrol

Installing AE.PlusModule for Tivoli

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
352 Chapter 8 Installation

combination of computers with different UNIX derivatives or a mixture of UNIX and Windows is not
possible.

8.2.2 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 and the list of supported database versions.

Do not limit resource consumption. Transactions that repeatedly abort because of limitations that are
specified in the database can impede processing in your AE system. Inconsistent database contents
can be a result thereof and cause subsequent errors or endless loops.

Note that your database will become inconsistent when you modify database contents.

The following error message might appear if you use DB2 Version 9.6 (or lower), which is no longer
supported:
U0003592 Status: '01605' Native error: '347' Msg: ' SQL0347W The recursive common table
expression "&01" may contain an infinite loop. SQLSTATE=01605'
This message, however, is a warning that you can ignore.

Size required for the initial installation of an AE database

Test systems: 1 GB
Production systems:
Small systems 5 - 20 GB
Medium systems 20 - 50 GB
Large system more than 50 GB

Procedure
General Requirements:

l 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
 Automation Engine 353

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 APP_CTL_HEAP_SZ to 1024
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_EVALUNCOMMITED 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:

354 Chapter 8 Installation

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

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
 Automation Engine 355

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.
356 Chapter 8 Installation

Do not limit resource consumption. Aborting transactions due to limitations specified in the database
can impede processing in the AE system. Additionally, inconsistent database contents can result,
which can cause subsequent errors or endless loops.

It is important to remember that modifying database content result s in an inconsistent database.

A Automation Engine crash under Oracle is only reliably recognized if the Dead Connection Detection
is activated. This is set with the entry SQLNET.EXPIRE_TIME in the SQLNET.ORA file to a
maximum of 60 seconds.

Visit the Automic website where we provide whitepapers about Oracle usage for download.

One effective way to maintain the AE database is to use partitioning with ILM (Information Lifecycle
Management). Automic recommends reading the document Maintaining the data records before you
start setting up the database.

Size required for the initial installation of an AE database

Test systems: 1 GB
Production systems:
Small systems 5 - 20 GB
Medium systems 20 - 50 GB
Large system more than 50 GB

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
 Automation Engine 357

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.

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.
358 Chapter 8 Installation

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.

3. Creating a database user

l DB computer
l Automic recommends creating an additional database user for AE. This user must have therequired
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,
 Automation Engine 359

MELD_TimeStamp DATE NULL,

MELD_MsgNr INTEGER NULL,ucablq.htm

MELD_MsgInsert VARCHAR2 (255) NULL,

MELD_DeleteFlag SMALLINT NULL,
MELD_Client SMALLINT NULL,
MELD_Source INTEGER NULL,
MELD_Category INTEGER NULL,
MELD_Type INTEGER NULL,
MELD_Host VARCHAR2 (200) NULL,
MELD_ArchiveFlag SMALLINT NULL,
CONSTRAINT PK_MELD PRIMARY KEY
(
MELD_Idnr
) USING INDEX TABLESPACE UC4_INDEX
) TABLESPACE UC4_DATA
STORAGE (INITIAL 51200K NEXT 7168K MAXEXTENTS UNLIMITED);

Automic recommends facilitating unlimited extensions (MAXEXTENTS) instead of limiting them.

5. 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 are found in subdirectories of
IMAGE:UTILITIES\UNIX. The subdirectory names indicate the supported platforms.

*.sh: normal utility start

without file ending: programs for batch call

File name Description

360 Chapter 8 Installation

UCYBDBar.jar AE DB Archive (archiving the database)

ucybchng AE.DB Change (editing exported data)
UCYBDBcc.jar AE DB Client Copy (copying and deleting clients)
UCYBDBLd.jar AE DB Load (loading the database)
UCYBDBre.jar AE DB Reorg (reorganizing the database)
UCYBDBRR AE.DB Revision Report (creating revision reports)
UCYBDBUn.jar AE DB Unload (unloading the database)
UCYBLGMX AE.LogMix (combination of log and trace files)
ucyrepg.jar AE.Reporting Tool (defining queries)
uc.msl Message library
UC4LAF.jar Archive for layout files
*.ini Initialization files for the utilities
*.sh Start scripts for calling the utilities
libgcc*, libssp*, libstdc++*, Runtime libraries
libsysapi, libuc001,
File ending with "a" indicates AIX
libuccache, libucdbup,
File ending with "sl" indicates HP-UX
libucsbepm, libucudb32,
File ending with "so" indicates Solaris, Linux and zLinux
libUCYBCLICPY,
libUCYBDBLd,
libUCYBDBUn,
libUCYDBArchive,
libUCYDBReorg,
libzu00132, libzuxml,
ucucli, ucuoci,

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.
 Automation Engine 361

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

UC4=/opt/uc4/utility; export UC4
PATH=.:$ORACLE_HOME/bin[:$PATH]; export PATH
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

UC4=/opt/uc4/utility; export UC4
PATH=.:$ORACLE_HOME/bin[:$PATH]; export PATH
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
UC4=/opt/uc4/utility; export UC4
PATH=.:$DB2DIR/bin[:$PATH]; export PATH
LIBPATH=$UC4/bin:$DB2DIR/lib:usr/lib:/lib[:$LIBPATH]; export LIBPATH

Sample for HP-UX:

362 Chapter 8 Installation

l DB2DIR=/opt/IBMdb2/V6.1; export DB2DIR

UC4=/opt/uc4/utility; export UC4
PATH=.:$DB2DIR/bin[:$PATH]; export PATH
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
UC4=/opt/uc4/utility; export UC4
PATH=.:$DB2DIR/bin[:$PATH]; export PATH
LD_LIBRARY_PATH=$UC4/bin:$DB2DIR /lib:/usr/lib:/lib[:$LD_LIBRARY_PATH]; export
LD_LIBRARY_PATH

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:
 Automation Engine 363

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

File name Description

UCYBARBR.EXE AE.Archive Browser
(searches the archive files)
UCYBCHNG.EXE AE.DB Change (edits
exported data)
UCYBDBRR.EXE AE.DB Revision Report
(creates revision reports)
UCYBDBCC.JAR AE DB Client Copy (copies
and deletes clients)
UCYBDBAR.JAR AE DB Archive (archives the
database)
UCYBDBLD.JAR AE DB Load (loads the
database)
UCYBDBRE.JAR AE DB Reorg (reorganizes
the database)
UCYBDBUN.JAR AE DB Unload (unloads the
database)
UCYBDBRT.EXE AE DB Reporting Tool
(creates object queries)
UCYBREPG.EXE (requires 32bit Java), AE DB Reporting Tool
UCYBREPG.JAR (graphical interface for creating
the query files)
UCYBLGMX.EXE AE.LogMix (combines log and
trace files)
UC.MSL Message library
UC4LAF.JAR Archive for layout files
*.INI Initialization files for the
utilities
364 Chapter 8 Installation

CALLHTMLHELP.DLL, Libraries of the utilities

CBLRTSS.DLL,

UCCACHE.DLL,

UCDBUP.DLL,
UCSBEPM.DLL, UCUCLI.DLL, UCUDB32.DLL, UCUOCI.DLL,
UCUODBC.DLL, UCYBCLICPY.DLL, UCYDBARCHIVE.DLL,
UCYDBREORG.DLL, UCYBDBLD.DLL,
UCYBDBUN.DLL, UCZU01.DLL, ZU00132.DLL, ZUXML1.DLL
COMDLG32.OCX, MSCOMCTL.OCX, RICHTX32.OCX ActiveX Controls
SETUP.EXE Installation program

Note that as of Automation Engine version 8.00A, the file names of all utilities have been changed to
lowercase letters.

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 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.
 Automation Engine 365

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:
366 Chapter 8 Installation

Configuring the Debugger for potential program failures

Loading the 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 utility AE 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)

 Automation Engine 367

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 Engines

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).
368 Chapter 8 Installation

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 is found in
one of the appropriate UNIX platform subdirectories: IMAGE:AUTOMATIONENGINE\UNIX\.
UCS???.tar.gz ( Automation Engine files).

File name Description

ucsrvcp Communication process
ucsrvwp Work process
uc.msl Message library
ucsrv.ori.ini INI file
 Automation Engine 369

libsysapi, libuccache, libucudb32, libzu00132, Runtime libraries

libzusynchk, libuc001, libucdsfun, libucmsgq, libucmsgxml, libucrtl,
Files ending with "a"
libucsbepm, libzuxml, libucsj, ucsj_1, ucsj_2, ucsj_3, libgcc_s, libstdc++,
indicate AIX.
libucldap, libssp
Files ending with "sl"
For Oracle database: ucuoci indicate HP-UX.
For DB2 database: ucucli Files ending with "so"
indicate Solaris, Linux
and zLinux.
syntax.bin Description of script
language

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
370 Chapter 8 Installation

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 Open the created file with a text editor (sed or vi). Verify that all libraries were found.
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:
ldd -r ucsrvcp > wk.txt
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:
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. 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:
 Automation Engine 371

l AE uses $DB2DIR/lib/libdb2.a.
l Library check:
dump -H ucsrvcp > wk.txt
l Open the created file with a text editor (sed or vi). Verify that all libraries were found.
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:
ldd -r ucsrvcp > wk.txt
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 ucucli.so and ucsrvwp. Some missing entries might be
reported that refer to the file ucucli.so, because it is a library instead of a main program. If
these messages refer to the libraries ucucli.sl, libzu00132.sl, or libucudb32.sl, they can be
disregarded. If an entry cannot be found in a different library (DB2, for example), this is an
error.

Linux, Solaris and zLinux:

l AE uses $DB2DIR/lib/libdb2.so.
l Library check:
ldd -r ucsrvcp > wk.txt
The option -s can be used instead of -r for ldd
l Open the created file with a text editor (sed or vi). Verify that all libraries were found.
l Repeat the above procedure with ucucli.so and ucsrvwp. Some missing entries might be
reported that refer to the file ucuoci.so, because it is a library instead of a main program. If
these messages refer to the libraries ucucli.so, libzu00132.so, or libucudb32.so, they can be
disregarded. If an entry cannot be found in a different library (DB2, for example), this is an
error.

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 &
372 Chapter 8 Installation

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
 Automation Engine 373

%s/<Ctrl-V><Ctrl-M>$//g
:wq!

See also:

Number of Server Processes

Installing the AE SNMP Subagent (UNIX)

Installing the Automation Engine for Windows

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 are found in the IMAGE:AUTOMATIONENGINE\WINDOWS directory.

File name Description

UCSRVCP.EXE Communication
process of the
Automation Engine
for Windows
UCSRVWP.EXE Work process of the
Automation Engine
for Windows
UC.MSL Message library
UCSRV.INI Configuration file of
the Automation
Engine for Windows
UC_MSGQ.DLL, UCCACHE.DLL, UCDSFUN.DLL, UCMSGXML.DLL, AE runtime system
UCSBEPM.DLL, UCSJ.DLL, UCUDB32.DLL, UCUODBC.DLL, for Windows
ZU00132.DLL, ZUSYNCHK.DLL, ZUXML1.DLL, UCSEVMSG.DLL,
UCLDAP.DLL

Oracle database: UCUOCI.DLL

DB2 database: UCUCLI.DLL
SETUP.EXE Installation program
374 Chapter 8 Installation

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
the Control Panel -> Add or Remove Programs to see if the package is installed, and if so, which
version.

l Server computer
l Install the package from the IMAGE:CRTS directory.

2. Installing the Automation Engine

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:

Number of Server Processes

Configuring the Debugger for potential program failures
Installing the AE SNMP Subagent (Windows)
 Automation Engine 375

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

2. Setting up the system environment

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
376 Chapter 8 Installation

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

Number of Server Processes

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.

 Automation Engine 377

Requirements
l Valid user ID for installation (AE)

Supplied Files
The UserInterface files are found in the directory IMAGE:USERINTERFACE\UNIX. Single files are
combined in the ucdj.tar.gz file.

File name Description

UCDJ.SH Start script
for calling the
UserInterface
UCDJ.INI Call options
for the start
program
UCDJ.BAT Batch file for
calling the
UserInterface
UCDJ.JAR UserInterface
in Java
UC4CONFIG.XML Configuration
file for
connecting to
the AE
systems
LOGIN_DAT.XML Configuration
file for user
login to the
AE system
UC.MSL Message
library
CALLHTMLHELP.DLL, CALLHTMLHELPIA64.DLL, CALLHTMLHELPX64.DLL, Files for
UC4DOCREF.PROPERTIES, UC4MSGREF.PROPERTIES calling help
with the F1
key
CONFIGREF.CLASS Configuration
class
SYNTHETICA.JAR, SYNTHETICAADDONS.JAR, UC4LOOKANDFEEL.JAR, Interface
ATTACHLAYOUT.JAR, SWINGX.JAR, SWING-WORKER-1.2.JAR layout
UC4.WAV WAV file that
is processed
when the
UserInterface
(Display
Splash
Screen) is
started
378 Chapter 8 Installation

UCXJPS84.JAR File with

specific Java
classes for
the
PeopleSoft
forms
AE-RA.JAR RA
Framework
INTELLISENSE.JAR File for the
Script
Editor's auto-
completion
function

Procedure
1. Installing the Java Runtime Environment (JRE)

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

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

l Download the required Java Runtime Environment from http://java.sun.com and install it.

2. Installing the UserInterface

l Admin computer and/or User computer

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

 Automation Engine 379

l Admin computer and/or User computer

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 Admin computer and/or User computer

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 Admin computer and/or User computer

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:

380 Chapter 8 Installation

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_
##_%USERNAME%.TXT</trace>

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.
 Automation Engine 381

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]
cmd="javaw" -Xmx512m com.uc4.ucdf.UCDialogFactory -U%User% -
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

Installing the UserInterface (Windows)

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 are found in the IMAGE:USERINTERFACE\WINDOWS directory.

File name Description

UCDJ.EXE Start program for calling the
UserInterface
UCDJ.INI Call options for the start program
UCDJ.BAT Batch file for calling the
UserInterface
UCDJ.JAR UserInterface in Java
UC4CONFIG.XML Configuration file for connecting to
the AE systems
382 Chapter 8 Installation

LOGIN_DAT.XML Configuration file for user login to

the AE system
UC.MSL Message library
CALLHTMLHELP.DLL, CALLHTMLHELPIA64.DLL, Files for calling help with the F1 key
CALLHTMLHELPX64.DLL, UC4DOCREF.PROPERTIES,
UC4MSGREF.PROPERTIES
CONFIGREF.CLASS Configuration class
SYNTHETICA.JAR, SYNTHETICAADDONS.JAR, Interface layout
UC4LOOKANDFEEL.JAR, ATTACHLAYOUT.JAR,
SWINGX.JAR, SWING-WORKER-1.2.JAR
UC4.WAV WAV file that is processed when the
UserInterface (Display Splash
Screen) is started
SETUP.EXE Installation program
UCXJPS84.JAR File with specific Java classes for
the PeopleSoft forms
AE-RA.JAR RA Framework
INTELLISENSE.JAR File for the Script Editor's auto-
completion function

Procedure

1. Installing the Java Runtime Environment (JRE)

If the required version of JRE is already installed, this step can be omitted.

l Admin computer and/or User computer

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.

l Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control. AE does not need it.

2. Installing the UserInterface

l Admin computer and/or User computer

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

 Automation Engine 383

l Admin computer and/or User computer

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

4. Using ERP Forms (optional)

l Admin computer and/or User computer

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 Admin computer and/or User computer

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
6. Starting the UserInterface

l Admin computer and/or user computer

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:
384 Chapter 8 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_
##_%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_
##_%USERNAME%.TXT</trace>
 Automation Engine 385

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]
cmd="javaw" -Xmx512m com.uc4.ucdf.UCDialogFactory -U%User% -
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:

Configuring the Debugger for potential program failures

Installing the Online Documentation

Several help systems are available for the UserInterface in the form of an online documentation (F1 key).
The particular one that should be used depends on the system platform on which the UserInterface is
installed.

Help formats

WebHelp

You can run the WebHelp on all platforms with an HTML browser. JavaScript must be enabled in order to
use the complete functional range.

HTML Help
386 Chapter 8 Installation

You can only run the HTML help on platforms with a Microsoft HTML Help Viewer (usually Microsoft
Windows).

Please note: A certain update for Windows Server 2003 SP1 by Microsoft may make the HTML help
unusable. Please see our knowledge base article on the subject for a solution, where you also find links
to the relevant Microsoft webpages.

PDF

You can open the PDF guides from all platform on which a display program (such as Adobe Reader) is
installed. Note that you cannot open this format through the UserInterface (F1).

Supplied Files

The documentation of the various formats and languages is provided in the directory
IMAGE:DOCUMENTATION.

Directory Documentation
IMAGE:DOCUMENTATION\GUIDES\WEBHELP The Guides of the Automation Engine in
WebHelp format.
IMAGE:DOCUMENTATION\GUIDES\HTMLHELP The Guides of the Automation Engine in
HTML Help format.
IMAGE:DOCUMENTATION\GUIDES\PDF The Guides of the Automation Engine as
PDFs.
IMAGE:DOCUMENTATION\RELEASE NOTES The Release Notes of the Automation Engine
as PDFs.
IMAGE:DOCUMENTATION\UC4MSG\WEBHELP The Message Documentation in WebHelp
format.
IMAGE:DOCUMENTATION\UC4MSG\HTMLHELP The Message Documentation in HTML Help
format.

The Automation Engine Documentation in WebHelp format is also available in compacted form as TAR
files (in the directory IMAGE:DOCUMENTATION\GUIDES\WEBHELP).

Procedure

1. Copying the Automation Engine Documentation

l The complete Automation Engine Documentation

l In Windows: Copy the whole directory IMAGE:DOCUMENTATION to a directory of your choice if
you intend to use all help systems and languages. This directory includes a ZIP file for each
WebHelp language. Unpack them and make sure that the content of the ZIP archive will be
unpacked directly to the corresponding folder and not to an additional sub-folder.
In UNIX: Copy the TAR files to the DOCUMENTATION folder and unpack them.

gunzip docu.tar.gz
tar xpvf docu.tar
 Automation Engine 387

l Parts of the Automation Engine Documentation

l If you prefer to use only one help system or language, you can also copy only the particular
directories that you need. Note that it is important to keep the folder structure intact so that help can
be called in the UserInterface by using the F1 key. The same applies when you use WebHelp in
UNIX.

For example:
English HTML Help documentation will be used.
Correct: Create the folder structure
\AUTOMIC\DOCUMENTATION\AUTOMIC\HTMLHELP\ENGLISH and save the CHM files
there.
Incorrect: Copy the CHM files directly to the folder \AUTOMIC\DOCUMENTATION.

You can also store the Automation Engine Documentation at a location that can be accessed by all
users (such as a directory on the server). Note that in this case, the directory of the HTML Help files
(.CHM) must additionally be released via the registry. For further information, refer to the articles
896054 and 896358 on the Microsoft homepage.

In the HTML Help, you can also access the AE Message Documentation. For this purpose, you must
copy the file Messages.chm to the directory DOCUMENTATION\GUIDES\HTMLHELP\ENGLISH (or
GERMAN or FRENCH).

2. Setting up the UserInterface

l Enter the type of the help system that you want to use and the path that should be used in the
configuration file uc4config.xml of the UserInterface. For using the WebHelp, you must also specify
the browser that the UserInterface should use when you click F1.

<docu type="type">path</docu>
<browser type="name">path</browser>

Note that you can keep the default path in the configuration file uc4config.xml when the
DOCUMENTATION folder is a parallel folder of the USERINTERFACE folder.

3. Calling the Automation Engine Documentation

l You can use the F1 key to open the Automation Engine Documentation from anywhere in the
UserInterface. It opens the document that describes the particular window, tab or script element
that is open or in use at that time. To view help on script elements, position the mouse pointer
somewhere within the script element's name (on the Process tab).
388 Chapter 8 Installation

l You can also open the Automation Engine Documentation manually from the folder to which you
copied it, by double-clicking the start page:

WebHelp: help.htm
HTML Help: help.chm

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.

File name Description

x.xxx.UCX2?.LIB Program Library
Library Elements
UCXBB2?C CallAPI Utility
UCXEB2?U Utility for the console event (UCON
connection)
UCXJB2? Agent
UCXJB2?M Message program for BS2000 agent
 Automation Engine 389

UCYBRFC? Utility for RFC task

x.xxx.UCXJB2?.INI INI file for BS2000 agent
x.xxx.UCXEB2?U.INI INI file for the utility
x.xxx.UCYEBXXZ Utility for recalling commands through a
console (only for console events)
x.xxx.E.UCXJB2? Sample - Enter file for BS2000 agent
x.xxx.E.UCXEB2?U Sample - Enter file for the utility
x.xxx.UCX.MSL Message Library

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.
390 Chapter 8 Installation

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.

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.

Automic strongly recommends installing the agent in a separate directory.

 Automation Engine 391

Before you start the installation, ensure that the Java agents can only connect to CP port numbers that
are lower than 65536. If they use a higher port number, the agent cannot start and aborts with an error
message. This limitation is caused by Java and affects the agents for JMX, databases, SAP and RA.

Supplied Files
The files that belong to the Database agent are stored in the directory IMAGE:AGENTS\SQL.

File name Description

UCXJSQLX.JAR Database agent
UCXJSQLX.INI Initialization file for the database agent
UC.MSL Message library
SETUP.EXE Installation program (Windows)

Additionally, two empty folders (Temp and JDBC) are supplied. The Temp folder stores log files, and the
JDBC driver must be installed in the JDBC folder.

Procedure
1. Installing the Java Runtime Environment (JRE)

If JRE is already available in the required version, this step of the installation process can be ignored.

l Admin computer and/or User computer

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
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. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control. The Automation Engine does not need it.

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

392 Chapter 8 Installation

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
Environment that is found first in the list of directories is used.
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 Install the driver.
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_
 Automation Engine 393

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.

5. Setting up the system environment

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 Admin computer or Server computer

l Adjust HEADER.WINDOWS, TRAILER.WINDOWS and RESTART.WINDOWS if necessary.
See: Job - Execution.

6. Starting the Agent

l Server computer
l The AE system must be running.
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.
394 Chapter 8 Installation

The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation..
l Admin computer or Server computer
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.

This installation guide can be used for Windows and for Unix.

The agent for SQL variables (DB Service Agent) can access each supported database type. This type
must be determined in a DB-type Connection objectDB-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).

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.

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.

File name Description

 Automation Engine 395

UCXJSQLX.JAR Database Agent

UCXJSQLX.INI Initialization file for the Database Agent
UC.MSL Message library
SETUP.EXE Installation program (Windows)

Additionally, two empty folders (Temp and JDBC) are supplied. The Temp folder stores log files, and the
JDBC driver must be installed in the JDBC folder.

Procedure
1. Installing the Java Runtime Environment (JRE)

If JRE is already available in the required version, this step of the installation process can be ignored.

l Admin computer and/or User computer

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
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. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control. AE does not need it.

2. Installing the Agent

l Host
l Create a separate directory for the agent (for example, 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 The driver supports MS SQL Server 2005 and 2008 (2008 R2).
396 Chapter 8 Installation

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
Environment that is found first in the list of directories is used.
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 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 Install the driver.
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
 Automation Engine 397

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 RACOracle
database in RAC.

5. Setting up the system environment

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

6. Starting the Agent

l Server computer
l The AE systemAE system must be running.
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

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 Admin computer or Server computer
398 Chapter 8 Installation

l Verify 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 rightsrights via the Agent object.

Use the ServiceManager to start or end the agent as a service.

Installing the Agent for GCOS8

This document guides you through the new installation of a GCOS8 agent.

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
RSM8 is required if the Job's output will be transferred to AE.

Supplied Files
The files of the GCOS8 agent are available in binary and ASCII format. They are stored in the directory
IMAGE:AGENTS\GCOS8.

File name File Description

type
UCXJGC8 binary GCOS8 agent
UCXJGC8M binary Message program for the
GCOS8 agent
UCMSL ASCII Message library
UCXJGC8I ASCII Initialization file
UC4EX, UC4TM, ASCII JCL for starting and
CANCEL.SPN, UC4, UC4EXEC.DIR, UC4EXEC.SPN, ending the agent
UC4TERM.DIR, UC4TERM.SPN, UC4SIM

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.
 Automation Engine 399

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

3. Setting up the system environment

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.
See: Job - Execution.

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.

5. Starting the Agent

400 Chapter 8 Installation

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 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
Overview. Because a newly logged-on agent has not yet been assigned a client, it can only
be viewed in the system client 0000. The newly installed agent can now be assigned to
clients through the Agent object with all the required rights.

6. Shutting down the Agent

l Host
l Use the JCL from the file UC4TM to close the agent.

$      ident <site-ident>
$      select &system/profile.prod/uc4
$      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.

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.

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.
 Automation Engine 401

File name Description

ucxjjmx.jar Agent for J2EE/JMX
ucxjjmx.ini Configuration file
uc.msl Message library
setup.exe Installation program

Procedure
1. Installing Java Standard Edition

This installation step can be omitted if the required version of Java Standard Edition is already
available.

l Admin computer and/or user computer

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.

l Download the required Java Runtime Environment from http://java.sun.com and install it.

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.

3. Starting the Agent

l Use the following command to start the agent from the command line (UNIX and Windows):

java -jar -Xrs -Xmx256M ucxjjmx.jar

402 Chapter 8 Installation

The agent can also be started by using the ServiceManager.

Note that the storage limit should be set to at least 256MB (or 512MB) for starting Java agents
(Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java applications by
using the start parameter -XmX.
Specifying a value that is too low can cause the agent to crash. The default value depends on the Java
version that is used.

The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation.

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.

Automic strongly recommends installing the agent in a separate directory (such as UC4/Agent/jmx or
C:\AUTOMIC\Agent\jmx).

Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.jar Agent for J2EE/JMX
ucxjjmx.ini Configuration file

Procedure
1. Installing Java Runtime Environment (JRE)

This installation step can be omitted if the required version of JRE is already available.
 Automation Engine 403

l Admin computer and/or user computer

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.

3. Important notes for creating jobs

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

The following guide describes how to install an agent in an AE system in which authentication is not used.
Additional installation steps are required before the agent can be started and used if you intend to use one
of the available authentication methods. More detailed information is provided in the document Advanced
Security.

Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.
404 Chapter 8 Installation

File name Description

ucxjjmx.war Agent for J2EE/JMX

Procedure
1. Setting up the JMX Agent

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."
 Automation Engine 405

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 web interface.

2. Using the configuration web 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/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.

3. Important notes for creating jobs

406 Chapter 8 Installation

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.

The following guide describes how to install an agent in an AE system in which authentication is not
used. Additional installation steps are required before the agent can be started and used if you intend to
use one of the available authentication methods. More detailed information is provided in the document
Advanced Security.

1. Setting up the JMX Agent

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.
 Automation Engine 407

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."
408 Chapter 8 Installation

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

 Automation Engine 409

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 tabJMX
tab of the Job object.

3. Starting the Agent

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:
410 Chapter 8 Installation

l Agent name
l Name of the computer on which a communication process is available
l Port number of a communication process

l Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.

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)

The following guide describes how to install an agent in an AE system in which authentication is not used.
Additional installation steps are required before the agent can be started and used if you intend to use one
of the available authentication methods. More detailed information is provided in the document Advanced
Security.

Supplied files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.war Agent for J2EE/JMX

Procedure
1. Setting up the JMX Agent
 Automation Engine 411

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 Name of the computer on which a communication process is available
l Port number of a communication process

l Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.

3. 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-menu "Use existing MB Server".
l It is not necessary to select the option "Generate new instance..."
412 Chapter 8 Installation

Setting up the Agent for J2EE/JMX (Oracle Containers for J2EE)

The following guide describes how to install an agent in an AE system in which authentication is not used.
Additional installation steps are required before the agent can be started and used if you intend to use one
of the available authentication methods. More detailed information is provided in the document Advanced
Security.

Supplied Files
The J2EE/JMX agent files are available in the folder IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.war Agent for J2EE/JMX

Procedure
1. Setting up the JMX Agent

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.

2. Using the web configuration interface

l Host

l The JMX agent has a Web configuration interface; it can be called in a Web browser using the
following address:

http://Server name:Port/ucxjjmx/uc4jmx

The above address uses the string "ucxjjmx" because that is the string that was used before ".war" in
the folder name. Adjust this address if you used a different name.

l Adjust the JMX agent settings to your system environment. The most important settings are:

l Name of the Agent

l Name of the computer on which a communication process is available

l Port number of a communication process

l Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
 Automation Engine 413

your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.

3. Important notes for creating jobs

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

l Specify the Server URL in the following format:

service:jmx:rmi://Host name of the Oracle J2EE Server:Port/oc4j

Setting up the Agent for J2EE/JMX (SAP NetWeaver)

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.

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
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.sca J2EE/JMX agent

Procedure
1. Setting up the JMX Agent

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.
414 Chapter 8 Installation

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.
 Automation Engine 415

l In the next step, ensure that the JMX agent is in the queue. If it is, click Start to initiate the setup
procedure.
416 Chapter 8 Installation

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.

3. Using the Web configuration interface

 Automation Engine 417

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 Name of the computer on which a communication process is available
l Port number of a communication process

4. Important notes for creating jobs

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)

The following guide describes how to install an agent in an AE system in which authentication is not used.
Additional installation steps are required before the agent can be started and used if you intend to use one
of the available authentication methods. More detailed information is provided in the document Advanced
Security.

Supplied files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.war Agent for J2EE/JMX

Procedure
1. Setting up the JMX Agent

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.

418 Chapter 8 Installation

l The JMX agent is displayed in the section "applications" of the Web Application Manager.

2. Using the web configuration interface

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

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.

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.
 Automation Engine 419

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.
420 Chapter 8 Installation

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.

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.

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.

File name File type Description

UC4DDL Text DDL description for usage in EMS filters to filter Automic related events.
UC4MACS Text Tacl macros used by the Automic agent, can be extended by customer if
needed.
UC4TMPL Text EMS template file to be used with EMS if required.
UCMSL Binary Message texts used by the agent.
UCXBNI6C Binary, Example program showing usage of call API.
executable
 Automation Engine 421

UCXBNI6O Binary, Call API link library

library
UCXFTSRV Binary, Automic server program used for file transfer, will be automatically stopped
executable and started by the agent when using file transfers.
UCXJNI6 Binary, Automic agent
executable
UCXJNI6M Binary, Automic program used to shutdown the agent.
executable
UCXJNI6O Binary, Output collector used by the agent.
executable
UCXJNI6R Binary, Used for internal purposes only, will simply output command line arguments
executable in certain format.
UCXJNI6T Binary, Virtual terminal program, started to be used as a dummy input/output device
executable
UCXSCAN Binary, Scan program internally used by the agent if file system scans for file
executable patterns are requested.
UCYBWAIT Binary, Used for internal purposes only, will simply create a given delay.
executable

CallAPI files and their implementation are described in a separate document.

Procedure

1. Transferring the files to the host

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.
422 Chapter 8 Installation

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.

Parameter Description
AE-PROGRAM-SUBVOLUME= Sub-volume for the executable agent files.
AE-STATUS-STORE-SUBVOLUME= Sub-volume for the StatusStore files of
FileTransfers.

The agent automatically created StatusStore files.

They store the restart information of active
FileTransfers. This mechanism ensures that
aborted FileTransfers 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 FileTransfers 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.
 Automation Engine 423

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
l Set the following command in the TACL input line:

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 Admin computer or Server computer

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
required rights via the Agent object.

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
424 Chapter 8 Installation

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.

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.

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 is found in the subdirectory
IMAGE:AGENTS\AS400.

File name AE CD Description

UCXJO41.BIN OS/400 agent
(binary SavFile)
Content:
IRSTRJOB Auxiliary program
for generating
Jobs
UCXBO41C CallAPI
UCXJO41 Agent
UCXJO41M Messenger
program for the
OS/400 agent
CLLE CL source files for
starting and
ending the agent
INI INI file
 Automation Engine 425

MSL Message library

TMP Empty text file
STRUCAGENT Program that
starts the agent
ENDUCAGENT Program that ends
the agent
MAKEMSL Program that
generates the
message library
COMPRESS, GSS, LIBCPPRNT Service programs
(libraries) for the
agent, the CallAPI
and the
MAKEMSL
program

The CallAPI files and CallAPI implementation are described in a separate document.

Procedure

1. 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)
426 Chapter 8 Installation

l Delete the temporary library.

DLTLIB LIB(UC4TMP)
l Rename the library.
RNMOBJ OBJ(QSYS/UC4AUSL) OBJTYPE(*LIB) NEWOBJ(UC4)

3. Setting up the system environment

l Server computer
l The AE system must be running.
l Host
l Adjust the INI file UC4/INI(UCXJO41).
l Admin computer or User computer
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.
l Admin computer or Server computer
l Verify that the agent is logged on.
l Start the UserInterface for client 0000. Information about agents is available in the System
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
 Automation Engine 427

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.

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.

Automic strongly recommends installing the agent in a separate directory (such as

UC4/Agent/peoplesoft).
428 Chapter 8 Installation

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:

File Name Description

UCXJPSX AE agent for PeopleSoft
UCXJPSX.INI INI file for the PeopleSoft
agent
UCX.msl Message library
psexj.bin Syntax file
UCXJPS82.jar Java Classes
UCXJPS84.jar
libsysapi, libzu00132, libzusynchk, libgcc_s, libstdc++, libucxjpsx3, AE runtime system for the
libucxjpsx4, libucxjpsx5, libucxjpsx6 PeopleSoft agent

File ending with "a" indicates

AIX
File ending with "sl" indicates
HP-UX
File ending with "so"
indicates Solaris

Technical Implementation
Component Interfaces (Java classes) can be used to connect the agent to PeopleSoft/PeopleTools.
 Automation Engine 429

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.
430 Chapter 8 Installation

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

This document guides you through the new installation of a PeopleSoft agent.

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).
 Automation Engine 431

l Open the "Definition Properties"either via "File" -&gt; "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
l Unpack the tar file:
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
432 Chapter 8 Installation

l Set the environment variable for the agent if an environment variable is used in the PeopleTools
configuration file (Log/Output Directory=).
l Admin computer or user computer
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.

6. Using ERP Forms (optional)

l Admin computer and/or user computer

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

l Admin computer or user computer

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.
 Automation Engine 433

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

l Admin computer or user computer

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

l Admin computer or user computer

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.
434 Chapter 8 Installation

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;
 Automation Engine 435

0
COMMIT;

The following SQL script is required if you use PeopleSoft version 8.2x or 8.4x:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_'||PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
'UC4_'||PRCSTYPEDESCR,
RESTARTENABLED,
SYSDATE,
'UC4'
FROM PS_PRCSTYPEDEFN;

COMMIT;

Assign execution rights to the new process types:

INSERT INTO PS_SERVERCLASS
SELECT ORIG.SERVERNAME,
ORIG.OPSYS,
'UC4_'||ORIG.PRCSTYPE,
ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG
WHERE 0 =
(SELECT COUNT(*) FROM PS_SERVERCLASS SC
WHERE SC.SERVERNAME=ORIG.SERVERNAME
AND SC.OPSYS=ORIG.OPSYS
AND SC.PRCSTYPE='UC4_'||ORIG.PRCSTYPE )
AND 0 <
(SELECT COUNT(*) FROM PS_PRCSTYPEDEFN PT
WHERE PT.PRCSTYPE='UC4_'||ORIG.PRCSTYPE
AND PT.OPSYS=ORIG.OPSYS );

COMMIT;

MS SQL Server:

The following SQL script is required if you use PeopleSoft version 8.50 or 8.51:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_' + PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
436 Chapter 8 Installation

CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
LEFT('UC4_' + PRCSTYPEDESCR,30),
RESTARTENABLED,
GETDATE(),
'UC4',
0
FROM PS_PRCSTYPEDEFN;

The following SQL script is required if you use PeopleSoft version 8.2x or 8.4x:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_' + PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
LEFT('UC4_' + PRCSTYPEDESCR,30),
RESTARTENABLED,
GETDATE(),
'UC4'
FROM PS_PRCSTYPEDEFN;

Assign execution rights to the new process types:

INSERT INTO PS_SERVERCLASS
SELECT ORIG.SERVERNAME,
ORIG.OPSYS,'UC4_' + ORIG.PRCSTYPE, ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG WHERE 0 =
(SELECT COUNT(*) FROM PS_SERVERCLASS SC
WHERE SC.SERVERNAME=ORIG.SERVERNAME
AND SC.OPSYS=ORIG.OPSYS
AND SC.PRCSTYPE='UC4_' + ORIG.PRCSTYPE )
AND 0 <
(SELECT COUNT(*) FROM PS_PRCSTYPEDEFN PT
WHERE PT.PRCSTYPE='UC4_' + ORIG.PRCSTYPE
AND PT.OPSYS=ORIG.OPSYS );

l  Automic strongly recommends extensive testing for Jobs that use Bind Variables. More detailed
information is provided in the document Bind Variables.
 Automation Engine 437

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

This document guides you through the new installation of a PeopleSoft agent.

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.

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.

Automic strongly recommends installing the agent in a separate directory (such as

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 files listed below:

File name Description

UCXJPSX.EXE AE agent for PeopleSoft
UCXJPSX2.DLL Runtime library for PeopleTools Version
8.1x (AE Interface)
438 Chapter 8 Installation

UCXJPSX3.DLL Runtime library for PeopleTools Version

8.1x (AE Interface, Java API)
UCXJPSX4.DLL Runtime library for PeopleTools Version
8.1x (Standard Interface, Java API)
UCXJPSX5.DLL Runtime library for PeopleTools Version
8.4x (Standard Interface, Java API)
UCXJPSX6.DLL Runtime library for PeopleTools Version
8.4x (AE Interface, Java API)
UCXJPSX.INI INI file for the PeopleSoft agent
UC.MSL Message library
ZUSYNCHK.DLL Runtime library for syntax checks
ZU00132.DLL Runtime libraries for shared functions
UCXJPS82.jar Java classes
UCXJPS84.jar
SETUP.EXE Installation program

The other files from this subdirectory are part of the installation program. The files of the AE Interface and
how they are implemented is described in a separate document.

Technical Implementation
Component Interfaces (Java classes) can be used for connecting the agent to PeopleSoft/PeopleTools.

1) People Tools with AE Interface (Java Classes)

Accesses for job processing are made via the Java Classes of the supplied UC4_* component interfaces.
 Automation Engine 439

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

440 Chapter 8 Installation

Installing the Agent for People Soft (Windows) - Details

This document guides you through the new installation of a PeopleSoft agent.

1. Installing the Microsoft Visual C++ 2010 Redistributable 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 and which version of the package is available.

l Host
l Install the package from the IMAGE:CRTS directory.

2. Installing the Java Runtime Environment (JRE)

Note that PeopleTools Version 8.53 requires at least Java Version 1.7!

If JRE is already available in the required version, this step of the installation process can be ignored.

l Admin computer and/or User computer

l The Version of the current Java Virtual Machine (VM) of the system can be checked with the
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.

l Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control as AE does not need it.

3. 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" -&gt; "Definition Properties" or use the
shortcut ALT + ENTER.
l In the Translate Values tab, change the table as shown below:
 Automation Engine 441

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

The file psjoa.jar is stored in the folder "web" in the installation directory of PeopleSoft. If PeopleSoft is
not installed on the same computer as the agent, release the folder "web" as share. The User under
which the agent starts must have computer access rights.

l Admin computer orUser computer

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 Admin computer and/or User computer

442 Chapter 8 Installation

l The PeopleSoft Java Object Adapter is required for using PS ERP Forms.Copy the "psjoa.jar"file to
the agent's and UserInterface's bin directories.
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

l Admin computer or User computer

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

l Admin computer or User computer

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

l Admin computer or User Computer

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.
 Automation Engine 443

11. Functional

l ServerComputer
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 orServerComputer
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 AdminComputer/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 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 whenBind 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:

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,
444 Chapter 8 Installation

WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
'UC4_'||PRCSTYPEDESCR,
RESTARTENABLED,
SYSDATE,
'UC4'
FROM PS_PRCSTYPEDEFN;
0
COMMIT;

The following SQL script is required if you use PeopleSoft version 8.2x or 8.4x:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_'||PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
'UC4_'||PRCSTYPEDESCR,
RESTARTENABLED,
SYSDATE,
'UC4'
FROM PS_PRCSTYPEDEFN;

COMMIT;

Assign execution rights to the new process types:

INSERT INTO PS_SERVERCLASS
SELECT ORIG.SERVERNAME,
ORIG.OPSYS,
'UC4_'||ORIG.PRCSTYPE,
ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG
WHERE 0 =
(SELECT COUNT(*) FROM PS_SERVERCLASS SC
WHERE SC.SERVERNAME=ORIG.SERVERNAME
AND SC.OPSYS=ORIG.OPSYS
AND SC.PRCSTYPE='UC4_'||ORIG.PRCSTYPE )
AND 0 <
(SELECT COUNT(*) FROM PS_PRCSTYPEDEFN PT
WHERE PT.PRCSTYPE='UC4_'||ORIG.PRCSTYPE
AND PT.OPSYS=ORIG.OPSYS );
 Automation Engine 445

COMMIT;

MS SQL Server:

The following SQL script is required if you use PeopleSoft version 8.50 or 8.51:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_' + PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
LEFT('UC4_' + PRCSTYPEDESCR,30),
RESTARTENABLED,
GETDATE(),
'UC4',
0
FROM PS_PRCSTYPEDEFN;

The following SQL script is required if you use PeopleSoft version 8.2x or 8.4x:
INSERT INTO PS_PRCSTYPEDEFN
SELECT 'UC4_' + PRCSTYPE,
OPSYS,
DBTYPE,
VERSION,
PARMLIST,
CMDLINE,
WORKINGDIR,
OUTPUTDEST,
GENPRCSTYPE,
WINPARM,
MVSSHELLID,
AS4JOBDESCNAME,
AS4JOBDESCLIB,
LEFT('UC4_' + PRCSTYPEDESCR,30),
RESTARTENABLED,
GETDATE(),
'UC4'
FROM PS_PRCSTYPEDEFN;

Assign execution rights to the new process types:

INSERT INTO PS_SERVERCLASS
SELECT ORIG.SERVERNAME,
ORIG.OPSYS,'UC4_' + ORIG.PRCSTYPE, ORIG.PRCSPRIORITY,
ORIG.MAXCONCURRENT
FROM PS_SERVERCLASS ORIG WHERE 0 =
(SELECT COUNT(*) FROM PS_SERVERCLASS SC
446 Chapter 8 Installation

WHERE SC.SERVERNAME=ORIG.SERVERNAME
AND SC.OPSYS=ORIG.OPSYS
AND SC.PRCSTYPE='UC4_' + ORIG.PRCSTYPE )
AND 0 <
(SELECT COUNT(*) FROM PS_PRCSTYPEDEFN PT
WHERE PT.PRCSTYPE='UC4_' + ORIG.PRCSTYPE
AND PT.OPSYS=ORIG.OPSYS );

l  We recommend testing Jobs which use Bind Variables extensively. More detailed information is
provided in the document Bind Variables.

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

Folder Description
PT8.21 Directory that contains the project files of the AE Interface for PeopleTools 8.2x
PT8.46 Directory that contains the project files of the AE Interface for PeopleTools 8.42 up to 8.46
PT8.49 Directory that contains the project files of the AE Interface for PeopleTools 8.47, 8.48 and 8.49
 Automation Engine 447

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.
448 Chapter 8 Installation

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.
 Automation Engine 449

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.
450 Chapter 8 Installation

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

 Automation Engine 451

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

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.

Automic strongly recommends installing the agent in a separate directory (such as

UC4/Agent/rapidautomation or C:\AUTOMIC\Agent\rapidautomation).

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.
452 Chapter 8 Installation

Supplied Files
The files that belong to the RA agent are stored in the directory IMAGE:AGENTS\RAPIDAUTOMATION.

File name Description

ucxjcitx.jar Agent for Rapid Automation
ucxjcitx.ini Configuration file
*.jar Libraries
uc.msl Message library
setup.exe Installation program

Procedure
1. Installing Java Standard Edition

This installation step can be omitted if the required version of Java Standard Edition is already
available.

l Admin computer and/or user computer

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 that is listed first is used.

l Download the required Java Runtime Environment from http://java.sun.com and install it.

2. Setting up the Agent

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
the agent and computer name, and the port of the communication process to which the agent
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
 Automation Engine 453

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

5. Starting the 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.

Note that the storage limit should be set to at least 256MB (or 512MB) for starting Java agents
(Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java applications
by using the start parameter -XmX.
Specifying a value that is too low can cause the agent to crash. The default value depends on the
Java version that is used.

The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation.

6. 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.
454 Chapter 8 Installation

l RA jobs do not contain Login objects. Login data is stored in one or several Connection objects
during the installation process and can be selected in the Agent object.

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:
 Automation Engine 455

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.

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.

Automic strongly recommends installing the agent in a separate directory (such as

C:\AUTOMIC\AGENT\SAP).
456 Chapter 8 Installation

Before you start the installation, make sure that the Java agents can only connect to CP port numbers
that are lower than 65536. If they use a higher port number, the agent cannot start and aborts with an
error message. This limitation is caused by Java and affects the agents for JMX, Databases, SAP and
RA.

It is not required to install the agent on the same computer as the SAP system.

Requirements
The following SAP support packages are required for using the job options No printing, Report send
status and Report status by mail for spool-list receivers:

l For 4.6C: SAPKB46C52

l For 6.20: SAPKB62059
l For 6.40: SAPKB64017
l For 7.00: SAPKB70008

Supplied Files
The files are found in the directory IMAGE:AGENTS\SAP\UNIX or IMAGE:AGENTS\SAP\WINDOWS.

File name Description

UCXJR3X.JAR SAP agent
UCXJR3X.INI INI file for SAP agent
UC.MSL Message library
SAPRFC.INI INI file for SAP's Remote Function Call
UMSVCP60.DLL Runtime library (Windows)
SETUP.EXE Installation program (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

 Automation Engine 457

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.

2. Installing the Java Runtime Environment (JRE)

If the required version of JRE is already available, you can skip this step.

l Admin computer and/or User computer

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.

l Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control if you prefer; AE does not need it.

3. 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
458 Chapter 8 Installation

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

 Automation Engine 459

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 Admin computer or User computer

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 Admin computer or User computer

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 The AE system must be running.
l Host
460 Chapter 8 Installation

l Use the commands to start the agent via the command line for your operating system.
l Windows:
<path to java> -Xrs -Xmx256M -jar ucxjr3x.jar

If java is installed in a folder which contains spaces the command needs to be placed in
quotes.

For example:
"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.

Note that the storage limit should be set to at least 256MB (or 512MB) for starting Java agents
(Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java applications by
using the start parameter -XmX.
Specifying a value that is too low can cause the agent to crash. The default value depends on the Java
version that is used.

The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation.

l If it does not already exist, an Agent object is automatically created in system client 0000 and
stored in the folder HOST.
l Admin computer or Server computer

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 Admin computer/host
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.
l Monitor the process in the UserInterface.
 It can take a couple of seconds for the system to register that the job is done. The agent checks
at a regular interval whether the job is still running. This interval can be specified in the Host
Characteristics.
 Automation Engine 461

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.

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.

Automic strongly recommends installing the agent in a separatedirectory (such as

C:\AUTOMIC\Agent\SIEBEL).

Supplied Installation Files

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
l Install the package from the IMAGE:CRTS directory.

2. Installing the Agent and setting up the system environment

462 Chapter 8 Installation

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 Admin computer or Server computer
l Adjust HEADER.SIEBEL, TRAILER.SIEBEL and RESTART.SIEBEL if necessary. See: Job -
Execution.

3. Starting the Agent

l Server computer
l The AE system must be running.
l Host
l Start the agent from the AE program group.
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 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, 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.

Use the ServiceManager to start or end the agent as a service.

4. Shutting down the Agent

l Host
l Shut down the agent.
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.

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.

Automic strongly recommends installing the agent in a separate directory.

 Automation Engine 463

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.

Eacht TAR file is found in the subdirectory of IMAGE:AGENTS\UNIX that corresponds with the
appropriate UNIX version.

File name Description

ucxj??? UNIX agent
ucxj???m Message Program for UNIX agent
464 Chapter 8 Installation

ucxjxxx.ini Sample of the INI file for the UNIX agent

ucx.msl Message library
ucxe???f Help program for extended querying of the file system

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 Admin computer or Server computer

l Adjust the HEADER.UNIX, TRAILER.UNIX and RESTART.UNIX if necessary. See:Job -
Execution
 Automation Engine 465

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

3. Starting the Agent

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,
466 Chapter 8 Installation

you need the OS user under which the related jobs and file transfers are started, and write access to
the backup directory.
l Admin computer or Server computer
l Verify whether the agent is logged on.
l Start the UserInterface for client 0000. Information about agents is available in the System
Overview. Because a newly logged-on agent has not yet been assigned a client, it can only
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.
 Automation Engine 467

The job limit must be specified with a number higher than zero in order to enable AE Jobs to be
performed in batch mode.

Supplied Installation Files

The files are found in the subdirectory of IMAGE:AGENTS\VMS that corresponds with the particular VMS
variant.

File name Description Destination File

directory type
UCXJV??.EXE VMS agent BIN Binary
UCXJV??M.EXE Messenger Program BIN Binary
UCXE???F.EXE For file event BIN Binary
UCXJV??.INI INI file BIN Text
UCX.MSL Message Library BIN Text
UC$CRDIR.COM Command file that creates directories and CMD Text
determines authorization
UC$START.COM Command file for starting the agent CMD Text
UC_START.COM Help command file for start the agents CMD Text
UC$STOP.COM Command file for deactivating the agent CMD Text
UC4$STARTUP.COM Command file (1) for automatic start of the agent SYS$STARTUP Text
UC4$STARTUP_ Command file (2) for automatic start of the agent SYS$STARTUP Text
BAT.COM

The CallAPI files and their implementation are described separately.

8.2.3 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).
468 Chapter 8 Installation

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.

4. Setting up the system environment

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.
 Automation Engine 469

$   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 Admin computer or User computer
l Adjust HEADER.VMS, TRAILER.VMS and RESTART.VMS if needed. See:Job - Execution

5. Starting the Agent

l Server computer
l Register using the user AE.
l The AE system must be running.
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.
l Admin computer or Server computer
l Verify that the agent is logged on.
l Start the UserInterface for client 0000. Information about agents is available in the System
Overview. Because a newly logged-on agent has not yet been assigned a client, it can only
be viewed in the client 0000. The newly installed agent can be assigned to clients with the
required rights through the agent object.

6. Shutting down the Agent

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
470 Chapter 8 Installation

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

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.
 Automation Engine 471

Automic strongly recommends installing the agent in a separate directory (such as

C:\AUTOMIC\AGENT\WINDOWS).

Supplied Installation Files

The files of the Windows agent are found in the directory IMAGE:AGENTS\WINDOWS.

File name Description

UCXJ???.EXE Windows agent.
UCXJ???M.EXE Message program for Windows agent.
UCXJ???.INI INI file for Windows agent.
UC.MSL Message library.
UCSMTP.DLL Library for the email connection via SMTP.
ZU00132.DLL Runtime library for shared functions.
SETUP.EXE Installation program (only for Intel IA-32).

Other files from this subdirectory are components of the installation program and the AE runtime system.
See: Knowledge Base.

The CallAPI files and CallAPI implementation are described in a separate document.

Potential Problems
l 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

1. Installing the Microsoft Visual C++ 2010 Redistributable 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 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.
472 Chapter 8 Installation

2. Installing the Agent

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.

3. Setting up the system environment

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"..
Admin computer or Server computer
Adjust HEADER.WINDOWS, TRAILER.WINDOWS and RESTART.WINDOWS if necessary.
See: Job - Execution.
4. Starting the Agent
 Automation Engine 473

l Server computer
l The AE system must be running.
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.
l Admin computer or Server computer
l Verify that the agent is logged on to the AE system.
l Start the UserInterface for client 0000. Information about agents is available in the System
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
required rights via the Agent object.

Use the ServiceManager to start or end the agent as a service.

5. Shutting down the Agent

l Host
l Shut down the agent.
Right-click the agent in the task bar. Click Exit.

Comments
Below you will find more detailed information about additional rights that are required when you install the
Windows agent as described above in the section "Setting up the system environment".

The Windows agent requires certain additional rights under Windows in order to be able to use the
Windows APIs that are listed below.

The agent requires these rights in order to process file transfers and start jobs in different user contexts.
Although users are defined in the Automation Engine jobs, the agent must still be able to log on with the
privileges of the particular user, read user profiles and start Jobs, for example. Therefore, Automic
recommends starting the agent via the Service Manager as a SYSTEM user.

When you start the agent as a regular user, however, you should install it with the recommended additional
rights in order to make sure that it can process the above tasks:

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

See also:

Configuring the Debugger for potential program failures

474 Chapter 8 Installation

Installing the Agent for z/OS

This document guides you through the new installation of a z/OS agent.

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.

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 following files are available in the directory IMAGE:AGENTS\MVS.

File name AE CD Description File name z/OS

UCXJM25-IBM.BIN z/OS agent UC4.UCXJM25.LOAD

Created using the TSO TRANSFER utility.

UCXJM25.INI INI file of the z/OS agent. UC4.UCXJM25.INI
UCXEM25.INI INI file of the Event Monitor. UC4.UCXEM25.INI
UCX.MSL Message Library. UC4.UC.MSL
STC25.TXT JCL for the started task.
UC4JCLE.ASM Sample module for the JCL Exit.
UC4EJM.INI INI file of the external job monitor.

The CallAPI files and their implementation are described in a separate document. 

8.2.5 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)
 Automation Engine 475

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

476 Chapter 8 Installation

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 FileTransfers. This
user must also be specified in the appropriate LOGIN object. Users without a password (batch
users) must be specified in the LOGIN object with no password being indicated. The parameter
askRACF in the agent's INI file must be set to "0" or "4" in order to deactivate the password
verification.

Using different users:

An appropriate OMVS segment must be defined for all users in addition to the required resources in
order to establish a TCP/IP connection to the Automation Engine. Specify the relevant LOGIN
object in the job attributes. If a batch user (user without a password) is used for the execution, the
STC user requires a surrogate authorization for this particular user. In this case, specify the
required user in the LOGIN object without defining a password and deactivate the password
verification (set the parameter askRACF in the agent's INI file to "0" or "4" ).

l 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
 Automation Engine 477

//SYSPRINT DD SYSOUT=*
//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 objectMVS.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

//SYSPRINT DD SYSOUT=*
//SYSIN DD *
  DEFINE -
  CLUSTER ( -
  NAME(UC4.UCXJM25.SSTORE) -
478 Chapter 8 Installation

  INDEXED -
  VOLUMES(volume) -
  CYLINDERS(10 5) -
  ) -
  DATA (   -
  NAME(UC4.UCXJM25.SSTORE.DATA) -
KEYS(16 0) -
RECORDSIZE(256 4096) -
  FREESPACE(10 10) -
)-
  INDEX (   -
  NAME(UC4.UCXJM25.SSTORE.INDEX) -
)
//* Load a dummy record
//DUMMYREC EXEC PGM=IDCAMS
//SYSPRINT DD SYSOUT=*
//OUT1 DD DISP=SHR,DSN=UC4.UCXJM25.SSTORE
//SYSIN DD * REPRO INFILE(IN1) OFILE(OUT1)
//IN1 DD *
DUMMY
/*

 Transfer information for every dataset/file is stored as a record in the VSAM dataset. The size of
the information record varies depending on the size of the dataset and file size. 260 bytes is an
average size. The suggested space values are 10,5 cylinders = (10 + 15 * 5) * 849,960 bytes ~
75.553 kilobyte, which should be enough for approximately 282k transfer entries.

5. Setting up the system environment

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

6. Starting the Agent

l Server computer
l The AE system must be running.
l Host
l Start using start UC4RUN via the system console.
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 is logged on.
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

 Automation Engine 479

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
//SYSPRINT DD SYSOUT=*
//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 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
//SYSPRINT DD SYSOUT=*
//SYSIN DD *
  DEFINE -
  CLUSTER ( -
  NAME(UC4.UCEVENT.VSAM) -
  INDEXED -
  VOLUMES(DSK30D) -
  TRACKS(1 1) -
  ) -
  DATA ( -
  NAME(UC4.UCEVENT.VSAM.DATA) -
  KEYS(20 0) -
  RECORDSIZE(1024 1024) -
  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
480 Chapter 8 Installation

//SYSPRINT DD SYSOUT=*
//OUT1 DD DISP=SHR,DSN=UC4.UCEVENT.VSAM
//SYSIN DD *
  REPRO INFILE(IN1) OFILE(OUT1)
//IN1 DD *
DUMMY
/*

l 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
//SYSPRINT DD SYSOUT=*
//STDOUT DD SYSOUT=*
//SYSUDUMP DD SYSOUT=*

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 "???."
 Automation Engine 481

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 are found in
subdirectories of IMAGE:SERVICEMANAGER\UNIX. The names of the subdirectories indicate the
supported platforms.

File name Description

libgcc_s.so GNU C Library
libstdc++.so GNU C++ Library
libsysapi.so, libzu00132.so, libssp Runtime libraries
uc4.smd Definition file for AE services to be started
uc.msl Message library
ucybsmcl Command line program for the ServiceManager
ucybsmgr ServiceManager
ucybsmgr.ori.ini Initialization file for the ServiceManager

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
l Unpack the tar file:
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

482 Chapter 8 Installation

HP-UX: export SHLIB_PATH=Path of the system library directory

Solaris, Linux, zLinux: export LD_LIBRARY_PATH=Path of the system library directory

2. 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:
o Note that for Automation Engines on UNIX, the file "syntax.bin" is in the same directory as

the INI files.

See also:

ServiceManager - Service
ServiceManager - Dialog Program
ServiceManager - Command Line Program

Installing the ServiceManager (Windows)

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 are found in the directory IMAGE:SERVICEMANAGER\WINDOWS.

File name Description

UCYBSMGR.EXE ServiceManager
UCYBSMGR.INI Initialization file for the ServiceManager
UC4.SMD Definition file for AE services to be started
 Automation Engine 483

ZU00132.DLL Runtime library for common functions

SETUP.EXE Installation program

The directory IMAGE:SERVICEMANAGERDIALOG\WINDOWS contains the files for the dialog and
command line programs of the ServiceManager.

File name Description

UCYBSMDI.EXE Dialog program for the ServiceManager
UCYBSMDI.INI Initialization file for the dialog program
UCYBSMCL.EXE Command line program for the ServiceManager
SETUP.EXE Installation program

Additional files that are included in these sub-directories belong to the installation program and the AE
runtime system. See: Knowledge Base.

Procedure

Server computer or host computer

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

l Start the program SETUP.EXE in the corresponding subdirectory of
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)

l Start the program SETUP.EXE in the corresponding subdirectory of
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)
484 Chapter 8 Installation

3. Installing the Dialog and Command Line Programs of the ServiceManager

l Host (32 bit)

l Start the program SETUP.EXE in the corresponding subdirectory of
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)

l Start the program SETUP.EXE in the corresponding subdirectory of

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

 Automation Engine 485

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
486 Chapter 8 Installation

l ServiceManager - Command Line Program

l Configuring the Debugger for potential program failures

Installing the CallAPIs

Installing the Call API 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

l IMAGE:AGENTS\BS2000\SIEMENS\UCXJB25.TAR for BS2000 Sockets Version 2.1
l IMAGE:AGENTS\BS2000\SIEMENS\UCXJB26.TAR for BS2000 Sockets Version 2.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 TAR file contains the files listed below, which are supplied with the BS2000 package. The characters
"x.xxx" replace the part of the file name that shows the current Automation Engine version:

File name Description

x.xxx.UCXBB2?C.INI INI file for the utility
x.xxx.UCXBB2?C.LIB LMS Plamlibrary

The LMS Plamlibrary contains all elements that are required for programming.

Element name Description

UCXBB2?C Type L Utility for calling the CallAPI
UCCALL3 Type L Large module that should be included or dynamically reloaded to the program
used by the CallAPI
UCCALL3 Type M Assembler macro for the interface description
UCCALL3.H Type S C-header file for the interface description
UCCALL3.CPY COBOL copy for the interface description
Type S
 Automation Engine 487

SAMPLE.COBOL Sample source for using the CallAPI from a COBOL program
Type D

Procedure
1. Setting up the system environment

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 Call API 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.

File name Description

ucxbgc8c Utility for calling the CallAPI
ucxbxxxc Sample program for calling the CallAPIs
ucxgc8c.oml OML library with CallAPI functions
ucxbgc8ci INI file for the utility
UCMSL Message library
callapi JCL for calling the CallAPI
callapi_fc JCL for calling the CallAPI (INI and SCRIPT files are allocated statically)
callapi_logon JCL for calling the CallAPI (call with LOGON information)
script AE Script file
uccall3.h Header file for the sample program with structure and API definition
488 Chapter 8 Installation

ucxbxxxc.c Sample program for calling the CallAPI (program code C)

comp_xxx, link_xxx JCL for compiling and creating the sample program
go_xxx JCL for calling the sample program
go_xxx_fc JCL for calling the sample program (INI and SCRIPT files are allocated statically)
go_xxx_logon JCL for calling the sample program (call with LOGON information)

Procedure
1. 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.

  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 GCOS8

Installing the Call API 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.
 Automation Engine 489

File name Description

UCCALL3.JAR CallAPI for Java
UCXBXXXC.INI Configuration file for the CallAPI
UCCALL3.BAT Batch file for calling the CallAPIs
SCRIPT.TXT Example for a script
SAMPLE.ZIP Example for Java programs
CALLAPI-DOC.ZIP Documentation for the UCCALL3 class

Procedure
1. Transferring the files and setting up the system environment

l Copy the supplied files to a separate directory (e.g. C:\AUTOMIC\CALLAPI\WINDOWS).

l If required, adjust the INI file UCXBXXXC.INI.

 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 Java

Installing the Call API 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 are not packed; they are available as binary files and as ASCII files. They are found in the
subdirectory IMAGE:CALLAPI\NSK.

File name File Description

UCXBNS1C Binary Utility for calling the CallAPI
UCXBNS1I Text INI file for the utility
scrsamp Text AE sample script
490 Chapter 8 Installation

UCMSL Text Message library

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.

 You can keep your existing INI file even if there is a new Automation Engine version. It might be
required to adjust it. More detailed information is provided in the Release Notes, a collection of
which is found in the manual Release Notes.

See also:

CallAPI for NSK

Installing the Call API 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
 Automation Engine 491

directory contains a sample sucI file (UCXBM25C.INI), which can be used for any text file transfer to
z/OS. Be sure to adjust it to your installation (Automation Engine data, for example).

You can keep your existing INI file even if there is a new Automation Engine version. It might be
required to adjust it. More detailed information is provided in the Release Notes, a collection of which is
found in the manual Release Notes.

See also:

CallAPI for z/OS

Installing the Call API 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).

You can keep your existing INI file even if there is a new Automation Engine version. It might be
required to adjust it. More detailed information is provided in the Release Notes, a collection of which is
found in the manual Release Notes.

See also:

CallAPI for OS/400

Installing the Call API 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 "???."
492 Chapter 8 Installation

Supplied Files
The files that belong to the CallAPI are provided in the subdirectories of the IMAGE:CallAPI\SAP. The
subdirectory \SAMPLE contains examples. These examples are not platform-specific.

Windows UNIX Description

ucxsapc.jar ucxsapc.jar RFC Server
ucxsapc.ini ucxsapc.ini INI file for RFC Server
uccall3.jar uccall3.jar CallAPI for JAVA
uc.msl uc.msl Message library

Technical Implementation

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.

1. Installing the Java Runtime Environment (JRE)

If JRE is already available in the required version, you can skip this step.

l Admin computer and/or user computer

l You check the version of the system's current Java Virtual Machine (VM) with the following
command.
 Automation Engine 493

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.

l Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control, because AE does not need it.

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

l Unpack the tar file:
gzip -d ucxsapc.tar.gz or gunzip ucxsapc.tar.gz
tar xvf ucxsapc.tar

(Linux: tar -zxvf ucs???.tar.gz)

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. 
494 Chapter 8 Installation

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:
 Automation Engine 495

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

496 Chapter 8 Installation

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 Call API 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
 Automation Engine 497

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.

The following files are supplied with AE and form the contents of the TAR file:

File name Description

UCXB???C Utility for calling the CallAPI
UCXBXXXC.ini INI file for the utility
start_example.??? Script for starting the utility
UCXBXXXC.c Sample program for calling the CallAPI (program code C)
uccall3.h Header file for the sample program with structure and API definition
makefile_example.??? Makefile for the sample program
libucxb???c.a, Link module - used from utility and example program
libucxb???c.so or
libucxb???c.sl
libssp
UCX.msl Message library

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

 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.
498 Chapter 8 Installation

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 Call API 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 are found in the appropriate subdirectory of the VMS variant under
IMAGE:CALLAPI\VMS.

File name Description

UCXBV??C.EXE Utility for calling the CallAPI
UCXBVXXC.INI INI file for the utility
API_START.COM Script for starting the utility
UCXBVXXC.C Sample program for calling the CallAPI (Program Code C)
UCCALL3.H Header file for sample program with structure and API definition
MAKEXAMP.COM Makefile for sample program
UCXBV??C.OLB Connecting module, used by sample program
UCX.MSL Message library

Procedure
1. Transferring the supplied files to the host

l Transfer the files using FTP.

openIP address
User name = UC4
Password = <as specified>
 Automation Engine 499

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.

 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 chapter Release Notes.

See also:

CallAPI for VMS

Installing the Call API 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.

Supplied Files
File name Description
sample1.jcl VSE example job, assigning AE Script using SYSIPT 
sample2.jcl VSE example job, AE Script via library element
ucx.msl Message library in adequate form for VSE
ucxbvse.bin CallAPI utility in binary form
ucxbvse.ini Configuration file
ucxbvse.punch CallAPI utility as PUNCH output
500 Chapter 8 Installation

Procedure
Adjust the supplied INI file to the values of your installation.

You can keep your existing INI file even if there is a new Automation Engine version. It might be
required to adjust it. More detailed information is provided in the Release Notes, a collection of which is
found in the manual Release Notes.

First, a library should be created in the VSE. It is called "PRD2.UC4" in this document. You can, of
course, select any name of your choice. The library can be created with a job using the utility LIBR:
* $$ JOB JNM=CREATE,CLASS=A,DISP=D
* $$ LST CLASS=A,DISP=D
// JOB CREATE
// EXEC LIBR
DEFINE SUB=PRD2.UC4
/*
/&
* $$ EOJ

The next step is to transfer the files to the VSE operating system. This is possible with IND$FILE or, if
available, by using FTP on the VSE computer.

If IND$FILE is not possible and no FTP is available, the program must be created using the Punch file
ucxbvse.punch.

Transfer with IND$FILE

Many 3270 emulations support the file-transfer method IND$FILE. In the IBM emulation, there are the
console utilities SEND.IND$FILE and RECEIVE. IND$FILE must be installed on the VSE in order to use
this type of file transfer. Use the following steps to confirm installation:

1. Log on to VSE in CICS.

2. Delete the CICS screen (F9 key = Escape).
3. Enter IND$

IND$FILE has successfully been installed if no error message is displayed. Press the F3 key (end IND$ 
transaction) and the F3 key (back to CICS menu) to get back.

If you want to execute the transfer, you should be on the deleted CICS screen with the 3270 emulation. If
this is not possible for reasons of security, you can change to a transfer mode using the menu items 3
(Operations), 8 (Personal Computer Move Utilities) and 6 (PC File Transfer).

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
 Automation Engine 501

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

502 Chapter 8 Installation

Installing the Call API 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.

File name Description

UCXBWI3C.DLL CallAPI
UCXBXXXC.EXE Utility for calling the CallAPI
UCXBXXXC.INI INI file for the utility
UCCALL3.BAT Batch file for starting the utility
UCCALL3.VBS Example (Visual Basic Script) for using the CallAPI with OLE
UCCALL3.H Header file with structure and API definition
UCXBWI3C.LIB Library - must be linked
ZU00132.DLL Runtime library for shared functions
UC.MSL Message library

Procedure
1. Installing the Microsoft Visual C++ 2010 Redistributable Package

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 Install the package from the IMAGE:CRTS directory.

2. Transferring the files and setting up the system environment

l Copy the files to a separate directory (C:\AUTOMIC\CALLAPI\WINDOWS).

l If required, adjust the INI file UCXBXXXC.INI.

 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 available in the chapter Release Notes.

3. Using OLE
 Automation Engine 503

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.

File name Description 

UCXBMQCS.EXE Connect for connecting to WebSphere MQ Queue Manager Server
UCXBMQCS.INI INI file for WebSphere MQ Queue Manager Server's Connector 
UC.MSL Message library
ZUXML1.DLL Runtime library for XML
ZU00132.DLL Runtime library for shared functions

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.
504 Chapter 8 Installation

Technical Implementation

Technical implementation

These applications place their activation requests for an AE script to the AE queue of the WebSphere MQ
Queue Manager. Connect regularly checks the contents of this queue. If there is a request in the queue, it
is forwarded to the Automation Engine. The Automation Engine processes the script and reports the result
to Connect for WebSphere MQ. Connect for WebSphere MQ converts this result and forwards it to the
Message Queue Manager which then updates the corresponding request and reports status and result to
the application.

Starting Operation

Connect for WebSphere MQ must be installed on a system on which an WebSphere MQ Queue Manager
Server is running. A WebSphere MQ Queue Manager Server must be available to set and configure the
CallAPI queue.

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

 Automation Engine 505

Call API 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
506 Chapter 8 Installation

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.

File name Description

AEResourceAdapter.rar AE.ResourceAdapter
 Automation Engine 507

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.
508 Chapter 8 Installation

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.
 Automation Engine 509

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.

510 Chapter 8 Installation

Installation

Installing the AE.Internal Webservice (Glassfish)

The following steps are required for installing and configuring the AE.Internal Webservice on a Glassfish
application server.

Supplied File
The AE.Internal Webservice file is available in the directory IMAGE:WEBSERVICE

File name Description

UC4WS.WAR Internal Webservice

Procedure
1. 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 Web Interface 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.

l Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.
 Automation Engine 511

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
The AE.Internal Webservice file is available in the directory IMAGE:WEBSERVICE

File name Description

UC4WS.WAR AE.Internal Webservice

Procedure
1. Installing the Webservice

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 WSDL is available via the following link:
http://Server name:Port/uc4ws/uc4ws?wsdl

2. Configuring the Webservice

l Host
l Call the Configuration Web Interface using 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 for the Internal Webservice.

l Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
512 Chapter 8 Installation

your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.

See also:

Using the Webservice

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
The AE.Internal Webservice file is available in the directory IMAGE:WEBSERVICE

File name Description

UC4WS.WAR Internal Webservice

Procedure
1. Installing the Webservice

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 WSDL is available via the following link:
http://Server name:Port/uc4ws/uc4ws?wsdl

2. Configuring the Webservice

l Host
l Call the Configuration Web Interface using 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 for the Internal Webservice.

l Note that the configuration file will be overwritten when you deploy the WAR file again. As a
 Automation Engine 513

result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.

See also:

Using the Webservice

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

File name Description

UC4WS.SCA Internal Webservice

Procedure
1. Installing the Webservice

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:
http://Server name:Port/uc4ws/uc4ws?wsdl

2. Configuring the Webservice

514 Chapter 8 Installation

l Host
l Additional authorizations are required to access the Configuration Web Interface of the AE.Internal
Webservice. Log on to the SAP Netweaver's User Management Configuration.
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 Web Interface:

http://Server name:Port/uc4ws/admin
l Enter the communication process to which a connection should be established (format: "Server
name:Port").
l No "Default user" is required.

See also:

Using the Webservice

Configuration Web Interface 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
 Automation Engine 515

Field/Element Description
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
516 Chapter 8 Installation

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.
 Automation Engine 517

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 Log on to system client 0000.

l Open the variableUC_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:
518 Chapter 8 Installation

There are two different installation types. The ServiceManager and the agent are either installed on a
shared disk (Type 1) or the ServiceManager is installed on a local disk and the agent on a shared disk
(Type 2).

Type 2 does not require you to switch the cluster group during the installation. The ServiceManager must
be installed on each node.

Type 1:

l 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 theHost 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

 Automation Engine 519

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).
520 Chapter 8 Installation

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:
 Automation Engine 521

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.
522 Chapter 8 Installation

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.
 Automation Engine 523

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
524 Chapter 8 Installation

8.2.6 After Installation

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

3. Setting up an authorization system

 Automation Engine 525

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.

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

Function Description
Database Maintenance Regular database maintenance is essential after AE system installation.
Database - Overview Additional database maintenance activities are described here.

Settings

Function Description
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
526 Chapter 8 Installation

Server

Function Description
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

Function Description
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

Function Description
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

Function Description
 Automation Engine 527

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

Note that AE checks whether the rest field of an object contains valid content before the
object starts. If not, the server will cancel the start procedure. The rest field is a database
field that contains the object's attributes. You can check the rest fields when you update
your database. By default, this function is deactivated, but it can be activated by
removing the comment in front of the following line:
message REPAIR_REST_FIELD
If necessary, the contents of inconsistent rest fields are repaired automatically.

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.
528 Chapter 8 Installation

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
Installing Utilities (UNIX)
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 "???."
 Automation Engine 529

Requirements

l Valid user ID for installation (AE)

Supplied Files

The utility files are supplied in compressed form (util???.tar.gz) and are stored in subdirectories of
IMAGE:UTILITIES\UNIX. Subdirectory names represent the supported platforms.

*.sh: normal utility start

Without file ending: programs for batch call

File name Description

UCYBDBar.jar AE DB Archive
(archiving the
database)
ucybchng AE.DB Change
(editing exported
data)
UCYBDBcc.jar AE DB Client
Copy (copying and
deleting clients)
UCYBDBLd.jar AE DB Load
(loading the
database)
UCYBDBre.jar AE DB Reorg
(reorganizing the
database)
UCYBDBRR AE.DB Revision
Report (creating
revision reports)
UCYBDBUn.jar AE DB Unload
(unloading the
database)
UCYBLGMX AE.LogMix
(combination of log
and trace files)
ucyrepg.jar AE.Reporting
Tool (defining
queries)
uc.msl Message library
UC4LAF.jar Archive for layout
files
*.ini Initialization files
for the utilities
*.sh Start scripts for
calling the utilities
530 Chapter 8 Installation

libgcc*, libssp*, libstdc++*, libsysapi, libuc001, libuccache, libucdbup, Runtime libraries

libucsbepm, libucudb32, libUCYBCLICPY, libUCYBDBLd, libUCYBDBUn,
File ending with"a"
libUCYDBArchive, libUCYDBReorg, libzu00132, libzuxml, ucucli, ucuoci,
indicates AIX
File ending with"sl"
indicates HP-UX
File ending with
"so" indicates
Solaris, Linux and
zLinux

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

l Download the required Java Runtime Environment from http://java.sun.com and install it.

2. Transferring the tar File to the Host

l Admin computer
l Log on using the user ID AE.
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.
l Unpack the tar file:
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.

Installing Utilities (Windows)

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.
 Automation Engine 531

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

File name Description

UCYBARBR.EXE AE.Archive Browser
(searching the archive
files)
UCYBCHNG.EXE AE.DB Change (editing
exported data)
UCYBDBRR.EXE AE.DB Revision
Report (creating
revision reports)
UCYBDBCC.JAR AE DB Client Copy
(copying and deleting
clients)
UCYBDBAR.JAR AE DB Archive
(archiving the database)
UCYBDBLD.JAR AE DB Load (loading
the database)
UCYBDBRE.JAR AE DB Reorg
(reorganizing the
database)
UCYBDBUN.JAR AE DB Unload
(unloading the database)
UCYBDBRT.EXE AE.DB Reporting Tool
(defining object queries)
UCYBREPG.EXE (requires 32bit Java), AE DB Reporting Tool
UCYBREPG.JAR (graphical interface for
creating the query files)
UCYBLGMX.EXE AE.LogMix (combines
log and trace files)
UC.MSL Message library
UC4LAF.JAR Archive for layout files
*.INI Initialization files for the
utilities
532 Chapter 8 Installation

CALLHTMLHELP.DLL, Libraries of the utilities

CBLRTSS.DLL,

UCCACHE.DLL,

UCDBUP.DLL,
UCSBEPM.DLL, UCUCLI.DLL, UCUDB32.DLL, UCUOCI.DLL,
UCUODBC.DLL, UCYBCLICPY.DLL, UCYDBARCHIVE.DLL,
UCYDBREORG.DLL, UCYBDBLD.DLL,
UCYBDBUN.DLL, UCZU01.DLL, ZU00132.DLL, ZUXML1.DLL
COMDLG32.OCX, MSCOMCTL.OCX, RICHTX32.OCX ActiveX Controls
SETUP.EXE Installation program

Procedure

1. Installing the Java Runtime Environment (JRE)

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.

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 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:
 Automation Engine 533

lAE 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 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 thenotes 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
534 Chapter 8 Installation

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 "???."
 Automation Engine 535

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 is found in its
respective UNIX platform subdirectory in IMAGE:AUTOMATIONENGINE\UNIX\.
UCS???.tar.gz ... Files of the Automation Engine

File name Description

ucsrvcp Communication
process of the
Automation Engine for
UNIX
ucsrvwp Work process of the
Automation Engine for
UNIX
uc.msl Message library
ucsrv.ori.ini Example of an INI file
for the Automation
Engine
libsysapi, libuccache, libucudb32, libzu00132, libzusynchk, libuc001, Runtime libraries
libucdsfun, libucmsgq, libucmsgxml, libucrtl, libucsbepm, libzuxml, libucsj,
File ending with "a"
ucsj_1, ucsj_2, ucsj_3, libgcc_s, libstdc++, libucldap, libssp
indicates AIX
for Oracle database: ucuoci File ending with "sl"
for DB2 database: ucucli indicates HP-UX
File ending with "so"
indicates Solaris,
Linux and zLinux
syntax.bin Description of script
language

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).
536 Chapter 8 Installation

l Unpack the transferred tar file in the current directory.

gzip -d ucs???.tar.gz
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.

Installing the Automation Engine for Windows

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 are found in the IMAGE:AUTOMATIONENGINE\WINDOWS directory.

File name Description

UCSRVCP.EXE Communication
process of the
Automation Engine
for Windows
UCSRVWP.EXE Work process of the
Automation Engine
for Windows
UC.MSL Message library
UCSRV.INI Configuration file of
the Automation
Engine for Windows
UC_MSGQ.DLL, UCCACHE.DLL, UCDSFUN.DLL, UCMSGXML.DLL, AE runtime system
UCSBEPM.DLL, UCSJ.DLL, UCUDB32.DLL, UCUODBC.DLL, for Windows
ZU00132.DLL, ZUSYNCHK.DLL, ZUXML1.DLL, UCSEVMSG.DLL,
UCLDAP.DLL

Oracle database: UCUOCI.DLL

DB2 database: UCUCLI.DLL
SETUP.EXE Installation program
 Automation Engine 537

Procedure

1. Installing the Automation Engine

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

l Valid user ID for installation (AE)

Supplied Files

The UserInterface files are found in the directory IMAGE:USERINTERFACE\UNIX. The individual files
are combined in the ucdj.tar.gz file.

File name Description

UCDJ.SH Start script
for calling the
UserInterface
UCDJ.INI Call options
for the start
program
UCDJ.BAT Batch file for
calling the
UserInterface
538 Chapter 8 Installation

UCDJ.JAR UserInterface
in Java
UC4CONFIG.XML Configuration
file for
connecting to
the AE
systems
LOGIN_DAT.XML Configuration
file for user
login to the
AE system
UC.MSL Message
library
CALLHTMLHELP.DLL, CALLHTMLHELPIA64.DLL, CALLHTMLHELPX64.DLL, Files for
UC4DOCREF.PROPERTIES, UC4MSGREF.PROPERTIES calling help
with the F1
key
CONFIGREF.CLASS Configuration
class
SYNTHETICA.JAR, SYNTHETICAADDONS.JAR, UC4LOOKANDFEEL.JAR, Interface
ATTACHLAYOUT.JAR, SWINGX.JAR, SWING-WORKER-1.2.JAR layout
UC4.WAV WAV file that
is processed
when the
UserInterface
(Display
Splash
Screen) is
started
UCXJPS84.JAR File with
specific Java
classes for
the
PeopleSoft
forms
AE-RA.JAR RA
Framework
INTELLISENSE.JAR File for the
Script
Editor's auto-
completion
function

Procedure

1. Installing the current Java Runtime Environment (JRE) version

 Automation Engine 539

Skip this installation step if the required version of JRE is already installed.

l Admin computer and/or User computer

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 Download the required Java Runtime Environment from http://java.sun.com and install it.

2. Installing the UserInterface

l Admin computer and/or User computer

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

(Linux: tar -zxvf ucs???.tar.gz)

3. Adapting the configuration files

l Admin computer and/or User computer

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.

4. Starting the UserInterface

l Admin computer and/or User computer

l Use the following command in order to execute the start script:

chmod +x ucdj.sh

Installing the UserInterface (Windows)

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.
540 Chapter 8 Installation

Supplied Files

The UserInterface files are found in the IMAGE:USERINTERFACE\WINDOWS directory.

File name Description

UCDJ.EXE Start program
for calling the
UserInterface
UCDJ.INI Call options
for the start
program
UCDJ.BAT Batch file for
calling the
UserInterface
UCDJ.JAR UserInterface
in Java
UC4CONFIG.XML Configuration
file for
connecting to
the AE
systems
LOGIN_DAT.XML Configuration
file for user
login to the
AE system
UC.MSL Message
library
CALLHTMLHELP.DLL, CALLHTMLHELPIA64.DLL, CALLHTMLHELPX64.DLL, Files for
UC4DOCREF.PROPERTIES, UC4MSGREF.PROPERTIES calling help
with the F1
key
CONFIGREF.CLASS Configuration
class
SYNTHETICA.JAR, SYNTHETICAADDONS.JAR, UC4LOOKANDFEEL.JAR, Interface
ATTACHLAYOUT.JAR, SWINGX.JAR, SWING-WORKER-1.2.JAR layout
UC4.WAV WAV file that
is processed
when the
UserInterface
(Display
Splash
Screen) is
started
SETUP.EXE Installation
program
 Automation Engine 541

UCXJPS84.JAR File with

specific Java
classes for
the
PeopleSoft
forms
AE-RA.JAR RA
Framework
INTELLISENSE.JAR File for the
Script
Editor's auto-
completion
function

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 Admin computer and/or User computer

l Use the following command to check which version of the Java Virtual Machine (VM) is installed.

java -version

If several JRE or Java SDK Versions are installed on the computer, make sure that the order of the
directories in the settings of %PATH% or $PATH is correct. The Java Runtime Environment that is
found first in the list of directories is used.

l Download the required Java Runtime Environment from http://java.sun.com and install it. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can disable it in the system control; AE does not need it.

2. Installing the UserInterface

l Admin computer and/or User computer

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.

3. Adapting the configuration files

l Admin computer and/or User computer

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.
542 Chapter 8 Installation

4.. Starting the UserInterface

l Admin computer and/or user computer

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.

2. Adapting the configuration files

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
TARBS2 TAR or BS2 TOOLS (version 2.00W and later).
 Automation Engine 543

Supplied Installation Files

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.

File name Description

x.xxx.UCX2?.LIB Program Library
Library Elements
UCXBB2?C CallAPI Utility
UCXEB2?U Utility for the console event (UCON
connection)
UCXJB2? Agent
UCXJB2?M Message program for BS2000 agent
UCYBRFC? Utility for RFC taskUtility for RFC task
x.xxx.UCXJB2?.INI INI file for BS2000 agent
x.xxx.UCXEB2?U.INI INI file for the utility
x.xxx.UCYEBXXZ Utility for recalling commands through a
console (only for console events)
x.xxx.E.UCXJB2? Sample - Enter file for BS2000 agent
x.xxx.E.UCXEB2?U Sample - Enter file for the utility
x.xxx.UCX.MSL Message Library

 The CallAPICallAPI files and CallAPI implementation are described in a separate document.

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:
544 Chapter 8 Installation

/FILE UCXJB2?.TAR,LINK=TAR or /FILE UCXJB2?NK4.TAR,LINK=TAR

/EXEC BS2-TAR

2. Unpack with BS2 TOOLS:

Show $UC4. Enter the command TAR into the command field next to the TAR file.

l 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? UCYBRFC? file must be shareable when the RFC mechanism is activated.

l Admin computer or User computer

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.

This installation guide can be used for Windows and for Unix.

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

Automic strongly recommends installing the agent in a separate directory.

Supplied Files

The files that belong to the Database Agent are stored in the directory IMAGE:AGENTS\SQL.
 Automation Engine 545

File name Description

UCXJSQLX.JAR Database Agent
UCXJSQLX.INI Initialization file for the Database Agent
UC.MSL Message library
SETUP.EXE Installation program (Windows)

Additionally, two empty folders (Temp and JDBC) are supplied. The Temp folder stores log files, and the
JDBC driver must be installed in the JDBC folder.

Procedure

1. Installing the Java Runtime Environment (JRE)

If JRE is already available in the required version, this step of the installation process can be ignored.

l Admin computer and/or User computer

l The version of the current Java Virtual Machine (VM) of the system can be checked using 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
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. The
installation process includes the automatic installation of the Java Plug-in for Web browsers. You
can deactivate it in the system control. AE does not need it.

2. Installing the Agent

l Host
l Create a separate directory for the agent (for example, C:\AUTOMIC\AGENTS\SQL\BIN or
UC4/AGENTS/SQL/BIN).
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
IMAGE:AGENTS\SQL\WINDOWS.

3. Installing the JDBC driver

l Host
l A suitable JDBC driver must be installed for all databases the agent should 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 driver.
546 Chapter 8 Installation

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 Install the driver.
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 Install the driver.
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 shown below 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 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 JCDBC
directory.
l Note that the agent requires Informix databases with transaction support.
l Because of an Informix error, you must specify the value for the environment variable DB_
LOCALE in particular versions. The error "Database locale information mismatch" occurs if DB_
LOCALE has not been correctly set.
In this case, set the corresponding value in the Agent's INI file, section [INFORMIX], using the
parameter db_locale= (use lower case).
Example: [INFORMIX] db_locale=EN_US.CP1252

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

 Automation Engine 547

l Oracle RAC
l The agent can also be configured so that it can connect to an Oracle database in RACOracle
database in RAC.

5. Setting up the system environment

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.

l Admin computer or Server computer

l Adjust HEADER.WINDOWS, TRAILER.WINDOWS and RESTART.WINDOWS if necessary.
See: Job - Execution.

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

6. Starting the Agent

l Server computer
l The AE system must be running.
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

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
548 Chapter 8 Installation

(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 Admin computer or Server computer

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 rightsrights via the
Agent object.

Use the ServiceManager to start or end the agent as a service.

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.

File name File Description

type
UCXJGC8 binary GCOS8 agent
UCXJGC8M binary Message program for the
GCOS8 agent
UCMSL ascii Message library
UCXJGC8I ascii Initialization file
UC4EX, UC4TM, ascii JCL for starting and ending
CANCEL.SPN, UC4, UC4EXEC.DIR, UC4EXEC.SPN, the agent
UC4TERM.DIR, UC4TERM.SPN

Procedure

1. Creating the required catalogs

 Automation Engine 549

l Host
l Create a catalog for the installation (UC4/version).
l The following subcatalogs are required: 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

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 Admin computer or User Computer

l Adjust HEADER.GCOS8 and TRAILER.GCOS8 as needed.
See: Job - Execution.

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.
550 Chapter 8 Installation

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.

5. Starting the Agent

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 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
Overview. Because a newly logged-on agent has not yet been assigned a client, it can only
be viewed in the system client 0000. The newly installed agent can now be assigned to
clients through the Agent object with all the required rights.

6. Shutting down the Agent

l Host
l Use the JCL from the file UC4TM to close the agent.

$      ident <site-ident>
$      select &system/profile.prod/uc4
$      select &uc4cat/jcl/uc4term.spn
$      endjob
 Automation Engine 551

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.

Automic strongly recommends installing the agent in a separate directory (such as UC4/Agent/jmx or
C:\AUTOMIC\Agent\jmx).

Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.jar Agent for J2EE/JMX
ucxjjmx.ini Configuration file
ucxbo.jar.ucc MBean "CrystalReports"
uc.msl Message library
setup.exe Installation program

Procedure
1. Installing Java Standard Edition

This installation step can be omitted if the required version of Java Standard Edition is already
available.

l Admin computer and/or user computer

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 you specify %PATH% or $PATH if
several versions of JRE or Java SDK are installed on your computer. The Java Runtime
Environment that is listed first is used.

l Download the required Java Runtime Environment from http://java.sun.com and install it.

2. Setting up the Agent

552 Chapter 8 Installation

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.

4. Starting the Agent

l Use the following command to start the agent via the command line (UNIX and Windows):

java -jar -Xrs -Xmx256M ucxjjmx.jar

The agent can also be started using the ServiceManager.

Note that the storage limit should be set to at least 256MB (or 512MB) for starting Java agents
(Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java applications by
using the start parameter -XmX.
Specifying a value that is too low can cause the agent to crash. The default value depends on the Java
version that is used.

The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation.

5. 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..."
 Automation Engine 553

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.

Automic strongly recommends installing the agent in a separate directory (such as UC4/Agent/jmx or
C:\AUTOMIC\Agent\jmx).

Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.jar Agent for J2EE/JMX
ucxjjmx.ini Configuration file

Procedure
1. Installing Java Runtime Environment (JRE)

This installation step can be omitted if the required version of JRE is already available.

l Admin computer and/or user computer

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:
554 Chapter 8 Installation

java -jar ucxjjmx.jar

You can also start the agent using the ServiceManager.

3. Important notes for creating jobs

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

The following document includes information about installing and configuring J2EE/JMX agents with an
IBM WebSphere Application Server.

Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.war Agent for J2EE/JMX

Procedure
1. Setting up the JMX Agent

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.
 Automation Engine 555

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."
556 Chapter 8 Installation

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 Web interface.

2. Using the configuration Web interface

l Host
l The JMX agent has a configuration Web interface which can be called with a Web browser using
the following address:

http://Server name:port/context root

l Adjust the settings of the JMX agent to your system environment. The most important ones are:
l Name for the Agent
l Name of the computer on which a communication process is available
l Port number of a communication process

l Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.

3. Important notes for creating jobs

 Automation Engine 557

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: Log on to the administrator console. Click Servers -> Applications
servers and then click on the name of your Server. Select "Communications" -> "Ports." The table
contains the entry BOOTSTRAP_ADDRESS. Use the port number shown here in the URL.

Setting Up the Agent for J2EE/JMX (IBM WebSphere) with SOAP Connector

The following document includes information about installing and configuring J2EE/JMX agents with an
IBM WebSphere Application Server.

This installation guide applies to WebSphere version 6.0 with activated administrative security.

1. Setting up the JMX Agent

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.
558 Chapter 8 Installation

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.
 Automation Engine 559

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 tabJMX
tab of the Job object.

3. Starting the Agent

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 which can be called with a Web browser via the
following address:

http://Server name:Port/context root

560 Chapter 8 Installation

l Adjust the settings of the JMX agents to your system environment. The following are particularly
important:
l Agent name
l Name of the computer on which a communication process is available
l Port number of a communication process

l 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 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
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.war Agent for J2EE/JMX

Procedure
1. Setting up the JMX Agent
 Automation Engine 561

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/

2. Using the Web configuration interface

l Host
l The JMX agent has a configuration Web interface which can be called with a Web browser using
the following address:

http://Server name:Port/ucxjjmx/uc4jmx

This example uses the term ucxjjmx in the address because it is also used in step one as part of the
folder name (".war"). If you opted for a different name, use this name instead.

l Adjust the settings of the JMX agent to your system environment. The most important ones are:
l Name for the Agent
l Name of the computer on which a communication process is available
l Port number of a communication process

l Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.

3. 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-menu "Use existing MB Server."
l It is not necessary to select the option "Generate new instance..."
562 Chapter 8 Installation

Setting Up the Agent for J2EE/JMX (Oracle Containers for J2EE)

The following document includes information about installing and configuring J2EE/JMX agents with an
Oracle Containers for J2EE ApplicationServer.

Supplied Files
The J2EE/JMX agent files are available in the folder IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.war Agent for J2EE/JMX

Procedure
1. Setting up the JMX Agent

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.

2. Using the Web configuration interface

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 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.
 Automation Engine 563

3. Important notes for creating jobs

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

l Specify the Server URL in the following format:

service:jmx:rmi://Host name of the Oracle J2EE Server:Port/oc4j

Setting Up the Agent for J2EE/JMX (SAP NetWeaver)

The following document includes information about installing and configuring J2EE/JMX agents with a
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
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.sca J2EE/JMX agent

Procedure
1. Setting up the JMX Agent

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)."
564 Chapter 8 Installation

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.
 Automation Engine 565

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.
566 Chapter 8 Installation

l Select the software component JMX_Agent (automic.com) from the list and click Add to
Undeploy List in the context menu.

l Now execute the function Undeploy in order to remove the Agent.

3. Using the Web configuration interface

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 Name of the computer on which a communication process is available
l Port number of a communication process

4. Important notes for creating jobs

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)

The following document includes information about installing and configuring J2EE/JMX agents with a
Tomcat Application Server.

Supplied Files
The files that belong to the J2EE/JMX agent are stored in the directory IMAGE:AGENTS\JMX.

File name Description

ucxjjmx.war Agent for J2EE/JMX
 Automation Engine 567

Procedure
1. Setting up the JMX Agent

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.

2. Using the Web configuration interface

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
particularly important:
l Agent name
l Name of the computer on which a communication process is available
l Port number of a communication process

l Note that the configuration file will be overwritten when you deploy the WAR file again. As a
result you will have to redefine your configuration settings. Instead, you can also save a copy of
your configuration file (INI file) before you start the deployment and copy it to the folder that
includes the web application after the deployment has taken place.

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.
568 Chapter 8 Installation

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.

File name File type Description

UC4DDL Text DDL description for usage in EMS filters to filter Automic related events.
UC4MACS Text Tacl macros used by the Automic agent, can be extended by customer if
needed.
UC4TMPL Text EMS template file to be used with EMS if required.
UCMSL Binary Message texts used by the agent.
UCXBNI6C Binary, Example program showing usage of call API.
executable
UCXBNI6O Binary, Call API link library
library
UCXFTSRV Binary, Automic server program used for file transfer, will be automatically stopped
executable and started by the agent when using file transfers.
UCXJNI6 Binary, Automic agent
executable
UCXJNI6M Binary, Automic program used to shutdown the agent.
executable
UCXJNI6O Binary, Output collector used by the agent.
executable
UCXJNI6R Binary, Used for internal purposes only, will simply output command line arguments
executable in certain format.
UCXJNI6T Binary, Virtual terminal program, started to be used as a dummy input/output device
executable
UCXSCAN Binary, Scan program internally used by the agent if file system scans for file
executable patterns are requested.
UCYBWAIT Binary, Used for internal purposes only, will simply create a given delay.
executable

The CallAPI files and their implementation are described in a separate document.

Procedure

1. Transferring the files to the host

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.
 Automation Engine 569

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

Parameter Description
UC4-PROGRAM-SUBVOLUME= Sub-volume for the executable agent files.
UC4-STATUS-STORE-SUBVOLUME= Sub-volume for the StatusStore files of
FileTransfers.

The agent automatically created StatusStore files.

They store the restart information of active
FileTransfers. This mechanism ensures that
aborted FileTransfers 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.
570 Chapter 8 Installation

UC4-STATUS-STORE-AUDITED= Stores StatusStore files of FileTransfers 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
l Set the following command in the TACL input line:
 Automation Engine 571

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 Admin computer or Server computer

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 with the
required rights via the Agent object.

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 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 is found in the subdirectory
IMAGE:AGENTS\AS400.

File name AE CD Description

UCXJO41.BIN OS/400 agent
(binary SavFile)
572 Chapter 8 Installation

Content:
IRSTRJOB Utility program for
generating Jobs
UCXBO41C CallAPI
UCXJO41 Agent
UCXJO41M Messenger
program for the
OS/400 agent
CLLE CL source files for
starting and
ending the agent
INI INI file
MSL Message library
TMP Empty text file
STRUCAGENT Program that
starts the agent
ENDUCAGENT Program that ends
the agent
MAKEMSL Program that
generates the
message library
COMPRESS, GSS, LIBCPPRNT Service programs
(libraries) for the
agent, the CallAPI
and the
MAKEMSL
program

The CallAPICallAPI 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
10.0.0')

l Admin computer
 Automation Engine 573

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)

3. Setting up the system environment

l Host
The AE system must be running.
l Host
Adjust the INI file UC4/INI(UCXJO41).

l Admin computer or User computer

Adjust the HEADER.OS400, TRAILER.OS400 and RESTART.OS400 if necessary. See: Job -
Execution.

There are two different methods that can be used to start the agent. Variant 1 requires a CL routine per
agent that should start (more complex). Variant 2 starts or ends the agent via separate programs. 

Method 1

4. 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 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.
574 Chapter 8 Installation

l The program UCEX_END ends the agent.

l Admin computer or Server computer
l Verify that the agent is logged on.
l Start the UserInterface for client 0000. Information about agents is available in the System
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 rightsrights 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.

 Automation Engine 575

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.

File Name Description

UCXJPSX AE agent for PeopleSoft
UCXJPSX.INI INI file for the PeopleSoft
agent
UCX.msl Message library
psexj.bin Syntax file
UCXJPS82.jar Java Classes
UCXJPS84.jar
libsysapi, libzu00132, libzusynchk, libgcc_s, libstdc++, libucxjpsx3, AE runtime system for the
libucxjpsx4, libucxjpsx5, libucxjpsx6 PeopleSoft agent

File ending with "a" indicates

AIX
File ending with "sl" indicates
HP-UX
File ending with "so"
indicates Solaris

Procedure
Transferring the tar file and setting up the system environment

l Host
l Transfer the TAR file UCXJPSX.tar.gz using FTP.
576 Chapter 8 Installation

l Navigate to the directory for PeopleSoft:

cd peoplesoft
l Unpack the tar file:
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 are found in the directory IMAGE:AGENTS\PEOPLESOFT\WINDOWS.

File name Description

UCXJPSX.EXE AE agent for PeopleSoft
UCXJPSX0.DLL Runtime library PeopleTools Version 7.x
UCXJPSX1.DLL Runtime library for PeopleTools Version 8.2x (Standard Interface)
UCXJPSX2.DLL Runtime library for PeopleTools Version 8.2x (AE Interface)
UCXJPSX3.DLL Runtime library for PeopleTools Version 8.2x (AE Interface, Java API)
 Automation Engine 577

UCXJPSX4.DLL Runtime library for PeopleTools Version 8.2x (Standard Interface, Java API)
UCXJPSX5.DLL Runtime library for PeopleTools Version 8.4x (Standard Interface, Java API)
UCXJPSX6.DLL Runtime library for PeopleTools Version 8.4x (AE Interface, Java API)
UCXJPSX.INI INI file for the PeopleSoft agent
UC.MSL Message library
UCUDB32.DLL Runtime library for the database connection
UCUODBC.DLL Runtime library for the ODBC database connection 
UCUOCI.DLL Runtime library for the OCI database connection
UCUCLI.DLL Runtime library for the CLI database connection
ZUSYNCHK.DLL Runtime library for syntax checks
ZU00132.DLL Runtime libraries for shared functions
UCXJPS82.jar Java classes
UCXJPS84.jar
SETUP.EXE Installation program

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 Admin computer or user computer

l Adjust HEADER.PS, TRAILER.PS and RESTART.PS as needed. See: Job - Execution.

Setting Up the Agent for Rapid Automation 

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.

Automic strongly recommends installing the agent in a separate directory (such as

UC4/Agent/rapidautomation or C:\AUTOMIC\Agent\rapidautomation).
578 Chapter 8 Installation

Supplied Files

The files that belong to the RA agent are stored in the directory IMAGE:AGENTS\RAPIDAUTOMATION.

File name Description

ucxjcitx.jar Agent for Rapid Automation
ucxjcitx.ini Configuration file
*.jar Libraries
uc.msl Message library
setup.exe Installation program

Procedure

1. Installing Java Standard Edition

This installation step can be omitted if the required version of Java Standard Edition is already
available.

l Admin computer and/or user computer

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.

l Download the required Java Runtime Environment from http://java.sun.com and install it.

2. Setting up the Agent

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
the agent and computer name, and the port of the communication process to which the agent
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
 Automation Engine 579

(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 Log on to system client 0000.
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.

5. Starting the 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.).
l Use the following command to start the agent via the command line (UNIX and Windows):

java -jar -Xrs -Xmx256M ucxjcitx.jar

 The agent can also be started via the ServiceManager.

Note that the storage limit should be set to at least 256MB (or 512MB) for starting Java agents
(Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java applications
by using the start parameter -XmX.
Specifying a value that is too low can cause the agent to crash. The default value depends on the
Java version that is used.

The Java parameter -Xrs ensures that the agent ends properly when a normal end is initiated.
Automic recommends using this parameter. More detailed information is provided in the Java
documentation.

6. Important notes for creating jobs

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.
580 Chapter 8 Installation

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

File name Description

UCXJR3X.JAR The SAP agent.
UCXJR3X.INI The SAP agent's INI file.
UC.MSL The message library.
SAPRFC.INI The INI file for SAP's Remote Function Call.
UMSVCP60.DLL The runtime library (Windows).
SETUP.EXE The installation program (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.
 Automation Engine 581

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.
l If recommended in the current Release Notes, adjust the INI file. Refer to the INI file
UCXJR3X.INI, which is supplied with the update installation.

l Admin computer or user computer

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.

4. Starting the Agent

l Use the following command to start the agent via the command line (UNIX and Windows):

java -jar ucxjr3x.jar

 You can also use the ServiceManager to start the agent.

Note that the storage limit should be set to at least 256MB (or 512MB) when you start Java
agents (Databases, RA, JMX, SAP). You can specify a value for the storage limitation of Java
applications via the start parameter -XmX.
Example for a start with 256MB: java -Xmx256M -jar ucxjr3x.jar.
Specifying a value that is too low can cause the agent to crash. The default value depends on the
Java version that you use.

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.

Supplied Installation Files

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
582 Chapter 8 Installation

The other files in this subdirectory belong to the installation program and the AE runtime system.
See: Knowledge Base.

Procedure

1. Installing the Agent

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 Admin computer or User computer

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 "???."

Close the agent before you start the update installation.

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.

Supplied Installation Files

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.

File name Description

 Automation Engine 583

ucxj??? UNIX agent

ucxj???m Message Program for UNIX agent
ucxjxxx.ini Sample of the INI file for the UNIX agent
ucx.msl Message library
ucxe???f Help program for extended querying of the file system

The CallAPI files and CallAPI implementation are described in a separate document. 

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

(Linux: tar -zxvf ucs???.tar.gz)

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 Admin computer or User computer

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.

Close the agent before you start the update installation.

Requirements

l The user AE has been given the privileges CMKRNL, BYPASS, SYSNAM, SYSPRV and
WORLD.
584 Chapter 8 Installation

l The batch queue SYS$BATCH must be initialized and started. As an alternative, you can use a
specially customized and prioritized batch queue for AE Jobs. This must be defined in the INI file of
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.

Supplied Installation Files

The files that match each VMS version are found in the respective subdirectory of IMAGE:AGENTS\VMS
.

File name Description Destination File

directory type
UCXJV??.EXE VMS agent BIN Binary
UCXJV??M.EXE Messenger program BIN Binary
UCXE???F.EXE For file event BIN Binary
UCXJV??.INI INI file BIN Text
UCX.MSL Message library BIN Text
UC$CRDIR.COM Command file that creates directories and CMD Text
determines authorizations
UC$START.COM Command file for starting the agent CMD Text
UC_START.COM Help command file for starting the agents CMD Text
UC$STOP.COM Command file for deactivating the agent CMD Text
UC4$STARTUP.COM Command file (1) for automatically starting the SYS$STARTUP Text
agent
UC4$STARTUP_ Command file (2) for automatically starting the SYS$STARTUP Text
BAT.COM agent

The CallAPI files and CallAPI implementation are described in a separate document.

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".
 Automation Engine 585

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.

4. Setting up the system environment

l Host
l Change from the login directory to the BIN directory:

$SET DEF [.BIN]

l If recommended in the current Release Notes, adjust the INI file. Refer to the INI file
UCXJV??.INI, which is supplied with the update installation.
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 Admin computer or User computer

l Adjust HEADER.VMS, TRAILER.VMS and RESTART.VMS if needed. See:Job - Execution.
586 Chapter 8 Installation

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 "???."

Close the agent before you start the update installation.

Supplied Installation Files

The files are found in the directory IMAGE:AGENTS\WINDOWS.

File name Description

UCXJ???.EXE Windows agent
UCXJ???M.EXE Message program for Windows agent
UCXJ???.INI INI file for Windows agent
UC.MSL Message library
UCSMTP.DLL Library for the email connection via SMTP
ZU00132.DLL Runtime library for shared functions
SETUP.EXE Installation program (only for Intel IA-32)

The other files in this subdirectory belong to the installation program and the AE runtime system.
See: Knowledge Base.

The CallAPI files and CallAPI implementation are described in a separate document.

Potential Problems

l 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

1. Installing the Agent

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).
 Automation Engine 587

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.

2. Setting up the system environment

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 Admin computer or User computer

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.

File name AE CD Description File name z/OS

UCXJM25-IBM.BIN z/OS agent UC4.UCXJM25.LOAD

Created with a TSO TRANSFER utility.

UCXJM25.INI INI file. UC4.UCXJM25.INI
UCX.MSL Message Library. UC4.UC.MSL
STC25.TXT JCL for the started task.
UC4JCLE.ASM Sample module for the JCL Exit.

The CallAPI files and their implementation are described in a separate document. 

Load Module:

l CADSDEL - A utility that can be used to release a Common Dataspace (CADS) allocated by the
Event Monitor.
588 Chapter 8 Installation

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 the files to the host

l Host
l Transfer the appropriate files from IMAGE:AGENTS\MVS\ by FileTransfer.

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
//SYSPRINT DD SYSOUT=*
//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')
 Automation Engine 589

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
//SYSPRINT DD SYSOUT=*
//STDOUT DD SYSOUT=*
//SYSCPRT DD SYSOUT=*
//JOBOUT DD SYSOUT=(A,INTRDR)
//SYSUDUMP DD SYSOUT=*
//*

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.*)
590 Chapter 8 Installation

l The started task requires the appropriate authorization to read JES lists

l Generate the datasets for the StatusStore

Example:

//CREATESS EXEC PGM=IDCAMS

//SYSPRINT DD SYSOUT=*
//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
//SYSPRINT DD SYSOUT=*
//OUT1 DD DISP=SHR,DSN=UC4.UCXJM25.SSTORE
//SYSIN DD * REPRO INFILE(IN1) OFILE(OUT1)
//IN1 DD *
DUMMY
/*

4. Setting up the system environment

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 Admin computer or User computer

l Adjust HEADER.MVS, TRAILER.MVS and RESTART.MVS where necessary. See: Job -
Execution.
 Automation Engine 591

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 are found in subdirectories of
IMAGE:SERVICEMANAGER\UNIX. The names of the subdirectories indicate the supported platforms.

File name Description

libgcc_s.so GNU C Library
libstdc++.so GNU C++ Library
libsysapi.so, libzu00132.so, libssp Runtime libraries
uc4.smd Definition file for AE services to be started
uc.msl Message library
ucybsmcl Command line program for the ServiceManager
ucybsmgr ServiceManager
ucybsmgr.ori.ini Initialization file for the ServiceManager

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 Log on using the user ID AE.
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.
592 Chapter 8 Installation

Installing the ServiceManager (Windows)

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.

File name Description

UCYBSMGR.EXE ServiceManager
UCYBSMGR.INI Initialization file for the ServiceManager
UC4.SMD Definition file for AE services to be started
ZU00132.DLL Runtime library for Common Functions
SETUP.EXE Installation program

The directory IMAGE:SERVICEMANAGERDIALOG\WINDOWS contains the files for the

ServiceManager's dialog and command line programs.

File name Description

UCYBSMDI.EXE Dialog program for the ServiceManager
UCYBSMDI.INI Initialization file for the dialog program
UCYBSMCL.EXE Command line program for the ServiceManager
SETUP.EXE Installation program

Additional files in these subdirectories are components of the installation program and the AE runtime
system. See:Knowledge Base.

Procedure

On the corresponding Server computer or host computer.

1. Installing the ServiceManager

l Start the program SETUP.EXE in the directory IMAGE:SERVICEMANAGER\WINDOWS.

l If recommended in the current Release Notes, adjust the INI file. Refer to the INI file
UCYBSMGR.ORI.INI which is supplied with the update installation.

2. Installing the ServiceManager's dialog and command-line programs

 Automation Engine 593

l Start the program SETUP.EXE in the directory

IMAGE:SERVICEMANAGERDIALOG\WINDOWS.
l If recommended in the current Release Notes, adjust the INI file. Refer to the INI file
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:

ServiceManager - Service
ServiceManager - Dialog Program
ServiceManager - Command Line Program

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\
594 Chapter 8 Installation

8.4 Update Installation

8.4.1 Updating an AE System - Basics

Guidelines for updating to a new Automation Engine version.

To ensure that your updating process is successful Automic recommends that you strictly follow the
steps that are described in this guide.

Never update 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
It is very important that you follow a structured procedure when you update an AE system because it
guarantees that processing can be continued as soon as possible. The following guidelines explain the
required steps in detail and especially address areas that need special attention.Follow the recommended
steps for a smooth conversion process and you will soon be able to use all the new functions of your new
Automation Engine version.

When changing the version of the Automation Engine, the utility AE DB Load processes and monitors all
the required steps for changing the database. This is necessary because it also modifies data that cannot
be changed with SQL. All steps that the utility processes during the updating process are logged in the file
uc_upd.txt. The file chngdb.sql also informs about the database-relevant statements that were set. These
statements must be processed by the utility. Refer to the Release Notes of the relevant Automation
Engine version for changing the database and preparing the necessary steps.

The updating process comprises of several stages:

1. Installation and comprehensive testing in a test environment

2. Planning the conversion time and creating a plan for a possible re-conversion.

Never change to a new Automation Engine version without having planned a re-conversion
scenario.
3. Make a backup of the AE database and all the components' directories.
4. Update your system step by step WITHOUT using the new functions.
5. Only use the new functions when every component has been converted to the new version and after
a particular system-monitoring period.

Each stage consists of many small steps. Your AE system is not updated at once but step by step. The
old components are not overwritten and the new files are installed in separate directories. Only the AE
database is directly updated with the utility AE DB Load. This method has two main advantages:

1. You can quickly re-convert to the old AE-component version if problems occur in your system
environment. Therefore, there is almost no risk for your processing.
2. Depending on the size of your AE system, the complete updating process can take some time. The
advantage of updating step by step is that you can do so in individual and shorter periods of time
which makes it easier to coordinate the updating process with other departments and processes.
And it is also easier to locate errors that might occur.
 Automation Engine 595

First update your test system. Possible problems can so be recognized and solved before they occur in
your productive system. Test the individual updating steps, thereby setting up a plan for updating your
productive system.

The AE system is not available while the database is upgraded.

After each step of the update installation, it is essential to monitor the new components for some time.
Only continue the updating procedure when they have proven to run stably.

Note that the updating process Automic recommends enables production to be continued in the old
Automation Engine version at any time. The only requirements are a parallel installation of the
components and the provision of a second database instance.

Use the message-comparing program if you require a list of all changed messages.

Our consultants are experts in updating AE systems. Contact Automic, our experts will be pleased to
assist you whenever it is necessary.

Requirements
Check Condition
Carefully read the Release Notes of the relevant Automation Engine version. They include
information that must be taken into account during the updating process.
The most important requirement is a test system. Comprehensive tests in a separate system
are necessary before the new Automation Engine version is used in your productive system.
The test system helps you to get used to the necessary steps for updating your productive
system and even to optimize them.
Has your database been maintained on a regular basis? Automic recommends starting a
reorganization run with AE utilities and database means before you update the database. The
smaller the database, the quicker the updating process. Note that it will still take some time to
update the AE database and that you will need sufficient disk space for having tables
duplicated.
Authorizations for the affected computers, databases, ERP systems etc. are required during
the various update phases. Ensure that the responsible administrators are available during the
particular work steps.
You can request assistance from consultants, developers or even 24x7 support when you
update your system. Our experts are trained in providing excellent support when action is taken
in critical and sensitive areas of your AE system. Contact your Account Manager or the
Technical Support Team as soon as you know when you are going to start the updating
process.
Ensure that you have the phone number and e-mail address of Technical Support and your login
data for the Download Center.

Procedure
Check Work steps
Preparations
Reading Release Notes

Last modifications in processing

Preparing the updating process of core components

596 Chapter 8 Installation

Updating UserInterfaces

Maintaining the AE database

Duplicating the AE database

Updating the core components

Installing utilities

Installing the Automation Engine and ServiceManager

Installing Framework Integration (optional)

Updating UserInterfaces (if they have not yet been updated)

Installing the WebInterface (optional)

Stopping all clients

Stopping the Automation Engine

Saving the AE database

Updating the AE database

Starting the Automation Engine and clients

Monitoring the AE system

Updating all other components

Installing the Agent

Installing the remaining components

Using the new functions

See also:

Updating an AE System - Details

8.4.2 Notes for Updating the AE Database

This document includes important information concerning database modifications for different Automation
Engine versions.

Automic strongly recommends reading this information carefully before you start the update installation
to a new Automation Engine version.

Important instructions

Automic recommends that a database administrator should execute the following steps.
 Automation Engine 597

 Direct modifications that are made in database contents without using AE programs result in an
inconsistent database.

Always make a database backup before you process any work steps.

This process can take a while depending on the database size and upgrading complexity.

Ensure there is sufficient disk space for the \AUTOMIC\DB directory and that the database's LOG
section can store all this data.

 Schemes that provide access to the database should be removed after the updating process in order
to avoid unintended database modifications.

DB2: After updating the AE database, check the size of the tablespaces and if required, run the
following SQL statement:
alter tablespace <UC4 tablespace name> reduce max;
8.00A
Note for updating from UC4 version 6.00A to version 8.00A

In order to start the utility AE DB Load, users of an ORACLE database require additional rights.
Notes for updating a DB2/ OS390 database from version 6.00A to 8.00A:

If the table AH is stored in a 4K tablespace, it will be copied to a larger tablespace of 8K during the
upgrade process. Automic recommends providing the corresponding memory before starting to update.
No copying process takes place if this table is already available in a bigger tablespace. In this case, use
the line "process_sql_file2 chngdb_ah.sql" instead of "process_sql_file2 copy_ah.sql" in the file "UC_
UPD_FOR_DB2.OS390.txt".

By default, the table will be copied.

Excerpt from the file "UC_UPD_FOR_DB2.OS390.txt":

message -----------------------------------------------------------------
message Apply chngdb_ah.sql if Table AH is already in an 8K Tablespace!!!
message process_sql_file2 chngdb_ah.sql
message -----------------------------------------------------------------
message -----------------------------------------------------------------
message Remove copy_ah.sql if Table AH is already in an 8K Tablespace!!!!
process_sql_file2 copy_ah.sql
message -----------------------------------------------------------------
598 Chapter 8 Installation

Important note for updating the AE database to version 8.00A

As part of the upgrading process to the new data model of version 8.00A, the table structures in the
report area (RH and RT) are adjusted. This modification applies to all supported databases.
The available tablespace must be of at least the same size as the database (for example: database size
40 GB, required available space: 40 GB). The RedoLog area must also be dimensioned appropriately.

Note that the conversion process takes some time depending on the complexity of the data involved.
The time required for updating the database can be reduced by reorganizing data (especially the reports)
beforehand.

Automic recommends testing the conversion process of your production database in a test environment
in order to obtain experience values for runtimes and the required space.

You have several options:

l Update the database without storing the reports. Data is deleted and no additional space is
required.
l Convert the reports during the updating process.
Note that this process can take some time depending on the amount of data involved. You
system is offline during this time.
l Convert the reports after the update installation - only possible for MS SQL Server and Oracle.
The utility AE DB Load now checks whether all Server processes share the same AE system name
(e.g. UC4PROD#WP001). If not, the loading process is canceled. Thus, the AE database can only be
updated to the new version if all Server processes share the same AE system name. Log on to system
client 0000 and search for Server objects. Delete all Server objects whose names do not start with the
AE system name.
9.00A
To update a DB2 database to version 9.00A, you need the EXECUTE right for SYSPROC.ADMIN_
CMD.

8.4.3 Requirements - Updating to Version 8.00A

This document lists the individual steps that are required before updating your AE system.

Checking new hardware and software requirements

Requirements - Checklist

Important information:

l AE Server, AE SNMP Subagent and the utilities are now only available for 64-bit platforms.
l The utilities and the UserInterface require at least Java 1.6 and the Java-based agents (JMX,
Database, SAP) require at least Java 1.5.
l The utilities and the AE Server can only be used with particular versions of the Oracle Instant
Client, depending on the platform that is used. The versions are available in the Requirements -
Checklist, section Database - Oracle.

Release Notes
Automic strongly recommends reading the Release Notes of version 8.00A.
 Automation Engine 599

Updating the AE database

Refer to the Notes for Updating the AE database for versions 6.00A and 8.00A.
Verify that all the required rights have been assigned to the database user.
A 64-bit client must be installed (all database types).

ILM installation (optional)

ILM can be installed during the updating process but also during a hotfix installation.

Advanced Security
Read about the extended security mechanisms in chapter Advanced Security before starting the
updating process. When updating the AE database, the utility AE.DB Load displays a mask in which
you must select an authentication method.

Subsequent changing of the authentication method involves considerable effort. Automic

recommends determining the required variant during the updating process.

8.4.4 Requirements - Updating to Version 9.00A

This document describes the individual steps that are required before you can start updating your AE
system.

Your system should at least have version 6.00A in order to ensure a safe updating procedure to version
9.00A.

If your system has a version below 8.00A, please refer to the Updating requirements for version 8.00A.

Checking new Hardware and Software Requirements

The requirements checklist for version 9 is available for download from the AE Knowledge Base.

Release Notes
Automic strongly recommends reading the Release Notes of version 9.00A.
The Automation Engine version numbers are described in a corresponding document.

Updating the AE database

600 Chapter 8 Installation

Refer to the Notes for Updating the AE database to version 9.00A.

Verify that the database user has all the required authorizations.
A 64-bit client must be installed (applies to all database types).

8.4.5 Updating an AE System - Details

This document describes the individual steps that are required to prepare and execute an AE system
update.

Preparations

The following preparatory work is required before you can start the actual updating process:

1. Reading the Release Notes

l Start off by reading the Release Notes of the Automation Engine version to which you intend to
update. They are available in the "Release Notes" chapter of the Automation Engine
documentation.
l  The section "Notes for the Update Installation" is extremely important. It contains information
about incompatibilities and points out additional work steps that can be required during or even
before the installation. Automic recommends preparing your AE system and your system
environment accordingly.

2. Last changes in processing

l  Processing must not be changed during the whole updating procedure. If a problem occurs in
your system environment during a particular step, you can either restore the AE database or directly
use the original one if you made a copy. In doing so, there is almost no risk for your processing.
Note that statistical data, reports, and modifications made to Variable object and Sync object
contents are lost.
l Inform all affected persons about the updating process and make sure that processing is not
changed.

Create a user group that explicitly denies everything and assign all users to this group. If the Revision
Report is activated in your AE system, the assignment to the user group must be made in the User
object because the tab is locked in the UserGroup object in this case.

3. Preparing the point in time for updating the core components

l Determine a point in time for updating the core components. Note that the Automation Engine must
temporarily be stopped which interrupts processing. For this reason Automic recommends
determining a time during which only a few activities take place. The duration of the updating
process depends on the size of your AE system. Your experiences when updating the test system
will help you estimate the required time to update your productive system.
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. Carefully think about requesting temporary 24x7 Support
 Automation Engine 601

if sensitive systems should be updated or if the update is not made during the regular business
hours of our support team.
l Our experts are trained in providing excellent on-site support in updating your AE system. Contact
your Account Manager or the Automic Support Team. Your request is forwarded to the relevant
expert in order to make an appointment.
l During the updating process, you require access to the AE database and to all computers with AE
core components (such as the Automation Engine, utilities etc.). Access to all affected computers
is required if you work in a distributed Server environment. Ensure that the responsible
administrators are available and that the login data (such as passwords) is correct.
l The UserInterfaces can already be updated. If you update them together with the core components,
access to the relevant computers is required.

4. Updating the UserInterfaces

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. For example: A 9.00A UserInterface can also log on to an 8.00A AE system.
The only requirement is that your AE system has the latest hotfix version. Be informed that the
UserInterface is not completely downwards compatible. Some functions are not fully available.
l  Changes made in the UserInterface's interface only become visible when the core components
have been updated to the new version.
l  Older UserInterfaces cannot be used with AE systems of a newer version. They must be
updated at least when the core components are updated.
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 8.00A agent can also be used in a
9.00A AE system). This requires the most current hotfix version to be installed on your AE system.

5. Maintaining 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 update it. The
smaller the database, the faster the updating process to the new Automation Engine version.
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.

6. Duplicating the AE database

l For company-critical processing in the AE system Automic recommends duplicating and backing
up your database. In doing so, you can leave one of the databases unchanged and easily re-access
your old database if any problems occur in your system environment.
l The database can be duplicated in several ways. You can duplicate it in offline mode which is
especially suitable for smaller databases and can be done during the updating process of the core
components. During this time, the AE system is not available anyway. Complex databases,
however, can be updated in online mode before the core components are updated. Inform your
database-administration group because the current log files must be stored in the duplicated
database.
602 Chapter 8 Installation

Updating the Core Components

The core components are updated during this stage. Your AE system is not available while the database is
updated.

1. Installing the 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.

Example for Windows:

Utility in C:\AUTOMIC\UTILITY\BIN

Database files in C:\AUTOMIC\UTILITY\DB

2. Installing the Automation Engine and the 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).

3. Installing the Framework Integration (optional)

l Alternately, you can carry out this step after the core components have been updated. The function
Framework Integration is not available until it has been installed.
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 If you use a Framework Integration such as "AE Smart Plug-In for HP OpenView", Automic
recommends installing it in the new Automation Engine version.

4. Updating the UserInterfaces (if they have not yet been updated)

l  Do not remove or overwrite the installation directories of the UserInterfaces. Back up the
corresponding folder in order to make sure that you can quickly return to your old version.
 Automation Engine 603

l At least one UserInterface must be updated to the new Automation Engine version. Use a separate
directory for each UserInterface. Older UserInterface versions can no longer log on when the core
components have been updated.

5. Stopping all clients

l  Starting with this step, your AE system is no longer available until the database has
successfully been updated.
l Stop all clients when the updating time is ripe. This is easily done in the system control of client
0000.

6. Stopping 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 de-activated.
l  Pay attention to programs such as Watchdogs, cluster monitoring etc. before ending the Server
processes. They might raise an alarm or re-start the Automation Engine.

7. Backing 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
updated.

8. Updating the AE database

l Automic strongly recommends reading the notes concerning database modifications for the
relevant Automation Engine version before starting the updating process.
l Update your AE database using the utility AE DB Load.The relevant guide is provided in the
chapterHotfix Installation.
l If you have created a duplicate, Automic recommends updating it now in order to make sure that the
original instance remains operable. Keep in mind to enter the correct database connection in the INI
files of the utilities.
l The statistics and reports (database table RT/FH) are specifically converted during the updating
process to version 8.00. It can take several hours because of the huge amount of data that is
involved. If you do not want to shut down your system for such a long time, you can skip this
process and execute it later on. The following document includes a detailed description: Converting
Reports after Updating to 8.00A.

9. Starting 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.

10. Monitoring the AE system

604 Chapter 8 Installation

l Do not yet replace the agents. Older agent versions run smoothly with newer Automation Engine
versions.
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.

Updating All Other Components

After updating the core components, you can update the remaining AE programs one after the other.

1. Installing 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 update
the agent (Variable UC_EX_JOB_MD).
2) Important: When you install the new agent in the same directory as the old one, you must delete
the old job messenger after the installation process.
3) Instead of adjusting the INI file during the updating process, you can also create a link (with the
old messenger names in uppercase letters) that points to the new messenger
Example for Linux: ln -s ucxjli3m UCXJLI3M

2. Installing 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.

3. Using the new functions

l  Monitor your updated AE system for a time. The updating process is complete if no problems
occur.
l Now you can update your productive system. Repeat the steps made when updating your test
system. Updating a test system optimally prepared you for updating your productive system.
l Again read the Release Notes of the new Automation Engine version after having updated your
productive system. They list all new functions. Use them and extend your processing. Automic
Support will be pleased to help you with any problem that may occur.
l Enjoy using your new Automation Engine version.

See also:
 Automation Engine 605

Updating an AE System - Basics

8.4.6 Converting Reports After Updating to 8.00A

Reports of tasks, agents, server processes etc. consume a lot of AE database space. This data is
specifically converted when the database is upgraded from Automation Engine version 6.00A to 8.00A.
This conversion process can take several hours depending on the amount of data involved. You can also
reduce your system's downtime by subsequently copying the reports. For this purpose, it is not even
necessary to shut down your system.

Only the reports of MS SQL Server and Oracle databases can be subsequently copied. Note that ILM
must not be activated and the computers on which the database scripts and the database run must not
be shut down.

Reports can only be subsequently updated if the database has been updated to version 8.00A. If you
update from version 6.00A to 9.00A, you must convert the report data during the updating process.

Important note: Do not reorganize the AE database during the whole procedure.

Follow the instructions that are provided in the update installation guide Updating an AE System until you
reach the step "Updating the AE database".

The subsequent steps require the manual execution of AE database commands. Automic recommends
that only database administrators execute these commands or at least that they provide assistance in
doing so. A database user is required who has the relevant rights as described in the chapter Setting up the
Database. Select the correct database type and switch to the section "Creating a database user" or
"Defining an AE User." Note that the right to execute stored procedures is required.

You can also update your system without including the reports and delete them instead. In this case,
execute step 1 and delete the tables RH_OLD and RT_OLD afterwards. Note that you cannot restore
these reports.

Procedure
1. Before updating the AE database

l Change to the \db\general\8.00A directory.

l The DB directory is supplied in IMAGE:DB and must be stored in a line parallel to the utilities'
BIN directory.
l Open the file UC_UPD.TXT.
l Change the line "process_sql_file do_report.sql" to "message process_sql_file do_report.sql." As a
result, the reports (except for agents) are not converted during the updating process.
The reports of agents are already converted with the statements that are included in the file
"switch_report.sql". Subsequent changing of this data has the effect that previous reports are no
longer available when the agent starts.
l Start the utility AE DB Load and select the file UC_UPD.TXT (see: Updating an AE System -
Updating the AE Database). The database updating process starts.
l Perform all the remaining steps as described in the Update Installation Guide.

2. Converting the reports after the AE updating process

l Attention: Verify that there is sufficient space and that the RT/RH tables can be stored in the
database before you convert the reports. RH stores the records of reports and RT stores the report
606 Chapter 8 Installation

text.
l Log on to the database with the user that has all the required rights.
l Manually execute the content of the file "do_report.sql" which was previously skipped. It converts
the report data. The conversion process includes two stored procedures that have been created
with the script "switch_report.sql".
l Execute the stored procedure UC_PREPARE_COPY_REP using the following command:
Oracle: EXECUTE UC_PREPARE_COPY_REP;
MS SQL Server: exec UC_PREPARE_COPY_REP

In doing so, the temporary RH_TEMP and RH_TEMP2 tables are created. RH_TEMP is filled with
the contents of the RH_OLD table which includes the original report records. All agent records that
have already been converted using the stored procedures UC_GET_LAST_AGENT_LOG and UC_
WRITE_LAST_AGENT_LOG are deleted from RH_TEMP.

l Call the stored procedure UC_WRITE_OLD_REP. Enter the number of records that should be
copied at once followed by the subsequent waiting time in seconds.
Oracle: EXECUTE UC_WRITE_OLD_REP(10000,1);
MS SQL Server: exec UC_WRITE_OLD_REP '10000', '00:00:01'

In doing, the first 10000 records of the RH_TEMP table are loaded to RH_TEMP2. These records
are copied from RH_OLD / RT_OLD to RH / RT which already has the new dataset of version
8.00A. The procedure then deletes the copied records from the temporary tables. If no error occurs,
this procedure continues until all data has been copied.

3. Handling "ah for rh not found" errors

l Repair procedures can only be executed if the reports have been subsequently manually
converted.

Follow the steps below if the error message "ah for rh not found - use repair procedures" occurs in the
stored procedure UC_WRITE_OLD_REP.

l Execute the stored procedure UC_REPAIR_FK_RH in the AE database:

Oracle: EXECUTE UC_REPAIR_FK_RH;
MS SQL Server: exec UC_REPAIR_FK_RH

Each record that is no longer available in the statistics (AH) is deleted from the RH_TEMP table.
l Use the following command again:
Oracle: EXECUTE UC_WRITE_OLD_REP(10000,1);
MS SQL Server: exec UC_WRITE_OLD_REP '10000', '00:00:01'

l Repeat these steps if this error occurs again.

4. Handling "rh for rt not found" errors

Follow the steps that are described below if the error message "rh for rt not found - use repair procedures"
occurs in the stored procedure UC_WRITE_OLD_REP.

l Execute the stored procedure UC_REPAIR_FILL_TEMP2. Enter the number of records that have
already been used for UC_WRITE_OLD_REP.
Oracle: EXECUTE UC_REPAIR_FILL_TEMP2(10000);
MS SQL Server: exec UC_REPAIR_FILL_TEMP2 10000

The temporary RH_TEMP2 table is filled with the records that caused an error.
 Automation Engine 607

l Execute the following command:

Oracle: EXECUTE UC_REPAIR_FK_RT_ANY_DUPL;
MS SQL Server: exec UC_REPAIR_FK_RT_ANY_DUPL

Erroneous records of the RH_TEMP2 table are removed from RT/RH. The RH_TEMP2 table is
emptied.
l Use the following command again:
Oracle: EXECUTE UC_WRITE_OLD_REP(10000,1);
MS SQL Server: exec UC_WRITE_OLD_REP '10000', '00:00:01'

l Repeat these steps if this error occurs again.

5. Deleting the temporary tables

l The temporary tables can be deleted from the database if the procedure has successfully been
completed (stored procedure UC_WRITE_OLD_REP). Doing so is important because it creates
disk space.
l The file "do_report.sql" includes some commented DROP commands. Remove the comments and
execute the required lines manually in the AE database.
l The following commands are available:

Oracle:
drop table ah_temp;
drop table rh_temp;
drop table rh_temp2;
drop table rt_old;
drop table rh_old;

MS SQL Server:
drop table ah_temp
GO
drop table rh_temp
GO
drop table rh_temp2
GO
drop table rt_old
GO
drop table rh_old
GO

Flow Chart of the Whole Procedure

608 Chapter 8 Installation
 Automation Engine 609

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
610 Chapter 8 Installation

l Adapt the INI file UCYBDBUN.ini to your environment. The entry OUTPUT= is very important, with
which you specify the path and the file name in which data are stored with it (Default:
OUTPUT=..\DB\UC_DATA.TXT).
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).

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)
 Automation Engine 611

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 10.0.0 and the MS SQL server 8.0.
In this case the appropriate directory is IMAGE:DB\SQL_8\10.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.
612 Chapter 9 ServiceManager

9 ServiceManager

9.1 ServiceManager - Service

The ServiceManager serves to start, stop and access components such as the Automation Engine
processes or agents from a central point.

You can specify the particular components in the definition file SMD. The ServiceManager starts the
programs in the background, grants access to particular properties and ends the program if necessary. It is
available for Windows and UNIX.

Install the ServiceManager program in Windows as a service. The AE components can then be
automatically started in the background during Windows system start-up without having to be entered as a
service.

A ServiceManager must be available on the same computer as the components which it uses. If the
components are installed on different hosts, you must install a ServiceManager on each of these
computers.

Select the start type "Automatic" in the service properties if the ServiceManager should be started together
with Windows,.

See also:

ServiceManager - Dialog Program

ServiceManager - Command Line Program

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.

 Automation Engine 613

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.
614 Chapter 9 ServiceManager

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
 Automation Engine 615

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.

616 Chapter 9 ServiceManager

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:

ServiceManager - Service
ServiceManager - Command Line Program
Starting and Ending Server Processes
 Automation Engine 617

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.
618 Chapter 10 Start Parameters

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

Program Start Description

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"
 Automation Engine 619

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.

Program Start Description

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
number in the following format:

"Agent file name version Automation Engine

version plus hotfix number"
All agents which run on Windows -V Prints the Automation Engine version and hotfix
number in the following format:

"Agent file name version Automation Engine

version plus hotfix number"

See also:

Start Parameters - Automation Engine and UserInterface

Start Parameters - Utilities
Start Parameters - ServiceManager
620 Chapter 10 Start Parameters

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 user interface,
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:

Program Start Description

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
 Automation Engine 621

- 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]
622 Chapter 10 Start Parameters

UCYBDBAR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Xreport -NObject [-
T1yyyymmddhhmmss] [-T2yyyymmddhhmmss] [-PPath and file prefix]

Program Start Parameter Description

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

Allowed values: "D", "E", "F"

"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you

do not specify this parameter.
-B Batch mode.
Archiving mode
-Smmmm 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/AE 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
starts this utility in batch mode.

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.
 Automation Engine 623

-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).
624 Chapter 10 Start Parameters

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
[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
UCYBCHNG [-V[Path and file name]] -B -1Script File -2Transport File [-3Output File] [-LLanguage]
 Automation Engine 625

Program Start Parameter Description

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
version plus hotfix number"
-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

version plus hotfix number"
-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

Allowed values: "D", "E", "F"

"D" = German (Deutsch), "E" = English, "F" =
French

The language that is specified in the INI file is

used if you do not specify this parameter.
For example:
ucybchng -b -1c:\AUTOMIC\uc_change.txt -2c:\AUTOMIC\uc_
transport.txt -3c:\AUTOMIC\uc_transport_new.txt

AE DB Client Copy
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE DB
Revision Report] [AE DB Unload] [AE.LogMix]

Syntax
Copy mode:

UCYBDBCC [-V[Path and file name]] [-IFile name] [-LLanguage] -B -C -Smmmm -Tmmmm -O [-M][-A][-
R] [-V] [-W]

Delete mode:

UCYBDBCC [-V[Path and file name]] [-IFile name] [-LLanguage] -B -E -Smmmm

UCYBDBCC [-V[Path and file name]] [-IFile name] [-LLanguage] -B -E -Tmmmm

Program Start Description

Parameter
626 Chapter 10 Start Parameters

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"

-IFile name The path and the name of the INI file.
-LLanguage Language

Allowed values: "D", "E", "F"

"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you do not
specify this parameter.
-B 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
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 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
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.
-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.
 Automation Engine 627

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
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE.DB
Revision Report] [AE DB Unload] [AE.LogMix]

Syntax
Loading the Transport Case / Initial Data:

UCYBDBLD [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Cmmmm [-EMode] [-
UName/Department] [-GName] [-AAccess] [-MAccess] -XFile name

Setting the authentication method:

UCYBDBLD [-V[Path and file name]] [-IFile name] [-LLanguage] -B -TAuthentication method-KCompany
key string

Program Start Parameter Description

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"
-IFile name The path and the name of the INI file.
628 Chapter 10 Start Parameters

-LLanguage Language

Allowed values: "D", "E", "F"

"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you do

not specify this parameter.
-B Batch mode
-Cmmmm 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
UserGroups.

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 UserGroups (default value).
-XFile name The name of the file that should be loaded. Note that this start
parameter is obligatory.
 Automation Engine 629

-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
[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]
630 Chapter 10 Start Parameters

Syntax
UCYBDBRE [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Smmmm

Program Start Description

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
Allowed values: "D", "E", "F"
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.
-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
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE.DB
Revision Report] [AE DB Unload] [AE.LogMix]

Syntax
UCYBDBRT [-IFile name] [-LLanguage] [-Cmmmm]-XPath and filename [-Ryyyymmdd[hhmm]] [-S] [-
OPath and filename] [-TFile type]
 Automation Engine 631

Program Start Parameter Description

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

Allowed values: "D", "E", "F"

"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

[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
UCYBDBRR [-V[Path and file name]] [-IFile name] [-LLanguage] -B -Cmmmm[-OPath and filename] [-
FType1,Type2,...] [-D1yyyymmddhhmmss] [-D2yyyymmddhhmmss] [-A] [-X]

Program Start Parameter Description

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"
632 Chapter 10 Start Parameters

-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

Allowed values: "D", "E", "F"

"D" = German (Deutsch), "E" = English, "F" = French

The language that is specified in the INI file is used if you do

not specify this parameter.
-B Batch mode.
-Cmmmm 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.
 Automation Engine 633

- 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
[AE DB Archive] [AE.DB Change] [AE DB Client Copy] [AE DB Load] [AE DB Reorg] [AE DB Reporting Tool] [AE.DB
Revision Report] [AE DB Unload] [AE.LogMix]

Syntax
UCYBDBUN [-V[Path and file name]] [-IFile name] [-LLanguage] -BMode [-D][-Cmmmm] [-XFile name] [-
K]

Program Start Parameter Description

Utility  for -V Prints the Automation Engine version and
unloading the hotfix number in the following format:
database
"UCYBDBun version Automation Engine
UCYBDBUN.JAR
version plus hotfix number"
634 Chapter 10 Start Parameters

-VPath and file name Prints the Automation Engine version and
hotfix number to the specified file in the
following format:

"UCYBDBun version Automation Engine

version plus hotfix number"
-IFile name The path and the name of the INI file.

-LLanguage Language

Allowed values: "D", "E", "F"

"D" = German (Deutsch), "E" = English, "F" =
French

The language that is specified in the INI file is

used if you do not specify this parameter.
-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.
"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.
 Automation Engine 635

-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
[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]
636 Chapter 10 Start Parameters

Syntax
UCYBLGMX [-V[Path and filename]] -B-LPaths and names of log and trace file -FPath and name of the
target file

Program Start Parameter Description

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
 Automation Engine 637

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
638 Chapter 10 Start Parameters

STOP_PROCESS Stops a service

-h Computer
This parameter must always be specified.
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.
This parameter must always be specified.
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.
 Automation Engine 639

-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.
640 Chapter 10 Start Parameters

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"
Only information pertaining to active services (Status = R) will be displayed.
Runtime The runtime of a service.
Format: "DD/HH:MM"
Only information pertaining to active services (Status = R) will be displayed.
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"
 Automation Engine 641

"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
642 Chapter 11 System Monitoring

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.
 Automation Engine 643

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.
644 Chapter 11 System Monitoring

Script Element
l The script element :TERMINATE is the third way of stopping an agent.

See also:

Agent
 Automation Engine 645

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:

Installing Utilities (Windows)

Installing Utilities (UNIX)

12.2 AE DB Archive

12.2.1 AE DB Archive
Archiving
The utility AE DB Archive can be used to remove the increasing amounts of data from the AE database.
Archived data is still available for years, it is stored in 7 bit ASCII code and can be displayed using the
Archive Browser.

Log on to the utility using the client that should be archived. You can also archive the relevant data in batch
mode (see Start Parameters). The settings that are specified in the utility apply. End the utility and a dialog
displays in which you can store the particular settings.
646 Chapter 12 Utilities

Database fields that are written to archive files are separated by semicolons. If semicolons are also
used in the archive keywords, the separation of database fields is no longer unique. Therefore, the
utility AE DB Archive converts the semicolons that are used in archive keywords to commas.

Note that the INI file of the archiving program must also be adjusted.

External report analyses can also be made using the utility AE DB Archive.

Field/Control Description
Table 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.
 Automation Engine 647

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 theINI file of the
utility AE DB Reorg.

Settings

Use the menu command Settings to define the archiving parameters or double-click the particular entry in
the table.

Note that these settings only apply for the client that is logged on to the utility.

A particular period of time can be specified for all data records that should be archived. The hour 00:00
is the time format that is used in order to ensure that complete days are considered in calculations.

Messages Tab

Description

Field/Control 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.
648 Chapter 12 Utilities

Statistics Tab

Note that reports that correspond to the statistical data are also archived.

Description

Field/Control 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
 Automation Engine 649

Description

Field/Control 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. 
650 Chapter 12 Utilities

Date format Specification of the required date format (mask) for the output of date and time
specifications in the archived files. 

If no particular date format is indicated, the format "Y.m.d H/M/S" is used (for example,
"2005.Aug.17 08/25/10").

Allowed date formats:

d Displays the day of the month as a two-figure number (01 -

31).
j 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
 Automation Engine 651

has already been archived for this client, the estimated amount of data and the estimated duration
(hours:minutes:seconds) of the archiving process is forecasted on the basis of this information.

As forecasts are created on the basis of the information that has been accumulated in previous archiving
processes, forecasts become more exact with each archiving process and the growing number of data
records that has already been archived.

See also:

General Procedure - Database Maintenance

Archive Browser
Structure of the Archived Folder
Start Parameters
Structure of the INI file, AE DB Archive
652 Chapter 12 Utilities

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
 Automation Engine 653

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

Position Description
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
654 Chapter 12 Utilities

Message Archive: UC_MELD.TXT

Position Description
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

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

General Procedure - Database Maintenance

Archive Browser
Archiving
Structure of the INI file, AE DB Archive
 Automation Engine 655

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:
656 Chapter 12 Utilities

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.
This entry is converted to upper-case
letters before the search starts.
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.
This entry is converted to upper-case
letters before the search starts.
Type Specification of the activation type.
This entry is converted to upper-case
letters before the search starts.
Subtype Specification of the activation type's
subtype.
There is no automatic check for
whether the combination with the
activation type is appropriate.
This entry is converted to upper-case
letters before the search starts.
Archive Key First archive keyword and second
1 archive keyword.
Archive Key
2
 Automation Engine 657

Object Name Name of the task that is searched or

or Message string in message text.
Text This entry is converted to upper-case
letters before the search starts.
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.
658 Chapter 12 Utilities

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
 Automation Engine 659

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

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.
660 Chapter 12 Utilities

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 entriesfrom 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 FileTransfers)
XRO_LoginSrc User name for the source host (only for FileTransfers)
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 FileTransfers 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
 Automation Engine 661

See also:

About Reports
Start Parameters

12.3 AE.DB Change

12.3.1 AE DB Change
Modifying Exported Data
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]
662 Chapter 12 Utilities

The parameter -B starts the program in batch mode. -I serves to specify the INI file's path and name.
Complete path specifications are required for the files. The parameter -L is used to determine the log file's
language.

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

Return code Description

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_PARTstatements to create scripting files for the AE DB
Change utility.

REPLACE Object Type, Name, Attribute, Old Value, New Value

 Automation Engine 663

REPLACE_PART Object Type, Name, Attribute, Part of the old Value, New Value

Syntax Description/Format
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 UC4.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.

REPLACE_PART
664 Chapter 12 Utilities

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.
 Automation Engine 665

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".
666 Chapter 12 Utilities

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

Modifying Exported Data
Structure of the INI file, AE DB Change
 Automation Engine 667

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.
668 Chapter 12 Utilities

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 theINI file using the parameter WorkTablePath=. The
utility does not create XML files if the indicated folder does not exist.

The following applies for subsequent copying processes:

 Automation Engine 669

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.

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.
670 Chapter 12 Utilities

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
 Automation Engine 671

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.
672 Chapter 12 Utilities

 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
 Automation Engine 673

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.
674 Chapter 12 Utilities

Field/Control Description
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.
 Automation Engine 675

Messages Tab

Description

Field/Control 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

Field/Control Description
Element
676 Chapter 12 Utilities

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

Field/Control 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.
 Automation Engine 677

Version Management Tab

Description

Field/Control Description
Element
Version You can use this check box to specify that Version-Control objects of the client are
management reorganized.
object
reorganization
Reorg objects 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.
678 Chapter 12 Utilities

Object Audit Tab

Description

Field/Control 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.
 Automation Engine 679

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:

General Procedure - Database Maintenance

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.
680 Chapter 12 Utilities

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:

Graphical Interface of the Reporting Tool

Creating Evaluation Reports
 Automation Engine 681

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 for UNIX and Windows. The way it is called depends on the
OS you use.

l UNIX: Start the Reporting Tool's interface via the Java Application Launcher using a console
command. The required file ucyrepg.jar is available in the utility folder.
l Windows: Under Windows, you can start the interface by using the file "ucyrepg.exe" or
"ucyrepg.jar". They are both stored in the utility folder.

Note for Windows: A 32-bit Java version is required if you start the Reporting Tool's interface via the
file "ucyrepg.exe". This limitation does not apply if you use the file "ucyrepg.jar".

You can use the following command in order to start the utility (UNIX and Windows):
java -jar ./ucyrepg.jar
682 Chapter 12 Utilities

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.
 Automation Engine 683

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
Creating Evaluation Reports

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.
684 Chapter 12 Utilities

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", "OA", "OS400", "R3",
"SIEBEL", "UNIX", "VMS" and "WINDOWS"
Int. account Internal account.

Interval Interval of the Time-Event object.

 Automation Engine 685

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.
686 Chapter 12 Utilities

See also:

Task Evaluations
Graphical Interface of the Reporting Tool
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>
Allowed values: "1" - "99999"

<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>
 Automation Engine 687

<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="10.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

Graphical Interface of the Reporting Tool
Creating Evaluation Reports
Start Parameters
688 Chapter 12 Utilities

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 UserGroup when the logging for revision reports has been
activated in the client. In this case, memberships can directly be specified in the User object.
 Automation Engine 689

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.

690 Chapter 12 Utilities

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.
 Automation Engine 691

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:

692 Chapter 12 Utilities

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
 Automation Engine 693

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.
694 Chapter 12 Utilities

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
 Automation Engine 695

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.
696 Chapter 12 Utilities

There can be time differences between the computers on which the components run. A message entry is
made in the report, log or trace file when such a time difference has been identified. AE.LogMix considers
this deviation in time in its chronological order. The entry's time stamp is not changed but a "T" is used to
flag the relevant lines.

Example:
Trace 01: C:\AUTOMIC\REPORTS\TRACES\WPSRV_TRC_001_##.TXT
Trace 02: C:\AUTOMIC\REPORTS\TRACES\WPSRV_TRC_002_##.TXT
Trace 03: C:\AUTOMIC\REPORTS\TRACES\WPSRV_TRC_003_##.TXT

02 - 20060620/163723.373 - U0003450 TRACE file was opened using the

switches '2400090000000000'.
01 - 20060620/163723.373 - U0003491 Time difference '0/00:02:11' or '131'
seconds to the Primary Server
03 T 20060620/163723.373 - U0009909 TRACE: (BINDPAR: MQSRV_System )
F074F57D 000008

Time-difference calculations are always based on the primary work process (PWP). The first PWP found
in file processing counts. This first identified time difference is used for the chronological order even if there
is a PWP change to a different work process within the files.

Return Codes

AE DB Archive:

Return code Description

1 Parameter -C is missing
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:

Return code Description

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.
 Automation Engine 697

Glossary
This glossary lists all specific technical terms in alphabetical order.

ABCDEFGHIJKLMNOPQRSTUVWXYZ

A
l AE Script
The Automation Engine's scripting language.
l AE Variables
These are Variable objects that include the AE system's specifications.
l AE component
Refers to AE programs such as UserInterfaces, the AutomationEngine, Agents, ServiceManagers,
utilities etc.
l AE database
A relational database management system (RDMS) that administers all scheduling data from a
central point. It contains object definitions, system specifications, statistical data, job reports, etc.
l AE priority
Affects the order of task execution within an AE system.
l AE system
An environment that is managed by AE components.
l Action Definition Editor
An Editor for <Actions>
l Action Service
A service which is able to respond (send) information to other systems, in contrast to the
<Response Service>, the service is configured using the incoming <event object>
l Activity Window
A UserInterface window that displays all activated tasks.
l AgentGroup
An AgentGroup combines agents of the same platform. The agents that shoulg be included in an
AgentGroup are specified by entering the agent name or via filters. A task which runs in an
AgentGroup is processed on one or all of the AgentGroup's agents, depending on the specified
mode.
l Auto Forecast
It displays tasks that will run in a predetermined period. Comprehensive forecast for all future
activities.
l Automation Engine
This component drives a AE system and consists of different types of server processes.
l Automation Engine
A separate Automic product that can be used to control, administer and operate an AE system. You
can define and schedule objects that run processes and activities on different hosts.
l activation
Through activation, tasks obtain a RunID, are displayed in the Activity Window, and are ready for
execution (see also 'Start').
l activation log
A report that contains all details about task activation. The details that are included in the log
698 Chapter Glossary

depend on the settings that have been specified (for example, the generated JCL, modified
Variables).
l activity
An activity (or task) is an entity, which can be planned, assigned to a user or a team and tracked
with respect to their plan and state (started, cancelled, suspended, completed).
l agent
A program that enables the de-centralized execution of processes (e.g. deployments) on target
systems (computers or business solutions) or a service that provides connectivity to a target
system (e.g. for databases or middleware). A particular AE object type.
l alias
This refers to the name of workflow tasks or objects that are activated once or recurring. This name
is used instead of the actual object name in the Activity Window, the monitors and the statistics.

B
l batch mode
This refers to the sequential background processing of tasks.
 Automation Engine 699

C
l Calendar
It consists of days using Calendar keywords. A particular AE object type.
l Calendar keyword
A part of a Calendar object that is used to define days.
l CallAPI
A programming interface that can either be called directly or from a different program. It processes a
script in the AE system.
l CallOperator
Deprecated Term. Replaced by: Notification
l Client Queue
Queue object which is available inside every client.
l Cockpit
It visualizes the values and states of the AE or of the monitored and controlled system. A particular
AE object type.
l CodeTable
It defines a complete set of characters. A particular AE object type.
l calendar condition
The criteria for running a task is based on calendar keywords.
l child / children
These are objects that are activated by superordinate tasks (parents).
l client
This is a closed environment for the execution of tasks within an AE system. A particular AE object
type.
l communication process
A communication process is part of the component Automation Engine. It is responsible for
connecting the AE components.

D
l Deployment
The creation of infrastructure for a specific set of <EventBases> on a <worker>
l DevOps
DevOps is the combination of development and operations in a single role.
l DialogClient
Deprecated Term. Replaced by: UserInterface
l data sequence
An internal listing of Console outputs or lines of Variable objects, etc. The lines of a data sequence
can be accessed by using a PROCESS loop or the script element GET_PROCESS_LINE. The
script elements PREP_PROCESS* generate data sequences.
l dialog process
A part of the Automation Engine component and a special form of work process. Is exclusively
responsible for UserInterface messages.
l dynamic variables
A Variable object with the attributes "Source" - "SQL", "SQL internal", "Multi" or "Filelist". Values
are directly retrieved from the data source and not stored in the object.
700 Chapter Glossary

E
l E-mail connection
This is a functionality of Windows and UNIX Agents that is used to send e-mails.
l Enterprise Control Center
A separate Automic product. Web application that allows access to the functions of various
Automation Engine applications and products in a quick and easy way. Available for download from
the Automic Download Center.
l Event
Action that is triggered if particular conditions apply. A particular Automation Engineobject type.
l Event ID
First RunID of FileSystem and Console Events. Both Event types require communication between
the component Automation Engine and Agent. They communicate via the first RunID. Otherwise,
Event identification is no longer possible after the first log change.
l Event Pattern Editor
An Editor for <Event Patterns>
l Event Transformer
A <component> which is able to transform raw data to <event objects>
l Exception Events View
View to observe occurred <exception events>
l Executor
Deprecated Term. Replaced by: agent
l Explorer
UserInterface window in which objects can be created, edited and administered.
l external dependency
A task whose end status is considered when a workflow is being processed. The task itself,
however, does not run within the framework of this workflow.

F
l FileTransfer
Transfers files from one computer to another. A particular AE object type (FileTransfer object).
l Forecast
Estimates a task's runtime on the basis of previous executions.
l fully qualified FileTransfer
File transfers without wildcard characters. One particular file is transferred (as opposed to partially
qualified file transfers).
 Automation Engine 701

G
l Generic Socket
A <Socket> which both senses (receives) events from its predecessors as well as responds
(sends) evens to its successors
l Graphical Workload Analyzer
Deprecated Term. Replaced by: UC4 ClearView
l Group
Integrates tasks so that they can be processed together. A particular AE object type.
l Group Monitor
Window that shows the state of tasks assigned to a group object.

H
l HTML Help
Microsoft help format for manuals. These help files have the ending .CHM (see also 'WebHelp').
l host
Computer, target system.
l host attributes
Platform-independent attributes of the Job object.

I
l Include
A script that is often used in several objects. A particular AE object type.

J
l Job
Processing on a target system. A particular AE object type.
l Job Control Language
Short form of "Job Control Language". It refers to applications that are processing steps executed
on computers.
l JobPlan
Deprecated Term. Replaced by: Workflow
702 Chapter Glossary

K
l Key column
Column in static Variable objects that can be used to access values of a particular line.

L
l Login
Login Objects store account credentials used by agents on target systems. A particular AE object
type.
l logical date
The logical date is used as a comparison date for checking Calendar conditions.

M
l Message Window
UserInterface window that displays warnings, information and error messages.
l Modelling Studio
An application which allows modeling of <EventBases> and managing the infrastructure of the
Policy Orchestrator and the associated <EventBases>
l main types
Release, Package, Package Dependency, Applications, Applications Versions, Host, Host Role,
Component, Activity, Environment, Reservation and Workflow.

N
l Node Registration View
View to manage <nodes> available in Decision
l Notification
Sends messages to individual users and user groups of the Automation Engine (AE) system. A
particular AE object type.
l Notification Monitor
Window of the Notification that is sent to one or severeal users at runtime.
l nonstop process
Part of the component Automation Engine. Nonstop processes assume processing if the computer
with the active server processes fails.
 Automation Engine 703

O
l Orchestration Editor
Editor to orchestrate EventBase components such as Maps and Sockets
l object
Automation Engine controlled activities and processes are structured in the form of objects (see
also 'Task').
l object class
There are four classes of objects: executable, active, passive and system objects.
l object type
An individual object is provided for the individual activities: User, UserGroup, Notification, Cockpit,
CodeTable, Documentation, Event, Agent, FileTransfer, Group, Include, Job, Workflow, Calendar,
Login, Client, RemoteTaskManager, Schedule, Script, Server, Sync, Variable and TimeZone.
l object variables
Placeholder for values that are stored in an object's "Variables & Prompts" tab.

P
l Predictive Analytics
A separate UC4 product. It is a complex graphical analysis tool that produces various interactive
graphical representations, called visualizations, of a data set. The visualizations can show both
individual data values or aggregations, depending on which functions and features that you use. If
the special eventBase for SLA results data is implemented in your company, you can retrieve and
view advanced analytics that show you patterns and trends in SLA historical performance.
Available for download from the UC4 Download Center.
l Process Assembly
A perspective of the Enterprise Control Center. You use it to create, define and modify workflows.
l Process Automation
The old name of the Service Catalog perspective.
l Process Monitoring
A perspective of the Enterprise Control Center. It lists the activities of all users and provides the
opportunity to manipulate them (you can cancel or deactivate them).
l ProcessFlow
Deprecated Term. Replaced by: Workflow
l PromptSet
A user-defined input mask for executable objects. A AE object type.
l PromptSet element
Fields/control elements that are used to query User values. They are the content of a PromptSet
input mask.
l PromptSet variable
It stores the value of a PromptSet element. Depending on the situation, a value can be user-defined
or a default value. PromptSet variables show the same behavior as object variables.
l package content
A package may reference applications, components and related packages.
l package dependency
A package milestone may depend upon another package to have passed a specific milestone.
704 Chapter Glossary

l package milestone
Since packages define a state machine, they need some sort of timely order. Milestones are used
for this.
l packages
Delivery package, a bundle of functionality.
l parent
There are different ways of activating objects. The originator of an activation is referred to as the
superordinate task (parent). (See also 'Child', 'Children')
l partially qualified FileTransfer
File transfers that use wildcard characters in order to transfer several files (as opposed to fully
qualified file transfers)..
l period container
Controls the execution of periodical tasks.
l perspective
Separate functional area of the Enterprise Control Center's (ECC) web interface. The perspectives
Process Automation and Process Monitoring provide functionalities of the Automation Platform.
l predefined variables
Fixed variables that can be used in the attributes or the script of executable objects. The values
refer to the object or the system.
l primary work process
It is responsible for the execution of AE-internal tasks and work processes.

Q
l Queue
A particular AE object type. In AE, a Queue determines the maximum number of concurrent tasks,
their priorities and the order in which tasks should be executed. In ARA, queues are containers for
workflow executions. Queues are intended to run repeatedly within a planned timeframe. The
assigned workflow executions are grouped together and are processed when the current queue run
starts.
l QueueManager
Deprecated Term. Replaced by: RemoteTaskManager

R
l RA Agent
An agent that can be connected to a particular RA Solution and thus provide this solution's
functionalities to an AE system. It is the interface between an external system / application /
platform and an AE system.
l RA Solution
A solution that is based on the Rapid Automation Technology that allows the AE to access an
external system / application / platform. The RA Solution is supplied as a JAR file that must be
loaded to the AE database and connected with an RA agent. The specific RA objects (such as
Jobs, Connections, Agent) are available in the AE system as soon as the solution has been loaded.
 Automation Engine 705

l Rapid Automation
A generic technology that can include various solutions. Is composed of an RA Agent and an RA
Solution.
l Release Manager
Deprecated Term. Replaced by: Application Release Automation
l Release Notes
Release Notes contain information about highlights, new functions, improvements, and corrections
for various versions and releases of the Automic procuct family.
l Release Orchestrator
The Application Release Automation is split into the two products Release Orchestrator and
Deployment Manager. The Release Orchestrator can be used to manage release plans and release
content for single or multiple application releases etc.
l RemoteTaskManager
It monitors and controls external Jobs that were not started by the Automation Engine. A particular
AE object type.
l Response Service
A service which is able to respond (send) information back to other systems, in contrast to the
Action service, most of its configuration has to be done manually in advance.
l Rule Editor
An editor for <Rules>
l Rule Space Editor
An editor for <Rule Spaces>
l RunID
Short for "run number". It is a number that provides unique information about a task's execution.
The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component .
l real date
The date that is used for checking runtime monitoring or time conditions in the properties of
workflow tasks is referred to as the real date. It complies with the top workflow's activation time. It
is passed on to all subordinate tasks.
l recurring tasks
These tasks are scheduled without using a Schedule object and mostly consist of a period that is
less than a day.
l registered
This is the status of a task that runs within a group and is waiting for its start.
l report
A report provides more detailed information about a task's execution or an AE component.
l restart
A restart refers to the repetition of an object's execution. This action differs from a new start in
some parts.
l result column
The first column of dynamic Variable objects with the sources "SQL", "SQL-internal" and "Multi".
The content of this column can be defined with Result format.
l return code
The value that represents the result of tasks and script functions.
l runtime
The duration of a task's execution. It refers to the period between a task's start and end. It does not
include its activation period (see also: activation and start).
706 Chapter Glossary

S
l Schedule
It starts executable objects periodically. A particular AE object type.
l Schedule Monitor
Graphical view of the execution of Schedule objects.
l Scheduler
A <component> which is able to send events in regular fashion or at specific points in time
l Script
A script processes statements in the AE's script language. A particular AE object type.
l Service Catalog
A perspective of the Enterprise Control Center. It allows users to start the objects in their Favorites
folder and generally monitor their execution.
l Service Orchestrator
An Automic product. The Service Orchestrator is a perspective of the Enterprise Control Centers
(ECC) and it is used to handle, monitor and analyze the performance of SLAs (Service Level
Agreements).
l ServiceManager
A program that facilitates the starts and stops of AE components.
l Sync
It synchronizes executable objects based on defined states and actions. A particular AE object
type.
l Sync Monitor
Window which contains the state of a Sync object and the assigned tasks.
l System Overview
The UserInterface window that contains information about the AE system.
l script variable
A placeholder for a value within a script.
l server process
The core of the component Automation Engine. Different types are available: communication, work
and dialog processes, as well as nonstop processes.
l static variables
A Variable object with the setting "Source" - "Static": Variable values are entered by a User or with
a script and remain stored in the object.
l statistics
This is a list of a task's previous runs.
l status
This represents the condition of a task (such as active, blocked, generating).
l sub-workflow
A workflow that is part of a different workflow.
l superordinate task
There are various ways of activating objects. The originator of the activation is referred to as the
superordinate task (parent).

T
l TimeZone
It defines a local time. A particular AE object type.
 Automation Engine 707

l task
An executable object that is running. Tasks are also referred to as activities.

U
l UC4 Automation Engine
A separate UC4 product which includes the individual components that are required to operate a
UC4 system (such as the component of the same name -the Automation Engine- which consists of
server processes, the UserInterface, the agents, the WebInterface etc.). Available for download
from the UC4 Download Center.
l UC4 Automation Platform
Deprecated Term. Replaced by: UC4 Automation Engine
l UC4 ClearView
A separate UC4 product. Graphical analysis tool: Displays the activities, statistical and forecast
data per UC4 system client in a bar diagram and can be used to calculate the critical path. Available
for download from the UC4 Download Center.
l UC4 Decision
Deprecated Term. Replaced by: UC4 Policy Orchestrator
l UC4 Insight
Deprecated Term. Replaced by: Predictive Analytics
l UC4 ONE Automation 2013
The name of the UC4 product family.
l UC4 Operations Manager
Deprecated Term. Replaced by: UC4 Automation Platform
l UC4 Policy Orchestrator
A separate UC4 product. It is an application for managing events within the UC4 system. This
application is the backend for Policy Orchestrator. First, UC4 Policy Orchestrator provides the
building blocks for defining the business rules. Then, it monitors the UC4 eventBases for
occurrences of the situations that are described in the business rule conditions and exceptions, and
then triggers the actions prescribed in the business rules. Available for download from the UC4
Download Center.
l UC4 Server
Old term for the component Automation Engine (v8 or lower).
l UC4.DB Archive
The utility UC4.DB Archive can be used to remove the increasing amounts of data from the UC4
Database
l UC4.DB Change
Utility for changing transport case exports.
l UC4.DB Client Copy
Utility for copying and deleting clients
l UC4.DB Load
The utility UC4.DB Load can be used to load data into the UC4 Database.
l UC4.DB Reorg
Data can be reorganized by using the utility UC4.DB Reorg. It marks data records with a deletion
flag in accordance with the settings that have been specified.
l UC4.DB Reporting Tool
The utility UC4.DB Reporting Tool can be used to query tasks in your UC4 system.
708 Chapter Glossary

l UC4.DB Revision Report

Utility unloading modification reports from the UC4 Database. Modification reports include detailed
information about object modifications and accesses.
l UC4.DB Unload
Utility for unloading the UC4 Database.
l UC4.Log Mix
The utility UC4.LogMix supports the generation of one common file from several report, log or trace
files.
l Universal Time Coordinated
Internally, the automation Engine uses UTC (Universal Time Coordinated) because UTC is the
international time standard and is always precise. Nevertheless, TimeZone objects are available
that can be used to show local times in tasks and script elements.
l User
A person who uses a UC4 system. A particular UC4 object type.
l User Management View
View to manage users and <authentication methods>
l UserGroup
A group of users who have a common profile of rights. A particular UC4 object type in the
Automation Engine.User groups are an organizing construct to help you better manage users
because you can grant user groups access rights the same way that you grant various access
rights to a single user. All users in the user group are automatically given those access rights. This
makes managing users not only more efficient but also more secure because working with user
groups gives you a better overview of what rights are assigned.
l UserInterface
This is UC4's graphical user interface.
l utilities
Utilities support the execution of administrative tasks in a UC4 system (such as reorganizing and
archiving the UC4 Database).

V
l Variable
It stores or retrieves values dynamically at runtime. An individual UC4 object type.
l Version Management
This refers to an object version that is stored when you have modified the object.
 Automation Engine 709

W
l WebHelp
One of the help formats that are provided for manuals. You open it with a Web browser (see also
'HTML Help').
l WebInterface
A UC4 user interface that can be called via a Web browser.
l Workflow
It refers to the execution of processes. A particular UC4 object type.
l wildcard characters
These are placeholders for characters when you specify filters. ? stands for exactly one character, *
for any number of characters.
l work process
A part of the component Automation Engine. It is responsible for a UC4 system's processes (see
also 'Primary work process').
l workflow monitor
Graphical view of a workflow's execution. It shows the workflow structure and the progress of the
child tasks.

X
l XML file
A format for imports and exports. An XML file contains object structures.