Produto VI:
ATUSAAP
How To (Como fazer)
Pablo Nogueira Oliveira
Termo de Referência nº 129275
Contrato Número 2008/000988
Brasília, 30 de outubro de 2008
Sumário
1) Introdução...3 2) How To (Como fazer)...3 2.1) Como instalar o sistema operacional...3 2.1.1) Iniciando a instalação...3 2.2) Como instalar o SAAP...8 2.2.1) Iniciando a instalação manual do SAAP...9 2.2.2) Iniciando a instalação automática do SAAP...11 2.3) Como fazer a configuração básica do SAAP (posinstalação)...13 2.3.1) Configuração da Ferramenta SAAP...14 2.3.2) Configuração do Email...15 2.3.3) Configuração do sitema de control de processos e pleitos...16 2.3.4) Configuração da Agenda...20 2.4) Como deixar o SAAP pronto para uso...211) Introdução
O presente relatório tem como objetivo apresentar capítulos com descrições de passos necessários para a realização de tarefas relacionadas a instalação e configuração do Sistema SAAP, instalações e configurações necessárias para se ter um servidor pronto para uso.
2) How To (Como fazer)
Um How To compreende uma descrição dos passos necessários para execução de tarefas específicas. Geralmente é desenvolvido para ajudar pessoas que não tem muita experiência, abordando descrições de passos simplificados e direcionados. 2.1) Como instalar o sistema operacional Notas: 1) A distribuição que o Interlegis adotou como plataforma, tanto de desenvolvimento quanto para seus servidores é a Ubuntu GNU/Linux Hardy Heron versão 8.04 LST. Todos os passos que seguem neste relatório são referentes à esta distribuição.
2) Para baixar a versão do Ubuntu, acessar o link de referência http://ubuntu.c3sl.ufpr.br/releases/hardy/
3) Para verificar a integridade dos arquivos que foram baixados na Internet, em comparação com os arquivos do servidor, certificandose que a instalação ocorrerá sem problemas, utilizase o MD5. Para baixálo acessar o seguinte link de referência http://wiki.ubuntu br.org/ConferindoMd5 4) Certificarse que haja conexão com a Internet para que a instalação ocorra seguindo todos os passos descritos abaixo. 5) É recomendado que seja feito backup dos dados do servidor, para que não sejam perdidos na hora da reinstalação. 6) Certificarse de obter um CD com o Ubuntu, ou graválo. 2.1.1) Iniciando a instalação Após o download e gravação da imagem do Ubuntu em um CD, devese configurar o
computador para que ele inicie pelo mesmo. Ao iniciar o processo de instalação aparecerá a tela mostrada na Figura 1, com as seguintes opções: ● F1 – (Ajuda): O usuário iniciante pode utilizarse desta opção para decidir qual o melhor caminho à tomar para o início da instalação; ● F2 – (Idioma): Opção para a alteração da linguagem do sistema; ● F3 – (Mapa de teclas): Opção para alteração do mapa de teclados do sistema, ajustandoo ao
existente no computador. No Brasil, normalmente encontramos a opção ABNT2, pela existência da tecla Ç; ● F4 – (Modos): Opção para selecionar o tipo de instalação (Normal, Gráfico Seguro, etc.). ● F5 – (Acessibilidade): O projeto do Ubuntu GNU/Linux preocupouse em oferecer opções de acessibilidade para deficientes , tanto visuais como auditivos. Com a escolha desta opção, a instalação tornase mais amigável para portadores de alguma deficiência; ● F6 – (Outras opções): Estão à mostra nesta opção, escolhas como instalação via texto ou parametrização do kernel, se necessário. Selecione a opção F2 e selecione o idioma Português do Brasil e em seguida escolha a opção “Instalar o Ubuntu”. Figura 1 – Inicio da Instalação
Em seguida será disponibilizado uma tela onde será apresentado novamente opções de idioma. Selecione Português do Brasil e clique em “Avançar”.
Figura 2 Seleção de Idioma
Seleção do Fuso Horário. Escolha São Paulo e clique em avançar.
Selecione o seu layout de teclado. E clique em avançar.
Figura 4 – Layout de teclado
O próximo passo será o particionamento do disco. Selecione a opção “Assistido – usar o disco inteiro se você deseja instalar o Ubuntu no seu computador. Esta opção irá formatar todas as informações do seu computador. Só utilize esta opção se não há nada de importante no seu HD que não possa ser perdido. Você pode também selecionar a opção manual e particionar manualmente o HD.
Em seguida deverá configurar o usuário inicial do sistema. Informe o nome de usuário, o login, a senha e o nome do computador. Depois de todos os campos preenchidos clique em “Avançar”.
Figura 6 – Configuração do Usuário Para finalizar clique em “Avançar”
Após ser iniciado, o sistema apresentará a tela de autenticação. Para autenticarse devese inserir o usuário e senha configurados no momento da instalação do Ubuntu. Figura 8 – Tela de Iniciação do Ubuntu. 2.2) Como instalar o SAAP O SAAP pode ser instalado de duas maneiras, manualmente ou automaticamente. Fazer a instalação manualmente significa que o administrador terá que baixar o pacote de instalação do SAAP no repositório Interlegis e proceder com a instalação. A instalação automática é feita através do pacote .deb que tem como procedimento instalar todas as dependências, incluindo Zope, se não estiver instalado, e Plone, e configurar um portal com um Sistema SAAP básico, onde a Casa deve, após a instalação, configurálo para adequálo às suas necessidades e realidade.
2.2.1) Iniciando a instalação manual do SAAP
Após essa instalação o SAAP estará semipronto para uso. Nesta instalação todas as dependências do SAAP serão instaladas, tanto para Zope, Python ou Plone. Para minimizar o esforço desse tipo de instalação foi criado para o SAAP um pacote chamado SAAP UnifiedInstaller.
O SAAPUnifiedInstaller é um pacote disponibilizado pela Interlegis contendo todos os fontes das dependências do SAAP e um script instalador.
Para realizar a instalação mencionada será necessário seguir os seguintes passos:
1. Baixar e descompactar o arquivo SAAPUnifiedInstaller do respositório Interlegis no diretório /tmp:
$ cd /tmp
$ sudo wget http://repositorio.interlegis.gov.br/ILSAAP/releases/SAAP-UnifiedInstaller.tgz
$ sudo tar -xzvf SAAP-UnifiedInstaller.tgz
2. Executar o script de Instalação:
$ cd SAAP-UnifiedInstaller $ sudo chmod +x installSaap.sh $ sudo ./installSaap.sh 3. Configurar opções de instalação pois algumas perguntas serão feitas sobre a instalação quando o script for executado. A resposta padrão para cada pergunta está marcada entre os caracteres [ ]. Para aceitar a opção padrão basta teclar enter. Ou então digitar a opção desejada. A primeira pergunta será quanto ao diretório onde o SAAP será instalado. A resposta padrão é /var/interlegis. Desta forma o SAAP será instalado no seguinte caminho completo: /var/interlegis/saap
Figura 9 – Inicio da instalação SAAP.
Depois de selecionar o diretório será perguntado em qual porta o ZOPE deverá estabelecer o serviço HTTP. A resposta padrão é 8280. Caso esta porta já esteja sendo utilizado será necessário alterála por outra.
Figura 10 – Seleção da porta HTTP
Uma vez selecionada a porta o script prosseguirá com a instalação instalando o Zope, todas as bibliotecas Python, o Plone, todos os produtos Plone e finalmente o SAAP. Feito isso o administrador deverá acessar o SAAP e terminar o restante das configurações.
2.2.2) Iniciando a instalação automática do SAAP
Todos os sistemas desenvolvidos pelo Interlegis são distribuídos livremente e publicados sob a Licença GPL[1]. Como qualquer sistema, o SAAP pode ser instalado manualmente em
qualquer Sistema Operacional, mas somente possuem instalador automático[2] para o Ubuntu
GNU/Linux, versão 8.04, Hardy[3].
Para instalação autmática do SAAP é necessário substituir o arquivo /etc/apt/sources.list da instalação original, pelo arquivo abaixo, executando o seguinte comando:
$ sudo mv /etc/apt/sources.list /etc/apt/sources.list-orig $ sudo vi /etc/apt/sources.list No editor de arquivos vi[5]executar digitar “i” copiar o arquivo abaixo relacionado, e colar no arquivo recém criado digitar “:wq” Sources.list Ubuntu 8.04 que deve ser copiado
## SAPL, SAAP, Portal Modelo
deb http://ftp.interlegis.gov.br/pub/interlegis/produtos/ubuntu interlegis/ ## Mirror Interlegis
#deb http://ubuntu.interlegis.gov.br/archive hardy main restricted universe #deb-src http://ubuntu.interlegis.gov.br/archive hardy main restricted universe #deb http://ubuntu.interlegis.gov.br/archive hardy-updates main restricted universe
#deb-src http://ubuntu.interlegis.gov.br/archive hardy-updates main restricted universe
#deb http://ubuntu.interlegis.gov.br/archive hardy-security main restricted universe
#deb-src http://ubuntu.interlegis.gov.br/archive hardy-security main restricted universe
## Mirror Ubuntu
deb http://br.archive.ubuntu.com/ubuntu hardy main restricted universe #deb-src http://br.archive.ubuntu.com/ubuntu hardy main restricted universe deb http://br.archive.ubuntu.com/ubuntu hardy-updates main restricted universe #deb-src http://br.archive.ubuntu.com/ubuntu hardy-updates main restricted
universe
deb http://br.archive.ubuntu.com/ubuntu hardy-security main restricted universe #deb-src http://br.archive.ubuntu.com/ubuntu hardy-security main restricted universe
Depois desta operação, é necessário atualizar a lista de softwares do Ubuntu com o comando:
$ sudo apt-get update
Neste momento será possível executar o comando para instalação do SAAP:
$ sudo apt-get install saap
Conteúdo Relacionado: [1] Referência sobre Licença GPL http://www.magnux.org/doc/GPLpt_BR.txt [2] Para maiores informações sobre o ambiente homologado para os sistema, ver o item 2.2 deste relatório. [3] Para baixar a versão do Ubuntu, acessar o link de referência http://oldreleases.ubuntu.com/releases/hardy [4] Para um processo de instalação mais detalhado, composto de instalação do Sistema Operacional Ubuntu mais instalação do SAAP, devese recorrer ao Relatório VI – How To (Como Fazer). [5] Referência para utilização do editor vi http://jczucco.blogspot.com/2006/03/vimgraphicalcheatsheet.html
2.3) Como fazer a configuração básica do SAAP (posinstalação)
Para utilizar o SAAP é necessário realizar algumas configurações para que estas identifiquem a Casa onde o sistema está rodando e que as funcionalidades adicionadas reflitam a necessidade da mesma, pois ao ser instalado, o SAAP possui algumas informações genéricas pré cadastradas e configurações superficiais dos serviços implantados.
Desta forma, logo após a instalação do SAAP, seja de forma manual ou automática, será necessário entrar no sistema realizar algumas configurações para deixálo pronto para uso. Para isso abra o navegador de internet e digite o endereço http://localhost:8280/saap . A aparecerá a tela de login onde deve ser digitado administrador para o login e saap para a senha.
Ao acessar com o usuário administrador do SAAP será apresentada a tela abaixo. Figura 12 – Tela principal de administração 2.3.1) Configuração da Ferramenta SAAP O Sistema foi construído para dar maior autonomia aos usuários e administradores, fazendo com que eles não precisem alimentar muitos cadastros e consigam trabalhar com a informação de uma maneira mais direta e fácil. O SAAP possui uma ferramenta na qual o Administrador pode configurar, em uma única tela, o rodapé com informações da Casa, modificar o logo, título, configurar o email e nome do administrador que dará suporte ao sistema. Também pode manipular a lista de partidos políticos referenciada no sistema. A Figura 13, mostra a tela com os campos do formulário a serem editados para que as informações sejam corretamente inseridas. É interessante ressaltar que todos os campos possuem breves descrições para que o usuário saiba o que está sendo pedido e sob que formatação. Para acessar a ferramenta de configuraçã do SAAP, a partir da tela inicial do administrador, basta clicar em “Configurações do ILSAAP / ILSAAP Settings“ . Após realizar o preenchimento dos campos clique em salvar.
Figura 13 – Configuração ILSAAP 2.3.2) Configuração do Email Clique em “Configurações do Email / Mail Settings”. Neste formulário será configurado qual é o servidor SMTP[1] através do qual o SAAP enviará suas mensagens. A opçõe de porta por padrão é a 25 para a maioria dos servidores, mas é colocar outra caso necessário. As opçõe usuário e senha só são necessárias se o servidor SMTP exige autenticação. Clique em salvar.
Figura 14 – Configurações do Email. Conteúdo Relacionado: [1]http://pt.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol 2.3.3) Configuração do sitema de control de processos e pleitos Uma das funcionalidades reimplementadas no SAAP é o Sistema de Controle de Processos/ Pleitos. Esta funcionalidade cria um banco de dados de ocorrências onde o Parlamentar pode recuperar informações sobre o andamento de um Processo, etc... Para configurar o Sistema é necessário ser usuário com perfil de Administrador acessar o, item de menu Processos e clicar na aba Configuração. Veja na figura abaixo o formulário de configuração.
Figura 15 – Configuração do sistema de processos Através da tela apresentada acima é possível fazer configurações dos seguintes itens do primeiro tópico: ● Principal ● Título: Nome do Sistema de Controle de Processos. ● Descrição: Breve descrição sobre o Sistema de Controle de Processos.
● Data Limite: Número de dias limite para que seja enviada resposta sobre a
ocorrência cadastrada.
● Workflow: Configuração da regra de tramitação que deve ser respeitada. Podese
deixar o padrão já selecionado.
● Referências entre Ocorrências: Selecionando a opção Ativado faz com que as
Ocorrências cadastradas possam ser referenciadas. Interessante para se houver necessidade de referências cruzadas entre as informações. ● Envio de Arquivo/Imagem: Se a opção selecionada for Ativado, faz com que seja possível anexar imagens ou arquivos à Ocorrência. ● Diretriz: Texto que informa as regras que devem ser seguidas quando uma nova ocorrência for adicionada. ● Email: Nome do Servidor ou Endereço IP: Configuração do nome do servidor de email.
● Endereço de Email: Endereço de email da pessoa responsável pelo Sistema. Este
email vai ser enviado como o endereço de origem.
● Abreviação: Se necessário podese acrescentar uma abreviação para melhor
identificação do email quando aparecer na caixa postal do usuário que o receberá.
● Submissão de Ocorrências Através do Email: Configura para que ninguém possa
enviar ocorrência, ou comente os membros da equipe, ou qualquer usuário autenticado ou qualquer um mesmo não autenticado. ● Verifica Ocorrências Enviadas pelo Email: Selecionando a opção Ativado, as ocorrências podem ser verificadas quando enviadas por email. ● Política de Notificações: Permite que sejam enviadas notificações, e escolhe para quem, como emissor, desenvolvedor envolvido ou não e administradores. ● Linguagem da Notificação: Escolher em que língua será enviado o email. ● Lista de Observação: Se ativado, usuários fora da equipe do coletor podem se inscrever nas ocorrências para receber notificações por email. As configurações do item Aparência, não são cruciais para a utilização do sistema, mas interessantes pelo ponto de vista da visualização e apresentação do mesmo ao usuário que o utilizará.
● Aparência
● Uso da Caixa: Permite que as configurações do Sistema de sobressaia às do
Gerenciador de Conteúdo. ● Posição das Caixas de Ação: Configura em que coluna as caixas de ações serão visualizadas. ● Caixa de Ocorrências: Configura onde as ocorrências serão visualizadas. ● Caixas que podem ser Usadas: Opções de caixas que podem ser visualizadas pelo sistema.
● Mostrar Diretriz: Se selecionada a opção, o texto que está no item
Principal/Diretriz será mostrado em todos os formulários.
● Mostrar Endereço de Email: Se selecionada o email será mostrado nos
formulários. ● Mostrar Copyright: Se selecionada a opção o copyright do produto aparecerá no sistema. O item de Permissões deve ser configurado para que se tenha um controle do cadastro e visualização das informações dos Processos. Também limita o tamanho dos arquivos que podem ser anexados aos mesmos.
● Permissões
● Modo de Participação (podem adicionar ocorrências): Permite ou não que
qualquer usuário mesmo não autenticado possa adicionar ocorrências, ou somente os membros da equipe. ● Modo de Exibição (podem ver ocorrências): Permite a visualização da ocorrência por qualquer usuário, mesmo não estando autenticado. ● Tamanho Máximo em Bytes para Arquivos que serão Enviados: Especificação do tamanho dos arquivos que podem ser enviados. ● Equipe
● Permite que sejam configurados os usuários que trabalham com o coletor de
solicitações de processos. Podese escolher qual o papel do usuário no Sistema de Controle de Processos. O item de Edição do Esquema não se faz necessário a um primeiro momento, só se a Casa estiver insatisfeita com o formulário de entrada de dados, querendo incrementálo. ● Editor do Esquema ● No editor do esquema é possível acrescentar mais campos ao formulário de envio de ocorrências, ou mesmo ordenálos no formulário. Para acrescentar um atributo, devese, na caixa Grupos, escolher em qual tela de formulário será acrescentado o mesmo. Escolhido Dados da Ocorrência, devese, na caixa Campos, inserir o nome do mesmo e clicar no botão '+'. Abrirá uma janela de formatação onde escolhese seu tipo, componente que define o tipo, o tamanho do campo, padrão, rótulo ou nome do campo, se ele será obrigatório e terá índice para busca no catálogo. Depois de adicionálo é possível removê lo, clicando no botão em forma de 'x'. O novo atributo será adicionado ao esquema da ocorrência após ser clicado no link Atualizar esquema de todas as ocorrências, na caixa Manutenção. Também é possível recatalogar e reindexar o catálogo que possui todas as ocorrências já cadastradas. Se o grupo escolhido for o Progresso, o campo será adicionado na tela do formulário referente ao Progresso, ou no grupo Contatos o mesmo processo. ● Configuração do Grupo de Tópicos ● Neste item configurase para que usuários do Sistema de Controle de Processo receberão que categorias de ocorrências.
● Notificações
● Este formulário permite que sejam especificados endereços de email adicionais para
cada estado, a serem notificados quando houver mudança nas ocorrências. Os endereços de e mail precisam ser colocados um por linha. O item Manutenção só será requisitado quando o sistema estiver em plena utilização, ou quando um esquema for alterado. ● Manutenção ● Exibe a quantidade de ocorrências cadastradas no sistema. ● Reindexar todas as ocorrências: É necessário reindexar todas as ocorrências após renomear ou mover o Sistema de Controle de Processos. ● Atualizar esquema de todas as ocorrências: Depois que é atualizado o esquema, é necessário atualizálo.
● Atualizar esquema do coletor: Se o Sistema de Controle de Processos for
atualizado, é necessário executar esta ação.
● Recriar a ferramenta de catálogo: É útil quando o Sistema de Controle de
Processos for atualizado, ou as configurações do catálogo forem alteradas ou ainda um novo índice for adicionado.
● Recriar a ferramenta de workflow: Algumas vezes é necessário depois de atualizar
o Sistema de Controle de Processos. AVISO: ISTO FAZ COM QUE TODAS AS CUSTOMIZAÇÕES DO WORKFLOW SEJAM DESFEITAS. USE COM CAUTELA. ● Exibir ocorrências incompletas: Exibe as ocorrências incompletas e oferece uma forma rápida para rejeitálas, usando um estado e comentário predefinidos. ● Recriar UIDs do Archetypes UIDs para as ocorrências importadas: Utilizar com cuidado e apenas caso tenha sido importada uma instância de um coletor usando tanto o mecanismo de cortar/colar ou a interface de import/export do Zope. ● Enviar email para todos os membros da equipe: Um formulário simples de envio de e mail para todos os membros da equipe. 2.3.4) Configuração da Agenda Antes de começar o cadastro de itens na Agenda é necessário configurar este mecanismo. Para acessar a tela mostrada na Figura 44, é preciso clicar no link Configurar Calendário na caixa Calendário. Os campos que podem ser configurados são:
● Fontes: Onde devem ser buscados os eventos para serem mostrados no calendário
daAgenda.
● Divisão da Hora: Quanto tempo deve ser particionada a hora para ser mostrada. ● Hora de Início: Em que hora deve ser iniciado o calendário.
Figura 16 – Configuração da agenda 2.4) Como deixar o SAAP pronto para uso
Para deixar o SAAP com uma URL correta e bonita, algo como http://saap.interlegis.gov.br, é preciso instalar o Apache2 e configurar um VirtualHost.
Para instalar o Apache2, no Ubuntu é necessário executar o seguinte comando:
$ sudo apt-get install apache2
Se a rede já sabe resolver o nome (URL) do SAAP, ou seja, o DNS já está configurado, pode se criar um arquivo: $ sudo vi /etc/apache2/sites-available/saap E configurar o VirtualHost: NameVirtualHost 10.10.10.10:80 <VirtualHost 10.10.10.10:80> ServerName saap.interlegis.gov.br ServerAlias saap ServerAdmin EMAIL_DO_ADMINISTRADOR
ErrorLog /var/log/apache2/error_saap.log RewriteEngine On RewriteCond %{HTTP_HOST} ^([^:]+)(:|$) RewriteRule ^(.*)$ http://localhost:8280/VirtualHostBase/http/%1:80/saap/VirtualHostRoot$1 [P,L] </VirtualHost>
Considerando que o Apache esteja no mesmo servidor que o SAAP, esse VirtualHost passará todas as requisições que receber no domínio configurado para o Zope, com a URL reescrita em conjunto com o Virtual Host Monster que deve estar habilitado na raiz do Zope.
Antes de habilitar o VirtualHost criado, precisase habilitar os módulos rewrite e proxy do Apache, fazendo um link simbólico dos arquivos /etc/apache2/modsavailable/rewrite.load e /etc/apache2/modsavailable/proxy.load no respectivo diretório de módulos habilitados, o /etc/apache2/modsenabled. Para isso, utilizando o terminal, digitar: $ cd /etc/apache2/mods-enabled Para criar o link do módulo proxy, digita no terminal: $ sudo ln s /etc/apache2/modsavailable/proxy.load Para criar o link do módulo rewrite, digita no terminal: $ sudo ln -s /etc/apache2/mods-available/rewrite.load
Considerando que você instalou o Apache2, e esse VirtualHost foi criado no diretório /etc/apache/sitesavailable basta habilitálo criando um link simbólico para o arquivo /etc/apache/sitesavaliable/saap no diretório /etc/apache/sitesenabled. Para isso abra o terminal e digite: $ cd /etc/apache2/sites-enabled Para criar o link do VirtualHost, digite o seguinte no terminal: $ sudo ln -s /etc/apache2/sites-available/saap Após feitas as configurações, reinicie o Apache e estará tudo funcionando. Para isso abra o terminal e digite:
Se a rede não conhece o nome (URL) do SAAP podese fazer de duas maneiras, através do arquivo /etc/hosts ou através do DNS mesmo, que é o ideal.
Para testar se está funcionando, na estação de trabalho local edite o arquivo /etc/hosts e insira no final a linha:
10.3.128.161 www.saap.interlegis.gov.br
Salve, abra o navegador, nessa mesma estação, e tentar acessar o endereço
www.saap.itnerlegis.gov.br.
Se responder com o Sistema, a configuração está ok. Não se deve esquecer de remover esta linha do /etc/hosts após os testes.
Após isso, basta fazer com que o DNS resolva o nome www.saap.interlegis.gov.br apontando para o IP do seu servidor 10.3.128.161. Então o portal estará publicado.
Notas :