MANUAL DE INSTALAÇÃO
MANUAL DE INSTALAÇÃO
MASTERSAF DFE MANUAL DE INSTALAÇÃO
ÍNDICE
QUE VALORES [MASTERSAF DFE] TRAZEM PARA VOCÊ?
1. VISÃO GERAL E REQUISITOS PARA INSTALAÇÃO ...................................................................................... 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 CONFIGURAÇÃO .......................................................................................................... 15
7.1.INSTALADOR .................................................................................................................................... 15
7.2. PORTAL ............................................................................................................................................ 15
7.3. MENSAGERIA .................................................................................................................................. 16
7.4. INTEGRADOR ................................................................................................................................... 17
Versão: 3 1
MASTERSAF DFE MANUAL DE INSTALAÇÃO
1. VISÃO GERAL E REQUISITOS PARA INSTALAÇÃO
1.1. AMBIENTE
• JDK 1.6 (Java Development Kit) instalado.
• Variável 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
• Variável de ambiente JAVA_HOME apontando para o diretório de instalação do Java JDK.
o Exemplo Windows: C:\Program Files\Java\jdk1.6
o Exemplo Linux: /usr/lib/jvm/Java-6-sun
Versão: 3 2
MASTERSAF DFE MANUAL DE INSTALAÇÃO
Variáveis de ambiente no Windows
Variáveis de ambiente no Linux
• Permissão de sistema para executar o script/bat de instalação.
• Permissão para editar arquivos texto 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 (seguir documentação fornecida pela MASTERSAF).
Versão: 3 3
MASTERSAF DFE MANUAL DE INSTALAÇÃO
1.2. BANCO DE DADOS
• Criar um banco de dados para o MASTERSAF DFE.
Nota: Necessário criar um SCHEMA com o nome msaf_dfe
Sentença SQL: create schema msaf_dfe
No MS SQL Server é possível:
• Clicar sobre o Banco de dados >> Segurança >> Esquemas;
• Com botão direito do mouse >> Novo Esquema.
Exemplo de esquema
Versão: 3 4
MASTERSAF DFE MANUAL DE INSTALAÇÃO
2. BAIXANDO OS INSTALADORES DO DFE MASTERSAF
Acessar portal Contact Center MASTERSAF, com usuário e senha fornecidos. Baixar o instalador na área
de “Atualização de Versão” do DF-e.
Importante: A versão do instalador está vinculada a versão do produto, portanto, deverá sempre realizar o
download da ultima versão do instalador antes de iniciar a instalação do produto.
Versão: 3 5
MASTERSAF DFE MANUAL DE INSTALAÇÃO
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:
o iniciar-instalador.bat para Windows.
o iniciar-instalador.sh para Linux.
• A cada versão lançada para o mercado, geramos um instalador exclusivo para aquela versão. Sendo
assim, caso o instalador seja da versão 3.22.1, por exemplo, será realizado download dos artefatos
dessa versão, mesmo que esta versão não seja a mais atual.
• No prompt de comando, confirmar a versão que a ser instalada. (Figura 1).
Figura 1 - Inicializando o Instalador Mastersaf DF-e
• Escolher um diretório de instalação do produto (<ENTER> para padrão).
• A seguir, informação de usuário e senha concedidos pela MASTERSAF, de acordo figura que segue:
Figura 2 - Diretório de Instalação e Usuário e Senha para Instalação
• Aguardar o processamento até receber a mensagem perguntando se deseja instalar todos os
módulos:
Versão: 3 6
MASTERSAF DFE MANUAL DE INSTALAÇÃO
o Se a aquisição foi no modelo SaaS, responder “N” e instalar somente o módulo Integrador.
o Caso tenha sido adquirido para instalação In House, responder “S”.
o Quando realizar uma atualização, 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.).
• Depois, escolher qual o Sistema Gerenciador de Banco de Dados (Oracle, SQL Server ou Postgres).
• Preencher as informações relativas ao banco criado para o produto.
Nota: A senha de banco de dados não 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 atualização da base de dados, como demonstrado abaixo (posicionar na
pasta do instalador):
Windows
Linux
Versão: 3 7
MASTERSAF DFE MANUAL DE INSTALAÇÃO
• IMPORTANTE: Se for necessário 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 criação/atualização
do banco)
Versão: 3 8
MASTERSAF DFE MANUAL DE INSTALAÇÃO
4. INICIANDO O PORTAL MASTERSAF DFE
• Após a instalação do produto, vamos dar início aos módulos que compõe 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 inicialização do portal, conforme segue abaixo.
Versão: 3 9
MASTERSAF DFE MANUAL DE INSTALAÇÃO
• Com o portal iniciado, acessar em um navegador o link http://localhost:8080/portal/mvc/login
(onde localhost é o IP ou nome da máquina no qual ele foi iniciado).
• 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: 3 10
MASTERSAF DFE MANUAL DE INSTALAÇÃ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: 3 11
MASTERSAF DFE MANUAL DE INSTALAÇÃO
5. INICIANDO O INTEGRADOR MASTERSAF DFE
• Para iniciar o Integrador, módulo responsável pela integração ERP <> MASTERSAF DFE, abra o
prompt de comando.
• Posicione no diretório da instalação e execute o arquivo:
o iniciar-integrador.bat para Windows;
o iniciar-integrador.sh para Linux;
Windows
Linux
• O serviço monitora as pastas de ENTRADA (exemplo: txt/nfse_entrada), processando os arquivos
que contém as notas e enviando-as ao sistema.
Versão: 3 12
MASTERSAF DFE MANUAL DE INSTALAÇÃO
• 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
Versão: 3 13
MASTERSAF DFE MANUAL DE INSTALAÇÃO
6. INICIANDO A MENSAGERIA MASTERSAF DFE
• O módulo de Mensageria é responsável por toda a comunicação transmissão dos documentos.
• Para iniciá-lo, abrir o prompt de comando indicando o diretório da instalação e execute o arquivo:
o iniciar-mensageria.bat para Windows;
o iniciar-mensageria.sh para Linux;
Windows
Linux
Versão: 3 14
MASTERSAF DFE MANUAL DE INSTALAÇÃO
7. ARQUIVOS DE CONFIGURAÇÃO
7.1. INSTALADOR
O arquivo de configuração do instalador MASTERSAF DFE 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
7.2. PORTAL
O arquivo de configuração do portal MASTERSAF DFE se encontra em:
tomcat\conf\context.xml
Nele, estão as configurações para:
• Conexão com a base de dados;
• Conta utilizada para envio dos e-mails pelo portal.
Versão: 3 15
MASTERSAF DFE MANUAL DE INSTALAÇÃO
Arquivo de configuração context.xml
7.3. MENSAGERIA
Os arquivos de configuração do portal MASTERSAF DFE se encontram em:
mensageria\config\db.properties
mensageria\config\email.properties
Neles, estão as configurações para:
• db.properties: armazena as configurações de conexão com o banco;
Arquivo db.properites
Versão: 3 16
MASTERSAF DFE MANUAL DE INSTALAÇÃO
• email.properties: armazena as configurações para os envios de e-mails da mensageria
(quando um documento é aprovado, por exemplo).
Arquivo email.properties
7.4. 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 de parametrização.
Versão: 3 17