Connect to Sage X3 Cloud Data from HeidiSQL

HeidiSQL is an open-source database administration tool that natively supports MariaDB, MySQL, SQL Server, and PostgreSQL. When paired with CData Connect AI, HediSQL reach extends to include access to live Sage X3 Cloud data. This article demonstrates how to connect to Sage X3 Cloud using Connect AI and query Sage X3 Cloud data in HeidiSQL.

CData Connect AI provides a pure SQL Server interface for Sage X3 Cloud, allowing you to query data from Sage X3 Cloud without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to Sage X3 Cloud, leveraging server-side processing to return the requested Sage X3 Cloud data quickly.

Configure Sage X3 Cloud Connectivity for HeidiSQL

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

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "Sage X3 Cloud" from the Add Connection panel

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.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Sage X3 Cloud Connection page and update the User-based 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.
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 HeidiSQL.

Connect to Sage X3 Cloud from HeidiSQL using Connect AI

To establish a connection from HeidiSQL to the CData Connect AI Virtual SQL Server API, follow these steps.

Create a new HeidiSQL Session

1. In the Session Manager, select New in the bottom-left
2. Give the new session a descriptive name, e.g. Connect-Cloud-Sage X3 Cloud

Configure a SQL Server Connection to Connect AI

1. In the session settings, set the Network type to Microsoft SQL Server (TCP/IP)
2. The Library DLL should automatically update to MSOLEDBSQL
3. Set the Hostname/IP to tds.cdata.com
4. Set the User to your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected]
5. Set the Password to your PAT created in Connect AI in the previous section.
6. Set the Port to 14333

Query Sage X3 Cloud from HeidiSQL

1. In the database listing on the left, find your connection to Sage X3 Cloud configured earlier.
2. Expand this connection to view individual tables or data objects present within Sage X3 Cloud.
3. Write custom SQL queries targeting these tables, treating the data source like any SQL Server database, or visually explore each tabular data set by selecting the relevant tables

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!