Mapping extended data elements in the Common Base Event format to Enterprise Console event format

When a CBE event is mapped to a Enterprise Console event class in the rule base, each extended data element is mapped to an attribute in the resulting Enterprise Console event.

If the complete name of an extended data element does not match the name of an attribute in the the Enterprise Console event class definition, the extended data element is discarded.

Table 1 illustrates the mapping of an CBE extended data element to attributes in a Enterprise Console event.

Extended Data Element sub-field

Enterprise Console attribute

extendedDataElement.name

attribute name

extendedDataElement.type

indicate whether the Enterprise Console attribute value is a simple value or an array.

extendedDataElement.values

attribute value

extendedDataElement.children

each extended data element child element is converted to another attribute in the Enterprise Console event. The process is repeated recursively until there are no more sub-elements inside the extended data element. See the "Name" section for details about the resulting attribute name in the Enterprise Console event.

Table 1. Mapping of CBE extended data elements to Enterprise Console attributes.


The following sections explain in details how each attribute of a CBE event definition is mapped to an attribute in a Enterprise Console event class definition:

Name

An extendedDataElement can be nested inside another extendedDataElement. The name of the resulting attribute in the Enterprise Console event class definition is formed by the concatenation of the names of all extendedDataElements starting from the top-most ancestor until the name of the element being mapped. The "." (period) character is used as the separator.

As an example, consider a CBE event with the following extended data elements

<CommonBaseEvent ...>
    <extendedDataElements name="abc" type="string">
      <values>my value</values> 
      <children name="def" type="int">  
        <values>123</values> 
      </children>  
    </extendedDataElements>
...
</CommonBaseEvent>

The resulting attributes, and corresponding values, in the Enterprise Console event would be:

abc='my value'
abc.def=123

If the mapped name of an extended data element conflicts with the name of another attribute in the Enterprise Console event, the extended data element is discarded. Refer to the topic "Name conflicts for extended data elements" for more details.

For the same reason, extended data elements with the following names are not be mapped to an attribute in the Enterprise Console event because the conversion algorithm processes basic attributes before extended data elements:

Note:

The name of the resulting attribute may need to be converted to fit the character space used for the attribute names in the Enterprise Console event.

Type and Values

The type sub-field in an extended data element indicates the expected data type for the values inside the element. The extended data element is only mapped to an attribute in the target Enterprise Console event if both types are compatible.

Table 2 illustrates the type compatibility between extended data element types and Enterprise Console attribute types.

Extended Data Element type

Enterprise Console attribute type

  • noValue
  • None, the entire extended data element is ignored
  • byte
  • short
  • INTEGER
  • INT32
  • REAL
  • STRING
  • int
  • long
  • INT32
  • REAL
  • STRING
  • float
  • double
  • REAL
  • STRING
  • string
  • dateTime
  • boolean
  • hexBinary
  • STRING
  • byteArray
  • shortArray
  • LIST_OF INTEGER
  • LIST_OF INT32
  • LIST_OF REAL
  • LIST_OF STRING
  • intArray
  • longArray
  • LIST_OF INT32
  • LIST_OF REAL
  • LIST_OF STRING
  • floatArray
  • doubleArray
  • LIST_OF REAL
  • LIST_OF STRING
  • stringArray
  • dateTimeArray
  • booleanArray
  • LIST_OF STRING

Table 2. Mapping of extended data element types to Enterprise Console attribute types.

As an example, consider a CBE event with the following extended data elements

<CommonBaseEvent extensionName="CustomEvent" ...>
    <extendedDataElements name="slot1" type="string">
      <values>my value1</values> 
      <values>my value2</values> 
      <values>my value3</values> 
    </extendedDataElements>
...
</CommonBaseEvent>

Assuming that the attribute "slot1" for the event class "CustomEvent" in the rule base is defined as a list of strings, the resulting Enterprise Console event would contain the following attribute:

slot1=['my value1', 'my value2', 'my value3']
Notes:
  1. If the complex type of the Enterprise Console attribute is SINGLE STRING and the attribute in the extended data element is an array, the values are concatenated to form the final string.
  2. If the attribute in the extended data element is an array and the complex type of the Enterprise Console attribute is not LIST_OF, the extended data element is discarded.
  3. If the attribute in the extended data element is an array, the type of the attribute is not STRING, and the complex type of the Enterprise Console attribute is SINGLE, the extended data element is discarded.


Related topics

Name conflicts for extended data elements


Parent topic

Converting an event in the Common Base Event format to Enterprise Console event format


Downloads | Library | Support | Terms of Use | Feedback

(C) Copyright IBM Corporation 1999,2005. All Rights Reserved.