9.13. 暗黙的に連携するレスポンスパラメータの仕様¶

	パラメータ名	データ型	説明
(1)	imfrErrorFlag	boolean	エラーフラグです。 レスポンス返却時は、処理結果がエラーの場合に「true」を設定します。エラーの場合はアイテムへの値の反映は行われません。
(2)	imfrMessage	array	メッセージ配列です。 処理結果メッセージを表示する場合に定義します。 レスポンス返却時に複数メッセージを設定した場合は以下で表示されます。 前処理、後処理：カンマ(,)区切りでメッセージ表示 アクション設定：改行してメッセージ表示
(3)	imfrMultiMessages	array	多言語用メッセージ情報配列です。 多言語に対応したメッセージを表示する場合に定義します。 返却されたレスポンスのimfrMessageにメッセージの設定がある場合は、imfrMessageが優先されます。
(4)	imfrMulti_%locale_id%	string	メッセージです。利用するシステムロケール数分定義します。 ex)日本語、英語、中国語に対応する場合「imfrMulti_ja」「imfrMulti_en」「imfrMulti_zh_CN」をそれぞれ定義。
(5)	imfrErrorItems	array	入力チェックエラーアイテム情報です。 連携先で入力チェックを行う場合は必ずこのパラメータを定義してください。
(6)	imfrInputId	array	エラーになったアイテムのフィールド識別ID配列です。 外部連携を設定したフォームにあるアイテムのフィールド識別IDを設定します。 一つのエラーメッセージに対し、複数のフィールドが紐づく場合は、レスポンス返却時に関連する画面アイテムのフィールド識別IDを全て設定します。 入力チェックエラーメッセージのみ表示させたい場合は空配列を設定します。
(7)	imfrErrorMessage	string	入力チェックエラーメッセージです。
(8)	imfrErrorMultiMessages	object	多言語用入力チェックエラーメッセージ情報です。多言語に対応したメッセージを返却する場合に定義します。 返却されたレスポンスのimfrErrorMessageにメッセージの設定がある場合は、imfrErrorMessageが優先されます。
(9)	imfrErrorMulti_%locale_id%	string	多言語用入力チェックエラーメッセージです。利用するシステムロケール数分定義します。 ex)日本語、英語、中国語に対応する場合は「imfrErrorMulti_ja」「imfrErrorMulti_en」「imfrErrorMulti_zh_CN」をそれぞれ定義。
(10)	imfrIndex	number	エラー行番号です。入力チェック対象にテーブルが含まれる場合に定義します。 レスポンス返却時はエラーになった行の番号を設定します。
(11)	imfrDownloadFile	object	ダウンロードファイルオブジェクトです。外部連携のレスポンスとして、ファイルデータを受け取る場合に定義します。
(12)	imfrFile	storage または binay	ファイルデータです。ファイルを示すストレージまたはバイナリデータを設定します。
(13)	imfrFileName	string	ファイル名です。未指定の時は、ファイルデータがstorageの場合は実ファイル名、binaryの場合は 「imfrFile_yyyyMMdd-HHmm」がファイル名に設定されます。

データソース定義に必要なパラメータは、外部連携を実行するタイミングにより異なります。

1. アクション設定

   • imfrErrorFlag

     処理結果メッセージを利用する場合は必須です。

   • imfrMessage, imfrMultiMessages, imfrErrorItems, imfrDownloadFile

     いずれか1つ以上のパラメータを定義する必要があります。imfrMessage、imfrMultiMessages両方にメッセージの設定がある場合は、imfrMessageのメッセージが優先されます。

     imfrErrorItemsは外部連携で入力チェックを行う場合に必ず必要なパラメータです。

     外部連携実行時に入力チェックエラーになった（返却されたレスポンスのimfrErrorItemsにエラーアイテム情報の設定がある）場合、imfrMessage、imfrMultiMessagesのメッセージは表示されません。

     注意

     入力チェックを行わない場合はimfrErrorItemsを定義してはいけません。

     定義すると外部連携実行時に予期しないタイミングで表示中のアイテムエラー通知がクリアされる場合があります。

2. 前処理/後処理

   • imfrErrorFlag

     処理結果メッセージを利用する場合は必須です。

   • imfrMessage, imfrMultiMessages

     どちらか1つのパラメータを定義する必要があります。imfrMessage、imfrMultiMessages両方にメッセージの設定がある場合は、imfrMessageのメッセージが優先されます。

     前処理/後処理ではimfrErrorItemsを利用できないため、パラメータを定義しても処理結果メッセージには反映されません。