Usage notes
Extra arguments
In the web interface, the Extra Args is the text area that is used to provide any extra arguments which are not supported through explicit property or configuration. You can use newlines in the Extra args field, and the newlines are treated as a space character. If an argument value has spaces, then the argument must be specified within quotes, for example: --name "Correlator Instance 1".
In the command line interface, the extraArgs is a property that must be updated in the properties file.
If you are updating the configuration type using the command line interface, use the following command to update the configuration of an instance:
sagcc update configuration data nodeAlias runtimeComponentId
configurationInstanceId -i properties file
Use the sagcc get configuration instances command to retrieve information about an instance such as the instance ID, the display name for an instance, and the description for an instance. For example, the following command displays the information of a correlator instance:
sagcc get configuration instances local Apama-correlator-myCorrelator
For more information on extra command line arguments for the correlator, see Deploying and Managing Apama Applications.
For more information on extra command line arguments for the IAF, see Connecting Apama Applications to External Components.
For more information on extra arguments for the display server and data server, see Building and Using Apama Dashboards.
Examples when executing on Command Central
To update the configuration type for a correlator instance:
sagcc update configuration data local
Apama-correlator-myCorrelator APAMA-ARGS -i C:\CorrelatorProps.properties
To update the configuration type for an IAF instance:
sagcc update configuration data local
Apama-iaf-myIAF APAMA-ARGS -i C:\IafProps.properties
To update the configuration type for a display server instance:
sagcc update configuration data local
Apama-displayserver-myDisplayServer APAMA-ARGS
-i C:\DisplayServerProps.properties
To update the configuration type for a data server instance:
sagcc update configuration data local
Apama-dataserver-myDataServer APAMA-ARGS -i C:\DataserverProps.properties
Example format of a properties file for a correlator:
extraArgs= -V DEBUG
logLevel=CRIT
inputLog=default-correlator-input_testing.log
outputLog=testing.log
enableCorrelatorPersistence=true
persistentDatastorePath=C:\myStore.db
clearPersistentStateOnStartup=true
Example format of a properties file for an IAF:
extraArgs= -v INFO
iafConfigFile= C:\iaf-config.xml
logLevel=DEBUG
outputLog=C:\output.txt
Example format of a properties file for a display server:
extraArgs= -v INFO
logLevel=DEBUG
outputLog=C:\output.txt
connectMode=always
dashboardExtraJars=${APAMA_WORK}/extra1.jar;${APAMA_WORK}/extra2.jar
enhancedQuery=true
inclusionFilter=DV_StatisticalArbitrage
Example format of a properties file for a data server:
extraArgs= -v INFO
logLevel=DEBUG
outputLog=C:\output.txt
connectMode=always
namedServerMode=true
dashboardExtraJars=${APAMA_WORK}/extra1.jar;${APAMA_WORK}/extra2.jar
enhancedQuery=true
exclusionFilter=DV_Weather