Integrador DFe Conector SAP 60 Manual PT

22/02/2023, 15:37 Integrador_DFe_Conector_SAP_60_Manual_pt
DFE PORTAL V3 - CONECTOR

SAP

English version

OBJETIVO
O objetivo deste documento é informar os pré-requisitos para a implantação do conector SAP ECC 6.0. Assim
como, a arquitetura e o escopo de software fornecido, os procedimentos de instalação e as políticas de suporte.

Não se pretende estender nem descrever os procedimentos em detalhes, sendo ele o ponto de partida para
análise do ambiente do cliente e das ações necessárias.

Dependendo das características especificas do cliente outras ações, não descritas aqui, podem ser necessárias. É
responsabilidade do canal implementador apoiar o cliente na avaliação das ações a serem tomadas.

ARQUITETURA
INTEGRAÇÃO CONECTOR SAP X PORTAL DF-E
Figura 1 - Arquitetura de integração Conector SAP ECC 6.0 x Portal DF-e

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conectore… 1/36

A conexão com o sistema SAP On Premise é realizada através de adaptadores SAP Java Connector (SAP
JCo 3).

Ele é um "Java Software Application" que permite o desenvolvimento de integrações compatíveis com SAP e
aplicativos em Java. Suportando a comunicação com o servidor em ambas as direções:

• Chamadas de entrada, na qual o Java chama o ABAP
• Chamadas de saída, na qual o ABAP chama o Java

O adaptador SAP JCo 3 conecta-se através de um usuário RFC (Remote Function Call), que é a interface
padrão para estabelecer conexões entre sistemas SAP e não-SAP. Todos os tipos de RFC são transferidos por
TCP/IP.

A conexão com o Portal TR/Mastersaf DF-e é realizada através de Web Services.

O conector realiza a conexão com SAP RFC Server através do SAP JCo 3, que expõe as notas fiscais enviadas
pelo SAP através de:

• Atributos e funções da estrutura XML_OUT e XML_IN, que são configuradas de acordo com o
ambiente do cliente.
Nota: A responsabilidade desta configuração é do projeto de implementação. Os componentes
computacionais disponibilizados pela TR/MASTERSAF e descritos neste documento, não
configuram ou tornam disponíveis esta infraestrutura. O perfil funcional denominado BASIS é o qual
realiza este setup.
• Funções TR/MASTERSAF, estas responsáveis por extrair informações complementares, ou seja,
que não estão disponibilizadas na XML_OUT.
Nota: Nos processos de emissão de notas fiscais de serviços, as extrações podem ser customizadas
através destas funções, o que não ocorre em notas fiscais mercantis.

ESCOPO FUNCIONAL

O escopo do produto disponibilizado visa fornecer a interoperação de dados de todos os processos aos quais o
SAP ECC 6.0 também atenda de forma standard. Desde que seja possível a extração dos dados através dos
componentes computacionais descritos na arquitetura:

• Notas Fiscais Mercantis
◦ Emissão de Nota Fiscal Mercantil
◦ Cancelamento de Nota Fiscal Mercantil
◦ Inutilização de Nota Fiscal Mercantil
◦ Carta de Correção

• Notas Fiscais de Serviço

◦ Emissão de Nota Fiscal Serviço
◦ Cancelamento de Nota Fiscal Serviço

• Conhecimento de Transporte
◦ Emissão de Conhecimento de Transporte
◦ Cancelamento de Conhecimento de Transporte
◦ Inutilização de Conhecimento de Transporte
◦ Carta de Correção de Conhecimento de Transporte

ESCOPO DO SOFTWARE CONECTOR

O software conector é disponibilizado de acordo com a arquitetura de integração definida pela
TR/MASTERSAF, levando em consideração as características técnicas e funcionais do produto SAP.

O kit de integração é composto por:
• Software Java que realiza a comunicação entre SAP e o Portal DF-e
• Manual de Instalação
• Script de criação de objetos ABAP (Request)
• Referências de layout, planilha com informações de mapeamento entre as estruturas e atributos por
processo, tipo de NF do TR/MASTERSAF Portal DF-e v3 e estruturas e atributos do software
Conector SAP

PRÉ-REQUISITOS
PRÉ-REQUISITOS DE SOFTWARE

TR/MASTERSAF - PORTAL DF-E

Realize instalação e aplicação de patches cumulativos e configuração do TR/MASTERSAF Portal DF-e V3,
com seus devidos cadastros e setups iniciais.

JAVA

Faça o download do JRE (Java Runtime Environment) compatível com o sistema operacional de cada
ambiente.
Nota: Recomenda-se a utilização da última versão estável disponibilizada pelos canais oficiais.

Realize o download do Java SE de uma das versões testadas e homologadas:
OpenJDK Java SE 11.0.2
http://jdk.java.net/11/

Atenção: Futuras versões poderão ser suportadas, porém será realizada avaliação de compatibilidade.

Adicione na variável de ambiente PATH a variável JAVA_HOME, conforme exemplo:
Figura 2 - Variável de Ambiente Path

SAP E RFC SERVER

SAP compatível com o Remote Function Call Server, devem estar instalados, configurados e conectados entre
si.

VERSÕES DO SAP COMPATÍVEIS

O Conector SAP foi originalmente desenvolvimento para ser compatível com o SAP ECC 6.00. A partir da
versão original foram realizados os ajustes e testes com as versões subsequentes até o SAP S/4 considerando os
aspectos de compatibilidade relevantes.

Assim, ele é compatível com as versões:

1. SAP e support packages subsequentes através de comunicação por RFC no ambiente On Premise.
2. SAP S/4 On Premise através de comunicação RFC no ambiente On Premise.

• As versões testadas são:
◦ SAP S/4HANA 1610

Nota: Atualizações para futuras versões serão realizadas.

SAP JCO 3

O conector SAP deve estar configurado e instalado no mesmo servidor do conector.

Para realizar download do SAPJCO 3: https://support.sap.com/en/product/connectors/jco.html

Atenção: É necessário um usuário/senha para acessar o SAP support, que deve ser verificado junto ao
responsável SAP na empresa.

Estão descritos na nota SAP 2786882: os pré-requisitos de JRE, as plataformas e sistemas operacionais
suportados.

Para o correto funcionamento do SAPJCO3 configure o arquivo: C:\WINDOWS\system32\drivers\etc\services

Nota: Este arquivo é disponibilizado para correta instalação do SAP Client. Em nossos ambientes não foi
necessária instalação do SAP Client, apenas a disponibilização do arquivo no local especificado.

Inconformidades na instalação do SAPJCO 3 devem ser tratadas com o suporte da SAP.

NOTAS SAP

NOTAS MERCANTIS E DE SERVIÇOS
A nota SAP 1589975 contém uma visão geral das soluções da SAP para cobrir os requisitos legais do Brasil no
que envolve as notas fiscais eletrônicas e os publicados através de notas técnicas no sítio do Ministério da
Fazenda.

Ela define o processo de criação de notas fiscais eletrônicas nos módulos SAP e contém todas as notas que a
SAP lançou para o correto funcionamento da NFE.

Para maiores informações consulte:

SAP NOTE 1589975 - Technical Notes from SEFAZ - Overview note
https://launchpad.support.sap.com/#/notes/1589975

Nota: Esta nota não se refere apenas a nota fiscal mercantil, também envolve notas fiscais de serviço e todo
processo de emissão de nota.

NOTAS MERCANTIS
O suporte ao layout 4.0 Sefaz foi disponibilizado pela SAP através da nota 2459713.

SAP NOTE 2459713 - NT 2016-002: NF-e 4.0 Layout - Outbound


CONHECIMENTO DE TRANSPORTE
A nota SAP de acompanhamento 1858130 contém uma visão geral das soluções da SAP para cobrir os
requisitos legais do Brasil no que envolve o conhecimento de transporte eletrônico e os publicados através de
notastTécnicas no sítio do Ministério da Fazenda.

SAP NOTE 1858130 - CT-e Technical Notes from SEFAZ - Overview note

Ela define o processo de criação de notas fiscais eletrônicas nos módulos SAP e contém todas as notas que a
SAP lançou para o correto funcionamento do CTE.

O suporte ao layout 3.0 Sefaz foi disponibilizado pela SAP através das notas 2368483 e 2387473

SAP NOTE 2368483 - CT-e 3.0

SAP NOTE 2387473 - Prerequisite objects for SAP Note 2368483

PERMISSÕES DE ACESSO AO SAP

O usuário atribuído ao ConectorSAP para comunicação precisa estar vinculado a role R3_RFCCALL.
Figura 3 - Permissão de usuário de comunicação

DEFINIÇÃO DA ROLE

Nome da Role SAP: R3_RFCCALL

Nota: É possível utilizar outro nome desde que o usuário SAP atribuído ao ConectorSAP esteja vinculado a
role.

Módulo SAP: Basis
Descrição da Role: Permite a comunicação entre o ConectorSAP e o ambiente SAP através do protocolo CPIC
(Common Prograaming Interface Communications).

• O ConectorSAP implementa a comunicação através da utilização do SAP Java Connector (SAP
JCO).
• A role deve ser associada ao usuário SAP atribuído ao ConectorSAP e vinculada as permissões
para comunicação através de RFC.
• O usuário SAP precisa ter acesso as funções mantidas pela TR/TR/MASTERSAF e as funções
SAP para emissão de notas fiscais e conhecimento de transporte.

PERFIL DO USUÁRIO SAP

Segue os requerimentos ao usuário SAP atribuído no ConectorSAP:

Propriedade Perfil do usuário
Dialog Logon (SAP GUI) Não necessário
Multiple Logons Necessário
RFC Logon Necessário
Background Job Necessário
Execution
Password Change Obrigatoriamente desligado
Logon Ticket can be Não necessário
generated

AUTORIZAÇÕES PARA FUNÇÕES RFC REMOTE FUNCTION CALL

É necessário permissão para acessar as seguintes funções (Function Modules):

Função Tipos de Responsável
Documento
J_1B_CTE_XML_OUT CTE SAP
J_1B_CTE_XML_OUT_200 CTE SAP
J_1B_CTE_XML_OUT_300 CTE SAP
J_1BNFE_CCEFLD_OUT CTE SAP
J_1B_NFE_XML_IN NFE, NFS SAP

J_1B_NFE_XML_OUT NFE, NFS SAP
J_1BNFE_CCE_OUT NFE, NFS SAP
J_1BNFE_OUTNFE_CREATE NFE, NFS SAP
J_1BNFE_OUTNFE_CREATE_400 NFE, NFS SAP
J_1BNFENUMGAP_STATUS_RFC NFE, NFS SAP
J_1BDFE_XML_IN_TAB NFE, NFS, SAP
CTE
J_1BNFE_EVENT_IN NFE, NFS, SAP
CTE
J_1BNFE_EVENT_OUT NFE, NFS, SAP
CTE
/MSAFDFE/MSAF_DFE_CTE_XML_OUT CTE TR/MASTERSAF
/MSAFDFE/MSAF_DFE_CANCEL NFE, NFS TR/MASTERSAF
/MSAFDFE/MSAF_DFE_XML_OUT NFE, NFS TR/MASTERSAF
/MSAFDFE/MSAF_DFE_UPDATEACTIVE NFE, NFS, TR/MASTERSAF
CTE

PRÉ-REQUISITOS DO TR/MASTERSAF PORTAL DF-E V3

A instalação e aplicação de patches cumulativos e configuração do TR/MASTERSAF Portal DF-e V3 deve ser
realizada, com seus devidos cadastros e setups iniciais.

Para acessar os Web Services do Portal DFE, o usuário - a ser configurado no Conector - deve ter as seguintes
permissões associadas a ele:

USUÁRIO PARA O CONECTOR NO PORTAL DFE

[Usuário do Conector]
Crie um usuário que será utilizado apenas para o Conector.
Sugestão de nome de usuário: msafcon_[erp]_[nome_da_empresa],

Substituir [nome_da_empresa] por uma sigla que descreva a empresa na organização.
Substituir [erp] por uma sigla que descreva o ERP utilizado. Por exemplo:
SAP/EBS/INFOR/Outro.
Selecionar a opção de “Gerador de chave para autenticação no webservice” e copiar esta chave
para cadastro no config.
Figura 4 - Cadastro de Usuário

PERMISSÕES DESABILITADAS DO USUÁRIO DO CONECTOR

As permissões indicadas a seguir não devem ser atribuídas ao usuário:
Não pode ser administrador.

Não utilizar o nome “admin” ou variações.
Não pode ter as permissões do grupo “administrador”.

Figura 5 - Permissões Desabilitadas

PERMISSÕES HABILITADAS PARA O USUÁRIO DO CONECTOR

Atribua ao Usuário do Conector as permissões pertinentes aos módulos utilizados.
As permissões possíveis:
• Administração do Sistema - Integrador
• CT-e Integrador
• NF-e Integrador
• NFC-e Integrador
• NFS-e Integrador
Figura 6 - Permissões Habilitadas

VINCULAR O USUÁRIO DO CONECTOR AS EMPRESAS EMITENTES

Crie o vínculo entre o usuário do conector e as empresas emitentes cujas notas devem ser processadas pelos
mesmos.
Figura 7 - Vinculo de empresa
SUGESTÕES PARA HARDWARE

Considere as especificações a seguir para cada instância do conector:

Processador: Recomendado um núcleo de processamento disponível em uma CPU.
Memória: Sugerido no mínimo 512 MB de memória. Com a recomendação da disponibilidade de 1,0 GB de
memória.
Espaço em Disco: Sugerido 1,0 GB de espaço em disco, sendo 150 MB para os arquivos executáveis e a
diferença utilizada em cache e rotação de logs.

Nota: Reserve a memória adequada aos requisitos mínimos do Sistema Operacional e outros aplicativos que
possam estar instalados na mesma máquina.

PROCEDIMENTOS DE INSTALAÇÃO
https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 10/36
REALIZANDO O DOWNLOAD DO PACOTE DO CONECTOR

Atenção: Caso não tenha credenciais (usuário/senha) para acessar a Central de Ajuda, solicite-as ao Customer
Care:

e-mail: TR/MASTERSAF.customercare@thomsonreuters.com

PROCESSO DE PUBLICAÇÃO DE VERSÕES

A cada 45 (quarenta e cinco) dias é lançada uma nova versão do produto e a cada 15 (quinze dias) um novo
patch. Através deste ciclo quinzenalmente é disponibilizado na Central de Ajuda um novo Pacote do Conector
SAP. Pontualidades e exceções poderão ser notificadas com antecedência.

Exemplo do ciclo de liberações do pacote:
Figura 8 - Ciclo de Liberação de Versão/Patch

O Pacote do Conector e o Release Notes são disponibilizados para download na Central de Ajuda, menu
Mastersaf DF-e > Atualização de Versão/ Patches > Interfaces DF-e

Figura 9 - Central de Ajuda Atualização de Versão/Patches
RELEASE NOTES

O Release Notes é o documento que descreve todas as alterações liberadas na nova versão/patch do produto.
Baixe-o e leia-o na sua integralidade antes de iniciar o processo de instalação/atualização do produto.

Figura 10 - Download Release Notes

PACOTE DO CONECTOR

O pacote de instalação do Conector sempre estará disponível dentro da estrutura Atualização de Versão > DF-e
V3.

Neste local é disponibilizado para download o Instalador da última versão lançada do produto.
Figura 11 - Atualização de Versão

Atenção: Para atualizar o conector não é necessário instalar as versões entre a já instalada e a nova versão.
Por exemplo: Caso esteja utilizando a versão 3.109.0 e pretenda atualizar para 3.110.1, baixe
somente a do pacote da versão 3.110.1

INSTALAÇÃO DO PROGRAMA - JAVA AMBIENTE WINDOWS

Acesse a Central de Ajuda e baixe o Conector SAP.
Figura 12 - Pacote disponibilizado no Central de Ajuda

Descompacte o pacote, conforme exemplo:
Figura 13 - Descompactar o pacote

Descompacte os executáveis em: C:\TR/MASTERSAF\DFe\Conector_SAP

Figura 14 - Descompactar na pasta Conector_SAP

Copie as bibliotecas do SAPJCO para pasta lib, conforme tópico: BIBLIOTECA SAP JCO CÓPIA DOS
ARQUIVOS

Disponibilize a request no ambiente SAP, conforme tópico: SAP CONFIGURAÇÃO REQUESTS

Edite o arquivo C:\TR\MASTERSAF\DFe\Conector_SAP\config\config.properties, conforme tópico: EDIÇÃO
DO ARQUIVO DE CONFIGURAÇÃO

Edite os arquivos de configuração do SAPJCO, conforme tópico: EDITAR AS CONFIGURAÇÕES DE
ACESSO AO SAP

INSTALAÇÃO DO PROGRAMA JAVA - AMBIENTE LINUX

Descompacte o arquivo ConectorSAP.zip. A estrutura de diretórios será como exibida abaixo:

Figura 15 - Estrutura de diretórios no GNU/Linux

Abra, no seu editor de texto, o arquivo:

/ConectorSAP/assets/servico_linux/v3init.d.CONECTOR/TR/MASTERSAF-conector

Com o usuário Linux, altere o valor da variável MASTER_USER e execute o Conector.
Figura 16 - Variável de ambiente

EDITAR O ARQUIVO ~/.PROFILE

Abra o arquivo ~/.profile no seu editor de texto a adicione a seguinte linha:

export CONECTOR_INSTALL_PATH=/home/user/ConectorSAP

O valor de CONECTOR_INSTALL_PATH deverá ser o caminho absoluto do Conector SAP.

INSTALAR O SERVIÇO DO CONECTOR SAP

Ainda no diretório /ConectorSAP/assets/servico_linux/v3init.d.CONECTOR, execute via terminal, o comando
abaixo como sudo:

sudo ./install.sh

Copie as bibliotecas do SAPJCO para pasta lib, conforme tópico: BIBLIOTECA SAP JCO CÓPIA DOS
ARQUIVOS

Disponibilize a request no ambiente SAP, conforme tópico: SAP CONFIGURAÇÃO REQUESTS

Edite o arquivo C:\TR\MASTERSAF\DFe\Conector_SAP\config\config.properties, conforme tópico: EDIÇÃO

DO ARQUIVO DE CONFIGURAÇÃO

Edite os arquivos de configuração do SAPJCO, conforme tópico: EDITAR AS CONFIGURAÇÕES DE
ACESSO AO SAP

BIBLIOTECA SAP JCO CÓPIA DOS ARQUIVOS

ATENÇÃO: Devido à política de licenciamento da SAP, não podemos disponibilizar as bibliotecas do SAP
JCO no pacote do Conector SAP. Vide nota no PRÉ-REQUISITOS.

A comunicação entre o Conector SAP e o SAP é feita através da biblioteca SAP JCO, sendo o uso dessa
biblioteca a forma recomendada de comunicação entre o ERP e os sistemas externos.

A política de licenciamento da SAP impede explicitamente a redistribuição das bibliotecas do SAP JCO. Assim,
não é possível disponibilizar as bibliotecas do SAP JCO no pacote do Conector SAP.

O SAP JCO está disponível no: http://service.sap.com/connectors

Nota: É necessário um usuário/senha, que deve ser verificado junto ao responsável SAP.

Após realizar o download das bibliotecas do SAP JCO:
Copie o arquivo sapjco3.dll para a pasta lib (Windows).
Copie o arquivo sapjco3.jar para a pasta lib (Windows).
Copie o arquivo libsapjco3.so para a pasta lib (GNU/Linux).
Figura 17 - Arquivos JCO para Windows
EDIÇÃO DO ARQUIVO DE CONFIGURAÇÃO

Edite o arquivo de configuração, localizado no caminho de exemplo:
Conector_SAP\config\config.properties

Figura 18 - Editar arquivo de configuração

Altere as configurações do arquivo config.properties com as informações do seu ambiente.
Figura 19 - Arquivo de configuração

TIPO DO AMBIENTE

Indique se é um ambiente de produção (1) ou de homologação (2).

MÓDULOS ATIVOS

Indique quais sub-módulos do conector devem ser inicializados.

Nota: Caso um sub-módulo não seja inicializado, seu fluxo não será executado pelo conector.

CRIPTOGRAFIA DE SENHAS

Vide Criptografia de Senhas

INFORMAÇÕES DO TR/MASTERSAF PORTAL DF-E V3

ws.url=http://localhost:8080/webservice [Ambiente Local (InHouse)]

ou

ws.url=https://ws.h.dfe.MASTERSAF.com.br [Ambiente SAAS]
ws.username=X#X#X#X#X#
ws.token=Y#Y#Y#Y#Y#

PROXY DE ACESSO AO PORTAL DFE

Caso seja utilizado um proxy entre o conector e o Portal DFe, defina-o.
Analise a necessidade e edite as demais propriedades.

CONFIGURAÇÕES DE ACESSO AO SAP

Crie os arquivos abaixo, conforme o tópico 4. Edite as configurações de acesso ao Sap.

C:\TR/MASTERSAF\DFe\Conector_SAP\CLIENT_POOL.jcoDestination
C:\TR/MASTERSAF\DFe\Conector_SAP\SERVER.jcoServer

Nota: Na pasta 'assets', possui exemplos dos dois arquivos, mas orientamos a criação do caminho:

IntegradorDFeConectorSAPX.XX.X\ConectorSAPX.XX.X\assets

Os arquivos CLIENT_POOL.jcoDestination e SERVER.jcoServer possuem os dados de endereçamento do
SAP.

Através desses arquivos é possível indicar o acesso ao SAP Gateway ou ao SAP Load Balancing.

COMUNICAÇÃO COM O SERVIDOR SAP

O arquivo SERVER.jcoServer deve ser configurado da mesma forma para os dois tipos de acesso.
Altere as configurações no arquivo D:\Dfe_MASTERSAF\Conector_sap\SERVER.jcoServer

Descrição dos Parâmetros Gateway host on which the server should be registered
jco.server.gwhost The program ID with which the registration is done
jco.server.progid Gateway service, i.e. the port on which a registration can be done
jco.server.gwserv Client destination from which to obtain the repository
jco.server.repository_destination

SERVER.jcoServer
jco.server.gwhost=xxx.xxx.xxx.xxx
jco.server.progid=RFC_DFE
jco.server.gwserv=sapgw01
jco.server.repository_destination=CLIENT_POOL

COMUNICAÇÃO SAP GATEWAY
Altere as configurações no
arquivo D:\Dfe_MASTERSAF\Conector_sap\CLIENT_POOL.jcoDestination

Descrição dos Parâmetros CLIENT_POOL.jcoDestination
jco.client.client SAP client jco.client.client=001
jco.client.user Logon user jco.client.passwd=1234
jco.client.passwd Logon password jco.client.user=nfe_rfc
jco.client.sysnr SAP system number jco.client.sysnr=01

COMUNICAÇÃO SAP LOAD BALANCING
Altere as configurações no
arquivo D:\Dfe_MASTERSAF\Conector_sap\CLIENT_POOL.jcoDestination

Descrição dos Parâmetros
jco.client.client SAP client
jco.client.user Logon user
jco.client.passwd Logon password
jco.client.r3name System ID of the SAP system
jco.client.group Group of SAP application servers
jco.client.mshost SAP message server
jco.client.msserv optional: SAP message server port to use instead of the default sapms<sysid>server

CLIENT_POOL.jcoDestination
jco.client.client=001
jco.client.user=nfe_rfc
jco.client.passwd=1234
jco.client.r3name=PRD
jco.client.group=PRODUCAO
jco.client.mshost=load.balance.host.com
jco.client.msserv=3600

A listagem completa dos parâmetros aceitos pelos arquivos CLIENT_POOL.jcoDestination e
SERVER.jcoServer podem ser analisados através do JAVADOC disponibilizado pela SAP para as classes:
Interface com.sap.conn.jco.ext.DestinationDataProvider
Interface com.sap.conn.jco.ext.ServerDataProvider

CONFIGURAÇÃO DO SERVIÇO DO CONECTOR

Leia o arquivo Integrador_DFe_Conector_Servicos_pt.pdf

PROCEDIMENTO DE ATUALIZAÇÃO
Atenção:
• A atualização das versões 2014.3.xx para as versões 3.3x.y deve ser considerada como uma
instalação, pois ocorreram mudanças na estrutura de diretórios.
• Sempre realize a atualização no ambiente de desenvolvimento ou homologação, somente após
testes de validação, agende a atualização do ambiente de Produção.
• Recomendamos que sempre crie uma nova pasta LIB. Nunca sobrepor, já que existem arquivos
que são gerados e nomeados por versão e se existirem estes arquivos duplicados na pasta, irá gerar
conflito ao iniciar o conector.
• Recomendamos, também, a realização de uma cópia de segurança do arquivo
CONFIG.PROPERTIES antes da atualização.

ACESSO A NOVA VERSÃO
1. Acesse a Central de Ajuda e baixe o pacote do Conector.
Figura 20 - Nova versão do Conector no Central de Ajuda
2. Através do Release Notes, acompanhe as alterações na versão.
Figura 21 - Exemplo conteúdo do Release Notes
SUBSTITUIÇÃO DE ARQUIVOS
1. Faça uma cópia de segurança da pasta lib contendo os arquivos da versão anterior.

Figura 22 - Cópia de Segurança
2. Verifique as modificações no arquivo CONFIG.PROPERTIES. Podem ser criadas novas flags para
adição de recursos, que uma vez adicionadas e obrigatórias, estarão descritas no Release Notes.
3. Os ERPs possuem pacotes específicos e obrigatórios, que são indicados com destaque no Release
Notes. É necessário manter uma versão compatível com o pacote disponibilizado.
a. SAP Request
b. Outros ERPS - indicação no Release Notes
4. Descompacte os arquivos em um diretório auxiliar.

Figura 23 - Descompactar o pacote em diretório auxiliar

5 . Pare a execução da versão antiga do conector.
Figura 24 - Parar Serviço do Conector

6 . Na pasta do Conector, renomeie a pasta lib para lib.xx.yy, onde xx e yy indicam a versão antiga. Os
arquivos conectorsap.jar, conectorebs.jar e outros estarão contidos na pasta lib copiada.
Figura 25 - Renomear pasta LIB indicando a versão antiga
7 . A partir do diretório auxiliar, copie a pasta lib para a pasta da instalação do Conector.
Figura 26 - Copiar Nova Pasta lib
8 . Verifique a versão da request compatível com a versão do ConectorSAP
9 . Reinicie o serviço do ConectorSAP.
SAP CONFIGURAÇÃO REQUESTS

INSTALAÇÃO DOS PROGRAMAS ABAP
1 . PREPARAÇÃO DA NAMESPACE
O objetivo deste tópico é ajudar o administrador SAP Basis a executar Request da TR/MASTERSAF para
ambientes SAP. Após a conclusão deste último processo de transporte para o ambiente DEV, pode-se iniciar o
projeto e configurar o Conector.
Figura 27 - SAP Ambientes
2 . CONFIGURANDO NAMESPACE /MSAFDFE/ NO SAP
A namespace /MSAFDFE/ está reservada pela TR/MASTERSAF para seus programas padrão.

Esta namespace é tipo "C", de Customer. Nenhum desenvolvimento ou mudança sobre os objetos desta licença
serão permitidas neste espaço. Logo, não há autorização para criar ou alterar programas neste namespace. Toda
e qualquer alteração deverá ser provida pela TR/MASTERSAF por meio de uma solicitação (request) externa.

Antes de iniciar o transporte de programas TR/MASTERSAF no ECC, você deve criar este espaço no ambiente
SAP, seguindo os seguintes passos.
a. Criar namespace /MSAFDFE/ no SAP;

b. Transação de acesso SE03;
c. No grupo Administração clique em Exibir/Modificar conjunto de nomes;
d. Click em Exibir > Modificar;
e. Na sequência, clique em Entradas Novas;
f. Preencha os campos para criar a namespace.

Figura 28 - Exibir/Modificar Conjuntos de Nomes

A NAMESPACE /MSAFDFE/ será configurada conforme exemplo abaixo:
FIGURA 29 - SAP NAMESPACE configuração

3. TRANSPORTE DE REQUEST
3.1. Assim como a instalação dos aplicativos, as requests da TR/MASTERSAF devem sempre ser as
mais atualizadas. Aplique a request externa no ambiente SAP.

Após ter criado a namespace, você tem permissão para transportar as Requests recebidas da
TR/MASTERSAF. No pacote baixado acesse a pasta
IntegradorDFeConectorSAPX.XX.X\SAP_Requests, descompacte o arquivo TRDK900XXX.zip
no qual você encontrará dois arquivos:

- K900XXX.XXX
- R900XXX.XXX
Figura 30 - Exemplo de arquivos que compõem uma request

Cada arquivo precisa ser colocado em uma pasta específica dentro do servidor SAP. Depois disso, o
transporte pode ser feito com a transação STMS do SAP.

Figura 31 - Transação para o transporte de requests

3.2 Faça a inclusão da Request em uma nova.

É importante que as requests com o prefixo da TR/MASTERSAF sejam colocadas em uma nova
request criada no ambiente de desenvolvimento da sua empresa para que ela adquira numeração
própria.
Isso pode ser feita através da SE09 através da inclusão de objetos.
Figura 32 - Detalhes da request que será importada

Desta forma a request da TR/MASTERSAF estará pronta para ser transportada aos demais ambientes
do SAP de sua empresa.
Figura 33 - Request disponível no ambiente
CONHECIMENTO DE TRANSPORTE
CTE - CONSIDERAÇÕES

A utilização do ConectorSAP para transmissão de CTEs é opcional.
Com o fluxo de processamento destes documentos sendo semelhante ao fluxo de NFEs.

CTE - ALTERAÇÕES NO CONFIG.PROPERTIES

É necessário ativar o módulo CTE através do config.properties
Adicione na propriedade “modulos” o módulo cte. Mantendo os demais utilizados.
Figura 34 - CTE Config.properties
CRIPTOGRAFIA DE SENHAS
O arquivo config.properties pode armazenar as senhas como texto corrido ou criptografado.

A utilização da criptografia é opcional e controlada por duas flags:

crypto.encryptPassword=false/true
Define se as senhas serão criptografadas.
Valores aceitos:
true: Criptografar as senhas
false: Não criptografar as senhas

crypto.encrypted=false/true
Indica se as senhas estão criptografas.
Valores aceitos:
true: As senhas contidas no arquivo config.properties já estão criptografadas
false: As senhas contidas no arquivo config.properties não estão criptogradas

DESCRIÇÃO DAS PROPRIEDADES DE CRIPTOGRAFIA DO

CONFIG.PROPERTIES

As propriedades indicadas nessa sessão foram criadas na versão 2014.3.27 do conector. O arquivo de
config.properties a partir dessa versão possui as propriedades com os valores padrão.

Para arquivos config.properties copiados de versões anteriores, é necessário criar as propriedades indicadas.

• Criar, alterar ou verificar os nomes das propriedades relacionadas com a conexão com o banco de
dados

Atenção: Foi adicionado o prefixo “db”, antes das propriedades jdbcUrl, username, password e driver.

Edite as propriedades que controlam a criptografia das senhas, conforme abaixo:
Figura 35 - Criptografia opções no config.properties
PROCEDIMENTO PARA HABILITAR A CRIPTOGRAFIA

Antes de criptografar as senhas, o conector fará um backup do arquivo config.properties original, esse arquivo
terá o nome de config.properties_backup localizado no diretório config.
1. Preencha o config.properties, definindo os usuários e senhas sem criptografia
Figura 36 - Criptografia exibição valores
2. Defina a propriedade crypto.encryptPassword=true
Figura 37 - Criptografia - Ativar utilização
3. Reinicie o Conector
4. O valor da propriedade crypto.encrypted será automaticamente atualizado para true
Figura 38 - Criptografia - atualização automática

As propriedades referentes às senhas serão criptografadas

Figura 39 - Criptografia - valores processados
REFERÊNCIA DE LAYOUT
Para auxiliar o projeto de implementação, a TR/MASTERSAF disponibiliza o
arquivo Referencia_de_Layout.zip que contém:
Planilhas de mapeamento
Notas Fiscais de serviços - Emissão e cancelamento
Notas Fiscais mercantis Inutilização e cancelamento

Templates de mapeamento
NFe Emissão Layout 2.0 Sefaz
NFe Emissão Layout 3.10 Sefaz

NFe Emissão Layout 4.0x Sefaz
CT e Emissão Layout 2.00 Sefaz
CT e Emissão Layout 3.00 Sefaz

As planilhas de mapeamento indicam os campos origem no SAP para os campos destinos segundo o Layout da
TR/MASTERSAF Portal DFe v3.

Os campos origem no SAP podem ser as funções padrão da SAP ou as funções disponibilizadas pela
TR/MASTERSAF.

Os arquivos templates de mapeamento estão distribuídos em pastas conforme a estrutura lógica dos
documentos gerados, NFe ou CTe.

A planilha De/Para NFS e os arquivos template podem ser localizados dentro do pacote do conector.
Exemplo: \IntegradorDFeConectorSAP6.0_X.XX.X\docs\Referencia_de_Layout

Figura 40 - Planilha Mapeamento e templates no pacote do ConectorSAP
MÓDULOS NO ARQUIVO CONFIG.PROPERTIES

Os tipos de documentos disponíveis para integração dependem da capacidade do ERP compartilhar os dados
referentes a eles, assim como, o suporte estar contemplado no Escopo Funcional do Conector.

Os tipos de documentos disponíveis para integração são:

Nota Fiscal Eletrônica - Mercantil (NFE)
Nota Fiscal Eletrônica - Serviços (NFS)
Nota Fiscal do Consumidor Eletrônica (NFC)
Conhecimento de Transporte Eletrônico (CTE)
Utilizando como referencial o ERP, existem os fluxos:

1 - envio: Envio do ERP para o Portal DFE. Saída de documentos do ERP para avaliação por Entidade
do Governo.
1A: Caso o fluxo seja ativado os documentos criados no ERP serão identificados e transmitidos para o
Portal DFE.
1B: Caso o fluxo não seja ativado o ERP não será monitorado, os documentos não serão identificados e
não haverá envio de documentos para o Portal DFE.
2 - retorno: Retorno do Portal DFE para o ERP. Entrada de status no ERP após avaliação pelo Entidade
do Governo.
2A: Caso o fluxo seja ativado os status dos documentos serão identificados no Portal DFE e os status
serão transmitidos para ERP.
2B: Caso o fluxo não seja ativado o Portal DFE não será monitorado e nenhum status será transmitido
para o ERP.

O conjunto tipo de documento e fluxo caracterizam um módulo. Exemplos:
nfe.envio - Refere-se aos documentos de Nota Fiscal Eletrônica - Mercantil e o Envio do ERP para o
Portal DFE.
nfe.retorno - Refere-se aos documentos de Nota Fiscal Eletrônica - Mercantil e o Retorno do Portal
DFE para o ERP.

Atenção: Caso não seja especificado um fluxo de dados, são ativados todos os fluxos de dados disponíveis para
o tipo de documento. Exemplo:

nfe - Refere-se aos documentos de Nota Fiscal Eletrônica - Mercantil e os dois fluxos de dados, o
Envio do ERP para o Portal DFE e o Retorno do Portal DFE para o ERP

A lista de módulos possíveis é:
nfe, nfe.envio, nfe.retorno

nfs, nfs.envio, nfs.retorno
nfc, nfc.envio, nfc.retorno
cte, cte.envio, cte.retorno

Todos os módulos são opcionais e é necessário ativar pelo menos um módulo para que o conector tenha ação de
integração de dados.
Serão processados, somente, os tipos de documentos que constarem na lista de módulos.

Exemplos de configurações validas para flag modulo:
# Ativa o envio e o retorno de Nota Fiscal Eletrônica - Mercantil
modulo=nfe

# Ativa o envio e o retorno de Nota Fiscal Eletrônica - Mercantil e Serviços
modulo=nfe, nfs

# Ativa somente o envio e o retorno de Nota Fiscal Eletrônica - Mercantil
modulo=nfe.envio

# Ativa o envio e o retorno de Nota Fiscal Eletrônica - Mercantil e o retorno de Nota Fiscal Eletrônica -
Serviços
modulo=nfe, nfs.retorno

# Ativa o envio de Nota Fiscal Eletrônica - Mercantil e o retorno de Nota Fiscal Eletrônica - Serviços
modulo=nfe.envio, nfs.retorno

POLÍTICAS DE SUPORTE
Aplicam-se todas as regras descritas no
documento Integrador_DFe_Conector_Politicas_De_Suporte_pt.pdf localizado dentro do pacote do conector.
Exemplo:

IntegradorDFeConectorSAPX.XX.X\IntegradorDFeConectorSAPX.XX.X\docs.

Para dúvidas ou problemas, abra um chamado na Central de Ajuda ou entre em contato com nossa equipe de
Suporte Técnico TR/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 as 18h.

APÊNDICE
EXEMPLO CONFIGURAÇÃO SAP E CONECTOR SAP

Deve-se considerar o exemplo do roteiro a seguir, onde os valores devem ser adaptados, conforme o ambiente
SAP. Caso existam dúvidas sobre a realização de qualquer um dos procedimentos a seguir, contacte a equipe de
infraestrutura SAP responsável pelo seu ambiente.
1. Conexão RFC no SAP.
2. Os valores a seguir são exemplos e podem ser adaptados de acordo com o ambiente SAP.

PARÂMETRO VALOR DESCRIÇÃO
DA SM59
Destino RFC MSAFDFE
Tipo de Conexão T Selecionar Conexão “Conexão
TCP/IP”
Descrição1 MSAFDFE -
TR/MASTERSAF
DFE
Tipo de ativação Programa servidor
registrado
ID programa MSAFDFE Deve ser exatamente o mesmo
valor do
campo jco.server.progid do
arquivo
SERVER.jcoServer
Timeout CPIC-C Gateway valor standard
Host gateway Deixar em branco
Serviço gateway Deixar em branco
3. Registre o programa (MSAFDFE) no servidor de aplicação do SAP. Esse passo pode não ser necessário
em algumas instalações SAP.

4. (Opcional) Configure endereço RFC para a namespace MSAFDFE, tabela RFCDEST (via SAP SM30).

5. Configure o sap gateway no Windows.

O procedimento a seguir pode ser substituído pela instalação do SAP Client no host.
Inclua o sap gateway nos serviços (arquivo service) do Windows (\Windows\System32\drivers\etc).
Atualmente está sendo utilizado o sapgw00, como porta sap.

Exemplo:
sapgw01 3300/tcp #SAP Gateway
sapgw01 3300/udp

Inclua o gateway sap na porta. No exemplo está em uso a 3300 e os protocolos.
Caso haja alguma alteração na porta, ajuste este arquivo.
6. Configure arquivos de propriedades do conector SAP no TR/MASTERSAF DF-e.
7. Configure CLIENT_POOL.jcoDestination.

8 . Configure SERVER.jcoServer.
9 . Configure config.properties.
1 0 . Inicie a execução do ConectorSAP.
1 1 . Teste a conexão no SAP.
EXEMPLO CONFIGURAÇÃO SAP PARA EMISSÃO DE

DOCUMENTOS

Foi configurado a RFC de destino para filial que está sendo utilizada?
Após essa configuração, foi realizado o debug no include LJ_1B_NFEF71 ?
A partir do include LJ_1B_NFEF71, chega-se no include LJ_1B_NFEF42, foi realizada análise nesse include?

A nota a seguir define a necessidade da criação das estruturas para integração através de soluções não GRC:

SAP NT 2006439 [3.10] FM for Non-GRC connection (obtida a partir da SAP NT 1589975)

Integrador DFe Conector SAP 60 Manual PT

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Integrador DFe Conector SAP 60 Manual PT

Enviado por

Direitos autorais:

Formatos disponíveis

22/02/2023, 15:37 Integrador_DFe_Conector_SAP_60_Manual_pt

DFE PORTAL V3 - CONECTOR

Figura 1 - Arquitetura de integração Conector SAP ECC 6.0 x Portal DF-e

• Notas Fiscais de Serviço

ESCOPO DO SOFTWARE CONECTOR

Figura 2 - Variável de Ambiente Path

NOTAS MERCANTIS E DE SERVIÇOS

SAP NOTE 2459713 - NT 2016-002: NF-e 4.0 Layout - Outbound

PERMISSÕES DE ACESSO AO SAP

Figura 3 - Permissão de usuário de comunicação

Nome da Role SAP: R3_RFCCALL

J_1B_NFE_XML_IN NFE, NFS SAP

PRÉ-REQUISITOS DO TR/MASTERSAF PORTAL DF-E V3

Sugestão de nome de usuário: msafcon_[erp]_[nome_da_empresa],

Figura 4 - Cadastro de Usuário

Não pode ser administrador.

Figura 5 - Permissões Desabilitadas

Figura 6 - Permissões Habilitadas

Figura 7 - Vinculo de empresa

SUGESTÕES PARA HARDWARE

REALIZANDO O DOWNLOAD DO PACOTE DO CONECTOR

Figura 8 - Ciclo de Liberação de Versão/Patch

Figura 10 - Download Release Notes

Figura 11 - Atualização de Versão

INSTALAÇÃO DO PROGRAMA - JAVA AMBIENTE WINDOWS

Figura 12 - Pacote disponibilizado no Central de Ajuda

Figura 13 - Descompactar o pacote

Figura 14 - Descompactar na pasta Conector_SAP

INSTALAÇÃO DO PROGRAMA JAVA - AMBIENTE LINUX

Figura 15 - Estrutura de diretórios no GNU/Linux

Figura 16 - Variável de ambiente

Edite o arquivo C:\TR\MASTERSAF\DFe\Conector_SAP\config\config.properties, conforme tópico: EDIÇÃO

BIBLIOTECA SAP JCO CÓPIA DOS ARQUIVOS

Figura 17 - Arquivos JCO para Windows

EDIÇÃO DO ARQUIVO DE CONFIGURAÇÃO

Figura 18 - Editar arquivo de configuração

Figura 19 - Arquivo de configuração

Indique quais sub-módulos do conector devem ser inicializados.

CONFIGURAÇÕES DE ACESSO AO SAP

CONFIGURAÇÃO DO SERVIÇO DO CONECTOR

ACESSO A NOVA VERSÃO

1. Acesse a Central de Ajuda e baixe o pacote do Conector.

Figura 20 - Nova versão do Conector no Central de Ajuda

2. Através do Release Notes, acompanhe as alterações na versão.

Figura 21 - Exemplo conteúdo do Release Notes

Figura 22 - Cópia de Segurança

4. Descompacte os arquivos em um diretório auxiliar.

Figura 23 - Descompactar o pacote em diretório auxiliar

5 . Pare a execução da versão antiga do conector.

Figura 24 - Parar Serviço do Conector

Figura 25 - Renomear pasta LIB indicando a versão antiga

Figura 26 - Copiar Nova Pasta lib

8 . Verifique a versão da request compatível com a versão do ConectorSAP

9 . Reinicie o serviço do ConectorSAP.

SAP CONFIGURAÇÃO REQUESTS

Figura 27 - SAP Ambientes

2 . CONFIGURANDO NAMESPACE /MSAFDFE/ NO SAP

a. Criar namespace /MSAFDFE/ no SAP;

Figura 28 - Exibir/Modificar Conjuntos de Nomes

FIGURA 29 - SAP NAMESPACE configuração

Figura 30 - Exemplo de arquivos que compõem uma request

Figura 31 - Transação para o transporte de requests

Isso pode ser feita através da SE09 através da inclusão de objetos.