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.
Server
Property
Description
Use Connection Variables
Tick to select saved MongoDB variables; or enter the text manually.
MongoDB Server
The address of the MongoDB server.
MongoDB Port
The Server Port of the MongoDB server.
Authentication Type
The authentication options for the connection are:
Anonymous - Unauthenticated access.
SCRAM - (Salted Challenge Response Authentication Mechanism) is a password-based mutual authentication protocol.
User Name
The user name to use for authenticating the connection (applies to SCRAM Authentication Type only).
Password
The password to use for authenticating the connection (applies to SCRAM Authentication Type only).
Database
Once the Server properties are entered, the Agent will attempt to open a connection with the server. If successful, the Database property is populated with a list of available databases.
Property
Description
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 MongoDB Query Command
Tick to return rows from a query; or leave unticked to return rows from a table (default).
MongoDB Query Command
The command to query data from MongoDB collection (applies when Specify MongoDB Query Command is ticked). 
Refer here for the Query Command Format.
Table/Collection
The name of the table to connect to (applies when Specify MongoDB Query Command is unticked). Once selected, the Fields To Return dropdown will be populated with available fields of the collection.
Fields 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
This section applies when Specify MongoDB Query Command is unticked.
Property
Description
Limit Rows By
The maximum rows that are returned in a single poll. The options are:
Number (e.g. first 100 rows)
Duration (e.g. 7 days or 24 hours)
None (default, no limit)
Number of Rows
The number of rows that are returned (applies to Number Limit Rows By only).
Duration Type
Day, Hour or Minute (applies to Duration Limit Rows By only).
Duration Value
The value of the duration (applies to Duration Limit Rows By only).
Timestamp Column
The column used when calculating the duration (applies to Duration Limit Rows By only).
Specify Filter Text
Rules for filtering the returned results (optional).
Sort By
The column(s) and sort order applied to the results (optional).
Endpoints
Name
Description
Output
The read events will be made available on this Endpoint with attributes as per Columns To Return.
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
Use Connection Variables	Tick to select saved MongoDB variables; or enter the text manually.
MongoDB Server	The address of the MongoDB server.
MongoDB Port	The Server Port of the MongoDB server.
Authentication Type	The authentication options for the connection are: Anonymous - Unauthenticated access. SCRAM - (Salted Challenge Response Authentication Mechanism) is a password-based mutual authentication protocol.
User Name	The user name to use for authenticating the connection (applies to SCRAM Authentication Type only).
Password	The password to use for authenticating the connection (applies to SCRAM Authentication Type only).

Property	Description
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 MongoDB Query Command	Tick to return rows from a query; or leave unticked to return rows from a table (default).
MongoDB Query Command	The command to query data from MongoDB collection (applies when Specify MongoDB Query Command is ticked). Refer here for the Query Command Format.
Table/Collection	The name of the table to connect to (applies when Specify MongoDB Query Command is unticked). Once selected, the Fields To Return dropdown will be populated with available fields of the collection.
Fields 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	The maximum rows that are returned in a single poll. The options are: Number (e.g. first 100 rows) Duration (e.g. 7 days or 24 hours) None (default, no limit)
Number of Rows	The number of rows that are returned (applies to Number Limit Rows By only).
Duration Type	Day, Hour or Minute (applies to Duration Limit Rows By only).
Duration Value	The value of the duration (applies to Duration Limit Rows By only).
Timestamp Column	The column used when calculating the duration (applies to Duration Limit Rows By only).
Specify Filter Text	Rules for filtering the returned results (optional).
Sort By	The column(s) and sort order applied to the results (optional).

Name	Description
Output	The read events will be made available on this Endpoint with attributes as per Columns To Return.
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 11mo ago