Log de Operações da Nota Fiscal de Saída

1) Contextualização

• O recurso realiza o log de diversas operações efetuadas na Nota Fiscal de Saída, permitindo a rastreabilidade dessas operações e fornecendo insumos para a análise de cenários ou investigação de erros, por parte da equipe de Manutenção e/ou de Suporte.
• O recurso também pode ser utilizado como Log de auditoria, com tempo de expiração limitado, conforme será visto posteriormente.

Abaixo segue a lista de Operações efetuadas na Nota Fiscal de Saída que a rotina possibilita mapear:

• Inclusão;
• Alteração;
• Exclusão;
• Fechamento;
• Emissão;
• Operações Eletrônicas;
• Reabilitação;
• Cancelamento.

Abaixo segue a lista de Operações Eletrônicas efetuadas na Nota Fiscal de Saída que a rotina possibilita mapear:

• Emissão;
• Inutilização;
• Carta de Correção Eletrônica;
• Evento de Cancelamento;
• Comprovante de Entrega;
• Cancelamento de Comprovante de Entrega;
• Registro de Saída;
• Cancelamento de Registro de Saída;

Em qual versão o recurso está disponível?

O recurso sofreu diversas correções e melhorias em versões próximas às versões 5.10.3.124 e 5.10.4.70. Por esse motivo, a recomendação da Senior é que o recurso seja utilizado com o sistema atualizado, ou seja, com alguma das versões descritas, ou versões posteriores.

É importante estar com o sistema atualizado para que o log contemple todas as interfaces (telas, web service, processos automáticos) e também para que a higienização da tabela de log ocorra corretamente, evitando lentidão na geração das notas fiscais de saída.

Além disso, nas versões mencionadas anteriormente, o sistema foi alterado para utilizar tabelas nativas (E140LOP - Notas Fiscais) para a geração dos logs, e não mais tabelas de usuário, o que facilita muito a adesão e implementação do recurso de logs nos clientes.

Para conhecimento

• A cada tentativa de log, o sistema verifica o valor do parâmetro global que habilita a rotina na Base de Dados, nunca em memória. Isso foi feito para que seja possível habilitar/desabilitar o recurso sem a necessidade de reiniciar o sistema/middleware.
• O comando executado pelo sistema para verificar se o recurso está ativo segue abaixo. Nenhum campo da consulta deve ser alterado:

SELECT VLRCMP

FROM E000PXF

WHERE CODEMP = 0

AND CODFIL = 0

AND CODUSU = 0

AND IDFFRM = '$PARAMETROS_GLOBAIS_SAPIENS$'

AND CMPFRM = 'GerLogNfs'

• O resultado da consulta com valor “S - Sim” indica que o recurso está ativo.
• Qualquer outro valor diferente de “S - Sim” ou mesmo a não existência do registro indicam que o recurso está inativo.

2) Novas necessidades e/ou sugestões

• Novas operações, tanto para as Operações efetuadas na Nota Fiscal de Saída, como para as Operações Eletrônicas, podem ser implementadas mediante necessidade de monitoramento elencadas pela equipe de Manutenção e/ou Suporte.
• Sugestões para tornar o recurso mais versátil também são bem vindas.
• Existindo a necessidade de efetuar o Log de outras rotinas, como por exemplo: Pedidos, Cargas, Notas de Entrada, basta entrar em contato com o suporte ou manutenção que estes irão analisar a viabilidade.

3) Clientes que já utilizavam o recurso

• Clientes que já utilizam o recurso de log de operações da nota fiscal de saída devem desabilitá-lo via parâmetro global e adequar a tabela de usuário à nova estrutura que será apresentada nesse documento.
• Caso não seja feita essa adequação da tabela, então certamente ocorrerá o seguinte aviso na entrada do sistema:
  “Erro na leitura do parâmetro global de sistema ‘GerLogNfs’: Valor ‘S’ inválido para o parâmetro global de sistema ‘GerLogNfs’: Não foi possível habilitar o log de operações da Nota Fiscal de Saída: A estrutura da tabela ‘USU_T140NFVLOG’, necessária para o log de operações da Nota Fiscal de Saída não está coerente. Pode-se desabilitar o log por meio do parâmetro ‘GerLogNfs’ na tela F000PGS. "
• Ao atualizar o sistema para as versões 5.10.3.124 e 5.10.4.70 ou posteriores, o sistema terá seus logs gravados em tabelas nativas, não sendo necessário criar nenhuma tabela/campos de usuário.

4) Erros durante o uso do recurso

• Caso ocorra algum erro durante a gravação do log, isso poderá impedir alguma operação efetuada na Nota Fiscal de Saída. Nesse cenário o sistema exibirá uma mensagem referenciando a tabela USU_T140NFVLOG e/ou o Parâmetro Global GerLogNfs, conforme exemplo apresentado abaixo:

“A estrutura da tabela USU_T140NFVLOG, necessária para o log de operações da nota fiscal de saída não está coerente. Pode-se desabilitar o log por meio do parâmetro ‘GerLogNfs’ na tela F000PGS”.

• Havendo urgência na continuidade de uso do sistema, pode-se desabilitar o parâmetro global até que a base de dados esteja adequada à nova estrutura, ou até que o erro que impede a gravação do log seja corrigido. Para desabilitar a funcionalidade basta acessar a tela Manutenção dos parâmetros globais do sistema (F000PGS) e atribuir “N - Não” ao parâmetro global GerLogNfs.

4.1) Como desabilitar o recurso de log em emergências

• O recurso deve ser desabilitado mediante a alteração do Parâmetro Global por meio da tela Manutenção dos parâmetros globais do sistema (F000PGS). Em emergências, caso não seja possível acessar essa tela, pode-se desabilitar o recurso de log por meio do comando SQL de Update abaixo:

UPDATE E000PXF

SET VLRCMP = 'N'

WHERE CODEMP = 0

AND CODFIL = 0

AND CODUSU = 0

AND IDFFRM = '$PARAMETROS_GLOBAIS_SAPIENS$'

AND CMPFRM = 'GerLogNfs'

5) Habilitando o recurso

• Para habilitar o recurso de log de operações da nota fiscal de saída deve-se seguir alguns passos, que seguem enumerados e descritos abaixo:

6) Configurando o sistema

6.1) Acessar a tela Manutenção dos parâmetros globais do sistema (F000PGS) e atribuir “S - Sim” ao parâmetro global GerLogNfs:

• Na tela Manutenção dos parâmetros globais do sistema (F000PGS), carregar o Parâmetro Global GerLogNfs e alterar o valor dele para “S - Sim”.
• O sistema somente permitirá a mudança do parâmetro caso a tabela de usuário exista e contenha todos os campos necessários para que o recurso funcione corretamente. Caso houver alguma inconsistência na estrutura da tabela, então o parâmetro não será alterado e o recurso não será habilitado.

6.2) Acessar a tela Parâmetros da Filial para Vendas (F070FVE) e inserir/alterar o parâmetro dinâmico NOTAFISCALSAIDA.LOG.OPERACOES:

• Acessar a tela Parâmetros da Filial para Vendas (F070FVE) e carregar a filial onde deseja aplicar os Parâmetros Dinâmicos;
• Na canto inferior esquerdo o clicar no botão Par. Dinâmico;
• A tela Configuração de parâmetros dinâmicos (F000PPD) será aberta.

6.3) Na tela Configuração de parâmetros dinâmicos (F000PPD) configurar as operações que podem efetuar log:

• O sistema abrirá a tela Configuração de parâmetros dinâmicos (F000PPD) ao clicar no botão Par. Dinâmico da tela Parâmetros da Filial para Vendas (F070FVE);
• Criar ou Alterar o Parâmetro Dinâmico NOTAFISCALSAIDA.LOG.OPERACOES .
• Para habilitar as operações deve-se seguir a tabela abaixo, informando uma ou mais de uma opção, conforme necessidade. As Operações inseridas devem estar separadas por vírgula, por exemplo: I,A,E,F.

6.4) Operações Disponíveis:

• I - log de Inclusão;

Indica que o sistema deve logar toda inclusão dos Dados Gerias das Notas Fiscais de Saída.

• A - log de Alteração;

Indica que o sistema deve logar toda alteração realizada nos Dados Gerias da Nota Fiscal de Saída.

• D - log de Depuração;

Indica que o sistema deve logar os pontos de depuração existentes na Nota Fiscal de Saída.

• E - log de Exclusão;

Indica que o sistema deve logar toda exclusão de Nota Fiscal de Saída.

• F - log de Fechamento;

Indica que o sistema deve logar todo fechamento de Nota Fiscal de Saída.

• M - log de Emissão;

Indica que o sistema deve logar toda emissão de Documentos Eletrônicos de Notas Fiscais de Saída.

• L - log de Operações Eletrônicas;

Indica que o sistema deve logar todas as Operações Eletrônicas executadas nas Notas Fiscais de Saída.

• R - Habilita o Identificador de Regras VEN-140LOGNF01.

Indica que o sistema pode invocar o identificador de regras VEN-140LOGNF01 a cada geração de log que for efetuada;

• C - Cancelamento de Nota Fiscal de Saída.

Indica que o sistema deve logar todo cancelamento de Nota Fiscal de Saída.

• B - Reabilitação de Nota Fiscal de Saída.

Indica que o sistema deve logar toda reabilitação de Nota Fiscal de Saída.

Identificador de regras VEN140LOGNF01

A rotina de log de operações da Nota Fiscal de Saída disponibiliza um ponto de regra para ser utilizado da forma como for necessário. Para que o identificador execute é necessário que exista a opção “R” cadastrada no parâmetro dinâmico NOTAFISCALSAIDA.LOG.OPERACOES da filial da empresa que estiver gerando o documento. Em 99,99% dos casos a empresa/filial do documento é também a empresa/filial logada.

Para conhecimento

• A cada tentativa de log o sistema verifica o valor do identificador de regras na base, nunca em memória. Isso foi feito para que seja possível habilitar/desabilitar o recurso sem a necessidade de reiniciar o sistema/middleware.
• O comando executado pelo sistema para verificar se o recurso está ativo segue abaixo. Nenhum campo da consulta deve ser alterado:

SELECT CODREG, SITREG

FROM E098REG

WHERE MODSIS = 'VEN'

AND IDEREG = '140LOGNF01'

AND SITREG = 'A';

• O resultado da consulta com valor maior do que zero para o campo CODREG e valor “A” para o campo SITREG indicam que o recurso está ativo.
• Valor zero para o campo CODREG ou valor “I” para o campo SITREG indicam que o identificador está inativo.

7.1) Como desabilitar o Identificador de Regras em emergências.

• O Identificador deve ser desabilitado mediante a alteração da situação dele por meio da tela Cadastro de Identificador de Regras (F098REG). Em emergências, caso não seja possível acessar essa tela, pode-se desabilitar o Identificador por meio do comando SQL de Update abaixo:

UPDATE e098reg

SET SITREG = 'I'

WHERE CODEMP = Informe o Código da Empresa aqui.

AND MODSIS = 'VEN'

AND IDEREG = '140LOGNF01'

7.2) Variáveis disponíveis no identificador:

• A regra associada ao identificador de regras recebe valor para as variáveis descritas abaixo:

Nome: VLOP_ADescricaoLog
Descrição: Descrição Sobre o Log.
Retorna Valor: Não;
Tipo: Alfa;

Nome: VLOP_NCodEmp
Descrição: Código da empresa logada no ERP
Retorna Valor: Não
Tipo: Numero

Nome: VLOP_NCodFil;
Descrição: Código da filial logada no ERP;
Retorna Valor: Não;
Tipo: Numero.

Nome: VLOP_NUsuario;
Descrição: Código do usuário logado no ERP;
Retorna Valor: Não;
Tipo: Numero.

Nome: VLOP_AUsuario_ERP;
Descrição: Nome do usuário logado no ERP;
Retorna Valor: Não;
Tipo: Alfa.

Nome: VLOP_AOrigem;
Descrição: Origem da execução;
Retorna Valor: Não;
Tipo: Alfa.

Nome: VLOP_AOrdemOperacao
Descrição: Ordem de Execução da Operação.
Valores Possíveis: Antes, Durante, Depois, Nenhuma;
Retorna Valor: Não;
Tipo: Alfa;

Nome: VLOP_AOperacao;
Descrição: Operação executada;
Retorna Valor: Não;
Tipo: Alfa.

Nome: VLOP_AObservacao;
Descrição: Observação da operação;
Retorna Valor: Não;
Tipo: Alfa.

Nome: VLOP_NRotina;
Descrição: Número da rotina em execução (Processo Automático);
Retorna Valor: Não;
Tipo: Numero.

Nome: VLOP_AWebservice;
Descrição: Web service em execução;
Retorna Valor: Não;
Tipo: Alfa.

Nome: VLOP_NTransacoes;
Descrição: Transações em aberto;
Retorna Valor: Não;
Tipo: Numero.

Nome: VLOP_NConexao;
Descrição: Código da conexão;
Tipo: Numero;
Retorna Valor: Não.

Nome: VLOP_AComputador;
Descrição: Nome do computador;
Retorna Valor: Não;
Tipo: Alfa.

Nome: VLOP_AUsuario_SO;
Descrição: Usuário do sistema operacional;
Retorna Valor: Não;
Tipo: Alfa.

Nome: VLOP_ARegra;
Descrição: Variável de retorno do identificador de regras;
Essa é a única variável do Identificador de Regras que permite o retorno de valor.
O valor informado nessa variável será gravado no campo USU_REGRA da tabela USU_T140NFVLOG.
A quantidade máxima de caracteres suportada pelo campo é 999.
Retorna Valor: Sim;
Tipo: Alfa.

Nome: VLOP_APermiteExecutar
Descrição: Variável que permite retornar valor ao sistema informando se Permite ou não gerar o Log para o documento atual.
Valores possíveis: “S” ou “N”;
Valor Padrão: “S”;
Retorna Valor: Sim;
Tipo: Alfa;

Nome: VLOP_AObservacaoDep
Descrição: Observação de Depuração.
Também pode ser utilizada quando o Log for gerado através das Funções de Programadores em LSP.
Retorna Valor: Não;
Tipo: Alfa;

Nome: VLOP_Nfv_NEmpNfv;
Descrição: Código da empresa da nota fiscal de saída;
Tipo: Numero;
Retorna Valor: Não;

Nome: VLOP_Nfv_NFilNfv;
Descrição: Código da filial da nota fiscal de saída;
Tipo: Numero;
Retorna Valor: Não;

Nome: VLOP_Nfv_ASnfNfv;
Descrição: Código da série da nota fiscal de saída;
Tio: Alfa;
Retorna Valor: Não.

Nome: VLOP_Nfv_AAbrNfv;
Descrição: Abrangência de notas fiscais de saída;
Tipo: Alfa;
Retorna Valor: Não

7.3) Variáveis devolvidas pelo identificador

• O identificador de regras permite devolver ao sistema valor para a variável VLOP_ARegra. Essa é a única variável do Identificador de Regras que permite o retorno de valor.
• O valor devolvido nessa variável será gravado no campo USU_REGRA da tabela USU_T140NFVLOG.
• A quantidade máxima de caracteres suportada pelo campo é 999.

7.4) Exemplo de regra para o identificador

Definir Numero VLOP_NCodEmp;

Definir Numero VLOP_NCodFil;

Definir Numero VLOP_NUsuario;

Definir Alfa VLOP_AUsuario_ERP;

Definir Alfa VLOP_AOrigem;

Definir Alfa VLOP_AOperacao;

Definir Alfa VLOP_AObservacao;

Definir Numero VLOP_NRotina;

Definir Alfa VLOP_AWebservice;

Definir Numero VLOP_NTransacoes;

Definir Numero VLOP_NConexao;

Definir Alfa VLOP_AComputador;

Definir Alfa VLOP_AUsuario_SO;

Definir Alfa VLOP_ARegra;

Definir Numero VLOP_Nfv_NEmpNfv;

Definir Numero VLOP_Nfv_NFilNfv;

Definir Alfa VLOP_Nfv_ASnfNfv;

Definir Alfa VLOP_Nfv_AAbrNfv;

Definir Alfa VAEmpNfv;

IntParaAlfa(VLOP_Nfv_NEmpNfv, VAEmpNfv);

Definir Alfa VAFilNfv;

IntParaAlfa(VLOP_Nfv_NFilNfv, VAFilNfv);

Definir Alfa VAMensagem;

VAMensagem = "Empresa: " + VAEmpNfv + " Filial: " + VAFilNfv + " Serie: " +

VLOP_Nfv_ASnfNfv + " Numero/s: " + VLOP_Nfv_AAbrNfv;

VLOP_ARegra = VAMensagem;

x = y;

8) Limpeza periódica de registros da tabela de log

• A limpeza dos registros é feita pelo próprio recurso de log, não sendo necessária qualquer configuração ou intervenção manual, seja por parte da TI do cliente e/ou da Senior.
• A cada registro de log que é inserido na base o sistema limpa a tabela, eliminando os registros com idade maior ou igual a 30 dias. Essa quantidade de dias é o padrão do sistema. Essa quantidade de dias pode ser alterada, mas a configuração deve estar entre um intervalo de 30 até 60 dias.

8.1) Configuração da Limpeza de Registros da tabela de Log

• A configuração da Limpeza de Registro pode ser feita por meio de um Parâmetro Dinâmico.
• Será necessário acessar a tela Parâmetros da Filial para Vendas (F070FVE) e inserir o Parâmetro Dinâmico NOTAFISCALSAIDA.LOG.OPERACOES.DIAS.
• O valor informado ao Parâmetro Dinâmico deve estar em 0 e 60 dias.
• Caso seja informado um valor menor que 0 dias, o sistema utilizará o valor de 30 dias.
• Caso seja informado um valor maior que 60 dias, o sistema utilizará o valor de 60 dias.
• Caso Parâmetro Dinâmico NOTAFISCALSAIDA.LOG.OPERACOES.DIAS não exista, o sistema utilizará o valor de 30 dias.

8.2) A limpeza pode gerar lentidão?

• A limpeza não deve causar lentidão, mesmo em cenários de clientes com grande volume de notas, como, por exemplo, em um cliente com geração de 20 mil notas/dia. Nesse cenário teríamos no mínimo 600 mil registros gerados em um mês na tabela de log. Ao deletar os registros o sistema eliminaria apenas a quantidade de registros que passou de 30 dias (20 mil registros) e não os 600 mil registros.

Como utilizar o log em rotinas com identificadores de regras e/ou regras LSP usando a função Gerar_Log_NotaSaida

Para registrar logs em rotinas que utilizam identificadores de regras ou regras LSP, utilize a função de programador Gerar_Log_NotaSaida. Essa função permite ao usuário registrar manualmente informações relevantes durante a execução da regra associada, com foco especial em operações relacionadas à saída de notas fiscais.

Principais pontos:

• A função Gerar_Log_NotaSaida deve ser chamada dentro da rotina da regra que você deseja monitorar;
• O log é registrado manualmente pelo usuário, possibilitando o acompanhamento detalhado de eventos ocorridos durante o processo de saída de notas fiscais.

Referência:

Para mais detalhes sobre a função, consulte a documentação correspondente.

Exemplo de uso:

Abaixo está um exemplo de regra que utiliza a função de programador para geração de log de saída de nota fiscal:

Gerar_Log_NotaSaida(1, 1, "1", "10001,10002,10003", ”Execução do Fechamento da Nota Fiscal de Saída”, "F140NFV", "A", "Log gerado via regra de validação VEN-140LOGNF01");