
AVEVA PI Vision comes with built-in symbols such as trends, tables, gauges and bar charts. Many teams need more: Sankey diagrams for energy flows, maps, wind roses or forms for manual data entry. Custom symbols close that gap. This guide explains how PI Vision custom symbols work, which rules apply and when a ready-made add-on saves you the work.
New to PI Vision? Start with our AVEVA PI Vision guide.
How PI Vision custom symbols work
Since PI Vision 2019, custom symbols built with the PI Vision extensibility framework are fully supported. According to the PI Vision Extensibility Guide, a symbol has three layers:
- Implementation layer: JavaScript that defines and registers the symbol, initializes it and handles data updates.
- Presentation layer: an HTML template, plus optional CSS, that draws the symbol.
- Configuration layer: the options a display builder can set for the symbol.
The same framework also supports custom tool panes.
Files and folders
Custom symbols live on the PI Vision application server, in the folder Scripts\app\editor\symbols\ext of the PI Vision installation. The files follow a naming convention: sym-<name>.js for the logic and sym-<name>-template.html for the layout, with an optional sym-<name>.css for styles. Icons go into the subfolder ext\icons and external JavaScript libraries into ext\libraries. OSIsoft walked through the process in its PI World session on PI Vision extensibility.
Getting PI data into a symbol
Custom symbols receive PI data through the data shapes defined in the extensibility framework. AVEVA’s product team states on the AVEVA feedback portal that this is the only documented way to retrieve PI data in custom symbols; calling PI Web API from a symbol counts as an external data source that you configure and secure yourself.
Rules and security
The extensibility guide sets clear limits:
- The framework does not provide full display automation: no cross-symbol interactions and no changes to the display time range.
- Native PI Vision code, including the standard symbols, must not be copied or modified.
- Icons of custom symbols must look different from the native ones.
- A PI Vision license does not cover third-party libraries used inside PI Vision, such as Kendo UI.
- Since PI Vision 2020, Content Security Policy headers block scripts and frames loaded from remote sources. Keep libraries on the server, or add trusted sources in the PI Vision configuration.
Plan for upgrades
The extensibility framework is supported within the current application framework and may change as PI Vision evolves. Test every custom symbol after each PI Vision upgrade. Users on AVEVA’s feedback portal also report that a custom symbol with broken JavaScript can stop PI Vision from working for everyone, so test in a development environment before you deploy to production.
Build your own or use the PI Vision Suite?
Building your own symbol makes sense for a one-off visualization that only your plant needs. For common needs, a maintained add-on saves development and test effort. The Amitec PI Vision Suite adds 41 custom symbols and 8 tools to AVEVA PI Vision, for example Sankey diagrams, maps, wind roses, SPC trends, calendar heatmaps, radar charts, manual data entry and a date picker. It is installed directly into PI Vision, developed and supported by Amitec, licensed per production PI Vision server with development and QA servers free of charge, and you can test it with a free 30-day trial.
Frequently asked questions
Are PI Vision custom symbols supported by AVEVA?
The extensibility framework has been fully supported since PI Vision 2019. The code of your own custom symbols is yours to maintain.
Where are PI Vision custom symbols installed?
In the folder Scripts\app\editor\symbols\ext of the PI Vision installation on the application server.
Can a custom symbol use PI Web API?
It can, but AVEVA treats this as an external data source. The documented way to get PI data is the data shapes of the extensibility framework.
Do custom symbols keep working after a PI Vision upgrade?
Test them. The framework may change as PI Vision evolves, so check every custom symbol in a development environment after each upgrade.
What is the difference between a custom symbol and the PI Vision Suite?
A custom symbol is code you build and maintain yourself. The PI Vision Suite is a ready-made, supported set of 41 symbols and 8 tools from Amitec.
Related posts
How to build ISO 50001 energy performance indicators and energy baselines from AVEVA PI data, and where energy:center automates the work.
What PI Asset Framework (AF) is and how elements, attributes, data references, templates, analyses and event frames work together.




