ÍNDICE SERVIÇOS DO WINDOWS MASTERSAF DFE

(1)

(2)

Versão: V3.64.1

Atualizado em: 23/10/2018

2

ÍNDICE

INICIANDO OS MÓDULOS COMO SERVIÇO DO WINDOWS VIA APACHE PROCRUN... 3

INSTALAÇÃO ... 3

CONFIGURAÇÕES AVANÇADAS... 4

CONFIGURAR LOG DA APLICAÇÃO COM NÍVEL DEBUG... 5

REMOVER SERVIÇO ... 6

INICIANDO OS MÓDULOS COMO SERVIÇO DO WINDOWS VIA WRAPPER ... 7

MENSAGERIA ... 7

INTEGRADOR ... 8

EXTRATOR ... 8

PRINTER SERVICE ... 9

PRINTER CONSOLE ... 9

INICIANDO OS MÓDULOS COMO SERVIÇO DO WINDOWS VIA WRAPPER (YAJSW) ... 11

MENSAGERIA ... 11

INTEGRADOR ... 11

EXTRATOR ...12

PRINTER SERVICE ... 13

PRINTER CONSOLE ... 14

REMOVER SERVICO WRAPPER YAJSW ... 15

INICIANDO O TOMCAT (PORTAL E WEBSERVICE) COMO SERVIÇO DO WINDOWS ... 16

ATUALIZAÇÃO DO “WRAPPER JSW” PARA “WRAPPER YAJSW” ... 22

PROCEDIMENTO PARA ATUALIZAÇÃO ... 22

MENSAGERIA ... 23 INTEGRADOR ... 23 EXTRATOR ... 23 PRINTER SERVICE ... 23 PRINTER CONSOLE ... 23 OBSERVAÇÕES ... 24 SUPORTE TÉCNICO... 25

(3)

Versão: V3.64.1

3

INICIANDO OS MÓDULOS COMO SERVIÇO DO

WINDOWS VIA APACHE PROCRUN

Para executar os módulos: Mensageria, Integrador, Extrator, Printer Service e Printer Console como serviços do Windows utilizando a ferramenta Apache Daemons Procrun, siga os passos abaixo que mostram como a configuração deve ser realizada.

INSTALAÇÃO

Finalize a Instalação dos módulos do MASTERSAF DFE (versão 3.30.1 ou superior).

Por padrão, os arquivos “.bat” vem preparados para sistemas operacionais 64 bits (x64). Em ambientes 32 bits (x86) é necessário editar o arquivo “<modulo> - criar servico.bat” de cada módulo, segue exemplo:

“extrator – criar servico.bat” - Encontrado na pasta “servico-windows” de cada módulo (por exemplo: “c:/mastersaf/extrator/servico-windows/extrator – criar servico.bat”) e alterar a variável “executavel” de “procrun-x64.exe” para “procrun-x86.exe”, como mostrado abaixo:

O instalador configura estes arquivos “.bat”, conforme o caminho da instalação informado. Se o local onde os processos forem executados não for o caminho original, é necessário alterar também a variável “caminhoInstalacao”, informando o caminho do módulo, como mostrado a seguir.

(4)

Versão: V3.64.1

4

Realizadas as verificações dos passos acima, basta apenas executar o arquivo “.bat” alterado. Se tudo ocorrer bem, receberá a seguinte mensagem:

CONFIGURAÇÕES AVANÇADAS

Se for necessário alterar a configuração de inicialização dos serviços ou as configurações do Java após a instalação de um serviço, é possível visualizar a sua janela de configuração, abrindo o arquivo “<modulo> - editar servico.bat” disponível na pasta “servico-windows” de cada módulo. Exemplo: “c:/mastersaf/extrator/servico-windows/extrator – editar servico.bat”.

Navegando pelas as abas desta tela, é possível alterar todas as propriedades avançadas do serviço, tais como: o nome de exibição do serviço, inicialização manual ou automática, nível de log e caminhos para os arquivos de log, configurações da JVM, parâmetros de memória, inicialização do Java, entre

(5)

Versão: V3.64.1

5

CONFIGURAR LOG DA APLICAÇÃO COM NÍVEL DEBUG

Para configurar o nível de LOG de uma aplicação do MASTERSAF DFE como DEBUG, quando o mesmo está sendo executado via serviço ProcRun, é necessário executar o arquivo de edição do próprio serviço, por exemplo, da aplicação Extrator “<dir instalação do Mastersaf DFE

V3>/extrator/servico-windows/extrator – editar servico.bat”, ir na janela “Logging” selecionar o nível “Debug”.

E depois, ir à janela “Java” no campo “Java Options”, deixe a opção “Use default” marcada e acrescente os argumentos abaixo:

• Dcom.sun.management.jmxremote.port=8070

• Dcom.sun.management.jmxremote.ssl=false

• Dcom.sun.management.jmxremote.authenticate=false

(6)

Versão: V3.64.1

6

exclusiva, ou seja, nenhuma outra aplicação poderá estar utilizando a mesma porta. Fica como um ponto de atenção para quando for ativar o nível DEBUG em mais de uma aplicação do MASTERSAF DFE V3.

REMOVER SERVIÇO

Para remover um serviço existente você tem duas opções:

1. Executar o arquivo “<modulo> - remover servico.bat” disponível na pasta “servico-windows” de cada módulo. Exemplo: “c:/mastersaf/extrator/servico-windows/extrator – remover

servico.bat”.

2. Se o arquivo acima não existir mais, é possível executar o comando de exclusão do serviço pelo prompt de comando do windows, navegando até a pasta onde estão os arquivos executáveis do Apache Procrun. Exemplo: “c:/mastersaf/extrator/servico-windows”.

Em seguida execute o comando abaixo, substituindo “nomeDoServico” pelo nome do serviço que deseja excluir:

(7)

Versão: V3.64.1

7

INICIANDO OS MÓDULOS COMO SERVIÇO DO

WINDOWS VIA WRAPPER

Para executar os módulos: Mensageria, Integrador, Extrator, Printer Service e Printer Console como serviços do Windows utilizando a ferramenta JAVA SERVICE WRAPPER, siga os passos abaixo que mostram como a configuração deve ser realizada.

ATENÇÃO: Esta versão do Wrapper será descontinuada a partir da versão 3.59.0 do MASTERSAF DFE.

Para mais informações clique AQUI.

MENSAGERIA

Para iniciar o módulo da ‘Mensageria’ como ‘Serviço’, execute os procedimentos abaixo:

Obs.: Os arquivos em questão são gerados pelo instalador na pasta ‘raiz’ da mensageria.

• Configurar o arquivo ‘wrapper.conf’ de acordo com timezone da região (Ex: -

Duser.timezone=America/Sao_Paulo);

Obs.: Configure, somente, se seu fuso-horário for diferente do fuso de São Paulo.

• Executar o arquivo ‘installService.bat’;

(8)

Versão: V3.64.1

8

INTEGRADOR

Para iniciar o módulo do ‘Integrador’ como ‘Serviço’, execute os procedimentos abaixo:

Obs.: Os arquivos em questão são gerados pelo instalador na pasta ‘raiz’ do integrador.

• Iniciar o serviço do Windows chamado ‘Mastersaf DF-e IntegradorTxt – V3’.

EXTRATOR

Para iniciar o módulo do ‘Extrator’ como ‘Serviço’, execute os procedimentos abaixo:

Obs.: Os arquivos em questão são gerados pelo instalador.

• Criar, se não existir, a pasta ‘log’ dentro da pasta ‘raiz’ do extrator;

• Se necessário, executar o arquivo ‘configurar-extrator.bat’ para realizar as configurações do

módulo;

(9)

Versão: V3.64.1

9

PRINTER SERVICE

Para iniciar o módulo do ‘Printer Service’ como ‘Serviço’, execute os procedimento abaixo:

Obs.: Os arquivos em questão são gerados pelo instalador.

• Crie a variável de ambiente ‘PRINTER_DIR’, apontando para o diretório onde os arquivos do

‘Printer Service’ devem ser gerados;

• Iniciar o serviço do Windows chamado ‘Printer Service’;

• Os novos arquivos devem ser gerados na pasta apontada pela variável de ambiente

‘PRINTER_DIR’;

• Se necessária alguma alteração na configuração do modulo, deve-se parar o serviço e realizar as

alterações necessárias no arquivo de configuração que se encontra na pasta parametrizada na variável de ambiente “PRINTER_DIR”/config/ config.properties.

PRINTER CONSOLE

Para iniciar o módulo do ‘Printer Service’ como ‘Serviço’, execute os procedimentos abaixo (Arquivos em questão são gerados pelo instalador):

• Criar a variável de ambiente ‘PRINTER_SERVICE_URL’, que deve indicar a ‘url’, cujo ‘Printer

Service’ estará acessível. Exemplo: ‘http://localhost:9092/printerservice’;

(10)

Versão: V3.64.1

10

• O modulo ‘PrinterService’ deve estar iniciado para que o ‘printerconsole’ funcione;

(11)

Versão: V3.64.1

11

INICIANDO OS MÓDULOS COMO SERVIÇO DO

WINDOWS VIA WRAPPER (YAJSW)

Para executar os módulos: Mensageria, Integrador, Extrator, PrinterService e PrinterConsole como serviços do Windows utilizando a ferramenta YA JAVA SERVICE WRAPPER, siga os passos abaixo que mostram como a configuração deve ser realizada.

MENSAGERIA

Para iniciar o módulo da “Mensageria” como “Serviço”, execute os procedimentos abaixo:

Obs.: Os arquivos para instalação deste serviço estão disponíveis no subdiretório da própria mensageria: “<raiz da instalação>\mensageria\servico-windows\wrapper\yajsw”.

• Editar e configurar o arquivo ‘wrapper.conf’, por exemplo os parâmetros enviados para a JVM

como as variáveis de inicialização de memória, encoding, timeZone, arquivos e nível de log, etc;

• Executar o arquivo “servico-criar.bat”;

• Iniciar o serviço do Windows chamado “Mastersaf DF-e Mensageria - V3”.

INTEGRADOR

Para iniciar o módulo do “Integrador” como “Serviço”, execute os procedimentos abaixo:

Obs.: Os arquivos para instalação deste serviço estão disponíveis no subdiretório do próprio integrador: “<raiz da instalação>\integrador\servico-windows\wrapper\yajsw”.

(12)

Versão: V3.64.1

12

Poderão ser incluídas variáveis adicionais para configurar inicialização de memória, por exemplo: ⋅ wrapper.java.additional.5=-Xss2048k ⋅ wrapper.java.additional.6=-Xmx512m ⋅ wrapper.java.additional.7=-Xms256m ⋅ wrapper.java.additional.8=-XX:PermSize=128m ⋅ wrapper.java.additional.9=-XX:MaxPermSize=128m

• Iniciar o serviço do Windows chamado “Mastersaf DF-e IntegradorTxt - V3”.

EXTRATOR

Para iniciar o módulo do “Extrator” como “Serviço”, execute os procedimentos abaixo:

Obs.: Os arquivos para instalação deste serviço estão disponíveis no subdiretório do próprio extrator: “<raiz da instalação>\extrator\servico-windows\wrapper\yajsw”.

como as variáveis de inicialização de memória, encoding, timeZone, arquivos e nível de log, etc; Poderão ser incluídas variáveis adicionais para configurar inicialização de memória, por

exemplo: ⋅ wrapper.java.additional.5=-Xss2048k ⋅ wrapper.java.additional.6=-Xmx512m ⋅ wrapper.java.additional.7=-Xms256m ⋅ wrapper.java.additional.8=-XX:PermSize=128m ⋅ wrapper.java.additional.9=-XX:MaxPermSize=128m

(13)

Versão: V3.64.1

13

• Para configurações da aplicação Extrator, deve-se executar manualmente o arquivo

“configurar-extrator.bat”.

PRINTER SERVICE

Para iniciar o módulo do “Printer Service” como “Serviço”, execute os procedimentos abaixo:

Obs.: Os arquivos para instalação deste serviço estão disponíveis no subdiretório do próprio printer service: “<raiz da instalação>\printerservice\servico-windows\wrapper\yajsw”.

• Crie a variável de ambiente “PRINTER_DIR”, apontando para o diretório onde os arquivos do

Printer Service devem ser gerados;

como as variáveis de inicialização de memória, encoding, timeZone, arquivos e nível de log, etc; Poderão ser incluídas variáveis adicionais para configurar inicialização de memória, por

Também é importante configurar com o mesmo valor da variável de ambiente PRINTER_DIR a variável “env.PRINTER_DIR=”.

• Iniciar o serviço do Windows chamado “Printer Service”;

(14)

Versão: V3.64.1

14

alterações necessárias no arquivo de configuração que se encontra na pasta parametrizada na variável de ambiente “PRINTER_DIR”/config/config.properties.

PRINTER CONSOLE

Para iniciar o módulo do “Printer Console” como “Serviço”, execute os procedimentos abaixo:

Obs.: Os arquivos para instalação deste serviço estão disponíveis no subdiretório do próprio printer console: “<raiz da instalação>\printerconsole\servico-windows\wrapper\yajsw”.

• Crie a variável de ambiente “PRINTER_SERVICE_URL”, que deve indicar a “URL” cujo Printer

Service estará acessível. Exemplo: “http://localhost:9090/printerservice”;

como as variáveis de inicialização de memória, encoding, timeZone, arquivos e nível de log, etc. Poderão ser incluídas variáveis adicionais para configurar inicialização de memória, por

Também é importante configurar com o mesmo valor da variável de ambiente PRINTER_SERVICE_URL a variável “env.PRINTER_SERVICE_URL=”;

• Iniciar o serviço do Windows chamado “Printer Console”;

• Para iniciar a aplicação “Printer Console” com sucesso, a aplicação “Printer Service” já deve

(15)

Versão: V3.64.1

15

REMOVER SERVICO WRAPPER YAJSW

Para remover um serviço do Windows do Wrapper YAJSW, execute os procedimentos abaixo:

• É necessário parar o serviço do Windows ao qual deseja-se remover;

• Acessar o diretório da aplicação no qual deseja remover o serviço do Windows, por exemplo, o

integrador: “<raiz da instalação>\integrador\servico-windows\wrapper\yajsw”;

• Executar o arquivo “servico-remover.bat”;

(16)

Versão: V3.64.1

16

INICIANDO O TOMCAT (PORTAL E WEBSERVICE)

COMO SERVIÇO DO WINDOWS

Para iniciar o módulo do ‘Portal (Tomcat)’ como ‘Serviço’, execute os procedimentos abaixo:

• Antes de prosseguir verifique se o Tomcat foi instalado corretamente através do instalador e

faça o backup de suas configurações do banco de dados;

• Salve o arquivo ‘tomcat/conf/context.xml’ com outro nome, por exemplo: ‘Copy of context.xml’;

• Pare o serviço do Tomcat executando o arquivo ‘tomcat/bin/shutdown.bat’;

• Download do Tomcat. Faça o download do Tomcat Windows Service Installer utilizando um dos

links abaixo. Utilize a versão que já está sendo usada no produto DFE.

Versão 6: http://archive.apache.org/dist/tomcat/tomcat-6/v6.0.32/bin/apache-tomcat-6.0.32.exe

(17)

Versão: V3.64.1

17

e marque-o. Clique em seguida no botão ‘Next >’;

• Escolha a porta do Tomcat. Se o Glassfish estiver sendo executado na porta ‘8080’, altere a

porta default do Tomcat para outra, por exemplo: ‘9090’. Caso contrário, deixe como está. Clique no botão ‘Next >’;

(18)

Versão: V3.64.1

18

• Procure a pasta onde está instalado o ’jdk’. Selecione a pasta do ‘JDK’, pois o sistema não será

(19)

Versão: V3.64.1

19

IMPORTANTE: O Instalador pode perguntar se deseja substituir o conteúdo da pasta. Confirme

clicando no botão ‘Yes’.

(20)

Versão: V3.64.1

20

(Aquele espaço perto do relógio do Windows no canto inferior direito);

• Clique com o botão direito e irá aparecer o menu abaixo. Clique na opção Configure;

• Configurando as variáveis de ambiente:

a) Clique na aba ‘Java’.

b) Acrescente na ‘Text Área’ chamada ‘Java Options’ as seguintes variáveis de ambiente:

⋅ Dfile.encoding=UTF-8 ⋅ Duser.timezone=America/Sao_Paulo ⋅ Duser.language=pt ⋅ Duser.country=BR ⋅ Xmx1g ⋅ Xms512m ⋅ XX:PermSize=256m ⋅ XX:MaxPermSize=256m

IMPORTANTE: Não apagar o conteúdo do ‘Java Options’. Apenas acrescente as variáveis,

(21)

Versão: V3.64.1

21

• Configurar inicialização automática:

a) Clique na aba ‘General’;

b) Selecione o modo ‘Automatic’ em ‘Startup type’;

c) Se o Tomcat estiver em execução, pare-o clicando no botão ‘Stop’;

d) Volte o backup do arquivo ‘context.xml’, apagando o arquivo criado pelo instalador do Tomcat e renomeie seu backup para ‘context.xml’ na pasta ‘tomcat/conf’;

(22)

Versão: V3.64.1

22

ATUALIZAÇÃO DO “WRAPPER JSW” PARA

“WRAPPER YAJSW”

Este procedimento é direcionado aos clientes que possuem as aplicações do MASTERSAF DFE instaladas como serviço do Windows através do Wrapper JSW.

A partir da versão 3.56.2 do Mastersaf DFE (entregue em 05 de dezembro de 2017) foi disponibilizado uma nova versão do Wrapper junto ao pacote de instalação do produto, chama-se “Wrapper YAJSW”, portando no mesmo pacote estão disponíveis “Wrapper JSW” e “Wrapper YAJSW”.

A versão antiga da ferramenta continua disponível no pacote de instalação do Mastersaf DFE para que não comprometa e nem gere impacto aos clientes que já utilizam o Wrapper, contudo, a versão antiga da

ferramenta , Wrapper JSW, será descontinuada na versão 3.59.0 do MASTERSAF DFE (entrega prevista para 13/03/2018) sendo que até esta data todos os clientes que utilizam tal ferramenta deverão

atualizar seus ambientes para a nova versão “Wrapper YAJSW” para não gerar impacto em seus ambientes.

PROCEDIMENTO PARA ATUALIZAÇÃO

Em cada aplicação que estiver configurada com o Wrapper JSW, acessar o diretório principal da aplicação e replicar as configurações do “wrapper.conf” antigo para o novo, por exemplo parâmetros de memória, configurações de encoding, timeZone e variáveis de ambiente (quando existir).

IMPORTANTE:

• Existem diferenças entre o wrapper.conf da versão antiga para a nova, portanto, não deve-se substituir

um arquivo pelo outro.

• Sempre que atualizar a versão do tomcat, deve desinstalar o serviço antigo e instalar o novo conforme a

versão/patch.

• Utilize o instalador do DF-e para atualizar o tomcat.

• Caso seja atualizado manualmente o tomcat, faça sempre em uma pasta nova. Não instale na mesma

(23)

Versão: V3.64.1

23

MENSAGERIA

O arquivo antigo fica em <raiz da instalação>\mensageria\wrapper.conf e o novo em <raiz da instalação>\mensageria\servico-windows\wrapper\yajsw\wrapper.conf;

INTEGRADOR

O arquivo antigo fica em <raiz da instalação>\integrador\wrapper.conf e o novo em <raiz da instalação>\integrador\servico-windows\wrapper\yajsw\wrapper.conf;

EXTRATOR

O arquivo antigo fica em <raiz da instalação>\extrator\wrapper.conf e o novo em <raiz da instalação>\extrator\servico-windows\wrapper\yajsw\wrapper.conf;

PRINTER SERVICE

O arquivo antigo fica em <raiz da instalação>\printerservice\wrapper.conf e o novo em <raiz da instalação>\printerservice\servico-windows\wrapper\yajsw\wrapper.conf;

PRINTER CONSOLE

O arquivo antigo fica em <raiz da instalação>\printerconsole\wrapper.conf e o novo em <raiz da instalação>\printerconsole\servico-windows\wrapper\yajsw\wrapper.conf.

Nota 1: Recomendamos manter como backup os arquivos de configurações wrapper.conf da versão antiga até

que a nova versão do Wrapper esteja em pleno funcionamento.

Nota 2: Desinstalar os serviços do Windows oriundos da ferramenta Wrapper JSW. Em cada aplicação, no diretório principal da aplicação, existe o arquivo “unistallService.bat” que ao ser executado irá desinstalar o

(24)

Versão: V3.64.1

24

serviço Windows do Wrapper JSW. Por exemplo da aplicação Mensageria:

• Acessar o diretório da aplicação “<raiz da instalação>\mensageria” e executar o arquivo

uninstallService.bat;

• Certificar que o serviço do Windows foi removido.

Nota 3: Instalar os novos serviços do Windows através da ferramenta Wrapper YAJSW. Seguir os procedimentos descritos neste mesmo manual, clicando AQUI.

OBSERVAÇÕES

Em alguns ambientes pode ocorrer uma situação, em que, o servidor onde o serviço esta instalado, pertença a um domínio e o usuário não tenha permissão para que todas as tarefas do serviço sejam executadas corretamente.

Neste caso, acessar as propriedades do serviço em questão e, na aba ‘Logon’ atribuir uma conta válida, conforme imagem a seguir.

(25)

Versão: V3.64.1

25

SUPORTE TÉCNICO

Para dúvidas ou problemas, abra um chamado no Contact Center ou entre em contato com nossa equipe de Suporte Técnico MASTERSAF pelo Telefone:

(11) 2159-0600 opção 02 (Atendimento das Soluções DFE).