---
sourceDocument: Australia Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/australia/integrate-applications

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# Create a MongoDB metadata collector

# Create a MongoDB metadata collector {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read  
Create a collector to import metadata from MongoDB.

## Before you begin

Before you begin, verify the following:

* All per-requisite tasks are completed. For more information, see [Prepare to run the MongoDB collector](https://www.servicenow.com/docs/oXdIfLCYVdYZssFm0paTlg "Create a MongoDB user and configure authentication before running the collector.").
* If you plan to run the collector on-premise, a MID Server is setup for the collector. For more information, see [MID Server for metadata collectors](https://www.servicenow.com/docs/QcdynKbGhxv_ZIEalalxAg "When your source is behind a firewall or requires on-premises handling, deploy metadata collectors on a MID Server you host to harvest metadata from on-premises and privately networked data sources.").
* Role required: connection-admin
{#create-mongodb-metadata-collector__ul_pvj_mz5_bjc}

## Procedure

1. Navigate to AllWorkflow Data FabricWorkflow Data Fabric Home.
2. Select the Connect Hub ![Connect Hub icon]() icon in the left sidebar.
3. Select CreateMetadata collector.
4. From the System list, select MongoDB.
5. From the Connection type list, select one of the following:
   1. Select New connection to configure a new connection.
   2. Select Existing connection to reuse an existing connection and select an existing connection from the Connections list.  
      The configuration form is filled with details from the existing connection. The name is appended with the word Copy and sensitive details like password aren't copied.
   {#create-mongodb-metadata-collector__substeps_lgh_q4y_jjc}
6. On the form, fill in the fields.  
   {#create-mongodb-metadata-collector__table_gkm_wgs_qhc__entry__2}

   | Field | Description |
   |-|-|
   | Connection name | Unique identifier for the connection. This field can't be modified once the connection is established. |
   | Short description | Purpose and details of the connection. |
   [Table 1. MongoDB metadata collector form]

   {#create-mongodb-metadata-collector__table_gkm_wgs_qhc}
7. Configure the connection options.  
   {#create-mongodb-metadata-collector__table_s3_collector_props__entry__2}

   | Field | Description |
   |-|-|
   | Use MID server | Option to connect to the source system through a MID Server. When selected, the MID selection options appear. |
   | MID selection | MID Server routing option for the collector job. This field appears only when Use MID server is selected. * Auto-Select MID Server --- The system selects an available MID Server at job execution time. Default selection. * Specific MID Server --- The collector job runs on the selected MID Server. If the MID Server is offline at job execution time, the job fails with an error identifying the MID Server by name. * Specific MID Cluster --- The collector job runs on any available MID Server within the selected cluster. |
   | MID Server | MID Server to use for the collector job. This field appears only when Specific MID Server is selected. The selected MID Server is saved on the collector record and used for all subsequent collection runs until changed. |
   | MID Cluster | MID cluster to use for the collector job. This field appears only when Specific MID Cluster is selected. The selected cluster is saved on the collector record; any available MID Server within the cluster may serve the job. |
   | Capabilities | One or more capability labels that restrict auto-selection to MID Servers advertising those capabilities. This field appears only when Auto-Select MID Server is selected. |
   | MID application | MID Server application to use for the collector job. This field appears only when Auto-Select MID Server is selected. |
   [Table 2. Connection options]

   {#create-mongodb-metadata-collector__table_s3_collector_props}
8. Enter the MongoDB connection details.  
   {#create-mongodb-metadata-collector__table_lk4_hrw_n3c__entry__2}

   | Field | Description |
   |-|-|
   | Connection String | [Connection string](https://www.mongodb.com/docs/manual/reference/connection-string-options/) for your MongoDB cluster or instance. Make sure that any option parameters in the connection string are URL-encoded. |
   [Table 3. MongoDB connection details]

   {#create-mongodb-metadata-collector__table_lk4_hrw_n3c}
9. Enter the MongoDB configuration details.  
   {#create-mongodb-metadata-collector__table_nyc_qqp_c3c__entry__2}

   | Field | Description |
   |-|-|
   | Included Databases | Databases to collect. Provide database names or regular expressions. List only one database per line. Databases matching any specified expression are collected. |
   | Excluded Databases | Databases to exclude from collection. Provide database names or regular expressions. List only one database per line. Databases matching any specified expression are excluded. Included databases take precedence over excluded databases. |
   [Table 4. MongoDB configuration details]

   {#create-mongodb-metadata-collector__table_nyc_qqp_c3c}
10. Configure the advanced options.  
    {#create-mongodb-metadata-collector__table_oxn_jh5_rjc__entry__2}

    | Name | Description |
    |-|-|
    | Analysis samples count | Number of documents sampled from each collection for [field type analysis](https://www.mongodb.com/docs/manual/reference/operator/aggregation/sample/). This field must be a non-negative integer. Default: 1000. |
    [Table 5. Advanced options]

    {#create-mongodb-metadata-collector__table_oxn_jh5_rjc}
11. Select Save.

## Result

The metadata collector is created and appears on the Connectors page with a Configured status. It is now ready to connect to the source system and harvest metadata.

## What to do next

After creating the collector, you can perform any of the following tasks:

* Run the collector manually to harvest metadata immediately. See [Run metadata collectors manually](https://www.servicenow.com/docs/rSO2~8_TxqskZXvlz0R2iw "Execute a metadata collector on-demand to import metadata immediately.").
* Automate metadata collection by scheduling regular collector runs. See [Schedule metadata collector runs](https://www.servicenow.com/docs/efDmDhMov5_Wj~hCB2Qv5Q "Schedule a metadata collector to run automatically at a specified frequency.").
* Monitor execution status and troubleshoot issues by viewing the runtime logs. See [View runtime logs for collector runs](https://www.servicenow.com/docs/usaS0NCo4Gro712LVBIf3w "Access execution logs and download detailed log files for metadata collector runs.").
* Discover and evaluate the harvested data assets in the Data Catalog. See [Governing the Data Catalog](https://www.servicenow.com/docs/~W6YqTji8ALzdDHDEBkFBQ "Data stewards add business context to catalog assets, making them more discoverable for catalog consumers. Governance tools include glossary terms, tags, domains, and direct asset updates.").

*[\>]: and then