Embulk を使用して SAP SuccessFactors ののデータをデータベースにロードする方法

Embulk はオープンソースのバルクデータローダーです。CData JDBC Driver for SAP SuccessFactors と組み合わせることで、SAP SuccessFactors から任意の同期先にデータを簡単にロードできます。この記事では、CData JDBC Driver for SAP SuccessFactors をEmbulk で使用してSAP SuccessFactors のデータをMySQL データベースにロードする方法を解説します。

CData JDBC Driver は、最適化されたデータ処理機能を内蔵しており、リアルタイムのSAP SuccessFactors のデータに対して比類のないパフォーマンスを発揮します。SAP SuccessFactors に対して複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接SAP SuccessFactors にプッシュし、サポートされていない操作（SQL 関数やJOIN 操作など）は組み込みのSQL エンジンを使用してクライアント側で処理します。

SAP SuccessFactors への JDBC 接続を設定

Embulk でバルクロードジョブを作成する前に、JDBC Driver のJAR ファイルのインストール場所（通常はC:\Program Files\CData\CData JDBC Driver for SAP SuccessFactors\lib）を確認しておきます。

Embulk はJDBC 接続をサポートしているため、SAP SuccessFactors に簡単に接続してSQL クエリを実行できます。バルクロードジョブを作成する前に、SAP SuccessFactors への認証用のJDBC URL を作成します。

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

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

以下は、SAP SuccessFactors への一般的なJDBC 接続文字列です。

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

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

CData JDBC Driver をインストールしてJDBC 接続文字列を作成したら、必要なEmbulk プラグインをインストールします。

Embulk の入力・出力プラグインをインストール

1. Embulk にJDBC 入力プラグインをインストールします。
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. この記事では、同期先データベースとしてMySQL を使用します。出力プラグインを使用して、SQL Server、PostgreSQL、またはGoogle BigQuery を同期先として選択することもできます。
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

入力プラグインと出力プラグインをインストールしたら、Embulk を使用してSAP SuccessFactors のデータをMySQL にロードする準備が整いました。

SAP SuccessFactors ののデータをロードするジョブを作成

まず、Embulk で設定ファイルを作成します。ファイル名はsapsuccessfactors-mysql.yml のようにします。

1. 入力プラグインのオプションには、CData JDBC Driver for SAP SuccessFactors、ドライバーJAR ファイルへのパス、ドライバークラス（例：cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver）、および上記のJDBC URL を指定します。
2. 出力プラグインのオプションには、MySQL データベースの値と認証情報を指定します。

設定ファイルのサンプル（sapsuccessfactors-mysql.yml）

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\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

ファイルを作成したら、Embulk ジョブを実行します。

embulk run sapsuccessfactors-mysql.yml

Embulk ジョブを実行すると、MySQL テーブルにSAP SuccessFactors のデータが格納されます。

フィルタリングした SAP SuccessFactors ののデータをロード

テーブルから直接データをロードするだけでなく、カスタムSQL クエリを使用してロードするデータをより詳細に制御できます。また、クエリフィールドのSQL WHERE 句で最終更新カラムを設定することで、増分ロードを実行することもできます。

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\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 SAP SuccessFactors をコネクタとして使用することで、Embulk のデータロードジョブにSAP SuccessFactors のデータを統合できます。また、200 を超えるエンタープライズデータソース向けドライバーにより、あらゆるエンタープライズSaaS、ビッグデータ、NoSQL ソースも統合できます。30日間の無料トライアルをダウンロードして、今すぐお試しください。