The correlator-integrated messaging for JMS configuration consists of a set of XML files and .properties files.

A correlator that supports JMS has the following two files:

In addition, for each JMS connection added to the configuration, there will be an additional XML and .properties file :

When the correlator is started with the --jmsConfig configDir argument, it will load all XML files matching *-spring.xml in the specified configuration directory, and also all *.properties files in the same directory. (Note, the correlator will not start unless the specified directory contains at least one configuration file.)

Global configuration that is shared across all a correlator's connections is stored in jms-global-spring.xml, the rules for mapping between JMS messages and Apama events are stored in jms-mapping-spring.xml, and the connectionId-spring.xml files contain the configuration for each JMS broker connection added to the configuration. Each XML file can contain ${...} property placeholders, whose values come from the *.properties files. This provides a way for the configuration to be defined once in the XML files, then customized for development, UAT, and different deployment scenarios by creating separate copies of the .properties files.

When using Apama Studio, all these files are generated automatically. A new connectionId-spring.xml and connectionId-spring.properties file is created when the JMS Configuration Wizard is used to add a JMS connection, and the most commonly used settings can be changed at any time using the correlator-integrated messaging for JMS instance editor window (which rewrites the .properties file whenever the configuration is changed). Apama Studio makes it easy to set and edit basic configuration options with the adapter editor. In addition, the jms-global-spring.xml and connectionId-spring.xml files can be edited manually in Apama Studio to customize more advanced configuration aspects such as advanced sender/receiver settings, logging of messages, etc. To edit the XML, open the correlator-integrated messaging for JMS editor and click on the Advanced tab; the various configuration files can be accessed through the hyperlinks on this tab. Once the editor for an XML file has been opened, you can switch between the Design and Source views using the tabs at the bottom of the editor window.

Note that unlike the other XML files, Apama does not support manual editing of the jms-mapping-spring.xml file in this release, and the format of that file may change at any time without notice. We recommend using Apama Studio for all mapping configuration tasks.