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

Dibyendu Datta
Lead Technology Evangelist

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

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

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

前提条件

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

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

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

Linux ベースのシステムにCData JDBC Driver for Paylocityをダウンロードします。
以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
1. Paylocity という名前の新しいディレクトリを作成します。
```
		mkdir Paylocity
		
```
2. ダウンロードしたドライバーファイル（.zip）をこの新しいディレクトリに移動します。
```
		mv PaylocityJDBCDriver.zip Paylocity/
		
```
3. CData PaylocityJDBCDriver の内容をこの新しいディレクトリに解凍します。
```
		unzip PaylocityJDBCDriver.zip
		
```
Paylocity ディレクトリを開き、lib フォルダに移動します。
```
ls
cd lib/
```
CData JDBC Driver for Paylocity のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.paylocity.jar ファイルがlib フォルダに正常にコピーされたことを確認します。
```
cp -r /path/to/CData JDBC Driver for Paylocity/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
```
以下のコマンドを使用して、CData Paylocity JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。
```
	java -jar cdata.jdbc.paylocity.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 Paylocity を使用して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_paylocity_01",
		"config": {
			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector",
			"connection.url": "jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;",
		"topic.prefix": "paylocity-01-",
		"mode": "bulk"
		}
	}'
```
HTTP POST 本文（上記）で使用されるフィールドについて説明します:
- connector.class: 使用するKafka Connect コネクタのJava クラスを指定します。
- connection.url: Paylocity データに接続するためのJDBC 接続URL です。
  組み込みの接続文字列デザイナー
  
  JDBC URL の作成については、CData JDBC Driver for Paylocityに組み込まれた接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
```
		java -jar cdata.jdbc.paylocity.jar
		
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  Paylocity への接続を確立するには以下を設定します。
  - RSAPublicKey：Paylocity アカウントでRSA 暗号化が有効になっている場合は、Paylocity に関連付けられたRSA キーを設定。
    このプロパティは、Insert およびUpdate ステートメントを実行するために必須です。この機能が無効になっている場合は必須ではありません。
  - UseSandbox：サンドボックスアカウントを使用する場合はTrue に設定。
  - CustomFieldsCategory：Customfields カテゴリに設定。これは、IncludeCustomFields がtrue に設定されている場合は必須です。デフォルト値はPayrollAndHR です。
  - Key：Paylocity の公開鍵で暗号化されたAES 共通鍵（base 64 エンコード）。これはコンテンツを暗号化するためのキーです。
    Paylocity は、RSA 復号化を使用してAES 鍵を復号化します。
    これはオプションのプロパティで、IV の値が指定されていない場合、ドライバーは内部でキーを生成します。
  - IV：コンテンツを暗号化するときに使用するAES IV（base 64 エンコード）。これはオプションのプロパティで、Key の値が指定されていない場合、ドライバーは内部でIV を生成します。
  OAuth
  
  OAuth を使用してPaylocity で認証する必要があります。OAuth では認証するユーザーにブラウザでPaylocity との通信を要求します。詳しくは、ヘルプドキュメントのOAuth セクションを参照してください。
  Pay Entry API
  
  Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。 Pay Entry API を使用すると、個々の従業員の給与情報を自動的に送信できます。 Pay Entry API によって提供されるものの性質が非常に限られているため、CData では個別のスキーマを提供しないことを選択しましたが、UsePayEntryAPI 接続プロパティを介して有効にできます。
  UsePayEntryAPI をtrue に設定する場合は、CreatePayEntryImportBatch、MergePayEntryImportBatch、Input_TimeEntry、およびOAuth ストアドプロシージャのみ利用できることに注意してください。製品のその他の機能を使用しようとするとエラーが発生します。また、OAuthAccessToken を個別に保存する必要があります。これは、この接続プロパティを使用するときに異なるOAuthSettingsLocation を設定することを意味します。
- topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「paylocity-01-」に設定されています。
- mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。
このリクエストにより、Paylocity のすべてのテーブル/コンテンツが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/ と入力してください。