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 アセンブリおよびコネクションストリングへの参照を追加します。

   SAP SuccessFactorsへの接続

   それでは、SAP SuccessFactors に接続していきましょう。CData 製品は、デフォルトで有効になっているOData API を介してSAP SuccessFactors と通信します。追加の権限が必要な場合は、SAP サポートサイトをご確認ください。

   認証方法として、Azure AD 認証、SAP IAS 認証、OAuth 認証（推奨）、Basic 認証（非推奨）のいずれかを使用してSAP SuccessFactors に認証できます。

   必要な接続プロパティ

   選択したAuthScheme に関わらず、SAP SuccessFactors 環境を識別するために以下の接続プロパティを設定しましょう。

   • URL：SuccessFactors をホストするサーバーのURL
   • CompanyId：SAP SuccessFactors テナントに割り当てられた一意の識別子。この値はAPI 認証に必要で、組織固有のものです

   OAuth 認証

   SAP SuccessFactors では、OAuth 認証を2種類のグラント種別でサポートしています。

   • SAP SuccessFactors LMS インスタンスのクライアントグラント種別
   • SAML-2 Bearer グラント種別

   OAuth 認証を有効にするには、すべてのOAuth フローでカスタムOAuth アプリケーションを作成し、適切なプロパティを設定する必要があります。

   デスクトップアプリケーションでカスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。

   OAuth アクセストークンの取得およびリフレッシュ

   以下のプロパティを設定してください。

   • InitiateOAuth：GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します
   • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId
   • CallbackURL：カスタムOAuth アプリケーションの登録時に定義されたリダイレクトURI
   • OAuthClientSecret （クライアントグラント種別のみ）：アプリケーションの登録時に割り当てられたクライアントシークレット
   • PrivateKey （SAML-2 Bearer グラント種別のみ）：カスタムOAuth アプリケーションの作成時にダウンロードした秘密鍵証明書のパス、またはその証明書のbase64 でエンコードされた内容

   接続すると、CData 製品がデフォルトブラウザでSAP SuccessFactors のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

   アプリケーションにアクセス許可を与えると、CData 製品がOAuth プロセスを完了します。

   1. CData 製品がSAP SuccessFactors からアクセストークンを取得し、それを使ってデータをリクエストします
   2. OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます

   アクセストークンの期限が切れた際は、CData 製品が自動でアクセストークンをリフレッシュします。

   カスタムOAuth アプリケーションの作成やその他の認証方法については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご確認ください。

   
   <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;