Apache NiFi で Zendesk に接続

Dibyendu Datta
Lead Technology Evangelist

CData JDBC Driver を使用して Apache NiFi で Zendesk のデータにアクセスして処理できます。

Apache NiFi は、強力かつスケーラブルなデータルーティング、変換、システム間連携ロジックの有向グラフをサポートしています。CData JDBC Driver for Zendesk と組み合わせることで、NiFi からリアルタイムのZendesk のデータを操作できます。この記事では、Apache NiFi Flow からZendesk のデータに接続してクエリを実行する方法を説明します。

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

Apache NiFi でZendesk のデータに接続

CData JDBC Driver for Zendesk のインストーラーをダウンロードし、パッケージを解凍して、.exe ファイルを実行してドライバーをインストールします。
CData JDBC Driver のJAR ファイル（およびライセンスファイルがある場合はそれも）、cdata.jdbc.zendesk.jar（および cdata.jdbc.zendesk.lic）を Apache NiFi の lib サブフォルダにコピーします（例：C:\nifi-1.3.0-bin\nifi-1.3.0\lib）。

Windows では、CData JDBC Driver のデフォルトのインストール場所は C:\Program Files\CData\CData JDBC Driver for Zendesk です。
bin サブフォルダにある run-nifi.bat ファイルを実行して Apache NiFi を起動します（例：C:\nifi-1.3.0-bin\nifi-1.3.0\bin）。

（または）

コマンドプロンプトで対象のディレクトリに移動し、run-nifi.bat ファイルを実行します：
```
cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin
.\run-nifi.bat
```
Web ブラウザで Apache NiFi の UI に移動します：https://localhost:8443/nifi でアクセスできます。

注意：古いバージョンの Apache NiFi を使用している場合は、http://localhost:8080/nifi からアクセスする必要があります。以前のバージョンでは HTTP プロトコルが使用されていましたが、最新バージョンでは HTTPS が標準になっています。デフォルトでは、HTTP はポート 8080 で動作し、HTTPS はポート 8443 を使用します。
URL から Apache NiFi にアクセスすると、ログイン用のユーザー名とパスワードの入力を求められます。

ログイン資格情報を取得するには、NiFi のインストールディレクトリ内の log ディレクトリにある「App.log」ファイルを確認してください。このファイルには通常、NiFi インターフェースにアクセスするために必要な情報が含まれています。
NiFi Flow のワークスペースを右クリックし、「Controller Services」をクリックします。
ボタンをクリックして、新しいコントローラーサービスを作成します。
Controller Services セクションで、新しく作成した「DBCPConnection Pool」を見つけ、メニュー（）から「Edit」をクリックして新しい接続を設定します。
以下のプロパティを入力します：
- Database Connection URL：jdbc:zendesk:URL=https://subdomain.zendesk.com;[email protected];Password=test123;
- Database Driver Class Name：cdata.jdbc.zendesk.ZendeskDriver
- Database Driver Location(s)：Apache NiFi の lib フォルダへのパス（JAR ファイルが配置されている場所）。
組み込みの接続文字列デザイナー

JDBC URL の構築には、Zendesk JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。
```
java -jar cdata.jdbc.zendesk.jar
```
接続プロパティを入力し、接続文字列をクリップボードにコピーします。

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

Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。
また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。
Zendesk への認証

Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。

API トークン認証

API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。
1. Token アクセスを有効にします。
2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
最後に、APIToken をアクティブなAPI トークンに設定します。
その他の認証方法についてはヘルプドキュメントを参照してください。
Controller Services セクションで、新しく作成した DBCPConnection Pool を見つけ、メニュー（）から「Enable」をクリックして新しい接続を有効にします。
「Enable Controller Service」ウィンドウで、Scope を「Service and referencing components」に設定します。
接続を確立し、SELECT クエリを実行するには、プロセッサー（黄色でハイライトされている部分）をワークスペースにドラッグ＆ドロップします。
「ExecuteSQL」プロセッサーを選択し、「Add」ボタンをクリックしてワークスペースに表示させます。
追加したプロセッサー（ExecuteSQL）をダブルクリックして、接続ページを開きます。
Properties セクションで、必要な情報を入力します。Database Connection Pooling Service を作成した DBCPConnectionPool に一致させ、SQL select query セクションに実行したい SQL クエリを設定してください。
Relationships に移動し、実行プロセスの成功時と失敗時にコンポーネントがどのように処理を進めるかのオプションを選択してください。
ExecuteSQL コンポーネントを有効にするには、それを選択して Operation セクションの「Enable」をクリックするか、右クリックして「Enable」を選択します。