Configuration

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

General

PropertyDescription

Collection

This associates this 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.

Output

PropertyDescription

Return Type

The type of data returned by the agent can be assets (lists the assets in the selected project) or events (the events for the specified assets).

Parent Assets

One or more assets from which the events will be filtered (applies to Events return type). Once selected, the Child Assets and Types properties are filtered and populated with a list of child assets and event types respectively.

Child Assets

An optional filter on the Types property (applies to Events return type).

Types

One or more event types from which the events will be filtered (applies to Events return type).

Once selected, the Sub Types property is filtered and populated based on selected Types

Sub Types

An optional filter on the events (applies to Events return type).

Duration Type

The unit of time that defines the poll interval: Day, Hour, and Minute (applies to Events return type).

Duration Value

The numeric value that defines the poll interval along with Duration Type (applies to Events return type).

Columns To Return

The columns which the Agent should return. If blank, all columns are returned based on the return type Assets or Events.

Endpoints

NameDescription

Output

An event per read row will be made available on this endpoint with attributes matching the Columns To Return property.

Error

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

Last updated