Configuration

This section explains each of the properties in the configuration blade.

General

PropertyDescription

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

PropertyDescription

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

PropertyDescription

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.

Input Mapping

The appropriate column or attribute of the input payload is mapped to the table attributes, which are fetched from the MongoDB database.

Refer to Setup Input Mappings for step-by-step instructions.

MongoDB does not allow $ or . characters as map keys due to restrictions on field names.

Endpoints

NameDescription

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 updated