PI Vision - Element Relative Toolpane

Blog Post created by pmartin Employee on Jun 1, 2017


PI Vision offers a form of Element Relativity that is quite different from PI ProcessBook.  While we love the style of PI Vision ER, we missed some of the features from ProcessBook ER when using PI Vision. With this in mind, we decided to develop a PI Vision toolpane that has features similar to what was available in ProcessBook.



  • Quickly swap between elements with a single click
  • Elements of Interest persistent across multiple sessions
  • Elements of Interest unique to each display
  • Minimal set-up
  • Robust search to populate list of Elements of Interest




Set Up


  1. In Windows Explorer, navigate to the "%PIHOME%\PIVision\Scripts\app\editor\tools\ext" on your PI Vision web server; typically, it's located in "C:\Program Files\PIPC\PIVision\Scripts\app\editor\tools\ext". If this folder doesn't exist, create it.
  2. Copy contents of the repository into the above folder. You may exclude "Example.png" and "README.MD"


In order to utilize the Elements of Interest unique to each display, an AF database is created to store the configuration strings for each display.  Use of this feature requires that the user be able to read from the AF Server when loading pages and write to the AF Server when saving the list in order to update the configuration. The creation of the AF database, elements, and attributes is done automatically once the AF Server has been specified.

The AF Server where the configuration is stored must be specified in the setup.json file located in the %pihome%\PIVision\Scripts\app\editor\Tools\Ext\ folder. With JSON format, such as the below:

{ AFServer”:”<YourAFServerName>” }

Where <YourAFServerName> is replaced with whatever AF Server you’d like to store the configuration in.

Additionally, in order to write to the AF Database, you will need Kerberos Delegation enabled and the user making changes to the elements of interest pane will need to have write permissions on that Asset Server in order to create a new database, and element beneath it.

Lastly, in some cases it has been necessary to create a MIME type in IIS in order to read the JSON configuration file if one does not already exist. This can be accomplished by opening up IIS Manager > Select the site hosting PI Vision > Double click on "MIME Types" in the Features View > Right-click "add" and use the settings below



Adding Elements to the Elements of Interest Pane

  1. Select a server from the list
  2. Verify the server connection was successful

Good: Bad:

  1. Specify search parameters:

Database (required): Which database should we search for elements in.

Root Element: Search only for elements below a particular element.  Default value searches entire database.

Element Name: Search only for elements with a particular name.  Wildcards (*) supported.  Default value is “*”

Template Name: Search only for elements with a particular template.  Default value is all templates.

Category Name: Search only for elements in a particular category.  Default value is all categories.

Add to Existing Results: Should the results of this search be added to the existing elements in the Elements of Interest.


Removing Elements from the Elements of Interest Pane

  1. Click the trash icon next to the element you want to remove from the list.

Display attributes for Element of Interest

  1. Click anywhere on the row for the element you want to view





This tool is not an official OSIsoft solution.  As such, it will not be supported.  If you have issues, please contact myself, Anna Perry, or Robert Schmitz and we will try our best to help you.