KPI rules

Key Performance Indicator (KPI) rules calculate a value across all business events in a specified window of time. KPIs are typically values tracked to understand and monitor trends across all events and/or business objects of similar types. For example, a KPI rule might calculate the total value of Order business objects that are updated within an hour to gauge the trends in Order total values over time.

KPI rule attributes include:

Query

Query for more data in the business object not present in the business event itself to aid in the KPI calculation.

Window

The time window over which the calculation is computed. A window can be expressed as a second, minute, hour, day, month, or year.

Dimension

A list of business object attributes for each of which a unique KPI is calculated for every unique value of each dimension. For instance, if the dimension is the EDI transaction type (eventDetails.eventSource.EDI.transactionType), then a separate KPI is calculated for every type of EDI transaction observed in the same window (for example 850, 856).

Map

A mathematical operation to transform one or more existing attributes on the event or associated business object to a new value. This new value is transitory and exists only to help the completion of the KPI metric calculation, as specified by the Reduce function.

Reduce

A mathematical operation to calculate the new KPI metric value based on the values of all events or business objects being updated in the specified Window. The final value isn't calculated until the window is over.