How to connect to Xero WorkflowMax Data from IntelliJ

The CData JDBC Driver for Xero WorkflowMax enables you to access Xero WorkflowMax as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Xero WorkflowMax data in IntelliJ.

Create a JBDC Data Source for Xero WorkflowMax

Follow the steps below to add the driver JAR and define connection properties required to connect to Xero WorkflowMax data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.xeroworkflowmax.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:xeroworkflowmax: and includes connection properties separated with semicolons.

     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;

Edit and Save Xero WorkflowMax Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.