Integrate WooCommerce Data in the Pentaho Report Designer

The CData JDBC driver for WooCommerce data enables access to live data from dashboards and reports. This article shows how to connect to WooCommerce data as a JDBC data source and publish reports based on WooCommerce 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 WooCommerce connection. In the resulting dialog, configure the connection properties as shown below.

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

     WooCommerce supports the following authentication methods: one-legged OAuth1.0 Authentication and standard OAuth2.0 Authentication.

     Connecting using one-legged OAuth 1.0 Authentication

     Specify the following properties (NOTE: the below credentials are generated from WooCommerce settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):

     • ConsumerKey
     • ConsumerSecret

     Connecting using WordPress OAuth 2.0 Authentication

     After having configured the plugin, you may connect to WooCommerce by providing the following connection properties:

     • OAuthClientId
     • OAuthClientSecret
     • CallbackURL
     • InitiateOAuth - Set this to either GETANDREFRESH or REFRESH

     In either case, you will need to set the Url property to the URL of the WooCommerce instance.

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.woocommerce.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:woocommerce:Url=https://example.com/; ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5; InitiateOAuth=GETANDREFRESH
   • Custom Driver Class Name: Enter cdata.jdbc.woocommerce.WooCommerceDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.

Add WooCommerce Data to a Report

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

1. Add the WooCommerce 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 ParentId, Total FROM Orders WHERE ParentId = '3'
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 Orders table.
4. Finally, run the report to see the chart.