Enterprise RTView® 
User Guide


Command Line Options: Display Server  

The following command line arguments are enabled when you run the Display Server  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
-daemon Run the Display Server as a daemon process. NOTE: This parameter must be the first command line argument given.

Example:
run_displayserver -daemon

-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

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

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

-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

//(host:port)

Read data from Data Server via socket instead of directly from data sources. If no host is specified, local host will be used. If no port is specified, default port (3278) will be used.

Example:
-dataserver://remotehost:8723

remote:http://host:port/rtvdata

Read data from Data Server via servlet instead of directly from socket. The host is web server hosting the servlet. The port is port used by the web server.

Example:
-dataserver:remote:http://host:port/rtvdata

name;connect

Specify named data server(s). The name is the Name specified when this data server was configured and connect is either host:port or http://host:port/rtvdata.

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

-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

-imageformat Specify image format: jpg or png. By default, the Display Server will automatically select the image that results in the fewer number of bytes for each display.

Example:
-imageformat:jpg

-imagequality: A value between 0 and 100 which controls the quality of the generated images. If the value is 100, the Display Server will output the highest quality image with the lowest compression. If the value is 0, the Display Server will output the lowest quality image using the highest compression. Default is 75.

Example:
-imagequality:75

-jmxport:(port number) The port number to use to expose JMX methods to monitor and manage the Display Server. There is no default port. If not specified, these JMX methods will not be accessible.

Example:
-jmxport:9998

-passclientlogin Pass Enterprise RTView login information into all data sources that have the Use Client Credentials option enabled.

NOTE: Some data sources do not support this feature. For information on Application Options for your data source, refer to the Data Sources section of this documentation.

Example:
-passclientlogin

-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

-standby:warm Run a backup Display Server without the overhead of maintaining the Alert and Cache data sources.

The following actions will be delayed until the backup server has become the primary:

  • Loading definition files (i.e. Global, Alert, Cache)
  • Preloading display files specified in initialization (.ini) files or on the command line

NOTE: Although the -standby:warm option reduces overhead because data sources do not provide data until a failover, it is important to note that Alert and Cache data definitions will not start collecting data until the first client connects. Therefore, any previous alert state or cached data from the primary server will not be available to the backup.

Example:
-standby:warm

-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/'

-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

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

Example:
-u5000 (updates every 5 seconds)

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.