Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From Sage X3 Cloud connection/s to launch the CData Query window. To setup a new connection, you will have to click the New Sage X3 Cloud Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Authenticating to Sage X3 Cloud

Sage X3 Cloud uses OAuth 2.0 Client Credentials flow for authentication. An X-API-Key is also required for API access. Set AuthScheme to OAuth.

Setting Up Authentication

To authenticate, specify these connection properties:

OAuthAccessTokenUrl: The OAuth token endpoint (for example, 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.
URL: The base URL of your Sage X3 Cloud instance.
Folder: The Sage X3 folder name (for example, SEED). This folder is used as the default schema.
Folders: An optional comma-separated list of Sage X3 folders (for example, SEED,PERF). Each folder is exposed as a separate schema, allowing you to query tables across multiple folders using the Schema.Table syntax. When this property is not set, only the folder specified in Folder is available.

The add-in automatically obtains an access token using the Client Credentials flow and includes it with the X-API-Key in all API requests. Set InitiateOAuth to GETANDREFRESH (the default) to have the add-in handle token acquisition and refresh automatically.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to Sage X3 Cloud you will be able to customize the data you are importing. To learn more about this, see Managing Connections.