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

検索結果テンプレート設定

概要

IM-ContentsSearch for Accel Platformにおける検索結果テンプレートに関する設定です。
本ドキュメントでは以下の設定ファイルを例として説明を記載しています。
  • contentssearch-template-config_imbox.xml
モジュール IM-ContentsSearch コアライブラリ
フォーマットファイル(xsd) WEB-INF/schema/contentssearch-template-config.xsd
設定場所 WEB-INF/conf/contentssearch-template-config/{任意のファイル名}.xml

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

    <template-pages>

        <template-page type="imbox" sort-key="3">
            <type-display-key>CAP.Z.IWP.CONTENTSSEARCH.IMBOX.CONTENTS.TYPE</type-display-key>
        </template-page>

        <template-page type="broadcast" sort-key="1">
            <parent-type>imbox</parent-type>
            <type-display-key>CAP.Z.IWP.CONTENTSSEARCH.IMBOX.BROADCASTMESSAGE.CONTENTS.TYPE</type-display-key>
            <template-path>im_contents_search/template/imbox/broadcast_message_template.jssp</template-path>
            <require-dynamic-fields>
                <field type="string">create_thread_user</field>
                <field type="string_mlt">reply_user</field>
                <field type="string_mlt">tag_name</field>
            </require-dynamic-fields>
        </template-page>
        <template-page type="companybox" sort-key="2">
            <parent-type>imbox</parent-type>
            <type-display-key>CAP.Z.IWP.CONTENTSSEARCH.IMBOX.COMPANYBOX.CONTENTS.TYPE</type-display-key>
            <template-path>im_contents_search/template/imbox/company_message_template.jssp</template-path>
            <require-dynamic-fields>
                <field type="string">create_thread_user</field>
                <field type="string_mlt">reply_user</field>
                <field type="string_mlt">tag_name</field>
            </require-dynamic-fields>
        </template-page>
        <template-page type="groupbox" sort-key="3">
            <parent-type>imbox</parent-type>
            <type-display-key>CAP.Z.IWP.CONTENTSSEARCH.IMBOX.GROUPBOX.CONTENTS.TYPE</type-display-key>
            <template-path>im_contents_search/template/imbox/group_message_template.jssp</template-path>
            <require-dynamic-fields>
                <field type="string">create_thread_user</field>
                <field type="string_mlt">reply_user</field>
                <field type="string_mlt">tag_name</field>
            </require-dynamic-fields>
        </template-page>
        <template-page type="directmessagebox" sort-key="5">
            <parent-type>imbox</parent-type>
            <type-display-key>CAP.Z.IWP.CONTENTSSEARCH.IMBOX.DIRECTMESSAGEBOX.CONTENTS.TYPE</type-display-key>
            <template-path>im_contents_search/template/imbox/direct_message_template.jssp</template-path>
            <require-dynamic-fields>
                <field type="string">create_thread_user</field>
                <field type="string_mlt">destination_user</field>
            </require-dynamic-fields>
        </template-page>

    </template-pages>

</contentssearch-template-config>

リファレンス

検索結果テンプレート設定

タグ名 template-pages
検索結果テンプレートのルートタグです。
詳細な設定は配下のタグで行います。

【設定項目】

<contentssearch-template-config>
    <template-pages>
        ....
    </template-pages>
</contentssearch-template-config>

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

検索結果テンプレート設定

タグ名 template-page
コンテンツ種別ごとに検索結果テンプレートを設定をします。
詳細な設定は配下のタグで行います。

【設定項目】

<contentssearch-template-config>
    <template-pages>
        <template-page type="broadcast" sort-key="1">
            ....
        </template-page>
    </template-pages>
</contentssearch-template-config>

必須項目
複数設定
親タグ template-pages

【属性】

属性名 説明 必須 デフォルト値
type
コンテンツ種別を指定します。
指定可能な値は、string のみです。
なし
sort-key
絞り込み条件に表示されるコンテンツ種別のソート順を指定します。
指定可能な値は、int のみです。
× 2147483647

親となるコンテンツ種別の設定

タグ名 parent-type
親となるコンテンツ種別を設定します。
指定可能な値は、string のみです。

【設定項目】

<contentssearch-template-config>
    <template-pages>
        <template-page type="broadcast" sort-key="1">
            <parent-type>imbox</parent-type>
            ....
        </template-page>
    </template-pages>
</contentssearch-template-config>

必須項目 ×
複数設定 ×
親タグ template-page

コンテンツ種別表示用プロパティキーの設定

タグ名 type-display-key
絞り込み条件に表示されるコンテンツ種別の表示用プロパティキーを表します。
指定可能な値は、string のみです。

【設定項目】

<contentssearch-template-config>
    <template-pages>
        <template-page type="broadcast" sort-key="1">
            <type-display-key>CAP.Z.IWP.CONTENTSSEARCH.IMBOX.BROADCASTMESSAGE.CONTENTS.TYPE</type-display-key>
            ....
        </template-page>
    </template-pages>
</contentssearch-template-config>

必須項目
複数設定 ×
親タグ template-page

テンプレート画面パス設定

タグ名 template-path
検索結果テンプレート画面の実装があるパスを指定します。
指定可能な値は、string のみです。

【設定項目】

<contentssearch-template-config>
    <template-pages>
        <template-page type="broadcast" sort-key="1">
            <template-path>im_contents_search/template/imbox/broadcast_message_template.jssp</template-path>
            ....
        </template-page>
    </template-pages>
</contentssearch-template-config>

必須項目 ×
複数設定 ×
親タグ template-page

動的フィールド一覧設定

タグ名 require-dynamic-fields
検索結果テンプレートにて利用する動的フィールドの一覧を設定します。
詳細な設定は配下のタグで行います。

【設定項目】

<contentssearch-template-config>
    <template-pages>
        <template-page type="broadcast" sort-key="1">
            ....
            <require-dynamic-fields>
                ....
            </require-dynamic-fields>
            ....
        </template-page>
    </template-pages>
</contentssearch-template-config>

必須項目 ×
複数設定 ×
親タグ template-page

動的フィールド設定

タグ名 field
検索結果テンプレートにて利用する動的フィールドを設定します。

【設定項目】

<contentssearch-template-config>
    <template-pages>
        <template-page type="broadcast" sort-key="1">
            ....
            <require-dynamic-fields>
                <field type="string">create_thread_user</field>
            </require-dynamic-fields>
            ....
        </template-page>
    </template-pages>
</contentssearch-template-config>

必須項目
複数設定
親タグ require-dynamic-fields

【属性】

属性名 説明 必須 デフォルト値
type
フィールドのデータ型を指定します。
指定可能な値は、以下の通りです。
string , string_mlt , int , int_mlt
long , long_mlt , date , date_mlt
boolean , boolean_mlt , morph , morph_mlt
ngram , ngram_mlt , whitespace , whitespace_mlt
なし