SAP SuccessFactors のデータ のPostgreSQL インターフェースを作成

PostgreSQL には多くの対応クライアントがあります。標準のドライバーからBI、アナリティクスツールまで、PostgreSQL はデータ接続の人気のインターフェースです。JDBC ドライバーを使用することで、簡単に任意の標準クライアントから接続できるPostgreSQL エントリポイントを作成できます。

SAP SuccessFactors にPostgreSQL データベースとしてアクセスするには、CData JDBC Driver for SAPSuccessFactors とJDBC foreign data wrapper (FDW) を使用します。この記事ではFDW をコンパイルしてインストールし、PostgreSQL サーバーからSAP SuccessFactors にクエリを実行します。

JDBC データソースとしてSAP SuccessFactors のデータに接続する

JDBC データソースとしてSAP SuccessFactors に接続するには、以下が必要です。

• Driver のJAR パス：JAR ファイルは、インストールディレクトリのlib サブフォルダにあります。

• Driver クラス

  cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver
  

• 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 です。

  jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;
  

JDBC FDW を構築する

FDW は、PostgreSQL を再コンパイルせずに、PostgreSQL の拡張機能としてインストールできます。例としてjdbc2_fdw 拡張子を使用します。

1. ご使用のバージョンのJRE 共有オブジェクトから、/usr/lib/libjvm.so にシンボリックリンクを追加します。コマンド例：

   ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
   

2. ビルドするには、以下のコマンドを実行してください。

   make install USE_PGXS=1
   

SAP SuccessFactors のデータをPostgreSQL データベースとしてクエリする

拡張機能をインストールした後、以下のステップに従ってSAP SuccessFactors へのクエリの実行を開始します。

1. データベースにログイン
2. データベースの拡張機能をロード

   CREATE EXTENSION jdbc2_fdw;
   

3. SAP SuccessFactors のオブジェクトを作成

   CREATE SERVER SAPSuccessFactors
   FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
   drivername 'cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver',
   url 'jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;',
   querytimeout '15',
   jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.sapsuccessfactors.jar');
   

4. PostgreSQL デーモンに認識されているユーザーのユーザー名とパスワードのユーザーマッピングを作成

   CREATE USER MAPPING for postgres SERVER SAPSuccessFactors OPTIONS (
   username 'admin',
   password 'test');
   

5. ローカルデータベースに外部テーブルを作成

   postgres=# CREATE FOREIGN TABLE extaddressinfo (
   extaddressinfo_id text,
   extaddressinfo_address1 text,
   extaddressinfo_zipCode numeric)
   SERVER SAPSuccessFactors OPTIONS (
   table_name 'extaddressinfo');
   

postgres=# SELECT * FROM extaddressinfo;

おわりに

このようにCData JDBC Driver for SAPSuccessFactors を使って簡単にSAP SuccessFactors のデータを取得して検索対象にすることができました。ぜひ、30日の無償評価版 をお試しください。