Adicionar regras a um Formulário adaptável adaptive-forms-rule-editor

O Adobe recomenda o uso de Componentes principaisde captura de dados moderna e extensível para criar um novo Forms Adaptávelou adicionar o Forms Adaptável às páginas do AEM Sites. Esses componentes representam um avanço significativo na criação do Forms adaptável, garantindo experiências de usuário impressionantes. Este artigo descreve a abordagem mais antiga para criar o Forms adaptável usando componentes de base.

Visão geral overview

O recurso do editor de regras permite que usuários e desenvolvedores de negócios de formulários gravem regras em objetos de Formulário adaptável. Essas regras definem as ações a serem acionadas nos objetos de formulário com base nas condições predefinidas, entradas do usuário e ações do usuário no formulário. Isso ajuda a simplificar ainda mais a experiência de preenchimento de formulário, garantindo precisão e velocidade.

O editor de regras fornece uma interface de usuário intuitiva e simplificada para escrever regras. O editor de regras oferece um editor visual para todos os usuários. Algumas das principais ações que podem ser executadas em objetos de Formulário adaptável usando regras são:

Os usuários adicionados ao grupo forms-power-users podem criar scripts e editar os existentes. Os usuários do grupo forms-users podem usar os scripts, mas não podem criá-los ou editá-los.

Diferença entre o Editor de regras nos Componentes principais e o Editor de regras nos Componentes de base

A tabela a seguir demonstra a diferença entre os recursos disponíveis nos Componentes principais do editor de regras e nos Componentes de base do editor de regras:

Noções básicas sobre um regra understanding-a-rule

Uma regra é uma combinação de ações e condições. No editor de regras, as ações incluem atividades como ocultar, mostrar, habilitar, desabilitar ou calcular o valor de um objeto em um formulário. As condições são expressões booleanas que são avaliadas executando verificações e operações no estado, valor ou propriedade de um objeto de formulário. As ações são executadas com base no valor ( True ou False) retornado pela avaliação de uma condição.

O editor de regras fornece um conjunto de tipos de regras predefinidos, como Quando, Mostrar, Ocultar, Ativar, Desativar, Definir valor de e Validar, para ajudá-lo a escrever regras. Cada tipo de regra permite definir condições e ações em uma regra. O documento explica detalhadamente cada tipo de regra.

Uma regra normalmente segue uma das seguintes construções:

Ação de condição Nesta construção , uma regra primeiro define uma condição seguida de uma ação a ser acionada. A construção é comparável à declaração if-then nas linguagens de programação.

No regra editor, o tipo Quando regra aplica a construção de ação de condição.

Condição de ação Nesta construção, uma regra primeiro define uma ação a ser acionada seguida de condições para avaliação. Outra variação dessa construção é a ação alternativa de condição de ação, que também define uma ação alternativa a ser acionada se a condição retornar False.

A Exibir, Ocultar, Ativar, Desativar, Definir Valor e Validar regra tipos em regra editor impor a construção regra ação-condição. Por padrão, a ação alternativa para Exibir é Ocultar e habilitar é Desativar e da maneira oposta. Não é possível alterar a ação alternativa padrão.

Para obter mais informações sobre tipos de regras disponíveis no editor de regras, consulte Tipos de regras disponíveis no editor de regras.

Diretrizes para a escolha de uma construção de regra guidelines-for-choosing-a-rule-construct

Embora seja possível obter a maioria dos casos de uso usando qualquer construção de regra, veja a seguir algumas diretrizes para escolher uma construção em vez de outra. Para obter mais informações sobre as regras disponíveis no editor de regras, consulte Tipos de regras disponíveis no editor de regras.

Tipos de operadores e eventos disponíveis no editor de regras available-operator-types-and-events-in-rule-editor

O editor de regras fornece os seguintes operadores lógicos e eventos com os quais você pode criar regras.

Tipos de regras disponíveis no editor de regras available-rule-types-in-rule-editor

O editor de regras fornece um conjunto de tipos de regras predefinidos que você pode usar para escrever regras. Vamos analisar cada tipo de regra detalhadamente. Para obter mais informações sobre como gravar regras no editor de regras, consulte Regras de gravação.

Quando whenruletype

O tipo When regra segue a ação alternativa de condição-ação regra construir, ou às vezes, apenas a construção de ação de condição . Nesse tipo de regra, primeiro você especifica uma condição para avaliação seguida de uma ação a ser acionada se a condição estiver atendida ( True). Ao usar o tipo Quando regra, você pode usar vários operadores AND e OR para criar expressões aninhadas.

Ao usar o tipo Quando regra, é possível avaliar uma condição em um objeto de formulário e executar ações em um ou mais objetos.

Em palavras simples, um típico de Quando regra está estruturado da seguinte maneira:

When on Object A:

(Condition 1 AND Condition 2 OR Condition 3) is TRUE;

Then, do the following:

Ação 2 no objeto B;
E
Ação 3 no Objeto C;

_

Quando você tem um componente de vários valores, como botões de opção ou lista, ao criar uma regra para esse componente, as opções são automaticamente recuperadas e disponibilizadas para o criador da regra. Não é necessário digitar os valores da opção novamente.

Por exemplo, uma lista tem quatro opções: Vermelho, Azul, Verde e Amarelo. Ao criar a regra, as opções (botões de opção) são recuperadas automaticamente e disponibilizadas ao criador da regra da seguinte maneira:

Ao escrever uma regra Quando, é possível acionar a ação Limpar valor de. Limpar valor da ação limpa o valor do objeto especificado. Ter o valor claro de como uma opção na instrução When permite criar condições complexas com vários campos.

Ocultar oculta o objeto especificado.

Mostrar Mostra o objeto especificado.

Habilitar Habilita o objeto especificado.

Desativa o objeto especificado.

Chamar serviço Chama um serviço configurado em um modelo de dados de formulário (FDM). Quando você escolhe a operação Chamar Serviço, um campo é exibido. Ao tocar no campo, ele exibe todos os serviços configurados em todos os modelos de dados de formulário (FDM) na instância Experience Manager. Ao escolher um serviço de Modelo de dados de formulário (FDM), mais campos são exibidos onde você pode mapear objetos de formulário com parâmetros de entrada e saída para o serviço especificado. Consulte exemplo de regra para chamar serviços de Modelo de dados de formulário.

Além do serviço de modelo de dados de formulário, você pode especificar um URL WSDL direto para chamar um serviço Web. No entanto, um serviço de modelo de dados de formulário tem muitos benefícios e a abordagem recomendada para chamar um serviço.

Para obter mais informações sobre como configurar serviços no modelo de dados de formulário (FDM), consulte Experience Manager Forms Integração de Dados.

Defina o valor de Computes e defina o valor do objeto especificado. Você pode definir o valor do objeto como uma string, o valor de outro objeto, o valor calculado usando a expressão matemática ou a função, o valor de uma propriedade de um objeto ou o valor de saída de um serviço de Modelo de Dados de Formulário configurado. Quando você escolhe a opção de serviço Web, ela exibe todos os serviços configurados em todos os modelos de dados de formulário (FDM) na sua instância Experience Manager. Ao escolher um serviço de modelo de dados de formulário, mais campos são exibidos onde você pode mapear objetos de formulário com parâmetros de entrada e saída para o serviço especificado.

Para obter mais informações sobre como configurar serviços no modelo de dados de formulário (FDM), consulte Experience Manager Forms Integração de Dados.

O tipo de regra Definir Propriedade permite que você defina o valor de uma propriedade do objeto especificado com base em uma ação de condição. Você pode definir a propriedade como uma das seguintes opções:

Por exemplo, permite definir regras para adicionar caixas de seleção dinamicamente ao Formulário adaptável. Você pode usar uma função personalizada, um objeto de formulário ou uma propriedade de objeto para definir uma regra.

Para definir uma regra com base em uma função personalizada, selecione Saída da Função na lista suspensa e arraste e solte uma função personalizada na guia Funções. Se a ação de condição for atendida, o número de caixas de seleção definidas na função personalizada será adicionado ao Formulário adaptável.

Para definir uma regra baseada em um objeto de formulário, selecione Objeto de formulário na lista suspensa e arraste e solte um objeto de formulário da guia Objetos de formulário. Se a ação de condição for atendida, o número de caixas de seleção definidas no objeto de formulário será adicionado ao Formulário adaptável.

Uma regra Definir propriedade com base em uma propriedade de objeto permite adicionar o número de caixas de seleção em um Formulário adaptável com base em outra propriedade de objeto incluída no Formulário adaptável.

A figura a seguir mostra um exemplo de adição dinâmica de caixas de seleção com base no número de listas suspensas no Formulário adaptável:

Limpar Valor de Limpa o valor do objeto especificado.

Definir Foco Define o foco no objeto especificado.

Salvar formulário Salva o formulário.

Enviar Forms Envia o formulário.

Redefinir formulário Redefine o formulário.

Validar formulário Valida o formulário.

Adicionar instância Adiciona uma instância do painel ou linha de tabela repetível especificado.

Remover instância Remove uma instância do painel ou linha de tabela repetível especificado.

Navegar até Navega até outro Forms Adaptive, outros ativos, como imagens ou fragmentos de documentos, ou uma URL externa.

Definir valor de set-value-of

O tipo de regra Definir Valor de permite que você defina o valor de um objeto de formulário, dependendo se a condição especificada é atendida ou não. O valor pode ser definido como um valor de outro objeto, uma sequência literal, um valor derivado de uma expressão matemática ou de uma função, um valor de uma propriedade de outro objeto ou a saída de um serviço de modelo de dados de formulário. Da mesma forma, você pode verificar uma condição em um componente, string, propriedade ou valores derivados de uma função ou expressão matemática.

O tipo Definir Valor de regra não está disponível para todos os objetos de formulário, como painéis e botões da barra de ferramentas. Um Conjunto padrão Valor De regra tem a seguinte estrutura:

Defina o valor do Objeto A como:

(sequência de caracteres ABC) OU
(objeto propriedade X do objeto C) OU
(valor de uma função) OU
(valor de uma expressão matemática) OU
(valor de saída de um serviço de modelo de dados ou de um serviço da Web);

Quando (opcional):

(Condição 1 E Condição 2 E Condição 3) é VERDADEIRA;

O exemplo a seguir pega o valor no campo dependentid como entrada e define o valor do campo Relation como a saída do argumento Relation do serviço de Modelo de Dados de Formulário getDependent.

Exemplo de regra Definir valor usando o serviço de Modelo de dados de formulário

Programa show

Usando o tipo de regra Mostrar, você pode escrever uma regra para mostrar ou ocultar um objeto de formulário com base no fato de uma condição ser atendida ou não. O tipo de regra Mostrar também aciona a ação Ocultar caso a condição não seja atendida ou retorne False.

Uma regra típica de exibição está estruturada da seguinte maneira:

Show Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Else:

Hide Object A;

Ocultar hide

Semelhante ao tipo de regra Mostrar, você pode usar o tipo de regra Ocultar para mostrar ou ocultar um objeto de formulário com base no fato de uma condição ser atendida ou não. O tipo de regra Ocultar também aciona a ação Mostrar caso a condição não seja atendida ou retorne False.

Uma regra típica de Ocultar está estruturada da seguinte maneira:

Hide Object A;

When:

(Condition 1 AND Condition 2 AND Condition 3) is TRUE;

Else:

Show Object A;

Habilitar enable

O tipo de regra Habilitar permite habilitar ou desabilitar um objeto de formulário com base no fato de uma condição ser atendida ou não. O tipo de regra Habilitar também aciona a ação Desabilitar caso a condição não seja atendida ou retorne False.

Uma regra Enable típica é estruturada da seguinte maneira:

Enable Object A;

When:

(Condition 1 AND Condition 2 AND Condition 3) is TRUE;

Else:

Disable Object A;

Desabilitar disable

Semelhante ao tipo de regra Habilitar, o tipo de regra Desabilitar permite habilitar ou desabilitar um objeto de formulário com base no fato de uma condição ser atendida ou não. O tipo de regra Desativar também aciona a ação Ativar caso a condição não seja atendida ou retorne False.

Uma regra típica de Desativação está estruturada da seguinte maneira:

Disable Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Else:

Enable Object A;

Validar validate

O tipo de regra Validar valida o valor em um campo usando uma expressão. Por exemplo, você pode escrever uma expressão para verificar se a caixa de texto para especificar o nome não contém caracteres especiais ou números.

Uma regra Validate típica é estruturada da seguinte maneira:

Validate Object A;

Using:

(Expression 1 AND Expression 2 AND Expression 3) is TRUE;

Definir Opções De setoptionsof

O tipo de regra Definir Opções de permite que você defina regras para adicionar caixas de seleção dinamicamente ao Formulário adaptável. Você pode usar um Modelo de dados de formulário (FDM) ou uma função personalizada para definir a regra.

Para definir uma regra com base em uma função personalizada, selecione Saída da Função na lista suspensa e arraste e solte uma função personalizada na guia Funções. O número de caixas de seleção definidas na função personalizada é adicionado ao Formulário adaptável.

Para criar uma função personalizada, consulte funções personalizadas no editor de regras.

Para definir uma regra com base em um modelo de dados de formulário (FDM):

Noções básicas sobre a interface do usuário do editor de regras understanding-the-rule-editor-user-interface

O Editor de regras fornece uma interface de usuário abrangente, mas simples, para gravar e gerenciar regras. É possível iniciar a interface do usuário do editor de regras em um Formulário adaptável no modo de criação.

Para iniciar a interface do usuário do editor de regras:

Vamos analisar cada componente da interface do editor de regras em detalhes.

A. Exibição de componente-regra a-component-rule-display

Exibe o título do objeto de Formulário adaptável pelo qual você iniciou o editor de regras e o tipo de regra selecionado no momento. No exemplo acima, o editor de regras é iniciado a partir de um objeto de Formulário adaptável chamado Salário, e o tipo de regra selecionado é Quando.

B. Funções e objetos de formulário b-form-objects-and-functions-br

O painel à esquerda na interface do usuário do editor de regras inclui duas guias: Objetos do Forms e Funções.

A guia Objetos de formulário mostra uma exibição hierárquica de todos os objetos contidos no formulário adaptável. Ele exibe o título e o tipo dos objetos. Ao escrever uma regra, você pode arrastar e soltar objetos de formulário no editor de regras. Ao criar ou editar uma regra ao arrastar e soltar um objeto ou função em um espaço reservado, o espaço reservado automaticamente assume o tipo de valor apropriado.

Os objetos de formulário que têm uma ou mais regras válidas aplicadas são marcados com um ponto verde. Se alguma das regras aplicadas a um objeto de formulário for inválida, o objeto de formulário será marcado com um ponto amarelo.

A guia Funções inclui um conjunto de funções incorporadas, como Soma de, Mín de, Máx de, Média de, Número de e Validar formulário. Você pode usar essas funções para calcular valores em painéis e linhas de tabela repetíveis e usá-los em declarações de ação e condição ao escrever regras. Entretanto, você também pode criar funções personalizadas.

Na árvore esquerda dos objetos de formulário, você pode selecionar os objetos de formulário para exibir as regras aplicadas a cada um dos objetos. Você não só pode navegar pelas regras dos vários objetos de formulário, como também pode copiar e colar regras entre os objetos de formulário. Para obter mais informações, consulte Copiar-colar regras.

C. Alternância entre objetos e funções de formulário c-form-objects-and-functions-toggle-br

O botão de alternância, quando tocado, alterna o painel de funções e objetos de formulário.

D. Editor visual de regras visual-rule-editor

Editor visual de regras é a área no modo editor visual da interface do usuário do editor de regras em que você escreve regras. Ele permite selecionar um tipo de regra e definir adequadamente condições e ações. Ao definir condições e ações em uma regra, você pode arrastar e soltar objetos e funções de formulário do painel Objetos de formulário e Funções.

Para obter mais informações sobre como usar o editor visual de regras, consulte Regras de gravação.

E. Botões Concluído e Cancelar done-and-cancel-buttons

O botão Concluído é usado para salvar uma regra. Você pode salvar uma regra incompleta. No entanto, incompletos são inválidos e não são executados. As regras salvas em um objeto de formulário são listadas na próxima vez que você iniciar o editor de regras a partir do mesmo objeto de formulário. Você pode gerenciar as regras existentes nessa visualização. Para obter mais informações, consulte Gerenciar regras.

O botão Cancelar descarta todas as alterações feitas em uma regra e fecha o editor de regras.

Regras de gravação write-rules

Você pode escrever regras usando o editor visual de regras <!— ou o editor de código>. Quando você inicia o editor de regras pela primeira vez, ele é aberto no modo do editor visual. Você pode alternar para o modo do editor de código e escrever regras. No entanto, se você escrever ou modificar uma regra no editor de código, não poderá alternar para o editor visual dessa regra, a menos que o editor de código seja limpo. Na próxima vez que você iniciar o editor de regras, ele será aberto no modo usado por último para criar a regra.

Primeiro, vamos analisar como escrever regras usando o editor visual.

Uso do editor visual using-visual-editor

Vamos entender como criar uma regra no editor visual usando o seguinte formulário de exemplo.

A seção Requisitos de Empréstimo no formulário de solicitação de empréstimo de exemplo exige que os candidatos especifiquem seu estado civil, salário e, se forem casados, o salário de seus cônjuges. Com base nas entradas do usuário, a regra calcula o valor de qualificação de empréstimo e é exibida no campo Elegibilidade do empréstimo. Aplique as seguintes regras para implementar o cenário:

Para gravar regras, execute as seguintes etapas:

Funções personalizadas no editor de regras custom-functions

Além das funções prontas para uso como Soma de que estão listadas em Saída de funções, você pode gravar funções personalizadas das quais precisa com frequência. Certifique-se de que a função que você grava esteja acompanhada pelo jsdoc acima dela.

O acompanhamento de jsdoc é obrigatório:

O editor de regras é compatível com a sintaxe JavaScript ES2015 para scripts e funções personalizadas.
Para obter mais informações, consulte jsdoc.app.

jsdoc marcas com suporte:

Adicionando uma função personalizada

Por exemplo, você deseja adicionar uma função personalizada que calcula a área de um quadrado. O comprimento do lado é a entrada do usuário na função personalizada, que é aceita usando uma caixa numérica no formulário. A saída calculada é exibida em outra caixa numérica no formulário. Para adicionar uma função personalizada, primeiro crie uma biblioteca do cliente e, em seguida, adicione-a ao repositório do CRX.

Para criar uma biblioteca do cliente e adicioná-la ao repositório do CRX, execute as seguintes etapas:

Depois de ter adicionado a biblioteca do cliente ao repositório do CRX, use-a no Formulário adaptável. Ela permite usar sua função personalizada como uma regra em seu formulário. Para adicionar a biblioteca do cliente no formulário adaptável, execute as seguintes etapas:

Tipos suportados de declaração de função function-declaration-supported-types

Instrução da Função

function area(len) {
    return len*len;
}

Esta função está incluída sem jsdoc comentários.

Expressão de função

var area;
//Some codes later
/** */
area = function(len) {
    return len*len;
};

Expressão e Instrução da Função

var b={};
/** */
b.area = function(len) {
    return len*len;
}

Declaração de função como variável

/** */
var x1,
    area = function(len) {
        return len*len;
    },
    x2 =5, x3 =true;

Limitação: a função personalizada escolhe somente a primeira declaração de função da lista de variáveis, se estiver junto. Você pode usar a expressão de função para cada função declarada.

Declaração de Função como Objeto

var c = {
    b : {
        /** */
        area : function(len) {
            return len*len;
        }
    }
};

Gerenciar regras manage-rules

Todas as regras existentes em um objeto de formulário são listadas ao selecionar o objeto e selecionar . É possível exibir o título e uma pré-visualização do resumo da regra. Além disso, a interface do permite expandir e exibir o resumo completo da regra, alterar a ordem das regras, editar regras e excluir regras.

Você pode executar as seguintes ações nas regras:

Copiar e colar regras copy-paste-rules

É possível copiar e colar uma regra de um campo para outros campos semelhantes para economizar tempo.

Para copiar e colar regras, faça o seguinte:

Expressões aninhadas nestedexpressions

O editor de regras permite usar vários operadores AND e OR para criar regras aninhadas. Você pode misturar vários operadores AND e OR em regras.

Veja a seguir um exemplo de uma regra aninhada que exibe uma mensagem ao usuário sobre a elegibilidade para a custódia de uma criança quando as condições necessárias são atendidas.

Também é possível arrastar e soltar condições em uma regra para editá-la. Selecione e passe o mouse sobre o identificador ( ) antes de uma condição. Depois que o ponteiro se transformar no símbolo da mão, como mostrado abaixo, arraste e solte a condição em qualquer lugar dentro da regra. A estrutura da regra muda.

Condições de expressão de data dateexpression

O editor de regras permite usar comparações de datas para criar condições.

A seguir está um exemplo de condição que exibe um objeto de texto estático se a hipoteca da casa já estiver sendo feita, o que o usuário significa preenchendo o campo de data.

Quando a data de hipoteca do imóvel conforme preenchido pelo usuário estiver no passado, o Formulário adaptável exibirá uma nota sobre o cálculo de renda. A regra a seguir compara a data preenchida pelo usuário com a data atual e, se a data preenchida pelo usuário for anterior à data atual, o formulário exibirá a mensagem de texto (chamada de Receita).

Quando a data de preenchimento for anterior à data atual, o formulário exibirá a mensagem de texto (Receita) como a seguir:

Condições de comparação de número number-comparison-conditions

O editor de regras permite criar condições que comparam dois números.

A seguir, há uma condição de exemplo que exibe um objeto de texto estático se o número de meses em que um candidato está hospedado no endereço atual for inferior a 36.

Quando o usuário indica que está morando no endereço residencial atual por menos de 36 meses, o formulário exibe uma notificação de que mais prova de residência pode ser solicitada.

Exemplo de regras example

Invocar serviço de modelo de dados de formulário invoke

Considere um serviço Web GetInterestRates que obtém o valor do empréstimo, a estabilidade e a pontuação de crédito do candidato como entrada e retorna um plano de empréstimo incluindo o valor da IME e a taxa de juros. Você cria um Modelo de dados de formulário (FDM) usando o serviço Web como uma fonte de dados. Você adiciona objetos de modelo de dados e um serviço get ao modelo de formulário. O serviço aparece na guia Serviços do modelo de dados de formulário (FDM). Em seguida, crie um Formulário adaptável que inclua campos de objetos de modelo de dados para capturar as entradas do usuário para valor do empréstimo, estabilidade e pontuação de crédito. Adicione um botão que aciona o serviço Web para buscar detalhes do plano. A saída é preenchida nos campos apropriados.

A regra a seguir mostra como configurar a ação Chamar serviço para realizar o cenário de exemplo.

Acionamento de várias ações usando a regra Quando triggering-multiple-actions-using-the-when-rule

Em um formulário de solicitação de empréstimo, você deseja registrar se o candidato ao empréstimo é um cliente existente ou não. Com base nas informações fornecidas pelo usuário, o campo ID do cliente deve mostrar ou ocultar. Além disso, é possível definir o foco no campo ID do cliente se o usuário for um cliente existente. O formulário de pedido de empréstimo tem os seguintes componentes:

Quando você escreve uma regra Quando no botão de opção para implementar esse comportamento, a regra é exibida da seguinte maneira no editor visual de regras.

Regra no editor visual

Na regra de exemplo, a instrução na seção When é a condição, que quando retorna True, executa as ações especificadas na seção Then.

Uso de uma saída de função em uma regra using-a-function-output-in-a-rule

Em um formulário de ordem de compra, você tem a tabela a seguir, na qual os usuários preenchem seus pedidos. Nesta tabela:

A. Linha1 B. Quantidade C. Quantidade Total

Agora, você deseja adicionar quantidades especificadas na coluna Quantidade do Produto para todos os produtos e exibir a soma na célula Quantidade Total. Você pode obter essa soma gravando uma regra Definir Valor de na célula Quantidade total, como mostrado abaixo.

Regra no editor visual

Validação de um valor de campo usando expressão validating-a-field-value-using-expression

No form ordem de compra explicado no exemplo anterior, você deseja impedir que o usuário faça pedidos de mais de uma quantidade de qualquer produto com preço superior a 10000. Para fazer essa validação, você pode gravar uma regra Validate como mostrado abaixo.

Regra no editor visual