How to Access Dynamics CRM Data Using Entity Framework

Microsoft Entity Framework serves as an object-relational mapping framework for working with data represented as objects. Although Visual Studio offers the ADO.NET Entity Data Model wizard to automatically generate the Entity Model, this model-first approach may present challenges when your data source undergoes changes or when you require greater control over entity operations. In this article, we will delve into the code-first approach for accessing Dynamics CRM data through the CData ADO.NET Provider, providing you with more flexibility and control.

Getting Started

---

1. Open Visual Studio and create a new Windows Form Application. This article uses a C# project with .NET 4.5.
2. Run the command 'Install-Package EntityFramework' in the Package Manger Console in Visual Studio to install the latest release of Entity Framework.

3. Modify the App.config file in the project to add a reference to the Dynamics CRM Entity Framework 6 assembly and the connection string.

   The connection string options meet the authentication and connection requirements of different Dynamics CRM instances. To connect to your instance, set the User and Password properties, under the Authentication section, to valid Dynamics CRM user credentials and set the Url to a valid Dynamics CRM server organization root. Additionally, set the CRMVersion property to 'CRM2011+' or 'CRMOnline'. IFD configurations are supported as well; set InternetFacingDeployment to true.

   Additionally, you can provide the security token service (STS) or AD FS endpoint in the STSURL property. This value can be retrieved with the GetSTSUrl stored procedure. Office 365 users can connect to the default STS URL by simply setting CRMVersion.

   <configuration>
    ... 
    <connectionStrings>
    <add name="DynamicsCRMContext" connectionString="Offline=False;User=myuseraccount;Password=mypassword;URL=https://myOrg.crm.dynamics.com/;CRM Version=CRM Online;" providerName="System.Data.CData.DynamicsCRM" />
    </connectionStrings>
    <entityFramework>
    <providers>
    ... 
    <provider invariantName="System.Data.CData.DynamicsCRM" type="System.Data.CData.DynamicsCRM.DynamicsCRMProviderServices, System.Data.CData.DynamicsCRM.Entities.EF6" />
    </providers>
    <entityFramework>
   </configuration>
   </code> 
   

4. Add a reference to System.Data.CData.DynamicsCRM.Entities.EF6.dll, located in the lib -> 4.0 subfolder in the installation directory.
5. Build the project at this point to ensure everything is working correctly. Once that's done, you can start coding using Entity Framework.
6. Add a new .cs file to the project and add a class to it. This will be your database context, and it will extend the DbContext class. In the example, this class is named DynamicsCRMContext. The following code example overrides the OnModelCreating method to make the following changes:
   • Remove PluralizingTableNameConvention from the ModelBuilder Conventions.
   • Remove requests to the MigrationHistory table.

   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   
   class DynamicsCRMContext : DbContext {
    public DynamicsCRMContext() { }
   
    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
    // To remove the requests to the Migration History table
    Database.SetInitializer<DynamicsCRMContext>(null); 
    // To remove the plural names 
    modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
    } 
   }
   

7. Create another .cs file and name it after the Dynamics CRM entity you are retrieving, for example, Account. In this file, define both the Entity and the Entity Configuration, which will resemble the example below:

   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   
   [System.ComponentModel.DataAnnotations.Schema.Table("Account")]
   public class Account {
    [System.ComponentModel.DataAnnotations.Key] 
    public System.String FirstName { get; set; }
    public System.String NumberOfEmployees { get; set; }
   }
    
   

8. Now that you have created an entity, add the entity to your context class:

   public DbSet<Account> Account { set; get; }
   

9. With the context and entity finished, you are now ready to query the data in a separate class. For example:

   DynamicsCRMContext context = new DynamicsCRMContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Account select line;