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

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

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

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

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

   Acumatica への接続

   Acumatica データソースに接続するには、次の接続プロパティを指定する必要があります。

   • Url：（必須）Acumatica ERP インスタンスのベースURL。例：https://domain.acumatica.com/。
   • Schema：（オプション）異なるデータを含む2つのスキーマがあります。デフォルトはREST で、Acumatica REST コントラクトベースのAPI を使用し、OData スキーマはAcumatica OData API を使用します。OData スキーマはAcumatica Generic Inquiries へのクエリに使用されます。
   • Company：（一部必須）会社名またはテナント名に設定。Schema がOData に設定されている場合は必須です。
   • EndpointVersion：（オプション）Web Services エンドポイントのバージョン。例：17.200.001。これはREST スキーマにのみ適用されます。
   • EndpointName：（オプション）Web Services エンドポイントの名前。例：Default。これはREST スキーマにのみ適用されます。
   詳細はヘルプドキュメントの「接続の確立」セクションを参照してください。

   Acumatica への認証

   Acumatica データソースへの接続に使用できる認証方法は2つあります。Basic およびOAuth です。 Basic 認証では、AuthScheme をBasic に設定し、User とPassword をログイン資格情報に設定します。 OAuth 認証については、ヘルプドキュメントの「接続の確立」セクションにある「OAuth」を参照してください。

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