Learn more
 

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.

In this article

Related articles

Import Real-Time Xero WorkflowMax Data in ColdFusion to Build Applications


Use the CData ODBC Driver for Xero WorkflowMax to import and use Xero WorkflowMax data in ColdFusion.

Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST. When ColdFusion is paired with the CData ODBC Driver for Xero WorkflowMax, you can link your ColdFusion web and mobile applications to operational Xero WorkflowMax data. This allows for your applications to be more robust and complete. This article details how to use the ODBC driver to create a table populated with Xero WorkflowMax data from within a ColdFusion markup file.

To follow along with this tutorial, you need to install the CData ODBC Driver for Xero WorkflowMax and Adobe ColdFusion.

Configuring the Connection

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 process. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Adding a Data Source and Creating a Table

After creating a DSN, follow the steps below to add a new data source, test our connection to it, create a ColdFusion markup file, and, finally, import Xero WorkflowMax Xero WorkflowMax data and display it in a table in ColdFusion:

  1. From the ColdFusion administrator interface, choose Data & Services.
  2. Here, click "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our ODBC driver, choose "ODBC Socket", then click the "Add" button.
  3. From the ODBC DSN Dropdown menu select CData Xero WorkflowMax Sys. Under the Advanced Settings section, leave the Connection String blank. Note that any properties specified in this input field will override the ones specified in the DSN Configuration.
  4. Now, test the connection by pressing the check mark to the left of the CDataXero WorkflowMaxODBC data source you just created. When the data source reports an "OK" status, it is ready for use.
  5. Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot") for ColdFusion.

    The following code queries the data source: 

                
        <cfquery name="Xero WorkflowMaxQuery" dataSource="CDataXero WorkflowMaxODBC"> 
          SELECT * FROM Clients 
        </cfquery>
    And a CFTable can be used to quickly output the table in HTML: 
                
          <cftable  
          query = "Xero WorkflowMaxQuery" 
          border = "1" 
          colHeaders 
          colSpacing = "2" 
          headerLines = "2" 
          HTMLTable 
          maxRows = "500" 
          startRow = "1"> 

          <cfcol header="<b>Id</b>" align="Left" width=2 text="Id"/> 

          <cfcol header="<b>Name</b>" align="Left" width=15 text="Name"/> 

          ...

        </cftable>
    Full code, including the HTML portion is available below: 
                
        <html> 
        <head><title>CData Software | Xero WorkflowMax Clients Table Demo </title></head> 
        <body> 
        <cfoutput>#ucase("Xero WorkflowMax Clients Table Demo")#</cfoutput> 
        <cfquery name="Xero WorkflowMaxQuery" dataSource="CDataXero WorkflowMaxODBC"> 

          SELECT * FROM Clients 

        </cfquery> 
        <cftable  
          query = "Xero WorkflowMaxQuery" 
          border = "1" 
          colHeaders 
          colSpacing = "2" 
          headerLines = "2" 
          HTMLTable 
          maxRows = "500" 
          startRow = "1"> 
          <cfcol header="<b>Id</b>" align="Left" width=2 text="Id"/> 

          <cfcol header="<b>Name</b>" align="Left" width=15 text="Name"/> 

          ...

        </cftable> 
        </body> 

        </html>
  6. Finally, run the code in a browser. It produces a table populated with Xero WorkflowMax data!

As a note, the CData ODBC Drivers also support parameterized queries using the cfqueryparam element. For example: SELECT * FROM Account WHERE name =

Get Started Today

Download a free, 30-day trial of the CData ODBC Driver for Xero WorkflowMax and start building Xero WorkflowMax-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.