Apama Documentation : Connecting Apama Applications to External Components : Using Message Services : Using Universal Messaging in Apama Applications : Legacy Universal Messaging integration : Defining Universal Messaging properties for Apama applications
Defining Universal Messaging properties for Apama applications
Note:  
The information in this topic is deprecated. It applies to the old Universal Messaging integration which will be removed in a future release. It is recommended that you use the new Universal Messaging connectivity plug-in.
When you start a correlator and you want that correlator to use Universal Messaging, instead of specifying the --rnames option, you might want to specify a file that defines Universal Messaging properties for your Apama application. This is an Apama file (a standard Java properties file) that lists Universal Messaging configuration details. You can specify a properties file with the -UMconfig option when you start a correlator. See Starting correlators that use Universal Messaging.
Another place where you can specify a Universal Messaging properties file is in the <universal-messaging> element of an adapter configuration file. See Configuring adapters to use Universal Messaging.
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 in Software AG Designer to add Universal Messaging configuration to a project, Software AG Designer 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 Universal Messaging properties file for Apama can contain entries for the following properties:
Property name
Description
um.channels.escaped
Specifies whether channel names are escaped (true) or not (false). When set to false, Apama passes channel names directly to Universal Messaging without escaping. In addition, when the slash (/) and backslash (\) characters are not escaped, they can be used to create nested channels.
Caution:  
Apama treats slash (/) and backslash (\) as different characters while Universal Messaging treats them as identical characters (Universal Messaging generally changes a backslash to a slash). You must choose to use one of these characters in your application and standardize on this. Use of both characters as path separators will result in undefined behavior.
When escaping is disabled (false), you must be careful not to use characters which are not supported by Universal Messaging (see the Universal Messaging documentation for the most up to date list of supported characters and character sets).
Default: true.
um.channels.mode
Indicates whether Universal Messaging channels can be dynamically created. Specify autocreate, mixed, or precreate. See Enabling automatic creation of Universal Messaging channels.
Default: precreate.
um.channels.prefix
Specifies a prefix for channel names. Channel names must have this prefix to allow dynamic creation.
Default: UM_.
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 Universal Messaging realms in the order in which you specify them here. Semicolons indicate that the adapter can try to connect to the specified Universal Messaging realms in any order. See Starting correlators that use Universal Messaging for more information.
Every RNAME you specify must belong to the same Universal Messaging cluster.
Default: Required.
um.security.certificatefile
Security certificate used to connect to Universal Messaging.
Default: None.
um.security.certificatepassword
Password for the specified security certificate file.
Default: None.
um.security.truststorefile
Certificate authority file for verifying server certificate.
Default: None.
um.security.user
User name supplied to the Universal Messaging realm.
Default: Current user name from the operating system.
um.session.pool
Configures how many Universal Messaging sessions to use. More sessions can increase throughput by allowing events to be sent in parallel, but may consume more CPU.
Note that if you are using the SHM protocol to communicate with the broker, you will probably want to limit the number of sessions to 1 or 2, as SHM connections will consume 2 CPU cores for each session.
Default: 8.
For example, a Universal Messaging 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
The Universal Messaging configuration file for Apama is encoded in UTF-8.
Copyright © 2013-2017 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback