Adding the Insight Query Summary component

This is for:

Developer System Administrator

Coveo for Salesforce 4.4 (June 2020)

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

The Insight Query Summary component is intended to be used in Coveo Insight Panel Lightning components where a contextual query is performed by default.

When integrated in a Coveo Insight Panel Lightning Component, the Insight Query Summary component displays a message to help your agents understand why the suggested results are relevant to their current task.

If your agents perform a query in the search box, the Insight Query Summary falls back to the QuerySummary component.

When your support agents are browsing a Salesforce Case, the Insight Query Summary component displays the following message by default:

3253-InsightQuerySummary

Once they send a query, the message changes to display the QuerySummary:

3253-InsightQuerySummary

See InsightQuerySummary Component for the component’s complete reference documentation.

Adding the Insight Query Summary component in a Coveo Insight Panel Lightning Component

  1. Access the Interface Editor of the Coveo Insight Panel Lightning Component in which you want to add the Insight Query Summary component.

  2. Select the Code View tab.

  3. In the coveo-summary-section section, replace the CoveoQuerySummary and CoveoQueryDuration elements with the following:

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

    The coveo-summary-section section should now look like this:

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

  4. Click Save.

Customizing the Insight Query Summary component

When you integrate the Insight Query Summary component in a Coveo Insight Panel Lightning Component, the default message is: Insights related to this [CURRENT_SALESFORCE_RECORD].

Where [CURRENT_SALESFORCE_RECORD] is automatically replaced with the Salesforce record on which the Coveo Insight Panel Lightning Component is integrated.

You can, however, change the default message if needed:

  1. Access the Interface Editor of the Coveo Insight Panel Lightning Component in which you integrated an Insight Query Summary component.

  2. Select the Code View tab.

  3. Find the CoveoInsightQuerySummary element, and then add the following element:

    data-title='[MY_CUSTOM_MESSAGE]'

    Where you replace [MY_CUSTOM_MESSAGE] with the message you want the component to display by default.

    The CoveoInsightQuerySummary element should now look like this:

     <div class='CoveoInsightQuerySummary' data-title='[MY_CUSTOM_MESSAGE]'></div>

  4. Click Save.