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 Type
Input 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.27

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

After upgrading from v2.21 or earlier to v2.24+, please open the Connector's configuration blade and follow the instruction message at the top of the screen to complete the upgrade process.

Release Notes

Version
Date
Description

2.27

06 Jan 2025

Repackaged to translate the Connector's properties.

2.26

14 Aug 2024

Implemented the IConnectorError interface to add error logging.

Fixed the ReturnAll data error.

2.24

27 Jul 2024

Improve overall performance by reducing calls to the OSIsoft Web API.

Support clearing the metadata cache.

2.21

01 May 2024

Implemented the new PI Client version using REST API.

1.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.

1.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

1.10

09 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

1.017

17 Jul 2023

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

1.01

29 Jan 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