Integrate a Coveo Community Search component

This is for:

Developer System Administrator

The Coveo Community Search component lets you integrate a Coveo Full Search page in your Experience Cloud site. The Coveo Full Search page provides a complete Coveo-powered search interface, which includes advanced features such as facets, tabs, sorting, and pagination.

Example of a Coveo Community Search interface
Tip
Leading practice

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

Add the Coveo Community Search component

  1. Access the Salesforce Experience Builder.

  2. In the left sidebar, select Components.

    Experience Builder Components menu in Salesforce

  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 add 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.

      Important
      Important

      In a newly created Experience Cloud site, you have two options to work with the search page. You can either publish the site and access the search page using the published site URL to create or edit it. Otherwise, if you prefer to continue working in Preview mode, you must first add the following Content Security Policy (CSP) trusted sites:

      After adding these sites, 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.

      Important
      Important

      If an error message appears after clicking Create page, add the 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 site users (see Publish Your Experience Builder Site Customizations).

    Important
    Important

    Be aware that publishing Interface Editor changes immediately affects your Experience Cloud site in production.

  6. Make sure that the appropriate users are members of your Experience Cloud site so that they can view your search page.

The Coveo standalone search box offers advanced features such as Coveo Machine Learning (Coveo ML) query suggestions, typo correction, and facet value suggestions.

Example of a Coveo standalone search box

To include a standalone search box in the header of your Experience Cloud site, you must add the Coveo Community Searchbox component.

Important

The Coveo Community Search component isn’t compatible with the Coveo Hosted Searchbox component. To complement your Full Search page with a standalone search box, you must use the Coveo Community Searchbox component.

To add the Coveo Community Searchbox component

  1. Access the Salesforce Experience Builder.

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

    Community Settings

  3. Under Search Component, in the dropdown menu, select Coveo Community Searchbox.

    Important
    Important

    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.
    Note

    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 includes a Coveo standalone search box.

Additional considerations

  • Modifying the default value of the enableHistory component option isn’t recommended. This option is automatically set to the correct value (true or false) based on the component you’re integrating. If you modify this value, the standalone search box may not work as expected.

  • Ensure that the value for the Search Url option is set to global-search/%40uri (see Customize the standalone search box).

  • When you have the default Headline component from Salesforce integrated into your Experience Cloud site, 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.

    Example of the Salesforce Headline component output

  • 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 site 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.

Add missing Content Security Policy trusted sites

Due to 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.

    Can’t Access Resources CSP error message displaying blocked URI in Salesforce

  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.

    Browser developer tools Console tab shows red URI in CSP error
    Note

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

What’s next?