How to Query Sage X3 Cloud Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Sage X3 Cloud to query Sage X3 Cloud data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Sage X3 Cloud data in MySQL Workbench.

Connect to Sage X3 Cloud Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Sage X3 Cloud data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Sage X3 Cloud from MySQL Workbench

The steps below outline connecting to the virtual Sage X3 Cloud database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Sage X3 Cloud data.

Connect to Sage X3 Cloud through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Sage X3 Cloud).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Sage X3 Cloud Data

1. Open the connection you just created (CData SQL Gateway for Sage X3 Cloud).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Sage X3 Cloud data, like SELECT * FROM `CData SageX3Cloud Sys`.BPCUSTOMER;

With access to live Sage X3 Cloud data from MySQL Workbench, you can easily work with Sage X3 Cloud, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Sage X3 Cloud and the CData SQL Gateway.