Ready to get started?

Download a free trial of the Xero WorkflowMax Driver to get started:

 Download Now

Learn more:

Xero WorkflowMax Icon Xero WorkflowMax JDBC Driver

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

Connect to Xero WorkflowMax Data in RazorSQL



Connect to Xero WorkflowMax from wizards and query Xero WorkflowMax data from the GUI in the RazorSQL database management tool.

The CData JDBC Driver for Xero WorkflowMax enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Xero WorkflowMax using wizards in RazorSQL.

Create a JDBC Data Source for Xero WorkflowMax Data

  1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
  2. In the Connection Wizard that appears, set the following properties:
    • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
    • Driver Class: Set the driver class to cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver.
    • Username: Enter the username. (This property can also be set in the JDBC URL.)
    • Password: Enter the password. (This property can also be set in the JDBC URL.)
    • JDBC URL: Enter connection parameters. The JDBC URL begins 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.

      A typical JDBC URL is the following:

      jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey;

Query Xero WorkflowMax Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.