The structure of delivered events

This section covers the CBE document structure of events delivered to the external JMS queue. Because the CBE event document structure is complex, the description of it is divided into two parts:

For the full canonic description of the CBE structure, see the schema file, located at \B2BIntegrate\events\schemas\commonbaseevent1_0_1.xsd. In the same directory there is an additional schema file, eventdelivery.xsd. This file defines a WebSphere Partner Gateway extension to the main schema, which defines the OtherSituation type of the SituationType type used in the situation element in the main schema. Further information on CBE and the schema can be found at the eclipse.org Web site, in the context of the Hyades project: www.eclipse.org/hyades/

The basic CBE document structure

The root element of a Common Base Event document is a CommonBaseEvent element. The children of the CommonBaseEvent are as follows:

CBE event structure for WebSphere Partner Gateway message events and business document events

This section provides an element by element description of the CBE elements supplied in the event documents generated by the WebSphere Partner Gateway external event delivery system. It includes a detailed list of the main elements' attributes. Some descriptions include a brief example of that element as it would appear in CBE XML for message and business document events, as appropriate.

The CommonBaseEvent element

This is the root element of all CBE event documents. The following table describes this element and its attributes.

Table 3. The CommonBaseEvent element
Property name Description
Version 1.0.1
WebSphere Partner Gateway supports this version of the schema
localInstanceId Unique identifier in the WebSphere Partner Gateway store:
  • Message events: the event ID of the source event
  • Business document events: the UUID of the business document
creationTime Creation time of this CBE event:
  • Message events: the creation time of the event
  • Business document events: since logging time is not stored in business document, set to current time
severity
  • Message events:
    • Debug: 8
    • Information: 10
    • Warn: 30
    • Error: 50
  • Business document events: business documents have no severity level, so this is set at 10 (Information)
priority WebSphere Partner Gateway has no notion of priority. Always set at 50
msg
  • Message event: description of this event is localized.
  • Business document event: not specified
repeatCount Not specified by WebSphere Partner Gateway
elapsedTime Not specified by WebSphere Partner Gateway
extensionName Used to distinguish message events from business document events
  • Message event: BCG_EVENT
  • Business document event:
    BCG_BUSINESSDOCUMENT
sequenceNumber Not specified by WebSphere Partner Gateway

The following sample illustrates the CommonBaseEvent element for a message event:

<cbe:CommonBaseEvent 
         creationTime="2004-06-20T06:26:01"
         extensionName="BCG_EVENT"
         localInstanceId="1087712761674000C766F006F0178601DF89630A39DF6CA"
         msg="ASValidation" 
         priority="50" 
         severity="10"
         version="1.0.1"
         xsi:schemaLocation=
                        "http://www.ibm.com/AC
                        /commonbaseevent1_0_1commonbaseevent1_0_1.xsd">
:
:
<cbe:CommonBaseEvent />

This is a sample of the CommonBaseEvent element for a business document event:

<cbe:CommonBaseEvent 
          creationTime="2004-06-20T06:26:02"
          extensionName="BCG_BUSINESSDOCUMENT"
          localInstanceId="1087712759944000C766F006F017860B7583EB51E26A336"
          priority="50" 
          severity="10" 
          version="1.0.1"
          xsi:schemaLocation="http://www.ibm.com/AC
             /commonbaseevent1_0_1 commonbaseevent1_0_1.xsd">
:
:
<cbe:CommonBaseEvent />

The sourceComponentId element

This element specifies the component that generated the event. WebSphere Partner Gateway fills this in the normal CBE way. Please see the schema for more information.

The situation element

This element describes the type of situation that generated the event. The following table describes this element and its attributes.

Table 4. The situation element
Property name Description
categoryName OtherSituation
reasoningScope INTERNAL
faultType WebSphere Partner Gateway defines this attribute for OtherSituation in the eventdelivery.xsd file.
Message events:
  • SOURCE
  • TARGET
  • SYSTEM
  • UNKNOWN
Business document events:
  • UNKNOWN

This is an example of the situation element for a message event:

<cbe:situation categoryName="OtherSituation">
               <cbe:situationType 
               reasoningScope="INTERNAL" 
                xsi:type="cbe:OtherSituation">
               <bcg:faultType/>
           </cbe:situationType>
</cbe:situation>

The extendedDataElements element

This element captures information not captured directly by the basic CBE structure. The following three tables describe this element, its attributes, and its specialized child elements, covering message event extended elements and business document event extended elements:

Table 5. The extendedDataElements element
Property name Description
name Used to distinguish message events from business document events
  • Message event: BCG_EVENT
  • Business document event:
    BCG_BUSINESSDOCUMENT
type WebSphere Partner Gateway sets this to noValue
children One or more elements are created, depending on the type (message or business document) of event. Descriptions are in the following tables.
Table 6. Message event extended data elements
Name Value
BCG_EVENTCD Event code from the message event
BCG_HOSTIPADDRESS Host IP address. Specified if available
BCG_PARTNERID1 Internal ID for participant. Specified if available
BCG_PARTNERID2 Internal ID for participant. Specified if available
BCG_STACKTRACE Stack trace. Specified if available
BCG_FRIPADDRESS From: IP address. Specified if available
BCG_PARENTBCGDOCID Unique ID for parent business document. Specified if available
BCG_BCGDOCID The ID of the business document with which this message event is associated
Note: Monitoring applications can use this element for correlating this event with any associated business document
BCG_USERID User ID. Specified if available
BCG_BUSINESSID1 From: business ID. Specified if available
BCG_INITBUSINESSID Initiating business ID. Specified if available
BCG_INITASMESSAGEID Initiating AS message ID. Specified if available
BCG_BUSINESSID2 To: business ID. Specified if available

The following example shows a partial example of an extendedDataElements element in a message event.

<cbe:extendedDataElements name="BCG_EVENT" type="noValue">
        <cbe:values/>
               <cbe:children name="BCG_EVENTTIMESTAMP" type="string">
               <cbe:values>1087712761674</cbe:values>
           </cbe:children>
              <cbe:children name="BCG_PARENTBCGDOCID" type="string">
              <cbe:values>1087712759944000C766F006F017860B7583EB51E26A336
              </cbe:values>
          </cbe:children>
              <cbe:children name="BCG_ARGUMENTSTRING" type="string">
              <cbe:values>ASValidation</cbe:values>
          </cbe:children>
              <cbe:children name="BCG_HOSTIPADDRESS" type="string">
             <cbe:values>127.0.0.1</cbe:values>
          </cbe:children>

  :
  :
  :

</cbe:extendedDataElements>
Table 7. The business document event extended data elements
Attribute Value
BCG_BCGDOCID Business document's unique document ID
BCG_PARENTBCGDOCID Document ID for parent business document. Specified if available
BCG_DOCLOCATION Location of business document with complete path. Specified if available
BCG_DOCSTATE Current state of the business document:
  • DOC_IN_PROCESS = "In Process"
  • DOC_SENT = "Sent"
  • DOC_RECEIVED = "Received"
  • DOC_FAILED = "Failed"
BCG_DOCSIZE Obtained from business document. Specified if available
Data related to business document In addition, business document events can contain other information concerning:
  • routing related data
  • flow related data
  • business protocol related data
The name attribute of the child elements is set to one of the constants specified in the BCGDocumentConstants class. See BCGDocumentConstants for further information. Specified only if available.

A partial example of an extendedDataElements element in a business document event follows:

<cbe:extendedDataElements name="BCG_BUSINESSDOCUMENT" type="noValue">
   <cbe:values/>
          <cbe:children name="BCG_BCGDOCID" type="string">
         <cbe:values>1087712755684000C766F006F01786046684D6EAC6FAC22
         </cbe:values>
      </cbe:children>
          <cbe:children name="BCG_DOCLOCATION" type="string">
            <cbe:values>
              /opt/IBM/bcghub/common/data/Inbound/process
              /520/D9
              /1087712753565000C766F006F003149F07FF1FC6C41D8D9.ascontent
        </cbe:values>
      </cbe:children>
          <cbe:children name="BCG_PARENTBCGDOCID" type="string">
        <cbe:values>1087712753565000C766F006F003149F07FF1FC6C41D8D9
        </cbe:values>
      </cbe:children>
          <cbe:children name="BCG_DOCSTATE" type="string">
        <cbe:values>In Process</cbe:values>
      </cbe:children>
          <cbe:children name="BCG_DOCRESTARTED" type="string">
        <cbe:values>false</cbe:values>
      </cbe:children>
          <cbe:children name="BCG_FRPARTNERTYPE" type="string">
        <cbe:values>0</cbe:values>
      </cbe:children>

      :
      :
      :

</cbe:extendedDataElements>

Copyright IBM Corp. 2003, 2005