MANUAL OPERACIONAL
MÓDULO INTEGRADOR
ONESOURCE™ ECF MANUAL OPERACIONAL
Versão: 3.56.2 Publicado em 05/12/2017
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
SUMÁRIO
INTRODUÇÃO.......................................................................................................................................... 1
FORMAS DE INTEGRAÇÃO .................................................................................................................. 1
INTEGRAÇÃO TXT / XML .................................................................................................................. 1
INTEGRAÇÃO WEB SERVICE ............................................................................................................ 1
ARQUIVO INTEGRADOR.PROPERTIES .................................................................................................. 2
PARÂMETROS GERAIS ....................................................................................................................... 2
PARÂMETROS DE IMPRESSÃO ....................................................................................................... 5
CONEXÃO COM O MÓDULO PRINTER ............................................................................................... 5
PROXY PARA PRINTER ................................................................................................................... 5
CONEXÃO COM WEBSERVICE DFE .................................................................................................... 6
PROXY PARA WEB SERVICE DFE .................................................................................................... 6
PARÂMETROS PARA DEFINIÇÃO DE PASTAS .................................................................................... 7
PASTAS PARA O MÓDULO NFS-E.................................................................................................... 7
PASTAS PARA O MÓDULO RECEPTOR NFS-E ............................................................................... 8
PASTAS PARA O MÓDULO NF-E ..................................................................................................... 9
PASTAS PARA O MÓDULO RECEPTOR NF-E ................................................................................ 10
PASTAS PARA XML LEGADO NF-E ................................................................................................ 12
PASTAS PARA O MÓDULO CT-E .................................................................................................... 12
PASTAS PARA O MÓDULO MDF-E ................................................................................................. 13
PASTAS PARA O MÓDULO RECEPTOR CT-E ................................................................................. 14
PASTAS PARA O MÓDULO NFC-E ................................................................................................. 15
PASTAS PARA ARQUIVOS NÃO IMPORTADOS ............................................................................. 16
HIERARQUIA DE PASTAS .................................................................................................................. 16
PARÂMETROS DE ARQUIVOS ........................................................................................................... 18
NOMENCLATURA DE ARQUIVOS................................................................................................... 18
TIPOS DE ARQUIVOS DE ENVIO E RETORNO ................................................................................ 19
TIPOS DE ARQUIVOS DE RETORNOS DE RECEBIMENTO ............................................................ 20
CONFIGURAÇÃO DE LOG .................................................................................................................. 21
CONTINGÊNCIA OFFLINE ................................................................................................................. 22
CONTINGÊNCIA OFFLINE NF-E ..................................................................................................... 22
CONTINGÊNCIA OFFLINE CT-E ......................................................................................................23
ONESOURCE™ ECF MANUAL OPERACIONAL
Versão: 3.56.2 Publicado em 05/12/2017
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
CONTINGÊNCIA OFFLINE NFS-E ....................................................................................................23
PROCESSAMENTO POR SÉRIE ......................................................................................................... 24
BACKUP DE PASTAS DO INTEGRADOR ........................................................................................... 24
SUPORTE TÉCNICO .............................................................................................................................. 25
ONESOURCE™ ECF MANUAL OPERACIONAL
1
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
INTRODUÇÃO
O módulo Integrador é responsável pela integração de documentos com o MASTERSAF DFE. Os
documentos integrados são tanto arquivos para emissão de documentos quanto arquivos processados
para os módulos receptores.
Sua configuração se dá através do arquivo integrador.properties, cujos parâmetros serão
apresentados a seguir.
FORMAS DE INTEGRAÇÃO
INTEGRAÇÃO TXT / XML
Nesse modo de integração o sistema do cliente é responsável por gerar arquivos em formato TXT ou
XML e gravar na pasta de entrada, de acordo com o layout de cada módulo. Após a integração e o
processamento, o produto grava o retorno em outra pasta.
Os arquivos serão compostos conforme definido no(s) layout (s) TXT/XML de cada módulo.
INTEGRAÇÃO WEB SERVICE
Neste modo os documentos são enviados diretamente ao Web Service do MASTERSAF DFE.
Para mais informações, vide manual de Integração WebService.
ONESOURCE™ ECF MANUAL OPERACIONAL
2
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
ARQUIVO INTEGRADOR.PROPERTIES
Neste arquivo estão disponíveis os parâmetros de configuração do Integrador V3.
PARÂMETROS GERAIS
modulos: Informar os módulos a serem habilitados no Integrador. Para habilitar mais de um módulo,
informá-los separados por vírgulas. Valores permitidos:
• nfs: Habilita o processamento de documentos do módulo NFS-e;
• nfe: Habilita o processamento de documentos do módulo NF-e;
• cte: Habilita o processamento de documentos do módulo CT-e;
• mdfe: Habilita o processamento de documentos do módulo MDF-e;
• nfce: Habilita o processamento de documentos do módulo NFC-e;
• receptor_nfs: Habilita o processamento de documentos do módulo Receptor NFS-e;
• recebimentoNfe: Habilita o processamento de documentos do módulo Receptor NF-e;
• recebimento: Habilita o processamento de documentos do módulo Receptor CT-e;
• manifestacaoNfe: Habilita o processamento de documentos de manifestação do módulo
Receptor NF-e;
• xmlLegadoNfe: Habilita o processamento de documentos de Legado para o módulo NF-e.
modo_operacao_manual: Definir se a integração dos arquivos será feita manualmente pela interface
gráfica do integrador. Valores permitidos:
• false: Desabilita o modo “operação manual”; (Valor padrão);
ONESOURCE™ ECF MANUAL OPERACIONAL
3
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
• true: Habilita o modo “operação manual”. Quando definido com esta opção, uma tela do
integrador é exibida ao iniciar o serviço. Esse modo é utilizado na fase de testes de layout,
pois nesta tela é possível colar o conteúdo de um arquivo e enviá-lo ao DFE.
operacoes_integrador: Indicar quais as operações o Integrador deve realizar. Quando não
preenchido, o integrador realiza todas as operações. Este parâmetro é utilizado para os módulos
NF-e, NFS-e, CT-e e MDF-e. Valores permitidos:
• enviar: Habilita apenas a função de envio de documentos;
• gerar_retorno: Habilita apenas a função de geração de retornos de documentos;
• imprimir: Habilita apenas a comunicação com o Printer.
tempo_ocioso: Indicar o tempo de espera em milissegundos para que cada arquivo seja gravado por
completo nas pastas de entrada. Se o tempo de gravação do arquivo superar este valor, o arquivo será
considerado como inválido e será movido para a pasta de erro. Valor mínimo de 30000
milissegundos. Valor padrão: 30000.
qtd_thread_envio: Indicar a quantidade de threads para envio de arquivos para o web service do DFE.
Valor padrão: “10”.
tempo_consulta: Indicar o intervalo de tempo em milissegundos entre as consultas. Valor mínimo de
1000 milissegundos. Valor padrão: 30000.
tempo_publicador: Indicar o intervalo de tempo em milissegundos entre as publicações. Valor
mínimo de 1000 milissegundos. Valor padrão: 30000.
qtd_results_consulta: Indicar a quantidade de processamentos que serão solicitados na execução do
método de consulta de retorno para os módulos NFS-e, NF-e e CT-e. Caso não seja preenchido, este
parâmetro será ignorado e será considerada a quantidade padrão de 50 resultados.
qtd_rps_por_envio: Indicar a quantidade máxima de RPS a serem enviados em uma requisição ao
Web Service do DFE. Quando não preenchido, todos os RPSs do arquivo serão enviados em uma única
vez.
ONESOURCE™ ECF MANUAL OPERACIONAL
4
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
modo_envio_documentos_cte: Indicar se o envio de CT-e pelo integrador ao Web Service será
sequencial (Ordenado) ou paralelo. Valores permitidos:
• sequencial;
• paralelo. (Valor padrão)
retornar_em_lote: Indicar se os retornos dos módulos NFS-e e Receptor NFS-e serão gravados em
um único arquivo. O preenchimento deste campo é obrigatório.
• false: Desabilita a gravação dos arquivos em lote; (Valor padrão)
• true: Habilita a gravação dos arquivos em lote.
retornar_em_lote_agrupador: Indicar se o retorno agrupado em lote deve agrupar os documentos
por empresa. É utilizado pelo sistema apenas se o parâmetro retornar_em_lote estiver definido como
true. Este parâmetro não consta no arquivo integrador.properties padrão, porém pode ser adicionado
manualmente no arquivo.
• vazio: Mantém agrupamento de retorno padrão do lote; (Valor padrão)
• empresa: Agrupará o lote por CNPJ e Inscrição do Prestador.
forcar_leitura_utf8: Indicar se deverá ser forçada a leitura de arquivos com encoding UTF8 pelo
integrador.
• false: Desabilita a leitura forçada; (Valor Padrão)
• true: Habilita a leitura forçada.
ONESOURCE™ ECF MANUAL OPERACIONAL
5
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
PARÂMETROS DE IMPRESSÃO
modulos_impressao_automatica: Informar os módulos que terão impressão automática. Valores
permitidos:
• nfs: Habilita a impressão automática de documentos do módulo NFS-e.
tempo_consulta_impressao: Indicar o Intervalo de tempo em milissegundos entre as consultas de
impressão. Valor mínimo de 1000 milissegundos. Caso tenha mais de um módulo habilitado com
impressão, utilizar como valor mínimo 5000 milissegundos. Valor padrão 30000.
tempo_espera_nova_impressao: Indicar o intervalo de tempo de espera em milissegundos entre as
consultas após envio de uma requisição de impressão ao printerservice. Valor mínimo de 0
milissegundos.
CONEXÃO COM O MÓDULO PRINTER
Os parâmetros abaixo devem ser utilizados para configurar a conexão com o módulo Printer:
url_printer: Informar a URL de conexão com o módulo Printer.
PROXY PARA PRINTER
Os parâmetros abaixo possibilitam configurar Proxy para a conexão do Integrador V3 com o módulo
Printer. O preenchimento destes parâmetros é opcional:
printer_proxy_url: Informar host ou IP do proxy;
printer_proxy_port: Informar a porta do proxy;
printer_proxy_username: Informar o usuário para autenticar no proxy;
printer_proxy_password: Informar a senha do usuário para autenticar no proxy;
printer_proxy_domain: Informar o domínio para autenticar no proxy.
ONESOURCE™ ECF MANUAL OPERACIONAL
6
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
CONEXÃO COM WEBSERVICE DFE
Os parâmetros abaixo possibilitam configurar a conexão do Integrador V3 com o Webservice DFE:
url_webservice: Informar a URL de conexão com o Web Service. O preenchimento deste campo é
obrigatório.
Exemplos:
http://localhost:8080/webservice (instalação in house)
https://ws.h.dfe.mastersaf.com.br (ambiente de homologação SaaS)
portal_username: Informar o login do usuário integrador para autenticar no Web Service.
portal_password: Informar a senha do usuário integrador para autenticar no Web Service.
O usuário integrador informado no parâmetro portal_username deverá estar previamente
cadastrado no MASTERSAF DFE e possuir as permissões de acesso de Integrador
habilitadas em seu perfil.
PROXY PARA WEB SERVICE DFE
Os parâmetros abaixo possibilitam configurar Proxy para a conexão do Integrador V3 com o Web
Service DFE. O preenchimento destes parâmetros é opcional:
proxy_url: Informar host ou IP do proxy.
proxy_port: Informar a porta do proxy.
proxy_username: Informar o usuário para autenticar no proxy.
proxy_password: Informar a senha do usuário para autenticar no proxy.
proxy_domain: Informar o domínio para autenticar no proxy.
ONESOURCE™ ECF MANUAL OPERACIONAL
7
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
PARÂMETROS PARA DEFINIÇÃO DE PASTAS
PASTAS PARA O MÓDULO NFS-E
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas de integração
utilizadas para o módulo NFS-e:
pasta_nfse_entrada: Indicar a pasta onde serão gravados os arquivos contendo os RPSs para a
integração. Nesta pasta devem ser gravados pelo sistema do cliente todos os arquivos gerados para
envio de Emissão e Cancelamento de RPS para integração.
pasta_nfse_enviadas: Indicar a pasta onde serão gravados os arquivos já enviados para a integração.
Depois do término do processamento do arquivo da pasta definida no parâmetro pasta_nfse_entrada,
este é movido para a pasta definida neste parâmetro em caso de sucesso.
pasta_nfse_retorno: Indicar a pasta onde serão gravados os arquivos com informações de retorno de
emissão que contenham status de autorização ou rejeição.
pasta_nfse_retorno_cancelamento: Indicar a pasta onde serão gravados os arquivos com
informações de retorno do processo de cancelamento que contenham status de autorização ou
rejeição.
pasta_nfse_erro: Indicar a pasta onde serão gravados os arquivos de retornos de erros de estrutura,
arquivos inválidos ou qualquer erro de processamento.
pasta_nfse_erro_tecnico: Indicar a pasta onde serão gravados os arquivos de retorno de erros
técnicos.
pasta_nfse_retorno_prefeitura_manual: Indicar a pasta onde serão gravados os arquivos os arquivos
de retorno da prefeitura para importação no sistema.
pasta_nfse_envio_prefeitura_manual: Indicar a pasta onde serão gravados os arquivos de envio para
a prefeitura.
ONESOURCE™ ECF MANUAL OPERACIONAL
8
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
pasta_nfse_upload_pdf_entrada: Indicar a pasta onde serão gravados os arquivos PDF de RPS para
que sejam importados no DFE.
Os arquivos deverão ser gravados na pasta entrada com o padrão de nomenclatura:
"NFSe_" + CNPJ_EMPRESA + "" + INSCRIÇÃO_MUNICIPAL + "" + NÚMERO_RPS + "_" +
SÉRIE_RPS + ".pdf"
Exemplo: "NFSe_00910509000171_32489617_75014_1.pdf"
pasta_nfse_upload_pdf_enviados: Depois do término do processamento do arquivo da pasta
definida no parâmetro pasta_nfse_upload_pdf_entrada, este é movido para a pasta definida neste
parâmetro em caso de sucesso.
pasta_nfse_erro: Indicar a pasta onde serão gravados os arquivos rejeitados pelo DFE por estar com a
nomenclatura fora do padrão ou por não encontrar um RPS equivalente no banco de dados do DFE.
PASTAS PARA O MÓDULO RECEPTOR NFS-E
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas de integração
para o módulo Receptor NFS-e:
pasta_receptor_nfs_retorno: Indicar a pasta onde serão gravados os arquivos com informações de
retorno do recebimento da autorização do RPS.
pasta_receptor_nfs_retorno_cancelamento: Indicar a pasta onde serão gravados com informações
de retorno do recebimento de cancelamento do RPS.
pasta_receptor_nfs_erro: Indicar a pasta onde serão gravados os arquivos com informações de
retorno de erros.
ONESOURCE™ ECF MANUAL OPERACIONAL
9
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
PASTAS PARA O MÓDULO NF-E
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas de integração
para o módulo NF-e:
pasta_nfe_entrada: Indicar a pasta onde serão gravados os arquivos o para a integração com
MASTERSAF DFE. Nesta pasta devem ser gravados pelo sistema do cliente todos os arquivos gerados
para envio de Emissão, Cancelamento, Inutilização de NF-e, Emissão de Carta de Correção, Pedido de
Prorrogação de ICMS e Cancelamento de Pedido de Prorrogação para integração.
pasta_nfe_enviadas: Indicar a pasta onde serão gravados os arquivos já enviados para a integração.
Depois do término do processamento do arquivo da pasta definida no parâmetro pasta_nfe_entrada,
este é movido para a pasta definida neste parâmetro em caso de sucesso.
pasta_nfe_retorno: Indicar a pasta onde serão gravados os arquivos com informações de retorno do
processo de Emissão de NF-e que contenham status de autorização ou rejeição. Os arquivos de
retorno de emissão em contingência também são gravados nesta pasta.
pasta_nfe_retorno_cancelamento: Indicar a pasta onde serão gravados os arquivos com informações
de retorno do processo de cancelamento de NF-e que contenham status de autorização ou rejeição.
pasta_nfe_retorno_inutilizacao: Indicar a pasta onde serão gravados os arquivos com informações
de retorno do processo de inutilização de numeração de NF-e que contenham status de autorização
ou rejeição.
pasta_nfe_erro: Indicar a pasta onde serão gravados os arquivos de retornos de erros de estrutura,
arquivos inválidos ou qualquer erro de processamento.
pasta_nfe_retorno_carta_correcao: Indicar a pasta onde serão gravados os arquivos com
informações de retorno do processo de emissão de carta de correção que contenham status de
autorização ou rejeição.
pasta_nfe_retorno_pedido_prorrogacao: Indicar a pasta onde serão gravados os arquivos com
informações de retorno de Pedido de Prorrogação de ICMS, Cancelamento de Pedido de Prorrogação
que contenham status de autorização ou rejeição e Eventos Fisco relacionados.
ONESOURCE™ ECF MANUAL OPERACIONAL
10
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
pasta_nfe_distribuicao: Indicar a pasta onde serão gravados os arquivos XML recebidos através da
Consulta Distribuição. Caso não seja preenchido, os arquivos recebidos por esta consulta não serão
gravados em pasta.
PASTAS PARA O MÓDULO RECEPTOR NF-E
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas de integração
para o módulo Receptor NF-e:
pasta_recebimento_nfe_envio: Indicar a pasta onde serão colocados todos os arquivos a serem
importados no sistema.
pasta_recebimento_nfe_nao_importado: Indicar a pasta onde serão gravados os arquivos não
importados no sistema com tipo diferente de cancelamento e carta de correção.
pasta_recebimento_nfe_nao_importado_canc: Indicar a pasta onde serão gravados os arquivos de
cancelamento de NF-e não importados no sistema.
pasta_recebimento_nfe_erro: Indicar a pasta para onde serão gravados os arquivos que tiverem
algum erro identificado na importação. Serão gravados em subpastas de acordo com o tipo do arquivo
ou erro.
pasta_recebimento_nfe_retorno: Indicar a pasta onde serão gravados os arquivos de retorno de
recebimento.
pasta_recebimento_nfe_importado: Indicar a pasta onde serão gravados os arquivos importados
corretamente que não forem de cancelamento. Os arquivos de emissão já importados anteriormente
são gravados na subpasta “Reprocessado”.
pasta_recebimento_nfe_importado_canc: Indicar a pasta onde serão gravados os arquivos de
Cancelamento importados corretamente. Os arquivos de cancelamento já importados anteriormente
são gravados na subpasta “Reprocessado”.
ONESOURCE™ ECF MANUAL OPERACIONAL
11
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
pasta_recebimento_nfe_importado_cce: Indicar a pasta onde serão gravados os arquivos de Carta
de Correção importados corretamente. Os arquivos de carta de correção já importados anteriormente
são gravados na subpasta “Reprocessado”.
pasta_recebimento_nfe_distribuicao: Indicar a pasta onde serão gravados os arquivos XML
recebidos através da Consulta Distribuição. Caso não seja preenchido, os arquivos recebidos por esta
consulta não serão gravados em pasta.
pasta_recebimento_nfe_download_xml: Indicar a pasta onde serão gravados os arquivos recebidos
através da funcionalidade Download XML SEFAZ. Os arquivos somente serão gravados nesta pasta se
o parâmetro “grava_download_xml_sefaz” estiver definido como “true”.
grava_download_xml_sefaz: Ao ser habilitado, os arquivos recebidos através do Download XML na
SEFAZ serão armazenados na pasta do parâmetro "pasta_recebimento_nfe_download_xml". Valores
permitidos:
• true: Habilita a gravação dos arquivos recebidos; (Valor padrão)
• false: Desabilita a gravação dos arquivos recebidos.
PASTAS PARA MANIFESTAÇÃO NF-E
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas de integração de
arquivos de Manifestação do Destinatário para o módulo Receptor NF-e:
pasta_manifestacao_nfe_entrada: Indicar a pasta onde serão gravados os arquivos de envio de
manifestação destinatário para a integração.
pasta_manifestacao_nfe_recebidos: Indicar a pasta onde serão gravados os arquivos já enviados
para a integração. Depois do término do processamento do arquivo da pasta definida no parâmetro
pasta_manifestacao_nfe_entrada, este é movido para a pasta definida neste parâmetro em caso de
sucesso.
pasta_manifestacao_nfe_erro: Indicar a pasta onde serão gravados os arquivos com retorno de erros
de estrutura, arquivos inválidos ou qualquer erro de processamento.
ONESOURCE™ ECF MANUAL OPERACIONAL
12
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
pasta_manifestacao_nfe_retorno: Indicar a pasta onde serão gravados os arquivos com informações
de retorno que contenham status de autorização ou rejeição.
pasta_manifestacao_nfe_donwload_xml: Indicar a pasta onde serão gravados os arquivos recebidos
através de Download XML na SEFAZ.
PASTAS PARA XML LEGADO NF-E
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas de integração de
arquivos de NF-e de Legado o módulo NF-e:
pasta_nfe_legado_entrada: Indicar a pasta onde serão gravados os arquivos NF-e de Legado para a
integração.
pasta_nfe_legado_enviadas: Indicar a pasta onde serão gravados os arquivos já enviados para a
integração. Depois do término do processamento do arquivo da pasta definida no parâmetro
pasta_nfe_legado_entrada, este é movido para a pasta definida neste parâmetro em caso de sucesso.
pasta_nfe_legado_erro: Indicar a pasta onde serão gravados os arquivos de retornos de erros.
PASTAS PARA O MÓDULO CT-E
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas de integração
para o módulo CT-e:
pasta_cte_entrada: Indicar a pasta onde serão gravados os arquivos para a integração. Nesta pasta
devem ser gravados pelo sistema do cliente todos os arquivos gerados para envio de Emissão,
Cancelamento, Inutilização de CT-e, Emissão de Carta de Correção para integração.
pasta_cte_enviadas: Indicar a pasta onde serão gravados os arquivos já enviados para a integração.
Depois do término do processamento do arquivo da pasta definida no parâmetro pasta_cte_entrada,
este é movido para a pasta definida neste parâmetro em caso de sucesso.
ONESOURCE™ ECF MANUAL OPERACIONAL
13
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
pasta_cte_retorno: Indicar a pasta onde serão gravados os arquivos com informações de retorno que
contenham status de autorização ou rejeição. Os arquivos de retorno de emissão em contingência
também são gravados nesta pasta.
pasta_cte_retorno_cancelamento: Indicar a pasta onde serão gravados os arquivos com informações
de retorno do processo de cancelamento de CT-e que contenham status de autorização ou rejeição.
pasta_cte_retorno_inutilizacao: Indicar a pasta onde serão gravados os arquivos com informações
de retorno de inutilização do processo de inutilização de numeração de CT-e que contenham status de
autorização ou rejeição.
pasta_cte_erro: Indicar a pasta onde serão gravados os arquivos de retornos de erros de estrutura,
arquivos inválidos ou qualquer erro de processamento.
pasta_cte_retorno_carta_correcao: Indicar a pasta onde serão gravados os arquivos com
informações de retorno de retorno do processo de emissão de carta de correção que contenham status
de autorização ou rejeição.
PASTAS PARA O MÓDULO MDF-E
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas de integração
para o módulo MDF-e:
pasta_mdfe_entrada: Indicar a pasta onde serão gravados os arquivos para a integração. Nesta pasta
devem ser gravados pelo sistema do cliente todos os arquivos gerados para envio de Emissão,
Cancelamento, Encerramento de MDF-e e demais eventos para integração.
pasta_mdfe_enviadas: Indicar a pasta onde serão gravados os arquivos já enviados para a
integração. Depois do término do processamento do arquivo da pasta definida no parâmetro
pasta_mdfe_entrada, este é movido para a pasta definida neste parâmetro em caso de sucesso.
pasta_mdfe_retorno: Indicar a pasta onde serão gravados os arquivos com informações de retorno
que contenham status de autorização ou rejeição. Os arquivos de retorno de emissão em contingência
também são gravados nesta pasta.
ONESOURCE™ ECF MANUAL OPERACIONAL
14
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
pasta_mdfe_retorno_cancelamento: Indicar a pasta onde serão gravados os arquivos com
informações de retorno do processo de cancelamento de MDF-e que contenham status de autorização
ou rejeição.
pasta_mdfe_retorno_encerramento: Indicar a pasta onde serão gravados os arquivos com
informações de retorno do processo de encerramento de MDF-e que contenham status de autorização
ou rejeição.
pasta_mdfe_erro: Indicar a pasta onde serão gravados os arquivos de retornos de erros de estrutura,
arquivos inválidos ou qualquer erro de processamento.
pasta_mdfe_retorno_inclusao_condutor: Indicar a pasta onde serão gravados os arquivos de
retornos do processo de eventos de inclusão de condutor que contenham status de autorização ou
rejeição.
PASTAS PARA O MÓDULO RECEPTOR CT-E
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas de integração
para o módulo Receptor CT-e:
pasta_recebimento_envio: Indicar a pasta onde serão colocados todos os arquivos a serem
importados para o sistema.
pasta_recebimento_erro: Indicar a pasta para onde serão gravados os arquivos que tiverem algum
erro identificado na importação.
pasta_recebimento_retorno: Indicar a pasta onde serão gravados os arquivos de retornos de
recebimento.
pasta_recebimento_nao_importado: Indicar a pasta onde serão gravados os arquivos não
importados no sistema com tipo diferente de cancelamento e carta de correção.
pasta_recebimento_nao_importado_canc: Indicar a pasta onde serão gravados os arquivos de
cancelamento de CT-e não importados no sistema.
ONESOURCE™ ECF MANUAL OPERACIONAL
15
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
pasta_recebimento_importado: Indicar a pasta onde serão gravados os arquivos importados
corretamente que não forem de cancelamento. Os arquivos de emissão já importados anteriormente
são gravados na subpasta “Reprocessado”.
pasta_recebimento_importado_canc: Indicar a pasta onde serão gravados os arquivos de
Cancelamento importados corretamente. Os arquivos de cancelamento já importados anteriormente
são gravados na subpasta “Reprocessado”.
pasta_recebimento_importado_cce: Indicar a pasta onde serão gravados os arquivos de Carta de
Correção importados corretamente. Os arquivos de carta de correção já importados anteriormente são
gravados na subpasta “Reprocessado”.
PASTAS PARA O MÓDULO NFC-E
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas de integração
para o módulo NFC-e:
pasta_nfce_entrada: Indicar a pasta onde serão gravados os arquivos para a integração. Nesta pasta
devem ser gravados pelo sistema do cliente todos os arquivos gerados para envio de Emissão,
Cancelamento e Inutilização de NFC-e para integração.
pasta_nfce_enviadas: Indicar a pasta onde serão gravados os arquivos já enviados para a integração.
Depois do término do processamento do arquivo da pasta definida no parâmetro pasta_nfce_entrada,
este é movido para a pasta definida neste parâmetro em caso de sucesso.
pasta_nfce_retorno: Indicar a pasta onde serão gravados os arquivos com informações de retorno
que contenham status de autorização ou rejeição. Os arquivos de retorno de emissão em contingência
também são gravados nesta pasta.
pasta_nfce_retorno_cancelamento: Indicar a pasta onde serão gravados os arquivos com
informações de retorno do processo de cancelamento de NFC-e que contenham status de autorização
ou rejeição.
ONESOURCE™ ECF MANUAL OPERACIONAL
16
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
pasta_nfce_retorno_inutilizacao: Indicar a pasta onde serão gravados os arquivos com informações
de retorno de inutilização do processo de inutilização de numeração de NFC-e que contenham status
de autorização ou rejeição.
pasta_nfce_erro: Indicar a pasta onde serão gravados os arquivos de retornos de erros de estrutura,
arquivos inválidos ou qualquer erro de processamento.
PASTAS PARA ARQUIVOS NÃO IMPORTADOS
Os parâmetros abaixo possibilitam informar a localização para cada uma das pastas para gravação de
arquivos quando não for possível identificar o documento por erro ou conteúdo incompleto dos
arquivos:
pasta_erro: Indicar a pasta onde serão gravados os arquivos não importados devido a erros.
pasta_retorno: Indicar a pasta onde serão gravados os arquivos de retorno.
HIERARQUIA DE PASTAS
Os parâmetros abaixo possibilitam definir a hierarquia de pastas e subpastas para a gravação de
arquivos:
recebimento_retorno_com_data: Indicar se o retorno do recebimento será gerado na pasta raiz
padrão (recebimento_nfe_retorno ou recebimento_retorno), ou na estrutura “pasta/dataEmissao”,
utilizado para pastas dos módulos Receptor NF-e e Receptor CT-e. Valores permitidos:
• true: Habilita a gravação dos arquivos na estrutura “pasta/dataEmissao”; (Valor padrão)
• false: Habilita a gravação dos arquivos na pasta raiz.
raiz_retorno_recebimento: Indicar se o retorno do recebimento será gerado na raiz do CNPJ
remetente ou em estrutura de pastas por emissão/cnpjEmissor. O preenchimento deste parâmetro é
obrigatório. Valores permitidos:
• false: Habilita a gravação de arquivos em estrutura de pastas; (Valor padrão)
ONESOURCE™ ECF MANUAL OPERACIONAL
17
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
• true: Habilita a gravação de arquivos diretamente na pasta raiz do CNPJ remetente.
nfe_raiz_importado_recebimento Indicar se os arquivos da pasta “recebimento_nfe_importado” do
módulo Receptor NF-e serão gerados diretamente nesta pasta ou em estrutura de pastas na
combinação “CNPJ Emitente/Data/CNPJ Destinatário”. O preenchimento deste parâmetro é
obrigatório. Valores permitidos:
• false: Habilita a gravação de arquivos na estrutura de pastas; (Valor padrão)
• true: Habilita a gravação dos arquivos diretamente na pasta “recebimento_nfe_importado”.
cte_raiz_importado_recebimento: Indicar se os arquivos da pasta “recebimento_importado” do
módulo Receptor CT-e serão gerados diretamente nesta pasta ou em estrutura de pastas na
combinação “CNPJ Emitente/Data/CNPJ Destinatário”. O preenchimento deste parâmetro é
obrigatório. Valores permitidos:
• false: Habilita a gravação de arquivos na estrutura de pastas; (Valor padrão)
• true: Habilita a gravação dos arquivos diretamente na pasta “recebimento_importado”.
nfe_raiz_download_xml: Indicar se os arquivos da pasta “recebimento_nfe_download_xml” do
módulo Receptor NF-e deverão ser gerados diretamente nesta pasta ou em estrutura de pastas na
combinação CNPJ Emitente / Data / CNPJ Destinatário. O preenchimento deste parâmetro é
obrigatório. Valores permitidos:
• false: Habilita a gravação de arquivos na estrutura de pastas; (Valor padrão)
• true: Habilita a gravação dos arquivos diretamente na pasta
“recebimento_nfe_download_xml”.
nfs_raiz_retorno_emissor: Indicar se os arquivos das pastas “pasta_nfse_retorno” e
“pasta_nfse_retorno_cancelamento” do módulo NFS-e deverão ser gerados diretamente nestas
pastas ou na estrutura pasta/CNPJ Prestador. O preenchimento deste parâmetro é obrigatório.
Valores permitidos:
• false: Habilita a gravação de arquivos na estrutura de pastas;
• true: Habilita a gravação dos arquivos diretamente nas pastas “pasta_nfse_retorno” e
“pasta_nfse_retorno_cancelamento”. (Valor Padrão)
ONESOURCE™ ECF MANUAL OPERACIONAL
18
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
PARÂMETROS DE ARQUIVOS
NOMENCLATURA DE ARQUIVOS
Os parâmetros abaixo possibilitam configurar o formato da nomenclatura dos arquivos de retornos de
emissão, cancelamento, inutilização, carta de correção, denegação e encerramento:
status_chave_nfe: Define o formato da nomenclatura dos arquivos do módulo NF-e. Valores
permitidos:
• false: A nomenclatura dos arquivos será composta apenas pela chave de acesso; (Valor
Padrão)
• true: A nomenclatura dos arquivos será composta no formato
STATUS_CODIGOSTATUS_CHAVEDEACESSO.
status_chave_cte: Define o formato da nomenclatura dos arquivos do módulo CT-e. Valores
permitidos:
• true: A nomenclatura dos arquivos será composta no formato
STATUS_CODIGOSTATUS_CHAVEDEACESSO; (Valor padrão)
• false: A nomenclatura dos arquivos será composta apenas pela chave de acesso.
status_chave_mdfe: Define o formato da nomenclatura dos arquivos do módulo MDF-e. Valores
permitidos:
• true: A nomenclatura dos arquivos será composta no formato
STATUS_CODIGOSTATUS_CHAVEDEACESSO; (Valor padrão)
• false: A nomenclatura dos arquivos será composta apenas pela chave de acesso.
nome_arquivo_retorno: Indicar o formato da nomenclatura de arquivos de retorno dos módulos
NF-e, CT-e e MDF-e, com base nas posições da chave de acesso. Para isso, informar o número inicial
da posição de partida e a quantidade de caracteres a serem considerados separados por vírgula.
(Ex.35,8). Caso não seja preenchido, os arquivos serão nomeados com a numeração completa da
chave de acesso.
ONESOURCE™ ECF MANUAL OPERACIONAL
19
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
O integrador efetua a contagem das posições considerando o dígito inicial. Se preenchido
com o valor “35,8”, por exemplo, a contagem de 8 posições inicia no dígito 35.
TIPOS DE ARQUIVOS DE ENVIO E RETORNO
Os parâmetros abaixo possibilitam configurar o tipo de extensão dos arquivos de entrada e de retorno.
extensoes_arquivo_entrada: Informar o(s) tipo(s) de extensão dos arquivos gravados nas pastas de
entrada. Valor padrão: “txt,xml”. Valores permitidos:
• txt: Habilita a leitura de arquivos TXT;
• xml: Habilita a leitura de arquivos XML.
extensoes_arquivo_saida: Informar o(s) tipo(s) de extensão dos arquivos gravados nas pastas de
retorno. Valores permitidos:
• txt: Habilita a geração de retornos em arquivos TXT; (Valor padrão)
• xml: Habilita a geração de retornos em arquivos XML.
extensoes_arquivo_saida_nfs: Indicar um tipo diferente de extensão para os arquivos de retorno do
módulo NFS-e. Se preenchido, o parâmetro extensoes_arquivo_saida será ignorado para este
módulo. O preenchimento deste parâmetro é opcional. Valores permitidos:
• txt: Habilita a geração de retornos em arquivos TXT;
• xml: Habilita a geração de retornos em arquivos XML.
extensoes_arquivo_saida_nfe: Indicar um tipo diferente de extensão para os arquivos de retorno do
módulo NF-e. Se preenchido, o parâmetro extensoes_arquivo_saida será ignorado para este módulo.
O preenchimento deste parâmetro é opcional. Valores permitidos:
• txt: Habilita a geração de retornos em arquivos TXT;
• xml: Habilita a geração de retornos em arquivos XML.
extensoes_arquivo_saida_cte: Indicar um tipo diferente de extensão para os arquivos de retorno do
módulo CT-e. Se preenchido, o parâmetro extensoes_arquivo_saida será ignorado para este módulo.
O preenchimento deste parâmetro é opcional. Valores permitidos:
ONESOURCE™ ECF MANUAL OPERACIONAL
20
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
• txt: Habilita a geração de retornos em arquivos TXT;
• xml: Habilita a geração de retornos em arquivos XML.
extensoes_arquivo_saida_mdfe: Indicar um tipo diferente de extensão para os arquivos de retorno do
módulo MDF-e. Se preenchido, o parâmetro extensoes_arquivo_saida será ignorado para este
módulo. O preenchimento deste parâmetro é opcional. Valores permitidos:
• txt: Habilita a geração de retornos em arquivos TXT;
• xml: Habilita a geração de retornos em arquivos XML.
TIPOS DE ARQUIVOS DE RETORNOS DE RECEBIMENTO
Os parâmetros abaixo possibilitam definir os tipos de arquivos para gravação:
tipo_retorno_recebimento: Indicar o tipo de retorno do recebimento de XML de fornecedores. O
preenchimento deste parâmetro é obrigatório. Valores permitidos:
• txt: Habilita a geração de retornos em arquivos TXT; (Valor padrão)
• xml: Habilita a geração de retornos em arquivos XML.
tipo_retorno_recebimento_recepNFS: Indicar um tipo diferente de arquivo de retorno para o módulo
Receptor NFS-e. Se preenchido, o parâmetro tipo_retorno_recebimento será ignorado para este
módulo. O preenchimento deste parâmetro é opcional. Valores permitidos:
• txt: Habilita a geração de retornos em arquivos TXT;
• xml: Habilita a geração de retornos em arquivos XML.
tipo_retorno_recebimento_recepNFE: Indicar um tipo diferente de arquivo de retorno para o módulo
Receptor NF-e. Se preenchido, o parâmetro tipo_retorno_recebimento será ignorado para este
módulo. O preenchimento deste parâmetro é opcional. Valores permitidos:
• txt: habilita a geração de retornos em arquivos TXT;
• xml: habilita a geração de retornos em arquivos XML.
ONESOURCE™ ECF MANUAL OPERACIONAL
21
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
tipo_retorno_recebimento_recepCTE: Indicar um tipo diferente de arquivo de retorno para o módulo
Receptor CT-e. Se preenchido, o parâmetro tipo_retorno_recebimento será ignorado para este
módulo. O preenchimento deste parâmetro é opcional. Valores permitidos:
• txt: habilita a geração de retornos em arquivos TXT;
• xml: habilita a geração de retornos em arquivos XML.
CONFIGURAÇÃO DE LOG
Os parâmetros abaixo possibilitam configurar a gravação de logs do Integrador V3. O preenchimento
destes parâmetros é obrigatório:
log_pasta: Indicar o local da pasta onde os arquivos de log serão gravados. Valor padrão: “log”.
log_tamanho_arquivo: Indicar o tamanho máximo para os arquivos de log. O arquivo é rotacionado
quanto atingir este tamanho. Valor padrão: “5000kb”.
log_qtd_arquivos: Indicar a quantidade de arquivos de log a serem mantidos como histórico. Valor
padrão: “150”.
log_nivel: Indicar o nível de detalhamento do log. Valores permitidos:
• Info: São gravadas mensagens similares ao modo ‘verbose’ em outras aplicações; (Valor
Padrão)
• Fatal: São gravadas as mensagens críticas do sistema;
• Error: São gravadas as mensagens de erro da aplicação;
• Warn: São gravadas as mensagens de alerta sobre eventos que se deseja manter
“Constância”, mas que não afetam ao correto funcionamento do programa;
• Debug: São gravadas mensagens de depuração. Este nível não deve estar ativado quando
a aplicação se encontrar em produção;
• Trace: São gravadas mensagens com um maior nível de detalhe que debug.
ONESOURCE™ ECF MANUAL OPERACIONAL
22
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
CONTINGÊNCIA OFFLINE
Os parâmetros abaixo possibilitam configurar o comportamento do Integrador V3 em caso de falha de
comunicação e ativação de contingência Off-line.
A Contingência Off-line é utilizada quando o integrador não consegue comunicação com o módulo
webservice do DFE. Se estiver habilitada, o integrador alterará o tipo de emissão do documento para a
contingência configurada e enviará o documento para impressão no módulo Printer. Se o printer
aceitar a impressão esse documento alterado é movido da pasta de entrada para a pasta de
documentos enviados em contingência off-line. Quando restabelecer a comunicação com o
webservice do DFE, esses documentos impressos em contingência são enviados ao webservice e
aprovados em contingência na Sefaz de Origem.
ip_rede_interna: Informar o endereço IP ser utilizado para testar a conexão com a rede local em caso
de falha na comunicação. Valor padrão: “127.0.0.1”.
url_internet: Informar o endereço ser utilizado para testar a conexão com a internet em caso de falha
na comunicação. Exemplo: http://www.google.com.br.
CONTINGÊNCIA OFFLINE NF-E
usa_conting_offline: Indicar se deverá ser utilizada a contingência off-line para emissão de NF-e no
Integrador. Valores permitidos:
• true: Habilita o uso de contingência Offline;
• false: Desabilita o uso de contingência Offline.
tipo_emissao_conting_offline: Indicar o tipo de emissão em contingência a ser aplicado em caso de
falha na comunicação. Valores permitidos:
• 2: para emissão em contingência FS;
• 5: para emissão em contingência FS-DA.
mensagem_conting_offline: Informar o texto a ser utilizado como mensagem de contingência com
no mínimo 15 e no máximo 256 caracteres.
ONESOURCE™ ECF MANUAL OPERACIONAL
23
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
pasta_nfe_enviadas_conting_offline: Indicar o local da pasta para gravação dos arquivos enviados
para o Printer.
CONTINGÊNCIA OFFLINE CT-E
usa_conting_offline_cte: Indicar se deverá ser utilizada a contingência off-line para emissão de CT-e
no Integrador. Valores permitidos:
• true: Habilita o uso de contingência Offline;
• false: Desabilita o uso de contingência Offline.
tipo_emissao_conting_offline_cte: Indicar o tipo de emissão em contingência a ser aplicado em caso
de falha na comunicação. Valores permitidos:
• 5: para emissão em contingência FS-DA.
mensagem_conting_offline_cte: Informar o texto a ser utilizado como mensagem de contingência
com no mínimo 15 e no máximo 256 caracteres.
pasta_cte_enviadas_conting_offline: Indicar o local da pasta para gravação dos arquivos enviados
para o Printer.
CONTINGÊNCIA OFFLINE NFS-E
usa_conting_offline_nfse: Indicar se deverá ser utilizada a contingência off-line para emissão de
NFS-e no Integrador. Valores permitidos:
• true: Habilita o uso de contingência Offline;
• false: Desabilita o uso de contingência Offline.
pasta_nfse_enviadas_conting_offline: Indicar o local da pasta para gravação dos arquivos enviados
para o Printer.
ONESOURCE™ ECF MANUAL OPERACIONAL
24
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
PROCESSAMENTO POR SÉRIE
Os parâmetros abaixo possibilitam definir restrição para que o integrador busque apenas o retorno de
documentos da(s) série(s) informada(s). Os parâmetros não preenchidos serão ignorados, e com isso,
o Integrador buscará os retornos de documentos de todas as séries do módulo.
filtro_nfe_serie: Indicar a(s) série(s) de NF-e desejada(s).
filtro_nfse_serie: Indicar a(s) série(s) de RPS desejada(s).
filtro_cte_serie: Indicar a(s) série(s) de CT-e desejada(s).
filtro_mdfe_serie: Indicar a(s) série(s) de MDF-e desejada(s).
BACKUP DE PASTAS DO INTEGRADOR
Os parâmetros abaixo possibilitam configurar a funcionalidade de backup das pastas do Integrador.
backup_pastas_integrador: Definir se o backup de pastas será executado. Valores permitidos:
• true: Habilita a execução do backup das pastas;
• false: Desabilita a execução do backup das pastas.
modulo_backup: Indicar os módulos para a geração de backup. Valores permitidos:
• nfs: Habilita o backup de pastas do módulo NFS-e;
• nfe: Habilita o backup de pastas do módulo NF-e;
• cte: Habilita o backup de pastas do módulo CT-e;
• mdfe: Habilita o backup de pastas do módulo MDF-e.
periodo_frequencia_backup: indicar a frequência de execução do backup. Valores permitidos:
• 1: Executar todo dia 15 do mês as 00:00h;
• 2: Executar diariamente as 00:00h.
ONESOURCE™ ECF MANUAL OPERACIONAL
25
MASTERSAF DFE V3 MANUAL OPERACIONAL INTEGRADOR
Versão: 3.56.2
Publicado em: 05/12/2017
• 3: Executar diariamente com horário personalizado. Para utilizar esta opção é obrigatório
definir o parâmetro backup_hora.
• 4: Executar em Dia e Hora personalizados. Para utilizar esta opção é obrigatório definir os
parâmetros backup_hora e backup_dia.
backup_hora: Indicar o horário em que o backup deverá ser executado, no formato HH:MM. Exemplo:
23:00. Este parâmetro deve ser preenchido apenas se o parâmetro periodo_frequencia_backup
estiver definido como 3 ou 4.
backup_dia: Indicar o dia do mês em que o backup deverá ser executado, no formato DD. Exemplo:
01. Este parâmetro deve ser preenchido apenas se o parâmetro periodo_frequencia_backup estiver
definido como 4.
SUPORTE TÉCNICO
Para dúvidas ou problemas, abra um chamado no Contact Center ou entre em contato com nossa
equipe de Suporte Técnico MASTERSAF pelo Telefone:
(11) 2159-0600 opção 2 (Atendimento das Soluções DFE).
Nosso horário de atendimento é de segunda à sexta-feira de 9h às 18h.