Create a Microsoft fabric metadata collector

task brazil Updated Jul 29, 2026 7 min read create-microsoft-fabric-metadata-collector.md
Raw file servicenow.com

Create a collector to import metadata from Microsoft Fabric.

Before you begin

Before you begin, verify the following:

Procedure

  1. Navigate to All > Workflow Data Fabric > Workflow Data Fabric Home.

  2. Select the Connect Hub [Omitted image "wdf-connect-hub-icon.png"] Alt text: Connect Hub icon icon in the left sidebar.

  3. Select Create > Metadata collector.

  4. From the System list, select Microsoft Fabric.

  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.

  6. Complete the form.

    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.
  7. Configure the authentication options.

    Field Description
    Microsoft Entra Tenant ID The tenant ID that identifies the organization in Microsoft Entra.
    Client ID The client ID of the registered application in Microsoft Entra.
    Client secret The client secret for the registered application in Microsoft Entra.
  8. Configure the connection options.

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.

9. Configure the MID server options.

Field

Description

Use MID server

Enable the Use MID server toggle to connect to the source system through a MID Server. The system automatically selects an available MID Server.

10. Configure the workspace options.
|Field|Description|
|-----|-----------|
|Include fabric workspaces|Match the workspaces to be collected. Use either a workspace name or a regular expression.|
|Exclude fabric workspaces|Match the workspaces and contents to exclude from cataloged. Use either a workspace name or a regular expression. If a workspace is specified in both Include Workspace and Exclude Workspace, Include Workspace takes precedence.|
  1. Select from Collect all schemas or Specify which schema to collect to configure the schema collection options.

    Field Description
    Collect all schemas
    Collect all schemas Catalog all schemas to which the user has access.
    Exclude Schema Name or regular expression of the database schema to be excluded.
    Include Information Schema Include the database's Information Schema in catalog collection.
    Specify which schema to collect
    Specify which schema to collect Catalog only the specified schemas.
    Schema Name of the database schema to catalog.
  2. Configure the advanced options.

Field

Description

Collect extended properties for SQL database resources

Harvest information about extended properties from SQL Server type databases.

Disable harvesting notebook definition

Specify whether to skip harvesting notebook definition.

Disable harvesting GraphQL API definition

Specify whether to skip harvesting GraphQL API definition.

Exclude delta table internal files

Specify whether to exclude delta table internal files (parquet files and _delta_log folders) from lakehouse file cataloging. Delta tables themselves are still cataloged via the Table API.

OneLake API page size

Page size for OneLake API pagination. Default is 5000.

Exclude system functions

Specify to exclude harvesting of built-in system functions.

JDBC properties

JDBC driver properties to pass through to driver connection, as name=value. Use the parameter multiple times for multiple properties.By default the collector uses authentication=ActiveDirectoryServicePrincipal, and encrypt=true

13. Configure the statistics and sampling options.

Field

Description

Disable Lineage collection

Skip harvesting of intra-database lineage metadata.

Disable Extended Metadata collection

Skip harvesting of extended metadata for data asset types such as database, schema, table, columns functions, stored procedures, user defined types, synonyms. Basic metadata for these data asset types will still be harvested.

Enable column statistics collection

Enable harvesting of column statistics (that is, data profiling).Note: Enabling profiling can increase the collector’s runtime, as the collector must read table data to generate profiling metadata.

Target sample size for column statistics

Number of rows sampled for computation of column statistics and string-value histograms. For example, to sample 1000 rows, set the parameter as: 1000.Default: 100000

SQL parsing timeout

Specify the timeout in seconds for SQL parsing during lineage collection. The default is 60.

14. Configure the Power BI options.

Field

Description

Maximum power BI expression length

Maximum number of characters in a Table expression (coming from Semantic Models and Dataflows) that will be parsed for lineage metadata. Expressions longer than this will be skipped. Default: 32000.

Datasource name mapping file

If you have configured source details in the datasources.yml file, upload the file.

Disable power BI expression lineage collection

Skip harvesting of intra-database lineage metadata. This applies only to database resources such as views.

Catalog report preview images

Specify if the collector should catalog preview images. The default setting is false. Ensure that you have met all pre-requisites for using this feature.

Disable max requests wait

Disable waiting up to an hour for the Power BI API endpoints to reset throttling limits (error code 429 - too many requests). When not disabled, the collector retries every 5 minutes for up to an hour. If this option is disabled, the Max retries and Retry delay options will be used instead.

Max retries

The number of times the system retries a failed API call.Default: 5

Retry delay

The number of seconds to wait between retry attempts for a failed API call.Default: 2 seconds

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

Parent Topic:Microsoft Fabric metadata collector

Search documentation
Search document titles and file paths on the brazil branch