Query Xero WorkflowMax Data in MySQL Workbench

Ready to get started?

Download a free trial of the Xero WorkflowMax ODBC Driver to get started:

 Download Now

Learn more:

Xero WorkflowMax Icon 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.

Execute MySQL queries against live Xero WorkflowMax data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for Xero WorkflowMax to query Xero WorkflowMax data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Xero WorkflowMax data in MySQL Workbench.

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.

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.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Xero WorkflowMax from MySQL Workbench

The steps below outline connecting to the virtual Xero WorkflowMax database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Xero WorkflowMax data.

Connect to Xero WorkflowMax through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Xero WorkflowMax).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Xero WorkflowMax Data

  1. Open the connection you just created (CData SQL Gateway for Xero WorkflowMax).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve Xero WorkflowMax data, like SELECT * FROM `CData XeroWorkflowMax Sys`.Clients;

With access to live Xero WorkflowMax data from MySQL Workbench, you can easily query and update Xero WorkflowMax, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Xero WorkflowMax and the CData SQL Gateway.