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

Ready to get started?

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

 Download Now

Learn more:

Xero WorkflowMax Icon Xero WorkflowMax JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Xero WorkflowMax.



Use the CData JDBC 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 JDBC 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 JDBC driver to create a table populated with Xero WorkflowMax data from within a ColdFusion markup file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Xero WorkflowMax data. When you issue complex SQL queries to Xero WorkflowMax, the driver pushes supported SQL operations, like filters and aggregations, directly to Xero WorkflowMax and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Xero WorkflowMax data using native data types.

Configuring the Connection to Xero WorkflowMax

You will need a JDBC connection string to establish a connection between Coldfusion and 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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Xero WorkflowMax JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.xeroworkflowmax.jar

Adding a Data Source and Creating a Table

After configuring the connection, follow the steps below to add the CData JDBC Driver to ColdFusion's lib directory, add a new data source, test the connection, create a ColdFusion markup file, and, finally, make a real-time connection with Xero WorkflowMax data and display it in a table written in the ColdFusion Markup Language, or CFML:

  1. Copy the JDBC Driver for Xero WorkflowMax and lic file from "C:\Program Files\CData\CData JDBC Driver for Xero WorkflowMax\lib" to "C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib". cdata.jdbc.xeroworkflowmax.jar cdata.jdbc.xeroworkflowmax.lic

    Note: If you do not copy the .lic file with the jar, you will see a licensing error that indicates you do not have a valid license installed. This is true for both the trial and full versions.

  2. From the ColdFusion administrator interface, choose Data & Services.
  3. Here, we can "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our JDBC driver, choose "other", then click the "Add" button.
  4. Next, populate the driver properties.
    • JDBC URL will need to be in the format: jdbc:xeroworkflowmax:|connectionString|.
    • A typical connection string looks like this:

      jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey;

    • The Driver Class is: cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver
    • The Driver Name is arbitrary and simply used to recognize the data source in the ColdFusion administration console.
  5. Now, test the connection by clicking the check mark to the left of the CDataXero WorkflowMaxJDBC data source you just created. When the data source reports an "OK" status, it is ready for use.
  6. 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 WorkflowMaxJDBC"> 
              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 WorkflowMaxJDBC"> 
    
              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>  
        
  7. Finally, run the code locally in a browser at the default port of 8500. It produces a table populated with Xero WorkflowMax data!

As a note, the CData JDBC 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 JDBC 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.