Deploying Search Alerts on a Coveo JS Search Page

An administrator in Coveo Cloud V1 and in Salesforce must perform the steps described in this article before end users can take advantage of the search alert service.

To deploy search alerts on a search page

  1. Ensure your environment meets the following requirements:

    • The search page gets results from a Coveo Cloud V1 Organization.

      The search alerts service is powered by the Coveo Cloud Search API and isn’t available when search results come from an on-premises CES index.

    • Users must currently be authenticated on the search interface for the search alerts service to be supported.

      The service needs to know the user’s email address to which send notifications.

    • A Coveo for Salesforce search interface linked to a Coveo Cloud V1 Organization: Coveo for Salesforce 2.29 (September 2016)

  2. Contact Coveo Support to request the search alerts service activation for your Coveo Cloud V1 Organization.

    This step is needed because the Coveo Cloud search alerts service is currently in pilot version.

  3. In your Salesforce organization, add the Search Alerts components to your Coveo JS Search page:

    1. Log in to your Salesforce organization with an administrator account.

    2. Access your Coveo JS Search page:

      1. In the navigation bar on the left, under App Setup, click Develop > Visualforce Pages.

      2. On the Visualforce Pages page, click the Name of your Coveo JS Search page.

      3. On the page that appears, click Preview.

    3. In your Coveo JS Search page, access the Interface Editor:

      1. In the lower-right corner of the browser window, click Menu.

      2. In the Interface Editor menu, select Edit.

    4. In the Interface Editor:

      1. Click Code View in the upper-right section of the header.

      2. In the code view, ensure the CoveoSearchAlerts component (<div class="CoveoSearchAlerts"></div>) is present in the page.

        • By default, the component is present in Coveo JavaScript Search pages.

        • When you have no use cases for search alerts, remove the code line quoted above to deactivate the search alerts component, and therefore stop receiving subscription requests from the user interface for /rest/search/subscriptions.

      3. Hover over a search result template, and then click Edit in the upper-right corner.


      4. In the Template Option panel that appears, click Layout.

      5. In the Layout panel, in the right section, drag and drop the Follow item component label at the place of your choice (ex., next to the Excerpt label).

        In the preview, the Follow link appears under the result title.

      6. Click Save to make changes effective.

      7. Ensure that the Follow link appears under the result title, and that the Manage Alerts and Follow Query options appear in the (Settings menu next to the search box), and then click Save in the upper-right corner.

  4. If not already done, log in to your Coveo organization with an Admin user role account.

  5. In the Coveo Cloud Administration Console Settings page, ensure the Send email alerts check box is selected (see Managing Your Coveo Cloud V1 Organization Settings).

  6. Once your search page is online, share the search page link with your end users.

What’s Next?

In the Coveo Cloud Administration Console, customize the email template and subscription cancellation page (see Managing Your Coveo Cloud V1 Organization Settings).

Recommended Articles