Establishing a Connection
Enabling SSIS in Visual Studio 2022
If you're using Visual Studio 2022, you will need to install the SQL Server Integration Services Projects extension to use SSIS.
- Navigate to Extensions > Manage Extensions.
- In the Manage Extensions window's search box, search for "SQL Server Integration Services Projects 2022" and select the extension in the list.
- Click Download.
- Close Visual Studio and run the downloaded Microsoft.DataTools.IntegrationServices.exe installer. Proceed through the installer with default settings.
- Open Visual Studio. There should now be an "Integration Services Project" project template available.
Adding the Sage X3 Cloud Connection Manager
Create a new connection manager as follows:
- Create a Visual Studio project with the "Integration Services Project" template.
- In the project, right-click within the Connection Managers window and select New Connection from the menu.
- In the Description column, select CData Sage X3 Cloud Connection Manager and click Add...
- Configure the component as described in the next section.
Alternatively, if you have an existing project and CData Sage X3 Cloud Source or CData Sage X3 Cloud Destination:
- Right-click your CData Sage X3 Cloud source or destination component in your data flow
- Select Edit... to open an editor window.
- Click the New... button next to the Connection manager: dropdown selector to create a connection manager.
- Configure the component as described in the next section.
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 component 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 component handle token acquisition and refresh automatically.