Configuration

This section explains each of the properties in the configuration blade.

General

PropertyDescription

Collection

This associates the Agent to a specific Collection (default to that of the current Data Stream).

Refer to Collections and Stream Hosts to understand more about Collections.

Authentication

PropertyDescription

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

PropertyDescription

Server

The name of the server to connect to. Once selected, the Database property is populated with the list of available databases.

Database

The name of the database to connect to.

Template

The name of the template that contains the attributes to be updated.

Filter Elements by Category

Tick to filter the Attributes property by element category.

Use Variable For Element Category

Tick to select a saved variable, or enter the text manually for the Elements Category (applies when Filter Elements By Category is ticked).

Elements Category

The elements category to filter the Elements property (applies when Filter Elements By Category is ticked).

Filter Attributes by Category

Tick to filter the Attributes property 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 update. At least one attribute must be selected.

Elements Cache Refresh Interval (hours)

The interval in hours for the Elements cache to refresh.

Endpoints

NameDescription

Input

This endpoint is used to receive data from the parent agent.

Output

Events received from the parent Agent will be made available on this endpoint with unchanged attributes and data.

Error

If errors are encountered during the execution of this Agent they will be published on this endpoint.

Last updated