Mensagens de erro de validação padrão para formulários adaptáveis

Os formulários adaptáveis validam as entradas fornecidas nos campos com base em um critério de validação predefinido. Os critérios de validação se referem aos valores de entrada aceitáveis para campos em um formulário adaptável. É possível definir os critérios de validação com base na fonte de dados usada com o formulário adaptável. Por exemplo, se você usar os serviços Web RESTful como a fonte de dados, poderá definir os critérios de validação em um arquivo de definição Swagger.

Se os valores de entrada atenderem aos critérios de validação, eles serão enviados para a fonte de dados. Caso contrário, o formulário adaptativo exibirá uma mensagem de erro.

Semelhante a essa abordagem, os formulários adaptáveis agora podem se integrar aos serviços personalizados para executar validações de dados. Se os valores de entrada não atenderem aos critérios de validação e a mensagem de erro de validação retornada pelo servidor estiver no formato de mensagem padrão, as mensagens de erro serão exibidas no nível do campo no formulário.

Se os valores de entrada não atenderem aos critérios de validação e a mensagem de erro de validação do servidor não estiver no formato de mensagem padrão, os formulários adaptativos fornecerão um mecanismo para transformar as mensagens de erro de validação em um formato padrão, de modo que sejam exibidas no nível do campo no formulário. É possível transformar a mensagem de erro no formato padrão usando qualquer um dos dois métodos a seguir:

  • Adicionar manipulador de erros personalizado no envio de formulário adaptável
  • Adicionar manipulador personalizado à ação Chamar serviço usando o Editor de regras

Este artigo descreve o formato padrão para as mensagens de erro de validação e as instruções para transformar as mensagens de erro de um formato personalizado para o padrão.

Formato de mensagem de erro de validação padrão

Os formulários adaptáveis exibem os erros no nível do campo se as mensagens de erro de validação do servidor estiverem no seguinte formato padrão:

   {
    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>
}

Em que:

  • errorCausedBy descreve o motivo da falha
  • errors mencionar a expressão SOM dos campos que falharam nos critérios de validação junto com a mensagem de erro de validação
  • originCode contém o código de erro retornado pelo serviço externo
  • originMessage contém os dados de erro brutos retornados pelo serviço externo

Configure o envio de formulário adaptável para adicionar manipuladores personalizados

Se a mensagem de erro de validação do servidor não for exibida no formato padrão, você poderá ativar o envio assíncrono e adicionar um manipulador de erros personalizado no envio do formulário adaptável para converter a mensagem em um formato padrão.

Configurar envio assíncrono de formulário adaptável

Antes de adicionar o manipulador personalizado, é necessário configurar o formulário adaptável para envio assíncrono. Execute as seguintes etapas:

  1. No modo de criação de formulário adaptável, selecione o objeto Container de formulário e toque em propriedades de formulário adaptáveis para abrir suas propriedades.

  2. Na seção de propriedades Submission, ative Utilizar submissão assíncrona.

  3. Selecione Revalidar no servidor para validar os valores de campo de entrada no servidor antes do envio.

  4. Selecione a Ação Enviar:

    • Selecione Enviar usando o Modelo de Dados de Formulário e selecione o modelo de dados apropriado, se estiver usando o serviço Web RESTful baseado no modelo de dados de formulário como a fonte de dados.
    • Selecione Enviar para o ponto de extremidade REST e especifique o Redirecionar URL/Caminho, se estiver usando os serviços Web RESTful como fonte de dados.

    propriedades adaptáveis de envio de formulário

  5. Toque em Salvar para salvar as propriedades.

Adicionar manipulador de erros personalizado no envio de formulário adaptável

A AEM Forms fornece manipuladores de erros e sucesso prontos para uso para envios de formulário. Os manipuladores são funções do lado do cliente que são executadas com base na resposta do servidor. Quando um formulário é submetido, os dados são transmitidos ao servidor para validação, o que retorna uma resposta ao cliente com informações sobre o evento bem-sucedido ou erro para o envio. As informações são passadas como parâmetros para o manipulador relevante para executar a função.

Execute as seguintes etapas para adicionar o manipulador de erros personalizado no envio do formulário adaptável:

  1. Abra o formulário adaptável no modo de criação, selecione qualquer objeto de formulário e toque em para abrir o editor de regras.
  2. Selecione Formulário na árvore de objetos de formulário e toque em Criar.
  3. Selecione Erro no envio na lista suspensa Evento.
  4. Grave uma regra para converter a estrutura de erro personalizada para a estrutura de erro padrão e toque em Done para salvar a regra.

A seguir está um exemplo de código para converter uma estrutura de erro personalizada para a estrutura de erro padrão:

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);
    }
}

O var som_map lista a expressão SOM dos campos de formulário adaptáveis que você deseja transformar no formato padrão. Você pode visualização a expressão SOM de qualquer campo em um formulário adaptável tocando no campo e selecionando Expressão SOM da Visualização.

Usando esse manipulador de erros personalizado, o formulário adaptativo converte os campos listados em var som_map para o formato de mensagem de erro padrão. Como resultado, as mensagens de erro de validação são exibidas no nível do campo no formulário adaptável.

Adicionar manipulador personalizado usando a ação Chamar serviço

Execute as seguintes etapas para adicionar o manipulador de erros para converter uma estrutura de erro personalizada na estrutura de erro padrão usando a ação Chamar serviço do Editor de regras:

  1. Abra o formulário adaptável no modo de criação, selecione qualquer objeto de formulário e toque em Editor de regras para abrir o editor de regras.
  2. Toque em Criar.
  3. Crie uma condição na seção When da regra. Por exemplo, Quando[Nome do campo] é alterado. Selecione é alterado na lista suspensa Selecionar Estado para obter esta condição.
  4. Na seção Em seguida, selecione Chamar serviço na lista suspensa Selecionar ação.
  5. Selecione um serviço Post e seus vínculos de dados correspondentes na seção Input. Por exemplo, se você deseja validar os campos Nome, ID e Status no formulário adaptável, selecione um serviço Post (pet) e selecione pet.name, pet.id e pet.status na seção Input.

Como resultado dessa regra, os valores inseridos para os campos Name, ID e Status são validados, assim que o campo definido na etapa 2 é alterado e você sai do campo no formulário.

  1. Selecione Editor de código na lista suspensa de seleção de modo.

  2. Toque em Editar código.

  3. Exclua a seguinte linha do código existente:

    guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs);
    
  4. Grave uma regra para converter a estrutura de erro personalizada para a estrutura de erro padrão e toque em Done para salvar a regra.
    Por exemplo, adicione o seguinte código de amostra no final para converter uma estrutura de erro personalizada para a estrutura de erro padrão:

    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);
    

    O var som_map lista a expressão SOM dos campos de formulário adaptáveis que você deseja transformar no formato padrão. Você pode visualização a expressão SOM de qualquer campo em um formulário adaptável tocando no campo e selecionando Expressão SOM Visualização no menu Mais opções (…).

    Certifique-se de copiar a seguinte linha do código de amostra para o manipulador de erros personalizado:

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

    A API executeOperation inclui os parâmetros null e errorHandler com base no novo manipulador de erros personalizado.

    Usando esse manipulador de erros personalizado, o formulário adaptativo converte os campos listados em var som_map para o formato de mensagem de erro padrão. Como resultado, as mensagens de erro de validação são exibidas no nível do campo no formulário adaptável.

Nesta página