MongoDB Collection

1. Overview

MongoDB is a scalable, flexible NoSQL document database platform known for its horizontal scaling and load balancing capabilities, which has given application developers an unprecedented level of flexibility and scalability.

Prior to setting up your data sync destination, ensure that you've configured your Source.

The MongoDB Collection destination supports batch and real-time syncs.

2. Destination Tab

The following table outlines the mandatory and optional parameters you will find on the Destination tab (Image 1).

Destination Details

The following parameters will help to define your data sync destination and how it functions.

Parameter	Description	Example
Destination	Mandatory. Select your destination from the drop down menu.	MongoDB Collection
Connection String	Mandatory. The encrypted connection string for your MongoDB Collection. The Connections UI will automatically encrypt this value for you.	You can review MongoDB's Connection String guide and parameter descriptions here.
Database	Mandatory. The name of your MongoDB database.	Cinchy
Collection	Mandatory. The name of your MongoDB collection.	Employees
Use SSL	This checkbox can be used to define the use of x.509 certificate authentication for your sync. If checked, you will need to input the following values taken from your cert: - SSL Key PEM - SSL Certificate PEM - SSL CLA PEM

Column Mapping

The Column Mapping section is where you define which source columns you want to sync to which destination columns. You can repeat the values for multiple columns.

Parameter	Description	Example
Source Column	Mandatory. The name of your column as it appears in the source.	Name
Target Column	Mandatory. The name of your column as it appears in the destination.	Name

Image 2: Define your Destination

6. Retry Configuration

Cinchy v5.6 introduced the Retry Configuration for MongoDB targets. This will automatically retry HTTP Requests on failure based on timeout or connection errors. If the final retry attempt fails it gets logged into the Execution Errors table

This capability provides a mechanism to recover from transient errors such as network disruptions or temporary service outages.

Note: the maximum number of retries is capped at 10.

To set up a retry configuration:

1. Under the MongoDB destination tab, select Retry Configuration

2. Select your Delay Strategy.

• Linear Backoff: Defines a delay of approximately n seconds where n = current retry attempt.

• Exponential Backoff: A strategy where every new retry attempt is delayed exponentially by 2^n seconds, where n = current retry attempt.

  • Example: you defined Max Attempts = 3. Your first retry is going to be in 2^1 = 2, second: 2^2 = 4, third: 2^3 = 8 sec.

3. Input your Max Attempts. The maximum number of retries allowed is 10.

5. Next Steps

• Define your Sync Behaviour.

• Add in your Post Sync Scripts, if required.

• Define your Permissions.

• If you are running a real-time sync, set up your Listener Config and enable it to begin your sync.

• If you are running a batch sync, click Jobs > Start a Job to begin your sync.