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 will be populated with the list of available databases.
Database
The name of the database to connect to.
Lookup Type
Read Element data (default) or Event Frame data.
Polling Delay (in secs)
The number of seconds by which the stream polls behind the current time. 
With a polling interval of 60 seconds and a delay of 60 seconds, the stream looks for new data between [Current Time - 120 seconds] and [Current Time - 60 seconds]. 
With a delay of 0 seconds, the lookup period is [Current Time - 60 seconds] and [Current Time].
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.
Element
This section applies to the Element lookup type only.
Element Lookup Configuration when Filter By Template option is ticked
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. 
Elements Category
The element category to filter the Elements field below. Applies only 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 field. Applies only when Filter Attributes By Category is ticked.
Attributes
One or more attributes to read. At least one attribute must be selected.
Return Type
Return all data or only the latest record since the previous poll.
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.
Summary Options
This section applies only to the Element lookup type and when Summary Options is ticked.
Element Lookup Configuration when Include Summaries option is ticked
Property
Description
Summary Attributes
One or more attributes for which summary data should be returned.
Summary Types
One or more summary types applied to the selected Summary Attributes. Available options are  Average, Count, Minimum, Maximum, Range, Standard Deviation, Population Standard Deviation, Percent Good, Total and Total with UoM. 
Duration Unit
The Duration Unit for which summary data should be returned. Available options are Second, Minute, Hour, Day, Month, and Year.
Duration Value
The summary duration value applies to the Duration Unit.
Use Summary Interval
Tick to split summary duration into multiple intervals.
Interval Duration Unit
The interval duration type options are Year, Month, Day, Hour, Minute, and Second (applies when Use Summary Interval is ticked).
Interval Duration Value
The interval duration value applied to the above Interval Duration Unit (applies when Use Summary Interval is ticked).
Exclusion Conditions
This section applies only to the Element lookup type and 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 will be populated with the list of available databases.
Database	The name of the database to connect to.
Lookup Type	Read Element data (default) or Event Frame data.
Polling Delay (in secs)	The number of seconds by which the stream polls behind the current time. With a polling interval of 60 seconds and a delay of 60 seconds, the stream looks for new data between [Current Time - 120 seconds] and [Current Time - 60 seconds]. With a delay of 0 seconds, the lookup period is [Current Time - 60 seconds] and [Current Time].

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.

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.
Elements Category	The element category to filter the Elements field below. Applies only 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 field. Applies only when Filter Attributes By Category is ticked.
Attributes	One or more attributes to read. At least one attribute must be selected.
Return Type	Return all data or only the latest record since the previous poll.
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.

Property	Description
Summary Attributes	One or more attributes for which summary data should be returned.
Summary Types	One or more summary types applied to the selected Summary Attributes. Available options are Average, Count, Minimum, Maximum, Range, Standard Deviation, Population Standard Deviation, Percent Good, Total and Total with UoM.
Duration Unit	The Duration Unit for which summary data should be returned. Available options are Second, Minute, Hour, Day, Month, and Year.
Duration Value	The summary duration value applies to the Duration Unit.
Use Summary Interval	Tick to split summary duration into multiple intervals.
Interval Duration Unit	The interval duration type options are Year, Month, Day, Hour, Minute, and Second (applies when Use Summary Interval is ticked).
Interval Duration Value	The interval duration value applied to the above Interval Duration Unit (applies when Use Summary Interval 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.

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 5mo ago