Updating the CDN Addresses of a Search Page

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.

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 aren’t affected when you update Coveo for Microsoft Dynamics 365, therefore preventing breaking changes to be introduced in your pages (see Editing a Search Page and Upgrading Coveo for Microsoft Dynamics 365).

You create a search page with Coveo for Microsoft Dynamics 365 5.0 (fictive version) (see Creating a Search Page). This page uses the Coveo JavaScript Search Framework 13.4 and the Coveo for Microsoft Dynamics 365 Search UI 3.2.

Later, you upgrade Coveo for Microsoft Dynamics 365 to version 5.1 (see Upgrading Coveo for Microsoft Dynamics 365). New pages created with this version use the Coveo JavaScript Search Framework 13.8 and the Coveo for Microsoft Dynamics 365 Search UI 4.1.

The search page you created before, however, still uses versions 13.4 and 3.2. As a result, it can’t be affected by breaking changes.

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 can’t 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.

To update the CDN addresses of a search page

By updating the CDN addresses of a search page, you allow this page to benefit from the latest Coveo for Microsoft Dynamics 365 features.

Following a CDN address update, breaking changes may appear in your search page. You’re therefore advised to test your page thoroughly before making it available to your users (see Publishing a Search Page or Migrating Search Pages and Custom UI Components to a Production Instance).

  1. Download, extract, and launch XrmToolBox, if not already done (see XrmToolBox).

  2. In the XrmToolBox for Microsoft Dynamics CRM/365 window, click Connect in the upper-left corner.

    Clicking Connect

  3. In the Select a connection window that opens, click New connection in the upper-left corner.

  4. Back in the XrmToolBox for Microsoft Dynamics CRM/365 window, in the Plugins tab, click Webresources Manager.

    Clicking Webresources Manager

  5. In the Webresources Manager tab, in the CRM drop-down menu, select Load Web resources.

  6. In the Webresources Explorer, expand coveo_, and then searchpages.

    Webresources Explorer

  7. Under searchpages, select the search page of which you want to update the CDN addresses.

  8. In the search page HTML, look for addresses starting with https://static.cloud.coveo.com/searchui/, and edit them to change the JavaScript Search Framework version number for the desired one.

    searchui Addresses

    Your search page uses the Coveo JavaScript Search Framework 13.4. The resource addresses therefore start with: https://static.cloud.coveo.com/searchui/v13.4.

    You want the page to use version 13.8, so you change the address for https://static.cloud.coveo.com/searchui/v13.8.

  9. Similarly, look for addresses starting with https://static.cloud.coveo.com/coveofordynamics/, and edit them to change the JavaScript Search Framework version number for the desired one.

    coveofordynamics Addresses

    Your search page uses the Coveo for Microsoft Dynamics 365 Search UI 3.2. The resource addresses therefore start with: https://static.cloud.coveo.com/coveofordynamics/v3.2.

    You want the page to use version 4.1, so you change the address for https://static.cloud.coveo.com/searchui/v4.1.

  10. In the upper-left corner of the HTML tab, click File, and then Save to save your changes.

  11. In the Webresources Explorer, click Show pending updates.

  12. Under Pending Updates, select Update and Publish, and then click Apply.

Recommended Articles