Search
Generic filters
Exact matches only
Filter by Custom Post Type
  1. Home
  2. Knowledge Base
  3. Interfaces & Data Sources
  4. Integrate Visual KPI RCS with OSIsoft PI AF Attributes
  1. Home
  2. Knowledge Base
  3. Remote Context Service
  4. Integrate Visual KPI RCS with OSIsoft PI AF Attributes

Integrate Visual KPI RCS with OSIsoft PI AF Attributes

Visual KPI Remote Context Services (RCS) can use OSIsoft PI AF as the master for configuration and hierarchy data and metadata, eliminating the need to have your data configuration in two places: Visual KPI Designer and OSIsoft PI AF. 

Your OSIsoft PI AF model becomes the master source for data, structure, hierarchy, metadata and groupings for metadata. RCS allows you to integrate this master source with Visual KPI Designer and deliver real-time data to your Visual KPI websites.

How RCS Integration Works with OSIsoft PI AF

Visual KPI looks for certain attributes in OSIsoft PI AF when deciding whether to create either a KPI, a Trend, Value, or another object from an AF attribute.

Below are some examples of how Visual KPI maps AF attributes to Visual KPI objects. For the full list of keywords and Visual KPI mapping, see keyword lists:

KPI

Visual KPI RCS will create a KPI if it finds one or more of the following sub-attributes: 

  • Max, Maximum 
  • High High High, HighHighHigh, Hi Hi Hi, HiHiHi, HHH 
  • High High, HighHigh, Hi Hi, HiHi, HH 
  • High, Hi, H 
  • Target, Tgt 
  • Low, Lo, L 
  • Low Low, LowLow, Lo Lo, LoLo, LL 
  • Low Low Low, LowLowLow, Lo Lo Lo, LoLoLo, LLL 
  • Min, Minimum 
  • URL (string any valid URL) 
  • URL Descriptor, URLDescriptor, URL Description, URLDescription, URL Name, URLName (string) 
  • KPI Name Click Path, Name Click Path (URL indicated that the system will look for URLs (above), anything else or missing goes to Trend)*  

* URL and URL Descriptor can be semi-colon (;) delimited lists. It is best if you match these up (for example: 3 urls and 3 descriptors)

Trend

Visual KPI RCS will create a Trend if it finds one or more of the following sub-attributes: 

  • Pen 1, Pen1, P1, Pen 01, Pen01, P01 
  • Pen 2, Pen2, P2, Pen 02, Pen02, P02 
  • Pen 3, Pen3, P3, Pen 03, Pen03, P03 
  • Pen 4, Pen4, P4, Pen 04, Pen04, P04 
  • Pen 5, Pen5, P5, Pen 05, Pen05, P05 
  • Pen 6, Pen6, P6, Pen 06, Pen06, P06 
  • Pen 7, Pen7, P7, Pen 07, Pen07, P07 
  • Pen 8, Pen8, P8, Pen 08, Pen08, P08 
  • Pen 9, Pen9, P9, Pen 09, Pen09, P09 
  • Pen 10, Pen10, P10 

Table

Visual KPI RCS will create a Table if it finds one or more of the following sub-attributes: 

  • ConnectString
  • Connect String
  • ConnectionString
  • Connection String 

Group

The following properties apply to Groups

  • Zoom Level
  • ZoomLevel
  • Zoom (numeric 0-21)  

KPI and Trend

The following properties apply to KPIs and Trends

  • Trend Scale
  • TrendScale 
  • string “Multi-Scale”, “Multiscale”, “Multi Scale” all mean multi-scale; anything else or missing means single scale  

General Properties

The following are general properties that apply to all Visual KPI object types (Groups, KPIs, Values, Trends, Links, Tables

  • Lat, Latitude* 
  • Long, Longitude* 
  • Show 
  • InService, In Service  

*Note that Lat/Long both must be present to create a valid geo coordinate.

Note: If none of the above sub-attributes exist, each attribute will be considered an individual value. In this case, AF Elements will map to Visual KPI groups.

Get help integrating Visual KPI RCS with OSIsoft PI AF

If you have questions or would like assistance setting up on your own system, contact us or email support@transpara.com

Was this article helpful?

Related Articles