Exporting event specifications

You can export descriptions for one or more event specifications in your event binding as a schema or copybook for use elsewhere.

Before you begin

You must have a CICS® bundle project that contains an event binding file, and specify the EP adapter to use for the event binding.

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

  1. From the Adapter tab in the CICS event binding editor, click Export Event Specifications.
  2. You will be prompted to choose an adapter or adapter set in any of the cases:
    • In your workspace, more than one EP adapter has the same name as the specified adapter or an adapter in the specified EP adapter set.
      The Choose the EP Adapter window
    • In your workspace, more than one EP adapter set has the specified name.
      The Choose the EP Adapter Set window
  3. In the Export Event Specifications for Rule window, ensure correct information is specified in corresponding fields:
    The Export Specifications window
    Export
    The event specifications that you want to export.
    To Directory
    The local directory to which you want to save the exported event specifications.
    Data Format
    The data format specified in your EP adapter, or the EP adapter in your EP adapter set.

    This field is displayed when CICS Explorer® cannot determine the data format because the EP adapter, EP adapter set, or an EP adapter within the EP adapter set is not in your workspace.

    Note: Ensure the data format information matches that specified in your EP adapters, otherwise it might fail when you use the exported files for data processing.
  4. Click OK.
  5. If an exported event specification with the same name already exists in the specified directory, you are prompted whether to overwrite the existing file or cancel the export.

Results

One or more files are created in the specified directory for each event specification that you selected. The following examples show the files that are created for different event specifications:
  • If you specify the IBM MQ Queue adapter and the Common Base Event format and select two event specifications that are called example1 and example2, two XML schema files are created: example1_CBE.xsd and example2_CBE.xsd. You can import these schema files to IBM Business Monitor to help define an inbound event.
  • If you specify the IBM MQ Queue adapter and the WebSphere Business Events (XML) format and select an event specification that is called example1, an XML schema file is created, called example1_WBE.xsd. You can use this schema file in the IBM Operational Decision Manager Event Designer tool to help define an event.
  • If you specify the IBM MQ Queue adapter and the Decision Server Insights Event (XML) format and select an event specification that is called example1, an XML schema file is created, called example1_DSIE.xsd. You can use this schema file in the IBM Operational Decision Manager Insight® Designer tool to help define an event.
  • If you specify the TD or TS Queue adapter and the CICS Flattened Event format and select two event specifications that are 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.
  • If you specify an EP adapter set that has a TD or TS Queue adapter (CICS Flattened Event format) and the IBM MQ Queue adapter (WebSphere Business Events (XML) format), and you then select two event specifications that are called example1 and example2, four files are created with the name suffix that indicates the format: example1.cpy, example1_WBE.xsd, example2.cpy, and example2_WBE.xsd. You can use these files in your programs and in the IBM Operational Decision Manager Event Designer tool.
  • If you specify an EP adapter set that has a TD or TS Queue adapter (CICS Flattened Event format) and the IBM MQ Queue adapter (Decision Server Insights Event (XML) format), and you then select two event specifications that are called example1 and example2, four files are created with the name suffix that indicates the format: example1.cpy, example1_DSIE.xsd, example2.cpy, and example2_DSIE.xsd. You can use these files in your programs and in the IBM Operational Decision Manager Insight Designer tool.