DbVisualizer でSAP SuccessFactors データに連携しクエリを作成

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for SAPSuccessFactors は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでSAP SuccessFactors データへの接続を提供します。この記事では、DbVisualizer からSAP SuccessFactors データに接続する方法、およびtable エディタを使ってSAP SuccessFactors を編集、および保存する方法を説明します。

CData JDBC ドライバとは？

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

1. SAP SuccessFactors をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
2. DBeaver を含む多様なアプリケーション、ツールにSAP SuccessFactors データを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData JDBC ドライバでは、1.データソースとしてSAP SuccessFactors の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

SAP SuccessFactors データの新しいドライバー定義を作成

下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからSAP SuccessFactors データに接続します。

1. DbVisualizer で「Tools」->「Driver Manager」をクリックします。
2. 「」ボタンをクリックして新しくドライバーを作成します。
3. テンプレートは「Custom」を選択します。
4. Driver Settings タブで：
   • Name をわかりやすい名前に設定します（例：CData SAP SuccessFactors Driver）。
   • URL Format をjdbc:sapsuccessfactors: に設定します。
   • Driver artifacts and jar files (jars are loaded in order from top) セクションで：
     1. 「」ボタンをクリックして、「Add Files」に進みます。
     2. インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for SAP SuccessFactors XXXX\）の「lib」フォルダに移動します。
     3. JAR ファイル（cdata.jdbc.SAPSuccessFactors.jar）を選択して「Open」をクリックします。
5. Driver Class は自動的に入力されます。もし入力されない場合は、クラス（cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver）を選択してください。

JDBC データソースへの接続を定義

「Driver Manager」を終了し、下記の手順に従ってJDBC URL に接続プロパティを入力します。

1. 「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。

2. 「Connection」セクションで以下のオプションを設定します。

   • Database Type：ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
   • Driver Type：先ほど作成したドライバーを選択します。

   • Database URL：完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:sapsuccessfactors: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

     Basic 認証またはOAuth with SAML アサーションを使用して、SAP SuccessFactors に認証できます。

     Basic 認証

     SAP SuccessFactors に正常に認証するには、次のプロパティの値を指定する必要があります。プロバイダーは、Cookie を使用してSAP SuccessFactors によって開かれたセッションを再利用することに注意してください。つまり、セッションを開く最初のリクエストでのみクレデンシャルが使用されます。その後、SAP SuccessFactors から返されたCookie が認証に使用されます。

     • Url: Success Factors をホストするサーバーのURL に設定。一部のサーバーがリストされています。SAP support documentation（外部リンク）。
     • User: アカウントのユーザー名に設定。
     • Password: アカウントのパスワードに設定。
     • CompanyId: 会社の一意の識別子に設定。

     OAuth 認証

     アクセストークンを取得するために使用される、次のプロパティの値を指定する必要があります。

     • Url: Success Factors をホストするサーバーのURL に設定。一部のサーバーがリストされています。SAP support documentation（外部リンク）。
     • User: アカウントのユーザー名に設定。
     • CompanyId: 会社の一意の識別子に設定。
     • OAuthClientId: API Center で生成されたAPI Key に設定。
     • OAuthClientSecret: SAML アサーションの署名に使用されるX.509 プライベートキー。プライベートキーは、「Registering your OAuth Client Application」でダウンロードした証明書に記載されています。
     • InitiateOAuth: GETANDREFRESH に設定。

     組み込みの接続文字列デザイナー

     JDBC URL の作成の補助として、SAP SuccessFactors JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

     java -jar cdata.jdbc.sapsuccessfactors.jar

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

     JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。

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

     jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;
   • NOTE：Database Userid とDatabase Password は、それぞれSAP SuccessFactors のUser プロパティとPassword プロパティに対応しています。
3. 「Connection」タブで「Connect」をクリックします。

SAP SuccessFactors JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。

SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。

サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。

おわりに