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 cache is refreshed during runtime - which depends how often your data changes e.g. hourly.
Visit Collections and Stream Hosts to understand more about Collections.
Server Details
Property
Description
Use Connection Variables
Tick to select saved variables; or enter the text manually for server connection properties.
Hostname
The MySQL server name / IP address. 
e.g. localhost / 127.0.0.1
Username
The MySQL login username.
Password
The MySQL login password.
Database
Property
Description
Schema
A list of Schemas to be selected.
Table Name
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
Property
Description
Limit Rows By
Optional criteria for limiting the output.
Available Options:
Number of Rows
Duration (required the table to have a DateTime column)
None (All qualified rows will be returned)
Defaulted to None.
Number of Rows
Limit the number of rows to be returned based on the value. 
​
Applies when Limit Rows By selected as Number of Rows.
Duration Type
The metric of duration used for limiting the output.  
Day
Hour
Minute
Defaulted to Day.
​
Applies when Limit Rows By property value is selected as Duration.
Duration Value
Limit the number of rows to be returned based on the Duration Value configured. 
​
The value will be compared against the selected Timestamp Column. 

Applies when Limit Rows By property value is selected as Duration.
Timestamp Column
A list of DateTime columns in the selected table. Applies when Limit Rows By property value is selected as Duration.
Filter Criteria
The optional filter(s) applied to the database table contents, expressed with the column name, operator (Contains, Does not contain, Starts with, Ends with and Equals) and compare value.
Sort By
The attribute(s) by which the output should be sorted in Ascending / Descending order (optional).
Endpoints
Name
Description
Output
Records in the selected Table will be made available to this endpoint with attributes matching the configured schema.
Error
If errors are encountered during the execution of this Agent they 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 cache is refreshed during runtime - which depends how often your data changes e.g. hourly.

Property	Description
Use Connection Variables	Tick to select saved variables; or enter the text manually for server connection properties.
Hostname	The MySQL server name / IP address. e.g. localhost / 127.0.0.1
Username	The MySQL login username.
Password	The MySQL login password.

Property	Description
Schema	A list of Schemas to be selected.
Table Name	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.

Property	Description
Limit Rows By	Optional criteria for limiting the output. Available Options: Number of Rows Duration (required the table to have a DateTime column) None (All qualified rows will be returned) Defaulted to None.
Number of Rows	Limit the number of rows to be returned based on the value. Applies when Limit Rows By selected as Number of Rows.
Duration Type	The metric of duration used for limiting the output. Day Hour Minute Defaulted to Day. Applies when Limit Rows By property value is selected as Duration.
Duration Value	Limit the number of rows to be returned based on the Duration Value configured. The value will be compared against the selected Timestamp Column. Applies when Limit Rows By property value is selected as Duration.
Timestamp Column	A list of DateTime columns in the selected table. Applies when Limit Rows By property value is selected as Duration.
Filter Criteria	The optional filter(s) applied to the database table contents, expressed with the column name, operator (Contains, Does not contain, Starts with, Ends with and Equals) and compare value.
Sort By	The attribute(s) by which the output should be sorted in Ascending / Descending order (optional).

Name	Description
Output	Records in the selected Table will be made available to this endpoint with attributes matching the configured schema.
Error	If errors are encountered during the execution of this Agent they will be published on this endpoint.

Context Provider - Previous

Example

Next - Context Provider

Release Notes

Last modified 1yr ago