Entity Framework 6 からDynamics NAV データに連携

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

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

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

   Dynamics NAV 接続プロパティの取得・設定方法

   Dynamics NAV に接続する前に、サーバーでOData サービスを有効にしておく必要があります。OData サービスを有効にすると、CData 製品はサーバーで発行されるあらゆるサービスにクエリできるようになります。Url を有効なDynamics NAV サーバー組織のルート（例：http://MyServer:7048）およびServerInstance（例：DynamicsNAV71）に設定します。 もしサーバーにService Default Company がない場合は、Company（例：'CRONUS Canada, Inc.'）も設定する必要があります。 マルチテナントインストールでは、Tenant にテナントId（例：'Cronus1'）を指定します。

   認証するには、User およびPassword プロパティを設定して、Dynamics NAV ログインクレデンシャルまたはWindows ユーザークレデンシャルを有効にします。 AuthScheme で適切な認証メソッドを選択します。

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