Entity Framework 6 からSalesforce Marketing のデータに連携

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

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

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

   Salesforce Marketing Cloud API への認証

   User およびPassword をログインクレデンシャルに設定するか、sandbox アカウントに接続する場合はsandbox ユーザーのクレデンシャルに設定します。

   Salesforce Marketing Cloud API への接続

   デフォルトでは、CData 製品は本番環境に接続します。Salesforce Marketing Cloud sandbox アカウントを使用するには、UseSandbox をtrue に設定します。

   デフォルトのインスタンスは、Web Services API s7 です。他のインスタンスを使用する場合は、Instance を設定できます。

   <configuration> ... <connectionStrings> <add name="SFMarketingCloudContext" connectionString="Offline=False;User=myUser;Password=myPassword;" providerName="System.Data.CData.SFMarketingCloud" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.SFMarketingCloud" type="System.Data.CData.SFMarketingCloud.SFMarketingCloudProviderServices, System.Data.CData.SFMarketingCloud.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.SFMarketingCloud.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はSFMarketingCloudContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class SFMarketingCloudContext :DbContext { public SFMarketingCloudContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<SFMarketingCloudContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSalesforce Marketing のエンティティ、例えばSubscriber にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Subscriber { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String Id { get; set; } } public class SubscriberMap :EntityTypeConfiguration<Subscriber> { public SubscriberMap() { this.ToTable("Subscriber"); this.HasKey(Subscriber => Subscriber.Id); this.Property(Subscriber => Subscriber.Id); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<Subscriber> Subscriber { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： SFMarketingCloudContext context = new SFMarketingCloudContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Subscriber select line;