---
title: AgentPanel Lightning component
slug: '1109'
canonical_url: https://docs.coveo.com/en/1109/
collection: coveo-for-salesforce
source_format: adoc
---
# AgentPanel Lightning component

[.version.c4sf.c4sf-edition.c4sf-pro-enterprise]
[Pro and Enterprise editions](https://docs.coveo.com/en/l2590456#salesforce)


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.

![Example of a Coveo Insight Panel Lightning component interface | Coveo for Salesforce](https://docs.coveo.com/en/assets/images/coveo-for-salesforce/lightning-insight-panel.png)

## Usage

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

```xml
<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.

## Resources included with this component

This component includes the [Coveo JavaScript Search Framework](++https://github.com/coveo/search-ui++), the [jQuery](++https://jquery.com/++) (latest 3.x.x version) library, and the Coveo for Salesforce specific assets.

> **Note**
>
> Since Lightning Locker is automatically enabled on this component, the [underscore result templates](https://docs.coveo.com/en/413#using-the-underscore-engine) aren't supported.
> You must use [HTML templates](https://docs.coveo.com/en/413#using-the-html-engine-recommended) 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`

- **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`.

### `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 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.

> **Note**
>
> If you haven't registered a [namespace prefix](https://help.salesforce.com/articleView?id=register_namespace_prefix.htm&type=5) for your Salesforce organization, use the default namespace `c` (for example, `c__myComponentName`).

### `debug`

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

Default value is `false`.

### `customUserActionsExclude`

> **Available since**
>
> This feature was introduced in the March 2022 release of Coveo for Salesforce version [4.23](https://docs.coveo.com/en/3236#march-2022-release-v4-23).

An exclusion filter to hide custom actions (based on `type` or `value`) from the [User Activity Timeline](https://docs.coveo.com/en/3129#session-summary-and-user-activity-timeline).

Uses the format: `value1`, `value2`, `value3`.

Default value is `ticket_create_start`, `ticket_field_update`, `ticket_next_stage`, `ticket_classification_click`.