Enterprise RTView® 
User Guide


Creating Display Servlet HTML Files

The Display Servlet comes with a few HTML files for testing. You can use these to deploy, or you can create your own HTML files which reference getdisplay.jsp to show the specified display (.rtv) file. getdisplay.jsp supports three parameters:

getdisplay.jsp Parameters
Parameter Description
display The name of the display (.rtv) file to show.
refresh The refresh rate (in seconds) at which the display inside this URL should be refreshed. Set to 0 if you do not want displays periodically refreshed. NOTE: This refresh rate overrides the rtvRefreshInterval property. If no refresh rate is specified, the interval defined in the rtvdisplay.properties file will be used unless you have set a value for rtvRefreshInterval. This parameter is optional.
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. Any non-alphanumeric characters in the parameter value must be URL encoded as %xx, where xx is the hexadecimal value of the ASCII character.
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. Any non-alphanumeric characters in the parameter value must be URL encoded as %xx, where xx is the hexadecimal value of the ASCII character.
NOTE: It may be necessary to URL-encode the username, password, or role, depending on the characters they contain.
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. Any non-alphanumeric characters in the parameter value must be URL encoded as %xx, where xx is the hexadecimal value of the ASCII character.
NOTE: If the user name or password specified is not valid, the login dialog will appear.
subs The substitution(s) to apply to the display. To specify multiple substitutions, separate them with a + (plus). If a substitution value contains a single quote, escape it with a / (forward slash). If a substitution value contains a space, enclose it in single quotes (do not escape these quotes) and replace the space with a +. Any non-alphanumeric characters in the parameter value must be URL encoded as %xx, where xx is the hexadecimal value of the ASCII character. This parameter is optional.

For example:

   getdisplay.jsp?display=MyDisplay&refresh=30&subs=$sub1:Hello+$sub2:'value+2&rtvsign=8I559A5NA8A5864J6J924N0B2

The HTML returned by getdisplay.jsp is only suitable to be displayed as an entire page, in a window, frame or iframe, so it can be used only in the href tag for links, or the src tag for frames and iframes:

        <A HREF="getdisplay.jsp?display=MyDisplay"> View My Display </A>
        <FRAME SRC="getdisplay.jsp?display=MyDisplay">
        <IFRAME SRC="getdisplay.jsp?display=MyDisplay">

The demos\esphere example shows how to setup a navigation frame on the left that uses getdisplay.jsp to load displays into the main frame. To show multiple displays on the same page, use frames or iframes to display the HTML from getdisplay.jsp. If the name of the frame or iframe corresponds to the window name specified in a drill down target, drill downs on that object update the named frame.

As an alternative, refer to the Multiple Display Panels section for information on how you can use Enterprise RTView to generate a navigation frame for your display. Once you've created a navigation tree definition as described, reference it from an iframe in your .html file as follows:

<iframe name="navtree" id="navtree" src="navtree.xml"scrolling="yes"></iframe>

See demos\dstututorial\displayserver\index.html or servlets\ocmonitor\index.html for an example.

NOTE: If you are referencing getdisplay.jsp from multiple HTML files in a frameset, and login is enabled, a login screen will appear for each HTML file. To bypass this, go to login.jsp to login and redirect to your page (where display1.html is the name of your page):

        <script> location.href = "login.jsp?destPath=display1.html"; </script>
 
 
 
 
   


 
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.