TR ONESOURCE Installation Guide

INSTALLATION GUIDE
THOMSON REUTERS ONESOURCE INSTALLATION GUIDE
TABLE OF CONTENTS
INTRODUCTION ................................................................................................................................................4
REQUIREMENTS FOR INSTALLATION ............................................................................................................4
DOWNLOADING THE APPLICATION ...............................................................................................................4
PREPARING THE ENVIRONMENT ...................................................................................................................5
JDK INSTALLATION ......................................................................................................................................5
SECURITY PROPERTY .................................................................................................................................. 7
CONFIGURING ENVIRONMENTAL VARIABLES.......................................................................................... 7
USING WINDOWS ...................................................................................................................................... 7
USING LINUX .............................................................................................................................................9
INSTALLING THE APPLICATION SERVER (WEB CONTAINER) ................................................................ 10
INSTALLING ORACLE SQLPLUS ................................................................................................................. 11
CREATING AN ORACLE DATABASE SCHEME FOR THE ONESOURCE ................................................... 11
INSTALLATION OF THE MESSAGE SERVER (ACTIVEMQ) ....................................................................... 12
RUNNING THE MESSAGE SERVER (ACTIVEMQ) IN WINDOWS ENVIRONMENT ....................................... 13
PROCEDURES FOR INSTALLATION/PRODUCT UPDATE............................................................................ 14
DATABASE ...................................................................................................................................................... 15
ONESOURCE MESSAGING ..............................................................................................................................17
ONESOURCE INTEGRATOR ........................................................................................................................... 18
PORTAL AND WEB SERVICE .......................................................................................................................... 19
SILENT MODE UPDATE .................................................................................................................................. 19
STARTING THE SERVICES ............................................................................................................................. 20
ACTIVEMQ MODULE .................................................................................................................................. 20
WEB CONTAINER ........................................................................................................................................ 21
PROCESSOR MODULE (MESSAGING)....................................................................................................... 21
INTEGRATOR MODULE .............................................................................................................................. 21
STOPPING THE SERVICES.............................................................................................................................. 21
INTEGRATOR MODULE .............................................................................................................................. 21
PROCESSOR MODULE (MESSAGING)....................................................................................................... 21
WEB CONTAINER ........................................................................................................................................22
ACTIVEMQ MODULE ...................................................................................................................................22
USING THE APPLICATION ..............................................................................................................................22
LICENSING APPLICATION ..............................................................................................................................22
Release: V01.R112
2
Latest update: 03/20/2018
IMPORTING A LICENSE (XML FILE) ...........................................................................................................22

IMPORTING THE DIGITAL CERTIFICATE (PFX) ............................................................................................ 24
CONFIGURATION OF THE TYPE OF ENVIRONMENT (ESOCIAL AND REINF) ............................................ 25
WEBSERVICES SETTINGS (ESOCIAL AND REINF) ........................................................................................ 27
SAFETY PROFILE ........................................................................................................................................... 28
TECHNICAL SUPPORT ................................................................................................................................... 29
Release: V01.R112
3
INTRODUCTION
ONESOURCE is a platform written in Java to assist in the delivery of tax obligations through ECF
(Escrituração Contábil Fiscal), eSocial (Escrituração Fiscal Digital das Obrigações Fiscais, Previdenciárias
e Trabalhistas) and REINF (Escrituração Fiscal Digital de Retenções e Outras Informações Fiscais)
modules. Also, the Management Module is responsible for the configuration required to use the
application and functionality of its modules.
This document contemns the steps to install and update the THOMSON REUTERS ONESOURCE
product.
REQUIREMENTS FOR INSTALLATION
It is very important that software and infrastructure requirements are comply so that ONESOURCE can
run at full capacity.
To suit your environment, please read the Architectural Overview Manual that contains all the
necessary details.
DOWNLOADING THE APPLICATION
After the suitability of your environment (servers, approved platforms), you can use the application.
Use the Download of the Application Manual that contains the steps required to save the application
to your environment.
After this procedure, read the following guidelines to start the application installation process.
Release: V01.R112
4
PREPARING THE ENVIRONMENT
JDK INSTALLATION
The Java Development Kit (JDK) is used as an application execution platform in Java and therefore is one
of the most important prerequisites.
The installation of the JDK is very simple, just enter the Java folder and choose the executable, according
to your operating system:
When starting the executable, simply follow the screens.
• In the starting screen, click <Next>;
Release: V01.R112
5
• In this screen, Java asks if you would like to install some additional item, but it is not necessary;
• In the next screen it is possible to change the Java installation directory by the ‘Change’ button,
however we recommend leaving it in the default folder;
Ready! Java successfully installed.
Release: V01.R112
6
SECURITY PROPERTY
In this new release, the security property to control the encryption policy must be set manually with the
following procedure:
• Locate the file java/<jre_home>/lib/security/java.security in the Java installation;

• Locate the line #crypto.policy=unlimited;
• Remove the symbol '#' from the crypto tag.
This procedure is necessary because Oracle changed the Java security polices for versions 8u151 and
8u152.
For more information, access the following link where you can find a summary of the changes made in
the Java 8u152 version:
http://www.oracle.com/technetwork/java/javase/8u152-relnotes-3850503.html
CONFIGURING ENVIRONMENTAL VARIABLES
With the installation complete, it is now necessary to configure the environment variables. This point is
also very simple and we will guide you on how to carry out the process for Windows and Linux operating
system.
USING WINDOWS
Configuring the environment variables using the Windows operating system.
• Go to the control panel and select the 'System' option;
• When you open the screen, select the ‘Advanced’ settings tab;
Release: V01.R112
7
• Click the ‘Environment Variables’ button;
• On the next screen click the ‘New’ button to create the variable;
• Let's create two variables, as shown below:
Name: JAVA_HOME
Value: Directory where the JDK* was installed. Example:
Release: V01.R112
8
*For REINF Module (Onesource Integrator) only: In this variable it is possible to

inform the directory where the JRE was installed.
Name: JAVA_TOOL_OPTIONS
Value: -Dfile.encoding=UTF8
• Finally, you will need to include JAVA_HOME in the path variable;
• To verify that the variables have been configured correctly, run the java -version command at the
command prompt.
Notice that the contents of the JAVA_TOOL_OPTIONS variable, the JDK version, and 64-bit architecture
appear, this item is of paramount importance.
USING LINUX
To configure the environment variables using the Linux operating system, perform the following steps.
• Open the terminal and enter the information shown below;
Release: V01.R112
9
• Add the variables, by example:
• Save the file and restart the system;
• To verify that the variables have been configured correctly, run the java -version command at the
command prompt.
Note that the contents of the JAVA_TOOL_OPTIONS variable, the JDK* version, and 64-bit architecture
appear, this step is very important.
*For REINF Module (Onesource Integrator) only: In this variable it is possible to inform the
directory where the JRE was installed.
INSTALLING THE APPLICATION SERVER (WEB CONTAINER)
The next step is to install the application server. Choose the server that attends your needs.
To perform the installation and the settings use the guidelines described in the manual according to your
choice:
• Apache Tomcat Installation Guide

• JBOSS Setting Guide
• Weblogic Configuration Manual
Release: V01.R112
10
INSTALLING ORACLE SQLPLUS
It is MANDATORY to have Sqlplus installed on the machine where the installer is run.
CREATING AN ORACLE DATABASE SCHEME FOR THE

ONESOURCE
To create the database schema for ONESOURCE, the following requirements must be considered:
• The character set recommended by Thomson Reuters is WE8MSWIN1252. Do not use UTF8.
• The database password cannot have the character “@”.
• Privileges to be granted:
1. GRANT CONNECT TO <ONESOURCE>

2. GRANT RESOURCE TO <ONESOURCE>
3. GRANT CREATE SESSION TO <ONESOURCE>
4. GRANT CREATE TABLE TO <ONESOURCE>
5. GRANT CREATE SEQUENCE TO <ONESOURCE>
6. GRANT CREATE TRIGGER TO <ONESOURCE>
7. GRANT CREATE PROCEDURE TO <ONESOURCE>
8. GRANT CREATE TYPE TO <ONESOURCE>
9. GRANT CREATE VIEW TO <ONESOURCE>
10. GRANT CREATE SYNONYM TO <ONESOURCE>
Note: Items 1 and 2 are optional and may be replaced by items 3 through 8. No replacement is
required for each other, the applications will continue to function properly.
Release: V01.R112
11
INSTALLATION OF THE MESSAGE SERVER (ACTIVEMQ)
The Apache ActiveMQ is a JMS used to balance the processing load.
Note 1: Use the package of server binaries downloaded through Contact Center:
INS_ONESOURCE-eSOCIAL-ECF-REINF_INSTALACAO-DDMMAAAA.zip
Note 2: Unpack the package into a directory structure that does not have any white space and /
or special characters.
Note 3: The installation of ActiveMQ must be unique for each environment. Homologation and
Production environments are not allowed to share the same ActiveMQ instance. If distinct
environments are pointing to the same ActiveMQ server, there will be several non-conformities in
integrations and processing. Therefore, it is mandatory to follow the recommendation below:
• Homologation environnent – 01 ActiveMQ dedicated

• Ambiente de Produção – 01 ActiveMQ dedicated
Unzip the installation package from the message server “Instalacao\Processamento\Serviço de

Mensagens\Windows\apache-activemq-5.15.2-tr-bin.zip” (or .../Linux/apache-activemq-5.15.2-tr-
bin.tar..gz, depending on the operating system used) in a directory that does not contain spaces and / or
special characters.
After unpacking the file, the directory structure should be, as shown below:
Release: V01.R112
12
The following is a brief description of each folder on the messaging server:
Bin: Contains scripts to start the message server, and the installer of the ActiveMQ Windows
service.
Conf (Setup): Contains scripts for the message server setup.
Data: Contains the log files from the message server and also the high performance message
repository.
Docs: Contains documentation of ActiveMQ.
Lib: Contains the standard libraries of the message server.
Example: Contains examples of ActiveMQ.
Webapps: Contains the monitor of ActiveMQ.
Webapps – demo: Contains examples of ActiveMQ Web.
RUNNING THE MESSAGE SERVER (ACTIVEMQ) IN

WINDOWS ENVIRONMENT
To run the server messages quickly, run “bin/activemq.bat” script.
To run the message server as Windows service, do the following steps:
1. Run the “bin/win64/installService.bat” script;
2. Visit the Windows services. The ActiveMQ service should be available for startup.
Release: V01.R112
13
PROCEDURES FOR INSTALLATION/PRODUCT

UPDATE
After downloading and unpacking the installation package, go to the “Integrador” folder:
In case of update, before start the installer, we recommend that all the server been stopped manually.
For that, follow the instructions in the menu “Stopping the Services” in this document.
Run the Installer as Administrator through the SetupWin.bat or SetupUnix.sh file, depending on the
Server Operating System.
IMPORTANT: By default, the installer sets the environment type to 3 (Pre-Production Fictitious Data). If
you wish to change this type of environment, we provide a system parameter to perform this procedure.
See more information in the topic “Setting the Environment Type” (eSocial and REINF).
At the beginning of the installation or update process, a question will be asked about which modality you
wish to install, due to the compliance of the installer, also taking into account the SaaS mode.
When running the installer, in the first question, it will be necessary to inform the modality of the
installation. For this question there are 2 options:
1. For ON-PREMISES (Default option in which the structure works in the client's company);
2. For SAAS (Template model as a service in Cloud Computing. All modules with the exception of
the integrator will be in the Thomson Reuters data center).
• Therefore, inform which environment will be used, as shown in the image below:
Release: V01.R112
14
• If the informed environment option is 2 (SaaS), the Installer will go directly to the Integrator
Module, performing the Onesource Integrator step, as described in the “Onesource Integrator”
topic in this manual.
• When informing option 1 (On-Premises) a validation of the minimum requirements for the
installation of the product will be performed. This validation is based on the requirements defined
in the Architectural Overview document.
IMPORTANT: Even if there are failures in running the validations of any of the items, the
installation will continue. We strongly recommend that the items listed be evaluated.
DATABASE
In this step the installer automatically creates/updates the base for the current version.
• Enter the data of the Database, as shown below;
Release: V01.R112
15
• In the next step you need to select which module you want to install. The modules available are:
ECF, eSocial or REINF.
• At the beginning of the process the Installer asks if you want to perform the database upgrade.
Type “s” to confirm or “n” to cancel.
Regardless of the choice made in this step, the installation process continues to run until all steps are
completed.
• Enter 's' to start the update. At this point, for a new installation the entire base will be created;
Release: V01.R112
16
If it is an update, the difference process between the current version of the environment and the patch
being applied will be executed.
• Wait for the following message to appear;
• If there is a problem or just want to check the logs, go to the folder

ONESOURCE-eSOCIAL-ECF-REINF_<versão>\Instalacao\Banco_de_Dados\executor:
ONESOURCE MESSAGING
To install/update the ONESOURCE Messaging, the installer asks you to be told which directory you want
to install/update it (if the directory does not exist, it will be created).
The application.properties file with the database data configured in the first step will be automatically
configured:
The installation process in Windows Service is executed in this moment and it is possible to choose the
Windows Service name to be created.
Release: V01.R112
17
In the event of an upgrade, the “/conf” directory will be backed up and, after installation, the previous
settings will be restored.
ONESOURCE INTEGRATOR
To perform the Onesource Integrator installation/update, when you run the installer, you will be
prompted to enter the directory (in case of installation, you must create the directory in advance) as
shown in the following screen:
We offer the possibility to adjust the name of the Windows Service to be installed.
In case of update, the configuration files of the '/etc' directory will be backed up and, after updating, the
previous settings will be restored.
The Windows Service installation process is also currently running, with the possibility of choosing the
name of the Windows Service to be created.
IMPORTANT: For the REINF module, there is a configuration to direct the database of the fiscal solution
to be integrated. Configure these parameters BEFORE starting the integrator. For details on the
parameters use the “Integrator – User Guide“.
Release: V01.R112
18
PORTAL AND WEB SERVICE
In this step we started deploying Portal and Webservice. To do this, it is necessary to answer the
questions asked by the installer, as shown below:
The HTTPS/SSL question should be answer as “s” (Yes) only if the container is set to work in
HTTPS/SSL. When HTTPS/SSL is enabled in the installer some security settings are also enabled in the
artifacts that will be published.
Note: This functionality does not change the container settings.
• Enter the directory where the Web Container is installed.
The ONESOURCE installation was successfully completed.
SILENT MODE UPDATE
The product provides an update feature, where there is no need for the user to type on the installer
screen, we call this install feature in silent mode.
If you want to use this feature, the setup.properties file should be adjusted with the answers already
Release: V01.R112
19
defined, as shown below:
STARTING THE SERVICES
The services must be started in this order for the correct setting of the system:
1. ACTIVEMQ MODULE
• For Windows, start with the Windows service installed.
• For Linux, run the “activemq start” command.
Release: V01.R112
20
2. WEB CONTAINER
• Initialize the Web Container as directed by the container vendor.
3. PROCESSOR MODULE (MESSAGING)
• For Linux, as a background service on Linux, run the “run.sh” script.
4. INTEGRATOR MODULE
• For Linux, run the “karaf start” command.
STOPPING THE SERVICES
INTEGRATOR MODULE
• For Linux, run the “karaf stop” command.
PROCESSOR MODULE (MESSAGING)
• For Linux, as a background service on Linux, run the “stop.sh” script.
Release: V01.R112
21
WEB CONTAINER
• Initialize the Web Container as directed by the container vendor.
ACTIVEMQ MODULE
• For Linux, run the “activemq stop” command.
USING THE APPLICATION
Ready! The installation of ONESOURCE is complete and to access it simply use the url:
http: // <HOST>: <PORT> /taxbr-solution-web/pages/index.jsf
HOST - Server where the web application was installed.

PORT - Port where the web application server is configured.
LICENSING APPLICATION
To use the application, you must import an XML file with the license content.
To purchase your license file, contact Thomson Reuters Contract department.
Without a license file you can log in to the application using the ADM/TRONESRC2015 user, however,
you will only have access to the Management Module. The other modules will be released only after
importing the respective license and can be accessed through the user OPERATOR/OP001.
IMPORTING A LICENSE (XML FILE)
To import a license follow the steps below:
• Enter the ADM/TRONESRC2015 user application;
Release: V01.R112
22
• Click on the “Administração” module;
• Click the ‘Configurações > Licenciamento’ (‘Settings > Licensing’) menu.
• As it is the first time, it will open the screen directly to import a license file.
• Click the “Add ...” button and select the license XML file. Wait for the “Successfully uploaded”
message.
• Click the save icon. Wait for the “Licensing successful” message.
Release: V01.R112
23
• Click the Exit icon to terminate the application and enter the OPERATOR / OP001 user. Licensed
modules will appear on the module screen.
IMPORTING THE DIGITAL CERTIFICATE (PFX)
IMPORTANT: A1 it is the only digital certificate use by the system.
To import a digital certificate in PFX format, follow the steps below:
• Enter the ADM / TRONESRC2015 user application;
• Click on the ‘Administração’ (‘Administration’) module;
• Click the ‘Configurações > Certificado Digital’ (‘Settings > Digital Certificate’) menu;
• Click the “Register” button (represented on the left by a [+] button);
• Click the “Add ...” button;
• Select the digital certificate file with .PFX extension;
• Click the <Open> or <Open> icon;
Release: V01.R112
24
• Inform the certificate password and click in “salvar” (save).
• Define if the certificate will be valid for all companies (field used only when a corporate taxpayer
registry is imported);
• To finish click in “salvar” (save).
E-MAIL CONFIGURATION
• In the Certificate Register step, you can edit the certificate email by clicking the icon .
Release: V01.R112
25
SETTING THE DIGITAL CERTIFICATE OF THE PROSECUTOR
• At the Certificate Registration step, you can inform the corporate taxpayer registry (CNPJ)
represented by the Prosecutor's Digital Certificate by clicking on the icon and include, edit and
/ or remove corporate taxpayer registry (CNPJ) on the ‘CNPJs Representados pelo Procurador’'
corporate taxpayer registry Represented by the Prosecutor' tab.
CONFIGURATION OF THE TYPE OF

ENVIRONMENT (ESOCIAL AND REINF)
The Public Revenue has formalized the use of three types of environments. They are:
1. Production
2. Pre-production real data
3. Pre-Production Fictitious data
For the default installation of ONESOURCE eSocial and MENSAGERIA REINF, we are setting the type of
environment as 3 - Pre-Production Fictitious Data.
We make available in the Management Module a functionality that makes it possible to change this
parameter, in cases in which it needs adjustments.
This feature is found in the ‘Configuração do Sistema’ (‘System Configuration’) menu. Follow the
screenshot below:
Release: V01.R112
26
IMPORTANT: This field can only be changed if the environment has no event issued for an environment
type other than the one you want to change.
WEBSERVICES SETTINGS (ESOCIAL AND REINF)
To configure which webservice of the Public Revenue that the ONESOURCE eSocial and MENSAGERIA
REINF will be communicating one must carry out the procedures in the Administration Module through
the menu ‘Configurações > Configuração de Acesso ao Webservice’ ('Settings > Web service Access
Configuration').
IMPORTANT: In this configuration we also offer the possibility of proxy configuration to access the
webservice of the Public Revenue.
Release: V01.R112
27
SAFETY PROFILE
In order to make data access available to the operator profile, we must first register the taxpayers,
employees and establishments that this profile will have access to.
• For the MENSAGERIA REINF module, an R-1000 event (Taxpayer) must be sent to be available in
the access possibility list.
• For the eSocial ONESOURCE module, an S-1000 event (Employer) must be sent to be available in
the access possibility list.
• For the ONESOURCE ECF module, an establishment must be sent to be available in the access
possibility list.
After performing the integration, the administrator must enter the Management Module and perform the
following steps:
• In the ‘Segurança > Profile Segurança’ (‘Security > Profile Security') menu.
• Click on ‘Acesso a Dado’ (Data Access) and add the employer, establishment and taxpayer who
will have access.
• It will only appear in the possibility list if the events are already pre-integrated.
Release: V01.R112
28
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 1 (Atendimento das Soluções Fiscais –Tax Solutions Services).
The Technical Support works from Mondays to Fridays (9 a.m - 6 p.m).
Release: V01.R112
29

TR ONESOURCE Installation Guide

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

TR ONESOURCE Installation Guide

Hochgeladen von

Copyright:

Verfügbare Formate

INSTALLATION GUIDE

THOMSON REUTERS ONESOURCE INSTALLATION GUIDE

IMPORTING A LICENSE (XML FILE) ...........................................................................................................22

REQUIREMENTS FOR INSTALLATION

DOWNLOADING THE APPLICATION

PREPARING THE ENVIRONMENT

When starting the executable, simply follow the screens.

• In the starting screen, click <Next>;

Ready! Java successfully installed.

• Locate the file java/<jre_home>/lib/security/java.security in the Java installation;

CONFIGURING ENVIRONMENTAL VARIABLES

Configuring the environment variables using the Windows operating system.

• Go to the control panel and select the 'System' option;

• Click the ‘Environment Variables’ button;

• Let's create two variables, as shown below:

*For REINF Module (Onesource Integrator) only: In this variable it is possible to

• Finally, you will need to include JAVA_HOME in the path variable;

• Open the terminal and enter the information shown below;

• Add the variables, by example:

• Save the file and restart the system;

INSTALLING THE APPLICATION SERVER (WEB CONTAINER)

• Apache Tomcat Installation Guide

INSTALLING ORACLE SQLPLUS

CREATING AN ORACLE DATABASE SCHEME FOR THE

• The database password cannot have the character “@”.

1. GRANT CONNECT TO <ONESOURCE>

INSTALLATION OF THE MESSAGE SERVER (ACTIVEMQ)

The Apache ActiveMQ is a JMS used to balance the processing load.

• Homologation environnent – 01 ActiveMQ dedicated

Unzip the installation package from the message server “Instalacao\Processamento\Serviço de

The following is a brief description of each folder on the messaging server:

RUNNING THE MESSAGE SERVER (ACTIVEMQ) IN

To run the server messages quickly, run “bin/activemq.bat” script.

To run the message server as Windows service, do the following steps:

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

PROCEDURES FOR INSTALLATION/PRODUCT

• Enter the data of the Database, as shown below;

• Wait for the following message to appear;

• If there is a problem or just want to check the logs, go to the folder

PORTAL AND WEB SERVICE

Note: This functionality does not change the container settings.

• Enter the directory where the Web Container is installed.

The ONESOURCE installation was successfully completed.

SILENT MODE UPDATE

defined, as shown below:

STARTING THE SERVICES

• For Windows, start with the Windows service installed.

• For Linux, run the “activemq start” command.

• Initialize the Web Container as directed by the container vendor.

3. PROCESSOR MODULE (MESSAGING)

• For Windows, start with the Windows service installed.

• For Linux, as a background service on Linux, run the “run.sh” script.

• For Windows, start with the Windows service installed.

• For Linux, run the “karaf start” command.

STOPPING THE SERVICES

• For Windows, start with the Windows service installed.

• For Linux, run the “karaf stop” command.

PROCESSOR MODULE (MESSAGING)

• For Windows, start with the Windows service installed.

• For Linux, as a background service on Linux, run the “stop.sh” script.

• Initialize the Web Container as directed by the container vendor.

• For Windows, start with the Windows service installed.

• For Linux, run the “activemq stop” command.

USING THE APPLICATION