Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

...

Permite que o cliente crie regras para sugestão de informações com base em variáveis de acordo com o tipo de operação. Essa configuração é feita por empresa, estabelecimento e operação.  Este programa tem por objetivo implantar as regras da mesma forma que o programa CD0024.

Informações
titleImportante

Está sendo liberado na 12.1.2311 a versão do configurador de regras HTML com operações específicas do módulo de Recebimento de materiais.


Listagem de regras

Objetivo da tela:

Exibir a listagem das regras já existentes e disponibilizar as funcionalidades de: Incluir novas regras por meio de wizard Wizard, editar regras já existentes, excluir regras e sequenciar as regras.


Outras Ações/Ações RelacionadasColunas:

Ação:Coluna

Descrição:

Inclui

Quando acionado, é apresentada a tela Inclusão de Manutenção (CD0024A), por intermédio da qual é possível incluir uma nova operação.

Copiar/Mover Regras

Quando acionado, é apresentada a tela Copiar/Mover Regra (CD0024F), por intermédio da qual é possível copiar/mover as regras da do tipo de operação origem para o tipo de operação destino.

Incluir/Modificar

Quando acionado, é apresentada a tela Inclusão de Variável (CD0024B), por intermédio da qual é possível incluir/modificar variáveis da regra.

Eliminar

Quando acionado, é apresentada a tela solicitando a confirmação da eliminação da variável selecionada.

Inclusão de Operação

Objetivo da tela:

Permitir incluir uma nova regra.

Principais Campos e Parâmetros:

Empresa

Código da empresa da regra cadastrada.

Estab

Código do estabelecimento da regra cadastrada.

Operação

Código da operação da regra cadastrada. No caso do Wizard HTML caso a operação não estiver cadastrada, o próprio Wizard fará os cadastros de operação e variáveis necessárias antes de efetivar o cadastro da regra

Campo:

Descrição:

Empresa

Inserir o código da empresa utilizado para a regra que será cadastrada.

Estabelecimento

Inserir o código do estabelecimento utilizado para a regra que será cadastrada.

Tipo Operação

Selecionar o tipo de operação utilizado para a regra que será cadastrada.

Informações
titleImportante:

O cadastro de tipo de operação é realizado pelo programa Cadastro Tipo de Operação (CD0025).

Ao confirmar a inclusão, de acordo com o Tipo de Operação selecionada, serão geradas todas as variáveis relacionadas ao tipo de operação.

Na inclusão, caso seja cadastrado um tipo de operação já existente na empresa e estabelecimento iniciando com a sigla do documento. Exemplo: Inicialmente o tipo de operação era "nat-operacao" e o novo tipo de operação passa a ser "nfe-nat-oper", o sistema irá apresentar uma mensagem de alerta, informando que se confirmada o tipo de operação irá substituir o tipo de operação anterior. Com o novo tipo de operação cadastrado, a recepção de documentos via TOTVS Colaboração passará a utilizar esse novo conjunto de regras, desprezando as regras que constam na operação anterior. Devendo ser confirmado se deseja desprezar o anterior e cadastrar o novo tipo de operação ou não.

Relacionamentos

Selecionar o nível de cópia a ser realizado neste relacionamento. As opções disponíveis são:

  • Não copia dados: Quando selecionada, indica que serão copiados somente os campos da chave primária.

  • Variável: Quando selecionada, indica que serão copiados os campos da chave primária e também as variáveis.

  • Regra: Quando selecionada, indica que serão copiados os campos da chave primária, as variáveis e as regras.

  • Condição: Quando selecionada, indica que serão copiados os campos da chave primária, as variáveis, regras e condições.

  • Retorno: Quando selecionada, indica que serão copiados os campos da chave primária, as variáveis, regras, condições e retornos.

Informações
titleImportante:

As opções deste quadro somente serão habilitadas quando for acionado o botão Cópia da tela principal.

Inclusão de Variável

Objetivo da tela:

Permitir incluir o código da variável que será utilizada pela regra.

Principais Campos e Parâmetros:

Campo:

Descrição:

Variável

Inserir o código da variável que será utilizada pela regra.

Descrição

Inserir a descrição que identifica as características da variável que será utilizada pela regra.

Tipo Variável

Selecionar o tipo de variável que será utilizada pela regra. As opções disponíveis são:

  • Caracter;

  • Inteiro;

  • Decimal;

  • Lógico;

  • Data.

Configurador de Regras – Pasta Regra

Objetivo da tela:

Permitir configurar uma regra.

Outras Ações/Ações Relacionadas:

 

Ação:

Descrição:

Incluir/Modificar

Quando acionado, é apresentada a tela Inclusão de Regra (CD0024C), por intermédio da qual é possível incluir/modificar regras da regra.

Eliminar

Quando acionado, é apresentada a tela solicitando a confirmação da eliminação da regra selecionada.

Informações
titleImportante:

Não é possível eliminar uma regra que esteja em uso nas pastas Condição ou Retorno.

Inclusão de Regra

Objetivo da tela:

Permitir cadastrar uma regra.

Principais Campos e Parâmetros:

Campo:

Descrição:

Regra

Inserir o código numérico da regra.

Descrição

Inserir a descrição que identifica as características da regra.

Mover Regra

Objetivo da tela:

Permitir copiar/mover as regras do Tipo de Operação de Origem, para outro Tipo de Operação de Destino.

Nota
titleNota:

O sistema não permite que seja retirada uma regra pré-existente no destino.

Outras Ações/Ações Relacionadas:

 

Ação:

Descrição:

Inclui Todos

Quando assinalado, inclui todas as regras para o tipo de operação destino.

Inclui

Quando acionado, inclui a regra selecionada para o tipo de operação destino.

Retira

Quando acionado, retira a regra selecionada da operação destino.

Retira Todos

Quando acionado, retira todas as regras da operação destino.

Principais Campos e Parâmetros:

Campo:

Descrição:

Empresa

Selecionar a empresa do tipo de operação a ser considerada como destino. 

Estabel

Selecionar o estabelecimento do tipo de operação a ser considerada como destino.

Tipo Oper

Selecionar o tipo de operação a ser considerada como destino da movimentação/cópia de regras.

Copiar Regras

Quando assinalado, define que a regra deve ser copiada do tipo de operação de origem para o tipo de operação de destino.

Caso não assinalado, a regra será movida da origem para o destino.

Configurador de Regras – Pasta Condição

Objetivo da tela:

Permitir incluir/modificar as condições das regras.

Outras Ações/Ações Relacionadas:

 

Ação:

Descrição:

Incluir/Modificar

Quando acionado, é apresentada a tela Inclusão de Condição (CD0024D), por intermédio da qual é possível incluir/modificar condições da regra.

Informações
titleImportante:

Para incluir uma condição, é necessário selecionar a regra e após isso acionar o botão Incluir. 

Incluir funcionalidade para agrupamento de condições. Em alguns casos é necessária esta função para implantar uma determinada regra.

Eliminar

Quando acionado, é apresentada a tela solicitando a confirmação da eliminação da condição selecionada.

Agrupar Início

Selecionar a condição inicial e acionar o botão.

Agrupar Fim

Selecionar a condição final e acionar o botão. Ao acionar este botão todas as condições que estão entre a faixa inicial e final estarão destacadas em preto.

Desagrupar Regra

Quando acionado, em qualquer condição da faixa o agrupamento é desfeito.

Inclusão de Condição

Objetivo da tela:

Permitir inserir condições para as regras.

Principais Campos e Parâmetros:

Campo:

Descrição:

Sequência

Exibe a sequência numérica sugerida pelo sistema podendo ser alterada pelo usuário.

Variável

Selecionar a variável previamente cadastrada na pasta Variável e que será utilizada nesta condição.

Informações
titleImportante:

Somente será possível selecionar uma variável cadastrada para a empresa, estabelecimento e operação corrente.

Condição

Selecionar a condição a ser utilizada. As opções disponíveis são:

  • IGUAL A;

  • MAIOR QUE;

  • MENOR QUE.

Nota
titleNota:

Quando tipo da variável considerada for Lógico, somente é possível utilizar a condição IGUAL A.

Valor

Inserir/selecionar o valor com o qual a variável deverá ser comparada.

Nota
titleNota:

Esse campo tem o seu formato alterado de acordo com o tipo da variável que está sendo considerada. Quando o tipo da variável for Lógico, serão disponibilizadas as opções Verdadeiro/Sim e Falso/Não para seleção.

Operador

Selecionar o operador a ser utilizado. As opções disponíveis são:

  • E;

  • OU;

  • (Branco – Utilizado para a última condição da Regra).

Configurador de Regras – Pasta Retorno

Objetivo da tela:

Permitir cadastrar informações para que sejam retornadas, caso as condições desta regra sejam atendidas.

Outras Ações/Ações Relacionadas:

 

Ação:

Descrição:

Incluir/Modificar

Quando acionado, é apresentada a tela Inclusão de Retorno (CD0024E), por intermédio da qual é possível incluir/modificar retornos da regra.

Informações
titleImportante:

Para incluir um retorno, é necessário selecionar a regra como demonstra a figura acima e após isso acionar o botão Incluir.

Eliminar

Quando acionado, é apresentada a tela solicitando a confirmação da eliminação do retorno selecionado.

Inclusão de Retorno

Objetivo da tela:

Permitir cadastrar as informações que serão retornadas, caso as condições desta regra sejam atendidas.

Principais Campos e Parâmetros:

...

Campo:

...

Descrição:

...

Sequência

...

Exibe a sequência numérica sugerida pelo sistema podendo ser alterada pelo usuário.

...

Campo

...

Inserir a informação que define as características do retorno.

Nota
titleNota:

Na inclusão esse campo irá sugerir o mesmo valor definido para o tipo de operação.

...

Valor

...

Inserir o valor que será retornado.

...

% Rateio

...

Em algumas situações onde serão cadastrados mais de um registro de retorno pode ser necessário informar um percentual de rateio.

Informações
titleImportante:

No caso de uma compra, pode existir rateio de Unidades de Negócio, ou seja, será retornado mais de uma Unidade e estas serão gravadas no rateio.

...

Tipo Retorno

...

Selecionar o tipo de retorno a ser considerado. As opções disponíveis são:

  • Valor: Quando selecionada, indica que ao final da validação das condições serão retornados os valores cadastrados no folder Retorno.

  • Programa: Quando selecionada, indica que ao final da validação das condições será executado um programa que irá retornar os valores de retorno.

Informações
titleImportante:

Só poderão ser cadastrados retornos de um tipo, ou valores ou programa. Sendo que quando o tipo de Retorno for programa, só poderá ser incluído um registro.

Descrição operação

Descrição da operação do configurador de regras.
RegraCódigo da regra cadastrada.
Descrição regraDescritivo da regra, um texto para facilitar o entendimento do que faz a regra para quem estiver consultando a regra.
Retorno(s)Exibe os retornos possíveis para a regra, sendo exibido sempre o código do retorno mais o símbolo de igual '=' e conteúdo de retorno. Caso a regra tenha mais de um retorno, os mesmos são concatenados utilizando o caractere pipe '|'.
AçõesProporciona por meio de uma imagem o link direto para as ações de: Editar, Excluir, Sequenciar ou Filtrar as regras.
CondiçõesExibe as condições cadastradas para que o retorno da regra seja sugerida para o programa chamador.
Nome empresaNome da empresa. Essa coluna não fica visível por padrão.
Nome estabelecimentoNome do estabelecimento. Essa coluna não fica visível por padrão.


Busca rápida:

Permite a busca por parte de um código de operação (por exemplo, busca por 'nfe-nat-oper' ou 'nfe-nat'). Caso seja digitado um valor inteiro a busca será feita por código de regra (pode trazer várias regras caso tenham os mesmos códigos em diversas operações).


Busca avançada:

Permite a busca por faixas de Empresa, Estabelecimento, Operação e Regra.


Ações da página:

Ação

Descrição

Atualizar

Quando acionado, atualiza a listagem de regras conforme os filtros de busca rápida ou avançada informados.

Novo

Quando acionado, é apresentada a tela do Wizard de criação de regras para o configurador de regras.

Excluir

Quando acionado, é apresentada a mensagem solicitando a confirmação da eliminação da(s) regra(s) selecionada(s). Caso efetivada a exclusão serão eliminadas também as condições, os retornos daquela regra.

Wizard de inclusão de regra

Objetivo da tela:

Permitir a inclusão de uma nova regra por meio de Wizard.


Passos do Wizard - nova regra

Passo

Descrição

Passo 1 - Operação

Inserir ou selecionar por meio do zoom o código da operação a qual se pretende cadastrar a regra e o estabelecimento no qual aquela regra irá funcionar. A empresa será preenchida automaticamente conforme a empresa cadastrada para aquele estabelecimento informado.

Passo 2 - Retorno(s)

Informar o retorno ou os retornos caso seja uma operação que permite mais de um retorno. Para os retornos que são cadastros fica disponível o zoom para que seja informado o código do retorno conforme o cadastro do sistema.

Passo 3 - Condições

Informar as condições para que aquele retorno seja sugerido. Para isso é necessário selecionar uma variável no combo-box de variáveis e clicar no botão mais '+'. Ao adicionar essa variável a tela é possível selecionar ou informar manualmente os códigos que serão utilizados na criação de condições. Caso seja uma variável referente a um cadastro do sistema, é possível informar no zoom todos os códigos que devem ser considerados para que a regra seja escolhida. Caso a variável seja uma lista fixa também será possível selecionar as opções do sistema. Caso seja uma variável referente a algo que não existe cadastro, por exemplo: Descrição que veio no XML, ou Alíquota ICMS, será possível informar manualmente o conteúdo.

Ao selecionar diversos códigos dentro da mesma variável o sistema automaticamente irá criar condições com o operador "OU". Entre as variáveis será sugerido o operador "E" que faz mais sentido, porém, é possível que o usuário altere o operador para "OU" se assim desejar.

Para variáveis do tipo Data o mais viável e usual é o usuário informar uma faixa de datas, portanto, no Wizard só é possível informar faixa de datas.

Passo 4 - Finalizar

Nesse passo deve ser informada uma descrição para a regra que está sendo criada, é importante que essa descrição faça sentido para que outros usuários possam entender o objetivo da regra. Além disso devem ser conferidos os dados para que possam ser efetivados no sistema. Ao clicar em Confirmar o sistema irá salvar a regra, as condições e os retornos informados em tela, exibir o código da regra criada e redirecionar para a página de sequenciamento de regras, para que o usuário possa ajustar a posição da regra conforme sua necessidade.


Wizard de edição de regra

Objetivo da tela:

Permitir a edição de regra já existente por meio de Wizard.

Informações
titleImportante

O Wizard tem por finalidade auxiliar os usuários com menos experiência em cláusulas complexas. Portanto, existem restrições para a edição de regras com condições complexas.
Motivos para que uma regra não possa ser editada via wizard:
1 - Existe mais de um agrupamento de condições utilizando a mesma variável.
2 - Existem condições com variável tipo Data e operador igual (=), o wizard só permite faixa de datas (> ou <).
3 - Existem condições onde a variável não é do tipo Data, mas que utilizam o operador "menor que" (<) ou "maior que" (>).
4 - Existe algum código de variável informado na condição que não existe nos tipos de operação do sistema.
5 - O retorno da regra é do tipo programa ou fórmula.


Passos do Wizard - regra já existente

Passo

Descrição

Passo 1 - Operação

Fica desabilitado, não é possível alterar a operação e estabelecimento, se isso for necessário deve ser adicionada uma nova regra, eliminando a atual.

Passo 2 - Retorno(s)

Informar o retorno ou os retornos caso seja uma operação que permite mais de um retorno. Para os retornos que são cadastros fica disponível o zoom para que seja informado o código do retorno conforme o cadastro do sistema.

Passo 3 - Condições

Informar as condições para que aquele retorno seja sugerido. Para isso é necessário selecionar uma variável no combo-box de variáveis e clicar no botão mais '+'. Ao adicionar essa variável a tela é possível selecionar ou informar manualmente os códigos que serão utilizados na criação de condições. Caso seja uma variável referente a um cadastro do sistema, é possível informar no zoom todos os códigos que devem ser considerados para que a regra seja escolhida. Caso a variável seja uma lista fixa também será possível selecionar as opções do sistema. Caso seja uma variável referente a algo que não existe cadastro, por exemplo: Descrição que veio no XML, ou Alíquota ICMS, será possível informar manualmente o conteúdo.

Ao selecionar diversos códigos dentro da mesma variável o sistema automaticamente irá criar condições com o operador "OU". Entre as variáveis será sugerido o operador "E" que faz mais sentido, porém, é possível que o usuário altere o operador para "OU" se assim desejar.

Para variáveis do tipo Data o mais viável e usual é o usuário informar uma faixa de datas, portanto, no Wizard só é possível informar faixa de datas.

Passo 4 - Finalizar

Nesse passo pode ser alterada a descrição da regra, além disso devem ser conferidos os dados para que possam ser efetivados no sistema. Ao clicar em Confirmar o sistema irá salvar a regra, as condições e os retornos informados em tela.


Sequenciamento de regras

Objetivo da tela:

Permitir o sequenciamento das regras de uma determinada Operação por Empresa e Estabelecimento.

Exibe uma listagem com as regras daquela Empresa/Estabelecimento/Operação e possibilita o sequenciamento manual ou automático.

Na coluna de ações é possível mover as regras para baixo ou para cima e após os ajustes é possível salvar as alterações.

No caso do botão "Automático" o sistema irá realizar automaticamente o sequenciamento sempre observando a quantidade de variáveis utilizada na regra, regras com maior número de variáveis serão movidas para as primeiras sequências, caso as regras tenham o mesmo número de variáveis elas não serão movidas.


Conteúdos Relacionados:

Conteúdos Relacionados:

Utilizando Engine de Regras com Integrações EAI

Configurador de Regras para Tradução de Dados do XML (NF-e/NFS-e/CT-e)

Configurador de Regras para sugestão de Conta Transitória no Recebimento Fiscal Incluir PáginaHow To - MRE - Utilizando Configurador de Regras no Recebimento de XML no TOTVS ColaboraçãoHow To - MRE - Utilizando Configurador de Regras no Recebimento de XML no TOTVS Colaboração

Utilizando Engine de Regras com Integrações EAI