Event Analytics KPI+

Overview

When to use it

Use Event Analytics KPI+ when you need to:

• Count the events in the display time range.
• Show the total, average, minimum, or maximum of an event attribute, such as downtime or production loss.
• Split a result into one card per root cause, asset, or other category.
• Keep only the largest or smallest categories and group the rest as Others.
• Color cards by limits, or compare them with a target.
• Let operators narrow the cards with an Event Filter+.

Choose KPI Card+ for one PI Point or attribute with a sparkline or a history comparison. Choose Event Analytics Pivot+ when you need a grid with two categories at once. Choose Event Analytics Table+ when readers need the list of categories with several summaries side by side.

Before you begin

• Prepare an event frame template with events in the display time range.
• For a sum, average, minimum, maximum, median, or standard deviation, use a numeric attribute or Duration. Text attributes offer only Count and Count Distinct.
• The cards follow the display time range and the event search of the symbol. Units come from the AF attribute.

Add and set up the symbol

1. Select Event Analytics KPI+ in the PI Vision symbol gallery.
2. Search for the events, then drag an event attribute such as Loss from the Event Frame Search results onto the display. The symbol starts with one card that counts the events.
3. Right-click the symbol and select Configure Event Analytics KPI....
4. Under Dimension, open Values. Set Value to |Loss and Summary to Sum.
5. Enter Total loss as the Title.
6. Close the configuration pane. The card shows the total loss of all events, with the unit from AF.

Note: Event attributes show a leading | in the Value lists. Event properties such as Name, Duration, and Start Time have none.

Common tasks

Count events and summarize an attribute

Use this when one card is not enough, for example the number of events next to the total loss and the total downtime.

1. In the configuration pane, open Values.
2. Select + (1) to add a value.
3. Set Value (2) to the property or attribute, for example Name, |Loss, or Duration.
4. Set Summary (3) to Count, Sum, Average, or another calculation.
5. Enter a Title (4) such as Events or Total downtime.
6. Repeat for each card.

Each value becomes one card. Show set to OFF keeps a value in the list without a card. A time attribute such as Duration shows as a readable time span.

Split the result into one card per category

Use this when you want the same calculation for each root cause, asset, or shift, or only for the largest ones.

1. Open Series and select + (1).
2. Set Value (2) to the attribute that defines the cards, for example |Root Cause|Level1. A hierarchical attribute offers one entry per level.
3. Check Sort Order (3) and Sort by (4). Sort by is the value that orders the cards, and Descending puts the largest first. Select Category to sort by the names instead.

The symbol shows one card for each root cause, titled with the category. With several values, every value is calculated for every category. With several series, every combination gets a card, such as Maintenance - Unknown, unless Drilldown is the click action.

To keep only the leaders when many categories would crowd the symbol:

1. In Series, set Top N (1) to ON and Mode (2) to Top. Select Bottom for the smallest categories.
2. Enter the Count (3), for example 3.
3. Set the ranking Value (4) to the value that decides the order.
4. Leave Others (5) ON to add one card that applies the same summary to all remaining categories.

The symbol shows the three leading categories and an Others card. With a sum, Others keeps the grand total complete.

Color cards by limits

Use this when readers must see which cards are normal, high, or low without reading the numbers.

1. Right-click the symbol and select Add Multi-State.... When limits exist, the command reads Configure Multi-State....
2. Select the value in the Values list, then select Enable multi-state (1).
3. Under Property (2), choose how the color is drawn. Accent + Tint colors the card edge and surface.
4. Under Status, type a limit (3) and press Enter or select +. Add one limit for each color you need.
5. Choose a color for each limit (4). A card takes the color of the lowest limit that is greater than or equal to its value.
6. Choose the Error color (5). It colors values above the highest limit and cards without a number.

The cards take the colors. Here limits of 50 and 110 give green up to 50, amber up to 110, and red above. For a time attribute such as Duration, type the limits as time spans, for example 1h or 1d.

Compare cards with a target

Use this when readers should see how far each card is from a goal.

1. Open Values and select the value in the list.
2. Set Enabled (1) under Target to ON.
3. Set Show (2) to ON to add the target value to the badge. Leave it OFF to keep repeated cards compact.
4. Enter the target Value (3). For a duration, enter a time span.
5. Set Difference (4) to Value for the signed difference, or Percent for a percentage. A percentage is not shown for a target of 0.
6. Set Direction (5) to Higher is better or Lower is better.

Each card shows a badge under its title. The arrow points up when the card is above the target and down when it is below, and no arrow shows at equal values. The color follows Direction, so an up arrow is red when lower is better. The target applies to every card of the value.

Narrow the cards with Event Filter+

Use this when readers should choose which events the cards summarize. Add an Event Filter+ to the display that publishes a Master filter and lists an attribute readers pick from.

1. Select an entry in the Event Filter+ list (1).
2. The cards recalculate for the matching events.
3. In the symbol's configuration pane, open Interactivity > Filtering and set Filter Indicator to Full. The indicator (2) shows how many events remain.
4. To keep one symbol unaffected, set Ignore Master to ON.

The values (3) now cover only the selected events. Clear the selection in the Event Filter+ or through the indicator to see all events again. The filter matches the exact value, so a parent entry does not include its sub-causes. See Filtering dashboards for linked channels.

Check the events behind a card

Use this when a reader asks which events make up a card, or needs the numbers in a spreadsheet.

1. Hover the symbol and select Inspect Data in the toolbar at its top right.
2. In the Summary tab, select a row (2), for example Operator error. The tab has one row for each card with its value and unit, and the target and difference when the card shows them.
3. Select the Rows tab. It lists the events behind that card with their properties and attributes, here 5 of 46 events.
4. To keep the data, select CSV, JSON, or XLSX (4). The file holds the tab you are viewing.

The count (1) shows how many rows the tab holds, and Data as of (3) when the dialog read the cards. Select Refresh to read it again. Select the same Summary row again to see all events.

Use the symbol

• Time range: the cards follow the display time range. Change the range and the numbers follow.
• Toolbar: hover the symbol to show the buttons in its top-right corner. Inspect Data shows the summary and the events behind the cards, see Check the events behind a card. Clear Filter shows while a selected card filters the display or the cards have drilled down, and clears that selection or drill-down. Download saves one row for each card as CSV, JSON, or XLSX. Your administrator can hide Download and the export buttons of Inspect Data.
• Click Action: the designer chooses what a click does. None does nothing. Drilldown needs two or more series: a click replaces the cards with the next series for the clicked category, and a drill-up button appears at the top right. Filter selects the card and publishes it as an event filter for the other symbols. Select the card again to clear it.
• Filters from other symbols: an Event Filter+ or another event symbol narrows the cards, and a filter indicator appears when the designer enabled it.
• No events: when nothing matches, the cards stay in the configured style. A count, distinct count, or sum reads 0 and every other summary reads a dash. These cards cannot be clicked.
• Edit mode: a symbol with events but no visible value shows a short "No values configured" hint. Add a value or set Show to ON.
• The symbol only displays data. It does not write to the PI System.

Configure the symbol

Right-click the symbol and select Configure Event Analytics KPI.... The groups appear in this order. The right-click menu also offers Add Multi-State... and Search Criteria....

Dimension > Values

One entry for each calculation. Use + to add one and the arrows to reorder.

Dimension > Series

One entry for each grouping. With several series, every combination gets a card, unless Drilldown is the click action.

Card Options > Layout

Card Options > Style

Card Options > Toolbar

Interactivity > Selection

Interactivity > Filtering

Attributes

The event attributes the symbol loads and offers in the Value lists. Use the buttons below the list to add, remove, or reorder entries.

Numbers

The number format of card values. Units and decimals follow the AF attribute unless you choose a format.

Search Criteria

Opened from the right-click menu. Choose the database, time range, event name, severity, asset, template and attribute values, and the number of results, then select Apply. Reset restores the search. By default the time range follows the display time range.

Add Multi-State

Opened from the right-click menu. Used in Color cards by limits.

Troubleshooting and limitations

Limitation: The symbol summarizes only the events that its search returns in the display time range.

Limitation: A target applies to every card of its value. You cannot set a different target for each category.