Apache Camel を使用してPipedrive データと連携

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Apache Camel は、データを消費または生成するさまざまなシステムを統合できる、オープンソースの統合フレームワークです。CData JDBC Driver for Pipedrive と組み合わせることで、リアルタイムPipedrive データと連携するCamel ルートを使用するJava アプリを作成できます。この記事では、Pipedrive データをJSON ファイルに接続、クエリ、及びルーティングするアプリをNetBeans で作成する方法について説明します。

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

新しいMaven/Java プロジェクトを作成する

以下の手順に従って、新しいJava プロジェクトを作成し、適切な依存関係を追加します。

1. NetBeans を開き、新しいプロジェクトを作成します。
2. カテゴリリストからMaven を選択し、プロジェクトリストからJava Application を選択して、「Next」をクエリします。
3. プロジェクトに名前を付け、他のプロパティを調整して「Finish」をクリックします。
4. ソースパッケージで新しいJava クラス（ここではApp.java を使用）を作成し、クラスにmain メソッドを追加します。

プロジェクトの依存関係を追加する

プロジェクトが作成されたら、アプリからリアルタイムPipedrive データを操作するために必要な依存関係を追加できるようになります。まだMaven を環境にインストールしていない場合、CData JDBC ドライバのJAR ファイルをプロジェクトに追加するのに必要なため、インストールしてください。

Maven を使用してCData JDBC Driver for Pipedrive をインストールする

1. Pipedrive 用のCData JDBC Driver をダウンロードしてパッケージを解凍し、JAR を実行してドライバーをインストールします。
2. Maven を使用し、コネクタとしてJDBC Driver をインストールします。

   mvn install:install-file 
   	-Dfile="C:\Program Files\CData\CData JDBC Driver for Pipedrive 2019\lib\cdata.jdbc.pipedrive.jar" 
   	-DgroupId="org.cdata.connectors" 
   	-DartifactId="cdata-pipedrive-connector" 
   	-Dversion="19" 
   	-Dpackaging=jar
   

JDBC Driver をインストールしたら、プロジェクトに依存関係を追加できます。依存関係を追加するには、pom.xml を編集するか、依存関係にあるフォルダを右クリックして「Add Dependency」をクリックします。各依存関係のプロパティは以下の通りですが、「Add Dependency」ウィザードの「Query」ボックスに依存関係の名前を入力することで使用可能なライブラリを検索できます。

必要な依存関係

Camel を使用してJava アプリでPipedrive データにアクセスする

必要な依存関係を追加したら、Java DSL（Domain Specific Language）を使用してリアルタイムPipedrive データにアクセスできるルートを作成できます。以下はコードの一部です。サンプルプロジェクト（zip ファイル）をダウンロードして以下を実行してください。（TODO コメントに注意してください。）

必要なクラスをメインクラスにインポートすることから始めます。

import org.apache.camel.CamelContext;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.impl.DefaultCamelContext;
import org.apache.camel.support.SimpleRegistry;
import org.apache.commons.dbcp2.BasicDataSource;
import org.apache.log4j.BasicConfigurator;

次に、main メソッドでロギングを構成し、新しいBasicDataSource を作成してレジストリに追加し、新しいCamelContext を作成して、最後にコンテクストへのルートに追加します。この例では、Pipedrive データをJSON ファイルにルーティングします。

ロギングを構成する

BasicConfigurator.configure();

BasicDataSource を作成する

BasicDataSource を作成し、ドライバークラス名（cdata.jdbc.salesforce.SalesforceDriver）とURL（必要な接続プロパティを使用）を設定します。

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

Pipedrive への接続に使用できる認証方法は、Basic およびOAuth です。

Basic

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」セクションを参照してください。

BasicDataSource basic = new BasicDataSource();
basic.setDriverClassName("cdata.jdbc.pipedrive.PipedriveDriver");
basic.setUrl("jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;");

CData JDBC ドライバには、接続URL の構成に役立つ組み込みの接続文字列デザイナーが含まれています。

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

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

java -jar cdata.jdbc.pipedrive.jar

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

BasicDataSource をレジストリに追加し、CamelContext を作成する

SimpleRegistry reg = new SimpleRegistry();
reg.bind("myDataSource", basic);

CamelContext context = new DefaultCamelContext(reg);

CamelContext にルーティングを追加する

以下のルーティングでは、timer コンポーネントを使用して一度実行し、SQL クエリをJDBC Driver に渡します。結果はJSON として整理され、（きれいに印刷できるようにフォーマットされて）file コンポーネントに渡され、JSON ファイルとしてディスクに書き込まれます。

context.addRoutes(new RouteBuilder() {
	@Override
	public void configure() {
		from("timer://foo?repeatCount=1")
			.setBody(constant("SELECT * FROM Account LIMIT 10"))
			.to("jdbc:myDataSource")
			.marshal().json(true)
			.to("file:C:\\Users\\USER\\Documents?fileName=account.json");
	}
});

CamelContext ライフサイクルを管理する

ルートを定義したら、CamelContext を開始してライフサイクルを始めます。この例では、10 秒待機してからコンテクストをシャットダウンします。

context.start();
Thread.sleep(10000);
context.stop();

無償トライアル、サンプルプロジェクト、テクニカルサポート

これで、Camel を使用してPipedrive からJSON ファイルにデータをルーティングするJava アプリケーションを使用できるようになりました。CData JDBC Driver for Pipedrive の30日の無償評価版と、サンプルプロジェクトをダウンロードして（TODO コメントに注意して）、Apache Camel でリアルタイムPipedrive データの操作を開始します。ご不明な点があれば、サポートチームにお問い合わせください。