Adding and Managing Search Pages

A Coveo search page is an HTML page using the Coveo JavaScript Search Framework to build a user-friendly and easily customizable search page (see JavaScript Search Framework Documentation Tip). A search page can be customized and used in Dynamics as a typical search page, as the side search panel, or as an Insight panel embedded in an entity form (see Searching With Coveo in Dynamics and Adding a Coveo Search Page to an Entity View).

Coveo for Microsoft Dynamics 365 includes pre-built search pages so that you can start using the Coveo search solution as soon as your Dynamics source has been built (see Add/Edit a Microsoft Dynamics 365 Source Panel and Accessing the Default Search Page). These pages contain the basic elements of a Coveo search interface, and you can customize them to personalize your users’ search experience and have them get the most out the Coveo for Microsoft Dynamics 365 search solution (see Editing a Search Page).

One of the pre-built search pages is named default. It is the page template used by default to build the Coveo search page in Dynamics (see Searching With Coveo in Dynamics and Adding a Coveo Search Page to an Entity View). A sidepanel page is also available. This page is used by the Coveo Side panel, which you can open anywhere in Dynamics (see Coveo Side Panel).

Microsoft Dynamics 365 8.2 If you use Microsoft Dynamics 365 8.2 or a previous version, the Default.html search page is available as a web resource in the Coveo solution (see Accessing the Sample Coveo Search Page Web Resource).

Beside the pre-built search pages, you can create, edit, and publish other search pages to tailor your users’ search experience to their needs.

Coveo for Microsoft Dynamics 365 search pages are stored as Dynamics web resources. Therefore, users with the permission to edit the webresourceset entity can edit Coveo for Microsoft Dynamics 365 search pages. Since this ability could be misused to access secured content, Coveo recommends to be careful when granting the permission to edit webresourceset.

Coveo for Dynamics 1.1.180912.3 - September 2018 Starting with Coveo for Microsoft Dynamics 365 1.1.180912.3, Coveo JavaScript Search Framework and Coveo for Microsoft Dynamics 365 Search UI resources are delivered through a content delivery network (CDN). In other words, these resources are hosted by Coveo instead of being included in the Coveo for Microsoft Dynamics 365 packages. This ensures that your search page customizations are not affected when you update Coveo for Microsoft Dynamics 365, thus preventing breaking changes to be introduced in your pages. However, since the search pages always use the resource version that was the newest when they were created, the resources you can leverage in a search page are limited to those that were available when you created the search page. You therefore cannot implement in an older search page a resource that was introduced in a newer release, unless you manually update versions used by your search page. See Updating the CDN Addresses of a Search Page for further information.

In Coveo for Microsoft Dynamics 365 1.1.180614.17 (June 2018) and 1.1.180912.3 (September 2018), a new Search Pages page has been gradually implemented to replace the old one. This new page is temporarily named Search Pages V2 in version 1.1.180614.17 (June 2018), as the old and the new page both appear in the configuration interface menu (see About the Configuration Interface).

If using version 1.1.180614.17 (June 2018), you must go to the Search Pages V2 page to create new a search page (see Creating a Search Page. Previously created search pages can still be accessed and managed via the Search Pages page.

If using version 1.1.180912.3 (September 2018) or a newer version, in the configuration interface menu, click Search Pages to access the new page (previously named Search Pages V2). The old Search Pages page is no longer available in the menu, but you can still access it at: [Dynamics URL]/WebResources/coveo_ConfigurationSource#/SearchPagesLegacy.

To install the latest version and benefit from the latest search page management features, see Upgrading Coveo for Microsoft Dynamics 365.

Creating a Search Page

You can create and edit a search page using the Interface Editor without leaving Dynamics (see JavaScript Search Interface Editor). Once your search page is created, the Interface Editor allows you to personalize it using customizable drag-and-drop components or directly in the page source code.

  1. In the Coveo for Microsoft Dynamics 365 configuration interface, click Search Pages or, if using version 1.1.180614.17 (June 2018), Search Pages V2 (see About the Configuration Interface).

  2. In the Search Pages page, click Add Page.
  3. In the Add a Page dialog that appears, in the Page Title box, enter a name for your search page.
  4. Under Page Type, specify how your search page will be used (see Classic and Insight Panel Search Pages)):

    The search page basic interface differs depending on the Page Type you choose (see Viewing a Search Page, Classic and Insight Panel Search Pages, and Searching With Coveo in Dynamics).

  5. At the bottom of the panel, click Add Page.
  6. In the Setup a Search Page window that appears, select the tabs to include in your search page. A tab contains an independent search page that typically has its own scope, e.g., a tab presenting only results from a given source type. You can also customize the search components available in each tab, for instance by implementing scope-specific facets.

    1. Select the tabs from those recommended based on the detected content of your organization (Sources).

    2. Optionally, click More Tabs to view other tab options for content types that are not yet available in your organization, in case you plan to add such content types.

      Once your search page is created, you can easily add or delete tabs using the Interface Editor (see JavaScript Search Interface Editor).

    3. Click Create Page.

Once your new search page has appeared in the Search Pages page, you can customize it and embed it in entity forms (see Getting Started With Insight Panels, Editing a Search Page, and Adding a Coveo Search Page to an Entity View).

Editing a Search Page

You can use the JavaScript Search Interface Editor to customize a search page depending on your users’ needs (see JavaScript Search Interface Editor). The Interface Editor also allows you to enable many search page enhancement options, and edit the arrangement of the search page components as well as the information they display.

  1. In the Coveo for Microsoft Dynamics 365 configuration interface, click Search Pages (see About the Configuration Interface).
  2. In the Search Pages page, click the search page you want to edit.
  3. In the Action bar, click Edit Interface.
  4. Refer to the JavaScript Search Interface Editor documentation to leverage the Interface Editor. You can edit your search page by moving components and selecting option check boxes, or by editing the page source code.

    The search page uses the latest version of the Coveo JavaScript Search Framework (see Coveo for Microsoft Dynamics 365 Release Notes and Coveo JavaScript Search Release Notes). Refer to the following documentation:

  5. When done editing your search page, in the top right corner of the Interface Editor, click Save.
  6. Once you saved your changes, you can review your search page to ensure it is adequate (see Viewing a Search Page).

Next, if you created an Insight panel search page, embed it in entity forms (see Getting Started With Insight Panels and Adding a Coveo Search Page to an Entity View).

Viewing a Search Page

You can view a search page to ensure it fits your needs and expectations.

  1. In the Coveo for Microsoft Dynamics 365 configuration interface, click Search Pages (see About the Configuration Interface).
  2. In the Search Pages page, click the search page you want to view.
  3. In the Action bar, click More, and then click View.

A new page opens, displaying your search page. You can then test it by searching for keywords. When satisfied with your changes, you can publish them (see Publishing a Search Page).

If you want to see a draft page as it was originally, i.e., without the modifications you made, copy the preview page URL, paste it into another browser tab, remove ?preview=1 from the preview page URL, and then press Enter.

Publishing a Search Page

When you are satisfied with the changes you made in a search page, you can publish your page to make it available to your search page users.

  1. In the Coveo for Microsoft Dynamics 365 configuration interface, click Search Pages (see About the Configuration Interface).
  2. In the Search Pages page, click the search page you want to publish.
  3. In the Action bar, click More, and then click Publish.

Within a few seconds, your search page will be available to users.

Coveo for Dynamics 1.1.180912.3 - September 2018Alternatively, if you have several drafts to publish, you can click Publish All to publish them all at once.

Using the Default Page in the Side Panel

Although the default and side panel search pages come as two separate pages, you could want your default search page to be used in the Coveo side panel, or your Coveo side panel search page to be your default search page. To do so, copy the code of your customized search page, and then replace the desired search page code with it (see View and Customize the Search Interface Source Code).

Whenever you make a change in one of these pages, ensure to copy its code in the other page so that they remain identical.

Deleting a Search Page

You can delete a search page permanently if you no longer need it.

  1. In the Coveo for Microsoft Dynamics 365 configuration interface, click Search Pages (see About the Configuration Interface).
  2. In the Search Pages page, click the search page you want to delete.
  3. In the Action bar, click More, and then click Delete.
  4. Click Yes.

Your search page will disappear from the search page list.

You cannot delete the search pages labeled Default and Side Panel.