Command Line Options: Data Server
The
following command line arguments are enabled when you run
the Data 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 Data
Server as a daemon process. NOTE: This parameter must be the first command
line argument given.
Example:
run_dataserver
-daemon
|
| -dataout:(path) |
Set the path of the XML output to
a directory other than the local directory. You can specify both an absolute
path or a relative path. Double quotes are required if the path contains
spaces. Example:
-dataout:"c:\rtview files\rtvdata.xml" |
| filename |
Add a data configuration
(.rtv) file to the Data Server.
Example:
run_dataserver
config.rtv
|
| -jmxport:(port
number) |
The port number
to use to expose JMX methods to monitor
and manage the Data Server. There is no default port. If not specified,
these JMX methods will not be accessible.
Example:
-jmxport:9997
|
| -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
|
| -port:(port number) |
Specify port when Data Server is set
to output data via socket. Default is 3278.
Example:
run_dataserver
-socket
-port:8723
|
| -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 |
| -sendalldata |
Send all data
over the socket regardless of whether or not it has been updated.
Example:
-sendalldata
|
| -socket |
Set the Data
Server to output data via socket.
Example:
run_dataserver
-socket
|
| -standby:warm |
Run a
backup Data 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:
run_dataserver
-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:$data:myData
-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) |
| -verbose |
Set the Show Data in Console flag
to true so that a line is printed to the console for each records that
is stored in the database.
Example:
-verbose
|
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 |
|
