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.
Server URL
The address of the MongoDB server.
Port Number
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 authenticaton (applies to SCRAM Authentication Type only).
Password
The password to use for authentication (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.
Table/Collection
The name of the table to connect to. Once selected, the Fields To Return property will be populated with the list of columns from the selected table.
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.
Field to Monitor
Property
Description
Field
The column to use when distinguishing new rows from older rows.
Ideally, the selected column should have a unique, incrementing value for each new row.
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.
Server URL	The address of the MongoDB server.
Port Number	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 authenticaton (applies to SCRAM Authentication Type only).
Password	The password to use for authentication (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.
Table/Collection	The name of the table to connect to. Once selected, the Fields To Return property will be populated with the list of columns from the selected table.
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
Field	The column to use when distinguishing new rows from older rows. Ideally, the selected column should have a unique, incrementing value for each new row.

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.

Last modified 5mo ago