TECHNICAL GUIDE AND FEATURES

THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

TABLE OF CONTENTS

INTRODUCTION............................................................................................................................................ 1

PROCESS FLOW ........................................................................................................................................... 1

SIZING ........................................................................................................................................................ 1

ARCHITECTURAL VIEW ............................................................................................................................ 1

INSTALLATION ..........................................................................................................................................2

PREREQUISITES: ...................................................................................................................................2

INSTALLATION PROCESS .....................................................................................................................2

UPDATE PROCESS ....................................................................................................................................2

SUPPORT DOCUMENT .............................................................................................................................3

DOWNLOAD THE APPLICATION ..............................................................................................................3

RELEASE NOTES (INFORMATIVO) AND MAIN FOCUSED (PONTOS DE ATENÇÃO)........................3

ONESOURCE ECF APPLICATION OVERVIEW ............................................................................................ 4

PROJECT TECHNICAL FEATURES........................................................................................................... 5

PERFORMANCE ....................................................................................................................................... 5

INSTALLATION TOPOLOGY..................................................................................................................... 5

INSTALLATION.............................................................................................................................................. 7

APPLICATION DOWNLOAD AND TECHNICAL RELEASE NOTES .......................................................... 7

ORACLE DATABASE ................................................................................................................................. 7

IMPORTANT INFORMATION ................................................................................................................. 7

NECESSARY PRIVILEGES ..................................................................................................................... 8

MODULE SCRIPT – CREATING USERNAME ....................................................................................... 8

CREATION OF DATABASE OBJECTS ................................................................................................... 8

PREREQUISITES FOR LIQUIBASE USING ........................................................................................... 9

Release: V01.R43
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

SETTINGS .............................................................................................................................................. 9

INSTALLING APACHE ACTIVEMQ....................................................................................................... 10

ONESOURCE ECF PORTAL..................................................................................................................... 12

PREREQUISITES .................................................................................................................................. 12

LICENSING THE APPLICATION ........................................................................................................... 13

IMPORT THE LICENSE FILE................................................................................................................. 13

ACCESS THE PORTAL WITH USERNAME “ADMINISTRADOR” ....................................................... 13

ACCESS THE PORTAL WITH USERNAME “OPERADOR” ................................................................. 14

ONESOURCE ECF WEBSERVICES.......................................................................................................... 15

PREREQUISITES .................................................................................................................................. 15

TOMCAT SETTINGS ............................................................................................................................. 16

AUTHENTICATION SETTINGS............................................................................................................. 16

ACTIVEMQ SETTINGS .......................................................................................................................... 16

INSTALLATION ..................................................................................................................................... 19

ACCESS TO WSDLS ............................................................................................................................. 19

ONESOURCE ECF MESSAGING ............................................................................................................ 20

PREREQUISITES ................................................................................................................................. 20

INSTALLATION .................................................................................................................................... 20

ONESOURCE ECF INTEGRATOR........................................................................................................... 23

PREREQUISITES ................................................................................................................................. 23

INSTALLATION .................................................................................................................................... 23

SERVICE INSTALLATION .................................................................................................................... 24

SERVICE RUNNING............................................................................................................................. 25

SERVICE STOPPING............................................................................................................................ 25

ONESOURCE ECF MESSAGING ............................................................................................................ 26

DATABASE BY DATABASE INTEGRATION ....................................................................................... 26

ONESOURCE ECF PORTAL.................................................................................................................... 28

Release: V01.R43
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

SETTINGS FOR SPED GENERATION ................................................................................................. 28

SYSTEM UPDATE....................................................................................................................................... 34

DATABASE UPDATE .............................................................................................................................. 34

PREREQUISITES ................................................................................................................................. 34

RUN THE LIQUIBASE .......................................................................................................................... 34

PORTAL AND WEBSERVICES UPDATE ................................................................................................ 35

PREREQUISITES ................................................................................................................................. 35

MENSAGERIA (MESSAGING) MODULE UPDATE ................................................................................ 36

PREREQUISITES ................................................................................................................................. 36

INTEGRATOR MODULE UPDATE ........................................................................................................... 37

PREREQUISITES .................................................................................................................................. 37

USING THE APPLICATIONS ...................................................................................................................... 38

MASTERSAF DW APPLICATION............................................................................................................ 38

MASTERSAF GF APPLICATION ............................................................................................................. 40

MASTERSAF SMART APPLICATION ..................................................................................................... 40

THOMSON REUTERS ONESOURCE ECF APPLICATION ..................................................................... 40

TECHNICAL SUPPORT ............................................................................................................................... 41

Release: V01.R43
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

INTRODUCTION
This document is designed to provide a technical guidance with simpler steps to download, install and
set the ONESOURCE ECF application.

For each procedure, follow the manual that provides the necessary guidance to perform correctly
every necessary action.

PROCESS FLOW
SIZING
Starting from the necessary architecture to ONESOURCE ECF/eSOCIAL application, perform the
sizing process for the module that you want:

ECF - ONESOURCE_ECF_Sizing_Questionnaire.docx

eSOCIAL - ONESOURCE_eSOCIAL_Sizing_Questionnaire.docx

This sizing with estimated volumetric data can be accomplished with a sizing questionnaire – you
must request it to Thomson Reuters. After filling the sizing questionnnaire
(ONESOURCE_ECF_Sizing_Questionnaire.docx) in this specific case, for ONESOURCE ECF module,
it must be forwarded to Thomson Reuters for the appropriate calculations.

ARCHITECTURAL VIEW
For orientations about infrastructure prerequisites to installation and using the application, please
access the Architectural View document.

Release: V01.R43 1
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

INSTALLATION

PREREQUISITES:

• Weblogic: default application server

• or Tomcat
• or JBoss

INSTALLATION PROCESS
1. For the installation process, use the manual: TR_ONESOURCE_Manual_Instalacao.pdf

Note: The installation process must start by this manual, which describes the default steps.
After installing ActiveMQ, since the topic “EXECUÇÃO MONITORAMENTO DO SERVIDOR
DE MENSAGENS (ACTIVEMQ)”, you need to use one of the following documents, according
to the application server used in your environment.

- If the standard used is Weblogic, use the following manual, which can also support the
process: TR_ONESOURCE_Manual_Instalacao_Weblogic.pdf
- If the standard used is Tomcat, use the following manual, which can also support the
process: TR_ONESOURCE_Manual_Instalacao_Apache_Tomcat.pdf
- If the standard used is JBoss, use the following manual, which can also support the
process: TR_ONESOURCE_Manual_Instalacao_Configuracao_JBOSS.pdf
2. If you need to customize the services and integration folders of the integrator, check the
integrator user guide: TR_ONESOURCE_Integrador_Guia_Usuario.pdf
3. O Manual de configuração contém as instruções de configuração banco a banco. Este manual
atende ao processo de configuração apenas do módulo ONESOURCE ECF:
ONESOURCE_ECF_Manual_Configuracao.pdf

UPDATE PROCESS
The settings manual have instructions for database to database settings. This manual is not necessary
in the installation process: TR_ONESOURCE_Manual_Atualizacao.pdf

Release: V01.R43 2
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

SUPPORT DOCUMENT
If you need information about ONESOURCE BR webservices, the manual can be used just as a support
document.

It is usually checked by users who do not want to use the integrator and will develop adapters for
dispatch directly to the ONESOURCE BR webservices.

For this particular case, we will use the definition of ONESOURCE ECF integration of Web services:
ONESOURCE_ECF_Integrador_Definicao_WebServices_Integracao.pdf

DOWNLOAD THE APPLICATION

The download procedures can be checked in the manual available in www.mastersaf.com.br, Base de
Conhecimento Cliente > ONESOURCE BR > Outros Documentos > Download da Aplicação >
TR_ONESOURCE_Download_Aplicacao.pdf.

All the manuals are available in "Base de Conhecimento" (Base de Conhecimento Cliente >
ONESOURCE BR) and the system package available in "Manuais" folder.

RELEASE NOTES (INFORMATIVO) AND MAIN FOCUSED (PONTOS DE

ATENÇÃO)
Please read the release notes “Informativo” and the main focused “Pontos de atenção” documents
before start this manual procedures:

1. In www.mastersaf.com.br, Atualização de Versão/Patches - ONESOURCE BR > Instalação >

Onesource ECF/eSOCIAL > Release Notes > Ver DOC

Note: In the release notes (TR_ONESOURCE_Informativo_Tecnico_V01.RXX.pdf), the topic

“Notas Importantes” (Important Notes) highlights the link to the document “Pontos de
atenção” (TR_ONESOURCE_Pontos_Atencao.pdf).

Release: V01.R43 3
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

2. In www.mastersaf.com.br, Base de Conhecimento Cliente > ONESOURCE BR > Outros

Documentos
3. In the system package INS_ONESOURCE_eSOCIAL_ECF_V01RXX.zip available in the folder
Manuais/Informativos:
• TR_ONESOURCE_Informativo_Tecnico_V01.RXX.pdf
• TR_ONESOURCE_Pontos_Atencao.pdf

After download the ONESOURCE ECF/eSOCIAL package

(INS_ONESOURCE_eSOCIAL_ECF_V01RXX.zip) follow the procedures as follows.

ONESOURCE ECF APPLICATION OVERVIEW

The information about the infrastructure – necessary to install the THOMSON REUTERS ONESOURCE
application – can be viewed in the the manual TR_ONESOURCE_Architectural_View.pdf.

Release: V01.R43 4
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

PROJECT TECHNICAL FEATURES

• ONESOURCE ECF receives the information from many sources (webservices, integrator or
native integration database to database);
• The system is available as On premise;
• Integrate XML or TXT in the integrator module connected to company’s computerized systems
and to ONESOURCE ECF with Webservices;
• Native integration database to database with Thomson Reuters applications (DW/GF/Smart);
• WebService Interfaces (data entry and data exit);
• PDF and MS Excel logs.

PERFORMANCE
Thomson Reuters uses a test environment by Rackspace to evaluate the communication routines
performance in Windows and Linux.

For a better integration and system calculation performance, it is strongly recommended that the
system environment runs in Linux. You may have substantial performance improvements when using
the system in Linux, in which the processing rate increases till 50% comparing with environments in
Windows.

INSTALLATION TOPOLOGY

Release: V01.R43 5
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

INSTALLATION
1. Application download and technical release notes
2. Create the Database
3. InstalIing Apache ActiveMQ
4. Installing ONESOURCE ECF Portal
5. Installing ONESOURCE ECF Webservices
6. Installing ONESOURCE Messaging
7. Installing ONESOURCE ECF Integrator

APPLICATION DOWNLOAD AND TECHNICAL RELEASE NOTES

You must download the installation package of the application and read its technical release notes,
also the Main Focused (Pontos de Atenção) document.

ORACLE DATABASE
The following information for installation process can be checked in the manual
TR_ONESOURCE_Manual_Instalacao.pdf.

IMPORTANT INFORMATION
Versions of Oracle database supported by the application:

- Oracle Database 11G Release 2 (64 bits), preferably 11.2.0.4

- Oracle Database 12c.

• The characterset recommended by THOMSON REUTERS is “WE8MSWIN1252”.

Do not use UTF8.

Release: V01.R43 7
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

NECESSARY PRIVILEGES
GRANT CONNECT TO <ONESOURCE>

GRANT RESOURCE TO <ONESOURCE>

GRANT CREATE VIEW TO <ONESOURCE>

MODULE SCRIPT – CREATING USERNAME

ORACLE 11.G Release 2

DROP USER ONESOURCE CASCADE;

CREATE USER ONESOURCE IDENTIFIED BY password@123 DEFAULT TABLESPACE

TR_TAXBR_DATA;

GRANT CONNECT,RESOURCE,CREATE VIEW TO ONESOURCE;

ORACLE 12c

CREATE USER ONESOURCE IDENTIFIED BY password@123 DEFAULT TABLESPACE

TR_TAXBR_DATA;

ALTER USER ONESOURCE ON TR_TAXBR_DATA

GRANT CONNECT,RESOURCE,CREATE VIEW TO ONESOURCE;

GRANT UNLIMITED TABLESPACE TO TR_TAXBR_DATA

(*) USER = ONESOURCE

(*) PASSWORD = password@123

(*) TABLESPACE = TR_TAXBR_DATA

CREATION OF DATABASE OBJECTS

Tool: Liquibase

Package folder: Instalacao\BancoDeDados

Release: V01.R43 8
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

PREREQUISITES FOR LIQUIBASE USING

• Operating system with Java virtual machine (Oracle Java 7 – 64 bits)

• Username with privileges of CONNECT,RESOURCE,CREATE VIEW
• Create a tablespace named TR_TAXBR_DATA

SETTINGS

To set the database parameterization, change the file ”liquibase.properties” the following values:

url:jdbc:oracle:thin:@<SERVER>:<PORT>/<SERVICE_NAME>

username:<DATABASE_USERNAME>

password:<DATABASE_PASSWORD>

Example 1: Settings using SERVICE_NAME:

url:jdbc:oracle:thin:@192.168.0.1:1521/ORCL

username:onesource

password:onesource@123

Example 2: Settings using ORACLE_SID:

url:jdbc:oracle:thin192.168.0.1:1521:ORCL

username:onesource

password:onesource@123

Note: Oracle will stop supporting SID in further versions. It´s strongly recommended use the
SERVICE_NAME instead of SID.

Release: V01.R43 9
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

TYPES OF DATA OBJECT CREATION

1. Create directly by the LIQUIBASE

liquibase.bat update (Windows)

liquibase.sh update (Linux)

2. Create the scripts SQL by the LIQUIBASE (apply manually)

liquibase updateSQL > ONESOURCE.sql

Run the generated file “ONESOURCE.sql” by SLQPlus or selected Oracle client

INSTALLING APACHE ACTIVEMQ

• Java Message Service (JMS);

• Unzip the messaging module installation package “apache-activemq-5.10.2-bin.zip” in the
folder Instalacao\Processamento\Serviço de Mensagens\Windows in installation package.

Note: You must unzip the package in a folder structure without special characters and
blanks.

FOLDER STRUCTURE

bin – have scripts to start the messaging server, also the ActiveMQ Windows service installer

conf – have scripts for messaging module settings

data – have service logs of messaging module and also a high performance messaging store

docs – have ActiveMQ documentation

lib – have pattern libraries in messaging module

example – have ActiveMQ examples

webapps – have ActiveMQ monitor

webapps-demo – have ActiveMQ Web examples

Release: V01.R43 10
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

RUN IN WINDOWS ENVIRONMENT

1. Run the script “bin/win64/installService.bat”.

2. Access the Windows services. The ActiveMQ service is available for boot process.

RUN IN LINUX ENVIRONMENT

1. As administrator (root), run the command “chmod 775 /${activemq_home} -R”.

The value “${activemq_home}” must be replaced ti the complete menu until the ActiveMQ
installation folder;
2. Run the script “bin/activemq start” to start the ActiveMQ.

Release: V01.R43 11
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

ONESOURCE ECF PORTAL

PREREQUISITES
• A database that use the liquibase
• Operating System with Oracle Java 7 virtual machine.
• JMS Apache ActiveMQ Server installation package;
• A Web Container (web application server) installed. The available options of homologated web
containers are:
- Apache Tomcat 7.x
- Weblogic versions 11 e 12c
- Jboss EAP 6.3.0.GA (AS 7.4.0.Final-redhat-14)

Obs.: For more information, access the Architectural Overview: TR_ONESOURCE_

Architectural_Overview.pdf

• Linux operating system for environments with high processing rates.

Note: Start the installation process using the manual:

TR_ONESOURCE_Manual_Instalacao.pdf. Follow the steps described in the manual.

Release: V01.R43 12
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

When ActiveMQ is installed, after the topic “Execução de Monitoramento do Servidor de Mensagens
(ActiveMQ)” (Running, citamos a necessidade de utilizar um dos manuais abaixo de acordo com o
servidor de aplicação utilizado no seu ambiente.

• Standard Weblogic: TR_ONESOURCE_Manual_Instalacao_Weblogic.pdf

• Standard Tomcat: TR_ONESOURCE_Manual_Instalacao_Apache_Tomcat.pdf
• Standard JBOSS: TR_ONESOURCE_Manual_Instalacao_Configuracao_JBOSS.pdf

LICENSING THE APPLICATION

Import a XML file with the license content.in order to use the application.

To adquire your own license file, please contact the Thomson Reuters’ Contracts Departments.

You can access the application without a license file. For this, you must use the username “ADM” and
password “ADM”, however, you can only operate the Administração (Management) module.

The access to the others modules (eSOCIAL and ECF) will be unlocked after import its license.

IMPORT THE LICENSE FILE

1. Access the application with username and password “ADM”;
2. Click the Administração (Management) module;
3. Access the menu Configurações > Licenciamento;
4. Click Add... and select the XML license file. The message “Upload efetuado com sucesso” (The
upload occurred successfully).
5. Click the “Save” button. The message “Licenciamento efetuado com sucesso” (License
performed successfully).
6. Click the “Exit” button to close the application. Open it again as “ADM”/”ADM”. The licensed
modules are displayed in the module screen.

ACCESS THE PORTAL WITH USERNAME “ADMINISTRADOR”

1. Open the browser and access: http://localhost:8080/taxbr-solution-parent/pages/login.jsf
2. Enter the username “ADM” and password “ADM”.
3. After the login, the Administração (Management) module is displayed available to access.

Release: V01.R43 13
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

ACCESS THE PORTAL WITH USERNAME “OPERADOR”

1. Open the browser and access: http://localhost:8080/taxbr-solution-parent/pages/login.jsf
2. Enter the username “OPERADOR” and password: “OP001”.
3. After the login, the ECF module is displayed available to access.

Release: V01.R43 14
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

ONESOURCE ECF WEBSERVICES

PREREQUISITES

• A database that use the liquibase

• Operating System with Oracle Java 7 virtual machine.
• JMS Apache ActiveMQ Server installation package;
• A Web Container (web application server) installed. The available options of homologated web
containers are:
- Apache Tomcat 7.x
- Weblogic versions 11 e 12c
- Jboss EAP 6.3.0.GA (AS 7.4.0.Final-redhat-14)

Obs.: For more information, access the Architectural Overview:

TR_ONESOURCE_ Architectural_Overview.pdf

• Linux operating system for environments with high processing rates.

Note: In this guide we use Apache Tomcat 7.x application server as an example of default
installation.

Release: V01.R43 15
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

TOMCAT SETTINGS
The Tomcat setting process comes down to two steps:

1. Copy the file “application.properties”, available in the folder

Instalacao\Aplicacao_Web\Arquivos_de_Configuracao\ to the folder “/conf” located in the
installation root folder of Apache Tomcat.

2. Open the file “conf/catalina.properties” located at Apache Tomcat installation folder.At the
end of “common.loader” property, add the expression: “${catalina.base}/conf”, as below:

common.loader=${catalina.base}/lib,${catalina.base}/lib/*.jar,${catalina.home}
/lib,${catalina.home}/lib/*.jar,${catalina.base}/conf

AUTHENTICATION SETTINGS
The webservices are set with UsernameToken authentication and can be changed as you need.

1. Edit the file “application.properties” in the folder “/conf” located in the installation root folder
of Apache Tomcat.

ACTIVEMQ SETTINGS
The webservices use Java Message Service (JMS) to ensure the dispatch of messages and its
processing.

Access the Configuração do Sistema (systems settings) screen in the menu Configurações >
Configuração do Sistema to set the ActiveMQ:

Release: V01.R43 16
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

1. Check the address settings of web generation service of SPED file.

a. Access the search screen of system settings, then enter “ecf” in the Chave de
Configuração (setting key) text field.
b. In the combo box search criterion, enter “inicia com” as below, then click “Executar
Consulta” (search button):

2. Edit the web service address of SPED file generation.

a. In the search results screen, click “Editar” (Edit) button:

Release: V01.R43 17
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

3. Change the ActiveMQ server address.

a. Access the edit screen of system settings, then change the Valor (value) text field of the
property amq.brokerUrl with the correct address of Active MQ server.
b. Enter “Endereço IP, ou nome de máquina” and the correct connection port as below,
then click “Salvar” (save) to confirm:
c. In the combo box search criterion, enter “inicia com” as below, then click “Executar
Consulta” (search button):

amq.brokerUrl=tcp://localhost:61616

Release: V01.R43 18
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

Note: These are values for a default installation with Mensageria (Messaging), ActiveMQ and
Tomcat are in the same workstation.

INSTALLATION
The Tomcat setting process comes down to two steps:

1. Access the location of WAR files in distribution package:

WebPortal:
${INSTALLATION_PACKAGE}\Instalacao\Aplicacao_Web_Services\taxbr-solution-
webservices.war
2. Copy the WAR file from the webservices to the webapps folder of Tomcat installation.
Copy to:
${TOMCAT_DIR}\webapps\

After this, you can start the Tomcat.

ACCESS TO WSDLS
1. Open the browser and access: http://localhost:8080/taxbr-solution-webservices/services
2. A list of all webservices available is displayed, as below:

Release: V01.R43 19
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

ONESOURCE ECF MESSAGING

PREREQUISITES

• A database that use the liquibase

• JMS Apache ActiveMQ Server 5.10.2 installation package (apache-activemq-5.10.2.zip)
• ONESOURCE eSOCIAL/ ONESOURCE ECF messaging installation package
• Operating system with Java virtual machine (1.7.x – 64 bits)
• Linux operating system for environments with high processing rates.

INSTALLATION
Unzip the “Mensageria” (Messaging) module installation package
“Instalacao\Processamento\Processador\onesource-messaging-<versão>.zip” in installation
package.

Note: You must unzip the package in a folder structure without special characters and
blanks.

FOLDER STRUCTURE

conf – have scripts for messaging module settings

lib – have pattern libraries in messaging module

Release: V01.R43 20
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

data – have service logs of messaging module

service– have binary numbers to run the messaging module as Windows service

DATABASE SETTINGS

The “Mensageria” (Messaging) module needs an encrypted password for its database.

Use the “keygen” application – located at root directory of messaging module – to encrypt the
password in a plain text:

E.g.:
Windows environment (console):
keygen.bat password_in_plain_text
Linux environment (console):
keygen.sh password_in_plain_text

The “keygen” application will return the following result:

Set the access to ONESOURCE ECF database:

Edit the file “conf/application.properties” and change the properties values below:

Example 1: Settings with SERVICE_NAME

db.url=jdbc:oracle:thin:@<SERVER>:<PORT>/<SERVICE_NAME>

db.username=<DATABASE_USERNAME>

db.password=<DATABASE_PASSWORD>

Release: V01.R43 21
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

Example 2: Settings with Oracle SID

db.url=jdbc:oracle:thin:@<SERVER>:<PORT>:<SID>

db.username=<DATABASE_USERNAME>

db.password=<DATABASE_PASSWORD>

Note 1: Oracle will stop supporting SID in further versions. It´s strongly recommended use
the SERVICE_NAME instead of SID.
Note 2: In “db.password” property, enter the encrypted value generated o valor
criptografado gerado a partir do utilitário “keygen” descrito no slide anterior.

RUNNING IN WINDOWS ENVIRONMENT

1. Run the script as “Administrador” located at the folder: “services/win64/installService.bat”

2. Access Windows services. The “ONESOURCE Messaging” service must be available to startup.

RUNNING IN LINUX ENVIRONMENT

1. Run the script “run.sh” located at the install root folder of ONESOURCE Messaging.
2. To end the service running, run the script “stop.sh” located at diretório raiz da instalação do
ONESOURCE Messaging.

Release: V01.R43 22
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

ONESOURCE ECF INTEGRATOR

PREREQUISITES

• A database that use the liquibase

• JMS Apache ActiveMQ Server installation package
• ONESOURCE Messaging installation package
• A Web Container (web server) installed with Webservices module
• Linux operating system for environments with high processing rates.

INSTALLATION
1. Unzip the integrator installation file in “Instalacao\Integrador-installer-x.x.x.zip” installation
package in a folder.
2. Change the files which start with “taxbr” in “/etc” folder in order to indicate the server and the
port to access the Webservices.
3. If you change the password in “ws-security.password” property file, you must change the
password of the username “INTTAXBRPAD” in ONESOURCE Portal, using the
“Administração” (Management) module in “Segurança > Usuário”. Access the portal with
“ADM” username in order to access the “Administração” module.

Release: V01.R43 23
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

Setting examples:

# WSClient configuration

wsclient.host=http://localhost:8081

# WSClient Return configuration

wsclient.return.host=http://localhost:8081

# WS-Security

ws-security.username=INTTAXBRPAD

ws-security.password=INT001

4. Run “bin/karaf.bat” to start the integrator.

SERVICE INSTALLATION
Follow the steps below to create the service installer:

1. Run the script ${INTEGRADOR_HOME}/bin/karaf.bat to access the integrator’s console

2. Install the wrapper service with the command: features:install wrapper
3. Create the service installer with the command: wrapper:install -s AUTO_START -n TAXBR-
Integrator -d TAXBR-Integrator -D "TAXBR Integrator Service"
4. If necessary, you must adjust the JVM properties in the created settings’ file:
“${INTEGRADOR_HOME}\etc\TAXBR-Integrator-wrapper.conf”;

Initially, the integrator service is configured to use a maximum 512 Mb (RAM).

Verify if the “wrapper.java.initmemory” parameter has comments. It starts with a “#” sign.

# Initial Java Heap Size (in MB)

#wrapper.java.initmemory=3

# Maximum Java Heap Size (in MB)

wrapper.java.maxmemory=512

It’s recommended to use 1 Gb in the memory parameters for most processings. However, you
need to set till 4 Gb (RAM) if is necessary to integrate big files.

Release: V01.R43 24
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

To configure the integrator service to use 1 Gb (RAM), set the memory configuration properties
as follows:

# Initial Java Heap Size (in MB)

wrapper.java.initmemory=1024

# Maximum Java Heap Size (in MB)

wrapper.java.maxmemory=1024

Attention: Verify if the “wrapper.java.initmemory” parameter no longer has comments. It do

not start with a “#” sign.

5. Run the command “${INTEGRADOR_HOME}\bin\TAXBR-Integrator-service.bat install” to

install the service.

SERVICE RUNNING
net start "TAXBR-Integrator“

SERVICE STOPPING
net start "TAXBR-Integrator“

Note: For more information about the ONESOURCE ECF integrator, access the use guide
“TR_ONESOURCE_Integrator_User_Guide.pdf” in “Manuais” folder in installation package.

Release: V01.R43 25
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

ONESOURCE ECF MESSAGING

DATABASE BY DATABASE INTEGRATION

You can integrate ONESOURCE ECF data with other applications. This feature is available only for the
THOMSON REUTERS tax solutions below:

• DW
• GF
• Smart

Run the ONESOURCE ECF database scripts and also THOMSON REUTERS tax solution’s to the
integration work correctly.

This feature is available only for Oracle database users. It works by synonyms created in ONESOURCE
ECF database. The databases must have the same Oracle instance to ensure a better performance.

First create the synonyms for ONESOURCE ECF integration tables in the database schema of the tax
solution.

Scripts for apply to the database of DW/GF/SMART if they are in separated instances:
create or replace synonym TBR_INT_0000 for TBR_INT_0000[@<database link>];
create or replace synonym TBR_INT_0001 for TBR_INT_0001[@<database link>];
create or replace synonym TBR_INT_0002 for TBR_INT_0002[@<database link>];
create or replace synonym TBR_INT_2002 for TBR_INT_2002[@<database link>];
create or replace synonym TBR_INT_2003 for TBR_INT_2003[@<database link>];
create or replace synonym TBR_INT_2101 for TBR_INT_2101[@<database link>];
create or replace synonym TBR_INT_2105 for TBR_INT_2105[@<database link>];

Release: V01.R43 26
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

Scripts for apply to the database of DW/GF/SMART if they are in the same instance:
create or replace synonym TBR_INT_0000 for <Owner ECF>.TBR_INT_0000;
create or replace synonym TBR_INT_0001 for <Owner ECF>.TBR_INT_0001;
create or replace synonym TBR_INT_0002 for <Owner ECF>.TBR_INT_0002;
create or replace synonym TBR_INT_2002 for <Owner ECF>.TBR_INT_2002;
create or replace synonym TBR_INT_2003 for <Owner ECF>.TBR_INT_2003;
create or replace synonym TBR_INT_2101 for <Owner ECF>.TBR_INT_2101;
create or replace synonym TBR_INT_2105 for <Owner ECF>.TBR_INT_2105;

Note: The database link is optional and should be used only when the database schemas are
located at different Oracle instances.

After creating synonyms, you must run the following scripts in ONESOURCE ECF owner to ensure that
access to recording are provided to the owner of tax solution database.

Scripts for apply to ONESOURCE ECF database, only if the applications are in the same instance:
grant select, insert, delete, update on <Owner ECF>.TBR_INT_0000 to <Owner
Solução Fiscal> with grant option;
grant select, insert, delete, update on <Owner ECF>.TBR_INT_0001 to <Owner
Solução Fiscal> with grant option;
grant select, insert, delete, update on <Owner ECF>.TBR_INT_0002 to <Owner
Solução Fiscal> with grant option;
grant select, insert, delete, update on <Owner ECF>.TBR_INT_2002 to <Owner
Solução Fiscal> with grant option;
grant select, insert, delete, update on <Owner ECF>.TBR_INT_2003 to <Owner
Solução Fiscal> with grant option;
grant select, insert, delete, update on <Owner ECF>.TBR_INT_2101 to <Owner
Solução Fiscal> with grant option;
grant select, insert, delete, update on <Owner ECF>.TBR_INT_2105 to <Owner
Solução Fiscal> with grant option;

Note: Change the expressions <Owner ECF> and <Owner Solução Fiscal> with the correct
name of the used owner.

Release: V01.R43 27
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

ONESOURCE ECF PORTAL

SETTINGS FOR SPED GENERATION

1. Before starting Mensageria (Messaging) module, set the web service address of the SPED file
generation in Administração (Management) module of THOMSON REUTERS ONESOURCE
application.
Access Administração (Management) module in THOMSON REUTERS ONESOURCE
application.
2. Login and access the module as below:

Release: V01.R43 28
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

3. Access Configuração do Sistema (System Settings) screen in Configurações > Configuração

do Sistema as below:

4. Consult the settings of web service address of the SPED file generation.
Access the system settings’ search screen, in Chave de Configuração (Setting key) text field,
enter “ecf”. In the combo box search criterion, enter “inicia com” as below, then click Executar
Consulta (search button):

Release: V01.R43 29
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

5. Edit the settings of web service address of the SPED file generation.
In the search result screen, click “Editar” (edit) button as follows:

6. Change the settings of web service address of the SPED file generation. In system settings edit
screen, change the Valor (value) text field with the correct server address which have the SPED
generation webservice (http://server:port) as below, then click Salvar (Save) to confirm.

Release: V01.R43 30
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

You can share the file with remote work teams that do not have access to the system. To use this
feature, you must enable the FTP access to this folder.

Also, you can download the SPED file directly in the Painel de Controle (Control Panel) screen.
Follow the steps below:

1. After you generate the SPED file in the menu Gerações > ECF, the protocol number is displayed
in the screen’s superior left corner. This number can be used for a further search:

2. Access Painel de Controle (Control Panel) to check the file. The screen allows to perform
many filters, including filter by protocol number.
After selecting the register related to the intended SPED, click Baixar Arquivo(s) (download
files):

Release: V01.R43 31
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

3. After opening the Download de Artefatos dialog box, click Clique aqui to download the file:

4. In this screen you can also check the SPED generation details – and errors if it occurred in this
process.
Click the search icon to access, as follows:

Release: V01.R43 32
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

5. The processing details are available in Resumo dos Parâmetros (parameters resume) tab:

6. To display the possible errors or alerts, select Erros/Alertas tab as below:

Release: V01.R43 33
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

SYSTEM UPDATE

DATABASE UPDATE

PREREQUISITES
1. Download the latest installation package.
2. Linux operating system for environments with high processing rates.

RUN THE LIQUIBASE

• Perform the steps in slide 16 for database update.

Attention: Stop all ECF services for database access.

Release: V01.R43 34
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

PORTAL AND WEBSERVICES UPDATE

PREREQUISITES
1. Download the latest installation package.
2. The application service server must be stopped.
3. Linux operating system for environments with high processing rates.

The installation process comes down to copy the WAR files, from portal and webservices to the folder
of Tomcat installation webapps.

The WAR files are located at distribution package:

WebPortal:

${INSTALLATION_PACKAGE}\Instalacao\Aplicacao_Web\Web_Portal\taxbr-solution-web.war

WebServices:

${ INSTALLATION_PACKAGE }\Instalacao\Aplicacao_Web\Web_Services\taxbr-solution-
webservices.war

Before start TOMCAT, you must copy the WAR files to the following folder:

${TOMCAT_DIR}\webapps\

Release: V01.R43 35
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

MENSAGERIA (MESSAGING) MODULE UPDATE

PREREQUISITES
1. Download the latest installation package.
2. Linux operating system for environments with high processing rates.

The installation process comes down to the following steps:

1. Remove the “Mensageria” module service

2. Backup the /conf folder
3. Install the latest version of “Mensageria” module
4. Update the content of /conf folder with the backup (step 2).
5. Reinstall the “Mensageria” module service
6. Start the “Mensageria” service.

Release: V01.R43 36
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

INTEGRATOR MODULE UPDATE

PREREQUISITES
1. Download the latest installation package.
2. Linux operating system for environments with high processing rates.

The installation process comes down to the following steps:

1. Remove the Integrator module server

2. Backup the files which start with “taxbr.*” in /etc folder
3. Install the latest version of the Integrator module
4. Update the content of /etc folder with the backup (step 2).
5. Reinstall the Integrator module service
6. Start the Integrator service.

Release: V01.R43 37
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

USING THE APPLICATIONS

The ONESOURCE ECF application receives the informations from others applications with export
process in TXT and XML files format and also from database to database, is necessary to import
toONESOURCE ECF application.

Inside THOMSON REUTERS applications structures, we can highlight the following systems:

• MASTERSAF DW
• MASTERSAF GF
• MASTERSAF SMART

MASTERSAF DW APPLICATION
The generation data information was unified for ECF in:

MASTERSAF DW > Conexão Onesource BR > ECF - Escrituração Contábil Fiscal.

The module is designed to allow the companies – which use MASTERSAF DW – to use the same
imported information to the tax solution, in order to keep the integrity of information released in
obligations and dispatched to ECF.

The information will be generated in TXT and XML files, or dispatched from database to database
following the Thomson Reuters default layout and will be consumed by ONESOURCE ECF application.

Onesource ECF module features:

Parâmetros (Parameters) menu:

- Onesource ECF folders

- CNPJ Identification for Registry Central

- CNPJ Registry

- CNPJ Registry by Company

- Integration Parameterization

- Restoration of Accounting Balances Parameterization

Release: V01.R43 38
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

- Ledger Account Parameterization

- SCP Establishments Identification

Geração (Generation) menu:

- Data generation

MASTERSAF DW Prerequisites for information generation:

1. Import the TFIX64 “Plano de Contas Referencial (SPED Contábil)” table in Ferramentas (Tools)
module.
2. Import the following SAFXs tables in Job Servidor (Server Job) module:
• SAFX2002: Tabela do Plano de Contas. The table data generates information for ECF
CAD2002 – Plano de Contas table;
• SAFX2003: Tabela de Centro de Custo. The table data generates information for ECF
CAD2003 – Centro de Custo table;
• SAFX2101: Contas Referenciais x Plano de Contas. The table data generates
information for ECF PAR2101 – Parametrização do Plano de Contas Referencial x
Plano de Contas da Empresa table;
• SAFX2105: Subcontas Correlatas. The table data generates information for ECF
PAR2105 – Associação de Subcontas Correlatas table;
• SAFX01: Arquivo Contábil. The table data generates information for ECF MOV0001 –
Lançamento Contábil table;
• SAFX02: Arquivo de Saldos Mensais. The table data generates information for ECF
MOV0002 – Saldos Contábeis table;
• SAFX80: Arquivo de Saldos Contábeis para Centro de Custo. The table data generates
information for ECF MOV0002 – Saldos Contábeis table.
3. Import the establishments in the Integrator (according to the layout in
TR_ONESOURCE_Manual_Layout_XML.xlsx or
TR_ONESOURCE_Manual_Layout_TXT.xlsx.

Attention: The tables’ data above will be used by the integrator and transferred to
ONESOURCE ECF application.

Release: V01.R43 39
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

MASTERSAF GF APPLICATION
The Onesource ECF module is designed to allow the integration of Mastersaf GF accounting
information with ONESOURCE ECF application.

For more information about how to operate the module, access Menu Principal > Obrigações Fiscais
Federais. Please access the use guide and the manual available in www.mastersaf.com.br, Base de
Conhecimento Cliente > MASTERSAF GF > Manuais Funcionais:
MastersafGF_OnesourceECF_Roteiro_Operacional.pdf

MASTERSAF SMART APPLICATION

The Onesource ECF module is designed in MASTERSAF SMART to allow the integration of accounting
information with ONESOURCE ECF application.

For more information about how to operate the module in “Integração” menu, access the use guide
and the manual available in www.mastersaf.com.br, Base de Conhecimento Cliente > MASTERSAF
SMART > Manuais Funcionais: Mastersaf_Smart_Roteiro_Onesource_ECF.pdf

THOMSON REUTERS ONESOURCE ECF APPLICATION

The ONESOURCE ECF module is designed in order to allow the release of Electronic Tax Assessment
of Income Tax and Social Contributions of Legal Person (ONESOURCE ECF).

For more information about how to operate the ONESOURCE ECF module, access the use guide and
the manual available in www.mastersaf.com.br, Base de Conhecimento Cliente > ONESOURCE BR >
Manuais Funcionais: ONESOURCE_ECF_Roteiro_Utilizacao.pdf

Release: V01.R43 40
Last update: 09/10/2015
THOMSON REUTERS
ONESOURCE™ ECF ONESOURCE ECF TECHNICAL GUIDE ANDOPERACIONAL
MANUAL FEATURES

TECHNICAL SUPPORT
For special aid on technical issues that exceeds the information of this manual, count on Mastersaf
Thomson Reuters Support team.

 (11) 2159-0600 option 01 (Atendimento das Soluções Fiscais – Service of Tax Solutions).

The Technical Support works from Mondays to Fridays (9:00 AM - 6:00 PM).

Release: V01.R43 41
Last update: 09/10/2015