intra-mart Accel Platform / Setup Guide

Version 12 2014-08-01

«  5.3.3.4. IMBox   ::   Contents   ::   5.3.3.6. IM-Workflow  »

5.3.3.5. IM-ContentsSearch

Apache Solr to be used in IM-ContentsSearch for Accel Platform is set.

5.3.3.5.1. IM-ContentsSearch Function

It is a module to achieve full text search function in intra-mart Accel Platform.
In order to use full text search function, [Apache Solr] server needs to be built.
Search subject addition module should be added to add the search subject.

Note

Please refer to [Solr Administrator Guide] for [Apache Solr Setup].

5.3.3.5.2. IM-ContentsSearch Module Use

If IM-ContentsSearch module is used, IM-ContentsSearch module should be selected in IM-Juggling.
In the initial setting when project of IM-Juggling is created, IM-ContentsSearch module has been already selected.
Overview of IM-ContentsSearch Module Select

5.3.3.5.3. IM-ContentsSearch Search Subject Addition Module Use

If search subject addition module is changed, the module under tree of IM-ContentsSearch > IM-ContentsSearch search subject addition function module should be changed.
Overview of IM-ContentsSearch Add Module Select

5.3.3.5.4. Solr Server Connection Setting (solr-config.xml)

Setting Contents

It is a file to retain the connection setting information for Solr server.

Warning

For the setting value of solr-config.xml, the intended usage has been changed from intra-mart Accel Platform 2014 Spring(Granada).
Setting Method

Shown below is the part of solr-config.xml that is provided as standard.

<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>
Setting Items
solr-config.xml Elements
Tag Description Mandatory Setting Value Default Value Multiple Settings
<group>
It sets Solr server group name.
Solr server group name should be set to name of <group>.
It can remain as the initial value, “default”.
O Solr server group setting None O
<searcher>
It sets Solr server that IM-ContentsSearch connects to for search.
O Solr server setting for search None X
<method>
It sets the method of request that IM-ContentsSearch sends to Solr server for search.
Normally, it does not need to be changed from POST.
X Request method setting that is used for search POST X
<distribution-policy>
It sets policy that selects Solr server to which IM-ContentsSearch sends the search request.
Available policy for search and that for index creation are different.
X Selection policy setting of Solr server for search FIRST X
<servers>
It sets Solr server list that IM-ContentsSearch connects to for search.
Solr server setting is set by the subordinate url tag.
O Solr server list setting for search None X
<url>
It sets Solr server URL that IM-ContentsSearch connects to for search.
default is Apache Solr core name and it is the setting value different from Solr server group name. Therefore, please do not change it.
O Solr server URL setting for search None O
<indexer>
It sets Solr server that IM-ContentsSearch connects to for index creation.
O Solr server setting for index creation None O
<distribution-policy>
It sets policy that selects the server for index creation.
Available policy for search and that for index creation are different.
X Selection policy setting of Solr server for index creation IDHASH X
<servers>
It sets Solr server list that IM-ContentsSearch connects to for index creation.
Solr server setting is set by the subordinate url tag.
O Solr server list setting for index creation None X
<url>
It sets Solr server URL that IM-ContentsSearch connects to for index creation.
default is Apache Solr core name and it is the setting value different from Solr server group name. Therefore, please do not change it.
O Solr server URL setting for index creation None O
<extractor>
It specifies the setting group of file that IM-ContentsSearch does text extract for index creation.
Text extract setting group ID that is defined in solr-extractor-config.xml is specified to ref attribute.
O Specify text extract setting group None X

5.3.3.5.4.1. Changes from intra-mart Accel Platform 2014 Spring(Granada)

If intra-mart Accel Platform 2014 Spring(Granada) version or later is used, the intended usage of solr-config setting value has changed as below.
  • Solr connection setting to be registered for the initial tenant environment setup or the tenant environment setup in case no Solr connection setting has been registered
  • Initial value of Solr connection setting new creation screen

Note

Only the setting with the name of <group> being “default” will be used.

5.3.3.5.5. Text Extract Setting (solr-extractor-config.xml)

Setting Contents

It is a file that retains setting information related to the following contents.

  • Common Parameter Setting
  • Text Extract Subject File Setting
  • Text Extract Method Setting
Setting Method

Shown below is the part of solr-extractor-config.xml that is provided as standard.

<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>
Setting Items
Items to be set to solr-extractor-config.xml are stated.
Since only the part of elements are described, please refer to Configuration File Reference Text Extract Setting for details.
solr-extractor-config.xml Elements (partial)
Tag Description Mandatory Setting Value Default Value Multiple Settings
<extractor>
It represents one text extract setting group.
Text extract setting group name is specified to name attribute.
O Text extract setting group None O
<min-size>
It sets the defined value of text extract subject file size minimum value.
X Defined value of text extract subject file size minimum value 0 (no limitation) X
<min-size>
It sets the defined value of text extract subject file size maximum value.
X Defined value of text extract subject file size maximum value 0 (no limitation) X
<property>
It sets the defined value of property.
Temporary disk area (name attribute “tmDir” of property tag) must be set.
Disk area which is accessible by the user who executes intra-mart Accel Platform must be specified.
X Property defined value setting None O

«  5.3.3.4. IMBox   ::   Contents   ::   5.3.3.6. IM-Workflow  »