Exporting event specifications from a policy
If a policy rule action is to emit an event, you can export event specifications for that event as a schema or copybook for use elsewhere.
Before you begin
About this task
The exported files contain the format of the event data, which is useful for you to process captured data with your programs or data processing engines.
The data format specified by your chosen EP adapter, or the EP adapter in your chosen EP adapter
set, determines whether the exported file is a schema or a copybook:
- For an XML format such as common base event, common base event REST, Decision Server Insights Event, or WebSphere® Business Events, the exported file is an XML schema definition
.xsd file. The following adapters can emit events in XML character formats:
- HTTP adapter
- TD Queue adapter
- TS Queue adapter
- IBM® MQ Queue adapter
- For a non-XML format, that is, CICS flattened event
format, the exported file is a COBOL copybook .cpy file. The following adapters
can emit events in CICS flattened event format:
- TD Queue adapter
- TS Queue adapter
- IBM MQ Queue adapter
Note: You cannot export event specifications for a Transaction Start adapter or a custom
adapter.
Procedure
Results
One or more files are created in the specified directory for the policy rule. Examples in the following table show files that are created for different events where no event names are specified.
If an event name is specified, it is used as the prefix of the exported file name. For example,
if an event name of event_name is specified in the first example, the output
file is named event_name_dsie_CICS_54.xsd. For instructions about defining
event names, see Creating a policy in a CICS bundle project.
EP adapters or adapter sets | Policy rule | Version | Data format | Exported event specifications |
---|---|---|---|---|
IBM MQ Queue adapter | A file open status system rule | V54 or later | Decision Server Insights Event (XML) format | An XML schema file named fileEnable_rule_dsie_CICS_54.xsd, which you can use in the IBM Operational Decision Manager Insight® Designer tool to help define an event. |
TD or TS Queue adapter | A storage requests task rule | V51 - 53 | common base event REST (XML) format | An XML schema file named cics_policy_event_payload_cbe_CICS_51-53.xsd, which you can import into IBM Business Monitor to define an inbound event. |
V54 or later | An XML schema file named task_rules_payload_cbe_CICS_54.xsd, which you can import into IBM Business Monitor to define an inbound event. | |||
IBM MQ Queue adapter | A file open status system rule | V54 or later | CICS Flattened Event format | A COBOL copybook named DFHMPFEO_CICS_54.cpy, which you can use to process data in your own event consumer programs. |
An EP adapter set that has:
|
A file open status system rule | V54 or later |
CICS Flattened Event format WebSphere Business Events (XML) format |
Two files named DFHMPFEO_CICS_54.cpy and fileEnable_rule_wbe_CICS_54.xsd, which you can use in your programs and in the IBM Operational Decision Manager Event Designer tool. |