XML File Connector for Power BI
In this article you will learn how to integrate Using XML File Connector you will be able to connect, read, and write data from within Power BI. Follow the steps below to see how we would accomplish that. The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
Connect to XML File in other apps
|
Video Tutorial - Integrate XML File data in Power BI
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
XML File integration in Power BI - How to configure connection for
XML File - Features about
XML Driver (Authentication / Query Language / Examples / Driver UI) - Using
XML File Connection in Power BI
Create ODBC Data Source (DSN) based on ZappySys XML Driver
Step-by-step instructions
To get data from XML File using Power BI we first need to create a DSN (Data Source) which will access data from XML File. We will later be able to read data using Power BI. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys XML Driver
ZappySys XML DriverYou should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
You can use pass single file or multiple file path using wildcard pattern in path and you can use select single file by clicking [...] path button or multiple file using wildcard pattern in path.
Note: If you want to operation with multiple files then use wild card pattern as below (when you use wild card pattern in source path then system will treat target path as folder regardless you end with slash) C:\SSIS\Test\reponse.xml (will read only single reponse.xml file) C:\SSIS\Test\j*.xml (all files starting with file name j) C:\SSIS\Test\*.xml (all files with .xml Extension and located under folder subfolder)
-
Now enter Path expression in Array Filter textbox to extract only specific part of XML file as below ($.feed.entry[*] will get content of entry attribute from XML document. Entry attribute is array of XML documents so we have to use [*] to indicate we want all records of that array)
NOTE: Here, We are using our desired filter, but you need to select your desired filter based on your requirement.
Click on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.$.feed.entry[*] -
Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
-
Click OK to finish creating the data source.
-
That's it; we are done. In a few clicks we configured the call to XML File using ZappySys XML File Connector.
Video instructions
Read XML File data in Power BI using ODBC
Importing XML File data into Power BI from table or view
-
Once you open Power BI Desktop click Get Data to get data from ODBC:
-
A window opens, and then search for "odbc" to get data from ODBC data source:
-
Another window opens and asks to select a Data Source we already created. Choose XmlFileDSN and continue:
XmlFileDSN -
Most likely, you will be asked to authenticate to a newly created DSN. Just select Windows authentication option together with Use my current credentials option:
XmlFileDSN -
Finally, you will be asked to select a table or view to get data from. Select one and load the data!
-
Finally, finally, use extracted data from XML File in a Power BI report:
Importing XML File data into Power BI using SQL query
If you wish to import XML File data from SQL query rather than a table then you can use advanced options during import steps (as below). After selecting DSN you can click on advanced options to see SQL Query editor.
SELECT ProductID, ProductName, SupplierID, CategoryID, QuantityPerUnit, UnitPrice FROM _root_ WHERE UnitPrice > 20
$
as the table name, e.g. SELECT * FROM $
.
Use _root_
instead, e.g. SELECT * FROM _root_
.
Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys XML Driver - XML FileXML File Connector can be used to extract and output XML data stored in local XML files or direct XML String (variables or DB columns). XML Connector also supports Path expression to extract data from any level. This Connector is optimized to work with very large files.XmlFileDSN
- The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then just paste the connection string into your script:
XmlFileDSNDRIVER={ZappySys XML Driver};DataPath='C:\my-folder\file-*.xml'
- You are good to go! The script will execute the same way as using a DSN.
Editing query for table in Power BI
There will be a time you need to change the initial query after importing data into Power BI. Don't worry, just right-click on your table and click Edit query menu item:
Using parameters in Power BI (dynamic query)
In the real world, many values of your REST / SOAP API call may be coming from parameters. If that's the case for you can try to edit script manually as below. In below example its calling SQL Query with POST method and passing some parameters. Notice below where paraAPIKey is Power BI Parameter (string type). You can use parameters anywhere in your script just like the normal variable.
To use a parameter in Power BI report, follow these simple steps:
-
Firstly, you need to Edit query of your table (see previous section)
-
Then just create a new parameter by clicking Manage Parameters dropdown, click New Parameter option, and use it in the query:
= Odbc.Query("dsn=XmlFileDSN", "SELECT * FROM _root_ WITH (SRC='http://my-api-provider.com/api/" & MyParameter & "/items')")
Refer to Power Query M reference for more information on how to use its advanced features in your queries.
Using DirectQuery Option rather than Import
So far we have seen how to Import XML File data into Power BI but what if you have too much data and you dont want to import but link it. Power BI Offers very useful feature for this scenario. Its called DirectQuery Option. In this section we will explore how to use DirectQuery along with ZappySys Drivers.
Out of the box ZappySys Drivers wont work in ODBC Connection Mode so you have to use SQL Server Connection rather than ODBC if you wish to use Live data using DirectQuery option. See below step by step instructions to enable DirectQuery mode in Power BI for XML File data.
Basically we will use ZappySys Data Gateway its part of ODBC PowerPack. We will then use Linked Server in SQL Server to Link API Service and then we will issue OPENROWSET queries from Power BI to SQL Server and it will then call XML File via ZappySys Data Gateway.
- First read this article carefully, How to query XML File API in SQL Server.
- Once linked server is configured we are ready to issue API query in Power BI.
- Click Get Data in Power BI, select SQL Server Database
- Enter your server name and any database name
- Select Mode as DirectQuery
-
Click on Advanced and enter query like below (we are assuming you have created XML File Data Source in Data Gateway and defined linked server (Change name below).
SELECT * FROM OPENQUERY([XML_FILE_LINKED_SERVER], 'SELECT * FROM Customers')
SELECT * FROM OPENQUERY([XML_FILE_LINKED_SERVER], 'SELECT * FROM Customers') - Click OK and Load data ... That's it. Now your XML File API data is linked rather than imported.
Publishing Power BI report to Power BI service
Here are the instructions on how to publish a Power BI report to Power BI service from Power BI Desktop application:
-
First of all, go to Power BI Desktop, open a Power BI report, and click Publish button:
-
Then select the Workspace you want to publish report to and hit Select button:
-
Finally, if everything went right, you will see a window indicating success:
If you need to periodically refresh Power BI semantic model (dataset) to ensure data accuracy and up-to-dateness, you can accomplish that by using Microsoft On-premises data gateway. Proceed to the next section - Refreshing Power BI semantic model (dataset) using On-premises data gateway - and learn how to do that.
Refreshing Power BI semantic model (dataset) using On-premises data gateway
Power BI allows to refresh semantic models which are based on data sources that reside on-premises. This can be achieved using Microsoft On-premises data gateway. There are two types of On-premises gateways:
- Standard Mode
- Personal Mode
Standard Mode supports Power BI and other Microsoft Data Fabric services. It fits perfectly for Enterprise solutions as it installs as a Windows Service and also supports Direct Query feature.
Personal Mode, on the other hand, can be configured faster, but is designed more for home users (you cannot install it as a Windows Service and it does not support DirectQuery). You will find a detailed comparison in the link above.
We recommend to go with Personal Mode for a quick POC solution, but use Standard Mode in production environment.
Below you will find instructions on how to refresh semantic model using both types of gateways.
Refresh using On-premises data gateway (standard mode)
Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (standard mode):
-
Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:
-
If you see this view, it means you have to install On-premises data gateway (standard mode):
-
Install On-premises data gateway (standard mode) and sign-in:
Use the same email address you use when logging in into Power BI account. -
Register a new gateway (or migrate an existing one):
-
If you are creating a new gateway, name your gateway, enter a Recovery key, and click Configure button:
-
Now, let's get back to your semantic model settings in Power BI portal. Refresh the page and you should see your newly created gateway. Click arrow icon and then click on Add to gateway link:
ODBC{"connectionstring":"dsn=XmlFileDSN"} -
Once you do that, you will create a new gateway connection. Give it a name, set Authentication method, Privacy level, and click Create button:
dsn=XmlFileDSNIn this example, we used the least restrictive Privacy level.If your connection uses a full connection string you may hit a length limitation when entering it into the field. To create the connection, you will need to shorten it manually. Check the section about the limitation of a full connection string on how to accomplish it.
On-premises data gateway (personal mode) does not have this limitation.
-
Proceed by choosing the newly created connection:
ODBC{"connectionstring":"dsn=XmlFileDSN"} -
Finally, you are at the final step where you can refresh the semantic model:
Refresh using On-premises data gateway (personal mode)
Here are the instructions on how to refresh a Power BI semantic model using On-premises data gateway (personal mode):
-
Go to Power BI My workspace, hover your mouse cursor on your semantic model and click Settings:
-
If you see this view, it means you have to install On-premises data gateway (personal mode):
-
Install On-premises data gateway (personal mode) and sign-in:
Use the same email address you use when logging in into Power BI account. -
Again, go to your semantic model Settings, expand Data source credentials, click Edit credentials, select Authentication method together with Privacy level, and then click Sign in button:
dsn=XmlFileDSN -
Finally, you are ready to refresh your semantic model:
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Conclusion
In this article we discussed how to connect to XML File in Power BI and integrate data without any coding. Click here to Download XML File Connector for Power BI and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download XML File Connector for Power BI
Documentation
More integrations
Other application integration scenarios for XML File
Other connectors for Power BI
Download XML File Connector for Power BI
Documentation
How to connect XML File in Power BI?
How to get XML File data in Power BI?
How to read XML File data in Power BI?
How to load XML File data in Power BI?
How to import XML File data in Power BI?
How to pull XML File data in Power BI?
How to push data to XML File in Power BI?
How to write data to XML File in Power BI?
How to POST data to XML File in Power BI?
Call XML File API in Power BI
Consume XML File API in Power BI
XML File Power BI Automate
XML File Power BI Integration
Integration XML File in Power BI
Consume real-time XML File data in Power BI
Consume real-time XML File API data in Power BI
XML File ODBC Driver | ODBC Driver for XML File | ODBC XML File Driver | SSIS XML File Source | SSIS XML File Destination
Connect XML File in Power BI
Load XML File in Power BI
Load XML File data in Power BI
Read XML File data in Power BI
XML File API Call in Power BI