3 - Linx Application Updater - Manual Funcional - V1.0

Orientações Gerais

Este documento tem por objetivo detalhar as etapas necessárias para a utilização do Application Updater. Isso possibilitará o cliente gerenciar e agendar atualizações automáticas de pacotes/versões nos PDVs Storex Home.

Premissas

Certifique que as condições abaixo estão devidamente cumpridas:

• O cliente deve disponibilizar um servidor com o Wildfly 10.1.0 conectado ao banco de dados Corporativo/Retaguarda - (Manual de Instalação do Portal Application Updater→https://share.linx.com.br/x/B-f7Dg).
  Se preferir, ao invés do Wildfly, o cliente, pode disponibilizar um servidor com Docker e o Docker-compose se for Linux ou o Docker desktop se for Windows.
• O(s) PDV(s) deve(m) estar com o client AppUpdater devidamente configurado(s).
• O departamento de P&D Linx deve encaminhar o pacote Compose_app_updater ao cliente caso a o servidor seja com Docker.
• O departamento de P&D Linx deve encaminhar o arquivo linx-application-updater-web.war ao cliente para realizar o deploy caso a o servidor seja com Wildfly.
• O departamento de P&D Linx deve viabilizar os pacotes das versões no padrão que o client AppUpdater no PDV processe. Exemplo: 001.002.002.189.000.

Acesso ao Web-Gui (Application Updater)

Uma vez instalado e configurado o wildfly pela infra do cliente (Manual de Instalação do Portal Application Updater→https://share.linx.com.br/x/B-f7Dg):

Abra o navegador e digite a url do servidor onde é realizado o deploy: "IP+Porta Servidor/linx-application-updater-web/#/dashboard".

Exemplo:

Não é necessário usuário e senha para acessar:

Dashboard

Através da opção Dashbord no menu, é possível filtrar a versão que deseja analisar o status (de cada PDV agendado):

Parametrização dos PDVs

Para que o Application Updater se comunique com os PDVs das Lojas, o cliente precisa realizar o cadastro de todos os pdvs no Web Gui.

1. Clique na opção "Atualizadores" no menu

2. Clique no botão "Novo"

3. Siga o padrão de cadastramento descrito abaixo:

[Novo Atualizador]

Endereço:
É o IP do PDV → O client do PDV passará o IP para se conectar ao Application Updater
Exemplo: 172.10.0.128

Descrição:
É a identificação do PDV e Filial na hora de controlar o agendamento → Cadastre sempre a Loja e PDV
Exemplo: Loja 9 PDV 5

Porta:
A porta não é utilizado atualmente → Por padrão inserir 4000
Exemplo: 4000

Pai:
Sempre será web-gui
Exemplo: web-gui

[Aplicações Suportadas]

Marque somente a opção STOREXHOMEPDV-LINX

• STOREXHOMEPDV-LINX

Clique no botão "SALVAR":

Apresentará um modal de sucesso e listará a(s) loja(s) e PDV(s) cadastrado(s):

Subida dos Pacotes de Versão

O departamento de P&D disponibilizará o pacote no formato pré estabelecido para que o cliente faça o upload no web-gui e agende a atualização nas filiais.

1. Clique na opção "Pacotes" no menu

2.  Em "Novo Pacote de Atualização", informe o pacote de atualização clicando na lupa e localizando no computador ou arraste o pacote diretamente e solte-o na área mencionada

3. Clique no botão "Adicionar"
*Obs.: Caso o pacote seja grande, apresentará uma barra de progresso mostrando como está sendo o upload até concluir e apresentará ao final um modal de sucesso listando a versão no "Pacotes de Atualização".

Agendamento para atualização do pacote nos PDVs

Para vincular um pacote que já subiu, para os pdvs das lojas:

1. Clique na opção "Agendamentos" no menu

2. Clique no botão "Novo"

3. Siga o padrão de agendamento descrito abaixo:

Tipo de Agendamento:
Atualização

Aplicativo:
STOREXHOMEPDV-LINX

Versão:
Selecione a versão que deseja atualizar, clicando na setinha ou clique em "Buscar Atualizadores" mais abaixo:

Data do Agendamento:
Informe a data que deseja que seja atualizado o(s) pdv(s)
*Obs.: A data do agendamento é respeitada. Para agendamento para o mesmo dia vigente, a atualização ocorrerá somente ao fechar e abir a aplicação novamente.

Hora do Agendamento:
Informe a hora que deseja que seja atualizado o(s) pdv(s)
*Obs.: A hora do agendamento é respeitada. Para agendamento para o mesmo dia vigente, a atualização ocorrerá somente ao fechar e abir a aplicação novamente.

Lojas e PDVs:
Marque o(s) pdv(s) que deseja atualizar
*Obs.: Pode atualizar a rede toda, selecionar alguns ou selecionar apenas 1 PDV:

Clique no botão "SALVAR" 
*Obs.: Será agendado e listado os PDVs com o status NOVO.
*Obs2.: Caso desista de algum agendamento que ainda não foi atualizado, basta clicar no "cancelar" na linha que deseja e confirmar o cancelamento do agendamento.

Atualização da versão no PDV

 Para facilitar o entendimento, simularemos dois cenários, um em que o PDV atualiza com sucesso e outro que apresenta erro durante a atualização do pacote.

*Obs.: O(s) PDV(s) deve(m) estar com o client AppUpdater devidamente configurados.

• Atualização com sucesso

Foi agendada uma atualização de pacote para o PDV teste.

Ao subir o PDV, foi verificado se havia atualizações. Ao identificar que sim, foi feita a chamada do linx-applicartion-updater-1.5.1-jar, que baixou o pacote 001.002.003.010.000 e iniciou o processo de atualização:

O PDV atualizou com sucesso.

No Web-Gui será possivel identificar facilmente que houve sucesso na atualização para o PDV teste:

• Atualização com erro

Foi agendada uma atualização de pacote para o PDV teste.

Ao subir o PDV, foi verificado se havia atualizações. Ao identificar que sim, foi feita a chamada do linx-applicartion-updater-1.5.1-jar, que baixou o pacote 001.002.002.189.000 e iniciou o processo de atualização:

O PDV não atualizou em função de erros e realizou o rollback iniciando com a versão anterior.

No Web-Gui será possivel identificar facilmente que houve erro na atualização para o PDV teste:

• Área do Log da Atualização Automática no PDV

O cliente deverá encaminhar os logs (c:/logAppUpdater) da atualização com erro para [email protected] (quando a atualização for relacionada a correções de erros em produção) ou para  [email protected] (quando a atualização for relacionada a projetos).