How to integrate Metabase with Sage X3 Cloud Data

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Connect AI to connect to live Sage X3 Cloud data and create an interactive dashboard in Metabase from Sage X3 Cloud data.

Metabase is an open source data visualization tool that allows users to create interactive dashboards. When paired with CData Connect AI, users can easily create visualizations and dashboards linked to live Sage X3 Cloud data. This article describes how to connect to Sage X3 Cloud and build a simple visualization using Sage X3 Cloud data.

CData Connect provides a pure cloud-to-cloud interface for Sage X3 Cloud, allowing you to easily integrate with live Sage X3 Cloud data in Metabase — without replicating the data. Connect looks exactly like a SQL Server database to Metabase and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to Sage X3 Cloud, leveraging server-side processing to quickly return Sage X3 Cloud data.

Configure Sage X3 Cloud Connectivity for Metabase

Connectivity to Sage X3 Cloud from Metabase is made possible through CData Connect AI. To work with Sage X3 Cloud data from Metabase, 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
  2. Select "Sage X3 Cloud" from the Add Connection panel
    3. Selecting a data source
  3. 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)
  4. Click Save & Test
  5. 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 from Metabase.

Connect to CData Connect AI from Metabase

After creating the connection in Connect AI, navigate to your Metabase instance. Use the SQL Server interface to connect to Connect AI.

  1. Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab Adding a new database connection to Metabase.
  2. Configure the connection to Connect AI and click "Save"
    • Database type: Select "SQL Server"
    • Name: Name the connection (e.g. "Sage X3 Cloud (Connect AI)")
    • Host: tds.cdata.com
    • Port: 14333
    • Database name: The name of the connection you just created (e.g. SageX3Cloud1)
    • Username: A Connect AI username (e.g. [email protected])
    • Password: The PAT previously created
    • Click to Use a secure connection (SSL)
    Configuring the connection to Connect AI.

Execute Sage X3 Cloud Data with Metabase

Once you configure the connection to Connect AI, you can query Sage X3 Cloud and build visualizations.

  1. Use the "Write SQL" tool to retrieve the Sage X3 Cloud data Click the
  2. Write a SQL query based on the Sage X3 Cloud connection in CData Connect AI, e.g. 

    SELECT BPCNUM, BPCNAM FROM BPCUSTOMER WHERE BPCNUM = 'MARTIN'
    Collected data (Salesforce is shown).
  3. Navigate to the "Visualization" screen, choose a visualization, and configure the visualization Collected data (Salesforce is shown).

More Information & Free Trial

At this point, you have built a simple visualization from Sage X3 Cloud data in Metabase. You can continue to work with live Sage X3 Cloud data in Metabase just like you would any SQL Server database. For more information on creating a live connection to Sage X3 Cloud (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live Sage X3 Cloud data in Metabase today.

Ready to get started?

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

Free Trial

In this article

Related articles