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 CloverDX (formerly CloverETL)



Transfer Xero WorkflowMax data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Xero WorkflowMax enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Xero WorkflowMax as sources and destinations. In this article, you will use the JDBC Driver for Xero WorkflowMax to set up a simple transfer into a flat file. The CData JDBC Driver for Xero WorkflowMax enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Xero WorkflowMax as sources and destinations. In this article, you will use the JDBC Driver for Xero WorkflowMax to set up a simple transfer into a flat file.

Connect to Xero WorkflowMax as a JDBC Data Source

  1. Create the connection to Xero WorkflowMax data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.xeroworkflowmax.jar file.
  3. Enter 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.

    A typical JDBC URL is below:

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

Query Xero WorkflowMax Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Xero WorkflowMax JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Clients table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.