-B logical-name:host:port | --namedServer logical-name:host:port

Sets the host and port for a specified logical data server name. This overrides the host and port specified by the Dashboard Builder for the given server logical name. This option can occur multiple times in a single command. See Working with multiple data servers for more information.

-c logical-name:host:port:bool | --correlator logical-name:host:port:bool

Sets the correlator host and port for a specified logical correlator name. bool is one of true and false, and specifies whether to use the raw channel for communication. This overrides the host, port, and raw-channel setting specified by the Dashboard Builder for the given correlator logical name. See Changing correlator definitions for deployment. This option can occur multiple times in a single command. For example:

These options set the host and port for the logical names default and work1.

-D directory | --dashboard directory

Start with the dashboard found in the specified directory.

-E bool | --purgeOnEdit bool

Specifies whether to purge all trend data when a DataView item is edited. bool is one of true and false. If this option is not specified, all trend data is purged when an instance is edited. In most cases, this is the desired mode of operation.

-F arg | --filterInstance arg

Exclude instances which are not owned by the user. This option applies to all dashboard processes. Default is false for Dashboard Builder and true for the other dashboard processes.

Exception: when the Dashboard Viewer is connecting to a dashboard server, the default is true and cannot be overridden.

-f file | --logfile file

Full pathname of the file in which to record logging. If this option is not specified, the options in the log4j properties file are used. See also Text internationalization in the logs.

-G file | --trendConfigFile file

Trend configuration file for controlling trend-data caching.

-h | --help

Emit usage information and then exit.

-J file | --jaasFile file

Full pathname of the JAAS initialization file to be used by the data server. If not specified, the data server uses the file JAAS.ini in the lib directory of your Apama installation.

-L file | --xmlSource file

XML data source file. If file contains static data, append :0 to the file name. This signals Apama to read the file only once.

-m mode | --connectMode mode

Correlator-connect mode. mode is one of always and asNeeded. If always is specified all correlators are connected to at startup. If asNeeded is specified, the data server connects to correlators as needed. If this option is not specified, the data server connects to correlators as needed.

-N name | --name name

Set the component name for identification in the correlator. The default name is Dashboard Builder: username.

-n | --noSplash

Do not display splash screen in startup.

-O file | --optionsFile file

Use the specified OPTIONS.ini file at startup.

-P n | --maxPrecision n

Maximum number of decimal places to use in numerical values displayed by dashboards. Specify values between 0 and 10, or -1 to disable truncation of decimal places. A typical value for n is 2 or 4, which eliminates long floating point values (for example, 2.2584435234). Truncation is disabled by default.

-q options | --sql options

Configures SQL Data Source access. options has the following form:

retry: Specify the interval (in milliseconds) to retry connecting to a database after an attempt to connect fails. Default is -1, which disables this feature.

fail: Specify the number of consecutive failed SQL queries after which to close this database connection and attempt to reconnect. Default is -1, which disables this feature.

db: Specify the logical name of the database as specified in the builder's SQL options.

nopererr: SQL errors with the word permission in them will not be printed to the console. This is helpful if you have selected the Use Client Credentials option for a database. In this case, if your login does not allow access for some data in their display, you will not see any errors.

quote: Encloses all table and column names specified in the Attach to SQL Data dialog in quotes when an SQL query is run. This is useful when attaching to databases that support quoted case-sensitive table and column names. If a case-sensitive table or column name is used in the Filter field, or you are entering an advanced query in the SQL Query field, they must be entered in quotes, even if the -sqlquote option is specified.

-R bool | --purgeOnRemove bool

Specifies whether to purge all DataView data when an instance or item is removed. bool is one of true and false. If this option is not specified, all DataView data is purged when an instance or item is removed.

-S variable:value | --sub variable:value

Specifies a value to substitute for a given dashboard variable. This can be used to parameterize a dashboard at startup. This option can occur multiple times in a single command. For example:

If the value contains a space, enclose the value in double quotes. If the value contains a double quote, you must escape it by using a backslash character (\).

-T depth | --maxTrend depth

Maximum depth for trend data, that is, the maximum number of events in trend tables. If this option is not specified, the maximum trend depth is 1000. Note that the higher you set this value, the more memory the data server requires, and the more time it requires in order to display trend and stock charts.

-t value | --title value

Text for the title bar of the Dashboard Builder main window.

-u rate | --updateRate rate

Data update rate in milliseconds. This is the rate at which the data server pushes new data to deployed dashboards in order to inform them of new events received from the correlator. rate should be no lower than 250. If the Dashboard Viewer is utilizing too much CPU, you can lower the update rate by specifying a higher value. If this option is not specified, an update rate of 500 milliseconds is used.

-V | --version

Emit program name and version number and then exit.

-v level | --loglevel level

Logging verbosity. level is one of FATAL, ERROR, WARN, INFO, DEBUG, and TRACE. If this option is not specified, the options in the log4j properties file will be used.

-w bool | --disconnectWarning bool

By default, the Dashboard Builder will display a warning dialog when the connection to a correlator is lost. Specify false to disable the display of this dialog.

-X file | --extensionFile file

Full pathname of the JAAS initialization file to be used by the data server. If not specified, the data server uses the file EXTENSIONS.ini in the lib directory of your Apama installation.

-x table-name:key-list | --queryIndex table-name:key-list

Add an index for the specified SQL-based instance table with the specified compound key. table-name is the name of a DataView. key-list is a comma-separated list of variable names or field names. If the specified DataView exists in multiple correlators that are connected to the dashboard server, the index is added to each corresponding data table. Example:

You can only add one index per table, but you can specify this option multiple times in a single command line in order to index multiple tables.

-Y | --enhancedQuery

Make SQL-based instance tables available as data tables for visualization attachments. See Attaching Dashboards to Correlator Data.

-z zone | --timezone zone

Default time zone for interpreting and displaying dates. zone is either a Java time zone ID or a custom ID such as GMT-8:00.  Unrecognized IDs are treated as GMT.  See Time Zone ID Values for the complete listing of permissible values for zone.

Set DataView exclusion filters. This option can occur multiple times in a single command.

Set DataView inclusion filters. This option can occur multiple times in a single command.