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

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

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

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

   これらのプロパティは会社のファイルに接続するときに必要です（クラウドインスタンスおよびオンプレミスインスタンスの両方）。

   • User：会社のファイルに紐づいているユーザー名。
   • Password：会社のファイルに紐づいているパスワード。
   • CompanyFileId：会社ファイルのID。指定しない場合は、最初に返された会社ファイルのID が使用されます。CompanyFiles ビュー をクエリしてこれを見ることができます:
     

     SELECT Id FROM CompanyFiles

   オンプレミスインスタンスへの接続：

   InitiateOAuth:OFF に設定。

   オンプレミスインスタンスに接続する場合は、上記に加えて、次の接続プロパティを設定する必要があります。

   • Url: MYOB インスタンスのURL。

   クラウドインスタンスへの接続：

   MYOB のクラウドインスタンスに接続するには、OAuth アプリを作成する必要があります。このプロセスの詳細は、ヘルプの「カスタムOAuth アプリの作成」を参照してください。

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