Tutorial de utilização
1 - Configurando os arquivos
1.1 - Localização dos arquivos
A pasta do atualizador devem estar junto da pasta do tomcat, dentro da pasta edusoft ou equivalente. Dentro da pasta atualizador devem estar os arquivos :
- atualizador.jar
- atualizador.bat(Windows)
- Pasta de perfis
- Pasta Logs
- config.xml
Esse arquivos são disponibilizados no FTP da Edusoft: ftp.edusoft.com.br
1.2 - Configuração dos arquivos
O atualizador utiliza 2 arquivos auxiliares para a sua inicialização, que são o arquivo de configurações e o arquivo de perfil. O arquivo de configurações se chama config.xml e ele deve conter as seguintes informações:
- so: deve ser WIN para sistemas operacionais Windows e LINUX para sistemas operacionais linux;
- banco: deve ser MSSQL para sistemas utilizando banco de dados Microsoft SQL Server e ORACLE para sistemas utilizando banco de dados Oracle;
- pathEdusoft: local da pasta Edusoft;
- pathTomcat: local da pasta onde se encontra o tomcat;
- pathJava: local da pasta onde se encontra os arquivos do java(junto com a pasta do tomcat);
- pathPerfil: local da pasta onde se encontra os arquivos de perfil;
- pathWar: local da pasta onde se encontra os arquivos wars das aplicações;
- pathXml: local da pasta onde se encontra os arquivos xml das aplicações;
- proxyUse: true quando a conexão com a internet possuir proxy e false para quando não possuir;
- proxyHost: host utilizado para conexão proxy;
- proxyPort: porta utilizada para conexão proxy;
- proxyUser: login utilizado para conexão proxy;
- proxyPass: senha utilizada para conexão proxy;
- ambiente: deve ser Cliente;
O arquivo deve ficar como no exemplo a seguir:
<configuracao> <so>WIN</so> <banco>MSSQL</banco> <pathEdusoft>C:\edusoft</pathEdusoft> <pathTomcat>C:\edusoft\tomcat7032</pathTomcat> <pathJava>C:\edusoft\java7u9\bin</pathJava> <pathPerfil>C:\edusoft\atualizador\Perfis</pathPerfil> <pathWar>C:\edusoft\tomcat7032\wars</pathWar> <pathXml>C:\edusoft\tomcat7032\conf\Catalina\localhost</pathXml> <proxyUse>false</proxyUse> <proxyHost></proxyHost> <proxyPort></proxyPort> <proxyUser></proxyUser> <proxyPass></proxyPass> <ambiente>Cliente</ambiente> </configuracao>
O arquivo de perfil deve possuir o nome da aplicação e deve conter os seguintes informações:
- nome: nome do arquivo e da aplicação;
- tipoRecurso: Podem ser: ICoruja, MentorWeb, Security, Relatorio, Message, Log, MentorIntegrador, MentorAgendador, DynaForm;
- arquivoXML: nome do arquivo xml da aplicação referente ao recurso;
- driver: driver utilizado pela aplicação java para a ligação com o banco de dados;
- url: url contendo o caminho do banco do recurso;
- username: usuário do banco;
- password: senha do banco;
Observações:
- Para que os scripts de versão sejam executados para um recurso, os dados de driver, url, username e password devem estar corretamente preenchidos;
- Só serão baixados os wars dos recursos que possuírem o arquivoXml;
- Para a atualização somente dos wars, o arquivo de perfil deve possuir os itens driver, url, username e password preenchidos apenas no recurso de mensagem;
- Todos os perfis deverão possuir os itens driver, url, username e password do recurso de mensagens preenchidos;
- Para que os scripts de versão sejam executados, as informações de conexões do recurso ICoruja e do Security devem estar preenchidos;
- O nome do perfil deve identificar o nome do cliente e identificar se é banco de produção, teste ou treino. Exemplo: Cliente_Prod;
O arquivo deve ficar como no exemplo a seguir;
<perfil> <nome>NOME_DO_PERFIL</nome> <recursos> <recurso> <tipoRecurso>ICoruja</tipoRecurso> <arquivoXML>ICoruja</arquivoXML> <driver></driver> <url></url> <username>login</username> <password>senha</password> </recurso> <recurso> <tipoRecurso>MentorWeb</tipoRecurso> <arquivoXML>MentorWeb</arquivoXML> <driver></driver> <url></url> <username>login</username> <password>senha</password> </recurso> <recurso> <tipoRecurso>Security</tipoRecurso> <arquivoXML>Security</arquivoXML> <driver></driver> <url></url> <username>login</username> <password>senha</password> </recurso> <recurso> <tipoRecurso>Relatorio</tipoRecurso> <arquivoXML>Relatorio</arquivoXML> <driver></driver> <url></url> <username>login</username> <password>senha</password> </recurso> <recurso> <tipoRecurso>Message</tipoRecurso> <arquivoXML></arquivoXML> <driver></driver> <url></url> <username>login</username> <password>senha</password> </recurso> <recurso> <tipoRecurso>Log</tipoRecurso> <arquivoXML></arquivoXML> <driver></driver> <url></url> <username>login</username> <password>senha</password> </recurso> <recurso> <tipoRecurso>MentorIntegrador</tipoRecurso> <arquivoXML>MentorIntegrador</arquivoXML> <driver></driver> <url></url> <username>login</username> <password>senha</password> </recurso> <recurso> <tipoRecurso>MentorAgendador</tipoRecurso> <arquivoXML>MentorAgendador</arquivoXML> <driver></driver> <url></url> <username>login</username> <password>senha</password> </recurso> <recurso> <tipoRecurso>EdusoftServico</tipoRecurso> <arquivoXML>EdusoftServico</arquivoXML> <driver></driver> <url></url> <username>login</username> <password>senha</password> </recurso> </perfil>
2 – Executando a atualização
Atenção! Avisos Importantes antes de atualizar;
- Obrigatoriamente deve-se excluir o aquivo ICoruja.war disponível na pasta (C:\edusoft\tomcat\webapps). Vale ressaltar que esse passo é exclusivo para primeira atualização do cliente na versão 8.6 do atualizador, após não será mais criado.
- Os arquivos .war da pasta (C:\edusoft\tomcat\wars) também devem ser excluídos. O atualizador não irá deletar outros arquivos de outras versões, ficando a cargo da pessoa que estiver atualizando deletar os arquivos antigos de outras versões anteriores manualmente.
- Se disponível, o atualizador irá baixar os arquivos dos serviços de mensageria, registro online, ou serviço de integração de dados, e irá copiar os mesmos para o endereço da pasta de serviços de acordo com cada ambiente: Windows: C:\edusoft\servicos e Linux: /edusoft/servicos. O atualizador irá copiar os arquivos dos serviços .jar de acordo com os serviços e pastas indicadas, seguido da versão em questão (exemplo: Integracao_RegistroOnline-06390000-SNAPSHOT.jar), deve-se editar o nome retirando a versão para os serviços funcionarem corretamente (exemplo: Integracao_RegistroOnline.jar). Vale ressaltar que o serviço de integração de dados não será baixado para as release do sistema, somente para as versões.
A título de curiosidade:
- Foi adicionado o recurso do EdusoftServico para que este seja atualizado juntamente com as aplicações, será necessário apenas adicionar o seguinte recurso no XML do perfil de atualização:
Recurso para ORACLE
<recurso> <tipoRecurso>EdusoftServico</tipoRecurso> <arquivoXML>EdusoftServico</arquivoXML> <driver>oracle.jdbc.driver.OracleDriver</driver> <url>jdbc:oracle:thin://@VENUS.EDUSOFT.NET:XXXX:DBXXG</url> <username>#USUARIO#</username> <password>#SENHA#</password> </recurso>
Recurso para SQL SERVER
<recurso> <tipoRecurso>EdusoftServico</tipoRecurso> <arquivoXML>EdusoftServico</arquivoXML> <driver>net.sourceforge.jtds.jdbc.Driver</driver> <url>jdbc:sqlserver://XXX.XXX.X.XX:XXXX;databaseName=BANCO_ICO</url> <username>#USUARIO#</username> <password>#SENHA#</password> </recurso>
2.1 – Sistema operacional Windows
Para iniciar o atualizador, vá até a pasta Edusoft/atualizador e execute o arquivo atualizador.bat, em seguida o mesmo apresentará a tela inicial como na imagem abaixo:
Observação:
- Devido as regras de permissão do Windows Server 2012 e do Windows 8 em diante é necessário executar o procedimento descrito a seguir para o correto funcionamento do atualizador:
- Vá na pesquisa do Windows e digite 'cmd' e no ícone 'cmd ' que aparecer clique com o botão direito com o mouse e clique em executar como administrador, nisto se abrirá o cmd e então deverá ser digitado 'C:\edusoft(ou edusoft7)\Atualizador' e clicado enter, em seguida devera ser digitado 'java -jar atualizador.jar' e clicado enter, nisto se abrirá o atualizador.
- Nesta tela temos todos os perfis criados na pasta de perfis,é necessário ao menos 1 perfil selecionado para continuar, podendo ser atualizado vários perfis.
Ao clicar em próximo vamos para a tela de escolha de versão, como na imagem abaixo:
Nesta tela é apresentado as versões disponíveis para atualização, conforme a versão das aplicações escolhidas. Serão apresentados as versões conforme itens a seguir:
- Somente as versões que a versão do atualizador pode executar;
- Somente as versões disponíveis para atualização a partir da versão mais recente das aplicações selecionadas;
Apertando em próximo vamos para a tela de acompanhamento da atualização, onde será mostrado
o progresso da atualização, como na imagem a seguir:
Nesta tela é apresentado a barra de progresso com o progresso atual da atualização, no canto direito temos qual etapa que o atualizador está executando, as etapas que vem a seguir e as etapas que já foram executadas, abaixo da barra de progresso temos as informações de qual ação específica o atualizador está executando, qual arquivo ele está baixando e a velocidade de download, qual perfil está sendo executado e qual banco está sendo atualizado.
Inicialmente o botão de Próximo fica desabilitado e só é liberado após a finalização da atualização.
Após o término do processo de atualização, apertando em próximo vamos para a tela final do atualizador, que pode apresentar as seguintes informações:
- Apresenta um texto informando que a atualização foi concluída;
- Se ocorrer algum erro nos scripts da atualização, o atualizador apresentará um quadro com o perfil e os erros ocorridos.
Clicando em finalizar o atualizador se fecha e termina o processo de atualização.
2.2 – Sistema operacional Linux
Para iniciar o atualizador, vá até a pasta Edusoft/atualizador e execute o arquivo atualizador.jar,
em seguida o mesmo apresentará a tela inicial como na imagem abaixo:
Nesta tela e apresentado a versão disponível para atualização, e os perfis criados na pasta de perfis, nesta tela será feita a escolha do perfis que serão atualizados, para isto é apresentado uma opção numérica com os perfis e uma opção de cancelamento da atualização, como na imagem a seguir:
Para escolher, é necessário somente digitar o número da opção desejada e se for escolher mais de uma aplicação, separar o número da opção por vírgula e apertar ENTER.
Em seguida será apresentado um pedido de confirmação da sua escolha, tendo 3 opções como mostra a imagem a seguir:
Para escolher basta apenas digitar a opção desejada e apertar ENTER.
Nesta tela e apresentado as versões disponíveis para atualização, para escolher, é necessário somente digitar o número da opção desejada, como na imagem a seguir:
Em seguida será apresentado um pedido de confirmação da sua escolha, tendo 3 opções como mostra a imagem a seguir:
Para escolher basta apenas digitar a opção desejada e apertar ENTER.
Em seguida é iniciado o processo de atualização dos perfis, nesta tela é apresentado as informações de qual ação específica o atualizador está executando, qual arquivo ele está baixando, qual perfil está sendo executado e qual banco está sendo atualizado, como na imagem a seguir:
Ao final do processo aparecerá uma mensagem se a atualização ocorreu com ou sem erros, como na imagem a seguir:
Clicando a tecla ENTER o atualizador se fecha e termina o processo de atualização
3 – Observações
- Acaso ocorra um erro na atualização durante a execução de scripts, será perguntado se você gostaria de iniciar a aplicação;
- Verifique se tudo está configurado corretamente, pois configurações erradas darão erro no atualizador;
- O atualizador mantém os wars antigos, apenas os wars que estavam na pasta webapps são apagados;
- O atualizador só parará a aplicação após o download e verificação dos wars;
- O atualizador envia um e-mail para a edusoft com o resultado da atualização, caso ele não consiga enviar, será mostrado uma mensagem informando que não foi possível enviar.
- Na atualização são criados 2 arquivos de log, um com o processo de atualização e outro com os erros de script que ocorreram na atualização, os mesmos ficam gravados na pasta atualizador/Logs;
- O atualizador utiliza conexão com a internet, caso esta conexão utilize proxy, o mesmo deverá ser configurado corretamente no arquivo de configurações, conforme item 1.2;
- Caso a aplicação utilize banco de log, o mesmo deve estar configurado no arquivo de perfil, referente a aplicação, conforme item 1.2;
- Caso exista algum war além do ICoruja e Dynaform dentro da pasta webapps, estes devem ser retirados desta pasta e transferidos para a pasta wars especificada no arquivo config.xml, as pastas referentes a estes war que estão no webapps devem ser excluidas. A não execução deste item pode acarretar não funcionamento da aplicação.
- Após baixar os wars, a aplicação perguntará se o mesmo continuará com a atualização, se sim, atualiza as aplicações, se escolher não, fecha o atualizador.
- Para a execução sem interação do usuário, atualizador deve ser iniciado via comando e ser passado como paramêtro o seguinte item: -perfil=CLIENTE_PROD,CLIENTE_TESTE
Importante: não pode existir espaços dentro do parâmetro passado.