Manual do Receptor 1.1. Divulgação de Resultado das Eleições Manual do Receptor Versão 1.1 de 20/08/2014. Divulgação de Resultado das Eleições

Transcrição

1 Manual do Receptor Manual do Receptor Versão. de 0/08/0.

2 Sumário. Apresentação.... As telas do sistema... a) Tela inicial... b) Tela de configuração básica... c) Tela de configuração do Provedor.... Utilizando o Receptor em Linha de Comando... 7 a) Arquivo receptor.properties... 7 b) Exemplo receptor.properties simplificado... 9 Manual do Receptor Versão. de 0/08/0

3 Manual do Receptor Manual do Receptor. Apresentação O Receptor é o sistema que recepciona os arquivos de resultado das Eleições de um repositório e os transfere para um destino configurável. Produzido pela Justiça Eleitoral JE, este sistema é responsável pelo transporte automatizado dos arquivos de resultados da Divulgação entre HOST e servidores HTTP, mantendo o controle sobre as atualizações de resultados, evitando acessos redundantes e consequente congestionamento no tráfego de rede. Pode ser utilizado por empresas de comunicação parceiras da JE, para baixar os arquivos da Divulgação do Data Center, e pelos Tribunais Regionais Eleitorais TRE, para baixar esses arquivos de um servidor HTTP e transferi-los a um destino configurável.. As telas do sistema a) Tela inicial A tela inicial é usada para iniciar e parar as transferências de arquivos. Seguem os detalhes: Figura. Tela inicial Receptor Botão Iniciar : inicia o processo de recepção e transferência dos arquivos. Esse processo consiste em, a cada 0 segundos, o software procurar por atualizações de arquivos no provedor configurado e consequentemente transferir esses arquivos para o destino também configurado. Botão Parar : para o processo de recepção e transferência dos arquivos. Ao clicar nesse botão, o processo é interrompido imediatamente. A clicar em Iniciar novamente, o processo é retomado do ponto em que parou. Manual do Receptor Versão. de 0/08/0

4 Botão Configurar : abra a tela de configuração do software. Os detalhes sobre essas configurações serão explanados mais adiante. Situação do serviço indica em que fase o software está (Transferência parada, Transferência em andamento..., Ciclo finalizado., Aguardando próximo ciclo de transferência... e outros). Áreas de Log: Exibe o passo a passo da recepção e transferência dos arquivos. b) Tela de configuração básica O primeiro passo para utilizar a aplicação Receptor é executar a configuração do sistema. Ao acessar a opção Configurar, o sistema abre a tela de configuração básica. Nesse momento, caso não haja nenhum provedor configurado, o sistema abre também a tela de configuração de provedor, pois só após a configuração de um provedor válido, é possível prosseguir com as demais configurações. Veja abaixo os detalhes: Figura. Tela de configuração básica Descrição do Provedor: informa o provedor atualmente configurado. Botão Alterar Provedor : abre a tela de configuração do provedor. As configurações de provedores serão detalhadas mais adiante. Seleção das Eleições : devem ser selecionadas as eleições cujos arquivos se deseja baixar. O software foi projetado para recepcionar arquivos de mais de uma eleição simultaneamente. Entende-se por eleição um conjunto de cargos em disputa ou uma consulta popular (plebiscito ou referendo). O primeiro turno das eleições municipais é considerado uma eleição, enquanto o segundo turno é outra eleição. Caso haja um referendo ou um plebiscito ocorrendo junto ao primeiro ou ao segundo turno das eleições municipais, haverá, nesse dia, duas eleições concomitantes. Essas eleições, por sua vez, estarão disponíveis para seleção. Caso deseje receber dados tanto da eleição municipal quanto da consulta popular, devem-se marcar as duas. Manual do Receptor Versão. de 0/08/0

5 Seleção das Abrangências : cada eleição é realizada em uma ou mais Unidades da Federação. Ao selecionar uma eleição, deve selecionar também de qual UF se deseja recepcionar os arquivos. Por e- xemplo, caso tenha interesse em baixar apenas arquivos do estado de São Paulo, então apenas essa UF deve estar selecionada Tipo de destino: ao recepcionar os arquivos, o software grava-os em um destino. Esse campo permite especificar o tipo de destino dos arquivos, que pode ser: LOCAL (pasta localizada no sistema de arquivos onde o Receptor está sendo executado), FTP (pata em um servidor FTP), SFTP (pasta em um servidor SFTP). Pasta de destino: independente do tipo de destino especificado no campo anterior, o caminho da pasta onde os arquivos serão gravados deve ser especificado nesse campo. Configuração dos servidores FTP e SFTP: caso o tipo de destino selecionado seja FTP ou SFTP, as configurações adicionais para conexão a esses servidores devem ser informadas nesses campos. Botão Limpar Cache : ao clicar nesse botão, os registros de todos os arquivos baixados até o momento serão excluídos. No próximo ciclo de processamento, o software interpretará que nenhum arquivo foi recebido; baixando, portanto, todos os arquivos novamente. Essa função deve ser usada somente quando estritamente necessário, pois sobrecarrega em demasia os servidores onde os arquivos estão hospedados. c) Tela de configuração do Provedor O provedor consiste em um repositório de origem onde estão os arquivos de resultado das eleições. Esse provedor pode ser um o servidor HTTP provido pela Justiça Eleitoral, outro servidor HTTP ou uma pasta no próprio sistema de arquivo, desde que contenha os arquivos e a estrutura de pasta esperada. Figura. Tela de configuração de provedor Manual do Receptor Versão. de 0/08/0

6 Tipo: os tipos possíveis para um provedor são: Justiça Eleitoral: servidor oficial dos arquivos de resultado das eleições. Essa deve ser a configuração utilizada no dia da eleição para aqueles que se conectarão via Internet. Intranet TRE: provedor de uso exclusivo dos Tribunais Regionais Eleitorais. Para usar esse tipo de provedor, o Regional deve estar, obrigatoriamente, conectado à Intranet da Justiça E- leitoral. HTTP: qualquer servidor HTTP que possua os arquivos e a estrutura de pasta no padrão esperado pelo Receptor. Essa opção deve ser a utilizada nos simulados com os Parceiros, ou para acessar um servidor diferente dos dois já pré-definidos (Justiça Eleitoral e Intranet TRE). Por exemplo, caso deseje cascatear Receptores, ou seja, baixam-se os arquivos de um provedor da Justiça Eleitoral para outro servidor HTTP e, posteriormente, desse para um segundo destino. Pasta Local: qualquer pasta no sistema de arquivo que possua os arquivos e a estrutura de pasta no padrão esperado pelo Receptor. Essa opção pode ser usada caso já tenha baixado os arquivos e deseja-se replicar esses arquivos para outra pasta. Fase: Determina a que fase a pertencem os arquivos que se deseja baixar. Pode ser: Oficial: arquivos que contém os resultados oficiais das eleições. Simulado: arquivos que contém dados simulados, utilizados em testes. Outros: utilizado no caso em que, havendo mais de um simulado concomitante, seja possível separar os arquivos de um ambiente e de outro. Dessa forma, um dos simulados receberia um alias (por exemplo, teste ). Ao selecionar Outros, é necessário especificar o alias. UF: usado somente para o tipo Intranet TRE, pois nesse tipo é necessário especificar a UF do Tribunal Regional. Pasta/URL: usado para os tipos HTTP e Pasta Local. Em caso de HTTP, deve-se especificar a URL do servidor. Em se tratando de Pasta Local, deve-se especificar o caminho completo da pasta. Tanto para URL quanto para Pasta, o caminho deve apontar para a pasta que contém as subpastas comum e 0 ; Configurações de Proxy: se o Receptor estiver instalado em uma rede em que seja exigido o uso de Proxy para acesso ao Provedor, será necessário configurar o servidor de Proxy procure um administrador de sua rede e consulte as informações necessárias para o preenchimento destas informações. Manual do Receptor Versão. de 0/08/0 6

7 . Utilizando o Receptor em Linha de Comando Para executar o Receptor por linha de comando, devem ser seguidas a etapas a seguir: Baixar o arquivo zip do Receptor e descompactá-lo, ou baixar e executar o instalador do Receptor para o sistema operacional adequado. Preencher o arquivo receptor.properties com as configurações conforme detalhado abaixo. Executar o comando receptor.bat <opção>, para Windows, ou receptor.sh <opção>, para Linux. o o O comando acima deverá ser executado dentro do diretório em que o arquivo receptor.jar está localizado); O parâmetro <opção> deve ter um dos seguintes valores: iniciar inicia o processo de recepção e transferência dos arquivos. parar para o processo de recepção e transferência dos arquivos. estado mostra em que estado se encontra a aplicação. Os estados possíveis são: "Transferencia em andamento", "Ciclo finalizado. Aguardando proximo ciclo de transferencia" e "Transferencia parada". listar lista os registros da data e hora da última atualização de todos os arquivos transferidos até o momento limpar-cache exclui os registros de todos os arquivos baixados até o momento. A versão da JRE (Java Runtime Enviromment) para execução do Receptor deve ser 6 ou superior. a) Arquivo receptor.properties O arquivo receptor.properties se encontra no diretório de instalação do software ou no diretório resultado da descompactação. As configurações constantes nesse arquivo serão utilizadas para a execução do processo de recepção e transferência dos arquivos da divulgação. Ele poderá conter o campos a seguir: eleicoes: Campo obrigatório. Indica as eleições e respectivas abrangências cujos arquivos se deseja baixar. O valor desse campo é um texto com a seguinte estrutura: [ { código :codigo-eleicao-, abrangencias :[ sigla-agrangencia-, sigla-abrangencia-n ] }, { código :codigo-eleicao-n, abrangências :[ sigla-agrangencia-, sigla-abrangencia-n ] } ] Onde: codigo-eleicao é um número identificador da eleição e sigla-abrangencia é a sigla da UF em maiúsculo ou a sigla BR para arquivos nacionais. Note que é possível especificar uma ou mais eleições. Cada uma identificada por um código. Cada eleição possui um conjunto de abrangências representadas entre colchetes e separadas por vírgula. o Ex: eleições= [{ codigo :99999, abrangencias":[ BR, AC, AL, AP]}, { codigo :88888, abrangencias :[ RO ]}] destino.protocolo: Campo obrigatório. Indica o tipo da pasta de destino. Valores possíveis são local, sftp ou ftp. Caso seja escolhida a opção sftp ou ftp, os seguintes campos devem ser preenchidos: destino.servidor, destino.porta, destino.usuario, destino.senha, destino.caminho. o Ex: destino.protocolo=local Manual do Receptor Versão. de 0/08/0 7

8 destino.servidor: Campo obrigatório caso o campo destino.protocolo seja igual a sftp ou ftp. Indica o endereço do servidor FTP ou SFTP de destino. o Ex: destino.servidor = destino.porta: Campo obrigatório caso o campo destino.protocolo seja igual a sftp ou ftp. Indica a porta utilizada para conexão FTP ou SFTP. o Ex: destino.porta = destino.usuario: Campo opcional. Indica o usuário utilizado para conexão FTP ou SFTP. o Ex: destino.usuario =usuario destino.senha: Campo opcional. Indica a senha utilizada para conexão FTP ou SFTP. o Ex: destino.senha =senha destino.ftpmodopassivo: Campo obrigatório caso o campo destino.protocolo seja igual a sftp ou ftp. Indica se é utilizado modo passivo para conexão FTP. Valores possíveis são true (indica que será utilizado o modo passivo) ou false (indica que não será utilizado o modo passivo). o Ex: destino.ftpmodopassivo =false destino.caminho: Campo obrigatório. Indica o endereço da pasta de destino. o Ex: destino.caminho =/home/receptor/destino provedor.tipo: Campo obrigatório. Indica o tipo de provedor utilizado. Os valores possíveis são: : para provedor do tipo Justiça Eleitoral; : para provedor do tipo Intranet TRE; : para provedor do tipo HTTP; : para provedor do tipo Pasta Local. o Ex: provedor.tipo = provedor.fase: Campo obrigatório. Indica se os dados dos arquivos são oficiais, simulados ou outros. Os valores possíveis são: O : para fase Oficial; S : para fase Simulado; T : para fase Outros o Ex: provedor.fase=o provedor.fase.outros: Campo obrigatório caso o campo provedor.fase seja igual a T (Outros). Especifica o alias da fase em que se encontram os dados dos arquivos. o Ex: provedor.fase.outros=teste provedor.uf: Campo obrigatório caso campo provedor.tipo tenha valor igual (Intranet TRE). Indica qual a UF do TRE. Valores possíveis são AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE ou TO. o Ex: provedor.uf=ac provedor.pastaurl: Campo obrigatório caso campo provedor.tipo tenha valor igual a (HTTP) ou (Pasta Local). Indica qual a URL ou a pasta de origem onde se encontram os arquivos. o Ex: provedor.pastaurl= Manual do Receptor Versão. de 0/08/0 8

9 provedor.proxy.habilitado: Campo obrigatório. Indica se será utilizado Proxy na conexão. Valores possíveis são true (para uso de Proxy) ou false (caso não seja utilizado Proxy). o Ex: provedor.proxy.habilitado=false provedor.proxy.endereco: Campo obrigatório caso o campo provedor.proxy.habilitado tenha valor igual a true. Indica o endereço do Proxy utilizado na conexão. o Ex: provedor.proxy.endereco= provedor.proxy.porta: Campo obrigatório caso campo provedor.proxy.habilitado tenha valor igual a true. Indica a porta utilizada para conexão no Proxy. o Ex: provedor.proxy.porta=80 provedor.proxy.usuario: Campo opcional. Indica o usuário utilizado para conexão no Proxy. o Ex: provedor.proxy.usuario=usuario provedor.proxy.senha: Campo opcional. Indica a senha utilizada para conexão no Proxy. o Ex: provedor.proxy.senha=senha b) Exemplo receptor.properties simplificado #CONFIGURAÇÃO DA ELEIÇÃO eleicoes=[{"codigo":7,"abrangencias":["br","ac,"mg","sp"]}] #CONFIGURAÇÃO DO DESTINO destino.protocolo=local destino.servidor= destino.porta= destino.usuario= destino.senha= destino.ftpmodopassivo= destino.caminho=/home/receptor/destino #CONFIGURAÇÃO DA ORIGEM provedor.tipo= provedor.fase=o provedor.fase.outros= provedor.uf= provedor.pastaurl= #CONFIGURAÇÃO DE PROXY provedor.proxy.habilitado=false provedor.proxy.endereco= provedor.proxy.porta= provedor.proxy.usuario= provedor.proxy.senha= Manual do Receptor Versão. de 0/08/0 9