VOOZH about

URL: https://www.cdata.com/kb/tech/xml-jdbc-birst.rst

⇱ Build Visualizations of XML Data in Birst


Build Visualizations of XML Data in Birst

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData drivers and the Birst Cloud Agent to build real-time visualizations of XML data in Birst.

Birst is a cloud business intelligence (BI) tool and analytics platform that helps organizations quickly understand and optimize complex processes. When paired with the CData JDBC Driver for XML, you can connect to live XML data through the Birst Cloud Agent and build real-time visualizations. In this article, we walk you through, step-by-step, how to connect to XML using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC driver offers unmatched performance for live XML data operations in Birst. When you issue complex SQL queries from Birst to XML, the driver pushes supported SQL operations, like filters and aggregations, directly to XML and utilizes the embedded SQL Engine to process unsupported operations client-side (often SQL functions and JOIN operations). With built-in dynamic metadata querying, the JDBC driver enables you to visualize and analyze XML data using native Birst data types.

Configure a JDBC Connection to XML Data in Birst

Before creating the Birst project, you will need to install the Birst Cloud Agent (in order to work with the installed JDBC Driver). Also, copy the JAR file for the JDBC Driver (and the LIC file, if it exists) to the /drivers/ directory in the installation location for the Cloud Agent.

With the driver and Cloud Agent installed, you are ready to begin.

  1. Create a new project in Birst. πŸ‘ Create a new Project in Birst
  2. Name the connection (e.g. CDataXML).
  3. Choose Live Access.
  4. Select an agent.
  5. Set Database Type to Other.
  6. πŸ‘ Configure the Connection (part 1)
  7. Set SQL Type to MSSQL
  8. Set the Connection string.

    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 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.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the XML JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.xml.jar
    

    Fill in the connection properties and copy the connection string to the clipboard.

    πŸ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

    Below is a typical JDBC connection string for XML:

    jdbc:xml:URI=C:/people.xml;DataModel=Relational;
    
    
  9. Set the Driver Name: cdata.jdbc.xml.XMLDriver and click Save.
πŸ‘ Configure the Connection (part 2)

NOTE: Since authentication to XML is managed from the connection string, you can leave Security Credentials blank.

Configure XML Data Objects

Now that the connection is configured, we are ready to configure the schema for the dataset, choosing the tables, views, and columns we wish to visualize.

  1. Select the Schema (e.g. XML).
  2. Click on Tables and/or Views to connect to those entities and click Apply.
  3. Select the Tables and Columns you want to access and click Done.
πŸ‘ Editing the objects

With the objects configured, you can perform any data preparation and discover any relationships in your data using the Pronto Prepare and Relate tools.

Build a Visualization

After you prepare your data and define relationships between the connected objects, you are ready to build your visualization.

  1. Select the Visualizer tool from the menu.
  2. πŸ‘ Select the Visualizer
  3. Select Measures & Categories from your objects
  4. Select and configure the appropriate visualization for the Measure(s) you selected.
πŸ‘ Live XML data in a Birst visualization

Using the CData JDBC Driver for XML with the Cloud Agent and Birst, you can easily create robust visualizations and reports on XML data. Download a free, 30-day trial and start building Birst visualizations today.