VOOZH about

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

โ‡ฑ Import Real-Time XML Data via ODBC in ColdFusion to Build Applications


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

๐Ÿ‘ Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Use CData ODBC drivers to import and use XML 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 XML, you can link your ColdFusion web and mobile applications to operational XML 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 XML data from within a ColdFusion markup file.

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

CData Drivers let you work with XML 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 XML file(s) within Amazon S3, set the URI property to the URI of the Bucket and Folder where the intended XML 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 XML file(s) within Box, set the URI property to the URI of the folder that includes the intended XML file(s). Use the OAuth authentication method to connect to Box.

Dropbox

To connect to XML file(s) within Dropbox, set the URI proprerty to the URI of the folder that includes the intended XML 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 XML file(s) within SharePoint with SOAP Schema, set the URI proprerty to the URI of the document library that includes the intended XML file. Set User, Password, and StorageBaseURL.

SharePoint Online REST

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

Google Drive

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

The property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

  • Document (default): Model a top-level, document view of your XML data. The data provider returns nested elements as aggregates of data.
  • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
  • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

See the Modeling XML Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

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 XML 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 XML 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 CDataXMLODBC 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="XMLQuery" dataSource="CDataXMLODBC"> 
     SELECT * FROM people 
     </cfquery> 
     
    And a CFTable can be used to quickly output the table in HTML:
     
     <cftable 
     query = "XMLQuery" 
     border = "1" 
     colHeaders 
     colSpacing = "2" 
     headerLines = "2" 
     HTMLTable 
     maxRows = "500" 
     startRow = "1"> 
    
     <cfcol header="<b>[ personal.name.first ]</b>" align="Left" width=2 text="[ personal.name.first ]"/> 
    
     <cfcol header="<b>[ personal.name.last ]</b>" align="Left" width=15 text="[ personal.name.last ]"/> 
    
     ...
    
     </cftable> 
     
    Full code, including the HTML portion is available below:
     
     <html> 
     <head><title>CData Software | XML people Table Demo </title></head> 
     <body> 
     <cfoutput>#ucase("XML people Table Demo")#</cfoutput> 
     <cfquery name="XMLQuery" dataSource="CDataXMLODBC"> 
    
     SELECT * FROM people 
    
     </cfquery> 
     <cftable 
     query = "XMLQuery" 
     border = "1" 
     colHeaders 
     colSpacing = "2" 
     headerLines = "2" 
     HTMLTable 
     maxRows = "500" 
     startRow = "1"> 
     <cfcol header="<b>[ personal.name.first ]</b>" align="Left" width=2 text="[ personal.name.first ]"/> 
    
     <cfcol header="<b>[ personal.name.last ]</b>" align="Left" width=15 text="[ personal.name.last ]"/> 
    
     ...
    
     </cftable> 
     </body> 
    
     </html> 
     
  6. Finally, run the code in a browser. It produces a table populated with XML 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 XML and start building XML-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 XML ODBC Driver to get started:

 Download Now

Learn more:

๐Ÿ‘ XML Documents Icon
XML ODBC Driver

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

Access XML data like you would any standard database - read, write, and update etc. through a standard ODBC Driver interface.