BIRT でSAP SuccessFactors のデータのレポートを作成
CData JDBC Driver for SAP SuccessFactors は、データドリブンな Java アプリケーションにSAP SuccessFactors API への接続機能を統合します。CData JDBC Driver for SAP SuccessFactors を BIRT(Business Intelligence Reporting Tools)プラットフォームと組み合わせることで、データの変更をリアルタイムに反映する BIRT レポートを作成できます。
- まだインストールしていない場合は、BIRT Framework プラグインと Database Development プラグインを Eclipse にインストールします。
- 「File」->「New」->「Report」をクリックします。Report Design パースペクティブが開きます。
- Data Explorer で「Data Sources」を右クリックし、「New Data Source」をクリックします。
- 「Create from a Data Source Type in the Following List」オプションを選択し、「JDBC Data Source」を選択します。
- 「Manage Drivers」をクリックし、インストールフォルダの lib サブフォルダにあるドライバー JAR を追加します。
- 「Database URL」ボックスに、接続文字列を含む 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 プロセスを完了します。
- 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;
- 「Data Sets」フォルダを右クリックし、SAP SuccessFactors用の JDBC データソースを選択します。
- 表示されるダイアログで、レポート用のデータを取得する SELECT クエリを作成します。この記事では以下のクエリを使用します:
SELECT address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'
- 「Palette」からエディターにチャートをドラッグします。チャートウィザードが表示されます。
- チャートタイプを選択した後、「Select Data」タブでカラムをチャートフィールドにドラッグします。
- 「Run」->「View Report」->「In Web Viewer」をクリックしてレポートを表示します。
これで、BIRT レポートがSAP SuccessFactors のデータの更新を反映できるようになりました。
レポートをアプリケーションサーバーに公開するには、ドライバー JAR を BIRT Viewer のクラスパスに追加します。詳細については、Java アプリケーションサーバーへの JDBC ドライバのデプロイに関する CData KB ガイドを参照してください。