Skip to main content

Sage X3 Cloud Source Connector

The Sage Business Cloud X3 source connector retrieves data from your X3 Cloud ERP through its REST API layer. It provides authenticated access to the API endpoints exposed by your X3 environment, enabling 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.

After creating all required source connections, configure your destination connection to finalize the setup.

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.

Create a 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. In the Connection Properties panel, enter the required connection properties.
  6. (Optional) In the Additional Connection Properties panel, click Add property and specify the relevant parameters.
  7. In the Advanced Settings panel, configure the advanced settings, including the Tracking Type and any other required values.
  8. Click Save.

Parameters​

Connection properties​

ParameterDescription
DescriptionUnique name for the connection. Example: Sage X3 Cloud
Tenant URIBase URL of the X3 deployment. Matches the BI Sync API URL.
Example: https://subdomain.dev-sagex3.com
Sync RouteAPI route exposed by your X3 environment. Example: syncapi
Tenant FolderAPI folder to expose. Derived from the last segment of the BI Sync API URL, with the specific folder appended. Example: SEED
Tenant API KeyBI Sync API key associated with your X3 instance. Each instance uses a single key shared across all folders.
Page sizeNumber of records returned per API call during paging. Higher values return more data per page but may increase timeout risk. Default: 1000
VerbosityLogging level that determines the amount of detail captured:

  • 1 – Log queries, row counts, execution start/end, errors.
  • 2 – Includes level 1 plus cache queries, HTTP headers.
  • 3 – Includes level 2 plus request/response bodies.
  • 4 – Includes level 3 plus transport-level communication.
  • 5 – Includes level 4 plus all interface commands.

Additional connection properties (optional)​

Additional connection‑string properties that are not included in the Connection Properties panel. For each property you add, you can choose whether it is Visible or Encrypted. Selecting Encrypted hides the value in the interface and stores it securely in the back end, which is recommended for sensitive information such as passwords.

PropertyValue
ConverDateTimeToGMTAutomatically set to True. Converts all DateTime values to GMT.

Advanced settings​

Advanced settings define how the Sage X3 Cloud connector tracks changes, manages regional and time‑related configuration, and processes data batches during extraction. These options allow you to fine‑tune performance and accuracy and should be adjusted according to your environment and operational requirements.

SettingDescription
Tracking TypeMethod used to track changes: None or Date.
RegionRegional configuration for the connector, if required by your deployment.
Time ZoneTime zone that matches the Sage X3 Cloud application server.
Time OffsetRefresh offset (in seconds) used to compensate for timing discrepancies during record selection. Minimum: 0; maximum: 3600.
Batch SizeNumber of records processed per batch during extraction. Larger batches increase memory usage but may improve performance up to a limit. Default: 2000; maximum recommended: 10000. Adjust this value according to network and disk performance; the default (2000) generally works best.