intra-mart Accel Platform IM-共通マスタ スマートフォン 検索画面仕様書 第5版 2018-04-01

5.2.1. ユーザ検索(キーワード)タブ

ユーザ検索(キーワード)タブでは、キーワード検索によりユーザ情報を検索します。

5.2.1.1. 画面構成

ユーザ検索(キーワード)タブの画面表示は以下のとおりです。
../../../_images/user_search_keyword.png

【図:ユーザ検索(キーワード)タブ 画面表示】

分類 項目 備考
キーワード検索 キーワード 検索する文字列。
検索結果一覧   キーワード検索を実行した結果を表示。

【表:ユーザ検索(キーワード)タブ 画面項目】

5.2.1.2. 画面イベントと検索処理

ユーザ検索(キーワード)タブで発生する画面イベントと検索処理の関連は以下のとおりです。
イベント 検索処理
画面起動時 特になし
検索ボタン押下時 入力されたキーワードよりユーザ検索を実行する。

【表:ユーザ検索(キーワード)タブ 画面イベントと検索処理】

5.2.1.2.1. ユーザ検索に関する補足(認可)

ユーザ検索では、ログインユーザごとに認可による会社の絞り込みが行われます。
検索結果には、ログインユーザが参照できる会社に所属しているユーザが表示されます。

コラム

暗黙条件にログインユーザが認可されていない会社が指定されている場合、それを除いて検索します。

5.2.1.3. 起動パラメータ

起動時のパラメータ設定により表示や検索条件を変更することができます。
ユーザ検索(キーワード)タブで指定可能なパラメータについて列挙します。

5.2.1.3.1. 画面構築基盤用

共通検索画面の外枠をなす画面構築基盤への引数です。
主に画面表示時のタイトルラベルなどに関する設定をします。
パラメータの詳細は「画面構築基盤用 」を参照してください。

5.2.1.3.2. 共通パラメータ

検索の基本条件となる引数です。
検索基準日、検索対象ロケール、削除されたデータの取得有無に関する設定をします。
パラメータの詳細は「共通パラメータ 」を参照してください。

5.2.1.3.3. 準共通パラメータ

タブ毎に、取得するテーブルのカラム名を設定します。
パラメータの詳細は「準共通パラメータ 」を参照してください。

コラム

ユーザ検索(キーワード)タブでは IMM_USER テーブルのカラムを取得可能です。

5.2.1.3.4. ユーザ検索固有

ユーザ検索時にのみ必要となる引数です。
  • 主所属による絞り込み
    検索対象を、主所属組織が設定されたユーザのみとするかを設定します。
プロパティ名 必須 初期値 備考
department_main_only Boolean × true
true : 主所属のみを表示
false: 主所属以外も含めて表示

5.2.1.3.5. キーワード検索固有

キーワード検索時にのみ必要となる引数です。
  • 検索対象
    キーワードの検索対象を指定します。
    複数指定することができます。
プロパティ名 必須 初期値 備考
keyword_search_target





Array
×
-
検索対象を指定
配列インデックス


String




“code”,”name”,”search_name”


code:コード
name:名称
search_name:検索名

  • 検索方法
    キーワード検索の検索方法を指定します。
プロパティ名 必須 初期値 備考
keyword_search_type


Boolean


×


prefix


prefix: 前方一致
full : 完全一致
part : 部分一致

5.2.1.3.6. 暗黙条件

ユーザ検索(キーワード)タブで検索を行う際に、ユーザ操作とは別に指定する条件です。
検索結果はこの暗黙条件の範囲で自動的に絞り込まれます。
  • 会社
    ユーザ検索時に指定の会社で絞り込みます。
    ただし、組織リストまたは組織を設定している場合、会社は利用されません。
    認可設定で許可された会社のみ有効です。
プロパティ名 必須 初期値 備考
company   Array × -  
配列インデックス   Object × -  
company_cd String -  
1
2
3
"criteria" : {
    "company" : [ { "company_cd" : 会社コード } , { "company_cd" :  会社コード } , ... ]
}

  • 組織リスト
    ユーザ検索時に指定の会社と組織の組み合わせで絞り込みます。
    ただし、1つの会社に複数の組織を指定することはできません。
    認可設定で許可された会社のみ有効です。
プロパティ名 必須 初期値 備考
department_set_list   Array × -  
配列インデックス   Object × -  
company_cd   String -  
department_set_cd   String -  
department   Object × -  
department_cd String -  
compare String × le gt、ge、eq、lt、leのいずれか
post   Object × -  
post_cd String -  
compare String × le gt、ge、eq、lt、leのいずれか
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
"criteria" : {
    "department_set_list" : [ {
        "company_cd" : 会社コード,
        "department_set_cd" : 組織セットコード,
        "department" : {
            "department_cd" : 組織コード,
            "compare" : "le"
        },
        "post" : {
            "post_cd" : 役職コード,
            "compare" : "le"
        }
    }, ...]
}

  • 組織
    ユーザ検索時に指定の組織で絞り込みます。
    ただし、組織リストが指定されている場合は、組織リスト指定が優先されます。
    認可設定で許可された会社のみ有効です。
プロパティ名 必須 初期値 備考
department_set   Object × -  
company_cd String -  
department_set_cd String -  
department   Object × -  
department_cd String -  
compare String × le gt、ge、eq、lt、leのいずれか
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
"criteria" : {
    "department_set" : {
        "company_cd" : 会社コード,
        "department_set_cd" : 組織セットコード,
        "department" : {
            "department_cd" : 組織コード,
            "compare" : "le"
        }
    }
}

  • 組織役職
    ユーザ検索時に指定の役職で絞り込みます。
    認可設定で許可された会社のみ有効です。
プロパティ名 必須 初期値 備考
department_set   Object × -  
company_cd String -  
department_set_cd String -  
post   Object × -  
post_cd String -  
compare String × le gt、ge、eq、lt、leのいずれか
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
"criteria" : {
    "department_set" : {
        "company_cd" : 会社コード,
        "department_set_cd" : 組織セットコード,
        "post" : {
            "post_cd" : 役職コード,
            "compare" : "le"
        }
    }
}

  • 組織分類項目
    ユーザ検索時に指定の組織分類項目を持つ組織で絞り込みます。
    認可設定で許可された会社のみ有効です。
プロパティ名 必須 初期値 備考
dept_ctg_item   Array × -  
配列インデックス   Object × -  
company_cd String -  
category_cd String -  
category_item_cd   Array -  
配列インデックス String -  
1
2
3
4
5
6
"criteria" : {
    "dept_ctg_item" :
        [ { "company_cd" : 会社コード,
            "category_cd" : 組織分類コード,
            "category_item_cd" : [ 組織分類項目コード, ...]}, ...]
}

  • パブリックグループ
    ユーザ検索時に指定のパブリックグループで絞り込みます。
プロパティ名 必須 初期値 備考
public_group_set   Object × -  
public_group_set_cd String -  
public_group   Object × -  
public_group_cd String -  
compare String × le gt、ge、eq、lt、leのいずれか
1
2
3
4
5
6
7
8
9
"criteria" : {
    "public_group_set" : {
        "public_group_set_cd" : パブリックグループセットコード,
        "public_group" : {
            "public_group_cd" : パブリックグループコード,
            "compare" : "le"
        }
    }
}

  • パブリックグループ役割
    ユーザ検索時に指定の役割で絞り込みます。
プロパティ名 必須 初期値 備考
public_group_set   Object × -  
public_group_set_cd String -  
public_group_role   Object × -  
role_cd String -  
compare String × le gt、ge、eq、lt、leのいずれか
1
2
3
4
5
6
7
8
9
"criteria" : {
    "public_group_set" : {
        "public_group_set_cd" : パブリックグループセットコード,
        "public_group_role" : {
            "role_cd" :役割コード,
            "compare" : "le"
        }
    }
}

  • パブリックグループ分類項目
    ユーザ検索時に指定のパブリック分類項目を持つパブリックグループで絞り込みます。
プロパティ名 必須 初期値 備考
public_group_ctg_item   Array × -  
配列インデックス   Object × -  
category_cd String -  
category_item_cd   Array -  
配列インデックス String -  
1
2
3
4
5
"criteria" : {
    "public_group_ctg_item" :
        [ { "category_cd" : パブリックグループ分類コード,
            "category_item_cd" : [ パブリックグループ分類項目コード, ...]} , ... ]
}

  • ユーザ分類項目
    ユーザ検索時に指定のユーザ分類項目で絞り込みます。
プロパティ名 必須 初期値 備考
user_ctg_item   Array × -  
配列インデックス   Object × -  
category_cd String -  
category_item_cd   Array -  
配列インデックス String -  
1
2
3
4
5
"criteria" : {
    "user_ctg_item" :
        [ { "category_cd" : ユーザ分類コード,
            "category_item_cd" : [ユーザ分類項目コード, ...]} , .. ,]
}

  • ロール
    ユーザ検索時に指定のロールで絞り込みます。
プロパティ名 必須 初期値 備考
role String × -  
1
2
3
"criteria" : {
    "role" : ロールID
}

5.2.1.4. システムパラメータ

  • 起動時のパラメータでは指定できない、システム共通のパラメータについて説明します。

5.2.1.4.1. 大量データモード

大量データモードとは、全件検索やあいまい検索などレスポンス悪化を招く検索を制限するためのものです。
具体的には、大量データモードを使用すると以下の制約が発生します。
  • キーワードの入力が必須になります。つまり、全件検索はできなくなります。
  • ユーザ検索時に表示数制限(ユーザ)を超えたデータの取得ができなくなります。

5.2.1.4.1.1. 設定ファイル

  • 大量データモードの有効/無効は、検索画面タブの plugin.xml で定義します。
  • 上記以外の設定は、<(展開したwar)/WEB-INF/conf/im-master-config.xml> に定義します。
  • このファイルは、パラメータ名とそれに対する値を定義する汎用的な定義ファイルです。
  • これらの設定ファイルを変更した場合は、intra-mart Accel Platformを再起動しないと変更が反映されません。
    また、設定ファイルが存在しない場合、intra-martの正常な動作は保証できないので削除しないでください。

5.2.1.4.1.2. 設定パラメータ

以下に大量データモードに関するパラメータについて説明します。
  • 大量データモード設定
    ユーザ検索(キーワード)タブで大量データモードを使用するかどうかの設定です。
設定ファイル <(展開したwar)/WEB-INF/plugin/ jp.co.intra_mart.im_master.app.search.tabs.user.user.keyword.smartphone_8.0.0 /plugin.xml >
要素 <plugin>/<extension>/<search>/<content>
属性

large_data_mode 。下記のいずれか

  • true : 大量データモードを使用する場合
  • false: 大量データモードを使用しない場合
  • 大量データモード表示数制限(ユーザ)
    ユーザ検索で大量データモードが設定されている場合、ユーザ情報の最大取得件数の設定です。
設定ファイル <(展開したwar)/WEB-INF/conf/im-master-config.xml>
要素 <im-master-config>/<sp-large-data-mode>/<user>/<limit>
任意の数値

5.2.1.5. 検索結果の返却

検索結果は、起動時のパラメータ callback_function で指定されたファクションの引数に渡されます。
ユーザ検索(キーワード)タブから返却されるオブジェクトは以下のような形式になります。
type imm_user
keyFields user_cd
displayName ユーザ名
data
デフォルト取得項目(user_cd, user_name, delete_flag)の値
propで指定された項目の値