IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Building mediation flows > Emitting common base events
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:
When no message data is included in the event
In 6.0.2 format, 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:
| 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 |
| Event Emitter property | Event Emitter property value | Common base event element | Common base event element value |
|---|---|---|---|
| label | OrderReceived | extensionName or event/eventPointData/EventEmitterLabel | OrderReceived |
| Mediation module name | ReceiveOrderMediationModule | event/eventPointData/ModuleName | ReceiveOrderMediationModule |
| Event Emitter primitive name | OrderReceivedEvent | event/eventPointData/MediationName | OrderReceivedEvent |
| Root | exclude message content from event data | none | none |
When a single root element is included in the event
In a 6.0.2 format, 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:
| 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 |
In a 6.1 format event, when the root property of the Event Emitter primitive specifies a single leaf element, the applicationData child element of the event element contains the value of the leaf element. The elements of the common base event are as follows:
| Event Emitter primitive property | Event Emitter property value | Common base event element | Common base event element value |
|---|---|---|---|
| label | OrderReceived | extensionName or event/eventPointData/EventEmitterLabel | OrderReceived |
| Mediation module name | ReceiveOrderMediationModule | event/eventPointData/ModuleName | ReceiveOrderMediationModule |
| Event Emitter primitive name | OrderReceivedEvent | event/eventPointData/MediationName | OrderReceivedEvent |
| Root | /body/getOrderInfo/argAccount/region | event/eventPointData/Root | /body/getOrderInfo/argAccount/region |
| event/applicationData/content/value | Asia Pacific |
When a complex root element is included in the event
In a 6.0.2 format 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.
The elements of the common base event are as follows:
| 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 |
In a 6.1 format event, when the root property of the Event Emitter primitive specifies a business object, the applicationData child element of the event element stores the specified business object.
For example, suppose the Event Emitter label property is OrderReceived, and the root specifies the location /body/getOrderInfo/argAccount. The elements of the common base event are as follows:
| Event Emitter primitive property | Event Emitter property value | Common base event element | Common base event element value |
|---|---|---|---|
| label | OrderReceived | extensionName or event/eventPointData/EventEmitterLabel | OrderReceived |
| Mediation module name | ReceiveOrderMediationModule | extendedDataElement/MediationName | ReceiveOrderMediationModule |
| Event Emitter primitive name | OrderReceivedEvent | event/eventPointData/MediationName | OrderReceivedEvent |
| Root | /body/getOrderInfo/argAccount | event/eventPointData/Root | /body/getOrderInfo/argAccount/ |
| event/applicationData/content/value/accountID | 049728 | ||
| event/applicationData/content/value/region | Asia Pacific | ||
| event/applicationData/content/value/termsDescription | 90 days | ||
| event/applicationData/content/value/companyName | Favourite Customer | ||
| event/applicationData/content/value/creditLimit | 50000 |