Connect to Sage X3 Cloud Data in RazorSQL

The CData JDBC Driver for Sage X3 Cloud enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Sage X3 Cloud using wizards in RazorSQL.

Create a JDBC Data Source for Sage X3 Cloud Data

1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
2. In the Connection Wizard that appears, set the following properties:
   • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
   • Driver Class: Set the driver class to cdata.jdbc.sagex3cloud.SageX3CloudDriver.
   • Username: Enter the username. (This property can also be set in the JDBC URL.)
   • Password: Enter the password. (This property can also be set in the JDBC URL.)

   • JDBC URL: Enter connection parameters. The JDBC URL begins with jdbc:sagex3cloud: and is followed by a semicolon-separated list of connection properties.

     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 the following:

     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;

Query Sage X3 Cloud Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.