OSIsoft PI

The OSIsoft PI Agents allows you to include data from an OSIsoft PI System in your Data Stream using the PI Web API.

The Listener allows you to read all recorded data of an Element(s) or Event Frame(s) since the last poll from the PI System. This agent also allows you to get summarized data from an OSIsoft PI System.

The Context Provider allows you to read all recorded Element(s) or Event Frame(s) data over a specified date/time range from an OSIsoft PI System.

The Action Agent allows you to update element data in an OSIsoft PI System.

Pre-requisites

The following is required to use these Agents:

  • PI AF Server should be installed before using the OSIsoft PI agents

  • PI Data Archive Server should be installed before using the OSIsoft PI agents

  • PI Web API needs to be installed and running alongside OSIsoft PI Server

  • The Stream Host running the Data Stream should be on a VM that has access to the OSIsoft PI server

Current Version

  • Request the OSIsoft PI Listener v4.02

  • Request the OSIsoft PI Context Provider v4.30

  • Request the OSIsoft PI Action Agent v3.02

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

Listener Release Notes

v4.02, 20 April 2024

  • Fixed summary attribute issues and validation errors

v4.0, 18 April 2024

  • Implemented the new PI Client library using REST API

  • Added PoolConnectionTimeout

v3.04, 17 Oct 2023

  • Includes number of requests per batch

  • Includes relabeling of properties

v2.66, 30 Jun 2023

  • Added polling delay option

v2.65, 23 May 2023

  • Added option to include the unit of measure (UoM) in the output

v2.64, 4 May 2023

  • Added option to include the latest value's timestamp in the output

Older

v2.60, 01 Dec 2022

  • Fixed bug in GetEndTime method (introduced in v2.56)

v2.59, 17 Nov 2022

  • Added the option to specify Elements Category using a variable

v2.58, 15 Nov 2022

  • Repackaged to include the Agent's Category

v2.57, 23 Sep 2022

  • Updated to return Name from values of complex data types

v2.56, 25 Jul 2022

  • Added Month and Year duration types to the Summary Interval duration property

v2.55, 02 Jun 2022

  • Added additional error handling to the Create and Poll events

v2.53, 08 Dec 2021

  • Added Polling Delay config option

v2.51, 04 Nov 2021

  • Merging changes from v2.42 and v2.43 into v2.50

v2.50, 11 Oct 2021

  • Added Event Frame lookup functionality

v2.43, 04 Nov 2021

  • Fixed an issue with refreshing the element list on every poll

v2.42, 11 Oct 2021

  • Fixed issue with summary attributes

v2.41, 15 Sep 2021

  • Enabled summary option for attribute names without a ".PV" suffix

v2.39, 05 Aug 2021

  • Added functionality to read child attributes

  • Filtering Summary Attributes list and using name filter to limit summary to numeric tags only

v2.38, 16 Mar 2021

  • Getting inherited attributes as well when using template

v2.37, 11 Mar 2021

  • Getting attributes based on template instead of element when filtering by template

v2.34, 17 Dec 2020

  • Fetching element list on every poll when no elements are specified

v2.33, 31 Aug 2020

  • Fixed issue with outputs when no template is selected

v2.32, 21 Aug 2020

  • Setting Filter By Template to True by default

v2.31, 18 Aug 2020

  • Added option to filter the elements and attributes without specifying the template

v2.2, 20 Jul 2020

  • Added 'Second' option to Summary Duration Unit and Interval Duration Unit

v2.1, 14 May 2020

  • Fixed issue with system variables where in variable values are now not copied to text fields when switching from variable box to text box

v2.0, 28 Apr 2020

  • Added option to specify connection settings using system Variables

  • Using Connection Variables is the default setting from this version

  • If upgrading the agent in an existing data stream, add the system variables first and then perform the variable mapping in the data stream

v1.61, 18 Aug 2020

  • Added option to filter the elements and attributes without specifying the template

v1.52, 22 Apr 2020

  • Added functionality to filter elements by category

v1.51, 07 Feb 2020

  • Added functionality to filter attributes by category to improve API requests' performance

v1.49, 25 Oct 2019

  • Fixed issue with missing summary, latest and recorded data

v1.48, 22 Oct 2019

  • Incorporate changes to the Filter agent

v1.47, 24 Sep 2019

  • Added Exclusion Conditions option

v1.46, 20 Aug 2019

  • Added option to specify Summary attributes separate to Main attributes

v1.45, 20 Aug 2019

  • Fixed integrity check for Elements

  • Added validation of Summary and Interval Duration values in integrity check

v1.44, 19 Aug 2019

  • Included option to specify Summary Interval Duration

v1.43, 15 Aug 2019

  • Fixed bug in the number of output columns when summary options are selected

v1.42, 09 Aug 2019

  • Replacing hyphen with underscore in output properties

v1.41, 02 Aug 2019

  • Returning the values only if they are Good, otherwise returning null

v1.40, 31 Jul 2019

  • Included option to retrieve summary values

v1.30, 26 Jul 2019

  • Implemented attribute filter

  • Implemented element filter

  • Implemented return all vs return latest

v1.17, 24 Jul 2019

  • Agent made Non-Virtual

v1.16, 04 Mar 2019

  • Updated help url

v1.15, 13 Aug 2018

  • Added error endpoint

v1.14, 18 May 2018

  • Corrected agent name

v1.13, 15 May 2018

  • Added validation

v1.0, 19 Mar 2018

  • Initial Release

Context Provider Release Notes

v4.30, 23 Apr 2024

  • Implemented the new PI Client library using REST API

  • Implemented the use of variables for Server and Database fields

  • Hiding Element Category fields when using the Event Frame lookup type

  • Fixed issues in polling and validation

  • Fixed issue with looking up child attributes

  • Added option to specify MaxCount

2022

v3.21, 15 Nov 2022

  • Repackaged to include the Agent's Category

v3.20, 23 Sep 2022

  • Updated to return Name from values of complex data type

v3.19, 02 Jun 2022

  • Added additional error handling to the Create and Poll events

Older

v3.18, 14 Dec 2021

  • Added Event Frame lookup functionality

v2.05, 13 Sep 2020

  • Update of CP to retrieve all recorded data from specified duration

v2.0, 03 Aug 2020

  • Added System Variables functionality

  • Added option to filter Elements and Attributes by category; Removed task cancellation functionality

v1.24, 21 Jan 2020

  • Added cancellation token to fix issue on unpublish of a stream

v1.23, 16 Jan 2020

  • Fixed the error on Elements dropdown

v1.22, 09 Aug 2019

  • Replacing hyphen with underscore in output properties

v1.21, 02 Aug 2019

  • Returning the values only if they are Good, otherwise returning null

v1.20, 01 Aug 2019

  • Agent made Non-Virtual

  • Added option to select Attributes

v1.16, 04 Mar 2019

  • Updated help url

v1.15, 13 Aug 2018

  • Added error endpoint

v1.14, 08 Jun 2018

  • Updated help url

v1.0, 19 Mar 2018

  • Initial Release

Action Agent Release Notes

v3.02, 01 May 2024

  • Implemented the new PI Client library using REST API

v2.38, 14 Aug 2023

  • Implemented parallel processing and the use of a streamset endpoint to write data faster

2022

v2.21, 15 Nov 2022

  • Repackaged to include the Agent's Category

v2.2, 12 Oct 2022

  • Fix to ignore null values when writing to PI

v2.1, 02 Jun 2022

  • Added additional error handling to the Create and Poll events

Older

v2.0, 03 Aug 2020

  • Added System Variables functionality; Added option to filter Attributes by category; Removed task cancellation functionality

v1.0, 13 Aug 2019

  • Initial Release

Last updated