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

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

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

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

   Basic 認証またはOAuth with SAML アサーションを使用して、SAP SuccessFactors に認証できます。

   Basic 認証

   SAP SuccessFactors に正常に認証するには、次のプロパティの値を指定する必要があります。プロバイダーは、Cookie を使用してSAP SuccessFactors によって開かれたセッションを再利用することに注意してください。つまり、セッションを開く最初のリクエストでのみクレデンシャルが使用されます。その後、SAP SuccessFactors から返されたCookie が認証に使用されます。

   • Url: Success Factors をホストするサーバーのURL に設定。一部のサーバーがリストされています。SAP support documentation（外部リンク）。
   • User: アカウントのユーザー名に設定。
   • Password: アカウントのパスワードに設定。
   • CompanyId: 会社の一意の識別子に設定。

   OAuth 認証

   アクセストークンを取得するために使用される、次のプロパティの値を指定する必要があります。

   • Url: Success Factors をホストするサーバーのURL に設定。一部のサーバーがリストされています。SAP support documentation（外部リンク）。
   • User: アカウントのユーザー名に設定。
   • CompanyId: 会社の一意の識別子に設定。
   • OAuthClientId: API Center で生成されたAPI Key に設定。
   • OAuthClientSecret: SAML アサーションの署名に使用されるX.509 プライベートキー。プライベートキーは、「Registering your OAuth Client Application」でダウンロードした証明書に記載されています。
   • InitiateOAuth: GETANDREFRESH に設定。
   <configuration> ... <connectionStrings> <add name="SAPSuccessFactorsContext" connectionString="Offline=False;User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;" providerName="System.Data.CData.SAPSuccessFactors" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.SAPSuccessFactors" type="System.Data.CData.SAPSuccessFactors.SAPSuccessFactorsProviderServices, System.Data.CData.SAPSuccessFactors.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.SAPSuccessFactors.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はSAPSuccessFactorsContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class SAPSuccessFactorsContext :DbContext { public SAPSuccessFactorsContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<SAPSuccessFactorsContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSAP SuccessFactors のエンティティ、例えばExtAddressInfo にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class ExtAddressInfo { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String address1 { get; set; } } public class ExtAddressInfoMap :EntityTypeConfiguration<ExtAddressInfo> { public ExtAddressInfoMap() { this.ToTable("ExtAddressInfo"); this.HasKey(ExtAddressInfo => ExtAddressInfo.Id); this.Property(ExtAddressInfo => ExtAddressInfo.address1); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<ExtAddressInfo> ExtAddressInfo { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： SAPSuccessFactorsContext context = new SAPSuccessFactorsContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.ExtAddressInfo select line;