Mid e Client - Instruções de Instalação

    O MID-e Client Agent pode funcionar de duas formas, sendo elas mutuamente excludentes. A primeira, como um servidor remoto para backup das NFC-e emitidas em contingência e a segunda, como um servidor remoto para gerenciamento de uma fila de requisições que serão processadas e respondidas pelo Sistema Autenticador e Transmissor (SAT).
   Este documento tem como objetivo fornecer as informações necessárias para instalação e configuração do MID-e Client Agent em ambientes Windows e Unix.

Informações Gerais e Requisitos para Instalação

    A instalação do MID-e Client Agent é realizada utilizando o Oracle Java Runtime Environment (JRE) na versão 6 ou superior. Caso a máquina onde a instalação será executada não possua um JRE instalado, o usuário poderá realizar a instalação utilizando o JRE embarcado que se encontra no pacote ao qual este manual está incluso (mais detalhes na próxima seção).

   Caso o intuito da instalação do MID-e Client Agent seja para que este se comporte como um servidor remoto SAT, será necessário que o aparelho SAT esteja ativado e com sua interface de rede devidamente configurada.

   Com a finalização da execução do instalador o usuário poderá executar o MID-e Client Agent através de um script de execução, ou adicionalmente, realizar sua instalação como Serviço no Sistema Operacional.

   É de responsabilidade do usuário verificar se já existe uma instalação do MID-e Client Agent antes de prosseguir com os passos deste manual, caso já exista, o serviço referente a esta instalação deverá ser interrompido. 

   Se a versão já instalada do MID-e Client Agent for inferior a 04.05.00, esta deverá ser completamente removida do sistema operacional antes de prosseguir com os passos deste manual. Para mais instruções sobre o processo de instalação, consultar seção Desinstalação de versões anteriores.

   É extremamente recomendável que a versão do MID-e Client Agent seja a mesma versão do MIDe Client dos PDVs que apontam para ele.

Instalação

Ambiente Windows

Conteúdo do Pacote de Instalação 
O pacote distribuído para instalação do MID-e Client Agent em ambiente Windows possui os seguintes arquivos: 

1. Script de instalação (instalador.bat) que executa o instalador (linx-mid-e-client-agent.jar) utilizando a JRE embarcada; 
2. Instalador do MID-e Client Agent (linx-mid-e-client-agent.jar); 
3. Este manual (MID-E-CLIENT-DI.pdf); 
4. Java Runtime Environment (JRE) embarcada v.1.7.0 (jre_win). 
   
   

Requisitos 
Caso o usuário opte por instalar o MID-e Client Agent como serviço no Sistema Operacional, o usuário deverá ter privilégios de administrador. 

Instalação 
Seja através do instalador.bat ou do InstaladorMIDeClient.jar, o processo de instalação se dá através dos seguintes passos: 

OBS: Esta etapa não requer execução com privilégios de administrador. Exceto caso o usuário queira instalar o MID-e Client Agent em pastas como por exemplo C:/ ou C:/Arquivos de Programas ou queira instalá-lo como serviço.

  Figura 1 – Seleção do idioma do wizard de instalação

 Figura 2 - Tela inicial da instalação

Clique no botão Próximo para continuar a instalação e será exibida uma tela conforme a Figura 3. Caso deseje cancelar, clique no botão Sair.

 Figura 3 – Instalação do MID-e Client Agent como Serviço

Caso o usuário deseje instalar o MID-e Client Agent como serviço, deverá marcar a opção Ativar instalação como serviço. Importante: Caso opte por isso, essa instalação deverá estar sendo executada com privilégios de administrador.

Clique no botão Próximo para continuar a instalação e será exibida uma tela conforme a Figura 4. Caso deseje cancelar, clique no botão Sair.

  Figura 4 - Inclusão de parâmetros de configuração do MID-e Client Agent

Informar o CNPJ do emitente, a URL do MID-e Central e o Identificador da Aplicação e clicar no botão Próximo para continuar a instalação e exibir a Figura 5.

  Figura 5 - Informar o usuário e senha do MID-e Client

Informar o usuário e senha do MID-e Client e clicar no botão Próximo para continuar a instalação e exibir a Figura 6.

Figura 6 - Seleção do Tipo de Agent

Como citado no início deste manual, o MID-e Client Agent poderá atuar de duas formas e é nesta etapa da instalação que deverá ser informada a forma de atuação desejada.

Caso a forma desejada seja a instalação do MID-e Client Agent como servidor remoto para backup das NFC-e emitidas em contingência, o usuário deverá selecionar o tipo NFCe.

Caso a forma desejada seja a instalação do MID-e Client Agent como servidor remoto para gerenciamento de uma fila de requisições que serão processadas e respondidas pelo Sistema Autenticador e Transmissor, o usuário deverá selecionar o tipo SAT.

Feito isso, o usuário deverá informar o IP local e a porta do serviço.

Se o tipo de Agent selecionado for o SAT, dois novos campos deverão ser informados, conforme exibido na Figura 7.

Figura 7 - Campos para o tipo de Agent SAT

São eles: o fabricante do aparelho SAT que será utilizado no Servidor onde o serviço será instalado e o código de ativação deste aparelho.

Feito isso, clique no botão Próximo para continuar a instalação e exibir a Figura 8.

Figura 8 - Habilitar o uso de Proxy

Caso o usuário queira habilitar o uso de Proxy para o serviço, deverá selecionar a opção Habilitar uso do proxy conforme a figura acima e preencher os campos solicitados.

Feito isso, clique no botão Próximo para continuar a instalação e exibir a Figura 9.

Figura 9 - Selecionar diretório de instalação

Selecione o diretório onde a aplicação será instalada, depois clique no botão Próximo para continuar a instalação e exibir a Figura 10. Caso deseje cancelar clique no botão Sair.

Figura 10 - Progresso da instalação

Aguarde a cópia dos arquivos. Ao término da cópia, clique no botão Próximo para continuar a instalação e exibir a Figura 11.

Figura 11 - Instalação finalizada

Após a conclusão das tarefas de instalação, clique no botão Próximo para prosseguir e finalizar a instalação do MID-e Client Agent.

Nesse momento, caso a opção Ativar instalação como serviço tenha sido selecionada, o MID-e Client Agent já se encontra instalado como serviço.

Caso contrário o usuário poderá executá-lo a partir de um script de execução. Para executar o MID-e Client Agent através deste script, o usuário deverá ir até o caminho especificado no início da instalação, acessar a basta bin e executar o script startup.bat:

Pronto! O MID-e Client Agent será executado e o usuário poderá ver sua execução através do próprio console. O log da execução será criado em bin/log/mid-e-client-agent.log.

Ambiente Unix

Conteúdo do Pacote de Instalação

O pacote distribuído para instalação do MID-e Client Agent em ambiente Unix possui os seguintes arquivos:

1. Script de instalação (linx-mid-e-client-agent.sh) que executa o instalador (linx-mid-e-client.jar) utilizando a JRE embarcada;
2. Instalador do MID-e Client Agent (linx-mide-e-client-agent.jar);
3. Este manual (MID-E-CLIENT-DI.pdf);
4. Java Runtime Environment (JRE) embarcada v.1.7.0 (jre_lnx).

Requisitos
Caso o usuário opte por instalar o MID-e Client Agent como serviço no Sistema Operacional, o usuário deverá ter privilégios de administrador.

Instalação

            Recomenta-se descompactar o pacote do instalador dentro do diretório do usuário (neste manual consideraremos o usuário linx): /home/linx/. Uma vez descompactado, a instalação poderá ser realizada de duas formas:

1. Utilizando o instalador com interface gráfica (onde serão exibidas as mesmas telas apresentadas na seção Instalação em ambiente Windows)
2. Via console, para versões Unix que não possuam suporte ao tipo de instalação com interface gráfica.

Para executar a instalação utilizando a interface gráfica, o usuário deverá executar o script instalador.sh como segue:

Para executar a instalação utilizando o modo console, basta utilizar a opção –console, conforme exemplo a baixo:

Após a instalação o usuário verá as seguintes mensagens

Para executar o MID-e Client Agent, o usuário deverá ir até o diretório onde a instalação foi realizada, mais especificamente no diretório bin, neste caso: /home/linx/Linx-MIDeClient-Agent/bin, e executar o script startup.sh:

Pronto! O MID-e Client Agent será executado e o usuário poderá ver sua execução através do próprio console. O log da execução será criado em bin/log/mid-e-client-agent.log.

Instalando como Serviço

Opcionalmente o usuário poderá instalar o MID-e Client Agent como serviço no Sistema Operacional. Para isso, o mesmo deverá ter privilégios de super usuário.

Em distribuições derivadas do RedHat, como por exemplo CentOS, a instalação como serviço deverá ocorrer através da execução, com privilégios de super usuário, do script installService.sh, localizado em: /home/linx/Linx-MIDeClient-Agent/bin:

Já em distribuições derivadas do Debian, como por exemplo Ubuntu, a instalação como serviço deverá ocorrer através da execução, com privilégios de super usuário, do script installServiceDebian.sh, também localizado em: /home/linx/Linx-MIDeClient-Agent/bin:

Em ambos os casos, serão exibidas as seguintes mensagens:

Pronto! O MID-e Client Agent está instalado como um serviço e em execução.

Comandos do MID-e Client Agent Service

O MID-e Client Agent Service possui disponível para execução os seguintes comandos:

• Para ligar o serviço (start):

• Para desligar o serviço (stop):

• Para consultar o status do serviço (status):

• Para reiniciar o serviço (restart):

Desinstalação

Ambiente Windows

Desinstalação do MID-e Client Agent Service
Para desinstalar o MID-e Client Agent Service o usuário deverá executar, como administrador, o script uninstallService.bat, localizado em: /Linx-MIDeClient-Agent/yajsw/bat/uninstallService.bat.

Essa desinstalação remove apenas o serviço do sistema operacional. Caso o usuário deseje desinstalar completamente o MID-e Client Agent, deverá executar o passo abaixo.

Desinstalação do MID-e Client Agent

Para desinstalar o MID-e Client Agent completamente, incluindo a remoção do serviço, o usuário deverá executar, como administrador, o script uninstall.bat, localizado em: /Linx-MIDeClient-Agent/Uninstaller. Logo em seguida, aparecerá a seguinte tela:

Figura 11 – Desinstalação do MID-e Client Agent

Ambiente Unix

Desinstalação do MID-e Client Agent Service

Para desinstalar o MID-e Client Agent Service em distribuições derivadas do RedHat, como por exemplo CentOS, a desinstalação deverá ocorrer através da execução, com privilégios de super usuário, do script uninstallService.sh, localizado em: /home/linx/Linx-MIDeClient-Agent/bin.

Analogamente, para desinstalar o MID-e Client Agent Service em distribuições derivadas do Debian, como por exemplo Ubuntu, a desinstalação deverá ocorrer através da execução, com privilégios de super usuário, do script uninstallServiceDebian.sh, também localizado em: /home/linx/Linx-MIDeClient-Agent/bin.

Essa desinstalação remove apenas o serviço do sistema operacional. Caso o usuário deseje desinstalar completamente o MID-e Client Agent, incluindo a remoção do serviço, deverá executar o passo abaixo.

Desinstalação do MID-e Client Agent

Para desinstalar completamente o MID-e Client Agent o usuário deverá executar, como administrador, o script uninstallAgent.sh (caso utilize uma distribuição derivada do RedHat – exemplo CentOS), ou o script uninstallAgentDebian.sh (caso utilize uma distribuição derivada do Debian – exemplo Ubuntu), ambos localizados em: /Linx-MIDeClient-Agent/Uninstaller/uninstallAgent.sh.