UserActions component (for Visualforce components)

This is for:

Developer System Administrator
In this article

Coveo for Salesforce 2.3 (July 2015)

The UserActions component allows your agents to see the actions performed by the end user before or after the creation of a case within the Salesforce console. The component takes the information from the Coveo Usage Analytics (Coveo UA) events performed 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). You can configure which events the component displays.

The component typically appears in a tab of the Insight Panel, but can also be included as a standalone component in a Visualforce page (see Implementing the UserActions component).

The analytics transactions are processed at least at a 15-minute interval, or at a shorter time interval whenever a sufficient number of events to process are available. There may therefore be a delay of up to 15 minutes between the moment an event is performed and the time the event appears in the component. The delay however decreases as the rate of search events increases.

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.

Option

showButton

Specifies if the component should render a button to open/close itself.

The default value is false.

<div class="CoveoUserActions" data-show-button="false"></div>

enableBindOnBox

Specifies if the component should listen to the onPopupOpen event fired by the closest BoxPopup component to open itself.

The default value is true.

<div class="CoveoUserActions" data-enable-bind-on-box="true"></div>

filters

Specifies which events the UserActions component should display. You typically want to include only events that are manually performed by the end users, including appropriate custom events, and omitting the ones that are generated automatically by the components. They typically are the Click, Search, or Custom dimension causes (see About usage Analytics dimensions).

The default value is searchboxSubmit,documentOpen,documentQuickview,pageVisit,pageView,caseCreate.

<div class="CoveoUserActions" data-filters="<MY_EVENTS>"></div>

Where you can replace <MY_EVENTS> by the UserActions component that should be displayed.

Method

open

This method opens the UserActions component.

$('#myUserAction').coveo('open')

close

This method closes the UserActions component.

$('#myUserAction').coveo('close')

toggle

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

$('#myUserAction').coveo('toggle')

Usage

Adding the UserActions component as a Tab in the CoveoBox Panel

The UserActions component is typically included in the tab of a CoveoBox panel, as follows:

Sample

<div class="CoveoBoxPopup" data-title="User actions" data-full-width="true" data-full-height="true" data-icon="coveo-sprites-tab-people">
    <div class="CoveoUserActions"></div>
</div>

Adding the UserActions component as a Standalone Component

To make the UserActions component work as a standalone component, you need to add the UserActions Visualforce Component in your Visualforce page.

You also need to create a custom handler to open/close the component or you can use the showButton property.

Sample

<div class="CoveoUserActions" data-bind-on-box="false" data-show-button="true"></div>