Entity Framework 6 からPCA Accounting データに連携

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

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

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

   PCA クラウド会計DX では、OAuth 2 認証標準を使います。

   ユーザー資格情報の接続プロパティを設定せずに接続できます。接続に最小限必要な接続プロパティは、次のとおりです。

   • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使って、OAuth 交換や、手動での接続文字列のアクセストークン設定の繰り返しを避けられます。
   • OAuthClientId：アプリケーション設定のクライアントId に設定。
   • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
   • CallbackURL：アプリケーション設定のリダイレクトURL に設定。
   • ApiVersion：接続するPCA API Server バージョンを設定。
   • DefaultDataArea：接続するデータ領域を設定。
   • DataCenter：接続するサーバーのDataCenter 名を設定。
   • ProductCode：PCA 製品コード名を設定。
   • InputModuleName：PCA InputSlip のInputModuleName を設定。

   接続すると、CData 製品はデフォルトブラウザでPCA Accounting OAuth エンドポイントを開きます。ログインして、CData 製品にアクセス許可を与えます。CData 製品がOAuth プロセスを完了します。

   ヘッドレスマシンの認証など、他のOAuth 認証フローについては、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

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