Import Real-Time Excel Data via ODBC 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 ODBC Driver for Excel, you can link your ColdFusion web and mobile applications to operational Excel 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 data from within a ColdFusion markup file.

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

Connecting to Local or Cloud-Stored (Box, Google Drive, Amazon S3, SharePoint) Excel Files

CData Drivers let you work with Excel files stored locally and stored in cloud storage services like Box, Amazon S3, Google Drive, or SharePoint, right where they are.

Setting connection properties for local files

Set the URI property to local folder path.

Setting connection properties for files stored in Amazon S3

To connect to Excel file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended Excel files exist. In addition, at least set these properties:

• AWSAccessKey: AWS Access Key (username)
• AWSSecretKey: AWS Secret Key

Setting connection properties for files stored in Box

To connect to Excel file(s) within Box, set the URI property to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect to Box.

Dropbox

To connect to Excel file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect to Dropbox. Either User Account or Service Account can be used to authenticate.

SharePoint Online (SOAP)

To connect to Excel file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended Excel file. Set User, Password, and StorageBaseURL.

SharePoint Online REST

To connect to Excel file(s) within SharePoint with REST Schema, set the URI proprerty to the URI of the document library that includes the intended Excel file. StorageBaseURL is optional. If not set, the driver will use the root drive. OAuth is used to authenticate.

Google Drive

To connect to Excel file(s) within Google Drive, set the URI property to the URI of the folder that includes the intended Excel file(s). Use the OAuth authentication method to connect and set InitiateOAuth to GETANDREFRESH.

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

1. From the ColdFusion administrator interface, choose Data & Services. 👁 Selecting 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. 👁 Adding Data Source Name
   
3. From the ODBC DSN Dropdown menu select CData Excel 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
   
4. Now, test the connection by pressing the check mark to the left of the CDataExcelODBC data source you just created. When the data source reports an "OK" status, it is ready for use. 👁 Testing the connection
   
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="ExcelQuery" dataSource="CDataExcelODBC"> 
    SELECT * FROM Sheet 
    </cfquery> 
    

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

    
    <cftable 
    query = "ExcelQuery" 
    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>Revenue</b>" align="Left" width=15 text="Revenue"/> 
   
    ...
   
    </cftable> 
    

   Full code, including the HTML portion is available below:

    
    <html> 
    <head><title>CData Software | Excel Sheet Table Demo </title></head> 
    <body> 
    <cfoutput>#ucase("Excel Sheet Table Demo")#</cfoutput> 
    <cfquery name="ExcelQuery" dataSource="CDataExcelODBC"> 
   
    SELECT * FROM Sheet 
   
    </cfquery> 
    <cftable 
    query = "ExcelQuery" 
    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>Revenue</b>" align="Left" width=15 text="Revenue"/> 
   
    ...
   
    </cftable> 
    </body> 
   
    </html> 
    

6. Finally, run the code in a browser. It produces a table populated with Excel 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 and start building Excel-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.