UPDATE MANUAL

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

TABLE OF CONTENTS
INTRODUCTION............................................................................................................................................ 1
TARGET AUDIENCE ...................................................................................................................................... 1
PREREQUISITES ........................................................................................................................................... 1
PROCEDURE TO START/STOP SERVICES OF ONESOURCE ....................................................................2
DATABASE UPDATE.....................................................................................................................................3
RUNNING IN WINDOWS .......................................................................................................................... 4
RUNNING IN LINUX ................................................................................................................................. 4
UPDATE MESSAGING PROCESS ................................................................................................................ 5
RUNNING MESSAGING MODULE IN CLUSTER ......................................................................................... 7
DATABASE SETTINGS.............................................................................................................................. 8
UPDATE ONESOURCE PORTAL AND WEBSERVICES IN WEBLOGIC...................................................... 9
UPDATE ONESOURCE PORTAL AND WEBSERVICES IN TOMCAT ........................................................ 12
UPDATE ONESOURCE PORTAL AND WEBSERVICES IN JBOSS ............................................................ 13
INTEGRATOR UPDATE............................................................................................................................... 14
TECHNICAL SUPPORT ............................................................................................................................... 16

Release: V01.R60
Latest update: 05/24/2016

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

INTRODUCTION
This document describes the procedures for ONESOURCE eSOCIAL/ECF update.

TARGET AUDIENCE
This document is intended to infrastructure team responsible for the application update.

PREREQUISITES
Files of Database current version

Banco_de_Dados

Files of Web application current version

Portal Web
o Weblogic/Jboss
onesource-taxbr-web.ear
o Tomcat
taxbr-solution-web.war

Web Services
o Weblogic/Jboss
onesource-taxbr-webservices.ear
o Tomcat
taxbr-solution-webservices.war

Files of Processamento(Processing) current version

onesource-messaging-<CurrentVersion>

Release: V01.R59
Latest update: 05/10/2016

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

Files of Integrador (Integrator) current version

tr-taxbr-onesource-integrator-installer-<VersoCorrente>

The following steps describe the procedures for ONESOURCE eSOCIAL/ECF update.

PROCEDURE TO START/STOP SERVICES OF

ONESOURCE
For the correct operation of the solution, it is necessary to follow a sequency of steps to start and stop
the services of ONESOURCE.

The following steps aim to describe the procedure to start OneSource Services:
1. Start ActiveMQ
2. Start Apache Tomcat (ONESOURCE Portal/Webservices)
3. Start ONESOURCE Messaging
4. Start ONESOURCE Integrator
The following steps aim to describe the procedure to stop OneSource Services:
1. Stop ActiveMQ
2. Stop Apache Tomcat (ONESOURCE Portal/Webservices)
3. Stop ONESOURCE Messaging
4. Stop ONESOURCE Integrator
Notice that the ActiveMQ Service must follow the rule below:
1. ActiveMQ is always the first service to be started (mandatory)
2. ActiveMQ is always the last service to be stopped (mandatory).

Release: V01.R59
Latest update: 05/10/2016

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

DATABASE UPDATE
You need to back up the database before continuing the upgrade process.
To create the base of the product we use a tool called 'Liquibase' which connects itself in your
database and performs all creation and load:
Prerequisites for Liquibase usage:

An operational system with a Java virtual machine installed in the workstation which will run
the Liquibase (Oracle Java 7 64 bits);

Have a created user with permissions: CONNECT, RESOURCE, CREATE VIEW;

It is suggested to create a tablespace with the name TR_TAXBR_DATA:

CREATE USER user_taxbr IDENTIFIED BY manager DEFAULT TABLESPACE TR_TAXBR_DATA;
GRANT CONNECT,RESOURCE,CREATE VIEW TO user_taxbr;

This tool can be used on both on Windows and Linux through command line.
Place the 'Liquibase' files in the directory: "Installation\Database" (Instalacao\BancoDeDados).
To set the parameter of the database, change in the file "liquibase.properties" the following values:
url:jdbc:oracle:thin:@<SERVER>:<PORT>/<SERVICES_NAME>
username:<DATABASE_USERNAME>
password:<DATABASE_PASSWORD>
EXAMPLE:
url:jdbc:oracle:thin:@192.168.0.1.:1521/ORCL
username:onesource
password:onesource@123
Note: If usage of the Oracle SID be necessary, change the URL property as below:
Release: V01.R59
Latest update: 05/10/2016

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

url:jdbc:oracle:thin:@<SERVER>:<PORT>:<SID>
username:<DATABASE_USERNAME>
password:<DATABASE_PASSWORD>
Note: Oracle will no longer support the SID in future versions, it is highly recommended to use
SERVICE_NAME instead of SID.

RUNNING IN WINDOWS
For running creation, type the command line "liquibase.bat update"; or, if it is preferable, a SQL file
via "liquibase.bat updateSQL> <filename> .sql" command can be created.

RUNNING IN LINUX
For running liquibase in Linux, type the command "liquibase.sh update" or, if you wish, you can create
a SQL file via "liquibase.sh updateSQL> <filename>.sql" command.

Release: V01.R59
Latest update: 05/10/2016

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

UPDATE MESSAGING PROCESS

The following steps describe the process to update the messaging module:
Stop Messaging service.
As default the service name is ONESOURCE BR Messaging (name defined in the file
INS_ONESOURCE_eSOCIALECF<CurrentVersion>\Instalacao\Processamento\Processador\onesource-messaging<CurrentVersion>\service\win64\wrapper.conf) in the parameter wrapper.ntservice.name.
Uninstall Messaging service:

The UninstallService file is located in the directory: INS_ONESOURCE_eSOCIALECF<CurrentVersion>\Instalacao\Processamento\Processador\onesource-messaging<CurrentVersion>\service\win64\UninstallService.bat

Run the file UninstallService.bat.

Backup the setting file INS_ONESOURCE_eSOCIALECF<CurrentVersion>\Instalacao\Processamento\Processador\onesource-messaging<CurrentVersion>\conf\application.properties.

Remove the folder INS_ONESOURCE_eSOCIALECF<CurrentVersion>\Instalacao\Processamento\Processador\onesource-messaging<CurrentVersion>.
Unzip the installation package of processing module INS_ONESOURCE_eSOCIALECF<CurrentVersion>\Instalacao\Processamento\Processador\onesource-messaging<CurrentVersion>\ in the folder where you removed the older version (which do not have
blanks and/or special characters). The folder structure after unzipping the file must be as
shown below:

Release: V01.R59
Latest update: 05/10/2016

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

Install the service again:

The InstallService file is located in the directory: INS_ONESOURCE_eSOCIALECF<CurrentVersion>\Instalacao\Processamento\Processador\onesource-messaging<CurrentVersion>\service\win64\InstallService.bat

Run the InstallService.bat file.

Note: If administrator permission is needed on the installation service, access the command
prompt in administrator mode for running BAT files. To run these files, the root folder,
where they are, must be accessed.
Find below some short descriptions of each messaging server folder:
Conf Contain scripts for messaging module settings
Lib Contain the default library of messaging module
Data Contain the service logs of messaging module
Service Contain the binary for running messaging module as Windows service

Release: V01.R59
Latest update: 05/10/2016

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

RUNNING MESSAGING MODULE IN CLUSTER

The main objective of the messaging module in cluster is balancing the processing load of the
messages sent to JMS queue.
NOTE 1: When the messaging (processor) is used in cluster, modify the startup.properties file,
(name defined in the file INS_ONESOURCE_eSOCIALECF<CurrentVersion>\Instalacao\Processamento\Processador\onesource-messaging<CurrentVersion>\conf\application.properties).
For a single instance, you must keep the default settings. For more than one, modify the values to
false, as below. Notice the detailed condition for each module:
ONESOURCE ECF MODULE
1. Edit the file /conf/startup.properties
2. Search for <dw> tags and replace all the words true with false.
3. Save and close the file.
Example 1: Image of the file conf/startup.properties with the original content and changed.

Release: V01.R59
Latest update: 05/10/2016

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

MDULO ONESOURCE ESOCIAL

1. Edit the file /conf/esocial.job.properties

2. Search for <autoStartup> tags tags and replace all the words true with false.
3. Save and close the file.

findLotToSend.autoStartup=true

checkOccurrenceConsistency.autoStartup=true

NOTE 2: Unzip each instance in a different folder/server. If it is in the same server and you want to
install as a service, you must modify the wrapper.conf file (name defined in the file
INS_ONESOURCE_eSOCIALECF<CurrentVersion>\Instalacao\Processamento\Processador\onesource-messaging<CurrentVersion>\service\win64\wrapper.conf), in order to the service name be different for each
instance.

DATABASE SETTINGS
In the messaging module installation folder, find the file conf/application.properties and change the
value of the properties below to set the access to the database (you can copy the data from the backup
file created in last step):
db.url=jdbc:oracle:thin:@<SERVER>:<PORT>/<SERVICES_NAME>
db.username=<DATABASE_USERNAME>
db.password=<DATABASE_PASSWORD>
EXAMPLE:
db.url=jdbc:oracle:thin:@192.168.0.1.:1521/ORCL
db.username=onesource
db.password=onesource@123
Note: If usage of Oracle SID is needed, modify the URL property as below:
db.url=jdbc:oracle:thin:@<SERVER>:<PORT>:<SID>
db.username=<DATABASE_USERNAME>
Release: V01.R59
Latest update: 05/10/2016

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

db.password=<DATABASE_PASSWORD>
Note: Oracle will no longer support the SID in future versions, it is highly recommended to use
SERVICE_NAME instead of SID.

UPDATE ONESOURCE PORTAL AND

WEBSERVICES IN WEBLOGIC
To update each Web Portal and Web Services application, consider the following steps:
Update Prerequisites in application server
In case this is the first time performing this action, access Centro de Alteraes do Console de
Administrao (Administrator Console change center) then click Bloquear e Editar (Lock and
Edit).

1. In left panel of console, select Implantaes, find Aplicao Corporativa (corporative

application) then select the checkbox next to corportative application name you want to
update.

Release: V01.R59
Latest update: 05/10/2016

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

2. Click Atualizar (Update).

3. In Localizar Novos Arquivos de Implantao (Locate new implantation files), use Alterar
Caminho (Change the menu path) Button if you want to change the application source file or
change the associated implantation plan.

4. Click Prximo (Next).

Release: V01.R59
Latest update: 05/10/2016

10

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

5. Check your settings then click Finalizar (Finish).

6. To activate this changings, access the Centro de Alteraes do Console de Administrao

and click Ativar Alteraes. (Activate changings).

Release: V01.R59
Latest update: 05/10/2016

11

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

UPDATE ONESOURCE PORTAL AND

WEBSERVICES IN TOMCAT
Update Prerequisites in application server
Stop Tomcat service running.
Delete the preexisting WAR files and folders (with the same WAR name):
o <TOMCAT_DIR>\webapps\taxbr-solution-webservices.war
o <TOMCAT_DIR>\webapps\taxbr-solution-webservices
o <TOMCAT_DIR>\webapps\taxbr-solution-web.war
o <TOMCAT_DIR>\webapps\taxbr-solution-web
The update process comes down to copy the WAR files from Portal Web and Web Services to the
webapps folder of Tomcat installation.
The application WAR files are:
WebPortal:
INS_ONESOURCE_eSOCIAL-ECF<CurrentVersion>\Instalacao\Aplicacao_Web\Web_Portal\taxbrsolution-web.war
WebServices:
INS_ONESOURCE_eSOCIAL-ECF< CurrentVersion >\Instalacao\Aplicacao_Web\Web_Services\taxbrsolution-webservices.war
You must copy to the folder: <TOMCAT_DIR>\webapps\
IMPORTANT: Do not store any kind of backup file in the folder <TOMCAT_DIR>\webapps\ or any
versions or files not used by Tomcat.
After you copy the files to webapps, Just start the Tomcat service.

Release: V01.R59
Latest update: 05/10/2016

12

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

UPDATE ONESOURCE PORTAL AND

WEBSERVICES IN JBOSS
Update Prerequisites in application server
Stop JBoss service running.
Delete the preexisting EAR files in the folder <JBOSS_DIR>/jboss-serverpath/standalone/deployments.
The update process comes down to copy the WAR files from Portal Web and Web Services to the
deployments folder of JBoss installation.
The application WAR files are as follows:
WebPortal:
INS_ONESOURCE_eSOCIALECF<CurrentVersion>\Instalacao\Aplicacao_Web\Web_Services\onesource-taxbr-web.ear
WebServices:
INS_ONESOURCE_eSOCIAL-ECF< CurrentVersion >\Instalacao\Aplicacao_Web\Web_Services
\onesource-taxbr-webservices.ear
The folder <JBOSS_DIR>/jboss-server-path/standalone/deployments must be copied to the directory.
Start the script standalone.sh (for Linux) or standalone.bat (for Windows) located in the folder
/bin of JBoss.

Release: V01.R59
Latest update: 05/10/2016

13

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

INTEGRATOR UPDATE
Update Prerequisites in application Server:
Stop TAXBR-Integrator service running;
Remove the integrator service (Windows):
%INTEGRADOR_DIR%\bin\TAXBR-Integrator-service.bat remove
Backup the files that start with taxbr in the folder <INTEGRADOR_DIR>\etc;
Running the file "karaf.bat" is only possible through the Command Prompt as administrator.
You may not run directly the "karaf.bat" file as below:

Release: V01.R59
Latest update: 05/10/2016

14

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

Steps for package updating:

Remove all the files from the folder <INTEGRADOR_DIR>;
Unzip the file INS_ONESOURCE_eSOCIAL-ECF<VersoCorrente>\Instalacao\tr-taxbronesource-integrator-installer-<VersoCorrente> in the intended directory.
Note: The Integrator includes in the same package versions of social eSOCIAL e do ECF, and it
is necessary to customize if you need to perform only the eSOCIAL Module or ECF Module.
Integrator binaries:
- Linux/eSOCIAL+ECF: tr-taxbr-onesource-integrator-installer-V01RXX.tar.gz
- Windows/eSOCIAL+ECF: tr-taxbr-onesource-integrator-installer-V01RXX.zip
Change the files that starts with taxbr.global in /etc folder (backup files can be used) to
point the server and port where the webservice is located. If the username and password is
changed in this file, the same values in application.properties file set in web application
server must be applied. File example:
# 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
Install and restart TAXBR-Integrator service.
Note: O <INTEGRADOR_DIR> corresponds to the folder where the integrator is installed.
Access the document TR_ONESOURCE_User_Guide.pdf for the installation procedures of
TAXBR-Integrador service.

Release: V01.R59
Latest update: 05/10/2016

15

THOMSON
REUTERS
ONESOURCE
ONESOURCE
ECF

UPDATE
MANUAL
MANUAL
OPERACIONAL

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

(11) 2159-0600 option 01 (Service of Tax Solutions).

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

Release: V01.R59
Latest update: 05/10/2016

16