Connect to Sage X3 Cloud Data in RunMyProcess through Connect AI

Akorbi Digital RunMyProcess makes it easy to create applications for complex business applications, such as budget application and contract management. CData Connect AI creates a live connection to Sage X3 Cloud and can be used to generate an OData API (natively supported in RunMyProcess) for Sage X3 Cloud. By pairing RunMyProcess with CData Connect AI, you get true cloud-to-cloud connectivity to all your SaaS and cloud-based Big Data and NoSQL sources - no need to migrate your data or write your own integrations. Simply connect to Connect AI from RunMyProcess as you would any other REST service and get instant, live access to your Sage X3 Cloud data.

In this article, we walk through connecting to Sage X3 Cloud from CData Connect AI and accessing Sage X3 Cloud data through an OData feed in RunMyProcess.

Connect to Sage X3 Cloud from RunMyProcess

To work with live Sage X3 Cloud data in RunMyProcess, 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. Select "Sage X3 Cloud" from the Add Connection panel

3. 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.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Sage X3 Cloud Connection page and update the User-based 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.
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 RunMyProcess

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).
2. Click Add to add new assets to the Workspace.
3. Select the Sage X3 Cloud connection (e.g. SageX3Cloud1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
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 RunMyProcess.

Retrieve Sage X3 Cloud Data from RunMyProcess DigitalSuite Studio

With the connection to Sage X3 Cloud and OData endpoints created, we are ready to add Sage X3 Cloud data to RunMyProcess for Retrieval.

Create a Provider

1. Log into RunMyProcess and open DigitalSuite Studio.
2. Click Resources to bring up the Resources page, then select then the CONNECTORS tab.
3. Click the + (New Provider) button to create a new provider, choose the account to use, then click Confirm.
4. In the provider settings page, configure the following properties.
   • URL: Set the OData endpoint in the Connect AI OData page: https://cloud.cdata.com/api/odata/{workspace_name}.
   • Authentication Schema: Select Login/Password.
   • Login: Specify a CData Connect AI username (e.g. [email protected]).
   • Password: Specify the PAT of the Connect AI user.
   
5. Fill in the same properties in the ACCEPTANCE and TEST tabs. Note: You can copy the configured settings by clicking 'Copy this configuration button,' then pasting the content in the new tab by clicking 'Paste previously copied configuration.'
6. Click Save to save the properties.

Retrieve Sage X3 Cloud Data by Creating a Connector

1. In the CONNECTORS tab, click the button with three dots to create the provider, then select Add connector from the menu.
2. In the following page, set Connector URL to the OData endpoint configured in Connect AI (e.g. https://cloud.cdata.com/api/odata/{workspace_name})
3. Click Save then Launch to test the connector execution. Click Launch test to execute. The process is successful if you get the JSON response of your configured table information.

More Information & Free Trial

Now, you have created a provider and connector to retrieve Sage X3 Cloud data. For more information on creating OData feeds from Sage X3 Cloud (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live Sage X3 Cloud data in RunMyProcess.