Elasticsearch へLogstash 経由でZoho Creator のデータをロードする方法

全文検索サービスElasticsearch のETL モジュール「Logstash」とCData JDBC ドライバを使って、Zoho Creator のデータを簡単にロードする方法をご紹介。

加藤龍彦
デジタルマーケティング

最終更新日:2022-07-22

この記事で実現できるZoho Creator 連携のシナリオ

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

Elasticsearch は、人気の分散型全文検索エンジンです。データを一元的に格納することで、超高速検索や、関連性の細かな調整、パワフルな分析が大規模に、手軽に実行可能になります。Elasticsearch にはデータのローディングを行うパイプラインツール「Logstash」があります。CData Drivers を利用することができるので、30日の無償評価版をダウンロードしてあらゆるデータソースを簡単にElasticsearch に取り込んで検索・分析を行うことができます。

この記事では、CData Driver for ZohoCreator を使って、Zoho Creator のデータをLogstash 経由でElasticsearch にロードする手順を説明します。

Elasticsearch Logstash でCData JDBC Driver for ZohoCreator を使用

  • CData JDBC Driver for ZohoCreator をLogstash が稼働するマシンにインストールします。
  • 以下のパスにJDBC Driver がインストールされます(2022J の部分はご利用される製品バージョンによって異なります)。後ほどこのパスを使います。この.jar ファイル(製品版の場合は.lic ファイルも)をLogstash に配置します。
    C:\Program Files\CData\CData JDBC Driver for ZohoCreator 2022J\lib\cdata.jdbc.zohocreator.jar
  • 次に、Logstash とCData JDBC ドライバをつなぐ、JDBC Input Plugin をインストールします。JDBC Plugin は最新のLogstash だとデフォルトでついてきますが、バージョンによっては追加する必要があります。
    https://www.elastic.co/guide/en/logstash/5.4/plugins-inputs-jdbc.html
  • CData JDBC ドライバの.jar ファイルと.lic ファイルを、Logstashの「/logstash-core/lib/jars/」に移動します。

Logstash でElasticsearch にZoho Creator のデータを送る

それでは、Logstash でElasticsearch にZoho Creator のデータの転送を行うための設定ファイルを作成していきます。

  • Logstash のデータ処理定義であるlogstash.conf ファイルにZoho Creator のデータを取得する処理を書きます。Input はJDBC、Output はElasticsearch にします。データローディングジョブの起動間隔は30秒に設定しています。
  • CData JDBC ドライバの.jar をjdbc driver ライブラリにして、クラス名を設定、Zoho Creator への接続プロパティをJDBC URL の形でせっていします。JDBC URL ではほかにも詳細な設定を行うことができるので、細かくは製品ドキュメントをご覧ください。
  • Zoho Creator 接続プロパティの取得・設定方法

    Zoho Creator に接続するには、Region をサーバーURL のトップレベルドメイン(TLD)に設定します。

    Zoho Creator への認証

    Zoho Creator は、データに接続する2つの方法を提供します。

    • デスクトップ経由で自分のローカルデータに接続する場合(非ブラウザ接続)は、CData が提供する組み込みOAuth アプリケーションを使用します。
    • ネットワーク経由で共有データに接続する場合(ブラウザ接続)は、カスタムOAuth アプリケーションを使用します。
    すべてのOAuth フロー(埋め込みまたはカスタム)で、この認証を有効にするにはAuthSchemeOAuth に設定する必要があります。 ヘルプドキュメントでは、次の3つの一般的な認証フローでのZoho Creator への認証について詳しく説明します。
    • デスクトップ:ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
    • Web:共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
    • ヘッドレスサーバー:他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。
    認証方法の詳細は、ヘルプドキュメントを参照してください。

                input {
                    jdbc {
                        jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.zohocreator.jar"
                        jdbc_driver_class => "Java::cdata.jdbc.zohocreator.ZohoCreatorDriver"
                        jdbc_connection_string => "jdbc:zohocreator:AccountsServer=AccountsServer;InitiateOAuth=REFRESH"
                        jdbc_user => ""
                        jdbc_password => ""
                        schedule => "*/30 * * * * *"
                        statement => "SELECT ID, Leave_Type FROM Leave_Types WHERE Leave_Type = 'Sick'"
                    }
                }
    
    
                output {
                    Elasticsearch {
                        index => "zohocreator_Leave_Types"
                        document_id => "xxxx"
                    }
                }
            

Logstash でZoho Creator のローディングを実行

それでは作成した「logstash.conf」ファイルを元にLogstash を実行してみます。

> logstash-7.8.0\bin\logstash -f logstash.conf

成功した旨のログが出ます。これでZoho Creator のデータがElasticsearch にロードされました。

例えばKibana で実際にElasticsearch に転送されたデータを見てみます。

        GET zohocreator_Leave_Types/_search
        {
            "query": {
                "match_all": {}
            }
        }
    
Elasticsearch にロードされたZoho Creator のデータをクエリ

データがElasticsearch に格納されていることが確認できました。

Elasticsearch にロードされたZoho Creator のデータを確認

CData JDBC Driver for ZohoCreator をLogstash で使うことで、Zoho Creator コネクタとして機能し、簡単にデータをElasticsearch にロードすることができました。ぜひ、30日の無償評価版をお試しください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。