CookBook

後処理プログラムで画面アイテム「ファイルアップロード」にバリデーションを実行する方法

投稿日:2017-06-28 更新日:

このCookbookでは、画面アイテム「ファイルアップロード」に添付されたファイルをバリデーションする方法を紹介します。
後処理プログラムを使用してバリデーションを実行することで、画面に表示するエラーメッセージを任意に設定することができます。

サンプルでは、アプリケーション種別「標準」の登録処理にバリデーションを設定います。
アプリケーション種別「IM-Workflow」や更新処理に対しても、同様の方法で実装することが可能です。

完成イメージ


1. 「The attached file」にファイルを添付してください。
2. 「Register」をクリックしてください。
3. 添付ファイルが以下の条件のいずれかに当てはまる場合は、画面上部にエラーメッセージが表示されます。
・ファイル名にアンダーバーが含まれる
・ファイルサイズが1MB以上

完成サンプル

以下の完成サンプルをダウンロードしてご活用ください。
なお、以下のサンプルはintra-mart Accel Platform 2016 Winterの環境を利用して作成したものです。
2016 Winterより前のバージョンでは正常に動作しない可能性があります。

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

レシピ

  1. フォームを作成する
  2. 後処理プログラムを作成する
    ・スクリプト開発モデル編
    ・JavaEE開発モデル編
  3. フォームに後処理プログラムを設定する
  4. 作成したフォームにて、登録処理を実行する

1. フォームを作成する

FormaDesignerでフォームを作成し、画面アイテム「ファイルアップロード」を配置してください。

2. 後処理プログラムを作成する

「スクリプト開発モデル」または「JavaEE開発モデル」で後処理プログラムを作成しましょう。

後処理プログラムの詳細は以下のドキュメントを参照してください。
IM-FormaDesigner for Accel Platform プログラミングガイド - 後処理

スクリプト開発モデル編

サンプルでは以下の場所にファイルを作成しています。
src/main/jssp/src/im_cookbook_119455_validate_fileupload/post_process.js

  • FormaFileUploadItemManagerを使用し、添付ファイルの情報を取得してください。
  • FormaFileUploadItemManager#getFilesInfo(insertId, processKey)
    案件に紐付くファイル情報を取得するメソッドです。
    引数にプロセスキーを指定することで、セッションに保存された一時保存状態のファイル情報を取得対象に含めることができます。
  • FormaFileUploadItemManager#getFile(insertId, fileId, processKey)
    ファイルの実体を取得する場合はgetFileメソッドを使用してください。

  • バリデーションエラーの場合は返却オブジェクトに以下のプロパティを設定してください。

  • userErrorMessage
    画面に表示するエラーメッセージを設定してください。
  • outputLog
    ログ出力可否を設定することができます。
    ログ出力が不要な場合はfalseを設定してください。

FormaFileUploadItemManagerの詳細は以下のドキュメントを参照してください。
IM-FormaDesigner スクリプト開発API - FormaFileUploadItemManagerオブジェクト

エラー処理の詳細は以下のドキュメントを参照してください。
IM-FormaDesigner for Accel Platform プログラミングガイド - 返却値とエラー処理

JavaEE開発モデル編

サンプルでは以下の場所にファイルを作成しています。
src/main/java/jp/co/intra_mart/cookbook/im_cookbook_119455_validate_fileupload/PostProcess.java

  • FormaFileUploadItemManagerを使用し、添付ファイルの情報を取得してください。
  • FormaFileUploadItemManager#getFilesInfo(insertId, processKey)
    案件に紐付くファイル情報を取得するメソッドです。
    引数にプロセスキーを指定することで、セッションに保存された一時保存状態のファイル情報を取得対象に含めることができます。
  • FormaFileUploadItemManager#getFile(insertId, fileId, processKey)
    ファイルの実体を取得する場合はgetFileメソッドを使用してください。

  • バリデーションエラーの場合はFormaUserProcessExceptionをthrowしてください。

  • FormaUserProcessException#setUserMessage(userMassage)
    画面に表示するエラーメッセージを設定してください。
  • FormaUserProcessException#setOutputLog(isOutputLog)
    ログ出力可否を設定することができます。
    ログ出力が不要な場合はfalseを設定してください。

FormaFileUploadItemManagerの詳細は以下のドキュメントを参照してください。
IM-FormaDesigner JavaEE開発API - クラス FormaFileUploadItemManager

エラー処理の詳細は以下のドキュメントを参照してください。
IM-FormaDesigner for Accel Platform プログラミングガイド - 返却値とエラー処理

3. フォームに後処理プログラムを設定する

レシピ1のフォームに、レシピ2の後処理プログラムを設定しましょう。

「後処理プログラム - 登録」に以下の値を設定してください。

プログラム種別 プログラムパス
スクリプト開発モデル im_cookbook_119455_validate_fileupload/post_process
JavaEE開発モデル jp.co.intra_mart.cookbook.im_cookbook_119455_validate_fileupload.PostProcess

ユーザプログラムの設定方法は以下のドキュメントを参照してください。
IM-FormaDesigner for Accel Platform 作成者 操作ガイド - アプリケーションでユーザプログラムを利用する

4. 作成したフォームにて、登録処理を実行する

権限設定やメニュー設定を行い、Formaアプリケーションを完成させてください。
登録画面でファイルを添付して登録ボタンをクリックすると、バリデーションが実行されます。

-CookBook

執筆者:


comment

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

関連記事

no image

IM-Workflowの一覧を業務別に使い分けるには

この記事では、”もっと効率的に” IM-Workflowを利用した業務ができるように、一覧画面に表示するフローや案件を絞り込んで表示するための手順をご紹介します。 「フローグループ」機能を利用し、一覧 …

no image

ワークフローの一覧を使い分けるには(改訂版)

このCookbookでは、以前に公開した「IM-Workflowの一覧を業務別に使い分けるには」に関して、お問い合わせいただいた内容を追加してワークフローの一覧の検索条件を付与する方法をご紹介いたしま …

no image

ViewCreatorのヘッダやフッタに配置するリンクのURLに計算結果を埋め込む方法

本記事では、ViewCreatorのヘッダやフッタにリンクを埋め込む際に、関数を利用する方法をご紹介します。 この方法を利用すると、パラメータ文字列に「今日日付」を受け渡すといったことが実現できます。 …

no image

ウォッチ機能のご紹介

このCookBookでは「intra-mart Accel Collaboration」に備わっているウォッチ機能のご紹介です。 各会社様でグループで仕事をする機会が多いと思います。 仕事を行う上で、 …

no image

外部連携を利用して簡単な相関チェックを行う方法

このCookbookでは、外部連携を利用して簡単な相関チェックを行う方法を紹介します。 この方法を活用することにより、簡単な入力チェックであれば、Formaユーザプログラムの入力チェックを作成せずに外 …

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

RSSRSSRSSRSS