FineReport で SAP SuccessFactors のデータ を利用する
CData JDBC Driver for SAP SuccessFactors は、JDBC 標準を完全に実装しており、さまざまなBI、レポート、ETL ツール、カスタムアプリケーションに SAP SuccessFactors のデータ への接続を提供します。この記事では、FineReport で SAP SuccessFactors のデータ をJDBC データソースとして設定し、レポートデザイナーで SAP SuccessFactors のデータ をテーブルとして表示する方法を説明します。
SAP SuccessFactors のデータ のJDBC データソースをセットアップする
以下の手順に従って、FineReport のデータベース接続として SAP SuccessFactors のデータ を設定します。
- CData JDBC Driver for SAP SuccessFactors のインストールディレクトリにあるlib フォルダから、cdata.jdbc.sapsuccessfactors.jar ファイルをFineReport のインストールディレクトリにあるlib フォルダにコピーします。cdata.jdbc.sapsuccessfactors.lic ファイルも同様にコピーしてください。
- ServerタブからDefine Data Connectionを選択し、クリックして新しい接続を追加してJDBCをクリックします。
続いて、ウィンドウでデータ接続の定義を設定します。
- Database: Others
- JDBC Driver: cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver
-
URL: セミコロン区切りの接続プロパティを使用した標準のJDBC 接続文字列を入力します。
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 プロセスを完了します。
- CData 製品がSAP SuccessFactors からアクセストークンを取得し、それを使ってデータをリクエストします
- OAuth 値はOAuthSettingsLocation で指定されたパスに保存されます。これらの値は接続間で永続化されます
アクセストークンの期限が切れた際は、CData 製品が自動でアクセストークンをリフレッシュします。
カスタムOAuth アプリケーションの作成やその他の認証方法については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」をご確認ください。
組み込みの接続文字列デザイナー
JDBC URL の作成には、SAP SuccessFactors JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
java -jar cdata.jdbc.sapsuccessfactors.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
JDBC URL を設定する際に、Max Rows 接続プロパティも設定しておくことをお勧めします。これにより、返される行数が制限されるため、レポートやビジュアライゼーションを設計する際のパフォーマンス向上に役立ちます。
JDBC URL の例を以下に示します。
jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com; - Connection pool attributesをクリックし、Test before getting connectionsをNoに設定します。
Test connectionをクリックして、接続が正しく設定されていることを確認します。これで、SAP SuccessFactors への接続を設定し、FineReport のデータソースとして使用できるようになります。
レポートデザイナーで SAP SuccessFactors のデータ を選択する
- クリックして新しいテンプレートデータセットを追加し、DB queryを選択してデータベースクエリウィンドウを開きます。
- ドロップダウンリストから、作成したJDBC 接続を選択します。
- 左ペインにSAP SuccessFactors のエンティティがテーブルとして表示されます。
- ロードするSAP SuccessFactors のデータ のテーブルとカラムに対してSELECT 文を記述します。
- プレビューをクリックすると、データがテーブルとして表示されます。
このように簡単な手順で、FineReport で SAP SuccessFactors をJDBC データソースとして利用できるようになります。