Installing Universal Agent

Owned by Stonebranch (Deactivated)
Last updated: Jul 15, 2024
5 min read

Overview

These pages provide information and instructions for the installation of Universal Agent, which differ for each supported operating system.
 

Note


The following table identifies the different operating systems on which an Agent can be installed, and the Agent packages that can be installed on each system.


Operating System

Universal Agent

Universal Enterprise Controller

UEC Client Applications

Universal Agent for SOA

z/OS 1

(tick)




z/OS USS

(tick)




Windows

(tick)

(tick)

(tick)

(tick)

UNIX - AIX

(tick)




UNIX - HP-UX

(tick)




UNIX - Solaris

(tick)




UNIX - Linux

(tick)



(tick)

IBM i 2

(tick)




1 Universal Agent for z/OS contains Universal Enterprise Controller.
2 Workload Automation 5.1.1 is installed on IBM i.
 

For each Universal Agent installation package, the following information is provided:

  • Installation package components
  • Product compatibility
  • Installation requirements
  • Installation upgrades
  • System upgrades
  • Distribution files
  • Installation procedures
  • Product customization
    • Configuration
    • Licensing
  • File inventory lists

Note

You can install Agents before, during, or after installation of Universal Controller.

Installation Requirements

Platform-specific installation requirements, including system requirements, are located on the Installation Requirements page specific to that platform:

Requirements relevant to all platforms are shown below.

Platform Requirements

Since platform requirements may change with new releases of a product, please consult the Platform Support page to make sure that your platform is supported before performing an installation.

Space Requirements

Space requirements for Universal Agent are driven largely by logging. A minimum 500MB of space is recommended. Each Agent contains a Universal Broker log and an Agent log.

The Universal Broker LOG_FILE_GENERATIONS configuration option lets you specify how many log files to save in the Universal Broker log directory. The default is 5.

The Agent log rolls over at midnight (12:00 a.m.) or whenever the Agent is restarted. The Log File Retention Period in Days Universal Controller system property lets you specify the number of days that an Agent log file (in addition to a Controller log file) is retained before it is purged. The default is 5 days.

Network Requirements

Agent components run on z/OS, Windows, UNIX, and IBM i operating systems. These systems must be connected with a network that supports TCP/IP. For example, the Universal Command Manager running on a z/OS system must be able to establish a TCP/IP socket connection with the Universal Command Server running on a UNIX or Windows system.

TCP/IP provides a set of commands to verify network connectivity between systems. For example, the ping command can determine if an IP connection is possible between two systems. However, the ping command may not work in all network environments. In addition, the ping command may work, but a firewall may deny all other connection attempts between the two systems. Check with your local network administrator to determine the capabilities and topology of your network.

Universal Agent offers configuration parameters that can facilitate connections through network firewalls. Due to the large variety of firewall configurations, all possibilities cannot be discussed in this document. Check with your local network administrator to determine if a firewall is between the computer systems involved.

Additional Requirements

In order to install any of these Agent components, you must be able to write to the directory from which the installation is launched.

Ports Configuration

Universal Agent is composed of several components that utilize the TCP/IP network for component communications. TCP/IP routes must be available between the distributed components and firewall rules open, if necessary.

The primary components using TCP/IP are Universal Broker, Universal Managers, and Universal Automation Center Agent (UAG).
 

Universal Broker

Executes on all servers on which workload management services are required. The Universal Broker accepts TCP socket connections on port 7887 from remote clients such as Universal Command Manager and Universal Data Mover Manager. A server running Universal Agent will need to be able to accept TCP connections on port 7887 in order to provide such services.

Universal Manager

Components include Universal Command Manager, Universal Data Mover Manager, and others. Manager components initiate TCP socket connections to remote Universal Brokers. If Universal Manager services are required, the Managers will need to be able to open TCP connections to remote Universal Brokers on port 7887.

UAG

Initiates a TCP socket connection to the Universal Message Service (OMS) deployed on a remote, centrally located server. OMS accepts TCP connections on port 7878. UAG must be able to open a TCP connection to the remote OMS server on port 7878.

The port numbers above are default port numbers. They can be changed in the respective component configuration, if necessary.

Product Distribution File Download

To install, update, or apply maintenance to an Agent package, you first must download the corresponding product distribution file for your specific operating system version and hardware platform.

All Agent distribution files are available for download from the Stonebranch Customer Portal. A customer user name and password - provided by Stonebranch, Inc. - are required to access the Customer Portal.

The operating system-specific pages of this installation guide identify the product distribution files to be downloaded for the different Agent packages.
 

Note

Agent installation packages for z/OS, Windows, and UNIX contain the Universal Controller Command Line Interface (CLI).

Agent installation packages for Windows and UNIX contain the Universal Message Service (OMS).


To download a product distribution file:

Step 1

Log in to the Customer Portal.

Step 2

Click the Software link.

Step 3

Click the Universal Agent link

Step 4

Click the Universal Agent package link appropriate for your platform.

Step 5

Click Save File and browse to your save location. You can then install the software.

Product Licensing

Each Agent installation package includes one or more components that must be licensed before they can be used. Licenses are provided by your Stonebranch, Inc. account representative.

Exception

UEC Client Applications, a separate, optional installation package of Universal Agent for Windows, does not contain any components that must be licensed.


The following table identifies all licensable components in the Agent package for each supported platform. The platform name is a link to detailed information about licensing the Agent components for that platform.
 

Component

z/OS

z/OS USS

Windows

UNIX

IBM i

Universal Command Manager

(tick)

(tick)

(tick)

(tick)

(tick)

Universal Data Mover Manager

(tick)

(tick)

(tick)

(tick)

(tick)

Universal Connector

(tick)


(tick)

(tick)


Universal Event Monitor Server



(tick)

(tick)


Universal Enterprise Controller

(tick)


(tick)



Universal Application Container Server



(tick)

(tick)


Note

Universal Enterprise Controller is a separate, optional installation package of Universal Agent for Windows.

Universal Application Container Server is a component of Universal Agent for SOA, a separate, optional installation package of Universal Agent for Windows and Universal Agent for UNIX.

Additional Information

In addition to this Installation Guide, Stonebranch, Inc. provides the following information:

Universal Agent 7.7.x Installation Requirements and Summary identifies network requirements for all Agent installations and, for each operating system, the following information:

  • System requirements
  • Installation summary
  • Customization

Universal Agent 7.7.x Installation Quick Start Guides provide the following information:

  • System Requirements
  • Downloading Universal Agent 7.0.x Distribution File
  • Installing Universal Agent 7.0.x
  • Licensing your Universal Agent 7.0.x Components
  • Encrypting User ID and Password for Job Execution
  • Executing a Job
  • Running a System Query
     

Note

There is a separate quick start guide for each Universal Agent and Universal Data Mover supported platform.