Build Visualizations of Sage X3 Cloud Data in Birst

Birst is a cloud business intelligence (BI) tool and analytics platform that helps organizations quickly understand and optimize complex processes. When paired with the CData JDBC Driver for Sage X3 Cloud, you can connect to live Sage X3 Cloud data through the Birst Cloud Agent and build real-time visualizations. In this article, we walk you through, step-by-step, how to connect to Sage X3 Cloud using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC driver offers unmatched performance for live Sage X3 Cloud data operations in Birst. When you issue complex SQL queries from Birst 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). With built-in dynamic metadata querying, the JDBC driver enables you to visualize and analyze Sage X3 Cloud data using native Birst data types.

Configure a JDBC Connection to Sage X3 Cloud Data in Birst

Before creating the Birst project, you will need to install the Birst Cloud Agent (in order to work with the installed JDBC Driver). Also, copy the JAR file for the JDBC Driver (and the LIC file, if it exists) to the /drivers/ directory in the installation location for the Cloud Agent.

With the driver and Cloud Agent installed, you are ready to begin.

1. Create a new project in Birst.
2. Name the connection (e.g. CDataSageX3Cloud).
3. Choose Live Access.
4. Select an agent.
5. Set Database Type to Other.

6. Set SQL Type to MSSQL
7. Set the Connection string.

   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.

   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.

   

   When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   Below is a typical JDBC connection string for Sage X3 Cloud:

   
   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;
   
   

8. Set the Driver Name: cdata.jdbc.sagex3cloud.SageX3CloudDriver and click Save.

NOTE: Since authentication to Sage X3 Cloud is managed from the connection string, you can leave Security Credentials blank.

Configure Sage X3 Cloud Data Objects

Now that the connection is configured, we are ready to configure the schema for the dataset, choosing the tables, views, and columns we wish to visualize.

1. Select the Schema (e.g. SageX3Cloud).
2. Click on Tables and/or Views to connect to those entities and click Apply.
3. Select the Tables and Columns you want to access and click Done.

With the objects configured, you can perform any data preparation and discover any relationships in your data using the Pronto Prepare and Relate tools.

Build a Visualization

After you prepare your data and define relationships between the connected objects, you are ready to build your visualization.

1. Select the Visualizer tool from the menu.

2. Select Measures & Categories from your objects
3. Select and configure the appropriate visualization for the Measure(s) you selected.

Using the CData JDBC Driver for Sage X3 Cloud with the Cloud Agent and Birst, you can easily create robust visualizations and reports on Sage X3 Cloud data. Download a free, 30-day trial and start building Birst visualizations today.