UserActions component (for Lightning components)

This is for:

Developer System Administrator
In this article

Coveo for Salesforce 3.38 (August 2019)

User Actions are part of the Coveo Insight Panel Lightning Component by default in Coveo for Salesforce (v4.6) and later releases. If you implemented your Coveo Insight Panel Lightning Component before v4.6, we highly recommend upgrading to the new design to activate the new experience.

In addition, improvements to the Session Summary and User Activity Timeline are now available in Coveo for Salesforce (v4.23).

The UserActions component for Lightning components allows your agents to see, within the Salesforce Lightning console, up to 400 actions in the last 60 days performed by the end user across any Coveo page or component. The agent can see the events performed by the user across many visit sessions, including during the visit in which the case was created, as seen from the Visit Browser page of the Coveo Administration Console (see Review user visits with the Visit Browser).

This component is available for the Coveo Insight Panel Lightning Component, as well as the Full Search page.

It’s composed of the ClickedDocumentList Component, the QueryList Component, and the UserActivity Component.

In Health Insurance Portability and Accountability Act (HIPAA) environments, the UserActions component may display Personal Health Information (PHI), per normal usage. However, no data is stored in Salesforce. The data that’s returned by the UserActions component follows the same security rules as the Coveo Search component.

Options

userId

Identifies the user whose actions are to be displayed.

The userId must be a single value.

This option is required.

buttonLabel

Label of the button used to open the user actions.

The default value is User Actions.

<div data-button-label="<MY_LABEL>"></div>

Where you can replace <MY_LABEL> by the label you want for the button used to open the user actions.

summaryLabel

Label of the summary section

The default value is Session Summary.

<div data-summary-label="<MY_LABEL>"></div>

Where you can replace <MY_LABEL> by the label you want for the summary section.

activityLabel

Label of the activity section.

The default value is User Recent Activity.

<div data-activity-label="<MY_LABEL>"></div>

Where you can replace MY_LABEL by the label you want for the activity section.

viewedByCustomer

Whether to add the ViewByCustomer component.

The default value is true.

<div data-viewed-by-customer="true"></div>

hidden

Whether the UserAction component should be hidden.

If you want the ViewedByCustomer component to be visible but not the user actions, set data-hidden="true".

Default: false

<div data-hidden="false"></div>

Methods

hide

This method hides the panel.

show

This method shows the panel.

toggle

This method opens or closes the UserActions component, depending on its current state.

Usage

<div class="CoveoUserActions"></div>