Customize the Coveo Lightning Aura components used in your Experience Cloud site

This is for:

Developer System Administrator
In this article
Notes

  • The Coveo Community Search component is the Locker-compliant version of the Coveo Search component.

  • The Coveo Case Deflection component is the Locker-compliant version of the Coveo Case Creation component.

The Coveo components offer some customizable properties using the Salesforce Experience Builder.

In the following screenshot, you can see that when the Coveo component is selected, the property editor on the right lights up with a set of options available to use.

Property editor displaying component customization options in Salesforce | Coveo for Salesforce

Name

  • As of the Coveo for Salesforce v5 release

    The name of the Page Content record that contains the HTML code of your search interface.

  • Prior Coveo for Salesforce versions

    The name of the Visualforce component that contains the HTML code of your search interface.

    Tip
    Tip

    When you create a Coveo-powered search page, the HTML content of the page is saved in a Visualforce component. To find the component of the same name, in your Salesforce instance, go to Setup > Develop > Visualforce Components.

Default is communitySearchCoveo for CommunitySearch components and communityCaseDeflectionCoveo for CaseDeflection components.

Notes

  • If you have two different Coveo Search Lightning components on two different community pages, and both have the same Name property, then they will both load the same HTML content.

  • If you don’t set the Search Hub property, then the origin level 1 or the Page/Hub for your usage analytics reports will be the name of the search page.

Debug

This Boolean value tells the Lightning component to load the debug version of the different resources.

By default, this option is unselected.

Notes

In practice, this means:

  • When deselected, this loads the *.min (minified) versions of all JavaScript resources. The box shouldn’t be selected in production mode.

  • When selected, this will load the non minified versions of all JavaScript resources. This can be useful during development or for debugging purposes.

Search hub

This sets the analytics search hub to a different value then the default value.

This value is passed in the Origin 1 (Page/Hub) Usage Analytics dimension (see Usage analytics dimensions).

If not set, the value of the search hub will be that of the Name property of the Lightning component.