formaParamオブジェクト¶

フォルマの基本情報を保持します。

sendParamオブジェクト¶

画面から渡されたリクエスト情報を保持する送信パラメータオブジェクトです。

明細テーブルアイテムを除く入力アイテムのパラメータ名はフィールド識別ID になります。

明細テーブルアイテムのパラメータ名はテーブル識別ID です。

アプリケーション種別がIM-Workflow の場合は、各種一覧画面から呼び出された際に受け取ることができるIM-Workflow リクエストパラメータ情報を含みます。

取得可能なIM-Workflow リクエストパラメータの詳細は「IM-Workflow プログラミングガイド」を参照してください。

アプリケーションの登録データの取得は、登録データ情報管理 API を利用しても取得が可能です。

取得方法については、後述のデータの取得メソッドをご参照ください。

但し、送信パラメータまたは API の取得データには、ファイルアップロードアイテムのアップロードファイル情報は含まれません。

また採番アイテムで採番方法を登録処理毎に設定した場合、採番処理は入力チェック後に行われるため送信パラメータに採番番号は含まれません。

• 入力アイテムのデータ型と取得値の対比

  入力アイテムのデータ型により取得値は以下のように設定されています。

  

  ※1： 関数、一覧選択アイテムは取得値の設定によりアイテムのデータ型が決定します。

  ※2： 複数項目選択可能なアイテム（チェックボックス、リストボックス）は選択された値をカンマ区切りにして値が設定されます。

• 明細テーブルアイテムの取得値

  値は１レコード（行）毎に各列のフィールド識別ID と値をマッピングしたオブジェクトの配列です。

  各列のデータ型は列タイプに依存します。

パラメータ¶

formaParam、sendParam についての詳細は共通パラメータをご参照ください。

返却値¶

エラーフラグ error にはエラーの有無を設定し、data にはカスタムプロパティオブジェクトを設定して返却します。

カスタムプロパティの指定がない場合は data に空のオブジェクトを設定してください。

• 返却オブジェクト

  

※ ファイルアップロードアイテムはフィールド識別ID を持たないため、ImFormaUtil オブジェクトの getFileUploadId メソッドにより取得される ID をセットします。

ImFormaUtilオブジェクトについての詳細は後述の共通処理 ImFormaUtilオブジェクトをご参照ください。

入力チェックプロパティ一覧¶

FRItems オブジェクトでは入力チェックプロパティを定義しています。

実装例¶

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

function getCustomProperties(formaParam, sendParam) { Debug.print("************** 入力チェックサンプルプログラム：カスタムプロパティを設定 ****************"); // フィールド(telnumber, age, startdate, userSelect)に対して入力チェックプロパティを設定する。 var customPropObj = {telnumber: {}, age : {}, startdate: {}, userSelect : {}}; if (xxxxxxxx) { // 設定する条件句 // "telnumber" 英数字のみをfalse customPropObj["telnumber"][FRItems.PROP_ONLY_ASCII] = false; } if (xxxxxxxx) { //"age" 最大入力値を40 に設定 customPropObj["age"][FRItems.PROP_MAX_LENGTH] = 40; } if (xxxxxxxx) { //"startdate" 必須をfalse customPropObj["startdate"][FRItems.PROP_REQUIRED] = false; } if (xxxxxxxx) { //" userSelect " 必須をfalse customPropObj["userSelect"][FRItems.PROP_REQUIRED] = false; } // ファイルアップロードアイテムの入力チェックプロパティを設定する if (xxxxxxxx) { var file_id = ImFormaUtil.getFileUploadId(0); customPropObj[file_id] = {}; //ファイルアップロード 最少入力ファイル数を０ customPropObj[file_id][FRItems.PROP_MIN_FILE_AMOUNT] = 0; } return { error : false , data : customPropObj}; // カスタムプロパティの指定がない場合 // return { error : false , data : {} }; //処理中にエラーが発生した場合 // return { error : true ,errorMessage : xxxxx }; }

パラメータ¶

• formaParam、sendParam についての詳細は共通パラメータを参照してください。

• resultObj・・・返却オブジェクト

  入力チェックエラー情報を設定して返却するためのオブジェクトです。

  

返却値¶

• 入力チェックエラーがなかった場合

  引数で渡された返却オブジェクト resultObj をそのまま返却します。

• 入力チェックエラーがあった場合

  ImFormaUtilオブジェクトを利用して返却オブジェクトresultObj にエラー情報を設定します。

  ユーザ画面へのエラー情報の通知方法は以下の二つの方法があります。

  • エラーメッセージのみを画面上部に表示する。

  • エラーがあったアイテムに対しエラー通知表示をする。

    （アイテムを赤枠で囲みエラー通知アイコンを表示など、エラー通知表示内容はアイテムに依存します）

  エラー通知の方法に合わせて ImFormaUtilオブジェクトの該当メソッドを使ってエラー情報を設定してください。

  ImFormaUtilオブジェクトについての詳細は後述の「3.3 共通処理 ImFormaUtilオブジェクト」をご参照ください。

実装例¶

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

function validate(formaParam, sendParam, resultObj) { Debug.print("************** 入力チェックサンプルプログラム：ユーザバリデーション実行 ****************"); // 入力チェック① フィールド識別ID「sample_field_1」に対するチェック if (checkOne(sendParam["sample_field_1"])) { errorMessage = 'フィールド１の値が不正です。'; // 返却オブジェクトにエラー情報を設定 ImFormaUtil.addValidationError(resultObj, errorMessage, 'check1', ["sample_field_1"]); } // 入力チェック② フィールド識別ID「sample_field_2」、「sample_field_3」の相関チェック if (checkTwo(sendParam["sample_field_2"]), sendParam["sample_field_3"])) { errorMessage = 'フィールド２の値が○○○の場合はフィールド３はXXX でなくてはいけません。'; ImFormaUtil.addValidationError(resultObj, errorMessage, 'check2', ["sample_field_2", "sample_field_3"] ); } // 明細テーブル（テーブル識別ID comp1_table_1）内のフィールドに対するチェック var tableId = "comp1_table_1"; // 明細テーブルデータの取得 var tableData = sendParam[tableId]; // 入力行数分チェック for (var i = 0, length = tableData.length; i < length; i++) { // 列数分チェック for (var input_id in tableData[i]) { var checkValue = tableData[i][input_id]; if (checkValue == "") continue; //入力チェック③ 列１のフィールドに対するチェック if (input_id == "table_field_1") { if (checkRow1 (checkValue)) { errorMessage = 'XXXXXXX '; ImFormaUtil.addValidationError( resultObj, errorMessage, 'check3', [input_id], i ); } //入力チェック④ 列2 のフィールドに対するチェック } else if ((input_id == "table_field_2") { if (checkRow2 (checkValue)) { errorMessage = 'XXXXXXX '; ImFormaUtil.addValidationError( resultObj, errorMessage, 'check4', [input_id], i ); } } else if ( ・・・・・・・・・・・・・・・・・・・・・・){ ・・・・・・・・・・・・・・・・・・ } } // 返却オブジェクトを返却 return resultObj; } function checkOne (inputValue){ . // 「sample_field_1」に対する入力チェック処理を実装する。 } function checkTwo (inputValue1, inputValue2) { . // 「sample_field_2」「sample_field_3」に対する入力チェック処理を実装する。 } } function checkRow1 (inputValue) { //明細テーブル内フィールド「table_field_1」に対する入力チェック処理を実装する。 } function checkRow2 (inputValue) { //明細テーブル内フィールド「table_field_2」に対する入力チェック処理を実装する。 }

上記の実装例では、４つの入力チェックを行っています。

【主な処理内容】

1. 送信パラメータ sendParam から入力値を受け取って順に妥当性を検証
2. 各入力チェックでは、validate メソッド内で一意になる固定の入力チェックID （上記の例では check1～check4 ）を付与
3. 入力チェックエラー時は返却オブジェクトに付与した入力チェックID を含むエラー情報を設定

システムエラー時の動作仕様¶

処理中に入力チェック以外のエラーが発生した場合は、返却オブジェクトのシステムエラーフラグ systemError を true に設定してください。

システムエラーフラグがtrue の場合または処理中に予期しないエラーが発生した場合は、画面にはシステムエラーが発生した旨のメッセージのみが表示され入力チェックに関するエラーの通知は行われません。

その際 forma ログにはエラーに関する情報が出力されます。

パラメータ¶

formaParam についての詳細は共通パラメータを参照してください。

返却値¶

入力チェックエラーがあった場合にエラーメッセージを表示する順番で下記の ID をセットします。

• 標準で提供する入力チェックによるメッセージ

  アイテムID をセットします。 アイテムID はImFormaUtil オブジェクトのgetItemIdByInputId メソッドにフィールド識別ID を渡すことで取得可能です。

  複数の入力フィールドを持つアイテムの場合は、任意の一つのフィールド識別ID を設定してください。

  ファイルアップロードアイテムはフィールド識別ID を持ちませんので、フィールド識別ID の代わりに ImFormaUtil オブジェクトの getFileUploadId 関数により取得されるID をセットします。

• ユーザプログラムの validate メソッドで行われる入力チェックによるメッセージ

  入力チェックプログラムの validate メソッド内で付与した入力チェックID をセットします。

  表示順の指定がない場合は空の配列を返却してください。

実装例¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

function getErrorDisplayOrder(formaParam) {
Debug.print("************** 入力チェックサンプルプログラム：エラーメッセージ表示順を指定 ****************");
    var arry = [];
    
    //標準で提供する入力チェックによるメッセージ
    //フィールド識別ID「sample_field_1」
    arry.push(ImFormaUtil.getItemIdByInputId("sample_field_1"));
    arry.push(ImFormaUtil.getItemIdByInputId("sample_field_3"));
    
    //標準で提供する入力チェックによるメッセージ(ファイルアップロードアイテムの場合)
    arry.push(ImFormaUtil.getItemIdById(ImFormaUtil.getFileUploadId(0)));
    
    // validate メソッドで行われる入力チェックによるメッセージ
    //入力チェックID「check1」
    arry.push("check1");

    arry.push(xxxxxxxxxxxxxxxxxx);
    arry.push(xxxxxxxxxxxxxxxxxx);
    arry.push(xxxxxxxxxxxxxxxxxx);
    ・・・・・・・・・・・・・・・・・・・・・
    
    return arry;
}