Integrating Coveo Components in a Lightning Community

Coveo for Salesforce comes with multiple Lightning components which can be easily added to your community. This page shows you how to add the default Coveo Lightning components to your community using the Salesforce Experience Builder.

You should always duplicate Coveo components instead of using the default ones. This keeps the original component configurations intact for reference and re-use (see Integrating Coveo Components in a Custom Lightning Component).

Prerequisites

Adding the Coveo Community Search Component

The Coveo Community Search component lets you insert a complete search results page in your Lightning community, including features such as facets, tabs, sorting, and pagination.

communitysearch

To add the Coveo Community Search component

  1. Access the Salesforce Experience Builder.

  2. In the left sidebar, select Components.

    components
  3. In the Components dialog, under Custom Components, drag the Coveo Community Search component and drop it onto the page region where you want the search interface to appear, typically in the Content section.

  4. When you create a Community Search component for the first time, the Interface Creator (This search page isn’t configured yet.) dialog is displayed:

    1. Click Preview in the upper-right corner of the Experience Builder to switch to preview mode.

      In a newly created community, you must either publish your community and create or edit your search page via the published community URL, or to continue in Preview mode, you must add the following Content Security Policy (CSP) Trusted Sites (see Content Security Policy Overview):

      After adding these sites, you must refresh the page to use the Interface Creator. You should also set the CSP security to Allow Inline Scripts and Script Access to Any Third-Party Host.

    2. In the Coveo Search component region, click Set up a Search Page.

    3. Follow the onscreen steps, and then click Create page.

      If an error message appears after clicking Create page, you must add missing Content Security Policy Trusted Sites to your Salesforce organization.

      You should now have a functional search page connected to the Salesforce search box, returning results from your Coveo organization index. You can also test your search page at this time.

  5. When you’re satisfied with your search page, in the upper-right corner of the Experience Builder, click Publish to make your changes available to your community users (see Publish Your Experience Builder Site Customizations).

    Be aware that publishing Interface Editor changes immediately affects your community page in production.

  6. Make sure that the appropriate users are members of your community so that they can see your search page (see Add Members to Your Experience Cloud Site).

You can use the Coveo Community Searchbox component to add a standalone search box to your Salesforce Lightning Community. The standalone search box offers advanced features such as Coveo Machine Learning (Coveo ML) Query Suggestions (QS), typo correction, and facet value suggestions.

searchbox

To add the Coveo Community Searchbox component

  1. Access the Salesforce Experience Builder.

  2. In the left sidebar, select Theme > Theme Settings.

    communitysettings
  3. Under Search Component, in the drop-down menu, select Coveo Community Searchbox.

    If you don’t see the Coveo Community Searchbox option, you may not be using the right template. Ensure that your Theme is set to Customer Service.

    If you’re using a previous version of the Coveo for Salesforce package, the component name will be Searchbox (before v2.51) and Coveo Searchbox (before v3.25).

  4. Close the Theme Settings menu.

Your search page now uses the Coveo standalone search box.

Additional Considerations

  • Ensure that the value for the Search Url option is set to global-search/%40uri (see Customizing the Standalone Search Box).

  • When you have the default Headline component from Salesforce integrated into your community search page, you won’t notice that it always shows the query is @uri. You’re encouraged to remove this component, as it’s incompatible with the standalone search box.

    resultforuri
  • With your current configuration, both the standalone search box and the search component are injecting their query to the search component. If you prefer to only inject the relevant query, you can disable the Auto inject basic query setting of your search component.

  • The Coveo standalone search box doesn’t support community branding. However, using custom CSS to override the template elements should still work as expected.

You can now use the options panel to customize your Coveo standalone search box.

Adding the Coveo Page View Tracker Component

The Coveo Page View Tracker component can be added to your Lightning community to send usage analytics data to the Coveo Cloud. The data gathered by the component can later be used to recommend pages to your users using an Event Recommendations model.

To add the Coveo Page View Tracker component

  1. Access the Salesforce Experience Builder.

  2. In the left sidebar, select Components.

    components
  3. Under Custom Components, drag and drop the Coveo Page View Tracker component in the header of your page.

    We recommend adding the Coveo Page View Tracker on every page of your community to ensure that all of your page views are recorded.

Adding the Coveo Case Deflection Component

You can add the Coveo Case Deflection component to your Lightning Community to provide recommended solutions to users before they submit a case to your support agents (see Integrating a Coveo Case Deflection Component in a Lightning Community).

Adding Missing Content Security Policy Trusted Sites

Following changes in the Salesforce framing policies, you may need to manually add URIs to your Content Security Policy (CSP) Trusted Sites to access the Interface Creator and Interface Editor.

To know which URIs to add to your CSP trusted sites

  1. In the Can’t Access Resources error message that appears after clicking Create page in the Interface Creator, copy the URI address displayed next to Blocked URI, and then add the URI to your CSP Trusted Sites.

    CPS-error-message
  2. Back in the Preview mode of the Experience Builder, open your browser developer tools, and then access the Console tab.

  3. In the Coveo Search component region, click Set up a Search Page, and then follow the onscreen steps.

  4. Click Create page and then, in the Console tab of your browser developer tools, you should see an error message.

  5. In the error message, copy the last URI that appears (the one displayed in red), and then add the URI to your CSP Trusted Sites.

    CPS-error-message-console

    After adding these sites, you must refresh the page to use the Interface Creator.

What’s Next?

Recommended Articles