DbVisualizer でSAP SuccessFactors のデータに連携しクエリを作成
CData JDBC Driver for SAPSuccessFactors は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでSAP SuccessFactors のデータへの接続を提供します。この記事では、DbVisualizer からSAP SuccessFactors のデータに接続する方法、およびtable エディタを使ってSAP SuccessFactors を編集、および保存する方法を説明します。
CData JDBC ドライバとは?
CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。
- SAP SuccessFactors をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
- DBeaver を含む多様なアプリケーション、ツールにSAP SuccessFactors のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData JDBC ドライバでは、1.データソースとしてSAP SuccessFactors の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
SAP SuccessFactors のデータの新しいドライバー定義を作成
下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからSAP SuccessFactors のデータに接続します。
- DbVisualizer で「Tools」->「Driver Manager」をクリックします。
- 「」ボタンをクリックして新しくドライバーを作成します。
- テンプレートは「Custom」を選択します。
- Driver Settings タブで:
- Name をわかりやすい名前に設定します(例:CData SAP SuccessFactors Driver)。
- URL Format をjdbc:sapsuccessfactors: に設定します。
- Driver artifacts and jar files (jars are loaded in order from top) セクションで:
- 「」ボタンをクリックして、「Add Files」に進みます。
- インストールディレクトリ(C:\Program Files\CData\CData JDBC Driver for SAP SuccessFactors XXXX\)の「lib」フォルダに移動します。
- JAR ファイル(cdata.jdbc.SAPSuccessFactors.jar)を選択して「Open」をクリックします。
- Driver Class は自動的に入力されます。もし入力されない場合は、クラス(cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver)を選択してください。
JDBC データソースへの接続を定義
「Driver Manager」を終了し、下記の手順に従ってJDBC URL に接続プロパティを入力します。
- 「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。
「Connection」セクションで以下のオプションを設定します。
- Database Type:ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
- Driver Type:先ほど作成したドライバーを選択します。
Database URL:完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:sapsuccessfactors: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。
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:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;
- NOTE:Database Userid とDatabase Password は、それぞれSAP SuccessFactors のUser プロパティとPassword プロパティに対応しています。
- 「Connection」タブで「Connect」をクリックします。
SAP SuccessFactors JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。
SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。
サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。