Ready to get started?

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

Download Now

Build Dashboards with Magento Data in DBxtra

Create dynamic dashboards and perform analytics based on Magento data in DBxtra.

The CData ODBC Driver for Magento enables access to live data from Magento under the ODBC standard, allowing you work with Magento data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to connect to Magento data as a generic ODBC Data Provider and create charts, reports, and dashboards based on Magento data in DBxtra.

Connect to Magento Data

  1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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

    When you configure the DSN, 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.

  2. Open the DBxtra application and in the New menu click Project and name the Project.
  3. Select ODBC Connection as the Data Connection Type.
  4. Click the browse option () for the Data Source.
  5. In the Data Link Properties window, select Microsoft OLE DB Provider for ODBC Drivers on the Provider tab.
  6. On the Connection tab, select the Data Source Name and the initial catalog to use (CData).
  7. Name the Connection and select the appropriate User Groups.
  8. Double-click the Connection from within the Project to connect to the data.

Create a Dashboard with Magento Data

You are now ready to create a dashboard with Magento data.

  1. Right-click Report Objects under the Project and select New Report Object.
  2. In the new Report Object, click the link to create the Query.
  3. In the Select Data Connection window, select the newly created data connection.
  4. On the Query tab, expand the connection objects and select the Tables, Views, and specific columns you wish to include in your dashboard. You can specify search requirements and even create complex queries which include JOINs and aggregations.
  5. On the Dashboard tab, select the visualizations and features for your dashboard. Assign the data values from the query to the appropriate fields for the Dashboards items (Values, Series, etc.)

With a new Dashboard created, you are ready to begin analysis of Magento data. Thanks to the ODBC Driver for Magento, you can refresh the Dashboard and immediately see any changes made at the source. In the same way, you can create and view Reports with live, up-to-date Magento data.