Enterprise RTView® 
User Guide


Command Line Options: Historian

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

Example:
run_historian -daemon

filename Add a data configuration (.rtv) file to the Historian.

Example:
run_historian config.rtv

-verbose Set the Show Data in Console flag to true so that a line is printed to the console for each record that is stored in the database.

Example:
-verbose

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

Example:
-jmxport:9996

-noreset Do not clear database tables before storing new data.

Example:
-noreset

-cachesize:(records) Set the cache size.  The Historian will cache the specified number of records and then commit them all to the database at one time.

Example:
-cachesize:50

-cachetime:(seconds) Set the cache time.  The Historian will cache records for the specified number of seconds and then commit them all to the database at one time.

Example:
-cachetime:60

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

Example:
-u5000 (updates every 5 seconds)
-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/'

-tablename:(tablename) Specify the table name (e.g., MY_TABLE) to use when archiving data. NOTE: Table names cannot contain spaces. The name you specify will be used for the numeric table and an _S will be appended to that name for the string table (e.g., MY_TABLE_S). 

Example:
-tablename:MY_TABLE

-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. If set to greater than zero, all cleared alerts are removed every x seconds where x is the value specified.

Example:
-alertcleartime:30000
-alertinitdelay:(number of milliseconds) The number of seconds to wait after startup to begin executing alerts.

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

Example:
-alertds:enabled:false
 


 
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-2008 Sherrill-Lubinski Corporation. All Rights Reserved.

 
JMS, JMX and Java are trademarks and/or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. They are mentioned in this document for identification purposes only.