Comment on page

Configuration

This section explains each of the properties in the configuration blade.
Configuration common to both Element and Event Frame Lookup types
General
Property
Description
Collection
This associates the Agent to a specific Collection (default to that of the current Data Stream).
Polling Interval (seconds)
A timespan to specify how often should the Agent check for new data/changes or update its cache.
Refer to Collections and Stream Hosts to understand more about Collections.
Authentication
Property
Description
Use Connection Variables
Tick to select saved variables; or enter the text manually for the authentication properties.
Web API Url
Web API Url of the OSIsoft PI instance.
Username
The user name to use for authenticating the connection.
Password
The password to use for authenticating the connection.
Configuration
Property
Description
Server
The name of the server to connect to. Once selected, the Database field is populated with the list of available databases.
Database
The name of the database to connect to.
Lookup Type
Read Event Frame data (default) or Element data.
Event Frame
This section applies to the Event Frame lookup type only.
Event Frame Lookup Configuration
Property
Description
Filter By Event Frame Template
Tick to filter data by event frame template.
Event Frame Templates
One or more templates from which the Agent reads the data (applies when Filter By Event Frame Template is ticked).
Filter By Element Template
Tick to filter data by element template. 
Element Templates
One or more element templates from which the Agent reads the data (applies when Filter By Element Template is ticked).
Columns
One or more columns to read.
Polling Delay (in secs)
The delay in-between data retrieval, therefore including data overlap to ensure no missing data.
Element
This section applies to the Element lookup type only.
Property
Description
Filter By Template
Tick to filter Elements field by element template.
Template
The template from which the Agent reads the data (applies when Filter By Template is ticked).
Filter Elements By Category
Tick to filter Elements field by element category. 
Use Variable For Elements Category
Tick to select saved variables; or enter the text manually for the Elements Category properties.
Elements Category
The element category to filter the Elements property (applies when Filter Elements By Category is ticked).
Elements
One or more elements from which the data is read. If none are specified, data for all elements from the selected Template and/or Elements Category will be returned.
Filter Attributes By Category
Tick to filter Attributes field by category.
Attributes Category
The attributes category to filter the Attributes property (applies when Filter Attributes By Category is ticked).
Attributes
One or more attributes to read. At least one attribute must be selected.
Return Attribute Description vs Name
Tick to include the attribute description and not the name.
Return Type
Return all data (Return All) or only the latest record since the previous poll (Return Latest).
Include Latest Value Timestamp
Tick to include the latest value for the timestamp when displaying data.
Include Unit of Measure
Tick to include the unit of measurement in the data, e.g. mm, cm , m, km.
Include Summaries
Tick to specify summary options to return summary data. 
Specify Exclusion Conditions
Tick to specify criteria to ignore the data from the current poll. This is to cater for outliers.
Polling Delay (in secs)
The delay in-between data retrieval, therefore including data overlap to ensure no missing data.
Number of Requests Per Batch
The number of requests retrieved within each polling interval.
Exclusion Conditions
This section applies to the Element lookup type when Specify Exclusion Conditions is ticked.
Element Lookup Configuration when Specify Exclusion Conditions option is ticked
Property
Description
Criteria
The exclusion criteria using the available attributes.
Duration (Minutes)
The duration in minutes. If the above criteria is true within the duration specified here, data from the current poll will be ignored.
Endpoints
Name
Description
Output
Data read from OSIsoft PI System will be made available on this endpoint with attributes/columns matching the configured payload.
Error
If errors are encountered during the execution of this Agent they will be published on this endpoint.

Property	Description
Collection	This associates the Agent to a specific Collection (default to that of the current Data Stream).
Polling Interval (seconds)	A timespan to specify how often should the Agent check for new data/changes or update its cache.

Property	Description
Use Connection Variables	Tick to select saved variables; or enter the text manually for the authentication properties.
Web API Url	Web API Url of the OSIsoft PI instance.
Username	The user name to use for authenticating the connection.
Password	The password to use for authenticating the connection.

Property	Description
Server	The name of the server to connect to. Once selected, the Database field is populated with the list of available databases.
Database	The name of the database to connect to.
Lookup Type	Read Event Frame data (default) or Element data.

Property	Description
Filter By Event Frame Template	Tick to filter data by event frame template.
Event Frame Templates	One or more templates from which the Agent reads the data (applies when Filter By Event Frame Template is ticked).
Filter By Element Template	Tick to filter data by element template.
Element Templates	One or more element templates from which the Agent reads the data (applies when Filter By Element Template is ticked).
Columns	One or more columns to read.
Polling Delay (in secs)	The delay in-between data retrieval, therefore including data overlap to ensure no missing data.

Property	Description
Filter By Template	Tick to filter Elements field by element template.
Template	The template from which the Agent reads the data (applies when Filter By Template is ticked).
Filter Elements By Category	Tick to filter Elements field by element category.
Use Variable For Elements Category	Tick to select saved variables; or enter the text manually for the Elements Category properties.
Elements Category	The element category to filter the Elements property (applies when Filter Elements By Category is ticked).
Elements	One or more elements from which the data is read. If none are specified, data for all elements from the selected Template and/or Elements Category will be returned.
Filter Attributes By Category	Tick to filter Attributes field by category.
Attributes Category	The attributes category to filter the Attributes property (applies when Filter Attributes By Category is ticked).
Attributes	One or more attributes to read. At least one attribute must be selected.
Return Attribute Description vs Name	Tick to include the attribute description and not the name.
Return Type	Return all data (Return All) or only the latest record since the previous poll (Return Latest).
Include Latest Value Timestamp	Tick to include the latest value for the timestamp when displaying data.
Include Unit of Measure	Tick to include the unit of measurement in the data, e.g. mm, cm , m, km.
Include Summaries	Tick to specify summary options to return summary data.
Specify Exclusion Conditions	Tick to specify criteria to ignore the data from the current poll. This is to cater for outliers.
Polling Delay (in secs)	The delay in-between data retrieval, therefore including data overlap to ensure no missing data.
Number of Requests Per Batch	The number of requests retrieved within each polling interval.

Property	Description
Criteria	The exclusion criteria using the available attributes.
Duration (Minutes)	The duration in minutes. If the above criteria is true within the duration specified here, data from the current poll will be ignored.

Name	Description
Output	Data read from OSIsoft PI System will be made available on this endpoint with attributes/columns matching the configured payload.
Error	If errors are encountered during the execution of this Agent they will be published on this endpoint.

Last modified 1mo ago