MongoDB

This article outlines the integration with the MongoDB connector, enabling streamlined metadata management through features such as crawling, profiling, querying, data preview, and manual lineage building. It also ensures secure authentication via Credential Manager.

Overview

Connector Details

Connector Category

NoSQL

Connector Version

Release6.3.4

Connectivity

[How the connection is established with MongoDB]

JDBC driver

Connector Features

Feature
Availability

Crawling

Delta Crawling

Profiling

Query Sheet

Data Preview

Auto Lineage

Manual Lineage

Secure Authentication via Credential Manager

Data Quality

DAM (Data Access Management)

Bridge

Metadata Mapping

The following objects are crawled from MongoDB and mapped to the corresponding UI assets.

MongoDB Object
MongoDB Attribute
OvalEdge Attribute
OvalEdge Category
OvalEdge Type

Table

Table Name

Table

Tables

Table

Table

Table Type

Table

Tables

Table

Table

Table Comments

Source Description

Descriptions

Source Description

Columns

Column Name

Column

Table Columns

Columns

Columns

Data Type

Column Type

Table Columns

Columns

Columns

Description

Source Description

Table Columns

Columns

Columns

Ordinal Position

Column Position

Table Columns

Columns

Columns

Length

Data Type Size

Table Columns

Columns

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

Whitelisting Ports

Ensure the inbound port “27017” is whitelisted for OvalEdge to connect to the Microsoft SQL Server database.

Service Account User Permissions

👨‍💻 Who can provide these permissions? These permissions are typically granted by the MongoDB administrator, as users may not have the required access to assign them independently.

Objects
Sys Tables
Access Permissions

Schema (Database)

listDatabases command

listDatabases privilege on the cluster

Tables (Collections)

listCollections command or system.namespaces collection

listCollections privilege on each database

Columns (Fields)

Derived by sampling documents using the find command

Find privilege on each collection

Connection Configuration Steps

  1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for MongoDB, and complete the required parameters.

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name
Description

Connector Type

By default, "MongoDB" is displayed as the selected connector type.

Authentication

OvalEdge supports the following two types of authentication for MongoDB:

  • Service

  • Standalone

Field Name
Description

Credential Manager*

Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection. Supported Credential Managers:

  • OE Credential Manager

  • AWS Secrets Manager

  • HashiCorp Vault

  • Azure Key Vault

Connector Name*

Enter a unique name for the MongoDB connection (Example: "MongoDB_Prod").

Connector Environment

Select the environment (Example: PROD, STG) configured for the connector.

Connector description

Enter a brief description of the connector.

Server*

Enter the MongoDB database server name or IP address (Example: xxxx-xxxx.xxxx4ijtzasl.xx-south-1.rds.xxxxx.com or 1xx.xxx.1.x0).

Database*

Enter the database name to which the service account user has access within the MongoDB.

Driver*

By default, the MongoDB driver details are auto-populated.

Username*

Enter the service account username set up to access the MongoDB database (Example: "oesauser").

Password*

Enter the password associated with the service account user.

Connection String

Configure the connection string for the MongoDB database: Automatic Mode: The system generates a connection string based on the provided credentials. Manual Mode: Enter a valid connection string manually. Replace placeholders with actual database details. {sid} refers to Database Name.

Plugin Server

Enter the server’s name when running as a plugin server.

Plugin Port

Enter the port number on which the plugin is running.

Default Governance Roles

Default Governance Roles*

Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.

Admin Roles

Admin Roles*

Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.

No of Archive Objects

No Of Archive Objects*

This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.

Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.

Bridge

Select Bridge*

If applicable, select the bridge from the drop-down list.

The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.

  1. After entering all connection details, the following actions can be performed:

    1. Click Validate to verify the connection.

    2. Click Save to store the connection for future use.

    3. Click Save & Configure to apply additional settings before saving.

  2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl/Profile

The Crawl/Profile button allows users to select one or more schemas for crawling and profiling.

  1. Navigate to the Connectors page and click Crawl/Profile.

  2. Select the schemas to crawl.

  3. The Crawl option is selected by default. Click the Crawl & Profile radio button to run both operations.

  4. Click Run to collect metadata from the connected source and load it into the OvalEdge Data Catalog.

  5. After a successful crawl, the information appears in the Data Catalog > Databases tab.

The Schedule checkbox allows automated crawling and profiling at defined intervals, from a minute to a year.

  1. Click the Schedule checkbox to enable the Select Period drop-down.

  2. Select a time period for the operation from the drop-down menu.

  3. Click Schedule to initiate metadata collection from the connected source.

  4. The system will automatically execute the selected operation (Crawl or Crawl & Profile) at the scheduled time.

Other Operations

The Connectors page in OvalEdge provides a centralized view of all configured connectors, including their health status.

Managing connectors includes:

  • Connectors Health: Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.

  • Viewing: Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

Nine Dots Menu Options:

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

  • Edit Connector: Update and revalidate the data source.

  • Validate Connector: Check the connection's integrity.

  • Settings: Modify connector settings.

    • Crawler: Configure data extraction.

    • Profiler: Customize data profiling rules and methods.

    • Query Policies: Define query execution rules based on roles.

    • Access Instructions: Add notes on how data can be accessed.

    • Business Glossary Settings: Manage term associations at the connector level.

    • Anomaly Detection Settings: Configure anomaly detection preferences at the connector level.

    • Connection Pooling: Allows configuring parameters such as maximum pool size, idle time, and timeouts directly within the application.

    • Others: Configure notification recipients for metadata changes.

  • Delete Connector: Remove a connector with confirmation.


Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA

Last updated

Was this helpful?