Edit and Search External JSON Objects in Salesforce Connect

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

Connect to JSON from Salesforce

To work with live JSON services in Salesforce Connect, 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 Salesforce Connect

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 Salesforce Connect.

Connect to JSON Services as an External Data Sources

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

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 AI: https://cloud.cdata.com/api/odata/{workspace_name}
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 AI, 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 AI username (e.g. [email protected]).
   • Password: Enter the user's PAT.

Synchronize JSON Objects

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

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

Access JSON Services as Salesforce Objects

After adding JSON services as an external data source and syncing JSON tables as external objects, you can use the external JSON 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 JSON objects from the Salesforce dashboard:

  

Simplified Access to JSON Services from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to live JSON services 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 AI page.