Feed Magento Data into FineReport

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Magento JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Magento including Customers, Inventory, Products, Orders, and more!



How to set Magento data as a JDBC data source in FineReport.

The CData JDBC Driver for Magento fully implements the JDBC standard and can provide Magento data connectivity to a wide variety of BI, reporting, and ETL tools and custom applications. In this article, we explain how to set Magento data as JDBC data source in FineReport and view Magento data as a table in the Report Designer.

Set Up a JDBC Data Source of Magento Data

Follow the instruction below to set Magento data as a FineReport database connection.

  1. Copy the cdata.jdbc.magento.jar file from the lib folder in the CData JDBC Driver for Magento installation directory to the lib folder of the FineReport installation directory. You will need to copy the cdata.jdbc.magento.lic file as well.
  2. From the Server tab, select Define Data Connection, click to add a new connection, and click JDBC.

Next we will set up the data connection definition in the window.

  1. Database: Others
  2. JDBC Driver: cdata.jdbc.magento.Magento Driver
  3. URL: A standard JDBC connection string using semicolon-separated connection properties.

    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.

    A typical JDBC URL is below:

    jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;
  4. Click Connection pool attributes and set Test before getting connections to No.

Click Test connection to ensure you have configured the connection properly. With the connection to Magento set up, you can use it as FineReport data source.

Select Magento Data in the Report Designer.

  1. Click to add a new template data set and select DB query to open the database query window.
  2. Choose the JDBC connection that you created from the dropdown list.
  3. The Magento entities will appear as tables on the left pane.
  4. Write a SELECT statement for the Magento data tables and columns that you want to load.
  5. Click preview and data is shown as table.

With these simple steps, Magento can be used as a JDBC data source in FineReport.