Connect to Cosmos DB Data in RunMyProcess through Connect Cloud

Akorbi Digital RunMyProcess makes it easy to create applications for complex business applications, such as budget application and contract management. CData Connect Cloud creates a live connection to Cosmos DB and can be used to generate an OData API (natively supported in RunMyProcess) for Cosmos DB. By pairing RunMyProcess with CData Connect Cloud, 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 Cloud from RunMyProcess as you would any other REST service and get instant, live access to your Cosmos DB data.

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

Connect to Cosmos DB from RunMyProcess

To work with live Cosmos DB data in RunMyProcess, we need to connect to Cosmos DB from Connect Cloud, provide user access to the connection, and create OData endpoints for the Cosmos DB data.

(Optional) Add a New Connect Cloud User

As needed, create Users to connect to Cosmos DB through Connect Cloud.

1. Navigate to the Users page and click Invite Users
2. Enter the new user's email address and click Send to invite the user
3. You can review and edit users from the Users page

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your 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.

Connect to Cosmos DB from Connect Cloud

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

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "Cosmos DB" from the Add Connection panel
3. Enter the necessary authentication properties to connect to Cosmos DB.

   To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

   • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
   • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.
4. Click Create & Test
5. Navigate to the Permissions tab in the Add Cosmos DB Connection page and update the User-based permissions.

Add Cosmos DB OData Endpoints in Connect Cloud

After connecting to Cosmos DB, create OData Endpoints for the desired table(s).

1. Navigate to the OData page and click Add to create new OData endpoints
2. Select the Cosmos DB connection (e.g. CosmosDB1) and click Next
3. Select the table(s) you wish to work with and click Confirm

Sample URLs for OData Feeds

Once you have configured a connection to Cosmos DB, created a user, and created OData endpoints in Connect Cloud, you can access OData feeds for Cosmos DB data. Below, you will see the URLs to access tables and the list of tables. For information on accessing the tables, you can navigate to the OData page for Connect Cloud. For the URLs, you will need the URL of Connect Cloud: https://cloud.cdata.com/api/odata/service.

As with standard OData feeds, if you wish to limit the fields returned, you can add a $select parameter to the query, along with other standard OData URL parameters, such as $filter, $orderby, $skip, and $top. See the help documentation for more information on supported OData queries.

With the connection and OData endpoints configured, you are ready to connect to Cosmos DB data from RunMyProcess.

Retrieve Cosmos DB Data from RunMyProcess DigitalSuite Studio

With the connection to Cosmos DB and OData endpoints created, we are ready to add Cosmos DB 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 Cloud OData page: https://cloud.cdata.com/api/odata/service.
   • Authentication Schema: Select Login/Password.
   • Login: Specify a CData Connect Cloud username (e.g. user@mydomain.com).
   • Password: Specify the PAT of the Connect Cloud 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 Cosmos DB 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 Cloud (e.g. https://cloud.cdata.com/api/odata/service)
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 Cosmos DB data. For more information on creating OData feeds from Cosmos DB (and more than 100 other data sources), visit the Connect Cloud page. Sign up for a free trial and start working with live Cosmos DB data in RunMyProcess.