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

   The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

   You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

   Additionally, specify the URL to the SugarCRM account.

   Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

   <configuration>
    ... 
    <connectionStrings>
    <add name="SugarCRMContext" connectionString="Offline=False;User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;" providerName="System.Data.CData.SugarCRM" />
    </connectionStrings>
    <entityFramework>
    <providers>
    ... 
    <provider invariantName="System.Data.CData.SugarCRM" type="System.Data.CData.SugarCRM.SugarCRMProviderServices, System.Data.CData.SugarCRM.Entities.EF6" />
    </providers>
    <entityFramework>
   </configuration>
   </code> 
   

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

7. Create another .cs file and name it after the Sugar CRM 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 Name { get; set; }
    public System.String AnnualRevenue { 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:

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