Microsoft Dynamics CRM Connector

Installation and Configuration

Copyright ©

Mindbreeze GmbH, A-4020 Linz, 2018.

All rights reserved. All hardware and software names used are brand names and/or trademarks of their respective manufacturers.

These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes, or any other protected rights. The dissemination, publication, or reproduction hereof is prohibited.

For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.

Creating and testing a crawler accountPermanent link for this heading

Create a new account for Microsoft Dynamics CRM. This account must have the required read access rights for all data relevant for crawling in CRM. A read-only administrator account is best suited for this purpose.

Then test the account by logging in to your Microsoft Dynamics CRM and checking whether you can see all the data relevant for crawling.

Configuring MindbreezePermanent link for this heading

IndexPermanent link for this heading

Click the “Indices” tab and then click the “Add new index” icon to create a new index (optional).

Enter the index path. If necessary, adjust the display name of the index service and the associated filter service.

To do this, the “Advanced Settings” must be activated first.

The following dynamic constraints must be configured:

Dynamic Constraint Source Expr

category:Undefined

Dynamic Constraint Pattern

NOT categoryclass:systemuser

Dynamic Constraint Static Fraction

NOT categoryclass:systemuser

Data sourcePermanent link for this heading

Set-upPermanent link for this heading

Add a new data source with the “Add new custom source” icon (located at the bottom right).

URLsPermanent link for this heading

Now enter the URL for your CRM in the “CRM URL” field.

You can disregard the “Organization Service URL” field if you have not changed the URL to the “Organization SOAP Service” of your Microsoft Dynamics CRM instance.

SourcesPermanent link for this heading

For the final step, specify which part(s) of your CRM should be indexed in Mindbreeze InSpire.

First, go to the entity settings of your CRM. The entity name of the relevant entity from Microsoft Dynamics CRM is required to index all entities of a particular entity type from Microsoft Dynamics CRM in Mindbreeze InSpire.

The following screenshot shows the configuration of the entity type “Opportunity” in Microsoft Dynamics CRM. In this example, all sales opportunities (blue-bordered in the screenshot) are to be indexed; the Microsoft Dynamics CRM connector requires the internal name of the entity type (name "opportunity", red-bordered in the screenshot).

In addition, the internal name of the main field is required for the configuration of the connector (red-bordered in the following screenshot).

Navigate back to the data source settings in Mindbreeze InSpire and enter all the entity types you want to index in the “Entity Types” field, separated by a line break. If you want to index all sales opportunities, enter the value “opportunity” in a new line in the field “Entity Types”.

For each entity type entered, the main field must be entered in the “Primary Name Attributes” field. The first line of “Entity Types” is linked to the first line of “Primary Name Attributes”; the second line of “Entity Types” is linked to the second line of “Primary Name Attributes” and so on. Since “opportunity” is written in the last line of the field “Entity Types” in this example, the corresponding main field “Name” must be placed in the last line of the field “Primary Name Attributes”.

  

Login informationPermanent link for this heading

For the next step, you’ll need the login information from chapter 2, “Creating and Testing a Crawler Account”. In the Mindbreeze management UI, switch to the Plugins tab and add the credentials/login information under Credentials:

Under Endpoints, add a new endpoint. Enter the CRM URL in the Location field (as described in Section 3.2.2). In the Credential drop-down field, select the login information that has just been configured.

Note: Your CRM must be configured to run the logins via AD FS (Active Directory Federation Services).

Synthesized metadataPermanent link for this heading

In Microsoft Dynamics CRM, entities are often related to other entities (frequently also to entities of a different entity type). In order to display attributes of the linked entity in the search client, ”synthesized metadata” needs to be configured. To do this, the “Advanced Settings” must be activated first.

Click the “Add Composite Property” icon and assign a name for the referenced attribute in the “Name” field.

The link is created in the “Property Expression” field using the following pattern: mscrm_<Fremdschlüssel-Attribut>/mscrm_<Attribut im Referenzierten Dokument>.

In “categoryDescriptor.xml”, the name (“mscrm_parentcustomer_name” in the screenshot) can then be used as the metadata date ID.

Must-have synthesized metadataPermanent link for this heading

The following synthesized metadata definitions have to be configured, as they are used in the “categoryDescriptor.xml” which is included in the standard delivery:

Name: mscrm_parentaccount_name
Property expression: mscrm_parentaccountid/mscrm_name

Name: mscrm_owninguser_fullname
Property expression: mscrm_owninguser/mscrm_fullname

Name: mscrm_parentcontact_fullname
Property expression: mscrm_parentcontactid/mscrm_fullname

Principal resolution servicePermanent link for this heading

To determine which users are allowed to see which entities in Mindbreeze, you need to add a PrincipalResolutionService under Services.

“Microsoft Dynamics CRM Principal Resolution" must be selected in the drop-down list Service.

You must also specify a free port in the Bind Port field.

The "ACL Cache Expires Minutes" option can be used to define the number of minutes after which the cached rights information will expire and have to be re-downloaded from the CRM.

The CRM URL and Organization Service URL fields must be specified as described in Section 3.2.2.

In the next step, the "Microsoft CRM Principal Service" needs to be added to the data source configured in Section 3.2. Select the service you just configured from the Caching Principal Resolution Service drop-down list.

An LDAP server is required to convert UPN users to a format known to Microsoft CRM. Switch to the Network tab and enter the domain name in the LDAP settings as a minimum.

In the next step, you need to configure a user under Credentials who, at a minimum, has the rights to read the UPN names of all users.

In addition, you need to create a link under Endpoints between the LDAP settings and the added credentials. The Location field must be configured as follows:

dns://<LDAP Server Domain Name>   (e.g. dns://mycompany.com)