Mapping extended data elements to Enterprise Console event class attributes

Each extendedDataElement element in a CBE event extension definition is mapped to an attribute in the corresponding Enterprise Console event class definition.

Table 1 illustrates the mapping of extendedDataElement in a CBE event extension definition to attributes in a Enterprise Console event class definition.

CBE event extension definition

Enterprise Console event class definition

extendedDataElement.name

attribute name

extendedDataElement.type

attribute type

extendedDataElement.defaultValue
extendedDataElement.defaultHexValue

attribute "default" facet

extendedDataElement.minOccurs

If "0" (zero), the extended data element is not mapped to the Enterprise Console event class definition because all attributes are required by the Enterprise Console server.

extendedDataElement.maxOccurs

Ignored: during a conversion from an event in CBE format to an event in Enterprise Console format, only the first repeat extended data element is mapped.

children extendedDataElement

each extended data element child element is converted to another attribute in the Enterprise Console event class definition. 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 class definition.

Table 1. Mapping of elements in a CBE event definition and attributes in a Enterprise Console event class definitions.


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.

For instance, the CBE event extension definition

<eventDefinition name="Transaction"> parent="event";
    <extendedDataElement name="tx_number" type="string">
        <extendedDataElement name="tx_items" type="string">
            ...
        </extendedDataElement>
    </extendedDataElement>
</eventDefinition>

results in the following Enterprise Console event definition class::

TEC_CLASS :
    Transaction ISA EVENT
    DEFINES {
        tx_number: STRING;
        tx_number.tx_items: STRING;
        ...
    }
END
Notes:
  1. 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.
  2. A CBE event definition without the parent attribute is always mapped to a Enterprise Console event class definition with EVENT as its superclass.

Type

Table 2 describes how the "type" sub-field of an extended data element is mapped to the attribute data type in the Enterprise Console event class definition.

CBE event extension definition

Enterprise Console event class definition

  • noValue

The entire extendedDataElement is ignored

  • byte
  • short
  • int
  • long

INT32

  • float
  • double

REAL

  • string
  • dateTime
  • boolean
  • hexBinary

STRING

  • byteArray
  • shortArray
  • intArray
  • longArray

LIST_OF INT32

  • floatArray
  • doubleArray

LIST_OF REAL

  • stringArray
  • dateTimeArray
  • booleanArray

LIST_OF STRING

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

Default value and default hex value

The default value, or values, for an extended data element definition are mapped to the default values of the corresponding attribute in the Enterprise Console event class definition.

For instance, the CBE event extension definition

<eventDefinition name="Transaction" parent="event">
    ...
    <extendedDataElement name="tx_type" type="string">
        <defaultValue>purchase</defaultValue>
    </extendedDataElement>
 
    <extendedDataElement name="tx_internal_code" type="long">
        <defaultValue>42</defaultValue>
    </extendedDataElement>

    <extendedDataElement name="tx_approvers" type="string">
        <defaultValue>employee_1</defaultValue>
        <defaultValue>employee_2</defaultValue>
    </extendedDataElement>

    <extendedDataElement name="tx_key" type="hexBinary">
        <defaultValue>CE908712AF</defaultValue>
    </extendedDataElement>

</eventDefinition>

results in the following Enterprise Console event definition class:

TEC_CLASS :
    Transaction ISA EVENT
    DEFINES {
        tx_type: STRING, default="purchase";
        tx_internal_code: INT32, default=42;
        tx_approvers: STRING, default=[employee_1, employee_2];
        tx_key: STRING , default=CE908712AF;
        ...
    };
END


Related topics
Mapping Common Base Event attributes to Enterprise Console event attributes