Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Anchor
Installation Procedure
Installation Procedure

Installation Procedure

To install Universal Controller:

Anchor
Unpack the Downloaded Distribution File
Unpack the Downloaded Distribution File

Unpack the Universal Controller Distribution File

To unpack the Universal Controller distribution file, use the following method appropriate for your platform:

Linux/Unix


Panel
tar -xvf universal-controller-N.N.N.N.tar


Windows

Use an appropriate archiving / unzipping product.

Anchor
Install the Controller
Install the Controller

Install the Controller

To install the Controller, issue the following command that is appropriate for your platform:

...

Linux


Panel
sh install-controller.sh --tomcat-dir ~/tomcat --controller-file ./universal-controller-N.N.N.N-build.N.war --dbuser root --dbpass userpass


Windows


Panel
install-controller.bat --tomcat-dir "c:\Program Files\Apache Software Foundation\Tomcat 9.0" --controller-file universal-controller-N.N.N.N-build.N.war --dbuser root --dbpass userpass


Note
titleNote

In the Tomcat directory (--tomcat-dir), when quoting the directory is necessary due to spaces, do not use a single backslash before the ending quotation mark; use either a double backslash or no backslash to avoid the command shell from treating \" as an escape character.


Anchor
Deploy the Controller
Deploy the Controller

Deploy the Controller

In this procedure, you will start Tomcat, which starts the Controller and builds your database tables. This process takes several minutes. When it is complete, the Controller is started and ready to use.

...

You now have completed the install process and the Controller is running.

Anchor
Update the Universal Controller Start-up Properties
Update the Universal Controller Start-up Properties

Update the Universal Controller Start-up Properties (uc.properties)

For AIX and z/Linux only

Follow this procedure to change two default values in the Universal Controller start-up properties file, uc.properties, which is read by the Controller.

...

Step 1

Change the following two properties from their default value to the IBM AIX value:

  • uc.trustmanager.algorithm= (Java trust manager algorithm)
    • Default value = SunX509
    • IBM AIX = IbmX509
       
  • uc.trustmanager.provider= (Java trust manager provider)
    • Default value = SunJSSE
    • IBM AIX value = IBMJSSE2

Step 2

Restart Tomcat.

Anchor
Verify the Installation
Verify the Installation

Verify the Installation

To make sure the Controller is installed, running, and communication with Universal Agent and Universal Message Service (OMS):

Step 1

Start the Controller.

Step 2

From your browser, access the Universal Controller user interface.
 

Panel
http://localhost:8080/uc

localhost represents the machine name where you installed the server.

Step 3

Log in with user ops.admin and no password. A Change Password dialog displays.
 

Step 4

Enter a password in the New Password and Confirm New Password fields (the Current Password field should remain empty) and click Change Password. The Universal Controller Home Dashboard displays.

Step 5

The System Details Widget provides current system information. Check the Release information to verify that the latest version number is displayed, as shown in the following example.
 
Image Removed Image Added

Step 6

From the Agents and Connections navigation pane, select Agents > All Agents or Agents > <type of Agent>. You will see a list similar to the following example. Make sure the Status of the Agent is Active.
 
Image Removed Image Added

Step 7

From the Agents and Connections navigation pane, select System > OMS Servers. You will see a list similar to the following example. Make sure the Status of the OMS Servers are Connected.
 
Image Removed Image Added

Step 8

For more information about these components in the Universal Controller user interface, see:

To get started using the Controller and become familiar with its features, we recommend you spend some time going through the Tutorials /wiki/spaces/Staging/pages/5833465.

Anchor
Apply the License Key
Apply the License Key

Apply the License Key

Although you do not normally need to enter a license key immediately after installation, at some point you will need to follow these steps to enter your key:

Step 1

From the Services, select Administrationation > Properties. The Properties list displays.
 

Step 2

Click the License Key property Value field and enter your encrypted license key.

Step 3

Return to the System Details Widget and review the License field to verify that the terms of your license are correct.

Step 4

Optionally, configure the Controller so that your system administrator receives notifications regarding license violations and expirations.

Anchor
License Information
License Information

License Information

The License field in the System Details widget (view the system-defined Home Dashboard or, on the Reporting navigation pane, click Widgets) identifies license information for:

  • Expiry Date
  • Distributed Agents
  • z/OS Agents
  • Tasks
  • Monthly Executions
  • Cluster Nodes
  • UPPS
  • USAP
  • Customer
  • Environment

Image Removed

Anchor
Enable LDAP Synchronization
Enable LDAP Synchronization

Enable LDAP Synchronization

In order to log in to the Controller using LDAP credentials, you must set the LDAP Synchronization Enabled Universal Controller System property (Administration > Configuration > Properties in the Controller user interface) to true.

Anchor
Configure System Notifications
Configure System Notifications

Configure System Notifications

System Notifications are emails sent to one or more Universal Controller system administrators based on either:

Note
titleNote

System Notifications are not the same as Email Notifications. Please refer to the following sections for explicitly defining Email Notifications.

...

Step 1

Select an email connection on which the notifications will be sent and enable the Use for System Notifications field.
 

Note
titleNote

Only one Email Connection can be used for system notifications. If this field is checked in an Email Connection Details, it will appear unchecked on all other Email Connection Details. If you then check this field in another Email Connection Details, it automatically will be unchecked from the Details in which it had been checked.


Step 2

Identify the Universal Controller Administrator(s) that will receive the system notifications by entering one or more valid email addresses for those administrators in the Administrator Email Address Universal Controller system property.

Step 3

If you want to identify the source system that is sending the system notifications in the Subject line of the emails, enter a value in the System Identifier Universal Controller system property.

Anchor
System Notifications for License Violations and Expirations
System Notifications for License Violations and Expirations

System Notifications for License Violations and Expirations

When you have configured the Controller for system notification, notifications automatically are sent to the specified system administrator(s) for the following license issues:

  • License violations
  • Expired licenses
  • Invalid licenses

Anchor
License Violations
License Violations

License Violations

A system notification is sent for the following license violations:

...

The License field in the System Details widget (view the system-defined Home Dashboard or, on the Reporting navigation pane, click Widgets) identifies these maximum numbers (see 55509135 License Information, above).

Anchor
License Expiration
License Expiration

License Expiration

A system notification is sent at the following times if a license will expire in 7 days or sooner:

...

Note
titleNote

A License Expiration message also displays on the Console when you log in to the Controller if the license will expire within the week and when the license already has expired.

Anchor
Invalid Licenses
Invalid Licenses

Invalid Licenses

A system notification is sent at the following times if a license is invalid:

...