Edit and Search External Cosmos DB Objects in Salesforce Connect

CData Connect Cloud, enables you to access Cosmos DB data from cloud-based applications like the Salesforce console and mobile applications like the Salesforce Mobile App. In this article, you will use CData Connect Cloud and Salesforce Connect to access external Cosmos DB objects alongside standard Salesforce objects.

Connect to Cosmos DB from Salesforce

To work with live Cosmos DB data in Salesforce Connect, 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

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

Connect to Cosmos DB Data as an External Data Sources

Follow the steps below to connect to the feed produced by Connect Cloud.

1. Log into Salesforce and click Setup -> Integrations -> External Data Sources.
2. Click Now External Data Sources.
3. Enter values for the following properties:
   • External Data Sources: Enter a label to be used in list views and reports.
   • Name: Enter a unique identifier.
   • Type: Select the option "Salesforce Connect: OData 4.0".
   • URL: Enter the URL to the OData endpoint of Connect Cloud: https://cloud.cdata.com/api/odata/service
4. Select the Writable External Objects option.
5. Select JSON in the Format menu.
6. In the Authentication section, set the following properties:
   • Identity Type: If all members of your organization will use the same credentials to access Connect Cloud, select "Named Principal". If the members of your organization will connect with their own credentials, select "Per User".
   • Authentication Protocol: Select Password Authentication to use basic authentication.
   • Certificate: Enter or browse to the certificate to be used to encrypt and authenticate communications from Salesforce to your server.
   • Username: Enter a CData Connect Cloud username (e.g. [email protected].
   • Password: Enter the user's PAT.

Synchronize Cosmos DB Objects

After you have created the external data source, follow the steps below to create Cosmos DB external objects that reflect any changes in the data source. You will synchronize the definitions for the Cosmos DB external objects with the definitions for Cosmos DB tables.

1. Click the link for the external data source you created.
2. Click Validate and Scan.
3. Select the Cosmos DB tables you want to work with as external objects.

Access Cosmos DB Data as Salesforce Objects

After adding Cosmos DB data as an external data source and syncing Cosmos DB tables as external objects, you can use the external Cosmos DB objects just as you would standard Salesforce objects.

• Create a new tab with a filter list view:

• Create reports of external objects:

• Create, update, and delete Cosmos DB objects from the Salesforce dashboard:

Simplified Access to Cosmos DB Data from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to live Cosmos DB data from Salesforce. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in cloud applications like Salesforce, refer to our Connect Cloud page.