Adding a Coveo-Powered Search Page to an Entity View

In December 2020, the Coveo for Microsoft Dynamics 365 integration will reach its end-of-life and will no longer be supported by Coveo. See Coveo for Microsoft Dynamics 365 End-of-Life for details.

You can embed a Coveo Insight panel in a Microsoft Dynamics 365 entity form to allow users to perform queries while they’re viewing an entity, e.g., a case, a contact, an opportunity, etc. (see Searching With Coveo in Dynamics). Since the search interface is embedded in the entity page next to the entity data, your Microsoft Dynamics 365 users don’t need to switch tabs or windows to make a query and open a result from the result list. This makes their Microsoft Dynamics 365 experience smoother and more efficient.

Step 1: Open the Desired Form

Open the form to which you would like to add a Coveo search interface in edit mode.

  1. Log in to your Microsoft Dynamics 365 organization with a System Administrator account.

  2. In the ribbon, click Settings, and then, under Customization, click Customizations.

  3. In the Customization screen, click Customize the System.

  4. In the Solution: Default Solution window, in the right pane, double-click Entities.

  5. Double-click the entity to which you would like to add a Coveo search interface, and then click Forms.

  6. Click the form to which you would like to add the Coveo search interface.

You’re now viewing the Microsoft Dynamics 365 entity form editor.

Dynamics Entity Form Editor

Step 2: Add the Desired Search Page to the Form

Add the Coveo SearchPage web resource to this form.

  1. In the Form: <ENTITY_TYPE> window, click the section to which you would like to add a Coveo search interface. In the image above, the right-hand side section, named Relationship Assistant, is selected.

  2. At the top of the interface, select the INSERT tab, and then click Web Resource.

    Clicking Web Resource in the ribbon

  3. In the Add Web Resource panel, in the Web Resource field, type coveo_/searchpages, and then click the magnifying glass icon to find the Coveo web resources. The items in the list are the search page Web resource names displayed in the Search Pages V2 page (see Search Pages).

    Add Web Resource panel

  4. In the list of Coveo-powered search pages that appears, select the web resource named after the search page you want to use.

  5. Under Field Name and Properties, enter a Name and a Label for the new controls you’re adding to the page.

  6. Optionally, select the Formatting tab to specify the height of the new controls you’re adding. Under Row Layout, you can then specify the number of rows to use for the Coveo search interface.

    You should give the Coveo search interface at least 20 rows since a search page is expected to display search content tabs, a search bar and a list of search results.

  7. Optionally, under Border, deselect the Display border box. We recommend that you deselect this option for a better look, but leaving the box selected doesn’t affect the panel.

  8. Click OK to save and close the Add Web Resource panel.

  9. In the Form: <ENTITY_TYPE> window, select the HOME tab.

  10. Click Save to save the form.

  11. In the ribbon, click Preview to preview your changes, and then, in the drop-down menu, select the desired kind of preview.

    End Result with Coveo for Microsoft Dynamics 365 version 1.1.180614.17 and later

  12. When satisfied with your changes, in the ribbon, click Publish.

    Publish button in ribbon

What’s Next?

Read more about entity context and decide whether you want to leverage it in your Insight panel (see Getting Started With Insight Panels and Understanding Entity Context). You can also customize your Insight panel, if not already done (see Editing a Search Page).

Recommended Articles