Apache Solr にFreshservice のデータをインポートする方法

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData JDBC Driver for Freshservice をData Import Handler で使用して、Freshservice のデータをApache Solr エンタープライズサーチプラットフォームに自動インポートできます。

Apache Solr は、Apache Lucene 上に構築された人気のある高速なオープンソースのエンタープライズサーチソリューションです。

Apache Solr には、データベースやXML、CSV、JSON ファイルからデータをインポートできるData Import Handler(DIH)が搭載されています。CData JDBC Driver for Freshservice と組み合わせることで、Freshservice のデータを簡単にApache Solr にインポートできます。この記事では、CData JDBC Driver をApache Solr のData Import Handler で使用し、エンタープライズサーチ用にFreshservice のデータをインポートする方法をステップバイステップで解説します。

Freshservice インポート用のApache Solr コアとスキーマを作成する

  1. Apache Solr を起動し、コアを作成します。
    > solr create -c CDataCore
    この記事では、Solr はローカル環境でスタンドアロンインスタンスとして実行されており、次のURL でコアにアクセスできます:http://localhost:8983/solr/#/CDataCore/core-overview
  2. インポートするFreshservice のデータのカラムを表す「field」オブジェクトと、エンティティの一意キーで構成されるスキーマを作成します。Freshservice にLastModifiedDate が存在する場合は、増分更新に使用されます。存在しない場合は、後述のdeltaquery を実行できません。スキーマはApache Solr が作成したmanaged-schema ファイルに保存します。
  3. 	APIUniqueKey
    	
    	
    	
    	
    	
    	
    	
    	
    	
    Solr でFreshservice のデータ用のスキーマを定義
  4. CData Freshservice JDBC Driver をインストールします。JAR ファイルとライセンスファイル(cdata.api.jarcdata.jdbc.api.lic)をSolr ディレクトリにコピーします。
    • CData JDBC JAR ファイル:C:\Program Files\CData\CData JDBC Driver for Freshservice ####\lib
    • Apache Solr:solr-8.5.2\server\lib

これで、Solr でFreshservice のデータを使用する準備が整いました。

Freshservice からApache Solr へのインポートを定義する

このセクションでは、Data Import Handler の設定手順を説明します。

  1. 作成したコアのConfig ファイルを編集します。JAR ファイルの参照を追加し、DIH RequestHandler の定義を追加します。
    	
    
    	<lib dir="${solr.install.dir:../../../..}/dist/" regex="solr-dataimporthandler-.*\.jar" />
    
    	<requestHandler name="/dataimport" class="org.apache.solr.handler.dataimport.DataImportHandler">
    		<lst name="defaults">
    			<str name="config">solr-data-config.xml</str>
    		</lst>
    	</requestHandler>
  2. 次に、同じ階層にsolr-data-config.xml を作成します。この記事ではFreshservice からテーブルを取得しますが、カスタムSQL クエリを使用してデータをリクエストすることもできます。Driver クラスとサンプルJDBC 接続文字列は以下のサンプルコードにあります。
    	
    	<dataConfig>
    		<dataSource driver="cdata.jdbc.api.APIDriver" url="jdbc:api:Profile=C:\profiles\Freshservice.apip;ProfileSettings='APIKey=your_api_key;Domain=your_subdomain';">
    		</dataSource> 
    		<document> 
    			<entity name="AgentGroups" 
    				query="SELECT Id,APIColumn1,APIColumn2,APIColumn3,APIColumn4,APIColumn5,APIColumn6,APIColumn7,LastModifiedDate FROM AgentGroups"
    				deltaQuery="SELECT Id FROM AgentGroups where LastModifiedDate >= '${dataimporter.last_index_time}'"
    				deltaImportQuery="SELECT Id,APIColumn1,APIColumn2,APIColumn3,APIColumn4,APIColumn5,APIColumn6,APIColumn7,LastModifiedDate FROM AgentGroups where Id=${dataimporter.delta.Id}">
    				<field column="Id" name="Id" ></field>
    				<field column="APIColumn1" name="APIColumn1" ></field>
    				<field column="APIColumn2" name="APIColumn2" ></field>
    				<field column="APIColumn3" name="APIColumn3" ></field>
    				<field column="APIColumn4" name="APIColumn4" ></field>
    				<field column="APIColumn5" name="APIColumn5" ></field>
    				<field column="APIColumn6" name="APIColumn6" ></field>
    				<field column="APIColumn7" name="APIColumn7" ></field>
    				<field column="LastModifiedDate" name="LastModifiedDate" ></field>
    			</entity>
    		</document>
    	</dataConfig>
  3. query セクションで、Freshservice からデータを選択するSQL クエリを設定します。deltaQuerydeltaImportquery は、同じエンティティの2回目以降のインポートで増分更新を使用する際のID と条件を定義します。
  4. すべての設定が完了したら、Solr を再起動します。
    	> solr stop -all
    	> solr start
    	

Freshservice のデータのDataImport を実行する

  1. 以下のURL からDataImport を実行します:
    http://localhost:8983/solr/#/CDataCore/dataimport//dataimport Data Import を使用してFreshservice のデータをSolr にロード
  2. 「full-import」コマンドを選択し、Entity からテーブルを選択して、「Execute」をクリックします。 Solr でfull import を実行
  3. Query からインポート結果を確認します。 Freshservice のfull import 結果を確認
  4. deltaQuery を使用した増分更新を試してみましょう。元のFreshservice データセットのデータを変更します。DataImport ウィンドウから今度は「delta-import」コマンドを選択し、「Execute」をクリックします。 Solr でDelta import を実行
  5. 増分更新の結果を確認します。 Freshservice のdelta import 結果を確認

CData JDBC Driver for Freshservice を使用することで、Freshservice のデータのApache Solr への自動インポートを作成できます。数百種類のCData JDBC Driver の無料30日間トライアルをダウンロードして、今すぐ始めましょう。

はじめる準備はできましたか?

API Driver で Freshservice のライブデータに接続

Freshservice に接続