Apama 10.15.5 | Connecting Apama Applications to External Components | Working with IAF Plug-ins | Using the IAF | The IAF configuration file | Defining Universal Messaging properties for the IAF
 
Defining Universal Messaging properties for the IAF
Note: 
Use of Universal Messaging from the IAF is deprecated and will be removed in a future release. It is recommended that you now change any IAF-based adapter configurations using Universal Messaging with a <universal-messaging> element in the configuration file to use an <apama> element to talk directly to the correlator. See Apama correlator configuration.
The IAF 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.
A Universal Messaging properties file for the IAF 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, the IAF 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: 
The IAF 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 one of the following:
*autocreate
The IAF looks up only channels whose names begin with the specified prefix. If the channel does not exist, it is created. For example, if the default prefix is used, channel names must start with UM_ for the channel to be a Universal Messaging channel.
*mixed
The IAF looks up each channel to determine if it is a Universal Messaging channel. If the channel does not exist, it is created only if it has the prefix specified by the um.channels.prefix property.
*precreate
Requires Universal Messaging channels to be created by using Universal Messaging Enterprise Manager or Universal Messaging client APIs. The IAF looks up all channels (except the default "" channel) to determine whether they are Universal Messaging channels. If a channel does not exist as a Universal Messaging channel, it is not created.
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). 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.
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 the IAF is encoded in UTF-8.