Import Real-Time Excel Online Data via ODBC in ColdFusion to Build Applications

Dibyendu Datta
Lead Technology Evangelist

Use CData ODBC drivers to import and use Excel Online 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 Excel Online, you can link your ColdFusion web and mobile applications to operational Excel Online 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 Excel Online data from within a ColdFusion markup file.

To follow along with this tutorial, you need to install the CData ODBC Driver for Excel Online 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.

You can connect to a workbook by providing authentication to Excel Online and then setting the following properties:

: Set this to the name or Id of the workbook.

If you want to view a list of information about the available workbooks, execute a query to the Workbooks view after you authenticate.
: Set this to true if you are connecting to a workbook in a sandbox account. Otherwise, leave this blank to connect to a production account.

You use the OAuth authentication standard to authenticate to Excel Online. See the Getting Started section in the help documentation for a guide. Getting Started also guides you through executing SQL to worksheets and ranges.

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 Excel Online Data and display it in a table in ColdFusion:

From the ColdFusion administrator interface, choose Data & Services. 👁 Selecting Data & Services
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. 👁 Adding Data Source Name
From the ODBC DSN Dropdown menu select CData Excel Online 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. 👁 Populating driver properties
Now, test the connection by pressing the check mark to the left of the CDataExcel OnlineODBC data source you just created. When the data source reports an "OK" status, it is ready for use. 👁 Testing the connection

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="Excel OnlineQuery" dataSource="CDataExcel OnlineODBC"> 
 SELECT * FROM Test_xlsx_Sheet1 
 </cfquery>

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

 
 <cftable 
 query = "Excel OnlineQuery" 
 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>Column1</b>" align="Left" width=15 text="Column1"/> 

 ...

 </cftable>

Full code, including the HTML portion is available below:

 
 <html> 
 <head><title>CData Software | Excel Online Test_xlsx_Sheet1 Table Demo </title></head> 
 <body> 
 <cfoutput>#ucase("Excel Online Test_xlsx_Sheet1 Table Demo")#</cfoutput> 
 <cfquery name="Excel OnlineQuery" dataSource="CDataExcel OnlineODBC"> 

 SELECT * FROM Test_xlsx_Sheet1 

 </cfquery> 
 <cftable 
 query = "Excel OnlineQuery" 
 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>Column1</b>" align="Left" width=15 text="Column1"/> 

 ...

 </cftable> 
 </body> 

 </html>

Finally, run the code in a browser. It produces a table populated with Excel Online data! 👁 Running the code

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

Ready to get started?

Download a free trial of the Excel Online ODBC Driver to get started:

Download Now

Learn more:

👁 Excel Online Icon
Excel Online ODBC Driver

The Excel Online ODBC Driver is a powerful tool that allows you to connect with live Excel Online data, directly from any applications that support ODBC connectivity.

Access Excel Online Spreadsheet data like you would a database - read, write, and update data through a standard ODBC Driver interface.

URL: https://www.cdata.com/kb/tech/excelonline-odbc-coldfusion.rst