Enterprise RTView® 
User Guide

Display Viewer Applet

The Rich Browser Client deployments are implemented using the Display Viewer Applet, which is a Java applet. The Display Viewer Applet can either connect directly to your data source(s) or it can connect to the Data Server. For step-by-step instructions on deploying the Display Viewer Applet, see Rich Client Browser with Served Data or Rich Client Browser with Direct Data Connection.

This document describes how to configure, host and run the Display Viewer Applet and Report Servlet. 


Configuration
The Display Viewer Applet must be instanced in an HTML page as described below.  All of the jars necessary to run the Display Viewer Applet can be found under your installation directory located in the lib directory. 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. 

Create an HTML page that instances the Display Viewer Applet. This procedure has two Parts:
  • Part i: Specify Required Applet Parameters
  • Part ii: Specify Optional Applet Parameters
NOTE: The Display Viewer Applet also supports several JavaScript methods.

Display Viewer Applet Example
A sample HTML page, mydisplay.html, contains the Display Viewer Applet and can be found in your installation directory under demos. The minimum HTML code required to run the Display Viewer Applet are as follows:
<html>
<body>
<object classid="clsid:8AD9C840-044E-11D1-B3E9-00805F499D93" 
            WIDTH = "725" HEIGHT = "585" ALIGN = TOP 
            codebase="http://java.sun.com/update/1.5.0/jinstall-1_5_0-windows-i586.cab#Version=1,5,0,0">
           <param NAME = CODE VALUE = "com.sl.gmsjrtview.GmsJRtView.class" >
           <param NAME = ARCHIVE VALUE = "gmsjrtview.jar,gmsjmodels.jar,gmsjrtvreport.jar,iText.jar,J2PrinterWorks.jar" >
           <param NAME="type" VALUE="application/x-java-applet;version=1.5">
           <COMMENT><embed type="application/x-java-applet;version=1.5" 
                             code = "com.sl.gmsjrtview.GmsJRtView.class" 
                             ARCHIVE = "gmsjrtview.jar,gmsjmodels.jar,gmsjrtvreport.jar,iText.jar,J2PrinterWorks.jar" 
                             WIDTH="725" HEIGHT="585" ALIGN=TOP rtv_filename="mydisplay.rtv" 
                             pluginspage="http://java.sun.com/j2se/1.5.0/download.html">
           <noembed></COMMENT>
           <param NAME="rtv_filename" VALUE="mydisplay.rtv">
           </noembed>
           </embed>
</object>
</body>
</html>

Part i: Required Applet Parameters
To host the Display Viewer Applet you must specify the following in your HMTL file:

  • basic required applet parameters;
  • applet parameters for data sources - this is only needed if you are not using the Data Server
  • TIBCO EMS Manager applet parameters - this is only needed if you are deploying the TIBCO EMS Manager
Basic Required Applet Parameters
Parameter Name Description
CODE  com.sl.gmsjrtview.GmsJRtView.class

The classes specified in the CODE parameter are included in the jars specified for the ARCHIVE parameter. 
ARCHIVE  gmsjrtview.jar, gmsjmodels.jar, gmsjrtvreport.jar, iText.jar, J2PrinterWorks.jar, jar file containing custom classes.

The gmsjrtview.jar does not need to be in the directory containing the HTML file. However, if it is not, the value for the ARCHIVE parameter must contain the relative path to the jar.

gmsjmodels.jar must be copied to the directory containing the HTML file.

Multiple command users:
Add the following files (found under your installation directory in lib) to the ARCHIVE parameter:

mail.jar
activation.jar
snmp.jar

Email command users:
Add the following files (found under your installation directory in lib) to the ARCHIVE parameter:

   mail.jar
   activation.jar

SNMP Trap command users:
Add the following file (found under your installation directory in lib) to the ARCHIVE parameter:

   snmp.jar

Asian font users (that want to export reports):
Add the following file (found under your installation directory in lib) to the ARCHIVE parameter:

    iTextAsian.jar
WIDTH Set to the width of the display plus 1 pixel. The width of the display (in pixels) is noted in the Background Properties dialog. To access this information, open the file in the Display Builder, select File>Background Properties.
HEIGHT Set to the height of the display plus 41 pixels. This additional space will ensure that your display is not scaled down in size by accommodating the logo panel that appears below the applet. The height of the display (in pixels) is noted in the Background Properties dialog. To access this information, open the file in the Display Builder and select File>Background Properties.
CODEBASE If you intend to pass your applet through a portal, set the base URL for your applet (i.e.: http://<host>:<port>/<applet directory>).
rtv_filename Name of the initial display (.rtv) file to open in the Display Viewer Applet.
dataserver This parameter is only required if you are using the Data Server. Set this parameter to redirect data requests to the Data Server. 

Default Data Server (where host is the application server hosting the servlet):

remote:http://host:port/rtvdata

Named Data Server (where name is the Name specified when this Data Server was configured and connect is http://host:port/rtvdata):

name;connect
dsenable This parameter is only required if you are using the Data Server. Set this parameter to enable data source(s) for data attachments and defined commands that have been configured to bypass data being redirected through the specified data server(s).

dsenable:dskey

Where dskey is the abbreviation for the data source as listed in the Attach to Data and Define Command drop down menus, but in all lower case.

NOTE: Some data sources do not allow direct access from the Display Viewer Applet. Refer to the Data Sources section of this documentation to see if deployment with a Direct Data Connection is supported by your data source.
xmlredirect This parameter is only required if you are using the Data Server. Set to true to redirect XML sources that do not start with http: or https: through the Data Server. Set to all to redirect all XML sources through the Data Server.  Otherwise, XML sources will be read directly by Enterprise RTView.

Applet Parameters Required for Data Sources

If you are using the Data Server, you do not need to specify any data source information. 

The applet parameters for the Alert and Cache data sources are listed below. If you are using additional data sources, refer to Deployment in the Data Sources section of this documentation for required applet parameters specific to your data source. If you are using history data you must include the SQL data source in your applet. NOTE: To specify multiple data sources for the value of the ds parameter, separate them with a ;.

When finished, go to Part ii: Optional Applet Parameters.

Applet Parameters Required for Alert Data Source
These parameters are only required if you are using the Alert data source. NOTE: Setup is also required for any data sources you used to input data to your alerts.
Include the Alert data source in your applet:
1. Add the following to your ARCHIVE parameter (found under your installation directory in lib):
gmsjalertds.jar
2. Add the following applet parameter:
name = ds
value = com.sl.gmsjalertds.GmsRtViewAlertDs

Applet Parameters Required for Cache Data Source
These parameters are only required if you are using the Cache data source. NOTE: Setup is also required for any data sources you used to input data to your caches.
Include the Cache data source in your applet:
1. Add the following to your ARCHIVE parameter (found under your installation directory in lib):
gmsjcacheds.jar
2. Add the following applet parameter:
name = ds
value = com.sl.gmsjcacheds.GmsRtViewCacheDs

Applet Parameters Required for the TIBCO EMS Manager
 NOTE: These parameters are only required if you are deploying the TIBCO EMS Manager application.
1. Add the following file (found under your installation directory in lib) to the ARCHIVE parameter:
gmsjemsmgr.jar
2. Include the following TIBCO EMS jars, tibjms.jar, jms.jar and tibjmsadmin.jar, in your ARCHIVE parameter if you would like to execute administration commands from the following TIBCO EMS Manager Displays:
Manage Topics (manage_topics.rtv)
Manage Queues (manage_queues.rtv)
Manage Durables (manage_durables.rtv)
Manage Routes (manage_routes.rtv)

 

Part ii: Optional Applet Parameters
Basic optional applet parameters can be specified either in your HTML file or from a configuration file (OPTIONS.ini).

  • To create in an initialization file, see Application Options.
  • To use an initialization file in your applet, include it in the directory containing the HTML file. 

NOTE: Applet parameters you specify in you HTML file will override settings in configuration (.ini) files.

The following can be specified in the applet parameters of your HTML file:

  • basic optional applet parameters;
  • data source optional applet parameters - this is only needed if you are not using the Data Server
Basic Optional Applet Parameters
Parameter Name Description
confirm Set the confirm policy for all commands, overriding the confirm policy on individual objects.

Accepted values:
-1 - do not confirm any commands
 1 - confirm all commands
 0 - follow individual object confirm policy
historytablename Specify the table name (e.g., MY_TABLE) to use when loading historical data into graphs. NOTE: Table names cannot contain spaces.
nohistory Set to true to suppress historical data in graphs. Default is false.
panelconfig Specify the name of the panel configuration file for Multiple Display Panels.
resizeMode

Controls object layout when display window is resized. In the Display Builder, the selected Resize Mode is only applied to drill down windows. The main window of the Display Builder is always in Crop mode.

All three resize modes support zooming the display (right-click -> zoom). In both Scale and Layout modes if the window is resized while the display is zoomed, then the resize will further zoom the display.

Accepted values:
crop When the window is resized, the display stays the same size. If the window is bigger than the display, empty space will show around the display. If the window is smaller than the display, scrollbars will be added. The window is not forced to maintain its aspect ratio. This is the default for the Thin Client.
scale When the window is resized, the display and all of the objects in it are scaled to fit the available space. The window is forced to maintain its aspect ratio. This is the default for the Display Builder, Display Viewer Application and Display Viewer Applet.
layout When the window is resized, the display is resized to fit the available space. The objects in the display are positioned according to their anchor and dock properties. The window is not forced to maintain its aspect ratio.

Objects that are not docked or anchored will move relative to their offset from the top left corner of the display. For example, if the object is centered on the display, the object will move 50% of the resize amount. If the object is centered at 3/4 of the display, it will move 75% of the resize amount.

rtvpass If login is enabled, specify the password in plain text to use for the login. This parameter must be used in conjunction with rtvuser and will bypass the login dialog. If the rtvrole parameter is not specified for a user with multiple roles, the first role will be used.  Use the rtvsign parameter instead to specify an encoded user name and password. 
NOTE: If the user name or password specified is not valid, the login dialog will appear.
rtvrole If login is enabled, specify the role to use for the login. This parameter must be used with rtvsign or rtvuser and rtvpass. If this parameter is not specified for a user with multiple roles, the first role will be used.
rtvsign If login is enabled, specify an encoded user name and password to use for the login, and bypass the login dialog. Contact SL Technical Support at support@sl.com to request a copy of the utility to create the encoded strings. If the rtvrole parameter is not specified for a user with multiple roles, the first role will be used. 
NOTE: If the user name or password specified is not valid, the login dialog will appear.
rtvuser If login is enabled, specify the user name in plain text to use for the login. This parameter must be used in conjunction with rtvpass and will bypass the login dialog. If the rtvrole parameter is not specified for a user with multiple roles, the first role will be used.  Use the rtvsign parameter instead to specify an encoded user name and password. NOTE: If the user name or password specified is not valid, the login dialog will appear.
singleclick Set to true to enable opening drill down windows or executing commands with a single click. Default is true.
sub Add a substitution string/value pair using the syntax substring:subvalue substring2:subvalue2

If a substitution value contains a single quote, it must be escaped using a / :

$filter:Plant=/'Dallas/'

If a substitution value contains a space, it must be enclosed in single quotes. Do not escape these single quotes:

$subname:subvalue $subname2:'sub value 2'
NOTE:  Substitution strings cannot contain the following:
:
|
.
tab
space
,
;
=
<
>
'
"
 & / \ { } [ ] ( )

timezone Set the default timezone for interpreting and displaying dates. Include a Java timezone ID or a custom ID, such as "GMT-8:00".  Unrecognized IDs will be treated as GMT.

If you run the Enterprise RTView Builder with a valid timezone parameter and then save Application Options, the timezone information will be persisted. To prevent the persisted timezone value from being used, pass "none" as the timezone ID.
update_period Set update rate in milliseconds.

 

Optional Applet Parameters for Data Sources

If you are using the Data Server, you do not need to specify any data source information. 

The applet parameters for the Alert and Cache data sources are listed below. If you are using additional data sources, refer to Deployment in the Data Sources section of this documentation for optional applet parameters specific to your data source.

 

Optional Applet Parameters for Alert Data Source

The following parameters can be specified in your HTML file, otherwise they will be read from ALERTOPTIONS.ini.
Parameter Name Description
alertds:history Sets the number of rows that are stored in the AlertTable.
alertds:alertdef Adds an alert definition file. Cannot specify substitutions. To specify substitutions, use the Application Options dialog.
alertcleartime Specifies the rate, in seconds, to remove cleared alerts. If set to greater than zero, all cleared alerts are removed every x seconds where x is the value specified.
alertinitdelay The number of seconds to wait after startup to begin executing alerts.
alertds:enabled Enables/disables all alerts in the active alert definition files.


 

 

 Hosting the Applet 

System Requirements
The system where you host the Display Viewer Applet must meet the following requirements:
  • Application server.
  • Basic system requirements
  • If you are not using the Data Server, 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.

Installing the Applet 

1. Create a project directory to store all files needed by the Display Viewer Applet.

2. Copy the following files into the directory you just created:

  • HTML file containing an instance of the Display Viewer Applet

  • From the lib directory of your Enterprise RTView installation:

    • all .jar files added to the ARCHIVE parameter in your HTML file

  • From the project directory of your Enterprise RTView installation:

    • OPTIONS.ini
    • COLORS.ini (only required if Custom Colors have been defined)

    • .jar file containing custom classes (optional)

    • Panel configuration file (optional)

    • All display (.rtv) files 

    • Refer to Deployment in the Data Sources section of this documentation for information on configuration (.ini) files specific to your data sources.

    • Security configuration files (optional)

  • KEYS (see Registration, next)

NOTE: The .jar files 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.
3. Install this directory to your application server according to documentation for that product.

Registration
At this point you have verified system requirements, configured and installed the applet.

Display Viewer Applet requires a separate license key from the Enterprise RTView application to run on a 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

Report Servlet 

The Display Viewer Applet uses a Report Servlet to support exporting PDF reports. If you do not want to generate reports, you can skip this setup. Your Enterprise 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 this setup.

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

Install and Setup Report Servlet
The servlets\rtvreport directory contains all of the files necessary to install the Report Servlet.

1.    In an initialized command window, go to the servlets\rtvreport directory and type:
 
make_war  This script creates a web archive (.war) named rtvreport.war that includes all of the files necessary to run the Report Servlet.
 

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

install_to_tomcat rtvreport This script installs the web archive rtvreport.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 rtvreport.war file to your application server according to the documentation for that product.

 

Browser Client

System Requirements
Each client must meet all of the following requirements:
 
  • Java Plugin 1.5.0_01+
  • Browser: IE4.0+ (other browsers also work)
  • In addition to basic system requirements, if you are not using the Data Server, refer to the Data Sources section of this documentation for system requirements specific to your data source.
  • To enable copying tables to the clipboard, the client must have the following permission on their Java security settings:
     
    permission java.awt.AWTPermission "accessClipboard";
  • In order to use the Send Email system command you must modify the Java security settings on each client to include the following permissions. Where SMTPHostName is the name of the SMTP server, SMTPHostIP is the IP address of the SMTP server and <> in the FilePermission is the name of the file to be attached to the email.
     
    permission java.net.SocketPermission "SMTPHostName", "resolve";
    permission java.net.SocketPermission "SMTPHostIP", "accept, connect, listen, resolve";
    permission java.util.PropertyPermission "user.name", "read"; };
    permission java.io.FilePermission "<>", "read";
  • The Send SNMP Trap command requires outgoing access to UDP port 162 (or a different port as specified in your command).
  •  In order to use the Topmost Window Mode on drill down windows, depending on your Security Manager, you may need to modify the Java security settings on each client to include the following permission: 
    permission java.awt.AWTPermission "setWindowAlwaysOnTop”;

Setup Client for Additional Data Sources
If you are using additional data sources and you are not using the Data Server, refer to Deployment in the Data Sources section of this documentation for information on client setup specific to your data source. NOTE: If you are using history data you must complete SQL setup.

 

Accessing the Project
1. Open a browser and navigate to the URL for the applet. NOTE: Multiple applets running in the same VM will share a single Custom Color tab.

2. Login to the Display Viewer Applet. By default, the Display Viewer Applet does not require a login. Login can be enabled at setup to support role based security. The default user name and password are:
User Name: admin
Password: admin

NOTE: It is possible that your system administrator may have configured another user name and password. In this case, you may also need to select a role.

For troubleshooting information, see Display Viewer Applet Troubleshooting.

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
   

 
Enterprise RTView contains components licensed under the Apache License Version 2.0.

 

Treemap Algorithms v1.0  is used without modifications and licensed by MPL Version 1.1. Copyright © 2001 University of Maryland, College Park, MD

 

Datejs is licensed under MIT. Copyright © Coolite Inc.

 

JCalendar 1.3.2 is licensed under LGPL. Copyright © Kai Toedter.

 

jQuery is licensed under MIT. Copyright © John Resig,

 
JMS, JMX and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. They are mentioned in this document for identification purposes only. 

 
SL, SL-GMS, GMS, Enterprise RTView, SL Corporation, and the SL logo are trademarks or registered trademarks of Sherrill-Lubinski Corporation in the United States and other countries. Copyright © 1998-2009 Sherrill-Lubinski Corporation. All Rights Reserved.