Ready to get started?

Download a free trial of the XML Power BI Connector to get started:

 Download Now

Learn more:

XML Documents Icon XML Power BI Connector

The fastest and easiest way to connect Power BI to XML Documents data. Includes comprehensive high-performance data access, real-time integration, extensive metadata discovery, and robust SQL-92 support.

Create XML Dataflows on PowerBI.com



Connect to the CData Power BI Connectors from PowerBI.com to create Power BI Dataflows with real-time data.

The CData Power BI Connector for XML seamlessly integrates with the tools and wizards in Power BI, including the real-time data workflows on PowerBI.com. Follow the steps below to pull data directly into DataFlows on PowerBI.com and use the Power BI Gateway to configure automatic refresh.

Create a DSN

Installing the Power BI Connector creates a DSN (data source name) called CData Power BI XML. This the name of the DSN that Power BI uses to request a connection to the data source. Configure the DSN by filling in the required connection properties.

You can use the Microsoft ODBC Data Source Administrator to create a new DSN or configure (and rename) an existing DSN: From the Start menu, enter "ODBC Data Sources." Ensure that you run the version of the ODBC Administrator that corresponds to the bitness of your Power BI Desktop installation (32-bit or 64-bit).

See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models XML APIs as bidirectional database tables and XML files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

After setting the URI and providing any authentication values, set DataModel to more closely match the data representation to the structure of your data.

The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

  • Document (default): Model a top-level, document view of your XML data. The data provider returns nested elements as aggregates of data.
  • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
  • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

See the Modeling XML Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

Pulling XML Data Directly Into Your Dataflow

With the data source configured, follow the steps below to load data from XML tables into your DataFlow.

Set Up the Power BI Gateway

Follow the steps below to configure the gateway on your machine:

  1. Run the CData Power BI Connector installer. If you have not already done so, download the Power BI Gateway.
  2. Select the on-premises data gateway (recommended) option.
  3. Sign into the gateway.
  4. Name the gateway and specify a recovery key.
  5. In the Connectors step, choose a folder where the gateway will look for the CData Power BI Connector. This article uses C:\Users\PBIEgwService\Documents\Power BI Desktop\Custom Connectors\. Copy the .pqx files for the CData Connector (found in C:\Users\USERNAME\Documents\Power BI Desktop\Custom Connectors\) to the folder you configured.

    NOTE: The account configured for the service (NT SERVICE\PBIEgwService) needs to be able to access the folder chosen for the gateway. If needed, you can change the service account in the Service Settings section of the gateway installer.

  6. Confirm that the entry CData.PowerBI.XML is displayed in the list in the Connectors section.

Set up Power BI Online for a Dataflow

  1. In Power BI Online, create a new workspace, which is also known as an app, if you do not already have one. Note that this is only available with Power BI Pro or higher.
  2. Set up your On-Premises Gateway. The steps for this are in the Configuring the Gateway section of this article.
  3. Go back to Power BI Online. In settings, go to 'Manage Gateways', and add a new data source to your Gateway
    • Enter the Data Source Name, the name that the data source will be referred to within Power BI Online
    • Select the Data Source Type, (e.g. CData Power BI Connector for XML) and set the Data Source Name (e.g. CData Power BI XML)
    • Set Authentication Method to "Anonymous"
    • Set Privacy Level as needed
  4. Click Add to finish the configuration (do not skip the test connection as it is important to know if a successful connection was made).

    If you would like to manage the users that have access to this data source, you can go to the Users tab.

Set up your Dataflow and pull the XML data

  1. In the new workspace, go to Create > Dataflow > Add New Entities.
  2. Choose the ODBC data source and enter the correct connection properties.
    Enter your DSN name in the ODBC connection string section, dsn=CData Power BI XML. Choose your gateway and set the authentication type to Anonymous.
  3. Choose the table(s) you want to work with and click Transform data.
    If you want to make any changes to the query, you can right click on the query and click on Advanced Editor.

Configure Data Refresh on PowerBI.com

Refresh your dataflow to have the most up to date data.

  • To refresh manually, open the dataflow options menu from your workspace -> Dataflows and click Refresh Now.
  • To schedule refreshes, open the dataflow options menu from your workspace -> Dataflows and click Schedule Refresh. Enable the option to keep your data up to date. Specify the refresh frequency in the menus.

At this point, you will have a Dataflow built on top of live XML data. Learn more about the CData Power BI Connectors for XML and download a free trial from the CData Power BI Connector for XML page. Let our Support Team know if you have any questions.