各製品の資料を入手。
詳細はこちら →ETL ツールのEmbulk を使ってZoho Projects のデータをDB にロードする方法
OSS のETL ツールEmbulk のJDBC Plugin を使って、Zoho Projects のデータを簡単にDB に同期する方法をご紹介します。
最終更新日:2023-10-13
この記事で実現できるZoho Projects 連携のシナリオ
こんにちは!リードエンジニアの杉本です。
Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for ZohoProjects を使って、Zoho Projects のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。
Embulk でZoho Projects のデータをロード
- CData JDBC Driver for ZohoProjects をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
-
以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
C:\Program Files\CData\CData JDBC Driver for ZohoProjects 2019J\lib\cdata.jdbc.zohoprojects.jar 次に、EmbulkとCData JDBC Driverをつなぎこむための、JDBC Input Plugin をインストールします。以下のリンクからダウンロードできます。
https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbcインストール用のコマンドはこちら:
embulk gem install embulk-input-jdbc
今回はロード先DB としてMySQL を使います。ほかにもSQL Server、PostgreSQL、Google BigQuery などを使うことも可能です。ロードに必要な以下のプラグインをインストールしましょう。
https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysqlコマンドはこちら。
embulk gem install embulk-output-mysql
- config ファイルを作成し、Zoho Projects -> MySQL のジョブを作成します。zohoprojects-mysql.yml というファイル名で、以下の内容で作成しました。
- JDBC URL の内容は、ご利用の環境や資格情報を入力してください。
Zoho Projects 接続プロパティの取得・設定方法
Zoho Projects に接続するには、Region をサーバーURL のトップレベルドメイン(TLD)に設定します。
Zoho Projects への認証
Zoho Projects は、データに接続する2つの方法を提供します。
- デスクトップ経由で自分のローカルデータに接続する場合(非ブラウザ接続)は、CData が提供する組み込みOAuth アプリケーションを使用します。
- ネットワーク経由で共有データに接続する場合(ブラウザ接続)は、カスタムOAuth アプリケーションを使用します。
すべてのOAuth フロー(埋め込みまたはカスタム)で、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。
ヘルプドキュメントでは、次の3つの一般的な認証フローでのZoho Projects への認証について詳しく説明します。
- デスクトップ:ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
- Web:共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
- ヘッドレスサーバー:他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。
認証方法の詳細は、ヘルプドキュメントを参照してください。
- テーブル名は取得したいテーブル名を入れます。
- これで準備完了です。あとは「embulk run」で実行するだけです。
- 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for ZohoProjects 2025J\lib\cdata.jdbc.zohoprojects.jar
driver_class: cdata.jdbc.zohoprojects.ZohoProjectsDriver
url: jdbc:zohoprojects:InitiateOAuth=REFRESH
table: "Portals"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Portals"
mode: insert
embulk run zohoprojects-mysql.yml
クエリ条件でフィルタリングしたデータのロード
ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for ZohoProjects 2019J\lib\cdata.jdbc.zohoprojects.jar
driver_class: cdata.jdbc.zohoprojects.ZohoProjectsDriver
url: jdbc:zohoprojects:InitiateOAuth=REFRESH
query: "SELECT Id, Name FROM Portals WHERE [RecordId] = 1"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Portals"
mode: insert
おわりに
CData JDBC Driver for ZohoProjects をEmbulk で使うことで、Zoho Projects と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。