PARAMETRIZAÇÃO RECEPTOR NF-E MASTERSAF DF-E

PARAMETRIZAÇÃO RECEPTOR NF-E MASTERSAF DF-E

SUMÁRIO Login... 1 Troca de senha... 1 Administração do Sistema...2 Certificados...2 Usuários...3 Dados do Usuário... 4 Permissões do Usuário... 4 Empresas...5 Parâmetro Manifestação do Destinatário no Cadastro de Empresa/Receptor NF-e... 7 Extrator de E-mail...8 Integração com Receptor... 8 Configurações Gerais... 9 Configurações de Contas...10 Módulo Integrador... 12 Tipos de Eventos...14 Formato de nomenclatura dos arquivos de retorno...14

LOGIN Com o portal iniciado, vamos iniciar o navegador de internet com o seguinte link http://localhost:8080/portal/mvc/login (onde localhost deve ser o servidor onde a aplicação está hospedada). TROCA DE SENHA Na parte superior do site, conforme figura abaixo, são apresentadas as seguintes opções: Mastersaf >> Trocar senha: permite a alteração da senha; Logout:Sair do sistema; Opções na parte superior 1

ADMINISTRAÇÃO DO SISTEMA O link Administração do Sistema leva à tela com as funções administrativas. Administração do Sistema CERTIFICADOS Nessa opção cadastra-se o certificado da(s) empresa(s). Selecionar o arquivo do certificado, digitar a senha e clicar em Cadastrar. Observar também se o mesmo poderá ser vinculado às filiais, de acordo regras de cada município. Em caso afirmativo, a opção Aplicar para matriz e filiais pode ser marcada; Atualização do certificado 2

USUÁRIOS Na opção Usuários, são apresentados todos os usuários cadastrados no sistema. Para efetuar uma busca, utilizar a opção Filtrar Resultado. Itens dessa tela: Cadastrar novo usuário ( ); Filtrar Resultado ( ); Indicador de usuário habilitado. Clicar para desabilitar ( ); Indicador de usuário desabilitado. Clicar para habilitar ( ); Para Editar dados do Usuário ( ); E o módulo mensageria fica responsável pela comunicação com a SEFAZ para fazer a consulta da chave do CT-e. Tela de listagem de usuários Para cadastrar um novo usuário, clicar em Cadastrar. Na tela que se abre, preencher os campos solicitados. 3

Cadastro de usuário DADOS DO USUÁRIO Login: preencher com o login do novo usuário; Seu Nome: preencher com o nome do novo usuário; Email: email do novo usuário; Data de Expiração: data na qual expira o usuário sendo criado; Status: se o usuário será incluído com o status habilitado ou desabilitado; Grupo Empresa: grupo de empresas ao qual o usuário faz parte; PERMISSÕES DO USUÁRIO Aqui são selecionadas as permissões que o novo usuário receberá. Caso o usuário sendo criado seja um usuário para ser utilizado no Integrador, selecionar permissão de integração (NFSE Integrador). Filtro: através do filtro de pesquisa pode-se buscar por usuário através de uma parte de seu login/nome. 4

Tela de listagem de usuários EMPRESAS Os seguintes dados são solicitados no cadastramento de uma nova empresa: CNPJ: CNPJ da nova empresa; Razão Social: razão social da nova empresa; Inscrição Estadual: Para nota Mercantil / CT-e esse campo será Obrigatório; Inscrição Municipal: Para nota de Serviço esse campo será Obrigatório; Email Administrador: email do administrador da nova empresa; Grupo Empresa: grupo de empresas ao qual a nova empresa faz parte; Estado e cidade; Status: indica se a empresa está habilitada ou não; Parâmetro de Fuso Horário: O sistema adota por padrão a hora local do Servidor, caso o servidor não esteja no mesmo fuso onde serão emitidos os documentos fiscais é possível fazer o ajuste para mais ou menos horas de acordo com a hora do servidor. Logotipo: logo da nova empresa (selecionar a imagem); Parâmetros específicos: parâmetros dos módulos de NFS, NFE e CTE; Os campos de preenchimentos obrigatórios estão sinalizados com um asterisco. OBS: no caso de instalação in house, será solicitado o arquivo XML de licenciamento no cadastramento de uma nova empresa. 5

Dados da empresa Assim como na tela de usuários, uma empresa pode ser desabilitada ou habilitada. Para isso clicar no ícone ou. Através da opção Filtrar Resultado pode-se buscar por uma empresa através de seu CNPJ/Razão Social. Listagem de empresas 6

PARÂMETRO MANIFESTAÇÃO DO DESTINATÁRIO NO CADASTRO DE EMPRESA/RECEPTOR NF-E Consulta de NF-e Destinatário Não Consulta: Esse parâmetro indica se será utilizado ou não a Manifestação do Destinatário Todos Emitentes/ Remetentes: Indica que será utilizada a manifestação e todas as notas emitidas serão exibidas no Grid de Notas recebidas NF-e emitidas por emissores diferentes: esse parâmetro indica que será utilizado a manifestação e que apenas as notas diferentes do CNPJ do cadastro da empresa as notas serão exibidas. Ciência da operação Consulta e XML: Após a consulta e o recebimento do XML, o sistema faz a ciência da operação automaticamente Consulta: Após a consulta o sistema faz a ciência da operação automaticamente Não: Não será feita a Ciência Automática Confirmação Automática no recebimento do DANFE Sim / Não Se o parâmetro estiver marcado como sim, ao fazer a leitura do DANFE na tela de semáforo o sistema automaticamente registra o evento de Confirmação da operação. A confirmação pode ocorrer também ao solicitar Download XML Sefaz manualmente. Ao finalizar o Download o sistema verificará se o DANFE já foi recebido e então o sistema automaticamente registra o evento de Confirmação da operação. Envio de e-mail automático de notas pendentes Sim/ Não Se o parâmetro estiver marcado como sim, após 7 dias da consulta da nota sem nenhum registro de eventos o sistema envia automaticamente o e-mail de alerta para o administrados da empresa com as notas pendentes de manifestação do Destinatário. Indicador de NF-e consultada Todas NF-e: Todas as NF-e s Somente NF-e sem manifestação: 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); Somente NF-e sem manifestação e ciência da Operação: Idem anterior, incluindo as NF-e que também não tiveram a Ciência da Operação. Download XML 7

Sim/ Não Se o parâmetro estiver marcado como sim: Ao receber um xml inválido (erro na assinatura) o sistema irá realizar o download do xml original na SEFAZ e atualizar o status da nota (Obs: Isso só é válido para notas que tenham recebido ciência, caso contrário a nota mantém status de Xml Inválido). Ao chegar o DANFE (normal), caso a nota já esteja no grid de notas recebidas através da consulta, o sistema irá fazer o download do xml original na SEFAZ e atualizar o status da nota, caso este (XML) não exista na base ou esteja inválido. EXTRATOR DE E-MAIL O módulo extrator é responsável por baixar os e-mails da caixa de entrada de uma conta especificada para o recebimento de XML do NF-e, salvando os mesmos em pastas pré-configurada pelo usuário. Para iniciar o extrator deve-se abrir um terminal de comandos, acessar o diretório onde o arquivo extrator.jar foi descompactado e digitar uma das seguintes linhas de comando: (a) java -jar extrator.jar (inicia o extrator sem o modo de configuração de dados) (b) java -jar extrator.jar --configurar (inicia o extrator com o modo de configuração de dados). Caso a opção (b) tenha sido a escolhida, ou o extrator foi iniciado pela primeira vez, uma tela irá aparecer onde o usuário irá configurar os dados das contas de e-mail onde este deseja que o extrator pegue os arquivos para a importação do módulo de Recebimento. INTEGRAÇÃO COM RECEPTOR A integração do extrator com o módulo extrator com o receptor de NF-e se dá quando o extrator busca nas contas de e-mail configuradas, os XML processados e os coloca na pasta de entrada/envio do receptor. 8

CONFIGURAÇÕES GERAIS A aba Geral possui os dados que serão compartilhados por todas as contas de e-mail que o usuário irá configurar: Campo Utilização Tam. máximo e-mail Limita o tamanho máximo que um e-mail pode ter para ser salvo, no exemplo se algum e- mail ultrapassar 1024Kb, este será ignorado. Caso deseja-se que todos os e-mails sejam salvos sem se preocupar com limites de tamanho o valor zero deve ser informado. Tam. máximo anexo Extensões anexos Limita o tamanho máximo que os anexos do e-mail podem ter, no exemplo se algum anexo ultrapassar os 256Kb, o e-mail será ignorado. Caso deseja-se que todos os anexos sejam salvos sem se preocupar com limites de tamanho o valor zero deve ser informado. Informado extensões exclusivas do extrator. Ao adicionar novas extensões nessa lista, o extrator irá salvar um arquivo caso o anexo tenha a extensão presente na lista. Caso não seja informada nenhuma extensão o extrator irá salvar todos os anexos do e-mail em que houver xml. Adicionam-se novas extensões clicando no botão + presente no lado da lista de extensões, e remove-se selecionando a extensão desejada e clicando no botão -. Pasta log Tam. máximo log Total arquivos log Nível log Total de threads Proxy URL Proxy porta Proxy usuário Proxy senha Determina onde os arquivos de log do extrator serão salvos. Utilizar o botão... para localizar o local desejado. Tamanho máximo que um arquivo de log possuirá. Quantidade máxima de arquivos de log que serão salvos por vez, quando o limite é alcançado os arquivos mais antigos são sobrescritos. Caso deseja-se ter uma quantidade indeterminada de arquivos log, o valor zero deve ser informado. Nível de detalhamento do que o extrator está fazendo, aonde INFO é o que possui menos detalhes e TRACE o que possui mais. INFO: descreve informações de execução da aplicação; WARN: informa situações que devem ser averiguadas para não ocorrer erros; ERROR: descreve situações onde erros ocorrem que ainda permitem a execução do sistema; FATAL: descrevem situações aonde os erros irão levar o sistema a parar de funcionar; DEBUG: informa a execução do sistema de uma forma mais detalhada para averiguar erros e melhorias; TRACE: detalha de uma forma mais meticulosa cada parte da execução do sistema. Total de serviços simultâneos que irá comunicar-se com as contas de e-mail e extrair os mesmos. URL do servidor de proxy, deixar em branco se nenhum servidor de proxy é utilizado. Ao utilizar proxy recomenda-se utilizar do tipo socket5 (proxy de soquete). Porta do servidor de proxy, deixar em branco se nenhum servidor de proxy é utilizado. Usuário do servidor de proxy, deixar em branco se nenhum servidor de proxy é utilizado. Senha do servidor de proxy, deixar em branco se nenhum servidor de proxy é utilizado. 9

CONFIGURAÇÕES DE CONTAS A aba Contas possui os dados que serão utilizados para a conexão com os servidores de e-mails e suas devidas contas: 10

Contas Campo Utilização Lista dos servidores de e-mails cadastrados, caso deseja-se modificar algum dado de um dos servidores, este deve ser selecionado primeiramente nesse campo. Para adicionar um servidor novo utiliza-se o botão + ao lado do campo e, para remover uma conta, deve-se selecioná-la e clicar no botão -. Servidor Conexão segura Protocolo Porta Campo que permite a alteração do nome do servidor. Marcar este campo se o servidor utilizar SSL. Selecionar qual protocolo que o servidor utiliza (POP3 ou IMAP). Porta de conexão do servidor. E-mails Lista de contas de e-mails do servidor selecionado. Para adicionar uma conta de e- mail utiliza-se o botão + ao lado deste campo e, para remover alguma conta de e- mail, deve-se selecioná-la e clicar no botão -. Habilitada Usuário Senha Caixa Pasta XML Pasta outros anexos Indica se a conta de e-mail deve ser lida e tiver seus e-mails processados pelo extrator. Campo que permite alterar o nome da conta de e-mail que o usuário usa para conectar-se ao servidor. Senha da conta de e-mail. Caixa de e-mails que deve ser verificada pelo extrator. Por padrão utiliza-se Inbox. Determina onde os arquivos de XML serão salvos. Utilizar o botão... para localizar o local desejado. Todos os arquivos XML serão salvos nessa pasta, caberá ao receptor decidir se o XML é válido e importa-lo para o software. Determina onde os outros arquivos que foram adicionados na lista de extensões de anexo serão salvos. Utilizar o botão... para localizar o local desejado. Pasta outros (sem XML) Determina onde os e-mails que não possuem relação com XML serão salvos (esses serão salvos com a extensão eml ). Utilizar o botão... para localizar o local desejado. Após configurado e salvo os dados, o usuário pode fechar a janela e executar o comando java -jar extrator.jar, fazendo com que o extrator inicie a comunicação com as contas de e-mails configuradas anteriormente. 11

MÓDULO INTEGRADOR O módulo Integrador é responsável pela integração dos NF-e com o portal do Mastersaf DF-e. A forma de integração disponível: Integração TXT: nesse modo de integração arquivos contendo os documentos a serem enviados ao portal são gravados em uma pasta/diretório. Após a integração e processamento, o produto gravará o retorno/resultado em outra pasta; (consultar o portal http://docs.dfe.mastersaf.com.br para obter os layouts) Sua configuração se dá através do arquivo integrador.properties, cujos principais parâmetros são: Pastas para o Receptor NF-e: aqui se define a localização para cada uma das pastas de integração: Envio: Esta pasta é o local que deverão ser colocados todos os XML que se deseja importar para o sistema (parâmetro pasta_recebimento_envio); Retorno: Esta pasta é o local que ir á manter todos os XML de carta de correção importados para o sistema (parâmetro pasta_recebimento_retorno); Importado: Pasta que irá conter todos os XML importados corretamente que não forem de cancelamento (parâmetro pasta_recebimento_importado); importado_cancelamento: Pasta que irá conter todos os XML importados corretamente que forem do tipo cancelamento (parâmetro pasta_recebimento_importado_canc); importado_ocorrencia: Esta pasta é o local que irá manter todos os XML de carta de correção importados para o sistema (parâmetro pasta_recebimento_importado_ocor); Erro: Local onde os XML serão movidos quando estes tiverem algum erro na importação (parâmetro pasta_recebimento_erro); url_webservice: endereço do WebService para a integração; portal_username: usuário do portal com permissão para integração; portal_password: senha do usuário do portal para integração; modulos: esse parâmetro indica quais módulos o integrador irá trabalhar poder ser: fs,recptor_nfs, nfe e cte, recebimento; modo_operacional_manual: se esse parâmetro estiver como true, uma tela do integrador será exibida ao iniciar. Esse modo é utilizado na fase de testes de layout, pois nessa tela é possível colar o conteúdo de um arquivo e enviá-lo ao portal; Verificar se o ambiente necessita de Proxy para comunicação com o portal. Caso seja necessário, configurar os parâmetros: proxy_url proxy_port proxy_username proxy_password 12

Exemplo do arquivo integrador.properties Tela do módulo de operação manual 13

Caso a integração não esteja ocorrendo, verificar: 1. Se os testes de comunicação passaram (visualizar em log/integrador.log); 2. Se as credenciais do usuário do portal estão configuradas corretamente no arquivo integrador.properties (portal_username, portal_password) e se esse usuário possui permissão de integração NFSE no portal. TIPOS DE EVENTOS Os arquivos de retorno podem conter os seguintes tipos de eventos FORMATO DE NOMENCLATURA DOS ARQUIVOS DE RETORNO Para a geração do nome do arquivo de retorno a estrutura proposta consiste em: <chave de acesso>_<cnpj da empresa>_<codigo do evento> Exemplo: 12345678901234567890123456789012345678901234_12345678901234_1.txt ou 12345678901234567890123456789012345678901234_12345678901234_1.xml 14