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

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

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

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

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

   独自のWeb サービスクレデンシャル、埋め込みクレデンシャル（Basic 認証）、またはOkta クレデンシャルのいずれかを使用して、Sage Intacct への接続を確立できます。

   Sage Intacct への認証

   Sage Intacct は2種類の認証をサポートします。Basic およびOkta です。選択した認証方法に関連するプロパティを設定して、接続を構成します。

   Basic 認証

   Basic 認証スキームでは、埋め込みクレデンシャルを使用してデータの読み書きが可能です。オプションとして、独自のWeb サービスクレデンシャルを指定することもできます。

   Basic 認証を使用して認証を行うには、以下のプロパティを設定します。

   • AuthScheme：Basic。
   • CompanyID：Sage Intacct にログインする際に会社を識別するために使用するID。
   • User：Sage Intacct へのログインに使用するログイン名。
   • Password：ログインクレデンシャル用のパスワード。
   • （オプション）SenderID およびSenderPassword：Web サービスのSender ID およびパスワード。
   Okta 認証についてはヘルプドキュメントを参照してください。
   <configuration> ... <connectionStrings> <add name="SageIntacctContext" connectionString="Offline=False;User=myusername;CompanyId=TestCompany;Password=mypassword;SenderId=Test;SenderPassword=abcde123;" providerName="System.Data.CData.SageIntacct" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.SageIntacct" type="System.Data.CData.SageIntacct.SageIntacctProviderServices, System.Data.CData.SageIntacct.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.SageIntacct.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はSageIntacctContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class SageIntacctContext :DbContext { public SageIntacctContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<SageIntacctContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSage Intacct のエンティティ、例えば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. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： SageIntacctContext context = new SageIntacctContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Customer select line;