Access Xero WorkflowMax Data from MySQL in Amazon QuickSight

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.



Connect to Xero WorkflowMax and build visualizations of Xero WorkflowMax data using a MySQL Connection in Amazon QuickSight.

Amazon QuickSight gives you a way to quickly build visualizations, perform analytics, and get insights from AWS data sources, uploaded files, and other databases in the cloud. When paired with the CData SQL Gateway, you get the same functionality with access to 200+ Big Data, NoSQL, and SaaS sources, both on-premises and in the cloud. In this article, we use the SQL Gateway with the CData ODBC Driver for Xero WorkflowMax to access Xero WorkflowMax data through a MySQL connection in Amazon QuickSight, either in real time using direct queries, or by importing the data into SPICE.

Connect to Xero WorkflowMax Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Xero WorkflowMax data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.


To connect to the SQL Gateway from QuickSight, you will need to run the SQL Gateway on a web-facing machine. After configuring the SQL Gateway, make note of the following information:

  • The IP address or domain name of the machine hosting the SQL Gateway
  • The data source name (likely CData XeroWorkflowMax Sys) of the MySQL service
  • The port number of the MySQL service
  • The credentials of a SQL Gateway user with access to the service

Connect to Xero WorkflowMax in QuickSight

Once you have a MySQL Service configured for the Xero WorkflowMax ODBC Driver, you are ready to connect to the data in QuickSight. Start by logging in to your QuickSight console. From there, click Manage Data, then click New Data Set and choose MySQL as the data source.


Configure the data set using the values for the MySQL service for Xero WorkflowMax you configured in SQL Gateway (be sure to use the DSN for the database name). Validate your connection and click Create Data Source.


Visualize Xero WorkflowMax Data in QuickSight

For this article, we will use a custom SQL query for our data visualization. To do so, click Edit/Preview Data and in the resulting Data Prep screen follow the steps below:

  1. Name your data set (for example, Clients).
  2. If you wish to import your data into QuickSight SPICE, click the SPICE option, otherwise QuickSight will query the data directly.
  3. Under the Tables menu, click Switch to Custom SQL Tool.
    • Give your SQL query a name.
    • Enter your custom SQL query. For example:
      SELECT Id, Name FROM Clients
    • Click Finish.
  4. Click Save & Visualize.


After you have saved the data set, you can configure the visualization. Select the columns you wish to visualize and choose a visual type. Your visualization can be customized, from its name to the way that data is aggregated.


With the CData ODBC Driver for Xero WorkflowMax and SQL Gateway, you are able to easily build data visualizations and perform analytics on Xero WorkflowMax data in Amazon QuickSight. If you have any questions, such as needing to access your on-premises data from AWS QuickSight, let our Support Team know.