This section explains each of the properties in the configuration blade.
Refer to Collections and Stream Hosts to understand more about Collections.
This section applies to the Event Frame lookup type only.
This section applies to the Element lookup type only.
Last updated
| Property | Description |
|---|---|
| Property | Description |
|---|---|
| Property | Description |
|---|---|
| Property | Description |
|---|---|
| Property | Description |
|---|---|
| Name | 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 the Agent should check for new data/changes, or update its cache.
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.
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.
Duration Type
Allows you to specify lookup duration type. Available options are Day, Hour, Minute, Month, Year and Second.
Duration
Allows you to specify duration value based on the Duration Type selected above.
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 Templates 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.
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 when Filter Attributes By Category is ticked.
Attributes
One or more attributes to read. At least one attribute needs to be selected.
Output
Data read from OSIsoft PI System is made available on this endpoint with attributes matching the configured payload.
Error
If errors are encountered during the execution of this Agent they will be published on this endpoint.
