InsightQuerySummary component

This is for:

Developer System Administrator

In this article

Options
Methods
Usage

Available since

This feature was introduced in the June 2020 release of Coveo for Salesforce version 4.4.

The InsightQuerySummary component is intended to be used in Coveo Insight Panels where a contextual query is performed by default. In such case, a message is displayed to help the user understand why those results are relevant.

Once the user performs a query, the message is replaced with the QuerySummary component.

Note

The InsightQuerySummary component is enabled by default in Coveo for Salesforce package version 4.4 and above.

Options

`title`

Specifies the message displayed by default. Once the user performs a query, the message is replaced with the QuerySummary component.

The default value is Insights related to this record.

<div class='CoveoInsightQuerySummary' data-title='Insights related to this record'></div>

Methods

This component doesn’t provide any methods.

Usage

This component is meant to be used inside the coveo-summary-section of the search interface.

<div class='CoveoInsightQuerySummary'></div>

Using QuerySummary instead of InsightQuerySummary

To pass specific options to the underlying QuerySummary component, modify the Insight Panel as follows:

Edit your Insight Panel search interface in code view.

Locate the InsightQuerySummary component.

<div class="coveo-summary-section">
  <div class="CoveoInsightQuerySummary"></div>
</div>

Replace it with the QuerySummary component.

<div class="coveo-summary-section">
  <div class="CoveoQuerySummary"></div>
</div>

Passing options to underlying QuerySummary component

To keep using the InsightQuerySummary, set the options using JavaScript as follows:

const root = document.getElementById('search');
Coveo.options(root, {
  QuerySummary: {
    enableSearchTips: false
  }
});

Note

For a Lightning component, you’ll need to create a Lightning wrapper component. See SearchUI.setSearchInterfaceOptions.