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

   Before establishing a connection, supply the SubscriptionKey, found in the Blackbaud Raiser's Edge NXT Profile.

   Authenticating to Raiser's Edge NXT

   Blackbaud Raiser's Edge NXT uses the OAuth authentication standard. You can connect to without setting any connection properties using the embedded OAuth credentials.

   Alternatively, you can authenticate by creating a custom app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

   See the Help documentation for an authentication guide.

   <configuration>
    ... 
    <connectionStrings>
    <add name="RaiserEdgeNXTContext" connectionString="Offline=False;SubscriptionKey=MySubscriptionKey;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH;" providerName="System.Data.CData.RaiserEdgeNXT" />
    </connectionStrings>
    <entityFramework>
    <providers>
    ... 
    <provider invariantName="System.Data.CData.RaiserEdgeNXT" type="System.Data.CData.RaiserEdgeNXT.RaiserEdgeNXTProviderServices, System.Data.CData.RaiserEdgeNXT.Entities.EF6" />
    </providers>
    <entityFramework>
   </configuration>
   </code> 
   

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

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

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

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

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

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