160 lines
6.4 KiB
Markdown

---
title: Configuration
---
# Configuring Your PowerBI Connector to DataHub
Now that you have created a DataHub specific Azure AD app with the relevant access in [the prior step](setup.md), it's now time to set up a connection via the DataHub UI.
## Configure Secrets
1. Within DataHub, navigate to the **Ingestion** tab in the top, right corner of your screen
<p align="center">
<img width="75%" alt="Navigate to the &quot;Ingestion Tab&quot;" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/common/common_ingestion_ingestion_button.png"/>
</p>
:::note
If you do not see the Ingestion tab, please contact your DataHub admin to grant you the correct permissions
:::
2. Navigate to the **Secrets** tab and click **Create new secret**.
<p align="center">
<img width="75%" alt="Secrets Tab" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/common/common_ingestion_secrets_tab.png"/>
</p>
3. Create a client id secret
This will securely store your PowerBI `Application (client) ID` within DataHub
- Enter a name like `POWER_BI_CLIENT_ID` - we will use this later to refer to the `Application (client) ID`
- Enter the `Application (client) ID`
- Optionally add a description
- Click **Create**
<p align="center">
<img width="70%" alt="Application (client) ID" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-client-id-secret.png"/>
</p>
4. Create a secret to store the Azure AD Client Secret
This will securely store your client secret"
- Enter a name like `POWER_BI_CLIENT_SECRET` - we will use this later to refer to the client secret
- Enter the client secret
- Optionally add a description
- Click **Create**
<p align="center">
<img width="70%" alt="Azure AD app Secret" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-client-secret.png"/>
</p>
## Configure Recipe
1. Navigate to the **Sources** tab and click **Create new source**
<p align="center">
<img width="75%" alt="Click &quot;Create new source&quot;" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/common/common_ingestion_click_create_new_source_button.png"/>
</p>
2. Choose PowerBI
<p align="center">
<img width="70%" alt="Select PowerBI from the options" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-source-window.png"/>
</p>
3. Enter details into the PowerBI Recipe
You need to set minimum 3 field in the recipe:
a. **tenant_id:** This is the unique identifier (GUID) of the Azure Active Directory instance. Tenant Id can be found at: PowerBI Portal -> Click on `?` at top-right corner -> Click on `About PowerBI`
<p align="center">
<img width="70%" alt="Select PowerBI from the options" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-portal-about-setting-window.png"/>
</p>
On `About PowerBI` window copy `ctid`:
<p align="center">
<img width="70%" alt="copy ctid" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-portal-about-window.png"/>
</p>
b. **client_id:** Use the secret POWER_BI_CLIENT_ID with the format "${POWER_BI_CLIENT_ID}".
c. **client_secret:** Use the secret POWER_BI_CLIENT_SECRET with the format "${POWER_BI_CLIENT_SECRET}".
Optionally, use the `workspace_id_pattern` field to filter for specific workspaces.
config:
...
workspace_id_pattern:
allow:
- "258829b1-82b1-4bdb-b9fb-6722c718bbd3"
Your recipe should look something like this:
<p align="center">
<img width="70%" alt="tenant id" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-recipe-window.png"/>
</p>
After completing the recipe, click **Next**.
## Schedule Execution
Now it's time to schedule a recurring ingestion pipeline to regularly extract metadata from your PowerBI instance.
1. Decide how regularly you want this ingestion to run-- day, month, year, hour, minute, etc. Select from the dropdown
<p align="center">
<img width="75%" alt="schedule selector" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/common/common_ingestion_set_execution_schedule.png"/>
</p>
2. Ensure you've configured your correct timezone
<p align="center">
<img width="75%" alt="timezone_selector" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/common/common_ingestion_set_execution_timezone.png"/>
</p>
3. Click **Next** when you are done
## Finish Up
1. Name your ingestion source, then click **Save and Run**
<p align="center">
<img width="75%" alt="Name your ingestion" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-source-window.png"/>
</p>
You will now find your new ingestion source running
<p align="center">
<img width="75%" alt="ingestion_running" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-running.png"/>
</p>
## Validate Ingestion Runs
1. View the latest status of ingestion runs on the Ingestion page
<p align="center">
<img width="75%" alt="ingestion succeeded" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-succeeded.png"/>
</p>
2. Click the plus sign to expand the full list of historical runs and outcomes; click **Details** to see the outcomes of a specific run
<p align="center">
<img width="75%" alt="ingestion_details" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-history.png"/>
</p>
3. From the Ingestion Run Details page, pick **View All** to see which entities were ingested
<p align="center">
<img width="75%" alt="ingestion_details_view_all" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-detail.png"/>
</p>
4. Pick an entity from the list to manually validate if it contains the detail you expected
<p align="center">
<img width="75%" alt="ingestion_details_view_all" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/guides/powerbi/powerbi-ingestion-assets.png"/>
</p>
**Congratulations!** You've successfully set up PowerBI as an ingestion source for DataHub!