This section provides step-by-step instructions on how to manually deploy RTView. Refer to Rich Client Browser with Served Data - Manual Deployment Process for a summary of these instructions. Alternatively, you can use the Deployment Wizard to guide you through this process.

NOTE: These instructions are intended for users with standard working knowledge of servlet deployment, HTML code and application server administration. If you do not have a full understanding of these, you will need assistance from your system administrator.

An Apache Tomcat application server is included with your RTView installation for prototyping and testing your deployment before going into the production environment. The following instructions will work for your application server or the one that comes with RTView.

Step 1: Set up Data Server
Install RTView on the system where you will run the Data Server. If you are using multiple or high availability Data Servers, you will need to repeat the following steps on each system where you will run Data Server(s).  

A: Verify System Requirements
 

Java 1.5.0_01+ Accessible over the network to the Data Servlet. Basic system requirements In addition to basic system requirements, refer to the Data Sources section of this documentation for system requirements and setup specific to your data source. NOTE: The Data Servlet must have permission to access the Data Server on the port specified for the socket in the DATASERVER.ini file. This process will be explained in Step D: Configure Data Server.

B: Install and Set up RTView
At this point you have verified your system requirements.

1. Install RTView

2. Set up RTView

C: Register
At this point you have installed and setup RTView.

Register for a license for the Data Server.

D: Configure Data Server
At this point you have installed, setup and registered your RTView installation.

1. Create a project directory to store Data Server configuration files.

2. Copy the following files into the directory you just created from the project directory where you developed your RTView application:
 

OPTIONS.ini file Refer to Deployment in the Data Sources section of this documentation for information on configuration (.ini) files specific to your data sources. All display (.rtv) files you want to preload (optional)

NOTE: If you are using multiple or high availability Data Servers, each Data Server needs to run on a different host and/or port. Be sure that the DATASERVER.ini file, the OPTIONS.ini file, and any related data source initialization files are all correct for this instance of the Data Server.

3. If you already created a DATASERVER.ini that is configured to run the Data Server in socket mode on the correct port, copy the DATASERVER.ini to the project directory you just created. Then go to Step 2: Set up Data Servlet on Application Server.

If you have not created a DATASERVER.ini, go to next step.

4.  In an initialized command window, go to the project directory you created in Step D1 and type:

run_dataserver -socket

NOTE: The Data Server must be configured to run on a socket. The port specified for the socket must match the ServicePort specified for the Data Servlet in Step 2B.

6. Click the Save Configuration button to save DATASERVER.ini and exit the Data Server.

Step 1 is completed. Go to Step 2: Set up Data Servlet on Application Server.

Step 2: Set up Data Servlet on Application Server
At this point you have completed the RTView installation and setup, and configured the Data Server.

A: Verify System Requirements
 

Application server with a JSP servlet container, such as Apache Tomcat Must have permission to access the Data Server on the port specified for the socket in   DATASERVER.ini (see Step 1D)

B: Install and Set up Data Servlet
The Data Server uses a Data Servlet that runs on your application server. The Data Servlet communicates with the Data Server via a socket and communicates with the clients via HTTP or HTTPS. The servlets\rtvdata directory contains all of the files necessary to configure and install the Data Servlet.

If you are using multiple Data Servers, you must configure and install a Data Servlet for each Data Server. If you want to install multiple Data Servlets on the same application server, each must have a unique name.

At this point you have verified your system requirements.

1. Configure Data Servlet Options
The Data Servlet reads servlet.properties to get configuration information. If you have not installed the Data Servlet, modify the servlet.properties files in the servlets\rtvdata directory and it will be installed as part of the next step. If you have already installed the Data Servlet on your application server, you can edit this properties file in your application server. You may need to restart your application server after making changes to this file.

You can set the following options in servlet.properties:

Option	Description
ServiceHost	The name of the host on which the Data Server is running. Default is localhost. NOTE: Default localhost assumes the servlet and Data Server are running on the same machine.
ServicePort	Port for communicating with the Data Server. Default is 3278.  *This must match the port specified in the Data Server (Step 1D-5).
ServiceTimeout	Amount of time (in seconds) the servlet will wait for replies from the Data Server. Default is 15 seconds.

The following is an example of the servlet.properties file:

ServiceHost=localhost
ServicePort=3278
ServiceTimeout=15

2. Install the Data Servlet
 

In an initialized command window, go to the servlets\rtvdata directory and type:

 

make_war

This script creates a web archive (.war) named rtvdata.war that includes all of the files necessary to run the Data Servlet.

 

Your RTView installation includes an Apache Tomcat application server, so that you can prototype and test your deployment before moving it to your production server. If you will be using this application server, type the following to install the Data Servlet:

 

install_to_demoserver rtvdata

This script installs the web archive rtvdata.war to the Apache Tomcat server included in your RTView installation. NOTE: This script will shutdown and restart Apache Tomcat and requires administrative permissions.

 

If you will be using your own Apache Tomcat application server, type the following to install the Data Servlet:

 

install_to_tomcat rtvdata

This script installs the web archive rtvdata.war to your Apache Tomcat server.  NOTE: This script will shutdown and restart Apache Tomcat and requires administrative permissions.

 

If you will be using an application server other than Apache Tomcat, install the files in the rtvdata.war file to your application server according to the documentation for that product.

Step 2 is completed. Go to Step 3: Set up Report Servlet on Application Server.

Step 3: Set up Report Servlet on Application Server
At this point you have completed the RTView installation and setup, configured the Data Server and setup the Data Servlet.

Your RTView installation includes an Apache Tomcat application server you can use to prototype and test your deployment before moving it to your production server. If you will be using this application server, the Report Servlet is already installed so you can skip to Step 4.

Follow the instruction in Report Servlet to setup and install the Report Servlet on your application server.

Step 3 is completed. Go to Step 4: Set up RTVAgent Servlet on Application Server.

Step 4: Set up RTVAgent Servlet on Application Server (Optional*)

*This step is only required if you are setting up the Data Server to accept RTVAgent data via HTTP or HTTPS.

At this point you have installed and setup RTView and configured the Data Server, setup the Data Servlet and Report Servlet.

1: Verify System Requirements

• Application server with a JSP servlet container, such as Apache Tomcat.

2: Install and Set up RTVAgent Servlet
The Data Server uses the RTVAgent Servlet that runs on your application server to access data sent from an RTVAgent application that is sending data via HTTP. The servlets\rtvagent directory contains all of the files necessary to configure and install the RTVAgent Servlet.

If you are using multiple Data Servers that are gathering RTVAgent data, you must configure and install a RTVAgent Servlet for each Data Server.

a. Configure RTVAgent Servlet Options
The RTVAgent Servlet reads the servlet.properties properties file to get configuration information. If you have not installed the RTVAgent Servlet, modify servlet.properties (in the servlets\rtvagent directory) and install. (Step 4-2b - Install the RTVAgent Servlet). If you have already installed the RTVAgent Servlet on your application server, you can edit your properties file in the application server. NOTE: You may need to restart your application server after making changes to your properties file.

You can set the following options in servlet.properties:

The following is an example of the servlet.properties file:

ServiceHost=localhost
ServicePort=5665
ServiceTimeout=15

b. Install the RTVAgent Servlet:

• In an initialized command window, go to the servlets\rtvagent directory and type:

make_war

This script creates a web archive (.war) named rtvagent.war that includes all of the files necessary to run the RTVAgent Servlet.

• Install the files in the rtvagent.war file to your application server according to the documentation for that product.

Step 4 is completed. Go to Step 5: Set up Applet on Application Server.

Step 5:  Set up Applet on Application Server
At this point you have installed and setup RTView, configured the Data Server, setup the Data Servlet, Report Servlet and RTVAgent Servlet.

A: Verify System Requirements

• Application server
  NOTE: This must be the same application server where you installed the Data Servlet in Step 2.

B: Configure Applet
In this section you create an HTML page that instances the Display Viewer Applet. All of the jars necessary to run the Display Viewer Applet can be found under your installation directory located in the lib directory.

NOTE: The jars in the lib directory are not digitally signed. If you need to deploy with signed jars, use the jars in lib\signed_jars.zip. The certificate in these jars will expire in December of 2011.
 

See Applet Configuration for instructions on configuring the Display Viewer applet. Since you are using the Data Server, you do not need to follow any instructions for configuring data sources.

C: Install Applet
At this point, you have created an HTML file that instances the Display Viewer Applet. Follow the instruction in Hosting the Applet to install the applet to your application server. 

D: Register
The Display Viewer Applet requires a separate license key from the RTView applications to run on an application server. Without a key, the Display Viewer Applet will run for 20 minutes to facilitate testing. No key is required to run locally.

Register Display Viewer Applet

Step 5 is completed. Go to Step 6: Start / Run Data Server.

Step 6: Start / Run Data Server
At this point you have installed and setup RTView, setup the Data Servlet, Report Servlet, RTVAgent Servlet and the Display Viewer Applet. If you are using multiple Data Servers, you will need to repeat the following steps on each system where you will run Data Server(s).

1. In an initialized command window, go to the directory you created in Step 1D and type:
 

run_dataserver

2. Click the Start Serving Data button.

NOTE: You may also run the Data Server as a daemon process. See Running the Data Server for more information and additional options.

NOTE: The Data Server is instrumented with JMX to allow you to manage and monitor the clients and application settings. See Managing the Data Server Using JMX for more information.

Step 6 is completed. Go to Step 7: Test Data Servlet.

Step 7: Test Data Servlet
At this point you have installed and setup RTView, setup the Data Servlet, Report Servlet, RTVAgent servlet, Display Viewer Applet and started the Data Server.

1. Open a browser and navigate to the test.jsp file included in the rtvdata.war:
 

http://host:port/rtvdata/test.jsp?test=1

Where host and port are where the Data Servlet is running.

2. Verify that the Data Servlet is running. The browser should display text similar to the following:

GmsServlet: running
POSTs: 0
Service:
host: localhost
port: 3278
connected: false

Service should reflect the configuration that is entered in servlet.properties and connected should be true if the Data Servlet is connected to the Data Server.

Step 8: Test Client
At this point you have installed and setup RTView, setup the Data Servlet, Report Servlet, RTVAgent servlet, and Display Viewer Applet, started the Data Server and tested the Data Servlet.

Follow the instructions in Browser Client to test your deployment.

For troubleshooting information, see Display Viewer Applet Troubleshooting.

Congratulations! RTView deployment is completed.