intra-mart Accel Platform セットアップガイド 第29版 2019-08-01

5.3.3.6. IM-ContentsSearch

IM-ContentsSearch for Accel Platform を利用するために必要な設定を行います。

5.3.3.6.1. IM-ContentsSearch の機能

intra-mart Accel Platform で全文検索機能を実現するためのモジュールです。
全文検索機能を利用するためには「Apache Solr」サーバを構築する必要があります。
検索対象を追加するには検索対象追加モジュールを追加する必要があります。

コラム

  • Apache Solr のセットアップについては、「 Solr管理者ガイド 」を参照してください。

  • 追加した検索対象のコンテンツを全文検索機能で検索できるようにするためには、検索対象追加モジュールの機能に含まれているジョブをジョブスケジューラ機能で実行する必要があります。
    IM-ContentsSearch のジョブ・ジョブネットについては「 ジョブ・ジョブネットリファレンス 」を参照してください。

5.3.3.6.2. IM-ContentsSearch モジュールの利用

IM-ContentsSearch モジュールを利用する場合は、IM-Juggling で IM-ContentsSearch モジュールを選択してください。
IM-Juggling のプロジェクト作成時の初期設定では、IM-ContentsSearch モジュールは選択済みです。
Overview of IM-ContentsSearch Module Select

5.3.3.6.3. IM-ContentsSearch 検索対象追加モジュールの利用

検索対象追加モジュールを変更する場合、IM-ContentsSearch > IM-ContentsSearch 検索対象追加機能 のモジュールのツリー配下のモジュールを変更してください。
Overview of IM-ContentsSearch Add Module Select

5.3.3.6.4. Solrサーバ接続設定(solr-config.xml)

設定内容

Solrサーバへの接続設定情報を保持するファイルです。

注意

solr-config.xmlの設定値は、intra-mart Accel Platform 2014 Spring(Granada)から使用用途が変更されました。
設定方法

以下は標準で用意されているsolr-config.xmlの一部です。

<group name="default">
   <searcher>
      <method>POST</method>
      <distribution-policy>FIRST</distribution-policy>
      <servers>
         <url>http://localhost:8983/solr/default</url>
      </servers>
   </searcher>
   <indexer>
      <distribution-policy>IDHASH</distribution-policy>
      <servers>
         <url>http://localhost:8983/solr/default</url>
      </servers>
   </indexer>
   <extractor ref="im_default" />
</group>
設定項目
solr-config.xmlの要素
タグ 説明 必須 設定値 デフォルト値 複数設定
<group>
Solrサーバグループ名を設定します。
<group>のnameにSolrサーバグループ名を設定します。
初期値の “default” のままで問題ありません。
Solrサーバグループの設定 なし
<searcher>
IM-ContentsSearchが検索時に接続するSolrサーバを設定します。
検索用Solrサーバの設定 なし ×
<method>
IM-ContentsSearchが検索時にSolrサーバへ送るリクエストのメソッドを設定します。
通常はPOSTから変更する必要はありません。
× 検索時に使用するリクエストメソッドの設定 POST ×
<distribution-policy>
IM-ContentsSearchが検索リクエストを送るSolrサーバを選択するポリシーを設定します。
検索用と索引作成用で利用可能なポリシーが異なります。
× 検索用Solrサーバの選択ポリシー設定 FIRST ×
<servers>
IM-ContentsSearchが検索時に接続するSolrサーバ一覧を設定します。
Solrサーバ設定は配下のurlタグで行います。
検索用Solrサーバ一覧の設定 なし ×
<url>
IM-ContentsSearchが検索時に接続するSolrサーバのURLを設定します。
Solrサーバを構築しているホストのアドレス、および、ポート番号を指定してください。
URL内の「default」は Apache Solr core名であり、Solrサーバグループ名とは別の設定値であるため、変更しないでください。

参考: 各Web Application Serverのデフォルトのポート番号
Resin 8080
Tomcat 8080
Jetty 8983
検索用SolrサーバのURLの設定 なし
<indexer>
IM-ContentsSearchが索引作成時に接続するSolrサーバを設定します。
索引作成用Solrサーバの設定 なし
<distribution-policy>
索引作成用サーバを選択するポリシーを設定します。
検索用と索引作成用で利用可能なポリシーが異なります。
× 索引作成用Solrサーバの選択ポリシー設定 IDHASH ×
<servers>
IM-ContentsSearchが索引作成時に接続するSolrサーバ一覧を設定します。
Solrサーバ設定は配下のurlタグで行います。
索引作成用Solrサーバ一覧の設定 なし ×
<url>
IM-ContentsSearchが索引作成時に接続するSolrサーバのURLを設定します。
defaultは Apache Solr core名であり、Solrサーバグループ名とは別の設定値であるため、変更しないでください。
索引作成用SolrサーバのURLの設定 なし
<extractor>
IM-ContentsSearchが索引作成時にテキスト抽出するファイルの設定グループを指定します。
ref属性にsolr-extractor-config.xmlに定義されたテキスト抽出設定グループIDを指定します。
テキスト抽出設定グループの指定 なし ×

5.3.3.6.4.1. intra-mart Accel Platform 2014 Spring(Granada)からの変更点

intra-mart Accel Platform 2014 Spring(Granada)以降のバージョンをご利用の場合、solr-configの設定値は以下のように使用用途が変更されました。
  • 初回テナント環境セットアップ時、または、Solr接続設定が1件も登録されていない場合のテナント環境セットアップ時に登録されるSolr接続設定
  • Solr接続設定新規作成画面の初期値

コラム

<group>のnameが”default”である設定のみ使用されます。

5.3.3.6.5. テキスト抽出設定(solr-extractor-config.xml)

設定内容

以下の内容に関する設定情報を保持するファイルです。

  • 共通パラメータの設定
  • テキスト抽出対象ファイルの設定
  • テキスト抽出方法の設定
設定方法

以下は標準で用意されているsolr-extractor-config.xmlの一部です。

<extractor name="im_default">
  <default>
    <min-size>0</min-size>
    <max-size>100M</max-size>
    <properties>
      <!-- temporary directory sample for Linux -->
      <property name="tmpDir" type="string">/tmp</property>
      <!-- temporary directory sample for Windows -->
      <!--
      <property name="tmpDir" type="string">C:\temp</property>
      -->
    </properties>
  </default>

  <mapping>
    <!-- Entry for text files -->
    <entry type="text/plain" extension="txt" max-size="1M" class="jp.co.nttdata.intra_mart.contentssearch.text.extraction.extractor.PlainTextExtractor" />
    ...
  </mapping>
</ectractor>
設定項目
solr-extractor-config.xmlに設定する項目を記載します。
一部の要素のみ記載しているため、詳細は 設定ファイルリファレンス テキスト抽出設定 を参照してください。
solr-extractor-config.xmlの要素(一部)
タグ 説明 必須 設定値 デフォルト値 複数設定
<extractor>
一つのテキスト抽出設定グループを表します。
name属性にはテキスト抽出設定グループの名称を指定します。
テキスト抽出設定グループ なし
<min-size>
テキスト抽出対象ファイルサイズ最小値の既定値を設定します。
× テキスト抽出対象ファイルサイズ最小値の既定値 0 (制限なし) ×
<max-size>
テキスト抽出対象ファイルサイズ最大値の既定値を設定します。
× テキスト抽出対象ファイルサイズ最大値の既定値 0 (制限なし) ×
<property>
プロパティの既定値を設定します。
× プロパティ既定値の設定 なし

注意

一時ディスク領域 (propertyタグのname属性”tmpDir”) は必ず設定してください。
指定するディレクトリは、 intra-mart Accel Platform の実行ユーザからアクセス可能である必要があります。

5.3.3.6.5.1. intra-mart Accel Platform 2016 Spring(Maxima)からの変更点

intra-mart Accel Platform 2016 Spring(Maxima)以降のバージョンをご利用の場合、 DocuWorks文書 および DocuWorksバインダー からテキストを抽出して全文検索の対象にすることが可能になりました。
機能を有効にするためには、以下の設定を行う必要があります。
  • solr-extractor-config.xml の設定を有効化する。
  • 富士ゼロックス株式会社より提供されている、DocuWorks Content Filter を intra-mart Accel Platform が動作するサーバにインストールする。

コラム

DocuWorks は富士ゼロックス株式会社の商標です。
設定の有効化方法
以下は2016 Spring(Maxima)から追加されたDocuWorks文書に対応するための solr-extractor-config.xml の記述です。
2015 Winter(Lydia)以前のバージョンからアップデートした場合は、下記の内容を追記してください。
<!-- DocuWorksファイルを処理するLinux向けの設定 -->
<entry enabled="false" type="application/vnd.fujixerox.docuworks" extension="xdw" precedence="1" class="jp.co.intra_mart.foundation.contentssearch.extraction.extractor.DocuWorksExtractor4Linux">
  <property name="tmpExtension" type="string">xdw</property>
  <property name="exeFile" type="string">xdw2text</property>
</entry>
<entry enabled="false" type="application/vnd.fujixerox.docuworks.binder" extension="xbd" precedence="1" class="jp.co.intra_mart.foundation.contentssearch.extraction.extractor.DocuWorksExtractor4Linux">
  <property name="tmpExtension" type="string">xbd</property>
  <property name="exeFile" type="string">xdw2text</property>
</entry>

<!-- DocuWorksファイルを処理するWindows向けの設定 -->
<entry enabled="false" type="application/vnd.fujixerox.docuworks" extension="xdw" precedence="1" class="jp.co.intra_mart.foundation.contentssearch.extraction.extractor.DocuWorksExtractor4Windows">
  <property name="tmpExtension" type="string">xdw</property>
</entry>
<entry enabled="false" type="application/vnd.fujixerox.docuworks.binder" extension="xbd" precedence="1" class="jp.co.intra_mart.foundation.contentssearch.extraction.extractor.DocuWorksExtractor4Windows">
  <property name="tmpExtension" type="string">xbd</property>
</entry>
intra-mart Accel Platform をインストールするサーバOSに合わせて、上記設定の entry タグにある enabled 属性の値を true に変更してください。
例えばサーバOSに Windows を利用する場合、上記設定の下部にある2箇所の entry タグについて enabled 属性の値を true に変更してください。
DocuWorks Content Filterのインストール方法
DocuWorks Content Filter のインストール方法については、「DocuWorks Content Filter のインストール方法」を参照してください。

5.3.3.6.6. 検索画面設定(contentssearch-display-config.xml)

設定内容

以下の内容に関する設定情報を保持するファイルです。

  • 検索クエリに関する設定
  • 検索オプションに関する設定
  • 検索結果表示に関する設定
設定方法

以下は標準で用意されているcontentssearch-display-config.xmlの一部です。

<?xml version="1.0" encoding="UTF-8"?>
<contentssearch-display-config
xmlns="http://intra-mart.co.jp/system/contentssearch/web/config/contentssearch-display-config"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://intra-mart.co.jp/system/contentssearch/web/config/contentssearch-display-config ../schema/contentssearch-display-config.xsd ">

  <query-settings>
    <max-length>200</max-length>
    <default-match-type>partial</default-match-type>
  </query-settings>

  <search-options>
    ...
  </search-options>

  <view-options>
    ...
  </view-options>

</contentssearch-display-config>
設定項目
contentssearch-display-config.xmlに設定する項目を記載します。
一部の要素のみ記載しているため、詳細は 「 設定ファイルリファレンス 」 - 「 検索画面設定 」 を参照してください。
contentssearch-display-config.xmlの要素(一部)
タグ 説明 必須 設定値 デフォルト値 複数設定
<query-settings>
検索クエリに関する設定です。
詳細な設定は配下のタグで行います。
検索クエリに関する設定値 なし ×
<max-length>
検索キーワードの最大文字数を設定します。
検索キーワードがこの値を超えた場合、検索処理は実行されずに警告メッセージが表示されます。
× 検索キーワードの最大文字数の設定値 200 ×
<default-match-type>
検索方法の初期値の設定です。
× 検索方法の初期値の設定値 partial ×
<search-options>
検索オプションに関する設定です。
詳細な設定は配下のタグで行います。
検索オプションに関する設定値 なし ×
<view-options>
検索結果の表示に関するオプションの設定です。
詳細な設定は配下のタグで行います。
検索結果の表示に関するオプションの設定値 なし ×

5.3.3.6.6.1. intra-mart Accel Platform 2018 Spring(Skylark)からの変更点

intra-mart Accel Platform 2018 Spring(Skylark)以降のバージョンをご利用の場合、 検索方法の初期値が変更可能になりました。
設定できる検索方法は、以下です。
  • 部分一致検索
  • 完全一致検索
設定の有効化方法
以下は2018 Spring(Skylark)から追加された検索方法の初期値の設定を対応するための contentssearch-display-config.xml の記述です。
2017 Winter(Rebecca)以前のバージョンからアップデートした場合は、<query-settings>タグ配下に下記の内容を追記してください。
<?xml version="1.0" encoding="UTF-8"?>
<contentssearch-display-config
xmlns="http://intra-mart.co.jp/system/contentssearch/web/config/contentssearch-display-config"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://intra-mart.co.jp/system/contentssearch/web/config/contentssearch-display-config ../schema/contentssearch-display-config.xsd ">

  <query-settings>
    ...
    <!-- 検索方法の初期値の設定値 -->
    <default-match-type>partial</default-match-type>
  </query-settings>

  <search-options>
    ...
  </search-options>

  <view-options>
    ...
  </view-options>

</contentssearch-display-config>
検索方法の初期値を「部分一致検索」に設定する場合は、<default-match-type>を”partial” に変更してください。
検索方法の初期値を「完全一致検索」に設定する場合は、<default-match-type>を”perfect” に変更してください。
詳細は、「 設定ファイルリファレンス 」 - 「 検索画面設定 」-「 検索方法の初期値の設定 」を参照してください。