Connect to Sage X3 Cloud Data in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for Sage X3 Cloud, HULFT Integrate can work with live Sage X3 Cloud data. This article explains how to connect to Sage X3 Cloud and move the data into a CSV file.

With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Sage X3 Cloud data. When you issue complex SQL queries to Sage X3 Cloud, the driver pushes supported SQL operations, like filters and aggregations, directly to Sage X3 Cloud and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Sage X3 Cloud data using native data types.

Enable Access to Sage X3 Cloud

To enable access to Sage X3 Cloud data from HULFT Integrate projects:

1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.sagex3cloud.jar (and cdata.jdbc.sagex3cloud.lic), to the jdbc_adapter subfolder for the Integrate Server
2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to Sage X3 Cloud Data

Once you copy the JAR files, you can create a project with access to Sage X3 Cloud data. Start by opening Integrate Studio and creating a new project.

1. Name the project
2. Ensure the "Create script" checkbox is checked
3. Click Next
4. Name the script (e.g.: SageX3CloudtoCSV)

Once you create the project, add components to the script to copy Sage X3 Cloud data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for Sage X3 Cloud. Set the following properties:
   • Name: Sage X3 Cloud Connection Settings
   • Driver class name: cdata.jdbc.sagex3cloud.SageX3CloudDriver
   • 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;
     
     

     Built-in Connection String Designer

     For assistance 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.

     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.

     
2. Write your SQL statement. For example:

   SELECT BPCNUM, BPCNAM FROM BPCUSTOMER

3. Click "Extraction test" to ensure the connection and query are configured properly
4. Click "Execute SQL statement and set output schema"
5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

1. Set a file to write the query results to (e.g. BPCUSTOMER.csv)
2. Set "Input data" to the "Select SQL" component
3. Add columns for each field selected in the SQL query
4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
5. Click "Finish"

Map Sage X3 Cloud Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move Sage X3 Cloud data into a CSV file.

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 HULFT Integrate. Reach out to our Support Team if you have any questions.