Edit and Search External Elasticsearch Objects in Salesforce Connect

CData Connect AI, enables you to access Elasticsearch 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 AI and Salesforce Connect to access external Elasticsearch objects alongside standard Salesforce objects.

Getting Started

---

Connect to Elasticsearch from Salesforce

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

Connect to Elasticsearch 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
👁 Adding a Connection

2. Select "Elasticsearch" from the Add Connection panel
👁 Selecting a data source

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

   Set the Server and Port connection properties to connect. To authenticate, set the User and Password properties, PKI (public key infrastructure) properties, or both. To use PKI, set the SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword properties.

   The data provider uses X-Pack Security for TLS/SSL and authentication. To connect over TLS/SSL, prefix the Server value with 'https://'. Note: TLS/SSL and client authentication must be enabled on X-Pack to use PKI.

   Once the data provider is connected, X-Pack will then perform user authentication and grant role permissions based on the realms you have configured.

   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Elasticsearch Connection page and update the User-based permissions. 👁 Updating 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. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure Elasticsearch Endpoints for Salesforce Connect

After connecting to Elasticsearch, 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). 👁 The Workspaces page.
   👁 Adding a new Workspace.
   
2. Click Add to add new assets to the Workspace.
3. Select the Elasticsearch connection (e.g. Elasticsearch1) and click Next. 👁 Selecting an Asset (Salesforce is shown).
   
4. Select the table(s) you wish to work with and click Confirm. 👁 Selecting Tables (Salesforce is shown).
   
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 Elasticsearch data from Salesforce Connect.

Connect to Elasticsearch Data 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.

👁 Configuration settings for the data source (NetSuite is shown)

Synchronize Elasticsearch Objects

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

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

👁 Select external objects (NetSuite is shown)

Access Elasticsearch Data as Salesforce Objects

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

• Create a new tab with a filter list view:

  👁 Viewing external objects from Salesforce (NetSuite is shown)
  

• Create reports of external objects:

  👁 Reporting on external objects from Salesforce (NetSuite is shown)
  

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

  👁 Editing external objects from Salesforce (NetSuite is shown)
  

Simplified Access to Elasticsearch Data from Cloud Applications

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