アダプティブフォームの標準検証エラーメッセージ

アダプティブフォームは、事前設定された検証条件に基づいて、フィールドに入力した入力を検証します。 検証条件は、アダプティブフォーム内のフィールドに許容される入力値を指します。 アダプティブフォームで使用するデータソースに基づいて検証条件を設定できます。 例えば、RESTful Webサービスをデータソースとして使用する場合、Swagger定義ファイルで検証条件を定義できます。

入力値が検証条件を満たす場合、値がデータソースに送信されます。 それ以外の場合は、エラーメッセージがアダプティブフォームに表示されます。

この方法と同様に、アダプティブフォームをカスタムサービスと統合して、データ検証を実行できるようになりました。 入力値が検証条件を満たさず、サーバーが返す検証エラーメッセージが標準メッセージ形式の場合、エラーメッセージはフォームのフィールドレベルに表示されます。

入力値が検証条件を満たさず、サーバーの検証エラーメッセージが標準メッセージ形式でない場合、アダプティブフォームは検証エラーメッセージを標準形式に変換し、フォームのフィールドレベルで表示するメカニズムを提供します。 次の2つの方法のいずれかを使用して、エラーメッセージを標準形式に変換できます。

  • アダプティブフォーム送信時にカスタムエラーハンドラーを追加する
  • ルールエディターを使用して、「Invoke Service」アクションにカスタムハンドラーを追加する

この記事では、検証エラーメッセージの標準形式と、エラーメッセージをカスタム形式から標準形式に変換する手順について説明します。

標準検証エラーメッセージ形式

サーバー検証エラーメッセージが次の標準形式の場合、アダプティブフォームはフィールドレベルでエラーを表示します。

   {
    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 外部サービスから返される生のエラーデータが含まれます

カスタムハンドラーを追加するためのアダプティブフォームの送信設定

サーバー検証エラーメッセージが標準形式で表示されない場合は、非同期送信を有効にし、アダプティブフォーム送信時にカスタムエラーハンドラーを追加して、メッセージを標準形式に変換できます。

非同期アダプティブフォーム送信の設定

カスタムハンドラーを追加する前に、非同期送信用にアダプティブフォームを設定する必要があります。 以下の手順を実行します。

  1. アダプティブフォームのオーサリングモードで、フォームコンテナオブジェクトを選択し、アダプティブフォームのプロパティをタップしてプロパティを開きます。

  2. 送信」プロパティセクションで、「非同期送信を使用」を有効にします。

  3. サーバーで再検証」を選択して、送信前にサーバー上の入力フィールド値を検証します。

  4. 送信アクションを選択します。

    • フォームデータモデル​を使用して送信を選択し、適切なデータモデルを選択します(データソースとしてフォームデータモデルをベースとするRESTful Webサービスを使用する場合)。
    • Submit to REST endpoint​を選択し、データソースとしてRESTful Webサービスを使用する場合は、Redirect URL/Path​を指定します。

    アダプティブフォーム送信プロパティ

  5. 保存」をタップして、プロパティを保存します。

アダプティブフォーム送信時のカスタムエラーハンドラーの追加

AEM Forms には、フォーム送信が成功した場合と失敗した場合の処理を実行するハンドラーが用意されています。これらのハンドラーは、すぐに使用することができます。ハンドラーは、サーバー応答に基づいて実行されるクライアントサイド関数です。フォームが送信されると、データが検証のためにサーバーに転送され、送信の成功またはエラーイベントに関する情報と共に、応答がクライアントに返されます。この情報は、関連するハンドラーにパラメーターとして渡され、関数が実行されます。

次の手順を実行して、アダプティブフォーム送信時にカスタムエラーハンドラーを追加します。

  1. アダプティブフォームをオーサリングモードで開き、任意のフォームオブジェクトを選択してから、をタップしてルールエディターを開きます。
  2. フォームオブジェクトツリーで「フォーム」選択し、「作成」をタップします。
  3. 「イベント」ドロップダウンリストから「送信中のエラー​」を選択します。
  4. カスタムエラー構造を標準エラー構造に変換するルールを作成し、「完了」をタップしてルールを保存します。

次に、カスタムエラー構造を標準エラー構造に変換するサンプルコードを示します。

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に示すフィールドを標準のエラーメッセージ形式に変換します。 その結果、検証エラーメッセージは、アダプティブフォームのフィールドレベルで表示されます。

「サービスを呼び出し」アクションを使用したカスタムハンドラーの追加

次の手順を実行して、カスタムエラー構造を標準エラー構造に変換し、ルールエディターの「サービスを呼び出し」アクションを使用します。

  1. アダプティブフォームをオーサリングモードで開き、任意のフォームオブジェクトを選択して、「ルールエディター」をタップし、ルールエディターを開きます。
  2. 作成」をタップします。
  3. ルールの​When​セクションに条件を作成します。 例えば、When[Name of field]が変更されたとします。 この条件を満たすには、状態を選択​ドロップダウンリストから「変更」を選択します。
  4. Then」セクションの「アクションの選択」ドロップダウンリストで「サービスの呼び出し」を選択します。
  5. Input​セクションから、Postサービスと対応するデータバインディングを選択します。 例えば、アダプティブフォームの​名前IDステータス​フィールドを検証する場合は、ポストサービス(pet)を選択し、入力​セクションでpet.name、pet.idおよびpet.statusを選択します。

このルールの結果、名前IDステータス​の各フィールドに入力した値は、手順2で定義したフィールドが変更され、フォームのフィールドからタブを離すとすぐに検証されます。

  1. 「モード選択」ドロップダウンリストから「コードエディター」を選択します。

  2. コードを編集」をタップします。

  3. 既存のコードから次の行を削除します。

    guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs);
    
  4. カスタムエラー構造を標準エラー構造に変換するルールを作成し、「完了」をタップしてルールを保存します。
    例えば、カスタムエラー構造を標準エラー構造に変換するために、末尾に次のサンプルコードを追加します。

    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に示すフィールドを標準のエラーメッセージ形式に変換します。 その結果、検証エラーメッセージは、アダプティブフォームのフィールドレベルで表示されます。

このページ