Add or Edit a Microsoft Dynamics 365 Source

The Add/Edit a Microsoft Dynamics 365 Source panel serves the purpose of managing your Dynamics 365 sources parameters.

The process described in this article is an older, less convenient way to add or edit a Microsoft Dynamics 365 source. You can now manage your Microsoft Dynamics 365 sources from the Coveo Cloud administration console, along with your other content sources.

To start benefiting from this change, edit your Dynamics sources from the administration console. If you are prompted to update the access token, authenticate with a user that is both a Microsoft Dynamics 365 administrator and an Azure administrator. Ensure that the source configuration is still valid, and then click Save and Rebuild. Once the source is rebuilt, manage it using the Coveo Cloud administration console to avoid mapping issues.

Accessing the Add/Edit a Microsoft Dynamics 365 Source Panel

In the Coveo for Microsoft Dynamics 365 configuration interface, on the Sources page (see About the Configuration Interface and Sources):

  • To add a new Microsoft Dynamics 365 source, click Add Source.

    OR

  • To edit a source, double-click the desired source.

    OR

  • To edit a source, click the desired source, and then click Edit.

Configuration Tab

In the Configuration tab, you can enter or edit the parameters Coveo Cloud uses to connect to your Microsoft Dynamics 365 instance.

Configuration tab

  1. In the Source Name box, enter a name for your source.

    If you are editing an existing source, you cannot change this parameter.

  2. Under Security, select who can see items from this source in a search interface that includes this source in its scope (see Content Security). Your options are:

    • Shared: Everyone will be able to find the source content in the search interface.
    • Secured: Only users authenticated in the search interface will see the source items for which they have read permission
  3. In the Authentication section, choose an authentication method (see Allowing Coveo to Access Your Content):

    • Microsoft Dynamics 8.2 In a Microsoft Dynamics 365 8.2 or 9.0 instance, select Application User to automatically create an application user that has read-only access rights. This option establishes an OAuth trust from Coveo to Dynamics, which you must accept by logging in with an Office 365 administrator account.

    • In a Microsoft Dynamics 365 8.1 or 8.0 instance, select Credentials (Legacy) to enter the credentials of a read-only Microsoft Dynamics 365 account (non-interactive user)(see Allowing Coveo to Access Your Content). If you choose this option:

      • Under Discovery Service URL, enter the Discovery Service URL of your Microsoft Dynamics 365 instance to be used as the endpoint to connect to the web services used to communicate with the Microsoft Dynamics 365 cloud components. This URL varies depending on the region where your instance is hosted (see Discover the URL of your organization using the Organization Service).

        If you do not know what is your Discovery Service URL, follow these steps to quickly recover it:

        1. Navigate to Settings > Customization > Customizations.

        2. In the Customization screen, click Developer Resources.

        3. In the section Connect your apps to the Dynamics 365 Discovery Service:

          1. In Endpoint Address, select the URL from https to the .com and copy it.

          2. Paste the URL in the Discovery Service URL field.

        For Canadian users, this address should include numbers.

        https://disco.crm9.dynamics.com

      • Under Username, enter the username of a Microsoft Dynamics 365 user with read-only access. As part of the Getting Started guide, you should have created an account specifically to crawl your Microsoft Dynamics 365 content (see Allowing Coveo to Access Your Content).
      • Under Password, enter the password associated with the Microsoft Dynamics 365 user you entered above.

        Once the source is created, you do not have to change the password in this field unless you changed this password in Microsoft Dynamics 365.

Entities Tab

In the Entities tab, you can choose which fields of which entities Coveo Cloud indexes. By default, Coveo for Microsoft Dynamics 365 enabled the most popular ones (see Entities and Fields Indexed by Default).

  1. On the left, in the Entity column, you can see a list of all available entities:
    • Check the box of an entity you want to index.
    • Clear the box of an entity you want to exclude.
  2. On the right, in the Field column, you can see the fields associated with the selected entity:

    • Check the box of a field you want to index.
    • Clear the box of an entity you want to exclude.

    Edit Microsoft Dynamics 365 Source panel

    When you add a new entity to index, you should also ensure that audit of the entity is enabled (see Enabling Auditing of Microsoft Dynamics 365 Entities).

  3. You can optionally edit the Title and Body mappings by double-clicking an entity you chose to index (see Field Mapping Rules). Alternatively, you can click the entity you chose, and then click Edit.

  4. In the Edit [EntityName] Entity panel, in the Configuration tab, you can personalize a document title and body metadata shown in the result list using one or more placeholders with the following syntax: %[fieldName].

    • Title Mapping: Enter the field or fields you want to use for the title metadata.

      You are editing the Account entity and you want to include both the number and the name of the account in the document Title: %[name] %[number]

    • Body Mapping: Enter the field or fields you want to use for the body metadata.

      You are editing the Account entity and you want to include the business type followed by its description in the document Body: %[businessType] %[description]

      Edit Appointment entity panel

  5. You can optionally specify conditions to index only certain entities. To do so, click the Conditions tab (see Entity Conditions).

  6. Once you are done, click Save. You are now back in the Source Properties panel.

Relations Tab

In the Relations tab, you can choose which relations to include in the index (see Relationships Indexing and Create and edit relationships between entities). On the left, you can see all the relations for each indexed entity. On the right, the panel shows the fields associated with the relation.

  1. In the Source Properties panel, click the Relation tab.

  2. On the left, click the entity whose relation(s) you want to edit to expand its section:

    1. Select the box of a relation you want to index.

    2. Clear the box of a relation you want to exclude.

  3. On the right, when you select a relation, you can see a list of the corresponding fields:

    1. Select the box of a field you want to index.

    2. Clear the box of a field you want to exclude.

      Edit Microsoft Dynamics 365 Source panel

      If you choose to index a relation, you should select at least one of its fields to index.

  4. Click an entity, and then click Edit to edit an indexed relation alias (see What Is an Alias?):

  5. Enter a meaningful Alias for the relation.

  6. Click Save.

    Edit Relation panel

Adding/Saving your Microsoft Dynamics 365 Source

Two options are available to save your source configuration and close the Add/Edit a Microsoft Dynamics 365 Source panel:

  • Click Add/Save when you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon.

    On the Sources page, you need to click More, and then Rebuild to add the source content and make your changes effective (see Sources).

  • Click Add and Build/Save and Rebuild when you are done editing the source and want to make changes effective.

Back in the Sources page, you can review the progress of your source addition or modification (see Sources).