Documentação de software

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.
====== Terminal de Mídias - Consulta Preço IWS ======

Esta ferramenta foi desenvolvida para oferecer o serviço de consulta de preços e ainda disponibilizar a exibição de promoções e campanhas, seja por imagens ou por vídeos.

O aplicativo foi desenvolvido para ser executado com dispositivo CK-100 da BlueBird, que opera com o sistema operacional Android 6.0.1.

O serviço ao qual os terminais se conectarão para realizar as consultas foi desenvolvido para o sistema operacional Windows (a partir do 7).

===== App Android =====

==== Home ====
Ao executar o aplicativo pela primeira vez, duas informações são solicitadas ao usuário, sendo o **Nome do Terminal** (apelido), e o IP:PORTA do servidor, de onde serão feitas as consultas.

{{ ::apphome.png |}}

<note important>Recomenda-se manter a porta 8032.</note>
==== Consulta ====
Ao iniciar a tela de consultas é exibida com a tela de produto não encontrado.

{{ :produtonaoencontado_nodetails.png |}}

Ao realizar uma consulta pelo leitor óptico, os detalhes da consulta serão exibidos de acordo com as informações disponíveis do produto como:

**Dados básicos:**

 -> código do produto;

 -> Descrição do produto;

 -> Preço do produto; 

 -> Preço normal = 0 / Preço Promoção = 1.

{{ ::appproduto.png |}}

**Dados Adicionais:**

 -> Preço de Atacado (menor preço);

{{ ::appatacado.png |}}

 -> Produtos Associados (até dois itens);

{{ ::appassociado.png |}}


**Cabeçalho e Rodapé**

Dentre as informações opcionais estão o cabeçaho, composto por um campo de texto e duas imagens, e o rodapé, composto por um campo de texto.
Para que o cabeçalho seja exibido é necessário que algum texto seja configurado, do contrario, ele não aparecerá. O mesmo se aplica ao rodapé.



==== Divulgação ====
Após um tempo de sociosidade o aplicativo inicia um processo de exibição de conteúdo. Este conteúdo pode ser imagens (PNG, JPG) e vídeos(MP4 e 3GP). 

{{ ::video.png |}}


===== Servidor de API =====

Uma palicação hospeda um serviço de API que restorna os parâmetros de configuração do app Android e as informações requisitadas.

==== Liberação ====

{{ ::logliberacao.jpg |}}

A primeira consulta ao servidor feita pelo teminal irá revelar o identificador do equipamento. Este valor deve ser enviado para a IWS juntamente com os dados do cliente para que uma chave de liberação seja gerada.

Dessa forma um arquivos com extensão **.iws** será devolvido ao cliente que deverá importá-lo no programa por este botão:

{{ ::btn_liberar.png |}}

Depois essas etapas, o terminal já estará habilitado para realizar consultas.

==== Configurações ====
A tela principal é a tela de configuração, de onde serão executadas as operações de importação de arquivos que alimentarão o banco de dados, configuração de cores do aplicativo e informações de cabeçalho e rodapé.

{{ ::serverhome.png |}}

**1 Ativa/Desativa** o serviço de API (status do serviço disponível na barra inferior);

**2 Gestão de Cores** abre uma janela que representa os elementos visuais da aplicação Android. O Clique em um dos elementos da janela abrirá uma janela de diálogo para seleção de cor;

{{ ::cores.png |}}

  O botão **Default** retorna para as cores básicas, como exibido na imagem.

**3 Cabeçalho** permite informar o local das imagens do cabeçalho bem como o texto que será exibido;

**4 Diretório de Imagens** aponta para diretório onde as imagens dos produtos estão armazenadas. Quando uma imagem deste diretório tem como nome o código do produto, a imagem é automaticamente carregada na aplicação Android. Do contrário, a imagem deve ser indicada no arquivo de importação de produtos ou alterado pela tela de produtos;

**5 Arquivo de Produtos** é o principal arquivo que irá alimentar o banco de dados da aplicação servidora. 

**Composição do Arquivo de Produtos**
  <ean>|<descricao>|<preço>|<*0/1 promoção>|<*dir.Img>
  Ex.:
  7891000065440|LEITE CONDENÇADO MOÇA 395G|4.85|1|C:\IMGS\IMAGEM01.JPG
  7898341430081|NÉCTAR DE CAJU DEL VALLE 1LT|5.99||C:\IMGS\7898341430081.PNG
  7891048050293|GELATINA UVA DR.OETKER|0.88
  *campos não obrigatórios

Após a importação o arquivo é renomeado.

**6 Arquivo de Produtos Associados**
Importa um arquivo de onde serão relacionados os itens associados. Um produto pode ter até dois podutos associados. A relação entre os itens se dá pelos códigos de cada um.

**Composição do Arquivo de Produtos Associados**
  <ean produto>|<ean associado 1>|<ean associado 2>
  Ex.:
  7891048050293|7898341430081|7891000065440
  Obs.: Os códigos dos produtos devem existir na tabela de produtos para que sejam exibidos corretamente.
  

**7 Arquivo de Preços de Atacado**
Importa um arquivo com as características descritivas dos preços de atacado do produto. Na consulta será retornado o menor praço do produto.

**Composição do Arquivo de Preço de atacado**
  <ean>|<qtde. a partir de>|<unidade>|<valor de oferta>
  Ex.: 
  7898341430081|6|Un.|2.99
  7622300807399|5|Cx.|5.85

**8 Diretório de Mídias de Divulgação**
Esta configuração aponta para um diretório que contem imagens e/ou vídeos que serão exibidos pela aplicação Android em seus momentos de ociosidade.

O tempo de ociosidade é definido pela configuração **9** e para imagens, o tempo de exibição das imagens é definido pela configuração **10**;

**11 Dígito separador** indica qual é o símbolo que separa os elementos do arquivo de texto ou csv. Por padrão, o '|' (pipe) é utilizado, mas pode ser alterado para ';' caso necessário.

**12 Texto do Rodapé**, quando não estiver em branco, aparecerá na parte inferior da aplicação Android.

**13 Configuração** exibe uma tabela com todas as configurações salvas e seus valores.
Documentação de software

Ferramentas do usuário

Ferramentas do site

Ferramentas da página
