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

   SAP SuccessFactors LMS uses OAuth authentication. Before connecting, you must configure an OAuth application tied to your SAP SuccessFactors LMS account.

   To establish a connection, set the following properties:

   • User: Your SAP SuccessFactors LMS username.
   • CompanyId: Your SAP SuccessFactors company identifier.
   • Url: The SAP SuccessFactors API URL (e.g., https://api4.successfactors.com).
   • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
   • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

   See the Getting Started chapter of the help documentation for a guide to creating a custom OAuth app and using OAuth.

   <configuration>
    ... 
    <connectionStrings>
    <add name="SAPSuccessFactorsLMSContext" connectionString="Offline=False;User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;InitiateOAuth=GETANDREFRESH;" providerName="System.Data.CData.SAPSuccessFactorsLMS" />
    </connectionStrings>
    <entityFramework>
    <providers>
    ... 
    <provider invariantName="System.Data.CData.SAPSuccessFactorsLMS" type="System.Data.CData.SAPSuccessFactorsLMS.SAPSuccessFactorsLMSProviderServices, System.Data.CData.SAPSuccessFactorsLMS.Entities.EF6" />
    </providers>
    <entityFramework>
   </configuration>
   </code> 
   

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

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

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

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

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

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