Versions Compared

Old Version 5

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 6

changes.mady.by.user Stonebranch

Saved on

Key

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

...

It assumes you already have performed all required prePre-installation proceduresInstallation Procedure:

Anchor
Installation Procedure
Installation Procedure

...

To install Universal Controller:

1

206389337Unpack the Downloaded Distribution File

2

206389337Install the Controller

3

206389337Deploy the Controller

4

206389337Update the Universal Controller Start-up Properties

5

206389337Verify the Installation

6

206389337Apply the License Key

7

206389337Enable LDAP Synchronization

8

206389337Configure System Notifications

Anchor
Unpack the Downloaded Distribution File
Unpack the Downloaded Distribution File

...

The Controller installation process writes the values for some command line switches to the Universal Properties#Universal Controller startStart-up Properties (opswise.properties file), 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 Universal Properties#Universal Controller startStart-up Properties (uc.properties file), 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
--agentonly


For an Agent-Only deployment

If --agentonly is true, Universal Properties#Universal Controller Start-up Properties (uc.properties) is deployed with an Agent-Only demonstration license.

falseNo


Panel
--controller-file


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



Panel
--dbname


Universal Controller database name.

Note

The property ucProperties#uc.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 ucProperties#uc.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 ucProperties#uc.db.name will be used to connect to the database by issuing the SQL "USE dbname", where dbname is the value of the ucProperties#uc.db.name property.
  • MySQL
    • MySQL should not contain the database name in the uc.db.url property.
    •     MySQL will use the ucProperties#uc.db.name property to connect to the database specficied by also issuing the SQL "USE dbname" statement where dbname is the value of the ucProperties#uc.db.name property.


uc

No

uc.db.name


Panel
--dbpass


Database user's password.

none

Yes

uc.db.password


Panel
--dburl


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
titleNote

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


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
  • sqlserver-jtds
  • oracle
Note
iconfalse

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


Note
titleNote

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


Panel
--tomcat-dir


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

Note
titleNote

Enclose the path in quotes to guard against spaces or any special characters (for example: ; > < &), which are treated by the shell uniquely.


none

Yes


...

Follow this procedure to change two default values in the Universal Properties#Universal Controller startStart-up Properties (uc.properties file), uc.properties, which is read by the Controller.

...

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

Step 1

Start the Starting and Stopping Universal 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 Widgets provides current system information. Check the Release information to verify that the latest version number is displayed, as shown in the following example.
 

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.
 

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.
 

Step 8

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

...

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 Widgets 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 System Notifications for License Violations and Expirations.

Anchor
License Information
License Information

...

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

...

In order to log in to the Controller using LDAP credentialsSettings#Credentials for Running Tasks Authentication, you must set the LDAP Properties#LDAP Synchronization Enabled Universal Controller System property (Administration > Configuration > Properties in the Controller user interface) to true.

...

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.


In order for a system administrator to receive system notifications, you must configure the Controller for system notifications:

Step 1

Select an email connection Email Connections on which the notifications will be sent and enable the Use Email Connections#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 Properties#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 Properties#System Identifier Universal Controller system property.

...

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

Anchor
License Expiration
License Expiration
License Expiration

...

  • Sent daily at midnight, processed same time as midnight log rollover.
  • Sent on Controller start-up (or a cluster node becoming the Active cluster node).
  • Sent on License Key property change (if new license still expired).
  • System paused on license expiration.
Note
titleNote

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

...

For detailed information on how to set up system notifications for Data Backup / Purge operations, see Data Backup / - Purge.