Sage Business Cloud X3 Source Connector

The Sage Business Cloud X3 source connector lets DataSync retrieve data from your X3 Cloud ERP through its REST API layer. It provides authenticated access to the API endpoints exposed by your X3 environment, allowing DataSync to read business objects and representations. This connector is available exclusively for Sage Business Cloud X3 and does not support on‑premises X3 installations.

Once your source connection is ready, configure your destination connection to finish the setup.

Step 1: Locate your BI Sync API details

1. Log in to your Partner Portal.
2. In the deployment list, select your deployment.
3. Select the BI integrations tab.
4. Copy the BI Sync API URL and BI Sync API key and store them securely. You will need both when creating your source connection.

Step 2: Create the source connection in DataSync

1. Log in to DataSync.
2. From the welcome screen, select Connections.
3. Next to Source Connections, click New.
4. Select Sage X3 (Cloud).
5. Enter all required connection properties.
6. (Optional) In the Additional Connection Properties panel, click Add property and enter any extra parameters you need.
7. Configure the advanced settings to match your environment, including Tracking Type.
8. Click Save.

Connection properties

Property	What to enter
Description	Unique name for the connection. Example: Sage X3 Cloud.
Tenant URI	Base URL of the X3 deployment. Matches the BI Sync API URL. Example: https://subdomain.dev-sagex3.com.
Sync Route	API route exposed by your X3 environment. Example: syncapi.
Tenant Folder	API folder to expose. Derived from the last segment of the BI Sync API URL, with the specific folder appended. Example: SEED.
Tenant API Key	BI Sync API key associated with your X3 instance. Each instance uses a single key shared across all folders.
Page Size	Number of records returned per API call during paging. Higher values return more data per page but may increase timeout risk. Default: 1000.
Verbosity	Controls how much detail the connector writes to the log. Each level includes everything from the level below it, plus additional detail. 1 logs queries, row counts, execution start and end times, and errors. 2 adds cache queries and HTTP headers. 3 adds request and response bodies. 4 adds transport-level communication. 5 adds all interface commands.

Additional connection properties

Use this panel to enter connection string properties not available in the Connection Properties panel. For sensitive values such as passwords, set the type to Encrypted. The value is hidden in the interface and stored encrypted in the back end.

The ConverDateTimeToGMT property is added automatically when you create a new Sage Business Cloud X3 source connection.

Property	What to enter
ConverDateTimeToGMT	Automatically set to True. Converts all DateTime values to GMT.

Advanced settings

These settings control how the connector tracks data changes, handles time and regional configuration, and processes records during extraction. Configure them to match your Sage Business Cloud X3 environment so that results stay accurate and consistent.

Setting	What to select
Tracking Type	Method for tracking data changes: None or Date.
Region	Region setting for the connector, if required by your setup.
Time Zone	Time zone matching your Sage Business Cloud X3 environment.
Time Offset	Refresh offset in seconds to compensate for timing issues in record selection. Minimum 0, maximum 3600.
Batch Size	Number of records processed per batch during extraction. Larger batches can improve performance but use more memory. Default is 2000, maximum is 10000. Adjust based on your network speed and disk performance. The default works well in most cases.

Example setup

Completed Sage Business Cloud X3 source connection in DataSync, with all properties and settings filled in.