You are on page 1of 21

MANUAL DE INSTALAO

MASTERSAF DFE MANUAL DE INSTALAO

NDICE

VISO GERAL ........................................................................................................................................................ 2


REQUISITOS PARA INSTALAO ....................................................................................................................... 2
AMBIENTE .......................................................................................................................................................... 2
BANCO DE DADOS ............................................................................................................................................ 4
BAIXANDO OS INSTALADORES DA APLICAO .............................................................................................. 5
INICIANDO O INSTALADOR DO MASTERSAF DFE ........................................................................................... 7
INICIANDO O PORTAL MASTERSAF DFE ..........................................................................................................10
INICIANDO O INTEGRADOR MASTERSAF DFE ................................................................................................ 13
INICIANDO A MENSAGERIA MASTERSAF DFE ................................................................................................ 15
ARQUIVOS DE CONFIGURAO ........................................................................................................................ 16
INSTALADOR..................................................................................................................................................... 16
PORTAL ............................................................................................................................................................. 16
MENSAGERIA .................................................................................................................................................... 17
INTEGRADOR .................................................................................................................................................... 18
CONFIGURAES DIVERSAS ............................................................................................................................. 19
SUPORTE TCNICO ............................................................................................................................................ 20

Verso: 4 1
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

VISO GERAL

REQUISITOS PARA INSTALAO

AMBIENTE

JDK 1.6 (Java Development Kit) instalado.

Varivel de ambiente PATH com o caminho da pasta Bin do JDK adicionado.


o Exemplo Windows: C:\Program Files\Java\jdk1.6\Bin
o Exemplo Linux: /usr/lib/jvm/Java-6-sun/bin

Verso: 4 2
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO
Varivel de ambiente JAVA_HOME apontando para o diretrio de instalao do Java JDK.
o Exemplo Windows: C:\Program Files\Java\jdk1.6
o Exemplo Linux: /usr/lib/jvm/Java-6-sun

Variveis de ambiente no Windows

Variveis de ambiente no Linux

Permisso de sistema para executar o script/bat de instalao.


Permisso para editar arquivos texto como os de extenso .properties e .xml.
Permisso para colocar os executveis do produto para serem chamados durante a inicializao do
sistema (seguir documentao fornecida pela MASTERSAF).

Verso: 4 3
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

BANCO DE DADOS

Criar um banco de dados para o MASTERSAF DFE.


Nota: Necessrio criar um SCHEMA com o nome msaf_dfe
Sentena SQL: create schema msaf_dfe

No MS SQL Server possvel:

Clicar sobre o Banco de dados >> Segurana >> Esquemas;


Com boto direito do mouse >> Novo Esquema.

Exemplo de esquema

Verso: 4 4
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

BAIXANDO OS INSTALADORES DA APLICAO

Acessar o portal do Contact Center MASTERSAF, com usurio e senha fornecidos. Baixar o instalador na
rea de Atualizao de Verso/Patches Mastersaf DF-e.

Importante: A verso do instalador est vinculada a verso do produto, portanto, dever sempre realizar o
download da ultima verso do instalador antes de iniciar a instalao do produto.

Baixe a verso mais recente atravs de uma das abas abaixo:

Obs.: No necessrio realizar o download das duas abas abaixo, basta apenas, realizar o download da
verso mais recente.

Verso: 4 5
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO
Utilize esta aba se for para baixar a verso de atualizao principal.

Utilize esta aba se for para baixar verso 1 ou 2 de patch da verso de atualizao:

Verso: 4 6
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

INICIANDO O INSTALADOR DO MASTERSAF DFE


Acessar a pasta onde os arquivos baixados foram salvos.
Descompactar o dfe-X.X.zip
Via prompt de comando, executar o arquivo:
o iniciar-instalador.bat para Windows.
o iniciar-instalador.sh para Linux.
A cada verso lanada para o mercado, geramos um instalador exclusivo para aquela verso. Sendo
assim, caso o instalador seja da verso 3.22.1, por exemplo, ser realizado download dos artefatos
dessa verso, mesmo que esta verso no seja a mais atual.
No prompt de comando, confirmar a verso que a ser instalada. (Figura 1).

Figura 1 - Inicializando o Instalador Mastersaf DF-e

Escolher um diretrio de instalao do produto (<ENTER> para padro).


A seguir, informao de usurio e senha concedidos pela MASTERSAF, de acordo figura que segue:

Figura 2 - Diretrio de Instalao e Usurio e Senha para Instalao

Aguardar o processamento at receber a mensagem perguntando se deseja instalar todos os


mdulos:

Verso: 4 7
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO
o Se a aquisio foi no modelo SaaS, responder N e instalar somente o mdulo Integrador.
o Caso tenha sido adquirido para instalao In House, responder S.
o Quando realizar uma atualizao, deve-se responder N, pois o Tomcat no dever ser
reinstalado. Apenas devero ser atualizados os mdulos do produto (Portal, Webservice,
Integrador, Extrator, PrinterService, PrinterConsole e etc.).
Depois, escolher qual o Sistema Gerenciador de Banco de Dados (Oracle, SQL Server ou Postgres).
Preencher as informaes relativas ao banco criado para o produto.

Nota: A senha de banco de dados no aparece em tela, portanto, assegurar-se que esteja sendo
digitada corretamente.

Aguardar o processamento at que a mensagem Fim... seja exibida.


Executar o comando para atualizao da base de dados, como demonstrado abaixo (posicionar na
pasta do instalador):

Windows

Linux

Verso: 4 8
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

Importante: Se for necessrio gerar o script para um arquivo, para encaminhar ao administrador do
banco de dados, executar:

o Windows: atualizar-bt.bat updateSQL 1> arquivo.sql 2> erros.log

o Linux: ./atualizar-bd.sh updateSQL > arquivo.sql

(Esse comando ir gerar um arquivo chamado arquivo.sql contendo o script de criao/atualizao


do banco)

Verso: 4 9
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

INICIANDO O PORTAL MASTERSAF DFE

Aps a instalao do produto, vamos dar incio aos mdulos que compe o produto.
Para iniciar o portal da MASTERSAF na pasta tomcat\bin, executar o arquivo:

o startup .bat para Windows;


o startup.sh para Linux;

Windows

Linux

A mensagem que deve ser mostrada com a inicializao do portal, conforme segue abaixo.

Verso: 4 10
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO
Com o portal iniciado, acessar em um navegador o link http://localhost:8080/portal/mvc/login
(onde localhost o IP ou nome da mquina no qual ele foi iniciado).

Caso no tenha um login e senha para acesso, clique em Minha Empresa no tem Cadastro e
cadastre os seus dados para acesso, onde o arquivo de Licena liberado para sua empresa dever ser
localizado atravs do boto Procurar, conforme abaixo:

Verso: 4 11
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO
Confirme os dados apresentados aps a seleo da Licena:

Na prxima tela, clique em Habilitar as empresas cadastradas.


Em seguida, selecionar o arquivo do certificado digital e digite sua senha.

Verso: 4 12
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

INICIANDO O INTEGRADOR MASTERSAF DFE

Para iniciar o Integrador, mdulo responsvel pela integrao ERP <> MASTERSAF DFE, abra o
prompt de comando.
Posicione no diretrio da instalao e execute o arquivo:
o iniciar-integrador.bat para Windows;
o iniciar-integrador.sh para Linux;

Windows

Linux

O servio monitora as pastas de ENTRADA (exemplo: txt/nfse_entrada), processando os arquivos


que contm as notas e enviando-as ao sistema.

Verso: 4 13
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

Depois que um arquivo processado ele movido de acordo com o resultado do processamento:
o Enviadas: quando o arquivo foi enviado com sucesso para o produto.
o Erro: quando ocorre um erro no arquivo processado analisar logs.

Windows

Linux

Verso: 4 14
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

INICIANDO A MENSAGERIA MASTERSAF DFE

O mdulo de Mensageria responsvel por toda a comunicao transmisso dos documentos.


Para inici-lo, abrir o prompt de comando indicando o diretrio da instalao e execute o arquivo:
o iniciar-mensageria.bat para Windows;
o iniciar-mensageria.sh para Linux;

Windows

Linux

Verso: 4 15
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

ARQUIVOS DE CONFIGURAO

INSTALADOR

O arquivo de configurao do instalador MASTERSAF DFE se encontra em:

config\settings.xml

Nele esto as configuraes de Proxy, caso o instalador esteja sendo executado em uma mquina com
acesso restrito Internet.

Configuraes de Proxy no arquivo settings.xml

PORTAL

O arquivo de configurao do portal MASTERSAF DFE se encontra em:

tomcat\conf\context.xml

Nele, esto as configuraes para:


Conexo com a base de dados;
Conta utilizada para envio dos e-mails pelo portal.

Verso: 4 16
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

Arquivo de configurao context.xml

MENSAGERIA

Os arquivos de configurao do portal MASTERSAF DFE se encontram em:

mensageria\config\db.properties
mensageria\config\email.properties

Neles esto as configuraes para:

db.properties: armazena as configuraes de conexo com o banco;

Arquivo db.properites

Verso: 4 17
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

email.properties: armazena as configuraes para os envios de e-mails da mensageria


(quando um documento aprovado, por exemplo).

Arquivo email.properties

INTEGRADOR

Os arquivos de configurao do integrador MASTERSAF DFE se encontram em:

Integrador\integrador.properties

Neles esto as configuraes do integrador, explicadas no manual de parametrizao.

Verso: 4 18
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

CONFIGURAES DIVERSAS
VARIVEL DE AMBIENTE DFE_LOG4J(PORTAL/WEBSERVICE)

Varivel de ambiente utilizada para customizar o arquivo padro de configurao do LOG4J. Esta varivel
utilizada pelos mdulos portal e/ou webservice.

DFE_LOG4J={diretrio}
Sendo:
DFE_LOG4J = Nome da varivel de ambiente, valor fixo.
{diretrio} = (diretrio root que ir conter as pastas portal e/ou webservice contendo o
arquivo de propriedades)

Exemplos:

- Windows: Varivel 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: Varivel 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 no seja utilizado a estrutura de pastas descrita acima ou o arquivo


log4j.properties no esteja disponvel nestes diretrios, o sistema ir carregar a configurao padro.

Verso: 4 19
Atualizado em: 07/06/2016
MASTERSAF DFE MANUAL DE INSTALAO

VARIVEL DE AMBIENTE DFE_EHCACHE

Varivel de ambiente que pode ser utilizada pelos mdulos abaixo para configurar o diretrio que ir gerar
os arquivos temporrios do ehCache:

- Portal
- Webservice
- Mensageria

SUPORTE TCNICO
Para dvidas ou problemas, abra um chamado no Contact Center ou entre em contato com nossa equipe de
Suporte Tcnico MASTERSAF pelo Telefone:

(11) 2159-0600 opo 2 (Atendimento das Solues DFE).


Nosso horrio de atendimento de segunda sexta-feira de 9h s 18h.

Verso: 4 20
Atualizado em: 07/06/2016