Boletim Tcnico

JOB para Cancelamento de NFe (Job FatJobNFe)

Produto

Microsiga
Protheus Faturamento - Verso 11
:

Chamado

THJBHP
:

Data da publicao

24/01/14
:

Pas(es)

Brasil
:

Banco(s) de Dados

Todos
: - DBAccess

Esta melhoria depende de execuo do update de base

para Implementao.

UpdFATNFE, conforme Procedimentos

Implementada melhoria no Faturamento (SIGAFAT) para efetivar o cancelamento de Notas Fiscais (NFe Modelo 55) somente aps a autorizao do cancelamento pela SEFAZ.
Esta operao pode ser feita por execuo de JOB, ou por refresh na tela da rotina Cancelamento de nota fiscal
de sada.
Ao efetuar esta configurao, executa-se o processo de estorno a cada n minutos (tempo pr-definido).
Para viabilizar essa melhoria, aplique o pacote de atualizaes (Patch) deste chamado e executar o
compatibilizador UpdFATNFE.

Procedimento para Implementao

Antes de executar o update/compatibilizador UpdFATNFE imprescindvel:

a)

Realizar o backup da base de dados do produto que ser executado o compatibilizador (diretrio
\PROTHEUS11_DATA\DATA) e dos dicionrios de dados SXs (diretrio \PROTHEUS11_DATA\SYSTEM).

b)

Os diretrios acima mencionados correspondem instalao padro do Protheus, portanto, devem ser
alterados conforme o produto instalado na empresa.
1

SIGAFAT JOB para Cancelamento de NFe (Job FatJobNFe)

Boletim Tcnico

c)

Essa rotina deve ser executada em modo exclusivo, ou seja, nenhum usurio deve estar utilizando o
sistema.

d)

Se os dicionrios de dados possurem ndices personalizados (criados pelo usurio), antes de executar o
compatibilizador, certifique-se de que esto identificados pelo nickname. Caso o compatibilizador
necessite criar ndices, ir adicion-los a partir da ordem original instalada pelo Protheus, o que poder
sobrescrever ndices personalizados, caso no estejam identificados pelo nickname.

e)

O compatibilizador deve ser executado com a Integridade Referencial desativada*.

O procedimento a seguir deve ser realizado por um profissional qualificado como Administrador
de Banco de Dados (DBA) ou equivalente!
A ativao indevida da Integridade Referencial pode alterar drasticamente o relacionamento
entre as tabelas no Banco de Dados. Portanto, antes de utiliz-la, observe atentamente os
procedimentos a seguir:
i. No Configurador (SIGACFG), veja se a empresa utiliza Integridade Referencial,
selecionando a opo Integridade/Verificao (APCFG60A).
ii. Se no h Integridade Referencial ativa, so relacionadas em uma nova janela todas as
empresas e filiais cadastradas para o sistema e nenhuma delas estaro selecionadas.
Neste caso, E SOMENTE NESTE, no necessrio qualquer outro procedimento de
ativao ou desativao de integridade, basta finalizar a verificao e aplicar
normalmente o compatibilizador, conforme instrues.
iii. Se h Integridade Referencial ativa em todas as empresas e filiais, exibida uma
mensagem na janela Verificao de relacionamento entre tabelas. Confirme a mensagem
para que a verificao seja concluda, ou;
iv. Se h Integridade Referencial ativa em uma ou mais empresas, que no na sua
totalidade, so relacionadas em uma nova janela todas as empresas e filiais cadastradas
para o sistema e, somente, a(s) que possui(em) integridade estar(ro) selecionada(s).
Anote qual(is) empresa(s) e/ou filial(is) possui(em) a integridade ativada e reserve esta
anotao para posterior consulta na reativao (ou ainda, contate nosso Help Desk
Framework para informaes quanto a um arquivo que contm essa informao).
v. Nestes casos descritos nos itens iii ou iv, E SOMENTE NESTES CASOS, necessrio
desativar tal integridade, selecionando a opo Integridade/Desativar (APCFG60D).
vi. Quando desativada a Integridade Referencial, execute o compatibilizador, conforme
instrues.
SIGAFAT JOB para Cancelamento de NFe (Job FatJobNFe)

Boletim Tcnico

vii. Aplicado o compatibilizador, a Integridade Referencial deve ser reativada, SE E SOMENTE

SE tiver sido desativada, atravs da opo Integridade/Ativar (APCFG60). Para isso, tenha
em mos as informaes da(s) empresa(s) e/ou filial(is) que possua(m) ativao da
integridade, selecione-a(s) novamente e confirme a ativao.
Contate o Help Desk Framework EM CASO DE DVIDAS!

1.

Em Microsiga Protheus Smart Client, digite UpdFATNFE no campo Programa Inicial.

Para a correta atualizao do dicionrio de dados, certifique-se que a data do update/compatibilizador seja
igual ou superior a 07/01/14.
2.

Clique em OK para continuar.

3.

Aps a confirmao exibida uma tela para a seleo da empresa em que o dicionrio de dados ser
modificado ou apresentada a janela para seleo do compatibilizador. Selecione o programa
UpdFATNFE.

4.

Ao confirmar exibida uma mensagem de advertncia sobre o backup e a necessidade de sua execuo
em modo exclusivo.

5.

Clique em Processar para iniciar o processamento. O primeiro passo da execuo a preparao dos
arquivos.
apresentada uma mensagem explicativa na tela.

6.

Em seguida, exibida a janela Atualizao concluda com o histrico (log) de todas as atualizaes
processadas. Nesse log de atualizao so apresentados somente os campos atualizados pelo programa.
O compatibilizador cria os campos que ainda no existem no dicionrio de dados.

7.

Clique em Gravar para salvar o histrico (log) apresentado.

8.

Clique em OK para encerrar o processamento.

SIGAFAT JOB para Cancelamento de NFe (Job FatJobNFe)

Boletim Tcnico

Procedimentos para Configurao

1.

No Configurador (SIGACFG), acesse Dicionrio de Dados/Pesquisar/Procurar por e verifique os dados a seguir:

Tabela SF2 - Cabealho das NF de Sada

Campo

F2_STATUS

Tipo

Caracter

Tamanho

Ttulo

Status NFE

Descrio

Status Canc. NFE

Help

Status Canc. NFE

Nvel

Tabela SX6 - Parmetros

Nome

MV_CANCNFE

Tipo

Lgico

Contedo

.F.

Descrio

Habilita processo de cancelamento da NFe.

Crie o parmetro MV_CANCNFE para habilitar a excluso das NFe quando utilizado como True(Verdadeiro).

SIGAFAT JOB para Cancelamento de NFe (Job FatJobNFe)

Boletim Tcnico

Procedimentos para Utilizao

Requisitos Prvios:
TSS configurado.
Faturamento configurado para utilizao com TSS.
1. Configure o Job para execuo do processo de cancelamento (estorno) dos documentos emitidos por NFe.
2. Abra o arquivo INI do Server Protheus, adicione a seo [FatJobNFe_<EMPRESA><FILIAL>] conforme exemplo
abaixo:
[ONSTART]
JOBS=FatJobNFe_<empresa><filial>
[FatJobNFe_<empresa><filial>]
MAIN=FatJobNFe
ENVIRONMENT=<Ambiente>
nParms=2
parm1=<Empresa>
parm2=<Filial>
START_TIME=00:00:01
FINISH_TIME=23:59:59
INTERVAL=5
ACTIVATE=ON

Observaes referentes s chaves:

ENVIRONMENT - Ambiente a que pertence o Job.
nParms - Deve permanecer 2.
parm1 - Cdigo da empresa.
parm2 - Cdigo da filial.
START_TIME - Horrio inicial que deve ser considerado para execuo.
FINISH_TIME - Horrio final que deve ser considerado para execuo.
INTERVAL - Intervalo de minutos entre as execues (deve ser maior ou igual a 5).
ACTIVATE - Indica se est ativo.
5

SIGAFAT JOB para Cancelamento de NFe (Job FatJobNFe)

Boletim Tcnico

Exemplo:
[ONSTART]
JOBS=FatJobNFe_9901

[FatJobNFe_9901]
MAIN=FatJobNFe
ENVIRONMENT=P11_BraNFE
nParms=2
parm1=99
parm2=01
START_TIME=00:00:01
FINISH_TIME=23:59:59
INTERVAL=15
ACTIVATE=ON

Observe que, no exemplo acima, foi definido um intervalo de 15 minutos para a execuo do processo de
cancelamento executado.
1.

No Faturamento (SIGAFAT), acesse Miscelnea/Atualizaes/Faturamento/Excluso

(MATA521), configure os parmetros da rotina.

2.

Escolha uma Nota Fiscal emitida para a SEFAZ.

3.

Clique em Aes Relacionadas / Excluir.

4.

Confirme o estorno dos documentos.

5.

Ao permitir a excluso, a legenda Aguardando cancelamento.

Obs: Se o job no est ativo, o boto refresh faz a validao na SEFAZ e estorna os documentos.

O cancelamento efetivado pelo JOB que deve estar ativo se a SEFAZ permite seu cancelamento.

SIGAFAT JOB para Cancelamento de NFe (Job FatJobNFe)

Doc.

Sada

Boletim Tcnico

Se o cancelamento no for permitido, sua legenda alterada para Cancelamento no autorizado e deve ser
verificado no Monitor (Nfe SEFAZ).
Para visualizar o novo status aps a execuo do Job, saia e retorne rotina ou clique em refresh. A sua
alterao depende de alguns fatores como disponibilidade da SEFAZ, se j foi permitida sua excluso, etc..

Informaes Adicionais

A quem se destina

A todos que utilizam NFe.

Objetivo

Excluso dos documentos de sada emitidos para a SEFAZ.

Informaes Tcnicas
Tabelas Utilizadas

SF2 Cabealho das NF de Sada.

Rotinas Envolvidas

MATA521 Excluso Doc. Sada.

Sistemas Operacionais

Windows/Linux

SIGAFAT JOB para Cancelamento de NFe (Job FatJobNFe)