REST event emitter

The Representational State Transfer (REST) event emitter service is a public API that you use to send events that can be consumed by IBM® Business Monitor. You can use the REST event emitter to synchronously publish events. This event emitter service makes it easier for other products to integrate with IBM Business Monitor.

The event emitter service takes an HTTP POST URI as input. Results are returned in JSON, and any error messages and status indicators are returned in the HTTP response as JSON output.

To use the REST event emitter, you define XSDs that describe the structure of the business information. These XSDs are then used in authoring the monitor model to process the incoming events.

For events created for IBM Business Monitor V8.5.5 monitoring models, the REST event emitter sends the events exactly as they are received to the monitor model application. Unless the context root of the REST event emitter is changed during installation, the address of the REST event emitter is:

https://localhost:9443/rest/bpm/monitor/events

When you create monitoring models with IBM Business Monitor V8.5.5, you can indicate event point keys as part of the event description. The keys are used by the IBM Business Monitor event framework to route events directly to your monitoring model event processing. You can include the keys as HTTP request headers when the events are sent to the REST XML event service.

The HTTP request headers for each event point key part are:

WBMapplicationName
WBMversion
WBMcontextType
WBMcontextName
WBMelementType
WBMelementName
WBMnature

Events in a Monitor model have an event point key filter. You can define this filter so that it takes the following action, depending on whether the REST header event point keys pass the filter:

Allow incoming events that pass the filter to be delivered to the model.
Exclude events that do not pass the filter.

Using the filter ensures that events that are not needed by the model are not delivered to the model.

If events are not tagged with event point keys, the REST XML event service delivers the events to all monitoring models that do not have events defined with an event point key.

Note: For events created for earlier versions of IBM Business Monitor, the REST event emitter wraps the event XML in a Common Base Event envelope. The REST event emitter then submits the Common Base Event to the Common Event Infrastructure (CEI) server, which forwards the event to the monitor model application. The REST event emitter URL to use in this case is:

https://localhost:9443/rest/bpm/events