AgentPanel Lightning Component

Salesforce Ecommerce Service & Support Workplace Developer System Administrator Product Documentation

Pro and Enterprise editions only

Coveo for Salesforce 3 (May 2018)

The AgentPanel component allows you to 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.

LightningInsightPanel

Usage

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}" />
</aura:component>

The recordId and sObjectName options on the AgentPanel component are needed so the panel can return results related to the currently viewed record. While removing them will still create a functional search page, it won’t be able to return contextually relevant information.

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:

ErrorEvent

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

Options

This component offers the following options:

name

The name of the Visualforce component that should act as your search interface for your Coveo Insight Panel Lightning Component.

Default value is coveoLightningInsightPanel.

searchHub

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.

title

The title to show at the top of the component.

Default value is Search.

recordFields

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

The field name syntax should be constructed as such:

YourSalesforceObjectName_YourSalesforceFieldApiName

Default value is Case_Subject, Case_Description.

openResultsInSubTab

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

Default value is false.

fullSearchComponent

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 (e.g., c__myComponentName).

  • In Coveo for Salesforce versions 3.10 and 3.13, the name should follow the myNamespacePrefix:myComponentName format.

debug

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

Default value is false.