Description

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

Override default java class name (MyRoleManager) for Custom Role Manager.

Example:

run_viewer -customRoleManagerClassName:com.xyz.RoleMgr

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

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

Specify a display (.rtv) file to serve as a template for new displays. You can edit the template as desired (e.g. add objects). The Builder prompts you for a new file name when you save the changes so that the (original template) remains unchanged.

Example:

run_builder -displayTemplate:MyTemplate.rtv

Property File Example:

sl.rtview.displayTemplate=MyTemplate.rtv

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

Turns on Log4j2 logging for the RTView application. By default, RTView processes (Builder, Viewer, Data Server, Display Server, or Historian) print log messages to the console. To obtain log files, you redirect the RTView application output and error streams to a log file using Log4j2.

After executing this command, the first time-stamped row in the log file appears as follows:

2012-02-02 14:00:54,693 INFO main – [rtview] Log4j2 is being used with sl.log4j.properties as the configuration file.

When Log4j is not in use, the first time-stamped row in the log file appears as follows:

2012-02-03 10:40:31.866 [rtview] Logging redirected for System.out and System.err. Log4j is not in use.

(Note the missing INFO column when Log4j is not in use.)

For example:

run_builder –log4j

run_builder –log4j –log4jlevel:INFO –showlogcat

To run an RTView application as a background process using the -bg command line argument, use the sl-bg.log4j.properties configuration file (which only outputs to a log file rather than to a console).

-bg (background) example:

run_dataserver –bg –log4j –log4jprops:sl-bg.log4j.properties

Note: The logging method from previous versions of RTView does not use Log4j or Log4j2. This previous method of logging is enabled with -logfile and –logdir and is still supported. Do not use both the previous logging method and Log4j2 or you receive the following error message:

ERROR: log4j configuration ERROR - com.sl.rtview.useLog4j is set to true but -logfile redirection is in use. Log4j will not be used.

Specify the .properties file to use to format the Log4j2 log file. By default, sl.log4j.properties is used. Use this to provide a different property file name. The .properties file is searched for inside a .jar/.war file, then searched for in the current directory, and lastly searched for in the %RTV_HOME%/lib directory. The filename can have a path preceding it. For example, C:\mydir\my.log4j.properties.

You can also use Log4j configuration files in the XML format. For example, log4j.xml. For details, see http://wiki.apache.org/logging-log4j/Log4jXmlFormat.

For example:

-log4jprops:mylog4jfile.properties

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

Appends new log file output to the previous file content. That is, if the dataserver.log file already exists, output from the new log process is added to the file, preserving pre-existing content. The file size can grow quite large so it is advisable to periodically rotate the file. On Linux, the logrotate utility can be used to automate this.

For example:

run_dataserver -logfile:dataserver.log -logappend

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

Display Builder only. Run with editing disabled.

Example:

-noedit

Display Viewer only. Run without menus.

Example:

-nomenus

Specifies the palette style to be used at startup. Options are classic or flat.

If the -paletteStyle option is not specified, the style previously selected in the Builder Options dialog is used, and if no style was previously selected in the Builder Options dialog (i.e. a new rtview installation), the flat palette style is used.

Example:

-paletteStyle:flat

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

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:

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 and Display Viewer Application.

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

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

Saves the user definition file with encoded passwords. The file is only saved if you are logged in the admin role and you are not using the Custom User Manager. See Configuration for more information.

Example:

-saveusers

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.

If true, enables the Tab key to switch focus to controls that are inside composite objects (see Composite Object). If false or not specified, the Tab key excludes controls that are inside composite objects. This option applies to the Display Viewer and the Builder preview window only.

Property File Example:

sl.rtview.tabcomposites=true

Command Line Example:

run_viewer -tabcomposites:true

Set update rate in milliseconds. Default is 2000.

Example:

-u5000 (updates every 5 seconds)

Description

Specifies name of the table in the Alert Action Audit Database in which to store the Audit Alert Action information.

Example:

-actionaudittable:ACTION_AUDIT_TABLE

Adds an alert definition file. Cannot specify substitutions. To specify substitutions, use the Application Options - Alerts tab.

Example:

-alertds:alertdef:myalerts.rtv

Sets the number of rows that are stored in the AlertTable.

Example:

-alertds:history:1000

If true, delete entries from the Alert Settings Table for alert names that are not defined in RTView.

Note: This is done at startup after alert configuration files are processed and all of the alerts are loaded.

Example:

-cleansettingstable:true

Specifies what occurs when alert persistence is enabled but cannot be initialized due to a database problem or configuration issue. When false (the default setting), RTView initializes the alerts with persistence disabled. This is consistent with the behavior in releases previous to RTView 6.6.0 and Enterprise Monitor 2.2.0. When true, RTView exits after the persistence initialization has failed without initializing the alerts.

Example:

-exitOnPersistInitFailed:true

Enables\disables updates to the AlertTable when New Data Only is selected and to the Alert Persistence database when the only columns that contain changes for that row are Last Update Time and Count.

By default, the Last Update Time and Count columns are not tracked by the Row Update Time column. To track the updates of the two columns in the Row Update Time column, use the -lutupdatesnewdata command line option.

Example:

-lutupdatesnewdata:true

Specify the amount of time, in seconds, to delay a backup Data Server from reading the alert persistence database during a failover. The default is 5 seconds. Increase the amount of time if the persistence database is slow or if you expect a large number of alerts to change on each update period. Otherwise, there might not be enough time for the failing Data Server to write all the alerts to the database before the backup server reads them.

Note: Even with high availability configurations, there are cases in which some alerts might not be persisted. For example:

In cases where alerts are not persisted, the new primary Data Server generates new alerts if the data is still in an alert state. The new primary Data Server might also re-use ID's that were used by the failed Data Server.

Example:

-persistInitDelayTime:10