Ready to get started?

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

Download Now

Integrate BigCommerce Data in the Pentaho Report Designer

Publish reports based on BigCommerce data in the Pentaho BI tool.

The CData JDBC Driver for BigCommerce data enables access to live data from dashboards and reports. This article shows how to connect to BigCommerce data as a JDBC data source and publish reports based on BigCommerce data in Pentaho.

Connect and Create a Report

  1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
  2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
  3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new BigCommerce connection. In the resulting dialog, configure the connection properties as shown below.

    • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:bigcommerce: and is followed by a semicolon-separated list of connection properties.

      BigCommerce authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Big Commerce developer platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL. These three parameters will be set as connection properties to your driver.

      Additionally, in order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

      1. Log in to your BigCommerce account.
      2. From the Home Page, select Advanced Settings > API Accounts.
      3. Click Create API Account.
      4. A text box named API Path will appear on your screen.
      5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
      6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
      7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.bigcommerce.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 URL:

      jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=GETANDREFRESH
    • Custom Driver Class Name: Enter cdata.jdbc.bigcommerce.BigCommerceDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add BigCommerce Data to a Report

You are now ready to create a report with BigCommerce data.

  1. Add the BigCommerce source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

  2. Configure the query. This article uses the one below:

    SELECT FirstName, LastName FROM Customers WHERE FirstName = 'Bob'
  3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Customers table.
  4. Finally, run the report to see the chart.