Manual Técnico

Sistema “Rede das Redes”

Ver 1.0

Nosso negócio. Sua melhor solução.

Rede das Redes – Manual técnico

Índice

REQUISITOS...................................................................................................... 4

CONFIGURAÇÕES DO APACHE .................................................................. 4

CONFIGURAÇÕES DO PHP ........................................................................... 5

CONFIGURAÇÃO DO ARQUIVO “DBCONFIG.INI” ................................ 6

CONTROLE DE EXIBIÇÃO DE CONTAINERS.......................................... 7

PERMISSÕES DE ESCRITA A DIRETÓRIOS ............................................. 8

PROCEDIMENTO PARA DESMEMBRAR PERFIS DE USUÁRIO ......... 8

SOBRE O FORMATO ARFF ........................................................................... 9

INTERNACIONALIZAÇÃO ............................................................................ 9

Nosso negócio. Sua melhor solução.

Rede das Redes – Manual técnico

Manual Técnico

Sistema “Rede das Redes”

Nosso negócio. Sua melhor solução.

Rede das Redes – Manual técnico

Requisitos

Independente do Sistema Operacional, os três requisitos básicos para a aplicação são:

1. Apache 2.2.8 a. Módulo php5 b. Módulo rewrite

2. PHP 5.2.6 a. Extensão php_mysql ou php_mysqli b. Extensão php_pdo c. Extensão php_pdo_mysql d. Extensão php_zip

3. Mysql 5.x

Observação: Foram listados acima apenas os módulos que, na instalação padrão do apache, não são ativados por padrão.

Configurações do Apache

A aplicação foi desenvolvida sob o framework da Zend, portanto, algumas configurações do Apache se fazem necessárias. São elas (grafadas em negrito):

Arquivo httpd.conf

Sobre a publicação do site:

<Directory /var/www/f-telefonica-pro-nino />

Options Indexes FollowSymLinks MultiViews

AllowOverride all

Order allow,deny

allow from all

</Directory>

<VirtualHost *>

ServerAdmin [email protected]

DocumentRoot /var/www/f-telefonica-pro-nino /

ServerName f-telefonica-pro-nino

ErrorLog /var/log/apache2/f-telefonica-pro-nino_log

CustomLog /var/log/apache2/f-telefonica-pro-nino_log combined

</VirtualHost>

Esta diretriz de configuração é responsável para que o Apache considere os arquivos

.htaccess dentro dos diretórios da aplicação. Entre alguns exemplos de uso, temos a reescrita da URL para nomes amigáveis (detalhados mais adiante), a proteção do acesso direto à qualquer script PHP da aplicação, bem como algumas configurações de segurança envolvendo o próprio PHP.

Nosso negócio. Sua melhor solução.

Rede das Redes – Manual técnico

Sobre a instância do Apache:

LoadModule rewrite_module modules/mod_rewrite.so

Este módulo é o responsável pela reescrita da URL “on the fly” (tempo real). Esse recurso trabalha em conjunto com o framework Zend, a fim de tornar as urls do sistema mais amigáveis.

Por exemplo: http://localhost/rede-das-redes/person/index/person/32547

Seguindo o exemplo acima, tradicionalmente (sem reescrita de URL) seria:

http://localhost/rede-das-redes/person-index.php?person=32547

Vale ressaltar que o exemplo acima é fictício, apenas para título de ilustração. Se a reescrita de url não estiver ativada, a aplicação não funcionará.

Configurações do PHP

Algumas configurações são recomendadas especificamente para o processo inicial de importação. São elas:

Arquivo php.ini

; Maximum execution time of each script, in seconds

max_execution_time = 43200 ; 12 horas

; Maximum amount of time each script may spend parsing request data

max_input_time = 10800 ; 3 horas

Para o parâmetro tempo máximo de execução do script, sugerimos o montante referente à

12 horas. Em nossos testes laboratoriais, a importação de 1 milhão de registros, num servidor Xenon dedicado, tivemos o tempo de 12 horas de processamento.

; Maximum allowed size for uploaded files.

upload_max_filesize = 80M

; Maximum size of POST data that PHP will accept.

post_max_size = 80M

Consideramos também mais produtivo que os arquivos de importação sejam colocados diretamente no sistema de arquivos do servidor para processamento.

Nosso negócio. Sua melhor solução.

Rede das Redes – Manual técnico

Quando não houver essa disponibilidade, o tempo máximo de upload de arquivos deve ser suficiente para atender ao tempo necessário de upload, considerando a velocidade da conexão disponível. O tamanho máximo permitido para upload também deve atender o tamanho de arquivo de importação do seu município.

Após as importações terem sido feitas com sucesso, é recomendável devolver os seguintes valores para o padrão:

upload_max_filesize = 2M

max_input_time = 30

Sendo que o tempo máximo de execução de script (max_execution_time), deve atender ao tempo de geração de relatório. Portanto, pode-se baixar de 12 para 2 horas, considerando o tamanho da base de dados e o hardware do servidor, esse número pode ser aumentado ou diminuído.

Ainda sobre a geração de relatório, recomendamos que esta atividade seja executada a noite, ou em horários/dias em que as atividades das entidades não estejam ocorrendo. Há uma demanda de banco de dados e processamento muito alta, podendo comprometer a usabilidade dos usuários do sistema.

; Maximum am ount of memory a script may consume (128MB)

memory_limit = 256M

Esta última configuração se refere ao uso de memória permitido à execução de scripts. O valor mínimo recomendado é 256 megas, considerando uma base de dados considerável nos processos de importação e geração/exportação de relatórios.

Configuração do arquivo “dbconfig.ini”

Para que haja a comunicação da aplicação com o banco de dados é necessário informar alguma configurações.

Este arquivo é encontrado em:

/rede-das-redes/application/

Ao abrir o arquivo você encontrará os seguintes campos: db.adapter = PDO_MYSQL db.config.host = informar o endereço na rede de seu banco de dados. db.config.username = informar o usuário que conectará no banco de dados. db.config.password = informar a senha do usuário. db.config.dbname = informar o nome da base de dados que será conectado.

Nosso negócio. Sua melhor solução.

Rede das Redes – Manual técnico

Após informar as configurações sobre o banco de dados é necessário apenas salvar o arquivo.

Controle de exibição dos Containers

Ao visualizar o perfil que uma determinada pessoa, o usuário também visualiza os containers, estes possuem um resumo de cada aba do perfil.

Estes containers, para que funcionem de modo mais otimizado, podem ser exibidos de 2 formas. A primeira é estando sempre visível, toda vez que a página for atualizada ele atualizará automaticamente. A segunda forma é deixar este controle de visualização para o usuário, desta forma o usuário optará em ver ou não estas informações, quando o usuário clicar para maximizar o container, ele atualizará e exibirá as informações.

Este controle determina quais containers sempre estarão visíveis e quais o usuário optará visualizar, pode ser feito no arquivo “config.ini” que é encontrado em:

/rede-das-redes/application/

Nosso negócio. Sua melhor solução.

Rede das Redes – Manual técnico

Ao abrir o arquivo você encontrará os seguintes campos: container.identification = 1 container.education = 0 container.health = 0 container.income = 0 container.personlog = 0 container.family = 1 container.residence = 0 container.lastattendance = 0 container.network = 0

Para que o container seja sempre exibido coloque o valor “1” na frente do container desejado.

Para que o container seja exibido apenas quando o usuário solicitar coloque o valor “0” na frente do container desejado.

Uma outra característica dos containers é a possibilidade de optar por dois modos de funcionamento. O primeiro modo é optar que os containers façam apenas uma requisição por page-view, a segunda opção é deixar que cada container haja independentemente gerando uma requisição por container a cada page-view.

Para configura esta opção é necessário indicar o modo preferido no campo: container.random

Para exibir utilizando apenas uma requisição marque o campo desta forma: container.random = 0

Para exibir utilizando várias requisições marque o campo desta forma: container.random = 1

Permissões de escrita a diretórios

Após copiar a estrutura de diretórios da aplicação na pasta destinada, é necessário dar permissão de escrita aos seguintes subdiretórios: logs/ import/

Procedimento para desmembrar perfis de usuário

Passos para o desmembramento de perfis de usuários. O procedimento contempla apenas os vínculos com a tabela de usuários (auth_user), habilitando/desabilitando usuários de um determinando perfil para outro.

Nosso negócio. Sua melhor solução.

Rede das Redes – Manual técnico

1. Ter em mãos o identificador do perfil a ser desmembrado (id_profile); a. SELECT * FROM auth_profile ;

2. Criar/procurar o novo perfil (tabela auth_profile), e ter em mãos o identificador

(id_profile) deste novo perfil; a. INSERT INTO auth_profile (profile, active) VALUES (‘novo profile’, 1);

3. Fazer uma consulta na tabela auth_user_profile, filtrando com o identificador do perfil original (id_profile); a. SELECT * FROM auth_user_profile WHERE idt_profile = ?;

4. A partir dos registros retornados, identificar e anotar quais usuários passarão a pertencer ao novo perfil;

5. Fazer o update dos usuários identificados previamente para o novo perfil. a. UPDATE auth_user_profile SET id_profile = ? WHERE id_user IN (?, ?,

?, ?);

Os perfis atribuídos aos atendimentos prestados não são alterados.

Sobre o formato ARFF

A versão utilizada como base na geração do arquivo de exportação do formato ARFF, foi a 3.4.12 do software Weka*.

* Weka 3: Data Mining Software in Java ( http://www.cs.waikato.ac.nz/ml/weka/ )

Internacionalização

A aplicação oferece suporte total à internacionalização, de maneira ainda a não ser necessária qualquer intervenção na codificação em PHP do sistema.

Na estrutura de diretório da aplicação (no servidor), existem 2 pastas contendo todos os textos exibidos ao usuário (menus, mensagens, rótulos, etc). São elas:

%HOME_APPLICATION%/application/resources

%HOME_APPLICATION%/application/help

No diretório resources, temos as mensagens de rótulos e mensagens de cada tela do sistema separadas uma a uma, sob o seguinte formato:

controller_name_pt_BR.ini

Exemplo de conteúdo:

Nosso negócio. Sua melhor solução.

Rede das Redes – Manual técnico

[controller] activity.text.title = Atividade Cadastrada activity.text.category = Categoria activity.text.activity = Atividade activity.text.newactivity = Nova Atividade activity.text.editactivity = Editar Atividade

No diretório help, temos:

controller_name_pt_BR.xml

Exemplo de conteúdo:

<?xml version="1.0" encoding="iso-8859-1"?>

<help>

<items>

<text1>Cadastramento das atividades da Rede que serão usadas como tabelas auxiliares das Entidades</text1>

<text2>As atividades são divididas em duas partes, as macroatividades e as atividades que devem possuir associação.</text2>

</items>

</help>

Algumas telas poderão ter mais de uma entrada de textos, de acordo com as necessidades.

Para internacionalizar a aplicação, deve-se seguir os seguintes passos:

1. Recriar todos os arquivos existentes nos dois diretórios informados (resources e

help), trocando o sufixo _pt_BR para o correspondente ao novo idioma (por exemplo, _eng_US);

2. Alterar o arquivo index.php (diretório raiz da aplicação), a seguinte linha: define ( 'LOCALE' , 'pt_BR' ); // sufixo para resources, help e systemMessages

Trocando o pt_BR para o correspondente ao novo idioma inserido.

Todos os arquivos, sem exceção, devem ser traduzidos e criados com o novo sufixo. A falta de um deles acarretará falhas na execução da(s) funcionalidade(s) envolvidas.