Documentation Vision Library+ Documentation

Event Analytics Pivot+

Event Analytics Pivot+ turns event frames into a cross-tab: one attribute down the side, another across the top, and a count, sum, or average of the events in each cell. Color the cells by limits to see at a glance where the events pile up.

Overview

Cross-tab of downtime events by root cause and priority, with colored cells and totals

When to use it

Use Event Analytics Pivot+ when you need to:

  • Count events across two categories at once, such as downtime events by root cause and production line.
  • Total or average a number from the events, such as lost production, per category.
  • Break events down by year and month with rows that expand and collapse.
  • Flag the cells where the count or total crosses a limit.
  • Keep the largest categories and group the rest as Others.

Choose Event Analytics Table+ when one set of categories is enough, or when you need several summaries side by side with click actions. Choose Event Analytics Chart+ when a picture reads better than a grid.

Before you begin

  • Prepare an event frame template that has events in the time range you will display.
  • Pick categories with a manageable number of distinct values. Use Top N when there are many.
  • To color cells or take a sum or average, the event frames need a numeric attribute.

Add and set up the symbol

  1. Select Event Analytics Pivot+ in the PI Vision symbol gallery.
  2. Drag an event frame attribute from the Event Frame Search results onto the display. The pivot starts empty.
  3. Right-click the symbol, select Search Criteria..., choose the database and event frame template, and select Apply.
  4. Right-click the symbol and select Configure Event Analytics Pivot Table.... Under Dimension, open Rows, select +, and set Value to the attribute that defines the rows.
  5. Open Columns, select +, and set Value to the attribute that defines the columns.
  6. Open Values, select +, set Value to Name, and set Summary to Count.
  7. Under Table, open Layout and select Fit Data. The symbol shows the number of events for every row and column pair, with totals.
Pivot with events counted by root cause and production line

Note: Rows and columns sort in descending order by default. Set Sort Order to Ascending in Rows and Columns for A to Z. Attribute names show a leading |, and hierarchical attributes such as |Root Cause|Level1 give one entry per level.

Common tasks

Break events down by month

Use this when you want to see how events build up over time and still read the yearly totals.

  1. In the configuration pane, open Rows.
  2. Select + (1), set Value (2) to Start Time, and set Group Interval (3) to Year.
  3. Select + again, set Value to Start Time, and set Group Interval to Month-Year.
  4. Under Table, open Layout and set Expand Rows to ON to open every year when the display loads.
Rows group with two Start Time rows grouped by year and by month

Each year is a parent row that adds up its months. Select the arrow beside a year to collapse it or open it again. This changes the view only and is not saved with the display.

Pivot with years as parent rows and months beneath

Sum or average a number instead of counting

Use this when you care about how much, not how many, for example the total loss per root cause.

  1. In the configuration pane, open Values.
  2. Select + and set Value (1) to a numeric attribute, such as |Loss.
  3. Set Summary (2) to Sum. Other choices are Min, Max, Average, Median, and Standard Deviation.
  4. Optionally enter a Title (3). The title names the value in the headers when the pivot shows more than one value.
  5. Delete the count value, or set its Visible to OFF, to show only the sum.
Values group with Value set to Loss, Summary set to Sum, and a title

Every cell now shows the total of the attribute for its events. A time attribute such as Duration shows as a readable time span. Text attributes offer only Count and Count Distinct.

Pivot showing the total loss by root cause and production line

Show only the largest categories

Use this when a row or column attribute has more values than the symbol can show.

  1. In the configuration pane, open Rows and select the row.
  2. Set Top N (1) to ON, set Mode to Top, and enter the Count (2), for example 3.
  3. Set the rank Value (3) to the value that decides the ranking.
  4. Leave Others (4) ON to add one row that sums everything else, so the totals still cover every event.
  5. Set Sort Order (5) to Descending and Sort by (6) to that value to put the largest row first.
Rows group with Top N on, a count of 3, and Others on

The pivot keeps the three largest rows and adds an Others row at the bottom. Use Bottom for the smallest. Columns have the same settings.

Pivot with three root causes and an Others row

Color cells by limits

Use this when readers must spot the cells that cross a limit without reading every number.

  1. Right-click the symbol and select Add Multi-State.... When a value already has limits, 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: Solid Fill, Soft Fill, Text, Border, Value Badge, and others. Select Gradient (3) to blend colors between limits.
  4. Under Status (4), enter a number for each limit and choose its color. A cell takes the color of the lowest limit that is greater than or equal to its value.
  5. Choose the Error color (5). It colors values above the highest limit and cells without a number.
Multi-State pane with Enable multi-state, Property, Gradient, limits, and Error marked

The value cells show the colors. Totals are never colored. For a time attribute such as Duration, type limits as time spans, for example 1h or 1.5d.

Pivot with green, amber, and red cells

Narrow the pivot with an event filter

Use this when readers should pick the categories that the pivot summarizes. Add an Event Filter+ to the display that publishes a Master filter and lists the attribute readers should pick from.

  1. Select entries in the Event Filter+ list.
  2. The pivot recalculates for the matching events and shows the filter indicator at its top right.
  3. Open the pivot's Filtering group under Interactivity and set Filter Indicator to Full to show how many events remain.
  4. To keep one pivot unaffected, set Ignore Master to ON.
Event Filter+ with three root causes selected next to a pivot showing 17 of 46 events

Rows, columns, and totals now cover only the selected events. The filter matches the exact value, so selecting Equipment breakdown does not include its sub-causes. Select those entries as well. See Filtering dashboards for linked channels.

Check the events behind a cell

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

  1. Hover the pivot and select Inspect Data at the right end of the header row.
  2. In the Summary tab, select a row (2). The tab has one row for each cell: the row, the column, and the value, with the totals as rows of their own.
  3. Select the Rows tab. It lists the events behind that cell with their properties and attributes.
  4. To keep the data, select CSV, JSON, or XLSX (4). The file holds the tab you are viewing.
Inspect Data dialog with the Equipment breakdown and Line 3 cell selected

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

Use the symbol

Pivot with numbered callouts
What it shows
(1)A column header. Each column is one value of the column attribute.
(2)A parent row. It adds up the rows beneath it. Select its arrow to collapse or expand it.
(3)A row of the next level, here one month.
(4)A value cell: the count, sum, or other summary for the events in that row and column. The color comes from the limits.
(5)The Grand Total row, with the total of each column.
(6)The Total column, with the total of each row.
  • Collapse and expand: select the arrow beside a parent row. The state lasts until the display reloads.
  • Time range: the pivot follows the display time range. Change the range and the counts follow.
  • Filters: an Event Filter+ or another Master filter narrows the events, and a filter indicator appears. Linked filters narrow them when the designer has mapped a channel.
  • Toolbar: hover the pivot to show the buttons at the right end of the header row. Inspect Data shows the summary and the events behind each cell, see Check the events behind a cell. Download saves the summary rows as CSV, JSON, or XLSX. Your administrator can hide Download and the export buttons of Inspect Data.
  • Cells are not clickable: the pivot publishes no filter and has no drill-down. To let readers drill, add an Event Analytics Table+ or Chart+ with a Filter click action next to it.
  • Empty cells: a cell without events shows 0 for Count and Sum, and a dash for Average.
  • No events: the pivot shows only its headers. Change the display time range or the search criteria.
  • The symbol only displays data. It does not write to the PI System or change other symbols.

Configure the symbol

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

Dimension > Values

One entry for each number the pivot shows. Use + to add one and the arrows to reorder.

SettingWhat it does
ValueThe attribute to summarize. Event properties include Duration (the whole event frame), Duration in Range (only the part inside the symbol's time range; use Sum for the time within the shown period), and Duration in Range, Overlaps Merged (the same, but time already covered by an earlier event frame on the same asset counts once; use it when event frames on one asset can overlap). Used in Sum or average a number.
SummaryCount, Count Distinct, Sum, Min, Max, Average, Median, or Standard Deviation. Text attributes offer only Count and Count Distinct.
TitleNames the entry in this list and the value in the headers when several values show.
VisibleOFF hides the value from the table. A hidden value can still rank and sort rows and columns.

Dimension > Columns and Rows

Both groups have the same settings. Several rows nest as parent and child rows. Several columns group under shared headers.

SettingWhat it does
ValueThe attribute whose values become the rows or columns.
Group IntervalAvailable for date and time attributes. Groups by Year, Month-Year, Day-Month-Year, Quarter, Hour, and other intervals. Used in Break events down by month.
Show Empty PeriodsAvailable with a Group Interval. Adds periods that have no events.
Top NKeeps the top or bottom entries. Mode, Count, Value (the ranking value), and Others set the details. Used in Show only the largest categories.
Sort OrderAscending or Descending. The default is Descending.
Sort byCategory sorts by the entry itself. A value sorts by that value.
TitleNames the entry in this list.

Table > Totals

SettingWhat it does
Row TotalsAdds the Total column. Available when the pivot has columns.
Column TotalsAdds the Grand Total row.
Grand TotalShows the overall total where the two meet. OFF leaves a dash.

Table > Layout

SettingWhat it does
LayoutFit Table spreads the columns over the symbol width. Fit Data sizes columns to their content. Manual gives every column the same fixed Column Width.
Expand RowsON opens all parent rows when the display loads.

Table > Toolbar

SettingWhat it does
Show ToolbarTurns the toolbar with Inspect Data and Download on or off. On by default.
RevealOn Hover shows the toolbar in the header row when the pointer is over the pivot. Always keeps it in view above the pivot.

Interactivity > Filtering

SettingWhat it does
Filter IndicatorCompact shows a filter icon, Full adds the event count, and Hidden shows nothing. Used in Narrow the pivot with an event filter.
Ignore MasterON ignores Master filters on the display. Linked inputs still apply.
Linked InputsMaps a named channel from a publisher to a property of the events. See Filtering dashboards.

Attributes

Lists the event frame attributes the pivot can use in Value lists. Drag more attributes onto the symbol to add them.

Style and Numbers

SettingWhat it does
StyleTheme, header, row, border, and font appearance of the table.
NumbersThe number format for value cells.

Add Multi-State

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

SettingWhat it does
ValuesThe list of values. Each value has its own limits.
Enable multi-stateTurns on coloring for the selected value.
PropertyHow the color is drawn: Text, Border, Soft Fill, Accent + Tint, Status Dot, Value Badge, Solid Fill, Progress, or Progress and Value.
GradientBlends colors between limits.
StatusOne row per limit with a color, and the Error color for everything the limits do not cover. Type a limit and select + to add one.

Troubleshooting and limitations

SymptomCauseWhat to do
Only the headers show.No events match the search in the display time range.Change the display time range, or open Search Criteria... and widen the search.
Fewer events than expected.An Event Filter+ selection or a linked input is active.Clear the selection, or set Ignore Master to ON.
Selecting a cause in the Event Filter+ leaves out its sub-causes.The filter matches the exact value.Select the sub-cause entries as well.
Row names are cut off.Fit Table gives every column the same width.Under Table > Layout, select Fit Data.
The totals are not colored.Limits color only value cells.Read the totals as plain numbers.
Colors look wrong for a time attribute.Limits were typed as plain numbers.Type limits as time spans such as 1h or 1.5d.

Limitation: The pivot receives filters but publishes none, and its cells cannot be clicked.

Limitation: Each pivot cell shows one summary of the events in it. To list the events behind a cell, use Inspect Data or Events Table+.

Limitation: Very many distinct values make a wide, hard-to-read grid. Use Top N or a coarser Group Interval.