Build a PostgreSQL Interface for Sage X3 Cloud Data using the CData JDBC Driver

There are a vast number of PostgreSQL clients available on the Internet. From standard Drivers to BI and Analytics tools, PostgreSQL is a popular interface for data access. Using our JDBC Drivers, you can now create PostgreSQL entry-points that you can connect to from any standard client.

To access Sage X3 Cloud data as a PostgreSQL database, use the CData JDBC Driver for Sage X3 Cloud and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query Sage X3 Cloud data from PostgreSQL Server.

Connect to Sage X3 Cloud Data as a JDBC Data Source

To connect to Sage X3 Cloud as a JDBC data source, you will need the following:

• Driver JAR path: The JAR is located in the lib subfolder of the installation directory.

• Driver class:

  
  cdata.jdbc.sagex3cloud.SageX3CloudDriver
  

• JDBC URL: The URL must start with "jdbc:sagex3cloud:" and can include any of the connection properties in name-value pairs separated with semicolons.

  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 below:

  
  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;
  

Build the JDBC Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The jdbc2_fdw extension is used as an example (downloadable here).

1. Add a symlink from the shared object for your version of the JRE to /usr/lib/libjvm.so. For example:

   
   ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
   

2. Start the build:

   
   make install USE_PGXS=1
   

Query Sage X3 Cloud Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to Sage X3 Cloud data:

1. Log into your database.
2. Load the extension for the database:

   
   CREATE EXTENSION jdbc2_fdw;
   

3. Create a server object for Sage X3 Cloud:

   
   CREATE SERVER SageX3Cloud 
   FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
   drivername '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;',
   querytimeout '15',
   jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.sagex3cloud.jar'); 
   

4. Create a user mapping for the username and password of a user known to the MySQL daemon.

   
   CREATE USER MAPPING for postgres SERVER SageX3Cloud OPTIONS (
   username 'admin', 
   password 'test');
   

5. Create a foreign table in your local database:

   
   postgres=# CREATE FOREIGN TABLE bpcustomer (
   bpcustomer_id text,
   bpcustomer_BPCNUM text,
   bpcustomer_BPCNAM numeric) 
   SERVER SageX3Cloud OPTIONS (
   table_name 'bpcustomer');
   

postgres=# SELECT * FROM bpcustomer;