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

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

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

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

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

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

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

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

  Zuora はユーザー認証にOAuth 標準を使用しています。OAuth 認証ついて詳しくは、オンラインヘルプドキュメントを参照してください。

  Tenant プロパティの設定

  プロバイダへの有効な接続を作成するには、アカウントの設定と合致するテナント値を1つ選択する必要があります。以下は、利用可能なオプションのリストです。
  • USProduction：リクエストはhttps://rest.zuora.com に送信されます。
  • USAPISandbox：リクエストはhttps://rest.apisandbox.zuora.com に送信されます。
  • USPerformanceTest：リクエストはhttps://rest.pt1.zuora.com に送信されます。
  • EUProduction：リクエストはhttps://rest.eu.zuora.com に送信されます。
  • EUSandbox：リクエストはhttps://rest.sandbox.eu.zuora.com に送信されます。

  デフォルトではUSProduction テナントを使用します。

  Zuora サービスの選択

  データクエリとAQuA API の2つのZuora サービスを使用します。デフォルトでは、ZuoraService はAQuADataExport に設定されています。

  DataQuery

  データクエリ機能は、非同期の読み取り専用SQL クエリを実行することで、Zuora テナントからのデータのエクスポートを実現します。 このサービスは、素早く軽量なSQL クエリでの使用を推奨します。

  制限

  • フィルタ適用後の、テーブルごとの入力レコードの最大数： 1,000,000
  • 出力レコードの最大数： 100,000
  • テナントごとの、実行用に送信される同時クエリの最大数： 5
  • テナントごとの、同時クエリの制限に達した後に実行用に送信され、キューに追加されるクエリの最大数： 10
  • 1時間単位での、各クエリの最大処理時間： 1
  • GB 単位での、各クエリに割り当てられるメモリの最大サイズ： 2
  • Index Join を使用する際のインデックスの最大値。言い換えれば、Index Join を使用する際にWHERE 句で使われる一意の値に基づいた、左のテーブルから返されるレコードの最大数： 20.000

  AQuADataExport

  AQuA API のエクスポートは、すべてのオブジェクト（テーブル）のすべてのレコードをエクスポートするように設計されています。AQuA のクエリジョブには以下の制限があります。

  制限

  • AQuA のジョブ内のクエリが8時間以上実行されている場合、ジョブは自動的に停止されます。
  • 停止されたAQuA のジョブは3回再試行可能で、その後失敗として返されます。
  
  ドライバクラス名：cdata.jdbc.zuora.ZuoraDriver
  接続文字列：jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=REFRESH
• ［更新］をクリックして、Zuora に接続するリポジトリコレクションができました。

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

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

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

Neuron でZuora のデータをクロールするジョブを実行

実際にNeuron で作成したジョブを実行します。［ジョブ］→［状態とジョブ管理］をクリックし、作成したジョブの［Start］をクリックします。

ジョブが正常完了すると、［Done］がステータスとして表示されます。

Neuron 上でのZuora のデータの検索の実施

実際にNeuron 上で検索ができるか確認してみます。取得元を絞り込むこと、内容やファイル名での検索、ファイルサイズやファイル更新日の絞り込み、部分一致や全部一致で検索が可能です。 検索をかけてみると、以下のようにデータを取得できました。

CData JDBC Driver for Zuora をNeuron で使うことで、Zuora コネクタとして機能し、簡単にデータを取得して同期することができました。ぜひ、30日の無償評価版をお試しください。