User Guide : Map Connectors : Source and Target Map Connectors : Microsoft Dynamics CRM 4.0
 
Share this page             
Microsoft Dynamics CRM 4.0
Microsoft Dynamics CRM 4.0 is a customer relationship management (CRM) software package that is available in two deployment styles: client-server and online. A client-server deployment is done on-premise within an organization and made available to users within an intranet or on the Internet. An online or cloud-based deployment using Microsoft Dynamics CRM allows users to subscribe to and access an instance from anywhere on the Internet. Both types of deployments expose the application functionalities through a web services interface.
This connector allows users to retrieve, insert, update, and delete data from both Microsoft Dynamics CRM on-premise and online instances.
Microsoft Dynamics CRM Versions Supported
This connector supports the following versions:
Microsoft Dynamics CRM 4.0 (on-premise and online)
Connector-Specific Notes
There are two requirements for the Microsoft Dynamics CRM 4.0 connector:
Version 3.0 or above of the .NET Framework must be installed on the system running DataConnect
The .dll files associated with the connector must be registered
The DataConnect installer automatically registers Microsoft CRM .dll files for .NET Framework version 3.0 and above.
To verify the version installed on your system, select the Microsoft CRM entry in the Add/Remove Programs section of the Windows Control Panel or look in the .NET Framework directory (for example, C:/Windows/Microsoft.NET/Framework). If you have a .NET Framework version other than 3.0 or above, use the following steps to register the Microsoft CRM 4.0 .dll files.
Note:  You must be logged in as Administrator to run the batch file to register the Microsoft CRM .dll files.
To register Microsoft CRM 4.0 .dll files
1. Install or ensure the latest version of Microsoft.NET framework is installed (version 3.0 or later).
2. Run the registerDJMsCrmComObj4.bat file located in the <installdir>\runtime\di9 directory.
A message stating that the the operation is displayed.
Connection Information
Note:  If when selecting the Microsoft Dynamics CRM 4.0 connector in Map Designer you receive an error stating the connector may not be licensed, you may need an updated license file. Please contact your account executive.
To establish a connection to Microsoft Dynamics CRM 4.0, you must provide the following information:
Server
Enter one of the following:
Server Name
IP Address of the Server, or
Local host (if DataConnect and the Microsoft Dynamics CRM server are on the same machine)
User ID
Username for connecting to the Microsoft Dynamics CRM Server.
For On Premise - Specify the domain name with backslash followed by username. [DomainName\Username]
For Online – Specify the Email-id in username field.
Password
Password for connecting to the Microsoft Dynamics CRM Server.
Organization
On-premise – Specify the company organization name.
Online – The organization name will be fetched automatically for the given server and username.
Properties
You can set the following source (S) and target (T) properties.
Property
S/T
Description
Authentication
ST
The authentication protocol for your source or target data:
Default - Uses Windows cached credentials. If necessary, add or edit your user name and password information in the Manage Passwords section of the Windows Control Panel.
Basic
Digest
NTLM
Anonymous
ServiceType
ST
Select the service type for connecting Microsoft Dynamics CRM options:
On-premise (default)
Online
Update Nulls
T
Select this option if you want to allow null values from source rows to overwrite existing data in the target rows during an update operation. The available options are Always (the default), Null only, and Never nulls
Batch Response
T
In delete operations, one batch response entry exists for every delete action.
In insert and update operations, one batch response entry exists for every insert or update action.
The return code for individual operation will show the result of the operation execution. If the operation is success then the return code will be 0.
For failed operations, the error Description tag will show the detailed error message. This will include any messages returned from Microsoft Dynamics CRM 4.0 as well as errors generated by DataConnect. When the return code is 0 (success), then this tag will return the Entity's unique ID for which the operation was successful.
MaxBatch
S
Controls how many records the server is asked to send at one time (read operations only). If you use a large number in this setting, you may see faster transformation run times. However, larger numbers may increase the need for memory. If you experience memory problems, lower the number.
The default is 500. To change this property, overtype the default with a new value. The maximum setting is 2000. The recommendation for inserts is 500 maximum and for queries, the maximum can be 2000.
WhereStmt
S
Provides a pass-through mechanism for SQL connectors where advanced users can construct the Where clause of the SQL query themselves. It can be used as an alternative to writing a lengthy query statement. You may use this to instruct the SQL database server to filter the data based on a particular condition before sending it to the integration platform. There is no default value for this property.
Note:  This property is not applicable when the source connection is a query statement or file. This property enables data filtering when you select a table.
Operations
The following operations are supported by the Microsoft Dynamics CRM Connector.
Create (C)
Read (R)
Update (U)
Delete (D)
Entity Support
The Microsoft Dynamics CRM Connector supports standard and custom entities.
Data Types
These are the data types of the fields in your target data table. If you are appending data to an existing table, the data type of each field uses the data type in the selected table by default. The following data types are available in Microsoft Dynamics CRM 4.0:
Boolean
Big Decimal
Double
Float
Integer
String
Batch Response
A batch response file contains a group of entries for each connector used in a batch operation. Each action in the operation generates a batch response entry. These entries often give detailed information, such as errors, that can be used for troubleshooting.
Sample XML
In delete operations, one batch response entry exists for every delete action.
In insert and update operations, one batch response entry exists for every insert or update action.
The return code for an individual operation will show the result of the operation execution. If the operation is successful, the return code will be 0.
For failed operations, the error Description tag will show the detailed error message. This will include the message returned from Microsoft Dynamics CRM 4.0 as well as errors generated by DataConnect. When the return code is 0 (success), then this tag will return the Entity's unique ID for which the operation was successful.
<BatchResponse: batchResult xmlns:BatchResponse="http://www.pervasive.com/BatchResponse">
<BatchResponse: results>
<BatchResponse: result>
<BatchResponse: returnCode>0</BatchResponse: returnCode>
<BatchResponse:objectContainerName>PhoneCall</BatchResponse:objectContainerName>
<BatchResponse: objectID>eb770db8-b581-e011-9673-1cc1de9bf0ef</BatchResponse: objectID>
<BatchResponse:updateOperation>UPDATE</BatchResponse:updateOperation>
</BatchResponse: result>
<BatchResponse: result>
<BatchResponse: returnCode>0</BatchResponse: returnCode>
<BatchResponse: errorDescription>13</BatchResponse: errorDescription>
<BatchResponse:objectContainerName>PhoneCall</BatchResponse:objectContainerName>
<BatchResponse:updateOperation>UPDATE</BatchResponse:updateOperation>
</BatchResponse: result>
</BatchResponse: results>
<BatchResponse: componentInfo>
<BatchResponse: returnCode>0</BatchResponse: returnCode>
<BatchResponse: componentName> MSCrm </BatchResponse: componentName>
</BatchResponse: componentInfo>
</BatchResponse: batchResult>
FilterXML
This option is used to apply filter conditions limiting the fields and rows fetched from source for the selected table.
Sample XML
<fetch mapping='logical'> <entity name='contact'><all-attributes/></entity></fetch>
<fetch mapping='logical'> <entity name='contact'><attribute name = 'contactid'/></entity></fetch>
Additional Information
Field Width
Microsoft Dynamics CRM 4.0 does not return the field size for all entities. In the case that the field width is not available, the field width will default to 40. If a value, such a text string appears to be truncated, you must manually adjust the field length.
Source Keys and Sorting and Source Filters
All sorting and filtering is done client side. All records will be read before any filtering or sorting is done.
Supported Authentications
The current version of Microsoft Dynamics CRM 4.0 supports Windows Live token-based authentication claims based authentication and NTLM authentication. This connector supports Windows Live token based authentication and NTLM authentication since claims based authentication is limited to .NET based application access.