| Name |
Description |
| -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
|
| -daemon |
Run the Historian as a daemon process.
NOTE: This parameter must be the first command line argument given.
Example:
run_historian
-daemon
|
| -dbname:(name) |
Set the name of the history
database.
NOTE: This name must match the Data Source Name specified when you registered
your database with ODBC, as well as the name of the history database configured in
the Display Builder's SQL Application Options tab.
Example:
-dbname:RTVHISTORY
|
| filename |
Add
a data configuration (.rtv) file to the Historian.
Example:
run_historian
config.rtv
|
| -insertcolumnnames |
Include column names in
the database insert statements for user-defined tables. This is useful when the
Historian is adding data to existing tables and the column order is not an exact
match or the insert statement contains a subset of the existing table columns.
NOTE: This option does not apply to the HISTORY and
HISTORY_S tables.
Example:
-insertcolumnnames |
| -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
|
| -rebuildtables |
Rebuild HISTORY and HISTORY_S tables
on startup of the Historian. User-defined tables will be rebuilt as data is
received for each table. NOTE: Do not use
-rebuildtables in conjunction with the -smoothCompaction option
because older data will be lost when the Historian tables are rebuilt.
Example:
-rebuildtables |
| -smoothcompaction |
Based on specified
compactionRules, perform compaction on old data that currently exists in
your database from prior executions of the Historian. NOTE: This command line
option applies to
Advanced Historian users only.
- Use the -noreset option together with
the -smoothcompaction option to preserve older data in the Historian
tables.
- Do not use the -rebuildtables option in
conjunction with -smoothCompaction because older data will be lost when
the Historian tables are rebuilt.
NOTE: The -smoothcompaction option is not
recommended if the Historian has a heavy load of data to process or the
Historian database is being used by other applications.
Example:
-smoothcompaction |
| -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
|
| -timestamp:(type) |
Specify the type of timestamp.
There are three options:
| none |
No TIMESTAMP
column is stored. |
| sql |
A single
TIMESTAMP column is stored using a standard SQL TIMESTAMP data type. |
| str |
Two TIMESTAMP
columns are stored with each record as strings. |
Example:
-timestamp:sql |
| -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 record that is stored in the database.
Example:
-verbose
|
| 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 |
