Connect to Xero WorkflowMax Data in Aqua Data Studio

The CData JDBC Driver for Xero WorkflowMax integrates Xero WorkflowMax data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Xero WorkflowMax data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Xero WorkflowMax data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Xero WorkflowMax.
   • Driver Location: Click the Browse button and select the cdata.jdbc.xeroworkflowmax.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver.

   • URL: Enter the JDBC URL, which 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.

     A typical JDBC URL is below:
     jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey;

Query Xero WorkflowMax Data

You can now query the tables exposed.