Comment on page
Configuration
This section explains each of the properties in the configuration blade.
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:
|
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). |
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 select saved MongoDB variables; or enter the text manually. |
Table/Collection | The name of the table in which to write. |
Create New Table/Collection | Tick to create a new table/collection, before writing data to it. |
Table Name/Collection | The name of the Table/Collection to be created (applies when Create New Table/Collection is ticked).
It must not contain the '$' or begin with the system prefix. |
Update existing Rows/Documents | Tick to update an existing row/document. |
Primary Key | The collection's primary key - used to uniquely identify each document for updates (applies when Update existing Rows/Documents is ticked). |
Before configuring the Action Agent, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.
The appropriate column or attribute of the input payload is mapped to the table attributes, which are fetched from the MongoDB database.
Name | Description |
---|---|
Input | This endpoint is used to receive data from the parent Agent. |
Output | Events received from the parent Agent are processed and made available to this endpoint with unchanged attributes. |
Error | Errors encountered during the execution of this Agent will be published on this Endpoint. |
Last modified 11mo ago