Connect to Sage X3 Cloud Data in JRuby

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Sage X3 Cloud makes it easy to integrate connectivity to live Sage X3 Cloud data in JRuby. This article shows how to create a simple JRuby app that connects to Sage X3 Cloud data, executes a query, and displays the results.

Configure a JDBC Connection to Sage X3 Cloud Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Sage X3 Cloud\lib).

JRuby natively supports JDBC, so you can easily connect to Sage X3 Cloud and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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.

Below is a typical JDBC connection string for Sage X3 Cloud:

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;

Create a JRuby App with Connectivity to Sage X3 Cloud Data

Create a new Ruby file (for example: SageX3CloudSelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java'
require 'rubygems'
require 'C:/Program Files/CData/CData JDBC Driver for Sage X3 Cloud 2018/lib/cdata.jdbc.sagex3cloud.jar'

url = "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;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT BPCNUM, BPCNAM FROM BPCUSTOMER")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

With the file completed, you are ready to display your Sage X3 Cloud data with JRuby. To do so, simply run your file from the command line:

jruby -S SageX3CloudSelect.rb

Writing SQL-92 queries to Sage X3 Cloud allows you to quickly and easily incorporate Sage X3 Cloud data into your own JRuby applications. Download a free trial today!