自适应表单的标准验证错误消息

自适应表单根据预设验证条件验证您在字段中提供的输入。 验证标准是指自适应表单中字段的可接受输入值。 您可以基于在自适应表单中使用的数据源设置验证条件。 例如,如果使用RESTful Web服务作为数据源,则可以在Swagger定义文件中定义验证条件。

如果输入值满足验证条件,则会将值提交到数据源。 否则,自适应表单会显示错误消息。

与这种方法类似,自适应表单现在可与自定义服务集成以执行数据验证。 如果输入值不符合验证条件,并且服务器返回的验证错误消息为标准消息格式,则错误消息在表单的字段级别显示。

如果输入值不符合验证标准,并且服务器验证错误消息不是标准消息格式,则自适应表单提供一种机制,将验证错误消息转换为标准格式,以便它们在表单中的字段级别显示。 可以使用以下两种方法中的任意一种将错误消息转换为标准格式:

  • 在自适应表单提交中添加自定义错误处理程序
  • 添加自定义处理程序以使用规则编辑器调用服务操作

本文介绍了验证错误消息的标准格式,以及将错误消息从自定义格式转换为标准格式的说明。

标准验证错误消息格式

如果服务器验证错误消息采用以下标准格式,则自适应表单会在字段级别显示错误:

   {
    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服务的) 表单数据模型 作为数据源。
    • 选择 提交到REST端点 并指定 重定向URL/路径,如果您使用RESTful Web服务作为数据源。

    自适应表单提交属性

  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表达式.

使用此自定义错误处理程序,自适应表单转换 var som_map 更改为标准错误消息格式。 因此,验证错误消息会在自适应表单中的字段级别显示。

使用“调用服务”操作添加自定义处理程序

执行以下步骤可添加错误处理程序,以使用将自定义错误结构转换为标准错误结构 规则编辑器的 调用服务操作:

  1. 在创作模式下打开自适应表单,选择任意表单对象,然后点按 规则编辑器 以打开规则编辑器。
  2. 点按 创建.
  3. 在中创建条件 时间 部分。 例如,当[字段名称] 已更改。 选择 已更改选择状态 下拉列表来达到此条件。
  4. 部分,选择 调用服务选择操作 下拉列表。
  5. 从中选择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表达式 起始日期 更多选项 (…)菜单。

    确保将示例代码的以下行复制到自定义错误处理程序中:

    guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs, null, errorHandler);
    

    executeOperation API包含 nullerrorHandler 参数基于新的自定义错误处理程序。

    使用此自定义错误处理程序,自适应表单转换 var som_map 更改为标准错误消息格式。 因此,验证错误消息会在自适应表单中的字段级别显示。

在此页面上