Elasticsearch へLogstash 経由でSAP SuccessFactors のデータをロードする方法

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

Elasticsearch は、人気の分散型全文検索エンジンです。データを一元的に格納することで、超高速検索や、関連性の細かな調整、パワフルな分析が大規模に、手軽に実行可能になります。Elasticsearch にはデータのローディングを行うパイプラインツール「Logstash」があります。CData Drivers を利用することができるので、30日の無償評価版をダウンロードしてあらゆるデータソースを簡単にElasticsearch に取り込んで検索・分析を行うことができます。

この記事では、CData Driver for SAPSuccessFactors を使って、SAP SuccessFactors のデータをLogstash 経由でElasticsearch にロードする手順を説明します。

Elasticsearch Logstash でCData JDBC Driver for SAPSuccessFactors を使用

• CData JDBC Driver for SAPSuccessFactors をLogstash が稼働するマシンにインストールします。
• 以下のパスにJDBC Driver がインストールされます（2022J の部分はご利用される製品バージョンによって異なります）。後ほどこのパスを使います。この.jar ファイル（製品版の場合は.lic ファイルも）をLogstash に配置します。
  C:\Program Files\CData\CData JDBC Driver for SAPSuccessFactors 2022J\lib\cdata.jdbc.sapsuccessfactors.jar
  
• 次に、Logstash とCData JDBC ドライバをつなぐ、JDBC Input Plugin をインストールします。JDBC Plugin は最新のLogstash だとデフォルトでついてきますが、バージョンによっては追加する必要があります。
  https://www.elastic.co/guide/en/logstash/5.4/plugins-inputs-jdbc.html
• CData JDBC ドライバの.jar ファイルと.lic ファイルを、Logstashの「/logstash-core/lib/jars/」に移動します。

Logstash でElasticsearch にSAP SuccessFactors のデータを送る

それでは、Logstash でElasticsearch にSAP SuccessFactors のデータの転送を行うための設定ファイルを作成していきます。

• Logstash のデータ処理定義であるlogstash.conf ファイルにSAP SuccessFactors のデータを取得する処理を書きます。Input はJDBC、Output はElasticsearch にします。データローディングジョブの起動間隔は30秒に設定しています。
• CData JDBC ドライバの.jar をjdbc driver ライブラリにして、クラス名を設定、SAP SuccessFactors への接続プロパティをJDBC URL の形でせっていします。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 に設定。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.sapsuccessfactors.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver"
                    jdbc_connection_string => "jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'"
                }
            }


            output {
                Elasticsearch {
                    index => "sapsuccessfactors_ExtAddressInfo"
                    document_id => "xxxx"
                }
            }
        

Logstash でSAP SuccessFactors のローディングを実行

それでは作成した「logstash.conf」ファイルを元にLogstash を実行してみます。

成功した旨のログが出ます。これでSAP SuccessFactors のデータがElasticsearch にロードされました。

例えばKibana で実際にElasticsearch に転送されたデータを見てみます。

        GET sapsuccessfactors_ExtAddressInfo/_search
        {
            "query": {
                "match_all": {}
            }
        }
    

データがElasticsearch に格納されていることが確認できました。

CData JDBC Driver for SAPSuccessFactors をLogstash で使うことで、SAP SuccessFactors コネクタとして機能し、簡単にデータをElasticsearch にロードすることができました。ぜひ、30日の無償評価版をお試しください。