Access Sage X3 Cloud Data as a Remote Oracle Database

The Oracle Database Gateway for ODBC and Heterogeneous Services technology enable you to connect to ODBC data sources as remote Oracle databases. This article shows how to use the CData ODBC Driver for Sage X3 Cloud to create a database link from Sage X3 Cloud to Oracle and to query Sage X3 Cloud data through the SQL*Plus tool. You can also create the database link and execute queries from SQL Developer.

Connect to Sage X3 Cloud as an ODBC Data Source

Information for connecting to Sage X3 Cloud follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

Windows

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Note: If you need to modify the DSN or create other Sage X3 Cloud DSNs, you must use a system DSN and the bitness of the DSN must match your Oracle system. You can access and create 32-bit DSNs on a 64-bit system by opening the 32-bit ODBC Data Source Administrator from C:\Windows\SysWOW64\odbcad32.exe.

Linux

If you are installing the CData ODBC Driver for Sage X3 Cloud in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData SageX3Cloud Source]
Driver = CData ODBC Driver for Sage X3 Cloud
Description = My Description
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

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Set Connection Properties for Compatibility with Oracle

The driver provides several connection properties that streamline accessing Sage X3 Cloud data just as you would an Oracle database. Set the following properties when working with Sage X3 Cloud data in SQL*Plus and SQL Developer. For compatibility with Oracle, you will need to set the following connection properties, in addition to authentication and other required connection properties.

• MapToWVarchar=False

  Set this property to map string data types to SQL_VARCHAR instead of SQL_WVARCHAR. By default, the driver uses SQL_WVARCHAR to accommodate various international character sets. You can use this property to avoid the ORA-28528 Heterogeneous Services data type conversion error when the Unicode type is returned.

• MaximumColumnSize=4000

  Set this property to restrict the maximum column size to 4000 characters.

• IncludeDualTable=True

  Set this property to mock the Oracle DUAL table. SQL Developer uses this table to test the connection.

Linux Configuration

In Linux environments, Oracle uses UTF-8 to communicate with the unixODBC Driver manager, whereas the default driver encoding is UTF-16. To resolve this, open the file /opt/cdata/cdata-driver-for-sagex3cloud/lib/cdata.odbc.sagex3cloud.ini in a text editor and set the encoding.

cdata.odbc.sagex3cloud.ini

[Driver]
DriverManagerEncoding = UTF-8

Configure the ODBC Gateway, Oracle Net, and Oracle Database

Follow the procedure below to set up an ODBC gateway to Sage X3 Cloud data that enables you to query live Sage X3 Cloud data as an Oracle database.

1. Create the file initmysagex3clouddb.ora in the folder oracle-home-directory/hs/admin and add the following setting:

   initmysagex3clouddb.ora

   HS_FDS_CONNECT_INFO = "CData SageX3Cloud Sys"

2. Add an entry to the listener.ora file. This file is located in oracle-home-directory/NETWORK/admin.

   If you are using the Database Gateway for ODBC, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

   listener.ora

   
   SID_LIST_LISTENER =
     (SID_LIST =
       (SID_DESC =
         (SID_NAME = mysagex3clouddb)
         (ORACLE_HOME = your-oracle-home)
         (PROGRAM = dg4odbc)
       )
     )
   

   If you are using Heterogeneous Services, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

   listener.ora

   
   SID_LIST_LISTENER =
     (SID_LIST =
       (SID_DESC =
         (SID_NAME = mysagex3clouddb)
         (ORACLE_HOME = your-oracle-home)
         (PROGRAM = hsodbc)
       )
     )
   

3. Add the connect descriptor below in tnsnames.ora, located in oracle-home-directory/NETWORK/admin:

   tnsnames.ora

   
   mysagex3clouddb  =
     (DESCRIPTION=
       (ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521))
       (CONNECT_DATA=(SID=mysagex3clouddb))
       (HS=OK)
     ) 
   

4. Restart the listener.

5. Test the configuration with the following command:

   tnsping mysagex3clouddb

6. Open SQL*Plus and create the database link with the command below:

   CREATE DATABASE LINK mysagex3clouddb CONNECT TO "user" IDENTIFIED BY "password" USING 'mysagex3clouddb';

You can now execute queries in SQL*Plus like the one below (note the double quotation marks around the table name):

SELECT * from "BPCUSTOMER"@mysagex3clouddb WHERE BPCNUM = 'MARTIN';