IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Developing monitor models > Create monitor models > Defining KPI models
Defining inbound events for KPI contexts
You can define an inbound event to specify that you want a key performance indicator (KPI) context to subscribe to a particular event.
For example, you might want the KPI to recalculate its value every time the event arrives. You create a trigger that is evaluated each time the inbound event arrives and have the trigger reference the KPI in its expression, for example, by verifying that the KPI has not exceeded a certain range.
To define an inbound event:
Procedure
- Click the KPI Model tab of the editor, right-click the KPI context (or any element of the KPI context) in the model tree, and click New > Inbound Event.
- In the Create New Inbound Event window, type a name in the Name and click OK. The name is limited to 256 characters. As you type the name, a default ID is created for you, although you can change it if you prefer. The ID is required and must be unique within the KPI context. The ID must be an XML NCName (non-colonized name), which means that it must start with a letter or underscore and that it can contain only letters, digits, underscores, hyphens, and periods.
The inbound event is added to the model tree under the KPI context, and the form editor opens so that you can define the event.
- Optional: Type a description in the Description field. The description is used only in the Monitor Model editor and is not displayed anywhere in Business Monitor. The character set is unrestricted.
- If the event definition is in a Common Base Event file, specify an extension name. Click Browse and navigate to the file. The file must have been previously imported into the project or must be in an associated project. You can specify both an extension name and event parts if the event definition contains information from both types of structure. An import statement referencing the Common Base Event file is added to the XML source document, which is reflected in the table on the Event Model page. This table displays the import location for each event definition file used in the monitor model.
- If the event definition (or part of the event definition) is in an XML Schema Definition (XSD) file, click Add to add a new event part to the Event parts table. Using the detailed information in Defining event parts, define all event parts required for the inbound event.
- To restrict the events that are received by this KPI context, add a Boolean expression in the Filter Condition box. The Boolean expression can reference attributes that are defined in the inbound event type.
If you press Ctrl+Space for content assist, a small window is displayed to help you write the expression. In this window, you can select valid operators, functions, and attributes from the inbound event.
- Specify quality of service properties to provide the location of configuration information inside your events rather than relying on the standard Common Base Event fields.
If you press Ctrl+Space for content assist, a small window is displayed to help you select the event attribute from the inbound event.
- Specify the path to the creation time of the event. The Monitor server uses this attribute to indicate the instance creation time, for example, to determine the stop and start times of a stopwatch, or to determine which instances should be included when calculating historical KPI values. By default, the value used at run time is the path to the Common Base Event creationTime attribute, which contains the time at which the event is created, in UTC. Alternatively, you might want to use a more business-relevant creation time from the event payload, such as the date and time that an order was placed.
- Specify the path to the global instance ID. This ID is used to relate the problem determination message to a specific event when there is an error at run time, (for example, in the WebSphere Application Server log). By default, the value used at run time is the path to the Common Base Event globalInstanceId, which is an automatically generated identifier to uniquely identify the event.