Replacing the Service Portal Search Page

Coveo-powered search pages don’t simply match keywords with items: they also leverage machine learning and usage analytics to ensure that the content returned to each search page user is the most relevant for them, based on their profile and inferred intentions. Coveo-powered search pages also make it possible for users to search many content sources at once, which typical search engines don’t allow. Therefore, to take full advantage of Coveo for ServiceNow and leverage Coveo’s unique features to improve your users’ search experience in your Service Portal, you should replace your Service Portal search engine with a customizable Coveo-powered search page.

Replace Your Current Service Portal Search Page With a Coveo-Powered Search Page

  1. In the Now Platform UI of your ServiceNow instance:

    1. Navigate to Service Portal > Pages.

    2. Find and open your Service Portal search page record (typically, this is the record whose ID is search).

      You should create a backup copy of the record by clicking Clone Page in the upper-right corner of the record form. When this is done, navigate back to the original record before proceeding on to the next step.

    3. In the Related Links section, click Open in Designer.

  2. In the Service Portal Designer application that opens in a new browser tab:

    1. Delete all widgets and containers in the page, or reorganize them to make room for the large Coveo Main Search widget.

    2. Create a one-column container or, if you want to display personalized recommendations next to the search results list, a two-column container (see Recommendations Widget and Configuring a Recommendations Panel).

      The Main Search and the Recommendations widget in a two-column container:

      The Main Search and the Recommendations widget in a two-column container

    3. Drag and drop the Coveo Main Search widget inside the container (see Main Search).

      For navigation purposes, you may also want to add a one-column container with a breadcrumbs widget right above the container with the Coveo Main Search widget.

    4. Optionally, customize the Main Search widget. Thanks to the Scope and Component options, you can name your widget according to your convention.

    5. Click Preview to see how your Coveo-powered search page looks on different display sizes.

Customize Your Coveo-Powered Search Page

Once you have added the Coveo Main Search widget to your portal search page, you may want to customize the page that the widget displays. This step is however optional.

When customizing the search page for the first time:

  1. In a new tab, access the Coveo Cloud Administration Console Search Pages page (see Access the “Search Pages” Page).

  2. Create and customize a new search page (see Add a Search Page). Note your new search page name, as you’ll need to enter it in the ServiceNow interface later.

  3. Back in the Service Portal Designer, click Edit-Widget in the upper-right corner of the Coveo Main Search widget.

  4. In the dialog that appears, under Search Page, enter the name you gave your custom search page when you created it in the Coveo Cloud Administration Console.

  5. Click Save.

Next time you want to edit your Coveo-powered search page, there are two ways to access the Interface Editor (Interface Editor):

  • In the Service Portal Designer Preview tab, click Edit-Search-Page that appears on the left-hand side of the Coveo Main Search widget.

  • In the Coveo Cloud Administration Console, access the Search Pages page, and then the Interface Editor (see Accessing the Interface Editor).

Configure Your Query Pipeline

Once you have implemented the widget in your ServiceNow instance, you must link it to a query pipeline in your Coveo Cloud organization.

  1. In the Coveo Cloud Administration Console, on the Query Pipelines page:

    • If you want to use an existing pipeline, select it, and then in the Action bar, click More > Edit.

    • Create a new pipeline for your Coveo for ServiceNow widget to use.

  2. In the Add/Edit a Query Pipeline panel, create a condition enforcing a specific search hub (Search hub is) for the pipeline. The filter value to enter depends on your widget configuration:

    • If you didn’t provide Scope and Component values in the widget options, enter ServiceNow.

    • If you provided a scope and a component, enter them in the following format: Scope_Component.

      For a widget with a Portal scope and a MyWidget component, your condition value should be Portal_MyWidget. Your complete pipeline condition is therefore Search Hub is Portal_MyWidget.

    With such a condition, your pipeline will be used for all queries originating from the widget.

    If your pipeline already has a condition, ensure to include this previous condition in your new one with an OR operator.

    Your pipeline has the following condition: Search Hub is Portal_MyWidget. You want to link a new portal widget to this pipeline, so your new condition is Search Hub is Portal_MyWidget OR Search Hub is Portal_MySecondWidget. With this condition, your pipeline will be used for all queries originating from one of these widgets.

What’s Next?

Replace the current search boxes in your Service Portal pages with standalone Coveo search boxes in order to properly forward queries to your Coveo-powered search page, and to eventually provide Coveo Machine Learning (Coveo ML) Query Suggestions (QS) to your customers (see Replacing the Service Portal Search Boxes).

Recommended Articles