| Name |
Description |
| Historian and Advanced Historian |
Advanced Historian Only |
| -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 |
|
| -cachelast |
Store
only the last (most
recent) values in the cache for each unique data attachment. By default, the
Historian stores all records in the cache each time the -cachesize or -cachetime
limit is reached.
This option allows the Historian
to store less data than it receives, which can be useful in a configuration where the Historian receives data from the
Data Server at a higher rate than necessary for historical storage.
Example:
-cachelast |
|
| -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
|
|
|
-compactiontimerinterval |
|
Specifies
the time interval, in seconds, for the compaction thread to sleep before
checking for work. The default is 5 seconds. Example:
-compactiontimerinterval:5 |
| -compactionverbose:n |
|
Specifies
whether and how to output to the console. There are three options:
0 - No information is output to the
console.
1 -
Summary information is output to the console.
2 - Debug-level information is
output to the console.
Example:
-compactionverbose:1 |
| -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
|
|
| -logdir |
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 |
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:Historian.log |
|
| nogui |
Specifies
to run the Historian as a daemon process. NOTE: This parameter must be the first
command line argument given.
Example:
run_historian -nogui |
|
| -noreset |
Do not clear database tables before
storing new data.
Example:
-noreset
|
This option does not apply to the Advanced
Historian. |
| -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 |
|
|
-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. Example:
-rebuildtables |
Do not use
-rebuildtables in conjunction with the -smoothCompaction option
because older data will be lost when the Historian tables are rebuilt. |
| -retention |
Specify (in minutes) the
length of time records can exist before they are deleted.
Example:
-retention:5 |
In the Advanced Historian,
compactionRules specify how long records can exist before they are
compacted or deleted. Go to Caches>Introduction>Historian Properties. |
| -retentionMax |
Specify (in minutes) the
maximum length of time that may pass before retention processing is performed.
NOTE: If the -retention
time set is shorter than the specified -retentionMax, then the record's
retention span is used.
Example:
-retentionMax:60 |
Specify (in minutes) the maximum length of time that
may pass before retention processing is performed -- this setting only
applies to the compaction rule with the longest retention amount.
For tables that do not have compactionRules set,
this option defaults to basic Historian behavior.
NOTE: If the span of the compaction rule with the
longest retention amount is shorter than the specified -retentionMax, then the
compaction rule span is used.
Example:-
-retentionMax:60 |
| -smoothcompaction |
|
Based on specified
compactionRules, perform compaction on old data that currently exists in
your database from prior executions of the Historian.
Do not use the -rebuildtables option in
conjunction with -smoothCompaction because older data will be lost when
the Historian tables are rebuilt.
Example:
-smoothcompaction
NOTE: This 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.
|
| -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
|
|
