Options | Description |
-A | --sendAllData | Send all data over the socket regardless of whether or not it has been updated. |
-a | --authUsers bool | Specifies whether to enable user authentication. bool is one of true and false. By default, authentication is enabled. Set --authUsers to false for Web deployments for which authentication is performed by the Web layer. |
-c | --correlator logical-name:host:port:raw-channel | Sets the Correlator host and port for a specified logical Correlator name. raw-channel 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 in the Preparing Dashboards for Deployment chapter of the Using Apama Studio.This option can occur multiple times in a single command. For example: -c default:localhost:15903:false –c work1:somehost:19999:false These options set the host and port for the logical names default and work1. |
-d | --dataPort port | Data Server or Display Server port to which Viewers (for local deployments) or the data servlet (for Web deployments) will connect in order to receive event data. If not specified, the default port (3278 for Data Servers and 3279 for Display Servers) is used. |
-E | --purgeOnEdit bool | Specifies whether to purge all trend data when a Scenario instance 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 | --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 will be used. |
-G | --trendConfigFile file | Trend configuration file for controlling trend-data caching. |
-h | --help | Emit usage information and then exit. |
-J | --jaasFile file | Full pathname of the JAAS initialization file to be used by the Data Server or Display Server. If not specified, the Server uses the file JAAS.ini in the lib directory of your Apama installation. |
-L | --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 | --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 or Display Server connects to Correlators as needed. If this option is not specified, the Server connects to Correlators as needed. |
-N | --name name | Component name for identification in correlator |
--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. |
--namedServerMode | Dashboard data server only. Specify this option when you start a data server that is used as a named server by a display-server deployment. See Working with multiple Data Servers for more information. |
-O | --optionsFile file | Full path of OPTIONS.ini |
-P | --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. |
-p | --port port | Port on which this Data Server or Display Server will listen for management operations. This is the port used for communication between the Server and the dashboard_management.exe process (on Windows) or dashboard_management process (on UNIX). |
-Q | --queueLimit size | Set the server output queue size to size. This changes the default queue size for each client that is connected to the server. |
-R | --purgeOnRemove bool | Specifies whether to purge all Scenario data when an instance is removed. bool is one of true and false. If this option is not specified, all Scenario data is purged when an instance is removed. |
-r | --cacheUsers bool | Specifies whether to cache and reuse user authorization information. bool is one of true and false. Specifying true can improve performance, because users are authorized only once (per Data Server or Display Server session) for a particular type of access to particular Scenario or Scenario Instance. |
-s | --ssl | Enable secure sockets for client communication. When secure sockets are enabled, the Data Server will encrypt data transmitted to Dashboard Viewers. Encryption is done using the strongest cipher available to both the Data Server and Viewer. SSL certificates are not supported. The Display Server does not support this option. |
-T | --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 or Display Server requires, and the more time it requires in order to display trend and stock charts. |
-t | --cacheAuthorizations bool | Cache and reuse scenario instance authorizations. Caching authorizations is enabled by default. When caching is enabled, authorization checks are performed only once per user for each scenario or data view they access. Disabling caching allows the current state of the scenario or data view to be used in the authorization check, but can degrade performance. |
-u | --updateRate rate | Data update rate in milliseconds. This is the rate at which the Data Server or Display 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 | --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. |
-X | --extensionFile file | Full pathname of the extensions initialization file to be used by the Data Server or Display Server. If not specified, the Server uses the file EXTENSIONS.ini in the lib directory of your Apama installation. |
-x | --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 scenario or DataView. key-list is a comma-separated list of varaible names or field names. If the specified scenario or DataView exists in multiple correlators that are connected to the dashboard server, the index is added to each corresponding data table.Example: --queryIndex Products_Table:prod_id,vend_id 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 in Building Dashboards. |
-z | --timezone zone | Default time zone for interpreting and displaying dates. zone is either a Java timezone ID or a custom ID such as GMT-8:00. Unrecognized IDs are treated as GMT. See Appendix A of the Dashboard Viewer guide for the complete listing of permissible values for zone. |
--inclusionFilter value | Set scenario inclusion filters. Use this option to control scenario/DataView discovery. If not specified, all scenario/DataViews will be discovered and kept in the memory of the dashboard processes, which can be expensive. For example, to include only the DV_Weather DataView, specify --inclusionFilter DV_Weather. The value can be a comma-separated list of scenario or DataView IDs. If you specify an inclusion filter, any specified exclusion filters are ignored. |
--exclusionFilter value | Set scenario exclusion filters. Use this option to exclude specific scenarios/DataViews from being kept in the memory of the dashboard processes. If neither exclusion filters nor inclusion filters are specified, all scenario/DataViews will be discovered and kept in the memory of the dashboard processes, which can be expensive. The value can be a comma-separated list of scenario or DataView IDs. If an inclusion filter is specified, any exclusion filters are ignored. |