Asset Analytics KPI+

Overview

When to use it

Use Asset Analytics KPI+ when you need to:

• Count the assets that match a search, or the assets in each state.
• Show the total, average, minimum, or maximum of an attribute across many assets.
• Split a result into one card per mode, template, or asset.
• Keep only the highest or lowest assets and group the rest as Others.
• Color cards by limits, or compare them with a target.
• Let operators narrow the cards with an Asset Filter+.

Choose KPI Card+ for one PI Point or attribute with a sparkline or a history comparison. Choose Asset Comparison Table+ when you need one row per asset with all of its values. Choose Event Analytics KPI+ when the cards should summarize event frames.

Before you begin

• Prepare the AF assets: either a fixed set of elements, or an asset search by database, root, and template.
• For a sum, average, minimum, maximum, median, or standard deviation, use a numeric attribute. Text, Boolean, and date properties offer only Count and Count Distinct.
• Each asset contributes its current value. The symbol does not aggregate an attribute over the display time range.
• Units come from the AF attribute.

Add and set up the symbol

1. Select Asset Analytics KPI+ in the PI Vision symbol gallery.
2. Search for the assets, then drag an attribute such as Speed from the results onto the display. The symbol starts with one card that counts the assets.
3. Right-click the symbol and select Configure Asset Analytics KPI....
4. Under Dimension, open Values. Set Summary to Average.
5. Enter Average speed as the Title.
6. Close the configuration pane. The card shows the average speed of all assets, with the unit from AF.

Note: Attribute names show a leading | in the Value lists. Asset properties such as AssetName and TemplateName have none.

Common tasks

Summarize an attribute across all assets

Use this when one card is not enough, for example the number of assets next to the average and the highest speed.

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 AssetName or |Speed.
4. Set Summary (3) to Count, Sum, Max, or another calculation.
5. Enter a Title (4) such as Assets or Top speed.
6. Repeat for each card.

Each value becomes one card. Show set to OFF keeps a value in the list without a card.

Split the result into one card per category

Use this when you want the same calculation for each mode, template, state, or asset.

1. Open Series and select + (1).
2. Set Value (2) to the property that defines the cards, for example |Mode.
3. Check Sort by (3). It 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 mode, titled with the category. With several values, every value is calculated for every category.

Show only the highest assets

Use this when many assets would crowd the symbol and operators need the leaders only.

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

The symbol shows the three leading assets and an Others card. A sum for Others keeps the grand total complete.

Color cards by limits

Use this when operators 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 (3), type a limit and 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 40 and 60 give green below 40, amber up to 60, and red above.

For a target instead of colors, see Target under Values in the reference.

Narrow the cards with Asset Filter+

Use this when operators should choose the assets that the cards summarize. Add an Asset Filter+ to the display that lists an attribute such as Mode.

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

The value (3) now covers only the selected assets. Clear the selection in the Asset Filter+ or through the indicator to see all assets again. See Filtering dashboards for linked channels.

Change the assets with search criteria

Use this when the assets come from a search, and you want a different set.

1. Right-click the symbol and select Search Criteria.... A symbol with a fixed set of assets offers Add Dynamic Search Criteria... instead, which replaces the fixed set.
2. Narrow the search with Search Root (1), Asset Name (2), Asset Type, or Asset Category. Asset Name accepts wildcards such as Line 1*.
3. Set Number of Results (3) to the most assets you want. The default is 16.
4. Select Refresh (4).

The cards recalculate for the new set. Each symbol keeps its own search.

Use the symbol

• Click Action: the designer chooses what a click does. None does nothing. Drilldown replaces the cards with the next series for the clicked category and adds a drill-up button at the top right. Filter selects the card and publishes it as an asset filter for the other symbols. Select the card again to clear it.
• Filters from other symbols: an Asset Filter+ or another asset symbol narrows the cards. Filters from Event Filter+ and the Event Analytics symbols are ignored.
• No assets: when nothing matches, the cards stay in the configured style. A count or sum reads 0 and every other summary reads a dash. These cards cannot be clicked.
• Asset without the attribute: an asset that has no value for the attribute adds nothing to a sum or average. In a card of its own it shows only the unit.
• The symbol only displays data. It does not write to the PI System.

Configure the symbol

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

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

Interactivity > Selection

Interactivity > Filtering

Attributes

Current Attributes are the attributes the symbol reads for every asset. Additional Attributes are the ones the assets offer but the symbol does not read. Use the buttons between the lists to move entries, and the arrows to reorder. Only current attributes appear in the Value lists.

Numbers

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

Add Multi-State

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

Troubleshooting and limitations

Limitation: The symbol reads the current attribute value. For a time-based answer, such as the average over the last shift, use an AF analysis or Asset Time Series Chart+.

Limitation: The properties offered for values and series are Asset, AssetName, Description, TemplateName, Path, and HasChildren, plus attributes. Element categories and extended properties are not available.

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