Comment on page

Configuration

This section explains each of the properties in the configuration blade. 
General
Property
Description
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.
Refer to Collections and Stream Hosts to understand more about Collections.
Service
Property
Description
Polling Interval (seconds)
A timespan to specify how often should the Agent check for new data/changes or update its cache.
OData Version
The version of your OData service. You can only select either V3 or V4. 
Authentication Type
The authentication methods supported:
User Credentials
App Credentials
Url
The URL of the token endpoint provided by the application to make API requests.
Use Connection Variables
Tick to select saved variables; or enter the text manually for the authentication properties.
Authorization URL
The endpoint address (URL) of the OData service authorizing the client (applies to App Credentials Authentication Type only) e.g. https://login.windows.net/example.com.au
Client ID
The unique identifier to request authorized access to client data (applies to App Credentials Authentication Type only).
Secret ID
The client secret obtained from the OData service (applies to App Credentials Authentication Type only).
User Name
The user name to use for authenticating the connection (applies to User Credentials Authentication Type only).
Password
The password to use for authenticating the connection (applies to User Credentials Authentication Type only).
Entity
Property
Description
Entity
The entity against which the operation is performed. The list of entities is populated from the OData service.
Result Properties
The columns which the Agent should return. If no columns are specified, the Agent will return all the columns from the OData service.
Number Of Results
The number of rows that should be returned.
Order By
The column by which the returned results are sorted.
Sort By
The sort direction: ASC (ascending) or DESC (descending). 
Endpoints
Name
Description
Output
An event per read row will be made available to this endpoint with attributes matching Result Properties.
Error
Errors encountered during the execution of this Agent will be published on this endpoint.

Property	Description
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.

Property	Description
Polling Interval (seconds)	A timespan to specify how often should the Agent check for new data/changes or update its cache.
OData Version	The version of your OData service. You can only select either V3 or V4.
Authentication Type	The authentication methods supported: User Credentials App Credentials
Url	The URL of the token endpoint provided by the application to make API requests.
Use Connection Variables	Tick to select saved variables; or enter the text manually for the authentication properties.
Authorization URL	The endpoint address (URL) of the OData service authorizing the client (applies to App Credentials Authentication Type only) e.g. https://login.windows.net/example.com.au
Client ID	The unique identifier to request authorized access to client data (applies to App Credentials Authentication Type only).
Secret ID	The client secret obtained from the OData service (applies to App Credentials Authentication Type only).
User Name	The user name to use for authenticating the connection (applies to User Credentials Authentication Type only).
Password	The password to use for authenticating the connection (applies to User Credentials Authentication Type only).

Property	Description
Entity	The entity against which the operation is performed. The list of entities is populated from the OData service.
Result Properties	The columns which the Agent should return. If no columns are specified, the Agent will return all the columns from the OData service.
Number Of Results	The number of rows that should be returned.
Order By	The column by which the returned results are sorted.
Sort By	The sort direction: ASC (ascending) or DESC (descending).

Name	Description
Output	An event per read row will be made available to this endpoint with attributes matching Result Properties.
Error	Errors encountered during the execution of this Agent will be published on this endpoint.

Context Provider - Previous

Example

Next - Context Provider

Release Notes

Last modified 1yr ago