Query Xero WorkflowMax Data in MySQL Workbench

MySQL Workbench allows users to administer MySQL environments and gain better visibility into databases. When paired with CData Connect (on-premise or Connect Server), you get live access to Xero WorkflowMax data as if it were a MySQL database. This article shows how to create a virtual database for Xero WorkflowMax in Connect and work with live Xero WorkflowMax data in MySQL Workbench.

Create a Virtual MySQL Database for Xero WorkflowMax Data

CData Connect uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Login to Connect and click Connections.
2. Select "Xero WorkflowMax" from Available Data Sources.
3. Enter the necessary authentication properties to connect to 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.

4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Xero WorkflowMax from MySQL Workbench.

Query Xero WorkflowMax from MySQL Workbench

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

Connect to Xero WorkflowMax through Connect

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData Connect).
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 Connect).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Xero WorkflowMax data, like SELECT * FROM workflowmaxdb.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. Request a demo of the CData Connect and start working with Xero WorkflowMax just like a MySQL database today.