Examples
The following examples can be found on this page:
Element Lookup
This Data Stream example demonstrates how to use this Listener to return element data from the OSIsoft PI System.
Refer to configuration to understand all configuration options of this Agent.
Step 1: Add the Agent
Drag the OSIsoft PI Listener onto the canvas and link the output endpoint to the printer. Rename the Agent and save the Data Stream.
Step 2: Configure General
Select the Agent and click Configure. In this case, keep the default Collection.
Step 3: Configure Authentication
Enter the authentication details: web API url, username, and password.
Step 4: Further Configuration
Set the server and database. In this case, keep the lookup type as Element.
Keep the filters ticked. Set the template, element category, and elements.
Select the Filter Attributes by Category checkbox, then select the Attributes Category, Attributes, Return Type and select Checkboxes for Inclusions. In this case, set return type to Return Latest, and selected Include Latest Value Timestamp.
Set the polling delay and number of requests per batch. In this case, set the polling delay to 60 and the number of requests per batch to 50, for 50 results every 60 seconds.
Apply the changes and save the Data Stream.
Click Publish.
Step 5: Results
Click Live View to view the results. Observe the values from OSIsoft PI are printed.
Files
See the Import, Export, and Clone - XMPro article for steps to import a Data Stream.
Event Frame Lookup
This Data Stream example demonstrates how to use this Listener to return event frame data from OSIsoft PI System.
Refer to configuration to understand all configuration options of this Agent.
Step 1: Add the Agent
Drag the OSIsoft PI Listener onto the canvas and link the output endpoint to the printer. Rename the Agent and save the Data Stream.
Step 2: Configure General
Select the Agent and click Configure. In this case, keep the default Collection.
Step 3: Configure Authentication
Enter the authentication details: web API url, username, and password.
Step 4: Further Configuration
Set the server, database and lookup type. In this case, set the lookup type to Event Frame.
Set the event frame template, element template, and element template columns.
Set the polling delay. In this case, set it to 60 for results every minute. Apply the changes and save the Data Stream.
Step 5: Results
Publish the Data Stream.
Click Live View to view the output of the Agent: observe the values from OSIsoft PI.
Files
See the Import, Export, and Clone - XMPro article for steps to import a Data Stream.
Last updated
