Configuration types that the Apama correlator supports

Configuration Type

Use to configure...

APAMA-ARGS

Use to configure command line arguments that are not represented by any other configuration type. For the correlator, the following properties are available:

extraArgs. for more information, see Extra arguments.

Logging properties. For more information, see Component logging.

Persistence properties. For more information, see The correlator persistence properties.

Connectivity configuration. For more information, see Deploying Apama applications with a YAML configuration file

COMMON-PORTS

Use to configure ports for Apama component instances. The available property for the correlator is port. For more information, see Component ports.

COMMON-LICENSE

Use to set the license key file assigned to the license key alias of the correlator run-time component. For more information, see The correlator license key.

COMMON-LICLOC

This configuration type contains the location of the license key file. After you set the license key file using the COMMON-LICENSE configuration type, the license key file information is available at APAMA_HOME/command-central/instances/correlator/instancename / ApamaCorrelatorLicense.xml. This license key location is stored in COMMON-LICLOC configuration type. This configuration type is read-only. This configuration type is not available in the web interface.

APAMA-ENVVAR

Use to define the environment variables. The defined variables are set when you start the instances. You must define the environment variables in the properties file. For more information, see Apama environment variables.

APAMA-ENGINE-CONNECT

Use to connect a source correlator (the sender) to a target correlator (the receiver). The target correlator will receive events from the specified channels of the source correlator. For more information, see Correlator connections.

APAMA-CORRELATOR-INITIALIZE

Sets an Apama application to initialize the correlator on startup. To use this feature, you must set the initializePath property. This property specifies a file or directory indicating the files that make up the Apama application. The path can be one of the following:

A text file containing a list of files making up the application. For example, .mon, .jar, .qry, .evt. The correlator initialization fails if any of the named files does not exist.

A directory containing the files making up the application. For example, .mon, .jar, .qry, .evt.

A .deploy file. The deployment file contains the launch configuration information to launch an Apama project. You can locate the deployment file in the project's config\launch folder. For more information, see Default launch configuration and Exporting to a deployment script.

A .deploy file with correlator. If there are multiple correlators in a deployment file, you can specify the correlator for initialization. For example, C:\project.deploy!defaultCorrelator

A .yaml file containing a list of files making up the application. For example, .mon, .jar, .evt. The correlator initialization fails if any of the named files does not exist.

A Correlator Deployment Package (.cdp) file. The CDP file contains the files making up the application. For more information, see Exporting correlator deployment packages.

Note:

Any Apama projects that make use of digital events can be initialized using a .deploy or .yaml file.

initializePropertiesFile. Optionally, specify a properties file containing any ${var} property substitutions required in the deployment path text file and deployment files.

For more information, see Correlator initializations.

APAMA-CORRELATOR-APP-MONITORING

Use to create, and monitor status and KPIs of an EPL application. The configuration values are a comma separated list of SUBCOMPONENT_ID strings. The SUMCOMPONENT_ID strings represent the EPL application names. The EPL files are injected into the correlator to publish the status and KPIs in Command Central. For more information, see Monitoring the KPIs for EPL applications and connectivity plug-ins.