Import Real-Time Xero Data via JDBC in ColdFusion to Build Applications

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, you can link your ColdFusion web and mobile applications to operational Xero 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 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 data. When you issue complex SQL queries to Xero, the driver pushes supported SQL operations, like filters and aggregations, directly to Xero 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 data using native data types.

Getting Started

---

Configuring the Connection to Xero

You will need a JDBC connection string to establish a connection between Coldfusion and Xero.

To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. Set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.

To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.

See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.

Built-in Connection String Designer

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

java -jar cdata.jdbc.xero.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 data and display it in a table written in the ColdFusion Markup Language, or CFML:

1. Copy the JDBC Driver for Xero and lic file from "C:\Program Files\CData[product_name]\lib" to "C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib".

    cdata.jdbc.xero.jar
    cdata.jdbc.xero.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. 👁 Selecting 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. 👁 Adding Data Source Name
   
4. Next, populate the driver properties.
   • JDBC URL will need to be in the format: jdbc:xero:|connectionString|.
   • A typical connection string looks like this:

     jdbc:xero:InitiateOAuth=GETANDREFRESH;

   • The Driver Class is: cdata.jdbc.xero.XeroDriver
   • The Driver Name is arbitrary and simply used to recognize the data source in the ColdFusion administration console.
   👁 Populating driver properties
   
5. Now, test the connection by clicking the check mark to the left of the CDataXeroJDBC data source you just created. When the data source reports an "OK" status, it is ready for use. 👁 Testing the connection
   
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="XeroQuery" dataSource="CDataXeroJDBC"> 
    SELECT * FROM Items 
    </cfquery> 
    

   And a CFTable can be used to quickly output the table in HTML:

    
    <cftable 
    query = "XeroQuery" 
    border = "1" 
    colHeaders 
    colSpacing = "2" 
    headerLines = "2" 
    HTMLTable 
    maxRows = "500" 
    startRow = "1"> 
   
    <cfcol header="<b>Name</b>" align="Left" width=2 text="Name"/> 
   
    <cfcol header="<b>QuantityOnHand</b>" align="Left" width=15 text="QuantityOnHand"/> 
   
    ...
   
    </cftable> 
    

   Full code, including the HTML portion is available below:

    
    <html> 
    <head><title>CData Software | Xero Items Table Demo </title></head> 
    <body> 
    <cfoutput>#ucase("Xero Items Table Demo")#</cfoutput> 
    <cfquery name="XeroQuery" dataSource="CDataXeroJDBC"> 
   
    SELECT * FROM Items 
   
    </cfquery> 
    <cftable 
    query = "XeroQuery" 
    border = "1" 
    colHeaders 
    colSpacing = "2" 
    headerLines = "2" 
    HTMLTable 
    maxRows = "500" 
    startRow = "1"> 
    <cfcol header="<b>Name</b>" align="Left" width=2 text="Name"/> 
   
    <cfcol header="<b>QuantityOnHand</b>" align="Left" width=15 text="QuantityOnHand"/> 
   
    ...
   
    </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 data! 👁 Running the code
   

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 and start building Xero-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.