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:
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", "Return Summary" and "Return Interpolated" Return Type).
Start Date (applies to "Return All", "Return Summary" and "Return Interpolated" Return Type).
Summary Interval Duration (applies to "Return Summary" Return Type) - The data aggregation timeframe.
API Filter Expression (applies to "Return All", "Return Summary" and "Return Interpolated" Return Type)
Sampling Interval (applies to "Return Interpolated" Return Type)
Sync Time (applies to "Return Interpolated" Return Type)
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.43 (Last Update: 30 Oct 2025)
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
2.43
30 Oct 2025
Support multiple aliases for a single PI attribute, allowing the same attribute value to be mapped to multiple output fields with different alias names. For example: to display sensor status for multiple axes on an asset.
2.42
30 Jun 2025
Repackaged to remove the System.Data.SqlClient library, to instead be served by App Designer. Ensured all SqlClient and HttpClient references are disposed.
2.41
30 May 2025
Implemented attribute alias function using a SQL database table and resolved an issue where an error was thrown when the cache duration was set to 0 while using Redis cache.
2.39
23 Apr 2025
Implemented GZip request header to Pi Web API to increase performance. Implemented new return type Return Interpolated, added return include the latest value option when Return Interpolated / Return Summary is selected
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
Was this helpful?