Ready to get started?

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

Download Now

Connect to Xero WorkflowMax Data in Squirrel SQL Client

Connect to Xero WorkflowMax data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for Xero WorkflowMax enables you to execute queries to Xero WorkflowMax data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Xero WorkflowMax data and execute queries.

Add the JDBC Driver for Xero WorkflowMax

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Xero WorkflowMax.
  4. In the Example URL box, enter jdbc:xeroworkflowmax:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData Xero WorkflowMax Source.
    • Driver: Select the CData JDBC Driver for Xero WorkflowMax.
    • URL: Enter jdbc:xeroworkflowmax:
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required 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.

    Below is a typical connection string:

    jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey;
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Xero WorkflowMax Data

After the metadata has loaded, a new tab for the Xero WorkflowMax data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'