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

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

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

はじめに

---

前提条件

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

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

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

1. Linux ベースのシステムにCData JDBC Driver for Workdayをダウンロードします。
2. 以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
   1. Workday という名前の新しいディレクトリを作成します。

      		mkdir Workday
      		

   2. ダウンロードしたドライバーファイル（.zip）をこの新しいディレクトリに移動します。

      		mv WorkdayJDBCDriver.zip Workday/
      		

   3. CData WorkdayJDBCDriver の内容をこの新しいディレクトリに解凍します。

      		unzip WorkdayJDBCDriver.zip
      		

3. Workday ディレクトリを開き、lib フォルダに移動します。

   ls
   cd lib/
   

4. CData JDBC Driver for Workday のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.workday.jar ファイルがlib フォルダに正常にコピーされたことを確認します。

   cp -r /path/to/CData JDBC Driver for Workday/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
   cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
   

5. 以下のコマンドを使用して、CData Workday JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。

   	java -jar cdata.jdbc.workday.jar -l
   	

6. プロダクトキーまたは"TRIAL" を入力します（ライセンスの有効期限が切れた場合は、CData サポートチームまでお問い合わせください）。
7. 以下のコマンドを使用してConfluent ローカルサービスを起動します:

   	confluent local services start
   	

   これにより、Zookeeper、Kafka、Schema Registry、Kafka REST、Kafka CONNECT、ksqlDB、Control Center などのすべてのConfluent サービスが起動します。これで、CData JDBC Driver for Workday を使用してKafka Connect Driver 経由でksqlDB のKafka トピックにメッセージをストリーミングする準備が整いました。

   
8. POST HTTP API リクエストを使用してKafka トピックを手動で作成します:

    curl --location 'server_address:8083/connectors'
   	--header 'Content-Type: application/json'
   	--data '{
   		"name": "jdbc_source_cdata_workday_01",
   		"config": {
   			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector",
   			"connection.url": "jdbc:workday:User=myuser;Password=mypassword;Tenant=mycompany_gm1;BaseURL=https://wd3-impl-services1.workday.com;ConnectionType=WQL;",
   		"topic.prefix": "workday-01-",
   		"mode": "bulk"
   		}
   	}'
   

   HTTP POST 本文（上記）で使用されるフィールドについて説明します:

   • connector.class: 使用するKafka Connect コネクタのJava クラスを指定します。
   • connection.url: Workday データに接続するためのJDBC 接続URL です。

     組み込みの接続文字列デザイナー

     JDBC URL の作成については、CData JDBC Driver for Workdayに組み込まれた接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

     		java -jar cdata.jdbc.workday.jar
     		

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

     Workday 接続プロパティの取得・設定方法

     ここでは、4つのWorkday API の接続パラメータを設定する方法、およびTenant とBaseURL を取得する方法について説明します。必要なAPI のパラメータが設定され、カスタムOAuth および / またはAzure AD API クライアントを作成したら、接続の準備は完了です。

     接続の前提条件

     API / 前提条件 / 接続パラメータ
     WQL / WQL サービスを有効化（下記参照） / ConnectionType： WQL
     Reports as a Service / カタログレポートの設定（ヘルプドキュメントの「データアクセスのファインチューニング」参照） / ConnectionType： Reports
     REST / 自動で有効化 / ConnectionType： REST
     SOAP / 自動で有効化 / ヘルプドキュメントのWorkday SOAP API への認証を参照

     BaseURL およびTenant の取得

     BaseURL およびTenant プロパティを取得するため、Workday にログインしてView API Clients を検索します。 この画面では、Workday はBaseURL とTenant の両方を含むURL であるWorkday REST API Endpoint を表示します。

     REST API Endpoint のフォーマットは、 https://domain.com//mycompany です。ここで、
     

     • https://domain.com（URL のサブディレクトリと会社名の前の部分）はBaseURL です。
     • mycompany（URL の最後のスラッシュの後の部分）はTenant です。

     例えば、REST API エンドポイントがhttps://wd3-impl-services1.workday.com/ccx/api/v1/mycompany の場合、 BaseURL はhttps://wd3-impl-services1.workday.com であり、Tenant はmycompany です。

     WQL サービスを有効化

     Workday WQL API を介して接続するには、はじめにWQL Service を有効にする必要があります。
     1. Workday を開きます。
     2. 検索バーにView Domain と入力します。
     3. プロンプトにWorkday Query Language と入力します。
     4. Allowed Security Group Types のいずれかに、接続するユーザーが含まれていることを確認します。

     Workday への認証

     Basic 認証以外のほとんどのWorkday 接続では、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。 Workday への認証につての詳細は、ヘルプドキュメントの「Workday への認証」セクションを参照してください。

     

   • topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「workday-01-」に設定されています。
   • mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。

   このリクエストにより、Workday のすべてのテーブル/コンテンツがKafka トピックとして追加されます。

   注意: リクエストをPOST するIP アドレス（サーバー）は、Linux ネットワークのIP アドレスです。

9. ksqlDB を実行し、トピックを一覧表示します。以下のコマンドを使用します:

   ksql
   list topics;
   

   
10. トピック内のデータを表示するには、以下のSQL ステートメントを入力します:

    PRINT topic FROM BEGINNING;
    

Confluent Control Center への接続

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

おわりに

CData JDBC Driver for Workdayの30日間無償トライアルをダウンロードして、Workday データをApache Kafka にストリーミングしましょう。ご不明な点があれば、サポートチームまでお問い合わせください。