Create a PowerBI metadata collector

Create a collector to import metadata from PowerBI.

Before you begin

Before you begin, verify the following:

• A MID Server is setup for the collectors. For more information, see MID Server for metadata collectors.
• All per-requisite tasks are completed. For more information, see Prepare to run the PowerBI collector.
• Role required: connection-admin

Procedure

1. Navigate to All > Workflow Data Fabric > Workflow Data Fabric Home.
2. Select the Connect Hub 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.

   Table 1. PowerBI metadata collector 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.

   Table 2. 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.

8. Configure the client ID and client secret details.

   Table 3. Configuration 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.

9. Configure the workspace scope and filters options.

   Table 4. Workspace scope and filters options

   Field	Description
   Disable Lineage collection	Option to skip harvesting lineage metadata from Power BI source expressions.
   Catalog contents of user's My Workspace	Option to catalog the contents of a user's My Workspace in Power BI. Default: Skip the user's workspace.
   Catalog all workspaces and apps in tenant	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.
   Include Power BI workspace(s)	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).
   Exclude Power BI Workspaces	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).

10. Configure the connection and reliability options.

    Table 5. Connection and reliability options

    Field	Description
    Maximum Power BI Expression Length	Maximum number of characters in a Power BI expression that is parsed for lineage metadata. Expressions longer than this value are skipped. Default: 32000
    Datasource Name Mapping File	File that maps ODBC source details configured in the datasources.yml file. Upload the file if you have configured ODBC source details.
    Catalog report preview images	Option to catalog preview images. Default: false
    Disable max requests wait	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.
    Max retries	Number of times the system retries a failed API call. Default: 5
    Retry delay	Number of seconds to wait between retry attempts for a failed API call. Default: 2 seconds

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.
• Automate metadata collection by scheduling regular collector runs. See Schedule metadata collector runs.
• Monitor execution status and troubleshoot issues by viewing the runtime logs. See View runtime logs for collector runs.
• Discover and evaluate the harvested data assets in the Data Catalog. See Governing the Data Catalog.