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

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

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

   それでは、Veeva Vault アカウントに接続していきましょう。まずはUrl 接続プロパティにホスト名を設定します。ホスト名は、アカウントにログインした後にアドレスバーから確認できます。

   例：https://myvault.veevavault.com

   Veeva Vaultへの認証

   続いて、認証方法を設定しましょう。CData 製品では、以下の認証方法をサポートしています。

   • Veeva Vault ユーザー資格情報
   • Azure AD 認証プロバイダーのOpenID Connect
   • Okta SSO

   ユーザー資格情報

   最も基本的な認証方法です。AuthScheme をBasic に設定し、User とPassword にユーザーログイン資格情報を設定してください。

   その他の認証方法については、ヘルプドキュメントの「接続の確立」をご確認ください。

   
   <configuration>
      ... <connectionStrings>
       <add name="VaultCRMContext" connectionString="Offline=False;User=myuser;Password=mypassword;Server=localhost;Database=mydatabase;" providerName="System.Data.CData.VaultCRM" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.VaultCRM" type="System.Data.CData.VaultCRM.VaultCRMProviderServices, System.Data.CData.VaultCRM.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

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

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

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