Introdução ao Editor de regras na Criação do WYSIWYG
Este recurso está disponível através do programa de acesso antecipado. Para solicitar acesso, envie um email com o nome da sua organização GitHub e o nome do repositório do seu endereço oficial para aem-forms-ea@adobe.com. Por exemplo, se a URL do repositório for https://github.com/adobe/abc, o nome da organização é adobe e o nome do repositório é abc.
É possível adicionar um comportamento de formulário dinâmico usando o Editor de regras, que permite criar regras. Essas regras permitem visibilidade condicional de campo, automatizam cálculos com base na entrada do usuário e melhoram a experiência geral do usuário. Ao simplificar o processo de preenchimento de formulário, o Editor de regras ajuda a garantir precisão e eficiência.
O Editor de regras oferece uma interface visual intuitiva para criar e gerenciar regras. Sua abordagem amigável torna-o acessível a todos os usuários, mesmo aqueles sem extensa experiência técnica, permitindo-lhes implementar a lógica sem esforço dentro de suas formas.
Noções básicas sobre uma regra
As regras são instruções que orientam os usuários sobre quais ações executar em condições específicas.
-
Condição: uma condição é uma verificação ou regra que avalia se algo é verdadeiro ou falso. Ela responde à pergunta: "Isso atende aos requisitos?"
-
Ação: uma ação é o que acontece quando a condição é verdadeira. É a tarefa ou o comportamento acionado com base na avaliação da condição.
Uma regra normalmente segue uma das seguintes construções:
- Condition-Action: verifique uma condição primeiro e, em seguida, execute uma ação. No editor de regras, o tipo de regra
When
impõe a construçãocondition-action
. - Condição-ação: execute uma ação primeiro e, em seguida, verifique uma condição. Os tipos de regra
Set Value Of
eValidate
no editor de regras impõem a construçãoaction-condition
. - Ação-Condição-Alternativa: Execute uma ação, verifique uma condição e execute a ação principal ou uma ação alternativa com base na condição. Por exemplo, por padrão, a ação alternativa para
Show
éHide
, e paraEnable
éDisable
.
Por exemplo, uma condição pode verificar se um usuário inseriu um determinado valor em um campo e a ação pode ser mostrar ou ocultar um campo.
- Condição: verifique se a renda é superior a US$ 50.000.
- Ação: se a condição for verdadeira, mostrar o campo
Additional Deduction
; caso contrário, executar a ação alternativa: ocultar o campoAdditional Deduction
.
Para obter instruções detalhadas passo a passo, consulte adicionar uma regra condicional.
Como ativar a extensão do Editor de regras?
No Editor universal, a extensão Editor de regras não é ativada por padrão. Para habilitar a gravação da extensão do Editor de Regras em aem-forms-ea@adobe.com da sua ID de email oficial.
Depois que a extensão Editor de regras for habilitada para o seu ambiente, o ícone
Selecione o componente de formulário para o qual deseja gravar uma regra e clique no ícone
Neste artigo, form object
e form component
são usados alternadamente.
Agora, você pode começar a escrever regras ou lógica de negócios para o campo de formulário selecionado usando os tipos de regras disponíveis no Editor de regras.
Noções básicas sobre a interface do usuário do Editor de regras
O editor do Editor de regras é aberto quando você clica no ícone
Todas as regras existentes em um componente de formulário são listadas ao selecionar o componente. É possível exibir o título e uma pré-visualização do resumo da regra no Editor de regras. Além disso, você pode alterar a ordem das regras, editar regras, habilitar/desabilitar regras ou excluir regras.
Tipos de regras disponíveis
O Editor de regras fornece um conjunto de tipos de regras predefinidos que você pode usar para escrever regras, conforme exibido na tabela abaixo:
Agora, vamos explorar como gravar regras no Editor de regras.
Regras de gravação
Para entender como escrever regras no Editor de regras visuais, considere um exemplo simples de um formulário de cálculo de imposto:
No formulário descrito acima, o usuário informa o salário bruto. Com base nessa entrada, o campo condicional é exibido e o imposto a pagar é calculado.
Campos de formulário:
- Salário Bruto (entrada do usuário)
- Dedução Adicional (campo condicional)
- Receita Tributável (campo calculado)
- Imposto a Pagar (campo calculado)
Regra condicional:
- Condição: Salário Bruto > 50.000
- Ação: Mostrar o campo Dedução Adicional
Regras de Cálculo:
- Receita Tributável = Salário Bruto - Dedução Adicional (se aplicável)
- Imposto a Pagar = Receita Tributável * Alíquota de Imposto (para simplificar, suponha uma alíquota fixa de 10%)
Para gravar regras, execute as seguintes etapas:
1. Criar um formulário
Para criar um formulário no Universal Editor:
-
Abra um formulário no Universal Editor para edição.
-
Adicione os seguintes componentes de formulário:
- Formulário de Cálculo de Imposto (Título)
- Salário Bruto (Entrada de Número)
- Dedução Adicional (Entrada de Número)
- Receita Tributável (Entrada de Número)
- Imposto a Pagar (Entrada de Número)
- Enviar (Botão Enviar)
-
Oculte o campo de formulário
Additional Deduction
abrindo seuProperties
.
2. Adicionar uma regra condicional para um campo de formulário
Depois de criar o formulário, escreva a primeira regra para mostrar o campo Additional Deduction
somente se o salário bruto exceder $50.000. Para adicionar uma regra condicional:
- Abra um formulário no Editor Universal para edição e selecione o campo Salário Bruto na árvore de conteúdo e selecione
A interface visual do Editor de regras é exibida. - Clique em Criar para criar regras.
Por padrão, o tipo de regraSet Value Of
está selecionado. Embora não seja possível alterar ou modificar o objeto selecionado, você poderá usar o menu suspenso de regras para selecionar outro tipo de regra.
- Abra a lista suspensa tipo de regra e selecione o tipo de regra Quando.
- Selecione o menu suspenso Selecionar Estado e selecione é maior que. O campo Inserir um Número é exibido.
- Insira
50000
no campo Insira um Número na regra.
Você definiu a condição comoWhen Gross Salary is greater than 50000
. Em seguida, defina a ação a ser executada se esta condição forTrue
. - Na instrução
Then
, selecione Mostrar no menu suspenso Selecionar Ação.
- Arraste e solte o campo Dedução Adicional da guia Objetos de Formulário no campo Soltar objeto ou selecionar aqui. Como alternativa, selecione o campo Soltar objeto ou selecione aqui e selecione o campo Dedução Adicional no menu pop-up, que lista todos os objetos de formulário no formulário.
- Clique em Adicionar Seção Mais para adicionar outra condição ao campo Salário Bruto, caso insira um salário menor que
50000
.
- Selecione Ocultar no menu suspenso Selecionar Ação na instrução
Else
.
- Arraste e solte o campo Dedução Adicional da guia Objetos de Formulário no campo Soltar objeto ou selecionar aqui. Como alternativa, selecione o campo Soltar objeto ou selecione aqui e selecione o campo Dedução Adicional no menu pop-up, que lista todos os objetos de formulário no formulário.
- Selecione Concluído para salvar a regra.
A regra é exibida da seguinte maneira no Editor de regras:
3. Adicionar regras de cálculo para os campos de formulário
Em seguida, escreva uma regra para calcular o Taxable Income
, que é a diferença entre Gross Salary
e Additional Deduction
(se aplicável). Para adicionar uma regra de cálculo ao campo Receita Tributável, execute as seguintes etapas:
-
No modo de criação, selecione o campo Receita Tributável e selecione o ícone
-
Em seguida, selecione Criar para criar a regra.
-
Selecione Selecionar Opção e selecione Expressão Matemática. Um campo para escrever expressão matemática é aberto.
-
No campo de expressão matemática:
-
Selecione ou arraste e solte da guia Objeto do Forms o campo Salário Bruto no primeiro objeto Soltar ou selecione aqui.
-
Selecione Menos no campo Selecionar Operador.
-
Selecione ou arraste e solte da guia Objeto do Forms o campo Dedução Adicional no outro objeto Soltar ou selecione aqui.
-
-
Selecione Concluído para salvar a regra.
Agora, adicione uma regra para o campo
Tax Payable
, que é determinado pela multiplicação da receita tributável pela alíquota do imposto. Para simplificar, suponha uma alíquota de imposto fixa de10%
. -
No modo de criação, selecione o campo Imposto a Pagar e selecione o ícone
-
Selecione Selecionar Opção e selecione Expressão Matemática. Um campo para escrever expressão matemática é aberto.
-
No campo de expressão matemática:
-
Selecione ou arraste e solte da guia Objeto do Forms o campo Receita Tributável no primeiro objeto Soltar ou selecione aqui.
-
Selecione Multiplicado por no campo Selecionar operador.
-
Selecione Número no campo Selecionar Opção e insira o valor como
10
no campo Inserir um Número.
-
-
Em seguida, selecione na área destacada ao redor do campo de expressão e selecione Estender expressão.
-
No campo de expressão estendida, selecione dividido por no campo Selecionar Operador e Número no campo Selecionar Opção. Em seguida, especifique
100
no campo de número.
-
Selecione Concluído para salvar a regra.
4. Pré-visualizar um formulário
Agora, ao visualizar o formulário e inserir o Salário Bruto como 60,000
, o campo Dedução Adicional será exibido e a Renda Tributável e o Imposto a Pagar serão calculados adequadamente.
Além das funções prontas para uso como Sum, Average que estão listadas em Saída de funções, você pode gravar funções personalizadas para implementar lógicas de negócios complexas.
Função personalizada no editor de regras
O Edge Delivery Services Forms é compatível com funções personalizadas, que permitem aos usuários definir funções do JavaScript para implementar regras de negócios complexas. As funções personalizadas estendem os recursos dos formulários facilitando a manipulação e o processamento dos dados inseridos para atender a requisitos especificados.
Criar uma função personalizada
Para criar funções personalizadas, edite o arquivo ../[blocks]/form/functions.js
. O processo de criação geralmente envolve as seguintes etapas:
- Declaração de função: defina o nome da função e seus parâmetros (as entradas que ela aceita).
- Implementação lógica: escreva o código que descreve os cálculos ou manipulações específicos executados pela função.
- Exportação de Função: torne a função acessível em suas regras exportando-a do arquivo relevante.
Este exemplo demonstra duas funções personalizadas como getFullName
e days
:
/**
* Get Full Name
* @name getFullName Concats first name and last name
* @param {string} firstname in Stringformat
* @param {string} lastname in Stringformat
* @return {string}
*/
function getFullName(firstname, lastname) {
return `${firstname} ${lastname}`.trim();
}
/**
* Calculate the number of days between two dates.
* @param {*} endDate
* @param {*} startDate
* @name days Calculates the numebr of days between two dates
* @returns {number} returns the number of days between two dates
*/
function days(endDate, startDate) {
const start = typeof startDate === 'string' ? new Date(startDate) : startDate;
const end = typeof endDate === 'string' ? new Date(endDate) : endDate;
// return zero if dates are valid
if (Number.isNaN(start.getTime()) || Number.isNaN(end.getTime())) {
return 0;
}
const diffInMs = Math.abs(end.getTime() - start.getTime());
return Math.floor(diffInMs / (1000 * 60 * 60 * 24));
}
// eslint-disable-next-line import/prefer-default-export
export { getFullName, days };
Usar uma função personalizada no editor de regras
Para usar a função personalizada no Editor de regras:
-
Adicionar a Função: Inclua sua função personalizada no arquivo
../[blocks]/form/functions.js
. Lembre-se de adicioná-lo à instruçãoexport
no arquivo. -
Implantar o arquivo: implante o arquivo
functions.js
atualizado em seu projeto GitHub e verifique se a compilação foi bem-sucedida. -
Uso da Função: acesse a função no Editor de Regras do formulário selecionando a opção
Function Output
no campo Selecionar Ação. -
Visualizar o formulário: visualize o formulário com a função recém-implementada.
Informações adicionais
../[blocks]/form/functions.js
.Este artigo fornece informações limitadas sobre o Editor de regras disponível no Editor universal. Para saber mais sobre o Editor de regras e as funções personalizadas, consulte os seguintes artigos:
- Introdução ao Editor de regras para o Forms adaptável com base nos Componentes principais
- Tipos de operadores e eventos no editor de regras de um Formulário adaptável com base nos Componentes principais
- Interface do usuário do Editor de regras para o Forms adaptável com base nos Componentes principais
- Casos de uso diferentes do Editor de regras para um formulário adaptável baseado em componentes principais
- Diferença em várias edições do editor de regras
- Uso de funções assíncronas em um Formulário adaptável
- Aprimoramentos do Serviço de chamada no Editor de regras visuais para formulários com base nos Componentes principais
- Introdução às funções personalizadas para o Forms adaptável com base nos Componentes principais
- Criar uma função personalizada para um formulário adaptável com base nos Componentes principais
- Objeto de escopo em funções personalizadas
- Exemplos de desenvolvimento e uso de uma função personalizada
Consulte também:
- Criar O Primeiro Formulário Usando O Editor Universal
- Adicionar comportamento dinâmico ao Forms
- Configurar e personalizar ações de envio de formulário
- Publicar e implantar o Forms
- Design Beautiful Forms: guia de estilo e tema
- Criar componentes de formulário personalizados
- Proteja seu Forms contra spam: adicionando segurança ao reCAPTCHA