Import Real-Time Sage X3 Cloud 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 Sage X3 Cloud, you can link your ColdFusion web and mobile applications to operational Sage X3 Cloud 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 Sage X3 Cloud data from within a ColdFusion markup file.

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

Sage X3 Cloud uses the OAuth 2.0 Client Credentials flow, and an X-API-Key is also required for API access. Set AuthScheme to OAuth and specify the following connection properties:

• URL: The base URL of your Sage X3 Cloud instance.
• OAuthAccessTokenUrl: The OAuth token endpoint (e.g., https://your-auth-domain/oauth/token).
• OAuthClientId: Your OAuth application client ID.
• OAuthClientSecret: Your OAuth application client secret.
• Audience: The API audience value for the token request.
• XAPIKey: The X-API-Key provided by your Sage X3 Cloud administrator.
• Folder: The Sage X3 folder name (e.g., SEED). This folder is used as the default schema.
• Folders (optional): A comma-separated list of Sage X3 folders (e.g., SEED,PERF). Each folder is exposed as a separate schema, so you can query across folders with the Schema.Table syntax.

The driver obtains an access token with the Client Credentials flow and sends it with the X-API-Key on every API request. With InitiateOAuth set to GETANDREFRESH (the default), the driver acquires and refreshes the token automatically.

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

1. From the ColdFusion administrator interface, choose 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.
3. From the ODBC DSN Dropdown menu select CData Sage X3 Cloud 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.
4. Now, test the connection by pressing the check mark to the left of the CDataSage X3 CloudODBC data source you just created. When the data source reports an "OK" status, it is ready for use.
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="Sage X3 CloudQuery" dataSource="CDataSage X3 CloudODBC"> 
             SELECT * FROM BPCUSTOMER 
           </cfquery> 
       

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

               
             <cftable  
             query = "Sage X3 CloudQuery" 
             border = "1" 
             colHeaders 
             colSpacing = "2" 
             headerLines = "2" 
             HTMLTable 
             maxRows = "500" 
             startRow = "1"> 
   
             <cfcol header="<b>BPCNUM</b>" align="Left" width=2 text="BPCNUM"/> 
   
             <cfcol header="<b>BPCNAM</b>" align="Left" width=15 text="BPCNAM"/> 
   
             ...
   
           </cftable> 
       

   Full code, including the HTML portion is available below:

               
           <html> 
           <head><title>CData Software | Sage X3 Cloud BPCUSTOMER Table Demo </title></head> 
           <body> 
           <cfoutput>#ucase("Sage X3 Cloud BPCUSTOMER Table Demo")#</cfoutput> 
           <cfquery name="Sage X3 CloudQuery" dataSource="CDataSage X3 CloudODBC"> 
   
             SELECT * FROM BPCUSTOMER 
   
           </cfquery> 
           <cftable  
             query = "Sage X3 CloudQuery" 
             border = "1" 
             colHeaders 
             colSpacing = "2" 
             headerLines = "2" 
             HTMLTable 
             maxRows = "500" 
             startRow = "1"> 
             <cfcol header="<b>BPCNUM</b>" align="Left" width=2 text="BPCNUM"/> 
   
             <cfcol header="<b>BPCNAM</b>" align="Left" width=15 text="BPCNAM"/> 
   
             ...
   
           </cftable> 
           </body> 
   
           </html>  
       

6. Finally, run the code in a browser. It produces a table populated with Sage X3 Cloud data!

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