# OSIsoft PI Connector

The OSIsoft PI Connector allows you to connect to an [OSIsoft PI](https://resources.osisoft.com/pi-system/) database and retrieve Element data as requested by the Application. 

Details for an [example](https://xmpro.gitbook.io/integrations/osisoft-pi-connector/how-to-use/example) and its [configuration](https://xmpro.gitbook.io/integrations/osisoft-pi-connector/how-to-use/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.                                                                          | <ul><li>Element - Optionally limit the result to the provided Element names (use a comma-separated string for multiple Element names).</li><li>Element Category - Limit the results to the Elements associated with this Element Category.</li><li>End Date (applies to "Return All", "Return Summary" and "Return Interpolated" <strong>Return Type</strong>).</li><li>Start Date (applies to "Return All", "Return Summary" and "Return Interpolated" <strong>Return Type</strong>).</li><li>Summary Interval Duration (applies to "Return Summary" <strong>Return Type</strong>) - The data aggregation timeframe.</li><li>API Filter Expression (applies to "Return All", "Return Summary" and "Return Interpolated" <strong>Return Type</strong>)</li><li>Sampling Interval (applies to "Return Interpolated" <strong>Return Type</strong>) </li><li>Sync Time (applies to "Return Interpolated" <strong>Return Type</strong>)</li></ul> |
| **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](mailto:support@xmpro.com?subject=Connector-osisoft-pi-connector-2.43) the OSIsoft PI Connector v2.43 (Last Update: 30 Oct 2025)

Please [contact](mailto:support@xmpro.com?subject=osisoft-pi-connector-older-version) XMPro if you're looking for an older version of this Connector.&#x20;

{% hint style="info" %}
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.
{% endhint %}

## Release Notes

<table><thead><tr><th width="105">Version</th><th width="129">Date</th><th>Description</th></tr></thead><tbody><tr><td>2.43</td><td>30 Oct 2025</td><td>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.</td></tr><tr><td>2.42</td><td>30 Jun 2025</td><td>Repackaged to remove the System.Data.SqlClient library, to instead be served by App Designer.
<br>Ensured all SqlClient and HttpClient references are disposed.</td></tr><tr><td>2.41</td><td>30 May 2025</td><td>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.</td></tr><tr><td>2.39</td><td>23 Apr 2025</td><td>Implemented GZip request header to Pi Web API to increase performance. Implemented new return type <strong>Return Interpolated,</strong> added return include the latest value option when <strong>Return Interpolated / Return Summary</strong> is selected</td></tr><tr><td>2.27</td><td>06 Jan 2025</td><td>Repackaged to translate the Connector's properties.</td></tr><tr><td>2.26</td><td>14 Aug 2024</td><td><p>Implemented the <a href="https://documentation.xmpro.com/how-tos/connectors/building-connectors#iconnectorerror">IConnectorError</a> interface to add error logging.</p><p>Fixed the <em>ReturnAll</em> data error.</p></td></tr><tr><td>2.24</td><td>27 Jul 2024</td><td><p>Improve overall performance by reducing calls to the OSIsoft Web API.</p><p>Support clearing the metadata cache.</p></td></tr><tr><td>2.21</td><td>01 May 2024</td><td>Implemented the new PI Client version using REST API.</td></tr><tr><td>1.13</td><td>01 Feb 2024</td><td><p>Fixed the 'Unable to create Connector instance' error when choosing the Attribute List.</p><p>Fixed the <a href="https://documentation.xmpro.com/blocks-toolbox/visualizations/time-series-chart">Time Series Chart</a> error thrown when zoomed in so tight that there are no data points.</p></td></tr><tr><td>1.11</td><td>19 Jan 2024</td><td><p>Support rounding of numeric values</p><ul><li>Tick 'Apply Rounding To Numeric Values?' to apply rounding to the numeric values</li><li>Use 'Rounding Precision' to configure the number of decimal points</li></ul></td></tr><tr><td>1.10</td><td>09 Oct 2023</td><td><p>Updated Input Parameters for the Element Data and Pivoted Element Data lookup Type</p><ul><li>Support multiple Element Names as a filter (in the format of a comma-separated string)</li><li>Support a runtime override for the Element Template</li></ul><p>Performance Enhancements</p><ul><li>Use UpdateValues API to write data to OSIsoft PI</li><li>Caching Element, Attributes data</li><li>Get Element Summary by the selected Attributes</li></ul></td></tr><tr><td>1.017</td><td>17 Jul 2023</td><td>Support variables for the Server, Database, and Template properties.</td></tr><tr><td>1.01</td><td>29 Jan 2023</td><td><p>Initial Release.</p><p>Performance Enhancements</p><ul><li>OSIsoft API calls were changed from sequential to batch processing</li><li>Added Web ID caching for database, template, element category, attribute, and elements</li></ul></td></tr><tr><td></td><td></td><td></td></tr></tbody></table>