Configuration

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

General

PropertyDescription

Collection

This associates this Agent to a specific Collection and defaults to that of the current Data Stream.

Polling Interval (seconds)

This determines how often the data is read from the table, e.g. every ten seconds.

Visit Collections and Stream Hosts to understand more about Collections.

Server

PropertyDescription

Use Connection Variables

Tick to select saved variables; or enter the text manually for the authentication properties.

Server Instance

The address of the SQL Server server instance.

User Name

The user name to use for authenticating the connection.

Use SQL Server Authentication

Enables SQL Server Authentication instead of Windows Authentication. This will allow you to specify the Password for authentication of the connection.

Password

The password to use for authenticating the connection.

Once all the Server properties are entered, the Agent will attempt to open a connection with the database server. If successful, then the Database property will be populated with a list of available databases to select.

Database

PropertyDescription

Database

The name of the database to connect to. Once selected, the Table property will be populated with the list of available tables in the database.

Specify SQL Query?

Tick to return rows from a query; or leave unticked to return rows from a table (default).

SQL Query

The command to query data from the SQL database (applies when Specify SQL Query is ticked).

Table

The name of the table to connect to. Once selected, the Columns To Return property will be populated with the list of columns from the selected table.

Columns To Return

The columns which the Agent should return. If no columns are specified, the Agent will return all the columns from the table.

Filtering & Sorting

PropertyDescription

Limit Rows By

Limits the returned rows by, Number (e.g. first 100 rows) or, Duration (e.g. 7 days or 24 hours). Optional.

Number of Rows

The number of rows that should be returned. Applies if Number is chosen for Limit Rows By.

Duration Type

Day, Hour or Minute. Applies if Duration is chosen for Limit Rows By.

Duration Value

The value of the duration. Applies if Duration is chosen for Limit Rows By.

Timestamp Column

The column to use as the timestamp for calculating the duration. Applies if Duration is chosen for Limit Rows By.

Filters

Rules for filtering the returned results.

Sort By

The columns that the results should be sorted by. Multiple columns and direction can be specified.

Endpoints

NameDescription

Output

The read events will be made available on this Endpoint with attributes matching those specified in 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