Create a PowerBI metadata collector

---
title: Create a PowerBI metadata collector
description: Create a collector to import metadata from PowerBI.
locale: en-US
canonical_url: https://www.servicenow.com/docs/r/australia/integrate-applications/create-powerbi-metadata-collector.html
release: australia
topic_type: task
last_updated: "2026-03-12"
reading_time_minutes: 5
breadcrumb: [PowerBI metadata collector, Configuring metadata collectors, Data Catalog, Workflow Data Fabric]
---

# Create a PowerBI metadata collector

Create a collector to import metadata from PowerBI.

## Before you begin

Before you begin, verify the following:

-   All per-requisite tasks are completed. For more information, see [Prepare to run the PowerBI collector](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/prepare-to-run-powerbi-collector.md).
-   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://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/mid-server-for-metadata-collectors-dc.md).
-   Role required: connection-admin

## 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 **PowerBI**.

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

<table id="table_s3_collector_props"><thead><tr><th>

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Use MID server

</td><td>

Option to connect to the source system through a MID Server. When selected, the **MID selection** options appear.

</td></tr><tr><td>

MID selection

</td><td>

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.


</td></tr><tr><td>

MID Server

</td><td>

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.

</td></tr><tr><td>

MID Cluster

</td><td>

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.

</td></tr><tr><td>

Capabilities

</td><td>

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.

</td></tr><tr><td>

MID application

</td><td>

MID Server application to use for the collector job. This field appears only when **Auto-Select MID Server** is selected.

</td></tr></tbody>
</table>8.  Configure the authentication options.

    |Field|Description|
    |-----|-----------|
    |Authenticate using Azure username and password|Azure Active Directory username and password. Set the Azure Tenant ID if you want to specify the Azure tenant ID while using the user name and password authentication.|
    |Authenticate using Azure Service principal|Azure Active Directory application tenant ID for Power BI app. To find the tenant ID, select the question mark in the Power BI app and then choose About Power BI. The tenant ID is found at the end of the Tenant URL.|

9.  Configure the client ID and client secret details.

    |Field|Description|
    |-----|-----------|
    |Microsoft Entra client ID|Application client ID for the PowerBI app.|
    |Microsoft Entra client secret|Application client secret for the PowerBI app.|

10. Configure the workspace scope and filters options.

<table id="table_qpw_5xc_j3c"><thead><tr><th>

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Disable Lineage collection

</td><td>

Option to skip harvesting lineage metadata from Power BI source expressions.

</td></tr><tr><td>

Catalog contents of user's My Workspace

</td><td>

Option to catalog the contents of a user's My Workspace in Power BI. Default: Skip the user's workspace.

</td></tr><tr><td>

Catalog all workspaces and apps in tenant

</td><td>

Option to catalog all workspaces and apps in a tenant, rather than only the workspaces and apps the credentials have explicit access to. Admin privileges are required for the credentials used.

</td></tr><tr><td>

Include Power BI workspace\(s\)

</td><td>

Workspaces to collect. Enter the exact workspace name or a regular expression to match. **Note:** If a workspace name includes special characters \[. , + , \* , ? , ^ , $ , \( , \) , \[ , \] , \{ , \} , \| , \\\], escape each special character with a backslash \(\\\). For example, enter Workspace \\\(Dev\\\) for Workspace \(Dev\).

</td></tr><tr><td>

Exclude Power BI Workspaces

</td><td>

Power BI workspaces and their contents to exclude from cataloging. Enter the exact workspace name or a regular expression to match. If both Include Workspaces and Exclude Workspaces are configured, Include Workspaces takes precedence. **Note:** If a workspace name includes special characters \[. , + , \* , ? , ^ , $ , \( , \) , \[ , \] , \{ , \} , \| , \\\], escape each special character with a backslash \(\\\). For example, enter Workspace \\\(Dev\\\) for Workspace \(Dev\).

</td></tr></tbody>
</table>11. Configure the connection and reliability options.

<table id="table_yhb_plp_33c"><thead><tr><th>

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Maximum Power BI Expression Length

</td><td>

Maximum number of characters in a Power BI expression that is parsed for lineage metadata. Expressions longer than this value are skipped. Default: 32000

</td></tr><tr><td>

Datasource Name Mapping File

</td><td>

File that maps ODBC source details configured in the [datasources.yml](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/prep-to-run-powerbi-collector-lineage-mapping.md)file. Upload the file if you have configured ODBC source details.

</td></tr><tr><td>

Catalog report preview images

</td><td>

Option to catalog preview images. Default: false

</td></tr><tr><td>

Disable max requests wait

</td><td>

Option to disable waiting for the Power BI API to reset throttling limits \(error code 429\). When not selected, the collector retries every 5 minutes for up to an hour. When selected, the Max retries and Retry delay settings are used instead.

</td></tr><tr><td>

Max retries

</td><td>

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

</td></tr><tr><td>

Retry delay

</td><td>

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

</td></tr></tbody>
</table>12. 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://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/run_metadata-collectors-manually.md).
-   Automate metadata collection by scheduling regular collector runs. See [Schedule metadata collector runs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/schedule-metadata-collector-runs.md).
-   Monitor execution status and troubleshoot issues by viewing the runtime logs. See [View runtime logs for collector runs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/view-runtime-logs-for-collector-runs.md).
-   Discover and evaluate the harvested data assets in the Data Catalog. See [Governing the Data Catalog](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/manage-data-catalog.md).

**Parent Topic:**[PowerBI metadata collector](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/powerbi-metadata-collector.md)