Common base event REST format

The common base event REST format is a basic XML representation of a CICS event. The common base event REST format can be consumed by any event processing HTTP server that requires events in XML format.

You specify the event format you want to 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.

This format is an XML-based format that represents the CICS event. The format is identical to the XML in the xs:any slot of the common base event format.

This code fragment shows the format emitted if you select the common base event REST format in the Event binding editor. Fields later in this section in braces {} are fields that are derived from either the captured event or the CICS® region on which the event was captured.

Figure 1. common base event REST format example

<?xml version="1.0"?>
<cics:event
xmlns:cics="http://www.ibm.com/xmlns/prod/cics/events/CBE">
<cics:context-info>
<cics:eventname>{BusinessEvent}</cics:eventname>
<cics:usertag>{User Tag}</cics:usertag>
<cics:networkapplid>{NETQUAL}.{APPLID}</cics:networkapplid>
<cics:timestamp>yyyy-mm-ddThh:mm:ssZ</cics:timestamp>  1 
<cics:bindingname>{Event Binding Name}</cics:bindingname>
<cics:capturespecname >{Capture Spec Name}</cics:capturespecname >
<cics:UOWid>{network unit of work id}</cics:UOWid>
</cics:context-info>
<cics:payload-data>
<data:payload xmlns:data="http://www.ibm.com/prod/cics/{User Tag}/{BusinessEvent}">
<data:customer>IBM</data:customer>
<data:orderValue>10250</data:orderValue>
<data:orderReference>QWERTY098765</data:orderReference>
</data:payload>
</cics:payload-data>
</cics:event>

Note: 1 All events are emitted with Coordinated Universal Time (UTC) timestamps.

The CICS common base event REST format contains both a static part (<cics:event> tag), which is the same for every CICS common base event REST event, and a dynamic part (<data:payload> tag), which is different for each event specification. The static and dynamic parts are described by separate XML schemas.

The static XML schema is installed with CICS in: /usr/lpp/cists55 /schemas/eventprocessing/eventformats/cics_cbe_static.xsd. You can export the dynamic schema for a common base event REST format event from the Adapter tab in the Event binding editor; see Specifying EP adapter and dispatcher information in the CICS Explorer product documentation for more details.

The CICS event context and payload data are contained in the <cics:context-info> and <cics:payload-data> child elements of the <cics:event> element. The dynamic schema provides the mapping for the payload data.