Entity Framework 6 からSAP SuccessFactors LMS のデータに連携

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

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

   SAP SuccessFactors LMS は OAuth 認証を使用します。接続する前に、SAP SuccessFactors LMS アカウントに紐づけた OAuth アプリケーションを構成する必要があります。

   接続するには、以下のプロパティを設定してください。

   • User: SAP SuccessFactors LMS のユーザー名。
   • CompanyId: SAP SuccessFactors の会社 ID。
   • Url: SAP SuccessFactors API の URL（例: https://api4.successfactors.com）。
   • OAuthClientId: カスタム OAuth アプリケーション登録時に割り当てられたクライアント ID。
   • OAuthClientSecret: カスタム OAuth アプリケーション登録時に割り当てられたクライアントシークレット。

   カスタム OAuth アプリの作成と OAuth の使用方法については、ヘルプドキュメントの「はじめに」を参照してください。

   
   <configuration>
      ... <connectionStrings>
       <add name="SAPSuccessFactorsLMSContext" connectionString="Offline=False;User=username;CompanyId=CompanyId;Url=https://api4.successfactors.com;InitiateOAuth=GETANDREFRESH;" providerName="System.Data.CData.SAPSuccessFactorsLMS" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.SAPSuccessFactorsLMS" type="System.Data.CData.SAPSuccessFactorsLMS.SAPSuccessFactorsLMSProviderServices, System.Data.CData.SAPSuccessFactorsLMS.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

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

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

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