Versions Compared

Key

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

...

When you install Universal Controller, you create a single instance (Glossary#cluster cluster node) of the Controller. To operate Universal Automation Center in a High Availability (HA) environment, you must add one or more cluster nodes. Each cluster node should be installed on a separate machine.

...

The Controller installation process writes the values for some command line switches to the Properties#Universal Universal Controller Start-up Properties (uc.properties), uc.properties (see the table, below). For any of those command line switches that are not required and, in fact, are not included on the command line, the Controller installation process writes their default value to uc.properties.

...

For command line switches that have their value written to the Properties#Universal Universal Controller Start-up Properties (uc.properties), uc.properties, the table also identifies the property in that file to which the value is written.

...

Command Line Switch

Description

Default

Required

Controller Property


Panel
--controller-file


Full path of the Universal Controller war file from the downloaded Universal Controller package.

none

Yes



Panel
--dbname


Universal Controller database name.

Note

The property Properties#ucuc.db.name should be set to the name of the database being connected to. It can be seen in the System Details widget under Database information as well as in the uc.log.


  • Oracle
  • SQL Server
    • If the uc.db.url property contains the attribute "DatabaseName" then the Properties#ucuc.db.name property is for informational purposes only, similar to Oracle.
    •     If however, the uc.db.url does not contain the database name, then the Properties#ucuc.db.name will be used to connect to the database by issuing the SQL "USE dbname", where dbname is the value of the Properties#ucuc.db.name property.
  • MySQL
    • MySQL should not contain the database name in the uc.db.url property.
    •     MySQL will use the Properties#ucuc.db.name property to connect to the database specficied by also issuing the SQL "USE dbname" statement where dbname is the value of the Properties#ucuc.db.name property.


uc

No

uc.db.name=


Panel
--dbpass


Database user's password.

none

Yes

uc.db.password=


Panel
--dburl


JDBC connection URL.
 
Format:   jdbc:<jdbc vendor>:<other jdbc vendor data>
 
Examples (for MS SQLServer, uc is the database name; for Oracle, XE is the SID):
 

Include Page
IL:dburl examples - 7.0.0.0
IL:dburl examples - 7.0.0.0

jdbc:mysql://localhost

No

uc.db.url=


Panel
--dbuser


Database user name.

none

Yes

uc.db.user=


Panel
--port


Used by the Universal Controller to generate a unique Cluster Node Node Id in the format of hostname:port-dbname.

Note
titleNote

This is meant to represent the value of the Tomcat HTTP/1.1 Connector port configured in the server.xml.

It is used solely for Node Id generation and does not impact the Tomcat HTTP/1.1 Connector configuration.


8080

No

uc.servlet.port


Panel
--rdbms


Database type.
 
Valid values are:

  • mysql
  • sqlserver
  • oracle
Note
iconfalse

* --rdbms is required if --dburl is used in the command.


mysql

No *

uc.db.rdbms=


Panel
--tomcat-dir


Path to the Tomcat installation directory (contains the directories:/bin, /conf, /logs, webapps).

none

Yes


...

Step 1

Start Tomcat as follows:
 
Linux
Start the Tomcat daemon using the script placed in the /etc/init.d directory for Tomcat.
 

Panel
service [name of Tomcat service] start

 
Windows
We recommend you use Windows Services to start Tomcat. Or, you can start Tomcat from the command line as follows:
 

Panel
net start [name of Tomcat service]

 
Linux or Windows
You can start the service using the $CATALINA_HOME/bin/startup.bat or $CATALINA_HOME/bin/startup.sh scripts.

Anchor
Opswise log
Opswise log
Step 2

You can view details of the start-up in the Tomcat window or monitor the Controller log, as described below:
 
Linux/Unix
Users can tail the uc.log to monitor the deployment process, as follows:
 

Panel
tail -f $TOMCAT_DIR/uc_logs/uc.log

 
Windows
Users can use a third-party tailing utility or open the log file using Notepad or other editor and scroll to the bottom to view the latest activity.
 

Panel
$TOMCAT_DIR/uc_logs/uc.log


Step 3

When you see the following, the Controller is ready:

  • INFO [Ops.Cluster.Monitor.0] Server is now Running in Passive mode.
  • INFO [Ops.Cluster.Monitor.0] Setting server to PASSIVE.

Step 4

AIX and z/Linux only: Follow this procedure to change two default values in the Properties#Universal Universal Controller Start-up Properties (uc.properties), uc.properties, which is read by the Controller.
 
(The uc.properties file resides in <tomcat directory>/webapps/uc/WEB-INF/properties).
 

  1. Change the following two properties from their default value to the AIX - z/Linux value:
     
    • uc.trustmanager.algorithm= (Java trust manager algorithm)
      • Default value = SunX509
      • AIX - z/Linux value = IbmX509
         
    • uc.trustmanager.provider= (Java trust manager provider)
      • Default value = SunJSSE
      • AIX - z/Linux value = IBMJSSE2
         
  2. Restart Tomcat.

...

Step 1

Log in to the originally installed Controller.

Step 2

Verify that the Cluster Node Status Widgets illustrates an Active and a Passive cluster node.

Step 3

For detailed information on the new (and original) cluster nodes, select Resources > System > Cluster Nodes.


Note
titleNote

The Installing Universal Controller#Apply Apply the License Key for the installed Universal Controller applies to all instances (cluster nodes) of that Controller; no additional licensing is required.

Installing Universal Controller#Configure Configure System Notifications configured for the installed Universal Controller apply to all instances (cluster nodes) of that Controller; no additional system notifications have to be configured.

...

You must specify all members of an OMS cluster in your HA environment in the same OMS Servers#Creating Creating OMS Server Records.

The OMS Servers list screen will contain a single entry for all OMS cluster members defined in the record. (The OMS Servers list screen could have additional entries for an OMS Server or OMS cluster outside of your HA environment. For example, OMS Servers outside a firewall would connect to a different message database and serve different Agents, but would connect to to the same Controller.)

...