Content of the Event Emitter primitive's event

The Event Emitter primitive defines the application specific event data that is placed into the extendedDataElements section of the common base event. This topic summarizes the mapping between the properties defined in the Event Emitter primitive and the elements of the common base event.

Event Emitter properties displayed in a generated event definition

When you generate an event definition from a mediation flow that has an Event Emitter primitive, the generated event definition contains the primitive's properties in these locations:
  • The label property of the primitive becomes the name of the generated event
  • The mediation module name is the ModuleName of extendedDataElement
  • The primitive name is the MediationName of extendedDataElement
  • The primitive's root property, for example /body, is in the Root of extendedDataElemetn
  • The value of the elements in the message is contained in the Message of extendedData
The relationship between the message schema, primitive properties and data elements of the generated event is illustrated below:


Relationship between event emitter properties and generated event data

When no message data is included in the event

When no message data is included in the event, the Message element of the extendedDataElement is not present, and the Root element of extendedDataElement is empty.. The elements of the common base event using example data, are as follows:
Table 1. Extended data elements when no message data is included in the event
Event Emitter property Event Emitter property value Common base event element Common base event element value
label OrderReceived extensionName OrderReceived
Mediation module name ReceiveOrderMediationModule extendedDataElement/ModuleName ReceiveOrderMediationModule
Event Emitter primitive name OrderReceivedEvent extendedDataElement/MediationName OrderReceivedEvent
Root exclude message content from event data extendedDataElement/Root none

When a single root element is included in the event

When the root property of the Event Emitter primitive specifies a single leaf element, the Message element of the extendedDataElement contains the value of the leaf element. The elements of the common base event are as follows:
Table 2. Extended data elements when a single root element is included in the event
Event Emitter primitive property Event Emitter property value Common base event element Common base event element value
label OrderReceived extensionName OrderReceived
Mediation module name ReceiveOrderMediationModule extendedDataElement/ModuleName ReceiveOrderMediationModule
Event Emitter primitive name OrderReceivedEvent extendedDataElement/MediationName OrderReceivedEvent
Root /body/getOrderInfo/argAccount/region extendedDataElement/Root /body/getOrderInfo/argAccount/region
    extendedDataElement/Message Asia Pacific

When a complex root element is included in the event

When the root property of the Event Emitter primitive specifies a business object, a Message element is created in the extendedDataElement for to store the value for each contained element. For example, suppose the Event Emitter label property is OrderReceived, and the root specifies the location /body/getOrderInfo/argAccount, as shown below:


Root property selection in the XPath Expression Builder

The corresponding generated event as seen in the Event Definition Editor is shown below:

T he elements of the common base event are as follows:
Table 3. Extended data elements when a single root element is included in the event
Event Emitter primitive property Event Emitter property value Common base event element Common base event element value
label OrderReceived extensionName OrderReceived
Mediation module name ReceiveOrderMediationModule extendedDataElement/ModuleName ReceiveOrderMediationModule
Event Emitter primitive name OrderReceivedEvent extendedDataElement/MediationName OrderReceivedEvent
Root /body/getOrderInfo/argAccount extendedDataElement/Root /body/getOrderInfo/argAccount/
    extendedDataElement/Message/accountID 049728
    extendedDataElement/Message/region Asia Pacific
    extendedDataElement/Message/termsDescription 90 days
    extendedDataElement/Message/companyName Favourite Customer
    extendedDataElement/Message/creditLimit 50000
Related concepts
The Common Event Infrastructure and Common Base Events
Best Practice: Choosing properties of an event
Best Practices: When to use an Event Emitter
When not to use an Event Emitter
Related tasks
Generating event definitions
Generating a monitor model

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