Enterprise RTView® 
User Guide


Command Line Options: Display Builder and Display Viewer

The following command line arguments are enabled when you run the Display Builder or Display Viewer from a Windows Command Prompt or UNIX terminal window. For command line options for your data source, refer to the Data Sources section of this documentation.

NOTE: If a command line argument contains a space or a semicolon, then the entire argument must be enclosed in quotes (e.g.: "-sub:$data:my Data").
 
Name Description
filename Open a specific file in the Display Builder or Display Viewer. NOTE: If your login doesn't allow you to view a particular display, the display will not open when you use the filename option.

Example:
sample.rtv
-historytablename:(tablename) Specify the table name (e.g., MY_TABLE) to use when loading historical data into graphs. NOTE: Table names cannot contain spaces.

Example:
-historytablename:MY_TABLE
-login Turns on role based security. A login dialog will come up at startup. 

Example:
-login
-max_displays_in_cache Sets the maximum number of display (.rtv) files with composite objects to cache. Default is 5. If value is set to 0, no displays are cached.

Example:
-max_displays_in_cache:50

-nomenus Display Viewer only. Run without menus.

Example:
-nomenus
-noedit Display Builder only. Run with editing disabled. 

Example:
-noedit
-panelconfig:(filename) Specify the name of the panel configuration file for Multiple Display Panels.

Example:
-panelconfig:PANELS_GRID.ini
-resizemode:(mode)

Globally controls object layout when a display window is resized. It is also possible to set a specific Resize Mode for each particular display (.rtv) file using the Background Properties dialog.

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.

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.

Example:
-resizemode:layout

-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.


Example:
-rtvpass:admin
-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. 

Example:
-rtvrole:admin
-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. 


Example:
-rtvsign:8I559A5NA8A5864J6J924N0B2 
-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.

Example:
-rtvuser:admin
-dataserver: (filename) Read data from Data Server output file instead of directly from data sources .If no file name is specified, default output file (rtvdata.xml) will be used. If necessary, include local directory path or http URL.

Example:
-dataserver:rtvdata.xml
remote:primary,backup1 Read data from Data Server instead of directly from data sources. Specify primary and backup servers. If no host is specified, local host will be used. If no port is specified, default port (3278) will be used. Designation of a backup server is optional; one or multiple backup servers can be specified.

Example:
-dataserver:remote:host:8723,host:8080
remote:http://host:port/rtvdata,http://host:port/rtvdata_backup1

 

Read data from Data Server via servlet instead of directly from data sources. Specify primary and backup servers. The host is web server hosting the servlet. The port is port used by the web server. Designation of a backup server is optional; one or multiple backup servers can be specified.

Example:
-dataserver:remote:http://host:8723/rtvdata,http://host:8080/rtvdata_backup
name=Name;connect=primary,backup1

Specify primary and backup named data server(s).

The name is the Name specified when this data server was configured and connect is either host:port or, for servlet, http://host:port/rtvdata. Designation of a backup server is optional; one or multiple backup servers can be specified.

Example:
-dataserver:name=MyDataServer;connect=localhost:56789,host:8080
-dataserver:name=London;connect=https://londonServer:8080/rtvdata,
http://host:8080/rtvdata_backup

-dsenable:(dskey) 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).

The 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.

Example:
-dsenable:sql

-u(milliseconds) Set update rate in milliseconds. Default is 2000.

Example:
-u5000 (updates every 5 seconds)
-confirm:(policy value) Set the confirm policy for all commands, overriding the confirm policy on individual objects. Default is 0.

Values:
-1 - do not confirm any commands
 1 - confirm all commands
 0 - follow individual object confirm policy


Example:
-confirm:-1

-saveusers Saves the user definition file with encoded passwords. The file is only saved if you are logged in in the admin role and you are not using the Custom User Manager.

Example:
-saveusers
-sub:(substring:subvalue) Add a substitution string/value pair. Multiple substitution pairs can be specified on the command line. NOTE:Substitution strings cannot contain the following:
 
:
|
.
tab
space
,
;
=
<
>
'
"
& / \ { } [ ] ( )

If your substitution value contains single quotes, you must escape them using a /.

Example:
-sub:$1:myValue
-sub:$filter:Plant=/'SanFrancisco/'

-singleclick Single-click to open drill down windows or execute commands. This is the default setting. NOTE: This option applies to the Display Viewer only.

Example:
-singleclick
-nosingleclick Disables the default setting. Double-click to open drill down windows or execute commands. NOTE: This option applies to the Display Viewer only.

Example:
-nosingleclick
-nohistory Supress historical data in graphs.

Example:
-nohistory
-resetlayout Display Builder only. Starts with the default window layout.

Example:
-resetlayout
-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.

Example:
-timezone:US/Eastern 
-timezone:none

Options Enabled with Alerts
In addition to the General Options, the following command line arguments are enabled with the Alert data source.

Name Description
-alertds:history:(size of table) Sets the number of rows that are stored in the AlertTable.

Example:
-alertds:history:1000
-alertds:alertdef:(filename) Adds an alert definition file. Cannot specify substitutions. To specify substitutions, use the Application Options dialog.

Example:
-alertds:alertdef:
myalerts.rtv
-alertcleartime:(number of seconds) Specifies the rate, in seconds, to remove cleared alerts.

Example:
-alertcleartime:3
-alertinitdelay:(number of seconds) Specifies the duration, in seconds, to wait after startup to begin executing alerts.

Example:
-alertinitdelay:5
-alertds:enabled:(true or false) Enables/disables all alerts in the active alert definition files.

Example:
-alertds:enabled:false
 

 
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.