Versions Compared

Old Version 4

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version 5

changes.mady.by.user Stonebranch

Saved on

Key

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

...

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

Linux/Unix


<pre>tar
tar -xvf universal-controller-N.N.N.N.
tar</pre>
tar
Panel
Html bobswift


Windows

Use an appropriate archiving / unzipping product.

...

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

Linux


html-bobswift
Panel
<pre> 
> sh install-controller.sh
<parameters></pre>

Windows

<pre> 
> install-controller.bat 
<parameters></pre>
 Panel
 Html bobswift

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.
...
<ul>
<li> mysql
<li> sqlserver
<li> 
  • mysql
  • sqlserver
  • sqlserver-jtds

<li> oracle 
</ul>
  • oracle
Command Line Switch
Description
Default
Required
Controller Property

 Panel
--agentonly

For an Agent-Only deployment
If --agentonly is true, 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.
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:
 Html bobswift
 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

...
Shown below are sample commands for installing the Controller on Linux and Windows platforms, using defaults for the database:
Linux

<pre>

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

</pre>
 Panel
 Html bobswift

Windows

html-bobswift
 Panel
<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
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.

...
Step 1
Start Tomcat as follows:
 
Linux
Start the Tomcat daemon using the script placed in the /etc/init.d directory for Tomcat.
 
<pre>

service [name of Tomcat service] start

</pre>
 Panel
 Html bobswift
 
Windows
We recommend you use Windows Services to start Tomcat. Or, you can start Tomcat from the command line as follows:
 
<pre>

net start [name of Tomcat service]

</pre>
 Panel
 Html bobswift
 
Linux or Windows
You can start the service using the $CATALINA_HOME/bin/startup.bat or $CATALINA_HOME/bin/startup.sh scripts.
 Anchor
uc log
uc log
Step 2
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:
 
html-bobswift
 Panel
<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.
 
<pre>

$TOMCAT_DIR\uc_logs\uc.log

</pre>
 Panel
 Html bobswift
 
Do not continue until you see output in the log similar to the following:
 
html-bobswift
 Panel
<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.
...
Step 1
Start the Controller.
Step 2
From your browser, access the Universal Controller user interface.
 
html-bobswift
 Panel
<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.
 
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:
...