Using the Microsoft Dynamics CRM Connector Configuration Generator Tool

The Dynamics Configuration Generator is a tool used to generate all the necessary configuration files for a specific Microsoft Dynamics CRM Organization, in order to index it properly.

To use the Microsoft Dynamics CRM Connector Configuration Generator Tool

1. Get your Discovery Service URL and Organization Name:

   1. Log into Microsoft Dynamics CRM Organization with an administrator account.

   2. Access the Developers Resources page:

      1. Click the Microsoft Dynamics CRM drop-down menu in the top-left of the screen, and then select Settings.

      2. Click the Settings drop-down menu, and then select Customizations.

      3. In the Customization page, click Developers Resources.

   3. In the Developers Resources page, take note of your Organization Unique Name and Discovery Service URL.

      Example: In Microsoft Dynamics CRM 2103 On-Premises, the Developers Resources page looks like the following:

      

2. Open the Microsoft Dynamics CRM Connector Configuration Generator Tool located in the CES 7 Bin folder.

   Example: C:\Program Files\Coveo Enterprise Search 7\Bin\DynamicsConfigGenerator.exe

3. In the Microsoft Dynamics CRM Connector Configuration Generator Tool interface:

   

   1. Under Configuration:

      1. In the Discovery Service URL box, enter the full discovery service endpoint URL.

      2. In the Organization Name box, enter the organization unique name.

      3. In the User Name and Passwords boxes, enter the credentials of the administrator account you previously used to create a user identity (see Microsoft Dynamics CRM Connector Deployment Overview).

      4. Click Connect.

         The connection to the Organization is initialized, displaying any errors and retrieving the complete entities schema. Retrieving the schema can take some time to complete.

         Notes:

         • After receiving the schema, a list of entities will be displayed in the left panel. For a better experience, the tool does not show entities that are not customizable. These entities are normally system entities with no relevant data.

         • CES 7.0.7599+ (April 2015) Meaningful entities and their attributes are selected by default.

   2. In the left panel, select the check box next to the entities you want to index.

      Note: Your selection defines the content of the ObjectsToGet file. The connector uses this file to determine what type of entity to get and what attributes to retrieve as their metadata.

   3. For each selected entities check boxes:

      1. Click an entity row.

      2. In the Entity Information tab, in the Attributes section panel on the right, select the attribute(s) to be used to create a corresponding field in the field set.

         Note: Each attribute for a specific entity will also be added in the document's metadata with the corresponding value.

      3. Finish configuring the mapping file:

         Note: The mapping file is generated using the selected entities and the entered Title and Body mappings (if any).

         In the Title and Body boxes:

         • Enter the exact same attribute name(s) selected in step ii in the format %[AttributeName].

           Note: In the Attributes section, the name in parentheses represents the name of the attribute in the mapping file.

           Example:

           In the Title box, when you selected the AccountId attribute, enter %[AccountId].

           In the Body box, when you selected the Description attribute, enter %[Description].

           OR

         • Drag-and-drop attribute(s).

      4. CES 7.0.7599+ (April 2015) Click the Relations tab to setup entity relations.

      5. In the Relations tab, for each selected related entities:

         1. Select the attribute(s) to be added to the current entity's metadata and used to create a corresponding field in the field set.

            Note: Each attribute for a specific entity is added in the document's metadata with the corresponding value in the following format:

            [ALIAS].[ATTRIBUTE_NAME]

            Example: When the alias is primarycontact and you select the Account attribute, the field that will be created in the field set is primarycontact.Account.

         2. (Optionally) Rename the Alias.

         Note: Adding relations can have a significant impact on crawling performances.

   4. Click Save to files.

   5. In the notification prompt that appears, select an output folder, and then click OK.

      Three configuration files are generated and prefixed by the unique name of your Organization.

      Example: CRM2013ObjectsToGet.xml, CRM2013FieldsSet.xml, and CRM2013MappingFile.xml.