Common base event format

The common base event format is based on the Common Base Event specification version 1.0.1, an XML-based format, using the xs:any slot in the common base event schema for the CICS® event data. It can be used by any consumer that can recognize the common base event 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.

This code fragment shows the format emitted if you select the common base event 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 format example

<?xml version="1.0"?>
<cbe:CommonBaseEvent xmlns:cbe="https://www.ibm.com/AC/commonbaseevent1_0_1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="1.0.1"
creationTime="{yyyy-mm-ddThh:mm:ssZ}">
<cbe:sourceComponentId component="IBM CICS TS#5.3.0"
componentIdType="ProductName" executionEnvironment="IBM z/OS"
instanceId="{NETQUAL}.{APPLID}" location="{MVSSYSTEM}"
locationType="Hostname" subComponent="CICS EP"
componentType="https://www.ibm.com/xmlns/prod/cics/eventprocessing" />
<cbe:situation categoryName="OtherSituation">
<cbe:situationType xsi:type="OtherSituation"
reasoningScope="EXTERNAL">
<CICSApplicationEvent/>
</cbe:situationType>
</cbe:situation>
<cics:event
xmlns:cics="https://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:ss.mmmZ</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="https://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>
</cbe:CommonBaseEvent>

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

The xs:any element in a CICS common base event event format contains both a static part (<cics:event> tag), which is the same for every CICS common base event format, 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 the location: /usr/lpp/cicsts/cicsts53 /schemas/eventprocessing/eventformats/cics_cbe_static.xsd. You can export the dynamic schema for a CICS common base event event format from the Adapter tab in the Event binding editor; see Specifying adapter and dispatcher information 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.

When sending CICS common base event format events to an event consumer that does not recognize the common base event format, for example, IBM WebSphere® Message Broker, use the static XML schema for the common base event format. For more information, see Common Base Event XML schema.