Documentation Vision Library+ Product documentation

Vision Library+

Learn how to install, configure, and use the advanced symbols included with Vision Library+.

Start here

7 pages
Vision Library+ OverviewVision Library+ is a suite of custom symbols and toolbar extensions for AVEVA PI Vision (formerly OSIsoft PI Vision). It extends the built-in PI Vision symbol set with advanced data-entry controls, enhanced charting and analytics, and operator-experience tools that are not available out of the box.Getting startedVision Library+ adds symbols and toolbar tools to the PI Vision display editor. Use this chapter to choose a symbol, add it to a display, and find the settings that affect operators.Using the Time BarThe Time Bar lets an operator change the time range of one visualization without changing the PI Vision display time. It is available on supported Vision Library+ charts and tables and on Quick Trend.Themes and container stylesVision Library+ symbols that support shared styling use up to three independent settings: Theme, Surface, and Container Style. Use them to give charts, tables, gauges, forms, and controls a consistent appearance without configuring every color separately.Data QualityVision Library+ can hide exact PI No Data results and warn operators when a live value has not received a recent event. These options are available only on symbols where the behavior is meaningful.Filtering dashboardsVision Library+ symbols can coordinate selections on one PI Vision display.Symbol guideThe symbol guide is organized in the same categories as the Vision Library+ symbol directory on the Software Athlete website. Each category begins with a selection table, followed by articles that use the same setup, usage, configuration, and troubleshooting structure.

Charts

15 pages
ChartsUse chart symbols to compare time-series behavior, distributions, repeated periods, asset profiles, or process relationships.Combo Chart+Combo Chart+ trends several PI Points or AF attributes on one time axis. Each data source gets its own trace type and value scale, and you can add equipment states, limits, event frames and a table of statistics.Period Comparison Chart+Period Comparison Chart+ lays repeated time periods on top of each other, such as today, yesterday and last week, so you see at once whether the current period behaves like the earlier ones. A summary table next to the chart gives the exact numbers for every period.Heatmap+Heatmap+ shows a value as colored cells over time. Use it to see at a glance which hours, days or data sources run high, low or out of target, without reading a trend.Box Plot+Box Plot+ shows how a value is distributed. It groups the values of one or more data sources by period or by source and draws one box per group: the middle half of the values as a box, the median as a line, the spread as whiskers, and outliers and the mean as markers.Histogram+Histogram+ shows how often a value falls into each range over a period. Overlay a normal curve, check capability against specification limits, or rank the states of a digital value as a Pareto chart.Pie Chart+Pie Chart+ shows how several numeric values add up to a whole, with one slice for each data source. Choose a pie, donut, half-donut, or polar layout and label the slices with names, values, or percentages.Waterfall Chart+Waterfall Chart+ shows how a start value changes through a series of gains and losses until it reaches a final result. Each data source is one bar: either a total that stands on the baseline, or a step that rises or falls from the running total.Sankey+Sankey+ draws the flows between the stages of a process as bands whose width follows the value. Use it to see at a glance where a total comes from, where it goes, and how much each path carries.Radar Chart+Radar Chart+ compares several values on spokes around a center. Each AF asset becomes a shape, so you see at a glance which production line is strong or weak on which KPI. Every KPI can have its own scale, because KPIs rarely share a unit.ProfileView+ProfileView+ shows a cross-direction measurement profile over time. Each data source is one zone across the machine, time runs down the display, and each cell is colored by its value or by its distance from a target. Operators spot streaks, heavy edges and drift on a paper machine or another continuous web, and compare one reel with the next.FFT+FFT+ shows the frequency spectrum of a value: how strongly each repeating cycle is present in the signal over the display time range. Use it to find the frequency of a vibration or a periodic disturbance, or the period of a pattern that repeats in your process.Duval Triangle+Duval Triangle+ plots the shares of dissolved gases from a transformer on a Duval triangle and shows which fault zone the current gas mix falls in. It can also draw the recent history as a trail of points.Control Chart+Control Chart+ shows whether a process is in statistical control. It plots one measured value against control limits, marks the points that break a rule, and states in a badge whether the process is stable. With specification limits it also reports the capability indices Cpk and Ppk.XY Plot+XY Plot+ plots one measured value against another instead of against time, so you can see how two process values relate: head against flow, power against load, temperature against pressure. It adds fitted lines, reference curves, operating envelopes and a time trail to the scatter plot, and counts the points that fall inside or outside them.

Assets

11 pages
AssetsUse asset symbols to compare AF assets, analyze their values, and let operators change the asset or asset properties that a display follows.Asset Comparison Bar Chart+Asset Comparison Bar Chart+ compares the same attributes across many AF assets as bars. Rank the assets, color the bars by limits, mark a target for each asset, and let operators click a bar to open a trend or change the display's asset context.Asset Comparison Table+Asset Comparison Table+ lists the assets of an AF search as rows and their attributes as columns, so readers compare exact values side by side. You can group and total the rows, color values by limits, and let operators enter new values for several assets at once.Asset Time Series Chart+Asset Time Series Chart+ trends the same attribute for every asset that an AF search finds, such as every assembly line, so readers see which asset behaves differently. One configuration gives every asset the same trace type, value scale and limits.Asset State Timeline+Asset State Timeline+ draws one row per asset with continuous bars colored by digital state, so readers see at a glance what every asset was doing and when. Beside the bars, it can show how much of the time each asset spent in a state.Asset Analytics KPI+Asset Analytics KPI+ turns a set of AF assets into KPI cards: how many assets there are, the average or highest value of an attribute, or the same result for each mode, template, or asset. Cards can change color with your limits and follow an Asset Filter+ on the same display.Asset Analytics Chart+Asset Analytics Chart+ turns a set of AF assets into a bar, line, or area chart. Count the assets or total an attribute such as production for each asset, mode, or template, split the bars by a second attribute, and let readers click a bar to filter the rest of the display.Asset Analytics Pie+Asset Analytics Pie+ turns a set of AF assets into a pie or donut chart. Count the assets or total an attribute such as production for each mode, template, or asset, draw one pie per category, and let readers click a slice to filter the rest of the display.Asset Treemap+Asset Treemap+ shows a set of assets as rectangles. One attribute sets the size of each tile and another sets its color, so you see which assets matter most and which need attention in a single view. Tiles can be grouped by the AF hierarchy or by attribute values.Asset Select+Asset Select+ lists the assets of an AF search as a tree or list, and switches the whole display to the asset an operator clicks. It can show a value or a state color next to each asset, so operators pick the asset that needs attention.Asset Filter+Asset Filter+ lists the values of an asset attribute, such as the operating mode of each production line, and lets operators click values to narrow every asset symbol on the display. Tables, charts, and KPI cards then show only the assets that match.

Event Frames

11 pages
Event FramesUse event-frame symbols to review, aggregate, compare, filter, and edit PI System event frames from a display.Events Table+Events Table+ lists the event frames of an event frame search as a table, with their properties and attributes as columns, so operators can find, filter, group and open events. In edit mode, authorized users can also change, create, split, copy and delete event frames.Event Analytics Chart+Event Analytics Chart+ turns event frames into a bar, line, or area chart. Count events or total a number such as lost production per category, split the bars by a second attribute, and let readers click a bar to drill down or filter the rest of the display.Event Analytics KPI+Event Analytics KPI+ turns event frames into KPI cards: how many events happened, the total or average of an attribute, or the same result for each root cause, asset, or shift. Cards can change color with your limits, show the gap to a target, and follow an Event Filter+ on the same display.Event Analytics Pie+Event Analytics Pie+ turns event frames into a pie or donut chart. Count events or total a number such as lost production for each category, draw one pie per production line, and let readers click a slice to drill down or filter the rest of the display.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.Event Analytics Table+Event Analytics Table+ turns event frames into a table: one row per category, one column per summary, and a totals row. Count events, total a duration, compare it with a target, color the cells by limits, and let readers click a row to drill down or filter the rest of the display.Event Comparison Chart+Event Comparison Chart+ lays the same attribute of many event frames, such as production batches, on one elapsed-time axis. You see at a glance which batch ran differently, how far it is from a golden batch, and which shift or asset it belongs to.Gantt Chart+Gantt Chart+ draws AF event frames, such as batches, shifts or downtime, as bars on a time axis, one row per asset. You see at a glance when each event ran, how long it lasted and how events overlap.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.Event Frame Form+Event Frame Form+ shows each event frame of a search as a card. Operators open a card, update the event's attributes with the control that fits each data type, and save the changes to AF without leaving the display.

Data Entry

5 pages
Data EntryUse data-entry symbols when operators need to record, correct, or submit values from a PI Vision display. Choose the symbol according to the number of values, the amount of guidance required, and whether historical rows must remain visible.Manual Data Entry+Manual Data Entry+ lets operators type, import, or paste values for PI Points and AF attributes into a grid, check them against limits, and write them to the PI Data Archive with one Save.Manual Input Table+Manual Input Table+ shows the recorded values of PI Points and AF attributes in a table, one row per timestamp. Operators review the values next to each other, correct them, add rows, and write the changes to the PI Data Archive with one Save.Manual Input Form+Manual Input Form+ lays out writable PI Points and AF attributes as a form, with sections, labels and a control that fits each data type, and writes all the entered values to the PI Data Archive with one Save and one timestamp.Quick Input+Quick Input+ lets operators write one value to a PI Point or AF attribute straight from the display, with a field, stepper, slider, switch, list, or button that matches the data type. There is no separate Save step.

Tables

3 pages
TablesUse table symbols when operators need structured rows for current conditions, historical values, or AF reference data.Alarm Table+Alarm Table+ lists the assets whose values are in alarm, with a severity, a message and an Acknowledge button, so operators see what needs attention at a glance. You define the alarm conditions in the symbol, so no event frames or PI Notifications are needed.Time Series Table+Time Series Table+ lists the values of one or more PI Points or AF attributes in rows, with one row for each point in time. Sort, filter, group and total the rows, color cells by limits, and export what you see.

SQL

4 pages
SQLUse the SQL symbols when a display needs the rows of an AF table, a filter built from the values of an AF table column, or a custom view of AF table data.SQL Table+SQL Table+ shows the rows of an AF table on a PI Vision display and lets operators sort, filter, group, and color them. In write mode it also edits a static AF table.SQL Filter+SQL Filter+ lists the values of a column in an AF table, linked to a SQL database or static, and lets operators click values to narrow other symbols on the display.Custom SQL Visualization+Custom SQL Visualization+ shows a visualization that you let an AI write as one HTML document, fed with the live values of the symbol's data sources and the rows of AF tables. A live position against a list of planned points, or a status board built from several tables, becomes display content without a dedicated symbol.

Values & Status

7 pages
Values & StatusUse these symbols when the display must communicate a current value, operating range, alarm state, or location at a glance.KPI Card+KPI Card+ shows one PI Point or AF attribute as a compact dashboard card: a large value, its label, and optionally a comparison with a target, a short history, and a color that follows your limits. Place several cards side by side to build a KPI dashboard.Value+Value+ shows the current or a time-specific value of one PI Point or AF attribute as a compact readout with its label, unit and timestamp. Hover over it for a tooltip, or open a floating trend of the value without leaving the display.Radial Gauge+Radial Gauge+ shows a value as a needle, marker, or bar on a circular scale, with colored bands that mark the limits. Operators see at a glance where the value is and how close it is to a limit.Linear Gauge+Linear Gauge+ shows one or more process values as a marker or a bar on a horizontal or vertical scale, with colored operating ranges behind them. Operators see at a glance where a value sits between its limits.Map+Map+ places assets on a map from their latitude and longitude attributes and shows their current values in labels beside each marker. Markers and labels can take their color from limits or states, so a site that needs attention stands out.Alarm Sound+Alarm Sound+ watches one value and, when it enters an alarm condition, turns red, shows a ringing bell, and plays a looping sound until an operator acknowledges it or the value returns to normal.

Navigation & Utility

7 pages
Navigation & UtilityUse these controls to move between displays, change the display time, present approved web content inside the current PI Vision display, or show a visualization of your own.Navigation Menu+Navigation Menu+ gives operators one place to move between related displays: a bar or side menu of links to PI Vision displays and web pages, with submenus. A link can carry the display time range and asset to the display it opens, and one menu can be shared by many displays.Navigation Button+Navigation Button+ is a button that takes operators to another PI Vision display or to a web page. The link can carry the display time range and an asset, so the destination opens on the same period or the same equipment.DateTime Picker+DateTime Picker+ lets operators set the PI Vision display time range with one click, from buttons or a drop-down list of days, shifts and weeks, from a named list of ranges, or from a calendar. Every symbol on the display that follows the display time range refreshes to the range the operator picks.Web View+Web View+ shows another PI Vision display or a web page inside your display, as a single frame, as tabs, as a slideshow, or in a dialog that opens from a button.Custom Visualization+Custom Visualization+ shows a visualization that you write yourself, or let an AI write, as one HTML document, fed with the live values of the symbol's data sources. A tank, a P&ID mimic, a status board or an operator panel becomes display content instead of a server installation.Custom Visualization+ document referenceThis page shows exactly what an AI receives when you select Copy AI prompt in the code editor of Custom Visualization+: the rules a document must follow, the vlp functions and data it can use, and 12 complete example documents. Read it when you write or review a document yourself, or to see why an AI wrote a document the way it did.

Tools

3 pages
ToolsVision Library+ tools operate at display level rather than as symbols bound to a data source.PlaybackPlayback replays a past period on the whole PI Vision display. It moves the display time range forward in steps, so every symbol that follows the display time shows how the process developed.Quick TrendQuick Trend opens a floating chart of the data behind a symbol on the display. You compare traces, read exact values and statistics, and keep the chart on screen while you work, without changing the display.