Search
Generic filters
Exact matches only
  1. Home
  2. Knowledge Base
  3. Remote Context Service
  4. Mapping AF and SQL Remote Context Service Attributes

Mapping AF and SQL Remote Context Service Attributes

The Visual KPI Remote Context Service (RCS) automates the configuration of Visual KPI by reading metadata from OSIsoft AF and SQL databases (and others). For these two sources, you will need to add appropriate attributes and child attributes to AF and/or SQL so the Visual KPI Remote Context Service can read them to create/edit/delete the various object types and values.

The Visual KPI RCS looks for attribute names when deciding which Visual KPI object to create, change, etc. We try (very hard) to map the attribute or field to the appropriate column name in Visual KPI Designer.

OSIsoft AF RCS Best Practices

When using the Visual KPI RCS for OSIsoft AF, you should have attributes for each Visual KPI object (excluding Groups) with a specific label for each Object Type.

While Visual KPI tries to figure out the object type based on certain fields, it’s better to specify the type. For example, if Visual KPI sees a field with High High, we assume this is a KPI.

The attribute should be named Object Type. It should be a string with the valid values, either with, or without, spaces between words. For example, both would be valid: Display Order, DisplayOrder.

Use the following table to name Object Types and Values:

Object Types and Values

Object TypeValid Value for Attribute
KPIKPI
Bar Chart
Bar, Bar Chart, BarChart
Embedded ContentEmbedded, Embedded Content, EmbeddedContent
Gannt ChartGantt, Gantt Chart, GanttChart
Pareto ChartPareto, Pareto Chart, ParetoChart
Pie ChartPie, Pie Chart, PieChart
TrendTrend
XY PlotXY, XY Plot, XYPlot
TableTable

SQL RCS Best Practices

For all interfaced fields, Visual KPI supports the recommended ‘interface name‘ of ‘interface ID‘ if used with the correct field name.

Example:

You have an interface called ‘ODBC-Localhost‘ with an ID of 4e432114-499c-44e1-994d-7690de272b74. You can use Latitude and LatitudeInterface, where Latitude is the lookup value and LatitudeInterface is set to ‘ODBC-Localhost’.
or
You can use Latitude and LatitudeInterfaceID where Latitude is the lookup value and LatitudeInterfaceID is 4e432114-499c-44e1-994d-7690de272b74.

View tables with valid values for each Object Type:

Groups

KPIs

Charts

Tables

Note: Tables include values for Visual KPI Designer, AF, SQL and inmation.

Learn more

Visual KPI Remote Context Services (RCS)

How Visual KPI Remote Context Server Works

 

 

 

Was this article helpful?

Related Articles