SAP SuccessFactors のデータをApache Kafka トピックにストリーミング

Dibyendu Datta
Lead Technology Evangelist

CData JDBC Driver とKafka Connect JDBC コネクタを使用して、Apache Kafka でSAP SuccessFactors のデータにアクセスし、ストリーミングできます。

Apache Kafka は、主にリアルタイムデータパイプラインやイベント駆動型アプリケーションの構築に使用されるオープンソースのストリーム処理プラットフォームです。CData JDBC Driver for SAP SuccessFactorsと組み合わせることで、Kafka はライブのSAP SuccessFactors のデータを扱うことができます。この記事では、SAP SuccessFactors データをApache Kafka トピックに接続、アクセス、ストリーミングする方法と、Confluent Control Center を起動してConfluent プラットフォームのKafka インフラストラクチャを使用して受信したSAP SuccessFactors のデータをユーザーが安全に管理および監視できるようにする方法について説明します。

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

前提条件

Apache Kafka トピックでSAP SuccessFactors のデータをストリーミングするためにCData JDBC Driver を接続する前に、クライアントのLinux ベースのシステムに以下をインストールおよび設定してください。

Confluent Platform for Apache Kafka
Confluent Hub CLI のインストール
Confluent Platform 用のSelf-Managed Kafka JDBC Source Connector

SAP SuccessFactors のデータへの新しいJDBC 接続を定義

Linux ベースのシステムにCData JDBC Driver for SAP SuccessFactorsをダウンロードします。
以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
1. SAP SuccessFactors という名前の新しいディレクトリを作成します。
```
		mkdir SAPSuccessFactors
		
```
2. ダウンロードしたドライバーファイル（.zip）をこの新しいディレクトリに移動します。
```
		mv SAPSuccessFactorsJDBCDriver.zip SAPSuccessFactors/
		
```
3. CData SAPSuccessFactorsJDBCDriver の内容をこの新しいディレクトリに解凍します。
```
		unzip SAPSuccessFactorsJDBCDriver.zip
		
```
SAP SuccessFactors ディレクトリを開き、lib フォルダに移動します。
```
ls
cd lib/
```
CData JDBC Driver for SAP SuccessFactors のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.sapsuccessfactors.jar ファイルがlib フォルダに正常にコピーされたことを確認します。
```
cp -r /path/to/CData JDBC Driver for SAP SuccessFactors/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
```
以下のコマンドを使用して、CData SAP SuccessFactors JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。
```
	java -jar cdata.jdbc.sapsuccessfactors.jar -l
	
```
プロダクトキーまたは"TRIAL" を入力します（ライセンスの有効期限が切れた場合は、CData サポートチームまでお問い合わせください）。
以下のコマンドを使用してConfluent ローカルサービスを起動します:
```
	confluent local services start
	
```
これにより、Zookeeper、Kafka、Schema Registry、Kafka REST、Kafka CONNECT、ksqlDB、Control Center などのすべてのConfluent サービスが起動します。これで、CData JDBC Driver for SAP SuccessFactors を使用してKafka Connect Driver 経由でksqlDB のKafka トピックにメッセージをストリーミングする準備が整いました。
POST HTTP API リクエストを使用してKafka トピックを手動で作成します:
```
 curl --location 'server_address:8083/connectors'
	--header 'Content-Type: application/json'
	--data '{
		"name": "jdbc_source_cdata_sapsuccessfactors_01",
		"config": {
			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector",
			"connection.url": "jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;",
		"topic.prefix": "sapsuccessfactors-01-",
		"mode": "bulk"
		}
	}'
```
HTTP POST 本文（上記）で使用されるフィールドについて説明します:
- connector.class: 使用するKafka Connect コネクタのJava クラスを指定します。
- connection.url: SAP SuccessFactors データに接続するためのJDBC 接続URL です。
  組み込みの接続文字列デザイナー
  
  JDBC URL の作成については、CData JDBC Driver for SAP SuccessFactorsに組み込まれた接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
```
		java -jar cdata.jdbc.sapsuccessfactors.jar
		
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  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">ヘルプドキュメントの「はじめに」をご確認ください。
- topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「sapsuccessfactors-01-」に設定されています。
- mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。
このリクエストにより、SAP SuccessFactors のすべてのテーブル/コンテンツがKafka トピックとして追加されます。

注意: リクエストをPOST するIP アドレス（サーバー）は、Linux ネットワークのIP アドレスです。
ksqlDB を実行し、トピックを一覧表示します。以下のコマンドを使用します:
```
ksql
list topics;
```
トピック内のデータを表示するには、以下のSQL ステートメントを入力します:
```
PRINT topic FROM BEGINNING;
```

Confluent Control Center への接続

Confluent Control Center のユーザーインターフェースにアクセスするには、上記のセクションで説明した"confluent local services" を実行し、ローカルブラウザでhttp://<server address>:9021/clusters/ と入力してください。