Import Real-Time Sage X3 Cloud 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 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 JDBC driver to create a table populated with Sage X3 Cloud data from within a ColdFusion markup file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Sage X3 Cloud data. When you issue complex SQL queries to Sage X3 Cloud, the driver pushes supported SQL operations, like filters and aggregations, directly to Sage X3 Cloud 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 Sage X3 Cloud data using native data types.

Configuring the Connection to Sage X3 Cloud

You will need a JDBC connection string to establish a connection between Coldfusion and Sage X3 Cloud.

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.

Built-in Connection String Designer

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

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

1. Copy the JDBC Driver for Sage X3 Cloud and lic file from "C:\Program Files\CData\CData JDBC Driver for Sage X3 Cloud\lib" to "C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib".

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

     jdbc:sagex3cloud:AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;

   • The Driver Class is: cdata.jdbc.sagex3cloud.SageX3CloudDriver
   • The Driver Name is arbitrary and simply used to recognize the data source in the ColdFusion administration console.
   
5. Now, test the connection by clicking the check mark to the left of the CDataSage X3 CloudJDBC data source you just created. When the data source reports an "OK" status, it is ready for use.
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="Sage X3 CloudQuery" dataSource="CDataSage X3 CloudJDBC"> 
             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 CloudJDBC"> 
   
             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>  
       

7. Finally, run the code locally in a browser at the default port of 8500. It produces a table populated with Sage X3 Cloud data!

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 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.