5.1.1. 画面起動引数¶
検索画面を起動する際に、起動引数を指定する必要があります。検索画面起動引数には、以下の種類があります。
- 画面構築基盤用
- 共通パラメータ
- 準共通パラメータ
- ユーザ検索固有
- 暗黙条件
以降、各検索画面タブで共通の仕様となる画面起動引数(画面構築基盤用、共通パラメータ、準共通パラメータ)を列挙します。ユーザ検索固有、暗黙条件については、検索画面タブ毎に指定可能なものが異なりますので、各検索タブを参照してください。
5.1.1.1. 画面構築基盤用¶
共通検索画面の外枠をなす画面構築基盤への引数です。主に画面表示時のタイトルラベルや、検索後、選択決定時のウィンドウの挙動などに関する設定をします。
検索対象(使用拡張ポイント)検索機能を選択します。設定する拡張ポイントによって機能が変わります。標準で提供している拡張ポイントは、「指定方法(1) デフォルトで提供する拡張ポイントの利用 」を参照してください。
プロパティ名 型 必須 初期値 備考 target String × -
基本情報描画領域上記の検索対象を設定せず、実行時に使用する基本情報描画領域を設定したい場合にこの項目を使用します。指定可能な基本情報描画領域Plugin IDは「基本情報描画領域Plugin指定 」を参照してください。
プロパティ名 型 必須 初期値 備考 basic_area String × - 基本情報描画領域Plugin ID
使用タブセット上記の検索対象を設定せず、実行時に使用する検索画面タブを設定したい場合にこの項目を使用します。指定可能な検索画面タブは「検索画面タブPlugin指定 」を参照してください。
プロパティ名 型 必須 初期値 備考 tabs Array × - 配列インデックス Object × - id String ○ - 検索画面タブPlugin ID title String ○ -
ウィンドウタイトルポップアップしたウィンドウのタイトルに表示する文字列です。
プロパティ名 型 必須 初期値 備考 wnd_title String × intra-mart
タイトルバーメッセージタイトルバーに表示するメッセージ(キャプション)です。
プロパティ名 型 必須 初期値 備考 message String × -
選択後のウィンドウの動作検索画面で決定ボタン押下後の、ポップアップウィンドウの制御に使用します。
プロパティ名 型 必須 初期値 備考 wnd_close Boolean × false
- true :ウィンドウを閉じる
- false:ウィンドウを閉じない
複数選択時の選択項目クリア検索画面で決定ボタン押下後の、複数選択リストの制御に使用します。
プロパティ名 型 必須 初期値 備考 multiple_select_clear Boolean × false
- true :リストをクリアする
- false:リストをクリアしない
ポップアップ対象ウィンドウ検索画面をポップアップする際のターゲットウィンドウを指定します。
プロパティ名 型 必須 初期値 備考 wnd_target String × -
- コールバックファンクション
検索した結果を返す関数を指定します。結果は指定した関数の引数に渡されます。
プロパティ名 型 必須 初期値 備考 callback_function String ○ - imACMSearch
- タブの初期フォーカス
画面を初期表示したときに表示するタブを選択します。検索画面タブPlugin IDを指定します。デフォルトではもっとも左側のタブにフォーカスされます。
プロパティ名 型 必須 初期値 備考 default_tab_id String × -
- 単一選択・複数選択
検索結果を単一選択とするか、複数選択とするかを設定します。
プロパティ名 型 必須 初期値 備考 type String × multiple
- multiple :複数選択
- single :単一
- ウィンドウの幅
検索画面ウィンドウの幅を設定します。ダイアログ表示時は本設定を無視します。
プロパティ名 型 必須 初期値 備考 width Number × 800
- ウィンドウの高さ
検索画面ウィンドウの高さを設定します。ダイアログ表示時は本設定を無視します。
プロパティ名 型 必須 初期値 備考 height Number × 600
- 初期選択オブジェクト
画面起動時に選択一覧に入れておくオブジェクトの配列を設定します。何も設定しなければ選択一覧には何も表示されません。このオブジェクトの形式は戻り値の形式のJSONオブジェクトでなければ正常に表示されません。戻り値の形式については、「戻り値の形式 」を参照してください。
プロパティ名 型 必須 初期値 備考 default_selected Array × - 配列インデックス Object × - 結果形式のJSONオブジェクト
5.1.1.2. 共通パラメータ¶
多くの機能で共通して利用するパラメータです。検索の基本条件となる引数です。検索基準日、検索対象ロケール、削除されたデータの取得有無に関する設定をします。
- 検索基準日
期間化された情報を取得する際基準にする日付を指定します。
プロパティ名 型 必須 初期値 備考 target_date Date × システム日付
削除データの使用論理削除状態のデータを検索対象にするかどうかを設定します。
プロパティ名 型 必須 初期値 備考 deleted_data Boolean × false true :論理削除データを取得false:論理削除データを取得しない
表示ロケール表示ロケールを設定します。検索結果もこのロケール表示で返します。
プロパティ名 型 必須 初期値 備考 target_locale String × 現在のログインユーザのロケール
5.1.1.3. 準共通パラメータ¶
多くの機能で共通して利用するパラメータです。タブ毎にそれぞれ設定する必要があります。
取得する情報(項目)検索画面タブ毎に、取得するテーブルのカラム名を設定します。検索タブにより、取得できるテーブルが異なります。
プロパティ名 型 必須 初期値 備考 prop Array × 検索タブPlugin ID Object × 配列インデックス String ○ 取得したいカラム名