How to Access Epicor Kinetic 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 Epicor Kinetic 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 Epicor Kinetic Entity Framework 6 assembly and the connection string.

   To successfully connect to your ERP instance, you must specify the following connection properties:

   • Url:the URL of the server hosting your ERP instance. For example, https://myserver.EpicorSaaS.com
   • ERPInstance: the name of your ERP instance.
   • User: the username of your account.
   • Password: the password of your account.
   • Service: the service you want to retrieve data from. For example, BaqSvc.

   In addition, you may also set the optional connection properties:

   • ApiKey: An optional key that may be required for connection to some services depending on your account configuration.
   • ApiVersion: Defaults to v1. May be set to v2 to use the newer Epicor API.
   • Company: Required if you set the ApiVersion to v2.
   <configuration> ... <connectionStrings> <add name="epicorKineticContext" connectionString="Offline=False;Service=Erp.BO.CustomerSvc;ERPInstance=MyInstance;URL=https://myaccount.epicorsaas.com;User=username;Password=password;InitiateOAuth=GETANDREFRESH" providerName="System.Data.CData.epicorKinetic" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.epicorKinetic" type="System.Data.CData.epicorKinetic.epicorKineticProviderServices, System.Data.CData.epicorKinetic.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. Add a reference to System.Data.CData.epicorKinetic.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 epicorKineticContext. 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 epicorKineticContext : DbContext { public epicorKineticContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<epicorKineticContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. Create another .cs file and name it after the Epicor Kinetic entity you are retrieving, for example, Customers. 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("Customers")] public class Customers { [System.ComponentModel.DataAnnotations.Key] public System.String CustNum { get; set; } public System.String Company { get; set; } }
8. Now that you have created an entity, add the entity to your context class: public DbSet<Customers> Customers { set; get; }
9. With the context and entity finished, you are now ready to query the data in a separate class. For example: epicorKineticContext context = new epicorKineticContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Customers select line;