Apama 10.15.0 | Connecting Apama Applications to External Components | Standard Connectivity Plug-ins | The Universal Messaging Transport Connectivity Plug-in | Overview of using Universal Messaging in Apama applications | General steps for using Universal Messaging in Apama applications
 
General steps for using Universal Messaging in Apama applications
Before you perform the steps required to use Universal Messaging in an Apama application, consider how your application uses channels. You should know which components need to communicate with each other, which events travel outside a correlator, and which events stay in a single correlator. Understand what channels you need and decide which channels should be Universal Messaging channels and which, if any, should be Apama channels.
For an Apama application to use Universal Messaging, the tasks you must accomplish are:
1. Use Software AG Installer to install both Apama and the Universal Messaging client libraries in the same Software AG installation directory.
2. Plan and implement the configuration of the Universal Messaging cluster that Apama will use. See the Universal Messaging documentation and Setting up Universal Messaging for use by Apama.
3. Use Software AG Designer to add one of the Universal Messaging connectivity bundles to your Apama project. For detailed information, see Adding the Universal Messaging connectivity plug-in to a project.
Note: 
In addition to using Software AG Designer to add bundles, you can also do this using the apama_project command-line tool. See Creating and managing an Apama project from the command line for more information.
4. Open the UM.properties file in your Apama project and specify the location of the Universal Messaging realm server(s) you wish to connect to. You can optionally edit the UM.yaml file if you need to perform more advanced configuration tasks, such as enabling authentication or customizing the way Universal Messaging messages are mapped to Apama events. See Configuring the Universal Messaging connectivity plug-in for detailed information.
5. In your EPL code, subscribe to receive events delivered on Universal Messaging channels. See Subscribing to channels.
As with all connectivity plug-ins, the EPL application is responsible for telling the system when it is ready to start receiving events with onApplicationInitialized. See also Sending and receiving events with connectivity plug-ins.
6. In your EPL code, specify Universal Messaging channels when sending events. See Generating events with the send statement.
7. Monitor the Apama application's use of Universal Messaging. See Monitoring Apama application use of Universal Messaging.