Build Semantic Layer Views for Sage X3 Cloud Data in APOS Live Data Gateway

APOS Live Data Gateway (LDG) is a data connection and data transformation solution that enables live data connectivity and expanded data source options for SAP Analytics Cloud and other SAP solutions. When paired with CData Connectors, users can build semantic layer views for live Sage X3 Cloud data, enabling real-time analytics on Sage X3 Cloud just like working with a relational database.

With built-in optimized data processing, the CData Connector 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.

Download and Install the Connector Files

In order to access Sage X3 Cloud data through the APOS Live Data Gateway, you will need to download the connector files from APOS and install them on the machine hosting the Live Data Gateway. An APOS representative can deliver the necessary files.

• Install the CData DLL file (System.Data.CData.SageX3Cloud.dll) to the APOS Live Data Gateway installation directory (C:\Program Files\Live Data Gateway\Admin\ by default).
• Install the CData JAR file (cdata.jdbc.sagex3cloud.jar) to the ConnectionTest_lib folder in the installation directory (C:\Program Files\Live Data Gateway\Admin\ConnectionTest_lib\ by default).
• Install the CData JAR file (cdata.jdbc.sagex3cloud.jar) to the lib folder in the Web UI installation directory (e.g.: C:\LDG_WebUI\lib\)

Configuring the Sage X3 Cloud Connection String

Before establishing the connection to Sage X3 Cloud from the APOS Live Data Gateway, you need to configure the Sage X3 Cloud JDBC Connection String.

Built-in Connection String Designer

For assistance in constructing the JDBC Connection String, 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.

Your connection string will look similar to the following:

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;

Connecting to Sage X3 Cloud & Creating a Semantic Layer View

After installing the connector files and configuring the connection string, you are ready to connect to Sage X3 Cloud in the Live Data Gateway Admin tool and build a semantic layer view in the Live Data Gateway Web UI.

Configuring the Connection to Sage X3 Cloud

1. Log into your APOS Live Data Gateway Manager
2. If you haven't already, update your APOS LDG license file
   1. Click File -> Configurations
   2. Click on the "..." Menu for the License
   3. Select the license file from the APOS team that includes your CData Connector license
3. In the APOS Live Data Gateway Manager, click "Add"
4. In the APOS Live Data Gateway On the Connection tab, configure the connection:
   • Set Data Source to "Database"
   • Set Database to "CData Drivers"
   • Set Database CData Drivers to "Sage X3 Cloud"
   • Set Connection String to the connection string configured earlier (e.g.:

     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;

   • Set Driver Class to "cdata.jdbc.sagex3cloud.SageX3CloudDriver" (this should be set by default)
   
5. Click Test Connection
6. Click Save
7. Give your connection a unique prefix (e.g. "sagex3cloud")
8. Highlight the newly created connection and click File -> "Approve Users For Web UI"
9. Approve the appropriate DB users to create views and click "Save"

At this point, we are ready to build our semantic layer view in the Live Data Gateway Web UI.

Creating a Semantic Layer View

1. In your browser, navigate to the APOS Live Data Gateway Portal
2. Select a Connection (e.g. "sagex3cloud")
3. Since Sage X3 Cloud does not require a User or Password to authenticate, you may use whatever values you wish for User Name and Password
4. Click "Login"
5. Once connected, click "Semantic Layer" to create a new semantic layer view
6. Click "New Semantic Layer View"
7. Set the Semantic Layer View Prefix and Semantic Layer View Name
8. Click "Step 2"
9. Select the table(s) and column(s) you wish to include in your view
10. Click "Step 3"
11. Select the Measures from the available table columns
12. Click "Step 5" (we skipped the "Extra Dimensions" step)
13. Add any Variable Prompts
14. Click "Step 6"
15. Define any Table Joins
16. Click "Review"
17. Review you semantic layer view and click "Save"

With the Semantic Layer View created, you are ready to access your Sage X3 Cloud data through the APOS Live Data Gateway, enabling real-time data connectivity to Sage X3 Cloud data from SAP Analytics Cloud and other SAP solutions.

More Information & Free Evaluation

Please visit APOS Systems - APOS Solutions - Request Evaluation Software to request evaluation software or email [email protected] for more information on working with your live Sage X3 Cloud data in APOS Live Data Gateway.