CookBook

スクリプト開発した画面にバリデーション(入力チェック)を実装する

投稿日:2015-12-14 更新日:

このCookBookでは、作成した画面項目に対してバリデーション(入力チェック)を設定する方法をご紹介します。
今回はスクリプト開発で登録フォームを作成するで作成した画面項目に対して、クライアントサイドでの適切なバリデーションを実装しましょう。

109003_validation_sample

完成イメージ

<操作方法>


1. 「商品名」には何も入力しないでください。
2. 「金額」に整数以外の値を入力してください。
3. 「備考」に201文字以上入力してください。
4. 「登録」ボタンをクリックすることでバリデーションが動作します。

なお、以下は入力項目ごとに割り当てたバリデーションルールです。

入力項目 バリデーション内容
商品名 必須
金額 必須・整数のみ
備考 200文字まで

完成サンプル

以下のサンプルをダウンロードしてご活用ください。
e builder プロジェクト : im_cookbook_109004.zip
imm ファイル : im_cookbook_109004-1.0.0.imm

ローカル環境で表示させる場合は以下のURLにアクセスしてください。
http://localhost:8080/imart/im_cookbook/109004/edit
なお、ベースURLである以下の部分は環境に合わせて適宜変更してください。
http://localhost:8080/imart

レシピ

  1. プレゼンテーションページでバリデーション用のライブラリをロードします
  2. バリデーションルールを定義します
  3. プレゼンテーションページでバリデーションルールをロードします
  4. バリデーションしたいフォームに対してimuiValidateを実装します

では、それぞれのステップを細かく見ていきましょう。

1. プレゼンテーションページでバリデーション用のライブラリをロードします

このCookBookでは、製品が提供しているAPIであるimuiValidateを利用してバリデーションを実装しましょう。 imuiValidateは内部でjQuery Validation Pluginを利用しています。プレゼンテーションページ(edit.html)のヘッダ部分に以下を記述してください。

2. バリデーションルールを定義します

バリデーションルールを定義しましょう。今回は src/im_cookbook/sample1/validators/validator.js という新しいjsファイルを作成し記述してください。

上記のパラメータ名は、プレゼンテーションページ内のinputタグのname属性の値と対応しています。
このように、プレゼンテーションページとは別のjsファイルにバリデーションルールを定義しておくことで、登録画面や編集画面で同じルール定義を使いまわすことができます。

この他にも多数のバリデーションルールを用意しています。 詳しくは以下のドキュメントを参照してください。

上記で作成したバリデーションルールオブジェクトは、次のステップでプレゼンテーションページからロードされます。

3. プレゼンテーションページでバリデーションルールをロードします

2. で作成したバリデーションルールをプレゼンテーションページにロードしましょう。
プレゼンテーションページのヘッダ部に以下を記述しましょう。

上記のimartタグは、im_cookbook/sample1/validators/validator.jsinitオブジェクトをルールとしてロードし、rulesというルール定義オブジェクトとmessagesというメッセージ情報オブジェクトがクライアントサイドに出力されます。

rulesオブジェクトとmessagesオブジェクトを利用して、次のステップでバリデーションを実装。

詳しくは以下のドキュメントを参照してください。

4. バリデーションしたいフォームに対してimuiValidateを実装します

今回は、登録ボタンがクリックされたときにバリデーションが行われるように実装しましょう。

バリデーションを実行しているimuiValidateについて見てみます。

上記の例では、formというIDを持つフォームに対して、rulesというバリデーションルールに基づきバリデーションしています。バリデーションに失敗した場合はfalseを返し、messagesで指定したエラーメッセージを表示しています。

現時点では、以下のように不適切な場所にエラーメッセージが表示されます。

109003_errorPlacement1

しかし、imuiValidateのAPIドキュメント内サンプルを応用し以下のように実装すると、適切な場所にエラーメッセージが表示されます。

109003_errorPlacement2

-CookBook
-,

執筆者:


  1. […] スクリプト開発した画面にバリデーション(入力チェック)を実装する 691 views […]

  2. […] スクリプト開発した画面にバリデーション(入力チェック)を実装する […]

  3. […] スクリプト開発した画面にバリデーション(入力チェック)を実装する […]

comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

スクリプト開発で利用できる close 関数のご紹介

この CookBook では、スクリプト開発で利用できる close 関数について紹介します。 スクリプト開発では作成した js ファイルの中に init と言う名前の関数を定義すると思いますが、この …

no image

ワークフローの一覧を使い分けるには(スマートフォン版)

このCookbookでは、以前に公開した「ワークフローの一覧を使い分けるには(改訂版)」に関して、お問い合わせいただいた内容を追加してスマートフォン画面でワークフローの一覧の検索条件を付与する方法をご …

no image

画面UI部品(imuiValidate)のバリデーションメッセージを任意の場所に表示する方法

このCookBookでは、画面UI部品のバリデーションメッセージを任意の場所に表示する方法について紹介しています。 intra-mart Accel Platform では、画面上に配置したUI部品の …

no image

完了したワークフロー案件の登録データをメンテナンスする方法

このCookBookでは、IM-BISとIM-FormaDesignerで作成したワークフロー案件の登録データを編集する方法を紹介します。 一部制限はありますが、IM-FormaDesignerのアプ …

no image

申請者の役職から処理対象者を設定する

このCookbookでは、IM-Workflow 2018 Springから新たに追加された 処理対象者プラグイン「ロジックフロー(ユーザ)」 の設定方法を紹介いたします。 この機能を利用すると、申請 …

まだデータがありません。

RSSRSSRSSRSS