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

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
CData JDBC Driver とKafka Connect JDBC コネクタを使用して、Apache Kafka でUKG Pro WFM のデータにアクセスし、ストリーミングできます。

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

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

前提条件

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

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

UKG Pro WFM のデータへの新しいJDBC 接続を定義

  1. Linux ベースのシステムにCData API Driver for JDBCをダウンロードします。
  2. 以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
    1. UKG Pro WFM という名前の新しいディレクトリを作成します。
      
      		mkdir API
      		
    2. ダウンロードしたドライバーファイル(.zip)をこの新しいディレクトリに移動します。
      
      		mv APIJDBCDriver.zip API/
      		
    3. CData APIJDBCDriver の内容をこの新しいディレクトリに解凍します。
      
      		unzip APIJDBCDriver.zip
      		
  3. UKG Pro WFM ディレクトリを開き、lib フォルダに移動します。
    
    ls
    cd lib/
    
  4. CData API Driver for JDBC のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.api.jar ファイルがlib フォルダに正常にコピーされたことを確認します。
    
    cp -r /path/to/CData API Driver for JDBC/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
    cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
    
  5. 以下のコマンドを使用して、CData UKG Pro WFM JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。
    
    	java -jar cdata.jdbc.api.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 UKG Pro WFM を使用してKafka Connect Driver 経由でksqlDB のKafka トピックにメッセージをストリーミングする準備が整いました。

    Confluent ローカルサービスを起動
  8. POST HTTP API リクエストを使用してKafka トピックを手動で作成します:
    
     curl --location 'server_address:8083/connectors'
    	--header 'Content-Type: application/json'
    	--data '{ 
    		"name": "jdbc_source_cdata_api_01", 
    		"config": { 
    			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector", 
    			"connection.url": "jdbc:api:Profile=C:\profiles\UKGProWFM.apip;AuthScheme=OAuthPassword;ProfileSettings='Host=yourcompany.mykronos.com;User=your_username;Password=your_password;';OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;",
    		"topic.prefix": "api-01-", 
    		"mode": "bulk" 
    		} 
    	}'
    

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

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

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

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

      
      		java -jar cdata.jdbc.api.jar
      		

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

      まず、Profile 接続プロパティをディスク上の UKGProWFM プロファイルの場所に設定します(例:C:\profiles\UKGProWFM.apip)。次に、ProfileSettings 接続プロパティを UKGProWFM の接続文字列に設定します(以下を参照)。

      UKGProWFM API プロファイル設定

      UKG Pro Workforce Management では、OAuth 2.0 の Resource Owner Password Credentials グラント(grant_type=password)を使用して API へのアクセスを認可します。一般的な OAuth ベースのプロファイルとは異なり、ブラウザでのリダイレクトや認可コードのステップはありません。ドライバーが UKG Pro WFM のユーザー名、パスワード、クライアント ID、クライアントシークレットを使って、直接アクセストークンを取得します。

      認証するには、以下の接続プロパティを設定します。

      • AuthScheme:OAuthPassword に設定します。
      • Host:UKG Pro Workforce Management のデータセンター/テナントのホスト名に設定します(例:yourcompany.mykronos.com)。プロトコル(https://)や末尾のスラッシュは含めないでください。
      • OAuthClientId:UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアント ID に設定します。
      • OAuthClientSecret:UKG Pro Workforce Management の OAuth アプリケーションに発行されたクライアントシークレットに設定します。
      • User:UKG Pro Workforce Management のユーザー名に設定します。
      • Password:UKG Pro Workforce Management のパスワードに設定します。

      アクセストークンは https://{Host}/api/authentication/access_token から取得します。UKG Pro Workforce Management が発行するリフレッシュトークンの有効期限は7日間です。リフレッシュトークン自体の期限切れによってトークンの更新に失敗した場合、ドライバーは User/Password の認証情報で再認証し、新しいアクセストークンを取得する必要があります。

      組み込みの接続文字列デザイナーを使用してJDBC URL を生成(Salesforce の例)
    • topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「api-01-」に設定されています。
    • mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。

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

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

  9. ksqlDB を実行し、トピックを一覧表示します。以下のコマンドを使用します:
    
    ksql
    list topics;
    
    Kafka トピックを一覧表示(BigCommerce の例)
  10. トピック内のデータを表示するには、以下のSQL ステートメントを入力します:
    
    PRINT topic FROM BEGINNING;
    

Confluent Control Center への接続

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

Confluent Control Center に接続

おわりに

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

はじめる準備はできましたか?

API Driver で UKG Pro WFM のライブデータに接続

UKG Pro WFM に接続