Entity Framework 6 からSAP Ariba Procurement データに連携

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

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

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

   SAP Ariba Procurement に接続するには以下を設定します。

   • ANID：Ariba Network ID。
   • API：本製品にSAP Ariba データを取得させたいAPI を指定。ビジネスロールに基づき、Buyer またはSupplier API を選択します（可能な値は、PurchaseOrdersBuyerAPIV1、または PurchaseOrdersSupplierAPIV1 です）。
   • Environment：接続先がテスト環境か本番環境かを指定（可能な値は、TEST またはPRODUCTION です）。

   OAuth 認証

   接続プロパティを設定した後、認証のためにOAuth 接続を設定する必要があります。

   • AuthScheme をOAuthClient に設定します。
   • サービスにアプリケーションを登録し、APIKey、OAuthClientId、およびOAuthClientSecret を取得する必要があります。

     OAuth アプリケーションの作成について、詳しくはヘルプドキュメントを参照してください。

   OAuth の自動リフレッシュ

   以下を設定して、接続してください。

   • APIKey：アプリケーション設定のApplication key。
   • OAuthClientId：アプリケーション設定のOAuth Client Id。
   • OAuthClientSecret：アプリケーション設定のOAuth Secret。

   接続すると、本製品は自動でOAuth プロセスを完了します。

   1. 本製品はSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします。
   2. 本製品はアクセストークンの期限が切れると自動的にリフレッシュします。
   3. TOAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます。
   <configuration> ... <connectionStrings> <add name="SAPAribaProcurementContext" connectionString="Offline=False;ANID=AN02000000280;API=PurchaseOrdersBuyerAPI-V1;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;AuthScheme=OAuthClient;" providerName="System.Data.CData.SAPAribaProcurement" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.SAPAribaProcurement" type="System.Data.CData.SAPAribaProcurement.SAPAribaProcurementProviderServices, System.Data.CData.SAPAribaProcurement.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.SAPAribaProcurement.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はSAPAribaProcurementContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class SAPAribaProcurementContext :DbContext { public SAPAribaProcurementContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<SAPAribaProcurementContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSAP Ariba Procurement のエンティティ、例えばOrders にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Orders { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String DocumentNumber { get; set; } } public class OrdersMap :EntityTypeConfiguration<Orders> { public OrdersMap() { this.ToTable("Orders"); this.HasKey(Orders => Orders.Id); this.Property(Orders => Orders.DocumentNumber); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<Orders> Orders { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： SAPAribaProcurementContext context = new SAPAribaProcurementContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Orders select line;