You specify information in your event binding that controls
how CICS emits events produced by the event binding.
About this task
You use dispatcher information to define what happens to
events created by this binding. You select the EP adapter to emit
events and then select options relevant to the EP adapter.
Procedure
- Click the Adapter tab in the CICS® event binding editor to specify the EP adapter configuration to use for this event
binding, the parameters for the EP adapter, and any advanced information.
- Choose the EP adapter type from the Adapter list. You can specify the following EP adapter types:
- TS Queue
- Emits events to a named CICS TS
queue. Use this EP adapter to validate
that the correct events are being captured with the correct data,
and to emit events to any consumer that reads from a TS queue.
- Transaction Start
- Emits events to a named CICS transaction.
Data is passed to the transaction in a container-based event format.
You can specify the CICS system
to run the transaction. You can use an existing transaction, if the
event data is not required.
- Custom (User Written)
- Emits events in any format that you require. A custom EP adapter
is a CICS program that you
write to provide a combination of formatting and routing of an event
that is not supported by the CICS-supplied EP adapters. The custom
EP adapter must not carry out any other processing, such as consumption
of the event.
- WMQ Queue
- Emits events to a WebSphere® message
queue either in an XML format for consumption by WebSphere Business Events,
the Common Base Event (CBE) format for WebSphere Business Monitor,
or in a non-XML format.
HTTP
Emits events to an HTTP 1.1 compliant server using HTTP POST in
XML format for consumption by products such as WebSphere Business Events and WebSphere Business Monitor.
- Specify the options for your chosen EP adapter type:
- Specify the following options for the TS Queue EP adapter:
- Specify the CICS queue name. You must specify a queue name.
- If your target queue is remote, specify the System ID.
- Select Use Auxiliary Temporary Storage if
required.
- Specify the following options for the Transaction start EP adapter:
- Specify the transaction ID of the CICS application that runs as
a result of the events. You must specify a transaction ID.
- Specify a transaction user ID. The transaction that is started
by the transaction start EP adapter runs using this user ID.
- Specify the following options for a Custom (User Written) EP adapter:
- Specify the transaction ID for your user-written CICS application
that formats, routes, and emits the event.
- Write the data to be passed to the Custom EP adapter. Your Custom
EP adapter processes this data.
- Specify the following options for the WMQ Queue EP adapter:
- Specify the Queue Name of the WebSphere MQ
queue on which events emitted by this event binding are placed. You
must specify a Queue Name.
- Specify whether messages are persistent. Select one of the following
values from the Persistent list.
- No
- Messages put on the queue by the WMQ EP adapter are nonpersistent.
- Yes
- Messages put on the queue by the WMQ EP adapter are persistent.
- Queue Default
- Messages put on the queue inherit the default persistence of the
named queue.
- Specify the message priority. You can either select the Queue
Default, or type a value in the Priority field,
for the WebSphere MQ message priority, from 0 - 9.
- Specify the expiry time. You can either select Never
Expire or type a value for the WebSphere MQ message expiry
in the Expiry Time field. This time is expressed
in tenths of a second. A message becomes eligible to be discarded
if it has not been removed from the destination queue before this
period elapses.
- Specify a data format for the event. Select one of the following
values from the Data Format list:
- CICS Flattened Event (CFE) format
- Event data is in a non-XML format.
- WebSphere Business Events XML format
- Messages are put on the queue in the XML format required by WebSphere Business Events.
- Common Base Event format for WebSphere Business Monitor
- Messages are put on the queue in the CBE event format required
by WebSphere Business Monitor.

- Specify the following options for the HTTP EP adapter:
- Specify a URIMAP. The name of a URIMAP resource that represents
the connection to the HTTP 1.1 compliant server.
- Specify a data format for the event. Select one of the following
values from the Data Format list.
- Common Base Event REST format for WebSphere Business
Monitor
- Events are sent to an HTTP 1.1 compliant server in an XML format,
as required by WebSphere Business Monitor.
- WebSphere Business Events XML format
- Events are sent to an HTTP 1.1 compliant server in the XML format
required by WebSphere Business Events.
- Common Base Event format for any consumer
- Events are sent to an HTTP 1.1 compliant server in the CBE event
format which is consumable by any product supporting the Common Event
Infrastructure.
- Optional: You can export one or
more event specifications in this event binding.
To
export an event specification:
- Use the TSQ EP adapter or the WMQ EP adapter and choose the CFE
format to emit events in a binary form, so a COBOL copybook (.cpy)
is provided.
- Use any other EP adapter and format to provide an XML schema definition
(.xsd).
- Click Export Event Specifications. The Export Event Specifications window
is displayed.
- Select the event specifications that you want to export.
- To export the event specifications, specify the directory
in the To directory field.
- Click Export.
A file is created in the specified directory for each
event specification that you selected. Here are some example specifications:
- For example, if you specify the WMQ Queue adapter and the Common
Base Event format and select two event specifications called example1 and example2,
two XML schema files are created, example1.xsd and example2.xsd.
You can import these schema files to WebSphere Business Monitor to
help define an inbound event.
- If you specify the WMQ Queue EP adapter and the WebSphere Business
Events (XML) format and select an event specification called example1,
an XML schema file is created, example1.xsd.
You can use this schema file in the WebSphere Business Events Design
Data tool to help define an event.
If you specify the HTTP EP adapter and the Common Base
Event REST format and select two event specifications called example1 and example2,
two XML schema files are created, example1.xsd and example2.xsd.
You can import these schema files to WebSphere Business Monitor to
help define an inbound event. 
If you specify the HTTP EP adapter and the WebSphere
Business Events (XML) format and select an event specification called example1,
an XML schema file is created, example1.xsd.
You can use this schema file in the WebSphere Business Events Design
Data tool to help define an inbound event. 
If you specify the HTTP EP adapter and the Common Base
Event format and select two event specifications called example1 and example2,
two XML schema files are created, example1.xsd and example2.xsd.
You can import these schema files to any consumer that accepts the
CBE format to help define an inbound event.
- If you specify the TS Queue EP adapter and select two event specifications
called example1 and example2,
two COBOL copybooks are created, example1.cpy and example2.cpy.
You can use these copybooks to process data in your own event consumer
programs.
Note that if you export an event specification, and then
export the same event specification again to the same directory, the
CICS event binding editor prompts
you to either overwrite the existing file or cancel the export operation.
- Optional: Specify any required
advanced dispatcher options. These options are for advanced
users, and they control the way in which the EP adapter is run in
a CICS system.
Note: It is generally more efficient to let CICS run
the EP adapter under the dispatcher thread. However, you might need
the EP adapter to be run as a separate transaction; for example, if
you need to run it under a particular user ID that has authority to
write to the WebSphere MQ queue, or you want to control the number
of concurrent EP adapter tasks by using the TRANCLASS settings.
- Specify the dispatch priority. You can specify Normal or High priority
to control how the event dispatcher processes events associated with
this event binding. High priority events are emitted as soon as
they are available based on the Events are Transactional setting.
Normal priority events are emitted as soon as they are available
based on the Events are Transactional setting
but after any outstanding high priority events.
Specify the Transaction ID (not available
for the CICS Transaction EP adapter).
The EP adapter program
runs using this Transaction ID.
If you do not specify a Transaction ID, and you do not specify
a User ID, the HTTP EP adapter is attached and run using the default
transaction CEPH. All other EP adapters are linked to using the dispatcher
transaction.
- Specify the User ID. If you specify a User
ID, the EP adapter transaction runs with this User ID. If you select
Use context User ID, the EP adapter runs using
the User ID which captured the event.
If you specify a User ID,
but you do not specify a Transaction ID, the EP adapter runs using
the default transaction for the EP adapter type:
- The WMQ Queue EP adapter uses the CEPQ transaction.
The HTTP EP adapter uses the CEPH transaction. 
- The TS Queue EP adapter uses the CEPT transaction.
- Specify the System ID, which is available only for the
Transaction EP adapter. The EP adapter transaction runs
on the CICS system with this System ID.
- Specify whether events are transactional. Select
the Events are Transactional check box if you
want CICS to capture events only if the business unit of work (UOW)
associated with the event completes successfully.
Clear the Events are Transactional check
box if you want CICS to process events associated with this event
binding outside a transaction. Events are emitted as they are produced.
Results
The adapter and dispatcher information for your event binding
is now complete.