Using the Microsoft ODBC Data Source Administrator

You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the DSN is created during the installation process.

Complete the following steps to edit the DSN configuration:

1. Select Start > Search, and enter ODBC Data Sources in the Search box.
2. Choose the version of the ODBC Administrator that corresponds to the bitness of your application (32-bit or 64-bit).
3. Click the System DSN tab.
4. Select the system data source and click Configure.
5. Edit the information on the Connection tab and click OK.

Note: For .NET Framework 4.0, the driver distributes Microsoft Visual C++ 2015-2022 Redistributable. For .NET Framework 3.5, the driver distributes Microsoft Visual C++ 2008 Redistributable.

Ensuring Registry Access

The driver stores connection information in the Windows registry. To ensure that the driver can write to the registry, perform either of the following actions:

1. Run the calling application as an administrator.
2. Connect via a User DSN instead of a System DSN.

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 driver 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 driver handle token acquisition and refresh automatically.