Load Xero WorkflowMax Data to a Database Using Embulk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Xero WorkflowMax JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Xero WorkflowMax.



Use CData JDBC Driver for Xero WorkflowMax with the open source ETL/ELT tool Embulk to load Xero WorkflowMax data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Xero WorkflowMax, Embulk easily loads data from Xero WorkflowMax to any supported destination. In this article, we explain how to use the CData JDBC Driver for Xero WorkflowMax in Embulk to load Xero WorkflowMax data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Xero WorkflowMax data. When you issue complex SQL queries to Xero WorkflowMax, the driver pushes supported SQL operations, like filters and aggregations, directly to Xero WorkflowMax and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to Xero WorkflowMax Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Xero WorkflowMax\lib).

Embulk supports JDBC connectivity, so you can easily connect to Xero WorkflowMax and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Xero WorkflowMax.

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 JDBC connection string for Xero WorkflowMax:

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

Load Xero WorkflowMax Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  2. embulk gem install embulk-input-jdbc
  3. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load Xero WorkflowMax data into MySQL using Embulk.

Create a Job to Load Xero WorkflowMax Data

Start by creating a config file in Embulk, using a name like xeroworkflowmax-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for Xero WorkflowMax, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (xeroworkflowmax-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Xero WorkflowMax 20xx\lib\cdata.jdbc.xeroworkflowmax.jar driver_class: cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver url: jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey; table: "Clients" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Clients" mode: insert

After creating the file, run the Embulk job.

embulk run xeroworkflowmax-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Xero WorkflowMax Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Xero WorkflowMax 20xx\lib\cdata.jdbc.xeroworkflowmax.jar driver_class: cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver url: jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey; query: "SELECT Id, Name FROM Clients WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Clients" mode: insert

More Information & Free Trial

By using CData JDBC Driver for Xero WorkflowMax as a connector, Embulk can integrate Xero WorkflowMax data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.