intra-mart Accel Platform 設定ファイルリファレンス 第23版 2019-08-01

検索画面設定

概要

IM-ContentsSearch for Accel Platformにおける標準の全文検索画面に関する設定です。
モジュール IM-ContentsSearch コアライブラリ
フォーマットファイル(xsd) WEB-INF/schema/contentssearch-display-config.xsd
設定場所 WEB-INF/conf/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>
    <target>ALL</target>
    <date-ranges>
      <date-range>*</date-range>
      <date-range>24H</date-range>
      <date-range>1W</date-range>
      <date-range>1M</date-range>
      <date-range optional="true">D</date-range>
    </date-ranges>
    <sort enable="true">
      <default-order>keyword</default-order>
    </sort>
  </search-options>

  <view-options>
    <summary>true</summary>
    <number-per-page default="10">
      <number>10</number>
      <number>25</number>
      <number>50</number>
      <number>100</number>
    </number-per-page>
  </view-options>

</contentssearch-display-config>

リファレンス

検索クエリに関する設定

タグ名 query-settings
検索クエリに関する設定です。
詳細な設定は配下のタグで行います。

【設定項目】

<contentssearch-display-config>
  <query-settings>
    ....
  </query-settings>
</contentssearch-display-config>

必須項目
複数設定 ×
親タグ contentssearch-display-config

検索キーワードの最大文字数の設定

タグ名 max-length
検索キーワードの最大文字数を設定します。
検索キーワードがこの値を超えた場合、検索処理は実行されずに警告メッセージが表示されます。

【設定項目】

<contentssearch-display-config>
  <query-settings>
    <max-length>200</max-length>
  </query-settings>
</contentssearch-display-config>

必須項目 ×
複数設定 ×
省略時のデフォルト値 200
親タグ query-settings

検索方法の初期値の設定

タグ名 default-match-type
検索方法の初期値を設定します。

【設定項目】

<contentssearch-display-config>
  <query-settings>
    <default-match-type>partial</default-match-type>
  </query-settings>
</contentssearch-display-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
partial 検索方法を部分一致に設定します。
perfect 検索方法を完全一致に設定します。
省略時のデフォルト値 partial
親タグ query-settings

コラム

intra-mart Accel Platform 2018 Spring(Skylark) から利用可能です。
intra-mart Accel Platform 2017 Winter(Rebecca) 以前と同じ動作をさせるには、「partial」を指定してください。

検索オプションに関する設定

タグ名 search-options
検索オプションに関する設定です。
詳細な設定は配下のタグで行います。

【設定項目】

<contentssearch-display-config>
  <search-options>
    ....
  </search-options>
</contentssearch-display-config>

必須項目
複数設定 ×
親タグ contentssearch-display-config

検索対象の初期値の設定

タグ名 target
検索オプションの 検索結果の絞り込み 欄にある、 検索対象 の初期表示値を設定します。

【設定項目】

<contentssearch-display-config>
  <search-options>
    <target>ALL</target>
      ....
  </search-options>
</contentssearch-display-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
ALL 以下のすべてを検索対象とします。
TITLE コンテンツのタイトルのみを検索対象とします。
TEXT コンテンツの本文のみを検索対象とします。
ATTACHMENT コンテンツに添付されたファイル内のテキストのみを検索対象とします。
単位・型 文字列(ALL/TITLE/TEXT/ATTACHMENT)
省略時のデフォルト値 ALL
親タグ search-options

最新更新日の初期値一覧の設定

タグ名 date-ranges
検索オプションの 検索結果の絞り込み 欄にある、 最新更新日 に表示する内容を設定します。
詳細な設定は配下の date-range タグで行います。

【設定項目】

<contentssearch-display-config>
  <search-options>
    ....
    <date-ranges>
      ....
    </date-ranges>
    ....
  </search-options>
</contentssearch-display-config>

必須項目
複数設定 ×
親タグ search-options

最新更新日の初期値の設定

タグ名 date-range
検索オプションの 検索結果の絞り込み 欄にある、 最新更新日 に表示する内容を設定します。

【設定項目】

<contentssearch-display-config>
  <search-options>
    ....
    <date-ranges>
      <date-range>*</date-range>
      <date-range>24H</date-range>
      <date-range>1W</date-range>
      <date-range>1M</date-range>
      <date-range optional="true">D</date-range>
    </date-ranges>
    ....
  </search-options>
</contentssearch-display-config>

必須項目
複数設定
設定値・設定する内容
「正の整数値 + 単位」 のフォーマットで指定する必要があります。
単位として指定可能な値は、 H (時間), D (日), W (週), M (月)のいずれかです。
例えば、 24H , 1W はそれぞれ 24時間前 , 1週間前 の意味を持ちます。
ただし、 optional 属性に true を指定した場合には、単位のみを指定してください。
単位・型 文字列
親タグ date-ranges

【属性】

属性名 説明 必須 デフォルト値
optional オプション値の指定有無を設定します。 × false

並べ替えに関する設定

タグ名 sort
検索結果の並べ替えに関する設定です。
詳細な設定は配下のタグで行います。

【設定項目】

<contentssearch-display-config>
  <search-options>
    <sort enable="true">
      ....
    </sort>
  </search-options>
</contentssearch-display-config>

必須項目 ×
複数設定 ×
省略時のデフォルト値 false
親タグ search-options

【属性】

属性名 説明 必須 デフォルト値
enable 並べ替え機能の有効、無効を設定します。 × true

注意

並べ替え機能を有効にすると、検索結果が大量にヒットした場合に検索処理の負荷が高くなる場合があります。
利用者が並べ替え機能を利用する事により負荷が高くなることを避ける場合には、並べ替え機能の無効化を検討してください。

並べ替え順序の設定

タグ名 default-order
検索結果の並べ替え順序の初期値を設定します。

【設定項目】

<contentssearch-display-config>
  <search-options>
    ....
    <sort enable="true">
      <default-order>keyword</default-order>
    </sort>
  </search-options>
</contentssearch-display-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
keyword 検索キーワードに関連する順でソートします。
desc コンテンツの日付(更新日時)が新しい順でソートします。
asc コンテンツの日付(更新日時)が古い順でソートします。
単位・型 文字列(keyword/desc/asc)
省略時のデフォルト値 keyword
親タグ sort

検索結果表示に関する設定

タグ名 view-options
検索結果の表示に関するオプションの設定です。
詳細な設定は配下のタグで行います。

【設定項目】

<contentssearch-display-config>
  <view-options>
    ....
  <view-options>
</contentssearch-display-config>

必須項目
複数設定 ×
親タグ contentssearch-display-config

要約表示有無の初期値の設定

タグ名 summary
検索オプションの 検索の設定 欄にある、 要約表示 の初期値の設定です。

【設定項目】

<contentssearch-display-config>
  <view-options>
    <summary>true</summary>
    ....
  <view-options>
</contentssearch-display-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
false 要約を表示しません。
true 要約を表示します。
省略時のデフォルト値 true
親タグ view-options

検索結果件数の設定

タグ名 number-per-page
検索オプションの 検索の設定 欄にある、 ページあたりの表示件数 の設定です。
このタグでは default 属性に初期値を設定します。
選択肢となる設定値は、配下の number タグにて設定します。

【設定項目】

<contentssearch-display-config>
  <view-options>
    ....
    <number-per-page default="10">
      ....
    </number-per-page>
  <view-options>
</contentssearch-display-config>

必須項目
複数設定 ×
親タグ view-options

【属性】

属性名 説明 必須 デフォルト値
default 検索結果件数の初期値を設定します。 なし

検索結果件数の選択肢の設定

タグ名 number
検索オプションの 検索の設定 欄にある、 ページあたりの表示件数 に指定可能な選択肢の設定です。

【設定項目】

<contentssearch-display-config>
  <view-options>
    ....
    <number-per-page default="10">
      <number>10</number>
      <number>25</number>
      <number>50</number>
      <number>100</number>
    </number-per-page>
  <view-options>
</contentssearch-display-config>

必須項目 ×
複数設定
設定値・設定する内容 正の整数値
親タグ number-per-page