Manage Xero WorkflowMax Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Xero WorkflowMax seamlessly integrates Xero WorkflowMax data into database management tools like DBArtisan by enabling you to access Xero WorkflowMax data as a database. This article shows how to create a JDBC source for Xero WorkflowMax in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Xero WorkflowMax Data into DBArtisan Projects

Follow the steps below to register Xero WorkflowMax data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   Below is a typical connection string:

   jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey;
6. Finish the wizard to connect to Xero WorkflowMax data. Xero WorkflowMax entities are displayed in the Datasource Explorer.

You can now work with Xero WorkflowMax data as you work with any other database. See the driver help documentation for more information on the queries supported by the Xero WorkflowMax API.