JReport Designer で SAP SuccessFactors ののデータを連携利用

Jerod Johnson
Senior Technology Evangelist

JReport Designer で SAP SuccessFactors のデータをもとにチャートとレポートを作成。

CData JDBC Driver for SAP SuccessFactors のデータを使えば、ダッシュボードやレポートから SAP SuccessFactors をリレーショナルデータベースのように扱い、使い慣れた SQL クエリで SAP SuccessFactors のデータのライブデータにアクセスできます。この記事では、JReport Designer で SAP SuccessFactors のデータに JDBC データソースとして接続し、SAP SuccessFactors のデータのデータをもとにレポートを作成する方法を説明します。

SAP SuccessFactors ののデータに接続

C:\JReport\Designer\bin\setenv.bat を編集して、JAR ファイルの場所を ADDCLASSPATH 変数に追加します。

...
set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for SAP SuccessFactors 2016\lib\cdata.jdbc.sapsuccessfactors.jar;
...

File メニューから New、Data Source と進み、新しいデータソースを作成します。
表示されるダイアログでデータソース名を入力し（例：CData JDBC Driver for SAP SuccessFactors）、JDBC を選択して OK をクリックします。
Get JDBC Connection Information ダイアログで、JDBC ドライバーへの接続を設定します。
- Driver: Driver ボックスにチェックが入っていることを確認し、ドライバーのクラス名を入力します。
```
cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver
```
- URL: JDBC URL を入力します。URL は jdbc:sapsuccessfactors: から始まり、その後に接続プロパティをセミコロン区切りで記述します。
  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
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  JDBC URL を設定する際には、Max Rows 接続プロパティの設定も検討してください。これにより返される行数が制限され、レポートやビジュアライゼーションのデザイン時のパフォーマンス向上に役立ちます。
  
  一般的な JDBC URL は次のとおりです。
```
jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;
```
- User: 認証に使用するユーザー名です。通常は空白のままにします。
- Password: 認証に使用するパスワードです。通常は空白のままにします。
Add Table ダイアログで、レポートに含めるテーブル（または、このデータソースを使用する今後のレポート用のテーブル）を選択し、Add をクリックします。

テーブルの読み込みが完了したら Done をクリックします。
Catalog Browser で、レポートを作成するためのクエリを作成できます。これはレポート作成前でも作成後でも行えます。データソース（CData JDBC Driver for SAP SuccessFactors）を展開（）し、Queries を右クリックして Add Query を選択します。
Add Table/View/Query ダイアログで、JDBC URL と Tables を展開（）し、クエリで使用するテーブルを選択して OK をクリックします。
Query Editor ダイアログで、含めるカラムを選択するか、SQL ボタンをクリックして独自のクエリを手動で入力します。例えば次のようになります。
```
SELECT address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'
```
クエリが構築できたら、OK をクリックして Query Editor ダイアログを閉じます。これで SAP SuccessFactors のデータを新規または既存のレポートに追加する準備が整いました。

NOTE: クエリが構築できたら、そのクエリをもとに Business View を作成できます。Business View を使用すると、クエリに基づいた Web レポートやライブラリコンポーネントを作成できます。詳しくは、JReport のチュートリアルを参照してください。