Integrate Xero WorkflowMax Data in the Pentaho Report Designer

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Xero WorkflowMax JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Xero WorkflowMax.



Publish reports based on Xero WorkflowMax data in the Pentaho BI tool.

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

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

      To connect to the WorkflowMax API, obtain an APIKey and AccountKey from Xero. This can only be done by contacting Xero support (https://www.workflowmax.com/contact-us).

      After obtaining an API Key and Account Key, set the values in the APIKey and AccountKey connection properties. Once these are set, you are ready to connect.

      Built-in Connection String Designer

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

      java -jar cdata.jdbc.xeroworkflowmax.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:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey;
    • Custom Driver Class Name: Enter cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add Xero WorkflowMax Data to a Report

You are now ready to create a report with Xero WorkflowMax data.

  1. Add the Xero WorkflowMax 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 Id, Name FROM Clients WHERE Name = 'Cynthia'
  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 Clients table.
  4. Finally, run the report to see the chart.