About the architecture

This is for:

Developer System Administrator
Coveo for Salesforce Pro and Enterprise architecture diagram

This diagram illustrates the architecture of the Coveo for Salesforce Pro and Enterprise solutions:

  1. The Coveo for Salesforce integration is installed in your Salesforce organization. It comes with Coveo components, the Coveo JavaScript Search Framework, and the Coveo Interface Editor.

  2. The integration connects to your Coveo organization, which hosts the Coveo index, the Coveo Search API, and Coveo Machine Learning (Coveo ML).

    The Coveo organization also hosts the usage analytics data coming from the Coveo components in your Salesforce organization. You can view this data in the Coveo Administration Console.

  3. When a user accesses a Coveo component, the Coveo for Salesforce integration issues an authentication request (that is, a secret key and a user ID) to the Coveo Search API. In turn, the Coveo Search API generates a search token for the authenticated user. For more information, see Search Token Authentication.

  4. When indexing Salesforce data, the following actions take place:

    1. The Salesforce connector initiates the crawling of the Salesforce objects through an account with the Modify Metadata Through Metadata API Functions and Manage Sharing permissions (see Creating a dedicated Salesforce crawling user).

    2. The Salesforce connector sends API requests to your Salesforce organization, using SOQL queries and other APIs, and indexes the returned records inside the Coveo index.

  5. When a query is performed in one of the Coveo components, the following actions take place:

    1. A query is sent from a Coveo component, inside your Salesforce organization, to the Coveo Search API in the Coveo organization.

    2. The Coveo Search API validates the search token, authorizes it, and sends the query through a query pipeline to modify and enhance the query. The modified query is then sent to the Coveo index to find the relevant results from your Salesforce records and external content.

    3. The Coveo index returns the results to the Coveo Search API, which takes input from Coveo ML to organize the results in order of relevance.

    4. The Coveo Search API returns the ordered results to the Coveo component in your Salesforce organization, which displays them to the user.

  6. In the meantime, the Coveo component sends user behavior information such as search queries and page views through the Coveo Usage Analytics (Coveo UA) Write API.

    Note

    Analytics dashboards can be used to view the usage analytics data in your Coveo organization.

  7. Coveo ML continually learns from usage analytics data and deducts user behavior patterns, allowing it to return more relevant results with every interaction (see Overview).