AgentPanel Lightning component

The AgentPanel component lets you present relevant articles to your agents directly from the Lightning console, while they’re viewing a record.

It takes care of wrapping and including the correct scripts and different resource references needed to do so.



Reference it in your Lightning component as you would for any other Aura component, using the namespace prefix of the Coveo package.

<aura:component implements="force:hasRecordId,force:hasSObjectName,flexipage:availableForRecordHome" access="global">
  <CoveoV2:AgentPanel recordId="{!v.recordId}"
                      sObjectName="{!v.sObjectName}" />

The recordId and sObjectName options on the AgentPanel component are needed so the panel can return results related to the currently viewed record.

Resources included with this component

This component includes the Coveo JavaScript Search Framework, the jQuery (latest 3.x.x version) library, and the Coveo for Salesforce specific assets.


Since Lightning Locker is automatically enabled on this component, the underscore result templates aren’t supported. You must use HTML templates instead.

Aura event

This component offers the following event:


This error is fired when an error occurs with the component.


This component offers the following options:


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

Default value is coveoLightningInsightPanel.


The name of the search hub to enforce when authenticating a query with this search token, which can also be used in query pipeline condition statements.

This option should have the same value as name.


The title to show at the top of the component.

Default value is Search.


A comma-separated list of record fields values to send in the query context.

The field name syntax should be constructed as such:


Default value is Case_Subject, Case_Description.


Whether the results should open in a subtab when clicking them.

Default value is false.


The name of the component to open when clicking the Full Search button.

The name should follow the myNamespacePrefix__myComponentName format.

Leave this field blank to use the default search page.


If you haven’t registered a namespace prefix for your Salesforce organization, use the default namespace c (for example, c__myComponentName).


Whether to use the non-minified versions of the different resources.

Default value is false.


An exclusion filter to hide custom actions (based on type or value) from the User Activity Timeline.

Uses the format: value1, value2, value3.

Default value is ticket_create_start, ticket_field_update, ticket_next_stage, ticket_classification_click.