Como Fazer - Configurar Fórmula Visual para validar o preenchimento de um Campo Complementar

 

Introdução

Fórmula visual trata-se de uma funcionalidade que executa um fluxo de operações pré-definidas. O fluxo é definido pelo próprio usuário, que através desta ferramenta pode criar as seguintes operações:

- Obrigar o preenchimento de algum campo do sistema, por exemplo, campos complementares ou qualquer outro campo que o sistema não trate como obrigatório.

- Enviar emails, poderá ser criado uma Fórmula Visual que analisará o número de faltas de um funcionário em um determinado período e quando atingir um número excessivo de faltas poderá ser enviado um email para ele com algum alerta.

- Atualização de campos complementares, supondo que exista um campo complementar que guarde um limite de compras por fornecedor, e cada compra/pagamento realizado, este campo deve ser atualizado para liberar crédito ou diminuir o limite de compras. Esta operação poderá ser realizada pela Fórmula Visual de forma automatizada.

- Outras operações podem ser criadas. A ferramenta Fórmula Visual é capaz de atender diversas particularidades.

Neste documento estaremos abordando como definir o preenchimento OBRIGATÓRIO de um campo complementar. O campo complementar criado para este exemplo será o campo SANGUE, que guardará o tipo sanguíneo do funcionário.

1. Acessando o cadastro de Fórmula Visual Fig. 1 – Acessando o cadastro de Fórmula Visual

1. Acesse o módulo [Serviços Globais]. 2. Acesse a Ribbon [Gestão]. 3. Clique no ícone [Fórmula Visual] e escolha a opção [Fórmula Visual].

2. Cadastrando uma Fórmula Visual Fig. 2 - Cadastrando uma Fórmula Visual

Clique no botão [Novo], conforme a Fig. 1 e preencha os campos: [ID]: é o identificador da Fórmula Visual, é preenchido automaticamente pelo sistema [Nome]: é o nome da Fórmula Visual. Deve ser preenchido com um texto claro, que informa a finalidade da Fórmula Visual. [Descrição]: poderá ser preenchido ou não. É recomendável detalhar o funcionamento da fórmula visual neste campo.

[Visível para todas as coligadas]: este campo define se a Fórmula Visual estará visível em todas as coligadas, caso a opção esteja desmarcada, a Fórmula Visual poderá ser visualizada somente na coligada em que foi cadastrada.

[Ativo]: define se a fórmula visual estará ativa ou não.

[Categoria]: define a categoria da Fórmula Visual. Cada categoria possui perfis associado a ela, desta forma, somente usuários associados aos perfis poderão editar a Fórmula Visual.

[Fórmula Visual Pai]: define a hierarquia das Fórmulas Visuais. Através desta opção as fórmulas serão ordenadas como se fosse pasta e subpasta.

2.1 Informando os Gatilhos Fig. 3 – Definindo o Gatilho

Gatilho é o evento que dispara o fluxo das etapas da Fórmula Visual. Este evento é iniciado através de um ponto do sistema, que quando executado dispara a Fórmula Visual. Ao cadastrar uma Fórmula Visual, é necessário informar aonde a mesma será acionada. Seguindo o nosso exemplo de validar um campo complementar no Cadastro de Funcionários, vamos acionar a nossa Fórmula Visual Antes de Salvar o Registro na tela de Funcionários. 1. Clique na Aba [Gatilhos] 2. Selecione a opção [Antes de Salvar o Registro] 3. Clique no botão [Adicionar Objeto]. Será carregada uma nova janela, digite o nome do Cadastro que vai disparar a Fórmula Visual, no nosso caso, [Funcionário]. O sistema exibirá uma lista de cadastros relacionados aos funcionários. Selecione [Funcionário] do sistema [Folha de Pagamento].

3. Cadastrando as etapas da Fórmula Visual Fig. 4 – Visualizando a visão de Fórmula Visual

Até aqui, já cadastramos a Fórmula Visual e definimos qual o Cadastro é responsável por disparar a Fórmula Visual. Teremos agora, que cadastrar as atividades da Fórmula Visual. Para iniciar o cadastro, clique duas vezes sobre a Fórmula Visual cadastrada.

3.1 Inserindo a atividade [Se/senão] na Fórmula Visual Fig. 5 – Cadastrando as etapas da Fórmula Visual

Seguindo o nosso exemplo de validar o preenchimento do campo complementar SANGUE, necessitaremos trabalhar com as atividades [Se/Senão] e [Gerar Exceção]. As demais atividades poderão ser usadas em outras circunstâncias. A atividade [Se/Senão] será responsável por ler o campo SANGUE e verificar se o mesmo está NULO ou preenchido. A atividade [Gerar Exceção] será responsável por emitir uma mensagem ao usuário caso o campo SANGUE esteja NULO.

Para adicionar a atividade [Se/Senão] na Fórmula Visual, clique sobre a atividade e arraste para a Janela de Sequências da Fórmula Visual. Após liberar o mouse, a atividade será inserida. Note que foi formado o bloco [Se/Senão], que se divide nas atividades [Se] e [Senão].

Fig. 6 – Inserindo a atividade Se/Senão na Fórmula Visual

Fig. 7 – Editando as Propriedades da atividade Se/Senão.

Com a atividade devidamente inserida, devemos alterar as suas propriedades para definirmos o que será analisado pela referida atividade. Selecione o bloco [Se] e clique na aba [Propriedades]. Preencha os seguintes campos: [Condition] como sendo [Declarative Rule Condition] [Condition Name] defina um nome para a Condição. [Expression] defina a expressão da condição. Para definir esta expressão é necessário ter conhecimento mais técnico em Linguagem de Programação. Neste exemplo usaremos o seguinte código fonte: this.Tables["PFCOMPL"]["SANGUE"].IsNull

O código fonte acima está testando se o campo SANGUE da tabela PFCOMPL é NULO. Após preencher as propriedades do bloco [Se], clique em [Salvar]. Neste exemplo, não será necessário utilizar o bloco [Senão], pois se o campo SANGUE for preenchido não há necessidade de exibir nenhuma mensagem para o usuário, ou seja, o sistema continuará o seu fluxo normal permitindo a gravação do registro.

3.2 Inserindo a atividade [Gerar Excessão] na Fórmula Visual Fig. 8 – Inserindo a atividade Gerar Exceção na Fórmula Visual

Após inserir a atividade [Se/Senão], temos que adicionar a próxima atividade do nosso fluxo de etapas, que vai ser a geração de uma exceção. A exceção será exibida caso o resultado do bloco [Se], seja verdadeiro, ou seja, caso o campo SANGUE seja NULO, será exibida uma mensagem ao usuário. Para adicionar a atividade [Gerar Exceção], clique na atividade e arraste para dentro da atividade [Se]. Pelo layout acima que vai se formando com a inserção das atividades, é percebido que é montado um desenho com as etapas da Fórmula Visual criada.

Fig. 9 – Editando as Propriedades da atividade Gerar Exceção.

Assim como fizemos com a atividade [Se/Senão], devemos também, alterar as propriedades da atividade [Gerar Exceção], para isso, clique na atividade e posteriormente na aba [Propriedades]. Insira a mensagem que será exibida ao usuário, caso o campo SANGUE esteja sem preenchimento, na propriedade [Mensagem]. Informe a seguinte mensagem “O campo SANGUE é obrigatório. Favor preencher.” Ao final, clique em [Salvar]. Para o nosso exemplo, a Fórmula Visual está pronta. Para validar o preenchimento de um campo, basta utilizar as atividades [Se/Senão] e [Gerar Exceção]. O próximo passo é ativar a Funcionalidade Fórmula Visual no arquivo de Configuração do HOST.

4. Alterando o CONFIG do HOST.

Para que a Fórmula Visual seja executada com sucesso, é necessário ativar a tag WorkflowEnabled no arquivo de configuração do HOST, para isso, edite o arquivo RM.HOST.SERVICE.EXE.CONFIG, se o HOST está sendo executado como serviço ou RM.HOST.EXE.CONFIG, se o HOST está sendo executado como aplicativo e inclua a linha abaixo:

<add key="WorkflowEnabled" value="true" />

5. Verificando o funcionamento da Fórmula Visual.

Após realizar o cadastro da Fórmula Visual, aonde definimos:

- A partir de qual cadastro ela será acionada;
- Quais serão as atividades envolvidas;
- Parametrização das atividades e
- Configuração do arquivo de configuração do HOST.

Podemos agora, acessar o cadastro de funcionários e verificar se as nossas regras estão sendo aplicadas.

Fig. 10 – Alterando os campos complementares de um funcionário.

Note que a tela ao lado representa a edição dos campos complementares de um Funcionário. Nesta edição foram preenchidos alguns campos e o campo SANGUE foi deixado em branco. Ao clicar em [Salvar], foi exibida a mensagem abaixo informando que o campo é obrigatório.

Com a exibição da mensagem de obrigatoriedade do campo SANGUE, podemos concluir que a nossa Fórmula Visual foi cadastrada e executada com sucesso.

Fig. 11 – Visualizando mensagem retornada pela Fórmula Visual.

Neste pequeno exemplo, estamos verificando apenas o preenchimento de um campo complementar, mas poderíamos verificar todos os campos desta tela. A funcionalidade Fórmula Visual possibilita fazer várias customizações no sistema para as diversas situações que ocorrem no nosso dia a dia.

Aproveite esta funcionalidade para tornar o seu sistema mais completo, estável e seguro.