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

   Connect to ADP by specifying the following properties:

   • OAuthClientId: The client Id of the custom OAuth application you obtained from ADP.
   • OAuthClientSecret: The custom OAuth application's client secret.
   • SSLClientCert: Set this to the certificate provided during registration.
   • SSLClientCertPassword: Set this to the password of the certificate.
   • UseUAT: The connector makes requests to the production environment by default. If using a developer account, set UseUAT = true.
   • RowScanDepth: The maximum number of rows to scan for the custom fields columns available in the table. The default value will be set to 100. Setting a high value may decrease performance.

   The connector uses OAuth to authenticate with ADP. OAuth requires the authenticating user to interact with ADP using the browser. OAuth access can be configured in ADP through ADP API Central. For more information, refer ADP's API Central Quick Start Guide and the OAuth section in CData's Help documentation.

   <configuration>
    ... 
    <connectionStrings>
    <add name="ADPContext" connectionString="Offline=False;OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\cert.pfx';SSLClientCertPassword='admin@123';InitiateOAuth=GETANDREFRESH;" providerName="System.Data.CData.ADP" />
    </connectionStrings>
    <entityFramework>
    <providers>
    ... 
    <provider invariantName="System.Data.CData.ADP" type="System.Data.CData.ADP.ADPProviderServices, System.Data.CData.ADP.Entities.EF6" />
    </providers>
    <entityFramework>
   </configuration>
   </code> 
   

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

7. Create another .cs file and name it after the ADP entity you are retrieving, for example, Workers. 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("Workers")]
   public class Workers {
    [System.ComponentModel.DataAnnotations.Key] 
    public System.String AssociateOID { get; set; }
    public System.String WorkerID { get; set; }
   }
    
   

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

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

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

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