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

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

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

   Anaplan への認証

   ドライバーはBasic、証明書、またはOAuth による認証をサポートしています。いずれの場合も、Region をAnaplan アカウントデータがホストされているリージョン（例：US1、これがデフォルト）に設定してください。

   Basic 認証の使用

   AuthScheme をBasic に設定し、Anaplan のUser とPassword を入力します。ワークスペースがシングルサインオン（SSO）を使用している場合は、Basic 認証を使用するために Exception User として割り当てられている必要があります。

   証明書認証の使用

   AuthScheme をCertificate に設定し、Certificate、CertificateType、PrivateKey プロパティを入力します（どちらかが暗号化されている場合はCertificatePassword / PrivateKeyPassword も設定してください）。証明書は、Anaplan テナント管理者に登録されたCA 発行のX.509 証明書である必要があります。

   OAuth 認証の使用

   Anaplan でカスタムOAuth アプリケーションを登録し、以下のプロパティを設定します：

   • OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
   • OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
   • CallbackURL：アプリケーションの登録時に定義したリダイレクトURI。
   • InitiateOAuth：GETANDREFRESH に設定すると、ドライバーがOAuth トークンの交換と更新を自動的に管理します。

   カスタムOAuth アプリの作成方法とOAuth の使用方法については、ヘルプドキュメントの「はじめに」の章を参照してください。

   
   <configuration>
      ... 
     <connectionStrings>
       <add name="AnaplanContext" connectionString="Offline=False;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;Region=US1;InitiateOAuth=GETANDREFRESH;" providerName="System.Data.CData.Anaplan" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.Anaplan" type="System.Data.CData.Anaplan.AnaplanProviderServices, System.Data.CData.Anaplan.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.Anaplan.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAnaplanContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class AnaplanContext :DbContext {
   	public AnaplanContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<AnaplanContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているAnaplan のエンティティ、例えばSales にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class Sales {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String Region { get; set; }
   }
   public class SalesMap :EntityTypeConfiguration<Sales> {
   	public SalesMap() {
   		this.ToTable("Sales");
   		this.HasKey(Sales => Sales.Id);
   		this.Property(Sales => Sales.Region);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

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

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

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