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

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

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

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

前提条件

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

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

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

  1. Linux ベースのシステムにCData JDBC Driver for Zoho CRMをダウンロードします。
  2. 以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
    1. Zoho CRM という名前の新しいディレクトリを作成します。 
      		mkdir ZohoCRM
    2. ダウンロードしたドライバーファイル（.zip）をこの新しいディレクトリに移動します。 
      		mv ZohoCRMJDBCDriver.zip ZohoCRM/
    3. CData ZohoCRMJDBCDriver の内容をこの新しいディレクトリに解凍します。 
      		unzip ZohoCRMJDBCDriver.zip
  3. Zoho CRM ディレクトリを開き、lib フォルダに移動します。 
    ls
cd lib/
  4. CData JDBC Driver for Zoho CRM のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.zohocrm.jar ファイルがlib フォルダに正常にコピーされたことを確認します。 
    cp -r /path/to/CData JDBC Driver for Zoho CRM/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
  5. 以下のコマンドを使用して、CData Zoho CRM JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。 
    	java -jar cdata.jdbc.zohocrm.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 Zoho CRM を使用して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_zohocrm_01",
		"config": {
			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector",
			"connection.url": "jdbc:zohocrm:AuthToken=2ad3b3e719f6bed7368e5e7e26e4f988;",
		"topic.prefix": "zohocrm-01-",
		"mode": "bulk"
		}
	}'

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

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

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

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

      		java -jar cdata.jdbc.zohocrm.jar

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

      Zoho CRM への接続

      それでは、Zoho CRM に接続していきましょう。データに接続するには、以下の接続パラメータを設定します。

      • Region：Zoho CRM サーバーURL のドメインに関連付けられたリージョン
      • Schema：Zoho CRM のバージョン（v2、v2.1、またはv4）。Zoho CRM のバージョンごとに独自のデータモデルがあります

      これらのプロパティに加えて、認可時にサンドボックスまたは開発者インスタンスのいずれかを選択した場合は、InstanceType 接続プロパティでも同じ設定を行ってください。

      Zoho CRM への認証

      Zoho CRM では、データへの認証に2つの方法が用意されています。お使いの環境に応じて適切な方法を選択てください。

      デスクトップ経由で自分のローカルデータに認証を行う場合（非ブラウザ接続）：CData 製品が提供する埋め込みOAuth アプリケーションを使用

      CData 製品はすでにZoho CRM にOAuth アプリケーションとして登録されています。そのため、デスクトップアプリケーションを介したローカルデータへの接続では、自動的に組み込みアプリケーションが使用されます。 OAuth 交換の繰り返しを避け、ローカルデータにアクセスするたびにOAuthAccessToken を手動で設定する手間を省くには、InitiateOAuth をGETANDREFRESH に設定してください。

      ネットワーク経由で共有データに認証を行う場合（ブラウザ接続）：カスタムOAuth アプリケーションを使用

      すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

      より詳細な認証手順については、ヘルプドキュメントの「Zoho CRM への認証」をご確認ください。

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

    このリクエストにより、Zoho CRM のすべてのテーブル/コンテンツが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 JDBC Driver for Zoho CRMの30日間無償トライアルをダウンロードして、Zoho CRM データをApache Kafka にストリーミングしましょう。ご不明な点があれば、サポートチームまでお問い合わせください。

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

Zoho CRM Driver の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

Zoho CRM Icon Zoho CRM JDBC Driver お問い合わせ

潜在顧客、連絡先、営業案件、アカウントなどのZoho CRM アカウントデータを組み込んだパワフルなJava アプリケーションを短時間・低コストで作成して配布できます。

この記事の内容

関連記事