| Name |
Description |
| -bg
|
Set the RTView application to run as a background process. When this option is
specified, the GmsLauncher process and run scripts exit immediately after the
RTView application is started, rather than continuing to run, thereby reducing
the host system process count. However, note that:
- The RTView application output and error
messages will not appear in the command/shell window from which it was
launched.
- Ctrl-c cannot be used to terminate the
application.
NOTE: This option is only recognized on the
command line and is not read from, or saved to, any RTView options (.ini)
files.
Example:
-bg |
| -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 |
| -customwindowtitle:(title) |
Specify a custom window title.
To specify an empty window title, enter
a single space. By default, window titles contain the
name of the application followed by the name of the display (.rtv)
file (e.g. RTView mydisplay.rtv).
A Custom Window Title:
Example:
-customWindowTitle:myTitle |
| -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.
NOTE: 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.
NOTE: 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.
NOTE:
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 |
| 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 |
| -fxreplace |
Replace all Fx graphs with standard
graphs in display (.rtv) files opened in the in the Display Builder and/or
Display Viewer Application.
Example:
-fxreplace
NOTE: The
fxreplace option can
also be specified as true in the initialization file OPTIONS.ini
file. Options specified using command line arguments override values
saved in initialization files. |
| -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 |
| -logdir:(dirname) |
Specify to prefix the log file name that is set in the -logfile option to
the directory name in which the log file is stored. If the -logfile option is not specified, this
option is ignored. NOTE: This option is only recognized on the
command line and is not read from, or saved to, any RTView options (.ini)
files.
Example:
-logdir:ABCcompany |
| -logfile:(filename)
|
Specify the redirection of output and error messages to a file. The RTView
application output and error message streams are redirected to the specified
file. The file is created if it does not exist. If the file does exist, its
previous contents are cleared.
NOTE: This option is only recognized on the command
line and is not read from, or saved to, any RTView options (.ini) files.
Example:
-logfile:Builder.log |
| -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 |
| -noedit |
Display
Builder only. Run with editing disabled.
Example:
-noedit |
| -nohistory |
Supress
historical data in graphs.
Example:
-nohistory |
| -nomenus |
Display
Viewer only. Run without menus.
Example:
-nomenus |
| -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 |
| -panelconfig:(filename) |
Specify
the name of the panel configuration file for Multiple
Display Panels.
Example:
-panelconfig:PANELS_GRID.ini |
| -processName |
Specify to identify applications running as
background processes. This option tags a unique identifier onto RTView
server instances, enabling you to differentiate between multiple instances of
those RTView applications. This option allows you to stop a particular instance
without eliminating the other instances. If no process name is specified, the
RTView application name is used as the process name.
For example,
run_builder-processName:XX
adds the following JVM option to the Java call:
-DPROCESS_NAME=XX
Where XX is the value you specified for the -processName argument.
NOTE: Values with spaces cannot be used for this option on Unix.
Example:
-processName:XX |
| -resetlayout |
Display
Builder only. Starts with the default window layout.
Example:
-resetlayout |
| -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 |
| -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 |
| -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 |
|
-stylesheet:(filename) |
Specify style sheet(s) to apply to all displays in your applications. NOTE: Style sheets are
applied at startup. If you edit a style sheet, then you need
to restart.
Example:
-stylesheet:rtv_darkstyles.rts
When multiple style sheet (.rts) files are
applied, they are
processed in the order specified. Therefore if the same property is specified in
multiple style sheets, the value in the last style sheet applied (e.g.
stylesheet3.rts) will take precedence.
Example:
-stylesheet:stylesheet1.rts,stylesheet2.rts,stylesheet3.rts. |
| -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) |
