アダプティブフォームは、事前設定された検証条件に基づいて、フィールドに入力した入力を検証します。 検証条件は、アダプティブフォーム内のフィールドに許容される入力値を参照します。 アダプティブフォームで使用するデータソースに基づいて、検証条件を設定できます。 例えば、RESTful Webサービスをデータソースとして使用する場合、Swagger定義ファイルで検証条件を定義できます。
入力値が検証条件を満たす場合、値がデータソースに送信されます。 そうでない場合は、アダプティブフォームにエラーメッセージが表示されます。
この方法と同様に、アダプティブフォームはカスタムサービスと統合して、データの検証を実行できるようになりました。 入力値が検証条件を満たさず、サーバーから返される検証エラーメッセージが標準メッセージ形式の場合、エラーメッセージはフォームのフィールドレベルで表示されます。
入力値が検証条件を満たさず、サーバー検証エラーメッセージが標準メッセージ形式でない場合、アダプティブフォームには、検証エラーメッセージを標準形式に変換し、フォームのフィールドレベルで表示するメカニズムが用意されています。 次の2つの方法のいずれかを使用して、エラーメッセージを標準の形式に変換できます。
この記事では、検証エラーメッセージの標準形式と、エラーメッセージをカスタム形式から標準形式に変換する手順について説明します。
サーバー検証エラーメッセージが次の標準形式の場合、アダプティブフォームはフィールドレベルでエラーを表示します。
{
errorCausedBy : "SERVER_SIDE_VALIDATION/SERVICE_INVOCATION_FAILURE"
errors : [
{
somExpression : <somexpr>
errorMessage / errorMessages : <validationMsg> / [<validationMsg>, <validationMsg>]
}
]
originCode : <target error Code>
originMessage : <unstructured error message returned by service>
}
ここで、
errorCausedBy
失敗の理由を説明するerrors
検証条件に失敗したフィールドのSOM式と検証エラーメッセージについて言及するoriginCode
外部サービスから返されたエラーコードが含まれます。originMessage
外部サービスから返された生のエラーデータが含まれます。サーバー検証エラーメッセージが標準形式で表示されない場合は、非同期送信を有効にし、アダプティブフォーム送信にカスタムエラーハンドラーを追加して、メッセージを標準形式に変換できます。
カスタムハンドラーを追加する前に、アダプティブフォームで非同期送信を設定する必要があります。 以下の手順を実行します。
アダプティブフォーム作成モードで、フォームコンテナオブジェクトを選択し、をタップして、そのプロパティを開きます。
送信プロパティセクションで、非同期送信を使用を有効にします。
「サーバーで再検証」を選択して、送信前にサーバー上の入力フィールドの値を検証します。
送信アクションを選択します。
「」をタップして、プロパティを保存します。
AEM Forms には、フォーム送信が成功した場合と失敗した場合の処理を実行するハンドラーが用意されています。これらのハンドラーは、すぐに使用することができます。これらのハンドラーは、サーバーからの応答に従って実行されるクライアント側の関数です。フォームを送信すると、データが検証用としてサーバーに転送され、フォーム送信の成功イベントとエラーイベントに関する情報とともに、サーバーからクライアントに応答が返されます。この情報は、パラメーターとして関連するハンドラーに渡され、対応する関数が実行されます。
次の手順を実行して、アダプティブフォームの送信時にカスタムエラーハンドラーを追加します。
次に、カスタムのエラー構造を標準のエラー構造に変換するためのサンプルコードを示します。
var data = $event.data;
var som_map = {
"id": "guide[0].guide1[0].guideRootPanel[0].Pet[0].id_1[0]",
"name": "guide[0].guide1[0].guideRootPanel[0].Pet[0].name_2[0]",
"status": "guide[0].guide1[0].guideRootPanel[0].Pet[0].status[0]"
};
var errorJson = {};
errorJson.errors = [];
if (data) {
if (data.originMessage) {
var errorData;
try {
errorData = JSON.parse(data.originMessage);
} catch (err) {
// not in json format
}
if (errorData) {
Object.keys(errorData).forEach(function(key) {
var som_key = som_map[key];
if (som_key) {
var error = {};
error.somExpression = som_key;
error.errorMessage = errorData[key];
errorJson.errors.push(error);
}
});
}
window.guideBridge.handleServerValidationError(errorJson);
} else {
window.guideBridge.handleServerValidationError(data);
}
}
var som_map
は、標準形式に変換するアダプティブフォームフィールドのSOM式をリストします。 アダプティブフォーム内の任意のフィールドのSOM式を表示するには、フィールドをタップし、表示のSOM式を選択します。
このカスタムエラーハンドラーを使用すると、アダプティブフォームはvar som_map
に示すフィールドを標準エラーメッセージ形式に変換します。 その結果、検証エラーメッセージはアダプティブフォームのフィールドレベルで表示されます。
次の手順を実行して、ルールエディターのサービスの呼び出しアクションを使用して、カスタムエラー構造を標準エラー構造に変換するエラーハンドラーを追加します。
このルールの結果、名前、ID、ステータスフィールドに入力した値は、手順2で定義したフィールドが変更され、フォームのフィールド外にタブ移動した直後に検証されます。
「モード選択」ドロップダウンリストから「コードエディター」を選択します。
「コードを編集」をタップします。
既存のコードから次の行を削除します。
guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs);
カスタムエラー構造を標準エラー構造に変換するルールを作成し、完了をタップしてルールを保存します。
例えば、カスタムエラー構造を標準エラー構造に変換するために、最後に次のサンプルコードを追加します。
var errorHandler = function(jqXHR, data) {
var som_map = {
"id": "guide[0].guide1[0].guideRootPanel[0].Pet[0].id_1[0]",
"name": "guide[0].guide1[0].guideRootPanel[0].Pet[0].name_2[0]",
"status": "guide[0].guide1[0].guideRootPanel[0].Pet[0].status[0]"
};
var errorJson = {};
errorJson.errors = [];
if (data) {
if (data.originMessage) {
var errorData;
try {
errorData = JSON.parse(data.originMessage);
} catch (err) {
// not in json format
}
if (errorData) {
Object.keys(errorData).forEach(function(key) {
var som_key = som_map[key];
if (som_key) {
var error = {};
error.somExpression = som_key;
error.errorMessage = errorData[key];
errorJson.errors.push(error);
}
});
}
window.guideBridge.handleServerValidationError(errorJson);
} else {
window.guideBridge.handleServerValidationError(data);
}
}
};
guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs, null, errorHandler);
var som_map
は、標準形式に変換するアダプティブフォームフィールドのSOM式をリストします。 アダプティブフォーム内の任意のフィールドのSOM式を表示するには、フィールドをタップし、詳細オプション(…)メニューから表示SOM式を選択します。
次のサンプルコード行をカスタムエラーハンドラーにコピーしてください。
guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs, null, errorHandler);
executeOperation APIには、新しいカスタムエラーハンドラーに基づくnull
パラメーターとerrorHandler
パラメーターが含まれます。
このカスタムエラーハンドラーを使用すると、アダプティブフォームはvar som_map
に示すフィールドを標準エラーメッセージ形式に変換します。 その結果、検証エラーメッセージはアダプティブフォームのフィールドレベルで表示されます。