アクション設定（Webデータベース）

アクション設定は、フォームへの操作イベント（クリックや入力など）をきっかけに実行される業務ロジックです。

図：業務ロジックの動作イメージ

備考

設定方法や、設定できるイベントの種類については「フォーム操作をきっかけに実行される業務ロジックを作成する」を参照してください。

利用シーン

アクション設定の業務ロジックを利用すると、以下のようなことが実現できます。

• フォーム項目に入力された値を元にロジックを実行し、結果を別のフォーム項目に反映する
• Excelファイルを読み込んで、内容をフォームに反映する
• フォームに表示されているテーブルのデータをCSVファイルとしてダウンロードする
• 外部システムから情報を取得して、フォームに反映する

業務ロジックの概要

アクション設定の業務ロジックを新規作成すると、初期状態では以下の図のように設定されています。タスクを追加し、実現したい業務ロジックを作成してください。

図：業務ロジックの初期状態

入力チェックの業務ロジックとの使い分け

アクション設定でも入力チェックの処理が実装できます。入力チェックの業務ロジックとは、処理を実行したいタイミングで使い分けてください。

• 一時保存・登録・更新のボタンをクリックしたタイミングでチェックを実施したい → 入力チェック
• 特定の項目を入力した際など、上記以外のタイミングでチェックを実施したい → アクション設定

入力値

初期設定されている入力値は以下の通りです。

入力値	型	説明
formData	object	フォームの入力情報を保持します。
formaParam	object	アプリケーションや表示中のフォームに関する情報を保持します。

formDataオブジェクト

フォームの入力情報を保持します。業務ロジック内でフォーム項目に入力された値を利用したい場合は、formData配下のパラメータをマッピングしてください。

• キー名は、画面アイテム（フォーム項目）の「フィールド識別ID」と対応しています。
  • 画面アイテム「明細テーブル」・「グリッドテーブル」、および、「スプレッドシート」上で設定されたテーブルについては、「テーブル識別ID」がキー名と対応しています。
• 複数項目選択可能な画面アイテム（「チェックボックス」、「リストボックス」）は選択された値をカンマ区切りにして値が設定されます。

注記

画面アイテム「ファイルアップロード」のアップロードファイル情報は含まれません。 ファイル情報の取得には「ファイルアップロード情報取得」タスクをご利用ください。

formaParamオブジェクト

アプリケーションや表示中のフォームに関する情報を保持します。

入力値	型	説明
imfr_application_id	string	アプリケーションID
imfr_application_no	string	アプリケーションバージョンNO（アプリケーション履歴番号）
imfr_application_type	string	アプリケーション種別 std：Webデータベース bis_wkf：ワークフロー
imfr_display_client_type	string	表示クライアントタイプ pc：PC版 sp：スマートフォン版
imfr_form_id	string	表示中のフォームID（「タブ切替」を利用している場合は、ヘッダフォームのフォームID）
imfr_form_id_tab	string	「タブ切替」を利用している場合：表示中のタブのフォームID 「タブ切替」を利用していない場合：値を受け取らない
imfr_insert_id	string	データ登録ID 登録データ（レコード）を一意に識別するためのIDです。
imfr_next_page_exist	string	次ページ存在フラグ 「タブ切替」を利用している場合：表示中のタブの右にタブがあればtrue 「画面遷移」を利用している場合：表示中のフォームの次に遷移先フォームが設定されていればtrue
imfr_process_key	string	プロセスキー（画面作成毎に一意で作成している値）
imfr_response_type	string	アプリケーションページ種別 REGISTRATION：登録 EDIT：更新 REFERENCE：参照
imfr_transition_id	string	フォーム遷移の遷移ID
imfr_version_no	string	画面表示時の登録データのバージョン 更新時に値がデータベースの登録値と異なる場合、排他制御によるエラーが発生します。

出力値

初期設定されている出力値は以下の通りです。

出力値	型	説明
formData	object	フォームに受け渡す情報です。
fileDownloadData	object	ダウンロードファイルの情報です。
notificationProperty	object	画面に表示する通知メッセージの情報です。

formDataオブジェクト

フォームに受け渡す情報を格納します。フォーム項目に値を反映したい場合は、formData配下のパラメータに反映したい値をマッピングしてください。

• キー名は、画面アイテム（フォーム項目）の「フィールド識別ID」と対応しています。
  • 画面アイテム「明細テーブル」・「グリッドテーブル」、および、「スプレッドシート」上で設定されたテーブルについては、「テーブル識別ID」がキー名と対応しています。
• 複数項目選択可能な画面アイテム（「チェックボックス」、「リストボックス」）は値をカンマ区切りにして設定します。

fileDownloadDataオブジェクト

ダウンロードファイルの情報を格納します。アクション設定で指定したイベントの発生時に、ファイルをダウンロードさせたい場合に利用します。

出力値	型	説明
file	storage	ダウンロードさせるファイルのデータです。
fileName	string	ダウンロードさせるファイルのファイル名です。

notificationPropertyオブジェクト

画面に表示する通知メッセージの情報を格納します。業務ロジックの処理結果を画面上に表示したい場合などに利用します。

出力値	型	説明
imfrErrorFlag	boolean	エラーフラグです。指定する値によって、画面に表示されるエラーメッセージの見た目が変わります。 true：エラーメッセージ（赤色）を表示します。 false：成功メッセージ（緑色）を表示します。
imfrMessage	string[]	画面に表示する処理結果メッセージを配列で指定します。複数指定した場合は改行してメッセージを表示します。 ロケールごとにメッセージを用意する必要がなければこのプロパティを利用してください。
imfrMultiMessages	object[]	ユーザの言語設定別にメッセージを表示したい場合に指定します。imfrMessageが設定されている場合は、imfrMessageが優先されます。
imfrErrorItems	object[]	入力チェックを行う場合に利用します。

imfrMultiMessages

出力値	型	説明
imfrMulti_ja	string	日本語ロケール用のメッセージです。
imfrMulti_en	string	英語ロケール用のメッセージです。
imfrMulti_zh_CN	string	中国語ロケール用のメッセージです。

imfrErrorItems

出力値	型	説明
imfrInputId	string[]	入力チェックエラーとする項目のフィールド識別IDを指定します。1つのエラーメッセージに対して複数の項目が紐づく場合は、関連する項目を全て配列で指定します。入力チェックのエラーメッセージのみを表示したい場合は空配列を指定します。
imfrErrorMessage	string	画面に表示する入力チェックエラーメッセージを指定します。 ロケールごとにメッセージを用意する必要がなければこのプロパティを利用してください。
imfrErrorMultiMessages	object	ユーザの言語設定別に入力チェックエラーメッセージを表示したい場合に指定します。imfrErrorMessageが設定されている場合は、imfrErrorMessageが優先されます。
imfrIndex	integer	入力チェック対象にテーブルが含まれる場合に指定します。入力チェックエラーになった行の番号を指定します。

imfrErrorMultiMessages

出力値	型	説明
imfrErrorMulti_ja	string	日本語ロケール用の入力チェックエラーメッセージです。
imfrErrorMulti_en	string	英語ロケール用の入力チェックエラーメッセージです。
imfrErrorMulti_zh_CN	string	中国語ロケール用の入力チェックエラーメッセージです。

変数

初期設定されている変数はありません。

定数

初期設定されている定数はありません。

実装例

アクション設定の業務ロジックを用いた実装例は、以下のチュートリアルを参照してください。

• フォーム操作をきっかけに実行される業務ロジックを作成する