Documentation Vision Library+ Documentation

Event Filter+

Event Filter+ lists the values of an event attribute, such as the root cause of a downtime event. Readers click an entry and every event symbol on the display that listens to filters, such as tables and analytics symbols, shows only the matching events.

Overview

Event Filter+ with two root causes selected next to a KPI symbol and an events table that show only those events

When to use it

Use Event Filter+ when you need to:

  • Let operators narrow the event symbols of a display without editing their searches.
  • Filter several event symbols at once with one list.
  • Filter by the combination of two attributes, or by a period such as a month.
  • Open a display with a value already selected, for example from a link in an email.

Choose Events Table+ when readers should pick individual events from a list. Choose Asset Filter+ when the filter should select assets.

Before you begin

  • Place the event symbols you want to filter on the same display. They narrow their events by the filter when they listen to Master filters, which is on by default. See Filtering dashboards.
  • The symbols must load events that carry the attribute you filter by. A value that no loaded event has does not appear in the list.
  • The filter list is built from the events that Event Filter+ loads with its own search criteria. Use the same event frame template as the symbols you filter.

Add and set up the symbol

  1. Select Event Filter+ in the PI Vision symbol gallery.
  2. Drag an event frame attribute from the Event Frame Search results onto the display.
  3. Right-click the symbol, select Search Criteria..., choose the database and the event frame template, and select Apply. A new symbol keeps its own search.
  4. Right-click the symbol and select Configure Event Filter.... Under Arguments, set Value to the attribute that defines the list, here |Root Cause.
  5. Under General, open Selection and set Mode to Multiple.
  6. Under Header, enter a Header Text such as Select Root Cause.

The symbol lists every root cause found in the loaded events. Each entry has a check box and All selects every entry.

Event Filter+ with a header, a search field, and one check box for each root cause

Note: Attribute names show a leading |. |Root Cause gives the full path, for example Equipment breakdown|Electrical|Fuse. |Root Cause|Level1 gives only the first level, Equipment breakdown.

Common tasks

Filter the event symbols by a value

Use this when operators should choose the events they look at, for example one root cause at a time.

  1. Right-click the symbol and select Configure Event Filter....
  2. Under General, open Selection and set Mode (1) to Single to allow one entry, or Multiple to allow several.
  3. In Single mode, set Allow Empty (2) to ON so readers can clear the selection by clicking the entry again.
  4. Set Icon (3) to ON to show a radio button or check box in front of each entry.
Selection group with Mode set to Single, Allow Empty on, and Icon on

Click an entry (1). The other symbols recalculate for the events with that value: the KPI card (2) and the table (3) now cover two events. The filter matches the exact value, so Equipment breakdown|Mechanical does not include Equipment breakdown events.

Event Filter+ in Single mode with one root cause selected, a KPI card, and a table with two events

Filter by two attributes together

Use this when the list should combine two attributes, such as the cause and who reported it, or when a parent entry should include its sub-causes.

  1. In the configuration pane, under Arguments, set Value (3) of the first argument to |Root Cause|Level1 (1).
  2. Select Add Argument and set Value of the new argument to |Reported By (2).
Arguments group with the arguments Root Cause Level1 and Reported By
  1. Under General, open Layout and set View to Tree. The Tree view needs at least two arguments.

The list shows one node per root cause. Expand a node to see the second argument. Select a child (1) to filter by both values: here the events that equipment breakdown caused and an operator reported. Select the parent node to filter by the first value alone, which includes every event of that level. The table shows the matching events (2) and the KPI cards (3) cover them.

Tree view with Operator selected under Equipment breakdown, three KPI cards, and a table with four events reported by an operator

In the List view, the same two arguments give one entry for each combination, such as Maintenance and Automatic.

Filter by a period

Use this when readers should pick a month, a week, or a shift period instead of a text value.

  1. In the configuration pane, under Arguments, set Value (1) to a date attribute, here StartTime.
  2. Set Group Interval (2) to the period, here Month-Year. Group Interval appears for date attributes only.
Arguments group with StartTime grouped by Month-Year

The list now has one entry for each month that has events. Select an entry (1): the table shows only events that started in that month (2), here November 2025.

Event Filter+ listing months, with November 2025 selected next to a table of events that started in November

The entries are sorted alphabetically, not by date. Use the search field to find a month quickly.

Show which filter is active

Use this when readers must see that a symbol is narrowed and by how much. Every receiving symbol has its own Filter Indicator setting.

  1. Right-click the receiving symbol, for example an Event Analytics KPI+, and open its configuration pane.
  2. Open Filtering.
  3. Set Filter Indicator (1) to Full (2). Compact shows only the filter icon and Hidden shows nothing.
Filtering group of a KPI symbol with Filter Indicator set to Full

With Full, the symbol always shows the count of events it uses, such as 10 of 46 events. With Compact, the chip appears while you hover over the symbol or tap the icon. Waiting for filter shows in every mode.

KPI symbol and table that show 10 of 46 events next to a filter with two entries selected

Open a display with a value selected

Use this when one display opens from many links, for example from notification emails, and each link should start with its filter set.

  1. Right-click the symbol and select Configure Event Filter....
  2. Under General, open Selection and enter a Link parameter name (1). Use letters, digits, -, and _. The name is not case-sensitive.
  3. Read the hint below the field (2). It shows the text to add to the link, here vlp.cause=.
  4. Save the display.
Selection group with the link parameter name cause and its hint

Add vlp.<name>=<value> to the display link, after the display name and ?, and separate parameters with &. This link selects two entries in the filter named cause:

https://<server>/PIVision/#/Displays/123/Events?vlp.cause=Maintenance,Operator%20error

The display opens with both entries selected (1) and the other symbols filtered (2), as if a reader had clicked them.

Display opened from a link, with Maintenance and Operator error selected
  • Several values: separate them with commas. In Single mode the first value that matches an entry is selected.
  • Commas and spaces: write a space as %20. Wrap a value that contains a comma in double quotes.
  • Several levels: for an entry built from two arguments, separate the parts with a backslash, such as vlp.site=North\Station%204. In the Tree view, a link can name a node at any level.
  • Time range: combine the link with PI Vision's own time parameters, such as StartTime and EndTime.

A link selection acts like a click and is never saved with the display. Readers can change it afterward. If the link changes while the display is open, the filter follows the new value. A value that is not in the list is ignored. If none of the values is in the list yet, the symbol tries again when new events load.

Use a default selection when every reader should start with the same entries, for example the latest batch.

  1. Under General, open Selection and set Default selection (1) to Specific values. To start with the last entry of the list instead, select Last item and go to step 4.
  2. Type the entries in Values (2), separated by commas as in a link, or click them on the display. In Ranges mode, check the ranges in the Ranges list instead.
  3. If you clicked the entries on the display, click Use current selection (3). It copies them into Values.
  4. Save the display.
Selection group with Default selection set to Specific values, Line 4 in Values, and the Use current selection button

The display opens with the default entries selected. Readers can change the selection, and a later refresh does not reset it. A link with a value for this filter replaces the default. A default value that is not in the list is skipped and recorded as a warning in the PI Vision log.

Let a symbol ignore the filter

Use this when one symbol must always show all events, for example a total beside the filtered symbols.

  1. Right-click the symbol that should stay unfiltered and open its configuration pane.
  2. Open Filtering.
  3. Set Ignore Master (1) to ON.
Filtering group of a table with Ignore Master on

With two entries selected (1), the KPI cards (2) show only those causes, and the table (3) keeps all its events and shows no filter icon. Ignore Master ignores Master filters only. Linked inputs still apply.

Event Filter+ with two entries selected, a narrowed KPI symbol, and a table that still shows all events

Use the symbol

Event Filter+ with numbered callouts next to a filtered KPI symbol and table
What it shows
(1)The header. It shows the fixed text, or the selected entries when Text is Selection.
(2)The search field. Type to narrow the list of entries.
(3)The entries. A selected entry is highlighted. All selects or clears every entry in a list in Multiple mode.
(4)The filter icon of Event Filter+. It shows that this symbol publishes a selection.
(5)The filter icon of a KPI symbol that the filter narrows.
(6)The filter icon of a table that the filter narrows.
  • Click an entry to select it. In Multiple mode, click it again to clear it. In Single mode, click it again to clear it when Allow Empty is ON. Without Allow Empty, one entry always stays selected.
  • Filter: a click changes what the other symbols on the display show, and never writes to the PI System. The selection is not saved with the display.
  • Clear: deselect the entries, or hover over the filter icon of Event Filter+ and use the clear action.
  • Collapsible layout: the list opens from its header, and closes after a selection when Collapse on Select is ON.
  • Time range: the entries come from the events in the symbol's search and time range. A new time range can add or remove entries.
  • No entries: the search finds no events. Open Search Criteria... or change the display time range.
  • Selected entry disappears: when a selection no longer matches any event, for example after another filter narrowed the events, Event Filter+ clears it.

Configure the symbol

Right-click the symbol and select Configure Event Filter.... The right-click menu also offers Search Criteria.... The sections appear in this order.

Dimension > Arguments

SettingWhat it does
Add Argument and the arrowsAdds an argument and orders or deletes the selected one. Several arguments give one entry for each combination of their values. Used in Filter by two attributes together.
ValueThe event attribute or property whose values fill the list, such as the Root Cause attribute, Severity, or StartTime.
Group IntervalAvailable for date attributes. Groups the timestamps by day, month, week, year, hour, and other periods. Used in Filter by a period.
Mode (Values or Ranges)Available for a numeric attribute. Ranges lists ranges that you define instead of every value. Each range has a Label, a minimum, and a maximum.

General > Layout

SettingWhat it does
TypeStatic keeps the list visible. Collapsible opens it from a header.
Collapse on Select and Start ExpandedAvailable for Collapsible. Close the list after a selection, and open it when the display loads.
ViewList shows one flat list. Tree groups the entries by the first argument and needs two or more arguments. Start Expanded opens all nodes.

General > Selection

SettingWhat it does
ModeSingle allows one entry, Multiple allows several. Used in Filter the event symbols by a value.
Allow EmptyAvailable in Single mode. OFF keeps one entry always selected, and selects the first entry when the display loads unless a link or the Default selection selects another.
IconShows a radio button or check box in front of each entry.
Default selectionWhat is selected when the display opens: None, Specific values, or Last item (the last entry of the list or tree). A link value for this filter takes precedence. Used in Start with the same entries without a link.
Values, Use current selectionAvailable when Default selection is Specific values. Values lists the entries, separated by commas as in a link. Use current selection copies the entries selected on the display. In Ranges mode, a check box per range replaces Values.
Link parameter nameLets a display link preselect entries. Empty ignores links. Used in Open a display with a value selected. In Ranges mode, the link value is the range label as shown in the list, such as vlp.severity=Low.
SettingWhat it does
Theme and the colors, Padding, Font SizeChange the appearance. Padding is the space above and below each entry in pixels.
HeaderAvailable for Static. Shows or hides the header bar. A Collapsible list always has one.
TextCustom shows the Header Text. Selection shows the selected entries, or No items selected.
Search and PlaceholderShows a search field above the list, with your placeholder text.

Interactivity > Filtering

SettingWhat it does
Filter IndicatorCompact (default) shows the filter icon and expands it to the chip on hover or tap. Full always shows the chip. Hidden shows no chip. Used in Show which filter is active.
Ignore MasterON ignores Master filters from other symbols, so this list is not narrowed by them. Used in Let a symbol ignore the filter.
Linked InputsMaps a named channel from another publisher to a property of the loaded events. See Filtering dashboards.
Output ModeMaster publishes the filter to every symbol that listens to Master filters. Linked publishes to named channels you define as Linked Outputs, and Both uses both. Linked output needs at least one valid mapping.

Attributes

Lists the event frame attributes that Value can use. Drag more attributes onto the symbol to add them. The Numbers section sets the number format.

Troubleshooting and limitations

SymptomCauseWhat to do
The list is empty.The symbol's own search finds no events in the time range.Open Search Criteria..., check the template, and change the display time range.
An expected value is missing.No loaded event has it.Widen the search, or the time range.
A symbol does not react.Ignore Master is ON on it, or its search loads other events.Set Ignore Master to OFF, and point the symbol at the same events.
A parent cause leaves out its sub-causes.The filter matches the exact value.Select the sub-cause entries too, or use the Level1 entry of the Root Cause attribute as the first argument.
A symbol shows no events after you select an entry.Its events do not have the selected value.Set Ignore Master to ON on that symbol, or load the same events.
A link does not select an entry.Link parameter name is empty, or the value does not match an entry.Set the name, compare the value with the entry text (in Ranges mode, the range label), and check the PI Vision log for a warning.
A default selection selects nothing.A default value is no longer in the list. The filter then selects the first entry when Allow Empty is OFF, otherwise nothing, and logs a warning.Update Values or the checked ranges, and check the PI Vision log for the warning.
The Tree view shows a flat list.The filter has one argument.Add a second argument.

Limitation: Event Filter+ filters the symbols of the current display only, and only symbols that listen to Master or Linked filters.

Limitation: The entries come from the events the symbol loads. A search that returns a limited number of events limits the entries.

Limitation: Entries of a date attribute are sorted alphabetically, not by date.