IBM MQ EP adapter

The IBM® MQ EP adapter emits events to a queue in IBM MQ either in one of the XML formats or in binary format.

IBM MQ on z/OS® is a prerequisite for using and implementing the IBM MQ EP adapter. To use the IBM MQ EP adapter, you must set up the CICS-IBM MQ adapter to provide a connection between the CICS region and IBM MQ on z/OS. For more information, see Setting up the CICS-MQ adapter.

The IBM MQ EP adapter places CICS® events on the queue that is specified in the EP Adapter specification; the events are placed on the queue in these formats:
The IBM MQ EP adapter supports these emission and transactional modes. The letter x indicates a supported combination of modes.
Table 1. IBM MQ EP adapter emission and transactional modes
Event processing adapter Emission mode Transactional mode Notes
SYNC ASYNC TRANS NONTRANS
IBM MQ x   x   Event emission is assured by using synchronous emission mode. For the IBM MQ EP adapter, event delivery is assured when synchronous emission mode is used in combination with persistent queues.
x     x
  x x  
  x   x

The event binding specification provides the queue details to the EP adapter.

Table 2. IBM MQ EP adapter properties
Data element Description
Queue name The name of the queue where the message is placed. This element is mandatory; there is no default.

For more information, see MQOD object descriptor.

Persistent Whether the messages are persistent in the IBM MQ infrastructure. The available options are YES, NO, or QUEUE DEFAULT. The last option is the default setting, defining that the persistence of the queue is to be used.

For more information, see MQMD persistence field.

Priority The priority of the message in the IBM MQ infrastructure; the default is no priority specification with a valid range of 0 to 99999999.

For more information, see MQMD priority field.

Expiry time The expiry time in milliseconds.

For more information, see MQMD expiry field.

Format The event format: CICS Flattened Event, Common Base Event, Decision Server Insights, or WebSphere Business Events.

You specify business events and the CICS EP adapters that they use by using the Event binding editor. For more information about adapter properties and supported formats, see Specifying EP adapter and dispatcher information in the CICS Explorer product documentation.

When using IBM MQ as the transport for either the WebSphere Business Event or common base event form of the event, the message is placed on the message queue as UTF-8 with escape sequences for the restricted characters:

Table 3. Restricted characters and their escape sequences
Character Escape sequence
& &amp
< &lt
> &gt
" &quot
' &apos