MANUAL DE INSTALAO

MASTERSAF DFE

MANUAL DE INSTALAO

NDICE
QUE VALORES [MASTERSAF DFE] TRAZEM PARA VOC?
1. VISO GERAL E REQUISITOS PARA INSTALAO ...................................................................................... 2
1.1. AMBIENTE ......................................................................................................................................... 2
1.2. BANCO DE DADOS ........................................................................................................................... 4
2. BAIXANDO OS INSTALADORES DO DFE MASTERSAF ....................................................................... 5
3. INICIANDO O INSTALADOR DO MASTERSAF DFE .............................................................................. 6
4. INICIANDO O PORTAL MASTERSAF DFE ............................................................................................. 9
5. INICIANDO O INTEGRADOR MASTERSAF DFE................................................................................... 12
6. INICIANDO A MENSAGERIA MASTERSAF DFE ................................................................................... 14
7. ARQUIVOS DE CONFIGURAO .......................................................................................................... 15
7.1.INSTALADOR .................................................................................................................................... 15
7.2. PORTAL ............................................................................................................................................ 15
7.3. MENSAGERIA .................................................................................................................................. 16
7.4. INTEGRADOR ................................................................................................................................... 17

Verso: 3

MASTERSAF DFE

MANUAL DE INSTALAO

1. VISO GERAL E REQUISITOS PARA INSTALAO

1.1. AMBIENTE

JDK 1.6 (Java Development Kit) instalado.

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

Verso: 3

Exemplo Windows: C:\Program Files\Java\jdk1.6\Bin

Exemplo Linux: /usr/lib/jvm/Java-6-sun/bin

Varivel de ambiente JAVA_HOME apontando para o diretrio de instalao do Java JDK.

o

Exemplo Windows: C:\Program Files\Java\jdk1.6

Exemplo Linux: /usr/lib/jvm/Java-6-sun

2

MASTERSAF DFE

MANUAL DE INSTALAO

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: 3

MASTERSAF DFE

MANUAL DE INSTALAO

1.2. 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: 3

MASTERSAF DFE

MANUAL DE INSTALAO

2. BAIXANDO OS INSTALADORES DO DFE MASTERSAF

Acessar portal Contact Center MASTERSAF, com usurio e senha fornecidos. Baixar o instalador na rea
de Atualizao de Verso do 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.

Verso: 3

MASTERSAF DFE

MANUAL DE INSTALAO

3. 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:

iniciar-instalador.bat para Windows.

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: 3

MASTERSAF DFE

MANUAL DE INSTALAO

Se a aquisio foi no modelo SaaS, responder N e instalar somente o mdulo Integrador.

Caso tenha sido adquirido para instalao In House, responder S.

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: 3

MASTERSAF DFE

MANUAL DE INSTALAO

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

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

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: 3

MASTERSAF DFE

MANUAL DE INSTALAO

4. 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:

startup .bat para Windows;

startup.sh para Linux;

Windows

Linux

Verso: 3

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

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: 3

10

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: 3

11

MASTERSAF DFE

MANUAL DE INSTALAO

5. 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;

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: 3

12

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.

Erro: quando ocorre um erro no arquivo processado analisar logs.

Windows

Linux

Verso: 3

13

MASTERSAF DFE

MANUAL DE INSTALAO

6. 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;

iniciar-mensageria.sh para Linux;

Windows

Linux

Verso: 3

14

MASTERSAF DFE

MANUAL DE INSTALAO

7. ARQUIVOS DE CONFIGURAO
7.1. 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

7.2. PORTAL
O arquivo de configurao do portal MASTERSAF DFE se encontra em:
tomcat\conf\context.xml
Nele, esto as configuraes para:

Verso: 3

Conexo com a base de dados;

Conta utilizada para envio dos e-mails pelo portal.

15

MASTERSAF DFE

MANUAL DE INSTALAO

Arquivo de configurao context.xml

7.3. 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: 3

16

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

7.4. 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: 3

17