MANUAL DE UTILIZAÇÃO Instalação do MV Portaria
Histórico da Revisão Data Versão Autor Descrição 15/06/12 1.0 Aluisio Comiran Criação do documento. 12/09/12 1.1 Aluisio Comiran - Foram removidas as etapas de instalação e configuração do Tomcat, pois a infra já possui um manual especifico para esse fim. - Adicionadas as etapas de instalação da versão para Android. - Ajustes gerais. 01/10/12 1.2 Karla Pereira Padronização do documento. out-12 Pág. 2 / 11
Sumário Introdução... 5 Definições, Acrônimos e Abreviações... 5 Escopo... 5 1. Dependências... 6 1.1. Versões dos Softwares... 6 1.2. Dispositivos Homologados... 6 2. Deploy de Aplicação... 7 2.1 Arquivos.war... 7 2.2 Arquivo de Configuração do Banco de Dados... 8 2.3 Arquivo de Configuração da Aplicação... 8 3. Instalação da Versão Android... 9 3.1 Configuração do Servidor... 10 out-12 Pág. 3 / 11
Sumário Complementar de Figuras Estrutura de mapeamento das aplicações 1... 9 Declaração mínima do arquivo apps.xml 1... 9 Acesso a configuração da aplicação 1... 10 Tela de configuração da aplicação 1... 11 out-12 Pág. 4 / 11
Introdução Este documento tem por objetivo descrever o processo de instalação do produto MV Portaria. O públicoalvo deste artefato são os responsáveis pela instalação do MV Portaria nos diversos ambientes dos clientes, podem ser ambientes de testes, homologação, apresentação, produção entre outros. Definições, Acrônimos e Abreviações Essa sub-seção descreve as definições de todos os termos, acrônimos e abreviações necessárias para a interpretação deste documento. Termo Descrição Android Coletores Smartphones Escopo Este documento tem como objetivo: Apresentar as dependências para a correta instalação do produto MV Portaria; O passo-a-passo de instalação do MV Portaria; O passo-a-passo para a instalação da versão para smartphones que utilizam o sistema operacional Android out-12 Pág. 5 / 11
1. Dependências Para que o produto MV Portaria funcione corretamente, existe a necessidade de procedimentos de instalação tanto para o servidor de aplicação que abrigará o MV Portaria, assim como para os"clientes" que acessam a aplicação via dispositivos móveis. 1.1. Versões dos Softwares Para o correto funcionamento da aplicação MV Portaria os softwares utilizados pela aplicação devem estar com a versão compatível indicada. A seguir são listados os softwares e as versões correspondentes. Java 6 ou versão mais recente; Oracle Database 8i; Servidor de Aplicação Tomcat 6.0.14 ou superior; Caso o cliente utilize a versão para Android, ver as especificações de equipamentos homologados. 1.2. Dispositivos Homologados Abaixo, segue a relação dos dispositivos homologados para a versão coletores: Honeywell Dolphin 9700 Sistema Operacional Windows Mobile 6.5 Processador Memória Marvel XScale PXA270 624 MHz 256 MB RAM x 1 GB Flash Display (pol.) 3,7 Resolução 480 x 640 Leitor de Código de Barras Wireless Teclado Sim, inclusive Data Matrix 802.11 a/b/g QWERTY out-12 Pág. 6 / 11
Dimensões (mm) 165 x 85 x 41 Peso (g) 380 Dispositivos homologados para versão Android: O aparelho homologado é o Samsung Galaxy S, modelo GT-I9000B, que possui uma resolução de 480 x 800 que utiliza a versão 2.1 do sistema operacional Android, portanto é necessário ter no mínimo essa versão para a execução da aplicação. 2. Deploy de Aplicação O processo de deploy da aplicação consiste na instalação do MV Portaria no servidor Tomcat, assim como a configuração desta aplicação através dos arquivos de propriedades, os quais devem ser ajustados de acordo com as especificidades do ambiente. Antes de prosseguir, o responsável pela instalação deve se certificar de ter em mãos as seguintes informações: Configurações de acesso do banco de dados que o MV Portaria vai utilizar, como servidor, porta, usuário, senha, etc; Nome da máquina que a aplicação será instalada. 2.1 Arquivos.war A aplicação é empacotada (compactada) num arquivo web application archive ou WAR, com o nome mvmobportaria.war (o nome vai depender da versão a ser instalada), o qual contém, além das classes da aplicação, os diversos arquivos e bibliotecas utilizados pela aplicação (imagens, arquivos de configuração, applets, arquivos de estilo). Este arquivo deve ser copiado dentro do diretório webapps do Tomcat, devendo o Tomcat estar parado (stopped). Ao iniciar o Tomcat, este irá, automaticamente, descompactar o arquivo WAR, criando a pasta mvmobportaria dentro da pasta webapps do Tomcat. Observações: Só iniciar o servidor Tomcat após todas as configurações abaixo serem realizadas, senão as mesmas não serão aplicadas corretamente. out-12 Pág. 7 / 11
2.2 Arquivo de Configuração do Banco de Dados O primeiro arquivo que deve ser configurado é o db.properties, que contém as configurações de acesso ao banco de dados do cliente, como nome do usuário, senha, host, porta, nome do serviço (servicename) e url. Este arquivo deve ser ajustado de acordo com o ambiente no qual a aplicação está sendo instalada. Antes que seja possível alterar este arquivo, é necessário criar (caso não exista) a estrutura de diretórios para os arquivos de configuração da aplicação e criar a variável de ambiente no que indica sua localização no servidor: No servidor, criar a variável de ambiente de nome MV_HOME, cujo valor deve corresponder ao diretório o qual pretende-se armazenar os arquivos de configuração (por padrão a variável deverá ser configurada para: C:\MV); Mover a estrutura de diretórios que possui os arquivos de configuração (fornecidos juntamente com a aplicação) para a pasta definida na variável ambiente %MV_HOME%. Caso a estrutura C:\MV já exista, executar somente o passo abaixo: Mover o diretório mvmobportaria (que vem junto com o pacote de instalação compactado no arquivo mvmobportaria.zip) que consta na estrutura de diretórios que possui os arquivos de configuração (fornecidos juntamente com a aplicação) para a pasta definida em %MV_HOME%/apps/. 2.3 Arquivo de Configuração da Aplicação Para que as configurações sejam identificadas pela aplicação, deve-se editar o arquivo apps.xml localizado em %MV_HOME%/conf/. Este arquivo é responsável por associar as aplicações com sua respectiva pasta de arquivos de configuração (cada aplicação vai possuir a sua própria pasta de configuração conforme o passo anterior). O mapeamento da aplicação para a sua respectiva pasta de configuração deve utilizar a seguinte estrutura: out-12 Pág. 8 / 11
Estrutura de mapeamento das aplicações 1 Observação: Ao preencher o campo dir, tenha cuidado com o nome da máquina (HOSTNAME), pois o mesmo é case sensitive (diferencia letras maiúsculas de minusculas). Na imagem abaixo, segue um exemplo de declaração mínima que o arquivo apps.xml deve conter. Declaração mínima do arquivo apps.xml 1 Observação: Este arquivo pode conter outras configurações de aplicações já instaladas. Tenha cuidado para não remover estas configurações já existentes. de 480 x 800 que utiliza a versão 2.1 do sistema operacional Android, portanto é necessário ter no mínimo essa versão para a execução da aplicação. 3. Instalação da Versão Android ATENÇÃO: Somente prosseguir com esse passo, caso a versão para dispositivos que utilizam o sistema operacional Android seja utilizada pelo cliente. Através de uma conexão USB, o usuário deve copiar e colar a pasta MVPortariaAndroid no diretório raiz do cartão de memória. Após copiar a pasta para o cartão de memória, deve-se executar e instalar os arquivos abaixo na seguinte ordem: BarcodeScanner.apk (aplicação que lê os códigos de barra); out-12 Pág. 9 / 11
MV Portaria.apk (aplicação MV Portaria). Observação: A aplicação MV Portaria necessita que o aplicativo BarcodeScanner seja instalado, pois faz uso do seu recurso de leitura de códigos de barra. 3.1 Configuração do Servidor Após a instalação dos aplicativos acima, o usuário deve localizar a aplicação no seu smartphone e configurar o servidor de acesso a aplicação. Para isso, deve-se acessar a aplicação MV Portaria e executar a ação de menu (botão de menu localizado nos aparelhos Android) onde o usuário deve clicar na opção Configurações conforme a imagem abaixo: Acesso a configuração da aplicação 1 Na tela de configuração, o usuário deve preencher as informações de servidor e portar com as mesmas informações onde a aplicação foi configurada anteriormente no passo 3.2 Arquivo de out-12 Pág. 10 / 11
no passo 3.2 Arquivo de Configuração do Banco de Dados. Abaixo, segue a tela de configuração: Tela de configuração da aplicação 1 Após preencher as informações, o usuário deve testar a conexão e caso a mesma retorne que foi realizada com sucesso, o usuário deve executar a ação de Salvar. out-12 Pág. 11 / 11