OSIsoft PI Listener

Description

The OSIsoft PI Listener reads data from OSIsoft PI System using Web API

Configuration

To add the OSIsoft PI Listener to a stream, follow the steps below:

1. Ensure you have a use case open in the stream designer, this can be a new use case or an existing use case
2. From the toolbox on the left expand the Listener option and scroll down until you can see “OSIsoft PI Listener”
   • You can also use the search in the header to find the stream object quickly
3. Click and drag the OSIsoft PI Listener from the toolbox onto the canvas
4. Rename the Listener by clicking into the text button on the action bar
5. Save the Stream by clicking the save button in the action bar
6. Hover over the icon for the stream object until it turns orange and then double click to open the configuration page
   • You can optionally use the configure option on the action bar once you have selected the specific stream object and then clicking this option
7. Configuration options
   • The drop down allows you to associate this stream object with a specific collection. The default option is derived from the default specified against the specific use case and is generated left as the same option. If you do need to change it to another collection make the change by selecting the new collection in the drop down.
   • Enter a value for the Polling Interval (the interval at which new records are accessed/checked for, in seconds)
8. Enter Authentication details
   • Enter the Web API Url
   • Enter the Username
   • Enter the Password
9. Enter Configuration details
   • Select Server from drop-down list
   • Select Database from drop-down list
   • Select Template from drop-down list
   • Select Elements from drop-down list
   • Select Attributes from drop-down list
   • Select Return Type from drop-down list: Return All or Return Latest
10. Tick “Include Summaries” to enter Summary Options
    • Select Summary Attributes from drop-down list
    • Select Summary Types from drop-down list
    • Select Duration Unit from drop-down list: Day, hour or minutes
    • Enter the Duration Value
    • Tick “Use Summary Interval” if required. Select Interval Duration Unit, Enter Interval Duration Value
11. Click Apply on the action bar, and then save the stream using the save button.

Limitations

• None at this time.

Release Notes

Version:	1.51
Released:	07-Feb-2020
Release Notes:	Added functionality to filter attributes by category to improve API requests’ performance