【徹底解説】SAP SuccessFactors とのデータ連携ができるMVC アプリケーションの作り方

この記事では、Visual Studio のウィザードを使って簡単なMVC（モデル・ビュー・コントローラ）プロジェクトを作成し、Entity Framework のメソッドを使うSAP SuccessFactors にcreate, read, update, delete (CRUD) コマンドクエリを実行する方法を説明します。

Entity Framework Model の作成

下記の手順に従って接続プロパティを保存し、データモデルのエンティティにテーブルをマップします。

1. Entity Framework 6 をお使いの場合は、あらかじめプロジェクトに SAP SuccessFactors Entity Framework プロバイダーを登録してください。詳しくは、ヘルプドキュメントの「LINQ およびEntity Framework」をご参照ください。
2. Visual Studio で新規MVC プロジェクトを作成［Internet Application］テンプレート、［Razor］ビューエンジンを選択します。この例では、プロジェクト名はMvcSAPSuccessFactorsApp です。
3. デザイナーから.edmx ファイルを追加するには、［プロジェクト］>［新しい項目の追加］をクリックします。ADO.NET Entity Data Model を選択してモデルに名前を付けたら［追加］をクリックします。この例では、モデル名はSAPSuccessFactorsModel です。
4. ［Entity Data Model］ウィザードで、［EF Designer from database］オプションを選択します。［Entity Data Model］ウィザードが表示されます。
5. ［New Connection］をクリックします。ダイアログが表示されたらCData SAP SuccessFactors のデータソースを選択します。

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">ヘルプドキュメントの「はじめに」をご確認ください。

   一般的な接続文字列は次のとおりです。

   User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;

   

7. 接続に名前を付け、資格情報などのセンシティブ情報を接続文字列に含めるかどうかを選択します。簡略化のため、この例ではセンシティブ情報をWeb.config に保存しています。

   
8. 必要なテーブルおよびビューを選択します。ここでは、ExtAddressInfo をインポートしています。また、オブジェクト名を複数形に変換するオプションは、チェックをはずしています。［Finish］をクリックして.edmx ファイルを作成します。
9. プロジェクトをビルドして完成です。

コントローラーの作成およびメソッドとビューの生成

モデルの作成とプロジェクトのビルドが終わったら、以下の手順に従ってコントローラー、ビュー、および関連するCRUD メソッドを作成できます。 ExtAddressInfo テーブルに許可されたすべてのアクションのビューは、［Views］フォルダ内のExtAddressInfo サブフォルダに.cshtml ファイルとして格納されます。

［ソリューション エクスプローラー］で［Controllers］フォルダを右クリックし、［追加］>［コントローラー］をクリックします。コントローラーにSAPSuccessFactorsController のような名前を付け、以下のオプションを設定します。

• Template：次のオプションを選択します：'Controller with read/write actions, using Entity Framework'.
• Model class：ExtAddressInfo を選択。
• Data context class：SAPSuccessFactorsEntities を選択。

これで、プロジェクトを実行できます。［Index］ビューにアクセスするには、"SAPSuccessFactors" をURL に追加します。 ［Create New］をクリックして［Create view］を選択すると、自動生成されたフォームを含むビューが作成されます。各レコードの隣にあるEdit およびDelete links をクリックして、対応するEdit またはDelete ビューを表示します。

一からコントローラーを作成

このセクションでは、ほんの数行のコードでCRUD コマンドクエリをインプリメントする方法について説明します。利用可能なウィザードは、各ステップで詳しく説明します。

このチュートリアルを始める前に、エンティティデータモデルを作成しておいてください。SAP SuccessFactors へのコマンドを実行するために、コンテキストクラスのメソッドを使用していきます。［Entity Framework Data Model］ウィザードを使ってモデルを作成する方法については、前のセクションをご参照ください。 — これはモデルファーストアプローチです。 コードファーストアプローチの利用に関する詳細は、ヘルプドキュメントの「LINQ およびEntity Framework」をご参照ください。

1. 次の例のSAPSuccessFactorsController のようにコントローラーを手動で作成するには、［ソリューション エクスプローラー］で［Controllers］フォルダを右クリックし、［追加］>［コントローラー］をクリックします。
2. ［Add Controller］ダイアログが表示されたら、［Template］メニューから'Controller with empty read/write actions' オプションを選択します。［Controller］フォルダ内にSAPSuccessFactorsController.cs が作成されます。

コンテキストの作成

以下のコードを追加し、コンテキストクラスをクラス変数としてインスタンスを生成します。この簡単な例では、コントローラーはコンテキストクラスのメソッドを直接呼び出してCRUD コマンドを実行します。

private SAPSuccessFactorsEntities db = new SAPSuccessFactorsEntities();

SAP SuccessFactors のデータエンティティの取得

レコードのリストをビューに表示するには、Index メソッドを以下のように書き換えます。このコードは、コンテキストクラスのToList() メソッドを呼び出して、レコードテーブルを表示するビューを返します。デフォルトでは、Index メソッドは空のビューを返します。

public ActionResult Index() { return View(db.ExtAddressInfo.ToList()); }

ビューを作成するには、Index メソッド内を右クリックし、［Add View］をクリックします。ウィザードが表示されたら新しいビューIndex.cshtml を作成します。作成されたビューは［Views］フォルダに格納されます。このビューをロードするには、.cshtml ファイルを右クリックして［View In Page Inspector］をクリックします。

［Add View］ダイアログでビューに名前を付け、以下のオプションを設定します：

• Create a strongly typed view：このオプションを選択し、ExtAddressInfo タイプのビューを作成。
• Model class：ExtAddressInfo エンティティ、ExtAddressInfo を選択。
• Scaffold template：［List］を選択。このメニューオプションは、エンティティを表示するHTML テーブルを生成します。

SAP SuccessFactors データエンティティの作成

レコードを作成するには、フォームにユーザーが送ったExtAddressInfo エンティティを受け取るビューを作成しておく必要があります。以下の手順に従って、create アクションをインプリメントします。

1. HttpPost 属性をアノテーションする2つ目のCreate メソッドをオーバーライドします。このメソッドは、ユーザーがsubmits it back したときにデータを処理します。最初のメソッドはフォームを表示するだけなので、この動作をオーバーライドする必要はありません。
2. デフォルトでインプットされたFormCollection を、ユーザーに作成を許可したいSAP SuccessFactors エンティティのタイプに置き換えます。

3. 以下のコードを追加して、Entity Framework 経由で新しいレコードを追加します。次のサンプルコードでは、コンテキストのAdd およびSaveChanges メソッドは、レコードを挿入するために呼び出されます。

   [HttpPost] public ActionResult Create(ExtAddressInfo extaddressinfo) {
   	try {
   		db.ExtAddressInfo.Add(extaddressinfo);
   		db.SaveChanges();
   		return RedirectToAction("Index");
   	} catch { return View(); }
   }
   

Create アクションのために追加する必要があるビューは１つだけです。新しいビューCreate.cshtml は、Index.cshtml と並んでViews のSAP SuccessFactors サブフォルダに追加されます。どちらかのCreate メソッド内を右クリックし、［Add］>［View］をクリックします。［Add View］ダイアログが表示されたら、以下のオプションを設定します。

• Create a strongly typed view：このオプションを選択し、ExtAddressInfo タイプのビューを作成。
• Model class：ExtAddressInfo エンティティを選択。
• Scaffold template：［Create］を選択し、フォーム用にHTML を生成。

SAP SuccessFactors のデータエンティティの編集および保存

SAP SuccessFactors 内のレコードを編集するには、Create メソッド同様に、ビューから入力された値を受け取りデータソースにコマンドを実行する必要があります。さらに、Edit アクションのもう一つのアスペクトも定義が必要です：コントローラーのEdit メソッドで、コンテキストを変更されたエンティティの状態に更新します。これら3つのステップを以下に示します。

1. 最初のEdit メソッドをオーバーライドして、コードを次のように書き換えます。ユーザーがExtAddressInfo のEdit link をクリックすると、このメソッドは選択されたExtAddressInfo エンティティをビューに送り、フォーム内での修正が可能になります。

   public ActionResult Edit(int id) { return View(db.ExtAddressInfo.Find(id)); }
     

2. 最初のEdit メソッドを右クリックし、［Add］>［View］をクリックします。Create アクション同様、必要なEdit ビューは1つだけです。ウィザードが表示されたら、以下のオプションを設定します：
   • Create a strongly typed view：このオプションを選択し、ExtAddressInfo タイプのビューを作成。ExtAddressInfo を選択。
   • Model class：ExtAddressInfo エンティティを選択。
   • Scaffold template：［Edit］を選択し、フォーム用にHTML を生成。

3. 以下のサンプルコードで、2つ目のEdit メソッドをオーバーライドします。HttpPost 属性によってアノテーションされると、このメソッドはユーザーがフォームの変更を送信するときにビューからデータを受け取ります。

   送信された値がExtAddressInfo レコードの更新に使える値である場合は、SAP SuccessFactors はSaveChanges メソッドが呼び出されたときに更新されます。提供されたデータ型が正しくないなど、送信された値が有効でない場合は、それらはフォームに再表示されます。

   最初のEdit メソッドで作成したビューは、フォームを表示します。Edit ビューは、エラーメッセージを表示するHtml.ValidationMessageFor helper も含みます。

   [HttpPost] public ActionResult Edit(ExtAddressInfo extaddressinfo) {
   	if (ModelState.IsValid) {
   		db.Entry(extaddressinfo).State = EntityState.Modified;
   		db.SaveChanges();
   		return RedirectToAction("Index");
   	}
   	return View(extaddressinfo);
   }
   

SAP SuccessFactors のデータエンティティの削除

以下のコードは、最初のDelete メソッド用のコードで、削除するExtAddressInfo エンティティのビューを返します。

public ActionResult Delete(string id) {
	ExtAddressInfo extaddressinfo = db.ExtAddressInfo.Find(id);
	return View(extaddressinfo);
}

このメソッド内を右クリックし、［Add］>［View］をクリックします。ダイアログが表示されたら、以下の情報を入力します。

• Create a strongly typed view：このオプションを選択し、ExtAddressInfo タイプのビューを作成。
• Model class：ExtAddressInfo エンティティを選択。
• Scaffold template：［Delete］を選択し、フォーム用にHTML を生成。

ビューを作成したら、DeleteConfirmed メソッドに次のコードを使います。ユーザーから削除を確認するポストバックを受け取ったときにエンティティを削除します。

[HttpPost, ActionName("Delete")] public ActionResult DeleteConfirmed(string id) {
	ExtAddressInfo extaddressinfo = db.ExtAddressInfo.Find(id);
	db.ExtAddressInfo.Remove(extaddressinfo);
	db.SaveChanges();
	return RedirectToAction("Index");
}