7.3. テンプレート定義¶
項目
7.3.1. 定義内容¶
IM-共通マスタ 検索（オートコンプリート型）はテンプレートIDを指定し、IDに紐づくテンプレート定義を組み立てて検索しています。テンプレート定義には以下の内容が含まれます。
7.3.1.1. テンプレートID¶
テンプレート定義を一意に区別するためのIDです。
7.3.1.2. 検索タイプ¶
ユーザ検索、ユーザ（所属組織）検索、会社検索、組織検索など検索を区別するタイプです。コラム
7.3.1.2.1. ユーザ検索¶
検索実施者の認可会社に所属するユーザの範囲で、キーワード検索を実施します。filter パラメータには以下が指定できます。
company departmentSetList department departmentPost departmentCategoryItem publicGroup publicGroupRole publicGroupCategoryItem userCategoryItem role
7.3.1.2.2. ユーザ（所属組織）検索¶
検索実施者の認可会社に所属するユーザの範囲で、所属組織を含めてキーワード検索を実施します。filter パラメータには以下が指定できます。
company departmentSetList department departmentPost departmentCategoryItem userCategoryItem role
7.3.1.2.4. 組織検索¶
検索実施者の認可会社に所属する組織の範囲で、キーワード検索を実施します。filter パラメータには以下が指定できます。
company departmentSetList department departmentCategoryItem
7.3.1.3. 検索項目¶
キーワードを検索する項目が定義されます。複数の項目が定義されている場合はOR条件で結合されます。
7.3.1.4. ソート項目¶
結果データをソートする項目が定義されます。複数の項目が定義されている場合は定義順にソートされます。
7.3.1.5. 結果項目¶
結果データとして取得する項目が定義されます。getResult メソッドで取得する項目と項目データです。
7.3.1.6. 表示項目¶
表示データとして取得する項目が定義されます。「検索候補リスト」に表示される項目データです。複数の項目が定義されている場合は定義順に表示されます。階層構造をもつデータの場合、区切り文字で結合した階層データで取得するかを定義します。
7.3.1.7. 暗黙条件¶
結果を絞り込む条件が定義されます。「検索候補リスト」に表示されるデータを絞り込みます。
7.3.2. 標準テンプレート定義¶
各検索タイプには標準テンプレートが用意されています。起動引数の templateId にテンプレートIDを指定することで、下記定義で検索できます。
7.3.2.1. imm_t_user¶
【図：標準テンプレート imm_t_user】
テンプレートID imm_t_user 検索タイプ ユーザ検索 検索項目 ユーザコード ユーザ名 ユーザ検索名 メールアドレス1 メールアドレス2 ソート項目 ソートキー 昇順 ユーザ名 昇順 メールアドレス1 昇順 ユーザコード 昇順 結果項目 ユーザコード ユーザ名 メールアドレス1 メールアドレス2 表示項目 ユーザ名 メールアドレス1
getResult メソッドから返却されるデータ
<link rel="stylesheet" type="text/css" href="./im_master/search_dialog/common_search.css" /> <script type="text/javascript" src="im_master/search_dialog/autocompletes_user.bundle.js"></script> <script type="text/javascript"> let autocompletesUserSearch = new ImMaster.AutocompletesUserSearch(params); ... function register() { let result = autocompletesUserSearch.getResult(); for (let idx = 0; idx < result.length; idx++) { console.log(result[idx].userCd); console.log(result[idx].userName); console.log(result[idx].emailAddress1); console.log(result[idx].emailAddress2); } } </script>
プロパティ名 型 備考 (result) Array 配列インデックス Object userCd String ユーザコード userName String ユーザ名 emailAddress1 String メールアドレス１ emailAddress2 String メールアドレス２
7.3.2.2. imm_t_user_dept¶
【図：標準テンプレート imm_t_user_dept】
テンプレートID imm_t_user_dept 検索タイプ ユーザ（所属組織）検索 検索項目 組織コード 組織名称 組織略称 組織検索名 ソート項目 ソートキー 昇順 会社コード 昇順 組織セットコード 昇順 階層 降順 組織コード 昇順 ソートキー （ユーザ） 昇順 ユーザ名 昇順 メールアドレス1 昇順 ユーザコード 昇順 結果項目 ユーザコード ユーザ名 メールアドレス1 メールアドレス2 会社コード 組織セットコード 組織コード 組織名称 表示項目 ユーザ名 組織名称 階層表示（階層をすべて表示） メールアドレス1
getResult メソッドから返却されるデータ
<link rel="stylesheet" type="text/css" href="./im_master/search_dialog/common_search.css" /> <script type="text/javascript" src="im_master/search_dialog/autocompletes_user.bundle.js"></script> <script type="text/javascript"> let autocompletesUserSearch = new ImMaster.AutocompletesUserSearch(params); ... function register() { let result = autocompletesUserSearch.getResult(); for (let idx = 0; idx < result.length; idx++) { console.log(result[idx].userCd); console.log(result[idx].userName); console.log(result[idx].emailAddress1); console.log(result[idx].emailAddress2); console.log(result[idx].companyCd); console.log(result[idx].departmentSetCd); console.log(result[idx].departmentCd); console.log(result[idx].departmentName); } } </script>
プロパティ名 型 備考 (result) Array 配列インデックス Object userCd String ユーザコード userName String ユーザ名 emailAddress1 String メールアドレス１ emailAddress2 String メールアドレス２ companyCd String 会社コード departmentSetCd String 組織セットコード departmentCd String 組織コード departmentName String 組織名称
7.3.2.3. imm_t_company¶
【図：標準テンプレート imm_t_company】
テンプレートID imm_t_company 検索タイプ 会社検索 検索項目 会社コード 組織名称 ソート項目 ソートキー 昇順 組織名称 昇順 結果項目 会社コード 組織名称 表示項目 組織名称 会社コード
getResult メソッドから返却されるデータ
<link rel="stylesheet" type="text/css" href="./im_master/search_dialog/common_search.css" /> <script type="text/javascript" src="im_master/search_dialog/autocompletes_company.bundle.js"></script> <script type="text/javascript"> let autocompletesCompanySearch = new ImMaster.AutocompletesCompanySearch(params); ... function register() { let result = autocompletesCompanySearch.getResult(); for (let idx = 0; idx < result.length; idx++) { console.log(result[idx].companyCd); console.log(result[idx].departmentName); } } </script>
プロパティ名 型 備考 (result) Array 配列インデックス Object companyCd String 会社コード departmentName String 組織名称
7.3.2.4. imm_t_dept¶
【図：標準テンプレート imm_t_dept】
テンプレートID imm_t_dept 検索タイプ 組織検索 検索項目 組織コード 組織名称 組織略称 組織検索名 ソート項目 ソートキー 昇順 会社コード 昇順 組織セットコード 昇順 階層 降順 組織コード 昇順 結果項目 会社コード 組織セットコード 組織コード 組織名称 表示項目 組織名称 組織名称 階層表示（階層をすべて表示）
getResult メソッドから返却されるデータ
<link rel="stylesheet" type="text/css" href="./im_master/search_dialog/common_search.css" /> <script type="text/javascript" src="im_master/search_dialog/autocompletes_department.bundle.js"></script> <script type="text/javascript"> let autocompletesDepartmentSearch = new ImMaster.AutocompletesDepartmentSearch(params); ... function register() { let result = autocompletesDepartmentSearch.getResult(); for (let idx = 0; idx < result.length; idx++) { console.log(result[idx].companyCd); console.log(result[idx].departmentSetCd); console.log(result[idx].departmentCd); console.log(result[idx].departmentName); } } </script>
プロパティ名 型 備考 (result) Array 配列インデックス Object companyCd String 会社コード departmentSetCd String 組織セットコード departmentCd String 組織コード departmentName String 組織名称