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

Jerod Johnson
Senior Technology Evangelist

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

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

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

ServiceNow データ連携について

CData は、ServiceNow のライブデータへのアクセスと統合を簡素化します。お客様は CData の接続機能を以下の目的で活用しています：

CData はデータには REST API を、スキーマには SOAP API を使用するため、最適化されたパフォーマンスを実現できます。
Schedules、Timelines、Questions、Syslogs などの ServiceNow オブジェクトの読み取り、書き込み、更新、削除ができます。
SQL ストアドプロシージャを使用して、カートへのアイテム追加、注文の送信、添付ファイルのダウンロードなどのアクションを実行できます。
Basic（ユーザー名とパスワード）、OKTA、ADFS、OneLogin、PingFederate 認証スキームを含め、ServiceNow に安全に認証できます。

多くのユーザーは、Tableau、Power BI、Excel などのお気に入りの分析ツールからライブ ServiceNow データにアクセスし、CData ソリューションを使用して ServiceNow データをデータベースやデータウェアハウスに統合しています。

はじめに

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

Apache Solr を起動し、コアを作成します。
```
> solr create -c CDataCore
```
この記事では、Solr はローカル環境でスタンドアロンインスタンスとして実行されており、次のURL でコアにアクセスできます：http://localhost:8983/solr/#/CDataCore/core-overview
インポートするServiceNow のデータのカラムを表す「field」オブジェクトと、エンティティの一意キーで構成されるスキーマを作成します。ServiceNow にLastModifiedDate が存在する場合は、増分更新に使用されます。存在しない場合は、後述のdeltaquery を実行できません。スキーマはApache Solr が作成したmanaged-schema ファイルに保存します。

	ServiceNowUniqueKey

CData ServiceNow JDBC Driver をインストールします。JAR ファイルとライセンスファイル（cdata.servicenow.jar とcdata.jdbc.servicenow.lic）をSolr ディレクトリにコピーします。
- CData JDBC JAR ファイル：C:\Program Files\CData\CData JDBC Driver for ServiceNow ####\lib
- Apache Solr：solr-8.5.2\server\lib

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

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

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

作成したコアの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>

次に、同じ階層にsolr-data-config.xml を作成します。この記事ではServiceNow からテーブルを取得しますが、カスタムSQL クエリを使用してデータをリクエストすることもできます。Driver クラスとサンプルJDBC 接続文字列は以下のサンプルコードにあります。

	
	<dataConfig>
		<dataSource driver="cdata.jdbc.servicenow.ServiceNowDriver" url="jdbc:servicenow:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Username=MyUsername;Password=MyPassword;Instance=MyInstance;">
		</dataSource>
		<document>
			<entity name="incident"
				query="SELECT Id,ServiceNowColumn1,ServiceNowColumn2,ServiceNowColumn3,ServiceNowColumn4,ServiceNowColumn5,ServiceNowColumn6,ServiceNowColumn7,LastModifiedDate FROM incident"
				deltaQuery="SELECT Id FROM incident where LastModifiedDate >= '${dataimporter.last_index_time}'"
				deltaImportQuery="SELECT Id,ServiceNowColumn1,ServiceNowColumn2,ServiceNowColumn3,ServiceNowColumn4,ServiceNowColumn5,ServiceNowColumn6,ServiceNowColumn7,LastModifiedDate FROM incident where Id=${dataimporter.delta.Id}">
				<field column="Id" name="Id" ></field>
				<field column="ServiceNowColumn1" name="ServiceNowColumn1" ></field>
				<field column="ServiceNowColumn2" name="ServiceNowColumn2" ></field>
				<field column="ServiceNowColumn3" name="ServiceNowColumn3" ></field>
				<field column="ServiceNowColumn4" name="ServiceNowColumn4" ></field>
				<field column="ServiceNowColumn5" name="ServiceNowColumn5" ></field>
				<field column="ServiceNowColumn6" name="ServiceNowColumn6" ></field>
				<field column="ServiceNowColumn7" name="ServiceNowColumn7" ></field>
				<field column="LastModifiedDate" name="LastModifiedDate" ></field>
			</entity>
		</document>
	</dataConfig>

query セクションで、ServiceNow からデータを選択するSQL クエリを設定します。deltaQuery とdeltaImportquery は、同じエンティティの2回目以降のインポートで増分更新を使用する際のID と条件を定義します。
すべての設定が完了したら、Solr を再起動します。
```
	> solr stop -all
	> solr start
	
```

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

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