Introdução
O Microsiga Protheus® permite personalizações em qualquer um de seus ambientes por meio da criação de Pontos de Entrada e Templates.
Com o intuito de facilitar analises e permitir uma melhor administração das personalizações realizadas via Pontos de Entrada Pontos e Templates, foi disponibilizado o Catalogo de Personalizações que permite as seguintes ações:
- Visualizar os Pontos de Entradas e Templates implementados no ambiente;
- Desabilitar Pontos de Entradas e Templates para todo ambiente ou filiais especificas.
- Fixar valores de retornos para os Pontos de Entrada e Templates.
Por meio desse recurso garantimos maior controle e apoio em analises relacionadas a personalizações.
Importante
- O Catalogo de Personalizações se restringe apenas as personalizações de Pontos de Entrada e Templates, não influenciando na execução de Validações Customizadas, Gatilhos e outros tipos de personalizações;
- Apenas tem efeito em aplicações com ambiente preparado (ex.: login efetuado pelo usuário e RpcSetEnv).
Acessando o Catalogo de Personalizações
Esta funcionalidade pode ser acessada por meio do módulo Configurador (SIGACFG) e por padrão é disponibilizada por meio do menu Ambiente/Cadastros/Catalogo de Personalização.
Manutenção do Cadastro
O cadastro das personalizações ocorrerá de maneira automática sempre que uma rotina padrão ou customizada verificar a existência por meio das funções ExistBlock e ExistTemplate, de qualquer forma é permitido ao usuário antecipar este cadastro acessando a rotina Catálogo de Personalizações e clicando no botão +Incluir.
Será apresentada a tela de cadastro a seguir para preenchimento desejado:
O cadastro se divide em duas partes (Cabeçalho e Itens), onde no cabeçalho informamos os dados da personalização e na segunda parte (itens) definimos os comportamentos que poderão ser para todas as filiais e filiais especificas, abaixo podemos verificar o detalhamento de cada campo:
Cabeçalho:
- Função
- Deverá ser indicado o nome da função relativa ao Ponto de Entrada ou Template sem os indicativos "U_" ou "T_".
- Tipo de Função
- Indicar a opção "1 - ExecBlock" para Pontos de Entrada (User Function);
- Indicar a opção "2 - Template Function" para funções de Template (Template Function).
- Descrição
- Campo de livre preenchimento, normalmente informada a descrição do Ponto de Entrada;
- Nos cadastros realizados automaticamente, este campo é preenchido com a informação "Incluído automaticamente pelo sistema - [DATA DA INCLUSÃO]".
Itens:
Neste ponto, definimos o comportamento que queremos influenciar na personalização indicada.
- Filial
- Indicar a qual filial que deseja alterar o comportamento;
- Caso queira definir o comportamento em questão para todas, manter o campo sem preenchimento;
- Outras linhas poderão ser inseridas para definir comportamentos específicos para cada filial.
- Situação
- 1 - Habilitado: Indica que a personalização será executada normalmente pelo Protheus;
- 2 - Desabilitado: Indica que, mesmo compilada, a personalização não será executada;
- 3 - Retorno Padrão: Selecionada esta opção, o Protheus não executará a customização porém retornará o valor indicado no campo "Retorno padrão".
- Retorno Padrão
Instrução ADVPL a ser macro executada;
Este campo apenas terá influência sobre a personalização quando o campo "Situação" estiver indicado com a opção "3 - Retorno padrão".
Casos de Uso
Abaixo demonstramos quatro casos de uso desta funcionalidade para uma melhor compreensão:
Desabilitando o Ponto de Entrada LJ7001 em todas as filiais:
Pontos de Atenção
- Campo Filial em branco (aplicar para todas as filiais);
- Campo Situação com a opção "2 - Desabilitado" selecionado.
Com esta configuração o Ponto de Entrada não será executado (mesmo que compilado) em nenhuma filial.
Desabilitando o Ponto de Entrada LJ7001 apenas em uma filial:
Pontos de Atenção
- Campo Filial preenchido com a filial que deseja desabilitar;
- Campo Situação com a opção "2 - Desabilitado" selecionado;
Com esta configuração o Ponto de Entrada não será executado (mesmo que compilado) apenas na filial "D MG 01".
Habilitando o Ponto de Entrada LJ7001 apenas em uma filial:
Pontos de Atenção
- Necessário cadastrar uma linha para a filial que deseja manter o ponto de entrada habilitado
- Campo Filial preenchido com a filial que deseja manter habilitado o ponto de entrada (neste caso, a filial "D MG 01");
- Campo Situação com a opção "1 - Habilitado" selecionado;
- Necessário cadastrar uma linha para para indicar todas as filiais com o ponto de entrada desabilitado
- Campo Filial em branco (aplicar para todas as filiais);
- Campo Situação com a opção "2 - Desabilitado" selecionado.
Importante ressaltar que o sistema sempre priorizará registros exclusivos para a filial logada, por este motivo não é necessário cadastrar cada uma das demais filiais neste cenário.
Definindo um retorno fixo para o Ponto de Entrada LJ7001:
Pontos de Atenção
- Campo Filial em branco (podendo ser utilizado conforme os Casos de Usos anteriores);
- Campo Situação com a opção "3 - Retorno padrão" selecionado.
Neste cenário, independente da implementação do Ponto de Entrada, sempre que acionado será retornado o valor .T.