PARAMETRIZAO RECEPTOR CT-E

MASTERSAF DF-E

MASTERSAF DF-E

PARAMETRIZAO DO RECEPTOR CT-E

NDICE
Login ....................................................................................................................................................................... 1
Troca de senha ........................................................................................................................................................ 1
Administrao do Sistema.......................................................................................................................................2
Certificados .............................................................................................................................................................2
Usurios .................................................................................................................................................................. 3
Dados do Usurio .................................................................................................................................................................................. 4
Permisses do Usurio .......................................................................................................................................................................... 4

Empresas.................................................................................................................................................................5
Extrator de E-mail.................................................................................................................................................... 7
Integrao com Receptor ...................................................................................................................................................................... 7
Configuraes Gerais............................................................................................................................................................................. 8
Configuraes de Contas....................................................................................................................................................................... 9

Mdulo Integrador.................................................................................................................................................. 11
Tipos de Eventos ................................................................................................................................................................................... 13
Formato de nomenclatura dos arquivos de retorno: ........................................................................................................................... 13

Publicado em 21/12/2012

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

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 aplicao est hospedada).

TROCA DE SENHA
Na parte superior do site, conforme figura abaixo, so apresentadas as seguintes opes:
Mastersaf >> Trocar senha: permite a alterao da senha;
Logout:Sair do sistema;

Opes na parte superior

Publicado em 21/12/2012

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

ADMINISTRAO DO SISTEMA
O link Administrao do Sistema leva tela com as funes administrativas.

Administrao do Sistema

CERTIFICADOS
Nessa opo cadastra-se o certificado da(s) empresa(s). Selecionar o arquivo do certificado, digitar a senha e clicar em
Cadastrar. Observar tambm se o mesmo poder ser vinculado s filiais, de acordo regras de cada municpio. Em caso
afirmativo, a opo Aplicar para matriz e filiais pode ser marcada;

Atualizao do certificado

Publicado em 21/12/2012

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

USURIOS
Na opo Usurios, so apresentados todos os usurios cadastrados no sistema. Para efetuar uma busca, utilizar a opo Filtrar
Resultado. Itens dessa tela:

Cadastrar novo usurio (

);

Filtrar Resultado (

Indicador de usurio habilitado. Clicar para desabilitar (

);

Indicador de usurio desabilitado. Clicar para habilitar (

);

Para Editar dados do Usurio (

);

);

E o mdulo mensageria fica responsvel pela comunicao com a SEFAZ para fazer a consulta da chave do CT-e.

Tela de listagem de usurios

Para cadastrar um novo usurio, clicar em Cadastrar. Na tela que se abre, preencher os campos solicitados.

Publicado em 21/12/2012

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

Cadastro de usurio

DADOS DO USURIO

Login: preencher com o login do novo usurio;

Seu Nome: preencher com o nome do novo usurio;

Email: email do novo usurio;

Data de Expirao: data na qual expira o usurio sendo criado;

Status: se o usurio ser includo com o status habilitado ou desabilitado;

Grupo Empresa: grupo de empresas ao qual o usurio faz parte;

PERMISSES DO USURIO
Aqui so selecionadas as permisses que o novo usurio receber. Caso o usurio sendo criado seja um usurio para ser utilizado no
Integrador, selecionar permisso de integrao (NFSE Integrador).
Filtro: atravs do filtro de pesquisa pode-se buscar por usurio atravs de uma parte de seu login/nome.

Publicado em 21/12/2012

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

Tela de listagem de usurios

EMPRESAS
Os seguintes dados so solicitados no cadastramento de uma nova empresa:

CNPJ: CNPJ da nova empresa;

Razo Social: razo social da nova empresa;

Inscrio Estadual: Para nota Mercantil / CT-e esse campo ser Obrigatrio;

Inscrio Municipal: Para nota de Servio esse campo ser Obrigatrio;

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 no;

Parmetro de Fuso Horrio: O sistema adota por padro a hora local do Servidor, caso o servidor no esteja no mesmo
fuso onde sero emitidos os documentos fiscais possvel fazer o ajuste para mais ou menos horas de acordo com a hora
do servidor.

Logotipo: logo da nova empresa (selecionar a imagem);

Parmetros especficos: parmetros dos mdulos de NFS, NFE e CTE;

Os campos de preenchimentos obrigatrios esto sinalizados com um asterisco.

OBS: no caso de instalao in house, ser solicitado o arquivo XML de licenciamento no cadastramento de uma
nova empresa.

Publicado em 21/12/2012

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

Dados da empresa

Assim como na tela de usurios, uma empresa pode ser desabilitada ou habilitada. Para isso clicar no cone
Atravs da opo Filtrar Resultado pode-se buscar por uma empresa atravs de seu CNPJ/Razo Social.

Listagem de empresas

Publicado em 21/12/2012

ou

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

EXTRATOR DE E-MAIL
O mdulo extrator responsvel por baixar os e-mails da caixa de entrada de uma conta especificada para o recebimento de XML
do CT-e, salvando os mesmos em pastas pr-configurada pelo usurio.
Para iniciar o extrator deve-se abrir um terminal de comandos, acessar o diretrio 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 configurao de dados)
(b) java -jar extrator.jar --configurar (inicia o extrator com o modo de configurao de dados).
Caso a opo (b) tenha sido a escolhida, ou o extrator foi iniciado pela primeira vez, uma tela ir aparecer onde o usurio ir configurar
os dados das contas de e-mail onde este deseja que o extrator pegue os arquivos para a importao do mdulo de Recebimento.

INTEGRAO COM RECEPTOR

A integrao do extrator com o mdulo extrator com o receptor de CT-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.

Publicado em 21/12/2012

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

CONFIGURAES GERAIS
A aba Geral possui os dados que sero compartilhados por todas as contas de e-mail que o usurio ir configurar:
Campo

Utilizao

Tam. mximo e-mail Limita o tamanho mximo que um e-mail pode ter para ser salvo, no exemplo se algum email 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. mximo anexo

Limita o tamanho mximo 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.

Extenses anexos

Informado extenses exclusivas do extrator. Ao adicionar novas extenses nessa lista, o

extrator ir salvar um arquivo caso o anexo tenha a extenso presente na lista. Caso no
seja informada nenhuma extenso o extrator ir salvar todos os anexos do e-mail em que
houver xml. Adicionam-se novas extenses clicando no boto + presente no lado da lista
de extenses, e remove-se selecionando a extenso desejada e clicando no boto -.

Pasta log

Determina onde os arquivos de log do extrator sero salvos. Utilizar o boto ... para localizar o local desejado.

Tam. mximo log

Tamanho mximo que um arquivo de log possuir.

Total arquivos log

Quantidade mxima de arquivos de log que sero salvos por vez, quando o limite alcanado os arquivos mais antigos so sobrescritos. Caso deseja-se ter uma quantidade indeterminada de arquivos log, o valor zero deve ser informado.

Nvel log

Nvel de detalhamento do que o extrator est fazendo, aonde INFO o que possui menos
detalhes e TRACE o que possui mais.
INFO: descreve informaes de execuo da aplicao;
WARN: informa situaes que devem ser averiguadas para no ocorrer erros; ERROR: descreve situaes onde erros ocorrem que ainda permitem a execuo do sistema;
FATAL: descrevem situaes aonde os erros iro levar o sistema a parar de funcionar;
DEBUG: informa a execuo do sistema de uma forma mais detalhada para averiguar erros
e melhorias;
TRACE: detalha de uma forma mais meticulosa cada parte da execuo do sistema.

Total de threads

Total de servios simultneos que ir comunicar-se com as contas de e-mail e extrair os

mesmos.

Proxy URL

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).

Proxy porta

Porta do servidor de proxy, deixar em branco se nenhum servidor de proxy utilizado.

Proxy usurio

Usurio do servidor de proxy, deixar em branco se nenhum servidor de proxy utilizado.

Proxy senha

Senha do servidor de proxy, deixar em branco se nenhum servidor de proxy utilizado.

Publicado em 21/12/2012

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

CONFIGURAES DE CONTAS
A aba Contas possui os dados que sero utilizados para a conexo com os servidores de e-mails e suas devidas contas:

Publicado em 21/12/2012

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

Campo

Utilizao

Contas

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 boto + ao lado do campo e, para remover uma conta, deve-se selecion-la e clicar no boto -.

Servidor

Campo que permite a alterao do nome do servidor.

Conexo segura

Marcar este campo se o servidor utilizar SSL.

Protocolo

Selecionar qual protocolo que o servidor utiliza (POP3 ou IMAP).

Porta

Porta de conexo do servidor.

E-mails

Lista de contas de e-mails do servidor selecionado. Para adicionar uma conta de email utiliza-se o boto + ao lado deste campo e, para remover alguma conta de email, deve-se selecion-la e clicar no boto -.

Habilitada

Indica se a conta de e-mail deve ser lida e tiver seus e-mails processados pelo extrator.

Usurio

Campo que permite alterar o nome da conta de e-mail que o usurio usa para
conectar-se ao servidor.

Senha

Senha da conta de e-mail.

Caixa

Caixa de e-mails que deve ser verificada pelo extrator. Por padro utiliza-se Inbox.

Pasta XML

Determina onde os arquivos de XML sero salvos. Utilizar o boto ... para localizar
o local desejado. Todos os arquivos XML sero salvos nessa pasta, caber ao receptor decidir se o XML vlido e importa-lo para o software.

Pasta outros anexos

Determina onde os outros arquivos que foram adicionados na lista de extenses de

anexo sero salvos. Utilizar o boto ... para localizar o local desejado.

Pasta outros (sem XML) Determina onde os e-mails que no possuem relao com XML sero salvos (esses
sero salvos com a extenso eml). Utilizar o boto ... para localizar o local desejado.
Aps configurado e salvo os dados, o usurio pode fechar a janela e executar o comando java -jar extrator.jar, fazendo com que o
extrator inicie a comunicao com as contas de e-mails configuradas anteriormente.

Publicado em 21/12/2012

10

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

MDULO INTEGRADOR
O mdulo Integrador responsvel pela integrao dos CT-e com o portal do Mastersaf DF-e. A forma de integrao disponvel:

Integrao TXT: nesse modo de integrao arquivos contendo os documentos a serem enviados ao portal so gravados
em uma pasta/diretrio. Aps a integrao 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 configurao se d atravs do arquivo integrador.properties, cujos principais parmetros so:

Pastas para Receptor CT-e: aqui se define a localizao para cada uma das pastas de integrao:
Envio: Esta pasta o local que devero ser colocados todos os XML que se deseja importar para o sistema (parmetro
pasta_recebimento_envio);
Retorno: Esta pasta o local que ir manter todos os XML de carta de correo importados para o sistema (parmetro pasta_recebimento_retorno);
Importado: Pasta que ir conter todos os XML importados corretamente que no forem de cancelamento (parmetro
pasta_recebimento_importado);
importado_cancelamento: Pasta que ir conter todos os XML importados corretamente que forem do tipo cancelamento (parmetro pasta_recebimento_importado_canc);
importado_Ocorrencia: Esta pasta o local que ir manter todos os XML de carta de correo importados para o
sistema (parmetro pasta_recebimento_importado_ocor);
Erro: Local onde os XML sero movidos quando estes tiverem algum erro na importao (parmetro
pasta_recebimento_erro);

url_webservice: endereo do WebService para a integrao;

portal_username: usurio do portal com permisso para integrao;

portal_password: senha do usurio do portal para integrao;

modulos: esse parmetro indica quais mdulos o integrador ir trabalhar poder ser: fs,recptor_nfs, nfe e cte, recebimento;

modo_operacional_manual: se esse parmetro estiver como true, uma tela do integrador ser exibida ao iniciar. Esse
modo utilizado na fase de testes de layout, pois nessa tela possvel colar o contedo de um arquivo e envi-lo ao portal;

Verificar se o ambiente necessita de Proxy para comunicao com o portal. Caso seja necessrio, configurar os parmetros:
proxy_url
proxy_port
proxy_username
proxy_password

Publicado em 21/12/2012

11

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E

Exemplo do arquivo integrador.properties

Tela do mdulo de operao manual

Publicado em 21/12/2012

12

PARAMETRIZAO DO RECEPTOR CT-E

MASTERSAF DF-E
Caso a integrao no esteja ocorrendo, verificar:
1.

Se os testes de comunicao passaram (visualizar em log/integrador.log);

2.

Se as credenciais do usurio do portal esto configuradas corretamente no arquivo integrador.properties

(portal_username, portal_password) e se esse usurio possui permisso de integrao 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 gerao 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

Publicado em 21/12/2012

13