Mastersaf DFE e Banco de Dados Oracle

MANUAL DE
INSTALAÇÃO/ATUALIZAÇÃO
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
ÍNDICE
VISÃO GERAL ........................................................................................................................................................ 3
TOPOLOGIA DO AMBIENTE SAAS ................................................................................................................... 4
TOPOLOGIA DO AMBIENTE IN HOUSE........................................................................................................... 4
REQUISITOS PARA INSTALAÇÃO ....................................................................................................................... 5
AMBIENTE .......................................................................................................................................................... 5
BANCO DE DADOS ............................................................................................................................................ 7
INICIANDO A INSTALAÇÃO ................................................................................................................................ 13
ARQUIVOS DE CONFIGURAÇÃO PARA UMA INSTALAÇÃO PADRÃO .......................................................... 18
INSTALADOR..................................................................................................................................................... 18
PORTAL ............................................................................................................................................................. 18
MENSAGERIA ................................................................................................................................................... 20
INTEGRADOR .................................................................................................................................................... 21
PRINTER CONSOLE .......................................................................................................................................... 21
PRINTER SERVICE ........................................................................................................................................... 22
EXTRATOR........................................................................................................................................................ 22
INICIANDO O INTEGRADOR .............................................................................................................................. 26
INICIANDO O PRINTER CONSOLE E O PRINTER SERVICE ............................................................................ 28
INICIANDO A MENSAGERIA .............................................................................................................................. 30
INICIANDO UMA ATUALIZAÇÃO ......................................................................................................................... 31
INICIANDO UMA ATUALIZAÇÃO MANUAL........................................................................................................ 37
CONFIGURAÇÕES DIVERSAS .............................................................................................................................. 41
SUPORTE TÉCNICO ............................................................................................................................................ 42
Versão: 8
Atualizado em: 09/05/2017
2
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
VISÃO GERAL
O MASTERSAF DFE V3 é comercializado em dois tipos de plataformas:
In House: Toda a aplicação é instalada no ambiente do cliente.
SaaS: Parte da aplicação fica nos servidores da Thomson Reuters e outra parte fica instalada no
ambiente cliente, conforme especificado abaixo:
Ambiente SaaS Thomson Reuters
⋅
Portal;
⋅
WebService;
⋅
Mensageria.
Ambiente SaaS Cliente
⋅
Integrador/Conectores;
⋅
Printer Service;
⋅
Printer Console;
⋅
Extrator.
O MASTERSAF DFE V3 é um produto desenvolvido na linguagem Java, composto por diversas aplicações.
Algumas são executadas apenas com o Java (Stand Alone), no entanto, outras precisam de um Servidor de
Aplicação Web.
Aplicações Java Stand Alone
⋅
Integrador/Conectores;
⋅
Mensageria;
⋅
Printer Service;
⋅
Printer Console;
⋅
Extrator.
Versão: 8
Atualizado em: 09/05/2017
3
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Aplicações com Servidor Aplicação Web
⋅
Portal;
⋅
Web service.
TOPOLOGIA DO AMBIENTE SAAS
TOPOLOGIA DO AMBIENTE IN HOUSE
Versão: 8
Atualizado em: 09/05/2017
4
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
REQUISITOS PARA INSTALAÇÃO
Hardware e Software: Requisitos estão descritos no documento Requisitos e Sizing no Contact Center.
Instalador MASTERSAF DFE V3: Utilizado para instalação e/ou atualização do produto, está disponível
para download no Contact Center.
Nota: Caso não tenha credenciais (usuário/senha) para acessar o Contact Center, entre em contato com
Customer Care (e-mail: [email protected]).
AMBIENTE
•
Java JDK (Java Development Kit) ou JRE (Java Runtime Environment) instalado. Verifique as versões
homologadas no documento de Requisitos e Sizing.
•
Editar variável de ambiente PATH adicionando o caminho da pasta “bin” da versão Java instalado.
Exemplos:
•
⋅
Windows: C:\Program Files\Java\jdk1.6\bin
⋅
Linux: /usr/lib/jvm/Java-6-sun/bin
Se JDK criar variável de ambiente JAVA_HOME, se JRE criar a variável JRE_HOME, apontando para o
diretório de instalação da versão Java instalado. Exemplos:
⋅
Linux: /usr/lib/jvm/Java-6-sun
Variáveis de ambiente Linux
Versão: 8
Atualizado em: 09/05/2017
5
MASTERSAF DFE V3
⋅
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Windows: C:\Program Files\Java\jdk1.6
Variáveis de ambiente Windows
•
Permissão de sistema para executar os scripts bat/sh de instalação.
•
Permissão para editar arquivos de configuração como os de extensão .properties e .xml.
•
Permissão para colocar os executáveis do produto para serem chamados durante a inicialização do
sistema.
Versão: 8
Atualizado em: 09/05/2017
6
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Permissão de usuário/diretório
BANCO DE DADOS
Este procedimento é exclusivo para clientes que adquiriram o produto na modalidade in House.
•
Criar um banco de dados para o MASTERSAF DFE.
Nota 1: Consulte o documento Requisitos e Sizing para saber quais bancos de dados e versões que
estão homologados.
Nota 2: Necessário criar um SCHEMA com o nome msaf_dfe.
•
Sentença SQL para criar o Schema
•
•
create schema msaf_dfe
Orientação para criar Schema no MS SQL
•
Clicar sobre o Banco de dados > Segurança > Esquemas;
•
Com botão direito do mouse > Novo Esquema.
Versão: 8
Atualizado em: 09/05/2017
7
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Exemplo de Schema
•
Usuário para o instalação/atualização do banco de dados deve ter permissão DDL (Data Definition
Language, create, alter, drop de tabelas, procedures, views, functions, etc.).
•
O mesmo usuário poderá ser utilizado nas outras aplicações do MASTERSAF DFE
(mensageria/portal/webservice), porém, como requisito, é necessário que o usuário tenha permissão
DML (Data Manipulation Language, insert, update, delete nas tabelas).
•
Exemplo de permissão de usuário banco Oracle:
GRANT CREATE DATABASE LINK;
GRANT CREATE MATERIALIZED VIEW;
GRANT CREATE PROCEDURE;
GRANT CREATE PUBLIC SYNONYM;
GRANT CREATE ROLE;
GRANT CREATE SEQUENCE;
GRANT CREATE SYNONYM;
GRANT CREATE TABLE;
GRANT CREATE TRIGGER;
GRANT CREATE TYPE;
GRANT CREATE VIEW;
GRANT CREATE SESSION;
GRANT UNLIMITED TABLESPACE;
•
Banco SQL permissão DDL e DML
DDL – Data Definition Language - Linguagem de Definição de Dados.
CREATE– criar banco de dados, tabelas, colunas.
Versão: 8
Atualizado em: 09/05/2017
8
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
DROP - remover um objeto no banco de dados.
ALTER – altera a estrutura da base de dados
TRUNCATE – remover todos os registros de uma tabela, incluindo todos os espaços alocados
para os registros são removidos. Limpa a tabela por completo.
COMMENT – adicionar comentários ao dicionário de dados.
RENAME – para renomear um objeto.
DML – Data Manipulation Language - Linguagem de Manipulação de Dados.
INSERT – inserir dados em uma tabela.
UPDATE – atualiza os dados existentes em uma tabela.
DELETE – exclui registros de uma tabela.
CALL – chamar um subprograma PL/SQL.
EXPLAIN PLAN – explicar o caminho de acesso aos dados.
LOCK TABLE – controle de concorrência.
Nota: Necessário que o DBA responsável pela empresa avalie e crie o user conforme política interna da
empresa, respeitando os requisitos.
IMPORTANTE: Quando utilizado o Oracle 12 deve ser configurado o argumento conforme abaixo:
•
Dhibernate.dialect_resolvers=br.com.mastersaf.pacote.resolver.DfeDialectResolver
No servidor de aplicação web Tomcat, editar o arquivo "catalina.bat" (Windows) ou "catalina.sh"
(Linux) no caminho: \tomcat\bin\ e incluir o argumento acima na mesma linha de comando onde
são declaradas as variáveis de memória da JVM. Exemplo:
set CATALINA_OPTS=Dhibernate.dialect_resolvers=br.com.mastersaf.pacote.resolver.DfeDialectResolver Dfile.encoding=UTF-8 -Duser.language=pt -Duser.country=BR -Xmx1g -Xms1g -XX:PermSize=512m
-XX:MaxPermSize=512m
Nos demais servidores, incluir o argumento no mesmo local onde já existem os demais argumentos
enviados para a JVM, por exemplo, encoding=UTF8.
Versão: 8
Atualizado em: 09/05/2017
9
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
BAIXANDO O INSTALADOR
Para instalar ou atualizar o produto MASTERSAF DFE V3 é necessário utilizar um Instalador.
A cada quarenta e cinco dias é lançada uma nova versão do produto e a cada quinze dias um novo patch,
através deste ciclo quinzenalmente (terças-feiras 18h00, salvo pontualidades que poderão ser notificadas
com antecedência) disponibiliza-se no Contact Center um novo Instalador do MASTERSAF DFE V3.
Exemplo do ciclo de liberações do Instalador:
Ciclo de Liberação de Versão/Patch
O Instalador fica disponível para download no Contact Center menu Atualização de Versão/Patches –
MasterSAF DF-e.
Contact Center – Atualização de Versão/Patches
Nota 1: Caso não tenha credenciais (usuário/senha) para acessar o Contact Center, solicitar credenciais ao
Customer Care (e-mail: [email protected]).
Versão: 8
Atualizado em: 09/05/2017
10
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Sempre estarão disponíveis para download dois Instaladores: um referente à Versão e outro ao Patch.
Atualização de Versão > DF-e V3: Neste local estará disponível para download o Instalador de uma
Versão do produto, somente a última lançada (na evidência abaixo a versão 3.45.0).
Atualização de Versão
Patches > DF-e V3: Neste local estará disponível para download o Instalador de um Patch do produto,
somente o último lançado (na evidência abaixo 3.45.1).
Atualização de Patches
Para obter a versão/patch mais recente do Instalador do produto, observe sempre os dois locais
evidenciados acima, conforme o ciclo de liberação, em um determinado momento a versão será a mais
recente e em outro momento o patch será o mais recente.
Nota 2: Não é necessário realizar o download da versão e do patch, basta realizar o download da versão ou
Versão: 8
Atualizado em: 09/05/2017
11
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
patch que pretende instalar/atualizar.
Nota 3: A versão do instalador está vinculada a versão do produto, portanto sempre deverá realizar o
download da versão/patch do instalador antes de iniciar a instalação/atualização do produto.
Nota 4: Em caso de atualização, por exemplo, se estiver utilizando a versão 3.46.0 e pretenda atualizar
para 3.47.1, será necessário fazer o download somente do Instalador da versão 3.47.1 (O instalador é
acumulativo).
Nota 5: No mesmo local de download do Instalador, é disponibilizado outro link para download do
Release Notes; documento que descreve todas as alterações liberadas na nova versão/patch do produto.
Recomendamos a leitura na íntegra deste documento antes de iniciar o processo de instalação/atualização
do produto.
Download Release Notes
Versão: 8
Atualizado em: 09/05/2017
12
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
INICIANDO A INSTALAÇÃO
•
Acessar o diretório onde Instalador foi salvo.
•
Descompactar o arquivo Instalador dfe-X.X.zip (exemplo: dfe_v3.46.zip)
•
Via prompt de comando, navegue até o diretório descompactado e execute o arquivo:
⋅
⋅
•
Windows: iniciar-instalador.bat
Linux: ./iniciar-instalador.sh
Caso o instalador seja da versão 3.46.0, por exemplo, será realizado download dos artefatos dessa
versão, mesmo que esta não seja a mais atual.
•
No prompt de comando, confirmar a versão que será instalada (Figura 1).
Figura 1 - Inicializando o Instalador MasterSAF DF-e
•
Escolher um diretório de instalação do produto (Figura 2).
IMPORTANTE: O nome do diretório de instalação não deverá conter espaços e/ou acentuação.
Versão: 8
Atualizado em: 09/05/2017
13
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Figura 2 – Diretório de instalação
O instalador faz download (host http://pylon.dfe.MasterSAF.com.br) dos artefatos, com isso, neste
momento deve informar se existir o proxy na rede.
Figura 3 - Configuração de Proxy
•
Informar usuário e senha do Repositório MasterSAF fornecidos pelo Customer Care (Figura 4).
Figura 4 - Usuário e Senha para Instalação
•
Aguardar o processamento até receber a mensagem perguntando se deseja instalar todos os
módulos:
⋅
Cliente SaaS (aquisição do produto como Serviço)
Recomendamos responder “N” (Não) e optar por instalar somente as aplicações necessárias
para este modelo de aquisição do produto, por exemplo: Integrador, Printer Service, Printer
Console e Extrator.
⋅
Cliente In House (aquisição do produto para instalação em servidor local)
Recomendamos responder “S” (Sim) de maneira que todas as aplicações sejam instaladas.
Versão: 8
Atualizado em: 09/05/2017
14
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Escolher qual o Sistema Gerenciador de Banco de Dados e preencher as demais informações
•
relativas ao banco de dados criado para o produto (Figura 5).
Figura 5 – Exemplo de configuração do banco de dados OK
Nota 1: Ao digitar a senha de banco de dados, a mesma não aparecerá em tela, portanto assegure-se
que esteja digitando corretamente.
Nota 2: Cliente SaaS também deverá responder as perguntas sobre dados de conexão com o banco,
informando qual o banco de dados utilizado, contudo, utilizará respostas padrão <ENTER> para as
demais.
O instalador vai emitir uma mensagem de que não foi possível realizar a conexão com o banco de dados
com a configuração informada. Responda Sim (s) para continuar.
Figura 6 – Exemplo de configuração do banco de dados que falhou
•
Serão realizados os downloads dos artefatos e demais procedimentos de instalação. Aguardar o
processamento até que a mensagem de ‘instalação concluída com sucesso’ seja exibida.
Figura 7 – Exemplo do fim da instalação
Versão: 8
Atualizado em: 09/05/2017
15
MASTERSAF DFE V3
•
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Para Cliente SaaS a instalação do produto está concluída. Verifique agora como iniciar os serviços da
aplicação no tópico Iniciando Integrador.
•
Para Cliente In House é necessário seguir com os procedimentos abaixo para gerar a estrutura do
banco de dados. É possível gerar a estrutura do banco de dados de duas maneiras:
a) Através do instalador padrão (processo recomendado) ou;
b) Através de script (arquivo.sql) que pode ser executado na console do banco de dados.
•
Instalador padrão:
⋅
Após finalizar a instalação da aplicação (procedimento descrito nos itens acima) ainda no
prompt de comando, navegue até o diretório em que o MasterSAF DFE V3 foi instalado,
acesse o diretório “\instalador” e execute o arquivo:
⋅
Windows: atualizar-bd.bat update
⋅
Linux: ./atualizar-bd.sh update
Exemplo Windows
Exemplo Linux
⋅
Aguardar o processamento até que a mensagem de atualização com sucesso seja exibida.
Liquibase Update Successful
Versão: 8
Atualizado em: 09/05/2017
16
MASTERSAF DFE V3
•
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Via Script:
⋅
Após finalizar a instalação da aplicação, ainda no prompt de comando, navegue até o
diretório em que o MASTERSAF DFE V3 foi instalado, acesse o diretório “\instalador” e
execute o procedimento:
⋅
Windows: atualizar-bt.bat updateSQL 1> arquivo.sql 2> erros.log
Onde: arquivo.sql nome do arquivo de script que será gerado
erros.log nome do arquivo de log da geração do script
⋅
Linux: ./atualizar-bd.sh updateSQL > arquivo.sql
Onde: arquivo.sql nome do arquivo de script que será gerado
⋅
O comando acima irá gerar um arquivo de script (arquivo.sql), após execução do comando é
necessário aguardar o final do processamento. O arquivo gerado deverá ser encaminhado ao
responsável pelo banco (administrador do banco) para que o mesmo possa executar o script
via console.
Nota 1: Para geração do Script é importante que o procedimento anterior (Instalador Padrão) não tenha
sido executado, pois a geração do script toma como base a versão da aplicação que está sendo instalada
versus a versão atual do banco (no caso de uma nova instalação espera-se que o banco esteja zerado, sem
estrutura alguma, apenas com o Schema, conforme mencionado no item Requisitos para Instalação deste
documento).
Nota 2: O script será gerado de acordo com as informações que foram incluídas durante a fase de
instalação do produto, por exemplo: se foi informado que o Banco de Dados é Oracle então será gerado um
script para este banco de dados. Se precisar de um script para banco MS SQL, durante a instalação deverá
informar que o banco de dados é MS SQL Server.
Versão: 8
Atualizado em: 09/05/2017
17
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
ARQUIVOS DE CONFIGURAÇÃO PARA UMA
INSTALAÇÃO PADRÃO
INSTALADOR
O arquivo de configuração do instalador MASTERSAF DFE V3 se encontra em:
•
config\settings.xml
Nele estão as configurações de Proxy, caso o instalador esteja sendo executado em uma máquina com
acesso restrito à Internet.
Configurações de Proxy no arquivo settings.xml
PORTAL
Mais de um servidor de aplicação web estão homologados, consulte manual de Requisitos e Sizing.
Na instalação padrão do MASTERSAF DFE V3 o produto disponibiliza o Tomcat.
Os arquivos de configuração do Tomcat são:
• tomcat\conf\context.xml e;
Versão: 8
Atualizado em: 09/05/2017
18
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
• tomcat\conf\server.xml
No arquivo context.xml configura-se:
•
Conexão com a base de dados;
•
maxActive - O número máximo de conexões ativas que podem ser alocadas, ao mesmo tempo.
Indicar 0 para não ter limite.
•
maxIdle - Número máximo de conexões que pode permanecer ociosa, aguardando. Indicar 0
para não ter limite.
•
maxWait - Tempo máximo de espera em milissegundos para se obter uma conexão ou de espera
de resultado de uma conexão.
•
Conta de email para serviços de envio de e-mail.
Arquivo de configuração context.xml
Nota 1: Recomendados que a configuração de email, apesar de estar disponível no arquivo context.xml, seja
feita via portal, conforme Manual Operacional Módulo Administração do Sistema.
No arquivo server.xml configura-se:
•
<Connector port=”8080”... >: A porta padrão é 8080, este parâmetro deverá ser alterado caso seja
necessário utilizar outra porta para acesso a aplicação.
Para outros servidores Web, consulte orientações de deploy nos manuais específicos para cada servidor de
aplicação disponível no Contact Center.
Versão: 8
Atualizado em: 09/05/2017
19
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
MENSAGERIA
Os arquivos de configuração da Mensageria do MASTERSAF DFE se encontram em:
•
mensageria\config\db.properties
•
mensageria\config\email.properties
Neles encontram-se as configurações para:
•
db.properties: armazena as configurações de conexão com o banco;
•
_initial_pool_size: Indica quantidade mínima que o recurso irá alocar;
•
_max_active: Indica o número máximo de conexões que o recurso irá alocar.
Arquivo db.properties
• email.properties: Armazena as configurações para os envios de e-mails da mensageria (quando um
documento é aprovado, por exemplo).
Versão: 8
Atualizado em: 09/05/2017
20
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Arquivo email.properties
Nota 1: Recomendados que a configuração de email, apesar de estar disponível no arquivo email.properties,
seja feita via portal, conforme Manual Operacional Módulo Administração do Sistema.
INTEGRADOR
Os arquivos de configuração do integrador MASTERSAF DFE se encontram em:
• Integrador\integrador.properties
Neles estão as configurações do integrador, explicadas no Manual Operacional Módulo Integrador.
Nota 1: Caso utilize outro integrador da MasterSAF (Conector SAP/EBS/INFOR) verifique o manual de cada
conector no Contact Center.
Nota 2: Caso utilize integrador de terceiros, verifique com o responsável do mesmo para parametrizar.
PRINTER CONSOLE
Para iniciar o Printer Console, é necessário configurá-lo informando o caminho/endereço do Printer Service.
Esta configuração pode ser realizada de duas formas:
a) Editar o arquivo iniciar-printerconsole.bat ou .sh, e incluir “set
PRINTER_SERVICE_URL=http://localhost:9090/printerservice”* antes da linha de comando
existente no arquivo OU;
Versão: 8
Atualizado em: 09/05/2017
21
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
b) Definir uma variável de ambiente no sistema operacional com o nome “PRINTER_SERVICE_URL” e
valor “http://localhost:9090/printerservice”*.
* é o caminho/endereço do Printer Service.
Pra mais detalhes, consulte o Manual Printer DFE V3 disponível no Contact Center.
PRINTER SERVICE
Os arquivos de configuração do printer Service MASTERSAF DFE se encontram em:
• Printer_DIR\config\config.properties
Detalhes da configuração, favor consultar o manual do Printer DFE V3 disponível no Contact Center.
EXTRATOR
O arquivo de configuração do extrator do MASTERSAF DFE encontra-se em:
• extrator\extrator.xml
Detalhes da configuração, favor consultar o manual de Parametrização do Extrator DFE disponível no
Contact Center.
Versão: 8
Atualizado em: 09/05/2017
22
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
INICIANDO O PORTAL MASTERSAF DFE
•
Após a instalação do produto, vamos iniciar as aplicações que compõe o produto.
•
Este procedimento é exclusivo para clientes que adquiriram o produto na modalidade In House.
•
A seguir o procedimento é manual (via executável), caso queira instalar via serviço do Windows, deve
verificar o manual Serviços do Windows disponível no Contact Center.
•
Para iniciar o Portal acessar o diretório de instalação \tomcat\bin executar o arquivo:
⋅
Windows: startup.bat
⋅
Linux: ./startup.sh
Windows
Linux
•
Abaixo segue mensagem que será apresentada ao final da inicialização do portal.
Portal iniciado
Versão: 8
Atualizado em: 09/05/2017
23
MASTERSAF DFE V3
•
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Com o portal iniciado, acessar em um navegador o link http://localhost:8080/portal (onde localhost
é o IP ou nome da máquina no qual ele foi iniciado, 8080 é a porta padrão).
•
Caso não tenha um login e senha para acesso, clique em “Minha Empresa não tem Cadastro” e
cadastre os seus dados para acesso, onde o arquivo de Licença liberado para sua empresa deverá ser
localizado através do botão Procurar, conforme abaixo:
Versão: 8
Atualizado em: 09/05/2017
24
MASTERSAF DFE V3
•
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Confirme os dados apresentados após a seleção da Licença:
•
Na próxima tela, clique em Habilitar as empresas cadastradas.
•
Em seguida, selecionar o arquivo do certificado digital e digite sua senha.
Versão: 8
Atualizado em: 09/05/2017
25
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
INICIANDO O INTEGRADOR
•
A seguir o procedimento é manual (via executável), caso queira instalar via serviço do Windows, deve
verificar o manual Serviços do Windows disponível no Contact Center.
•
Para iniciar o Integrador, aplicação responsável pela integração ERP <> MASTERSAF DFE, abra o
prompt de comando.
•
Posicione no diretório da instalação \integrador e execute o arquivo:
⋅
Windows: iniciar-integrador.bat
⋅
Linux: ./iniciar-integrador.sh
Windows
Linux
Versão: 8
Atualizado em: 09/05/2017
26
MASTERSAF DFE V3
•
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
O serviço monitora os diretórios de entrada (exemplo: txt/nfse_entrada, txt/nfe_entrada,
txt/xxx_entrada), processando os arquivos gerados pelo sistema de origem e enviando-os para o
MASTERSAF DFE V3.
Obs.: Orientamos a leitura do Manual Operacional Módulo Integrador disponibilizado no Contact
Center na Base de conhecimento.
•
Depois que um arquivo é processado ele é movido de acordo com o resultado do processamento:
⋅
xxx_enviadas: quando o arquivo foi enviado com sucesso para o produto.
⋅
xxx_erro: quando ocorre um erro no arquivo processado (analisar logs em
\integrador\log\integrador.log).
Windows
Linux
Versão: 8
Atualizado em: 09/05/2017
27
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
INICIANDO O PRINTER CONSOLE E O PRINTER
SERVICE
•
A seguir o procedimento é manual (via executável), caso queira instalar via serviço do Windows, deve
verificar o manual Serviços do Windows disponível no Contact Center.
•
Para iniciar o printer service, aplicação responsável pela impressão de documento, abra o prompt
de comando.
•
Posicione no diretório da instalação\printer console e execute o arquivo:
⋅
Windows: iniciar-printerservice.bat
⋅
Linux: ./ iniciar-printerservice.sh
Windows
•
Para iniciar o printer console, aplicação responsável pela configuração das impressoras, abra o
prompt de comando.
•
Posicione no diretório da instalação \printer console e execute o arquivo:
⋅
Windows: iniciar-printerconsole.bat
⋅
Linux: ./ iniciar-printerconsole.sh
Versão: 8
Atualizado em: 09/05/2017
28
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Windows
Deve acessar a URL http://localhost:3000/ para cadastrar a impressora e realizar as configurações
desejadas:
Printer Console
Versão: 8
Atualizado em: 09/05/2017
29
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
INICIANDO A MENSAGERIA
•
A aplicação Mensageria é responsável por toda a comunicação e transmissão dos documentos com
ambientes da SEFAZ e Prefeituras.
•
Este procedimento é exclusivo para clientes que adquiriram o produto na modalidade In House.
•
A seguir o procedimento é manual (via executável), caso queira instalar via serviço do Windows, deve
verificar o manual Serviços do Windows disponível no Contact Center.
•
Para iniciar, abrir o prompt de comando acessar o diretório de instalação\mensageria e executar o
arquivo:
⋅
Windows: iniciar-mensageria.bat
⋅
Linux: ./iniciar-mensageria.sh
Windows
Linux
Versão: 8
Atualizado em: 09/05/2017
30
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
INICIANDO UMA ATUALIZAÇÃO
•
Parar todos os serviços/aplicações do produto MASTERSAF DFE V3;
•
Faça um backup da aplicação completa.
Nota 1: Caso não seja possível o backup completo, faça um backup dos arquivos de configuração, abaixo
alguns exemplos de arquivos:
⋅
tomcat: context.xml
⋅
mensageria: db.properties e email.properties
•
Acessar o diretório onde o atualizador foi salvo.
•
Descompactar o atualizador dfe-X.X.zip (exemplo: dfe_v3.46.zip).
Nota 2: Orientamos que copie todo o conteúdo descompactado, e vá para a pasta “instalador”, apague
a pasta "lib" e cole todo o conteúdo descompactado. Após isso, deve inicie o processo de atualização.
•
Via prompt de comando, navegue até o diretório descompactado ou a pasta do Instalador e execute
o arquivo:
•
⋅
Windows: iniciar-instalador.bat
⋅
Linux: ./iniciar-instalador.sh
No prompt de comando, confirmar a versão que será atualizada. (Figura 1).
Versão: 8
Atualizado em: 09/05/2017
31
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Figura 2 - Inicializando o atualizador MasterSAF DF-e
•
Informe o diretório onde o produto já está instalado. (Figura 2).
Figura 2 – Diretório de instalação
O atualizador faz download (host http://pylon.dfe.MasterSAF.com.br) dos artefatos, com isso, neste
momento deve informar o Proxy se existir na rede.
Figura 3 - Configuração de proxy
•
A seguir, é necessário informar o usuário e senha do repositório de atualização MasterSAF fornecidos
pelo Customer Care. (Figura 4).
Figura 4 - Usuário e Senha para atualização
Versão: 8
Atualizado em: 09/05/2017
32
MASTERSAF DFE V3
•
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Aguardar o processamento até receber a mensagem perguntando se deseja instalar todos os
módulos:
⋅
Cliente SaaS (aquisição do produto como Serviço)
Recomendamos responder “N” (Não) e optar por instalar somente as aplicações necessárias
para este modelo de aquisição do produto, por exemplo: Integrador, Printer Service, Printer
Console e Extrator.
⋅
Cliente In House, deve-se responder “N”, pois o Tomcat não deverá ser reinstalado.
Apenas deverão ser atualizados os módulos do produto (Portal, WebService, Integrador,
Extrator, PrinterService, PrinterConsole e etc.).
•
Escolher qual o Sistema Gerenciador de Banco de Dados e preencher as demais informações
relativas ao banco de dados criado para o produto (Figura 5).
Figura 5 – Exemplo de configuração do banco de dados
Nota 1: Ao digitar a senha de banco de dados, a mesma não aparecerá em tela, portanto assegure-se
que esteja digitando corretamente.
Nota 2: Cliente SaaS também deverá responder as perguntas sobre dados de conexão com o banco,
informando qual o banco de dados utilizado, contudo, utilizará respostas padrão <ENTER> para as
demais.
O instalador vai emitir uma mensagem de que não foi possível realizar a conexão com o banco de dados
com a configuração informada. Responda Sim (s) para continuar.
Versão: 8
Atualizado em: 09/05/2017
33
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Figura 6 – Exemplo de configuração do banco de dados que falhou
•
Serão realizados os downloads dos artefatos e demais procedimentos de instalação. Aguardar o
processamento até que a mensagem de instalação concluída com sucesso seja exibida.
Figura 7 – Exemplo do fim da instalação
•
Caso tenha as aplicações em outro servidor ou no mesmo servidor (exemplo: mensageria1 e
mensageria2), deve realizar a atualização manual copiando a pasta lib e o mensageria.jar.
Exemplo com mais de uma mensageria
Versão: 8
Atualizado em: 09/05/2017
34
MASTERSAF DFE V3
•
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Atualização padrão:
⋅
Após finalizar a atualização da aplicação (procedimento descrito nos itens acima) ainda no
prompt de comando, navegue até o diretório em que o MASTERSAF DFE V3, acesse o
diretório “\instalador” e execute o arquivo:
⋅
Windows: atualizar-bd.bat update
⋅
Linux: ./atualizar-bd.sh update
Exemplo Windows
Exemplo Linux
⋅
Aguardar o processamento até que a mensagem de atualização com sucesso seja exibida.
Liquibase Update Successful
•
Via Script:
⋅
Após finalizar a atualização da aplicação, ainda no prompt de comando, navegue até o
diretório em que o MASTERSAF DFE V3 foi instalado, acesse o diretório “\instalador” e
execute o procedimento:
⋅
Windows: atualizar-bt.bat updateSQL 1> arquivo.sql 2> erros.log
Onde: arquivo.sql nome do arquivo de script que será gerado
erros.log nome do arquivo de log da geração do script
Versão: 8
Atualizado em: 09/05/2017
35
MASTERSAF DFE V3
⋅
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Linux: ./atualizar-bd.sh updateSQL > arquivo.sql
Onde: arquivo.sql nome do arquivo de script que será gerado
⋅
O comando acima irá gerar um arquivo de script (arquivo.sql), após execução do comando é
necessário aguardar o final do processamento. O arquivo gerado deverá ser encaminhado ao
responsável pelo banco (administrador do banco) para que o mesmo possa executar o script
via console.
Nota 1: Para geração do Script é importante que o procedimento anterior (Atualização Padrão) não
tenha sido executado, pois a geração do script toma como base a versão da aplicação que está sendo
instalada versus a versão atual do banco (no caso de uma nova instalação espera-se que o banco esteja
zerado, sem estrutura alguma, apenas com o Schema conforme mencionado no item Requisitos para
Instalação deste documento).
Nota 2: O script será gerado de acordo com as informações que foram incluídas durante a fase de
instalação do produto, por exemplo: se foi informado que o Banco de Dados é Oracle então o script
gerado neste momento será para um banco de dados Oracle. Se precisar de um script para banco MS
SQL, durante a instalação deverá informar que o banco de dados é MS SQL Server.
Versão: 8
Atualizado em: 09/05/2017
36
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
INICIANDO UMA ATUALIZAÇÃO MANUAL
•
Parar todos os serviços/aplicações do produto MASTERSAF DFE V3;
•
Faça um backup da aplicação completa.
Nota 1: Cliente In House deve atualizar todas as aplicações, conforme contratado.
Nota 2: Cliente SaaS deve atualizar somente as aplicações Integrador/Extrator/Printer Service e Printer
console, conforme contratado.fix
•
ALTERAR SENHA
Excluir a pasta: alterarsenha\lib
Copiar/substituir os arquivos:
•
⋅
alterarsenha\lib\*
⋅
alterarsenha\alterarsenha.jar
⋅
\alterar-senha.bat ou alterarsenha\alterar-senha.sh
EXTRATOR
Excluir a pasta: extrator\lib
Copiar/substituir os arquivos:
•
⋅
extrator\lib\*
⋅
extrator\extrator.jar
⋅
extrator\iniciar-extrator.bat ou extrator\iniciar-extrator.sh
INSTALADOR
Excluir a pasta: instalador\bd
Copiar/substituir os arquivos:
⋅
instalador\bd\bd-changes\*
⋅
instalador\bd\lib\*
⋅
instalador\bd\liquibase*.jar
⋅
instalador\atualizar-bd.bat ou instalador\atualizar-bd.sh
Versão: 8
Atualizado em: 09/05/2017
37
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
Verificar a necessidade de merge manual dos arquivos: instalador\bd\liquibase.properties.
IMPORTANTE: Este arquivo possui as configurações de conexão com o banco de dados. Para
atualizar este arquivo, é necessário editar e comparar os arquivos manualmente. Ele não deve ser
substituído.
•
ATUALIZAÇÃO DO BANCO DE DADOS
Após realizar o procedimento do Tópico “INSTALADOR”, execute o comando
“instalador\atualizar-bd.bat update” ou “instalador\atualizar-bd.sh update”.
•
INTEGRADOR
Excluir a pasta: integrador\lib
Copiar/substituir os arquivos:
⋅
integrador\lib\*
⋅
integrador\integrador.jar
⋅
integrador\iniciar-integrador.bat ou integrador\iniciar-integrador.sh
Verificar a necessidade de merge manual dos arquivos: integrador\integrador.properties.
IMPORTANTE: Este arquivo possui as configurações do integrador (diretórios, urls do
WebService e printer). Para atualizar este arquivo, é necessário editar e comparar os arquivos
manualmente. Ele não deve ser substituído.
•
MENSAGERIA
Excluir a pasta: mensageria\lib
Copiar/substituir os arquivos:
⋅
mensageria\lib\*
⋅
mensageria\mensageria.jar
⋅
mensageria\iniciar-mensageria.bat ou mensageria\iniciar-mensageria.sh
Verificar a necessidade de merge manual dos arquivos:
⋅
mensageria\config\db.properties
⋅
mensageria\config\email.properties
⋅
mensageria\log4j.properties
Versão: 8
Atualizado em: 09/05/2017
38
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
IMPORTANTE: Estes arquivos possuem as configurações de conexão com banco de dados, email e diretório para geração de logs. Para atualizar estes arquivos, é necessário editar e
comparar os arquivos manualmente. Eles não devem ser substituídos.
•
PRINTER CONSOLE
Excluir a pasta: printerconsole\lib
Copiar/substituir os arquivos:
⋅
printerconsole\lib\*
⋅
printerconsole\printerconsole.war
⋅
printerconsole\warserver.jar
⋅
printerconsole\iniciar-printerconsole.bat ou printerconsole\iniciar-printerconsole.sh
Se o ambiente for Windows, atualizar também:
•
⋅
printerconsole\wrapper.exe
⋅
printerconsole\installService.bat
⋅
printerconsole\uninstallService.bat
⋅
printerconsole\wrapper.conf
PRINTER SERVICE
Excluir a pasta: printerservice\lib
Copiar/substituir os arquivos:
⋅
printerservice\lib\*
⋅
printerservice\printerservice.jar
⋅
printerservice\iniciar-printerservice.bat ou printerservice\iniciar-printerservice.sh
Se o ambiente for Windows, atualizar também:
⋅
printerservice\wrapper.exe
⋅
printerservice\installService.bat
⋅
printerservice\uninstallService.bat
⋅
printerservice\wrapper.conf
Verificar a necessidade de merge manual do arquivo:
⋅
Versão: 8
Atualizado em: 09/05/2017
printerservice\config\config.properties
39
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
IMPORTANTE: Este arquivo possui as configurações de diretórios e portas utilizadas pelo
Printer-Service. Para atualizar este arquivo, é necessário editar e comparar os dois arquivos
manualmente. Ele não deve ser substituído.
•
WEBSERVICE
Copiar/substituir os arquivos:
⋅
tomcat\webapps\webservice.war
Excluir pasta tomcat\webapps\webservice
•
PORTAL
Copiar/substituir os arquivos:
⋅
tomcat\webapps\portal.war
Excluir pasta tomcat\webapps\portal
•
TOMCAT
Verificar a necessidade de merge manual do arquivo:
⋅
tomcat\conf\context.xml
IMPORTANTE: Este arquivo possui as configurações da conexão de banco de dados e e-mail.
Para atualizar este arquivo, é necessário editar e comparar os dois arquivos manualmente.
Ele não deve ser substituído.
Versão: 8
Atualizado em: 09/05/2017
40
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
CONFIGURAÇÕES DIVERSAS
VARIÁVEL DE AMBIENTE DFE_LOG4J (PORTAL/WEBSERVICE)
Variável de ambiente utilizada para customizar o arquivo padrão de configuração do LOG4J. Esta variável é
utilizada pelos módulos Portal e/ou WebService.
•
DFE_LOG4J={diretório}
Sendo:
DFE_LOG4J = Nome da variável de ambiente, valor fixo.
{diretório} = (diretório root que irá conter as pastas portal e/ou WebService contendo o
arquivo de propriedades)
•
Exemplos:
⋅
Windows: Variável de Ambiente: DFE_LOG4J=C:\opt\log4j
O arquivo log4j.properties deverá estar em:
C:\opt\log4j\portal\log4j.properties
e/ou
C:\opt\log4j\webservice\log4j.properties
⋅
Linux: Variável de Ambiente: DFE_LOG4J=/home/usuario/logger
O arquivo log4j.properties deverá estar em:
/home/usuario/logger/portal/log4j.properties
e/ou
/home/usuario/logger/webservice/log4j.properties
IMPORTANTE: Caso não seja utilizado à estrutura de pastas descrita acima ou o arquivo
log4j.properties não esteja disponível nestes diretórios, o sistema irá carregar a configuração
padrão.
Versão: 8
Atualizado em: 09/05/2017
41
MASTERSAF DFE V3
MANUAL DE INSTALAÇÃO/ATUALIZAÇÃO
SUPORTE TÉCNICO
Para dúvidas ou problemas, abra um chamado no Contact Center e entre em contato com nossa equipe de
Suporte Técnico MasterSAF pelo telefone:

(11) 2159-0600 opção 2 (Atendimento das Soluções DFE).
Nosso horário de atendimento é de segunda à sexta-feira de 9h às 18h.
Versão: 8
Atualizado em: 09/05/2017
42