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

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Use the CData Connect AI and APOS Live Data Gateway to build Semantic Layer Views for Sage X3 Cloud data.

APOS Live Data Gateway (LDG) serves as a data connection and data transformation solution, facilitating live data connectivity and broadening data source possibilities for SAP Analytics Cloud and other SAP solutions. When integrated with CData Connect AI, users have the capability to construct semantic layer views for real-time access to Sage X3 Cloud data, enabling real-time analytics on Sage X3 Cloud in a manner akin to working with a relational database.

CData Connect AI offers a dedicated SQL Server interface for Sage X3 Cloud, enabling data querying directly from Sage X3 Cloud without the need to replicate data to a native database. With pre-optimized data processing capabilities, CData Connect AI efficiently directs all supported SQL operations, including filters and JOINs, directly to Sage X3 Cloud. This harnesses server-side processing to swiftly retrieve the requested Sage X3 Cloud data.

Configure Sage X3 Cloud Connectivity for APOS Live Data Gateway

Connectivity to Sage X3 Cloud from APOS Live Data Gateway is made possible through CData Connect AI. To work with Sage X3 Cloud data from APOS Live Data Gateway, we start by creating and configuring a Sage X3 Cloud connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. Adding a Connection
  3. Select "Sage X3 Cloud" from the Add Connection panel
  4. Selecting a data source
  5. Enter the necessary authentication properties to connect to Sage X3 Cloud.

    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.

    Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add Sage X3 Cloud Connection page and update the User-based permissions. Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Sage X3 Cloud data in the APOS Live Data Gateway.

Connecting to Sage X3 Cloud & Creating a Semantic Layer View

After configuring the connection in CData Connect AI 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 Logging into the APOS LDG 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 Connect AI 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 "JDBC Generic"
    • Set Connection String to a connection string similar to the following, using the name of the connection you configured earlier, e.g.
      jdbc:sqlserver://tds.cdata.com:14333;databaseName=SageX3Cloud1
    • Set Driver Class to "com.CData.connect.Driver" (this should be set by default)
    Configuring the Connection (Salesforce is shown).
  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" Approving Users For Web UI.
  9. Approve the appropriate DB users to create views and click "Save" Configuring which DB users can create views.

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. Set User Name and Password to your Connect AI username and PAT .
  4. Click "Login" Connecting from the Web UI (Salesforce is shown).
  5. Once connected, click "Semantic Layer" to create a new semantic layer view
  6. Click "New Semantic Layer View" Adding a new semantic layer view.
  7. Set the Semantic Layer View Prefix and Semantic Layer View Name Setting the semantic layer view prefix and name.
  8. Click "Step 2"
  9. Select the table(s) and column(s) you wish to include in your view Selecting table(s) and column(s).
  10. Click "Step 3"
  11. Select the Measures from the available table columns Selecting the measure(s).
  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" Saving the semantic layer view.

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.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect AI today!

Ready to get started?

Learn more about CData Connect AI or sign up for free trial access:

Free Trial