A PostgreSQL Interface for Xero WorkflowMax Data

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 the Remoting features of the Xero WorkflowMax JDBC Driver to create a PostgreSQL entry-point for data access.

There are a vast number of PostgreSQL clients available on the Internet. From standard Drivers to BI and Analytics tools, PostgreSQL is a popular interface for data access. Using our JDBC Drivers, you can now create PostgreSQL entry-points that you can connect to from any standard client.

To access Xero WorkflowMax data as a PostgreSQL database, use the CData JDBC Driver for Xero WorkflowMax and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query Xero WorkflowMax data from PostgreSQL Server.

Connect to Xero WorkflowMax Data as a JDBC Data Source

To connect to Xero WorkflowMax as a JDBC data source, you will need the following:

  • Driver JAR path: The JAR is located in the lib subfolder of the installation directory.
  • Driver class: cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver

  • JDBC URL: The URL must start with "jdbc:xeroworkflowmax:" and can include any of the connection properties in name-value pairs 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 below:

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

Build the JDBC Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The jdbc2_fdw extension is used as an example (downloadable here).

  1. Add a symlink from the shared object for your version of the JRE to /usr/lib/libjvm.so. For example: ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
  2. Start the build: make install USE_PGXS=1

Query Xero WorkflowMax Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to Xero WorkflowMax data:

  1. Log into your database.
  2. Load the extension for the database: CREATE EXTENSION jdbc2_fdw;
  3. Create a server object for Xero WorkflowMax: CREATE SERVER XeroWorkflowMax FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver', url 'jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey;', querytimeout '15', jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.xeroworkflowmax.jar');
  4. Create a user mapping for the username and password of a user known to the MySQL daemon. CREATE USER MAPPING for postgres SERVER XeroWorkflowMax OPTIONS ( username 'admin', password 'test');
  5. Create a foreign table in your local database: postgres=# CREATE FOREIGN TABLE clients ( clients_id text, clients_Id text, clients_Name numeric) SERVER XeroWorkflowMax OPTIONS ( table_name 'clients');
You can now execute read/write commands to Xero WorkflowMax: postgres=# SELECT * FROM clients;