...
- Determined space requirements
- Installed all prerequisites.
- Downloaded a Universal Controller distribution file.
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 |
---|
Html bobswift | <pre>tartar -xvf universal-controller-N.N.N.N. tar</pre>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 | html-bobswift |
---|
<pre> > sh install-controller.sh <parameters></pre> |
|
---|
Windows |
Panel | html-bobswift |
---|
<pre> > install-controller.bat <parameters></pre> |
|
---|
The installation process writes the war file (universal-controller-N.N.N.N-build.N.war
) to the Tomcat installation directory and renames it uc
.war
.
...
Command Line Switch | Description | Default | Required | Controller Property |
---|
| For an Agent-Only deployment If --agentonly is true, Universal Controller Start-up Properties (uc.properties) is deployed with an Agent-Only demonstration license. | false | No |
|
| Full path of the Universal Controller war file (universal-controller-N.N.N.N-build.N.war ) from the downloaded Universal Controller package. | none | Yes |
|
| Universal Controller database name. | uc | No | uc.db.name |
| Database user's password. | none | Yes | uc.db.password |
| JDBC connect URL. Format: jdbc:[database type]://localhost Examples (for MS SQLServer and Oracle, uc is the database name): Include Page |
---|
| IL:dburl examples - 7.0.0.0 |
---|
| IL:dburl examples - 7.0.0.0 |
---|
|
Note |
---|
| Enclose the URL in quotation marks to guard against any special characters (for example: ; > < &) which are treated by the shell uniquely. - Unix
Enclose the URL in single quotation marks; for example: 'jdbc:sqlserver://dbserver.local;instanceName=IN01;DatabaseName=uc' - Windows
Enclose the URL in double quotation marks; for example: "jdbc:sqlserver://dbserver.local;instanceName=IN01;DatabaseName=uc"
|
Refer to the jdbc documentation from your database supplier for specific jdbc driver URL parameters or options that might be needed for your environment. You may want to consult with your local DBA to discuss these parameters and options. Refer to Installing a Database in this documentation for more information about suggested connection parameters, database configuration, and setup. | jdbc:mysql://localhost:3306/ | No | uc.db.url |
| Database user name. | none | Yes | uc.db.user |
| Used by the Universal Controller to generate a unique Cluster Node Node Id in the format of hostname:port-dbname. Note |
---|
| 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 |
| Database type. Valid values are: Html bobswift | <ul>
<li> mysql
<li> sqlserver
<li> - mysql
- sqlserver
- sqlserver-jtds
<li> oracle
</ul> Note |
---|
| * --rdbms is required if --dburl is used in the command. |
Note |
---|
| Customers have reported difficulty establishing secure SQL connections using the jTDS open source JDBC driver for Microsoft SQL Server (--rdbms sqlserver-jtds) when SSL/TLS is enabled on the server. We have received feedback that the issue can be resolved by installing a patched version of the jTDS driver from bug report https://sourceforge.net/p/jtds/bugs/725/. Stonebranch only bundles the official jTDS release, currently 1.3.1, with the Universal Controller. We do not include unofficial patches, and if you decide to use them, you do so at your own risk. |
| mysql | No * | uc.db.rdbms |
| Path to the Tomcat installation directory (contains the directories:/bin , /conf , /logs , webapps ). Note |
---|
| Enclose the path in quotes to guard against spaces or any special characters (for example: ; > < &), which are treated by the shell uniquely. |
| none | Yes |
|
...
Shown below are sample commands for installing the Controller on Linux and Windows platforms, using defaults for the database:
Linux |
Panel | html-bobswift |
---|
<pre>
sh install-controller.sh --tomcat-dir ~/tomcat --controller-file ./universal-controller-N.N.N.N-build.N.war --dbuser root --dbpass userpass
</pre> |
|
---|
Windows |
Panel |
---|
Html bobswift | <pre>
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
</pre> |
Note |
---|
| 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.
...
Step 1 | Start Tomcat as follows: Linux Start the Tomcat daemon using the script placed in the /etc/init.d directory for Tomcat. Panel |
---|
Html bobswift | <pre>
service [name of Tomcat service] start
</pre> |
Windows We recommend you use Windows Services to start Tomcat. Or, you can start Tomcat from the command line as follows: Panel | html-bobswift |
---|
<pre>
net start [name of Tomcat service]
</pre> |
Linux or Windows You can start the service using the $CATALINA_HOME/bin/startup.bat or $CATALINA_HOME/bin/startup.sh scripts. |
---|
| During this initial startup, the Controller builds the database tables, a process that takes several minutes. You can view details 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 |
---|
Html bobswift | <pre>
tail -f $TOMCAT_DIR/uc_logs/uc.log
</pre> |
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 |
---|
Html bobswift | <pre>
$TOMCAT_DIR\uc_logs\uc.log
</pre> |
Do not continue until you see output in the log similar to the following: Panel | html-bobswift |
---|
<pre>
2014-09-15-11:16:17:774 -0400 INFO [Ops.Cluster.Monitor.0] Cluster Monitor / ClusterWatchDog started (16951472)
2014-09-15-11:16:17:778 -0400 INFO [Ops.Cluster.Monitor.0] No active node found. sb-server:8080-ops6100 becoming Active node.
2014-09-15-11:16:17:778 -0400 INFO [Ops.Cluster.Monitor.0] Loading time zones
2014-09-15-11:16:17:810 -0400 INFO [Ops.Cluster.Monitor.0] Setting System time zone to "America/New_York"
2014-09-15-11:16:17:810 -0400 INFO [Ops.Cluster.Monitor.0] Initialize PubSubController
2014-09-15-11:16:17:813 -0400 INFO [Ops.Cluster.Monitor.0] PubSubController Active Start Load: 0 Subscriptions
2014-09-15-11:16:17:813 -0400 INFO [Ops.Cluster.Monitor.0] Server is now Running in Active mode. Previous mode was Passive
2014-09-15-11:16:17:813 -0400 INFO [Ops.Cluster.Monitor.0] Setting server to ACTIVE.
2014-09-15-11:16:17:814 -0400 INFO [Ops.Cluster.Monitor.0] Releasing lock and ending transaction
2014-09-15-11:16:18:147 -0400 INFO [Ops.Cluster.Monitor.0] 617 database statements took 0 Seconds
2014-09-15-11:16:18:149 -0400 INFO [Ops.Cluster.Monitor.0] Lock released and transaction ended
2014-09-15-11:16:18:149 -0400 INFO [Ops.Cluster.Monitor.0] Creating OmsServerWatchDog
2014-09-15-11:16:18:150 -0400 INFO [Ops.Cluster.Monitor.0] Creating AgentWatchDog
2014-09-15-11:16:18:150 -0400 INFO [Ops.Cluster.Monitor.0] Creating ApplicationWatchDog
</pre> |
|
---|
Step 3 | When you see the following, the Controller is ready: - INFO [Ops.Cluster.Monitor.0] Server is now Running in Active mode. Previous mode was Passive
- INFO [Ops.Cluster.Monitor.0] Setting server to ACTIVE.
|
---|
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 |
---|
Html bobswift | <pre>
http://localhost:8080/uc
</pre> |
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
...
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:
...
Step 1 | Select an email connection on which the notifications will be sent and enable the Use for System Notifications field. Note |
---|
| 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 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 |
---|
|
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:
...