IM-共通マスタ設定¶
項目
- 概要
- リファレンス
- セパレータ
- 大量データモード
- 大量データモード(ユーザ検索)
- ユーザ検索表示件数
- 大量データモード(会社・組織検索)
- 組織一覧表示件数
- 大量データモード(パブリックグループ検索)
- パブリックグループ一覧表示件数
- 大量データモード(ロール検索)
- ロール検索表示件数
- 大量データモード(アカウント検索)
- アカウント検索表示件数
- 大量データモード(組織+ユーザ分類項目検索)
- ユーザ分類項目検索表示件数
- 大量データモード[スマートフォン]
- 大量データモード[スマートフォン](ユーザ検索)
- ユーザ検索表示件数[スマートフォン]
- 大量データモード[スマートフォン](会社・組織検索)
- 組織一覧表示件数[スマートフォン]
- 大量データモード[スマートフォン](パブリックグループ検索)
- パブリックグループ一覧表示件数[スマートフォン]
- 大量データモード[スマートフォン](ロール検索)
- ロール検索表示件数[スマートフォン]
- 大量データモード[スマートフォン](アカウント検索)
- アカウント検索表示件数[スマートフォン]
- APIモデルバリデーション
- あいまい検索(ユーザ検索)
- あいまい検索(小文字・大文字の設定)
- あいまい検索(半角・全角の設定)
- あいまい検索(ひらがな・カタカナの設定)
- プロファイル画像
- プロファイル画像(種別)
- プロファイル画像(最大値)
- 検索ダイアログ設定
- 検索ダイアログデフォルトサイズ設定
概要¶
IM-共通マスタで利用する設定を行います。
モジュール IM-共通マスタフォーマットファイル(xsd) WEB-INF/schema/im-master-config.xsd設定場所 WEB-INF/conf/im-master-config.xml<?xml version="1.0" encoding="UTF-8"?> <im-master-config xmlns="http://intra-mart.co.jp/foundation/master/common/config/im-master-config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://intra-mart.co.jp/foundation/master/common/config/im-master-config ../schema/im-master-config.xsd "> <separator>/</separator> <large-data-mode> <user enabled="false"> <limit>1000</limit> </user> <department enabled="false"> <length>20</length> </department> <public-group enabled="false"> <length>20</length> </public-group> <role enabled="false"> <limit>1000</limit> </role> <account enabled="false"> <limit>1000</limit> </account> <user-category-item enabled="false"> <limit>1000</limit> </user-category-item> </large-data-mode> <sp-large-data-mode> <user> <limit>1000</limit> </user> <department> <length>20</length> </department> <public-group> <length>20</length> </public-group> <role> <limit>1000</limit> </role> <account> <limit>1000</limit> </account> </sp-large-data-mode> <api-model-validation enabled="true" /> <fuzzy-string-search> <fuzzy-search enabled="true"> <!-- 大文字・小文字を区別しないかどうか --> <upper>false</upper> <!-- 半角・全角を区別しないかどうか(Japanese Only) --> <to-multi-byte>false</to-multi-byte> <!-- ひらがな・カタカナを区別しないかどうか(Japanese Only) --> <transliterate>false</transliterate> </fuzzy-search> </fuzzy-string-search> <user-image-config> <image-size-type key="large" size="100" /> <image-size-type key="small" size="48" /> <max-image-file-size>20</max-image-file-size> </user-image-config> </im-master-config>
リファレンス¶
セパレータ¶
タグ名 separator 階層構造を持つデータ(組織、パブリックグループetc)を表示する場合の区切り文字を定義します。【設定項目】
<im-master-config> <separator>/</separator> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 セパレータ 単位・型 文字列 省略時のデフォルト値 なし 親タグ im-master-config
大量データモード¶
タグ名 large-data-mode 大量データモードの利用を定義します。大量データモードとは、全件検索やあいまい検索などレスポンス悪化を招く検索を制限するためのものです。利用データ件数が大量にある場合には登録されているデータ全てを対象とせず、より範囲を狭めた検索を実行するようにします。大量データモードを使用すると以下の制約が発生します。
- キーワードの入力が必須です。つまり、全件検索はできません。
- キーワード検索対象が、「名前」、「コード」、「検索名(ユーザの場合フリガナ)」のいずれかになります。
- キーワード検索条件は「完全一致」、「前方一致」のどちらか一つしか選択できなくなります。
- 表示数制限を超えたデータの取得ができなくなります。
【設定項目】
<im-master-config> <large-data-mode> .... </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ im-master-config
大量データモード(ユーザ検索)¶
タグ名 user ユーザ検索の実行時に大量データモードを利用するかを設定します。【設定項目】
<im-master-config> <large-data-mode> <user enabled="false"> .... </user> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ large-data-mode 【属性】
属性名 説明 必須 デフォルト値 enabled trueの場合、大量データモードを利用します。falseの場合、大量データモードを利用しません。○ なし
ユーザ検索表示件数¶
タグ名 limit 大量データモードを利用した場合にユーザ情報の最大取得件数を設定します。設定値に従って打ち切ります。大量データモードを利用しない場合は設定値は無視されます。【設定項目】
<im-master-config> <large-data-mode> <user enabled="false"> <limit>1000</limit> </user> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ user
大量データモード(会社・組織検索)¶
タグ名 department 会社・組織検索の実行時に大量データモードを利用するかを設定します。この設定を有効にした場合は、直下のノードの一覧のみを取得します。この設定を無効にした場合は、階層の下位を再帰的に末端まで取得します。(検索条件の指定によっては指定されているノードまで取得します。)【設定項目】
<im-master-config> <large-data-mode> <department enabled="true"> .... </department> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ large-data-mode 【属性】
属性名 説明 必須 デフォルト値 enabled trueの場合大量データモードを利用します。falseの場合、大量データモードを利用しません。○ なし
組織一覧表示件数¶
タグ名 length 会社・組織の検索結果で改ページを有する箇所で1ページの表示件数を設定します。【設定項目】
<im-master-config> <large-data-mode> <department enabled="true"> <length>20</length> </department> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ department
大量データモード(パブリックグループ検索)¶
タグ名 public-group パブリックグループ検索の実行時に大量データモードを利用するかを設定します。この設定を有効にした場合は、直下のノードの一覧のみを取得します。この設定を無効にした場合は、階層の下位を再帰的に末端まで取得します。(検索条件の指定によっては指定されているノードまでとなります。)【設定項目】
<im-master-config> <large-data-mode> <public-group enabled="true"> .... </public-group> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ large-data-mode 【属性】
属性名 説明 必須 デフォルト値 enabled trueの場合、大量データモードを利用します。falseの場合、大量データモードを利用しません。○ なし
パブリックグループ一覧表示件数¶
タグ名 length パブリックグループの検索結果で改ページを有する箇所で1ページの表示件数を設定します。【設定項目】
<im-master-config> <large-data-mode> <public-group enabled="true"> <length>20</length> </public-group> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ public-group
大量データモード(ロール検索)¶
タグ名 role ロール検索の実行時に大量データモードを利用するかを設定します。【設定項目】
<im-master-config> <large-data-mode> <role enabled="false"> .... </role> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ large-data-mode 【属性】
属性名 説明 必須 デフォルト値 enabled trueの場合、大量データモードを利用します。falseの場合、大量データモードを利用しません。○ なし
ロール検索表示件数¶
タグ名 limit 大量データモードを利用した場合にロール情報の最大取得件数を設定します。設定値に従って打ち切ります。大量データモードを利用しない場合は設定値は無視されます。【設定項目】
<im-master-config> <large-data-mode> <role enabled="false"> <limit>1000</limit> </role> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ role
大量データモード(アカウント検索)¶
タグ名 account アカウント検索の実行時に大量データモードを利用するかを設定します。【設定項目】
<im-master-config> <large-data-mode> <account enabled="false"> .... </account> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ large-data-mode 【属性】
属性名 説明 必須 デフォルト値 enabled trueの場合、大量データモードを利用します。falseの場合、大量データモードを利用しません。○ なし
アカウント検索表示件数¶
タグ名 limit 大量データモードを利用した場合にアカウント情報の最大取得件数を設定します。設定値に従って打ち切ります。大量データモードを利用しない場合は設定値は無視されます。【設定項目】
<im-master-config> <large-data-mode> <account enabled="false"> <limit>1000</limit> </account> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ account
大量データモード(組織+ユーザ分類項目検索)¶
タグ名 user-category-item 組織+ユーザ分類項目検索の実行時に大量データモードを利用するかを設定します。【設定項目】
<im-master-config> <large-data-mode> <user-category-item enabled="false"> .... </user-category-item> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ large-data-mode 【属性】
属性名 説明 必須 デフォルト値 enabled trueの場合、大量データモードを利用します。falseの場合、大量データモードを利用しません。○ なし
ユーザ分類項目検索表示件数¶
タグ名 limit 大量データモードを利用した場合にユーザ分類項目情報の最大取得件数を設定します。設定値に従って打ち切ります。大量データモードを利用しない場合は設定値は無視されます。【設定項目】
<im-master-config> <large-data-mode> <user-category-item enabled="false"> <limit>1000</limit> </user-category-item> </large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ user-category-item
大量データモード[スマートフォン]¶
タグ名 sp-large-data-mode スマートフォンで大量データモードの利用を定義します。大量データモードとは、全件検索やあいまい検索などレスポンス悪化を招く検索を制限するためのものです。利用データ件数が大量にある場合に登録されているデータ全てを対象とせず、より範囲を狭めた検索を実行するようになります。大量データモードを使用すると以下の制約が発生します。
- キーワードの入力が必須になります。つまり、全件検索はできなくなります。
- 表示数制限を超えたデータの取得ができなくなります。
【設定項目】
<im-master-config> <sp-large-data-mode> .... </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ im-master-config
大量データモード[スマートフォン](ユーザ検索)¶
タグ名 user 大量データモードを利用した場合のユーザ情報の検索条件を設定します。【設定項目】
<im-master-config> <sp-large-data-mode> <user> .... </user> </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ sp-large-data-mode
ユーザ検索表示件数[スマートフォン]¶
タグ名 limit 大量データモードを利用した場合にユーザ情報の最大取得件数を設定します。設定値に従って打ち切ります。大量データモードを利用しない場合は設定値は無視されます。【設定項目】
<im-master-config> <sp-large-data-mode> <user> <limit>1000</limit> </user> </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ user
大量データモード[スマートフォン](会社・組織検索)¶
タグ名 department 現在利用されていません。【設定項目】
<im-master-config> <sp-large-data-mode> <department> .... </department> </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ sp-large-data-mode
組織一覧表示件数[スマートフォン]¶
タグ名 length 現在利用されていません。【設定項目】
<im-master-config> <sp-large-data-mode> <department> <length>20</length> </department> </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ department
大量データモード[スマートフォン](パブリックグループ検索)¶
タグ名 public-group 現在利用されていません。【設定項目】
<im-master-config> <sp-large-data-mode> <public-group> .... </public-group> </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ sp-large-data-mode
パブリックグループ一覧表示件数[スマートフォン]¶
タグ名 length 現在利用されていません。【設定項目】
<im-master-config> <sp-large-data-mode> <public-group> <length>20</length> </public-group> </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ public-group
大量データモード[スマートフォン](ロール検索)¶
タグ名 role ロール検索の実行時に大量データモードを利用するかを設定します。【設定項目】
<im-master-config> <sp-large-data-mode> <role> .... </role> </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ sp-large-data-mode
ロール検索表示件数[スマートフォン]¶
タグ名 limit 大量データモードを利用した場合にロール情報の最大取得件数を設定します。設定値に従って打ち切ります。大量データモードを利用しない場合は設定値は無視されます。【設定項目】
<im-master-config> <sp-large-data-mode> <role> <limit>1000</limit> </role> </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ role
大量データモード[スマートフォン](アカウント検索)¶
タグ名 account 現在利用されていません。【設定項目】
<im-master-config> <sp-large-data-mode> <account> .... </account> </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ sp-large-data-mode
アカウント検索表示件数[スマートフォン]¶
タグ名 limit 現在利用されていません。【設定項目】
<im-master-config> <sp-large-data-mode> <account> <limit>1000</limit> </account> </sp-large-data-mode> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 なし 単位・型 数値 (1 - ) 省略時のデフォルト値 なし 親タグ account
APIモデルバリデーション¶
タグ名 api-model-validation IM-共通マスタAPIでのバリデーションの動作を定義します。このバリデーションは、APIの引数に対して「IM-共通マスタ 入力項目定義書」に定義されている制約に違反していないかどうか検証します。コラム
intra-mart Accel Platform 2015 Winter 以前は、APIの引数に対する必須制約のみ検証されていました。intra-mart Accel Platform 2016 Spring から、データの登録に関するAPIで「IM-共通マスタ 入力項目定義書」に定義されている制約に違反していないかどうか検証されるようになりました。この検証を無効化したい場合は、属性 enabled に対して明示的に false を指定してください。【設定項目】
<im-master-config> <api-model-validation enabled="true" /> </im-master-config>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 属性「enabled」の設定値が「true」として動作します。 親タグ im-master-config 【属性】
属性名 説明 必須 デフォルト値 enabled trueの場合、APIバリデーションが動作します。falseの場合、APIバリデーションが動作しません。○ なし
あいまい検索(ユーザ検索)¶
タグ名 fuzzy-string-search IM-共通マスタでユーザ検索時に、あいまい検索を利用するかどうかを定義します。ここでのあいまい検索とは、アルファベットの大文字・小文字/ひらがな・カタカナ/半角・全角を区別せず検索するためのものです。あいまい検索を使用する際は、以下の制限事項が発生します。
- ユーザ検索のパフォーマンスが劣化する可能性があります
- アルファベット、ひらがな、カタカナを複合させた場合、意図した結果が表示されない場合があります
詳細は「制限事項 」-「IM共通マスタ 」を参照してください。
【設定項目】
<im-master-config> <fuzzy-string-search> <fuzzy-search enabled="true"> .... </fuzzy-search> </fuzzy-string-search> </im-master-config>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 真偽値 省略時のデフォルト値 属性「enabled」の設定値が「false」として動作します。 親タグ im-master-config 【属性】
属性名 説明 必須 デフォルト値 enabled trueの場合、ユーザ検索であいまい検索を利用します。falseの場合、ユーザ検索であいまい検索を利用しません。○ なし
あいまい検索(小文字・大文字の設定)¶
タグ名 upper あいまい検索を利用した場合に、大文字・小文字を区別しないかどうかを設定します。【設定項目】
<im-master-config> <fuzzy-string-search> <fuzzy-search enabled="true"> <upper>false</upper> .... </fuzzy-search> </fuzzy-string-search> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 trueの場合、大文字・小文字を区別しません。falseの場合、大文字・小文字を区別します。単位・型 真偽値 省略時のデフォルト値 なし 親タグ fuzzy-search
あいまい検索(半角・全角の設定)¶
タグ名 to-multi-byte あいまい検索を利用した場合に、半角・全角を区別しないかどうかを設定します。【設定項目】
<im-master-config> <fuzzy-string-search> <fuzzy-search enabled="true"> <to-multi-byte>false</to-multi-byte> .... </fuzzy-search> </fuzzy-string-search> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 trueの場合、半角・全角を区別しません。falseの場合、半角・全角を区別します。単位・型 真偽値 省略時のデフォルト値 なし 親タグ fuzzy-search
あいまい検索(ひらがな・カタカナの設定)¶
タグ名 transliterate あいまい検索を利用した場合に、ひらがな・カタカナを区別しないかどうかを設定します。【設定項目】
<im-master-config> <fuzzy-string-search> <fuzzy-search enabled="true"> <transliterate>false</transliterate> .... </fuzzy-search> </fuzzy-string-search> </im-master-config>
必須項目 ○ 複数設定 × 設定値・設定する内容 trueの場合、ひらがな・カタカナを区別しません。falseの場合、ひらがな・カタカナを区別します。単位・型 真偽値 省略時のデフォルト値 なし 親タグ fuzzy-search
プロファイル画像¶
タグ名 user-image-config プロファイル画像に関しての設定を定義します。【設定項目】
<im-master-config> <user-image-config> .... </user-image-config> </im-master-config>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ im-master-config
プロファイル画像(種別)¶
タグ名 image-size-type プロファイル画像のサムネイルのサイズおよび種別を設定します。指定したサイズで正方形のサムネイル画像を生成し画像を保存します。【設定項目】
<im-master-config> <user-image-config> <image-size-type key="xx-large" size="350" /> <image-size-type key="x-large" size="200" /> <image-size-type key="large" size="100" /> <image-size-type key="small" size="48" /> </user-image-config> </im-master-config>
必須項目 × 複数設定 ○ 親タグ im-master-config 【属性】
属性名 説明 必須 デフォルト値 key 画像種別を定義します。○ なし size 画像の縦横のサイズ(ピクセル)を定義します。○ なし コラム
image-size-typeの記載が無い場合は、以下内容でサムネイルが作成されます。
種別(key) サイズ(size) large 100 small 48
プロファイル画像(最大値)¶
タグ名 max-image-file-size プロファイル画像としてアップロードできるファイルサイズの最大バイト数(MBytes)を設定します。【設定項目】
<im-master-config> <user-image-config> <max-image-file-size>20</max-image-file-size> </user-image-config> </im-master-config>
必須項目 × 複数設定 × 設定値・設定する内容 ファイルサイズの最大バイト数単位・型 数値 (1 - ) 省略時のデフォルト値 20MByte 親タグ user-image-config
検索ダイアログ設定¶
タグ名 search-dialog-config 検索ダイアログに関しての設定を定義します。【設定項目】
<im-master-config> <search-dialog-config> .... </search-dialog-config> </im-master-config>
必須項目 × 複数設定 × 設定値・設定する内容 なし 単位・型 なし 省略時のデフォルト値 なし 親タグ im-master-config
検索ダイアログデフォルトサイズ設定¶
タグ名 default-size-absolute 検索ダイアログのデフォルトサイズに関しての設定を行います。固定サイズかウィンドウサイズとの比率サイズか選択できます。検索ダイアログはimACMSearchDialogタグを利用しているため、詳細は スクリプト開発向けタグライブラリ の imACMSearchDialog を参照してください。【設定項目】
<im-master-config> <search-dialog-config> <default-size-absolute>false</default-size-absolute> </search-dialog-config> </im-master-config>
必須項目 × 複数設定 × 設定値・設定する内容 trueの場合、ダイアログのデフォルトサイズは固定です。(横800px * 縦600px)falseの場合、ダイアログのデフォルトサイズはウィンドウサイズに依存します。単位・型 真偽値 省略時のデフォルト値 false 親タグ search-dialog-config