Entity Framework 6 からReckon Accounts Hosted のデータに連携

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

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

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

   CData 製品 はOAuth 経由でReckon Accounts Hosted にリクエストを作成します。次の接続プロパティを指定します。

   • User： 必須。企業ファイルのユーザー名。
   • Password： 必須。企業ファイルのパスワード。
   • CompanyFile: 必須。企業ファイルへのパス。
   • InitiateOAuth：アクセストークンの処理をドライバーに任せる場合はGETANDREFRESH に設定。
   • CountryVersion：デフォルトは、2021.R2.AU です。

   カスタムOAuth アプリケーションを作成し、以下の追加の接続プロパティを指定することもできます。

   • SubscriptionKey：Azure Platform 上のReckon Portal から取得したAPI キー。
   • OAuthClientId：アプリケーション設定のクライアントID に設定。
   • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
   • CallbackURL：カスタムOAuth アプリのリダイレクトURI。

   CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。ほかのOAuth 認証方法（Web、ヘッドレスなど）、カスタムOAuth アプリケーションの作成、その理由などについては、ヘルプドキュメントを参照してください。

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