Gerenciamento de Regras Customizadas
Introdução
O gerenciamento de Regras Customizadas é uma utilidade do Data Proof que possui como objetivo conceder aos membros de um projeto a possibilidade de visualizar e controlar as propriedades de uma Regra Customizada.
Acessando o Painel de Gerenciamento de Regras Customizadas
O acesso ao painel de gerenciamento é através do botão Regras Customizadas, presente no menu lateral situado no lado esquerdo da tela, conforme demonstra a imagem abaixo.
Ao acessar a aba de Regras Customizadas, uma lista será exibida com todos as regras que o usuário pode visualizar ou modificar (caso possua permissão).
Gerenciando Regras Customizadas
Modificar alguma Regra Customizada sem o devido conhecimento pode ocasionar em irregularidades no processo de validação de dados. Tenha cautela ao realizar alterações.
Criando uma Regra Customizada da forma tradicional
Realizar esta tarefa requer a permissão especial Manage Configurations.
As regras customizadas são construidas e modificadas utilizando a linguagem de programação C#, conhecimentos em lógica de programação e desenvolvimento são importantes para garantir a integridade da validação.
A criação de uma Regra Customizada pode ser feita através da aba de Regras Customizadas, nela, basta clicar no botão Nova Regra Customizada, localizado no canto superior direito da tela, para abrir a interface de criação.
É possível escolher entre 2 tipos de Regras Customizadas, que são:
· Stateful: Regras que serão executadas no arquivo como um todo, permitindo a interação com diferentes Layouts e o armazenamento de valores em sessões durante a validação.
· Stateless: Regras que serão executadas em apenas um Layout alvo e seus campos, realizando validações que não exigem o armazenamento de informações.
Na interface de cadastro, também é possível escolher entre 2 formatos para a criação da regra: Código-Fonte e DLL. Na primeira opção, será possível realizar a criação da regra diretamente no editor de texto e até mesmo realizar o build do código, contudo, extras como intellisense, versionamento e testes unitários não serão recursos disponíveis. Na outra opção, a criação das regras deverá ser feita em um projeto do tipo Biblioteca de Classes e a DLL gerada ao compilar o projeto deverá ser enviada para o Data Proof através da interface de upload, disponível na própria tela de criação.
Para regras feitas no próprio editor do Data Proof, deve-se seguir as instruções presentes no arquivo modelo, que contém todas as informações que serão relevantes para garantir o funcionamento da mesma.
Caso o formato escolhido para o desenvolvimento da regra seja DLL, é necessário adicionar a biblioteca LayoutValidator.CustomRuleTemplate como dependência da regra e utilizar a interface adequada para o tipo de regra desejada.
· Stateful: A interface ICustomRule deve ser implementada na classe da regra;
· Stateless: A interface ICustomCode deve ser implementada na classe da regra.
A versão do projeto de biblioteca de classes deve ser equivalente a versão utilizada do Data Proof. Para a versão antiga, usa-se o .NET Core 3.1 e, para a nova, o .NET 8.
A versão desejada da biblioteca de Regras Customizadas pode ser baixada clicando no link a seguir: Versão Antiga ou Versão Nova Após o download, basta extrair o arquivo .dll e vinculá-lo ao projeto desejado.
Após a customização da regra, o arquivo deve ser enviado para a ferramenta através do utilitário de upload ou inserção direta na pasta Rules, localizada na pasta do Site.
Diversas regras customizadas podem ser incluídas em um único projeto, e, portanto, estarem associadas ao mesmo arquivo .DLL. Por isso, é importante inserir corretamente o nome da classe alvo onde a validação correspondente a regra está para que a mesma seja executada.
Para confirmar a criação, clique no botão Salvar, presente no canto inferior da interface.
Criando uma Regra Customizada através de IA
É possível criar Regras Customizadas utilizando a ferramenta de inteligência artificial do Data Proof, simplificando o processo de codificação e diminuindo a probabilidade de erros, além de aumentar a produtividade. Para realizar isso, é necessário marcar a opção Gerar com IA, presente no formato Código fonte de regra.
Ao clicar no botão, a interface será alterada e basta apenas inserir os detalhes da regra de negócio de forma específica e detalhada no campo, e clicar no botão Gerar Regra Customizada.
Com isso, a regra será gerada e basta apenas conferir se está coerente com a validação desejada.
Para confirmar a criação, clique no botão Salvar, presente no canto inferior da interface.
Editando Informações de uma Regra Customizada
Realizar esta tarefa requer a permissão especial Manage Configurations.
É possível manipular as informações de uma Regra Customizada clicando diretamente no item desejado, presente na lista de regras.
Uma interface será aberta com os dados da Regra Customizada selecionada, que poderão ser modificados conforme desejar.
Para confirmar as alterações, clique no botão Salvar, presente no canto inferior da interface.
Ao realizar altera ções nas regras do formato DLL, o arquivo DLL deve ser enviado novamente para o Data Proof e os módulos FileBreaker e ValidationWorker devem ser reiniciados.
Excluindo uma Regra Customizada
Realizar esta tarefa requer a permissão especial Manage Configurations.
É possível excluir uma Regra Customizada clicando no botão Excluir Regra, presente na interface de detalhes de uma regra.
Uma interface será aberta confirmando a ação.
