Question & Answer
Question
Using CAP for KPI events
Answer
Using CAP for KPI events
The WebSphere? Message Brokerwhich is provided as part of the IBM? Intelligent Operations Center accepts CAP eventmessages and uses the data in key performance indicator (KPI) calculations.
Table 1 lists the dataelements used in KPI calculations:
| Required or Optional | Data Element (normative) | Description |
|---|---|---|
| Required | Message_ID (identifier) | Unique message identifier |
| Required | Sender_ID (sender) | Unique sender identifier |
| Required | SentDateTime (sent) | Date and time of the event For example: 2011-02-07T16:49:00-05:00 |
| Required | MessageStatus (status) | One of the following:
|
| Required | MessageType (msgType) | One of the following:
|
| Optional | Source (source) | The source of the message |
| Required | Scope (scope) | Contains the value Public |
| Required | Code (code) | Contains the value KPI to hide this event fromthe Events portletlist. |
| Required | EventCategory (category) | One of the following:
|
| Required | EventType (event) | Description of the event. For example: Police_Department_Budget |
| Required | Urgency (urgency) | One of the following:
|
| Required | Severity (severity) | One of the following:
|
| Required | Certainty (certainty) | One of the following:
|
| Optional | EventCode (eventCode) | Name value pairs for event typing. |
| Optional | OnsetDateType (onset) | Date time when the event started. For example: 2011-02-08T16:49:00-05:00 |
| Optional | SenderName (senderName) | Name of the entity initiating the alert. Forexample: Police Department |
| Optional | EventDescription (description) | Detailed description of the event |
| Optional | Parameter (parameter) | Additional data associated with the event. |
| Optional | AreaGeocode (geocode) | A field that can be used to provide informationwhen the KPI is location dependent |
For more information see the OASIS Common Alerting Protocol specification.
The following is an example of an event reporting a caraccident.
<?xml version="1.0" encoding="UTF-8"?><cap:alert xmlns:cap="urn:oasis:names:tc:emergency:cap:1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:oasis:names:tc:emergency:cap:1.2 CAP-v1.2-os.xsd "> <cap:identifier>1112</cap:identifier> <cap:sender>Transportation</cap:sender> <cap:sent>2011-02-17T15:00:00-05:00</cap:sent> <cap:status>Actual</cap:status> <cap:msgType>Alert</cap:msgType> <cap:scope>Public</cap:scope> <cap:code>KPI</cap:code> <cap:info> <cap:category>Transport</cap:category> <cap:event>Traffic_Accident</cap:event> <cap:urgency>Unknown</cap:urgency> <cap:severity>Extreme</cap:severity> <cap:certainty>Unknown</cap:certainty> <cap:eventCode> <cap:valueName>OwningOrg</cap:valueName> <cap:value>Police</cap:value> </cap:eventCode> <cap:onset>2011-02-17T15:00:00-05:00</cap:onset> <cap:senderName>Transportation</cap:senderName> <cap:description>Single car crash</cap:description> <cap:parameter> <cap:valueName>accident number</cap:valueName> <cap:value>1112</cap:value> </cap:parameter> </cap:info></cap:alert>Parent topic: Integrating with the Common Alerting Protocol
Related information:
[{"Business Unit":{"code":"BU055","label":"Cognitive Applications"},"Product":{"code":"SSMGP8","label":"Smarter Cities"},"Component":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"","label":""}}]
Was this topic helpful?
Document Information
Modified date:
08 December 2018
UID
ibm10751155