How to Connect DBeaver to Sage X3 Cloud via a JDBC Driver

The CData JDBC Driver for Sage X3 Cloud implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Sage X3 Cloud data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Sage X3 Cloud Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Sage X3 Cloud).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.sagex3cloud.SageX3CloudDriver.
   • Set URL Template to jdbc:sagex3cloud:.
   
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData\CData JDBC Driver for Sage X3 Cloud XXXX\) and select the JAR file (cdata.jdbc.SageX3Cloud.jar).

Create a Connection to Sage X3 Cloud Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Sage X3 Cloud) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required 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.

   

   Below is a typical connection string:

   
   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;
   

   
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query Sage X3 Cloud Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial

Download a free, 30-day trial of the CData JDBC Driver for Sage X3 Cloud and start working with your live Sage X3 Cloud data in DBeaver. Join the CData Community or reach out to our Support Team if you have any questions.