Integrate Sage X3 Cloud with External Services using SnapLogic

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData JDBC drivers in SnapLogic to integrate Sage X3 Cloud with External Services.

SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including Sage X3 Cloud, in their SnapLogic workflows.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Sage X3 Cloud data. When platforms issue complex SQL queries to Sage X3 Cloud, the driver pushes supported SQL operations, like filters and aggregations, directly to Sage X3 Cloud and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with Sage X3 Cloud data using native data types.

Connect to Sage X3 Cloud in SnapLogic

To connect to Sage X3 Cloud data in SnapLogic, download and install the CData Sage X3 Cloud JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData JDBC Driver for Sage X3 Cloud/lib by default).

Upload the Sage X3 Cloud JDBC Driver

After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.

Uploaded JDBC Driver (Salesforce & QuickBooks Online are shown)

Configure the Connection

Once the JDBC Driver is uploaded, we can create the connection to Sage X3 Cloud.

  1. Navigate to the Designer tab
  2. Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer Adding a Generic JDBC snap onto the designer
  3. Click Add Account (or select an existing one) and click "Continue"
  4. In the next form, configure the JDBC connection properties:
    • Under JDBC JARs, add the JAR file we previously uploaded
    • Set JDBC Driver Class to cdata.jdbc.sagex3cloud.SageX3CloudDriver
    • Set JDBC URL to a JDBC connection string for the Sage X3 Cloud JDBC Driver, for example:

      jdbc:sagex3cloud:AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;RTK=XXXXXX;

      NOTE: RTK is a trial or full key. Contact our Support team for more information. Configuring a connection (Salesforce is shown)

      Built-In Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Sage X3 Cloud JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.sagex3cloud.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      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.

      Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  5. After entering the connection properties, click "Validate" and "Apply"

Read Sage X3 Cloud Data

In the form that opens after validating and applying the connection, configure your query.

  • Set Schema name to "SageX3Cloud"
  • Set Table name to a table for Sage X3 Cloud using the schema name, for example: "SageX3Cloud"."BPCUSTOMER" (use the drop-down to see the full list of available tables)
  • Add Output fields for each item you wish to work with from the table
Configuring a Select snap (Salesforce is shown)

Save the Generic JDBC - Select snap.

With connection and query configured, click the end of the snap to preview the data (highlighted below).

Click the end of the snap to preview the data.

Once you confirm the results are what you expect, you can add additional snaps to funnel your Sage X3 Cloud data to another endpoint.

Previewing data (Salesforce is shown).

Piping Sage X3 Cloud Data to External Services

For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.

  1. Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
  2. Add an account to connect to Google Sheets Connecting to Google
  3. Configure the Worksheet Writer snap to write your Sage X3 Cloud data to a Google Spreadsheet Writing to a Google Spreadsheet

You can now execute the fully configured pipeline to extract data from Sage X3 Cloud and push it into a Google Spreadsheet.

Data written to Google Spreadsheets (Salesforce is shown)

More Information & Free Trial

Using the CData JDBC Driver for Sage X3 Cloud you can create a pipeline in SnapLogic for integrating Sage X3 Cloud data with external services. For more information about connecting to Sage X3 Cloud, check at our CData JDBC Driver for Sage X3 Cloud page. Download a free, 30 day trial of the CData JDBC Driver for Sage X3 Cloud and get started today.

Ready to get started?

Download a free trial of the Sage X3 Cloud Driver to get started:

 Download Now

Learn more:

Sage X3 Cloud Icon Sage X3 Cloud JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Sage X3 Cloud.