Connect to Xero WorkflowMax as an External Data Source using PolyBase

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Xero WorkflowMax ODBC Driver

The Xero WorkflowMax ODBC Driver is a powerful tool that allows you to connect with live data from Xero WorkflowMax, directly from any applications that support ODBC connectivity.

Access Xero WorkflowMax data like you would a database - read, write, and update Xero WorkflowMax Clients, Jobs, Leads, Quotes, etc. through a standard ODBC Driver interface.



Use the CData ODBC Driver for Xero WorkflowMax and PolyBase to create an external data source in SQL Server 2019 with access to live Xero WorkflowMax data.

PolyBase for SQL Server allows you to query external data by using the same Transact-SQL syntax used to query a database table. When paired with the CData ODBC Driver for Xero WorkflowMax, you get access to your Xero WorkflowMax data directly alongside your SQL Server data. This article walks through creating an external data source and external tables to grant access to live Xero WorkflowMax data using T-SQL queries.

The CData ODBC drivers offer unmatched performance for interacting with live Xero WorkflowMax data using PolyBase due to optimized data processing built into the driver. When you issue complex SQL queries from SQL Server to Xero WorkflowMax, the driver pushes down supported SQL operations, like filters and aggregations, directly to Xero WorkflowMax and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. And with PolyBase, you can also join SQL Server data with Xero WorkflowMax data, using a single query to pull data from distributed sources.

Connect to Xero WorkflowMax

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs. To create an external data source in SQL Server using PolyBase, configure a System DSN (CData Xero WorkflowMax Sys is created automatically).

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.

Click "Test Connection" to ensure that the DSN is connected to Xero WorkflowMax properly. Navigate to the Tables tab to review the table definitions for Xero WorkflowMax.

Create an External Data Source for Xero WorkflowMax Data

After configuring the connection, you need to create a master encryption key and a credential database for the external data source.

Creating a Master Encryption Key

Execute the following SQL command to create a new master key, 'ENCRYPTION,' to encrypt the credentials for the external data source.

CREATE MASTER KEY ENCRYPTION BY PASSWORD = 'password';

Creating a Credential Database

Execute the following SQL command to create credentials for the external data source connected to Xero WorkflowMax data.

NOTE: Since Xero WorkflowMax does not require a User or Password to authenticate, you may use whatever values you wish for IDENTITY and SECRET.

CREATE DATABASE SCOPED CREDENTIAL xeroworkflowmax_creds
WITH IDENTITY = 'username', SECRET = 'password';

Create an External Data Source for Xero WorkflowMax

Execute the following SQL command to create an external data source for Xero WorkflowMax with PolyBase, using the DSN and credentials configured earlier.

For Xero WorkflowMax, set SERVERNAME to 'localhost' or '127.0.0.1' and leave PORT empty. PUSHDOWN is set to ON by default, meaning the ODBC Driver can leverage server-side processing for complex queries.

CREATE EXTERNAL DATA SOURCE cdata_xeroworkflowmax_source
WITH ( 
  LOCATION = 'odbc://SERVERNAME[:PORT]',
  CONNECTION_OPTIONS = 'DSN=CData Xero WorkflowMax Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = xeroworkflowmax_creds
);

Create External Tables for Xero WorkflowMax

After creating the external data source, use CREATE EXTERNAL TABLE statements to link to Xero WorkflowMax data from your SQL Server instance. The table column definitions must match those exposed by the CData ODBC Driver for Xero WorkflowMax. You can refer to the Tables tab of the DSN Configuration Wizard to see the table definition.

Sample CREATE TABLE Statement

The statement to create an external table based on a Xero WorkflowMax Clients would look similar to the following:

CREATE EXTERNAL TABLE Clients(
  Id [nvarchar](255) NULL,
  Name [nvarchar](255) NULL,
  ...
) WITH ( 
  LOCATION='Clients',
  DATA_SOURCE=cdata_xeroworkflowmax_source
);

Having created external tables for Xero WorkflowMax in your SQL Server instance, you are now able to query local and remote data simultaneously. Thanks to built-in query processing in the CData ODBC Driver, you know that as much query processing as possible is being pushed to Xero WorkflowMax, freeing up local resources and computing power. Download a free, 30-day trial of the ODBC Driver for Xero WorkflowMax and start working with live Xero WorkflowMax data alongside your SQL Server data today.