Connect to Sage X3 Cloud Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for Sage X3 Cloud into your processes in RapidMiner. This article uses the CData JDBC Driver for Sage X3 Cloud to transfer Sage X3 Cloud data to a process in RapidMiner.

Connect to Sage X3 Cloud in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Sage X3 Cloud:

1. Add a new database driver for Sage X3 Cloud: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL:

   
   jdbc:sagex3cloud:
   

4. Enter the path to the cdata.jdbc.sagex3cloud.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class:

   
   cdata.jdbc.sagex3cloud.SageX3CloudDriver
   

   
6. Create a new Sage X3 Cloud connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the Sage X3 Cloud driver you configured previously.
9. Enter your connection string in the Host box.

   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 connection string is below:

   
   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;
   

10. Enter your username and password if necessary.

You can now use your Sage X3 Cloud connection with the various RapidMiner operators in your process. To retrieve Sage X3 Cloud data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the Sage X3 Cloud data.