Entity Framework 6 からRaisers Edge NXT データに連携

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでRaisers Edge NXT にアクセスします。

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、Raisers Edge NXT Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

   BlackBaud Raiser's Edge NXT 接続プロパティの取得・設定方法

   接続設定の前に、BlackBaud Raiser's Edge NXT Profile にあるSubscriptionKey を取得しておいてください。

   BlackBaud Raiser's Edge NXT への認証（OAuth）

   BlackBaud Raiser's Edge NXT は、OAuth 認証規格を使用します。すべてのフローにおいて、以下の設定が必要です。

   • AuthScheme をOAuth に設定
   • SubscriptionKey をお使いのSubscription Key に設定
   • 認可アカウントでBlackBaud Raiser's Edge NXT を有効にし、結果を取得

   この設定ののち、続けてOAuth 設定を行います。設定方法は、ヘルプドキュメント の「OAuth」セクションを参照してください。

   <configuration> ... <connectionStrings> <add name="RaiserEdgeNXTContext" connectionString="Offline=False;SubscriptionKey=MySubscriptionKey;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;" 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. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.RaiserEdgeNXT.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はRaiserEdgeNXTContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   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. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているRaisers Edge NXT のエンティティ、例えばConstituents にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Constituents { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String Id { get; set; } } public class ConstituentsMap :EntityTypeConfiguration<Constituents> { public ConstituentsMap() { this.ToTable("Constituents"); this.HasKey(Constituents => Constituents.Id); this.Property(Constituents => Constituents.Id); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<Constituents> Constituents { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： RaiserEdgeNXTContext context = new RaiserEdgeNXTContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Constituents select line;