Connect to JSON Services 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 JSON and can be used to generate an OData API (natively supported in RunMyProcess) for JSON. 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 JSON services.

In this article, we walk through connecting to JSON from CData Connect AI and accessing JSON services through an OData feed in RunMyProcess.

Connect to JSON from RunMyProcess

To work with live JSON services in RunMyProcess, we need to connect to JSON from Connect AI, provide user access to the connection, and create a Workspace for the JSON services.

Connect to JSON 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 "JSON" from the Add Connection panel

3. Enter the necessary authentication properties to connect to JSON.

   See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models JSON APIs as bidirectional database tables and JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

   After setting the URI and providing any authentication values, set DataModel to more closely match the data representation to the structure of your data.

   The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

   • Document (default): Model a top-level, document view of your JSON data. The data provider returns nested elements as aggregates of data.
   • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
   • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

   See the Modeling JSON Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add JSON 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 JSON Endpoints for RunMyProcess

After connecting to JSON, 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 JSON connection (e.g. JSON1) 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 JSON services from RunMyProcess.

Retrieve JSON Services from RunMyProcess DigitalSuite Studio

With the connection to JSON and OData endpoints created, we are ready to add JSON services 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 JSON Services 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 JSON services. For more information on creating OData feeds from JSON (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live JSON services in RunMyProcess.