ETL Sage X3 Cloud in Oracle Data Integrator

Leverage existing skills by using the JDBC standard to connect to Sage X3 Cloud: Through drop-in integration into ETL tools like Oracle Data Integrator (ODI), the CData JDBC Driver for Sage X3 Cloud connects real-time Sage X3 Cloud data to your data warehouse, business intelligence, and Big Data technologies.

JDBC connectivity enables you to work with Sage X3 Cloud just as you would any other database in ODI. As with an RDBMS, you can use the driver to connect directly to the Sage X3 Cloud APIs in real time instead of working with flat files.

This article covers a JDBC-based ETL -- Sage X3 Cloud to Oracle. After reverse engineering a data model of Sage X3 Cloud entities, you will create a mapping and select a data loading strategy -- since the driver supports SQL-92, this last step can easily be accomplished by selecting the built-in SQL to SQL Loading Knowledge Module.

Install the Driver

To install the driver, copy the driver JAR (cdata.jdbc.sagex3cloud.jar) and .lic file (cdata.jdbc.sagex3cloud.lic), located in the installation folder, into the ODI appropriate directory:

• UNIX/Linux without Agent: ~/.odi/oracledi/userlib
• UNIX/Linux with Agent: ~/.odi/oracledi/userlib and $ODI_HOME/odi/agent/lib
• Windows without Agent: %APPDATA%\Roaming\odi\oracledi\userlib
• Windows with Agent: %APPDATA%\odi\oracledi\userlib and %APPDATA%\odi\agent\lib

Restart ODI to complete the installation.

Reverse Engineer a Model

Reverse engineering the model retrieves metadata about the driver's relational view of Sage X3 Cloud data. After reverse engineering, you can query real-time Sage X3 Cloud data and create mappings based on Sage X3 Cloud tables.

1. In ODI, connect to your repository and click New -> Model and Topology Objects.
2. On the Model screen of the resulting dialog, enter the following information:
   • Name: Enter SageX3Cloud.
   • Technology: Select Generic SQL (for ODI Version 12.2+, select Microsoft SQL Server).
   • Logical Schema: Enter SageX3Cloud.
   • Context: Select Global.
   
3. On the Data Server screen of the resulting dialog, enter the following information:
   • Name: Enter SageX3Cloud.
   • Driver List: Select Oracle JDBC Driver.
   • Driver: Enter cdata.jdbc.sagex3cloud.SageX3CloudDriver
   • URL: Enter the JDBC URL containing the connection string.

     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. On the Physical Schema screen, enter the following information:
   • Name: Select from the Drop Down menu.
   • Database (Catalog): Enter CData.
   • Owner (Schema): If you select a Schema for Sage X3 Cloud, enter the Schema selected, otherwise enter SageX3Cloud.
   • Database (Work Catalog): Enter CData.
   • Owner (Work Schema): If you select a Schema for Sage X3 Cloud, enter the Schema selected, otherwise enter SageX3Cloud.
   
5. In the opened model click Reverse Engineer to retrieve the metadata for Sage X3 Cloud tables.

Edit and Save Sage X3 Cloud Data

After reverse engineering you can now work with Sage X3 Cloud data in ODI. To view Sage X3 Cloud data, expand the Models accordion in the Designer navigator, right-click a table, and click View data.

Create an ETL Project

Follow the steps below to create an ETL from Sage X3 Cloud. You will load BPCUSTOMER entities into the sample data warehouse included in the ODI Getting Started VM.

1. Open SQL Developer and connect to your Oracle database. Right-click the node for your database in the Connections pane and click new SQL Worksheet.

   Alternatively you can use SQLPlus. From a command prompt enter the following:

   
   sqlplus / as sysdba
   

2. Enter the following query to create a new target table in the sample data warehouse, which is in the ODI_DEMO schema. The following query defines a few columns that match the BPCUSTOMER table in Sage X3 Cloud:

   
   CREATE TABLE ODI_DEMO.TRG_BPCUSTOMER (BPCNAM NUMBER(20,0),BPCNUM VARCHAR2(255));
   

3. In ODI expand the Models accordion in the Designer navigator and double-click the Sales Administration node in the ODI_DEMO folder. The model is opened in the Model Editor.
4. Click Reverse Engineer. The TRG_BPCUSTOMER table is added to the model.
5. Right-click the Mappings node in your project and click New Mapping. Enter a name for the mapping and clear the Create Empty Dataset option. The Mapping Editor is displayed.
6. Drag the TRG_BPCUSTOMER table from the Sales Administration model onto the mapping.
7. Drag the BPCUSTOMER table from the Sage X3 Cloud model onto the mapping.
8. Click the source connector point and drag to the target connector point. The Attribute Matching dialog is displayed. For this example, use the default options. The target expressions are then displayed in the properties for the target columns.
9. Open the Physical tab of the Mapping Editor and click BPCUSTOMER_AP in TARGET_GROUP.
10. In the BPCUSTOMER_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.

You can then run the mapping to load Sage X3 Cloud data into Oracle.