ETL ツールのEmbulk を使ってSAP SuccessFactors のデータをDB にロードする方法

OSS のETL ツールEmbulk のJDBC Plugin を使って、SAP SuccessFactors のデータを簡単にDB に同期する方法をご紹介します。

杉本和也
リードエンジニア

最終更新日:2023-10-13

この記事で実現できるSAP SuccessFactors 連携のシナリオ

こんにちは!リードエンジニアの杉本です。

Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for SAPSuccessFactors を使って、SAP SuccessFactors のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。

Embulk でSAP SuccessFactors のデータをロード

  • CData JDBC Driver for SAPSuccessFactors をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
  • 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
    C:\Program Files\CData\CData JDBC Driver for SAPSuccessFactors 2019J\lib\cdata.jdbc.sapsuccessfactors.jar
  • 次に、EmbulkとCData JDBC Driverをつなぎこむための、JDBC Input Plugin をインストールします。以下のリンクからダウンロードできます。

    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

    インストール用のコマンドはこちら:

    embulk gem install embulk-input-jdbc
  • 今回はロード先DB としてMySQL を使います。ほかにもSQL Server、PostgreSQL、Google BigQuery などを使うことも可能です。ロードに必要な以下のプラグインをインストールしましょう。

    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

    コマンドはこちら。

    embulk gem install embulk-output-mysql
  • config ファイルを作成し、SAP SuccessFactors -> MySQL のジョブを作成します。sapsuccessfactors-mysql.yml というファイル名で、以下の内容で作成しました。
  • in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for SAPSuccessFactors 2025J\lib\cdata.jdbc.sapsuccessfactors.jar driver_class: cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver url: jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com; table: "ExtAddressInfo" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "ExtAddressInfo" mode: insert
  • JDBC URL の内容は、ご利用の環境や資格情報を入力してください。

    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 に設定。
  • テーブル名は取得したいテーブル名を入れます。
  • これで準備完了です。あとは「embulk run」で実行するだけです。
  • embulk run sapsuccessfactors-mysql.yml
  • 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。

クエリ条件でフィルタリングしたデータのロード

ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for SAPSuccessFactors 2019J\lib\cdata.jdbc.sapsuccessfactors.jar driver_class: cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver url: jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com; query: "SELECT address1, zipCode FROM ExtAddressInfo WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "ExtAddressInfo" mode: insert

おわりに

CData JDBC Driver for SAPSuccessFactors をEmbulk で使うことで、SAP SuccessFactors と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。