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 will happen to events created by this binding. You select the
EP adapter to emit events, then select options relevant to the EP adapter.
- Click the
Adapter
tab in the
CICS® event binding editor. The adapter pane is where you specify the type of EP adapter 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 four EP adapter types:
- TS Queue
- Emits events to a named CICS TS queue.
This EP adapter can be used 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. The transaction
is passed data in a container-based event format.
You can specify the CICS system that will 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. It must not carry out
any other processing, such as consumption of the event.
- WMQ Queue
- Emits events to a WebSphere MQ 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 binary format.
- Specify the options for your chosen EP adapter type. The options for each EP adapter type are explained
below:
- 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 which is started by the transaction start EP adapter will run under 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. You must specify a transaction ID.
- Write the data to be passed to the Custom EP adapter. Your Custom EP adapter will process 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 adapter are nonpersistent.
- Yes
- Messages put on the queue by the 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 period of 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 of time 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 binary 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 Monitor
- Messages are put on the queue in the CBE event format required by WebSphere
Business Monitor.
- Optional: You can export one or
more event specifications in this event binding.
- If you are using the WMQ Queue adapter and the Common Base Event format, the exported file will be an XML
schema definition (.xsd) file.
- If you are using the WMQ Queue adapter and the WebSphere Business Events (XML) format, the exported file will be an XML
schema definition (.xsd) file.
- If your chosen adapter and data format emit events to a system in a binary format, the exported file will be a COBOL
copybook (.cpy) file. The TS Queue adapter and the WMQ Queue adapter using the CICS Flattened Event format emit events
in a binary format.
- Click Export Event Specifications. The Export Event Specifications window is displayed.
- Select the event specifications that you want to export
- Specify a directory to export the event specifications to in the To directory field.
- Click Export.
A file is created in the specified directory for each event specification that you selected.
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 this schema file to
WebSphere
Business Monitor to help define an inbound event.
If you
specify the WMQ Queue adapter and the WebSphere Business Events (XML) format and
select
an event specification called example1, an XML schema file are 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 TS Queue 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 control the way in which the EP adapter is run in a CICS
system.
- 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, or a Custom EP
adapter). The EP adapter program will run under this Transaction ID.
If you do not specify a Transaction ID, and you do not specify a User ID, the EP adapter is linked to under 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 with the User ID under which the event was captured.
If you specify a User ID, but you do not specify a Transacation ID, the EP adapter will run under the
default transaction for the EP adapter type:
- The WMQ Queue EP adapter
runs under the CEPQ transaction.
- The TS Queue EP adapter
runs under the CEPT transaction.
- Specify the System ID (only available for the CICS Transaction EP adapter). The EP adapter transaction will run on the CICS system with this System ID.
- Specify whether events are transactional. Select the
Events are Transactional
checkbox 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
checkbox if you want CICS to process events associated with this event binding outside a transaction. Events will be emitted as they are produced.
Results
The adapter and dispatcher information for your event binding is now complete.