Enterprise Control Center Installation Guide

Enterprise Control Center Installation Guide
Enterprise Control Center
ONE Automation Platform
Installation Guide
Version: 1.9
Publication Date: 2015-12
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 Software.
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.
Siebel is a registered trademark of Oracle.
Other names may be trademarks of their respective holders.
Contents
1 Introduction
5
1.1 The ECC Perspectives
5
1.2 ECC Architecture
7
2 System Requirements for ECC 1.9
9
2.1 ECC Framework
9
2.2 Automic Products
9
3 Installation
11
3.1 Installing ECC
11
3.2 Internet Explorer Settings
14
4 Implementing ECC and Its Plug-Ins
17
4.1 Implementing the ECC Framework and Its Core Plug-Ins
17
4.1.1 About the ECC Framework and Its Core Plug-Ins
17
4.1.2 Configuring the ECC Framework and Its Core Plug-Ins
18
4.1.3 Authorizing Users to the ECC and Its Core Plug-Ins
20
4.1.4 User Privileges: An Overview
21
4.2 Implementing the Automation Engine Plug-In
22
4.2.1 About the Automation Engine Plug-In
22
4.2.2 Activating and Configuring the AE Plug-In
23
4.2.3 Authorizing Users for the AE Plug-In
23
4.3 Implementing the Policy OrchestratorPlug-In
24
4.3.1 About the Policy OrchestratorPlug-In
24
4.3.2 Activating and Configuring the PCOPlug-In
24
4.3.3 Authorizing Users for the PCO Plug-In
25
4.4 Implementing the Service Orchestrator Plug-In
26
4.4.1 About the Service Orchestrator Plug-In
26
4.4.2 Activating and Configuring the SVO Plug-In
27
4.4.3 Authorizing Users for the SVO Plug-In
28
4.5 Implementing the Release Manager Plug-In
29
4.5.1 About the Release Manager Plug-In
30
4.5.2 Activating and Configuring the Release Manager Plug-In
30
4.5.3 Authorizing Users for the Release Manager Plug-In
31
5 Configuration in ECC
33
iv | Contents
5.1 About Configuring ECC
33
5.2 Overview: ECC Configuration Files
34
5.3 configuration.properties for the ECC Framework
35
5.4 configuration.properties for the SVO Plug-In
37
5.5 decision.properties
38
5.6 eventbase.properties
40
5.7 externalpages.xml
42
5.8 navigation.xml
45
5.8.1 Available Icons for Navigator Buttons
52
5.9 releasemanager.properties
54
5.10 uc4config.xml
55
6 Setting Up SSL for Communication with ECC Components
57
6.1 Overview of the SSL Setup Steps
57
6.2 Configuring the Policy Orchestrator Gateway for SSL
58
6.3 Adding Truststore Certificates for SSL
59
6.4 Enabling SSL for the Policy Orchestrator Plug-in
59
7 Upgrading to ECC 1.9
61
8 Troubleshooting Display Problems
65
Release Notes for the Enterprise Control Center Version 1
67
Always the Latest Documentation
67
Version 1.9.0
67
Version 1.8.0
67
Version 1.7.0
68
Version 1.6.0
68
Version 1.5.0
68
Version 1.4.0
68
Version 1.3.0
69
Version 1.2.0
70
Version 1.1.0
71
Version 1.0.0
72
Bug Fixes
72
Known Issues
72
Glossary
73
Chapter 1 Introduction | 5
1 Introduction
The Enterprise Control Center (ECC) is a web application that brings together functions of several Automic
products from one entry point with a common look and feel. This guide describes the general ECC
installation and configuration procedures for the ECC and its plug-ins.
Perspectives and plug-ins
A perspective is a certain area within the ECC that includes specific features. Some perspectives provide
core functions that apply to more than one area, such as administration, and others apply to one functional
area that provide capabilities and data related to Automic backend systems, such as the Automation
Engine, Policy Orchestrator, or Application Release Automation.
Perspectives are provided through plug-ins. A plug-in itself can include one or several perspectives. The
plug-ins are part of the ECC and therefore, you do not have to install them separately. However, you have
to implement to a perspective to be able to use it. You so this by configuring the plug-in and grant the
required privileges and authorities to users.
1.1 The ECC Perspectives
When you install a perspective, a button to open it appears in the Navigator of the ECC interface. The
following perspectives are available for the ECC:
Perspective
Automic
Backend
Product
External Pages
Administration
Purpose
To be able to directly access sites that you would otherwise
have to access over a web browser.
Various
To manage ECC-related administration tasks.
Specifically to manage user and user group access rights for all
ECC perspectives from one central place.
This functional area appears on the ECC interface only for
users who have administrator rights in the Automation
Engine.
Service Catalog
AE
To start and monitor tasks, view activities and history.
The view is tailored to the needs of line of business users and
managers.
Process
Monitoring
AE
To filter and influence activities.
Process
Assembly
AE
Creating and defining workflows and folders
Policy
Orchestrator
PCO
To define and manage Policy Orchestrator business rules based
on existing templates
Service
Orchestrator
SVO
To manage SLAs and monitor and report on their performance.
6 | Chapter 1 Introduction
Release
Manager
ARA
Direct access to Application Release Automation.
Note: The names that appear on perspecitve buttons can be changed by an administrator, so your
button names may differ from those that are used in the installation guides and user help.
ECC and ARA
You can also use the ECC in combination with Application Release Automation (ARA). This is a separate
solution that you use to define, administer and activate deployment processes of one or several
applications. The deployment processes run in specific Deployment Workflows of the Automation Engine.
In the ECC Process Assembly perspective, you create and define these Deployment Workflows. To
simplify this process, you can establish a connection to the ARA web application and retrieve the values
that you use in the workflows. For the connection to the ARA web application, you must install and
configure a specific Deployment API in the ECC. The user must have access rights to Application
Release Automation and the ECC.
Chapter 1 Introduction | 7
1.2 ECC Architecture
End users can access the ECC over a web server from any computer. They can start processes and
retrieve various kinds of information. In the background, the related actions are executed through either a
Automation Engine, Policy Orchestrator, or Service Orchestrator, which can be installed on different
hosts.
The following illustration shows a sample Automation Engine environment where three users are logged
into the ECC web application from their PCs to connect to the ECC Server. What each user can see or do
in the ECC is configurable by a system administrator in the Automation Engine(s), PCO, SVO and ARA.
These connections are established by perspectives that are installed on the ECC Server and configuration
files that are defined on the various hosts:
8
Chapter 2 System Requirements for ECC 1.9 | 9
2 System Requirements for ECC 1.9
The Enterprise Control Center (ECC) is a web interface that can be used to access the functions of
various Automic products.
2.1 ECC Framework
The ECC server components were developed and tested on Windows (Windows Server 2008 R2) and
Linux (SuSE Enterprise Linux 11). Please contact Automic Support (support@automic.com)before
planning or attempting an installation on any other platforms.
Web Server
Note
Apache Tomcat V7.0.xx
You can only deploy one instance of the ECC web application
per Tomcat instance.
JAVA
Note
Oracle/Sun JRE 1.6.31 or higher, or the
latest 1.7 update
Important: In connection with the JDBC driver of MS SQL
Server 2008 R2, Java versions 1.6.27 – 29 lead to system
shutdowns. Therefore, Automic does not recommend
using these versions.
Browser
Note
MS Internet Explorer V8 or V9
MS Internet Explorer V9 is recommended over V8 because of
better performance results.
For best performance, however, use Firefox or Chrome.
Mozilla Firefox V17 or higher
Google Chrome 23.0.1 or higher
Safari 5.1.7 for Windows 7 64 bit or
higher
2.2 Automic Products
ECC and its plug-ins work with Automic backend products. The following table shows which versions of
these products that the ECC 1.9 plug-ins need.
Note: The "x" in the version number stands for the latest hotfix. In all cases, make sure to install the
latest hotfix versions.
Plug-in
Compatible Backend Product Versions
Automation Engine Plug-in
(Process Automation) which
includes:
Automation Engine
l
l
l
Process Monitoring
Process Assembly
Service Catalog
l
V9.00A SP6 or later service pack
10 | Chapter 2 System Requirements for ECC 1.9
Plug-in
Compatible Backend Product Versions
Policy Orchestrator Plug-in
Policy Orchestrator
l
l
Service Orchestrator Plugin
(frontend)
V9.7.x
V10.1.x
Service Orchestrator server
l
V1.11
Automation Engine
l
V9.00A SP6 or later service pack
Policy Orchestrator
l
l
Release Manager Plug-in
V9.7.x
V10.1.x
Automation Engine
l
V9.00A SP6 or later service pack
Release Automation (Application Release Automation)
l
V3.5.x
Chapter 3 Installation | 11
3 Installation
3.1 Installing ECC
The following document provides a step-by-step description of the installation of the Enterprise Control
Center (ECC).
Prerequisites
Make sure that you have installed the required hardware and software, and compatible versions of Automic
products for this version of the ECC. These are described in the System Requirements for ECC 1.9 in this
guide.
Overview of the installation steps
1.
2.
3.
4.
5.
6.
7.
Install Java Runtime (JRE or JDK)
Install and prepare the Apache Tomcat web server
Install the ECC
Implement the initial ECC settings
Prepare Internet Explorer
Start the ECC
Grant users privileges and authorities
1.
Install Java Runtime (JRE or JDK)
Check the System Requirements for ECC 1.9 to see which Java version you need. If you already have
that installed on the server where you will install the ECC, you can skip to the step "Installing and
Preparing Apache Tomcat."
You can check the system's current Java Virtual Machine (JVM) version by using the command "java version".
If several different Java versions are installed on your computer, then when defining %PATH% or
$PATH variable, then ensure that the order of the specified directories is correct. The Java Runtime
Environment (JRE) that is found first in the list of directories is applied.
If you do not have the required Java version, then do the following:
1. On the ECC computer, download and install the Java Runtime Environment (JRE) or Java
Development Kit (JDK) from the following site:
http://www.oracle.com/technetwork/java/javase/overview/index.html
2.
Install and prepare the Apache Tomcat web server
The ECC runs on a Apache Tomcat web server, an open source software. You need to download and
install it, and then configure it to handle the ECC installation package.
12 | Chapter 3 Installation
a. Check the System Requirements to see which version of Tomcat you need.
b. Go to the Tomcat home page and then download and install the required version. You will find the
installation instructions and other relevant information on their home page.
http://tomcat.apache.org/index.html
Recommended: Install the 64-bit version of Tomcat and JAVA Runtime Environment (JRE) on
a 64-bit operating system.
c. This is a good time to increase the amount of memory that Tomcat is allowed to allocate. Increasing
the memory allocation settings to the maximum available on your hardware will optimize
ECC performance.
This is only possible on a 64-bit version of Tomcat, which needs a 64-bit JRE and 64-bit
operating system, as recommended above.
d. To improve performance on browsers with poor connections, adapt your Tomcat configuration so
that Tomcat uses the NIO2 connector and the upload timeout attribute is enabled.
To do this, open the <Tomcat>/conf/server.xml file and edit it as follows:
Before:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" />
After:
<Connector port="8080"
protocol="org.apache.coyote.http11.Http11NioProtocol"
connectionTimeout="20000"
redirectPort="8443"
disableUploadTimeout="false"
connectionUploadTimeout="10000"/>
For complete information about the Tomcat connector configuration attributes, see
https://tomcat.apache.org/tomcat-7.0-doc/config/http.html.
e. Copy or move the ECC WAR file into the webapps folder in your Tomcat installation, and Tomcat
will deploy it automatically.
f. Create and start a Windows service for Tomcat so that it is automatically started when you start the
physical server that it is installed on.
g. Make sure that Tomcat automatically starts when you start the server that it is installed on, for
example, with a Windows service or an init script.
h. Start Tomcat.
3.
Install the ECC
You install the ECC by deploying it on your Tomcat server.
a. From the Automic Download Center (downloads.automic.com), download the most recent version
of the Enterprise Control Center 1.9 package.
The name of the WAR file will also be in the name of your ECC installation. If you want to use a
different name, change the name of the WAR file now, keeping the "war" extension.
Chapter 3 Installation | 13
b. There are two ways to deploy the ECC.
l
With the Tomcat Manager web application. See the Tomcat website for instructions.
l
Manually:
i. On the server where you have Tomcat installed, copy the file
uc4.enterprise.control.center.war file that you downloaded to the webapps folder
of the Tomcat installation.
ii. If your Tomcat service is running, the WAR file will be deployed automatically.
A new folder named "uc4.enterprise.control.center" is created in the webapps folder.(If you
changed the WAR file name, then the new folder has that name.)
Do not delete the WAR file! If you do, Tomcat will also remove the corresponding
subfolder,which also undeploys the ECC!
4.
Implement the initial ECC settings
Do the following implementation tasks:
Configure the ECC using the steps described in Implementing the ECC Framework and Its Core
Plug-Ins.
Configure all the plug-ins that you want to implement as described in the related sections of
Implementing ECC and Its Plug-Ins.
Grant the initial administrator the following:
l
All privileges listed in User Privileges: An Overview
l
Full authorization to all Automation Engine objects and folders
l
Optionally, Policy Orchestrator roles and eventBase access, if needed
l
Optionally, Release Manager (Application Release Automation) permissions and folder
rights, if needed.
l
l
l
Note: If you want to implement Service Orchestrator, you have to install the SVO server separately.
You can download the package from the download center, and find the latest version of the Service
Orchestrator Installation Guide on docs.automic.com.
5.
Prepare Internet Explorer
These tasks are only required if you or your users want to use the Microsoft Internet Explorer as your
ECC browser.
On each computer where Internet Explorer will be used as the ECC browser:
l
l
Install and enable the Microsoft hotfix for a bug that is related to timeouts on HTTP POST requests
and produces terminal errors in ECC. For the download of the hotfix and instructions for
implementing it, see https://support.microsoft.com/en-us/kb/895954.
Make sure that your users Internet Explorer mode settings are set for the version of Internet
Explorer that they are using. For details see the instructions in Internet Explorer Settings.
6.
Start the ECC
To call the ECC enter the following URL in the address bar of your internet browser:
http://host name:8080/webapp name/ where:
host name = the name of the computer on which the Apache Tomcat web server runs
webapp name = the name of the WAR file (without the file extension).
14 | Chapter 3 Installation
7.
Grant users privileges and authorities
After logging in as an administrator, you can create users and user groups and assign them the rights they
need to work with the perspectives, objects and data that they need. Depending on their needs, you need
to grant the following:
l
l
l
l
Privileges (User Privileges: An Overview)
Authorization to Automation Engine objects and folders
Policy Orchestrator
Release Manager (Application Release Automation) permissions and folder rights
For information, see the related sections in Implementing ECC and Its Plug-Ins. For instructions about
how to create and maintain users and user groups, see the information about User Management under
Adminstration in the ECC online help.
If users have display problems, see the section Troubleshooting Display Problems.
3.2 Internet Explorer Settings
If you want to work with the ECC on a Microsoft Internet Explorer browser, you must make sure that its
Browser Mode and Document Mode match the Internet Explorer version. This topic describes how to set
these modes.
You can run the ECC on Internet Explorer versions 8 or 9. If you do, make sure that on every computer, the
following modes match the version of the Internet Explorer:
l
l
Browser Mode
Document Mode
Steps...
1. Open your Internet Explorer.
2. Press F12 to open the Developer Tools page.
Alternatively, you can select Developer Tools from the Tools menu in the Internet Explorer toolbar.
3. Click the Browser Mode menu, and select the Browser Mode that matches your Internet Explorer
version.
In the example here with Internet Explorer version 9 (IE9), Internet Explorer 9 is selected.
In Internet Explorer version 8, you would select Internet Explorer 8.
Do not select the Compatibility View mode.
Chapter 3 Installation | 15
4. Click the Document Mode menu, and select the Document Mode that matches your Internet
Explorer version.
In the example here with Internet Explorer version 9 (IE9), Internet Explorer 9 Standards is
selected.
In Internet Explorer version 8, you would select Internet Explorer 8.
Click here to return to the Installation Procedure and continue with Step 4.
16
Chapter 4 Implementing ECC and Its Plug-Ins | 17
4 Implementing ECC and Its Plug-Ins
After deploying the ECC, the only perspective you can see immediately is the External Pages perspective.
To see an use any of the other perspectives, you need to implement them.
Although all plug-ins are installed with the ECC, most plug-ins are not active until you implement them.
Implementing a plug-in involves the following tasks:
1. Defining configuration files
After this step, the plug-in and its perspectives and functions are activated in your ECC installation
and available to users with the required authorities.
2. Define user authorities
After this step, the authorized users can see and use the related ECC functions. Authorities for
ECC include:
l
Privileges to the perspectives
Most perspectives and some functions require certain Automation Engine privileges to be
able to see the perspective button in the ECC Navigator and access the related functions.
l
Various authorities
Generally, to be able to see and work with the data structures of a perspective, a user needs
certain authorities. The data structures are stored in Automic backend systems, so the kind
of authorities that users might need to work in a perspective can vary. The necessary
authorities can include a combination of the following:
o AE Authorizations to objects and folders
o PCO roles and authorization to EventBases
o ARA folder rights
The sections that follow cover the ECC framework and its core perspectives, and then the applicationrelated plug-ins. Each section contains three kinds of information:
l
l
l
A brief description of the related perspectives and functions
A summary of the configurations required to activate the perspective in ECC
A summary of the authorities that users need
4.1 Implementing the ECC Framework and Its
Core Plug-Ins
This section explains what you need to do to implement the ECC Framework and its core plug-ins:
External Pages and Administration.
4.1.1 About the ECC Framework and Its Core Plug-Ins
The ECC Framework is the web container that allows you to view and work with various plug-ins that are
related to specific Automic backend products. The core plug-ins have functions that support the other plugins, that provide administrative tasks for the ECC or its backend products, or that are not related to any
other plug-in or backend product.
The following plug-ins and their related perspectives are what are called the ECC "core" plug-ins:
18 | Chapter 4 Implementing ECC and Its Plug-Ins
l
l
External Pages, which gives you access to web pages outside of the ECC, such as the Automic
homepage or your company's intranet site, the links to which you have configured in ECC.
Administration, which allows administrators to manage user and user group definitions, as well as
view system information about the Automation Engine that the ECC is connected to, such as the
cache, exits libraries, and the quarantine messages.
Details about the functions of these plug-ins and instructions for working with them are covered in the
Enterprise Control Center User Guide, whereas the other plug-ins are described separately in their own
user guides.
4.1.2 Configuring the ECC Framework and Its Core Plug-Ins
This section describes what you have to configure to prepare the ECC Framework, which is a critical
installation step, and to prepare the standard ECC plug-ins: External Pages and Administration.
The following configuration files affect the ECC Framework and its core plug-ins:
l
l
l
l
uc4config.xml
configuration.properties
navigation.xml
externalpages.xml
The tables that follow contain overviews of which files affect the ECC Framework and the individual core
plug-ins: External Pages and Administration.
Except for the External Pages plug-in, for all other core plug-ins, after you configure the necessary
files, you need to give users the related privileges. Otherwise, they will not see the related perspective
buttons in the ECC. For information about the authorizations that users of the core plug-ins need, see
Authorizing Users to the ECC and Its Core Plug-Ins.
Configuring the ECC Framework
The following table describes the configuration files that the ECC Framework needs:
Configuration File
Required?
Purpose
uc4config.xml
Yes.
To define the connection between ECC to one or
more Automation Engine systems.
Without this connection, you would have a blank
ECC except for the External Pages perspective.
configuration.properties
Yes.
To define aspects of the communication
between the ECC and the AE, such as the
security options and timeout intervals.
Chapter 4 Implementing ECC and Its Plug-Ins | 19
Configuration File
Required?
Purpose
navigation.xml
No. Default settings
are provided.
To define the order and appearance of the
buttons that open the ECC perspectives.
l
l
l
Change the icon that appears on a
button.
Change the order in which the buttons are
listed.
Define a new label for a button. You can
define both an English and German label.
Configure this file only when you want to change
the default settings.
Configuring the External Pages plug-in
The following table describes the configuration files that are related to the External Pages plug-in:
Configuration File
Required?
Purpose
externalpages.xml
Yes.
To define each external page link by doing the
following:
l
l
Defining the URL for the web pages that
you want users to be able to open from
ECC.
Specifying authentication requirements
to open the external page.
You must also define each external page in
the navigation.xml so that they appear in the
ECC Navigator
navigation.xml
Define how the external pages perspective
buttons and links appear in the ECC Navigator.
For each external pages button you can do the
following:
l
l
l
Define the label for the buttons in both
English and German.
Define the icon that appears on the
button.
Specify its placement in the list of
buttons.
By default there is only one External Pages
button, but you can add more perspective
buttons for external pages. For each button, you
can also add multiple links, which users can
select from the Navigator pane.
Configuring the Administration plug-in
If you have already defined the uc4config.xml , then there is nothing else that you have to configure for the
Administration plug-in. The uc4config.xml file establishes the connection to the AE systems that store the
20 | Chapter 4 Implementing ECC and Its Plug-Ins
user and user group definitions. In addition, these are the AE systems for which you can see statistics of
system activities in the related administrative functional areas: Cache, Exits, Quarantine.
4.1.3 Authorizing Users to the ECC and Its Core Plug-Ins
This section covers the kinds of privileges and authorizations that users need to work with the core plugins in ECC. For an overview of all ECC privileges, see User Privileges: An Overview.
There are several kinds of authorities that users of the ECC core plug-ins need:
l
l
l
l
Automation Engine (AE) Privileges
AE authorizations to objects and folders
PCO authorizations to EventBases
PCO roles
Recommendation for all ECC users
To be able to use most ECC perspectives and functions, a user needs a user definition in the Automation
Engine, regardless of whether the definition is created in AE or in ECC. A user that is only defined in the
Policy Orchestrator Modelling Studio can log into the ECC, but such a user can login only with Decision
Authentication and access only the Policy Orchestrator perspective.
Authorities for the initial ECC administrator
To prepare for the first time that you log into the ECC, you should set up at least one user in the
Automation Engine backend to act as an administrator for the ECC. This users should have the following:
l
l
l
All ECC privileges in AE
AE authorization to all objects and folders in the AE, and all clients (AE Client 0)
If you are using PCO, PDA or SVO for event-based SLAs, also all PCO roles and authorizations to
all EventBases
Automation Engine Privileges for ECC core plug-ins
A user can see the External Pages, without any AE privileges. However, to use the other core
perspectives, privileges are required as described in the following table.
Give this privilege...
To...
ECC: Access to Administration
Users of the Administration perspective
Typically administrators have all ECC privileges.
In ECC, you grant privileges to users in the Automation Engine/Privileges section of the Users
&Groups function of the Administration perspective. For instructions, see the Enterprise Control Center
User Guide or online help.
Chapter 4 Implementing ECC and Its Plug-Ins | 21
Authorizations and roles for ECC core plug-ins
For the Administration Grant users Automation Engine authorizations to the necessary objects and their
folders. Otherwise, they will be able to open the perspectives, but will not be able to see or work with any
objects.
Functional Area
Authority Considerations
Administration: User
Management
To effectively manage users, an adminstrator needs:
l
l
l
Administration:
l
l
l
Cache
Exits
Quarantine
AE authorizations to all objects and folders, not just to the USER and
UGRP objects
The Super Administrator role in PCO
PCO authorization to all EventBases
Users can see and work with only the objects and folders that they have
AE authorizations for.
In ECC, you grant all AE authorizations and PCO roles and authorizations in the related section sof the
Users &Groups function of the Administration perspective. For instructions, see the Enterprise Control
Center User Guide or online help. You can also grant these authorizations in the respective backend
systems
4.1.4 User Privileges: An Overview
When implementing ECC, you have to make sure that the people who need to work with ECC have the
required Automation Engine privileges. This topic provides an overview of all user privileges that are
related to the ECC perspectives.
After logging into the ECC, users see the perspective buttons in the ECC Navigator that open the
perspectives which they have privileges for. Every Automation Engine user has different authorities and
privileges. Some privileges control access to ECC perspectives and functions.
Where users should be defined
You can define users and grant them privileges and authorities in the Automation Engine Rich Client or
directly in ECC's User Management function in the Administration perspective.
To be able to use most ECC perspectives and functions, a user needs a user definition in the Automation
Engine, regardless of whether the definition is created in AE or in ECC. A user that is only defined in the
Policy Orchestrator Modelling Studio can log into the ECC, but such a user can login only with Decision
Authentication and access only the Policy Orchestrator perspective.
The ECC privileges
There is no privilege required to see the External Pages perspective. This is always available to all users,
unless the navigation.xml file is configured to exclude it from ECC altogether. All other perspectives
require privileges as described in the following table.
Privilege
Description
ECC: Access to Administration
Displays the Administration perspective button
22 | Chapter 4 Implementing ECC and Its Plug-Ins
ECC: Access to Policy Orchestrator
Displays the Policy Orchestrator perspective button ECC: Manage SLAs and Business Units
in Service Orchestrator
Allows SVO users to maintain SLA and business unit
definitions.
The user must also have the privilege "ECC: Access to
Service Orchestrator."
ECC: Access to Service Catalog
Displays the Service Catalog perspective button
ECC: Access to Process Assembly
Displays the Process Assembly perspective button
ECC: Access to Process Monitoring
Displays the Process Monitoring perspective
ECC: Access to Service Orchestrator
Displays the Service Orchestrator perspective button and
allows users to monitor and produce reports of performance
of SLAs that they have authorization for, but not to maintain
SLA or business unit definitions.
4.2 Implementing the Automation Engine PlugIn
This section explains what you need to do to implement the Automation Engine Plug-In in ECC. This plugin contains three perspectives: Service Catalog, Process Assembly, and Process Monitoring.
4.2.1 About the Automation Engine Plug-In
The Automation Engine Plug-In contains three perspectives for working with AE objects to create, start,
and monitor executable workflows and tasks.
Prerequisite Automic backends
In addition to installing the ECC, you need to have the compatible versions of the following Automic
products installed:
l
Automation Engine, which stores the instances of the objects for the workflows and tasks that you
can create, start, and monitor in the AE Plug-in perspectives.
Description
When you have configured the AE Plug-in, the following perspectives are available in the ECC to users
with the required privileges:
l
l
l
Service Catalog, where you can start and monitor AE tasks
Process Monitoring, where you can monitor and take action (such as stopping, rolling back,
providing parameter values) on executed AE workflows and tasks.
Process Assembly, where you defined the workflows that can be executed and monitored in the
Service Catalog and Process Monitoring
You can create, execute and monitor the workflows in the AE Rich Client as well. The perspectives of the
AE Plug-in in ECC provides a simplified web interface to do these tasks. For complete information about
what you can do in the AE Plug-in perspectives, see the Automation Engine Plug-in User Guide or the
online help.
Chapter 4 Implementing ECC and Its Plug-Ins | 23
4.2.2 Activating and Configuring the AE Plug-In
This section describes how to activate and configure Automation Engine Plug-in in your ECC installation.
Activating the plug-in
You activate the plug-in in ECC by defining the uc4config.xml file in ECC for the AE systems that you
want users of the perspectives of the AE Plug-in to be able to work with. You have probably already
configured this file when you first set up the ECC. When you implement the AE Plug-in, check to see if all
the needed AE systems are configured and configure the missing ones
Activating a plug-in makes its perspectives available to authorized users in your ECC installation. This
means, that in addition to activating the plug-in you have to give users the related privileges.
Otherwise, they will not see the related perspective buttons in the ECC. For information about the
authorizations that users of the AE Plug-in need, see Authorizing Users for the AE Plug-In.
Configuration files
The following table summarizes the configuration files related to this plug-in.
Configuration File
Required?
Purpose
uc4config.xml
Yes.
To define the connection between ECC to one or
more Automation Engine systems.
4.2.3 Authorizing Users for the AE Plug-In
This section explains the types of authorizations that users need to be able use the perspectives of the
Automation EnginePlug-in in ECC.
To work with the perspectives of the Automation EnginePlug-in, a user must have the needed:
l
l
Automation Engine Privileges
Automation Engine Authorizations
Automation Engine Privileges
To use the perspectives of the AE Plug-in users must have the related privilege. Otherwise, they will not
even see the related perspective button when they log into the ECC.
Give this privilege...
To...
ECC: Access to Service Catalog
Users of the Service Catalog perspective to start and
monitor tasks
ECC: Access to Process Assembly
Users of the Process Assembly perspective to create
and maintain workflow tasks
ECC: Access to Process Monitoring
Users of the Process Monitoring perspective to monitor
executed workflows
24 | Chapter 4 Implementing ECC and Its Plug-Ins
In ECC, you grant privileges to users in the Automation Engine/Privileges section of the Users
&Groups function of the Administration perspective. For instructions, see the Enterprise Control Center
User Guide or online help. You can also grant these privileges in the Automation Engine Rich Client.
Automation Engine authorizations
Grant users Automation Engine authorizations to the necessary objects and their folders. Otherwise, they
will be able to open the perspectives that they have privileges for, but the perspectives will contain no
objects to see or work with.
In ECC, you grant object authorizations to users in the Automation Engine/Authorizations section of
the Users &Groups function of the Administration perspective. For instructions, see the Enterprise
Control Center User Guide or online help. You can also grant these authorizations in the Automation
Engine Rich Client.
4.3 Implementing the Policy OrchestratorPlug-In
This section explains what you need to do to implement the PCOPlug-In in ECC.
4.3.1 About the Policy OrchestratorPlug-In
The Policy OrchestratorPlug-In is an ECC component for event-based business rule management.
Prerequisite Automic backends
In addition to installing the ECC, you need to have the compatible versions of the following Automic
products installed:
l
Policy Orchestrator, which is the backend to the PCO Plug-in
About the plug-in
The PCO-Plugin provides you a simple interface for creating business rules by dragging in predefined
building blocks (conditions, actions, and exceptions) and then specifying the values for the new rule.
These building blocks are either already delivered from Automic or can be created in the Modelling Studio
in the PCO backend.
4.3.2 Activating and Configuring the PCOPlug-In
This section describes how to activate and configure Policy Orchestrator Plug-in in your ECC installation.
If you have already implemented the Service Orchestrator Plug-in or the Predictive Analytics Plug-in, then
you can skip this topic and continue with Authorizing Users for the PCO Plug-In.
Activating the plug-in
You activate this plug-in in ECC by defining the decision.properties configuration file.
Chapter 4 Implementing ECC and Its Plug-Ins | 25
Activating a plug-in makes its perspectives available to authorized users in your ECC installation. This
means, that in addition to activating the plug-in you have to give users the related privileges.
Otherwise, they will not see the related perspective buttons in the ECC. For information about the
privileges that users of the PCO Plug-in need, see Authorizing Users for the PCO Plug-In.
Configuration files
The following table summarizes the configuration files related to this plug-in.
Configuration File
Required?
decision.properties
Yes
Purpose
l
l
To activate the related plug-ins by
defining the location of the
PCO Gateway, with which ECC needs to
communicate to exchange EventBase
data.
To indicate whether the communication
between ECC and the Gateway is
secured with SSL.
4.3.3 Authorizing Users for the PCO Plug-In
This section explains the types of authorizations that users need to work with the PCO Plug-in to create or
view business rules.
To work with the PCO Plug-in, a user must have the needed:
l
l
l
Automation Engine Privilege
Policy Orchestrator Roles
Policy Orchestrator Authorizations
Automation Engine Privilege
To use the PCO Plug-in users must have the privilege ECC: Access to Policy Orchestrator. Otherwise,
they will even not see the Policy Orchestrator perspective button when they log into the ECC.
In ECC, you grant privileges to users in the Automation Engine/Privileges section of the Users
&Groups function of the Administration perspective. For instructions, see the Enterprise Control Center
User Guide or online help.
Policy Orchestrator Roles
You assign Roles to a PCO user to define the level of access that the user can have. For the PCO Plug-in,
make sure that the user has the needed roles. The following table lists the ones that can apply to PCO
Plug-in users:
This role...
Allows the user to...
Super Administrator
Do everything in Policy Orchestrator
Rule Administrator
Create and maintain business rules
26 | Chapter 4 Implementing ECC and Its Plug-Ins
This role...
Allows the user to...
Rule Operator
View business rules
Activate/deactivate rules
In ECC, you assign PCO roles to users in the Policy Orchestrator section of the Users &Groups
function of the Administration perspective. For instructions, see the Enterprise Control Center User
Guide or online help.
Policy Orchestrator Authorizations: Access to EventBases
Give users access to the EventBases that store rule management specifications.
In ECC, you give users access to EventBases by selecting them from a list under the "Authorizations"
heading in the Policy Orchestrator section of the Users &Groups function of the Administration
perspective. For instructions, see the Enterprise Control Center User Guide or online help.
4.4 Implementing the Service Orchestrator
Plug-In
This section explains what you need to do to implement the SVO Plug-In in ECC.
4.4.1 About the Service Orchestrator Plug-In
The Service Orchestrator Plug-In is the frontend component for managing and monitoring SLAs in ECC.
Prerequisite Automic backends
In addition to installing the ECC, you need to have the compatible versions of the following Automic
products installed:
l
Service Orchestrator Server, which is the backend to the SVO Plug-in.
This guide only provides information about implementing the SVO Plug-in in ECC. For
information about installing and configuring the SVO Server, see the Service Orchestrator
Installation Guide.
l
l
Automation Engine, which has several functions:
l
It provides various process-related objects that are the basis for AE SLAs.
l
It provides objects that can be triggered when SLAs are violated.
l
It stores the user definitions with the various authorizations that they need.
Optionally, the Policy Orchestrator, which provides the events for the following;
l
Event-based SLAs
l
The optional EventBase that stores extended SLA performance data that can be analyzed
with Predictive Analytics.
Not all companies use EventBase SLAs, and not all users within the company might work with
them. Check with the appropriate members of your organization.
Chapter 4 Implementing ECC and Its Plug-Ins | 27
Description
The SVO Plug-in is the frontend component of the SVO Server.
Basically, in the plug-in, you create SLAs to track the performance of Automation Engine objects and the
occurrences of events in Policy Orchestrator EventBases. The SVO Server monitors the objects and
events and keeps historical records of the SLA performance and sends this information to the SVO Plug-in
in real time. In addition to seeing how SLAs are currently performing, you can generate reports on historical
performance data. For complete information about what you can do in the SVO Plug-in, see the Service
Orchestrator User Guide or the online help.
4.4.2 Activating and Configuring the SVO Plug-In
This section describes how to activate and configure Service Orchestrator Plug-in in your
ECC installation.
Activating the plug-in
You activate the plug-in in ECC by defining the configuration.properties file for the SVO. This file is in a
different file from the one that you define for the ECC in general. See the table below for the link to details
about the file.
Activating a plug-in makes its perspectives available to authorized users in your ECC installation. This
means, that in addition to activating the plug-in you have to give users the related privileges.
Otherwise, they will not see the related perspective buttons in the ECC. For information about the
privileges that users of the SVO Plug-in need, see Authorizing Users for the SVO Plug-In.
Configuration files
The following table summarizes the configuration files related to this plug-in.
Configuration File
Required?
decision.properties
Yes, if you have not
already configured it
when implementing
the PCO Plug-in or
PDA Plug-in.
configuration.properties for
the SVO Plug-In
Yes.
Purpose
l
l
l
l
l
To establish the connection between the
ECC and the PCO Gateway, with which
ECC needs to communicate to exchange
EventBase data.
To indicate whether the communication
between ECC and the Gateway is
secured with SSL.
To activate the SVO Plug-in by
establishing the connection between the
ECC and the SVO Server.
To indicate whether the communication
between ECC and the SVO Server is
secured with SSL.
To specify the refresh interval for
monitoring SLAs.
28 | Chapter 4 Implementing ECC and Its Plug-Ins
4.4.3 Authorizing Users for the SVO Plug-In
This section explains the types of authorizations that users need to be able use the SVO Plug-in in ECC
and work with SLAs.
To work with the SVO Plug-in, a user must have the needed:
l
l
l
Automation Engine Privileges
Automation Engine Authorizations
Policy Orchestrator Authorizations
There are also authorities that you need to grant the runtime user for the SVO Server. These are
described in the Service Orchestrator Installation Guide.
Automation Engine Privileges
To use the SVO Plug-in users must have at least one of the following privileges. Otherwise, they will not
even see the Service Orchestrator perspective button when they log into the ECC.
Give this privilege...
To...
ECC: Access to the Service Orchestrator
All SVO users.
ECC: Manage SLAs and Business Units in Service Orchestrator
Only users who will need to
maintain SLA or business unit
definitions.
In ECC, you grant privileges to users in the Automation Engine/Privileges section of the Users
&Groups function of the Administration perspective. For instructions, see the Enterprise Control Center
User Guide or online help.
Chapter 4 Implementing ECC and Its Plug-Ins | 29
Automation Engine authorizations
Grant users Automation Engine authorizations to the necessary SLA objects and their folders.
Type
Name
Authorizations and Purpose
*
*
R
To see all SLAs that are to be monitored
Do not restrict this authorization to a certain "TYPE"! The TYPE
must be set to "*".
L
Allows Service Orchestrator (SVO) users to define Automation Engine
SLAs for objects with the allowed object types.
The allowed object types are CALL, EVNT (all four kinds: EVNT.FILE,
EVT.TIME, EVNT.DB, EVNT.CONS), JOBF, JOBP, JOBS, SCRI.
In SVO only objects of these types appear in the list for selecting an
object for an SLA.
Do not restrict this authorization to a certain "TYPE"! The TYPE
must be set to "*".
BU
SLA
*
*
R
View business units
W
Create and edit business units
D
Delete business units
R
View SLAs
W
Create and edit SLAs
D
Delete SLAs
In ECC, you grant object authorizations to users in the Automation Engine/Authorizations section of
the Users &Groups function of the Administration perspective. For instructions, see the Enterprise
Control Center User Guide or online help.
Policy Orchestrator Authorizations: Access to EventBases
Users who will maintain or monitor event-based SLAs need PCO authorization to use the related
EventBases. Not all users may need to work with event-based SLAs.
In ECC, you give users access to EventBases by selecting them from a list under the "Authorizations"
heading in the Policy Orchestrator section of the Users &Groups function of the Administration
perspective. For instructions, see the Enterprise Control Center User Guide or online help.
4.5 Implementing the Release Manager Plug-In
This section explains what you need to do to implement the Release Manager Plug-In in ECC.
30 | Chapter 4 Implementing ECC and Its Plug-Ins
4.5.1 About the Release Manager Plug-In
The Release Manager Plug-In is an ECC component that gives you direct access to Automic's Application
Release Automation web application (ARA).
Prerequisite Automic backends
In addition to installing the ECC, you need to have the compatible versions of the following Automic
products installed:
l
l
Application Release Automation
Automation Engine, which provides the following:
o User definitions for ARA including folder rights
o Objects that ARA uses, such as the objects in workflows
About the plug-in
The Release Manager Plug-in does not offer ECC functionality, but rather lets you switch directly from
ECC to the Application Release Automation (ARA) by clicking the Release Manager perspective button
in the ECC Navigator. For complete information about working with ARA, see the online help within ARA
or download the related PDF user guides from the .Automic Download Center (downloads.automic.com)
4.5.2 Activating and Configuring the Release Manager PlugIn
This section describes how to activate and configure Release Manager Plug-in in your ECC installation.
Activating the plug-in
You activate this plug-in in ECC by defining the releasemanager.properties configuration file.
You do not need to do anything else to grant users access to the Release Manager perspective.
Configuration files
The following table summarizes the configuration files related to this plug-in.
Configuration File
Required?
Purpose
releasemanager.properties
Yes
To activate the RM Plug-in by defining the
connection to ARA.
Chapter 4 Implementing ECC and Its Plug-Ins | 31
4.5.3 Authorizing Users for the Release Manager Plug-In
After the Release Manager Plug-In is configured, you do not have to grant any user authorizations to it. All
ECC users can use the perspective button.
No Automation Engine privileges are needed for an ECC user to see the Release Manager perspective.
When it has been activated, the Release Manager perspective button is in everyone's ECC. Whether they
can log into ARA when its log-in page appears depends on their user authorizations.
Again, because the Release Manager perspective is just a link to the ARA log-in page, users do not need
any further authorizations to see or use the perspective button. However, to work in ARA, users will need
Application Release Automation permissions to types and authorizations to folders. These are maintained
in the Users &Groups function of the Administration perspective in ECC or in the embedded Users and
Groups function in ARA Administration. For instructions, see the Enterprise Control Center User Guide or
online help or the ARA Administration Guide.
32
Chapter 5 Configuration in ECC | 33
5 Configuration in ECC
This chapter covers the configuration files that you need to define to implement the ECC and its plug-ins.
For details about which configurations you need for the individual plug-ins, see the related sections in the
chapter Implementing ECC and Its Plug-Ins.
5.1 About Configuring ECC
Part of setting up ECC is to define the necessary configuration files to describe how you want to
implement ECC in your company. You do this when you first install ECC. Later, when ECC is in use, you
can modify the settings as needed.
Main purposes
There are two purposes of configuration files:
l
l
To define technical specifications such as communication channels, timeout intervals for various
processes, and security options.
To activate certain plug-ins
Which files you have to configure
Some of the files in the /webapps/<ECC>/config folder are predefined by Automic with the settings that
ECC needs. For this reason, only the files that you might need to configure are covered in this guide.
Also, some configuration files are needed only for certain plug-ins. If you do not want to use a plug-in, you
do not have configure the related files.
For a list of all files that you might need to configure, see the section Overview: ECC Configuration Files. If
you want to implement ECC with all its plug-ins, use the overview table as a checklist for all the
configuration files you have to set up. If you are implementing only some of the plug-ins see the related
sections in this guide for a summary of the configuration setup for the plug-ins you want to use.
Why some files have .samples at the end of their names
When you install an ECC version, many of the installed configuration files have the extension ".sample"
such as the configuration.properties.sample file. These files are not read by ECC programs unless you
remove the .samples extension.
Delivering ECC with these files offers two functions:
l
l
When you upgrade to a new version of ECC, you will not accidentally override the definitions in your
previous files.
The non-core plug-ins are activated only when a related configuration file is present. So, by
removing the ".sample" extension and configuring the file, you activate the related plug-ins.
Where the configuration files are stored
All configuration files for ECC and its perspectives are installed when you deploy the ECC WAR file. You
can find them on your Tomcat web application server in the folder webapps/<ECC>/config, where <ECC>
34 | Chapter 5 Configuration in ECC
stands for the name of your ECC installation, for example:
C:/Program Files/Apache Software Foundation/Tomcat 7.0/webapps/enterprise.c
ontrol.center/config
Because some configuration files are in subfolders, the exact location of each file is included with the
detail description of the configuration file.
5.2 Overview: ECC Configuration Files
The table in this topic lists all configuration files that you might need to configure and the main purpose of
each file—what it defines or controls.
The following table lists the configuration files for the ECC framework and its plug-ins that you either must
or might want to configure. For instructions about how to configure the files, see the related sections in this
guide.
Configuration files that you should not modify are not included in this table.
Note: In this table the configuration files are organized by the functional areas. However, for easier
lookup, in the table of contents you will find the configuration files listed in alphabetical order.
File
Area
Required?
Main Purpose
configuration.properties
ECC Framework
Yes.
To define aspects of the
communication between the ECC
and the AE, such as the security
options and timeout intervals.
uc4config.xml
- ECC Framework
- AE Plug-in
- SVO Plug-in
Yes.
To define the connection between
ECC to one or more Automation
Engine systems.
navigation.xml
ECC Framework
No. Default
settings are
provided.
To define the order and
appearance of the buttons that
open the ECC perspectives and
external pages.
externalpages.xml
External Pages
perspective
Yes, when you
want to define
access to
external pages.
To define the links to external
functions that you want users to
be able to access from the ECC.
decision.properties
Plug-ins that use
the PCO
backend.
Yes, for the
related plug-ins:
To activate the related plug-ins by
defining the location of the
PCO Gateway, with which
ECC needs to communicate to
exchange EventBase data.
PCO Plug-in
No.
To optionally define custom icons
for the EventBase Description
widget on ECC dashboards.
Yes, for the
SVO Plug-in.
To activate the SVO Plug-in by
defining the connection to the
SVO server.
eventbase.properties
configuration.properties for SVO Plug-in
the SVO Plug-in
- PCO Plug-in
- PDA Plug-in
- SVO Plug-in
Chapter 5 Configuration in ECC | 35
releasemanager.properties Release Manager
Plug-in
Yes, for the
RM Plug-in.
To activate the RM Plug-in by
defining the connection to ARA.
5.3 configuration.properties for the ECC
Framework
In this configuration file you define how the communication between the Automation Engine and the ECC
runs.
Related ECC Products
The ECC framework.
File Location
When you have installed the ECC, you find this configuration file in your Tomcat web application server, in
the folder webapps/<ECC>/config.
Steps...
1. In your Tomcat web server go to the folder …\webapps\<ECC>\config.
2. Rename the file configuration.properties.sample to configuration.properties.
Some configuration files are delivered with the extension "sample" to ensure that your existing
configuration files and their settings will not be overwritten when you update your installation.
3. Open the renamed file and update the configurations as described in the table that follows.
4. After making changes to configuration files, you must stop and restart your Tomcat web server for
those changes to take effect.
Structure
The table that follows explains the structure of the file and describes the parameters and settings with their
possible values.
Parameter
Description
There are three categories of properties,
as follows:
Properties that support
SSL connection security
Provide this information when you want to run the
ECC communication with other UC4 products, such as
the Policy Orchestrator, over a secure socket layer (SSL)
connection.
36 | Chapter 5 Configuration in ECC
truststore*
The path to the SSL truststore, which contains the security
certificate.
Provide this information when you want to run the
ECC communication with other UC4 products, such as the
Policy Orchestrator , over a secure socket layer (SSL)
connection. For information about how to create a truststore
and add a certificate to it.
truststorePassword*
The password for the SSL truststore.
Do not leave the value blank! If you define a truststore
path, then add this parameter and specify a password.
Otherwise, remove it from the file (or mark it as a
comment to disable it).
Properties that control
communication timeouts
automationEngineTimeoutMilliseconds
Do not change any of these values without first
talking to your UC4 Support consultant.
The connection timeout provided by the ECC to the
Automation Engine (AE) API. This timeout applies to most
calls from the ECC to the AE.
Default: 30000
asyncLoadingTimeoutMilliseconds
The timeout interval for all user-facing asynchronous
operations in the ECC timing out, after which a message
appears on the interface to that effect.
Default: 15000
XRequestExecutorTimeoutMilliseconds The connection timeout provided by the ECC to the
Automation Engine (AE) API. This timeout applies to longerrunning asynchronous operations in AE.
Default: 90000
* You need the truststore values only if you want the communication between the ECC and the Automation
Engine to run over a Secure Sockets Layer (SSL).
Example
Here is a sample of the configuration.properties file with all parameters defined. This means that you are
using SSL to secure the communication between the ECC andother Automic products.
truststore = truststore.jks
truststorePassword = 10C122029C6945895C
automationEngineTimeoutMilliseconds = 30000
asyncLoadingTimeoutMilliseconds = 15000
XRequestExecutorTimeoutMilliseconds = 90000
Chapter 5 Configuration in ECC | 37
5.4 configuration.properties for the SVO Plug-In
In this configuration file you define how the communication between the SVO Plug-in in ECC and the
SVO Server runs.
Attention: Do not confuse this with the configuration.properties file for the ECC framework or the
configuration.properties file for the Service Orchestrator server. For information about the latter, see the
Service Orchestrator Installation Guide.
Related ECC Products
l
l
SVO Plug-in (and perspective) for the ECC SVO Server
File Location
When you have installed the ECC, you find this configuration file on your Tomcat web application server,
in the folder webapps/<ECC>/config/servicelevelgovernor.
Caution: There is a second file with the same name in the webapps/<ECC>/config/ folder, but it is
configured differently and has nothing to do with the SVO.
Steps...
1. In your Tomcat web server go to the folder webapps/<ECC>/config/servicelevelgovernor.
2. Rename the file configuration.properties.sample to configuration.properties.
Some configuration files are delivered with the extension "sample" to ensure that your existing
configuration files and their settings will not be overwritten when you update your installation.
3. Open the renamed file and update the configurations as described in the table that follows.
4. Stop and restart your Tomcat web server, to ensure that the changes to the configuration file take
effect.
Structure
The table that follows explains the structure of the file and describes the parameters and settings with their
possible values.
These values must be the same as the ones defined for the same properties in the
slgbackendconnection.properties and the configuration.properties files for the Service Orchestrator
server (backend). For details, see the Service Orchestrator Installation Guide.
Parameter
Description
There are three categories
of properties, as follows:
Properties related to establishing the RMI remote connection to the SVO Server
registryHost
This is the hostname or IP address of the server on which the backend
processes of the Service Orchestrator run.
registryPort
The port on which the RMI registry waits for requests.
Properties that are related to SSL (Secure Sockets Layer) connection security
38 | Chapter 5 Configuration in ECC
enableSSL*
Indicates whether SSL is used for the connection between the SVO Server
and the SVO Plug-in.
Valid values: "true" or "false"
keystorePassword*
The password for the SSL keystore file.
truststorePassword*
The password for the SSL truststore.
Do not leave the value blank! If you are not using SSL
(enableSSL=false) then remove this parameter entirely. If you want use
SSL (enableSSL=true), then add this parameter.
Properties that are related to monitoring activities
monitoringRefreshInterval The frequency in time (seconds) that the Service Orchestrator
automatically refreshes the SLA status information on the Monitoring
views.
Default: 10 seconds
You can also manually refresh the status information with a button on
the Monitoring pages.
Example
registryHost = localhost
registryPort = 1080
enableSSL = true
keystorePassword = --10E3378E27CCE6E27CCE6AC0QQ9
truststorePassword =--10RT45839PQ444481P11594X2VW12
monitoringRefreshInterval = 10
5.5 decision.properties
By configuring this file, you activate the related ECC plug-ins: PCO, PDA, and SVO Plug-ins.
Related Components
All ECC plug-ins that interact with the Policy Orchestrator backend system:
l
l
l
Policy Orchestrator Plug-in
Predictive Analytics Plug-in
Service Orchestrator Plug-in
There is a second decision.properties file on the SVO server, which describes the communication
between the SVO Server and the PCO backend.
Description
All communication between ECC and Policy Orchestrator runs through the PCO Gateway. In the
decision.properties file you specify where the ECC can find the PCO Gateway. You also indicate whether
Chapter 5 Configuration in ECC | 39
the communication between ECC and the Gateway is secured with SSL.
File Location
When you have installed the ECC, you find this configuration file in your Tomcat web application server, in
the folder webapps/<ECC>/config.
Steps...
1. In your Tomcat web server go to the folder …\webapps\<ECC>\config.
2. Rename the file decision.properties.sample to decision.properties.
Some configuration files are delivered with the extension "sample" to ensure that your existing
configuration files and their settings will not be overwritten when you update your installation.
3. Open the renamed file and update the configurations as described in the table that follows.
4. Stop and restart your Tomcat web server, to ensure that the changes to the configuration file take
effect.
Structure
The table that follows explains the structure of the file and describes the parameters and settings with their
possible values.
Parameter Description
host
The host where the PCO Gateway Gateway is running.
Default: hostname
Note for SSL: This must match the hostname with the certificate CN and gateway
hostname that is defined in the UC4.Decision.Gateway.exe.config for the PCO
Gateway.
port
The port for the PCO Gateway
Default: 9898
Note for SSL: If the enableSSL parameter in this file is set to "true" then change this to
"9900". For more information, see Setting Up SSL for Communication with ECC
Components.
path
The base path of your PCO Gateway installation, which is essentially the root path in the
PCO Gateway URL.
Most installations use the default value.
enableSSL Indicates whether SSL is used to access PCO
Valid values: "true" or "false"
For more information, see Setting Up SSL for Communication with ECC Components.
Example
host = localhost
port = 9898
path = Decision.Gateway
40 | Chapter 5 Configuration in ECC
enableSSL = true
5.6 eventbase.properties
Configuring this file is optional. If you want to include icons on your EventBase Description widgets, which
appear on the PCO Plug-in home dashboard, then configure this file to specify where the icons are stored
for each EventBase.
Related Components
l
Policy Orchestrator Plug-in
Description
An EventBase Description widget can contain a description of one PCO EventBase and contains an icon.
If a description appears, this comes from the EventBase properties that are defined in the Modelling Studio
in PCO. If no custom icon is defined, then the default icon appears, as you see on the left below. If you
want to add an icon that identifies the EventBase on the widget (as you see on the right) then you need to
configure the location of the image file in eventbase.properties.
Default widget icon
Customized widget with icon (and description)
File Location
When you have installed the ECC, you find this configuration file in your Tomcat web application server, in
the folder webapps/<ECC>/config.
Chapter 5 Configuration in ECC | 41
Steps...
1. In your Tomcat web server go to the folder …\webapps\<ECC>\config.
2. Rename the file eventbase.properties.sample to eventbase.properties.
Some configuration files are delivered with the extension "sample" to ensure that your existing
configuration files and their settings will not be overwritten when you update your installation.
3. Open the renamed file and update the configurations as described in the table that follows.
4. Stop and restart your Tomcat web server, to ensure that the changes to the configuration file take
effect.
Structure
The table that follows explains the structure of the file and describes the parameters and settings with their
possible values.
Parameter
Description
eb_uri = imagePathAndFile
For each EventBase (one line per EventBase with icon) define the
location of the icon image, by specifying the following:
l
eb_uri
The URI that identifies how to access the EventBase. You find the
URI for an EventBase in the Properties pane in the Modelling
Studio in PCO.
Important: In the Modelling Studio, the URI is preceded by
two slashes (//). Make sure to exclude these in this
configuration. For example:
IF the Modelling Studio has... ENTER this here...
l
///EBExample1
/EBExample1
//Automic/EBExample2
Automic/EBExample2
imagePathAndFile
The URL for the image file for the icon.
If you do not configure an EventBase here, then the widget will have
no icon on it. However, the description from the properties Modelling
Studio (if there is one) is automatically included in the widget without
further configuration.
Example
In this example, icons are defined for two EventBases.If there are other EventBases, then the default icon
appears on their EventBase Description widgets.
/EBExample1 = http://my.domain.com/icon123.png
Automic/EBExample2 = http://automic.com/icon777.jpg
42 | Chapter 5 Configuration in ECC
5.7 externalpages.xml
You can add links to external locations to the ECC Navigator so that you can access Web pages that are
outside the ECC based on your authentication. You do this in the externalpages.xml configuration file.
Related Components
The External Pages perspective, which is a standard perspective in ECC.
Description
By default, the ECC has one button in the Navigator Pane called External Pages that contains one link to
the Automic Homepage and which you can open when you have signed in with Automation Engine
authentication. In the externalpages.xml you can do the following:
l
l
l
Change the page (web URL) that this button opens.
Change the authentication requirements.
Add more pages to a button.
If you have multiple pages defined for an external page button (Package element), then when the
user clicks on the button, a list of the pages appears in the main part of the Navigator Pane.
l
Add more external pages buttons.
Each button (Package element) can have authentication requirements. These apply to all pages
defined for that button.
More customization options in the navigation.xml
To define the label and icons that appear on buttons and specify the sequence of the buttons in the
Navigator, see navigation.xml. If you do not define these parameters there, then the button appearance will
have the following default values:
l
l
The button label will come from the name attribute of the Package element in the
externalpages.xml.
The button will be at the end of the list.
If there are other installed perspectives that are not defined in the navigation.xml, then these
will all appear at the end of the list in alphabetical order.
l
l
The icon on the button will be a folder
.
If more than one button is defined, they appear in alphabetical order by the name attribute of the
Package element in the externalpages.xml.
The navigation.xml lets you modify how the buttons appears, but not the page links that are included in
each button. These are only defined here.
File location
When you have installed the ECC, you find this configuration file in your Tomcat web application server, in
the folder webapps/<ECC>/config.
Chapter 5 Configuration in ECC | 43
Structure
The following table explains the structure of the XML file and describes the parameters and settings with
their possible values:
Element / Parameter
Description
<ExternalPages>
File beginning.
<Package
Beginning of the <Package> element section.
Add one Package section for each button with external page
links.
If you want to have no external page buttons at all, then delete
all Package elements.
name = "name"
The default label for the button.
This is the text that appears on the button. If you have more
than one <Package> element then the buttons appear in
alphabetical order according to this name. Both of these
default behaviors are overridden if you configure this button in
the navigation.xml file. In this case, the following is true:
l
l
l
decisionauthenticationRequired =
"true/false"
uc4authenticationRequired =
"true/false">
The id attribute in the corresponding <entry> element
must match the name attribute here.
The sequencing of buttons that is defined in the
navigation.xml is used.
You can provide language-dependent labels.
These two parameters control which kind of authentication
method a user must login to the ECC with for the button to
appear.
Allowed values:
l
l
true
false
When one is set to "true" and the other to "false" then the user
sees the button only when logging in with the authentication
method that is set to true.
When both are set to "true" then the user has to have both
authentications. This means that the user logs in with an
Automation Engine authentication that in the background also
confirms the Decision authentication for the user.
If both are set to "false" then the button appears regardless of
which kind of authentication the user logs in with.
44 | Chapter 5 Configuration in ECC
<Page name = "pagename"
url = "url" icon="iconurl" />
The destination of an external page link.
Each external page button can provide one or more links.
Define one <Page> element for each link related to button that
the parent <Package> element defines. The links appear in
the Navigator in the order that they are defined here.
Parameters:
l
name
When the related external page button is clicked, this
label appears on the link in the main part of the
Navigation pane and also on the tab in the Main Pane.
This label is the same regardless of which language
the user logs in with.
l
l
url
The URL to the destination page that you want to open.
You must use the entire name including http:// or
https://.
icon
(Optional) The URL that contains the icon appears next
to the name of the page. This appears both in the main
part of Navigator pane and on the tab in the Main Pane.
The default is the Automic icon.
</Package>
End of the <Package > element.
This XML tag must be at the end of each <Package> element.
</ExternalPages>
End of the <ExternalPages> element.
This XML tag must be at the end of the file.
Example:
In this example that follows there are two <Package> elements, which means that two external page
buttons are defined and will appear in the Navigator if the user fulfills the authentication requirements when
logging in.
l
l
The first one is the default button that contains one link to the UC4 homepage. However, this button
appears only when the user logs in with UC4 Automation Engine authentication.
The second button and will appear in the Navigator only when the user logs in with UC4 Decision
authentication that in also confirms Decision authentication for the user.
Use the navigation.xml to control where the button appears in the list of buttons in the Navigator and to
define the label that appears on the button. If it is not also defined in the navigation.xml, the name on
the button comes from the "name" attribute here and the button appears at the end of the list of buttons
with any other buttons that are not defined there.
<ExternalPages>
<Package name = "External Pages" decisionauthenticationRequired =
"false"
uc4authenticationRequired = "true">
<Page name = "UC4" url = "http://www.uc4.com"
icon="http://mdimg.uc4.netdna-cdn.
Chapter 5 Configuration in ECC | 45
com/favicon.ico" />
</Package>
<Package name = "External Pages_1" decisionauthenticationRequired =
"true"
uc4authenticationRequired = "false">
<Page icon="http://mdimg.uc4.netdna-cdn.com/favicon.ico"name
="Calendar url =
"http://www.mycompanycalendar.com"/>
<Page icon="http://mdimg.uc4.netdna-cdn.com/favicon.ico"name
="Glossary"url =
"http://www.mycompanyglossary.com"/>
<Pageicon="http://mdimg.uc4.netdna-cdn.com/favicon.ico"name
="Address Book"
url ="http://www.mycompanydirectory.com"/>
</Package>
</ExternalPages>
5.8 navigation.xml
Configuring this file is optional. The navigation.xml file allows you to modify the appearance of the
buttons in the ECC Navigator.
Related Components
All ECC perspectives
Description
The navigation.xml does not control which buttons appear in the Navigator Pane. It can control only some
aspects of the appearance of the buttons, such as the button label, which icons appear and the sequence
of the buttons. All perspectives that are installed and all external pages that are defined (in
externalpages.xml) will have buttons in the Navigator Pane regardless of what is defined here. If they are
not also defined here, they will just have the default label, icon and placement in the Navigator Pane.
Use the navigation.xml to optionally do any of the following:
l
l
For buttons for ECC perspectives:
o Change the icon that appears on a button.
o Change the order in which the buttons are listed.
o Define a new label for a button. You can define both an English and German label.
For an external pages button:
o Define the label for buttons in both English and German
o Define the icon that appears on the button
o Specify its placement in the list of buttons.
You must also define each external page in externalpages.xml.
46 | Chapter 5 Configuration in ECC
File Location
When you have installed the ECC, you find this configuration file in your Tomcat web application server, in
the folder webapps/<ECC>/config.
Structure
The table that follows explains the structure of the XML file and describes the parameters and settings with
their possible values.
You will notice that in the main element, <plugin> has an optional <entry> sub-element. You use this subelement only when the plugin has more than one button in the Navigator Pane so that you can define
different icons and the placement for each button. There are only two of these group <plugin> elements for
ECC:
l
l
The <plugin> element for Process Automation (id="processautomation"), which includes the
following three buttons:
o Service Catalog
o Process Monitoring
o Process Assembly
The <plugin> element for external page buttons (id="externalpages"), which by default only has one
button, but you can define more buttons in externalpages.xml
Element / Parameter
Description
<navigation
>
File beginning
This XML element must be present.
Chapter 5 Configuration in ECC | 47
<plugin id="perspective" index="99"
icon="iconName"/>
If a <plugin> element includes
subordinate <label> elements, use " >"
instead of "/>" at the end of this line.
Also make sure to add an </plugin> tag
after all the <label> elements.
A <plugin> element for one ECC plugin.
Use this syntax for a single plugin to correspond to one
button in the Navigator. For the syntax for a plugin group,
see the next row in this table.
l
id
The unique string that identifies the perspective
button.
Valid values:
l
processautomation = the Automation Engine
Plug-in bundle
servicelevelgovernor = the Service Orchestrator
perspective
decision = the Policy Orchestrator perspective
administration = the Administration Perspective
icon
The name of the icon that appears on the button.
See "Available Icons for Navigator Buttons" for a
list of the icons that you can use.
If you do not define an icon or the name is invalid,
the default icon, a folder
l
, will be used.
index
The number that determines the position of the
button in the Navigator. When two perspectives
have the same index number, then they will appear
in alphabetical order based on their id values.
If there is no index number defined, then the button
appears at the bottom of the Navigator.
For a the Automation Engine Plug-in perspectives and
the External Pages perspective use separate <entry>
elements, as described in the next two rows of this
table.
48 | Chapter 5 Configuration in ECC
<plugin id="pluginName" >
The start of a group <plugin> element. Each group can
define one or more buttons in their <entry> elements.
l
id
The unique string that identifies the group plugin.
Valid values:
processautomation = the Automation Engine
bundle, which is composed of the Service Catalog,
Process Monitoring and Process Assembly
perspectives (see the <entry> description).
externalpages = External page buttons. ECC is
delivered with one standard External Pages button.
l
index
A number that determines the position of the button
in the Navigator. When two elements have the
same index number, then their corresponding
buttons will appear in alphabetical order based on
their id values. If there is no index number defined,
then button appears at the bottom of the Navigator.
l
icon
The name of the icon that appears on the button.
See "Available Icons for Navigator Buttons" for a
list of the icons that you can use.
If you do not define an icon or the name is invalid,
the default icon, a folder
, will be used.
Chapter 5 Configuration in ECC | 49
<entry id="perspectiveOrExternalPage"
index="99" icon="iconName"/>
If an <entry> element includes
subordinate <label> elements, use " >"
instead of "/>" at the end of this line.
Also make sure to add an </entry> tag
after all the <label> elements.
Only for group <plugin> elements.
Define one <entry> element for each button, for the
Process Automation plugin and for external pages. (See
"Example 1" after this table.)
l
perspectiveOrExternalPage
Unique string that identifies the perspective button.
Valid values within the <plugin
id="processautomation" > plugin group element:
automation = perspective: Service Catalog
monitoring = perspective: Process Monitoring
development = perspective: Process Assembly
Allowed values for <plugin id="externalpages" >:
These must match the name attribute in a Package
element in externalpages.xml.
Default: External Pages
l
icon
The name of the icon that appears on the button.
See "Available Icons for Navigator Buttons" for a
list of the icons that you can use.
If you do not define an icon or the name is invalid,
the default icon, a folder
l
, will be used.
index
The number that determines the position of the
button in the Navigator. When two perspectives
have the same index number, then they will appear
in alphabetical order based on their id values.
If there is no index number defined, then the button
appears at the bottom of the Navigator.
50 | Chapter 5 Configuration in ECC
<label
language="Language">
labelText</label>
Optional element
Use this to define alternative button labels based on the
language that the user logs in with. If you do not define
this element, the default label will be used. For
perspectives internally defined. For external pages, it is
the value in the name attribute in the corresponding
Package element in externalpages.xml.
You can add a <label> element wherever you define a
button. That means <plugin> elements for a single
perspective and <entry> elements within a group <plugin>
element. (See "Example 2" after this table.)
l
Language
The login language that labels Language that
should be used for the specified name.
Allowed values:
d = German
e = English
l
labelText
The button label
</entry>
End of the <entry > element.
Must be present when a <entry> element includes
subordinate <label> elements.
</plugin>
End of the <plugin> element.
Must be present when a <plugin> element includes
subordinate <entry> or <label> elements.
</navigation>
End of the <navigation> element.
This XML element must be present.
Example 1—The standard setup plus one more external pages button
In the following example code below, based on their index numbers, perspective buttons in the ECC
Navigator will appear in the following order:
1.
2.
3.
4.
5.
6.
7.
8.
Service Catalog
Process Monitoring
Process Assembly
Service Orchestrator
Decision
Administration
External Pages
My Company Tools
Notice the following:
l
l
All except the last are standard buttons.
There are two standard plugin groups, "process automation" and "externalpages". Remember, you
must use the plugin group structure for the respective plug-in entries.
Chapter 5 Configuration in ECC | 51
l
l
In this example, there are two buttons for external pages, the default one and one for "My Company
Tools."
The labels for the two external pages depend on whether the user logs in using English or German.
In this example, the icons and sequence assigned to the perspectives and to the standard external
pages button are all the ECC defaults.
You must use the id values that you see here for every ECC perspective and for the externalpages
plugin group. In the delivered navigation.xml, you will find comments that tell you which perspective
each plugin and entry element corresponds to.
<navigation>
<plugin id="processautomation">
<entry id="automation" icon="gear" index="0"/>
<entry id="monitoring" icon="monitor" index="1"/>
<entry id="development" icon="process" index="2"/>
</plugin>
<plugin id="servicelevelgovernor" icon="dashboard" index="3"/>
<plugin id="decision" icon="decision" index="4"/>
<plugin id="administration" icon="wrench" index="5"/>
<plugin id="externalpages">
<entry id="External Page" icon="globe" index="6">
<label language="d">Externe Seiten</label>
<label language="e">External Pages</label>
</entry>
<entry id="External Page" icon="heart" index="6">
<label language="d">Meine Firmenwerkzeuge</label>
<label language="e">My Company Tools</label>
</entry>
</plugin>
</navigation>
Example 2—Custom labels for standard buttons
In this example, you see all the standard perspective buttons. However, instead of the default labels on
buttons, custom labels will appear in the Navigator. The label will be different depending on the language
the user logs in with. The labels that are replaced are
l
l
"Service Catalog” (id="automation")
"Policy Orchestrator" (id="decision")
<navigation>
<plugin id="processautomation">
<entry id="automation" icon="gear" index="0">
<label language="e">Process Automation</label>
<label language="d">Prozessautomatisierung</label>
</entry>
<entry id="monitoring" icon="monitor" index="1"/>
<entry id="development" icon="process" index="2"/>
</plugin>
<plugin id="servicelevelgovernor" icon="dashboard" index="3"/>
52 | Chapter 5 Configuration in ECC
<plugin id="decision" icon="decision" index="4"
<label language="d">Rule Management</label>
<label language="e">Regelverwaltung</label>
plugin/>
<plugin id="administration" icon="wrench" index="5"/>
<plugin id="externalpages">
<entry id="External Page" icon="globe" index="6">
<label language="d">Externe Seiten</label>
<label language="e">External Pages</label>
</entry>
</plugin>
</navigation>
5.8.1 Available Icons for Navigator Buttons
The following table contains the icons that you can assign to the buttons for the perspectives and external
pages in the Navigator Pane. To use an icon, enter the name in the icon parameter in the <plugin> or
<entry> element. You can reuse the same icons. If you do not select an icon, or the name that you enter is
invalid, then the button will have the default icon, a folder
For...
Enter...
For...
Enter...
.
For...
Enter...
activity
admin
airplane
alarm
attachment
attention
bar-chart
book
bookmark
briefcase
brightness-plus
brush
bubble
bug
bulb
calculator
calendar day
calendar month
car
cart
checked
clock
cloud
cloud-down
cloud-up
dashboard
database
decision
display
dollar
Chapter 5 Configuration in ECC | 53
For...
Enter...
For...
Enter...
For...
Enter...
euro
eye
favorite
flag
flash
folder
gear
globe
heart
history
home
image
import
info
label
license
line-chart
link
list
locked
login
mind-map
monitor
multiply
next
notepad
ok
page
percent
phone
picker
pie-chart
position
process
puzzle
rate-up
redo
reload
repeat
report
right
security
share
shuffle
sync
table
temperature
thumbnails
timer
total
truck
wizard
wrench
54 | Chapter 5 Configuration in ECC
5.9 releasemanager.properties
By configuring this file, you activate the Release Manager perspective in the ECC, and enable direct
access to the Application Release Automation (ARA) web application from the ECC. Here you configure
the ARA instance that you access.
Related Components
l
l
The Release Manager plug-in and perspective in ECC
Application Release Automation
Description
The Release Manager Plug-in does not offer ECC functionality, but rather lets you switch directly from
ECC to the Application Release Automation (ARA) by clicking the Release Manager perspective button
in the ECC Navigator.
Required additional configuration in ARA: In the customer.config file in ARA, you must also
define the URL for the ECC installation, so that ARA can also have access to the ECC. Otherwise,
you will be able to switch from ECC to ARA but you will have no access to the ECC functions that are
embedded in ARA, such as Process Assembly, Process Monitoring, or user management. For details
about the configuring that file, see theApplication Release Automation Installation Guide.
File location
When you have installed the ECC, you find this configuration file in your Tomcat web application server, in
the folder webapps/<ECC>/config.
Steps...
1. In your Tomcat web server go to the folder …\webapps\<ECC>\config.
2. Rename the file releasemanager.properties.sample to releasemanager.properties.
Some configuration files are delivered with the extension "sample" to ensure that your existing
configuration files and their settings will not be overwritten when you update your installation.
3. Open the renamed file and update the configurations as described in the table that follows.
4. Stop and restart your Tomcat web server, to ensure that the changes to the configuration file take
effect.
Structure
The table that follows explains the structure of the file and describes the parameters and settings with their
possible values.
Parameter
Description
url
The link to the instance of the ARA web application that you want to access from ECC.
timeout_
millis
The maximum time (milliseconds) that ECC should try to establish a connection to the
ARA instance.
Default: 30000
Chapter 5 Configuration in ECC | 55
Example
Here is an example of a configured releasemanager.properties file.
url = http://rmhost/rm-ecc
timeout_millis = 3000
5.10 uc4config.xml
In this configuration file, you define the connections to the AE systems that the AE Plug-in and its
perspectives can access. Without this configuration, you will not be able to work with the perspectives of
the AE Plug-in.
Related Components
l
l
The following ECC plug-ins
o Administration Plug-in
o AE Plug-in
Automation Enginebackend
File Location
When you have installed the ECC, you find this configuration file in your Tomcat web application server, in
the folder webapps/<ECC>/config.
Steps...
1. In your Tomcat web server go to the folder …\webapps\<ECC>\config,
2. Rename the file uc4config.xml.sample to uc4config.xml.
Some configuration files are delivered with the extension "sample" to ensure that your existing
configuration files will not be overwritten when you update the ECC installation.
3. Open the renamed file and update the configurations as described in the table that follows.
4. Stop and restart your Tomcat web server, to ensure that the changes to the configuration file take
effect.
Structure
The table that follows explains the structure of the file and describes the parameters and settings with their
possible values.
Parameters
Description
<configuration>
The beginning of the configuration.
<logging
count="
count"></logging>
The definitions for the log file.
These values are set by Automic. Do not change them unless explicitly told to
do so by Automic Support.
56 | Chapter 5 Configuration in ECC
<trace
count="count"
xml="XML
trace"></trace>
The definitions for the trace file.
<connections>
The beginning of the elements for the connections to the AE systems.
These values are set by Automic. Do not change them unless explicitly told to
do so by Automic Support.
<connection
The definition of the connection to a AE system.
name=name"
Name = Alias for the connection to a AE system. In the ECC's login window, you
system="system">
can select the connection by using this name (selection field Connection).
System = Name of the AE system. The name of the AE system is defined in the
Automation Engine's INI file.
Important: Every connection must have a unique system definition.
<cp ip="DNS/IP"
port="Port"/>
Definition of the connection to the AE system's communication process (CP).
DNS/IP = Specifies the name or the IP address of the computer on which the
communication process runs.
Port = Port number of the communication processes in the AE system.
If you define more than one CP for a connection, the system will try to connect to
the first CP in the list, and if it fails, then the system will try the next and so on,
until it can connect successfully.
For more information about the communication processes in AE, see
"Establishing a Connection" in the Inside Automation Engine help or PDF.
</connection>
The ending of the XML element <connection>.
</connections>
The ending of the XML element <connections>.
</configuration>
The ending of the XML element <configuration>.
Example:
<configuration>
<logging count="10"></logging>
<trace count="10" xml="0"></trace>
<connections>
<connection name="AE Prod" Production" system="AEPROD">
<cp ip="aehost01" port="2217"/>
<cp ip="aehost01" port="2219"/>
<cp ip="aehost01" port="2220"/>
</connection>
<connection name="AE Test" system="AETEST">
<cp ip="testsys" port="2217"/>
</connection>
</connections>
</configuration>
Chapter 6 Setting Up SSL for Communication with ECC Components | 57
6 Setting Up SSL for Communication
with ECC Components
You can secure any of the communication channels between the ECC-related components and Policy
Orchestrator by running them over an SSL connection. You setup for SSL connections in various
configuration files. This topic describes the connections that you can secure with SSL and which
configuration files ensure the SSL connection at each of these junctions.
The following figure shows you all the places that you can secure with an SSL connection and the
configuration files that control the SSL connections.
Overview of SSL connection options between the ECC and Policy Orchestrator
6.1 Overview of the SSL Setup Steps
This topic gives you an overview of the steps you need to take to secure the connection between ECC and
PCO with an SSL connection, and provides links to the instructions for each step.
To set up any SSL connection for ECC-related components, you have to do the following:
1. Configure the Policy Orchestrator Gateway Gateway for SSL
2. Add Truststore Certificates for SSL
3. Enable SSL for the Policy Orchestrator Plug-in
58 | Chapter 6 Setting Up SSL for Communication with ECC Components
For instructions for each of these steps, see the related sections that follow.
6.2 Configuring the Policy Orchestrator
Gateway for SSL
If you want to use SSL to secure any communication connection between an ECC-related component and
the Policy Orchestrator, then you need to configure the PCO Gateway for SSL using the steps here.
Prerequisite:
Before you set up the PCO Gateway for SSL, make sure that your target machine already has a certificate
and password that are available to use for SSL. For more information, consult your system administrator.
Steps...
1. Get the signature of your certificate by opening its properties and copying its thumbprint.
In the following screen you see certificate details including the Thumbprint value.
Certificate properties dialog
2. Configure a port with an SSL certificate.
For more information and instructions see
http://msdn.microsoft.com/en-us/library/ms733791.aspx
Chapter 6 Setting Up SSL for Communication with ECC Components | 59
3. Overwrite the existing UC4.Decision.Gateway.exe.config in the PCO Gateway directory with
UC4.Decision.Gateway.exe-ssl.config in the same directory.
4. Restart the PCO Gateway.
Next step: Adding Truststore Certificates for SSL.
6.3 Adding Truststore Certificates for SSL
An SSL connection between any ECC components and/the Decision Gateway need truststore
certificates. The steps here describe how to add the truststore certificates that you need for the
connections that you want to secure.
1. Go to the command line (CMD).
2. Enter the following command to add a certificate to the truststore that is specified in the ECC
configuration.properties file (in the folder ...\<ECC>\config...):
keytool -import -v -trustcacerts -alias <alias> -file <certificate> keystore <ECC>\config\truststore.jks –password <bundle>
In this string:
l
l
l
l
<alias> should be the hostname of your PC.
<certificate> is the exported certificate file that you should already have.
<ECC> is the path to your ECC installation.
<password> is the truststorePassword that is specified in your ECC
configuration.properties file.
Next step: Enabling SSL for the Policy Orchestrator Plug-in
6.4 Enabling SSL for the Policy Orchestrator
Plug-in
Use these steps to configure ECC for an SSL secured connection between the PCO Plug-in component in
the ECC and Policy Orchestrator.
Steps...
1. Modify the configuration of the decision.properties file for SSL.
a. In your Tomcat web server, go to the folder …\webapps\<ECC>\config, where <ECC>
stands for your ECC installation folder.
b. Rename the decision.properties.sample file to decision.properties.
c. Open the decision.properties file and update the following parameters:
Parameter Description
port
The port for the PCO Gateway.
The default port for the PCO Gateway when SSL is enabled is "9900". If
yours is different, change it here.
60 | Chapter 6 Setting Up SSL for Communication with ECC Components
Parameter Description
enableSSL Change this to "true"
This indicates that SSL is used to control the access to Policy Orchestrator.
2. Restart the Apache Tomcat service so that the configuration changes go into effect.
This is communication path that begins with (1) in the illustration in Setting Up SSL for Communication
with ECC Components.
Chapter 7 Upgrading to ECC 1.9 | 61
7 Upgrading to ECC 1.9
Upgrading an existing ECC installation to a new release upgrades the ECC framework and all its plug-ins
at the same time. Use the same steps to install hot fix packages between releases.
Overview
To upgrade from Enterprise Control Center1.6, 1.7, or 1.8 to 1.9 or involves the following steps:
1.
2.
3.
4.
Backing up your current configurations
Upgrading Apache Tomcat
Deploying the new ECC WAR file
Carrying over your saved configurations
No data migration is needed.
Steps...
To upgrade Enterprise Control Center ECC 1.6, 1.7, or 1.8 to ECC 1.9 use the following steps:
1. Stop the Apache Tomcat web server that the current ECC is running on.
2. Make safety copies of the configuration files, that are already defined with your preferences.
l
From the folder webapps/<ECC>/config:
o configuration.properties
o decision.properties
o eventbase.properties
o externalpages.xml
o navigation.xml
o releasemanager.properties
o uc4config.xml
l
From the folder webapps/<ECC>/config/servicelevelgovernor:
o configuration.properties
If you do not see all the files that are listed, it means that you probably do not have all plug-ins
implemented. Just copy the files that are there. Note also that there are additional files in these
folders, but they are pre-defined by Automic, and you do not need to touch them.
3. Upgrade the Apache Tomcat web application server where you have ECC currently installed to the
latest version that complies with the new release.
a. Check the System Requirements to see which version of Tomcat you need.
b. Go to the Tomcat home page and then download and install the required version. You will
find the installation instructions and other relevant information on their home page.
http://tomcat.apache.org/index.html
Recommended: Install the 64-bit version of Tomcat and JAVA Runtime Environment
(JRE) on a 64-bit operating system.
c. This is a good time to increase the amount of memory that Tomcat is allowed to allocate.
Increasing the memory allocation settings to the maximum available on your hardware will
optimize ECC performance.
62 | Chapter 7 Upgrading to ECC 1.9
This is only possible on a 64-bit version of Tomcat, which needs a 64-bit JRE and 64-bit
operating system, as recommended above.
d. To improve performance on browsers with poor connections, adapt your Tomcat
configuration so that Tomcat uses the NIO2 connector and the upload timeout attribute is
enabled.
To do this, open the <Tomcat>/conf/server.xml file and edit it as follows:
Before:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" />
After:
<Connector port="8080"
protocol="org.apache.coyote.http11.Http11NioProtocol"
connectionTimeout="20000"
redirectPort="8443"
disableUploadTimeout="false"
connectionUploadTimeout="10000"/>
For complete information about the Tomcat connector configuration attributes, see
https://tomcat.apache.org/tomcat-7.0-doc/config/http.html.
e. Copy or move the ECC WAR file into the webapps folder in your Tomcat installation, and
Tomcat will deploy it automatically.
f. Create and start a Windows service for Tomcat so that it is automatically started when you
start the physical server that it is installed on.
g. Make sure that Tomcat automatically starts when you start the server that it is installed on,
for example, with a Windows service or an init script.
h. Start Tomcat.
4. Deploy the new version of the ECC on Tomcat.
a. From the Automic Download Center (downloads.automic.com), download the most recent
version of the Enterprise Control Center 1.9 package.
The name of the WAR file will also be in the name of your ECC installation. If you want to
use a different name, change the name of the WAR file now, keeping the "war"
extension.
b. There are two ways to deploy the ECC.
l
With the Tomcat Manager web application. See the Tomcat website for instructions.
l
Manually:
i. On the server where you have Tomcat installed, copy the file
uc4.enterprise.control.center.war file that you downloaded to the webapps
folder of the Tomcat installation.
ii. If your Tomcat service is running, the WAR file will be deployed automatically.
A new folder named "uc4.enterprise.control.center" is created in the webapps folder.(If
you changed the WAR file name, then the new folder has that name.)
Do not delete the WAR file! If you do, Tomcat will also remove the corresponding
subfolder,which also undeploys the ECC!
Chapter 7 Upgrading to ECC 1.9 | 63
5. Configure your upgraded ECC.
a. Restore your previous configurations by copying the safety copies of the configuration files
to the same location in the folder webapps/<ECC>/config, where <ECC> is the name of
ECC installation.
Also restore the subfolder servicelevelgovernor and its configuration.properties file, if you
have been using SVO and have saved the file.
b. Now is a good time to check your configurations and make any modifications that you would
like to implement. Use the descriptions of the configuration files to help you. See Overview:
ECC Configuration Files.
c. Stop and restart your Tomcat web server, to ensure that the changes to the configuration file
take effect.
ECC 1.9 web application is now installed and ready to use.
If users have display problems, see the section Troubleshooting Display Problems.
64
Chapter 8 Troubleshooting Display Problems | 65
8 Troubleshooting Display Problems
Users may have display problems if their Internet browser has cached the old ECC stylesheet.
Troubleshooting tip for display problems: Retrieve latest stylesheet
If you or your users notice display problems, like text being cut off on buttons, labels and links, this means
that the Internet browser is not using the latest version of the ECC stylesheet. This happens because the
cache of the browser has stored the previous ECC stylesheet and continues to use it.
To solve this problem, empty the cache of the browser and login to the ECC again. For instructions about
how to do this, see the user help for your internet browser. For example, for Microsoft Internet Explorer,
you can do this by pressing Ctrl + F5.
66
Enterprise Control Center Installation Guide | 67
Release Notes for the Enterprise
Control Center Version 1
The following is the change history of the framework functionality of the Enterprise Control Center (ECC)
Version 1.0 to 1.9 major and minor releases. For the change history of the plug-in components, see the
release notes for the individual components.
Always the Latest Documentation
The latest version of the online help and PDF documentation for ECC are now available under
ONE Automation Platform on docs.automic.com. By default, the link in the ECC title bar to the online help
opens the same, current online help from the website, so you get the latest available information.
However, the Release Notes and PDF documentation that are delivered as part of the ECC 1.9 WAR file
are a permanent part of the package and cannot be changed. When changes are needed, the
documentation will be updated and uploaded to docs.automic.com for your immediate availability.
Also valid for ECC 1.7 and 1.8
Please note that the information in the documentation for ECC 1.9 is also valid for ECC 1.7 and ECC 1.8.
Version 1.9.0
ECC version 1.9.0 contains no new features nor modifications to the ECC functionality, only bug fixes. For
a description of the bug fixes, see the package description on the Automic Download Center
(downloads.automic.com).
Version 1.8.0
ECC version 1.8.0 contains no new features nor modifications to the ECC functionality, only bug fixes. For
a description of the bug fixes, see the package description on the Automic Download Center
(downloads.automic.com).
68 | Release Notes for the Enterprise Control Center Version 1
Version 1.7.0
In addition to bug fixes, the following change was made to the packaging and delivery of ECC version
1.7.0. For a description of the bug fixes, see the package description on the Automic Download Center
(downloads.automic.com).
Enhancement
1 WAR file includes all plug-ins
Important: Do not try to install plug-ins separately!
The ECC framework and all its plug-ins are delivered in one WAR file and installed at the same time.
Prior to ECC 1.7, the application plug-ins were packaged separately and you had to download and install
them individually.
Although all plug-ins are installed, the optional plug-ins are not activated until your system
administrators configure them and grant users the required privileges and authorities. Information about
activating and configuring each plug-in is described in the related parts of the ECC Installation Guide.
Note: The Service Orchestrator (SVO) server is still a separate product that you need to download
and install separately, but its frontend, the SVO Plugin is part of the ECC WAR file.
Version 1.6.0
ECC version 1.6.0 contains no new features nor modifications to the ECC functionality, only bug fixes. For
a description of the bug fixes, see the package description on the Automic Download Center
(downloads.automic.com).
Version 1.5.0
ECC version 1.5.0 contains no new features nor modifications to the ECC functionality, only bug fixes. For
a description of the bug fixes, see the package description on the Automic Download Center
(downloads.automic.com).
Version 1.4.0
The following features were added with ECC 1.4. They include features that were released with the ECC
1.3.1 hotfix package.
Enterprise Control Center Installation Guide | 69
New Features / Modifications
Alerts for asynchronous prompts
When asynchronous prompts are triggered, a button to alert you and let you open the related prompts
dialog appears in the header bar.
Dynamic combo boxes in prompts dialog
In a prompt set, valid values for one prompt (for example, Prompt_B) might be dependent on the value in
another prompt (Prompt_A). When this is the case, as soon as you enter a value in Prompt_A, the
selection of values for the dependent Prompt_B is limited to only the relevant values.
Reverse proxy support
ECC can now be used over a reverse proxy. (Tested with IIS 7.5 and Apache HTTPD 2.2.)
Fixed: For the Release Manager Plug-in, connections stay open in embedded mode
When using the Release Manager Plug-In in ECC, which embeds the ECC in the Application Release
Manager (ARA), the connections to the Automation Engine are no longer periodically broken
Version 1.3.0
The product Release Manager has been renamed to Application Release Automation and is split into the
products Release Orchestrator and Deployment Manager.
New Features / Modifications
General performance and usability improvements
l
l
l
Several optimizations in loading and rendering data
Improved error handling
Access to and interaction with the UserInterface is now faster because Individual module
contents are now loaded asynchronously.
Browser back/forward button support
The ECC now allows navigating back and forth via the web browser’s back and forth navigation
capabilities. In addition, the new URL handling allows creating bookmarks to directly navigate to a
particular view.
Support for multiple browser windows
It is now possible to open the ECC in multiple browser windows or tabs and to log in with different users
in parallel on the same workstation. For example, you can now keep different contents open in different
tabs while monitoring or editing workflows.
Navigation from home dashboard
It is now possible to navigate from the home dashboard directly to the individual contents, for instance
by clicking on a queue in process monitoring.
Improvements in user management for Application Release Automation users
The synchronization between ARA credentials and Automation Engine authorizations has been
improved. When synchronizing folder permissions in the ARA section of user settings, all necessary AE
authorizations as well as privileges are now set automatically to guarantee consistent security
configurations for users and groups.
70 | Release Notes for the Enterprise Control Center Version 1
Workflow editor, monitor anduser management for Application Release Automation users
Workflows can now be edited and monitored and users and their rights directly be configured within the
ARA web application. This means no switching is required between the two web applications ECC and
ARA - the functions are all available within one application.
New maximization mode
A new button in the top-right corner hides the header and expands the content area to provide maximum
space for monitoring or editing workflows.This is very useful for editing huge workflows.
Version 1.2.0
The following features were added with ECC 1.2.
Enterprise Control Center Installation Guide | 71
New Features / Modifications
The user management capabilities for the Release Manager was enhanced with the following:
l
The Rights page has been renamed to Permissions. As in the previous version, here you can
grant users and user groups permission to create main and custom types in the Release
Manager.
The ability to grant "read" rights to these types has been removed because it was superfluous.
l
l
A new Folder Authorizations page was added and provides you with the following functionality:
o You can give users and user groups rights to work with Release Manager folders. These
include rights to read, use, write, execute, and delete objects in the folders.
o You can create new Release Manager folders. All changes to folders are immediately
synchronized with theRelease Manager. This ensures that all users have the real time
folder status. You can choose which folders are also synchronized with the Automation
Engine.
o You cannot delete folders that are not empty.
A new Approvals page was added.
Here you can define approval subscriptions for users and user groups. In the subscriptions you
specify the characteristics of the activities that are included. When a matching activity is
planned, the user or the user groups users are notified by the Release Manager to approve the
activity before it can be further processed.
New functionality was build into the Navigator pane for better usability:
l
l
l
Collapsible perspective buttons
o The buttons in the Navigator pane can be collapsed to allow more space in the pane for
the central area.
o Icons have been added to each perspective button, so they can be recognized when they
are collapsed..
o You can configure which icons appear for each perspective.
Collapsible functional area buttons
o The buttons for functional areas can also be collapsed and expanded to allow more space
in the pane for the central area.
o When there are more than three functional area buttons , you can scroll horizontally to see
the hidden ones.
Text on mouse over
o Names of collapsed perspectives appear on mouse over.
o Additional object details appear on mouse over.
Version 1.1.0
The following features were added with ECC 1.1.
New Features / Modifications
New perspective: Administration
This contains user management functions to maintain user and user groups definitions for the
Automation Engine, Decision, and the Release Manager all from the ECC. This is possible because of
the new UC4 integrated authentication capabilities.
72 | Release Notes for the Enterprise Control Center Version 1
Version 1.0.0
This is the first release of the Enterprise Control Center (ECC).
New Features / Modifications
The plug-ins and perspectives of other products (such as the Automation Platform or UC4 Decision) can
now be included.
Standard perspective: External Pages.
It can be used to list and administer links to websites outside of the ECC.
The User documentation is provided in WebHelp format (you open it directly in the ECC, the available
languages are English and German).
An Installation Guide and the System Requirements are provided as PDFs (in English and German).
Bug Fixes
For detailed and up-to-date information, see the Patch Descriptions section on the Automic Download
Center (downloads.automic.com).
Known Issues
This section contains information about the known bugs that have not yet been resolved and, in many
cases, also descriptions of workarounds for them.
For detailed and up-to-date information, see the Known Bugs & Workarounds section on the Automic
Download Center (downloads.automic.com).
Glossary
This topic provides brief definitions of terms used in Automic documentation.
A
Action Definition Editor
Deprecated Term.
Action Service
A service that can respond (send) information to other system. Unlike the Response Service, an
action service is configured using the incoming event object.
activation
Through activation, tasks are assigned a RunID, displayed in the Activity Window, and ready for
execution. See also: Start.
activation log
A report that contains details about task activations. The report details depend on the specified
settings, such as the generated JCL and modified variables.
activity
An activity (or task) is an entity that can be planned, assigned to a user or a team and tracked
with respect to their plan and state (started, cancelled, suspended, completed).
Activity Window
A window that lists all activated tasks with some details for each activated task.
Administration
This is a perspective of the Enterprise Control Center (ECC). You use it to manage users and
their rights and privileges.
AE variables
These are Variable objects that include the Automation Engine system's specifications.
agent
A program that enables the de-centralized execution of processes (such as deployments) on
target systems (computers or business solutions) or a service that provides connectivity to a
target system (such as for databases or middleware). An agent is also an object type in the
Automation Engine. [Formerly called "Executor."] See also: host
alias
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.
authentication
Authentication is the process through which Automation Engine systems verify whether a user is
allowed to enter the system. The system does this by verifying the user ID and the related
password.
74 | Chapter Glossary
authorization
Authorization refers to user rights to access objects in the Automation Engine (AE) and to perform
specific operations within the AE system.
Auto Forecast
A view that displays tasks that will run in a predetermined period. It gives you a complete
overview of all future activities.
Automation Engine
This component drives an Automation Engine system and consists of different types of server
processes.
Automation Engine 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.
Automation Engine priority
Affects the order of task execution within an Automation Engine system.
Automation Engine Script
Automic's scripting language. [Formerly called "UC4 Script."]
Automation Engine system
An environment that is managed by Automation Engine components. [Formerly called "UC4
system."]
Automic Release Automation
Automic Release Automation (ARA), is an end-to-end solution for planning, coordinating and
automating software release processes, including automated deployment of applications across
large-scale server environments and covers all mentioned use cases. [Formerly called
"Application Release Automation", "Release Manager" and "Deployment Manager"]
Automic services
Automic services consist of Automation Engine workflows provided as a service including the
required prompt set.
B
batch mode
The method of processing tasks sequentially in the background.
C
calendar
An Automation Engine object type that defines a set of days based on calendar keywords.
calendar condition
The criteria for running a task is based on calendar keywords.
calendar keyword
The attribute of a Calendar object that defines which days included in the calendar.
Chapter Glossary | 75
CallAPI
A programming interface that processes a script in the Automation Engine system. It can be
called directly from within the program itself or from a different program.
CallOperator
Deprecated Term. Replaced by: notification
child, children
These are objects that are activated by superordinate tasks (parents).
ClearView
Deprecated Term. Replaced by: Process Analytics
client
A closed environment within an Automation Engine system where you can create and run
objects. A client name consists of a 4-digit number that must be indicated when a user logs on to
the Automation Engine system. Users and their rights are also defined in clients. A particular
Automation Engine object type.
Client Queue
Queue object which is available inside every client.
cockpit
An Automation Engine object type that allows you to include multiple visualizations of values and
states of the Automation Engine or of the monitored and controlled system in one window.
code table
An Automation Engine object type that defines a complete set of characters.
communication process
A communication process is part of the component Automation Engine. It is responsible for
connecting the components.
D
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.
Deployment
The creation of infrastructure for a specific set of <EventBases> on a <worker>
DialogClient
Deprecated Term. Replaced by: UserInterface
dynamic variables
A Variable object with the attributes "Source" - "EXEC", "SQL", "SQL internal", "Multi" or
"Filelist". Values are directly retrieved from the data source and not stored in the object.
E
ECC
Abbreviation for the Enterprise Control Center
76 | Chapter Glossary
Enterprise Control Center
Automic's web application that provides a single, browser-based interface for the ONE
Automation platform.
event
Action that is triggered if particular conditions apply. It can be an Automation Engine object type
or an entry in a Policy Orchestrator EventBase.
Event ID
First RunID of FileSystem and Console Events in the Automation Engine. Both Event types
require communication between the AE component and an Agent. They communicate via the first
RunID. Otherwise, Event identification is no longer possible after the first log change.
Event Pattern Editor
Deprecated Term.
Event Transformer
A <component> which is able to transform raw data to <event objects>
eventBase
EventBases are an essential component of the Policy Orchestrator. An eventBase represents a
bundle of all components needed to execute the event processing. Every eventBase also defines
a database to provide event data management.
Exception Events View
The exception events view is a tracking tool for events that are emitted on the exception ports of
map components. The view allows you to see a tree view or a grid view of all exception events
that occurred during a certain time span. If the exception was caused by an incoming event, you
can republish the events that caused the exception.
Executor
Deprecated Term. Replaced by: agent
Explorer
UserInterface window in which objects can be created, edited and administered.
external dependency
A task whose end status is considered when a workflow is being processed. The task itself,
however, does not run within the framework of this workflow.
External Pages
The general perspective that is always available and contains a list of links to other websites.
F
file transfer
Transfers files from one computer to another. A particular Automation Engine object type
(FileTransfer object).
forecast
Estimates a task's runtime on the basis of previous executions.
Chapter Glossary | 77
fully qualified file transfer
File transfers without wildcard characters. One particular file is transferred (as opposed to a
partially qualified file transfer).
G
Generic Socket
A socket which both senses (receives) events from its predecessors as well as responds (sends)
evens to its successors. A generic socket allows you to connect two maps. This enables you to
build complex structures combining multiple maps.
Graphical Workload Analyzer
Deprecated Term. Replaced by: ClearView
group
An Automation Engine object type that integrates tasks so that they can be processed together.
H
Home Dashboard
The ECC start page: An overview of the installed perspectives and their corresponding
functionalities.
host
Computer, target system.
host attributes
Platform-independent attributes of the Job object.
I
Include object
An Automation Engine object type for a script that is frequently used in more than one object.
J
Java Database Connectivity
Java Database Connectivity is an database connectivity API for the Java programming language
from Oracle.
JMS Receiver
A job type for the JMS agent than receives JMS messages.
job
An Automation Engine object type for a process that runs on a target system.
Job Control Language
Short form of "Job Control Language". It refers to applications that are processing steps executed
on computers.
JobPlan
Deprecated Term. Replaced by: workflow
78 | Chapter Glossary
K
Key column
Column in static Variable objects that can be used to access values of a particular line.
L
logical date
The logical date is used as a comparison date for checking Calendar conditions.
login
An Automation Engine object type that stores account credentials used by agents on target
systems.
M
Main Page
The core part of the ECC web page, which can display several overlapping tab pages for different
ECCs or different views of one ECC perspective.
Message Window
A window that appears on the user interface and contains information, warning, and error
messages.
Modelling Studio
An application which allows modeling of <EventBases> and managing the infrastructure of the
Policy Orchestrator and the associated <EventBases>
N
Navigator Pane
The left pane of the ECC web page that can be used to select the perspectives and their
corresponding functionalities.
Node Registration View
A view in the Management perspective of the PCO Modelling Studio that you use to manage
nodes. The view displays all registered workers and their current status (stopped or running) and
allows to register new worker nodes.
NonStop Server
You can use nonstop processes (NWP) in order to increase your system reliability. A specific
license is required for this purpose. In nonstop operation, only the WPs of one computer are
active. The processes of a different computer (nonstop processes) are available upon request. If
the primary computer that includes the active WPs fails, the nonstop processes take over their
role. As opposed to a usual parallel operation, the system configuration NonStop Server does not
use the WPs of all computers. The WPs of ony computer are always in the mode "hot standby."
[Formerly called "UC4.Nonstop Server."]
Chapter Glossary | 79
O
object
Automation Engine controlled activities and processes are structured in the form of objects. See
also: Task
object class
There are four classes of objects: executable, active, passive and system objects.
object type
An individual object is provided for the individual activities: There are User, UserGroup,
Notification, Cockpit, CodeTable, Documentation, Event, Agent, FileTransfer, Group, Include,
Job, Workflow, Calendar, Login, Client, RemoteTaskManager, Schedule, Script, Server, Sync,
Variable and TimeZone objects
object variables
Placeholder for values that are stored in an object's "Variables & Prompts" tab/section.
ONE Automation
The name of an Automic platform (product family). [Formerly called "ONE Automation Platform."]
Orchestration Editor
The editor to orchestrate EventBase components such as Maps and Sockets
Overview tab page
The start page of a perspective that provides an overview of possible functionalities.
P
page header
The upper bar in ECC. Displays the current user and allows him or her to log off.
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
perspective
Separate functional area of the Enterprise Control Center's (ECC) web interface.
Policy Orchestrator
An Automic application for managing events within the Automation Engine system. This
application is the backend for Predictive Analytics and the Policy Orchestrator Plug-in in ECC.
First, the Policy Orchestrator provides the building blocks for defining the business rules. Then, it
monitors the eventBase objects for occurrences of the situations that are described in the
business rule conditions and exceptions. When the situations occur, PCO triggers the actions
prescribed in the business rules. [Formerly called "Decision."]
Predictive Analytics
Automic's complex graphical analysis tool that produces interactive graphical representations,
called "visualizations," of a data set from a Policy Orchestrator (PCO) EventBase. The
visualizations can show both individual data values or aggregations, depending on which
functions and features that you use. If your organization uses Service Orchestrator and has
80 | Chapter Glossary
implemented the special eventBase for SLA results data, you can retrieve and view advanced
analytics that show you SLA patterns and trends. [Formerly called "Insight."]
privileges
Privileges in the Automation Engine refer to user rights to work with certain frontend and user
interface functions. You grant privileges to users in the Automation Engine.
Process Assembly
A perspective of the Enterprise Control Center that you use it to create, define and modify
workflows.
Process Automation
The previous name of the ECC Service Catalog perspective.
Process Monitoring
The perspective of the Enterprise Control Center that you use to monitor and modify activities.
ProcessFlow
Deprecated Term. Replaced by: workflow
PromptSet
A user-defined input mask for executable objects. An Automation Engine object type.
PromptSet element
Fields/control elements that are used to query User values. They are the content of a PromptSet
input mask.
PromptSet variable
It stores the value of a PromptSet element. Depending on the situation, a value can be userdefined or a default value. PromptSet variables show the same behavior as object variables.
Proxy
Separate Automic product that can be used as an additional service program in combination with
the Automation Engine. Combines and reroutes CP connections.
Q
queue
A particular Automation Engine (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 that should be executed at a certain time
one after another.
QueueManager
Deprecated Term. Replaced by: RemoteTaskManager
R
RA agent
An agent that can be connected to a particular RA Solution and thus provide this solution's
functionalities to an Automation Engine system. It is the interface between an external system /
application / platform and an Automation Engine system.
Chapter Glossary | 81
real date
The date that is used for checking runtime monitoring or time conditions in the properties of
workflow tasks is referred to as the real date. It complies with the top workflow's activation time.
It is passed on to all subordinate tasks.
recurring tasks
These tasks are scheduled without using a Schedule object and mostly consist of a period that is
less than a day.
registered
This is the status of a task that runs within a group and is waiting for its start.
release notes
Release Notes contain information about highlights, new functions, improvements, and
corrections for various versions and releases of the Automic product family.
report
A report provides more detailed information about a task's execution or a component.
Response Service
A service that can respond (send) information to other systems. Unlike the Action service, most
of the configuration of a response service needs to be done manually in advance.
REST
Representational State Transfer, a software architecture for distributed systems e.g., web
services.
restart
A restart refers to the repetition of an object's execution. This action differs from a new start in
some parts.
return code
The value that represents the result of tasks and script functions.
rights
Rights in the user management functions in the ECC refer to user access rights to main object
types and custom types in the Automic Release Automation. These rights can be granted to
either only read or also create these types.
roles
Roles in the user management functions in the ECC refer to user roles in Policy Orchestrator.
User roles indicate what actions the user is allowed to perform, for example, a user with the role
"super administrator" is allowed to work with all functions related to Policy Orchestrator.
Rule Editor
A editor for business and system rules in Policy Orchestrator.
Rule Space Editor
An editor for Rule Spaces.
RunID
Short for "run number". It is a number that provides unique information about a task's execution.
The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component .
82 | Chapter Glossary
runtime
The duration of a task's execution. It refers to the period between a task's start and end. It does
not include its activation period (see also: activation and start).
S
script
A particular Automation Engine object type.
server process
The core of the component Automation Engine. Different types are available: communication,
work and dialog processes, as well as nonstop processes.
Service Catalog
A service catalog is a list of services from which a user or an application can consume (obtain
and utilize) one or more services. In the ECC, the term also refers to a perspective presenting the
workflows that the user is allowed to execute.
service consumer
Uses a service provided via SAPI.
Service Orchestrator
An Automic product. The Service Orchestrator is a perspective of the Enterprise Control Centers
(ECC) and it is used to handle, monitor and analyze the performance of SLAs (Service Level
Agreements).
ServiceManager
A program that facilitates the starts and stops of Automation Engine components.
Single Sign-on
Login without entering login information (user, department, password). Single Sign-on is
transacted with KDC over a directory service (for example Windows Active Directory).
statistics
This is a list of a task's previous runs.
status
This represents the condition of a task (such as active, blocked, generating).
sub-workflow
A workflow that is part of a different workflow.
superordinate task
There are various ways of activating objects. The originator of the activation is referred to as the
superordinate task (parent).
Sync object
It synchronizes executable objects based on defined states and actions. A particular Automation
Engine object type.
Chapter Glossary | 83
T
tab
Tabs allow you to structure the Main Pane in several overlapping sections that are all open at the
same time but are viewed one at time.
task
An executable object that is running. Tasks are also referred to as activities.
templates
Pre-defined 'workflows' for specific components/tasks, e.g. Tomcat, SubVersion.
time zone
It defines a local time. A particular Automation Engine object type.
TNS name
A TNS name is used to establish a connection from a client to an Oracle database server using
the Local Naming service. Configured in the TNSnames.ora file.
U
UC4 Automation Engine
Deprecated Term. Replaced by: Automation Engine
UC4 Automation Platform
Deprecated Term. Replaced by: ONE Automation
UC4 Decision
Deprecated Term. Replaced by: Policy Orchestrator
UC4 Insight
Deprecated Term. Replaced by: Predictive Analytics
UC4 Operations Manager
Deprecated Term. Replaced by: Automation Engine
UC4 Release Manager
Deprecated Term. Replaced by: Automic Release Automation
UC4 Script
Deprecated Term. Replaced by: Automation Engine Script
UC4 Server
Deprecated Term. Replaced by: Automation Engine component
UC4 system
Deprecated Term. Replaced by: Automation Engine system
UC4.Nonstop Server
Deprecated Term. Replaced by: NonStop Server
unified user management
Unified user management is a capability that is available in the ECC to centrally manage users
within the Automation Engine. This simplifies user management if you use the ECC because
84 | Chapter Glossary
rather that having to define user rights in multiple Automation Engine components, you can
maintain all user and user group definitions in the ECC Administration section and the changes
are immediately replicated in the related Automation Engine backend systems. These backend
systems are the Automation Engine, Decision and the ARA web application.
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.
user
In the Automation Engine, a user is an instance of a User object, and generally the user is a
specific person who works with Automic products. The User object is assigned a user ID and
then a set of access rights to various parts of the Automation Engine system and product suite.
These access rights come in the form of Automation Engine authorizations and privileges,
Decision user roles and EventBase rights and ARA web application object rights. You can
manage all these centrally in the ECC user management functions. See also, Unified user
management.
user group
A group of users who have a common profile of rights. A particular 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.
User Management View
A view in the Management perspective of the PCO Modelling Studio that you use to manage
users and authentication methods.
V
variable
It stores or retrieves values dynamically at runtime. An individual Automation Engine object type.
W
WebHelp
One of the help formats that are provided for manuals. You open it with a Web browser.
wildcard characters
These are placeholders for characters when you specify filters. ? stands for exactly one
character, * for any number of characters.
workflow
An object of the Automation Engine that can include several executable objects and which runs
them in a specified order. [Formerly called "ProcessFlow" and "JobPlan."]
Workflow Monitor
Graphical view of a workflow's execution. It shows the workflow structure and the progress of the
child tasks.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising