Skip to main content

PowerBI Report Server

Overview​

Power BI Report Server is a business intelligence and analytics platform. Learn more in the official Power BI Report Server documentation.

The DataHub integration for Power BI Report Server covers BI entities such as dashboards, charts, datasets, and related ownership context. Depending on module capabilities, it can also capture features such as lineage, usage, profiling, ownership, tags, and stateful deletion detection.

Concept Mapping​

Power BI Report ServerDatahub
Paginated ReportDashboard
Power BI ReportDashboard
Mobile ReportDashboard
Linked ReportDashboard
Dataset, DatasourceN/A

Module powerbi-report-server​

Incubating

Important Capabilities​

CapabilityStatusNotes
Detect Deleted Entities✅Enabled by default via stateful ingestion.
Extract Ownership✅Enabled by default.

Overview​

The powerbi-report-server module ingests metadata from Powerbi Report Server into DataHub. It is intended for production ingestion workflows and module-specific capabilities are documented below.

Metadata that can be ingested:

  • eport name
  • eport description
  • wnership(can add existing users in DataHub as owners)
  • ransfer folders structure to DataHub as it is in Report Server
  • ebUrl to report in Report Server

Due to limits of PBIRS REST API, it's impossible to ingest next data for now:

  • tiles info
  • datasource of report
  • dataset of report

Next types of report can be ingested:

  • PowerBI report(.pbix)
  • Paginated report(.rdl)
  • Linked report

Prerequisites​

Before running ingestion, ensure network connectivity to the source, valid authentication credentials, and read permissions for metadata APIs required by this module.

  1. Grant user access to Report Server following Microsoft documentation
  2. Use these credentials in your ingestion recipe

Install the Plugin​

pip install 'acryl-datahub[powerbi-report-server]'

Starter Recipe​

Check out the following recipe to get started with ingestion! See below for full configuration options.

For general pointers on writing and running a recipe, see our main recipe guide.

source:
  type: powerbi-report-server
  config:
    # Your Power BI Report Server Windows username
    username: username
    # Your Power BI Report Server Windows password
    password: password
    # Your Workstation name
    workstation_name: workstation_name
    # Your Power BI Report Server host URL, example: localhost:80
    host_port: host_port
    # Your alias for Power BI Report Server host URL, example: local_powerbi_report_server
    server_alias: server_alias
    # Workspace's dataset environments, example: (PROD, DEV, QA, STAGE)
    env: DEV
    # Your Power BI Report Server base virtual directory name for reports
    report_virtual_directory_name: Reports
    #  Your Power BI Report Server base virtual directory name for report server
    report_server_virtual_directory_name: ReportServer
    # Enable/Disable extracting ownership information of Dashboard
    extract_ownership: True
    # Set ownership type
    ownership_type: TECHNICAL_OWNER


sink:
  # sink configs

Config Details​

Note that a . is used to denote nested fields in the YAML recipe.

FieldDescription
host_port ✅
string
Power BI Report Server host URL
password ✅
string(password)
Windows account password
report_server_virtual_directory_name ✅
string
Report Server Virtual Directory URL name
report_virtual_directory_name ✅
string
Report Virtual Directory URL name
username ✅
string
Windows account username
extract_ownership
boolean
Whether ownership should be ingested
Default: True
graphql_url
One of string, null
[deprecated] Not used
Default: None
ownership_type
string
Ownership type of owner
Default: NONE
platform_name
string
Default: powerbi
platform_urn
string
Default: urn:li:dataPlatform:powerbi
server_alias
string
Alias for Power BI Report Server host URL
Default:
workstation_name
string
Workstation name
Default: localhost
env
string
The environment that all assets produced by this connector belong to
Default: PROD
chart_pattern
AllowDenyPattern
A class to store allow deny regexes
chart_pattern.ignoreCase
One of boolean, null
Whether to ignore case sensitivity during pattern matching.
Default: True
report_pattern
AllowDenyPattern
A class to store allow deny regexes
report_pattern.ignoreCase
One of boolean, null
Whether to ignore case sensitivity during pattern matching.
Default: True
stateful_ingestion
One of StatefulIngestionConfig, null
Stateful Ingestion Config
Default: None
stateful_ingestion.enabled
boolean
Whether or not to enable stateful ingest. Default: True if a pipeline_name is set and either a datahub-rest sink or datahub_api is specified, otherwise False
Default: False

Capabilities​

Use the Important Capabilities table above as the source of truth for supported features and whether additional configuration is required.

Limitations​

  • Ingestion is focused on report-server catalog assets and does not model all report-server object types as first-class DataHub entities.
  • Upstream dataset/datasource lineage is limited compared with cloud Power BI ingestion.
  • Metadata quality depends on permissions granted to the report-server user.

Troubleshooting​

  • Unauthorized responses: verify the configured account has access to the report server and target folders.
  • Missing reports: confirm report types are supported and the crawler scope includes the expected catalog paths.
  • Connection issues: validate Report Server URL reachability and authentication settings from the ingestion runtime.

Code Coordinates​

  • Class Name: datahub.ingestion.source.powerbi_report_server.report_server.PowerBiReportServerDashboardSource
  • Browse on GitHub
Questions?

If you've got any questions on configuring ingestion for PowerBI Report Server, feel free to ping us on our Slack.

💡 Contributing to this documentation

This page is auto-generated from the underlying source code. To make changes, please edit the relevant source files in the metadata-ingestion directory.

Tip: For quick typo fixes or documentation updates, you can click the ✏️ Edit icon directly in the GitHub UI to open a Pull Request. For larger changes and PR naming conventions, please refer to our Contributing Guide.