Apache Spark でSAP SuccessFactors のデータをSQL で操作する方法

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

CData JDBC ドライバーを使用して、Apache Spark でSAP SuccessFactors にデータ連携。

Apache Spark は大規模データ処理のための高速エンジンです。CData JDBC Driver for SAPSuccessFactors と組み合わせると、Spark はリアルタイムでSAP SuccessFactors のデータに連携して処理ができます。本記事では、Spark シェルに接続してSAP SuccessFactors をクエリする方法について解説します。

CData JDBC Driver は、最適化されたデータ処理がドライバーに組み込まれているため、リアルタイムSAP SuccessFactors と対話するための高いパフォーマンスを提供します。SAP SuccessFactors に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計など、サポートされているSQL操作を直接SAP SuccessFactors にプッシュし、組込みSQL エンジンを使用してサポートされていない操作（SQL 関数やJOIN 操作）をクライアント側で処理します。組み込みの動的メタデータクエリを使用すると、ネイティブデータ型を使用してSAP SuccessFactors を操作して分析できます。

CData JDBC Driver for SAPSuccessFactors をインストール

まずは、本記事右側のサイドバーからSAPSuccessFactors JDBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

Spark Shell を起動してSAP SuccessFactors のデータに接続

ターミナルを開き、Spark shell でCData JDBC Driver for SAPSuccessFactors JAR file をjars パラメータに設定します:
```
$ spark-shell --jars /CData/CData JDBC Driver for SAPSuccessFactors/lib/cdata.jdbc.sapsuccessfactors.jar
```
Shell でJDBC URL を使ってSAP SuccessFactors に接続し、SQL Context load() function でテーブルを読み込みます。
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
```
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
```
scala> val sapsuccessfactors_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;").option("dbtable","ExtAddressInfo").option("driver","cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver").load()
```
接続が完了し、データがロードされたら、テーブルスキーマが表示されます。
SAP SuccessFactors をテンポラリーテーブルとして登録します:
```
scala> sapsuccessfactors_df.registerTable("extaddressinfo")
```
データに対して、次のようなカスタムSQL クエリを実行します。
```
scala> sapsuccessfactors_df.sqlContext.sql("SELECT address1, zipCode FROM ExtAddressInfo WHERE city = Springfield").collect.foreach(println)
```
コンソールで、次のようなSAP SuccessFactors のデータを取得できました！これでSAP SuccessFactors との連携は完了です。