Manual de Usuário v4.00 - r002 PDF

Fazer download em pdf ou txt
Fazer download em pdf ou txt
Você está na página 1de 438

Manual de Usuários do Sistema:

Comply e-Docs

1
Conteúdo

Versões do Produto ............................................................................................................ 5

Informativos dos Produtos.................................................................................................. 6

Sistema Comply e-Docs ..................................................................................................... 8

Componente Framework .............................................................................................. 13

Menu Painel de Controle .......................................................................................... 30

Menu Cadastrar ........................................................................................................ 81

Personalização de Email ......................................................................................124

Menu Relatórios ......................................................................................................169

Menu Gerência ........................................................................................................188

Modelo Operacional SAP ............................................................................................253

Parâmetros (/PWS/ZNFEM000) ..............................................................................253

Parâmetros de Inclusão e Exclusão - (/PWS/ZNFEM001) .......................................293

Extrator NF-e - (/PWS/ZNFERP002) ......................................................................296

Painel de Controle - (/PWS/ZNFEMP000) ..............................................................299

Gerenciar Eventos no ABAP ...................................................................................304

Limpar Tabelas de NF-e - (/PWS/ZNFECTAB) ......................................................307

Job de limpeza Tabelas de NF-e (/PWS/ZNFECTAB2) ...........................................310

Componente Comply e-Docs Server............................................................................312

Processos ....................................................................................................................313

NF-e: .......................................................................................................................315

2
NFS-e:.....................................................................................................................325

Interface EDI...........................................................................................................331

EDI ..........................................................................................................................331

Procedimentos de Contingência .........................................................................332

Serviço Web WCF (Inbound) ......................................................................................379

Alterar as Portas dos Serviços .....................................................................................379

Endereços disponibilizados para consumo do WCF Inbound .......................................380

Mensagem para a URL sem compactação ................................................................381

Mensagem para a URL com compactação ...............................................................382

Com Compactação ou Sem Compactação....................................................................383

Client Inbound ............................................................................................................397

Padrões Técnicos.....................................................................................................399

Pré-Requisitos Instalação Client Inbound ................................................................400

Configuração ...........................................................................................................406

Integração e Requisitos Técnicos Comply e-Docs .......................................................421

Introdução – Módulo NFS-e ....................................................................................423

Eventos de NF-e ....................................................................................................430


Ferramenta de Ajuda
Com o intuito de facilitar o acesso de nossos clientes e colaboradores às informações sobre as
soluções desenvolvidas pela empresa, a Sonda IT, maior empresa latino-americana de TI,
implementa o uso desta completa ferramenta de ajuda, dando mais um passo no seu projeto de
busca por inovação e aperfeiçoamento dos seus serviços.

Com este projeto, a Sonda IT busca um contato mais próximo com seus clientes e colaboradores,
facilitando e simplificando o acesso às informações sobre seus produtos, permitindo que o
usuário, de forma online ou off-line, otimize o uso das ferramentas desenvolvidas pela empresa,
suas funcionalidades e aplicações.

A ferramenta de ajuda tem o objetivo de centralizar as informações e permite a divulgação de


comunicados sobre atualizações e novidades dos produtos e a publicação de informações
relevantes sobre alterações legais que impactam diretamente no desenvolvimento e manutenção
de nossos softwares.

A ajuda de nossos produtos está estruturada por módulos, que obedecem a uma sequência,
permitindo que o usuário utilize-os como um roteiro para a realização das atividades e rotinas
atendidas por cada um dos sistemas da Sonda IT. De forma clara e objetiva, essa documentação
apresenta o passo a passo pra a realização das rotinas, ilustrando os tópicos com telas dos
próprios produtos. A atualização dessas informações é feita constantemente e reflete sempre
qualquer alteração sofrida pelo produto.

Sugerimos aos nossos clientes e colaboradores que explorem os recursos desta ferramenta para
solucionar possíveis dúvidas quanto à utilização dos produtos Sonda IT, agilizando assim a solução
de problemas simples, que dependem de uma simples parametrização ou uso mais eficiente da
ferramenta.

4
Versões do Produto
Esta documentação refere-se à Versão 4.00 do Comply e-Docs, podendo conter funções ainda
indisponíveis em seu aplicativo.

Atualize sua versão para acessar todas as funcionalidades aqui apresentadas.

Nesta pasta é possível acessar, imprimir e baixar os arquivos da versão atual e anteriores,
clicando duas (02) vezes sobre o link de interesse.

>> Versão Atual

>> Versões Anteriores


Informativos dos Produtos
As atualizações e melhorias do Comply e-Docs são comunicadas aos nossos clientes e
colaboradores através de documentos informativos divulgados periodicamente.

>> Clique aqui para visualizar os Informativos

Caso não tenha recebido seus dados de acesso em sua caixa de correio, favor solicitar reenvio
através do e-mail: [email protected]

6
Gerenciador de Documentos Eletrônicos
Comply e-Docs
Sistema Comply e-Docs

Introdução

O novo sistema Comply e-Docs agrega funcionalidades de gerenciamento de documentos


eletônicos nos âmbitos municipal e estadual, processando ou arquivando documentos como NF-es,
NFS-es e CT-es. Assim como seu antecessor, é nativamente compatível com SAP e adaptável a
qualquer outro sistema de origem, utilizando uma interface de troca de informações entre bancos
de dados.
A equipe do Comply e-Docs trabalha continuamente para criar uma ferramenta cada vez mais útil
no gerenciamento de documentos digitais.

Abaixo seguem as principais caracteristicas do sistema e dos módulos Mercantil e Serviços, que
estão incorporados ao Comply e-Docs:

Sistema Comply e-Docs:

 Suportar múltiplos bancos de dados (SQL Server e Oracle);


 Suportar múltiplos protocolos de comunicação (HTTP, HTTPS, TCP e ICP);
 Suporta várias empresas e filiais;
 Extrator SAP nativo;
 Interface EDI para carregamento de NF a partir de outros Sistemas de Origem;
 Controle de Acesso;
 Possibilidade de customizações via pontos de Exit;

8
Nota Fiscal Eletrônica Mercantil:

 Efetuar críticas fiscais;


 Priorizar a transmissão das informações necessárias à SEFAZ dos Estados;
 Gerar lotes de transmissão conforme as regras definidas na legislação;
 Transmitir lotes de NF-es para a SEFAZ;
 Consultar o resultado da transmissão;
 Receber o número do protocolo dado pela SEFAZ ou as críticas por esta apontadas;
 Gerenciar a impressão;
 Gerar automaticamente os arquivos PIN necessários para Notas Fiscais da SUFRAMA;
 Emitir Cartas de Correção Eletrônica (CC-e);
 Cancelamentos por evento;
 Receber e validar NF-es de Entrada de Fornecedores através de um Serviço Web;
 Manifesto do Destinatário;
 Consulta Documentos Destinados;
 Download de XML;
 Oferecer um painel de controle para que o usuário acompanhe o andamento do
processamento das NF-e e Eventos de Segunda Geração (NF-e 2G);
 Arquivar informações de NF-e automaticamente em um data center aumentando a
segurança.
Nota Fiscal Eletrônica de Serviço:

 Integrar o WebService com o sistema de origem e outras soluções de NF-e;


 Utilizar um layout padrão de comunicação;
 Gerar dados com segurança e desempenho com assinatura digital;
 Oferecer monitoramento através do Painel de Controle:
 Painel de Controle Unificado de NF-es e NFS-es no SAP;
 Painel de Controle Exclusivo de NFS-es;
 Painel de Controle Unificado de NF-es, NFS-es no componente framework.
 Oferecer solução compatível com as exigências de cada Prefeitura Municipal;
 Obter serviços como de Recepção, Mapeamento, Pré-Validação, Envio de Lote e Consulta
de Lote do RPS;
 Oferecer o cancelamento de NFS-e;
 Receber o feedback da validação do RPS;
 Gerar o envio de e-mail automático (PDF e XML);
 Gerar impressão automática do RPS;
 Gerar impressão automática da NFS-e após a autorização do município;
 Gerar a reimpressão individual ou em lote;
 Realizar download dos arquivos XML individuais ou em lote;

10
Expandindo os Módulos de Nota Fiscal Eletrônica Mercantil e Serviços, temos as seguintes
funcionalidades dividas em: Abap, Framework, Comply e-Docs Server, Outbound, Inbound, Client
Inbound, Arquivamento, Integração e Nota de Serviço Eletrônica.

 ABAP. Este componente é responsável pela interface entre o componente Comply e-Docs
Server e o SAP, sendo utilizado pelas funcionalidades de Outbound, Inbound e Nota Fiscal
de Serviço. Este componente tem as funções de prover informações aos usuários SAP
sobre o estado das Notas Fiscais, extrair informações, enviá-las ao componente Comply e-
Docs Server, receber a resposta do processamento. Além de atualizar o SAP com as
informações relacionadas à NF-e;

 Framework. Componente responsável pela apresentação de uma interface amigável


entre o usuário e o banco de dados. Também é responsável pelo gerenciamento de
informações existentes no banco de dados, como criação e alteração de tabelas;

 Comply e-Docs Server. Componente responsável pela mensageria e processamento das


informações de Nota Fiscal do sistema Comply e-Docs. Ele pode trabalhar nos fluxos
Outbound, Inbound, Arquivamento e Integração.

 Outbound: Realiza a comunicação com o SAP e outros sistemas legados, e as envia à


SEFAZ. Também realiza a impressão do DANFE, envio de XML de distribuição por
email, entre outras funcionalidades;

 Inbound: Disponibiliza um Serviço Web (com a tecnologia WCF – Windows


Commucation Foundation) que pode ser utilizado para receber NF-es ou CT-es de
Entrada recebida por fornecedores. Após receber as NF-es ou CT-es, pode consultar a
autorização de uso da NF-e ou CT-e na SEFAZ que o autorizou;

 Arquivamento: O Comply e-Docs Server disponibiliza um Serviço Web (com a


tecnologia WCF) para receber NF-es geradas por qualquer sistema de mensageria de
NF-e disponível no mercado, incluindo o próprio Comply e-DOCs. O Comply e-Docs
Server ainda pode ser configurado para automaticamente realizar o Arquivamento de
NF-es geradas no Outbound em um Serviço Web de Arquivamento;

 Integração: Realiza a comunicação com o SAP e outros sistemas legados, efetuando


uma interação/ponte entre o módulo de NFS-e. No Comply e-Docs Server
disponibiliza um Serviço Web para o envio de XML de integração e retorno do
processamento ao sistema de origem;

 Nota Fiscal Eletrônica de Serviço: No módulo de Nota Fiscal de Serviço, o Comply e-


Docs Server disponibiliza um Serviço Web para receber as NFS-e geradas pela NF-e
pelo módulo de integração do Comply e-Docs. Após receber as NFS-e ele realiza o
envio através de Web Service às prefeituras, ele ainda realiza as consultas e
cancelameto das NFS-e.
 Client Inbound: Este componente é responsável pela realizaçãoh h de interface entre o
usuário e o Serviço Web Inbound. Ele pode ser utilizado para transmitir informações ao
Serviço Web através de interface gráfica ou modo texto.

12
Componente Framework

Neste manual, demonstraremos os cadastros e parâmetros que devem ser efetuados antes da
ativação dos processos do componente Comply e-Docs Server. O sucesso deste depende
principalmente de informações externas a ele, que irão garantir a correta ocorrência dos ciclos.

Acesso ao Sistema

Login
Para login ao Comply e-Docs siga o procedimento abaixo:

 Selecione a opção na área de trabalho e, em seguida, será disponibilizada a


tela abaixo:

 Do lado esquerdo da tela, selecione na lista o ambiente para login:


 Ao escolher o ambiente para login, clique duas (02) vezes sobre o mesmo e será
demonstrada a seguinte tela, para preenchimento de usuário e senha de acesso ao
sistema:

 Campos disponíveis:
o Nome do usuário: Informar o nome de usuário.
o Senha: Informar a senha cadastrada.
o Entrar automaticamente: Marque esta opção se desejar salvar os dados de acesso,
dispensando a digitação do usuário e senha no próximo acesso.

14
 Depois de informados os dados solicitados, clique duas (02) vezes sobre o ícone ao
lado do aplicativo Comply e-Docs:

 Ao final do procedimento é exibida a tela inicial do aplicativo Comply e-Docs:


Primeiro Acesso
No primeiro acesso é necessário efetuar a Configuração do Servidor. Para isto, siga o
procedimento descrito abaixo:

 Na área de trabalho, clique duas (02) vezes sobre o ícone ;

 Na tela exibida clique duas (02) vezes no botão - Conexões:

 Ao clicar nesta opção é exibida a tela a seguir:

16
 Para adicionar um novo Servidor, clique duas (02) vezes no botão: - Adicionar.
Será exibida a tela abaixo:

 Preencha os campos disponíveis na tela, conforme indicado abaixo:


o Descrição: Informe a descrição do ambiente incluso;
o Conexão: Informe o nome do ambiente para conexão;
o Servidor: Preencher ou selecionar na lista o ambiente a ser utilizado;
o Porta: Número da porta de conexão com Servidor;

o Clique no botão - Salvar para gravar as informações cadastradas.


Todos os campos são de preenchimento obrigatório!

 O Servidor cadastrado aparecerá na lista de ambientes:

18
Janelas Ativas
Ao abrir qualquer função do Comply e-Docs, o aplicativo lista as janelas que estão ativas,
conforme destacado em vermelho na imagem abaixo:

Para acessá-las, escolha na caixa "Janelas Ativas", a tela que deseja utilizar.
Pesquisa
Para realizar a pesquisa de registros, existentes no Comply e-Docs, siga o procedimento a seguir:

A tela de pesquisa está disponível em todas as funcionalidades que permitem cadastros de dados.

 Selecione o campo responsável pelo filtro para concluir a pesquisa:

 Escolha a operação:

20
 Resultados gerados:
o A operação % mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado similar ao digitado. Pode ser utilizada a operação no início, meio
ou final do conteúdo inserido no campo;
o A operação = mais uma letra / número ou palavra digitada no campo Valor, retorna
o resultado igual ao digitado;
o A operação ! = mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado diferente do digitado;
o A operação < mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado menor que o digitado.
o A operação <= mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado igual ou menor que o digitado.
o A operação > mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado maior que o digitado.
o A operação >= mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado igual ou menor que o digitado.

Registre o Valor que irá filtrar para ter acesso à lista. Caso não haja nenhuma informação
referente ao filtro, o sistema apenas não demonstra as informações.
Transação
Todas as telas do sistema possuem nomenclatura, a qual denominamos de "Transação".

Através do nome da transação, o usuário pode acessar uma funcionalidade sem utilizar o menu.

Veja a seguir o procedimento para localizar uma funcionalidade pelo nome da transação:

 A cada tela aberta, no canto inferior, é indicado o nome da transação, conforme


destacado em vermelho na tela abaixo:

 No canto superior da tela principal do sistema, no campo "Atalho" o usuário digita o nome
da transação:

22
 Para buscar a transação indicada no campo "Atalho", selecione a opção :

 O sistema abre a tela através do atalho isentando o acesso pelo menu.


Alterar Senha
Para alterar a senha do usuário atual acesse:

Menu: Sistema > Alterar Senha

Atalho: Não se aplica

O Comply e-Docs disponibilizará a tela para Alteração de Senha.

 Preencha os campos abaixo com os dados solicitados:

 Campos disponíveis:
 Senha Atual: Informar a senha atual.
 Nova Senha: Cadastrar uma nova senha.
 Nova Senha Repetir: Repetir nova senha cadastrada.

A senha pode ser alterada quando desejar; A primeira senha de acesso ao sistema será informada
pelo consultor.

24
Envio de Mensagem
O sistema disponibiliza a opção de envio de mensagem em tempo real, sem a obrigatoriedade de
acessar outro aplicativo. Esta funcionalidade servirá para o contato entre os usuários do sistema
devidamente cadastrados na tela de Usuário.

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Sistema > Exibir > E-mails

Atalho: Não se aplica

Enviar Mensagem:

Para enviar mensagens, acesse o menu a seguir:


Menu: Sistema > Exibir > E-mails > Enviar e-mails

Atalho: Não se aplica

 Em seguida será exibida a tela abaixo:


 No campo "Para", para informar o e-mail do usuário que receberá o e-mail, clicar no
botão , o aplicativo lista todos os usuários cadastrados no sistema:

26
 Na lista apresentada, selecionar o usuário;
 Inserir o assunto no campo "Assunto";
 Registrar a mensagem no campo "Corpo da Mensagem";
 E, por último, clicar em "Enviar";
 Será apresentada mensagem para confirmação do envio:

 Ao clicar na opção "Sim" a mensagem é enviada e exibida mensagem de status do envio:


 Caso não queira enviar a mensagem, selecione a opção "Descartar" ou "Não";
 A mensagem será salva na aba "Mensagens Enviadas":

28
Visualizar E-mails
Para receber a mensagens usando o aplicado, acessar o menu a seguir:

Menu: Exibir > E-mails > Visualizar E-mails

Atalho: Não se aplica

 Selecionar o registro com duplo clique para leitura;


 É exibida a tela abaixo:

Para utilização das opções ‘Marcar como Lida’ e ‘Exclusão’, escolha o registro antes de efetuar
a ação.
Menu Painel de Controle

Imprime Série DANFEs


No Painel de Controle da Nota Fiscal, o sistema apenas disponibiliza a impressão da NF-e uma a
uma. Para a impressão manual em massa dos DANFEs, acesse:

Menu: Painel de Controle > Imprime Série DANFEs

Atalho: N/A

 Preencher os campos conforme indicado a seguir:


o Matriz: Escolher a Matriz com o auxílio da listagem;
o Filial: Selecionar a Filial com o auxílio da listagem;
o Nota Inicial: Inserir o número inicial das notas fiscais;
o Nota Final: Informar o número final das notas fiscais;
o Série: Inserir a série das Notas Fiscais;

30
o Impressora Cliente: Local – Impressora cadastrada localmente;
o Impressora Rede: Impressora compartilhada para os usuários;
o Oficial: DANFE que pode ser impresso para circular com a mercadoria (possui
validade legal);
o Não Oficial: DANFE que pode ser impresso, mas não deve circular com a
mercadoria, utilizada apenas para conferência (não possui validade legal);
o Bandeja da Impressora: Selecione a bandeja onde será impresso o DANFE.

o Após estas definições, clique em (Imprimir).


Painel de Controle Inbound
Esta função auxilia no gerenciamento exclusivo das Notas Fiscais de Inbound. Através desta,
pode-se visualizar as NF-es de Inbound e o controle de mensagens efetuadas pelo sistema de
acordo com as informações enviadas pela SEFAZ ou recebidas pela importação dos XMLs
recebidos.

Para visualizar a funcionalidade acessar o menu abaixo:

Menu: Painel de Controle > Inbound

Atalho: PNLINB

 Painel Inbound mostrando apenas informações de NFs de Inbound

32
 Painel Inbound mostrando expansão de NF-e com informações de Evento e
Histórico de Eventos
 Aba > Todas

Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema;

 Aba > Pendente

Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que não
possuem nenhum evento de manifestação do destinatário;

 Aba > Ciência da Operação

Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que
possuem o último evento válido sendo Ciência da Operação;

 Aba > Confirmação da Operação

Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que
possuem o último evento válido sendo Confirmação da Operação;

 Aba > Erro

Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que
possuem o último evento em estado de Erro;

 Aba > Desconhecimento da Operação

Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que
possuem o último evento válido sendo Desconhecimento da Operação;

 Aba > Operação Não Realizada

Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que
possuem o último evento válido sendo Operação Não Realizada;

Colunas com Sinalizadores

34
O Painel de Controle Inbound possui quatro colunas com sinalizadores para indicar se a
NF-e possui XML ou o estado do último evento de Manifesto que lhe foi atribuído.

Coluna XML

Botão Utilização
Não possui XML

Possui XML
Colunas, Ciência, Confirmação, Desconhecimento ou Não Realizada

Botão Utilização

Evento autorizado

Erro na autorização do evento

Não possui Evento

Esta transação possui as seguintes funções:

 Botão > Atualizar

Atualizar as informações da tela;

 Botão > Filtro

O novo filtro que determina os campos que serão utilizados, se torna mais rápido na
busca pelas NF-es;

36
Para que a busca pelos critérios seja realizada, é necessário selecionar os mesmos e
adiciona-los com o botão , assim como a figura acima.
Caso deseje remover algum parâmetro da busca, apenas clique no botão .

Após a seleção, utilizar o botão .

 Botão > Limpar Filtro

Remove o filtro inserido anteriormente.

 Botão > Download XML

É utilizado para realizar o download do arquivo XML de uma NF-e que esteja com a coluna
XML indicada com o sinalizador , não possui XML. Pode-se selecionar várias NF-es e
solicitar o download, mesmo selecionando NF-es com XML, o download será comandado
apenas para os registros sem XML.

 Botão > Visualizar XML


Prove uma visualização rápida do XML da NF-e selecionada, mostra apenas um XML por vez.

 Botão > Ciência em Lote


Realiza o Manifesto do Destinatário para uma ou várias NF-es, incluindo um evento de Ciência da
Operação para as NF-es selecionadas. Caso uma NF-e selecionada já possua o evento, o mesmo
não será criado. Este botão apenas cria o evento, é necessário o seu acompanhamento para
verificar que o evento pedido foi corretamente autorizado.

 Botão > Confirmação em Lote


Realiza o Manifesto do Destinatário para uma ou várias NF-es, incluindo um evento de
Confirmação da Operação para as NF-es selecionadas. Caso uma NF-e selecionada já possua o
evento, o mesmo não será criado. Este botão apenas cria o evento, é necessário o seu
acompanhamento para verificar que o evento pedido foi corretamente autorizado.

38
 Botão > Desconhecimento em Lote
Realiza o Manifesto do Destinatário para uma ou várias NF-es, incluindo um evento de
Desconhecimento da Operação para as NF-es selecionadas. Caso uma NF-e selecionada já possua
o evento, o mesmo não será criado. Este botão apenas cria o evento, é necessário o seu
acompanhamento para verificar que o evento pedido foi corretamente autorizado.

 Botão > Operação Não Realizada em Lote


Realiza o Manifesto do Destinatário para uma ou várias NF-es, incluindo um evento de Operação
Não Realizada para as NF-es selecionadas. Caso uma NF-e selecionada já possua o evento, o
mesmo não será criado. Este botão apenas cria o evento, é necessário o seu acompanhamento
para verificar que o evento pedido foi corretamente autorizado.

 Botão > Salvar Manifesto Temporário


Funcionalidade em desenvolvimento...

 Botão > Importar XML de CNPJs Manifesto Automático


Este botão é utilizado para importar um XML com informações de clientes para que as mesmas
sejam utilizadas na criação de Manifestos Automáticos pelo Servidor de Processos. O processo de
Manifesto Automático será mais detalhado neste manual na seção de Processos, abaixo o leiaute
do arquivo e como realizar a importação.
Exemplo: listaCNPJ.xml
<?xml version="1.0" encoding="UTF-8"?>
<ListaCNPJ>
<manifestoAutomatico>
<cnpj>08733698000166</cnpj>
<razaoSocial>Sonda Software Ltda.</razaoSocial>
</manifestoAutomatico>
<manifestoAutomatico>
<cnpj> 99999999000191</cnpj>
<razaoSocial>Empresa 2</razaoSocial>
</manifestoAutomatico>
</ListaCNPJ>
Para importar um arquivo que deve seguir o padrão acima, basta pressionar o botão e apontar
para o arquivo XML. O resultado da importação pode ser verificado no menu-tela, Cadastrar-Lista
de CNPJs de Manifesto Automático. O processo de importação do XML não sofre nenhum tipo de
validação, caso um importação tenha sido duplicada ou algum registro esteja incorreto, é
necessário a correção do cadastro pela tela “Lista de CNPJs de Manifesto Automático”.

 Botão > Detalhes de Processamento


Tela utilizada para visualizar os detalhes ocorridos durante o processamento de uma NF-e, esta
tela também esta presente no Painel de Controle Nota Fiscal:

40
 Botão > Exibir Eventos
Tela para gerenciar os eventos de segunda geração que pertencem a uma NF-e, esta tela também
esta presente no Painel de Controle Nota Fiscal:

o Colunas disponíveis no grupo Eventos:


 Status: Determina se o Evento está em processamento, com erro ou
autorizado;
 Tipo Evento: Indica o tipo de Evento. Para NF-es de Inbound os eventos de
Manifesto são os únicos disponíveis;
 Seq: É o número sequencial do Evento;
 Data: Data de Emissão do Evento;
 Protocolo: Número do Protocolo de autorização do evento.
o Colunas disponíveis no grupo Histórico:
 Data: Data que um determinado status ocorreu;
 Cod.: Código do Status;
 Descrição: Descrição do Status;
 Detalhes: Detalhes do Status, se houver.

o Campos disponíveis no grupo Detalhes:


 Tipo de Evento: Indica o tipo de Evento. Para NF-es de Inbound os eventos de
Manifesto são os únicos disponíveis;
 Descrição do Evento: Descrição do Evento.

o Funcionalidades disponíveis:

 Para atualizar as informações da listagem clique no botão Atualizar;

 Para criar um novo Evento é necessário clicar no botão “Novo” ;

 Para editar um evento é necessário clicar no botão “Editar” .


Importante: Somente é possível editar um evento com erro e se for o último
Evento gerado para aquela NF-e;
 Para enviar um evento que foi criado ou editado é necessário clicar no botão

“Enviar” ;
 Para cancelar o envio de um evento é necessário clicar no botão “Cancelar”

42
Painel de Controle Nota Fiscal
Esta função auxilia no gerenciamento das Notas Fiscais, através do Status.

Nesta operação, pode-se visualizar o controle de mensagens, efetuado pelo sistema, de acordo
com informações enviadas pela SEFAZ.

Para visualizar a funcionalidade acessar o menu abaixo:

Menu: Painel de Controle > Nota Fiscal

Atalho: PAINELCOM

É através do Painel de Controle que o usuário pode gerenciar todo o ciclo de vida de um registro
de Nota Fiscal. Este Painel permite o acompanhamento do estado de um determinado registro e
pode ser utilizado tanto para Notas Fiscais de Outbound (emitidas), quanto para Notas Fiscais e
Conhecimento de Transporte de Inbound (recebidas) e arquivamento. Além disso, também é
possível visualizar, de maneira integrada, NF-es, ePin (Notas Fiscais da Suframa) e NFS-e
(somente para emissão).
 Aba > Envio / Recebimento:

São demonstradas as Notas Fiscais em processo de: Geração do XML, Validação


Priorização, Transmissão, Impressão, aprovadas pela SEFAZ, aguardando retorno, em
processo de impressão, Inutilização / Cancelamento e Notas Fiscais autorizadas. Além
disso, é possível verificar NF-es e CT-es recebidas (Inbound) e NFS-es.

 Aba > Exceções:

São exibidas as notas fiscais que foram pré-validadas e estão com erro de validação,
notas fiscais rejeitadas e denegadas pela SEFAZ, que possuem erro de impressão, erro na
geração do XML e erro de transmissão em geral.

 Aba > Contingência:

São apresentadas as notas fiscais que estão em contingência, ou seja, que não estão com
o tipo de emissão Normal.

Sinalizadores do Painel de Controle:

Os sinalizadores do painel de controle definem o status da nota fiscal, que estão


diretamente ligados à coluna ocorrência, são eles:

Botão Utilização
Impressão do DANFE

Processo concluído

Nota inutilizada e cancelada

Aguardando transmissão e retorno do WebService

Notas Fiscais denegadas


Erros: pré-validação, transmissão, validação, impressão, geração do XML,
transmissão normal e cancelamento

* Estas informações podem ser personalizadas. Consulte a equipe de produto.

44
Esta transação possui as seguintes funções:

 Para atualizar as informações da lista selecione a opção - Atualizar;

 Escolha o botão (Congelar Grid ou Descongelar Grid , para


congelar/descongelar o Painel de Controle (permitir ou não a listagem de novas
atualizações));

 Filtro: utilizado para realizar uma busca por Notas Fiscais. As opções são as
seguintes:
 Seleção Múltipla: utilizando esse botão é possível selecionar mais de um
registro de um mesmo tipo de filtro.

46
 Limpar Filtro: utilizado para limpar as informações do filtro anterior;

 Para visualizar o DANFE selecione o registro e use o botão (Visualizar DANFE). O


DANFE será apresentado na tela;

 Para impressão do DANFE manualmente, selecione o registro e a opção “Imprimir


DANFE”. O sistema solicitará a escolha da opção "Oficial" (com validade legal) ou "Não
Oficial" (com a marca “Sem validade Legal” no DANFE) e a definição da impressora que
receberá o documento.
 Defina a Impressora Cliente (Impressora instalada localmente, na máquina do
usuário) ou Impressora Rede (Impressora que não precisa estar instalada na
máquina do usuário);
 Oficial: DANFE que pode ser impresso para circular com a mercadoria (possui
validade legal);
 Não Oficial: DANFE que pode ser impresso, mas não deve circular com a
mercadoria, utilizada apenas para conferência (não possui validade legal);
 Bandeja da Impressora: Escolha a bandeja onde será impresso o DANFE;
 Após estas definições, clique em "Imprimir".;

48
 Imprimir por lote de impressão: O último ícone de impressora – ‘Impressão de Lotes’

é utilizado para reprocessar uma impressão de Lotes de impressão.

o Colunas disponíveis:
 Lote: Número do lote;
 Total de Notas: Total de notas que compõem o lote;
 Notas Processadas: Quantidade de notas processadas para este lote;
 Status: Pendente- Está faltando Notas para completar o lote. OK- todas as
notas deste lote foram processadas;

 Para filtrar as informações do lote, clique no botão . Será visualizada a


tela abaixo:
 O filtro poderá ser realizado por:
o Lote: Informe o número do lote de impressão;
o Exibir apenas lotes completos: Notas com status OK;
o Exibir apenas lotes incompletos: Notas com status PENDENTE, para
serem processadas;

o Definido o filtro, clique em ;

o Depois de selecionado o lote, escolha a impressora e clique em -


Imprimir Lote;

50
 Para impressão do DACTE manualmente, selecione o registro e a opção “Imprimir
DACTE”. O sistema solicitará a escolha da opção "Oficial" (com validade legal) ou "Não
Oficial" (com a marca “Sem validade Legal” no DACTE) e a definição da impressora que
receberá o documento.

 Defina a Impressora Cliente (Impressora instalada localmente, na máquina do


usuário) ou Impressora Rede (Impressora que não precisa estar instalada na
máquina do usuário);
 Oficial: DACTE que pode ser impresso para circular com a mercadoria (possui
validade legal);
 Não Oficial: DACTE que pode ser impresso, mas não deve circular com a
mercadoria, utilizada apenas para conferência (não possui validade legal);
 Bandeja da Impressora: Escolha a bandeja onde será impresso o DACTE;
 Após estas definições, clique em "Imprimir".;

 Para visualizar o DACTE selecione o registro e use o botão (Visualizar DACTE). O


DACTE será mostrado na tela;
 Exportar XML da NF-e: Para exportar NF-es em formato XML, selecione um grupo de

registros no Grid e a opção .

o Escolha o modo de exportação: Lote XML, exporta todo o grid, porém, somente
quando o filtro está ativado. Já a opção Notas Selecionadas somente exporta as
NF-es selecionadas no grid:

 Exportar XML de NFS-e: Para exportar o XML de uma NFS-e, selecione um grupo de

registros no Grid e a opção . Observação: Este botão somente estará ativo caso os
registros selecionados sejam do tipo NFS-e.

 Exportar XML de DPEC: Para exportar o XML do DPEC, selecione um grupo de registros no

Grid e a opção . Observação: Este botão somente estará ativo caso a NF-e
selecionada estiver com o tipo de emissão DPEC.

 Exportar XML de CT-e: Para exportar o XML do CT-e, selecione um grupo de registros no

Grid e a opção . Observação: Este botão somente estará ativo caso os registros
selecionados sejam do tipo CT-e.

 Exportar DANFE em PDF: Selecione o botão (Exportar PDF), em seguida, escolha o


caminho que deseja gravar os arquivos e confirme a operação;

52
 O Painel de Controle possui a função (Reprocessamento de Nota Fiscal), que
permite configurar um grupo de Notas Fiscais para uma etapa de processamento anterior
ou posterior à atual, de acordo com o seu status. Ao selecionar um grupo de registros no
Grid o sistema verificará se alguma Nota Fiscal do grupo permite reprocessamento, se
permitir o botão ficará ativo, caso contrário será desativado e nenhuma ação pode ser
realizada. Ao clicar no botão, quando ativo, será exibida a tela de processamento de NF-
es:

 Reprocessar: A tela "Reprocessamento de NF-e" permite, dada uma seleção realizada no


Grid do Painel de Controle, definir para a etapa de processamento anterior ou posterior à
atual, de acordo com o status da nota. Para isso é necessário selecionar a opção
“Reprocessamento?” e o Status da Nota será alterado de acordo com o campo “Status
Futuro”. Para obter uma descrição detalhada do processo que será alterado é necessário

clicar no botão (Visualizar Detalhes);

 Ao clicar sobre o botão (Reprocessar), todas as Notas Fiscais que estavam com o
campo “Reprocessamento” selecionado, serão reprocessadas. Existe ainda um campo
que auxilia a visualizar o estado da NF-e: “A Nota foi reprocessada com sucesso”,
“Permite Reprocessamento” e “NF-e não permite reprocessamento”;

 Clique na opção “Detalhes de Processamento” , para visualizar os status ocorridos


durante todo o ciclo da nota fiscal.
54
 O botão (Exibir Eventos) permite gerenciar os Eventos relacionados a uma
determinada NF-e. Ao clicar sobre o botão a seguinte tela será exibida:

o Colunas disponíveis no grupo Eventos:


 Status: Determina se o Evento está em processamento, com erro ou
autorizado;
 Tipo Evento: Indica o tipo de Evento. Atualmente o único evento existente é
de Carta de Correção;
 Seq: É o número sequencial do Evento;
 Data: Data de Emissão do Evento;
 Protocolo: Número do Protocolo de autorização do evento.

o Colunas disponíveis no grupo Histórico:


 Data: Data que um determinado status ocorreu;
 Cod.: Código do Status;
 Descrição: Descrição do Status;
 Detalhes: Detalhes do Status, se houver.

o Campos disponíveis no grupo Detalhes:


 Tipo de Evento: Indica o tipo de Evento. Atualmente o único evento
existente é de Carta de Correção;
 Descrição do Evento: Descrição do Evento.

o Funcionalidades disponíveis:

 Para atualizar as informações da listagem clique no botão Atualizar;

 Para criar um novo Evento é necessário clicar no botão “Novo” ;

 Para editar um evento é necessário clicar no botão “Editar” .


Importante: Somente é possível editar um evento com erro e se for o último
Evento gerado para aquela NF-e;
 Para enviar um evento que foi criado ou editado é necessário clicar no botão

“Enviar” ;
 Para cancelar o envio de um evento é necessário clicar no botão “Cancelar”

56
Gerenciar Eventos na Framework
No componente Framework é possível visualizar, criar, editar e gerenciar Eventos.

Acessando o Painel de Eventos de NF-es:

Para acessar os eventos de uma determinada NF-e é necessário acessar o Painel de Controle de
NF-e através do Menu: Painel de Controle > Notas Fiscais.
 Com a NF-e selecionada é necessário clicar no botão “Exibir Eventos”. Conforme abaixo:

 Em seguida será exibido o Painel de Eventos:

 A tela acima possui os seguintes botões e campos:


o Atualizar: Para atualizar a informação disponível no Painel;
o Novo: Para a criação de um novo Evento de NF-e;
o Editar: Para editar o evento. Somente habilitado caso o status do evento permita
alteração;
o Enviar: Para enviar um novo evento ou uma alteração de evento;
o Cancelar: Para cancelar a edição ou a criação de um Novo Evento.
o Campo "NF-e": Possui o cabeçalho da NF-e que receberá o evento em questão;
o Campo "Eventos": Este campo possibilita a visualização de todos os eventos
relacionados à NF-e;
o Campo "Detalhes": Neste campo é possível verificar o tipo de Evento e as
informações relacionadas a aquele evento;
o Campo "Histórico": Através deste campo é possível verificar o histórico de
processamento do Evento em questão.

Criando um Novo Evento:


 Para criar um evento é necessário acessar o "Painel de Eventos de NF-e" e

clicar no botão - Novo:

 Ao clicar no botão - Novo, o grupo "Detalhes" será liberado e o texto


do último evento será copiado para este novo evento e será possível
adicionar informações;
 Após isso clicar no botão - Enviar e será gerada uma nova pendência
de envio de evento.

Editando um Evento Existente:

 Para editar um evento Existente, é necessário que o mesmo se encontre


com status de erro;

 Selecionar o evento e, em seguida, clicar no botão - Editar;


 Após esta ação o grupo "Detalhes" será liberado e é possível corrigir o
Evento;

 Por último, clicar no botão - Enviar e o evento será reenviado.

 Para o reenvio de e-mail do XML de Distribuição da NF-e é necessário clicar em -


Envio de E-mail. A seguinte tela será apresentada:

o Colunas disponíveis:
 Enviar: Flag de Envio de E-mail.
 Endereço de Email: E-mail que será enviado o XML.
 Número: Número da NF-e;
 Série: Série da NF-e;

 Para filtrar as informações do NF-e, clique no botão :

58
 O filtro poderá ser realizado por:
o Matriz: Filtro por Matriz;
o Filial: Filtro por Filial;
o Número da Nota: Filtro por Número de Nota;
o Série: Filtro por Série;

o Definido o filtro, clique em ;


o Após selecionar as NF-es é necessário reenviar o XML, escolha a

impressora e clique em ‘Enviar Emails Selecionados’ ;

 Clicar sobre o botão (Mensagens para o Contribuinte), para verificar as mensagens


enviadas pela SEFAZ ao contribuinte, com isso a tela abaixo será exibida:
o Ao clicar sobre o botão - é possível verificar os detalhes da
Mensagem.

60
Painel de Controle Nota Fiscal de Serviço
Para visualizar a funcionalidade acessar o menu abaixo:

Menu: Painel de Controle > Nota Fiscal de Serviço

Atalho: NFSPCO

É através do Painel de Controle que o usuário pode gerenciar todo o ciclo de vida de um registro
de Nota Fiscal de Serviço. Este Painel permite o acompanhamento do estado de um determinado
registro.

 Aba > Envio / Recebimento:

São demonstradas as Notas Fiscais de Serviço em processo de: Geração do XML, Validação,
Transmissão, Impressão, aprovadas pelos municípios, aguardando retorno, Cancelamento e Notas
Fiscais autorizadas.

 Aba > Exceções:


São exibidas as notas fiscais de serviço que foram pré-validadas e estão com erro de
validação, notas fiscais de serviços rejeitadas, que possuem erro de impressão, erro na
geração do XML e erro de transmissão em geral.

Esta transação possui as seguintes funções:

 Para atualizar as informações da lista selecione a opção - Atualizar;

 Escolha o botão (Congelar Grid ou Descongelar Grid , para


congelar/descongelar o Painel de Controle (permitir ou não a listagem de novas
atualizações));

 O Painel de Controle possui a função (Reprocessamento de Nota Fiscal de Serviço),


que permite configurar um grupo de Notas Fiscais de Serviços para uma etapa de
processamento anterior ou posterior à atual, de acordo com o seu status. Ao selecionar
um grupo de registros no Grid o sistema verificará se alguma Nota Fiscal de Serviço do
grupo permite reprocessamento, se permitir o botão ficará ativo, caso contrário será
desativado e nenhuma ação pode ser realizada. Ao clicar no botão, quando ativo, será
exibida a tela de processamento de NFS-es:

62
 Reprocessar: A tela "Reprocessamento" permite, dada uma seleção realizada no Grid do
Painel de Controle do Módulo de NFS-e, definir para a etapa de processamento anterior
ou posterior à atual, de acordo com o status da nota. Para isso é necessário selecionar a
opção “Reprocessamento?” e o Status da Nota será alterado de acordo com o campo
“Status Futuro”. Para obter uma descrição detalhada do processo que será alterado é

necessário clicar no botão (Visualizar Detalhes);

 Ao clicar sobre o botão (Reprocessar), todas as Notas Fiscais de Serviços que


estavam com o campo “Reprocessamento” selecionado, serão reprocessadas.
 Para impressão da Nota Fiscal de Serviço manualmente, selecione o registro e a opção

“Imprimir”. O sistema solicitará a escolha da definição da impressora que


receberá o documento e qual tipo de documento que deseja realizar a impressão,
somente RPS, somente Nota Fiscal de Serviço ou Todas Selecionadas (RPS ou Nota Fiscal
de Serviço).

 Defina a Impressora Cliente (Impressora instalada localmente, na máquina do usuário) ou


Impressora Rede (Impressora que não precisa estar instalada na máquina do usuário);
 Apenas RPS: Recibo Provisório de Serviço que pode ser impresso;
 Apenas NFS-e: Nota Fiscal de Serviço que pode ser impresso;
 Todos Selecionados: Todos que foram selecionados, podem ser Recibo Provisório de
Serviços ou Nota Fiscal de Serviço;
 Bandeja da Impressora: Escolha a bandeja onde será impresso o RPS e a Nota Fiscal de
Serviço;
 Após estas definições, clique em "Imprimir";
 Para visualizar a Nota Fiscal de Serviço ou RPS selecione o registro e a opção
(Visualizar)

 Filtro: utilizado para realizar uma busca por Notas Fiscais de Serviço. As opções são
as seguintes:

 Seleção Múltipla: utilizando esse botão é possível selecionar mais de um registro de


um mesmo tipo de filtro;

64
 Limpar Filtro: utilizado para limpar as informações do filtro anterior;

 Clique na opção “Detalhes de Processamento” , para visualizar os status ocorridos


durante todo o ciclo da nota fiscal de serviço.
 Exportar Nota Fiscal de Serviço em PDF: Selecione o botão (Exportar PDF), em
seguida, escolha o caminho que deseja gravar os arquivos e confirme a operação;

 Exportar XML da NFS-e: Para exportar NFS-es em formato XML, selecione um grupo de

registros no Grid e a opção .

o Escolha o tipo de exportação: RPS, exporta o RPS emitido. Já a opção XML será
aberta as opções do tipo de XML. E deverá selecionar o caminho que o arquivo
será exportado :

 Para o reenvio de e-mail do XML ou PDF da NFS-e é necessário clicar em - Envio de


E-mail. A seguinte tela será apresentada:

66
 Colunas disponíveis:
o Enviar: Flag de Envio de E-mail;
o Nro. da Nota: Número da NFS-e;
o Remetente: Endereço de e-mail do qual será enviado o e-mail;
o Data Inserção: Data de inserção da Nota Fiscal de Serviço;

 Para filtrar as informações do NFS-e, clique no botão :


 O filtro poderá ser realizado por:
o Matriz: Filtro por Matriz;
o Filial: Filtro por Filial;
o Número da Nota: Filtro por Número de Nota;
o Série: Filtro por Série;

o Definido o filtro, clique em ;


o Após selecionar as NFS-es é necessário reenviar o XML, clique em ‘Enviar Emails

Selecionados’ ;

Status Manifesto
Painel de Controle para acompanhamento do processamento das consultas de Documentos
Destinados. Cada filial parametrizada para o processo de Consulta Documentos Destinados é
indicada nesta tela, e por ela, podemos visualizar entre outras informações, o último número
sequencial consultado, o horário da próxima consulta e os status da consulta atual em anterior.

Quando um registro apresentar erro é possível reprocessá-lo utilizando o botão ou atualizar

a tela com o botão .


68
Status Web Service
Nesta tela é possível verificar os status dos WebServices cadastrados e ativos no sistema:

70
Consulta Situação Parceiro
Esta interface tem como objetivo atender o processo de consulta ao cadastro nacional de
contribuintes de ICMS, através da tecnologia WebService que a SEFAZ de cada estado do Brasil
oferece, permitindo que ao informar o CNPJ, CPF ou Inscrição Estadual seja possível receber as
informações cadastrais do parceiro.

Menu: Painel de Controle > Consulta Situação Parceiro

Atalho: STATUSPARC

Descrição das Colunas:

o UF: Estado do parceiro que será consultado. É utilizado como campo chave
juntamente com o campo Num. Docto. (Número do Documento Consultado);
o UF Atendida: Estado que respondeu a consulta de cadastro. Por default é a
mesma da coluna UF;
o Tipo Docto: Selecione o tipo de documento que será usado para a consulta do
parceiro;
o Num Docto: Insira os dados para a consulta do parceiro;
o Status Atual: Identifica o processo que está sendo executado no momento;
o Situação: Identifica o último evento respondido pela SEFAZ para um determinado
parceiro. O Evento Default é o 075 (Aguardando Consulta), o semáforo fica
amarelo, evento 111 (Consulta de cadastro com uma ocorrência) ou 112 (Consulta
cadastro com mais de uma ocorrência) são os eventos de sucesso na consulta, o
sistema apresentará a cor verde. Qualquer evento diferente desses, o semáforo
ficará vermelho indicando que existe alguma não-conformidade com determinada
consulta;
o Intervalo: Considera o prazo em dias para que o sistema realize uma nova
consulta;
o Próxima Atualização: É a data agendada para realizar uma nova consulta no
cadastro de parceiros. O agendamento é efetuado automaticamente ao realizar a
primeira ou nova consulta. Neste último caso, é determinada através do Intervalo
(em dias) a data da próxima consulta;
o Consulta Atual: É a data da última consulta realizada pelo processo de cadastro
de parceiros.

Informações Adicionais do Parceiro:

Aba > Detalhes:


 A coluna "Número Documento." possui um link que exibe informações adicionais
(Endereço, Inscrição Estadual);
 Ao clicar sobre o número de documento, caso existam informações adicionais,
será exibida a seguinte tela:

Aba > Outras Informações:

72
 Caso não haja informações adicionais para determinado número de documento será
exibido o seguinte aviso:

Para adicionar um novo parceiro manualmente, siga o procedimento a seguir.

 Clicar no botão Novo Parceiro;


 Será exibida a tela abaixo:

 Preencha os campos:
o UF: Estado do parceiro que será consultado;
o Tipo Documento: Selecionar o tipo de documento com o auxílio da lista;
o Intervalo: Considera o prazo em dias para que o sistema realize uma nova consulta;
o Número Documento: Quantidade de consultas. Esse número será utilizado para a
consulta do parceiro;

o Clique no botão .

 Para alterar o parceiro, clique no botão - Editar Parceiro. Todos os campos estarão
disponíveis para alteração;

 Para excluir o parceiro, clique no botão - Excluir Parceiro.

Adicionar Parceiro Através de Arquivo (com múltiplos documentos):


 Para adicionar parceiros “Através de arquivo”, clicar no botão - Importar
Parceiros;
 Será exibida uma tela do Windows Explorer:

 O Layout do arquivo XML deverá seguir o modelo abaixo:


<?xml version="1.0" encoding="utf-8" ?>
<sts>
<stParc>
<uf>RS</uf> Código da UF.
<tpDoc>1</tpDoc> Tipo de Documento.(1 CNPJ, 2 CPF, 3 Inscrição Estadual).
<numDoc>123456786</numDoc> Número do documento.
<int>1</int> Intervalo em dias.
</stParc>
</sts>
 É possível adicionar quantos parceiros sejam necessários utilizando a tag <stParc> para
diferenciar os registros.

74
 O Comply e-Docs permite realizar filtros de parceiros, neste caso, é necessário clicar no

botão - Filtrar;
 Será apresentada a tela abaixo:

 É possível escolher um ou mais itens desses filtros e em seguida executá-lo. Desta forma,
serão apenas exibidos os parceiros que atenderem aos critérios de seleção.

o Para retirar o filtro, deve-se clicar no botão - Limpar Filtro;

o Se for necessário atualizar o Grid, deve-se escolher no botão - Atualizar.


Processos
O cadastro de processos adiciona uma nova Thread para um determinado processo (Entrada, XML,
Validação e etc.) para um servidor específico. Deverá ser analisada cuidadosamente a
necessidade de acréscimo ou exclusão de Thread que faz referencia o processo, pois dependendo
da manipulação, este poderá ter o seu desempenho prejudicado.

Para visualizar a funcionalidade acessar o menu indicado abaixo:

Menu: Painel de Controle > Painel de Controle > Processos

Atalho: PAINELSIS

Aba Processos:

Criar processo:

76
 Para criar uma nova Thread (processo), clicar no botão - Incluir Processo:

 Preencher os campos:
o Servidor: Selecione o servidor onde será executado;
o Módulo: Selecione o módulo (NF-e ou NFS-e) que será cadastrado;
o Processo: Determine o processo;
o Tipo de inicialização: Determine se o processo será iniciado manualmente ou
automaticamente:
 Manual: Iniciar o processo manualmente;
 Automático: Quando o servidor iniciar, automaticamente o processo será
iniciado.
o Tipo de Intervalo: Tipo de intervalo que o processo rodará em horas, minutos ou
segundos;
o Intervalo: Estipular o tempo para a Thread;

 Clicar em - Salvar para gravar as alterações.

Filtro de Processos:

 Para executar filtro por tipo de processo, clicar no botão - Filtrar Processos;
 Será exibida a tela a seguir:
 Preencher os campos:
o Processo: Selecionar o processo;
o Servidor: Determinar o servidor do processo;

o Por último, clicar em - Filtrar.

Alterar Processo:

 Para alterar dados do processo, clicar no botão - Editar Processo;


 Será exibida a tela abaixo, onde apenas os campos "Tipo de Inicialização" e "Tipo de
Intervalo", estarão disponíveis para alteração:

78
Excluir Processo:

 Para excluir um processo, clicar no botão - Excluir Processo;


 Será exibida a confirmação da exclusão:

Configurar Processo:

Permite a configuração de parâmetros especiais para alguns processos como, restringir o processo
a apenas uma ou várias UFs ou tipo de Notas Fiscais.

Para configuração especial por processo, clicar no botão - Configurar Processo. Caso o
botão esteja desabilitado, significa que o processo não possui parametrização especial.

 Abaixo alguns exemplos de parametrização:

Thread do processo de Entrada parametrizada para apenas executar o Inbound para o SO


SAP:
Thread do processo de Envio Lote parametrizada para apenas enviar NF-es para as UFs de
“SP”, “RS” e “RJ”:

80
Menu Cadastrar

Lista de CNPJs de Manifesto Automático


Tela de manutenção dos cadastros de CNPJs confiáveis. Os CNPJs cadastrados
nesta lista serão manifestados automaticamente pelo processo de Manifesto
Automático de acordo com suas parametrizações.
Esta lista também pode ser carregada pelo botão “Importar XML de CNPJs

Manifesto Automático” , mostrado nas funcionalidades do Painel de


Controle Inbound.
Para visualizar a funcionalidade acesse o menu abaixo:

Menu: Cadastrar > Lista de CNPJs de Manifesto Automático

Atalho: CADCMA

 Selecione os campos no filtro de pesquisa para listar os CNPJs cadastrados no sistema.


Inclusão de CNPJ:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:

 Preencha os campos:
o CNPJ: Nome do Usuário do sistema;
o Razão Social: Acesso do usuário ao aplicativo.

o Salve a operação .

Os campos: CNPJ e Razão Social são de preenchimento obrigatório.

Alteração de CNPJ:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar;

Apenas o campo Razão Social não estará disponível para alteração.


 Altere o campo;

 Salve a operação ou cancele as alterações .

82
Exclusão de CNPJ:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir;
 O sistema apresentará a seguinte mensagem:

 Confirme ou não a exclusão.


Município
De acordo com a SEFAZ e prefeituras, é necessário que o emissor de NF-e envie no XML, o código
de município para identificação das cidades. Considerando que as empresas não dispõem destes
dados, a Sonda IT desenvolveu a funcionalidade "Município", para inserir estas informações no
documento digital.

Antes de cadastrar a Faixa CEP, deve-se, primeiramente, inserir os municípios de cada Unidade
Federal (UF).

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Cadastrar > Localidade > Município

Atalho: MunicipioB

 Localize os municípios efetuando a seleção dos campos no filtro de pesquisa.

84
Inclusão de Município:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:

 Preencha os campos:
o UF: Selecione a UF de acordo com a listagem;
o Código Município: Insira o código do município. Através do site:
http://www.ibge.gov.br/home/geociencias/areaterritorial/principal.shtm
o Campo "Informações Complementares":
 Código SEF: Inserir Código SEF. (Preenchimento não obrigatório);
 Ind Emite Rel: Quando selecionado, é emitido Relatório com informações
sobre Município;
 Emite Re. Mov. ISS: Registrar se é emitente ou não (Preenchimento não
obrigatório);
 Percentual de Rateio - DIC - SE: Inserir Percentual (Preenchimento não
obrigatório);
 Cód. SIAFI: Insira o código do município. Através do site:
http://www.mi.gov.br/pt/c/document_library/get_file?uuid=3e343d1c-
d559-4845-bee6-20337340be53&groupId=10157

86
 Ind Recibo ISS CNPJ: Caso possua Recibo de ISS por CNPJ, deve ser
selecionado;
 Ind Imprime RG Termo: Marcando essa opção, é emitido Relatório de RG
Termo;
o Campo "Intervalo de CEP":
 CEP Inicial: Código de Endereço Postal inicial do município informado;
 CEP Final: Código de Endereço Postal final do município informado.

 Salve a operação .

Alteração de Município:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


 Altere os campos;
 Salve a operação .

Exclusão de Município:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

 Confirme ou não a exclusão.

88
Faixa de CEP
Para inserir o código de município do fator gerador, bem como do município do destinatário no
XML. O sistema verifica o número do CEP e de acordo com a faixa, é inserido o dado na NF-e.

Para acessar a funcionalidade acesse o menu indicado a seguir:

Menu: Cadastrar > Localidade > Faixa de CEP

Atalho: FACEP

Selecione os campos no filtro de pesquisa para listar as faixas de CEP.

Inclusão de Faixa de CEP:


 Selecione a opção - Novo;
 Será exibida a tela abaixo:

 Preencha os campos:
o Sigla UF: Selecione a UF;
o Município: Escolha o município com o auxílio da lista;
o CEP Inicial: Insira a faixa inicial do CEP;
o CEP Final: Registre a faixa final do CEP;

 Salve a operação .

Alteração de Faixa de CEP:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


 Altere os campos;

 Clicar em - Salvar para gravar os dados alterados.


90
Exclusão de Faixa de CEP:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir. O sistema apresentará a seguinte


mensagem:

 Confirme ou não a exclusão.


Localização da Faixa de CEP Correta
 Site dos correios: www.correios.com.br;

 Na página principal no campo "Busca CEP ou Endereço", clicar no sinal de (mais),


conforme destacado em vermelho na figura abaixo:

 No menu "Busca CEP" escolher a opção "Faixas de CEP":

92
 Preencher os campos, conforme indicado:
o Localidade: Informe o município desejado;
o UF: Escolha o estado em que se encontra a cidade;
 Em seguida, clicar no botão BUSCAR para pesquisar a faixa de CEP da localidade
informada:
 Será apresentado o resultado da pesquisa:

94
Registre o resultado no cadastro da Faixa de CEP no Comply e-Docs.
Usuário Inbound
Cadastro de usuários e senhas para autorização de uso do Client Inbound. O componente Client
Inbound ou o WS Inbound são ferramentas para inserção de XMLs no banco de dados do Comply e-
Docs, devido a sua criticidade esta operação necessita de um senha para autorização.

Para acessar a funcionalidade acesse o menu indicado a seguir:

Menu: Cadastrar > Usuário Inbound

Atalho: USUINB

Selecione os campos no filtro de pesquisa para listar os usuários cadastrados.

Inclusão de Usuário:

 Selecione a opção - Novo;


 Será exibida a tela abaixo:
96
 Preencha os campos:
o Usuário: login do usuário;
o Senha: Senha do usuário.

 Salve a operação .

Alteração de Usuário:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


 Altere os campos;

 Clicar em - Salvar para gravar os dados alterados.

Exclusão de Usuário:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;


 Na seqüência selecione a opção - Excluir. O sistema apresentará a seguinte
mensagem:

 Confirme ou não a exclusão;

 Caso confirme, é indicada a exclusão;

98
Representante Legal
Para identificar os representantes legais responsáveis pela integridade das informações enviadas
à Secretaria da Fazenda, cadastre os respectivos dados.

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Cadastrar > Matriz/Filial > Representante Legal

Atalho: REPLEGAL

 Selecione os campos no filtro de pesquisa para listar os Representantes Legais


cadastrados.

Inclusão de Representante Legal:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:
 Preencha os campos:
o Nome: Informar o nome do Representante Legal;
o CNPJ/CPF: Dado do Representante Legal;
o RG: Inserir o RG do Representante Legal;
o Status: Código ou descrição do status do Representante Legal;
o E-mail: Registre o e-mail do Representante Legal;
o Campo "Endereço":
 Tipo de Logradouro: Informar o tipo de logradouro. Exemplo: Rua,
Avenida, etc.;
 Logradouro: Informar o endereço;
 Número: Informar o número onde está localizado o estabelecimento;
100
 Bairro: Informar o bairro de localização do endereço;
 Complemento: Informar complemento de endereço, caso haja. Exemplo:
Conjunto, Sala, Andar, etc.;
 Cód. UF: Escolher na lista a sigla da UF onde está localizado o
estabelecimento;
 Município: Escolher na lista o nome do município onde está localizado o
estabelecimento;
 CEP: Informar o código de endereçamento postal;
 Telefone: Informar o DDD e o número do telefone para contato com o
Representante Legal;
 Fax: Informar o DDD e número de fax do estabelecimento ou do
Representante Legal;
 Caixa Postal: Informar número da caixa postal do Representante Legal,
caso tenha;
 CEP da Portal: Informar o CEP da caixa postal.

o Campo "Informações de C.R.C":

 Padrão: Selecionar , se o contador é responsável em responder pela


empresa para Receita Federal, caso contrário, não deve ser selecionado;
 CRC: Inserir o número do C.R.C do Representante Legal;
 UF: Unidade de Federação do Representante Legal. Selecionar na lista de
auxilio ao preenchimento.

 Salve a operação clicando em - Salvar.

Alteração de Representante Legal:


 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


 Altere os campos;

 Salve a operação .

Exclusão de Representante Legal:


 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

 Confirme ou não a exclusão.

Se o Representante Legal estiver vinculado a outros registros, não será permitida a exclusão do
registro.

102
Índice
Um índice mede a variação dos valores monetários. Para informar o índice no qual a Matriz se
enquadra, deverão ser cadastrados os índices monetários.

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Cadastrar > Matriz/Filial > Índice

Atalho: INDC

 Selecione os campos no filtro de pesquisa para listar os índices cadastrados.

Inclusão de Índice:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:
 Preencha os Campos:
o Cód. Índice: Insira o código do índice, informado pelo usuário;
o Descrição: Registre a descrição do índice, informado pelo usuário;
o Tipo: Selecionar o Tipo do Índice;
o Campo "Dados Básicos": FALTA DESCRIÇÃO DO CAMPO;

 Para informar dados neste campo, clicar em - Novo;


 Será exibida a tela abaixo:

104
 Preencher os campos conforme indicado a seguir:
 Valor Índice: Informar o Valor do Índice;
 Qtd. Dias: Informar a quantidade de dias para o Índice;
 Valor Rateio Dia: Informar o Valor de Rateio Diário;
 Valor Rateio Mês: Informar o Valor de Rateio Mensal;
 Taxa Acumulada: Informar a Taxa Acumulada;
 Campo "Vigências":
 Início Vigência: Data inicial de Vigência do Índice;
 Término Vigência: Data Final de Vigência do Índice.

 Clicar em - Salvar para gravar os dados informados.

 Salvar a operação .

Todos os campos são de preenchimento obrigatório.

Alteração de Índice:

 Efetue a pesquisa;
 Selecione o registro;
 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


Somente o campo Descrição estará disponível para alteração.
 Altere os campos;

 Salve a operação .

Exclusão de Índice:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir. O sistema apresentará a seguinte


mensagem:

 Confirme ou não a exclusão.

Se o índice estiver vinculado a outros registros, não será permitida a exclusão do registro.

106
Matriz
A Matriz é fundamental para que o sistema localize e envie as notas fiscais à Secretaria da
Fazenda, providencie a definição de validações, prioridades de envio dos documentos e outras
funcionalidades.

Para visualizar a funcionalidade acesse o menu:

Menu: Cadastrar > Matriz/Filial > Matriz

Atalho: MATBSC

 Selecione os campos no filtro de pesquisa para listar as Matrizes cadastradas:

Inclusão de Matriz:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:
 Preencha os campos, conforme indicado a seguir:
 Aba "Dados Básicos":

108
o Campo "Informações Principais":
o Razão Social: Razão Social da Matriz;
o Início Vigência: Início da Vigência do CNPJ;
o CNPJ: Número do Cadastro Nacional de Pessoa Jurídica da Matriz;
o Término da Vigência: Término da Vigência do CNPJ;
o Campo "Endereço":
 Tipo Logradouro: Rua, Avenida, Via, etc.;
 Logradouro: Nome da Rua, Avenida, Via onde a Matriz se situa;
 Número: Número do estabelecimento onde a Matriz se situa;
 Bairro: Bairro do estabelecimento onde a Matriz se situa;
 Complemento: Apto, Sala, etc.;
 CEP: Código de Endereço Postal da Matriz;
 UF: Unidade de Federação da Matriz (selecionar na lista de auxilio ao
preenchimento);
 Município: Descrição do Município conforme tabela do IBGE;
 Caixa Postal: Número da Caixa Postal da Matriz;
 CEP Caixa Postal: CEP da Caixa Postal da Matriz.
o Campo "Inscrições":
 Código CAEF: Código de Atividade Econômica Federal referente à Matriz;
 Código CNAE: Código Nacional de Atividade Estadual referente à Matriz;
 Inscrição NIT: Número da Inscrição Número de Inscrição do Trabalhador
referente à Matriz;
 Inscrição SUFRAMA: Número da Inscrição SUFRAMA referente à Matriz;
 Inscrição Estadual: Número da Inscrição no Estado referente à Matriz;
 Inscrição CEI: Número da Inscrição CEI referente à Matriz;
 Dt. Opção Conv ICMS: Data da opção de Inscrição do ICMS na Junta
Comercial;
 Município: Descrição do Município;
 Inscrição Junta: Código de Inscrição na Junta Comercial;
 Data Inscrição Junta: Data de Inscrição na Junta Comercial;
 Data Inscrição Junta Conv: Data de Inscrição do Convênio na Junta
Comercial.

 Clicar em - Salvar para gravar os dados informados.


 Aba "Representante Legal":

o Tipo de Representante: Selecionar o tipo de representante. Exemplo:


Representante Legal Federal;
o Representante Legal: Selecionar o nome do Representante Legal;

110
o Início Vigência: Informar a data de início da vigência do Representante Legal;
o Término Vigência: Informar a data de término da vigência do Representante
Legal;

o Clicar em - Salvar para gravar os dados informados.

Alteração de Matriz:
 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


 Altere os campos;

 Salve a operação .

Exclusão da Matriz:

Uma Matriz não pode ser excluída, o sistema permite a alteração do status para ‘inativo’
caso a mesma não exista no cadastro.
Filial
Para o sistema localizar as notas fiscais e enviá-las à Secretaria da Fazenda, é necessário além de
uma Matriz, uma Filial na qual será utilizada também para definição de validações, prioridades
de envio dos documentos e outras funcionalidades deste sistema.

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Cadastrar > Matriz/Filial > Filial

Atalho: MNTFIL

 Selecione os campos no filtro de pesquisa para listar as Filiais cadastradas:

Inclusão de Filial:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:

112
 Preencha os campos:
o Matriz: Selecionar a Matriz a qual a Filial a ser cadastrada pertence;
o Código Filial: Criar um código que facilite a identificação da Filial;
o Nome Fantasia Filial: Informar o nome fantasia da Filial;
o E-mail: Informar o endereço eletrônico; da Filial;
o Status: Selecionar o código de uma das situações disponíveis na lista de seleção
do campo;
o DDD - Tel: Informar o código de área do telefone;
o Telefone: Informar o número do telefone;
o DDD - Fax: Código de área do telefone do fax;
o Fax: Informar o número do telefone do fax;
o Segmento de Negócio: Informar a natureza da atividade que a empresa exerce
perante o Estado.
o Aba "Centralizadora":

 Clicar em - Novo;
 Será exibida a tela abaixo:
 Preencher os campos, conforme indicado a seguir:
 Tipo Obrigação: Selecionar o Tipo de Obrigação;
 Filial Associada: Selecionar a Filial Associada à Obrigação;
 Início Vigência: Inicio da Vigência da Filial;
 Término Vigência: Término da Vigência da Filial.
o Aba "Representantes":

 Clicar em - Novo;
 Será exibida a tela abaixo:

114
 Preencher os campos, conforme indicado a seguir:
 Tipo Representante: Selecionar o tipo de representante.
Exemplo: Representante Legal Federal;
 Nome: Selecionar o nome do Representante Legal;
 Início Vigência: Informar a data de início da vigência do
Representante Legal;
 Término Vigência: Informar a data de término da vigência do
Representante Legal.

 Clicar em - Salvar para gravar os dados informados.


o Aba "Dados Básicos":

 Clicar em - Novo;
 Será exibida a tela abaixo:

 Preencher os campos, conforme indicado a seguir:


 Campo "Informações Principais":
 Razão Social: Informar a razão Social da Filial;
 CNPJ: Número do Cadastro Nacional de Pessoa Jurídica da Filial
(Dados originados do SAP);
 Início Vigência: Informar a data de início de vigência da Filial;
 Término Vigência: Informar a data de término de vigência da
Filial.
 Campo "Endereço":
 Tipo Logradouro: Rua, Avenida, Via, etc.;
 Logradouro: Nome da Rua, Avenida, Via onde a Filial se situa;
 Número: Número estabelecimento onde a Filial se situa;
 Complemento: Apto, Sala, etc.;
 Bairro: Bairro estabelecimento onde a Filial se situa;
 UF: Unidade de Federação da Filial (selecionar na lista de auxilio
ao preenchimento);
 Município: Nome do município onde a Filial está situada;
 CEP: Código de Endereço Postal da Filial;
 Caixa Postal: Número da Caixa Postal da Filial;
 Estabelecimento: Tipo de atividade em que o estabelecimento se
enquadra.
 Campo "Índices":
 Federal: Utilizado para cálculo Federal;
 Estadual: o Utilizado para cálculo Estadual.

Alteração de Filial:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


Todos os campos estarão disponíveis para alteração, exceto os campos: Matriz; Descrição;
Filial; Nome da Filial e Dt. Opção ICMS.

 Altere os campos;

 Salve a operação .

116
Exclusão de Filial:

Uma Filial não poderá ser excluída, o sistema permitirá a alteração do status para ‘inativo’
caso a mesma não exista no cadastro.
Inscrição ST
Quando for operação de mercadorias que se reserva para filiais que possuem Inscrições Estaduais
de Substituição Tributária, será necessário efetuar o cadastro por filial e unidade de federação
correspondente.

Visualize a funcionalidade, acessando o menu abaixo:

Menu: Cadastrar > Matriz/Filial > Inscrição ST

Atalho: INSCSTBSC

 Selecione os campos no filtro de pesquisa para listar as Inscrições de Substituição


Tributária:

Inclusão de Inscrição ST:

 Selecione a opção - Novo;

118
 Será exibida a tela abaixo:

 Preencha os campos:
o Matriz: Código da Matriz e Nome da Matriz;
o Filial: Filial: Código da Filial e Nome da Filial;
o Inscrição/UF: Unidade de Federação da Filial (selecionar na lista de auxilio ao
preenchimento), Inscrição Estadual Sub. Tributária: Número da Inscrição no
Estado do Substituto Tributário referente à Filial e Status: Status e descrição do
status referente ao cadastro de Inscrição Estadual de Subst. Tributária
relacionada à Filial;

o Clicar em - Salvar para gravar os dados informados.


Os campos: Matriz; Filial e Inscrição Estadual Sub. Tributária são de preenchimento
obrigatório.

Alteração de Inscrição ST:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


Apenas os campos Inscrição Estadual ST e Status estarão disponíveis para alteração.
 Altere os campos;

 Salve a operação .

Exclusão de Inscrição ST:

 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir. O sistema apresentará a seguinte


mensagem:

 Confirme ou não a exclusão. O sistema apresentará a seguinte mensagem:

 Clique em ‘OK’.

120
Configuração de Filial
Para determinar as particularidades de cada filial, deverá ser configurado os campos na tela
“Configuração de Filial".

Visualize a funcionalidade, acessando o menu abaixo:

Menu: Cadastrar > Matriz/Filial > Configuração de Filial

Atalho: CFGFIL

 Selecione os campos no filtro de pesquisa para listar as configurações das Filiais


cadastradas.

Inclusão de Configuração da Filial:

 Selecione a opção - Novo;


 Será exibida a tela abaixo:
 Preencha os campos:
o Matriz: Código da Matriz e Nome da Matriz;
o Filial: Código da Filial e Nome da Filial;
o Ambiente: Selecionar o ambiente em que a filial se posiciona no momento
(Homologação/Produção);
o Campo "DANFE":
 Logo DANFE: Caso haja diferenças de logos entre matrizes ou filiais,
poderá ser parametrizado com o nome do arquivo, para que o aplicativo
assuma no DANFE a diversidade de logos.
o Campo "E-mail do Remetente":
 E-mail: Cadastrar e-mail para o envio do DANFE em pdf.
 Cadastrar e-mail do Remetente do Envio de XML e DANFE via PDF.
o Campo "Personalização de E-mail":
 Padrão Envio: Informar Padrão de Envio do XML;
 Padrão Cancelamento: Informar Padrão de Cancelamento do XML;
 Padrão Inutilização: Informar Padrão de Inutilização do XML.
o Campo "Credenciamento":

122
 Número: Número do Credenciamento do emissor de nota fiscal
eletrônica;
 Data: Determinar a data do Credenciamento;
 Código do Regime Tributário: Determinar o código do Regime Tributário:
1 – Simples Nacional, 2 – Simples Nacional – excesso de sublimite de
receita bruta e 3 – Regime Normal.
o Campo "Impressão de DANFE em PDF": Marcar umas das opções disponíveis:
 PDF: Somente para envio de DANFE via pdf por e-mail;
 Normal: Somente envio de XML de Distribuição;
 Ambos: Envio de PDF e XML de Distribuição via e-mail.
o Campo "Tipo de Emissão": Selecionar uma das opções disponíveis:
 DPEC: Determina que o tipo de emissão que deve ser utilizado para
aquela filial caso o sistema Comply e-Docs esteja configurado para
contingência automática é DPEC;
 SCAN: Determina que o tipo de emissão que deve ser utilizado para
aquela filial caso o sistema Comply e-Docs esteja configurado para
contingência automática é SCAN;
 FS: Determina que o tipo de emissão que deve ser utilizado para aquela
filial caso o sistema Comply e-Docs esteja configurado para contingência
automática é Formulário de Segurança;
 FS-DA: Determina que o tipo de emissão que deve ser utilizado para
aquela filial caso o sistema Comply e-Docs esteja configurado para
contingência automática é FS-DA;
 Nenhum: Determina que não sera utilizado nenhum tipo de emissão para
contingência automática;
o Campo NFS-e Incentivador Cultural:
 Determina para notas fiscais de serviço se possui incentivador cultural sim
ou não;
o Campo "E-pin":
 Cadastrar diretório / local para o E-pin.
o Campo Manifesto de Destinário:
 Indicador NF-e Consultada: Parâmetro utilizado para a seleção das NF-es
que serão consultadas na SEFAZ. Seus valores possíveis são: 0 – Todas as
NF-e; ou 1 – Somente as NF-e que ainda não tiveram manifestação do
destinatário (Desconhecimento da operação, Operação não Realizada ou
Confirmação da Operação); ou 2 – Idem anterior, incluindo as NF-e que
também não tiveram a Ciência da Operação;
 Indicador de Emissor da NF-e: Parâmetro utilizado para a seleção de quais
Emissores serão selecionados para as NF-es consultadas na SEFAZ. Seus
valores possíveis são: 0 – Todos os Emitentes / Remetentes; ou 1 –
Somente as NF-e emitidas por emissores / remetentes que não tenham a
mesma raiz do CNPJ do destinatário (para excluir as notas fiscais de
transferência entre filiais);
 Consulta Documentos Destinados: Habilita a Filial visualizada ao
Download de Documentos Destinados, ou seja, as NF-es emitidas para
esta filial serão consultadas e trazidas ao sistema.
 Utiliza Manifesto Temporário: Funcionalidade em desenvolvimento.

 Clicar em - Salvar para gravar os dados informados.

Os campos: Matriz; Filial e Inscrição Estadual Sub. Tributária são de preenchimento obrigatório; A
prioridade para definição de contingência é a seguinte: FS, DPEC, SCAN e DPEC.

Personalização de Email
Introdução
A funcionalidade de personalização de email permite ao cliente customizar o formato como seus
emails são enviados aos destinatários da NF-e.

Os emails personalizados são criados em formato HTML e durante o processo de geração do Email,
eles recebem informações do XML de NF-e que será anexado neste mesmo email. Estas
informações podem ser utilizadas no arquivo HTML, permitindo assim, utilizar quase todas as tags
de um determinado arquivo XML para entregar mais informações da NF-e descritas no corpo do
email.

Configurações Necessárias
Para estar habilitado a enviar um email personalizado são necessárias algumas configurações no
sistema Comply e-Docs.

Configuração de Filial:

É necessário configurar o nome dos arquivos HTMLs utilizados para a geração do email
personalizado em HTML.

Na transação “Configuração de Filial” e “Configuração Municipal de Filial” do componente


Framework, que pode ser acessada através do caminho: Cadastrar > Matriz / Filial > Configuração
de Filial ou Configuração Municipal de Filial, é possível configurar as informações de email
conforme abaixo:

124
Os nomes destes arquivos devem bater com os arquivos encontrados na pasta HTML do Comply e-
Docs Server:
Personalizar o HTML
É possível personalizar o arquivo HTML com qualquer ferramenta de mercado de
desenvolvimento. Em nosso exemplo utilizaremos o MS Visual Studio 2010.

Para personalizar o arquivo é necessário abrí-lo na ferramenta desejada e alterar o conteúdo da


página HTML. Para que o Comply e-Docs Server entenda que deve substituir um valor no HTML
pelo conteúdo do XML, é necessário utilizar a seguinte formatação:

• Para Email de Distribuição de NF-e: Somente informações disponíveis até o terceiro grupo
hierárquico. Exemplo:
 [dest].[xNome] – Neste caso será extraído a Razão Social do destinatário;
 [total].[ICMSTot].[vNF] – Neste caso será extraído o Valor Total da Nota.

*Não recomendamos utilizar as tags do grupo prod dado que não é possível extrair informações
em nível de item.

• Para Email de Distribuição de Cancelamento: Somente informações disponíveis abaixo do


grupo cancNFe. Exemplo:
 [infCanc].[chNFe] – Neste caso será extraída a Chave de Acesso da NF-e
cancelada;
 [infCanc].[xJust] – Neste caso será extraída a Justificativa de Cancelamento da
NF-e.

• Para Email de Distribuição de Inutilização: Somente informações disponíveis abaixo do


grupo inutNFe. Exemplo:
 [infInut].[nNFIni] – Neste caso será extraído o número inicial da faixa a ser
inutilizada;
 [infInut].[serie] – Neste caso será extraída a séria da NF-e.

• Para Email de Distribuição de Evento: Somente informações disponíveis abaixo do grupo


evento. Exemplo:
 [infEvento].[detEvento].[descEvento] – Neste caso será extraída a descrição do
Evento;
 [infEvento].[detEvento].[xCorrecao] – Neste caso serão extraídas as informações da
carta de correção eletrônica..

126
Alteração de Configuração da Filial:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


 Altere os campos;

 Clicar em - Salvar para gravar os dados informados.

Exclusão de Configuração da Filial:

 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir. O sistema apresentará a seguinte


mensagem:

 Confirme ou não a exclusão. O sistema apresentará a seguinte mensagem:

 Clique em "OK".
Configuração de Matriz
Para determinar as particularidades de cada Matriz, deverão ser configurados os campos na tela
“Configuração de Matriz”.

Visualize a funcionalidade, acessando o menu abaixo:

Menu: Cadastrar > Matriz/Filial > Configuração de Matriz

Atalho: CFGMAT

 Selecione os campos no filtro de pesquisa para listar as configurações das Filiais


cadastradas:

Inclusão de Configuração da Matriz:

128
 Selecione a opção - Novo;
 Será exibida a tela abaixo:

 Preencha os campos:
o Matriz: Selecionar o Código da Matriz;
o Campo "Usar certificado global": Determina se o certificado utilizado para
assinatura de XMLs é global, ou seja, se é utilizado para assinar XMLs emitidos por
todas as filiais relacionadas a ela. Caso a configuração seja não, será necessário
possuir um certificado para cada filial. Selecionar uma das opção disponíveis:
"Sim" ou "Não";
o Campo "Usar nome fantasia": o Determina se será utilizado nome fantasia para a
matriz selecionada. Selecionar uma das opção disponíveis: "Sim" ou "Não";
o Campo "HSM":
o Usuário: Determina se o usuário de autenticação no Servidor HSM;
o Senha: Determina a senha do usuário de autenticação no Servidor HSM;
o URL: Determina o endereço do Servidor HSM;
o Chave do Certificado: Determina a Chave Pública do Certificado no
Servidor HSM;
o Identificação do Certificado: Determina o Identificador do Certificado de
autenticação no Servidor HSM.
o Campo "Encriptado": Determina se o método de comunicação com o Servidor
HSM utiliza criptografia. Selecionar uma das opção disponíveis: "Sim" ou "Não";
o Campo "Utiliza Load Balance": Determina se o método de comunicação com o
Servidor HSM utiliza balanceamento de carga. Selecionar uma das opção
disponíveis: "Sim" ou "Não";
o Biblioteca: Determina a biblioteca (.dll) a ser utilizada pelo sistema para acesso
ao sistema ao HSM;
o Classe: Determina a biblioteca (.dll) a ser utilizada pelo sistema para acesso ao
sistema ao HSM.

o Clicar em - Salvar para gravar os dados informados.

Os campos: Matriz, Usar Certificado Global e Usar Nome Fantasia são de preenchimento
obrigatório; A utilização de HSM não é obrigatória. As configurações descritas são compatíveis
apenas com o HSM da True Access modelo Net-D Fence.

Alteração de Configuração da Matriz:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


 Altere os campos;

 Clicar em - Salvar para gravar a operação.

130
Exclusão de Configuração da Matriz:

 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir. O sistema apresentará a seguinte


mensagem:

 Confirme ou não a exclusão. O sistema apresentará a seguinte mensagem:

 Clique em ‘OK’.
Configuração Municipal de Filial
Para determinar as particularidades de cada filial para cada município, deverá ser configurado os
campos na tela “Configuração Municipal de Filial".

Visualize a funcionalidade, acessando o menu abaixo:

Menu: Cadastrar > Matriz/Filial > Configuração Municipal de Filial

Atalho: NFSCFILIAL

 Selecione os campos no filtro de pesquisa para listar as configurações das Filiais


cadastradas.

Inclusão de Configuração Municipal de Filial:

132
 Selecione a opção - Novo;
 Será exibida a tela abaixo:
 Preencha os campos:
134
o Matriz: Código da Matriz e Nome da Matriz;
o Filial: Código da Filial e Nome da Filial;
o Ambiente: Selecionar o ambiente que a filial se posiciona no momento
(Homologação/Produção);
o AEDF: Código da AUTORIZAÇÃO DE EMISSÃO DE DOCUMENTOS FISCAIS;
o Regime Especial de Tributação: Campo de seleção do Regime Especial de
Tributação, utilizado para o município que possui leiaute ABRASF;
o Op. Simples Nacional: Selecionar se a filial é Simples Nacional;
o Impressão de Nota Fiscal de Serviço: Opções de “Imprimir”, “Salvar e PDF”, os
dois tipos, ou nenhum deles;
o Impressão de Recibo Provisório de Serviços: Opções “Impressão Automática”,
para a impressão automática do RPS, “Para Processo no Caso de Erro”, para a
paralização do processo caso ocorra erro de impressão do RPS;
o Nome do Logo: Preencher com o nome do logo salvo na pasta “...\Comply e-Docs
Server 4.0\NFS\Imagens” para ser impresso na Nota Fiscal de Serviço e RPS;
o Brasão da Prefeitura: Preencher com o nome do logo do brasão da prefeitura
salvo na pasta “...\Comply e-Docs Server 4.0\NFS\Imagens” para ser impresso na
Nota Fiscal de Serviço e RPS;
o Envio de E-mail:Opções de envio de “PDF”, “XML”, os dois tipos e nenhum deles;
o E-mail Remetente: Campo para cadastrar o e-mail do Remetente para o envio da
Nota;
o E-mail Destinatário: Campo para cadastrar o e-mail do Destinatário do envio da
Nota;
o Assunto E-mail: Campo para cadastrar o assunto do e-mail;

 Clicar em - Salvar para gravar os dados informados.

Os campos: Matriz; Filial e Inscrição Municipal são de preenchimento obrigatório;

Alteração de Configuração Municipal de Filial:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na sequência selecione a opção - Editar;


 Altere os campos;

 Clicar em - Salvar para gravar os dados informados.

Exclusão de Configuração Municipal de Filial:

 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na sequência selecione a opção - Excluir. O sistema apresentará a seguinte


mensagem:

 Confirme ou não a exclusão. O sistema apresentará a seguinte mensagem:

 Clique em "OK".

136
Servidor
Local onde se encontra o Comply e-Docs Server da NF-e.

Para visualizar a funcionalidade, acesse o menu indicado abaixo:

Menu: Cadastrar > Servidor

Atalho: CADSERV

Selecionar os campos no filtro de pesquisa para listar os servidores cadastrados no sistema:

Inclusão de Servidor:
 Selecione o botão - Novo;
 Será exibida a seguinte tela:

 Preencha os campos:
o Código Servidor: Código do servidor no sistema;
o Descrição: Descrição do servidor no sistema;
o URL: É o nome (hostname) do servidor;
o Número máximo de threads: Informação que define o limite de Threads que o
servidor suporta;

o Salve a operação .

Alteração de Servidor:

 Efetue a pesquisa;
 Seleciono registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


 Altere os campos;

138
 Salvar a operação .

Exclusão de Servidor:
 Selecionar o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

 Confirmar ou não a exclusão;


 Caso a exclusão seja confirmada, o sistema emite a seguinte mensagem:

 Clique em "OK".

As informações sobre o Servidor poderão ser adquiridas através da área de TI da empresa.


Usuário
Esta funcionalidade é utilizada para cadastrar usuários para acesso ao sistema.

Para visualizar a funcionalidade acesse o menu abaixo:

Menu: Cadastrar > Usuário

Atalho: USU

 Selecione os campos no filtro de pesquisa para listar usuários cadastrados no sistema.

Inclusão de Usuário:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:

140
 Preencha os campos:
o Usuário: Nome do Usuário do sistema;
o Login: Acesso do usuário ao aplicativo;
o Senha: Senha do usuário novo;
o Active Directory Id: Identificador utilizado quando o usuário acessa o sistema
diretamente após ter efetuado o login na rede (poderá ser usado o mesmo login
de rede do usuário);
o Endereço Eletrônico: E-mail do usuário;
o Grupo: Restringe o acesso às funções do sistema;
o Unidade de Negócio: Filial do usuário.
o Ativo: Opção utilizada para definir se o usuário é ativo no sistema, caso
contrário, não marque este campo.

o Salve a operação .
Os campos: Usuário e Login são de preenchimento obrigatório.

Alteração de Usuário:
 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;



Apenas o campo Login não estará disponível para alteração.
 Altere os campos;

 Salve a operação .

Exclusão de Usuário:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

 Confirme ou não a exclusão.

Se o usuário estiver vinculado a outras operações do sistema, como a uma filial, não será
permitida a exclusão do registro.

142
Usuário x Filial
Para atrelar as filiais de acesso por usuário, deverá ser realizadas algumas parametrizações na
tela "UsuárioXFilial".

Visualize a funcionalidade, acessando o menu abaixo:

Menu:Cadastrar > Usuário > Usuário X Filial

Atalho: ASCUSUFIL
 Selecione o Usuário que deverá ter acesso às filiais;
 Escolha a Matriz;
 O sistema listará todas as filiais existentes para a Matriz selecionada;
 Replique os dados do campo “Filiais Não Selecionadas” para “Filiais Selecionadas”
através da opção ;

 Clicar em - Salvar para gravar os dados da operação.

Para selecionar todas as filiais e direcionar para a coluna à esquerda ‘Filiais Selecionadas’,
clique em , permitindo o acesso a todas as filiais para o usuário; para retirar a autorização
das filiais do usuário, faça o mesmo procedimento da inclusão, na direção dos campos Filiais Não
Selecionadas, através das opções ou .

144
Impressora
Para impressão automática do DANFE, é necessário determinar a impressora que irá emitir o
documento, ela deverá estar vinculada a uma Matriz/ Filial e / ou a um usuário e um local de
expedição para que o aplicativo efetue esta operação.

Nesta operação ocorre também a determinação do tipo de DANFE que será impresso na
impressora cadastrada, Normal ou em Contingência.

Para visualizar a funcionalidade acesse o menu indicado abaixo:

Menu: Cadastrar > Impressora > Impressora

Atalho: IMP

 Selecione os campos no filtro de pesquisa para listar as impressoras cadastradas no


sistema:

Inclusão de Impressoras:
 Selecione a opção - Novo;
 Será exibida a tela a seguir:

 Preencha os campos:
o Código Impressora: Código informado pelo usuário ao criar um cadastro novo de
Impressora;
o URL: Endereço da rede onde a impressora está localizada;
o Nome da Impressora: Nome da impressora cadastrada na rede da empresa;

o Clicar em - Salvar para gravar os dados informados.


Todos os campos são de preenchimento obrigatório.

Alteração de Impressoras:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;

Todos os campos estarão disponíveis para alteração, exceto o campo Código Impressora.

 Altere os campos;

146
 Salve a operação .

Exclusão de Impressoras:

 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir. O sistema apresentará a seguinte


mensagem:

 Confirme ou não a exclusão.

Se a impressora estiver vinculada a uma Matriz / Filial, não será permitida a exclusão do
registro.
Impressora x Filial
Cada impressora deverá ser parametrizada, para garantir maior flexibilidade e disponibilidade de
impressoras nas filiais.

Para visualizar a funcionalidade acesse o menu indicado abaixo:

Menu: Cadastrar > Impressora > Impressora X Filial

Atalho: IMF

 Selecione os campos no filtro de pesquisa para listar as impressoras vinculadas a Filial:

Inclusão de Impressora x Filial:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:

148
 Preencha os Campos:
o Cód. Impressora: Código da Impressora já determinado no ato de cadastrar a
impressora;
o Usuário Nota Fiscal: Usuário que emitiu a nota fiscal na origem;
o Local de Expedição: Local de expedição do sistema de origem;
o Tipo de Impressão: Tipo de documento que será impresso na impressora, Todos,
Normal, FS (Formulário de Segurança), SCAN, DPEC, FSDA;
o Vias: Quantidade de Vias para a impressão;
o Matriz: Código da Matriz (selecionar na lista de auxilio ao preenchimento);
o Filial: Código da Filial (selecionar na lista de auxilio ao preenchimento);

o Salve a operação .
Todos os campos são de preenchimento obrigatório, exceto os campos: Usuário da Nota Fiscal
e Local de Expedição.

Alteração dos Dados Associados:

 Efetue a pesquisa;
 Selecione o registro;
 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


Todos os campos estarão disponíveis para alteração, exceto o campo Código Impressora.

 Altere os campos;

 Salve a operação .

Exclusão dos Dados Associados:

 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir. O sistema apresentará a seguinte


mensagem:

 Confirme ou não a exclusão.

150
Web Services Estadual
Para a comunicação entre o emitente de Nota Fiscal Eletrônica e a SEFAZ, em função de envio e
recepção de mensagens/ lotes de notas fiscais gerados pelo aplicativo por WebServices da
Secretaria da Fazenda, será necessária a definição de um endereço, que deverá estar vinculado a
UF da SEFAZ que processará as notas fiscais eletrônicas.

O pw. NF-e disponibiliza duas (02) opções de cadastramento, uma cadastra o endereço do
WebService e outra que vincula este WebService a Unidade de Federação.

Para visualizar a funcionalidade, acesse o menu indicado abaixo:

Menu: Cadastrar > WebServices > WebService

Atalho: WS
 Selecione os campos no filtro de pesquisa para listar as impressoras cadastradas no
sistema:

Inclusão do WebService:
 Selecione a opção - Novo;
 Será exibida a tela a seguir:

 Preencha os campos:
o Código Serviço: Código informado pelo usuário;
o Status: Status do Serviço;

152
o Código de WS Manifesto: Utilizado para redirecionar os envios de Eventos para
NF-es de Inbound e os Métodos de Documentos Destinados e Download NF-e.
Atualmente a única UF que possui ambiente para estes tipos de envio é “RS”. As
demais UFs devem utilizar o Ambiente Nacional. Abaixo um exemplo de
preenchimento do Ambiente Nacional.
o Descrição: Descrição do serviço;
o Cabeçalho: Definir cabeçalho Padrão;
o Método de Envio de Lote: Endereço (IP, URL etc.) para envio de lote;
o Método de Solicitação do Lote: Endereço (IP, URL etc.) para solicitação de lote;
o Método de Cancelamento: Endereço (IP, URL etc.) para cancelamento de lote;
o Método de Consulta: Endereço (IP, URL etc.) para consulta de lote;
o Método de Consulta do Status: Endereço (IP, URL etc.) para verificação de status
do lote;
o Método de Inutilização: Endereço (IP, URL etc.) para inutilização do lote;
o Método de Consulta Situação Cliente: Endereço (IP, URL etc.) para verificação
da situação do cliente na SEFAZ;
o Método de Evento: Endereço (IP, URL etc.) para verificação do Método utilizado;
o Metodo de Consulta Documentos Destinados: Endereço (IP, URL etc.) para
verificação do Método utilizado;
 Metodo de Download NF-e: Endereço (IP, URL etc.) para verificação do Método
utilizado;

Salve a operação .
Exemplo de Preenchimento do WS do Ambiente Nacional:

Coluna > Versões:


o Deverá ser informada a versão do schema de XML para cada serviço disponível.
Os campos: "Código Serviço" e "Descrição" são de preenchimento obrigatório; Os WebServices e
as versões do schema de XML estão disponíveis no site da SEFAZ Nacional /Estadual e no Manual
de Integração do Contribuinte.

Alteração de WebService:
154
 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


Todos os campos estarão disponíveis para alteração, exceto o campo "Código do Serviço".
 Altere os campos;

 Salve a operação .

Exclusão dos Dados Associados:

 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

 Confirme ou não a exclusão.

Se a WebService estiver vinculada a uma UF, não será permitida a exclusão do registro.
WebService x UF
Cada Estado do Brasil possui seus respectivos WebServices, para associá-los por Unidade Federal,
parametrize a tela WebService por UF.

Visualize a funcionalidade, acessando o menu abaixo:

Menu: Cadastrar > WebServices > WebService x UF

Atalho: WSUF

 Selecione os campos no filtro de pesquisa para listar os WebServices já vinculados a uma


UF:

Associar UF a um WebService:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:
156
 Preencha os Campos:
o Ordem: Determine a ordem de utilização do WebService. Caso exista mais de um
WebService associado à mesma UF a prioridade de transmissão será para o
WebService com o menor número;
o UF: Unidade de Federação do WebService que irá receber o arquivo (selecione na
lista de auxilio ao preenchimento).
o WebService: Endereço (URL) parametrizado no cadastro de WebServices, no
subitem 1 do item 7 deste manual (selecione na lista de auxilio ao
preenchimento).
o Número de Tentativas: Defina o número de tentativas de conexão com o
WebService. No caso de falha na comunicação com a SEFAZ, o Comply e-Docs
tentará o número de vezes determinado neste parâmetro antes de determinar
que uma NF-e não pode ser transmitida.

o Salve a operação .

Todos os campos são de preenchimento obrigatório.

Alteração de WebService por UF:


 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


Todos os campos estarão disponíveis para alteração.
 Altere os campos;
 Salve a operação .

Exclusão de WebService por UF:


 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

 Confirme ou não a exclusão.

158
WebService x Filial
Cada Estado do Brasil possui seus respectivos WebServices, para associá-las por Filial,
parametrize a tela WebService por Filial.

Somente realize este cadastro caso seja estritamente necessário para o negócio da empresa.

Visualize a funcionalidade, acessando o menu abaixo:

Menu: Cadastrar > WebServices > WebService x Filial

Atalho: WSF

 Selecione os campos no filtro de pesquisa para listar os WebServices já vinculados a uma


Filial:

Associar Filial a um WebService:

 Selecione a opção - Novo;


 Será exibida a seguinte tela:

 Preencha os Campos:
o Holding: Selecione a Holding;
o Matriz: Selecione a Matriz;
o Filial: Selecione a Filial;
o WebService: Selecione o WebService parametrizado no cadastro de WebServices,
no subitem 1 do item 7 deste manual (selecione na lista de auxilio ao
preenchimento);
o Tipo de Ambiente: Selecione o Tipo de Ambiente;
o Tentativas: Defina o número de tentativas de conexão com o WebService. No
caso de falha na comunicação com a SEFAZ, o Comply e-Docs tentará o número
de vezes determinado neste parâmetro antes de determinar que uma NF-e não
pode ser transmitida;
o Ordem: Defina a Ordem de prioridade deste WebService.

o Salve a operação .
Todos os campos são de preenchimento obrigatório.

Alteração de WebService por Filial:

160
 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;

Todos os campos estarão disponíveis para alteração.


 Altere os campos;

 Salve a operação .

Exclusão de WebService por Filial:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir. O sistema apresentará a seguinte


mensagem:

 Confirme ou não a exclusão.


Web Services Municipal
Para a comunicação entre o emitente de Nota Fiscal de Serviços Eletrônica e as prefeituras, em
função de envio e recepção de notas fiscais de serviços gerados pelo aplicativo por WebServices
das prefeituras, será necessária a definição de um endereço, que deverá estar vinculado ao
municípios que processará as notas fiscais eletrônicas.

Disponibiliza-se de duas (02) opções de cadastramento, uma cadastra o endereço do WebService


e outra que vincula este WebService a um município.

Para visualizar a funcionalidade, acesse o menu indicado abaixo:

Menu: Cadastrar > WebServices > Municipal > WebService

Atalho: NFSWEBSER

162
Inclusão do WebService:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:

 Preencha os campos:
o Cód. Serviço: Código informado pelo usuário;
o Status: Status do Serviço;
o Descrição Serviço: Descrição do serviço;
o URL Envio: Endereço para envio do lote;
o URL Consulta: Endereço para consulta do lote;
o URL Cancelamento: Endereço para cancelamento do lote;

 Salve a operação .

Coluna > Versões:


 Deverá ser informada a versão do schema de XML para cada serviço disponível.
Os campos: "Cód. Serviço" e "Descrição Serviço" são de preenchimento obrigatório; Os
WebServices e as versões do schema de XML estão disponíveis no site de cada prefeitura.

Alteração de WebService:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na sequência selecione a opção - Editar;

Todos os campos estarão disponíveis para alteração, exceto o campo "Cód. do Serviço".

 Altere os campos;

 Salve a operação .

Exclusão dos Dados Associados:

 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na sequência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

 Confirme ou não a exclusão.


164
Se a WebService estiver vinculada a um município, não será permitida a exclusão do registro.
WebService x Município
Cada município possui seus respectivos WebServices, para associá-los por Município, parametrize
a tela WebService por Município.

Visualize a funcionalidade, acessando o menu abaixo:

Menu: Cadastrar > WebServices > Municipal > WebService xMunicípio

Atalho: WSUF

Selecione os campos no filtro de pesquisa para listar os WebServices já vinculados a um


Município:

Associar Municipio a um WebService:

166
 Selecione a opção - Novo;
 Será exibida a tela a seguir:

 Preencha os Campos:
o Cód. Serviço: Determinar qual serviço no qual está vinculadas as WebService;
o UF: Unidade de Federação do WebService (selecione na lista para auxilio ao
preenchimento do município);
o Município: Determinar qual município será vinculado ao Serviço;
o Número Tentativas: Defina o número de tentativas de conexão com o
WebService. No caso de falha na comunicação com o município, o sistema tentará
o número de vezes determinado neste parâmetro antes de determinar que uma
NFS-e não pode ser transmitida;
o Intervalo Tentativas: Defina o número de intervalos, em segundos, para cada
tentativa de conexão com a WebService;

 Salve a operação .

Todos os campos são de preenchimento obrigatório.

Alteração de WebService por Município:


 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na sequência selecione a opção - Editar;

Todos os campos estarão disponíveis para alteração.

 Altere os campos;

 Salve a operação .

Exclusão de WebService por Município:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na sequência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

 Confirme ou não a exclusão.

168
Menu Relatórios
Eventos
Para a geração de relatório por eventos das notas fiscais, o aplicativo disponibiliza critérios para
a visualização das informações. Este relatório deve ser utilizado quando se deseja verificar um
determinado tipo de status e quais NF-es apresentaram esse status.

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Relatórios > Eventos

Atalho: RELEVEN

 Ao clicar na opção "Eventos", aparecerá o menu para a geração, visualização ou exclusão


de relatórios:

Inclusão de uma Nova Tarefa:

 Selecione a opção - Nova Tarefa;

Aba Parâmetros:
 Preencher os campos conforme indicado a seguir:
 Matriz: Escolha a Matriz;
 Filial: Selecione Filial;
 Data Emissão inicial: Marque a data da emissão da nota inicial;
 Data Emissão final: marque a data da emissão da nota final;
 Nota Fiscal: Insira o número da Nota Fiscal Eletrônica;
 Evento: Selecione o evento;
 Tipo Nota: Determine 0 (zero) para Entrada e 1 (um) para Saída;
 Grupo Evento: Determine o grupo de eventos do sistema;
 Série: Número da série da nota fiscal;
 Tipo de Emissão: Informe N para nota fiscal normal e C para nota fiscal
contingência.

170
Aba Opções do Relatório:

 Preencher os campos conforme indicado a seguir:


 Título do Relatório: Determine o título do relatório;
 Formato de Saída do Relatório: Informe em qual tipo de arquivo será
gerado o relatório;
 Destino do Relatório: O destino do arquivo depois de gerado;
 Opções: Marque as alternativas para impressão;
 Número de Cópias: Quantidade de cópias.

Aba Agendamento:
 Preencher os campos conforme indicado a seguir:
 Tipo de Agendamento:
 Executar agora: Imediatamente a execução do relatório.
 Agendar: Agende o horário para executar o relatório. Ao
selecionar esta opção, será habilitado o campo “Informações de
Agendamento”.
 Condicional: Insira uma condição para o relatório. Ao selecionar
esta opção, será habilitado o campo “Condições para execução”.
Ao selecionar esta opção o sistema exibe o campo "Condição para
execução":

172
 Intervalo entre verificações (minutos): Determine em quanto
tempo o relatório irá utilizar a condição descrita na "Função de
verificação":
 Função de verificação (C#): Insira a rotina de programação para
o relatório, na linguagem C#.
o Executar: Quando será executado;
o Data: A data que será executada a geração do relatório;
o Hora: A hora que será executado a geração do relatório;
 Clicar em “OK”.

Funções Existentes no Relatório de Eventos:

 Para Visualizar, Salvar localmente ou Salvar e Apagar do Servidor, o relatório gerado,

clicar no botão - Visualização;

 Tenha acesso às particularidades da tarefa e logs, selecionando a opção -


Propriedades da Tarefa.
 Escolha a opção “Reiniciar Tarefa”, para dar início novamente à realização da tarefa;
 Para ativar ou desativar a atualização do painel de relatórios, selecione a opção “Ligar/
Desligar Refresh Automático”.

Relatório:

174
Relatório de Manifesto
Este relatório deve ser utilizado para verificar NF-es de Inboun juntamente com seus eventos de
Manifesto do Destinatário.

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Relatórios > Relatório Manifesto

Atalho: RELMAN

 Depois de acessada a funcionalidade, é exibida a tela abaixo:

176
 Clicar no botão - Novo, para gerar o relatório;

Aba Parâmetros:

 Preencher os campos conforme indicado a seguir:


o Matriz: Escolha o dado solicitado;
o Filial: Selecione a Filial;
o Data Emissão Inicial: Data que se iniciou o log;
o Data Emissão Final: Data que se finalizou o log;
o Número da Nota: Insira o número da nota fiscal eletrônica;
o Série da Nota: Série da Nota Fiscal;
o Status Manifesto: Escolha o código que deseja pesquisar.
Log de Notas Fiscais
Este relatório deve ser utilizado para verificar NF-es que apresentaram algum erro no
processamento.

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Relatórios > Log de Notas Fiscais

Atalho: RELOGNOTAS

 Depois de acessada a funcionalidade, é exibida a tela abaixo:

 Clicar no botão - Novo, para gerar o relatório;

Aba Parâmetros:

178
 Preencher os campos conforme indicado a seguir:
o Matriz: Escolha o dado solicitado;
o Filial: Selecione a Filial;
o Data Inicio: Data que se iniciou o log;
o Data Final: Data que se finalizou o log;
o Nota Fiscal: Insira o número da nota fiscal eletrônica;
o Tipo Nota: Determine 0 (zero) Entrada e 1 (um) Saída;
o Grupo Evento: informe o grupo de eventos do sistema;
o Descrição: Insira a descrição do log;

Aba Opções do Relatório:


 Preencher os campos conforme indicado a seguir:
 Título do Relatório: Determine o título do relatório;
 Formato de Saída do Relatório: Informe em qual tipo de arquivo será gerado o
relatório;
 Destino do Relatório: O destino do arquivo depois de gerado;
 Opções: Marque as alternativas para impressão;
 Número de Cópias: Quantidade de cópias.

Aba Agendamento:

180
 Preencher os campos conforme indicado a seguir:
 Tipo de Agendamento:
 Executar agora: Imediatamente a execução do relatório.
 Agendar: Agende o horário para executar o relatório. Ao
selecionar esta opção, será habilitado o campo “Informações de
Agendamento”.
 Condicional: Insira uma condição para o relatório. Ao selecionar
esta opção, será habilitado o campo “Condições para execução”.
Ao selecionar esta opção o sistema exibe o campo "Condição para
execução":
 Intervalo entre verificações (minutos): Determine em quanto
tempo o relatório irá utilizar a condição descrita na "Função de
verificação":
 Função de verificação (C#): Insira a rotina de programação para
o relatório, na linguagem C#.
o Executar: Quando será executado;
o Data: A data que será executada a geração do relatório;
o Hora: A hora que será executado a geração do relatório;
 Clicar em “OK”.

182
Notas Reimpressas
Este relatório deve ser utilizado para verificar quais NF-es foram reimpressas pelos usuários.

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Relatórios > Notas Reimpressas

Atalho: RELNOTREI

 Depois de acessada a funcionalidade, é exibida a tela abaixo:

 Clicar no botão - Novo, para gerar o relatório;

Aba Parâmetros:
 Preencher os campos conforme indicado a seguir:
 Matriz: Selecione o dado solicitado;
 Filial: Escolha a Filial;
 Data de emissão inicial: Data de emissão da nota inicial;
 Data de emissão final: Data de emissão da nota final;
 Data de reimpressão inicial: Data de reimpressão da nota inicial;
 Data de reimpressão final: Data de reimpressão da nota final;
 Evento: Selecione o evento;
 Usuário: Determine o usuário;
 Tipo de emissão: Informe N para nota normal e C – NF contingência.
 Nota Fiscal: Insira o número da nota fiscal eletrônica;
 Série: Insira o número da série;
 Impresso (S - Sim/ N - Não): Selecionar se a nota foi impressa ou não.

184
Aba Opções do Relatório:

 Preencher os campos conforme indicado a seguir:


 Título do Relatório: Determine o título do relatório;
 Formato de Saída do Relatório: Informe em qual tipo de arquivo será gerado o
relatório;
 Destino do Relatório: O destino do arquivo depois de gerado;
 Opções: Marque as alternativas para impressão;
 Número de Cópias: Quantidade de cópias.

Aba Agendamento:
 Preencher os campos conforme indicado a seguir:
 Tipo de Agendamento:
 Executar agora: Imediatamente a execução do relatório.
 Agendar: Agende o horário para executar o relatório. Ao selecionar esta
opção, será habilitado o campo “Informações de Agendamento”.
 Condicional: Insira uma condição para o relatório. Ao selecionar esta
opção, será habilitado o campo “Condições para execução”. Ao
selecionar esta opção o sistema exibe o campo "Condição para
execução":

186
 Intervalo entre verificações (minutos): Determine em quanto tempo o
relatório irá utilizar a condição descrita na "Função de verificação":
 Função de verificação (C#): Insira a rotina de programação para o
relatório, na linguagem C#.
o Executar: Quando será executado;
o Data: A data que será executada a geração do relatório;
o Hora: A hora que será executado a geração do relatório;
 Clique em “OK”.
Menu Gerência
Regras de Validação Por Filial
Determinam as informações da Nota Fiscal que devem ser pré-validadas, antes do envio a SEFAZ.
O Comply e-Docs possui regras definidas que não permitem que uma nota fiscal com
inconsistências seja inserida em um lote e emitida à Secretaria da Fazenda. Estas validações são
opcionais.

Para visualizar a funcionalidade, acesse o menu abaixo:


Menu: Gerência > Regras de Validação por Filial

Atalho: VALIDAINF

 Clique em - Editar;
 Escolha uma Matriz de acordo com a listagem;
188
 Selecione uma ou todas as Filiais de acordo com a listagem;
 Replique as Validações das Configuráveis para Validações Configuradas através da opção
;

 Salve a operação .
O sistema permite a inclusão de todas as validações para as filiais, desta forma selecione a opção

; é possível retirar a validação da nota fiscal para determinadas filiais, neste caso efetue o
mesmo procedimento utilizado para inclusão, na direção dos campos Validações Configuradas
para Validações Configuráveis e selecione as opções ou ; as configurações podem ser
efetuadas para todas as filiais em um mesmo cadastro, selecione a Filial. O Comply e-Docs
considera que todas as filiais da Matriz possuem as regras de validações determinadas; os
preenchimento dos campos Matriz e Filial são obrigatórios.
Versão Municipal de XML
Este parâmetro define as versões de XML que são utilizadas pelo sistema para comunicação e
validação de acordo com o Schema XSD.

Para visualizar a funcionalidade, acesse o menu indicado abaixo:

Menu: Gerência > Versão Municipal de XML

Atalho: NFSVERSIMU

 Selecione a opção - Novo;


 Será exibida a tela a seguir:

 Preencha os Campos:

190
o UF: Unidade de Federação de vinculo com o leiaute do XSD e de geração de XML
(selecione na lista para auxilio ao preenchimento do município);
o Município: Determinar qual município será vinculado ao leiaute XSD e de geração
do XML;
o Nome da Dll: Descrição da Dll;
o Nome do Objeto: Nome do Objeto que utilizará essa Versão de XML;
o Ação: Descrição da Ação do XML;
o Versão XSD: Versão do XSD;
o Caminho XSD: Caminho da máquina onde se localiza o XSD desta versão de XML
na máquina onde o Serviço: “Comply e-Docs Server da NFS-e” é executado;
o Caminho XML: Caminho da máquina onde se salvar o XML gerado;

 Salve a operação .

Alteração de Parâmetro da Versão Municipal de XML:

 Selecione o registro;

 Clique em - Editar;

Todos os campos estarão disponíveis para alteração.

 Altere os campos;

 Salve a operação .
Regras de Priorização
As regras de priorização servirão para definir a prioridade de envio do lote para a Secretaria da
Fazenda, de acordo com esta parametrização, o pw. NF-e gera o lote fiscal e o insere na fila de
saída. As prioridades podem ser definidas também pelos atributos mais importantes do
documento, ou seja, informações que determinam a importância da Nota Fiscal quanto ao
negócio do contribuinte (Exemplo: CFOP de vendas, CNPJ do cliente de maior faturamento,
Matriz / Filial que possui maior movimento de faturamento, etc.).

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Gerência > Regras de Priorização

Atalho: PRIORI

 Selecione os campos no filtro de pesquisa para listar as Prioridades cadastradas:

192
Inclusão da Prioridade:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:
 Preencha os campos:
o Descrição: Descrição da prioridade;
o Número Mínimo do Lote: Número mínimo de notas que serão processadas por lote
desta prioridade;
o Número Máximo do Lote: Número máximo de notas que serão processadas por lote
desta prioridade;
o Tipo de intervalo: Informa o tipo de periodicidade, podendo ser em horas, minutos
ou segundos;
o Intervalo: Periodicidade em que os lotes que utilizam essa prioridade devem ser
processados e enviados para a SEFAZ;
o Limite de Contingência: Determina a quantidade de vezes que o lote desta
prioridade deve tentar conexão com a SEFAZ, antes de entrar em contingência;

o Clicar em - Salvar para gravar os dados informados.

Alteração da Prioridade:

 Selecione o registro;

 Clique em - Editar;

 Na seqüência selecione a opção - Editar;


194
Todos os campos estarão disponíveis para preenchimento exceto o campo Cód. Prioridade.
 Altere os campos;

 Salvar a operação .

Exclusão da Prioridade:

 Efetuar a pesquisa;
 Selecionar o registro;

 Clicar em - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

 Confirme ou não a exclusão.

O sistema não permite a exclusão de uma regra de prioridade, somente a alteração das regras já
existentes.

Determinar atributos importantes das Notas Fiscais para uma prioridade:

 Selecione o registro;

 Clique em - Outras Regras de Prioridade;

Aba CFOP:
 Selecione a opção - Novo;
 Preencha os Campos:
 Cód. CFOP: Código Fiscal da Operação da nota fiscal;
 Dígito: Digito do Código fiscal de operação;

 Salve a operação .
O campo CFOP é de preenchimento obrigatório; para exclusão de um ou mais CFOP,
selecione o registro e "Excluir".

Aba Matriz/Filial:

196
 Selecione a opção - Novo;
 Escolha a Matriz de acordo com a listagem;
 Filial de acordo com a listagem;

 Salvar a operação .

Aba CNPJ do Destinatário:


 Selecione a opção - Novo;
 Preencha os Campos:
o CNPJ do Destinatário: Código Nacional de Pessoa Jurídica do destinatário da nota
fiscal (Cliente / Fornecedor);

o Salve a operação .
Para exclusão de uma ou mais Filiais, selecione o registro e "Excluir".

Aba Tipo de Ordem:

198
 Selecione a opção - Novo;
 Preencha os Campos:
o Tipo de Ordem: Relacionado à venda da operação;

o Salve a operação .
Para excluir uma ou mais Filiais, selecione o registro e clique no botão "Excluir".

Aba Série:
 Selecione a opção - Novo;
 Preencha os Campos:
o Série: número da série da nota fiscal;

o Salve a operação .
Para excluir uma ou mais Filiais, selecione o registro e clique no botão "Excluir".

Aba Tipo de Nota Fiscal:

200
 Selecione a opção - Novo;
 Preencha os Campos:
o Tipo de Nota Fiscal: Tipo de nota fiscal que determinada pela Categoria no
sistema de origem;

o Salve a operação .
Para excluir uma ou mais Filiais, selecione o registro e clique no botão "Excluir".

O usuário pode indicar uma prioridade default, de acordo com o parâmetro


PRIORIDADE_DEFAULT_NOTA_FISCAL, que determina em qual prioridade a nota fiscal será
classificada, no caso de não se enquadrar em nenhuma das prioridades pré-definidas.
Parâmetros de Regras e Padrões
Estes parâmetros são pré-definidos pela Sonda IT. Nesta parametrização, são determinados,
valores que serão utilizados pelo sistema, mas que serão compostos por múltiplas definições do
contribuinte, podendo assim variar de acordo com cada negócio e decisão.

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Gerência > Parâmetros de Regras e Padrões

Atalho: PARAMPAD

O Comply e-Docs lista todos os parâmetros existentes no sistema.

Alteração de Regras:

202
 Selecione o grupo e em seguida o registro que será alterado;
 Preencha campo ‘Valor’ de acordo com o parâmetro:

Parâmetros do Grupo NF-e:

Parâmetro Finalidade Valor


Determina o código da
cod_holding Alfanumérico
holding
(S/N) Sim ou Não caso
positivo o sistema
tentara realizar o
utiliza_cancelamento_por_evento Alfanumérico
processo de
cancelamento por
evento.

Parâmetros do Grupo Arquivamento:


Parâmetro Finalidade Valor
maximo_arquivamento Quantidade máxima de NF-e para
arquivamento a cada execução do Numérico
processo.
maximo_consulta_arquivamento Quantidade máxima de NF-e para
consulta a cada execução do Numérico
processo.
parceiro_senha_arquivamento Senha do parceiro para
Senha
arquivamento
parceiro_usuario_arquivamento Usuário do parceiro para
Alfanumérico
arquivamento
quantidade_dias_arquivamento Quantidade em dias decorridos
para que uma NF-e concluída seja Numérico
arquivada
transmissao_utilizar_compactacao Utilizar compactação de dados na
transmissão das mensagens (S/N) S ou N
Sim ou Não.
url_frame_arquivamento Framework na Nuvem para
Alfanumérico
arquivamento.
url_serv_proc_arquivamento URL do Comply e-Docs Server na
Alfanumérico
Nuvem para arquivamento.
utiliza_arquivamento Utilizar o processo de
‘S’ ou ‘N’
arquivamento de NF-e.

204
Parâmetros do Grupo Contingência:

Parâmetro Finalidade Valor


Código do WebService que
contém os endereços para Alfanumérico (Código do
cod_ws_dpec_hom comunicação com o DPEC WebService DPEC de
no ambiente de Homologação cadastrado)
homologação.
Código do WebService que
Alfanumérico (Código do
contém os endereços para
cod_ws_dpec_prd WebService DPEC de
comunicação com o DPEC
Produção cadastrado)
no ambiente de produção.
Código do WebService que
contém os endereços para Alfanumérico (Código do
cod_ws_scan_hom comunicação como o SCAN WebService SCAN de
no ambiente de Homologação cadastrado)
homologação.
Código do WebService que
Alfanumérico (Código do
contém os endereços para
cod_ws_scan_prd WebService SCAN de
comunicação como o SCAN
Produção cadastrado)
no ambiente de produção.
Alfanumérico (Mensagem
Determina a mensagem
mensagem_padrao_contingencia que deverá preencher o
padrão para contingência.
tag xJust);
Determina que se o
sistema estiver em
contingência automática
utiliza_dpec ‘S’ ou ‘N’
os tipos de emissão das
NF-es serão convertidos
para DPEC.
Determina que se o
sistema estiver em
contingência automática
utiliza_fs 'N' ou 'S'
os tipos de emissão das
NF-es serão convertidos
para FS.
Determina que se o
sistema estiver em
contingência automática 'N' ou 'S'
utiliza_fsda
os tipos de emissão das
NF-es serão convertidos
para FSDA.
Código do WebService
Inbound que contém os
cod_ws_scan_inbound_hom endereços para Alfanumérico
comunicação com o SCAN
no ambiente de
homologação.

Código do WebService
Inbound que contém os
cod_ws_scan_inbound_prd endereços para Alfanumérico
comunicação com o SCAN
no ambiente de produção.

Determina a utilização do 'N' ou 'S'


utiliza_epin
e-PIN

Determina que se o
sistema estiver em
contingência automática 'N' ou 'S'
utiliza_scan
os tipos de emissão das
NF-es serão convertidos
para SCAN.

206
Parâmetros do Grupo - Configuração de Desempenho:

Parâmetro Finalidade Valor


Determina o número
máximo de registros
maximo_impressao_danfe Numérico
selecionados pelo
processo de impressão
Determina o número
máximo de registros
maximo_processamento_cadastro selecionados pelo Numérico
processo de consulta
do cadastro
Determina o número
máximo de registros
selecionados pelo
maximo_processamento_edi Numérico
processo de entrada
para Interface do tipo
EDI
Determina o número
máximo de registros
maximo_processamento_email selecionados pelo Numérico
processo de envio de
e-mail.
Determina o número
máximo de registros
maximo_processamento_entrada Numérico
selecionados pelo
processo de entrada.
Determina o número
máximo de registros
maximo_processamento_evento Numérico
selecionados pelo
processo Evento.
Determina o número
máximo de registros
maximo_processamento_geracao_xml selecionados pelo Numérico
processo de geração de
XML.
Determina o número
máximo de registros
maximo_processamento_manifesto_aut
selecionados pelo Numérico
omatico
processo de manifesto
automático
Determina o número
máximo de registros
maximo_processamento_pedente selecionados pelo Numérico
processo de
pendências.
Determina o número
máximo de registros
maximo_processamento_timeout Numérico
selecionados pelo
processo de Time-out.
Máxima quantidade de
registros para o
maximo_qtde_consulta_documentos_de
processo Consulta Numérico
stinados
Documentos
Destinados
Máxima quantidade de
registros para o
maximo_qtde_download_xml Numérico
processo Download NF-
e
Máxima quantidade de
maximo_qtde_retorno_inbound_sistema registros para o
Numérico
_origem Retorno Inbound
Sistema Origem
Determina o número
máximo de registros
maximo_reprocessamento_parse_inbou
selecionados para Numérico
nd
reprocessamento do
Parse do XML Inbound
Determina o número
máximo de registros
maximo_retorno_sistema_origem selecionados pelo Numérico
processo de retorno ao
sistema de origem.
Determina o máximo
de notas que o
maximo_xml_epin_geracao gerenciador de geração Numérico
de XML e-PIN deve
selecionar por vez.
Determina se será
realizado o
utiliza_reprocessamento_parse_inbound ‘S’ ou ‘N’
reprocessamento do
Parse do XML Inbound.

208
Parâmetros do Grupo - Configuração de E-mail:

Parâmetro Finalidade Valor


Número de dias
restantes até o
vencimento do
certificado digital a
qtde_dias_aviso_vencimento_certificado_digital partir do qual será Numérico
enviado um e-mail
notificando que o
certificado deve ser
renovado.
Determina qual a
ultima data em que foi
data_envio_ultimo_email_aviso_vencimento_cer
enviado e-mail de Numérico
tificado_digital
certificados próximos
ao vencimento.
Determina os
destinatários de PDF: 0
- EMAIL_PDF, 1 -
ENDERECO_ELETRONIC
destinatario_email_pdf O, 2 - CONFIG_FILIAL, Numérico
3- Opção 1 e 2, 4 -
Opção 0 e 1,5 - Opção
0 e 2,6 - Todas as
Opções
Destinatários para os Alfanumérico
email_ti e-mails de TI (Destinatário
separados por “;”. do E-mail)
Endereço que pode ser
Alfanumérico
configurado para
(destinatário
endereco_eletronico receber todos os XMLs
do XML de
de Distribuição do
Distribuição)
Sistema.
Parâmetros do Grupo - Configurações de E-PIN:

Parâmetro Finalidade Valor


Determina se o processo de
nota fiscal eletrônica será
epin_interrompe_processo interrompido no caso de ‘S’ ou ‘N’
problema do algum problema
no ePin.
Determina o local onde os
Alfanumérico (Caminho da
epin_path_arquivos arquivos do e-PIN serão
pasta e-pin)
armazenados.
Determina a versão atual do
Alfanumérico (Versão XML e-
epin_valida_schema arquivo XML da Portaria
Pin)
Suframa 529.
Determina a versão atual do
Alfanumérico (Versão XML e-
epin_versao_arquivo_xml arquivo XML da Portaria
Pin)
Suframa 529.
Determina o Maximo de notas
fiscais que o processo de
maximo_lote_epin_geracao Numérico
geração de lote de e-PIN irá
carregar

210
Parâmetros do Grupo - Configurações de Impressão:

Parâmetro Finalidade Valor


Determina se o DANFE
impressao_danfe_sistema_origem será impresso no sistema ‘S’ ou ‘N’
de origem.
Formato de Impressão do
impressao_formato_danfe DAFE - 1 - Retrato/ 2 – ‘1’ ou ‘2’
Paisagem.
Determina o caminho e o
arquivo utilizado para a Alfanumérico
impressoes_danfe_minuta
marca de minuta na (Nome do Logo)
impressão.
Tempo em segundos que o
sistema irá aguardar a
tempo_vida_thread_executa_impressao Numérico
resposta de uma fila de
impressão (por nota).
Determina se será
utiliza_impressao_odt utilizada a impressão por ‘S’ ou ‘N’
ODT.
Determina se os lotes de
utiliza_lote_impressao impressão são utilizados ‘S’ ou ‘N’
neste ambiente.

Determina o intervalo em
segundos entre tentativas
impressoes_danfe_logo Numérico
de conexão com um
WebService.

Determina se será
utilizado HTML ou Crystal “HTML” ou
visualizacao_impressao_danfe
para visualizar e imprimir “CRYSTAL”
DANFEs.
Parâmetros do Grupo - Configurações de Log do Sistema:

Parâmetro Finalidade Valor


Determina quais logs serão
registrados na tabela
nivel_log ‘1’, ‘2’ ou ‘3’
NFE_PROCESSO_SERVIDOR_LOG,
1=Todos, 2=Erros, 3=Nenhum.
Determina se o sistema irá
utilizar a
nivel_log_evento_timeout NFE_EVENTO_TIMEOUT durante ‘0’ ou ‘1’
o processamento das NF-es 0 -
Não Utiliza / 1 – Utiliza.
Determina se o sistema irá
utilizar a NFE_NF_HIST_STATUS
nivel_log_hist_status durante o processamento das ‘0’ ou ‘1’
NF-es 0 - Não Utiliza / 1 –
Utiliza.
Determina o intervalo em
timeout_elimina_log segundos da eliminação dos log Numérico
do processo servidor.
Determina o intervalo em dias
timeout_intervalo_eliminacao_log em que será executado a Numérico
eliminação de log.
Determina qual a ultima data
timeout_ultima_eliminacao_log em que foi executado a Numérico
eliminação de log;

212
Parâmetros do Grupo - Configurações do Painel de Controle:

Parâmetro Finalidade Valor


Determina a quantidade de dias
anterior a data emissão mais
controle_filtro_painel_controle Numérico
recente das notas a serem
carregadas.
Determina o número máximo de
nota_servico_limite_registros_exibicao registros a serem exibidos no Numérico
painel.
Determina qual será o tempo do
painel_controle_intervalo_refresh intervalo do refresh no painel de Numérico
controle (Em Segundos).
Parâmetro responsável por
limitar a quantidade de registros
painel_controle_registros_paginacao Numérico
carregados do banco para
exibição no Grid.
Parâmetro responsável por
otimizar a query executada no
painel_controle_utiliza_orderby_paginacao painel de controle, excluindo ou Numérico
não a cláusula order by do
script.
Determina se as novas
mensagens para o contribuinte
visualiza_msg_contribuinte Numérico
serão exibidas ao iniciar o
sistema.
Parâmetros do Grupo - Configurações de Proxy:

Parâmetro Finalidade Valor


Determina o
transmissao_dominio_proxy Alfanumérico
domínio do Proxy.
Determina o host do
transmissao_host_proxy Alfanumérico
Proxy.
Determina a porta
transmissao_porta_proxy Numérico
do Proxy.
Define se o sistema
deve usar uma
Credencial Padrão
transmissao_proxy_utilizar_DefaultNetworkCredentials ou credenciais ‘S’ ou ‘N’
customizadas para
autenticação no
proxy.
Determina a senha
transmissao_senha_proxy para o usuário do Alfanumérico
Proxy.
Determina o usuário
transmissao_usuario_proxy Alfanumérico
do Proxy.
Determina se será
utilizada uma
autenticação por
transmissao_utilizar_proxy_cw ‘S’ ou ‘N’
proxy para acesso a
conexão do serviço
de NFS-e.
Determina se será
utilizada uma ‘S’ ou ‘N’
transmissao_utilizar_proxy autenticação por
proxy para acesso a
internet.

214
Parâmetros do Grupo - Configurações de SMTP:

Parâmetro Finalidade Valor


Determina o domínio para
smtp_autenticacao_dominio autenticação no servidor Alfanumérico
SMTP.
Determina a senha para
smtp_autenticacao_senha autenticação no servidor Alfanumérico
SMTP.
Determina o usuário para
smtp_autenticacao_usuario autenticação no servidor Alfanumérico
SMTP.
Determina o endereço IP do
smtp_host servidor de SMTP para Alfanumérico
disparos de e-mail
Determina o endereço de e-
smtp_remetente Alfanumérico
mail para disparos de e-mail.
Determina se o servidor
smtp_utilizar_autenticacao Alfanumérico
SMTP requer autenticação.
Parâmetros do Grupo - Configurações de Threads:

Parâmetro Finalidade Valor


Determina se o Controle
controle_threads_habilitado Automático de Threads ‘S’ ou ‘N’
está Habilitado.
Determina o Tamanho do
Cache da Fila do
controle_threads_tamanho_amostra ‘S’ ou ‘N’
Controle Automático de
Threads.
Determina o Tempo do
Cache da Fila do
controle_threads_tempo_cache_fila ‘S’ ou ‘N’
Controle Automático de
Threads.

216
Parâmetros do Grupo - Configurações de WebService:

Parâmetro Finalidade Valor


CNPJ utilizado
para a busca do
certificado que
será utilizando
cnpj_certificado_login para Numérico
autenticação
com os
WebServices da
SEFAZ.
Determina qual
o número
máximo de dias
para o
limite_dias_reprocessamento_consulta_nfe reprocessamento Numérico
automático de
uma nota para
NF-es recebidas
pelo Inbound.
Determina o
intervalo em
segundos entre
intervalo_retry_segundos Numérico
tentativas de
conexão com um
WebService.
Determina a
mensagem
mensagem_padrao_canc_inut_pt1 padrão de Alfanumérico
cancelamento
ou inutilização.
Determina a
continuação da
mensagem
mensagem_padrao_canc_inut_pt2 Alfanumérico
padrão de
cancelamento
ou inutilização.
Determina em
qual prioridade
a nota fiscal
será classificada
prioridade_default_nota_fiscal no caso de não Numérico
se enquadrar em
nenhuma das
prioridades
parametrizadas.
Determina qual
o número
prioridade_quantidade_maximo_nota_fiscal máximo de notas Numérico
fiscais a
priorizar.
Determina em
segundos o
máximo de delay
retorno_delay_sefaz Numérico
possível entre o
cliente e a
SEFAZ.
Determina o
numero máximo
de notas
transmissao_numero_maximo_nf_cancelamento canceladas que Numérico
o processo irá
selecionar por
vez.
Determina o
numero máximo
de notas
transmissao_numero_maximo_nf_inutilizacao inutilizadas que Numérico
o processo irá
selecionar por
vez.
Determina qual
será o numero
máximo de notas
transmissao_numero_maximo_nf_lote Numérico
fiscais que
poderão compor
o lote.
Determina o
tempo limite
antes de um
transmissao_tempo_timeout Numérico
time out em
uma requisição
(em segundos).
Determina a
versão do
transmissao_versao_xml_envio arquivo XML que Alfanumérico
será enviado
para a SEFAZ;
Determina o
tempo máximo
validacao_tempo_limite_cancelamento para Numérico
cancelamento
da nota fiscal.
218
Parâmetros do Grupo - Configurações de XML:

Parâmetro Finalidade Valor


Determina se o processo
que gera os XMLs das notas
assinar_xml_processo_geracao ‘S’ ou ‘N’
os assina antes de guardá-
los no banco

Determina o caminho para


caminho_schema_xml Alfanumérico
o schema XSD.

Determina o peso máximo


peso_maximo_xml_lote Numérico
para o XML do lote.
Determina se o sistema
retirará os acentos das
retira_acentos_sistema_origem ‘S’ ou ‘N’
tabelas de NF (Processo de
Entrada).
Determina se o sistema
deve somar o valor total do
IPI, Frete, Seguro e Outros
soma_valor_total_itens ‘S’ ou ‘N’;
valores de cada item ao
valor total dos itens da
nota.
1 - Produção; 2 –
tipo_ambiente ‘1’ ou ‘2’
Homologação

Determina qual o tipo de


tipo_assinatura_xml assinatura será efetuado 1 ‘1’ ou ‘2’
- Comply e-Docs / 2 – HSM

Determina o tipo de
tipo_cliente_oil Cliente Oil R - Refinaria ou ‘R’ ou ‘D’
D – Distribuidora.
Determina se o campo
NUM_NF será utilizado para
utiliza_chave_acesso_num_nf ‘S’ ou ‘N’
a geração da chave de
acesso.

Determina se o sistema irá


utilizar a função para
utiliza_funcao_retira_brancos ‘S’ ou ‘N’
remover os espaços em
branco.

220
Parâmetros do Grupo - Configurações de NFSE:

Parâmetro Finalidade Valor

Nome do XSD de Recepcao


xsd_recepcao_nfse Alfanumérico
de NFSe.

Caminho de Geração dos


caminho_geracao_pdf Alfanumérico
Arquivos PDF.

Determina o número
máximo de registros
maximo_registros_timeout Numérico
selecionados pelo processo
de Time-out.
Maximo de registros para
serem selecionadas pelo
maximo_registros_cancelamento Numérico
Gerenciador de
Cancelamento de NFSe.

Maximo de registros para


maximo_registros_impressao serem selecionados pelo Numérico
Gerenciador de Impressão.

Nome do XSD de Consulta


xsd_consulta_nfse Alfanumérico
de NFSe.

Nome do XSD de Envio de


xsd_envio_lote_nfse Alfanumérico
Lote de NFSe.

Caminho da pasta de XSDs


caminho_xsd_nfse Alfanumérico
de NFSe.

Maximo de registros para


serem selecionadas pelo
maximo_registros_consulta_nota Numérico
Gerenciador de Consulta
de Nota do NFSe.

Determina o nome do logo


impressao_logo_padrao Alfanumérico
padrão para impressão.

Nome do XSD de
xsd_cancelamento_nfse Alfanumérico
Cancelamento de NFSe.
Parâmetros do Grupo - Configurações de INTEG:

Parâmetro Finalidade Valor


Utilizar compactação de
dados na transmissão das
transmissao_utilizar_compactacao_NFSE mensagens de Nota fiscal Alfanumérico
de Serviço (S/N) Sim ou
Não.

maximo_geracao_xml_nfes maximo_geracao_xml_nfes. Numérico

Determina o número
máximo de registros
maximo_processamento_retorno_lote_nfse Numérico
selecionados pelo processo
de retorno de lote NFS-e.

Codigo do WebService que


cod_ws_nfse contém os endereços para Alfanumérico
comunicação de NFS-e.

Determina o número
máximo de registros
maximo_processamento_lote_nfse Numérico
selecionados pelo processo
de envio de lote NFS-e.

Determina o número
maximo de tentativas de
conexao com um
maximo_tentativas_nfse Numérico
WebService de NFS-e antes
de alterar a nota para
status de erro.
Determina a observação
mensagem_padrao_nfse padrão para o XML do NFS- Alfanumérico
e.
Determina o intervalo em
segundos entre tentativas
intervalo_retry_nfse Numérico
de conexao com um
WebService de NFS-e.
Determina o número
máximo de registros
maximo_cancelamento_nfse Alfanumérico
selecionados pelo processo
de Cancelamento de NFS-e.

222
Determina a mensagem
mensagem_padrao_cancelamento_nfse padrão para a justificativa Alfanumérico
de Cancelamento do NFS-e.
Parâmetros do Grupo INBO - Configurações de Inbound:

Parâmetro Finalidade Valor


Retornar as NF-es Inbound
retornar_NF- para o Sistema de Origem após
‘S’ ou ‘N’
e_inbound_sistema_origem a conclusão de seu
processamento
Código da Interface de Saída
codigo_interface_saida_para_retorno_i
para retorno das NF-es Alfanumérico
nbound_sistema_origem
Inbound ao sistema de origem
Máxima quantidade de
maximo_qtde_retorno_inbound_sistem
registros para o Retorno Numérico
a_origem
Inbound Sistema Origem
Incluir_documentos_destinados_no_ma Após a consulta de
nifesto_automatico documentos destinados na
‘S’ ou ‘N’
sefaz realizar o inbound
automático para estas NF-es.
manifesto_temporario_quantidade_dias Quantidade de dias para que o Numérico
Manifesto Temporário crie
automaticamente um evento
para NF-es sem um evento
conclusivo

manifesto_temporario_tipo_evento Tipo de Evento que o Numérico


Manifesto Temporário irá
criar: 0 – Confirmação da
Operação ou 1 –
Desconhecimento da
Operação ou 2 – Operação Não
Realizada
manifesto_temporario_descricao_opera Descrição Obrigatória quando
cao_nao_realizada utilizado o evento Operação
Alfanumérico
Não Realizada. (Apenas para
Manifesto Temporário)
realiza_manifesto_confirmacao_autom Cria um evento de manifesto
atico Confirmação da Operação,
quando o serviço Gerenciador
de Manifesto Automático esta
iniciado e o CNPJ do
Fornecedor estiver cadastrado
‘S’ ou ‘N’
na tela Lista CNPJ Manifesto
Automático. Caso estejam
marcadas as duas
parametrizações do manifesto
automático, será realizada a
Confirmação para CNPJs
224
cadastrados e a Ciência para
os não cadastrados. Caso
esteja marcada apenas a
opção Ciência do manifesto
automático, será realizada
apenas a Ciência automática.
Caso esteja marcada apenas a
opção Confirmação do
manifesto automático, será
realizada a Confirmação para
CNPJs cadastrados e para os
CNPJs não cadastrados
nenhum evento de manifesto
será criado.
realiza_manifesto_ciencia_automatico Cria um evento de manifesto
Ciência da Operação, quando
o serviço Gerenciador de
Manifesto Automático esta
iniciado. Caso estejam
marcadas as duas
parametrizações do manifesto
automático, será realizada a
Confirmação para CNPJs
cadastrados e a Ciência para
os não cadastrados. Caso
esteja marcada apenas a ‘S’ ou ‘N’
opção Ciência do manifesto
automático, será realizada
apenas a Ciência automática.
Caso esteja marcada apenas a
opção Confirmação do
manifesto automático, será
realizada a Confirmação para
CNPJs cadastrados e para os
CNPJs não cadastrados
nenhum evento de manifesto
será criado.
manifesto_temporario_quantidade_dias Quantidade de dias para que o Numérico
Manifesto Temporário crie
automaticamente um evento
para NF-es sem um evento
conclusivo

 Salve a operação .
Informações do Sistema de Origem
Nesta transação é configurada a conexão entre o sistema Comply e-Docs e os mais diversos
sistemas, incluindo o ERP da SAP.

São configuradas interfaces de entrada e saída de informações, além de uma interface padrão
para o recebimento de XMLs de Inbound.

Para visualizar a funcionalidade acesse o menu abaixo:


Menu: Gerência > Parametrizar Informações do Sistema de Origem
Atalho: BUSCAINF

 Selecionar os campos no filtro de pesquisa, para listar as informações de Interface


cadastradas:

226
Inclusão de Parâmetro para Informações do Sistema de Origem:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:
 Preencha os Campos:
228
o Campo "Interface":
 Código Interface: Informado pelo usuário ao criar um cadastro novo de
busca e envio das informações;
 Descrição: Depois de informado o código de interface, a descrição da
mesma é demonstrada neste campo;
 Tipo de Transmissão: Tipo de transmissão do sistema de origem
(selecionar na lista de auxilio ao preenchimento);
 Tipo da Interface: Tipo de interface do sistema de origem - entrada ou
saída de informações - (selecionar na lista de auxilio ao preenchimento);
 Interface Destino (Saída): Definir o Destino de Interface Saída;
o Campo "Contingência":
 Ativar Contingência: Informar se o modo de contingência deve ser
ativado;
o Campo "Arquivo":

As informações desta caixa serão preenchidas ou selecionadas apenas quando o


Tipo de Transmissão for Arquivo.
 Tipo de Arquivo: Contém as informações (selecione na lista de auxílio ao
preenchimento);
 Sistema Operacional: Contém o tipo de arquivo selecionado;
 Diretório: Consta o arquivo a ser solicitado. Preencha este campo apenas
quando o Sistema Operacional for ‘Windows’ (informe ou selecione o
diretório através do caminho);
o Campo "SAP":
 Mandante: Relacionado ao sistema de origem (quando se tratar de SAP).
Preencha este campo apenas quando o tipo de transmissão for ‘Dblink’ ou
‘Memória’;
 URL: Endereço, IP do sistema de origem. Preencha este campo quando o
tipo de transmissão for ‘Dblink’ ou ‘Memória’ ou Sistema Operacional
UNIX;
 Usuário: Referente ao sistema de origem / Sistema operacional UNIX.
Preencha este campo quando a solicitação do sistema operacional for
UNIX ou o tipo de transmissão for ‘Dblink’ ou ‘Memória’;
 Número do sistema: Número do sistema de origem (quando se tratar de
SAP). Preencha este campo quando o tipo de transmissão for ‘Dblink’ ou
‘Memória’;
 Senha: Relacionado ao sistema de origem / Sistema operacional UNIX.
Preencher este campo quando a solicitação do sistema operacional for
UNIX ou o tipo de transmissão for ‘Dblink’ ou ‘Memória’;
 Nome do Programa: Nome do programa que irá extrair e retornar as
notas fiscais ao sistema de origem;
 Versão SAP: Versão do componente ABAP do sistema Comply e-Docs;
 SAP Unicode: Parametrizar se o SAP é Unicode ou Não Unicode.
o Campo Load Balance:
 Utiliza Load Balance: Determina se o SAP utiliza Load Balance;
 Message Host: Endereço do servidor de mensagens. Caso o SAP utilize
Load Balance;
 Nome do R3: Nome do Sistema. Caso o SAP utilize Load Balance;
 Grupo de servidores: Grupo de Servidores. Caso o SAP utilize Load
Balance.
Todos os campos são de preenchimento obrigatório, de acordo com as regras estabelecidas.

o Clicar em - Salvar para gravar os dados informados.

Alteração de Parâmetro para Informações do Sistema de Origem:

 Selecione o registro;

 Clique em - Editar;
Todos os campos estarão disponíveis para alteração, exceto o campo "Cód. Interface".
 Altere os campos;

 Salve a operação .

Exclusão de Parâmetro para Informações do Sistema de Origem:

 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

230
 Confirme ou não a exclusão.
Eventos por Usuário
Esta transação permite configurar o envio de email a um usuário quando ocorrem determinados
status no sistema Comply e-Docs.

Por exemplo, se for necessário o aviso de quando uma NF-e é cancelada, é possível determinar
que um usuário deva receber uma notificação por email.

Para visualizar a funcionalidade, acesse o menu indicado abaixo:

Menu: Gerência > Eventos por Usuário

Atalho: EVENTOUSU

 Preencha os Campos:

232
o Matriz: Matriz;
o Filial: Filial;
o Usuário: Usuário;
o Grupos de Eventos: Grupo de Eventos para a verificação;

Alteração de Parâmetro para Eventos de Usuário:

 Selecione o registro;

 Clique em - Editar;
 Selecione os Status desejados;

 Salve a operação .
Gerenciar Versão de XML
Este parâmetro define as versões de XML que são utilizadas pelo sistema para comunicação e
validação de acordo com o Schema XSD.

Para visualizar a funcionalidade, acesse o menu indicado abaixo:

Menu: Gerência > Gerenciar Versão de XML

Atalho: GVXML

 Selecione a opção - Novo;


 Será exibida a tela a seguir:

 Preencha os Campos:
o Ação: Descrição da Ação do XML;
o Versão: Versão do XSD;
o Nome da Dll: Descrição da Dll;
o Nome do Objeto: Nome do Objeto que utilizará essa Versão de XML;
o Caminho do XSD: Caminho da máquina onde se localiza o XSD desta versão de
XML na máquina onde o Serviço: “Comply e-Docs Server da NF-e” é executado;

o Salve a operação .

Alteração de Parâmetro para Gerenciar Versão de XML:

234
 Selecione o registro;

 Clique em - Editar;
Todos os campos estarão disponíveis para alteração.
 Altere os campos;

 Salve a operação .
Controle de Acesso
Deve existir um Grupo para cada usuário que será determinado no Controle de Acesso. Este estará
associado a uma atividade que possui determinadas transações (operações e funções) que serão
acessadas. Inicialmente cria-se um Grupo e uma Atividade, associa transações a esta Atividade e
vincula o Grupo à Atividade.

Grupo
Para visualizar a funcionalidade acesse o menu indicado abaixo:

Menu: Gerência > Controle de Acesso > Grupos

Atalho: GRP

 Selecione os campos no filtro de pesquisa para listar os Grupos cadastrados para o


Controle de Acesso.

Inclusão do Grupo:

 Selecione a opção - Novo;


 Será exibida a tela a seguir:

 Preencha os campos:
o Grupo: Informe o nome do Grupo;
o Ativo: Define se o Grupo está ativo ou inativo no sistema;

o Salve a operação .

236
O preenchimento do campo Grupo é obrigatório.

Alteração de Grupo:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;


Todos os campos estarão disponíveis para alteração.
 Altere os campos;

 Salve a operação .

Exclusão de Grupo:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir;


 O sistema apresentará a seguinte mensagem:

 Confirme ou não a exclusão.


Se o Grupo pertencer a uma Atividade, não será permitida a exclusão do registro.
Atividade
Para visualizar a funcionalidade acesse o menu abaixo:

Menu: Cadastrar > Controle de Acesso > Atividade

Atalho: ROLE

 Selecione os campos no filtro de pesquisa para listar as Atividades cadastradas para o


Controle de Acesso.

Inclusão da Atividade:

 Selecione a opção - Novo;


 Será exibida a tela abaixo:
238
 Preencha os campos:
o Nome da Atividade: Informe o nome da atividade criada;
o Descrição da Atividade: Defina se o Grupo está ativo ou inativo no sistema.

o Salve a operação .
O preenchimento de todos os campos é obrigatório.

Alteração da Atividade:

 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Editar ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Editar;

Todos os campos estarão disponíveis para alteração.


 Altere os campos;

 Salve a operação .

Exclusão da Atividade:
 Efetue a pesquisa;
 Selecione o registro;

 Escolha - Excluir ou - Exibir detalhes do registro corrente;

 Na seqüência selecione a opção - Excluir. O sistema apresentará a seguinte


mensagem:

 Confirme ou não a exclusão.

Se a Atividade estiver vinculada a um Grupo e a transações, não será permitida a exclusão do


registro.

240
Atividade x Transação
Para visualizar a funcionalidade acesse o menu abaixo:

Menu: Cadastrar > Controle de Acesso > Atividade X Transação

Atalho: ROT

 Selecione a Atividade que deverá ser vinculada às transações;


 Informe a Aplicação utilizada;
 O sistema apresentará todas as Transações existentes para a Aplicação:

 Clique em - Editar;
 Replique as "Transações Não Selecionadas" para "Transações Selecionadas", através da
opção ;

 Salve a operação .
 Para acesso às transações como Somente Leitura, escolha no campo "Transações
Selecionadas" o (s) item (s) que serão somente visualizados pelo usuário e em seguida a
opção "Somente Leitura". O usuário não terá acesso à inclusão, alteração e exclusão da
tela;
 O sistema lista todos os objetos pertencentes ao Painel de Controle e será necessário
selecioná-las de acordo com os acessos permitidos pela atividade cadastrada e salvar.

242
Selecione a opção para ter acesso a todas as transações; Para retirar as transações
relacionadas à atividade, efetue o mesmo procedimento adotado para inclusão, na direção do
campo Transações Selecionadas para Transações Não Selecionadas, através das opções ou
os campos Atividade e Aplicação são obrigatórios.

Alteração de Atividade x Transação:

 Selecione a Atividade que deverá ser alterada;


 Escolha a Aplicação que está sendo utilizada.
 O sistema lista todas as Transações existentes para a Aplicação e para a Atividade
selecionada:
 Selecione a opção - Editar;

 Efetue as alterações através das opções e , ou .

 Salve a operação .

244
Atividade x Grupo
Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Cadastrar > Controle de Acesso > Atividade X Grupo

Atalho: GRPROLE

 Escolha o Grupo;

 Selecione a opção - Novo;


 Será exibida a seguinte tela:

 Determine a Atividade que fará parte do grupo:


 Salve a operação .

Alteração de Atividade do Grupo:

 Selecione o grupo;

 Clique em - Editar;

246
 Altere a Atividade que fará parte do Grupo;

 Salve a operação .

Exclusão de Atividade do Grupo:

 Selecione o Grupo;
 Escolha a Atividade;

 Clique em - Excluir;
 O sistema apresentará a seguinte mensagem:
 Confirme ou não a exclusão.

248
Processar Data Clean
Esta transação pode ser utilizada para realizar uma limpeza das NF-es armazenadas no banco de
dados quando já armazenadas.

Caso não nenhum processo de Arquivamento esteja configurado a transação não excluirá nenhum
registro da base de dados, mesmo executando o Job.

Para visualizar a funcionalidade, acesse o menu abaixo:

Menu: Gerência > Processar Data Clean

Atalho: DTC

 Depois de acessada a funcionalidade, é exibida a tela abaixo:

 Clicar no botão - Novo, para gerar um novo Job de exclusão;

Aba Parâmetros:
 Preencher os campos conforme indicado a seguir:
 Número Limite de Registros: É a quantidade máxima de registros que serão
excluídos por execução do Job;
 Apagar Notas Anteriores: É a quantidade de dias anteriores à execução do Job
que será considerada para a exclusão dos registros;

Aba Agendamento:

250
 Preencher os campos conforme indicado a seguir:
 Tipo de Agendamento:
 Executar agora: Imediatamente a execução do relatório.
 Agendar: Agende o horário para executar o relatório. Ao selecionar esta
opção, será habilitado o campo “Informações de Agendamento”.
 Condicional: Insira uma condição para o relatório. Ao selecionar esta
opção, será habilitado o campo “Condições para execução”. Ao
selecionar esta opção o sistema exibe o campo "Condição para
execução":
 Intervalo entre verificações (minutos): Determine em quanto tempo o
relatório irá utilizar a condição descrita na "Função de verificação":
 Função de verificação (C#): Insira a rotina de programação para o
relatório, na linguagem C#.
o Executar: Quando será executado;
o Data: A data que será executada a geração do relatório;
o Hora: A hora que será executado a geração do relatório;
 Clique em “OK”.

252
Modelo Operacional SAP
O componente ABAP é constituído pelo programa extrator, responsável pela extração de
informações de NF-e; pelo painel de controle, que é o programa que auxilia a visualização do
status atual de envio da NF-e; por parâmetros que definem quais notas fiscais devem ser
extraídas e a determinação de contingência e demais constantes do sistema; e por alguns
programas adicionais que facilitam a verificação e correção de erros.

O extrator permite que as informações sejam enviadas ao componente Comply e-Docs Server do
sistema Comply e-Docs.

O Comply e-Docs Server, por sua vez, realiza a tarefa de gerar o arquivo XML, gerenciar o envio e
retorno do arquivo XML à SEFAZ ou ao Módulo de Nota Fiscal Eletrônico de Serviço, e enviar o
status de retorno ao sistema de origem. O sistema Comply e-Docs pode se comunicar com
diversos sistemas de origem, porém, neste documento, trataremos apenas o SAP.

Quando executado, o extrator irá verificar se existem novas notas para envio. A extração é
realizada de forma sequencial através de um controle standard de docnum.
O usuário pode definir se o programa extrator deve ser executado manualmente ou
automaticamente. Se executado manualmente, as notas consideradas para extração deverão
estar definidas no range de docnum, configurado na transação de parâmetros.

Se o extrator for configurado para trabalhar automaticamente, as notas fiscais serão extraídas a
partir do último docnum extraído. Este docnum será gravado na transação de parâmetros. Neste
formato, o extrator apenas pode ser executado através de RFC (Remote Function Call). O
componente responsável por realizar a chamada da RFC é o Comply e-Docs Server do sistema
Comply e-Docs.

Quando extraídas, as notas fiscais são recebidas pelo componente Comply e-Docs Server que as
enviará à SEFAZ ou ao Módulo de Nota Fiscal Eletrônico de Serviço. No momento em que a SEFAZ
ou o Módulo NFS-e retorna as informações ao Comply e-Docs Server, o status da nota é
encaminhado ao SAP via RFC. O componente Comply e-Docs Server executará uma função -
deverá gravar o status de retorno da nota fiscal.

Além do retorno das informações, a função de retorno tem a capacidade de chamar programas de
impressão, como, por exemplo, um programa SAP Script ou ainda um formulário Smart Forms,
que podem ser utilizados para a impressão do DANFE.

Parâmetros (/PWS/ZNFEM000)
A transação “Parâmetros” permite configurar informações para que o componente ABAP do
sistema e-Docs atenda diversos tipos de cenário de acordo com necessidades específicas. Nesta
transação, são configurados parâmetros referentes à interface, modo de extração e (outras)
informações para o programa “Painel de Controle”.

Menu: /PWS/ZNFEM000 > Parâmetros Gerais


Nesta seção são determinados os parâmetros gerais para o funcionamento do programa extrator
e seu método de extração.

 Último Documento: Campo obrigatório quando o semáforo estiver verde. É atualizado


automaticamente pelo sistema com o último registro (docnum) processado. Se a interface
estiver configurada para extrair os dados automaticamente, o programa extrator
selecionará este docnum e iniciará a extração. Este é o controle de docnum que o
programa utiliza para não realizar extrações repetidas.

 Semáforo Verde : Indica que a Interface será executada automaticamente


através do componente Comply e-Docs Server do sistema e-Docs. Este botão controla o
fluxo de saída de notas fiscais do SAP. Somente quando este semáforo está em verde as
notas fiscais serão enviadas ao componente Comply e-Docs Server. Além desta
verificação, o programa extrator ainda utiliza a tabela de controle (/PWS/ZNFETB000)
para verificar se existem notas fiscais extraídas que não foram enviadas ao componente
Comply e-Docs Server.
254
 Semáforo Amarelo : Indica que a interface será executada manualmente e que
o intervalo de docnum que deve ser utilizado pela interface é o que consta no campo
“Múltiplos Documentos De/até” de notas fiscais. Quando o semáforo está amarelo, o
extrator não recebe requisições via RFC, portanto as notas fiscais não são enviadas ao
componente Comply e-Docs Server. As notas serão enviadas ao Comply e-Docs Server
somente quando o usuário configurar o semáforo para verde novamente.

 Código da Holding: Campo obrigatório. Campo chave nos produtos da Sonda utilizado
para identificar um cliente no banco de dados.

 Tipo de Interface: A opção “e-Docs” deve ser selecionada para que as notas sejam
enviadas ao componente Comply e-Docs Server do sistema e-Docs através de RFC.

 Alteração de NF: Parametrização em desuso.


Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Descrição do Imposto

Nesta seção deverão ser parametrizados todos os códigos de Impostos que o cliente utiliza e a
descrição destes respectivos impostos. Estes códigos de imposto são padronizados nos produtos da
Sonda, portanto podem ser utilizados os mesmos códigos utilizados no programa pw.SATI.

 Código do Imposto e-Docs: Coluna de preenchimento obrigatório. Deve ser preenchida


com os códigos de imposto referentes a todos os impostos que serão enviados ao
componente Comply e-Docs Server.

 Descrição do Imposto: Coluna de preenchimento obrigatório. Deve ser preenchida com as


descrições referentes aos impostos correspondentes.

256
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Código SAP X e-Docs

Nesta seção deverão ser parametrizado os de/para dos impostos entre o SAP e o código utilizado
pelo sistema e-Docs. Além disso, deverá ser cadastrada a modalidade de base de calculo para o
ICMS. O programa extrator efetua este de/para antes de enviar os dados de imposto ao
componente Comply e-Docs Server.

 Grupo de Impostos SAP: Coluna de preenchimento obrigatório. Deve ser preenchida com
os impostos encontrados no SAP. É possível utilizar o Matchcode.

 Código de Imposto e-Docs: Coluna de preenchimento obrigatório. Deve ser preenchida


com o código do imposto correspondente ao que foi cadastrado na aba anterior,
Descrição do Imposto.

 Modalidade BC: Coluna de preenchimento facultativo. Deve ser preenchida de acordo


com a modalidade da base de cálculo do ICMS. As modalidades de base de cálculo
disponíveis podem ser verificadas através do manual de integração do contribuinte. As
tags que receberão esses valores são: modBC e modBCST, para ICMS e ICMS substituição
tributária, respectivamente.
 Sit. Tribut. ICMS: Não preencher. Coluna em desuso.
258
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Incoterms

Nesta seção deverão ser parametrizados todos os códigos de Incoterms SAP e suas respectivas
modalidades de frete.

 Incoterms: Coluna de preenchimento obrigatório. Deve ser preenchida com os códigos de


Incoterms encontrados no SAP e utilizados pelo cliente.

 Modalidade de Frete: Coluna de preenchimento obrigatório. Deve ser preenchida com a


modalidade do frete. Este campo possui as seguintes opções: “Por conta do
destinatário”, “Por conta do emitente”, “Por conta de terceiros” ou “Sem frete”.
Informação fornecida pelo cliente.
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Tributação IPI SAP X
SEFAZ

Nesta seção deverão ser parametrizados todos os códigos de tributação do IPI do SAP
correspondentes aos códigos de situação tributária do IPI da SEFAZ.

 Direção Nota Fiscal: Coluna de preenchimento obrigatório. Deve ser preenchida de


acordo com a direção da nota fiscal referente ao IPI. Admite dois valores: “Entrada” ou
“Saída”.

 Tributação IPI SAP: Coluna de preenchimento obrigatório. Deve ser preenchida de acordo
com o código de tributação do IPI no SAP. O cliente deverá informar qual código é
utilizado para a tributação do IPI.

 Tributação IPI SEFAZ: Coluna de preenchimento obrigatório. Deve ser preenchida de


acordo com o código de situação tributária do IPI junto à SEFAZ. Os códigos de situação
tributária do IPI estão no manual de integração do contribuinte.

Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Seleção Empresa/Filial

260
Nesta seção deverão ser parametrizadas todas as empresas e suas respectivas filiais que o
extrator deverá considerar para a extração de Notas Fiscais.

 Empresa: Coluna de preenchimento obrigatório. Deve ser preenchida com o código da


empresa no SAP.

 Local de Negócios: Coluna de preenchimento obrigatório. Deve ser preenchida de acordo


com o código do local de negócios.

 Processar?: Coluna de preenchimento facultativo. Deve ser selecionada caso o local de


negócios vinculado à respectiva empresa deva emitir NF-e.

 Prioridade: Coluna de preenchimento facultativo. Deve ser preenchida de acordo com a


prioridade de envio de registros de uma filial. O programa extrator permite cadastrar
códigos de prioridade para determinar quais Notas Fiscais devem ser enviadas primeiro,
permitindo assim que filiais que possuem maior criticidade de autorização de NF-es sejam
atendidas primeiro.
 NFS-e: Coluna de preenchimento facultativo. Deve ser selecionada caso a filial emita
NFS-e.
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Indicador de
Pagamento

Nesta seção deverão ser parametrizados todos os indicadores de pagamentos a serem tratados
pelo extrator.

 Cond. Pgto: Coluna de preenchimento obrigatório. Deve ser preenchida com o código da
condição de pagamento no SAP.
 Condição Conversão: Coluna de preenchimento obrigatório. Deve ser preenchida de
acordo com o indicador de pagamento da SEFAZ. Admite três valores: ‘0’ – à vista; ‘1’ – a
prazo; ‘2’ – Outros.

262
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Status e-Docs

Nesta seção deverão ser parametrizados os possíveis status da nota fiscal eletrônica.
Estes status são enviados pelo componente Comply e-Docs Server e devem estar cadastrados para
que possam ser interpretados pelo componente ABAP. Além disso, é possível determinar se
o status representa erro, se permite cancelamento e conversão para contingência.

 Status: Coluna de preenchimento obrigatório. Deve ser preenchida com o código do


status de retorno do componente Comply e-Docs Server.
 Descrição do Status: Coluna de preenchimento obrigatório. Deve ser preenchida com a
descrição do status de retorno do componente Comply e-Docs Server.
 Tipo Status ERRO?: Coluna de preenchimento facultativo. Deve ser selecionada caso o
status represente erro. Com isso, a nota fiscal que retornar com esse status, ficará na aba
de erro do painel de controle do componente ABAP.
 Cancela?: Coluna de preenchimento facultativo. Deve ser selecionada caso o status
permita a solicitação de cancelamento através do painel de controle do componente
ABAP.
 Contingência?: Coluna de preenchimento facultativo. Deve ser selecionada caso o status
permita a conversão para contingência através do painel de controle do componente
ABAP.

Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Controle de
Contingência / Paralelo
Nesta seção deverão ser parametrizadas quais empresas e para quais locais de negócio e região
(UF) deverão ser emitidas notas fiscais eletrônicas. Além disso, pode-se inserir ou retirar uma
filial de contingência, sendo possível definir qual o tipo de contingência por filial e versão do XML
de contingência serão utilizados.

 Empresa: Coluna de preenchimento obrigatório. Deve ser preenchida com o código da


empresa no SAP.
 Local de Negócios: Coluna de preenchimento obrigatório. Deve ser preenchida de acordo
com o código da filial referente à empresa no SAP.
 Região: Coluna de preenchimento obrigatório. Deve ser preenchida com a região
referente ao local de negócios. Deve-se utilizar o código da UF. Exemplo: PR, SC, MG.
 Impressão: Coluna de preenchimento facultativo. Deve ser selecionada caso o local de
negócios emita notas fiscais eletrônicas.
 Paralelo: Coluna de preenchimento facultativo. Deve ser selecionada caso o local de
negócios emita notas fiscais eletrônicas e, simultaneamente, notas fiscais no modelo 1 e
1A. Este parâmetro deve ser utilizado quando a empresa estiver em processo de
homologação e desejar acompanhar o sistema e-Docs num ambiente real, emitindo notas
fiscais em modelo 1/1A e enviando NF-es ao ambiente de homologação da SEFAZ.
 Contingência: Coluna de preenchimento facultativo. Deve ser selecionada caso o local de
negócios emita notas fiscais eletrônicas diretamente em contingência. Este parâmetro
deve ser utilizado quando já for sabido que a SEFAZ relacionada àquele local de negócios

264
está em contingência. Quando este parâmetro for ativado, todas as NF-es emitidas ou
reprocessadas deste local de negócios possuirão o tipo de emissão de contingência.
 Tp. Cont: Coluna de preenchimento facultativo. Deve ser preenchida com o tipo de
contingência utilizada pelo local de negócios. O tipo de contingência é relacionado a tag
“Tipo de Emissão” (tpEmis). Admite os valores “Vazio” (sem contingência), “C”
(Formulário de Segurança), “3” (SCAN), “4” (DPEC) e “5” (FS-DA).
 Versão Cont: Coluna de preenchimento facultativo. Deve ser preenchida de acordo com a
versão do leiaute da NF-e utilizada pelo local de negócios. Este campo, quando
preenchido, determina o formato da chave de acesso - se no leiaute 1.10 ou 2.00. Admite
os valores “1” (1.10) ou “2” (2.00).
 Cód. Msg: Coluna de preenchimento facultativo. Deve ser preenchido para emissão de
notas fiscais eletrônicas em contingência, sendo atribuído o texto de justificativa de
acordo com o Cód.Msg atrelada ao local de negócio. Cód.Msg possui relacionamento com
a aba Justificativa de Contingência.
 Data de Contingência: Preenchimento pelo Componente Abap. Após selecionar o
parâmetro na coluna Contingência e salvar automaticamente, será incluído data e hora
da ativação da contingência.

 Botão ”Job de Contingência” - : Botão que, quando pressionado,


ativa o job de contingência. O job de contingência é um processo disparado em
background que tem a função de executar o extrator automaticamente. Esta
funcionalidade deve ser utilizada apenas enquanto o componente Comply e-Docs Server
estiver inoperante. Somente será possível ativar um job de contingência quando todas as
filiais estiverem configuradas para trabalhar em contingência.
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Exits do Sistema

Nesta seção, deverão ser parametrizadas quais exits o extrator deverá chamar durante sua
execução. Uma exit é um ponto específico dentro de um programa ABAP que permite a chamada
de outro programa configurado anteriormente. Assim que o programa chamado pela exit termina
seu processamento, o programa original dá continuidade a seu processo de execução.

 Código da Holding: Coluna de preenchimento obrigatório. Campo chave nos produtos da


Sonda, utilizado para identificar um cliente no banco de dados.
 Ativo?: Coluna de preenchimento facultativo. Deve ser selecionada quando a exit estiver
ativa.
 Exit: Coluna de preenchimento obrigatório. Esta coluna deve ser preenchida com o nome
da exit do extrator. Estes nomes são informados pela equipe de desenvolvimento do
sistema e-Docs.
 Programa: Coluna de preenchimento obrigatório. Deve ser preenchida com o nome do
programa que deverá ser chamado para a execução da exit.
 Form: Coluna de preenchimento obrigatório. Quando existe um programa cadastrado
para uma exit, o programa necessita estar vinculado a um form. Este campo é utilizado
para que o extrator faça a chamada do programa Z vinculado à exit corretamente.
 Descrição: Coluna de preenchimento facultativo. Deve ser preenchida com a descrição da
funcionalidade da exit.

266
Abaixo todas as exits que podem ser configuradas:
o Programa extrator: Esta exit sempre deve estar configurada. Ela é responsável pela
chamada do extrator. Para configurar esta exit é necessário configurar os seguintes
dados:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEXTRAT
 Programa: /PWS/ZNFERP002
 Form: F_EXIT_001
 Descrição: Exit para execução do extrator.

o Gravar informações nas tabelas Zs do e-Docs: Esta exit deve ser configurada
quando se deseja que as informações extraídas da NF-e permaneçam nas tabelas Zs
após a extração. É recomendado que esta exit esteja ativa. Para configurá-la, é
necessário parametrizar os seguintes dados:
 Código Holding: (Identificador do cliente).
 Exit: ZNFETABZ
 Programa: /PWS/ZNFERFORM
 Form: F_EXIT_001
 Descrição: Gravação de dados em tabela Z.

o Verificação de autorização para execução do programa extrator: Esta exit deve


ser configurada quando se deseja verificar se o usuário que está executando o
programa extrator possui autorização:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEAUT
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Verificação de autorização do extrator.

o Verificação de consistência de cabeçalho de NF-e: Esta exit deve ser configurada


quando se deseja verificar se as informações extraídas e consideras Nota Fiscal
Eletrônica devem ser realmente extraídas:
 Código Holding: (Identificador do cliente).
 Exit: ZNFSCONCAB
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Verificação de consistência dos dados extraídos.

o Verificação de consistência de cabeçalho para e-PIN: Esta exit deve ser


configurada quando se deseja verificar se as informações extraídas e consideras e-
Pin devem ser realmente extraídas:
 Código Holding: (Identificador do cliente).
 Exit: ZEPIN
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Verificação de consistência dos dados extraídos de e-PIN.

o Alteração de dados da tabela de cabeçalho: Esta exit deve ser configurada quando
se deseja alterar alguma informação referente à tabela de cabeçalho de NF-e
(/PWS/ZNFET001). Para clientes que possuem o sistema pw.CE aplicado no SAP, é
possível ativar a exit padrão de exportação. Caso o cliente deseje alterar dados de
cabeçalho, mas utilizar o programa padrão para extração de informações de
exportação do pw.CE, é necessário criar um programa Z, realizar o tratamento na
tabela de cabeçalho e, em seguida, criar uma chamada para o programa padrão de
extração de informações de exportação do pw.CE:
 Código Holding: (Identificador do cliente).
 Exit: ZNFECAPA
 Programa: (Definido pela empresa) ou com pw.CE /PWS/ZNFERFORM3.
 Form: (Definido pela empresa) ou com pw.CE F_EXIT_001.
 Descrição: Alteração de Informações de cabeçalho.

o Alteração de dados da tabela de duplicatas: Esta exit deve ser configurada quando
se deseja alterar alguma informação referente à tabela de duplicatas de NF-e
(/PWS/ZNFET007):
 Código Holding: (Identificador do cliente).
 Exit: ZNFEDUP
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).

268
 Descrição: Alteração de informações de duplicatas.

o Alteração de dados da tabela de cabeçalho de cana de açúcar: Esta exit deve ser
configurada quando se deseja alterar alguma informação referente à tabela de
dados de cabeçalho de cana de açúcar de NF-e (/PWS/ZNFET016):
 Código Holding: (Identificador do cliente).
 Exit: ZNFECANA1
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de dados de cabeçalho de cana de
açúcar.

o Alteração de dados da tabela de dados de fornecimento diário de cana de


açúcar: Esta exit deve ser configurada quando se deseja alterar alguma informação
referente à tabela de dados de fornecimento diário de cana de açúcar de NF-e
(/PWS/ZNFET017):
 Código Holding: (Identificador do cliente).
 Exit: ZNFECANA2
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de dados de fornecimento diário de cana
de açúcar.

o Alteração de dados da tabela de dados de deduções de cana de açúcar: Esta exit


deve ser configurada quando se deseja alterar alguma informação referente à tabela
de dados de deduções de cana de açúcar de NF-e (/PWS/ZNFET018):
 Código Holding: (Identificador do cliente).
 Exit: ZNFECANA3
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de dados de deduções de cana de açúcar.

o Alteração de dados da tabela de item: Esta exit deve ser configurada quando se
deseja alterar alguma informação referente à tabela de item de NF-e
(/PWS/ZNFET002):
 Código Holding: (Identificador do cliente).
 Exit: ZNFEITEM
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de item.

o Alteração de dados da tabela de importação: Esta exit deve ser configurada


quando se deseja alterar alguma informação referente às tabelas de importação de
NF-e (/PWS/ZNFET008 – Declaração de Importação e /PWS/ZNFET009 - Adições).
Para clientes que possuem o sistema pw.CE aplicado no SAP, é possível ativar a exit
padrão de importação:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEIMPORT
 Programa: (Definido pela empresa) ou com pw.CE /PWS/ZNFERFORM2.
 Form: (Definido pela empresa) ou com pw.CE F_EXIT_001.
 Descrição: Alteração de informações de importação.

o Alteração de dados da tabela de medicamentos: Esta exit deve ser configurada


quando se deseja alterar alguma informação referente à tabela de medicamentos de
NF-e (/PWS/ZNFET014). Também é possível utilizar o programa padrão para realizar
a busca dessas informações, porém, caso o cliente não trabalhe no ramo
farmacêutico, é recomendado não ativar esta exit:
 Código Holding: (Identificador do cliente).
 Exit: ZNFELOTMED
 Programa: (Definido pela empresa) ou /PWS/ZNFERFORM.
 Form: (Definido pela empresa) ou F_EXIT_004.
 Descrição: Alteração de informações de medicamentos.

o Alteração de dados da tabela de veículos: Esta exit deve ser configurada quando se
deseja alterar alguma informação referente à tabela de veículos de NF-e
(/PWS/ZNFET019):
 Código Holding: (Identificador do cliente).
 Exit: ZNFEVEIC
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de veículos.

270
o Alteração de dados da tabela de informações de combustíveis: Esta exit deve ser
configurada quando se deseja alterar alguma informação referente à tabela de
combustíveis de NF-e (/PWS/ZNFET013):
 Código Holding: (Identificador do cliente).
 Exit: ZNFEIMPCOM
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de combustíveis.

o Alteração de dados da tabela de informações de armamentos: Esta exit deve ser


configurada quando se deseja alterar alguma informação referente à tabela de
armamentos de NF-e (/PWS/ZNFET015):
 Código Holding: (Identificador do cliente).
 Exit: ZNFEIMPARM
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de combustíveis.

o Alteração de Dados de Impostos de Gerais: Esta exit deve ser configurada quando
se deseja adicionar alguma linha de imposto não extraída ou inexistente no SAP
standard. Por este motivo, é possível alterar as tabelas de item (/PWS/ZNFET002) e
de imposto (/PWS/ZNFET003):
 Código Holding: (Identificador do cliente).
 Exit: ZNFEIMPGER
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de impostos não standard.

o Alteração de dados da tabela de observações: Esta exit deve ser configurada


quando se deseja alterar alguma informação referente à tabela de observações de
NF-e (/PWS/ZNFET005). É possível ativar a exit padrão de Ponto de atenção: Esta
exit apenas extrai informações contidas nas tabelas standard de observação da nota
fiscal no SAP, que não são completas. Sendo assim, orientamos ao cliente que
desenvolva um tratamento específico:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEOBS
 Programa: (Definido pela empresa) ou /PWS/ZNFERFORM.
 Form: (Definido pela empresa) ou F_EXIT_008.
 Descrição: Alteração de informações de observação.
o Alteração de dados da tabela de referência: Esta exit deve ser configurada quando
se deseja alterar alguma informação referente à tabela de referência de NF-e
(/PWS/ZNFET004):
 Código Holding: (Identificador do cliente).
 Exit: ZNFEREFER
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de referência.

o Alteração de dados da tabela de imposto: Esta exit deve ser configurada quando se
deseja alterar alguma informação já extraída e tratada extrator referente à tabela
de imposto de NF-e (/PWS/ZNFET003):
 Código Holding: (Identificador do cliente).
 Exit: ZNFEIMP
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de imposto standard.

o Programa de impressão SAP: Esta exit deve ser configurada quando se deseja
realizar a chamada ao programa de impressão do DANFE no SAP. Esta exit é
executada pela função de retorno e pelo extrator, quando o status de retorno do
componente Comply e-Docs Server indicar autorização de NF-e, e através do Painel
de Controle, clicando no botão Impressão de DANFE:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEDANFE
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Programa de impressão de DANFE.

o Programa de impressão de FS (Formulário de Segurança) no SAP: Esta exit deve


ser configurada quando se deseja realizar a chamada ao programa de impressão do
formulário de segurança no SAP. Esta exit é executada apenas pelo extrator, quando
verifica que o tipo de emissão da NF-e é 2 (formulário de segurança), e através do
painel de controle, clicando no botão “Tratamento Automático de Contingência”:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEDANSEG

272
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Programa de impressão de FS.

o Programa de impressão de SCAN no SAP: Esta exit deve ser configurada quando se
deseja realizar a chamada ao programa de impressão do DANFE autorizado pelo
SCAN no SAP. Esta exit é executada apenas pela função de retorno, quando o status
de retorno do componente Comply e-Docs Server é de autorização, o tipo de
emissão é 3 – SCAN, e através do painel de controle, clicando no botão “Tratamento
Automático de Contingência”. Essa impressão só ocorre quando há o status de
autorização:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEDANF3.
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Programa de impressão de SCAN.

o Programa de impressão de DPEC no SAP: Esta exit deve ser configurada quando se
deseja realizar a chamada ao programa de impressão do DANFE autorizado pelo
DPEC no SAP. Esta exit é executada apenas pela função de retorno, quando o status
de retorno do componente Comply e-Docs Server é 124 – DPEC, recebido pelo
sistema de contingência eletrônica, e através do painel de controle, clicando no
botão “Tratamento Automático de Contingência”. Essa impressão só ocorre
quando há o status 124 ou status 100:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEDANF4.
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Programa de impressão de DPEC.

o Programa de impressão de FSDA (Documento Auxiliar - Formulário de Segurança)


no SAP: Esta exit deve ser configurada quando se deseja realizar a chamada ao
programa de impressão do FS-DA no SAP. Esta exit é executada apenas pelo
extrator, quando percebe que o tipo de emissão da NF-e é 5 (FS-DA), e através do
painel de controle, clicando no botão “Tratamento Automático de
Contingência”:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEDANF5.
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Programa de impressão de FSDA.

o Verificação de autorização para exibição do botão de impressão de DANFE no


painel de controle: Esta exit deve ser configurada quando se deseja verificar se o
usuário atual possui permissão para visualizar o botão de impressão de DANFE no
painel de controle:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEAUDAN.
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Verificação de autorização para visualização do botão de impressão
de DANFE.

o Verificação de autorização para exibição de dados de NF-e no painel de controle:


Esta exit deve ser configurada quando se deseja verificar se o usuário atual possui
permissão para visualizar os registros de NF-e que selecionou através do filtro no
painel de controle. Essa verificação deve ser executada por matriz e filial:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEAUPC.
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Verificação de autorização para visualização de dados de NF-e.
o Atualizações da aba “NF-e Data” na transação J1B3N e estorno dos documentos
relacionados a uma NF-e cancelada ou inutilizada: Esta exit deve ser configurada
quando se deseja que o componente ABAP do sistema e-Docs atualize as
informações de NF-e na aba “NF-e Data” (“Dados NF-e”) da transação J1B3N do SAP.
Serão atualizados: o status da NF-e e o protocolo de autorização de Uso. Além disso,
caso a NF-e seja cancelada (101 – Cancelamento de NF-e Homologado) ou inutilizada
(102 – Inutilização de número Homologado), será realizada a tentativa de estorno
dos documentos relacionados a esta NF-e no SAP. É realizado o cancelamento
manual, o estorno da fatura e estorno de documento de material:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEATLZ.
 Programa: (Definido pela empresa).
 Form: (F_EXIT_006 OU F_EXIT_009 OU Definido pela empresa).
 Descrição: Atualização de Dados Standard de NF-e no SAP.

o Gravar informações nas tabelas Zs do e-Docs: Esta exit deve ser configurada

274
quando se deseja que as informações extraídas da NF-e permaneçam nas tabelas Zs
após a extração. Para configurá-la, é necessário parametrizar os seguintes dados:
 Código Holding: (Identificador do cliente).
 Exit: ZNFETABZ2
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Gravação de dados em tabela Z.

o Retorno de NFS-e: Esta exit deve ser configurada para tratamento de retorno de
nota fiscal de serviço. Para configurá-la, é necessário parametrizar os seguintes
dados:
 Código Holding: (Identificador do cliente).
 Exit: ZNFSERET
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Retorno de NFS-e.

o Alteração de dados da tabela de construção para NFS-e: Esta exit deve ser
configurada quando se deseja alterar alguma informação referente à tabela de
dados de construção para NFS-e (/PWS/ZNFET021):
 Código Holding: (Identificador do cliente).
 Exit: ZNFSCONST
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Alteração de informações de dados de construção para NFS-e.

o Botão de estorno do painel de controle: Esta exit deve ser configurada quando se
deseja alterar o tratamento do botão de estorno do painel de controle:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEEST
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Botão de estorno.

o Tratamento de botões do painel de controle: Esta exit deve ser configurada


quando se deseja alterar o tratamento dos botões do painel de controle:
 Código Holding: (Identificador do cliente).
 Exit: ZNFEBOTAO
 Programa: (Definido pela empresa).
 Form: (Definido pela empresa).
 Descrição: Botões do painel de controle.

276
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Categorias de NFe

Esta seção somente deve ser configurada caso o cliente utilize a função de conversão de NF-e
(/PWS/ZNFE_DETERMINA_NFE). Esta função tem o papel de verificar se a nota fiscal modelo 1/1A
representa NF-e e para qual categoria deve ser convertida para utilizar o modelo 55. Esta função
deve ser amarrada ao programa de determinação de numeração de nota fiscal standard do SAP.

Nesta seção deve ser parametrizado o de/para de categorias de nota fiscal no SAP. A função que
determina se a nota fiscal é eletrônica utiliza esta parametrização. Após verificar se a nota fiscal
pertence aos locais de negócio configurados como emissores de nota fiscal eletrônica, a função
verifica este de/para para então determinar qual a categoria a NF-e deve ser convertida para
possuir o modelo 55. A categoria de nota fiscal determina o modelo da nota fiscal, portanto é
através desta parametrização que temos a conversão de diversos modelos de nota fiscal ao
modelo 55.

 De: Coluna de preenchimento obrigatório. Preencher com a categoria de origem no SAP;


 Para: Coluna de preenchimento obrigatório. Preencher com a categoria de destino no SAP
que possui o modelo 55.

Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Constantes do Produto
Nesta seção deverão ser parametrizadas as constantes do extrator. Estas constantes nos
permitem modificar a forma que uma variável é tratada pelo programa extrator. Além do
programa extrator, as exits desenvolvidas pelo cliente podem utilizar este cadastro.

 Nome do programa: Coluna de preenchimento obrigatório. Preencher com o programa


que irá ler os dados parametrizados.
 Nome da variável: Coluna de preenchimento obrigatório. Preencher com o nome da
variável que deverá receber o valor.
 Valor da variável: Coluna de preenchimento obrigatório. Preencher com o valor a ser
recebido pela variável.

Abaixo todas as constantes que podem ser configuradas:


o Exclusão da extração de NF-e com processo concluído: Esta constante deve ser
configurada quando o cliente não desejar que NF-es com processo concluído
(autorizadas, canceladas ou inutilizadas) sejam reprocessadas:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: EXTEXCNFP.
 Valor da variável: EXTEXCNFP.

278
o Campo de numeração de NF-e: Esta constante deve ser configurada quando se
deseja determinar qual campo da tabela de Cabeçalho de NF standard (J_1BNFDOC)
deve ser considerado para determinar a numeração da NF-e: O NFNUM (6 posições)
ou NFENUM (9 posições). O valor NFENUM somente deve ser configurado caso o
cliente já tenha realizado as configurações necessárias para que este campo seja
preenchido corretamente. Caso essa constante não exista, o campo considerado
será o NFNUM:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: NFNUM.
 Valor da variável: “NFNUM” ou “NFENUM”.

o Quantidade máxima de registro para extração normal: Esta constante deve ser
configurada quando existir a necessidade de determinar qual a quantidade máxima
de registros que devem ser extraídos a cada chamada RFC do componente Comply e-
Docs Server. Caso essa constante não exista, o valor padrão utilizado será “cem”:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: EXTNREG.
 Valor da variável: (Numérico). Recomenda-se estudar a quantidade ideal de
registros a serem extraídos. Por padrão é “100”.

o Quantidade máxima de registro para extração em contingência: Esta constante


deve ser configurada quando existir a necessidade de determinar qual a quantidade
máxima de registros que devem ser extraídos em contingência a cada chamada RFC
do componente Comply e-Docs Server. Caso essa constante não exista, o valor
padrão utilizado será “cem”:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: EXTNREGC.
 Valor da variável: (Numérico). Recomenda-se estudar a quantidade ideal de
registros a serem extraídos. Por padrão é “100”.

o Quantidade máxima de processos paralelos: Esta constante deve ser configurada


quando existir a necessidade de determinar qual a quantidade máxima de processos
paralelos de envio ao componente Comply e-Docs Server serão aceitos. Caso essa
constante não exista, o valor padrão utilizado será “cinco”:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: EXTNPRL.
 Valor da variável: (Numérico). Recomenda-se estudar a quantidade ideal de
processos paralelos. Por padrão é “5”.

o Quantidade máxima de registros para gravação no banco de dados: Esta constante


deve ser configurada quando existir a necessidade de determinar qual a quantidade
máxima de registros que devem ser gravados nas tabelas Zs do componente ABAP a
cada execução do extrator. Caso essa constante não exista, o valor padrão utilizado
será “cem”:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: EXTRECLOT.
 Valor da variável: (Numérico). Recomenda-se estudar a quantidade ideal. Por
padrão é “100”.

o Justificativa de contingência: Esta constante deve ser configurada para determinar


uma justificativa padrão para contingência. O valor desse campo será preenchido na
tag xJust, no leiaute da NF-e 2.00. Essa constante é verificada quando a NF-e possui
o tipo de emissão diferente de normal. Caso essa constante não exista, o valor
padrão utilizado será vazio:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: JUST_CONT.
 Valor da variável: (Alfanumérico). Justificativa da entrada em contingência.

o Data de emissão substituída pela data atual (somente para fase de teste
unitário): Esta constante deve ser configurada quando existir a necessidade de
realizar testes com NFs antigas que possuam a data de emissão muito atrasada e,
por esse motivo, seriam rejeitadas pela SEFAZ. Caso essa constante não exista, a
data de emissão considerada será a da NF-e:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: TESTE.
 Valor da variável: TESTE.

o Retirar zeros à esquerda do código do material: Esta constante deve ser


configurada quando existir a necessidade de retirar os zeros à esquerda do código
do produto. Caso essa constante não exista, o código do material será enviado da
forma como está no cadastro de materiais do SAP:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: MATNR.
 Valor da variável: MATNR.

o Indica se o valor do produto do item deve ser somado ao total dos produtos,
apenas leiaute NF-e 2.00: Esta constante determina, por padrão, se o valor do
produto do item (tag vProd) deve ser somado ao grupo de totais do ICMS (ICMSTot,
tag vProd). Apesar de esta constante existir, recomendamos que os clientes
analisem seus cenários de emissão de NF-e, para verificar se existe algum caso em
que há a necessidade de não somar um item ao valor total de produtos. Com um
cenário assim, será necessário um desenvolvimento adicional, através da EXIT de

280
Item (ZNFEITEM). Caso essa constante não exista, haverá erro na geração do XML,
uma vez que a tag de indicador de total (indTot) no item não será preenchida:
o Nome do programa: /PWS/ZNFERP002.
o Nome da variável: NFITM_IND_TOT.
o Valor da variável: 0 (O valor do item (vProd) não compõe o valor total da NF-
e (grupo ICMSTot, vProd)) ou 1 (O valor do item (vProd) compõe o valor total
da NF-e (grupo ICMSTot, vProd)).

o Destinatário da NF-e no exterior - Bairro: Esta constante determina, por padrão,


qual valor deve ser inserido no bairro quando o destinatário da NF-e for no exterior.
Recomendamos preencher o valor desta constante com EXTERIOR:
o Nome do programa: /PWS/ZNFERP002.
o Nome da variável: BAIRRO.
o Valor da variável: (Alfanumérico). Recomendamos preencher com
“EXTERIOR”.

o Destinatário da NF-e no exterior – Código de Município do Destinatário: Esta


constante determina, por padrão, qual valor deve ser inserido no código de
município do destinatário quando o destinatário da NF-e for no exterior.
Recomendamos preencher o valor desta constante com 9999999:
o Nome do programa: /PWS/ZNFERP002.
o Nome da variável: COD_MUNIC_DEST.
o Valor da variável: 9999999. Imposição do manual de integração do
contribuinte.

o Destinatário da NF-e no exterior – Nome de município do destinatário: Esta


constante determina, por padrão, qual valor deve ser inserido no nome do município
do destinatário quando o destinatário da NF-e for no exterior. Recomendamos
preencher o valor desta constante com EXTERIOR:
o Nome do programa: /PWS/ZNFERP002.
o Nome da variável: NOME_MUNIC_DEST.
o Valor da variável: EXTERIOR. Imposição do manual de integração do
contribuinte.

o Destinatário da NF-e no exterior – Código da UF: Esta constante determina, por


padrão, qual valor deve ser inserido no código da UF do destinatário quando o
destinatário da NF-e for no exterior. Recomendamos preencher o valor desta
constante com EX:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: COD_UF.
 Valor da variável: Exemplo: Imposição do manual de integração do
contribuinte.

o Destinatário da NF-e no exterior – CEP: Esta constante determina, por padrão, qual
valor deve ser inserido no CEP do destinatário quando o destinatário da NF-e for no
exterior. É necessário preencher o valor desta constante com 99999999:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: CEP.
 Valor da variável: (Numérico). Recomendamos preencher com 99999999.

o Código de município – Consulta a tabela de faixa de CEP: Esta constante


determina se o extrator deve realizar a busca no cadastro de faixa de CEP no SAP,
para determinar o código de município do destinatário. Esta constante somente
deve ser utilizada caso o cadastro de faixa de CEP do SAP estiver atualizado. Se esta
constante não estiver configurada, por padrão o programa extrator realizará a
verificação de faixa de CEP no SAP:
 Nome do programa: /PWS/ZNFERP002.
 Nome da variável: FAIXACEP.
 Valor da variável: ‘S’ (para utilizar a verificação) ou ‘N’ (para não utilizar a
verificação e deixar o cadastro de faixa de CEP a cargo do componente
Comply e-Docs Server).

o Código do tipo de condição para determinar o PMC (medicamentos): Esta


constante determina qual a nome do tipo de condição, dentro de uma princing de
uma fatura, para determinar qual o valor do PMC (preço máximo ao consumidor). O
valor dessa condição será inserido na tag vPMC. Esta constante somente deve ser
utilizada caso o cliente seja uma farmacêutica. Se esta constante não estiver
configurada, por padrão, o programa extrator procurará a condição standard de
preço “PR00”:
o Nome do programa: /PWS/ZNFERFORM.
o Nome da variável: KSCHL.
o Valor da variável: (Alfanumérico).

o Exibir botão de solicitação de cancelamento de NF-e: Esta constante determina se


o botão de solicitação de cancelamento de NF-e deve ser exibido no painel de
controle do componente ABAP. Se esta constante não estiver configurada, por
padrão o botão será exibido:
o Nome do programa: /PWS/SAPMZNFEMP000.
o Nome da variável: BOTAO_CANCELAMENTO.
o Valor da variável: ‘S’ (para exibir) ou ‘N’ (para não exibir).

282
o Update tabela de controle: Esta constante determina a quantidade de vezes em
que a função de retorno executará o update na tabela /PWS/ZNFETB000. Caso não
esteja parametrizado, o update ocorre só uma vez.
o Nome do programa: /PWS/ZNFE_RETORNO_SAP.
o Nome da variável: NUM_UPD.
o Valor da variável: (Numérico).

o Limpar Tabelas Z: Esta constante determina se no momento da re-extração de um


docnum as tabelas Z (área de armazenamento Sonda) serão apagadas ou não. Esta
contante pode ser utilizada para apagar dados indesejados num momento de
reprocessamento, constante muito utilizada em testes.
o Nome do programa: /PWS/ZNFERP002.
o Nome da variável: LIMPA_TABZ.
o Valor da variável: S ou N.

o Utilizar NUM_NF na chave de acesso: Esta constante indica se o campo NUM_NF


deve ser utilizado como parte da chave acesso, caso N, a chave de acesso será
criada normalmente com o campo DOCNUM. Esta constante deve ser utilizada em
conjunto com o parâmetro “UTILIZA_CHAVE_ACESSO_NUM_NF”.
o Nome do programa: /PWS/SAPLZNFEGF1.
o Nome da variável: CHVNFE_CNF_NFENUM.
o Valor da variável: S ou N.

o Buscar Número FCI: Esta constante se integra com o produto Sonda FCI e busca o
número FCI para o material extraído na NF-e. Apenas parametrize esta função se
utilizar o produto Sonda FCI.
o Nome do programa: /PWS/ZNFERP002.
o Nome da variável: INTEGRA_SONDA_FCI.
o Valor da variável: S ou N.

Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Código País

Nesta seção, deverão ser parametrizados todos os países do SAP e seus respectivos códigos
BACEN.
 País: Coluna de preenchimento obrigatório. Preencher com a sigla do país existente no
SAP. Exemplo: BR, AR.
 Código País: Coluna de preenchimento obrigatório. Preencher com código do país, de
acordo com a Tabela BACEN.
 Nome do País: Coluna de preenchimento obrigatório. Preencher com o nome do país.

Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Finalidade de
Documento

Nesta seção, deverão ser parametrizados os de/para das finalidades de documento no SAP para a
SEFAZ. Este cadastro determina qual valor deverá ser extraído para a tag finNFe. Esta tag possui
os seguintes valores: 1 - NF-e Normal, 2 - NF-e Complementar e 3 – NF-e de Ajuste.

284
 De: Coluna de preenchimento obrigatório. Preencher com o tipo de documento
(document type) da categoria da NF-e no SAP. Para verificar quais são os tipos de
documentos cadastrados no SAP, é possível acessá-los através da transação SE16, verificar
a tabela J_1BNFDOC e, em seguida, clicar sobre o matchcode do campo “DOCTYP”.
Exemplo:
 Para: Coluna de preenchimento obrigatório. Preencher com a finalidade de documento
relacionada ao tipo de documento no SAP. As finalidades de NF-e possíveis são: 1 - NF-e
Normal, 2 - NF-e Complementar e 3 – NF-e de Ajuste.

286
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > e-Pin - Parâmetros

Nesta seção, deverão ser parametrizados os critérios para definir se uma nota fiscal pertence ao
e-Pin. O e-Pin é um arquivo TXT, que possui um formato interno de XML, que deve ser enviado à
SUFRAMA para mercadorias que possuem como destino a zona franca de Manaus. É possível
realizar este cadastro através do CFOP do item da nota fiscal, domicílio fiscal e inscrição
SUFRAMA. Caso mais de uma opção seja utilizada, a nota fiscal deve atender a todos os critérios
para ser considerada e-Pin. Exemplo: CFOP 6109 e domicílio fiscal ‘ZN’. Caso este critério seja
configurado, será necessário que uma nota fiscal, para ser considerada e-Pin, possua este CFOP e
que o parceiro destinatário da nota fiscal possua o domicílio fiscal informado.

É importante destacar que, caso uma nota fiscal não seja considera NF-e, mas for considerada e-
Pin, será gerado o e-Pin convencional; caso ela seja considerada apenas NF-e, e não e-Pin,
somente será gerada a NF-e. Também existe a possibilidade da nota fiscal ser considerada NF-e e
e-Pin. Nesse caso, primeiro a NF-e deverá ser autorizada; em seguida, deverá ser gerado o
arquivo e-Pin eletrônico, lembrando sempre que uma NF-e somente gerará o e-Pin eletrônico
após sua autorização de uso, logo, se a NF-e for rejeitada, o arquivo e-Pin não será gerado. Isso
ocorre porque, ao realizar o upload de um arquivo e-Pin eletrônico, é verificada a existência da
NF-e na base de dados da SUFRAMA.

 CFOP’s zona franca: Aba de preenchimento facultativo. Preencher somente se for


necessário determinar se uma nota fiscal representa e-Pin através do CFOP.
 Domicílios fiscais – Zona Franca: Aba de preenchimento facultativo. Preencher somente
se for necessário determinar se uma nota fiscal representa e-Pin através do domicílio
fiscal.
 Inscrição SUFRAMA: Aba de preenchimento facultativo. Preencher somente se for
necessário determinar se uma nota fiscal representa e-Pin através da inscrição SUFRAMA.
 Ignorar pessoa ísica: Parâmetro de preenchimento facultativo. Marcar somente para
determinar se as opções do filtro e-Pin devem ser desconsideradas para NF-es emitidas
para pessoas físicas.

288
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Justificativa de
Contingência

Nesta seção, deverão ser parametrizados o código de contingência e a descrição correspondente.


Este cadastro determina qual valor deverá ser exibido no matchcode da aba “Controle de
Contingência / Paralelo” no campo “Cód. Msg“.

 Cód.: Coluna de preenchimento obrigatório. Preencher com o tipo de contingência;


 Mensagem: Coluna de preenchimento obrigatório. Preencher com a descrição
correspondente ao tipo de contingência.
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Município X Filial

Nesta seção deverão ser parametrizados dados de nota fiscal de serviço (NFS-e) de acordo com os
respectivos leiautes municipais. Esse cadastro determina por local de negócio: Natureza de
operação / Tributação, Tipo de Rps, Tipo de Recolhimento e Tipo de Operação.

Esta parametrização é somente para emissão de Nota fiscal de Serviço (NFS-e) com integração ao
Módulo NFS-e da Sonda IT.

 Empresa: Coluna de preenchimento obrigatório. Deve ser preenchida com o código da


empresa no SAP.
 Loc. negócios: Coluna de preenchimento obrigatório. Deve ser preenchida de acordo com
o código do local de negócios.
 Nat. op. município / tributação: Coluna de preenchimento obrigatório. Deve ser
selecionada a natureza de operação / tributação correspondente com o leiaute NFS-e.
 Tipo RPS: Coluna de preenchimento obrigatório. Deve ser selecionado o tipo da nota
fiscal de serviço.
 Tipo recolhimento: Para leiaute DSF, coluna de preenchimento obrigatório. Para leiautes
ABRASF e GINFES, coluna não utilizada.
 Tipo operação: Para leiaute DSF, coluna de preenchimento obrigatório. Para leiautes
ABRASF e GINFES, coluna não utilizada.
290
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Cód. Serviço X Cód.
Tributação do ISSQN

Nesta seção deverá ser parametrizado o código de tributação do ISSQN que será atribuído nas
notas fiscais de serviço (NFS-es), vinculado ao código de lista de serviço. Na extração da nota
fiscal de serviço serão verificados: empresa, local de negocio e código de serviço da nota para
atribuir o cód. Tributação do ISSQN que estiver parametrizado.

Esta parametrização é somente para emissão de Nota fiscal de Serviço (NFS-e) com integração ao
Módulo NFS-e da Sonda IT.

 Empresa: Coluna de preenchimento obrigatório. Deve ser preenchida com o código da


empresa no SAP.
 Loc. negócios: Coluna de preenchimento obrigatório. Deve ser preenchida de acordo com
o código do local de negócios.
 Código de serviço: Coluna de preenchimento obrigatório. Deve ser preenchido o código
de lista de serviço que será atribuído nas notas fiscais de serviço.
 Cód. tributação do ISSQN: Coluna de preenchimento obrigatório. Deve ser preenchido o
número do código de tributação do ISSQN.

292
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Formas de Tributação
X NFS-e

Nesta seção, deverão ser parametrizados o código de natureza de operação, tipo de


recolhimento, tipo de operação e suas correspondentes descrições. Este cadastro determina os
valores que deverão ser exibidos nos matchcodes da aba “Município X Filial“.

 Nat. op. município / tributação: Deve ser preenchido valor da natureza da operação do
município/tributação de acordo com o leiaute municipal de emissão de NFS-e.
 Descrição nat. op. município / tributação: Deve ser preenchido com a descrição
correspondente ao tipo de natureza de operação do município/tributação.
 Tipo recolhimento: Deve ser preenchido com o tipo de recolhimento.
 Descrição recolhimento: Deve ser preenchido com a descrição correspondente ao tipo de
recolhimento.
 Tipo operação: Deve ser preenchido com o tipo de operação.
 Descrição operação: Deve ser preenchido com a descrição correspondente ao tipo de
operação.

Parâmetros de Inclusão e Exclusão - (/PWS/ZNFEM001)


A transação “Parâmetros de Inclusão e Exclusão” permite determinar alguns parâmetros para
definir quais notas fiscais devem ser consideradas para a extração. Essa configuração deve ser
realizada quando o projeto possuir uma fase de migração (rollout). Dessa forma, é possível
determinar, por exemplo, que todas as NF-es de uma filial sejam extraídas, menos as que
possuírem a Série 2.

Os parâmetros configurados nessa transação são globais, logo, se uma filial nesta transação for
configurada para a exclusão e na transação de Parâmetros for configurada para extrair, as NF-es
emitidas por esta filial não serão extraídas.

Quando um parâmetro é determinado para a inclusão, todos os demais serão considerados


excluídos. Por exemplo: Se for configurado para a inclusão da filial 1 e 2 e uma nota fiscal for
emitida pela filial 3, ela não será extraída.

 Empresa: Empresas que devem ou não emitir nota fiscal eletrônica.


 Filial: Filiais que devem ou não emitir nota fiscal eletrônica.
 Local de expedição: Informar quais locais de expedição deverão ser considerados para
emissão de nota fiscal eletrônica.
 Tipo de nota: Informar quais categorias de notas fiscais deverão ser consideradas para
emissão de nota fiscal eletrônica.

294
 Direção NF: Informar se as notas fiscais de entrada/saída deverão ser consideradas para
emissão de nota fiscal eletrônica.
 Parceiro: Informar quais os parceiros que deverão ser considerados para emissão de nota
fiscal eletrônica.
 Série: Informar quais as séries de nota fiscal que deverão ser consideradas para emissão
de nota fiscal eletrônica.
 Subsérie: Informar quais subséries de nota fiscal deverão ser consideradas para emissão
de nota fiscal eletrônica.
 Modelo: Informar quais os modelos de nota fiscal que deverão ser considerados para
emissão de nota fiscal eletrônica.
 CFOP: Informar quais os CFOPs que deverão ser considerados para emissão de nota fiscal
eletrônica. Atentar que esta configuração é em nível de item e, quando configurada,
exclui os Itens não relacionados àquele CFOP. Exemplo: Quando um CFOP está
configurado aqui, todos os demais serão desconsiderados; em uma nota fiscal com dois
CFOPs diferentes, um item seria mantido e o outro, excluído.
 Material: Informar quais materiais deverão ser considerados para emissão de nota fiscal
eletrônica. Atentar que esta configuração é em nível de item e, quando configurada,
exclui os itens não relacionados àquele material.
 Centro: Informar quais centros deverão ser considerados para emissão de nota fiscal
eletrônica. Atentar que esta configuração é em nível de item e, quando configurada,
exclui os itens não relacionados àquele centro.
Extrator NF-e - (/PWS/ZNFERP002)
A transação “Extrator NF-e” possibilita executar manualmente o programa extrator. O programa
extrator tem a função de realizar a seleção dos dados de nota fiscal nas tabelas standard do SAP,
executar os tratamentos necessários e gravar o resultado nas tabelas Zs do componente ABAP, do
sistema e-Docs.

Esta transação deve ser acessada somente para a realização de testes e pequenas intervenções
nos dados das tabelas Zs. O ideal é sempre trabalhar com extração automática, não utilizando
esta transação.

Caso o campo “Interface Normal S/N” seja definido como “N”, ao executar o programa extrator
serão levados em consideração os intervalos de notas fiscais definidos na transação de
parâmetros. Caso seja definido como “S”, o programa extrator irá extrair as notas fiscais a partir
do Último documento, que também está gravado na transação “Parâmetros”.

296
Caso o usuário selecione no botão seleção múltipla, é possível definir um intervalo de docnum
para a extração de NF-es.
298
Painel de Controle - (/PWS/ZNFEMP000)
A transação “Painel de Controle” possibilita visualizar o status e últimos eventos de uma NF-e
extraída pelo extrator. É possível acompanhar seu ciclo de vida, desde a extração até a
autorização de uso, bem como cancelamento e inutilizações executadas.

Além disso, é possível executar a impressão do DANFE e outros formulários (FS, FS-DA),
visualização de informações, reprocessamento, solicitação de cancelamento e visualizações de
mensagens enviadas ao contribuinte.

Menu: /PWS/ZNFEMP000 > Tela de Seleção

 Código matriz: Permite selecionar o código da matriz, com possibilidade de definir um


intervalo ou seleção múltipla. É obrigatório informar pelo menos uma matriz. É possível a
utilização do matchcode.
 Código filial: Permite selecionar o código da filial, com possibilidade de definir um
intervalo ou seleção múltipla. É possível a utilização do matchcode.
 Código do cliente: Permite selecionar o código da filial, com possibilidade de definir um
intervalo ou seleção múltipla. É possível a utilização do matchcode.
 Número nota fiscal: Permite selecionar o número da nota fiscal gerada no SAP, com
possibilidade de definir um intervalo ou seleção múltipla.
 Série: Permite entrar com o número de série gerado no SAP, com possibilidade de definir
um intervalo ou seleção múltipla.
 Data de emissão: Permite entrar com um intervalo de datas de emissão de nota fiscal. É
possível a utilização do matchcode.
 Hora de emissão: Permite entrar com um intervalo de horas de emissão de nota fiscal. É
possível a utilização do matchcode.
 Impresso: Permite selecionar se as notas que serão exibidas serão somente notas
impressas ou não impressas. É possível a utilização do matchcode.
 CFOP: Permite selecionar o CFOP do item, com possibilidade de definir um intervalo ou
seleção múltipla. É possível a utilização do matchcode.
 Tipo de emissão: Permite selecionar o tipo de emissão da NF-e, com possibilidade de
definir um intervalo ou seleção múltipla. É possível a utilização do matchcode.
 Status de estorno: Permite entrar com um intervalo de status de estorno. É possível a
utilização do matchcode.
 Docnum: Permite entrar com um intervalo de docnum.
 Chave de acesso: Permite entrar com um intervalo de chave de acesso.
 Categoria de NF-e: Permite entrar com um intervalo de categoria de NF-e. É possível a
utilização do matchcode.
 Usuário: Permite entrar com um intervalo de usuário.
 Total da nota: Permite entrar com um intervalo de total de nota.
 Tipo de nota: Os dados da nota fiscal podem ser filtrados através da direção das notas
fiscais entrada / saída. As opções possíveis são:
o Saída/Entrada: Seleciona NF-es de entrada e saída;
o Somente saída: Seleciona NF-es de saída;
o Somente entrada: Seleciona NF-es de entrada.
 Status: Os dados da nota fiscal podem ser filtrados por seu status de envio. As opções
possíveis são:
o Retorno com sucesso: Seleciona NF-es com processo concluído (autorização de uso,
cancelamento homologado ou inutilização homologada);
o Aguardando retorno: Seleciona NF-es que foram extraídas e estão pendentes de
envio ou retorno do componente Comply e-Docs Server.
o Retorno com erro: Seleciona NF-es que retornaram ao sistema de origem, porém
apresentou alguma falha no processamento.
o NF-e: Seleciona NF-e.
o NFS-e: Seleciona NFS-e.

 Num. máx. de ocorrência: Determina o número máximo de registros que serão


apresentados no painel de controle.

300
 Botão executar (Atalho F8): Executará a seleção determinada e montará os
registros para exibição no painel de controle.

Menu: /PWS/ZNFEMP000 > Exibição Painel de Controle

 Abas: O painel de controle é divido em abas para facilitar a visualização do status atual
da NF-e, dado seu ciclo de vida. As abas são as seguintes:
 Envio/Recebimento: Exibirá NF-es que já foram enviadas ao componente Comply e-
Docs Server. As NF-es nesta aba estarão com o farol amarelo, caso estejam com o
status pendente de retorno, e estarão verdes, caso o processo da NF-e já esteja
concluído;
 Aguardando envio: Exibirá NF-es que já foram extraídas, mas ainda não foram
enviadas ao componente Comply e-Docs Server;
 Envio/Recebimento - Erro: Exibirá NF-es que já foram enviadas ao componente
Comply e-Docs Server e retornaram com erro. Todas as NF-es nesta aba estarão com
o farol vermelho. A seção Status e-Docs, da transação parâmetros, permite
configurar se um evento representa erro. Com isso, caso o evento de retorno da NF-
e represente erro, ele será exibido nesta aba; caso contrário, será exibido na aba
“Envio/Recebimento”, com o farol verde;
 Contingência: Exibirá NF-es que estão em contingência. As NF-es nessa aba possuem
o tipo de emissão diferente de normal. Se a NF-e estiver sendo processada em
contingência, sem retorno, estará com o farol amarelo. Caso haja algum erro no
processamento da contingência, ficará com o farol vermelho e, caso seja autorizada
em contingência, ficará com o farol verde;

 Botão exibir documento : Permite visualizar a nota fiscal selecionada na transação


J1B3N.

 Botão reprocessamento de NF : Permite reprocessar a nota fiscal selecionada, ou


seja, retransmiti-la ao componente Comply e-Docs Server. Se a NF-e estiver com o farol
vermelho (status de erro), será reextraída; se estiver com o farol amarelo, será
reenviada. Isso ocorre porque uma NF-e que está com o farol amarelo não deve ser
reextraída, porque ainda está em processamento no componente Comply e-Docs Server.
Logo, isso impossibilita, que uma NF-e seja autorizada no componente Comply e-Docs
Server com uma informação que não é mais coerente com o componente ABAP.

 Botão impressão DANFE : Permite imprimir o DANFE de uma nota fiscal, somente se
a NF-e estiver autorizada (status 100 – autorizado o uso da NF-e). Para que a impressão
ocorra é necessário que o programa de impressão, configurado na exit ZNFEDANFE,
funcione corretamente.

 Botão atualização de dados : Permite atualizar os dados exibidos no painel de


controle.

 Botões de ordenação : Permite ordenar de forma crescente ou decrescente os


dados exibidos no painel de controle.

 Botão tratamento automático de contingência : Permite converter uma NF-e para


contingência ou imprimir o DANFE em um dos tipos de emissão de contingência (FS, SCAN,
DPEC ou FS-DA). Para converter uma NF-e para contingência, é necessário que a NF-e
esteja com o farol vermelho ou amarelo. Quando este botão é ativado, a primeira
verificação executada é quanto à impressão: se a NF-e já foi impressa, é necessário que
seja impressa no mesmo formulário; somente será realizada uma chamada ao programa
de impressão, de acordo com o formulário. Caso a impressão não tenha ocorrido, será
verificado o tipo de contingência, de acordo com a filial no cadastro realizado nas abas
“Controle de Contingência” / “Paralelo na transação Parâmetros”, e então a NF-e será
registrada para reextração. Com a reextração, a NF-e será extraída e impressa, de acordo
com o tipo de contingência configurado.

 Botões de seleção múltipla : Permite selecionar ou retirar a seleção de todos os


registros no grid do painel de controle.

 Botão solicitar estorno da nota fiscal selecionada : Permite realizar a solicitação de


Estorno das NF-es selecionadas. Para isso, é necessário que o status da NF-e permita a
solicitação de cancelamento. Isso deve ser configurado através do campo “Cancela?” da
aba “Status e-Docs”, da transação “Parâmetros”. Quando há uma solicitação de
cancelamento, o componente Comply e-Docs Server verificará se existe um protocolo de
autorização, dado que uma NF-e somente pode ser cancelada se já foi autorizada
anteriormente. Se houve protocolo de autorização de uso, a NF-e será cancelada; caso

302
contrário, será inutilizada. Quando houver o retorno do status de cancelamento, será
verificado se a exit ZNFEATLZ está ativa; se estiver, os documentos relacionados a esta
NF-e serão cancelados (faturamento, documento de material ou nota fiscal writer).

 Botão informações da SEFAZ ao contribuinte : Permite visualizar as últimas


mensagens enviadas ao contribuinte. Essa mensagem não é ligada necessariamente a
nenhuma NF-e, mas sim a uma informação que a SEFAZ deseja enviar aos contribuintes.
Exemplo de mensagem enviada: “A SEFAZ SP estará fora do ar neste sábado”.

 Botão eventos : Permite visualizar, inserir e editar eventos. Exibe os dados


relacionados a eventos.
Gerenciar Eventos no ABAP
No componente ABAP é possível visualizar, criar e editar Eventos.

Acessando o Painel de Eventos de NF-e:

Para acessar os eventos de uma determinada NF-e é necessário acessar o Painel de Controle de
NF-e através da transação: /PWS/ZNFEMP000 - Comply e-Docs - Painel de Controle.

 Com a NF-e selecionada é necessário clicar no botão “Exibir Eventos”. Conforme abaixo:

 Em seguida será exibido o "Painel de Eventos":

304
 Na tela acima possuímos os seguintes botões e campos:
o Atualizar: Para atualizar a informação disponível no Painel;
o Novo: Para a criação de um novo Evento de NF-e;
o Editar: Para editar o evento. Somente habilitado caso o status do evento permita
alteração;
o Salvar: Para enviar um novo evento ou uma alteração de evento;
o Na parte superior da tela está disponível o cabeçalho da NF-e que receberá o
evento em questão;
o No meio da tela no grid apresentado é possível verificar todos os eventos
relacionados à NF-e;
o No campo "Detalhes" é possível verificar o tipo de Evento e as informações
relacionadas a aquele evento.

Criando um Novo Evento:


Para criar um novo evento é necessário estar o Painel de Eventos de NF-e e clicar no botão Novo:
Ao clicar no botão “Novo” o grupo Detalhes será liberado. O texto do último evento será copiado
para este novo evento e será possível adicionar informações.
Após isso o usuário deverá clicar no botão “Salvar” e com isso será gerado uma nova pendência de
envio de evento.

Editando um Evento Existente:

Para editar um evento existente, é necessário que o mesmo se encontre com um status de erro.
Selecione o evento e em seguida clique sobre o botão “Editar”:
Após isso o grupo Detalhes será liberado e o usuário poderá corrigir o Evento.
Após isso o usuário deverá clicar no botão “Salvar” e com isso o evento será reenviado.

306
Limpar Tabelas de NF-e - (/PWS/ZNFECTAB)
A transação “Limpar Tabelas de NF-e” permite realizar a exclusão de registros gravados nas
tabelas Zs do componente ABAP do sistema e-Docs. Esta transação deve ser utilizada quando
existir a necessidade de excluir os registros das tabelas Zs do componente ABAP e não houver a
necessidade de manter um histórico, uma vez que os dados serão perdidos. Em todo caso, as
informações serão mantidas nas tabelas standard do SAP de notas fiscais e também no banco de
dados do sistema e-Docs.

É possível definir alguns filtros de seleção que permitem determinar quais NF-es deverão ser
excluídas das tabelas Zs.

Menu: /PWS/ZNFECTAB > Tela de Seleção

 Selecionar todas as notas: Permite selecionar todas as notas fiscais existentes nas
tabelas Zs. Todo conteúdo será excluído.
 Definir parâmetros: Permite selecionar quais notas fiscais devem ser excluídas. Se esta
opção for ativada, os parâmetros abaixo serão levados em consideração no momento de
realizar a seleção de NF-es que deverão ser excluídas.
 Código holding: Permite selecionar o código da holding, com possibilidade de definir um
intervalo ou seleção múltipla.
 Código da matriz: Permite selecionar o código da matriz, com possibilidade de definir um
intervalo ou seleção múltipla.
 Código da filial: Permite selecionar o código da filial, com possibilidade de definir um
intervalo ou seleção múltipla.
 Número do documento: Permite selecionar o docnum da nota fiscal, com possibilidade
de definir um intervalo ou seleção múltipla.
 Data de transmissão: Permite selecionar a data de transmissão da nota fiscal, com
possibilidade de definir um intervalo ou seleção múltipla. É possível a utilização
do matchcode.
 Tipo de nota fiscal: Permite selecionar o tipo de nota fiscal, com possibilidade de definir
um intervalo ou seleção múltipla. Aceita os valores ‘0’ – entrada e ‘1’ – saída.

 Botão “Executar data clean” - (Atalho F8): Executará a seleção determinada e


montará os registros que deverão ser excluídos.

Menu: /PWS/ZNFECTAB > Exibição de Registros a Serem Excluídos

 Grid: No grid, serão exibidas as NF-es que podem ser excluídas, de acordo com o filtro
realizado anteriormente. Para executar a exclusão, é necessário realizar a seleção das

NF-es que se deseja excluir e clicar no botão “Excluir Nota(s) Selecionada(s)” - .

308
 Botões de ordenação - : Permite ordenar de forma crescente ou decrescente os
dados exibidos no Grid.

 Botões de seleção múltipla : Permite selecionar ou retirar a seleção de todos os


registros no Grid.

 Botão excluir nota(s) selecionada(s) : Executa a exclusão dos registros selecionados


no Grid.

 Botões de navegação : Permite navegar através dos dados exibidos no


Grid. Os botões possuem as seguintes funções, respectivamente:
o Retornar ao início do grid;
o Retornar uma página;
o Avançar uma página;
o Ir ao fim do grid.
Job de limpeza Tabelas de NF-e (/PWS/ZNFECTAB2)
Menu: /PWS/ZNFECTAB2 > Job de limpeza de Tabelas de NF-e

A transação “Job de limpeza de Tabelas de NF-e” permite realizar a exclusão de registros


gravados nas tabelas Zs do componente ABAP do sistema e-Docs através de um job que pode ser
executado em segundo plano. Esta transação deve ser utilizada quando existir a necessidade de
excluir os registros das tabelas Zs do componente ABAP, não houver a necessidade de manter um
histórico e for uma quantidade alta de registros. Em todo caso, as informações serão mantidas
nas tabelas standard do SAP de notas fiscais e também no banco de dados do sistema e-Docs.

 Código holding: Permite selecionar o código da holding, com possibilidade de definir um


intervalo ou seleção múltipla;
 Código da matriz: Permite selecionar o código da matriz, com possibilidade de definir um
intervalo ou seleção múltipla;
 Código da filial: Permite selecionar o código da filial, com possibilidade de definir um
intervalo ou seleção múltipla;
 Docnum: Permite selecionar o docnum da nota fiscal, com possibilidade de definir um
intervalo ou seleção múltipla;
 Data de transmissão: Permite selecionar a data de transmissão da nota fiscal, com
possibilidade de definir um intervalo ou seleção múltipla. É possível a utilização
do matchcode;
310
 Direção: Define se o documento é de entrada ou saída;

Após a solicitação de exclusão aparecerá a tela abaixo, para a confirmação da


solicitação:
Componente Comply e-Docs Server
O componente Comply e-Docs Server é o serviço responsável basicamente pela mensageria do
sistema Comply e-Docs. Ele é divido em vários processos que possuem funções específicas e
trabalham de maneira independente.

O Comply e-Docs Server pode ser utilizado tanto no módulo NF-e como NFS-e. Para tanto, apenas
é necessário ativar e configurar os processos responsáveis por cada módulo.

Para o NF-e, a função principal do Comply e-Docs Server é gerenciar o processo de emissão de
NF-e, para tanto, ele executa da interface de extração, processa as informações de NF-e,
enviando e recebendo os resultados da SEFAZ. Além disso, ainda existe a possibilidade de
imprimir o DANFE, enviar o DANFE e o XML de Distribuição por Email, retornar informações ao
sistema de origem, entre outros.
Para o NFS-e, sua função principal além do gerenciamento dos processos de emissões de NFS-e
para as prefeituras, também processar as informações, enviando e recebendo os resultados das
prefeituras. Além disso, possibilita a impressão automática do RPS, impressão da Nota Fiscal de
Serviço, enviar e-mail em PDF, e/ou XML, salvar a Nota Fiscal de Serviço em PDF, e/ou XML, e
integrada ao NF-e, realiza o retorno das informações, possibilitando a visualização dos status das
Notas Fiscais no Painel de Controle do NF-e e SAP.

Tecnicamente, o Comply e-Docs Server trabalha como uma máquina de estado, ou seja, seus
processos são disparados de acordo com o estado dos registros que devem ser manipulados por
ele.

O Comply e-Docs Server é um Windows Service (Serviço do Windows) e pode ser instalado em
mais de um Servidor Windows relacionando-se com o mesmo banco de dados. Esse procedimento
pode ser utilizado para aumento do desempenho do sistema Comply e-Docs.

Inicialização

Inicialização
Para que o Comply e-Docs Server passe a funcionar é necessário iniciar o Serviço do Windows do
Comply e-Docs Server.

Durante a inicialização do serviço, são verificadas informações básicas para o funcionamento do


programa como versionamento, conexão com o banco de dados, arquivos de configuração,
informações e estrutura de tabelas. Para iniciar o Serviço do Comply e-Docs Server é necessário
executar os seguintes passos:

Acessar o Serviço do Comply e-Docs Server através do Gerenciador de Serviços do


Windows e clicar no botão Iniciar:

312
Processos
O Comply e-Docs Server é constituído por uma série de processos. O processo principal,
denominado Gerenciador de Processos, é responsável pelo gerenciamento da execução de todos
os processos do Comply e-Docs Server.

Os processos são executados após a inicialização do serviço. Cada processo tem uma função
específica no sistema e realiza uma tarefa que, em alguns casos, é independente de outros
processos.

Os processos existentes no NF-e são os seguintes:

Código Processo
1 Gerenciador NF-e – Entrada
2 Gerenciador NF-e – Pendencias
3 Gerenciador NF-e – Email
4 Gerenciador NF-e - DANFE em PDF
5 Gerenciador NF-e – XML
6 Gerenciador NF-e - Integração XML
10 Gerenciador NF-e - Pré-validação
20 Gerenciador NF-e – Priorização
25 Gerenciador NF-e - Contingência DPEC
30 Gerenciador NF-e - Envio Lote
35 Gerenciador NF-e - Integração Envio Lote
40 Gerenciador NF-e – Retorno
45 Gerenciador NF-e - Integração Retorno
50 Gerenciador NF-e - Impressão DANFE
60 Gerenciador NF-e - Retorno ao Sistema de Origem
80 Gerenciador NF-e – Cancelamento
85 Gerenciador NF-e - Integração Cancelamento
90 Gerenciador NF-e – Inutilização
99 Gerenciador NF-e – Timeout
100 Gerenciador NF-e - XML e-PIN
110 Gerenciador NF-e - Lote e-PIN
120 Gerenciador NF-e - Consulta Status WebService
130 Gerenciador NF-e - Consulta Cadastro
140 Gerenciador NF-e - Consulta de Retorno de Notas
150 Gerenciador NF-e - Reprocessamento Parse Inbound
160 Gerenciador NF-e – Archive
165 Gerenciador NF-e - Consulta Archive
170 Gerenciador NF-e – Eventos
200 Gerenciador NF-e - Consulta Documentos Destinados
205 Gerenciador NF-e - Download NF-e
215 Gerenciador NF-e - Manifesto Automático
260 Gerenciador NF-e - Retorno Inbound Sist. de Origem

Os processos existentes no NFS-e são os seguintes:

Código Processo
Gerenciador de Entrada/Recepção – Pré-validação
30 Gerenciador de Envio - Lote
40 Gerenciador de Envio - Retorno
80 Gerenciador de Envio – Cancelamento
3 Gerenciador de Envio de E-mail XML
3 Gerenciador de Envio de E-mail PDF
5/50 Gerenciador de Impressão
99 Gerenciador de Timeout

314
NF-e:

Gerenciador NF-e – Entrada:


O processo de entrada é responsável pela execução das interfaces de Entrada do Comply e-Docs
Server. Ele executa a interface Dblink, RFC (SAP) e Inbound.
Em caso de erro, é necessário verificar a tabela NFE_PROCESSO_SERVIDOR_LOG, NFE_NF_LOG e
Event View do Windows onde o Comply e-Docs Server está sendo executado.
As informações das interfaces selecionadas podem ser encontradas na tabela NFE_INTERFACE.
Se o sistema de origem for SAP a função /PWS/ZNFEMF000_RFC_NF será executada no SAP. Já se
o sistema de origem for EDI as tabelas EDIs serão lidas. A principal tabela é a tabela
NFE_NF_CAPA_EDI.

Gerenciador NF-e – Pendencias:


O processo de pendências é responsável por gerenciar processos pendentes para uma NF-e. Ele
agenda, para posterior cancelamento ou inutilização, uma NF-e que está sendo processada no
momento.
Em caso de erro, é necessário verificar a tabela NFE_PROCESSO_SERVIDOR_LOG, NFE_NF_LOG e
Event View do Windows onde o Comply e-Docs Server está sendo executado.
A principal tabela utilizada por este processo é a tabela NFE_NF_PROC_PENDENTE. O
gerenciamento de estado deste processo é realizado através do campo
NFE_NF_PROC_PENDENTE.STATUS_PENDENTE: se estiver como 1 está aguardando processamento,
2 em processamento. Assim que a pendência for concluída, o registro é excluído desta tabela.

Gerenciador NF-e – Email:


O processo de email é responsável pelo envio de emails do Comply e-Docs Server. Ele envia logs e
XMLs aos destinatários da NFe.
Em caso de erro, é necessário verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do
Windows onde o Comply e-Docs Server está sendo executado. Também é possível verificar as
configurações de SMTP na tabela NFE_PARAMETROS que pode ser acessada através do
componente Framework. É possível verificar os destinatários na tabela
NFE_NF_CAPA.ENDERECO_ELETRONICO.
A principal tabela utilizada por este processo é a tabela NFE_NF_FILA_EMAIL. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_FILA_EMAIL.STATUS_EMAIL: se
estiver como 1 está aguardando processamento, 2 em processamento, 3 erro de processamento.
Assim que a email for enviado o registro será excluído desta tabela.
O campo NFE_NF_FILA_EMAIL.TIPO_ENVIO determina qual é o tipo de email que está sendo
enviado: C = XML de Distribuição, E = Logs do Comply e-Docs Server e D = XML de Eventos da NF-
e.
Gerenciador NF-e - DANFE em PDF:
O processo de DANFE em PDF é responsável pelo envio de DANFEs em PDF. Ele envia DANFE em
PDF aos endereços de e-mail configurados na tabela NFE_CONFIG_FILIAL e também ao
destinatário da NF-e.
Em caso de erro, é necessário verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do
Windows onde o Comply e-Docs Server está sendo executado. Também é possível verificar as
configurações de SMTP na tabela NFE_PARAMETROS que pode ser acessada através do
componente Framework, a tabela NFE_CONFIG_FILIAL e o campo
NFE_NF_CAPA.ENDERECO_ELETRONICO para verificar o endereço de e-mail cadastrado.
A principal tabela utilizada por este processo é a tabela NFE_DANFE_PDF. O gerenciamento de
estado deste processo é realizado através do campo NFE_DANFE_PDF.ENVIO_PDF_STATUS: se
estiver como 0 está aguardando processamento, 1 em processamento, 2 erro de processamento e
3 envio com sucesso.

Gerenciador NF-e – XML:


O processo de XML é responsável pela geração do arquivo XML. Ele valida informações, gera o
arquivo XML e o assina.
Em caso de erro, deverá verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do
Windows onde o Comply e-Docs Server está sendo executado. Também é possível verificar se o
certificado digital está instalado e configurado corretamente, é também possível verificar a
tabela NFE_NF_EVENTO ou no histórico de evento do Painel de Controle do componente
Framework ou componente ABAP.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 5 está aguardando processamento, 6 em processamento, 7 erro de processamento.
Assim que o processo for finalizado o status de processamento do registro será modificado para
10. No caso da NF-e estar em contingência o status de processamento em caso de sucesso será o
20, uma vez que NF-es em contingência não são pré-validadas pelo Comply e-Docs Server.
O campo NFE_NF_CAPA.XML armazena as informações do XML assinado da NF-e. O XML da NF-e
armazenado neste campo não possui o grupo protNFe.

Gerenciador NF-e - Integração XML:


O processo de XML NFS-e é responsável pela geração do arquivo XML da NFS-e. Ele valida
informações de NFS-e, gera o arquivo XML de NFS-e e o assina.
Em caso de erro, deverá verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do
Windows onde o Comply e-Docs Server está sendo executado. Também é possível verificar se o
certificado digital está instalado e configurado corretamente, é também possível verificar a
tabela NFE_NF_EVENTO ou no histórico de evento do Painel de Controle do componente
Framework ou componente ABAP.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 405 está aguardando processamento, 406 em processamento, 407 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 430. O campo NFE_NF_CAPA.XML armazena as informações do RPS da NFS-e.
316
Gerenciador NF-e - Pré-validação:
O processo de Pré-validação é responsável pela validação do arquivo XML. Ele valida informações
do arquivo XML da NF-e gerado.
Em caso de erro, deverá verificar a tabela NFE_NF_EVENTO ou no histórico de evento do Painel
de Controle do componente Framework ou ABAP.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 10 está aguardando processamento, 11 em processamento, 12 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 20.
A principal validação que deve estar ativada para o módulo Outbound é: “Valida se a NF-e é
compatível com o XSD”. Dessa forma, caso haja algum erro na estrutura do XML gerado, o
sistema identificará este erro antes do envio à SEFAZ.
Já a principal validação que deve estar ativada para o módulo Inbound é: “Validade se a NF-e
está autorizada”. Essa validação realizará a consulta da Chave de Acesso recebida através do
Inbound na SEFAZ.

Gerenciador NF-e – Priorização:


O processo de Priorização é responsável pela priorização dos lotes de arquivos XMLs gerados. Ele
define a seqüência em que os lotes deverão ser enviados.
Em caso de erro, deverá verificar a tabela NFE_NF_EVENTO ou no histórico de evento do Painel
de Controle do componente Framework ou componente ABAP.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 20 está aguardando processamento, 21 em processamento, 22 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 30. No caso da NF-e estar em contingência o status de processamento em caso
de sucesso será o 50, uma vez que NF-es em contingência podem ser impressas antes do envio à
SEFAZ. Se a NF-e estiver em contingência e o tipo de emissão for DPEC o status de processamento
em caso de sucesso será o 25, uma vez que NF-es em contingência DPEC devem ser autorizadas
pelo WebService DPEC para poderem ser impressas.

Gerenciador NF-e - Contingência DPEC:


Responsável pela administração das NF-es em modo de contingência DPEC, realiza a geração do
arquivo, envio e recebimento do mesmo.

Gerenciador NF-e - Envio Lote:


O processo de Envio de Lote é responsável pelo envio dos lotes de arquivos XMLs gerados. Ele
controla o envio e a recepção da confirmação de entrega dos arquivos enviados a SEFAZ.
Em caso de erro, deverá ser verificada a tabela NFE_NF_EVENTO ou no histórico de eventos do
Painel de Controle do componente Framework ou ainda o do componente ABAP. Também é
possível que sejam gravados logs no Event View do Windows onde o Serviço “Comply e-Docs
Server da NFe” está sendo executado.
É importante dimensionar o tráfego de informações, os períodos do dia nos quais existem maior
emissão de NF-es e o tráfego de rede para que não ocorra gargalos na transmissão de arquivos
XMLs. Também é interessante dada à infra-estrutura disponível ao projeto, utilizar links
dedicados redundantes, inclusive com operadoras diferentes para que em caso de queda do link
de uma operadora o cliente continue a autorizar NF-es.
O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server da NFe”. O parâmetro “cert_cnpj_login” é
utilizado para a busca do Certificado Digital utilizado para a transmissão.
Em caso de falha nesse processo a NFe entrará em processo de contingência técnico, ou seja, o
sistema irá gerar um evento para essa NF-e informando que não foi possível sua transmissão
(evento 096).
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 30 está aguardando processamento, 70 está aguardando processamento em
contingência, 21 em processamento, 71 está em processamento em contingência, 32 erro de
processamento, 72 erro do processamento em contingência e 75 impossibilidade na transmissão
da NF-e por problemas técnicos. Assim que o processo for finalizado o status de processamento
do registro será modificado para 40. No caso da NF-e estar em contingência o status de
processamento em caso de sucesso será o 72.

Gerenciador NF-e - Integração Envio Lote:


O processo de Envio de Lote NFS-e é responsável pelo envio de XMLs de NFS-es gerados. Ele
controla o envio e a recepção da confirmação de entrega dos arquivos enviados ao município.

Em caso de erro, deverá ser verificada a tabela NFE_NF_EVENTO ou no histórico de eventos do


Painel de Controle do componente Framework ou ainda o do componente ABAP. Também é
possível que sejam gravados logs no Event View do Windows onde o Serviço “Comply e-Docs
Server da NFe” está sendo executado.

A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de


estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 430 está aguardando processamento, 431 em processamento e 432 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 440.

Gerenciador NF-e – Retorno:


O processo de Retorno de Lote é responsável pelo retorno dos lotes de arquivos XMLs gerados. Ele
controla a solicitação de retorno de status e a recepção do status dos lotes de XMLs enviados a
SEFAZ.
Em caso de erro, verificar a tabela NFE_NF_EVENTO ou no histórico de evento do Painel de
Controle do componente Framework ou ainda o do componente ABAP. Também é possível que
sejam gravados logs no Event View do Windows onde o Serviço “Comply e-Docs Server da NFe”
está sendo executado.
É importante dimensionar o tráfego de informações, os períodos do dia nos quais existem maior
emissão de NF-es e o tráfego de rede para que não ocorra gargalos na transmissão de arquivos
XMLs. Também seria interessante dada à infra-estrutura disponível ao projeto, utilizar links
318
dedicados redundantes, inclusive com operadoras diferentes para que em caso de queda do link
de uma operadora o cliente continue a autorizar NF-es.
O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server da NF-e”.
Em caso de falha nesse processo a NF-e entrará em processo de contingência técnico, ou seja, o
sistema irá gerar um evento para essa NF-e informando que não foi possível sua transmissão.
É possível que mesmo com o arquivo transmitido, a SEFAZ rejeite a autorização de uso, nesse
caso será necessária uma análise funcional do erro ocorrido (evento 098).
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 40 está aguardando processamento, 72 está aguardando processamento em
contingência, 41 em processamento, 43 está em processamento em contingência, 42 erro de
processamento, 74 erro do processamento em contingência ou impossibilidade na transmissão da
NF-e por problemas técnicos. Assim que o processo for finalizado o status de processamento do
registro será modificado para 50, tanto para NF-es com o tipo de emissão normal quanto para
contingência.

Gerenciador NF-e - Integração Retorno:


O processo de Retorno de Lote NFS-e é responsável pelo retorno do status dos XMLs de NFS-es
enviados. Ele controla a solicitação de retorno de status e a recepção do status do RPS enviados
ao município.
Em caso de erro, verificar a tabela NFE_NF_EVENTO ou no histórico de evento do Painel de
Controle do componente Framework ou ainda o do componente ABAP. Também é possível que
sejam gravados logs no Event View do Windows onde o Serviço “Comply e-Docs Server da NFe”
está sendo executado.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 440 está aguardando processamento, 441 em processamento e 442 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 499.

Gerenciador NF-e - Impressão DANFE:


O processo de Impressão de DANFE é responsável pela impressão do DANFE, FS e FSDA. Ele
controla o envio para a fila de impressão, com a possibilidade de realizar agrupamentos e
selecionar uma fila específica.
Em caso de erro, deverá verificar a tabela NFE_NF_EVENTO ou no histórico de evento do Painel
de Controle do componente Framework ou ainda o do componente ABAP. Também é possível que
sejam gravados logs no Event View do Windows onde o Serviço “Comply e-Docs Server da NFe”
está sendo executado.
É importante dimensionar o tráfego de informações na rede entre o Comply e-Docs Server e o
Servidor de Impressão, e também entre o Servidor de Impressão (Fila de impressão) e a
impressora.
É interessante manter um plano de substituição de impressoras que permita a rápida troca de
equipamentos e também possuir uma impressora como contingência para impressoras que podem
estar fora do ar por algum período de tempo.
Mesmo que a NFe seja autorizada pela SEFAZ, sem a impressão do DANFE ou do Formulário de
Segurança, a mercadoria não pode circular.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 50 está aguardando processamento, 51 em processamento e 52 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 99, para NF-es com o tipo de emissão normal. Para 70 caso o tipo de emissão da
NF-e estiver em contingência e 98 caso a NF-e estiver em contingência e autorizada pela SEFAZ.

Gerenciador NF-e - Retorno ao Sistema de Origem:


O processo de retorno ao sistema de origem é responsável pela execução das interfaces de
Retorno (Saída) do Comply e-Docs Server. Ele executa a interface Dblink e RFC (SAP),
dependendo de como o destino da interface daquele registro está configurada.
Em caso de erro, deverá verificar a tabela NFE_NF_RET_ORIGEM ou no histórico de evento do
Painel de Controle do componente Framework. Também é possível que sejam gravados logs no
Event View do Windows onde o Serviço “Comply e-Docs Server da NFe” está sendo executado.
A principal tabela utilizada por este processo é a tabela NFE_NF_RET_ORIGEM. O gerenciamento
de estado deste processo é realizado através do campo NFE_NF_RET_ORIGEM.FLAG_PROCESSADO:
se estiver como 0 está aguardando processamento e 1 em processamento. Assim que o processo
for finalizado a o campo será modificado para 2.
Se a interface de destino for SAP, a função de retorno (/PWS/ZNFE_RETORNA_SAP) será
executada. Já se a interface de destino for Dblink, a tabela NFE_NF_RET_ORIGEM_EDI será
preenchida com as informações do retorno do Status.

Gerenciador NF-e – Cancelamento:


O processo de Cancelamento é responsável pelo envio e retorno de mensagens de cancelamento
de NF-es. Ele controla o envio e a recepção da confirmação dos XMLs de cancelamentos enviados
a SEFAZ.
Em caso de erro, deverá verificar a tabela NFE_NF_EVENTO ou o histórico de evento do Painel de
Controle do componente Framework ou ainda o do componente ABAP. Também é possível que
sejam gravados logs no Event View do Windows onde o Serviço “Comply e-Docs Server da NF-e”
está sendo executado.
Por conta do processo de cancelamento possuir menor prioridade na transmissão de arquivos, é
possível que em momento de grande processamento de NF-es, os cancelamento possuam maior
demora.
O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server da NF-e”.
Em caso de falha nesse processo, serão gerados logs de erro, porém a NF-e continuará a realizar
tentativas de transmissão de cancelamento.
É possível que mesmo com o arquivo transmitido, a SEFAZ rejeite o cancelamento, nesse caso
será necessária uma análise funcional do erro ocorrido.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
320
estiver como 80 está aguardando processamento, 81 em processamento e 82 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 83, tanto para NF-es com o tipo de emissão normal quanto para contingência.

Gerenciador NF-e - Integração Cancelamento:


O processo de Cancelamento NFS-e é responsável pelo envio e retorno de mensagens de
cancelamento de NFS-es. Ele controla o envio e a recepção da confirmação dos XMLs de
cancelamentos de RPS enviados ao município.
Em caso de erro, deverá verificar a tabela NFE_NF_EVENTO ou o histórico de evento do Painel de
Controle do componente Framework ou ainda o do componente ABAP. Também é possível que
sejam gravados logs no Event View do Windows onde o Serviço “Comply e-Docs Server da NF-e”
está sendo executado.
O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server da NF-e”.
Em caso de falha nesse processo, serão gerados logs de erro, porém a NFS-e continuará a realizar
tentativas de transmissão de cancelamento.
É possível que mesmo com o arquivo transmitido, o município rejeite o cancelamento, nesse caso
será necessária uma análise funcional do erro ocorrido.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 480 está aguardando processamento, 481 em processamento e 482 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 483.

Gerenciador NF-e – Inutilização:


O processo de Inutilização é responsável pelo envio e retorno de inutilizações de NF-es. Ele
controla o envio e a recepção da confirmação dos XMLs de inutilização enviados a SEFAZ.
Em caso de erro, deverá verificar a tabela NFE_NF_EVENTO ou no histórico de evento do Painel
de Controle do componente Framework ou ainda componente ABAP. Também é possível que
sejam gravados logs no Event View do Windows onde o Serviço “Comply e-Docs Server da NFe”
está sendo executado.
Por conta do processo de inutilização possuir menor prioridade na transmissão de arquivos, é
possível que em momento de grande processamento de NF-es, as inutilizações possuam maior
demora.
O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server da NF-e”. Em caso de falha nesse processo,
serão gerados logs de erro, porém a NF-e continuará a realizar tentativas de transmissão.
É possível que mesmo com o arquivo transmitido, a SEFAZ rejeite a inutilização, nesse caso será
necessária uma análise funcional do erro ocorrido.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 90 está aguardando processamento, 91 em processamento e 92 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 93, tanto para NF-es com o tipo de emissão normal quanto para contingência.
Gerenciador NF-e – Timeout:
O processo de Timeout é responsável pelo controle de timeouts do sistema. Ele verifica o tempo
que um determinado processo está demorando a executar uma operação e em caso de estouro,
avisa aos atores parametrizados no sistema, além de retornar o registro para o status de
processamento anterior.
Em caso de erro, deverá verificar a tabela NFE_PROCESSO_SERVIDOR_LOG, NFE_NF_LOG e Event
View do Windows onde o Comply e-Docs Server está sendo executado.
Esse processo é interno e não deve apresentar problemas de processamento por ações do usuário.
A principal tabela utilizada por este processo é a tabela NFE_TABELAS_TIMEOUT. Esta tabela
define que outras tabelas são gerenciadas pelo Processo de Timeout. Assim que um processo
estoura o tempo de timeout, um status é registrado na tabela NFE_EVENTO_TIMEOUT.

Gerenciador NF-e - XML e-PIN:


O processo de XML ePin é responsável pela geração do arquivo XML do ePin Convencional. Ele
valida os dados obrigatórios e gera o arquivo XML do ePin Convencional.
Em caso de erro, deverá verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do
Windows onde o Comply e-Docs Server está sendo executado.
Importante: Os principais erros encontrados no momento da geração do XML ePin é por falta de
dados obrigatórios nas tabelas de NF-es. O principal deles que costuma apresentar erros é o
campo inscrição Suframa (NFE_NF_CAPA.INSC_SUFRAMA).
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 300 está aguardando processamento, 301 em processamento, 302 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 310.

Gerenciador NF-e - Lote e-PIN:


O processo de Lote ePin é responsável pelo agrupamento e geração do arquivo TXT do ePin. Ele
agrupa os XMLs ePin gerados e os grava em um arquivo TXT a ser salvo em um diretório
configurado.
Em caso de erro, deverá verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do
Windows onde o Comply e-Docs Server está sendo executado.
Importante: Os principais erros encontrados no momento da geração do Lote ePin é por erro na
parametrização da pasta onde os arquivos TXT devem ser gravados. Para tal, é necessário
verificar a tabela NFE_PARAMETROS com o VALOR igual a “epin_path”.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 310 está aguardando processamento, 311 em processamento, 312 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 399.

322
Se a NF-e for um ePin eletrônico, ou seja, que a Nota Fiscal é relacionada a SUFRAMA é
representa uma NF-e, então o seu XML será gerado por este processo.

Gerenciador NF-e - Consulta Status WebService:


O processo de Consulta Status WebService é responsável pela verificação do status dos
WebServices junto a SEFAZ.
O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server da NFe” está instalado.
Em caso de falha nesse processo somente será gerado um log de aviso sobre a funcionalidade
desse processo. A tabela NFE_PROCESSO_SERVIDOR_LOG pode ser verificada e o Event View do
Windows no qual o Comply e-Docs Server está instalado.
A principal tabela utilizada por este processo é a tabela NFE_WEB_SERVICE_STATUS. A cada
execução deste processo é executada a consulta a todos os WebServices cadastrados e que estão
vinculados a uma UF ou Filial. Recomendamos configurar este processo para rodar a cada 5
minutos, dada a orientação do próprio ENCAT. Isso deve ser configurado no cadastro de
processos.

Gerenciador NF-e - Consulta Cadastro:


O processo de Consulta Cadastro é responsável pela verificação do status do parceiro cadastrado
junto ao cadastro de contribuintes de ICMS.
O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server da NF-e” está instalado.
Em caso de falha nesse processo somente será gerado um log de aviso sobre a funcionalidade
desse processo. A tabela NFE_PROCESSO_SERVIDOR_LOG pode ser verificada e o Event View do
Windows no qual o Comply e-Docs Server está instalado.
A principal tabela utilizada por este processo é a tabela NFE_PARCEIRO. O gerenciamento de
estado deste processo é realizado através dos campos NFE_PARCEIRO.STATUS_CONSULTA,
NFE_PARCEIRO.DT_PROX_ATUALIZACAO e NFE_PARCEIRO.INTERVALO. Se o campo
STATUS_CONSULTA estiver como “0” significa que o Parceiro está esperando processamento, se
estiver “1” é em processamento. Assim que a consulta é finalizada o valor volta a ser “0”. Uma
consulta só ocorrerá caso o campo STATUS_CONSULTA for “0” e o campo DT_PROX_ATUALIZACAO
for maior que o campo INTERVALO. Recomendamos agendar uma consulta semanal, dessa forma o
campo INTERVALO deve ser gravado como 7. Esse cadastro pode ser realizado através do
componente Framework na transação “Painel de Controle > Parceiro”.

Gerenciador NF-e - Consulta de Retorno de Notas:


Processo desabilitado.

Gerenciador NF-e - Reprocessamento Parse Inbound:


O processo de reprocessamento de Parse Inbound é responsável pela reexecução do Parse
Inbound, ou seja, realizar novamente o desmembramento das informações do XML da NF-e em
dados nas tabelas NFE_NFs.
Em caso de erro, deverá verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do
Windows onde o Comply e-Docs Server está sendo executado.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 200 está aguardando processamento, 201 em processamento, 202 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 210.

Gerenciador NF-e – Archive:


O processo de Archive é responsável pelo arquivamento das informações de NF-e em uma segunda
base de dados. Basicamente esse processo seleciona as informações do banco de dados e as envia
a um Serviço Web de Arquivamento pré-configurada.
Em caso de erro, deverá verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do
Windows onde o Comply e-Docs Server está sendo executado.
A principal tabela utilizada por este processo é a tabela NFE_NF_ARQUIVAMENTO. O
gerenciamento de estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS: se
estiver como 0 está aguardando processamento, 1 em processamento, 2 erro de processamento.
Assim que o processo for finalizado o status do registro será modificado para 3.

Gerenciador NF-e - Consulta Archive:


O processo de Consulta Archive é responsável pela confirmação do arquivamento da informação
no banco de dados de arquivamento. Este processo consome um Serviço Web de consulta de
arquivamento que retorna uma confirmação de arquivamento de uma NF-e.
Em caso de erro, é necessário verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do
Windows onde o Comply e-Docs Server está sendo executado.
A principal tabela utilizada por este processo é a tabela NFE_NF_ARQUIVAMENTO. O
gerenciamento de estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS: se
estiver como 3 está aguardando processamento, 4 em processamento, 5 erro de processamento.
Assim que o processo for finalizado a informação da NF-e é retirada desta tabela.

Gerenciador NF-e – Eventos:


O processo de Eventos é responsável pelo processamento dos Eventos de NF-e. Este processo
busca Eventos pendentes de autorização, os transmite à SEFAZ e recebe o protocolo do Evento. O
primeiro evento que este processo suporta é a Carta de Correção Eletrônica (CC-e).
Em caso de erro, deverá verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do
Windows onde o Comply e-Docs Server está sendo executado.
A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA_EVENTO. O gerenciamento
de estado deste processo é realizado através do campo
NFE_NF_CAPA_EVENTO.STATUS_PROCESSAMENTO: se estiver como 500 está aguardando
processamento, 501 em processamento, 502 erro de processamento. Assim que o processo for
finalizado o status do registro será modificado para 503.

324
Gerenciador NF-e - Consulta Documentos Destinados:
O processo de Eventos é responsável pelo processamento dos Eventos de NF-e. Este processo
busca Eventos pendentes de autorização, os transmite à SEFAZ e recebe o protocolo do Evento. O
primeiro evento que este processo suporta é a Carta de Correção Eletrônica (CC-e).

Gerenciador NF-e - Download NF-e:


O processo de Eventos é responsável pelo processamento dos Eventos de NF-e. Este processo
busca Eventos pendentes de autorização, os transmite à SEFAZ e recebe o protocolo do Evento. O
primeiro evento que este processo suporta é a Carta de Correção Eletrônica (CC-e).

Gerenciador NF-e - Manifesto Automático:


O processo de Eventos é responsável pelo processamento dos Eventos de NF-e. Este processo
busca Eventos pendentes de autorização, os transmite à SEFAZ e recebe o protocolo do Evento. O
primeiro evento que este processo suporta é a Carta de Correção Eletrônica (CC-e).

Gerenciador NF-e - Retorno Inbound Sist. de Origem:


O processo de Eventos é responsável pelo processamento dos Eventos de NF-e. Este processo
busca Eventos pendentes de autorização, os transmite à SEFAZ e recebe o protocolo do Evento. O
primeiro evento que este processo suporta é a Carta de Correção Eletrônica (CC-e).

NFS-e:
Gerenciador de Entrada/Recepção - Pré-validação:

O Processo de entrada não executa interfaces de entrada. O processo expõe um WebService para
servir de interface com o sistema de origem.

Em caso de erro, é necessário verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do


Windows onde o Comply e-Docs Server está sendo executado.

O processo de Entrada realiza a Pré-validação que é responsável pela validação do arquivo XML.
Ele valida informações do arquivo XM, requisições e dos RPS’s gerados.

Em caso de erro, os dados do XML não entrarão na base de dados do NFS, deverá ser verificado no
histórico de evento do Painel de Controle – Nota Fiscal do componente Framework ou ABAP.

A principal validação é: Valida se o RPS é compatível com o modelo padrão definido pelo XSD.
Dessa forma, caso haja algum erro na estrutura do XML gerado, o sistema identificará este erro
antes do envio a tabela NFS_NF_CAPA.
Gerenciador de Envio - Lote NFS-e:
O processo de Envio de Lote NFS-e é responsável pelo envio de XMLs de NFS-es gerados. Ele
controla o envio e a recepção da confirmação de entrega dos arquivos enviados ao município.

Em caso de erro, deverá ser verificada a tabela NFE_NF_EVENTO ou no histórico de eventos do


Painel de Controle do componente Framework ou ainda o do componente ABAP. Também é
possível que sejam gravados logs no Event View do Windows onde o Serviço “Comply e-Docs
Server da NFe” está sendo executado.

A principal tabela utilizada por este processo é a tabela NFE_NF_CAPA. O gerenciamento de


estado deste processo é realizado através do campo NFE_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 430 está aguardando processamento, 431 em processamento e 432 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 440.

Gerenciador de Envio - Lote:

O processo de Envio de Lote é responsável pelo envio dos lotes de arquivos XMLs gerados. Ele
controla o envio e a recepção da confirmação de entrega dos arquivos enviados as prefeituras.

Em caso de erro, deverá ser verificada a tabela NFS_NF_EVENTO ou no histórico de eventos do


Painel de Controle – Nota Fiscal de Serviço do componente Framework ou ainda o do componente
ABAP. Também é possível que sejam gravados logs no Event View do Windows onde o Serviço
“Comply e-Docs Server – Módulo NFS-e” está sendo executado.

É importante dimensionar o tráfego de informações, os períodos do dia nos quais existem maior
emissão de NFS-es e o tráfego de rede para que não ocorra gargalos na transmissão de arquivos
XMLs. Também é interessante dada à infra-estrutura disponível ao projeto, utilizar links
dedicados redundantes, inclusive com operadoras diferentes para que em caso de queda do link
de uma operadora o cliente continue a autorizar NFS-es.

O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server – Módulo NFS-e”.

A principal tabela utilizada por este processo é a tabela NFS_NF_CAPA. O gerenciamento de


estado deste processo é realizado através do campo NFS_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 30 está aguardando processamento, 31 em processamento, 32 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 40.

326
Gerenciador de Envio - Retorno:

O processo de Retorno de Lote é responsável pelo retorno dos lotes de arquivos XMLs gerados. Ele
controla a solicitação de retorno de status e a recepção do status dos lotes de XMLs enviados as
prefeituras.

Em caso de erro, verificar a tabela NFS_NF_EVENTO ou no histórico de evento do Painel de


Controle – Nota Fiscal de Serviço do componente Framework ou ainda o do componente ABAP.
Também é possível que sejam gravados logs no Event View do Windows onde o Serviço “Comply
e-Docs Server – Módulo NFS-e” está sendo executado.

O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server – Módulo NFS-e”.
Em caso de falha nesse processo o sistema irá gerar um evento para essa NFS-e informando que
não foi possível sua transmissão.

É possível que mesmo com o arquivo transmitido, a prefeitura rejeite a autorização de uso, nesse
caso será necessária uma análise funcional do erro ocorrido.

A principal tabela utilizada por este processo é a tabela NFS_NF_CAPA. O gerenciamento de


estado deste processo é realizado através do campo NFS_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 40 está aguardando processamento, 41 em processamento, 42 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 50.

Gerenciador de Envio - Cancelamento:

O processo de Cancelamento é responsável pelo envio e retorno de mensagens de cancelamento


de NFS-es. Ele controla o envio e a recepção da confirmação dos XMLs de cancelamentos enviados
as prefeituras.

Em caso de erro, deverá verificar a tabela NFS_NF_EVENTO ou o histórico de evento do Painel de


Controle – Nota Fiscal de Serviço do componente Framework ou ainda o do componente ABAP.
Também é possível que sejam gravados logs no Event View do Windows onde o Serviço “Comply
e-Docs Server – Módulo NFS-e” está sendo executado.

O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server – Módulo NFS-e”.

É possível que mesmo com o arquivo transmitido, a prefeitura rejeite o cancelamento, nesse caso
será necessária uma análise funcional do erro ocorrido.
A principal tabela utilizada por este processo é a tabela NFS_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFS_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 80 está aguardando processamento, 81 em processamento e 82 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 83.

Gerenciador de E-mail XML:

O processo de email em XML é responsável pelo envio de emails do Comply e-Docs Server. Ele
envia XMLs aos destinatários da NFS. Ele envia os XMLs aos endereços de e-mail configurados na
tabela NFS_CONFIG_FILIAL, caso esteja parametrizado para envio.

Em caso de erro, é necessário verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do


Windows onde o Comply e-Docs Server está sendo executado. Também é possível verificar as
configurações de SMTP na tabela NFE_PARAMETROS que pode ser acessada através do
componente Framework. É possível verificar os destinatários na tabela
NFS_NF_CAPA.NNC_ENDERECO_ELETRONICO, caso tenha sido parametrizado.

A principal tabela utilizada por este processo é a tabela NFS_NF_FILA_EMAIL. O gerenciamento de


estado deste processo é realizado através do campo NFS_NF_FILA_EMAIL.NFS_STATUS_EMAIL: se
estiver como 1 está aguardando processamento, 2 em processamento, 3 erro de processamento.
Assim que a email for enviado o registro será excluído desta tabela.

O campo NFS_NF_FILA_EMAIL.NFE_TIPO_ENVIO determina qual é o tipo de email que está sendo


enviado: C = XML de Cliente.

Gerenciador de E-mail PDF:

O processo de e-mail em PDF é responsável pelo envio de e-mails em PDF. Ele envia os PDFs aos
endereços de e-mail configurados na tabela NFS_CONFIG_FILIAL, caso esteja parametrizado para
envio.

Em caso de erro, é necessário verificar a tabela NFE_PROCESSO_SERVIDOR_LOG e Event View do


Windows onde o Comply e-Docs Server está sendo executado. Também é possível verificar as
configurações de SMTP na tabela NFE_PARAMETROS que pode ser acessada através do
componente Framework, e também pode verificar o endereço de e-mail cadastrado na
NFS_NF_CAPA.NNC_ENDERECO_ELETRONICO, caso tenha sido parametrizado.

A principal tabela utilizada por este processo é a tabela NFS_NF_EMAIL_PDF. O gerenciamento de


estado deste processo é realizado através do campo NFS_NF_EMAIL_PDF.NEP_PDF_STATUS: se
estiver como 0 está aguardando processamento, 1 em processamento, 2 erro de processamento e
3 envio com sucesso.
328
Gerenciador de Impressão:

O processo de Impressão é responsável pela impressão das NFS (Nota Fiscal de Serviço) e RPS
(Recibo Provisório de Serviços). Ele controla o envio para a fila de impressão.

Em caso de erro, deverá verificar a tabela NFS_NF_EVENTO ou no histórico de evento do Painel


de Controle – Nota Fiscal de Serviço do componente Framework. Também é possível que sejam
gravados logs no Event View do Windows onde o Serviço “Comply e-Docs Server – Módulo NFS-e”
está sendo executado.

É importante dimensionar o tráfego de informações na rede entre o Comply e-Docs Server e o


Servidor de Impressão, e também entre o Servidor de Impressão (Fila de impressão) e a
impressora.

É interessante manter um plano de substituição de impressoras que permita a rápida troca de


equipamentos e também possuir uma impressora como contingência para impressoras que podem
estar fora do ar por algum período de tempo.

A principal tabela utilizada para o processo do RPS é a tabela NFS_NF_CAPA. O gerenciamento de


estado deste processo é realizado através do campo
NFS_NF_CAPA.NNC_STATUS_PROCESSAMENTO: se estiver como 5 está aguardando processamento,
6 em processamento e 7 erro de processamento. Assim que o processo for finalizado o status de
processamento do registro será modificado para 30.

A principal tabela utilizada para o processo da NFS-e é a tabela NFS_NF_CAPA. O gerenciamento


de estado deste processo é realizado através do campo
NFS_NF_CAPA.NNC_STATUS_PROCESSAMENTO: se estiver como 50 está aguardando
processamento, 51 em processamento e 52 erro de processamento. Assim que o processo for
finalizado o status de processamento do registro será modificado para 99.

Gerenciador de Timeout:

O processo de Timeout é responsável pelo controle de timeouts do sistema. Verifica o tempo que
a nota esta em processamento e em caso de ultrapassar o tempo limite retorna para o status de
processamento anterior para reprocessamento. Não avisa os atores parametrizados no sistema.

Em caso de erro, é necessário verificar a tabela NFE_PROCESSO_SERVIDOR_LOG, NFE_NF_LOG e


Event View do Windows onde o Comply e-Docs Server está sendo executado.
Esse processo é interno e não deve apresentar problemas de processamento por ações do usuário.

330
Interface EDI
EDI
Procedimentos de Contingência
Contingência
O sistema Comply e-Docs entende contingência como a impossibilidade de autorização de NF-es
em processo normal. A falha no processo pode ser ocasionada por problemas de infra-estrutura do
cliente ou da SEFAZ, cenários que apresentam inconsistências etc.

Caso a emissão normal não esteja disponível, o cliente deve optar pelos outros tipos de emissão
disponibilizados pela SEFAZ. São eles:

 Contingência FS (Formulário de Segurança);


 Contingência SCAN (Sistema de Contingência do Ambiente Nacional);
 Contingência DPEC (Contingência Eletrônica com o uso da Declaração Prévia de Emissão
em Contingência);
 Contingência FSDA (Formulário de Segurança para impressão de Documento Auxiliar de
Documento Fiscal Eletrônico.

De acordo com o Manual de Contingência versão 1.01: “Em um cenário inconsistente que
impossibilita emissão da NF-e na modalidade normal, o emissor deverá escolher a emissão de
contingência que lhe for mais conveniente ou, se preferir, aguardar a normalização da situação
para emitir o referido documento normalmente, caso a emissão da NF-e não seja premente”.

332
Modalidades de Emissão

Modalidades de Emissão
O tipo de emissão é o que determina como será o processamento para a autorização de uso da
NF-e, se utilizará e qual o formato de contingência. O que define o tipo de emissão no XML da NF-
e é a tag tpEmis. Abaixo serão detalhadas as modalidades de emissão disponíveis até o momento.

Tipos:

>> Contingência Normal


>> Contingência FS
>> Contingência Scan
>> Contingência DPEC
>> Contingência FSDA
Contingência Normal
De acordo com o Manual de Contingência versão 1.01:

“Tipo de Emissão que compreende o processo normal de autorização de NF-es. O processo de


emissão normal é a situação desejada e mais adequada para o emissor, pois é a situação em que
todos os recursos necessários para a emissão da NF-e estão operacionais e a autorização de uso
da NF-e é concedida normalmente pela SEFAZ”.

“Nesta situação a emissão das NF-es é realizada normalmente com a impressão do DANFE em
papel comum, após o recebimento da autorização de uso da NF-e”.

O fluxo genérico utilizado pelo sistema Comply e-Docs para o tipo de emissão normal é o
seguinte:

 Interface de Entrada com o Sistema de Origem;


 Processamento da Nota Fiscal;
 Autorização de Uso;
 Impressão do DANFE;
 Interface de Retorno com o Sistema de Origem.

334
Contingência FS
De acordo com o Manual de Contingência versão 1.01:

“A contingência com o uso do formulário de segurança é o processo mais simples de


implementar, sendo o processo de contingência que tem a menor dependência de recursos de
infra-estrutura, hardware e software para ser utilizado”.

“Sendo identificada a existência de qualquer incidente que prejudique ou impossibilite a


transmissão das NF-es e/ou obtenção da autorização de uso da SEFAZ, a empresa pode adotar a
Contingência com formulário de segurança”.

O fluxo genérico utilizado pelo sistema Comply e-Docs para o tipo de emissão contingência FS é o
seguinte:

 Interface de Entrada com o Sistema de Origem;


 Verificação da Indisponibilidade do WebService;
 Processamento da Nota Fiscal;
 Impressão do FS;
 Autorização de Uso;
 Interface de Retorno com o Sistema de Origem.
Contingência Scan
De acordo com o Manual de Contingência versão 1.01:

“A recepção das NF-es pelo SCAN é ativado pela UF interessada e uma vez acionada passa a
recepcionar as NF-es de série 900 a 999 dos emissores credenciados para emitir NF-e na UF.
Eventualmente um emissor credenciado recentemente pode não estar autorizado a emitir NF-e
no SCAN caso o Cadastro Nacional de Emissores não tenha sido atualizado pela UF interessada”.

“Ocorrendo à indisponibilidade, a SEFAZ origem acionará o SCAN para que ative o serviço de
recepção e autorização de NF-e em seu lugar. Finda a indisponibilidade, a SEFAZ origem acionará
novamente o SCAN, agora para desativar o serviço. A desativação do serviço de recepção e
autorização de NF-e pelo SCAN será precedida por um período de 15 minutos, em que ambos os
ambientes estarão simultaneamente disponíveis, de forma a minimizar o impacto da mudança
para o Contribuinte”.

O fluxo genérico utilizado pelo sistema Comply e-Docs para o tipo de emissão contingência SCAN
é o seguinte:

 Interface de Entrada com o Sistema de Origem;


 Verificação da Indisponibilidade do WebService;
 Verificação da disponibilidade do WebService SCAN;
 Processamento da Nota Fiscal;
 Autorização de Uso;
 Impressão do DANFE;
 Interface de Retorno com o Sistema de Origem.

336
Contingência DPEC
De acordo com o Manual de Contingência versão 1.01:

“O modelo de Contingência Eletrônica foi idealizado como alternativa que permita a dispensa do
uso do formulário de segurança para impressão do DANFE e a não alteração da série e numeração
da NF-e emitida em contingência”.

“Esta modalidade de contingência é baseada no conceito de Declaração Prévia de Emissão em


Contingência – DPEC, que contem as principais informações da NF-e que serão emitidas em
contingência, que será prestada pelo emissor para SEFAZ”.

O fluxo genérico utilizado pelo sistema Comply e-Docs para o tipo de emissão contingência DPEC
é o seguinte:

 Interface de Entrada com o Sistema de Origem;


 Verificação da Indisponibilidade do WebService;
 Processamento do DPEC;
 Autorização do DPEC;
 Impressão DANFE;
 Processamento da Nota Fiscal;
 Autorização de Uso;
 Interface de Retorno com o Sistema de Origem.
Contingência FSDA
De acordo com o Manual de Contingência versão 1.01:

“Este procedimento de contingência será adotado pelos emissores que adquirirem o Formulário
de Segurança para impressão de Documento Auxiliar de Documento Fiscal – FSDA, e substitui a
contingência com o uso do formulário de segurança”.

“Sendo identificada a existência de qualquer fator que prejudique ou impossibilite a transmissão


das NF-es e/ou obtenção da autorização de uso da SEFAZ, a empresa pode acionar a
Contingência com FS-DA”.

O fluxo genérico utilizado pelo sistema Comply e-Docs para o tipo de emissão contingência FSDA é
o seguinte:

 Interface de Entrada com o Sistema de Origem;


 Verificação da Indisponibilidade do WebService;
 Processamento da Nota Fiscal;
 Impressão do FSDA;
 Autorização de Uso;
 Interface de Retorno com o Sistema de Origem.

338
Modelo Operacional

Modelo Operacional de Contingência


O Modelo Operacional de contingência utilizado pelo sistema Comply e-Docs atende os tipos de
emissão disponibilizados pela SEFAZ até o momento. A determinação do tipo de emissão é
realizada pelo sistema de origem ou pelo gerenciador de entrada.

O sistema de origem possui maior prioridade na determinação de contingência, logo, o tipo de


emissão de contingência escolhido pelo sistema de origem será mantido pelo processo de
entrada. Dessa forma, se o sistema de origem informar que a NF-e deve ser emitida em um
formato de contingência, mesmo que o WebService esteja ativo para aquele estado, seu tipo de
emissão será mantido.

Caso o sistema de origem não envie a NF-e com um tipo de emissão de contingência determinado,
o processo de entrada se encarregará de realizar a verificação da disponibilidade do WebService.

Se o processo de entrada identificar que o WebService não está ativo, status esse analisado pelo
processo de consulta de status de WebService anteriormente, o sistema irá adotar um dos fluxos
de contingência de acordo com a configuração do sistema Comply e-Docs.

Existem dois fluxos de contingência que podem ser seguidos: com ou sem determinação de
contingência automática. O que define isso é um parâmetro de sistema que deve ser configurado
por código de interface.

Durante o processo de entrada se a interface estiver definida como “sem determinação de


contingência automática”, apenas será gerada uma mensagem informando ao sistema de origem
que não é possível realizar a transmissão em processo normal.

Essa mensagem pode variar de acordo com os parâmetros de sistema. Já se a interface estiver
definida como “determinação de contingência automática” o sistema converterá
automaticamente para o formato de contingência definido através dos parâmetros de sistema e
realizará o processamento dessa NF-e.

A seguir serão detalhados todos os tipos de emissão possíveis para o sistema Comply e-Docs e os
fluxos de informação trocados entre o sistema de origem, o Comply e-Docs e a SEFAZ.
Modelo Normal
Para que a NF-e seja processada e transmitida com o tipo de Emissão Normal, é necessário que o
sistema de origem não envie o campo “Tipo de Emissão” preenchido e que o status do
WebService para a UF da filial de emissão da NF-e esteja ativo. Esse modelo deve ser adotado
quando não houver falhas de comunicação.

Pré-Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = null;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = null;
 Status WebService: NFE_WEB_SERVICE_STATUS.COD_STATUS = 107 (Evento da SEFAZ -
Serviço em Operação).

Dados Técnicos:

 Tabela Comply e-Docs: NFE_NF_CAPA.TIPO_EMISSAO = ‘N’;


 Tag XML: <tpEmis>1</tpEmis>.

Parâmetros de Sistema:

 NFE_INTERFACE.CONTINGENCIA = Não aplicável;


 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = Não aplicável;
 utiliza_dpec = Não aplicável;
 utiliza_fs = Não aplicável;
 utiliza_fsda = Não aplicável.

Fluxo Técnico:

 NF-e é gerada no sistema de origem;


 Interface de Entrada com o sistema de Origem;
340
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão não estiver definido no sistema de origem, será verificado o status
do WebService (NFE_WEB_SERVICE_STATUS) e se estiver em operação a NF-e será inserida
em processo normal;
 A NF-e será inserida com tipo de emissão igual à normal (NFE_NF_CAPA-TIPO_EMISSAO =
'N', tag tpEmis = '1');
 O XML será gerado;
 A validação do XML será executada de acordo com parametrização do sistema;
 A priorização será executada de acordo com parametrização do sistema;
 Serão gerados o lote de XML, a transmissão e a recepção do evento 103 (Lote Recebido
com Sucesso);
 O processo de consulta de lote irá verificar o status do lote e receberá o evento 100
(Autorizado o Uso da NF-e);
 O processo de impressão irá verificar se o DANFE é impresso no sistema de origem. Caso a
impressão seja executada no componente Comply e-Docs Server o DANFE será impresso,
além disso, será retornado ao sistema de origem o evento 100;

Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
está ativa. Caso não estiver, somente irá atualizar a tabela /PWS/ZNFETB000 com o status
da NF-e, caso estiver irá imprimir o DANFE, gravar o indicador de impressão = 'S'
(/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela /PWS/ZNFETB0000-
COD_STATU = 100. Visualmente este registro estará na aba de Envio / Recebimento do
Painel de Controle, com farol verde e evento 100.
342
Modelo Normal - Timeout de Envio de Lote
Existem momentos de instabilidade de Infra-estrutura que apesar do WebService estar ativo na
consulta de status, ocorre lentidão no envio do lote, gerando assim incertezas quanto ao
recebimento do lote pela SEFAZ. Isso ocorre por problemas de infra-estrutura como: lentidão de
link, instabilidade no processamento da recepção do lote pelo WebService da SEFAZ, etc.

Como não existe uma confirmação de recebimento (evento 103), mas há possibilidade da SEFAZ
ter recebido esta NF-e, não é recomendado que esta seja impressa em nenhum formato de
contingência, restando apenas a opção do reprocessamento ou cancelamento para geração de
uma nova NF-e.

Pré-Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = null;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = null;
 Status WebService: NFE_WEB_SERVICE_STATUS.COD_STATUS = 107 (Evento da SEFAZ -
Serviço em Operação).

Dados Técnicos:

 Tabela Comply e-Docs: Não aplicável;


 Tag XML: Não aplicável.

Parâmetros de Sistema:

 NFE_INTERFACE.CONTINGENCIA = Não aplicável;


 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = Não aplicável;
 utiliza_dpec = Não aplicável;
 utiliza_fs = Não aplicável;
 utiliza_fsda = Não aplicável.
 NFE_PRIORIDADE.INTERVALO: Tempo máximo em segundos de processamento da NF-e
após a priorização;
 NFE_UF_WEB_SERVICE.NRO_TENTATIVAS ou NFE_FILIAL_WEB_SERVICE.NRO_TENTATIVAS:
Número máximo de tentativas de Transmissão de um Lote a SEFAZ.
Fluxo Técnico:

 NF-e é gerada no sistema de origem;


 Interface de Entrada com o sistema de Origem;
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão não estiver definido no sistema de origem, será verificado o status
do WebService (NFE_WEB_SERVICE_STATUS) e se estiver em operação a NF-e será inserida
em processo normal;
 A NF-e será inserida com tipo de emissão igual a normal (NFE_NF_CAPA-TIPO_EMISSAO =
'N', tag tpEmis = '1');
 O XML será gerado;
 A validação do XML será executada de acordo com parametrização do sistema;
 A priorização será executada de acordo com parametrização do sistema;
 O lote XML será gerado e executadas algumas tentativas de envio de Lote até que o
número máximo de tentativas parametrizadas seja alcançado ou o tempo máximo de
processamento da NF-e. Caso alguma destas condições ocorra, a NF-e será registrada com
um status de processamento estático (75), ou seja, seu processamento será impedido.
Além disso, será registrado para retornar o evento 096 (Erro na Transmissão.
Impossibilidade de Transmissão da NF-e) ao sistema de origem;

Somente para SAP: Quando o SAP receber o evento 096, irá atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 096. Visualmente este registro estará na aba Erro do
Painel de Controle, com farol vermelho e evento 096. O usuário deverá realizar o
reprocessamento ou cancelamento para geração de uma nova NF-e.

344
Modelo Normal - Timeout de Retorno de Lote
Existem momentos de instabilidade de Infra-estrutura que apesar do WebService estar ativo na
consulta de status, ocorre lentidão no retorno do lote, gerando assim a certeza do recebimento
deste pela SEFAZ, porém a impossibilidade de consulta do seu Status. Isso ocorre por problemas
de infra-estrutura como: lentidão de link, instabilidade no processamento do lote pelo
WebService da SEFAZ, demora no processamento do pedido com vários retornos de Lote em
Processamento (evento 105) etc. Como existe a confirmação de recebimento (evento 103), mas
não há o retorno da SEFAZ, é possível que esta NF-e esteja autorizada, logo não é recomendado
que esta seja impressa em nenhum formato de contingência, restando apenas a opção do
reprocessamento ou cancelamento para geração de uma nova NF-e.

Pré-Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = null;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = null;
 Status WebService: NFE_WEB_SERVICE_STATUS.COD_STATUS = 107 (Evento da SEFAZ -
Serviço em Operação).

Dados Técnicos:

 Tabela Comply e-Docs: Não aplicável;


 Tag XML: Não aplicável.

Parâmetros de Sistema:

 NFE_INTERFACE.CONTINGENCIA = Não aplicável;


 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = Não aplicável;
 utiliza_dpec = Não aplicável;
 utiliza_fs = Não aplicável;
 utiliza_fsda = Não aplicável.
 NFE_PRIORIDADE.INTERVALO: Tempo máximo em segundos de processamento da NF-e
após a priorização;
 NFE_UF_WEB_SERVICE.NRO_TENTATIVAS ou NFE_FILIAL_WEB_SERVICE.NRO_TENTATIVAS:
Número máximo de tentativas de Transmissão de um Lote a SEFAZ.

346
Fluxo Técnico:

 NF-e é gerada no sistema de origem;


 Interface de Entrada com o sistema de Origem;
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão não estiver definido no sistema de origem, será verificado o status
do WebService (NFE_WEB_SERVICE_STATUS) e se estiver em operação a NF-e será inserida
em processo normal;
 A NF-e será inserida com tipo de emissão igual a normal (NFE_NF_CAPA-TIPO_EMISSAO =
'N', tag tpEmis = '1');
 O XML será gerado;
 A validação do XML será executada de acordo com parametrização do sistema;
 A priorização será executada de acordo com parametrização do sistema;
 Serão gerados o lote de XML, a transmissão e a recepção do evento 103 (Lote Recebido
com Sucesso);
 O processo de consulta de lote irá verificar o status deste e serão executadas algumas
tentativas de consulta do referido status até que o número máximo de tentativas
parametrizado seja alcançado ou o tempo máximo de processamento da NF-e. Caso
alguma destas condições ocorra, a NF-e será registrada com um status de processamento
estático (42), ou seja, seu processamento será impedido. Além disso, será registrado para
retornar o evento 098 (Tempo para contingência ultrapassado sem resposta da SEFAZ) ao
sistema de origem;

Somente para SAP: Quando o SAP receber o evento 098, irá atualizá-lo na tabela
/PWS/ZNFETB0000-COD_STATU = 098. Visualmente este registro estará na aba Erro do
Painel de Controle, com farol vermelho e evento 098. O usuário deverá realizar o
reprocessamento ou cancelamento para geração de uma nova NF-e.
Contingência Manual - Não definida no Sistema de
Origem
Para que a NF-e seja processada com o tipo de emissão Contingência Manual Não Definida no
Sistema de Origem, é necessário que o sistema de origem não envie o campo “Tipo de Emissão”
preenchido e que a configuração de interface aponte para contingência manual. Esse modelo
deve ser adotado quando se deseja que o sistema de origem seja informado do problema de
comunicação e que posteriormente o mesmo defina qual o tipo de emissão que será utilizado.

Pré- Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = null;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = null;
 Status WebService: NFE_WEB_SERVICE_STATUS.COD_STATUS <> 107 (Serviço fora de
Operação).

Dados Técnicos:

 Tabela Comply e-Docs: Não aplicável;


 Tag XML: Não aplicável.

Parâmetros de Sistema:

348
 NFE_INTERFACE.CONTINGENCIA = ‘N’;
 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = Não aplicável;
 utiliza_dpec = Não aplicável;
 utiliza_fs = Não aplicável;
 utiliza_fsda = Não aplicável.

Fluxo Técnico:

 NF-e é gerada no sistema de origem;


 Interface de Entrada com o sistema de Origem;
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão não estiver definido no sistema de origem, será verificado o status
do WebService (NFE_WEB_SERVICE_STATUS) e se não estiver em operação e a Interface
não utilizar contingência automática (NFE_INTERFACE.CONTINGENCIA = ‘N’) a NF-e será
inserida com um status de Processamento Estático (75), ou seja, seu processamento será
impedido. Além disso, será registrado para retornar o evento 097 (WebService
Indisponível. Impossibilidade de Transmissão da NF-e) ao sistema de origem;

Somente para SAP: Quando o SAP receber o evento 097, irá atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 097. Visualmente este registro estará na aba Erro do
Painel de Controle, com farol vermelho e evento 097. O usuário neste caso deverá optar
por imprimir a NF-e em Contingência ou simplesmente processá-la novamente.

Lembramos que se a NF-e já foi impressa em tipo de emissão de contingência, nunca mais deve
voltar a ser normal.
350
Contingência FS Manual - Definida no Sistema de
Origem
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência FS Definida no
Sistema de Origem, é necessário que o sistema de origem apenas envie o campo “Tipo de
Emissão” preenchido com o valor ‘C’. Este modelo deve ser adotado quando já se sabe que existe
um problema que irá impossibilitar a autorização de uso antes da emissão ou reprocessamento de
uma NF-e.

Pré-Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = ‘C’;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = ‘C’;
 Status WebService: Não aplicável.

Dados Técnicos:

 Tabela Comply e-Docs: NFE_NF_CAPA.TIPO_EMISSAO = ‘C’;


 Tag XML: <tpEmis>2</tpEmis>.

Parâmetros de Sistemas:

 NFE_INTERFACE.CONTINGENCIA = Não aplicável;


 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = Não aplicável;
 utiliza_dpec = Não aplicável;
 utiliza_fs = Não aplicável;
 utiliza_fsda = Não aplicável.

Fluxo Técnico:

 NF-e é gerada no sistema de origem com o tipo de emissão com o valor ‘C’;
 Interface de Entrada com o sistema de Origem;
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão estiver definido no sistema de origem com o valor ‘C’, a NF-e será
inserida com tipo de emissão FS (NFE_NF_CAPA-TIPO_EMISSAO = 'C', tag tpEmis = '2');
 O XML será gerado;
 A priorização será executada de acordo com parametrização do sistema;
 O processo de impressão irá verificar se o FS já foi impresso e se a impressão é executada
no sistema de origem, caso esta seja executada no componente Comply e-Docs Server o
Formulário de Segurança será impresso com as informações de Dados de NF-e (Segundo
Código de Barras);
 Serão gerados o lote de XML, a transmissão e a recepção do evento 103 (Lote Recebido
com Sucesso);
 O processo de consulta de lote irá verificar o status deste e receberá o evento 100
(Autorizado o Uso da NF-e);
 O processo de impressão irá verificar se o FS já foi impresso e se a impressão é executada
no sistema de origem, neste caso sabemos que a impressão já foi executada ou a mesma
ocorre no sistema de origem, logo somente será retornado ao sistema de origem o evento
100;

Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
está ativa. Caso não estiver e o indicador de impressão estiver como ‘S’, somente irá
atualizar a tabela /PWS/ZNFETB000 com o evento da NF-e, caso estiver e o indicador de
impressão estiver como ‘N’ irá imprimir o FS, gravar o indicador de impressão = 'S'
(/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela /PWS/ZNFETB0000-
COD_STATU = 100. Visualmente este registro estará na aba Contingência do Painel de
Controle, com farol verde e evento 100.

352
Contingência FS Automática
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência FS
Automática, é necessário que o sistema de origem não envie o campo “Tipo de Emissão”
preenchido, que o WebService esteja fora do ar e que os parâmetros de sistema apontem para o
tipo de emissão FS. Esse modelo deve ser adotado quando se deseja que o sistema Comply e-Docs
ao perceber que um WebService não está ativo, emita automaticamente a NF-e em FS.

Pré-Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = null;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = null;
 Status WebService: NFE_WEB_SERVICE_STATUS.COD_STATUS <> 107 (Serviço fora de
Operação).

Dados Técnicos:

 Tabela Comply e-Docs: NFE_NF_CAPA.TIPO_EMISSAO = ‘C’;


 Tag XML: <tpEmis>2</tpEmis>.

Parâmetros de Sistema:

 NFE_INTERFACE.CONTINGENCIA = ‘S’;
 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = ‘N’;
 utiliza_dpec = ‘N’;
 utiliza_fs = ‘S’;
 utiliza_fsda = ‘N’;

Fluxo Técnico:

 NF-e é gerada no sistema de origem;


354
 Interface de Entrada com o sistema de Origem;
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão não estiver definido no sistema de origem, será verificado o status
do WebService (NFE_WEB_SERVICE_STATUS) e se não estiver em operação e a Interface
utilizar contingência automática (NFE_INTERFACE.CONTINGENCIA = ‘S’) a NF-e será
inserida com tipo de emissão igual à FS (NFE_NF_CAPA-TIPO_EMISSAO = 'C', tag tpEmis =
'2');
 O XML será gerado;
 A priorização será executada de acordo com parametrização do sistema;
 O processo de impressão irá verificar se o FS já foi impresso e se a impressão é executada
no sistema de origem, caso seja executada no componente Comply e-Docs Server o
Formulário de Segurança será impresso com as informações de Dados de NF-e (Segundo
Código de Barras), além disso, será retornado ao sistema de origem o evento 099 - (Nota
Fiscal Convertida para Contingência);
 Somente para SAP: Quando o SAP receber o evento 099, irá verificar se a Exit de
Impressão em Formulário de Segurança está ativa. Caso não estiver, somente irá atualizar
a tabela /PWS/ZNFETB000 com o evento da NF-e, caso estiver irá imprimir o formulário
de segurança, gravar o indicador de impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e
atualizar o evento na tabela /PWS/ZNFETB0000-COD_STATU = 099. Visualmente este
registro estará na aba Contingência do Painel de Controle, com farol vermelho e evento
099;
 Serão gerados o lote de XML, a transmissão e a recepção do evento 103 (Lote Recebido
com Sucesso);
 O processo de consulta de lote irá verificar o status deste e receberá o evento 100
(Autorizado o Uso da NF-e);
 O processo de impressão irá verificar se o FS já foi impresso e se a impressão é executada
no sistema de origem, neste caso sabemos que ou a impressão já foi executada ou ocorre
no sistema de origem, logo, somente será retornado ao sistema de origem o evento 100;
 O processo de impressão irá verificar se o FS é impresso no sistema de origem, caso seja
executada no componente Comply e-Docs Server o DANFE será impresso, além disso, será
retornado ao sistema de origem o evento 100.

Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
em Formulário de Segurança está ativa. Caso não estiver e o indicador de impressão estiver
como ‘S’, somente irá atualizar a tabela /PWS/ZNFETB000 com o evento da NF-e, caso
estiver e o indicador de impressão apresentar ‘N’ irá imprimir o FS, gravar o indicador de
impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 100. Visualmente este registro estará na aba Contingência
do Painel de Controle, com farol verde e evento 100.
356
Contingência Scan Manual
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência SCAN Definida
no Sistema de Origem, é necessário que o sistema de origem apenas envie os campos “Tipo de
Emissão” preenchido com o valor ‘3’ e o Série entre 900 e 998. Este modelo deve ser adotado
quando já se sabe que existe um problema que irá impossibilitar a autorização de uso no
WebService do estado de emissão da NF-e e que a SEFAZ desse estado já solicitou a habilitação
ao SCAN e que essa UF já está ativa no SCAN.

Pré-Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = ‘3’;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = ‘3’;
 Status WebService: Não aplicável.

Dados Técnicos:

 Tabela Comply e-Docs: NFE_NF_CAPA.TIPO_EMISSAO = ‘3’;


 Tag XML: <tpEmis>3</tpEmis>.

Parâmetros de Sistema:

 NFE_INTERFACE.CONTINGENCIA = Não aplicável;


 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = Não aplicável;
 utiliza_dpec = Não aplicável;
 utiliza_fs = Não aplicável;
 utiliza_fsda = Não aplicável.

Fluxo Técnico:

 NF-e é gerada no sistema de origem com o tipo de emissão com o valor ‘3’;
358
 Interface de Entrada com o sistema de Origem;
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão estiver definido no sistema de origem com o valor ‘3’, a NF-e será
inserida com tipo de emissão SCAN (NFE_NF_CAPA-TIPO_EMISSAO = '3', tag tpEmis = '3');
 O XML será gerado;
 A validação do XML será executada de acordo com parametrização do sistema;
 A priorização será executada de acordo com parametrização do sistema;
 Serão gerados os lotes de XML, a transmissão para o WebService SCAN e a recepção do
evento 103 (Lote Recebido com Sucesso);
 O processo de consulta de lote irá verificar o status deste e receberá o evento 100
(Autorizado o Uso da NF-e) do WebService SCAN;
 O processo de impressão irá verificar se o DANFE é impresso no sistema de origem, caso
seja executada no componente Comply e-Docs Server o DANFE será impresso, além disso,
será retornado ao sistema de origem o evento 100.

Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
está ativa. Caso não estiver, somente irá atualizar a tabela /PWS/ZNFETB000 com o evento
da NF-e, caso estiver irá imprimir o DANFE, gravar o indicador de impressão = 'S'
(/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela /PWS/ZNFETB0000-
COD_STATU = 100. Visualmente este registro estará na aba Contingência do Painel de
Controle, com farol verde e evento 100.
360
Contingência Scan Automática
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência SCAN
Automática, é necessário que o sistema de origem não envie o campo “Tipo de Emissão”
preenchido, que o WebService esteja fora do ar, que os parâmetros de sistema apontem para o
tipo de emissão SCAN e o WebService SCAN esteja ativo para a UF onde a NF-e foi gerada. Esse
modelo deve ser adotado quando se deseja que o sistema Comply e-Docs, ao perceber que um
WebService não está ativo, informe ao sistema de origem que o SCAN está ativo para aquela UF,
permitindo assim ao usuário decidir se irá emitir o SCAN convertendo o tipo de emissão e série da
NF-e.

Pré-Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = null;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = null;
 Status WebService: NFE_WEB_SERVICE_STATUS.COD_STATUS <> 107 (Serviço fora de
Operação);
 Status WebService SCAN: NFE_WEB_SERVICE_STATUS_SCAN.COD_STATUS = 107 (Serviço
em Operação).

Dados Técnicos:

 Tabela Comply e-Docs: NFE_NF_CAPA.TIPO_EMISSAO = ‘3’;


 Tag XML: <tpEmis>3</tpEmis>.

Parâmetros de Sistema:

 NFE_INTERFACE.CONTINGENCIA = ‘S’;
 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = ‘S’;
 utiliza_dpec = ‘N’;
 utiliza_fs = ‘N’;
 utiliza_fsda = ‘N’.

Fluxo Técnico:
 NF-e é gerada no sistema de origem;
 Interface de Entrada com o sistema de Origem;
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão não estiver definido no sistema de origem, será verificado o status
do WebService (NFE_WEB_SERVICE_STATUS), se não estiver em operação e a Interface
utilizar contingência automática (NFE_INTERFACE.CONTINGENCIA = ‘S’) será verificado o
status do WebService SCAN para essa UF (NFE_WEB_SERVICE_STATUS_SCAN) e a NF-e será
inserida com um status de processamento estático, ou seja, seu processamento será
impedido. Além disso, será registrada para retornar o evento 079 (Nota fiscal não pode
ser transmitida, SCAN ativo) ao sistema de origem.

Somente para SAP: Quando o SAP receber o evento 079, ele entenderá que esse evento
corresponde a erro. Dessa forma, somente irá atualizar a tabela /PWS/ZNFETB000 com o
evento da NF-e. Visualmente este registro estará na aba Erro do Painel de Controle, com
farol vermelho e evento 079. O usuário neste caso deverá optar por cancelar esta NF-e e
emitir uma nova já utilizando a categoria de NF-e correta amarrada à série desejada ou
simplesmente processá-la novamente para que o sistema realize uma nova tentativa de
autorização de uso.

362
Contingência DPEC Manual - Definida pelo Sistema de
Origem
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência DPEC Definida
no Sistema de Origem, é necessário que o sistema de origem apenas envie o campo "Tipo de
Emissão" preenchido com o valor ‘4’. Esse modelo deve ser adotado quando já se sabe que existe
um problema que irá impossibilitar a autorização de uso no WebService do estado de emissão da
NF-e, mas é possível transmitir arquivos através da rede e não se deseja modificar a série para a
utilização do SCAN.

Pré-Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = ‘4’;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = ‘4’;
 Status WebService: Não aplicável.

Dados Técnicos:

 Tabela Comply e-Docs: NFE_NF_CAPA.TIPO_EMISSAO = ‘4’;


 Tag XML: <tpEmis>4</tpEmis>.

Parâmetros de Sistemas:

 NFE_INTERFACE.CONTINGENCIA = Não aplicável;


 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = Não aplicável;
 utiliza_dpec = Não aplicável;
 utiliza_fs = Não aplicável;
 utiliza_fsda = Não aplicável.

Fluxo Técnico:

364
 NF-e é gerada no sistema de origem com o tipo de emissão com o valor ‘4’;
 Interface de Entrada com o sistema de Origem;
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão estiver definido no sistema de origem com o valor ‘4’, a NF-e será
inserida com tipo de emissão DPEC (NFE_NF_CAPA-TIPO_EMISSAO = '4', tag tpEmis = '4');
 O XML será gerado;
 A validação do XML será executada de acordo com parametrização do sistema;
 A priorização será executada de acordo com parametrização do sistema;
 O processo de Contingência DPEC irá gerar o lote DPEC, transmiti-lo ao WebService DPEC
e receber a autorização: evento 124 (DPEC recebido pelo Sistema de Contingência
Eletrônica);
 O processo de impressão irá verificar se o DANFE já foi impresso e a impressão é
executada no sistema de origem, caso seja executada no componente Comply e-Docs
Server o DANFE será impresso com as informações de Número do Protocolo de
Autorização DPEC, além disso, será retornado ao sistema de origem o evento 124 - (DPEC
recebido pelo Sistema de Contingência Eletrônica);
 Somente para SAP: Quando o SAP receber o evento 124, irá verificar se a Exit de
Impressão está ativa. Caso não estiver, somente irá atualizar a tabela /PWS/ZNFETB000
com o evento da NF-e, caso estiver irá imprimir o DANFE e gravar o indicador de
impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 124. Visualmente este registro estará na aba
Contingência do Painel de Controle, com farol verde e o evento 124.
 Serão gerados os lotes de XML, a transmissão para o WebService e a recepção do evento
103 (Lote Recebido com Sucesso);
 O processo de consulta de lote irá verificar o status deste e receberá o evento 100
(Autorizado o Uso da NF-e) do WebService;
 O processo de impressão irá verificar se o DANFE é impresso no sistema de origem ou se
já ocorreu, caso nenhuma das alternativas sejam realizadas, a impressão acontecerá,
além disso, será retornado ao sistema de origem o evento 100.

Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
DPEC está ativa e se o DANFE já foi impresso. Caso não estiver, somente irá atualizar a
tabela /PWS/ZNFETB000 com o evento da NF-e, caso estiver irá imprimir o DANFE, gravar o
indicador de impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 100. Visualmente este registro estará na aba Contingência
do Painel de Controle, com farol verde e evento 100.
366
Contingência DPEC Automática
Para que a NF-e seja processada e transmitida com o Tipo de Emissão Contingência DPEC
Automática, é necessário que o sistema de origem não envie o campo "Tipo de Emissão"
preenchido, que o WebService esteja fora do ar, que os parâmetros de sistema apontem para o
tipo de emissão DPEC. Esse modelo deve ser adotado quando se deseja que o sistema Comply e-
Docs ao perceber que um WebService não está ativo, autorize o DPEC e permita a impressão do
DANFE.

Pré-Requitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = null;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = null;
 Status WebService: NFE_WEB_SERVICE_STATUS.COD_STATUS <> 107 (Serviço fora de
Operação);

Dados Técnicos:

 Tabela Comply e-Docs: NFE_NF_CAPA.TIPO_EMISSAO = ‘4’;


 Tag XML: <tpEmis>4</tpEmis>.

Parâmetros de Sistema:

 NFE_INTERFACE.CONTINGENCIA = ‘S’;
 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = ‘N’;
 utiliza_dpec = ‘S’;
 utiliza_fs = ‘N’;
 utiliza_fsda = ‘N’.

Fluxo Técnico:

 NF-e é gerada no sistema de origem;


 Interface de Entrada com o sistema de Origem;

368
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão não estiver definido no sistema de origem, será verificado o status
do WebService (NFE_WEB_SERVICE_STATUS) e se não estiver em operação e a Interface
utilizar contingência automática (NFE_INTERFACE.CONTINGENCIA = ‘S’) a NF-e será
inserida com tipo de emissão igual a DPEC (NFE_NF_CAPA-TIPO_EMISSAO = '4', tag tpEmis
= '4');
 O XML será gerado;
 A validação do XML será executada de acordo com parametrização do sistema;
 A priorização será executada de acordo com parametrização do sistema;
 O processo de Contingência DPEC irá gerar o lote DPEC, transmiti-lo ao WebService DPEC
e receber a autorização: evento 124 (DPEC recebido pelo Sistema de Contingência
Eletrônica);
 O processo de impressão irá verificar se o DANFE já foi impresso e se é executada no
sistema de origem, caso a seja no componente Comply e-Docs Server o DANFE será
impresso com as informações de Número do Protocolo de Autorização DPEC, além disso,
será retornado ao sistema de origem o evento 124 - (DPEC recebido pelo Sistema de
Contingência Eletrônica);
 Somente para SAP: Quando o SAP receber o evento 124, irá verificar se a Exit de
Impressão está ativa. Caso não estiver, somente irá atualizar a tabela /PWS/ZNFETB000
com o evento da NF-e, caso estiver irá imprimir o DANFE e gravar o indicador de
impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 124. Visualmente este registro estará na aba
Contingência do Painel de Controle, com farol verde e o evento 124.
 Serão gerados os lotes de XML, a transmissão para o WebService e a recepção do evento
103 (Lote Recebido com Sucesso);
 O processo de consulta de lote irá verificar o status o lote e receberá o evento 100
(Autorizado o Uso da NF-e) do WebService;
 O processo de impressão irá verificar se o DANFE é impresso no sistema de origem ou se
já ocorreu, caso nenhuma das alternativas sejam realizadas, a impressão acontecerá ,
além disso, será retornado ao sistema de origem o evento 100;

Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
está ativa e se o DANFE já foi impresso. Caso não estiver, somente irá atualizar a tabela
/PWS/ZNFETB000 com o evento da NF-e, caso estiver irá imprimir o DANFE, gravar o
indicador de impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 100. Visualmente este registro estará na aba Contingência
do Painel de Controle, com farol verde e evento 100.
370
Contingência FSDA Manual - Definida pelo Sistema de
Origem
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência FSDA Definida
no Sistema de Origem, é necessário que o sistema de origem apenas envie o campo "Tipo de
Emissão" preenchido com o valor ‘5’. Esse modelo deve ser adotado quando já se sabe que existe
um problema que irá impossibilitar a autorização de uso antes da emissão ou reprocessamento de
uma NF-e e não existe mais estoque de FS.

Pré-Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = ‘5’;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = ‘5’;
 Status WebService: Não aplicável.

Dados Técnicos:

 Tabela Comply e-Docs: NFE_NF_CAPA.TIPO_EMISSAO = ‘5’;


 Tag XML: <tpEmis>5</tpEmis>.

Parâmetros de Sistema:

 NFE_INTERFACE.CONTINGENCIA = Não aplicável;


 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = Não aplicável;
 utiliza_dpec = Não aplicável;
 utiliza_fs = Não aplicável;
 utiliza_fsda = Não aplicável.

Fluxo Técnico:

 NF-e é gerada no sistema de origem com o tipo de emissão com o valor ‘5’;
 Interface de Entrada com o sistema de Origem;
 Processo de Entrada irá verificar os parâmetros citados;

372
 Se o tipo de emissão estiver definido no sistema de origem com o valor ‘5’, a NF-e será
inserida com tipo de emissão FSDA (NFE_NF_CAPA-TIPO_EMISSAO = '5', tag tpEmis = '5');
 O XML será gerado;
 A priorização será executada de acordo com parametrização do sistema;
 O processo de impressão irá verificar se o FSDA já foi impresso e se esta é executada no
sistema de origem, caso seja executada no componente Comply e-Docs Server o FSDA
será impresso com as informações de Dados de NF-e (Segundo Código de Barras);
 Serão gerados o lote de XML, a transmissão e a recepção do evento 103 (Lote Recebido
com Sucesso);
 O processo de consulta de lote irá verificar o status deste e receberá o evento 100
(Autorizado o Uso da NF-e);
 O processo de impressão irá verificar se o FSDA já foi impresso e se esta é executada no
sistema de origem, neste caso sabemos que ou a impressão já foi executada ou ocorrerá
no sistema de origem, logo, somente será retornado ao sistema de origem o evento 100;
 O processo de impressão irá verificar se o FSDA é impresso no sistema de origem, caso
seja executada no componente Comply e-Docs Server o FSDA será impresso, além disso,
retornará ao sistema de origem o evento 100;

Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
está ativa. Caso não estiver e o indicador de impressão estiver como ‘S’, somente irá
atualizar a tabela /PWS/ZNFETB000 com o evento da NF-e, caso estiver e o indicador de
impressão estiver como ‘N’ irá imprimir o FSDA, gravar o indicador de impressão = 'S'
(/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela /PWS/ZNFETB0000-
COD_STATU = 100. Visualmente este registro estará na aba Contingência do Painel de
Controle, com farol verde e evento 100.
374
Contingência FSDA Automática
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência FSDA
Automática, é necessário que o sistema de origem não envie o campo “Tipo de Emissão”
preenchido, o WebService esteja fora do ar e que os parâmetros de sistema apontem para o tipo
de emissão FSDA. Este modelo deve ser adotado quando se deseja que o sistema Comply e-Docs
ao perceber que um WebService não está ativo, emita automaticamente a NF-e em FSDA.

Pré-Requisitos:

 Sistema de origem EDI: NFE_NF_CAPA_EDI.TIPO_EMISSAO = null;


 Sistema de origem SAP: /PWS/ZNFET001-TIPO_EMISSAO = null;
 Status WebService: NFE_WEB_SERVICE_STATUS.COD_STATUS <> 107 (Serviço fora de
Operação).

Dados Técnicos:

 Tabela Comply e-Docs: NFE_NF_CAPA.TIPO_EMISSAO = ‘5’;


 Tag XML: <tpEmis>5</tpEmis>.

Parâmetros de Sistemas:

 NFE_INTERFACE.CONTINGENCIA = ‘S’;
 NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
 utiliza_scan = ‘N’;
 utiliza_dpec = ‘N’;
 utiliza_fs = ‘N’;
 utiliza_fsda = ‘S’.

Fluxo Técnico:

 NF-e é gerada no sistema de origem;


 Interface de Entrada com o sistema de Origem;
 Processo de Entrada irá verificar os parâmetros citados;
 Se o tipo de emissão não estiver definido no sistema de origem, será verificado o status
do WebService (NFE_WEB_SERVICE_STATUS) e se não estiver em operação e a Interface
utilizar contingência automática (NFE_INTERFACE.CONTINGENCIA = ‘S’) a NF-e será
inserida com tipo de emissão igual à FS (NFE_NF_CAPA-TIPO_EMISSAO = '5', tag tpEmis =
'5');
 O XML será gerado;
 A priorização será executada de acordo com parametrização do sistema;
 O processo de impressão irá verificar se o FSDA já foi impresso e se a impressão é
executada no sistema de origem, caso seja executada no componente Comply e-Docs
Server o Formulário de Segurança Documento Auxiliar será impresso com as informações
de Dados de NF-e (Segundo Código de Barras), além disso, será retornado ao sistema de
origem o evento 099 - (Nota Fiscal Convertida para Contingência);
 Somente para SAP: Quando o SAP receber o evento 099, irá verificar se a Exit de
Impressão em Formulário de Segurança Documento Auxiliar está ativa. Caso não estiver,
somente irá atualizar a tabela /PWS/ZNFETB000 com o evento da NF-e, caso estiver irá
imprimir o formulário de segurança, gravar o indicador de impressão = 'S'
(/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela /PWS/ZNFETB0000-
COD_STATU = 099. Visualmente este registro estará na aba Contingência do Painel de
Controle, com farol vermelho e evento 099;
 Serão gerados o lote de XML, a transmissão e a recepção do evento 103 (Lote Recebido
com Sucesso);
 O processo de consulta de lote irá verificar o status deste e receberá o evento 100
(Autorizado o Uso da NF-e);
 O processo de impressão irá verificar se o FSDA já foi impresso e se a impressão é
executada no sistema de origem, neste caso sabemos que ou a impressão já foi executada
ou ocorre no sistema de origem, logo, somente será retornado ao sistema de origem o
evento 100;
 O processo de impressão irá verificar se o FSDA é impresso no sistema de origem, caso
seja executada no componente Comply e-Docs Server o DANFE será impresso, além disso,
será retornado ao sistema de origem o evento 100;

Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
em Formulário de Segurança Documento Auxiliar está ativa. Caso não estiver e o indicador
de impressão estiver como ‘S’, somente irá atualizar a tabela /PWS/ZNFETB000 com o
evento da NF-e, caso estiver e o indicador de impressão apresentar ‘N’ irá imprimir o FSDA,
gravar o indicador de impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na
tabela /PWS/ZNFETB0000-COD_STATU = 100. Visualmente este registro estará na aba
Contingência do Painel de Controle, com farol verde e evento 100.

376
378
Serviço Web WCF (Inbound)
O sistema Comply e-Docs atende ao processo de recebimento de XML de Distribuição através do
Serviço Web disponibilizado pelo Comply e-Docs Server. Esse processo é chamado de Inbound.

Nas versões anteriores do sistema Comply e-Docs era necessário publicar um WebService em um
IIS Server. A partir da versão 4.00 isto não é mais necessário dado que o próprio Comply e-Docs
Server disponibiliza um Serviço Web que trabalha em um formato muito similar ao do WebService
tradicional.

Para ativar esse Serviço Web apenas é necessário iniciar o Serviço do Comply e-Docs Server.

Quando o Comply e-Docs Server é iniciado dois Serviços Web são publicados: com compactação e
sem compactação. Cada um desses serviços tem sua própria URL. O que diferencia estas URLs é a
porta na qual está sendo executado o Serviço. Para realizar esta configuração apenas é
necessário acessar o Assistente de Configuração e modificar as Chaves “PORT” (sem
compactação) e “PORT_COMPACTATION” (com compactação).

A diferença entre utilizar compactação ou não é relacionada ao método HTTP que será utilizado
para a comunicação com o Serviço Web. Recomendamos utilizar o Serviço com Compactação.

A URL que será publicada será nesse formato:

http://HOST:PORT/RecebimentoNFe

Onde HOST é a máquina onde o Comply e-Docs Server está instalado e PORT a porta utilizada.
Exemplo: http://localhost:1236/RecebimentoNFe.

Em caso de dúvidas, é possível verificar a URL que está sendo executada, para isso é necessário
acessar o “Event View” do Windows do Servidor. Após os eventos de inicialização do Serviço,
será gravado um log informando o caminho que o Serviço Web foi publicado. A mensagem é neste
formato: “Serviço http://localhost:1236/RecebimentoNFe iniciado com sucesso
(COMPACTAÇÂO)”.

Esta URL que deve ser utilizada para a transmissão de arquivos XMLs de distribuição.

Alterar as Portas dos Serviços


As portas utilizadas para os serviços WCF podem ser trocadas no arquivo de configuração
“SondaIT.Aplicativos.NFE.WindowsService.exe.config”, localizado originalmente em “C:\Program
Files (x86)\Sonda IT\Comply e-Docs Server 4.00\NFE”.

<!-- Porta de comunicação sem compactação-->


<add key="PORT" value="1235" />
<!-- Porta de comunicação com compactação-->
<add key="PORT_COMPACTION" value="1236" />

Endereços disponibilizados para consumo do WCF


Inbound

380
Logo que o serviço do Comply e-Docs Server é iniciado, os serviços WCF são disponibilizados. As
mensagens com o log do início do funcionamento podem ser localizadas no Event Viewer do
Servidor em que a aplicação esta rodando.

Mensagem para a URL sem compactação

Executando a partir de: C:\Program Files (x86)\Sonda IT\Comply e-Docs Server-4.00\NFE\


Serviço http://localhost:1235/RecebimentoNFe iniciado com sucesso ()
Mensagem para a URL com compactação

Executando a partir de: C:\Program Files (x86)\Sonda IT\Comply e-Docs Server-4.00\NFE\


Serviço http://localhost:1236/RecebimentoNFe iniciado com sucesso (COMPACTAÇÂO)

382
Com Compactação ou Sem Compactação

A diferença entre os serviços com e sem compactação, é que a compactação prove uma
criptografia para os dados trafegados.
384
Modelo Operacional Inbound
Após a autorização de uso, o sistema emissor de NF-e do parceiro deverá enviar o XML no formato
de Distribuição para a URL do Serviço Web do sistema Comply e-Docs disponibilizada pelo cliente.

O Serviço por sua vez, irá realizar as seguintes verificações:

 Estrutura do XML;
 Validação do Schema XSD;
 Desmembramento do XML em dados;
 Inserção no Banco de Dados.

No término desse processo será gerada uma mensagem de retorno ao sistema que executou a
chamada do Serviço Web.

O envio e retorno de mensagem do Serviço Web é através de processo síncrono, ou seja, o


processamento da solicitação de serviço é concluído na mesma conexão, com a devolução de uma
mensagem informando o resultado do processamento do serviço solicitado.

Após a inserção no banco de dados, o processo “Gerenciador de Pré-Validação” irá verificar a


autenticidade da chave de acesso do XML no WebService “Consulta Nota”, da Secretaria da
Fazenda do Estado Emissor da NF-e.

Caso o arquivo XML esteja autorizado a NF-e será registrada com o Status de Processamento 299
(Processo de Entrada de Nota Fiscal Concluído), caso não esteja autorizado a NF-e será registrada
com o Status de Processamento 212.

O diagrama a seguir ilustra o fluxo de comunicação entre o aplicativo do Parceiro e o WebService


Inbound do Sistema Comply e-Docs:
386
Documento XML
Os padrões técnicos utilizados pelo sistema Comply e-Docs para os documentos XML de
Distribuição estão definidos nos manuais de integração. Estes padrões abrangem a codificação do
XML (UTF-8), Namespace do XML, otimizações para a geração do arquivo e validação do Schema
XSD (é interessante antes do envio do XML para o Serviço Web do sistema Comply e-Docs, que o
mesmo seja validado de acordo com o Schema XSD pela aplicação emissora).
Comunicação
A comunicação entre o sistema emissor da NF-e, NFS-e do sistema Comply e-Docs será baseado
em Serviço Web disponibilizado pelo cliente a seus parceiros.

O meio físico de comunicação utilizado será a Internet, com o uso do protocolo HTTP. Para a
realização da conexão é necessário somente o Login do usuário.

A autenticação é definida através de usuário e senha que devem ser definidos na tabela
NFE_PARCEIRO_USUARIO.

O modelo de comunicação segue o padrão de WebServices definido pelo WS-I Basic Profile. A
troca de mensagens entre sistema emissor da NF-e e sistema Comply e-Docs será realizada no
padrão SOAP versão 1.2, com troca de mensagens XML no padrão Style/Enconding:
Document/Literal, wrapped. A opção “wrapped” representa a chamada aos métodos disponíveis
com a passagem de mais de um parâmetro.

Anexo a este documento existem as mensagens SOAP de envio de XML e retorno de evento.

388
Mensagens do WebService
Após o envio do arquivo XML ao Serviço Web do sistema Comply e-Docs podem ocorrer as
seguintes mensagens para o NF-e:

Código Descrição Detalhes


1 Nota fiscal importada com sucesso A NF-e foi incluída na base de dados
2 Nota fiscal rejeitada: nota já existe A NF-e já consta na base de dados
A NF-e não pode ser inserida. É
Nota fiscal rejeitada: erro ao importar a
3 necessário verificar a descrição do
nota (ver detalhes)
erro.
A NF-e foi rejeitada por não estar de
Nota fiscal rejeitada: schema XML do
4 acordo com o Schema XSD de
arquivo inválido
Distribuição
Nota fiscal rejeitada: arquivo XML não O Padrão do XML enviado não é de
5
reconhecido Distribuição
Não foi possível realizar a
6 Erro de login no serviço
autenticação no sistema
É necessário verificar os logs da
9 Erro interno ao processar a nota fiscal
aplicação

Já o envio do arquivo XML no NFS-e, podem ocorrer as seguintes mensagens:

Código Descrição Detalhes


Erro de validação: Número de Nota
Validação do número da Nota Fiscal de
1 '00000' Não Encontrado Para O CNPJ
Serviço com o CNPJ emissor.
'0000000'.
Validação do XML montado, com o XSD
Erro de validação: Arquivo XSD de Envio
2 referente ao município para envio de
Lote inválido.
lote.
Validação do XML montado, com o XSD
Erro de validação: Arquivo XSD de
3 referente ao município para consulta
Consulta inválido.
do lote.
Validação do XML montado, com o XSD
Erro de validação: Arquivo XSD de
4 referente ao município para
Cancelamento inválido.
cancelamento da Nota.
O status atual do RPS '00000' não permite Validação do status do RPS antes da
5
alteração.Status: realização de alguns eventos.
Mensagem de sucesso de recebimento
6 Lote recebido com sucesso.
do lote na prefeitura.
CNPJ '00000' não cadastrado nas
7 Validação de cadastro de CNPJ.
configurações de filial.
8 RPS em processamento. Status: Mensagem informativa.
Validação do número do RPS passado,
9 RPS não existe na base de dados.
com os registrados na base de dados.
O status atual da nota não permite Validação do status do RPS antes da
10
cancelamento. Status: realização de alguns eventos.
Não é possível realizar o cancelamento. O
Validação do número da nota passado,
11 número da nota não esta cadastrado na
com os registrados na base de dados.
base de dados.
Validação do XML montado, com o XSD
Erro de validação. O XML de requisição
12 referente ao município para envio de
esta em um formato incorreto.
lote.

390
Verificando o Serviço Web
Para verificar se o Serviço Web está funcionando corretamente é possível adicionar a URL do
Serviço em um Browser de Internet. O exemplo abaixo é usando o Google Chrome:
Validação da Chave de Acesso na SEFAZ
É possível configurar uma regra de validação para que ao receber arquivos XMLs do Inbound, seja
realizada uma consulta na SEFAZ para verificar a autenticidade da NF-e. Para tanto é necessário
ativar um parâmetro. Este parâmetro deve ser executado através da transação do componente
Framework.

Menu: Gerência > Regras de Validação por Filial

Atalho: VALIDAINF

É necessário configurar todas as filiais que se deseja verificar a autenticidade com a regra
“Valida se a NF-e está autorizada”.

A imagem a seguir ilustra como configurar para a filial EMP1 da empresa EMP1:

392
Anexo – NF-e
Exemplo de uma mensagem dentro do SOAP de envio de XML completa:

<?xml version="1.0" encoding="utf-8"?>


<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<Autenticacao xmlns="http://recebimento.pw-nfe.procwork.com.br/">
<usuario>usuario_cliente</usuario>
<senha>senha_cliente</senha>
</Autenticacao>
</soap:Header>
<soap:Body>
<Recebimento xmlns="http://recebimento.pw-nfe.procwork.com.br/">
<xml><nfeProc versao="1.10" xmlns="http://www.portalfiscal.inf.br/nfe"><NFe
xmlns="http://www.portalfiscal.inf.br/nfe"><infNFe versao="1.10"
Id="NFe35090859275792000150550000000029330002386870"><ide><cUF>35</cUF><cNF>000238687
</cNF><natOp>ompra de bem para o ativo
imobilizado</natOp><indPag>2</indPag><mod>55</mod><serie>0</serie><nNF>2933</nNF><dEm
i>2009-08-25</dEmi><dSaiEnt>2009-08-
25</dSaiEnt><tpNF>0</tpNF><cMunFG>3550308</cMunFG><tpImp>1</tpImp><tpEmis>1</tpEmis>
<cDV>0</cDV><tpAmb>2
</tpAmb><finNFe>1</finNFe><procEmi>0</procEmi><verProc>2.0.0.0</verProc></ide><emit><C
NPJ>59275792000150
</CNPJ><xNome>Empresa de Teste</xNome><xFant>EMP1</xFant><enderEmit><xLgr>AV
GOIAS</xLgr><nro>1805</nro><xBairro>S PAULA</xBairro><cMun>3550308</cMun><xMun>Sao
Paulo</xMun><UF>SP</UF><CEP>09550900</CEP><cPais>1058</cPais><xPais>Brasil</xPais><fone
>1155555555</fone>
</enderEmit><IE>636003724112</IE></emit><dest><CNPJ /><xNome>Fornecedor Importacao USA
Nome campo
1</xNome><enderDest><xLgr>TESTE2</xLgr><nro>99</nro><xCpl>TESTE23</xCpl><xBairro>EXTE
RIOR</xBairro><cMun>
9999999</cMun><xMun>EXTERIOR</xMun><UF>EX</UF><CEP>99999999</CEP><cPais>2496</cPais
><xPais>ESTADO UNIDOS</xPais></enderDest><IE /></dest><det
nItem="1"><prod><cProd>000000000000000010</cProd><cEAN /><xProd>Satiagel ADF 22 Satiagel
ADF 22
Satiagel</xProd><NCM>29094100</NCM><genero>29</genero><CFOP>3551</CFOP><uCom>UN</u
Com><qCom>100.0000
</qCom><vUnCom>6828.2051</vUnCom><vProd>682820.51</vProd><cEANTrib
/><uTrib>UN</uTrib><qTrib>100.0000</qTrib>
<vUnTrib>6828.2051</vUnTrib><vSeg>1200.00</vSeg></prod><imposto>
<ICMS><ICMS00><orig>1</orig><CST>00</CST><modBC>3</modBC><vBC>752913.70</vBC><pICMS
>11.00</pICMS><vICMS>
82820.51</vICMS></ICMS00></ICMS><PIS><PISNT><CST>08</CST></PISNT></PIS><COFINS><COFIN
SNT><CST>08</CST>
</COFINSNT></COFINS></imposto></det><total><ICMSTot><vBC>752913.70</vBC><vICMS>82820.
51</vICMS><vBCST>0.00
</vBCST><vST>0.00</vST><vProd>682820.51</vProd><vFrete>0.00</vFrete><vSeg>1200.00</vSeg
><vDesc>0.00</vDesc>
<vII>0.00</vII><vIPI>0.00</vIPI><vPIS>12281.92</vPIS><vCOFINS>56571.27</vCOFINS><vOutro>12
4535.78</vOutro><vNF>
752913.70</vNF></ICMSTot></total><transp><modFrete>0</modFrete><vol><qVol>0</qVol><pes
oL>100.000</pesoL>
<pesoB>1000.000</pesoB></vol></transp></infNFe><Signature
xmlns="http://www.w3.org/2000/09/xmldsig#"><SignedInfo><CanonicalizationMethod
Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315" /><SignatureMethod
Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1" /><Reference
URI="#NFe35090859275792000150550000000029330002386870"><Transforms><Transform
Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature" /><Transform
Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"
/></Transforms><DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"
/><DigestValue>EKGdBzeqUojTuwJRzH97RfcZZYU=</DigestValue>
</Reference></SignedInfo><SignatureValue>
X6KKurGMu/3I3S+cYTjBy6l9WKcIkuy/jISdn/jIly2sLk9BUMrXY5e0G46A+FdlBFJp01XolQzn6fHj30SCZ9
3XsKzErckC/rrF1dJEV+
5pbt5pmwrqDVrsXciy9iH1ZpxLWP88i03XE4vuODIOkoQJOUqNUrRDI7Xy+nCOjAo=</SignatureValue>
<KeyInfo><X509Data>
<X509Certificate>MIIGOzCCBSOgAwIBAgIIO3UNAIfnrSwwDQYJKoZIhvcNAQEFBQAwTDELMAkGA1UEB
hMCQlIxEzARBgNVBAoTCklDUC1
CcmFzaWwxKDAmBgNVBAMTH1NFUkFTQSBDZXJ0aWZpY2Fkb3JhIERpZ2l0YWwgdjEwHhcNMDkwNjE
3MTcwMDAwWhcNMTAwNjE3MT
cwMDAwWjCB6DELMAkGA1UEBhMCQlIxEzARBgNVBAoTCklDUC1CcmFzaWwxFDASBgNVBAsTCyhFTSB
CUkFOQ08pMRgwFgYDVQQLEw
8wMDAwMDEwMDA1OTM0MzExFDASBgNVBAsTCyhFTSBCUkFOQ08pMRQwEgYDVQQLEwsoRU0gQlJBT
kNPKTEUMBIGA1UECxMLKEVNI
EJSQU5DTykxFDASBgNVBAsTCyhFTSBCUkFOQ08pMRQwEgYDVQQLEwsoRU0gQlJBTkNPKTEmMCQGA1
UEAxMdR0VORVJBTCBNT1RPU
lMgRE8gQlJBU0lMIExUREEwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAOQJSZjOaxmtK3vEc1AU
DKvrpmmxr8EGVvwCtOhBWMVu
qOlbyRZbBpNmgTalgrtdpiMuW2h9OeCqlZkfj70vQ26WcLxxQd1KzSug4Koy3oMHB2XfpW4kzpSx209p2
J36F0CkzWq6wBvwwCHDleKlt9
QB7U7eieirffs2VtzPz56pAgMBAAGjggMGMIIDAjAOBgNVHQ8BAf8EBAMCBeAwHQYDVR0lBBYwFAYIKw
YBBQUHAwIGCCsGAQUFBwMEM
B8GA1UdIwQYMBaAFLdgqFv5sqauAO1069VKyZZoZvVcMIHJBgNVHREEgcEwgb6BFkVTVEVMQS5CRVJU
UkFOREBHTS5DT02gPgYFYEwB
AwSgNRMzMjMxMTE5NDUwNjU2Nzg2MDg2MzAwMDAwMDAwMDAwMDAwMDAzLjMzOS4wMDk1U1NQI
FNQoDAGBWBMAQMCoCcTJUp
PU0UgQ0FSTE9TIERBIFNJTFZFSVJBIFBJTkhFSVJPIE5FVE+gGQYFYEwBAwOgEBMONTkyNzU3OTIwMDA
xNTCgFwYFYEwBAwegDhMMMD
AwMDAwMDAwMDAwMFcGA1UdIARQME4wTAYGYEwBAgEGMEIwQAYIKwYBBQUHAgEWNGh0dHA6Ly9
3d3cuY2VydGlmaWNhZG9kaWdp
dGFsLmNvbS5ici9yZXBvc2l0b3Jpby9kcGMwgfAGA1UdHwSB6DCB5TBJoEegRYZDaHR0cDovL3d3dy5jZ
XJ0aWZpY2Fkb2RpZ2l0YWwuY29
tLmJyL3JlcG9zaXRvcmlvL2xjci9zZXJhc2FjZHYxLmNybDBDoEGgP4Y9aHR0cDovL2xjci5jZXJ0aWZpY2
Fkb3MuY29tLmJyL3JlcG9zaXRvc
mlvL2xjci9zZXJhc2FjZHYxLmNybDBToFGgT4ZNaHR0cDovL3JlcG9zaXRvcmlvLmljcGJyYXNpbC5nb3Y

394
uYnIvbGNyL1NlcmFzYS9yZXBvc2l
0b3Jpby9sY3Ivc2VyYXNhY2R2MS5jcmwwgZcGCCsGAQUFBwEBBIGKMIGHMDwGCCsGAQUFBzABhjBod
HRwOi8vb2NzcC5jZXJ0aWZpY2F
kb2RpZ2l0YWwuY29tLmJyL3NlcmFzYWNkdjEwRwYIKwYBBQUHMAKGO2h0dHA6Ly93d3cuY2VydGlm
aWNhZG9kaWdpdGFsLmNvbS5ici9
jYWRlaWFzL3NlcmFzYWNkdjEucDdiMA0GCSqGSIb3DQEBBQUAA4IBAQA2fZkSQ4yLh6hq9bx1awAzk6u
LrSdlh7iNieC9YMMS4CAQlfcNoM
7xqakYSzpe+DJtm5udvVC3smzy8pJVsdlKJfcNRQVhNSAw57G2aH+af6jHplQn2Pulu9K23Y8sZQTvvMAy
3wJhj3DwUKLRf2AQANzRTt0rAO
j5pshjtfw/wcPtZeCjHZjbzzhJNGe9PegT8TaZbELggIqtF2ORw1ifK13z74ujWnqtOCOOByUgN9zXFGwp
JApP09tSX6bR+9GSxIOogD+RNVI
urRGzq29i+TH5z9FflzpxtzYCnyuuQ/jdtoFvVKZBSAa/qPEPwpwHrB6Vzi/MGKn6Tlc1UbiH</X509Certi
ficate></X509Data></KeyInfo>
</Signature></NFe><protNFe versao="1.10"
xmlns="http://www.portalfiscal.inf.br/nfe"><infProt><tpAmb>2</tpAmb><verAplic>SP_NFE_PL_0
05d</verAplic><chNFe>
35090859275792000150550000000029330002386870</chNFe><dhRecbto>2009-09-
15T16:15:37</dhRecbto><nProt>135090013179264</nProt><digVal>EKGdBzeqUojTuwJRzH97RfcZZ
YU=</digVal><cStat>100</cStat>
<xMotivo>Autorizado o uso da NF-e</xMotivo></infProt></protNFe></nfeProc> </xml>
</Recebimento>
</soap:Body>
</soap:Envelope>

Segue abaixo um exemplo de uma mensagem dentro do SOAP de retorno de evento do XML
enviado:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RecebimentoResponse xmlns="http://recebimento.pw-nfe.procwork.com.br/">
<RecebimentoResult>
<CodigoMensagem>3</CodigoMensagem>
<Mensagem>CNPJ não cadastrado - Filial Inexistente</Mensagem>
<NumeroDocumento>
35090859275792000150550000000029330002386870</NumeroDocumento>
</RecebimentoResult>
</RecebimentoResponse>
</soap:Body>
</soap:Envelope>
396
Client Inbound
O Client Inbound é um programa que pode ser utilizado para realizar o envio de XMLs de
Distribuição ao Serviço Web Inbound do componente Comply e-Docs Server.

Após a autorização de uso, o sistema emissor de NF-e deverá disponibilizar o XML no formato de
Distribuição para posterior envio ao Serviço Web Inbound. O usuário poderá utilizar o Client
Inbound para transmitir o arquivo XML destinado a parceiros que possuem o Serviço Web Inbound
do sistema Comply e-Docs.

É possível configurar o Client Inbound para transmitir os arquivos manualmente, ou ainda,


configurá-lo para realizar a transmissão automática de arquivos utilizando o Modo Prompt de
Comando, agendando uma tarefa no utilitário “Tarefas Agendadas” do Windows.

O Client Inbound irá transmitir o XML de Distribuição ao Serviço Web Inbound do componente
Comply e-Docs Server que, por sua vez, irá realizar a verificação da estrutura do XML, validação
do Schema XSD, desmembramento do XML em dados e a inserção no Banco de Dados. Ao término
desse processo será gerada uma mensagem de retorno ao Client Inbound que a registrará e
passará para o processamento do próximo arquivo XML a ser enviado.

O envio e retorno de mensagem do Serviço Web Inbound é através de processo síncrono, ou seja,
o processamento da solicitação de serviço e o retorno são concluídos na mesma conexão, com a
devolução de uma mensagem informando o resultado do processamento do serviço solicitado.

O diagrama a seguir ilustra o fluxo de comunicação entre o Client Inbound e o Serviço Web
Inbound do Sistema Comply e-Docs:
398
Padrões Técnicos
Documento XML:
Os padrões técnicos utilizados pelo sistema Comply e-Docs para os documentos XML de
Distribuição estão definidos no Manual do Contribuinte 4.0.1. Este padrão abrange a codificação
do XML (UTF-8), Namespace do XML, otimizações para a geração do arquivo e validação do
Schema XSD (é interessante antes do envio do XML para o Serviço Web Inbound, que o mesmo
seja validado de acordo com o Schema XSD pela aplicação emissora).

Comunicação:
A comunicação entre o Client e o Servidor Inbound do sistema Comply e-Docs é baseada em
Serviço Web WFC (Windows Communication Foundation) disponibilizados pelo cliente a seus
parceiros.

O meio físico de comunicação utilizado será a Internet, com o uso do protocolo HTTP. Para que a
conexão seja realizada com sucesso, somente é necessário o Login do usuário.

A autenticação é definida através de usuário e senha que devem ser disponibilizados pelo Cliente
detentor do Inbound.

O modelo de comunicação segue o padrão de WebServices definido pelo WS-I Basic Profile. A
troca de mensagens entre Client e o Server Inbound do sistema Comply e-Docs é realizada no
padrão SOAP versão 1.2.
Pré-Requisitos Instalação Client Inbound
Software:

Sistema Operacional:

 Windows Server 2003;


 Windows Server 2008;
 Windows XP;
 Windows Vista;

Microsoft .Net Framework:

 3.5 ou Superior

Hardware:

 Processador:
 400MHz Pentium ou equivalente (mínimo), 1GHz Pentium ou equivalente (Recomendado).
 Memória:
 128 MB (mínimo), 512 MB (recomendado). Utilização média 40 MB.

Armazenamento:

 40 MB de espaço livre em disco (mínimo), 100 MB (recomendado). Utilização média 35


MB.

400
Instalação

O Client Inbound do Sistema Comply e-Docs pode ser instalado em Servidores e Clients do
Windows.

Para instalar o Client Inbound é necessário seguir os seguintes passos:

1. Executar o arquivo “Client Inbound 4.00.msi”:

2. Iniciar o Wizard clicando sobre o botão "Avançar". O sistema apresentará a seguinte tela:

3. Selecionar o caminho para instalação dos programas do Client Inbound, definir quais
usuários devem possuir acesso a este aplicativo, Todos ou Somente eu, e em seguida
clicar sobre o botão "Avançar":
4. Iniciar a Instalação clicando sobre o botão “Avançar”:

402
5. Aguardar a finalização da instalação:
6. E em seguida clicar sobre o botão "Fechar":

404
Configuração
Configuração
Antes de utilizar o Client Inbound do sistema Comply e-Docs é necessário configurar quais
Serviços Web serão utilizados. Dessa forma, para configurar o Client Inbound é necessário seguir
os seguintes passos:

1. Acessar o Client Inbound através do atalho “Client Inbound Comply e-Docs” localizado
na Área de Trabalho do Windows:

2. Clicar sobre o botão “Configurar”:

406
3. Clicar sobre o botão “Adicionar Nova Credencial”. Nomear a Nova Credencial e Clicar
sobre o botão “Salvar”:
 Configurar os campos de acordo com a descrição abaixo e Clicar sobre o botão “Salvar”:
o Usuário: Usuário do Serviço Web;
408
o Senha: Senha do Usuário do Serviço Web;
o CNPJ do Destinatário: CNPJ dos Destinatários relacionados a aquele Serviço Web
Inbound;
o URL Compactação: URL do Serviço Web Inbound se o Serviço usar Compactação;
o URL: URL do Serviço Web Inbound se o Serviço não usar Compactação;
o Habilitar Framework: Informa que o Serviço Web Inbound está usando a
publicação de URL a partir do componente Framework. (Normalmente esta
função não está disponível).
o URL Compactação Framework: URL do Serviço Web Inbound publicada pelo
componente Framework Compactação;
o URL Framework: URL do Serviço Web Inbound publicada pelo componente
Framework Sem Compactação.
Configurar Proxy
1. Clicar sobre o botão “Configurar Proxy”:

2. Acessar Configurações de Proxy, em seguida aparecerá a tela abaixo:

3. Habilitar a opção Utilizar Proxy, conforme indicado;


4. Informar Usuário e Senha;
5. Informar o Host e porta do Proxy.

410
Operação

Transmitir
Para realizar a transmissão de XMLs de Distribuição é necessário seguir os seguintes passos:

1. Acessar o Client Inbound e selecionar Credencial salvar anteriormente:

2. Clicar sobre o botão “Importar nota”:

3. Selecionar os XMLs desejados, no máximo 50 registros, clicar sobre o botão “Abrir”:


4. Com os XMLs carregados, clicar sobre o botão “Transmitir notas”:

5. O processo de transmissão será iniciado. Aguarde o termino da transmissão:

412
6. Será exibida uma mensagem de conclusão de transmissão com sucesso:

ou erro:

Exportar Resultados
Para realizar a exportação dos resultados dos XMLs de Distribuição transmitidos é necessário
seguir os seguintes passos:
1. Clicar sobre o botão “Exportar Resultados”:

2. Selecionar a pasta de destino, nomear o arquivo e clicar sobre o botão “Salvar”:

3. Será exibida uma mensagem sucesso de exportação do arquivo:

414
Importar Resultado
Para realizar a importação de resultados de transmissão anteriores é necessário seguir os
seguintes passos:

1. Clicar sobre o botão “Importar Histórico de Envio”:

2. Selecionar o XML de histórico desejado. Clicar sobre o botão “Abrir”:

3. O resultado será importado:


416
Limpar Grid
Para realizar a limpeza do Grid dos XMLs de Distribuição já transmitidos é necessário seguir o
seguinte passo:

1. Clicar sobre o botão “Limpar”, e a limpeza do Grid será executada:


Modo Texto

Modo Texto
Para realizar a transmissão de XMLs de Distribuição em modo texto é necessário seguir os
seguintes passos:

1. Criar um diretório para inserir XMLs de Distribuição pendentes de envio e que não foram
transmitidos por erro de comunicação. Este exemplo utilizará a pasta
"C:\Inbound_XML\Exporta\" e “C:\Inbound_XML\Erro”;
2. Criar um arquivo texto com extensão .bat (arquivo de linha de comando) na pasta que o
Client Inbound foi instalado. Esta pasta normalmente é encontrada no caminho:
“C:\Program Files\Sonda Procwork\Client Inbound NF-e”. O arquivo .bat deve possuir o
seguinte conteúdo:

"Inbound NF-e" -in "C:\Inbound_XML" "Credencial" -out "C:\Inbound_XML\Exporta" -erro


"C:\Inbound_XML\Erro"

 Inbound NF-e: Nome do programa;


 -in “C:\Inbound_XML: Pasta aonde os XMLs de Distribuição pendentes de envio devem
estar;
 Credencial: Utilizada para realizar o Inbound;
 -out “C:\Inbound_XML\Exporta: Pasta aonde será salvo um relatório de transmissão
(não obrigatório);
 -erro “C:\Inbound_XML\Erro: Pasta aonde os arquivos que apresentaram erros de
transmissão serão armazenados, juntamente com um arquivo de texto com o mesmo
nome do XML que contendo a descrição do erro.

É necessário que o usuário configurado para executar o arquivo .bat tenha acesso aos diretórios
mencionados anteriormente.

3. Criar uma tarefa agendada para a execução do arquivo criado anteriormente. Para isso é
necessário acessar o “Painel de Controle” do Windows. O caminho normalmente é “Iniciar
> Painel de Controle > Tarefas Agendadas”. Em seguida selecione a opção “Adicionar uma
nova tarefa agendada”.

418
4. Inserir as informações solicitadas. É necessário configurar a freqüência do disparo da
tarefa e o programa a ser executado. O programa deve ser o arquivo .bat criado
anteriormente:
5. Concluir o Assistente.

420
Integração e Requisitos Técnicos Comply e-Docs
Introdução
A finalidade deste documento é prover informações sobre os requisitos necessários para a
implementação do sistema Comply e-Docs.

Segue abaixo desenho da solução com arquitetura proposta:

1. Internet: canal de comunicação com a SEFAZ;

2. Firewall: normalmente existente entre a rede interna da empresa e a Internet. É


necessário que estejam liberadas as URLs dos WebServices constantes no manual de
integração da SEFAZ.

3. Comply e-Docs Server: trata-se do servidor no qual são realizados todos os processos de
comunicação com o mundo externo. É nesse servidor que são executados os vários
processos em Batch responsáveis por:

 Extrair a informação do sistema de origem;


 Realizar a pré-validação das informações de negócios contidas na NF-e;
 Priorizar a nota fiscal de acordo com parametrização própria;
 Gerar e assinar o arquivo XML;
 Transmitir o arquivo XML para a SEFAZ;
 Buscar o número do protocolo na SEFAZ;
 Retornar o status da transmissão para o sistema emissor da nota fiscal.

É importante ressaltar que esse servidor não realiza nenhum tipo de comunicação com o cliente,
portanto ele pode estar em uma DMZ fora da rede, desde que tenha comunicação com o banco de
dados.

4. Servidor de aplicação é o serviço que provê ao usuário mecanismos para a consulta,


acompanhamento e interação com as informações que estão sendo processadas pelo
Comply e-Docs Server. Esse serviço realizará a comunicação com os clientes e também
com banco de dados.

5. Servidor de banco de dados 1;

6. Servidor de banco de dados 2. Esse servidor garantirá a alta disponibilidade da aplicação.


Para gerenciamento desse “espelhamento”, deve-se utilizar as ferramentas
disponibilizadas pelos fabricantes dos bancos de dados.

7. Clientes - é a camada que roda no PC do usuário e realiza a comunicação com o servidor


de aplicação. É através dessa camada que o usuário pode visualizar as operações que
estão ocorrendo no Comply e-Docs;

8. Emissores de notas fiscais são os sistemas ERPs responsáveis pela emissão dos documentos
fiscais da empresa. Existe um canal de comunicação entre o Comply e-Docs Server e ERP
para realizar a operação de extração da nota fiscal;

9. São os outros sites da empresa que realizam comunicação com a filial onde está
localizado o servidor do sistema Comply e-Docs. Essa comunicação pode ser feita através
de protocolo TCP/IP ou http.

10. Impressora – meio pelo qual é feita a impressão do DANFE, caso a opção de impressão
seja feita a partir do sistema Comply e-Docs, e não do sistema de origem. Nesse caso,
deve estar liberada a comunicação entre a impressora e o Servidor de aplicação, Comply
e-Docs Server e Clientes.

422
A instalação do sistema Comply e-Docs não requer servidores físicos distintos para serem
executados. Ambos os serviços, Aplicação e Processos, podem estar instalados no mesmo
equipamento, porém a redundância dos equipamentos com dois serviços instalados nos dois
servidores garante ao sistema um balanceamento da carga e maior disponibilidade do serviço,
visto que, caso haja algum defeito no equipamento, o outro se manterá on-line, havendo apenas
uma pequena sobrecarga no serviço. O gerenciamento da alta disponibilidade e o balanceamento
de carga são 100% gerenciados pela aplicação, não havendo a necessidade de nenhum outro
equipamento ou software, como, por exemplo, um cluster.

Introdução – Módulo NFS-e

A finalidade deste documento é prover informações sobre os requisitos necessários para a


implantação do produto NFS-e.

Segue abaixo o desenho da solução com arquitetura proposta:

1. Internet, o canal de comunicação com as prefeituras;


2. Firewall normalmente existente entre a rede interna da empresa e a internet precisa
estar liberado as URL’s dos webservices das prefeituras;
3. Comply e-Docs Server NFS-e, trata-se do serviço onde são realizados todos os processos
de comunicação com o mundo externo. É nesse servidor que são executados vários
processos em Batch responsável por:
 Disponibilizar um webservice de recepção;
 Gerar e assinar o arquivo XML especifica para a prefeitura;
 Realizar a pré-validação das informações de negócios contidas no XML;
 Transmitir o arquivo XML as prefeituras;
 Buscar o número da NFS-e e o código de verificação nas prefeituras;
 Disponibilizar os dados para consulta via webservice;
 Impressão automática das notas;
 Envio de e-mail de XML/PDF.
4. Servidor da Framework é o serviço que prove ao usuário mecanismo para consulta,
acompanhamento e integração com as informações que estão sendo processadas pelo
Comply e-Docs Server NFS-e. Esse serviço que realizará a comunicação com os clientes e
também com o banco de dados;
5. Servidor de banco de dados;
6. Clientes, é a camada que roda no PC do usuário e realiza a comunicação com o Servidor
da Framework, é através dessa camada que o usuário pode visualizar as operações que
estão ocorrendo no NFS-e;
7. Emissores de notas fiscais são os sistemas ERP’s ou módulo NF-e, responsáveis pela
emissão dos documentos fiscais da empresa. Existe um canal de comunicação
(webservice) entre o módulo NFS-e e o ERP/NF-e;
8. São os outros sites da empresa que realizam comunicação com a filial onde está
localizado o servidor do NFS-e. Essa comunicação pode ser feita através de protocolo
TCP/IP ou HTTP;
9. Impressora é onde é feita a impressão da Nota Fiscal caso a opção de impressão seja feita
a partir do NFS-e e não do sistema de origem. Nesse caso, deve estar liberada a
comunicação entre a impressora e o Servidor de aplicação, Comply e-Docs Server e
Clientes.

A instalação do NFS-e, não requer servidores físicos distintos para serem executados, ambos os
serviços, Aplicação e Processos, podem estar instalados no mesmo equipamento, porém, a
redundância dos equipamentos com os serviços instalados nos 2 servidores, garante ao sistema
um balanceamento da carga e maior disponibilidade do serviço, visto que caso haja algum defeito
no equipamento, o outro irá manter-se on-line havendo apenas uma pequena sobrecarga no
serviço.
O gerenciamento da alta disponibilidade e balanceamento de carga são 100% gerenciado pela
aplicação, não havendo a necessidade de nenhum outro equipamento ou software, como por
exemplo, um cluster.

424
Servidor de Banco de Dados
Requisitos:
 Banco de Dados Oracle (versão 10 g ou superior) ou Microsoft SQL Server (versão 2000
com Service Pack 4 ou superior);
 Sistema operacional que atenda aos requisitos do banco de dados requeridos pelo
fabricante para as versões citadas acima;
 Configuração de hardware mínima: um processador e 2GB de memória (pode variar em
função do volume de dados);
 O espaço necessário para armazenamento de dados depende do volume de informações a
serem tratadas pelo produto.

426
Servidor de Aplicação
Requisitos:
 Sistema Operacional Windows 2003 Server ou Superior, 32 ou 64 Bits;
 Microsoft .NET Framework 4.0;
 "Client" do banco de dados definido pelo cliente (Oracle 11g ou SQL Server 2000);
 Configuração de hardware mínima: dois processadores e 4Gb de memória (pode variar em
função do volume de dados);
 Espaço livre em disco para instalação do framework das aplicações da Procwork: 150 MB;
 Microsoft DTC (Coordenador de transações distribuídas) ativado no servidor;
 Somente para impressão através de Cristal Reports: SAP Crystal Report 2010 SP2;
 Somente para impressão através de PDF: Adobe Reader 8 ou superior;
 Somente se houver Sistema de Origem SAP: SAP .Net Connector 3.0.
Portas:
 Servidor de Aplicação: 9500 (Entrada/Saída). (Esta porta pode ser modificada de acordo
com a configuração executada durante o projeto).
 Para o módulo NFS-e o Servidor de Aplicação: 9000(Entrada/Saída).
Desktop do Usuário
Requisitos:
 Sistema Operacional Windows (versão XP Professional ou superior);
 Microsoft .NET Framework 4.0;
 Memória mínima de 256MB;
 Resolução de vídeo de 1024x768 pixels;
 Espaço livre em disco para instalação do runtime framework das aplicações da Procwork:
200 MB;
 Somente para impressão através de Cristal Reports: SAP Crystal Report 2010 SP2;
 Somente para impressão através de PDF: Adobe Reader 8 ou superior.
Portas:
 Servidor de Aplicação: 9500 (Entrada/Saída). (Esta porta pode ser modificada de acordo
com a configuração executada durante o projeto).
 Para o módulo NFS-e o Servidor de Aplicação: 9000(Entrada/Saída).

428
Outros Requisitos do Produto
Informações Sobre os Servidores de Banco de Dados:
 Endereço do Servidor;
 Nome do Banco de Dados;
 Usuário do Banco;
 Senha do Usuário do Banco de Dados.

O usuário de banco de dados deve possuir permissão para executar comandos DDL e DML. É
necessário que o consultor que realize a implantação possua as mesmas permissões DML e DDL
nos ambientes de DEV e QA.

Informações Sobre o Comply e-Docs Server e Servidor de Aplicação:


 Endereço do Servidor;
 Nome do Servidor;
 Usuário/Senha do Servidor (com permissão de Instalação de Produtos, Gerenciamento de
Serviços e Visualização de Eventos do Servidor).

O acesso ao servidor pode ser de modo local ou remoto.

Informações Sobre Impressoras:


 Somente para Impressão em PDF: Suporte a Post-Script.

Todas as impressoras devem dar suporte a Post-Script quando se deseja imprimir em formato
PDF, tanto para impressão automática quanto para a impressão manual executada pelo usuário.
Eventos de NF-e
Evento de NF-e
Um evento de NF-e é um documento adicional que será anexado a uma NF-e existente ou
pendente de autorização de uso. A SEFAZ planeja adicionar outros documentos digitais e associá-
los a NF-e.

O primeiro Evento de segunda geração (NF-e 2G) se chama Carta de Correção Eletrônica.
Acreditamos que o segundo evento a ser utilizado será o Evento de Cancelamento de NF-e.

430
CC-e (Carta de Correção Eletrônica)
A Carta de Correção Eletrônica é um evento para corrigir as informações da NF-e. O autor do
evento é o emissor da NF-e. A mensagem XML do evento será assinada com o certificado digital
que tenha o CNPJ base do Emissor da NF-e.

O evento será utilizado pelo contribuinte e o alcance das alterações permitidas é definido no § 1º
do art. 7º do Ajuste SINIEF S/N, que transcrevemos a seguir:

“Art. 7º Os documentos fiscais referidos nos incisos I a V do artigo anterior deverão ser extraídos
por decalque a carbono ou em papel carbonado, devendo ser preenchidos a máquina ou
manuscritos a tinta ou a lápis-tinta, devendo ainda os seus dizeres e indicações estar bem
legíveis, em todas as vias.

(...)

§ 1º-A Fica permitida a utilização de carta de correção, para regularização de erro ocorrido na
emissão de documento fiscal, desde que o erro não esteja relacionado com:

I - as variáveis que determinam o valor do imposto tais como: base de cálculo, alíquota, diferença
de preço, quantidade, valor da operação ou da prestação;

II - a correção de dados cadastrais que implique mudança do remetente ou do destinatário;

III - a data de emissão ou de saída.”

O registro de uma nova Carta de Correção substitui a Carta de Correção anterior, assim a nova
Carta de Correção deve conter todas as correções a serem consideradas.
Configurações Necessárias
Para estar habilitado a emitir uma Carta de Correção Eletrônica é necessário algumas
configurações no sistema Comply e-Docs.

Cadastro de Novo Processo:

É necessário adicionar um novo processo para o gerenciamento de Evento no Comply e-Docs


Server.

Na transação “Processos” do componente Framework, que pode ser acessada através do


caminho: Painel de Controle > Processos, é possível definir e ativar o novo processo, conforme
abaixo:

Após essa configuração, apenas é necessário reiniciar o componente Comply e-Docs Server que o
sistema Comply e-Docs já estará apto a trabalhar com eventos de NF-e.

432
WebService de Eventos de NF-e:

É necessário adicionar a URL de Eventos de NF-e. Para consultar as URLs disponíveis


recomendamos acessar o portal da NF-e: www.nfe.fazenda.gov.br.

Será necessário adicionar a WebService de integração do NFS-e.

Na transação “WebServices” do componente Framework, que pode ser acessada através do


caminho: Cadastro > WebServices > WebService, adicionar a URL de Eventos de NF-e no campo
Método de Evento, conforme abaixo:
434
436
Gerenciar eventos em sistemas legados (EDI)
Quando a integração é realizada através de sistemas legados EDI é possível enviar e receber
retorno dos eventos criados.

Enviando Eventos:

Para enviar um Evento de NF-e através de Interface EDI é necessário preencher a tabela
NFE_NF_CAPA_EVENTO_EDI. A tabela deve ser preenchida de acordo com o leiaute abaixo:

Clicar na tabela para visualização em tamanho real.

Buscando Resultado do Processamento de Eventos:

Para buscar o resultado de um evento é necessário utilizar a mesma tabela utilizada hoje em dia
para NF-es: a tabela NFE_NF_RET_ORIGEM_EDI. A diferença neste caso é que o campo EVENTO
estará marcado com um “X” informando assim que se trata de uma resposta do Evento de uma
NF-e e não de uma NF-e.

Sempre que ocorre um retorno de Evento as tabelas NFE_NF_RET_ORIGEM_EDI e


NFE_NF_CAPA_EVENTO_EDI serão preenchidas. Isto ocorre porque é possível ao usuário criar um
evento através do componente Framework, mas necessitar que este evento seja enviado ao
sistema de origem.

Abaixo o leiaute da tabela NFE_NF_RET_ORIGEM_EDI. Os campos em negrito são Campos novos:

Clicar na tabela para visualização em tamanho real.


438

Você também pode gostar