How to integrate Metabase with XML Data
Metabase is an open source data visualization tool that allows users to create interactive dashboards. When paired with CData Connect AI, users can easily create visualizations and dashboards linked to live XML data. This article describes how to connect to XML and build a simple visualization using XML data.
CData Connect provides a pure cloud-to-cloud interface for XML, allowing you to easily integrate with live XML data in Metabase — without replicating the data. Connect looks exactly like a SQL Server database to Metabase and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to XML, leveraging server-side processing to quickly return XML data.
Configure XML Connectivity for Metabase
Connectivity to XML from Metabase is made possible through CData Connect AI. To work with XML data from Metabase, we start by creating and configuring a XML connection.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "XML" from the Add Connection panel
-
Enter the necessary authentication properties to connect to XML.
Connecting to Local or Cloud-Stored (Box, Google Drive, Amazon S3, SharePoint) XML Files
CData Drivers let you work with XML files stored locally and stored in cloud storage services like Box, Amazon S3, Google Drive, or SharePoint, right where they are.
Setting connection properties for local files
Set the URI property to local folder path.
Setting connection properties for files stored in Amazon S3
To connect to XML file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended XML files exist. In addition, at least set these properties:
- AWSAccessKey: AWS Access Key (username)
- AWSSecretKey: AWS Secret Key
Setting connection properties for files stored in Box
To connect to XML file(s) within Box, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Box.
Dropbox
To connect to XML file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Dropbox. Either User Account or Service Account can be used to authenticate.
SharePoint Online (SOAP)
To connect to XML file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. Set User, Password, and StorageBaseURL.
SharePoint Online REST
To connect to XML file(s) within SharePoint with REST Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. StorageBaseURL is optional. If not set, the driver will use the root drive. OAuth is used to authenticate.
Google Drive
To connect to XML file(s) within Google Drive, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect and set InitiateOAuth to GETANDREFRESH.
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.
- Click Save & Test
-
Navigate to the Permissions tab in the Add XML Connection page and update the User-based permissions.
Add a Personal Access Token
When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.
With the connection configured and a PAT generated, you are ready to connect to XML data from Metabase.
Connect to CData Connect AI from Metabase
After creating the connection in Connect AI, navigate to your Metabase instance. Use the SQL Server interface to connect to Connect AI.
- Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab
- Configure the connection to Connect AI and click "Save"
- Database type: Select "SQL Server"
- Name: Name the connection (e.g. "XML (Connect AI)")
- Host: tds.cdata.com
- Port: 14333
- Database name: The name of the connection you just created (e.g. XML1)
- Username: A Connect AI username (e.g. [email protected])
- Password: The PAT previously created
- Click to Use a secure connection (SSL)
Execute XML Data with Metabase
Once you configure the connection to Connect AI, you can query XML and build visualizations.
- Use the "Write SQL" tool to retrieve the XML data
- Write a SQL query based on the XML connection in CData Connect AI, e.g.
SELECT [people].[personal.age] AS age, [people].[personal.gender] AS gender, [people].[personal.name.first] AS first_name, [people].[personal.name.last] AS last_name, [vehicles].[model], FROM [people] JOIN [vehicles] ON [people].[_id] = [vehicles].[people_id]
- Navigate to the "Visualization" screen, choose a visualization, and configure the visualization
More Information & Free Trial
At this point, you have built a simple visualization from XML data in Metabase. You can continue to work with live XML data in Metabase just like you would any SQL Server database. For more information on creating a live connection to XML (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live XML data in Metabase today.