The IBM® Sensor
Event is the event format used by WebSphere® Premises Server.
The IBM Sensor
Event (IBMSensorEvent class) has three sections:
- Header - contains information about the who, what, and
where of an event
- Payload metadata - provides a way for users to pass data
about the payload (additional data about the event)
- Payload - contains the actual data that was captured from
the sensor device (event data)
Each section is a group within the event model.
Header details
Each header has the following required
attributes:
- dateTime - System-generated date/time stamp in UTC time
- eventId - System-generated unique ID
- eventType - Name of the generated event. This value is supplied by the
calling code when creating the event.
- priority - Event priority (the default is 50)
- sourceId - Source ID which generated the event such as a controller ID
or reader ID. This value is supplied by the calling code when creating the
event.
These attributes are optional for the header:
- assetId - Asset ID being tracked in the event
- geoLocation - Geographical location of the asset
- originatingEventId - Originating event ID used to correlate related events
- targetId - Target ID of a specific command event, such as a controller
ID
Payload metadata details
The payload metadata contains
additional information about the event. This information is defined by the
creator of the event.
Payload details
Each payload included within an
event extends from the IBMSensorEventPayload class and has the following attributes:
- payloadClassName - The fully qualified class name of the payload, such
as com.ibm.sensorevent.model.payload.HeartbeatPayload. This attribute is required
to reconstruct the payload class within the task agent message-driven bean
(MDB).
- eventGroup - A group within the payload containing all payload data. The
name of this group is the same as the eventType attribute in the header.