JDBI からSAP SuccessFactors データのデータアクセスオブジェクトを作成

JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for SAPSuccessFactors は、Java アプリケーションとリアルタイムSAP SuccessFactors のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、SAP SuccessFactors のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するSAP SuccessFactors のデータ の読み書きのためのコードの作成について説明します。

SAP SuccessFactors ExtAddressInfo Entity のDAO を作成

以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。

public interface MyExtAddressInfoDAO {
  //insert new data into SAP SuccessFactors
  @SqlUpdate("INSERT INTO ExtAddressInfo (city, zipCode) values (:city, :zipCode)")
  void insert(@Bind("city") String city, @Bind("zipCode") String zipCode);

  //request specific data from SAP SuccessFactors (String type is used for simplicity)
  @SqlQuery("SELECT zipCode FROM ExtAddressInfo WHERE city = :city")
  String findzipCodeBycity(@Bind("city") String city);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

SAP SuccessFactors への接続を開く

必要な接続プロパティを収集し、SAP SuccessFactors に接続するための適切なJDBC URL を作成します。

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

ビルトイン接続文字列デザイナー

JDBC URL の構成については、SAP SuccessFactors JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.sapsuccessfactors.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

SAP SuccessFactors の接続文字列は、通常次のようになります。

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

構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。

DBI dbi = new DBI("jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;");
MyExtAddressInfoDAO dao = dbi.open(MyExtAddressInfoDAO.class);

//do stuff with the DAO

dao.close();

SAP SuccessFactors データについて

SAP SuccessFactors への接続を開いた状態で以前定義したメソッドを呼び出すだけで、SAP SuccessFactors のExtAddressInfo エンティティからデータを取得できます。

//disply the result of our 'find' method
String zipCode = dao.findzipCodeBycity("Springfield");
System.out.println(zipCode);

SAP SuccessFactors データの書き方

以前定義した方法を使用すれば、SAP SuccessFactors にデータを書き込むことも簡単になります。

//add a new entry to the ExtAddressInfo entity
dao.insert(newcity, newzipCode);

JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for SAPSuccessFactors と統合することで、SQL Object API for SAPSuccessFactors を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムSAP SuccessFactors を操作しましょう。