Universal Controller for Agent Management
- Stonebranch (Deactivated)
Overview
Starting with Universal Agent 6.9.0.0, customers using Universal Agents with 3rd-party scheduling solutions have the option to implement a central license manager.
This central license management function can be implemented via a Universal Controller for Agent Management (UCAM) deployment, which is a special version of Universal Controller configured to provide Agent Management functions.
UCAM provides the following functionality:
Implements a single license key per environment (Production or Non-Production).
Provides one place to apply and manage licensing for all Universal Agent components (Universal Command, Universal Data Mover, Universal Connector for SOA, Universal Connector for SAP, and Universal Connector for Peoplesoft).
The License key is defined to UCAM and is distributed to each Universal Agent when the Agent starts and registers with UCAM via an OMS server.
Registered Agent status is tracked by UCAM and displayed in a customizable dashboard.
To take advantage of the central license management. your Agents must be at version 6.9.0.0 or higher.
UCAM can be downloaded from the Universal Agent / Universal Data Mover section of Software Downloads in the Stonebranch Customer Portal.
Installation
Installation Requirements for UCAM
UCAM, which can be installed on a Linux or Windows server, requires the following:
| Apache Tomcat | 8.5 or 9.0 |
| Java JRE | 8.0 or 11.0 |
| Relation Database |
|
| Database space | 200MB |
| Memoery | 2GB |
| Disk space | 4GB |
You also will need to deploy at least one OMS (Universal Message Server).
Installation Steps Summary
Step | Description | Detailed Information |
|---|---|---|
1 | Install UCAM Prerequisites. | |
2 | Download the platform-specific UCAM Distribution File. | |
3 | Unpack the UCAM Distribution File. | |
4 | Install UCAM using the --agentonly true installation option. | |
5 | Deploy UCAM. | |
6 | Verifiy UCAM. | |
7 | Apply your Universal Agent License Key. | |
8 | Set-up and Configure OMS. | |
9 | Connect Universal Agents to UCAM. | |
10 | Optional HA Configuration. | |
11 | Optional LDAP / AD or SSO configuration. | |
12 | Configure System Notifications. |
OMS Set-Up and Configuration
The OMS component handles communication to and from UCAM and your Universal Agents. As with the UCAM application itself, this can optionally be configured in an HA (High Availability) configuration.
OMS is a components of both Linux and Windows Agents and already is installed; it just needs to be enabled and configured to meet your needs.
You can designate one or more existing Universal Agent deployments as an OMS server (each of which can be HA, if desired), or you can choose to deploy dedicated Universal Agents as OMS-only servers. OMS-only servers will not be configured to consume a UA license and cannot execute or receive any component workloads (Universal Command, Universal Data Mover, Universal Connector for SOA, Universal Connector for SAP, or Universal Connector for Peoplesoft).
OMS Server Automatic Start-up
For an existing Universal Agent installation, you will need to configure the OMS Server component definition to specify autostart yes and restart yes. You also will need to restart Universal Agent after making these component configuration changes.
- To install a new OMS-only server, make sure to configure OMS to automatically start and UAG not to automatically start. By not starting UAG, this OMS-only server will not register with UCAM and will not consume one of your Agent Licenses.
Note
The OMS server receives inbound connections from UCAM and Universal Agents on port 7878 (default configuration). Make sure you allow connections to OMS on this port.
For more information on OMS set-up and configuration, see the Universal Message Service (OMS) 7.3.x Reference Guide.
Configure OMS in UCAM
Once you have one or more active OMS servers or OMS HA clusters, they need to be defined to UCAM. See Creating OMS Server Records for more detailed information.
Connect Universal Agents to UCAM
Universal Agents must be configured to register with UCAM in order to receive their license. The UAGS (Universal Agent Server) component of Universal Agent connects to an OMS in order to communicate with UCAM. The UAGS OMS_SERVERS option must be configured to connect to an OMS or OMS HA Cluster.
Optional HA Configuration
For UCAM, you can simply install and configure a second UCAM instance (Cluster Node) to connect to the same database as the primary UCAM Cluster Node; see Adding a Cluster Node.
For OMS, you will need to provide an NFS (Network File Share) for each OMS HA Cluster; see OMS Server High Availability for more information.
Getting Started with UCAM
When you first logon to a vanilla UCAM installation, you will be presented with the following screen:
For useful information about the user interface navigation and concepts, see User Interface Overview.
Displaying Universal Agent Status
All Universal Agents will register automatically with UCAM when configured and started as described previously.
On the Agents & Connections navigation pane of the Controller navigator, you can, at any time, see the status and the details of your Universal Agents.
All Universal Agents can be displayed, or the Universal Agents display can be grouped by the operating system they run on.
The above display shows the status Information that this Agent currently has (Active / Offline) on which Alerts, as described in the following section, can be based.
By clicking the Icon next to the Agent name, a Details screen will open showing the details of the selected Agent
Configuring Universal Agent Alerts
From the Universal Agents details display (see above), you can manage (display, create, update, or delete) Email or SNMP Notifications from the Notifications tab .
To create an Email Notification, click New on the Email Notifications header.
For details on specifying Universal Agent Email Notifications and the required Definitions, see Agent Notifications, Email Templates, and Email Connections.