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

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

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

   それでは、SAP Ariba Source に接続していきましょう。接続するには、以下のプロパティを設定します。

   • API：CData 製品にSAP Ariba データを取得させたいAPI を指定してください。ビジネスロールに基づき、Supplier、Sourcing Project Management、またはContract API を選択します（可能な値は、SupplierDataAPIWithPaginationV4、SourcingProjectManagementAPIV2、または ContractAPIV1 です）
   • DataCenter：アカウントのデータがホストされているデータセンター
   • Realm：アクセスしたいサイト名
   • Environment：テスト環境、または本番環境のいずれかを指定してください。（可能な値は、TEST またはPRODUCTION）

   Supplier Data API またはContract API に接続する場合は、さらに以下のプロパティも設定してください。

   • User：API 呼び出しを行うユーザーのId
   • PasswordAdapter：認証するUser に関連付けられたパスワード

   Supplier API に接続している場合は、ProjectId をデータを取得したいソーシングプロジェクトのId に設定してください。

   OAuth 認証

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

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

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

   OAuth の自動リフレッシュ

   以下のプロパティを設定して、接続してみましょう。

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

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

   1. CData 製品がSAP Ariba からアクセストークンを取得し、それを使ってデータをリクエストします
   2. CData 製品がアクセストークンの期限が切れると自動的にリフレッシュします
   3. OAuth 値はOAuthSettingsLocation で指定された場所に基づいてメモリに保存されます

   
   <configuration>
      ... <connectionStrings>
       <add name="SAPAribaSourceContext" connectionString="Offline=False;API=SupplierDataAPIWithPagination-V4;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment=SANDBOX;Realm=testRealm;AuthScheme=OAuthClient;" providerName="System.Data.CData.SAPAribaSource" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.SAPAribaSource" type="System.Data.CData.SAPAribaSource.SAPAribaSourceProviderServices, System.Data.CData.SAPAribaSource.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.SAPAribaSource.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はSAPAribaSourceContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class SAPAribaSourceContext :DbContext {
   	public SAPAribaSourceContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<SAPAribaSourceContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSAP Ariba Source のエンティティ、例えばVendors にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class Vendors {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String SMVendorID { get; set; }
   }
   public class VendorsMap :EntityTypeConfiguration<Vendors> {
   	public VendorsMap() {
   		this.ToTable("Vendors");
   		this.HasKey(Vendors => Vendors.Id);
   		this.Property(Vendors => Vendors.SMVendorID);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   public DbSet<Vendors> Vendors { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   SAPAribaSourceContext context = new SAPAribaSourceContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Vendors select line;