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.

Visit Collections and Stream Hosts to understand more about Collections.

Connection Details

PropertyDescription

Base Url

The base url of the Streaming Data Platform.

User Name

The user name used to authenticate the connection.

Password

The password used to authenticate the connection.

Stream Name

The stream against which data is queried.

Psearch Rest Head

The rest head name to use for Psearch query.

Query Details

PropertyDescription

Operation

The data operation to perform is currently limited to Search.

Query Input

The input can be using filters (filter criteria) or by manual entry (manually input the query).

Filters

The filter criteria for the query (applies to Using Filters Query Input only).

Query

The query is entered manually using the Elastic Search DSL Query syntax (applies to Manual Entry Query Input only).

Output Details

The Source Columns grid is populated with available columns when the connection details are entered and the Agent successfully opens a connection to the Streaming Data Platform.

PropertyDescription

Name

The column name returned in the output payload, which must match the name of an entry under the query response's _source object.

Data Type

The data type of the column in the output payload, which must match the column's data type in the query response.

Include

Untick to exclude the column from the output.

Endpoints

NameDescription

Output

An event per stream row will be made available on this endpoint with attributes matching those specified in the Output Details property.

Stats

The statistics from the query response (e.g. number of hits and max_score) will be made available on this endpoint.

Error

Errors encountered during the execution of this Agent will be published on this endpoint.

Last updated