Ready to get started?

Learn more about the CData JDBC Driver for Magento or download a free trial:

Download Now

Build Visualizations of Magento Data in Birst

Use the CData JDBC Driver for Magento and the Birst Cloud Agent to build real-time visualizations of Magento 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 Magento, you can connect to live Magento 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 Magento using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC Driver offers unmatched performance for live Magento data operations in Birst. When you issue complex SQL queries from Birst to Magento, the driver pushes supported SQL operations, like filters and aggregations, directly to Magento 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 Magento data using native Birst data types.

Configure a JDBC Connection to Magento 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.
  2. Name the connection (e.g. CDataMagento).
  3. Choose Live Access.
  4. Select an agent.
  5. Set Database Type to Other.
  6. Set SQL Type to MSSQL
  7. Set the Connection string.

    Magento uses the OAuth 1 authentication standard. To connect to the Magento REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Magento system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

    You will also need to provide the URL to your Magento system. The URL depends on whether you are using the Magento REST API as a customer or administrator.

    • Customer: To use Magento as a customer, make sure you have created a customer account in the Magento homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Magento system.

    • Administrator: To access Magento as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

      If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.magento.jar

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

    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 Magento:

    jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH
  8. Set the Driver Name: cdata.jdbc.magento.MagentoDriver and click Save.

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

Configure Magento 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. Magento).
  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.

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 Measures & Categories from your objects
  3. Select and configure the appropriate visualization for the Measure(s) you selected.

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