OSIsoft PI Connector

The OSIsoft PI Connector allows you to connect to an OSIsoft PI database and retrieve Element data as requested by the Application.

Details for an example and its configuration can be found in the How to Use section.

Supported Lookup Types

The following data lookup types are supported:

Lookup TypeInput Parameters

Element Categories - Return a list of attributes available in the configured database, Asset Framework (AF) Template, and Attributes Category.

Element Data - Return the Element data of the selected AF attributes.

  • Element - Optionally limit the result to the provided Element names (use a comma-separated string for multiple Element names).

  • Element Category - Limit the results to the Elements associated with this Element Category.

  • End Date (applies to "Return All" and "Return Summary" Return Type).

  • Start Date (applies to "Return All" and "Return Summary" Return Type).

  • Summary Interval Duration (applies to "Return Summary" Return Type) - The data aggregation timeframe.

  • Element Template - Optional runtime override (the configured Attributes must be present in this Element Template too).

Element List - Return a list of Elements available in the configured database.

Pivoted Element Data - Return the Element data of the selected AF attributes with the attribute name as a row value instead of column names.

Same as Element Data

Pre-requisites

OSIsoft PI database credentials are required to use this Connector.

Current Version

  • Request the OSIsoft PI Connector v2.21

Please contact XMPro if you're looking for an older version of this Connector.

Release Notes

v2.21, 01 May 2024

  • Implemented the new PI Client version using REST API

v1.13, 01 Feb 2024

  • Fixed the 'Unable to create Connector instance' error when choosing the Attribute List

  • Fixed the Time Series Chart error thrown when zoomed in so tight that there are no data points

v1.11, 19 Jan 2024

  • Support rounding of numeric values

    • Tick 'Apply Rounding To Numeric Values?' to apply rounding to the numeric values

    • Use 'Rounding Precision' to configure the number of decimal points

2023

v1.1, 9 Oct 2023

  • Updated Input Parameters for the Element Data and Pivoted Element Data lookup Type

    • Support multiple Element Names as a filter (in the format of a comma-separated string)

    • Support a runtime override for the Element Template

  • Performance Enhancements

    • Use UpdateValues API to write data to OSIsoft PI

    • Caching Element, Attributes data

    • Get Element Summary by the selected Attributes

v1.017, 17 Jul 2023

  • Support variables for the Server, Database, and Template properties

v1.01, 29 Jun 2023

  • Initial Release

  • Performance Enhancements

    • OSIsoft API calls were changed from sequential to batch processing

    • Added Web ID caching for database, template, element category, attribute, and elements

Last updated