エンタープライズサーチのNeuron にPipedrive データを取り込んで検索利用

企業内検索エンジンサービスの Neuron にPipedrive のデータを取り込んで検索する方法：CData JDBC Driver。

杉本和也
リードエンジニア
最終更新日：2021-03-01

CData

こんにちは！リードエンジニアの杉本です。

ブレインズテクノロジー社のNeuron は、先端OSS 技術（Apache Solr）を活用したエンタープライズサーチ（企業内検索エンジン）サービスです。Apache Solr は、エンタープライズサーチ機能をAPI として提供してくれますが、Neuron はApache Solr に企業ユーザーがデータを探索するためのシンプルかつ使いやすいユーザーインターフェースと管理画面・運用機能を提供してくれます。これによりエンドユーザーが簡単にエンタープライズサーチを利用することができます。管理画面では、ファイルやデータのクローリング設定がUI で行えるようになっています。この記事では、Neuron に備わっているJDBC インターフェース経由で、CData JDBC Driver for Pipedrive を利用することでNeuron にPipedrive データを取り込んで検索で利用できるようにします。

Neuron にCData JDBC Driver for Pipedrive データをロード

CData JDBC Driver for Pipedrive のインストールと.jar ファイルの配置

CData JDBC Driver for Pipedrive をNeuron と同じマシンにインストールします。
以下のパスにJDBC Driver がインストールされます。
C:\Program Files\CData\CData JDBC Driver for Pipedrive 20xxJ\lib\cdata.jdbc.pipedrive.jar
このcdata.jdbc.pipedrive.jar とcdata.jdbc.pipedrive.lic ファイルをコピーして、Neuron のC:\APP cf\lib フォルダに配置します。

Neuron CF でのPipedrive データを扱うリポジトリの作成

Neuron CF でクローラーの設定をGUI で行います。JDBC を読み取るためのリポジトリを作成します。Neuron の管理画面にログインし、［リポジトリ］→［リポジトリコレクション一覧］→［新規］をクリックします。
任意のリポジトリ名を入力します。タイプは［JDBC］を選択します。
次に、ドライバーのクラス名とJDBC 接続文字列でPipedrive への接続を行います。

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

Pipedrive への接続に使用できる認証方法は、Basic およびOAuth です。
Basic
API トークンの取得から始めます。
1. PipeDrive の右上にあるアカウント名をクリックします。
2. 会社設定をクリックし、続いてPersonal Preferences -> API -> Generate Token をクリックします。
3. API トークンを控えておきます。
4. CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。
以下を設定してPipedrive へ認証します。
- APIToken：控えておいたAPI トークンに設定。
- CompanyDomain：控えておいた開発者サンドボックスURL の会社ドメインに設定。
- AuthScheme：Basic に設定。
API トークンは、PipeDrive の右上にあるアカウント名 -> 会社設定 -> Personal preferences -> API に移動して確認できます。
OAuth

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

ドライバクラス名：cdata.jdbc.pipedrive.PipedriveDriver
接続文字列：jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;
［更新］をクリックして、Pipedrive に接続するリポジトリコレクションができました。

Neuron でPipedrive のデータをクローリングするジョブを作成

続いて、Pipedrive のどのデータをどのようにクローリングするのかをジョブで定義していきます。

管理画面で［ジョブ］→［ジョブ一覧］→［新規］とクリックします。
任意のジョブ名を入力します。出力先にはSolr を選択します。リポジトリは先ほど作成したPipedrive に接続するリポジトリコレクションを選びます。
次に基本タブからジョブ実行を手動にするか、定期実行するかを自由に設定します。
SQL タブでは、どんなデータを取得するのか、テーブル名やカラム、フィルタリング条件などを設定できます。CData JDBC ドライバがPipedrive データをテーブルにモデル化しているので、標準SQL でPipedrive をクエリすることができます。
- SQL文：SELECT PersonName, UserEmail FROM Deals
- キーカラム：Id など取得テーブルのキーとなるカラム
- 検索対象カラム：検索の対象とするカラム
- タイトルカラム：検索結果のタイトルとするカラム
- タイムスタンプカラム：タイムスタンプとなるカラムがあれば、ここで指定します
リクエストパラメータでは、検索結果レコードのURL （があれば）を設定することもできます。URL を表示できると表示された検索結果からレコードに簡単に移動できます。
取得元では、ラベルを設定しておきます。［更新］をクリックして、クローラージョブの設定を完了します。