Deploying Coveo for Microsoft Dynamics 365 Using a Solution File

This article is intended to guide you on how to deploy Coveo for Microsoft Dynamics 365 from a solution file (ZIP file).

  • Ensure that your browser does not block popup windows as this may hinder the deployment process.
  • To deploy a solution in Microsoft Dynamics 365, you need the System Administrator or System Customizer security role, or equivalent permissions.

Step 1 - Download the Package

Download the desired Coveo for Microsoft Dynamics 365 solution package (see Downloads).

If you want to install the September 2018 (1.1.180912.3) or June 2018 (1.1.180614.21) version in a Microsoft Dynamics 365 9 instance, you actually need to download and install two packages, i.e., the basic Coveo for Microsoft Dynamics 365 package and an additional package for Dynamics 9 instances. These packages must be installed successively, starting with the basic one.

Step 2 - Import the Solution

Import the Coveo for Microsoft Dynamics 365 solution package in your Dynamics 365 instance.

  1. Log in to your Microsoft Dynamics 365 instance with System Administrator credentials.
  2. Navigate to Settings > Customization > Solutions.
  3. Click Import to import Coveo for Microsoft Dynamics 365.

    Import tab

  4. Click Choose File, select the right Coveo for Microsoft Dynamics 365 solution file, and then click Next.

    Choosing a File to Import

  5. Validate the information regarding the solution you are about to import, and then click Next.

    Validating the Solution Information

  6. On the Import Option page, select Enable any SDK message processing steps included in the solution, and then click Import.

    Enabling SDK Messages

  7. Wait for the importation to complete.

    Progress Bar

  8. Once the importation is completed, check the logs to validate that the deployment is successful, and then click Close.

    Import Successful

  9. If applicable, repeat the procedure with the Dynamics 9 solution package (see Step 1 - Download the Package and Downloads).

  10. Back in the Solutions window, click Publish All Customizations.

Now that you deployed Coveo for Microsoft Dynamics 365 in your Dynamics 365 organization, you can link your Coveo for Microsoft Dynamics 365 instance to a Coveo Cloud organization.

A source is a subdivision created in the Coveo index to house the data coming from specific repositories such as Microsoft Dynamics 365, Sitecore, Jira Software, and many more (see What Is Coveo for Microsoft Dynamics 365? and Available Connectors). You can specify individual parameters for each source, including refreshing rates and security. You can manage all Microsoft Dynamics 365 sources directly from Coveo for Microsoft Dynamics 365 in your Dynamics 365 solutions. You need to log in to the Coveo Cloud administration console to manage sources based on other connectors (see Administration Console).

  1. If not already there, access the Coveo for Microsoft Dynamics 365 configuration interface (see About the Configuration Interface).
  2. In the Connect to Coveo Cloud window, click Connect to Coveo Cloud.
  3. In the Log into Coveo Cloud window, click Log in with Office 365.
  4. Click Authorize to allow access to your Coveo Cloud organization.
  5. In the Select a Coveo Cloud Organization panel:
    • If you do not have a Coveo Cloud organization:
      1. Click Create a Trial Organization.
      2. Enter a name for your organization.
      3. Click Create.
    • If you already have a Coveo Cloud organization:
      1. Click Select an Existing Organization.
      2. If you have more than one organization linked to your Office 365 account, choose the one you want to use.
      3. Click Next.

      The linking process can take a minute or two. Please wait until Coveo for Microsoft Dynamics 365 initializes.

      If the process fails, redirecting you to the Connect to Coveo Cloud page, see Known Issue: Infinite Loop at Authentication Step.

Coveo for Microsoft Dynamics 365 is now deployed and ready to use.

What’s Next?

Now that Coveo for Microsoft Dynamics 365 is deployed, you can review the links provided in What Do I Do Next? to explore more options. Most importantly, you should create a Microsoft Dynamics 365 source and make Coveo your default search provider (see Sources, Add/Edit a Microsoft Dynamics 365 Source, and Searching With Coveo in Dynamics).