Query Sage X3 Cloud Data in ColdFusion

The CData JDBC driver for Sage X3 Cloud seamlessly integrates connectivity to Sage X3 Cloud data with the rapid development tools in ColdFusion. This article shows how to connect to Sage X3 Cloud data in ColdFusion and query Sage X3 Cloud tables.

Create a JDBC Data Source for Sage X3 Cloud in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

   The JAR and license for the driver are located in the lib subfolder of the installation directory.

   Restart the server after this step.

2. Add the driver as a data source:

   From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

   

3. Populate the driver properties:

   • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:sagex3cloud: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

     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

     Fill in the connection properties and copy the connection string to the clipboard.

     

     A typical JDBC URL is below:

     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;

   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.sagex3cloud.SageX3CloudDriver.
   • Driver Name: Enter a user-defined name for the driver.
   • Username: Enter the username used to authenticate.
   • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Sage X3 Cloud data source in the Actions column. After reporting a status of OK, the Sage X3 Cloud data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Sage X3 Cloud. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="SageX3CloudQuery" dataSource="CDataSageX3Cloud">
  SELECT * FROM BPCUSTOMER WHERE BPCNUM = <cfqueryparam value="#BPCNUM#" cfsqltype="cf_sql_varchar">
</cfquery>
<cfdump var="#SageX3CloudQuery#">

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
  "SELECT * FROM BPCUSTOMER WHERE BPCNUM = ?", 
  [
    { value="MARTIN", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataSageX3Cloud" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?BPCNUM=MARTIN