Integrate with live Sage X3 Cloud Data in Jitterbit

Mohsin Turki
Mohsin Turki
Technical Marketing Engineer
Use CData Connect AI to connect to and integrate live Sage X3 Cloud data in Jitterbit.

Jitterbit is an enterprise iPaaS (integration platform as a service) that lets you streamline your data workflows. When paired with CData Connect AI, Jitterbit gets access to live Sage X3 Cloud data. This article demonstrates how to connect to Sage X3 Cloud using Connect AI and integrate with live Sage X3 Cloud data in Jitterbit.

CData Connect AI provides a pure OData interface for Sage X3 Cloud, allowing you to query data from Sage X3 Cloud without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to Sage X3 Cloud, leveraging server-side processing to return the requested Sage X3 Cloud data quickly.

Configure Sage X3 Cloud Connectivity for Jitterbit

To work with Sage X3 Cloud data from Jitterbit, we need to connect to Sage X3 Cloud from Connect AI, provide user access to the connection, and create a Workspace for the Sage X3 Cloud data.

Connect to Sage X3 Cloud from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. Adding a Connection
  3. Select "Sage X3 Cloud" from the Add Connection panel
  4. Selecting a data source
  5. Enter the necessary authentication properties to connect to Sage X3 Cloud.

    Sage X3 Cloud uses the OAuth 2.0 Client Credentials flow, and an X-API-Key is also required for API access. Set AuthScheme to OAuth and specify the following connection properties:

    • URL: The base URL of your Sage X3 Cloud instance.
    • OAuthAccessTokenUrl: The OAuth token endpoint (e.g., 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.
    • Folder: The Sage X3 folder name (e.g., SEED). This folder is used as the default schema.
    • Folders (optional): A comma-separated list of Sage X3 folders (e.g., SEED,PERF). Each folder is exposed as a separate schema, so you can query across folders with the Schema.Table syntax.

    The driver obtains an access token with the Client Credentials flow and sends it with the X-API-Key on every API request. With InitiateOAuth set to GETANDREFRESH (the default), the driver acquires and refreshes the token automatically.

    Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add Sage X3 Cloud Connection page and update the User-based permissions. Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure Sage X3 Cloud Endpoints for Jitterbit

After connecting to Sage X3 Cloud, create a workspace for your desired table(s).

  1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace). The Workspaces page. Adding a new Workspace.
  2. Click Add to add new assets to the Workspace.
  3. Select the Sage X3 Cloud connection (e.g. SageX3Cloud1) and click Next. Selecting an Asset (Salesforce is shown).
  4. Select the table(s) you wish to work with and click Confirm. Selecting Tables (Salesforce is shown).
  5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to Sage X3 Cloud data from Jitterbit.

Connect to Sage X3 Cloud from Jitterbit using Connect AI

To establish a connection from Jitterbit to CData Connect AI using the OData protocol, follow these steps.

  1. Log into Jitterbit.
  2. Create a project in Cloud Studio and provide a workspace environment for it. Creating a new project in Jitterbit.
  3. click Sources and enter OData in the search bar.
  4. Select the OData connector.
  5. Enter the OData connection properties.
    • Connection Name: enter a connection name.
    • OData Metadata URL: enter https://cloud.cdata.com/api/odata/{workspace_name}.
    • Authentication: select Basic Auth.
    • User Name: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
    • Password: enter the PAT you generated on the Settings page.
    Configuring connectivity to the Connect AI OData endpoint.
  6. Click Test to test the connection, and then click Save Changes.
  7. Choose the operation you want to perform and drag it to the workflow in your project. Selecting the operation for the workflow.
  8. Double-click the query operation to see all the tables and derived views available in your OData endpoint. Viewing the available endpoints.
  9. Select a table and configure the query.

You can now transform and integrate live Sage X3 Cloud data in Jitterbit.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from Jitterbit, try CData Connect AI today!

Ready to get started?

Learn more about CData Connect AI or sign up for free trial access:

Free Trial