Defining UM properties for Apama applications
When you start a correlator and you want that correlator to use UM, instead of specifying the
--rnames option you might want to specify a file that defines UM properties for your Apama application. This is an Apama file (a standard Java properties file) that lists UM configuration details. You can specify a properties file with the
-UMconfig option when you start a correlator. See
Starting correlators that use UM. This file is separate from the service configuration file that you might specify for the
-Xconfig option at correlator start-up.
Another place where you can specify a UM properties file is in the
<universal-messaging> element of an adapter configuration file. See
Configuring adapters to use UM.
Apama provides the UM-config.properties template file in the etc folder of your Apama installation directory. The template is for a standard Java properties file. When you use Apama Studio to add UM configuration to a project, Apama Studio copies the UM-config.properties file to the config folder in your project. The recommendation is to use one properties file for all Apama components.
A UM properties file for Apama can contain entries for the following properties:
Property name | Description | Default |
um.channels.mode | | precreate |
um.channels.prefix | Specifies a prefix for channel names. Channel names must have this prefix to allow dynamic creation. | UM_ |
um.install.dir | Location in the UM installation of the UM libraries for the platform this properties file is being used on. | None |
um.realms | List of RNAME values (URLs). This is the same value you might specify for the --rnames option when you start a correlator. You can use commas or semicolons as separators. Commas indicate that you want the adapter to try to connect to the UM realms in the order in which you specify them here. Semicolons indicate that the adapter can try to connect to the specified UM realms in any order. See Starting correlators that use UM for more information. Every RNAME you specify must belong to the same UM cluster. | Required |
um.security.certificatefile | Security certificate used to connect to UM. | None |
um.security.certificatepassword | Password for the specified security certificate file. | None |
um.security.truststorefile | Certificate authority file for verifying server certificate. | None |
um.security.user | User name supplied to the UM realm. | Current user name from the operating system |
For example, a UM properties file for an Apama installation running on Windows 64 might contain the following:
um.realms=nsp://localhost:5629
um.security.user=ckent
um.channels.mode=autocreate
um.install.dir=C:/SoftwareAG/UniversalMessaging/cplus/lib/x86_64
The UM configuration file for Apama is encoded in UTF-8.