10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

DFE Portal V3 connector SAP

| Purpose
This document aims to inform the design requirements for deployment or update of SAP ECC 6.0 Connector,
the scope of supplied software, requirements and Installation procedures and support policies.

This document is not intended to be extensive nor describes the procedures in detail and is the starting point for
analyzing the customer's environment and the required actions.

Depending on the specific characteristics of the customer, other actions may be required that are not described in
this document. The implementer Channel is responsible for providing support to the client concerning the
evaluation of actions to be taken.

| Architecture
Integration connector SAP ECC 6.0 X DF-E Portal

Connection to SAP ECC 6.0 is performed via SAP Java Connector (SAP JCo 3) adapters, which is a "Java
Software Application" that allows the development of SAP-compatible integrations and applications in Java.
SAP JCo 3 supports communication with the SAP server in both directions:
https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conectore… 1/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Incoming calls (Java calls ABAP) and outbound calls (ABAP calls Java).

The SAP JCo 3 adapter connects to the SAP through an RFC (Remote Function Call) user and is the standard
interface to establish connections between SAP and non-SAP. All types of RFC are transferred via TCP / IP.

Connection to the Portal MASTERSAF DF-e is performed through Web Services.

The connector performs connection to SAP RFC Server via SAPJco 3, which exposes invoices sent by the SAP
ECC 6.0 through attributes and functions of the XML_OUT and XML_IN structure and MASTERSAF
functions.

The XML_OUT and XML_IN structures are configured according to the customer's environment. The
implementation project is responsible to carry out the configuration. The computing components provided by
MASTERSAF and described herein, DO NOT configure or make available this infrastructure.

The functional profile called BASIS performs this setup.

The MASTERSAF functions are responsible for extracting additional information, that is, those not provided in
XML_OUT. In the process of issuing services invoices, the extraction can be customized through these
functions, which does not occur in commercial invoices.

Functional scope
The scope of the product offered aims to provide an interoperation of data of all processes that SAP ECC 6.0
also meets as standard, provided it is possible to extract data through computational components described in
the Architecture.
• Commercial invoice:
• Issue of Commercial invoice
• Cancellation of Commercial invoice
• Annulment of Commercial invoice
• Correction Letter
• Service Invoice:
• Issue of Service Invoice
• Cancellation of Service Invoice
• Transportation invoice:
• Issue of Transportation invoice
• Cancellation of Transportation invoice
• Annulment of Transportation invoice
• Correction Letter of Transportation invoice

Software connector scope

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conectore… 2/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

The Connector SAP software is made available under the Integration Architecture defined by MASTERSAF,
taking into consideration the technical and functional characteristics of the SAP product.

The integration kit comprises of:

• Java Software, responsible for the communication between SAP ECC 6.0 and DF-e Portal;
• Installation Manual;
• Creation script of ABAP objects. (Request);
• Layout references, spreadsheet with mapping information between the structures and attributes by Invoice
process and type of MASTERSAF Portal DF-e v3 and structures and attributes of integrator Connector
(SAP ECC 6.0) software.

| Prerequisites
Software prerequisites
TR/MASTERSAF-Portal DFE V3
Installation and application of cumulative patches and setup of TR/MASTERSAF Portal DF-e v3 has already
been done, with their respective registries and initial setups.

JAVA
Download the JRE (Java Runtime Environment) compatible with the Operational System of each environment.
It's recommended to use the last stable version available through official channels.
Please download the Java SE from one of the tested and homologated versions:
• OpenJDK Java SE 11.0.2
• http://jdk.java.net/11/

Future versions shall be supported; however, a compatibility evaluation will be performed.

Add the variable JAVA_HOME in the PATH environment variable, according to the example:

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conectore… 3/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

SAP and RFC Server

SAP ECC 6.0 and Remote Function Call Server, installed, configured and connected to each other.

Compatible SAP versions

SAP connect was originally developed to be compatible with SAP ECC 6.00. As from its original version were
made adjustments and tests with the following versions until SAP S/4 considering the aspects of essential
compatibility.

So, it is compatible with versions:

1. SAP and support packages subsequent through comunication by RFC on On Premise environment.
2. SAP S/4 On Premise através de comunicação RFC no ambiente On Premise.

• The tested versions are:

◦ SAP S/4HANA 1610
◦ SAP S/4HANA 1709
◦ SAP S/4HANA 1809

Nota: Updating for future versions will be performed.

SAP JCO 3
SAP Connector configured and installed in same integrator's server.

To download SAPJCO 3, please access:

http://service.sap.com/connectors

Attention: A user/password is required, which must be verified with the SAP responsible person.

Attention to SAP instruction: The SAP JCo 3.0.9 is unrestrictedly available for the following platforms:
Windows XP/Vista/7 (Intel IA32, Intel EM64T and AMD64), Windows Server 2003/2008/2008 R2 (Intel IA32,
Intel EM64T and AMD64, Itanium),Linux (Intel IA32, Intel EM64T and AMD64, Itanium, IBM eServer
zSeries, PowerPC), HP-UX (PA-RISC and Itanium),AIX, z/OS, IBM i, Solaris (SPARC, Intel EM64T and
AMD64) and Apple OS X (Intel IA32, Intel EM64T and AMD64).

For the exact platform and JRE Prerequisites please see SAP note 2786882.

For proper functioning of SAPJCO3 it is necessary to configure the following file:

C:\WINDOWS\system32\drivers\etc\services

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conectore… 4/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

This file is made available by the proper installation of the SAP Client. Installation of SAP Client was not
required in our environments, it was only required to have the file available in the specified location.
Nonconformities during SAPJCO 3 installation should be handled by SAP support.

SAP notes
Commercial and service invoice notes
The SAP NOTE 1589975 is an overview of SAP solution to cover the Brazilian legal requirements regarding
'Notas Fiscais Eletrônicas' (Electronic Invoices) released on 'Notas Técnicas' (Technical Notes) at 'Ministério da
Fazenda' website.

It sets the creation process of 'Notas Fiscais' on the SAP modules and It has all the invoices SAP has released for
the correct operation of the Electronic Invoice.

For further information, consult:

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

This SAP note does not reference only Commercial Invoices, it also contains relevant information about
Eletronic Service Invoices and information about the whole process of Invoice issuing.

Commercial invoice
The support to 4.0 Sefaz Layout is available by SAP through 2459713 note.

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

https://launchpad.support.sap.com/#/notes/2459713

Transportation invoice
The SAP tracking note 1858130 presents an overview of SAP solutions in order to cover Brazil legal
requirements that involve 'Conhecimento de Transporte Eletrônico' (Transportation invoice) released on 'Notas
Técnicas' (Technical Notes) at 'Ministério da Fazenda' website.

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

It sets the creation process of 'Notas Fiscais' (Invoices) on the SAP modules and It has all the invoices SAP has
released for the correct operation of the Electronic Transportation invoice.

The support to 3.0 Sefaz layout is available by SAP thorough notes 2368483 and 2387473

SAP NOTE 2368483 - CT-e 3.0

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conectore… 5/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

https://launchpad.support.sap.com/#/notes/2368483

SAP NOTE 2387473 - Prerequisite objects for SAP Note 2368483

https://launchpad.support.sap.com/#/notes/2387473

SAP grants
The role R3_RFCCALL must be linked to the user assigned to the SAP Connector for communication.

Role definition
SAP Role name: R3_RFCCALL. It's possible to use another name as long as the SAP user assigned to the SAP
Connector is linked to the role.

SAP Module: Basis

Role Description: Allows communication between SAP Connector and SAP environment via CPIC (Common
Programming Interface Communications) protocol.
Connector SAP implements communication using the SAP Java Connector (SAP JCO).
The role must be linked to SAP user assigned to the ConnectorSAP.
The role needs to be linked to permissions for communication via RFC.
The SAP user must have access to all features maintained by TR/Mastersaf and the SAP features for invoice
issue and transport invoice (CT-e)

SAP user profile

The SAP user assigned to ConnectorSAP has the requirements listed as follows:

Propriedade Perfil do usuário

Dialog Logon (SAP GUI) Not necessary
https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conectore… 6/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Multiple Logons Necessary

RFC Logon Necessary
Background Job Execution Necessary
Password Change Requiredly off
Logon Ticket can be generated Not necessary

Authorization for features RFC- remote Function call

Permission to access the following functions (Function Modules) is required.

Function Type of document Responsible

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, CTE SAP
J_1BNFE_EVENT_IN NFE, NFS, CTE SAP
J_1BNFE_EVENT_OUT NFE, NFS, CTE SAP
/MSAFDFE/MSAF_DFE_CTE_XML_OUT CTE TR/Mastersaf
/MSAFDFE/MSAF_DFE_CANCEL NFE, NFS 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, CTE TR/Mastersaf

DF-E V3 TR/MASTERSAF Portal prerequisites

Installation and application from cumulative patches and MASTERSAF Portal DF-e V3 configurations were
performed with proper registration and initial setups.

For the user to be configured on the Connector, access the Web Service from DFE Portal, the following
permissions must be associated to it.

User for connector at the DFE Portal

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conectore… 7/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Create a user that will be used only for the Connector. [User Connector]
• Suggestion of user name: msafcon_[erp]_[nome_da_empresa]
• Replace [nome_da_empresa] for an abbreviation that describes the company in the organization.
• Replace [erp] for an abbreviation that describes the ERP used. (SAP/EBS/INFOR/Outro)
• Select option “Gerador de chave para autenticação no webservice” and copy this key to register at config.

Disabled connector user permissions

The permissions indicated next must not be assigned to the user Connector:
• Cannot be the administrator
• Cannot use the name 'admin' or variations
• Cannot have 'administrator' group permission.

Permissions enabled for the connector's user

Assign the Connector user as relevant to the modules used. The orders that can be assigned are:
• System Administration - Integrator
• CT-e Integrator
• NF-e Integrator
• NFC-e Integrator
• NFS-e Integrator

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conectore… 8/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Link the connector's user as issuing companies

Create a link between the connector's user and the issuing companies which invoices must be processed by this
user and connector.

Suggestions for hardware

The following specifications must be considered for each instance of the Connector:

Processor: It's recommended a processing core available on a CPU

Memory: At least 512 MB of memory is suggested. The availability of 1.0 GB of memory is recommended.
Disk Space: It is suggested 1.0 GB of disk space, with 150 MB for executable files and the difference will be
used for cache and log rotation.

Adequate memory must be provisioned for minimum Operating System requirements and other applications that
may be installed on the same machine.

| Installation procedures
https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conectore… 9/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Downloading the Connector package

Attention: If you don't have credentials (user/password) to access the Contact Center, please ask the Customer
Care for credentials (e-mail: mastersaf.customercare@thomsonreuters.com).

Versions publication process

Every 45 (forty-five) days a new version of the product is released and every 15 (15 days) a new patch.

Through this cycle, fortnightly a new SAP Connector package is made available in the Contact Center.
Punctuality and exceptions may be notified in advance.

Example of package release cycle:

Connector package and Release notes are available for downloading on the Contact Center, menu Mastersaf DF-
e > Atualização de Versão/ Patches > Interfaces DF-e

Release notes
Download the Release notes; this document describes all the alterations released in the new version/patch of the
product. We recommend reading this document in its entirely BEFORE initiating the product installation/update
process.
https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 10/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Connector package
The Connector installation package will always be available inside the structure 'Atualização de Versão' (Version
Update).

'Atualização de Versão > DF-e V3': Here the Installer of a product Version is available, only the last one
released.

In order to update the Connector, it is not needed to install the intermediate versions between the installed
version and the new one. For example: If you are using the 3.109.0 version and intend to update it to the
3.110.1, it will be needed to download only the version 3.110.1 package.

Java program installation Windows environment

Access the Contact Center and download the SAP Connector

Decompress the package, according to the example below:

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 11/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Decompress the executables in: C:\Mastersaf\DFe\Conector_SAP

Copy the libraries from SAPJCO to the folder lib, according to the topic “BIBLIOTECA SAP JCO CÓPIA DOS
ARQUIVOS”.

Make a request available in the SAP environment, according to the topic “SAP CONFIGURAÇÃO
REQUESTS”.

Edit the file C:\Mastersaf\DFe\Conector_SAP\config\config.properties, according to the topic “EDITING

A configuration FILE”

Edit the SAPJCO configuration files, according to the topic “EDIT SAP ACCESS CONFIGURATIONS”

Java program installation Linux environment

Unzip the file ConectorSAP.zip. The directory structure will be shown in the image below:

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 12/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Open, on your text editor, the file /ConectorSAP/assets/servico_linux/v3init.d.CONECTOR/mastersaf-conector

and alter the variable value MASTER_USER to the Linux user that will execute the Connector.

Editing the file ~/.profile

Open the file ~/.profile on your text editor and add the following line:
export CONECTOR_INSTALL_PATH=/home/user/ConectorSAP

The value of CONECTOR_INSTALL_PATH must be the absolute path to the SAP Connector.

Instal the connector SAP service

Still in the directory ConectorSAP/assets/servico_linux/v3init.d.CONECTOR, execute via terminal, the
commands bellow as 'sudo':

sudo ./install.sh

Copy the libraries from the SAPJCO to the folder lib, according to the topic “LIBRARY SAP JCO FILE
COPIES”

Make the request available in the SAP environment, according to the topic “SAP CONFIGURAÇÃO
REQUESTS”

Edit the file C:\Mastersaf\DFe\Conector_SAP\config\config.properties, according to the topic “EDITING A

configuration FILE”

Edit the SAPJCO configuration files, according to the topic “EDIT THE SAP ACCESS CONFIGURATIONS”

| SAP JCO library files copies

Attention: Due to the SAP licensing policy, we cannot make the SAP JCO libraries available in the SAP
Connector package, check the 'notes' in the section 'Prerequisites'.

The communication between SAP Connector and SAP is made through SAP JCO library. The use of this library
is the recommended communication way between ERP and external systems.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 13/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

The SAP licensing policy restrains explicitly the SAP JCO libraries redistribution, for that reason we cannot
make the SAP JCO libraries available in the SAP Connector package.

The SAP JCO is available on the website: http://service.sap.com/connectors

Note: It's required a user/password, which must be verified with an SAP responsible person.
After downloading the SAO JCO libraries:
• Copy the file sapjco3.dll to the folder lib (Windows)
• Copy the file sapjco3.jar to the folder lib (Windows)
• Copy the file libsapjco3.so to the folder lib (GNU/Linux)

Editing the configuration file

Edit the configuration file, located in the sample address:
Conector_SAP\config\config.properties

Change the file config.properties configurations with information from the environment.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 14/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Environment type
Indicate if it's production (1) or homologation (2) environment

Active modules
Indicate which Connector sub-modules must be initialized.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 15/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

If a sub-module is not initialized, its flow will not be executed by the Connector.

Password cryptography
Verify the chapter “Password Cryptography”

MASTERSAF DF-E V3 Portal information

ws.url=http://localhost:8080/webservice [Ambiente Local (InHouse)]
or
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 of access to DFE Portal

If it's used a proxy between the Connector and the DFe Portal, define it.
Analyze the need to edit the other properties.

SAP access configuration

Create the files bellow, according to topic 4. After that, edit the access configurations to SAP.

C:\Mastersaf\DFe\Conector_SAP\CLIENT_POOL.jcoDestination
C:\Mastersaf\DFe\Conector_SAP\SERVER.jcoServer

Note: The folder 'assets' has examples of the 2 files, however we suggest the creation.
Path: 'IntegradorDFeConectorSAPX.XX.X\ConectorSAPX.XX.X\assets',

The files CLIENT_POOL.jcoDestination and SERVER.jcoServer have SAP addressing data.

Through these files it's possible to indicate access to SAP Gateway or to SAP Load Balancing.

Communication with the SAP Server

The file SERVER.jcoServer must be set in the same way for both access types.

Change the configurations in the file D:\Dfe_Mastersaf\Conector_sap\SERVER.jcoServer

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 16/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

SAP gateway communication

• Change files configurations
D:\Dfe_Mastersaf\Conector_sap\CLIENT_POOL.jcoDestination

SAP communication load balancing

• Change files configurations
D:\Dfe_Mastersaf\Conector_sap\CLIENT_POOL.jcoDestination

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 17/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

The complete listing of the parameters accepted by the files CLIENT_POOL.jcoDestination and
SERVER.jcoServer can be analyzed through JAVADOC, available by SAP to access the classes:

Interface com.sap.conn.jco.ext.DestinationDataProvider
Interface com.sap.conn.jco.ext.ServerDataProvider

| Connector service configuration

Please read the file “Integrador_DFe_Conector_Servicos_pt.pdf”

| Updating process
Attention:
• The update from the versions 2010.3.xx to the versions 3.3x.y must be considered as an installation, since
changes happened in the directory structure.
• Always update in the development environment or homologation, only after validation tests, schedule the
production environment update.
• We recommend the creation of a new LIB folder always. Never OVERLAP the folder, once there are
already files that are generated and named by version. If there's a duplication of these files, a conflict will
come up you the connector is initiated.
• We recommend a safety copy of the file CONFIG.PROPERTIES before upgrading.

Access to a new version

1. Access the Contact Center and download the Connector package.

2. Use the Release notes document to keep up with the alterations in the version.
https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 18/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Files replacement
1. Make a security copy of the lib folder, which contains the previous versions of the files,

2. Check the modifications in the file CONFIG.PROPERTIES. New flags for resources adding may be
created. When added and mandatory, these flags are described on the Release notes.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 19/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

3. The ERPs have specific and mandatory packages, these packages are highlighted on the Release notes. It's
necessary to have a compatible version with the available package.
a. SAP Request
b. Others ERPS Indicated on the Release notes
4. Decompress the files into an auxiliary directory.

5. Stop running the old version of the Connector

6. In the Connector folder, rename the folder 'lib' to 'lib.xx.yy', where 'xx' and 'yy' indicate the old version.
The files conectorsap.jar, conectorebs.jar and others are inside the 'lib' folder copied.

7. From the auxiliary directory, copy the 'lib' folder to the Connector installation folder.

8. Check if the version of the request is compatible with the ConnectorSAP version.
9. Restart the ConnectorSAP service.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 20/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

| SAP requests configurations

ABAP programs instalation
1. Namespace preparation

This topic aims to help the SAP Basis Administrator to execute the MASTERSAF Request for SAP
environments.
After concluding this last step of transportation to the DEV environment, the project can start and connector can
be configured.

2. CONFIGURING NAMESPACE /MSAFDFE/ IN SAP

The namespace /MSAFDFE/ is reserved by MASTERSAF for their standard programs.

This namespace is “C” type, from Customer. None development or changes in these licensed objects are allowed
in this namespace. Therefore, there is no authorization to create or update the programs in this namespace.
Every change is this objects and sources must be provided by MASTERSAF via an external request.
Before starting the transport of MASTERSAF programs on ECC, you must create this namespace in the SAP
environment following these steps.
a. Create the /MSAFDFE/ namespace in SAP:
b. Access SE03 transaction;
c. In group “Administration” click on "Display/Change Namespaces";
d. Click on "Display -> Change" button;
e. Then, click on "New Entries" button;
f. Complete the fields to create the namespace.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 21/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

The namespace /MSAFDFE/ will be configured as per example below:

3. Request transport
• As the installation of applications, MASTERSAF requests should always be the most updated.
Apply external request in the SAP environment.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 22/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

After creating the namespace, you have permission to transport Requests received from MASTERSAF.
In the downloaded package access the folder IntegradorDFeConectorSAPX.XX.X\SAP_Requests and
decompress the file TRDK900XXX.zip. You will find two files:
K900XXX.XXX;
R900XXX.XXX;

Each file must be placed in a specific folder within SAP server. Then, the transfer can be made through
SAP STMS transaction.

4. Perform the inclusion of the Request in a new one

It is important that requests with MASTERSAF prefix are placed in a new request created in the
development environment of your company so that it acquires its own numbering.

This can be done through SE09 by the inclusion of objects.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 23/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Thus, MASTERSAF request will be ready to be transferred to other SAP environments of your
company.

| Transportation invoice (CT-e)

CT-e considerations
Using the Connector SAP to transmit the CTe's is optional.
The process flow of the CTE documents is similar to the NFe's flow.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 24/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

CT-e alterations in config.properties

It's needed to activate the CTE module through the config.properties
Add in the property 'modules' the module cte.
Keep the other used modules.

Password criptography
The file config.properties can store passwords as either plain text or encrypted text. The use of cryptography is
optional, and it's controlled by two flags:

crypto.encryptPassword=false/true
Defines if the passwords will be encrypted.
Accepted values:
true: Encrypt password
false: Do not encrypt password

crypto.encrypted=false/true
Indicates if the password is encrypted
Accepted values:
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

Description of cryptography properties of

config.properties
The properties indicated in this session were created in the Connector version 2014.3.27. The file
config.properties, after this version, acquired the properties with the standard values. Files config.properties
copied from previous versions require the creation of the indicated properties.

Create, change or verify the properties names related to the connection with the database.

Attention: The prefix 'db' was added before the properties jdbcUrl, username, password and driver.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 25/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Edit the properties that control the password cryptography, as follow:

Procedure to enable cryptography

Before encrypting the passwords, the Connector will perform a backup of the original file config.properties, this
file will have the name config.properties_backup, located in the config. directory.
1. Complete the config.properties, defining users and passwords without cryptography:

2. Define the property crypto.encryptPassword=true.

3. Restart the Connector

4. The crypto.encrypted property value will be updated automatically for 'true'.

The properties for password will be encrypted:

| Layout references
To assist the implementation project, MASTERSAF makes the file " Referencia_de_Layout.zip" available, it
contains:

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 26/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

• Mapping Sheets
• Service Invoices Issue and cancellation
• Commercial Invoices Annulment and cancellation

• Mapping Templates
• NFe Issuing Layout 2.0 Sefaz
• NFe Issuing Layout 3.10 Sefaz
• NFe Issuing Layout 4.0x Sefaz
• CTe Issuing Layout 2.00 Sefaz
• CTe Issuing Layout 3.00 Sefaz

The mapping sheets set the SAP source fields to destination fields, according to Mastersaf Portal DFe v3
Layout.

The source fields in SAP can be the SAP standard functions or the MASTERSAF available functions.

The mapping template files are distributed in folders according to the logic structure of the documents, NFe or
CTe.

The sheet From/To NFS and the template files can be found inside the Connector package,
Ex: \IntegradorDFeConectorSAP6.0_X.XX.X\docs\Referencia_de_Layout

| Modules in the config.properties file

The type of documents available to integration depends on ERP capacity to share data relative to them, as well
as, the support being considered in the connector Functional scope.

The documents available to integration are:

E-Commercial invoice (NFE)
E-Service invoice (NFS)
E-Customer invoice (NFC)

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 27/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

E-Transportation invoice (CTE)

Using ERP as referential, exist the following flows:

1 - send: ERP send to the DFE Portal. Document output from ERP to validation by Government entity.
1A: In case the flow is activated the documents created at the ERP will be identified and transmitted to
the DFE Portal.
1B: In case the flow is not activated the ERP will no be monitored, the documents will not be identified
and no document will be sent to the DFE Portal.
2 - return: DFE Portal return to the ERP. Entry status in the ERP after validation by Government entity.
2A: In case the flow is activated the documents status will be identified in the DFE Portal and status
will be transmitted to the ERP.
2B: In case the flow is not activated the DFE Portal will not be monitored and no status will be
transmitted to the ERP.

The set with the type of document and flow characterize a module. Examples:

nfe.envio - Referring to the e-Commercial invoice documents and ERP send to the DFE Portal.
nfe.retorno - Referring to the e-Commercial invoice documents and DFE Portal return to the ERP.

Note: If it is not specified one data flow, all available data flow are activated for the document type. Example:
nfe - Referring to the e-Commercial invoice documents and both data flows, ERP send to the DFE
Portal and DFE Portal return to the ERP.

List of possible modules are:

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

All modules are aptional and it is necessary to activate at least one of them so that the connector act as data
integration.
It will be processed, only, the type of documents that appears in the module list.

Valid configurations examples to the module flag:

# Active send and return of e-Commercial invoice

modulo=nfe

# Active send and return of e-commercial and service invoice

modulo=nfe, nfs

# Active only send and return of e-Commercial invoice

modulo=nfe.envio

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 28/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

# Active send and return of e-Commercial invoice and return of e-service invoice
modulo=nfe, nfs.retorno

# Active send e-Commercial invoice and return of e-service invoice

modulo=nfe.envio, nfs.retorno

| Support policies
All the rules described in the document “Integrator_DFe_Connector_SAP-EBS_Support_Policies_en.pdf”,
found inside the Connector package, are applied.
Ex: IntegradorDFeConectorSAPX.XX.X\IntegradorDFeConectorSAPX.XX.X\docs.

In order to solve doubts or problems, please open a ticket in the Contact Center or contact the MASTERSAF
Technical Support team by Phone:
(11) 2159-0600 option 2 (DFE Solutions Attendance)

Our office hours are Monday to Friday, from 9 AM to 6 PM.

| Appendix
Example of SAP configuration and SAP connector
The following example must be considered, so that the values should be adapted according to the SAP
environment. If doubts come up while performing any of the following procedures, please contact SAP
Infrastructure Team, responsible for its environment.
1. Connection RFC in SAP

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 29/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

2. The following values are examples and can be adapted according to the SAP environment.

SM59 parameter Value Description

Destino RFC MSAFDFE
Tipo de Conexão T Selecionar Conexão “Conexão TCP/IP”
Descrição1 MSAFDFE - Mastersaf DFE
Tipo de ativação Programa servidor registrado
Deve ser exatamente o mesmo valor do
ID programa MSAFDFE 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. Register the program (MSAFDFE) in the SAP application server. This step may not be needed in some
SAP installations.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 30/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

4. (Optional) Set RFC address for namespace MSAFDFE, table RFCDEST (via SAP SM30).

5. Set SAP Gateway in Windows.

The following procedure can be replaced by the installation of the SAP Client in the host.
Include sap gateway in the services (service file) of Windows (\Windows\System32\drivers\etc).
Currently it's been used the sapgw00 as SAP port.

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

Include the SAP gateway on the port. It the example, it's being used 3300 and protocols.
In case of port changes, adjust this file.
6. Set SAP connector property files on MASTERSAF DF-e
7. Configuration CLIENT_POOL.jcoDestination.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 31/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

8. Configuration SERVER.jcoServer.

9. Configuration config.properties.

10. Start ConnectorSAP execution

11. Test SAP Connection.

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 32/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

Example of SAP configuration for documents issuing

Was the RFC destination configured for the branch that is being used?

After this configuration, was the debug performed in the include LJ_1B_NFEF71 ?

From the include LJ_1B_NFEF71, you get on the include LJ_1B_NFEF42. Was a query performed on this
include?

The following note sets the need to create structures for integration through Non-GRC solutions:
• SAP NT 2006439 [3.10] FM for Non-GRC connection (obtained from SAP NT 1589975)

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 33/34
10/16/23, 3:32 PM Integrator_Portal_DFEV3_Connector_SAP_60_Manual_en

https://webhelp.thomsonreuters.com.br/Site/HELPDW/V2R010/Conteudo/Demais_Empresas/DFE/DFEV3/Manuais/WebHelpDFEV3/Conector… 34/34