How to Access Dynamics 365 Business Central 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 365 Business Central data through the CData ADO.NET Provider, providing you with more flexibility and control.

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 365 Business Central Entity Framework 6 assembly and the connection string.

   To authenticate to Dynamics 365 Business Central, you must select an AuthScheme and provide the required properties (OAuth by default).

   All Methods

   Specify the . If you have multiple companies in your organization, you must also specify the to indicate which company you would like to connect to. does not need to be specified if you have only one company.

   Access Key

   To authenticate with an Access Key, set AuthScheme to "AccessKey" and provide the and properties.

   To obtain the and values, navigate to the Users page in Dynamics 365 Business Central and then click on Edit. The User Name and Web Service Access Key values are what you will enter as the and connection string properties. Note that the User Name is not your email address. It is a shortened user name.

   If you wish to authenticate through other methods, refer to the Help documentation.

   <configuration>
    ... 
    <connectionStrings>
    <add name="D365BusinessCentralContext" connectionString="Offline=False;OrganizationUrl=https://myaccount.financials.dynamics.com/;InitiateOAuth=GETANDREFRESH;" providerName="System.Data.CData.D365BusinessCentral" />
    </connectionStrings>
    <entityFramework>
    <providers>
    ... 
    <provider invariantName="System.Data.CData.D365BusinessCentral" type="System.Data.CData.D365BusinessCentral.D365BusinessCentralProviderServices, System.Data.CData.D365BusinessCentral.Entities.EF6" />
    </providers>
    <entityFramework>
   </configuration>
   </code> 
   

4. Add a reference to System.Data.CData.D365BusinessCentral.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 D365BusinessCentralContext. 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 D365BusinessCentralContext : DbContext {
    public D365BusinessCentralContext() { }
   
    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
    // To remove the requests to the Migration History table
    Database.SetInitializer<D365BusinessCentralContext>(null); 
    // To remove the plural names 
    modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
    } 
   }
   

7. Create another .cs file and name it after the Dynamics 365 Business Central entity you are retrieving, for example, Accounts. 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("Accounts")]
   public class Accounts {
    [System.ComponentModel.DataAnnotations.Key] 
    public System.String accountid { get; set; }
    public System.String Name { get; set; }
   }
    
   

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

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

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

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