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).

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.

Settings

PropertyDescription

Authentication Type

The connection authentication options are ApiKey and OpenID Connect.

Api Key

The API key to use for authentication (applies to ApiKey authentication type only).

Base Url

The base url of the Cognite instance (applies to OpenID Connect authentication type only).

Tenant ID

The Id of the tenant to which the Client belongs (applies to OpenID Connect authentication type only).

Client ID

The Id of the Cognite App Registration used to connect to the Cognite instance (applies to OpenID Connect authentication type only).

Client Secret

The Secret of the Cognite App Registration used to connect to the Cognite instance (applies to OpenID Connect authentication type only).

Project

The project on the Cognite instance to connect to.

Once the above properties are entered, the Agent attempts to open a connection with the specified project on the Cognite instance. If successful, the Parent Assets property is populated with a list of available assets.

PropertyDescription

Parent Assets

One or more assets from which the time series will be selected. Once selected, the Child Assets and Time Series properties are populated with a list of child assets and time series columns respectively.

Child Assets

Optional. When specified, Time Series attributes will be filtered further based on the selected child assets.

Time Series

The time series attributes which the Agent should return.

Endpoints

NameDescription

Output

The time series data will be made available on this endpoint.

Error

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

Last updated