Using the CData ODBC Driver for Xero WorkflowMax in PyCharm

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 as an ODBC data source in PyCharm using the CData ODBC Driver for Xero WorkflowMax.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Xero WorkflowMax from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Xero WorkflowMax as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to Xero WorkflowMax

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData XeroWorkflowMax Source] Driver = CData ODBC Driver for Xero WorkflowMax Description = My Description APIKey = myApiKey AccountKey = myAccountKey

Execute SQL to Xero WorkflowMax

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for XeroWorkflowMax};APIKey = myApiKey;AccountKey = myAccountKey;') cursor = cnxn.cursor() cursor.execute("SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'") rows = cursor.fetchall() for row in rows: print(row.Id, row.Name)

After connecting to Xero WorkflowMax in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Xero WorkflowMax data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.