Instalação do ABCD
Versões de instalação disponíveis.
Tabela de conteúdo
- ABCD versão 1.0 vem em três versões principais:
- Questões de instalação
- Estrutura de diretórios e direitos de acesso
- empweb
- iAH
- isisws
- secs-web
- site
- EmpWeb (somente se a instalação dele foi acrescentada!)
- Temp
ABCD versão 1.0 vem em três versões principais:
1 Pacote de instalação não assistida para Windows:
Este é um arquivo ZIP contendo todos os arquivos necessários, que simplesmente precisa ser descompactado para a raiz do (um de seus) disco(s) rígido(s), por exemplo, C:. Visto que engloba tanto o Apache como o PHP, depois de ter simplesmente descompactado, deve funcionar normalmente! Aqui Apache vem com seu próprio arquivo de configuração (httpd.conf), onde a porta 9090 está ativada para permitir que rode junto com outras possíveis instalações Apache em execução. Apenas para alguns usos específicos, como, por exemplo, o uso do Z39.50 que necessita de módulos PHP adicionais (YAZ), será necessário fazer algumas edições (por exemplo, php.ini). Instalações do ABCD que irão utilizar o módulo Avançado Empréstimo (EmpWeb) precisam descompactar adicionalmente o mais recente pacote zip EmpWeb, onde uma subpasta principal extra será criada em \ABCD e alguns arquivos adicionais serão acrescentados ao diretório Central do ABCD.
2 Instalação assistida para o Windows:
Este é um executável de auto-instalação, que irá verificar primeiro se o Apache e PHP já estão instalados no sistema. Se assim for, estas instalações serão ignoradas, se não elas serão adicionados à instalação ABCD básica. Isto requer, principalmente, seguir os diálogos e as instruções do próprio instalador. No final, o resultado será uma pasta de diretório semelhante ao pacote em 1.
3 Pacote de instalação não assistida para Linux:
Este é um arquivo .tar.gz. para sistemas Linux, que deve ser descompactado paro o “file-system” do Linux, dependendo de sua organização (definição como onde tais aplicações podem ser colocadas). Se os corretos direitos de acesso são concedidos (com os comandos apropriados do Linux como chown e chmod) ABCD pode ser instalado, como no Windows, sob o file-system root ‘/’. Em sistemas Linux, pressupõe-se que o Apache e o PHP sejam instalados separadamente (por exemplo, com a ferramenta dedicada como o apt-get ou Synaptic), assim o pacote contém apenas os arquivos ABCD próprios do diretório “www’”.
Questões de instalação
Esta seção trata das questões de instalação do ABCD. Visto que o ABCD tem vários componentes totalmente diferentes, a instalação, por definição, envolve algumas armadilhas potenciais. Três motivos principais podem ser dados para que a instalação seja complexa:
- ABCD é uma combinação de várias tecnologias de software: bases de dados ISIS, ISIS-scripts e formatos ISIS, um servidor web, PHP-scripting, mais (no caso do módulo avançado de empréstimos), algumas partes em JAVA e MySQL;
- sendo baseado na web, o que significa um servidor web tem de ser instalado e medidas especiais devem ser tomadas sobre os direitos de acesso: em princípio, todo o mundo - com acesso ao WWW - pode interferir;
- ABCD será instalado em situações muito diferentes, variando desde um PC simples “stand-alone” (mesmo sem rede) até servidores nas grandes redes com um servidor web e muitas vezes também com serviços PHP-scripting já pré-instalados. Atualmente, a instalação é fornecida em dois tipos:
1 Um pacote completo, contendo todos os arquivos do próprio ABCD mais o servidor Apache e motor PHP-scripting.
Nesta situação um arquivo (.Zip) deve ser descompactado em uma pasta-raiz do sistema de arquivos (que pode ser qualquer sistema operacional no qual o Apache/PHP e ISIS podem ser executados). Após a descompactação, haverá uma pasta específica para o Apache, uma outra para o PHP, uma pasta cgi (para conter os executáveis para acesso web) e uma pasta ‘documentos’ (no Apache chamado ‘htdocs’), que funciona como a página inicial (homepage) da aplicação ABCD. O Apache vem com uma configuração pré-definida (arquivo httpd.conf na subpasta conf da pasta do Apache), que define os seguintes parâmetros específicos:
Parâmetros do Apache | Descrição |
---|---|
ServerRoot”/ABCD/apache” | Diretório a partir do qual o Apache é executado |
Listen 9090 | A porta usada pelo ABCD, sendo a porta http por default 80, mas para evitar interferência com outras aplicações http existentes, se assim o desejar, uma porta diferente pode ser usada, por exemplo, 9090. No caso de utilizar um número de porta diferente, algumas adaptações terão que ser feitas no script ABCD_start.bat e, em algumas URLs do OPAC. |
PHPIniDir “/ABCD/php” | A pasta a partir da qual PHP é executado |
DocumentRoot “/ABCD/www/htdocs” | A pasta-raiz de todos os arquivos que fazem parte da própria aplicação, ou seja a ‘homepage’ |
ScriptAlias /cgi-bin/ “/ABCD/www/cgi-bin/” | A pasta na qual o Apache irá permitir a execução dos executáveis a partir de instruções nas páginas web |
PHP vem com uma configuração predefinida em php.ini. Configurações PHP e php.ini Visto que ABCD usa PHP com alguns módulos PHP adicionais (Yaz, Processador XSLT…) “Pears” devem ser instalados dentro da instalação PHP e alguns módulos extras precisam ser copiados para a pasta de ‘extensões’ PHP: php_yaz.dll, yaz.dll, yaz3.dll (estes dois servem às funções Z39.50 de catalogação ABCD), iconv.dll, libxm2l.dll, libxslt.dll (para o processador XSLT). A pasta de extensões PHP precisa estar presente no caminho (path) da variável de ambiente do sistema (no Windows, por exemplo: clique em ‘Meu Computador’ (botão direito do mouse) | Propriedades | Avançado | Variáveis de Ambiente | Variáveis do Sistema e modificar a variável Path, acrescentando, se não existir : ‘;C:\ABCD\php\ext’). Verifique também se seu php.ini (em \ABCD\php) tem as extensões mencionadas aqui que estejam comentadas (ou seja, remover o ‘;’ precedente para ativar a extensão).
- extension=iconv.dll
- extension=libxml2.dll
- extension=libxslt.dll
- extension=yaz3.dll
- extension=php_yaz.dll
Seja cuidadoso com os outros eventuais arquivos php.ini existentes, por exemplo, em \Windows ou \PHP, uma vez que estes podem perturbar o seu ABCD-PHP. Uma opção de teste do PHP com ABCD está disponível na URL: http://localthos:9090/info.php. Estamos especialmente interessados na seção seguinte, onde XSL e Yaz devem estar no estado de executando. Se não, verificar sua variável ambiente Path e todos os caminhos mais uma vez, assim como as ‘extensões’ do seu php.ini!
O arquivo php.ini contém mais algumas configurações que devem ser verificadas para que o ABCD rode corretamente:
- register_globals = On (default = Off);
- extension_dir = “/ABCD/php/ext” (ou ajustar o caminho real de sua instalação ABCD);
- default_charset = “iso-8859-1” (default = inativo);
- extension_dir = “/ABCD/php/ext” => define o diretório de extensões;
- extension=yaz3.dll e extension=php_yaz.dll listados no => são adicionados na secção “Dynamic Extensions”, a fim de permitir que o módulo Yaz-Z39.50 funcione.
2 Um pacote de somente ABCD, que requer que o Apache (ou outro servidor web) e PHP já estejam instalados.
Neste caso, supõe-se que pelo menos algum “expert” esteja disponível que entenda a instalação do servidor web e a configuração do PHP existentes. Usando ‘aliases’ para a instalação do ABCD e da pasta cgi, que podem ser colocados em um arquivo de configuração “virtual host”, o ABCD pode ser instalado em qualquer lugar dentro ou fora da pasta Home do servidor web. Portanto, apenas as pastas cgi e htdocs são incluídas neste pacote. Gerentes de Sistema devem recorrer aos manuais do Apache e PHP, no caso de não terem certeza sobre como proceder com este tipo de instalação. Alternativamente pode-se também usar um pacote de instalação como EasyPHP ou WAMP (para Windows) / XAMP (para UNIX/Linux). Novamente, neste caso, o Apache e o PHP (e MySQL) serão automaticamente instalados e as pastas cgi-bin e htdocs do ABCD precisam ser movidos para a estrutura de pastas existentes (do Apache) e php.ini precisa ser editado. Uma ferramenta dedicada à instalação, como parte do software ABCD, será criada, mas na essência continuará fazendo o mesmo conforme descrito acima, apenas a coleta de alguns parâmetros para a instalação (como qual disco que será utilizado, qual porta, etc.).
Estrutura de diretórios e direitos de acesso
Durante a instalação do ABCD a seguinte estrutura de pastas será criada:
Como pode ser observado, três sub-pastas foram criadas na pasta principal \ABCD. No caso da instalação do módulo opcional de Empréstimos Avançados, mais uma pasta contendo a tecnológica base do ABCD será acrescentada: o “Java Development Kit” (JDK). As pastas padrão são respectivamente:
Apache
A pasta Apache contém o software do servidor web Apache, que é na realidade apenas um de vários softwares importantes desenvolvidos pela “Apache Software Foundation”. Por default, o servidor Apache é instalado em outra pasta-base (por exemplo, no Windows: C:\Arquivos de Programas\Apache Software Foundation\Apache2.2) e o suporte de rede, provavelmente, terá instalado o Apache no servidor de acordo com as suas próprias preferências, mas, quando instalado a partir do “pacote ABCD completo” o Apache será executado - com seu arquivo de configurações httpd.conf adaptado para esta situação - a partir de \ABCD\Apache.
PHP
A pasta PHP contém os scripts do software PHP. Novamente, como no Apache, em muitos casos, este software será instalado no seu próprio diretório, por exemplo, em C:\PHP, ou muitas vezes também como parte de um pacote em conjunto com Apache, MYSQL e PHP, por exemplo, com EasyPHP ou servidor WAMP. Quando instalado como parte do ABCD, porém, PHP será executado daqui com as necessárias adaptações feitas no php.ini, arquivo principal de configuração do PHP.
WWW
A pasta WWW contém todo o sistema ABCD, que é subdividida em 4 pastas :
Bases
A pasta bases contém as bases de dados de sua instalação ABCD, que tem uma subpasta dedicada (com muitas subpastas por sua vez) para cada base de dados. Quando uma base de dados adicional é copiada ou criada usando ABCD, o sistema irá criar uma subpasta dedicada extra aqui. Uma lista típica de pastas de bases de dados na pasta /bases tem o seguinte aspecto:
Como pode ser observado, existem muitas bases de dados (mas não tantas quantas tabelas existem em uma configuração relacional, visto que ISIS não pratica a ‘normalização’ em tabelas relacionais), algumas delas - por exemplo, Marc, biblo, dblil - são modelos que vem com a instalação do ABCD, outras - neste caso, por exemplo, gemim - são criadas pelo ABCD nesta instalação, enquanto outras, finalmente, servem para módulos específicos do sistema de bibliotecas, por exemplo, ‘providers’ e ‘purchaseorder’. Recomendamos que ‘reserva’, ‘suggestions’, ‘suspml’ sejam utilizadas para o módulo de aquisição, ‘ trans’ e ‘users’ serão utilizadas para o Módulo de Empréstimos. Uma base de dados especial é a “access”, que mantém os usuários (com os seus dados de login) e os seus direitos de acesso (nível de autorização) para as bases de dados. Um arquivo .par, na verdade, é um pequeno arquivo de texto (assim, o mesmo pode ser editado por qualquer editor TXT como Notepad), cada linha com o caminho completo referente às partes da base de dados em questão. Por exemplo, um arquivo .par típico do ABCD é parecido com este:
marc.*=%path_database%marc/data/marc.*
prologoact.pft=%path_database%www/prologoact.pft
prologo.pft=%path_database%www/prologo.pft
epilogoact.pft=%path_database%www/epilogoact.pft
epilogo.pft=%path_database%www/epilogo.pft
autoridades.pft=%path_database%marc/pfts/en/autoridades.pft
Cada elemento recebe, após o sinal de igual, o seu caminho no sistema de arquivos. Como pode ser observado, variáveis tomadas a partir do Ambiente do Sistema Operacional podem ser utilizadas, neste caso %path_database%, que é substituído pelo verdadeiro caminho, tal como definido na configuração principal do arquivo config.php (ver abaixo). Embora normalmente todos os elementos referidos aqui pertençam à base de dados em questão, os elementos de outras bases de dados também devem ser acrescentados, se forem utilizados em declarações ‘REF’ dos formatos utilizados nesta base de dados, visto que ISIS precisará saber onde localizar tais elementos de dados externos, se chamados a partir de um formato - e vai procurar o seu caminho aqui!
cgi-bin
A pasta cgi-bin contém os arquivos executáveis que o ABCD irá chamar a partir de sua página Web e que, portanto, deve ter autorização de execução pelo servidor web (Apache), utilizando protocolo CGI. No caso do ABCD, o executável principal é o servidor ISIS wxis.exe, que realiza a principal parte do trabalho. Porém algumas outras ferramentas CISIS, para tarefas específicas, também estão incluídas. As subpastas do módulo Wxis aqui contém scripts (com extensão .Xis ) para o servidor Wxis, enquanto a pasta “gizmo” contém algumas bases de dados ISIS pequenas que definem cadeias de caracteres (“strigns”) para serem substituídas por uma outra, por exemplo, para as mudanças devido a diferentes ambientes utilizados (DOS/ASCII, Windows/ANSI, WWW/XML).
htdocs
A pasta htdocs (usamos o nome da pasta tradicional do Apache ‘hypertext documents’) é a pasta “Home” do Web site servido pelo servidor Apache do ABCD. Por este motivo, então, contém todos os elementos do software especificamente produzidos para o ABCD (exceto a tecnologia básica externa como o Apache e o PHP):
Dois scripts iniciais estão presentes dentro desta pasta “homepage”: index.php (que é na verdade a “homepage” default, permitindo que a URL do ABCD se refira apenas à parte do servidor) e o script “info.php” é o script PHP clássico de teste que invoca outro script (phpinfo) dando todas as informações sobre a execução da instalação PHP. Visto que o ABCD é uma “suíte” de diferentes funções, cada um tem sua própria página inicial (Homepage), ou seja, o arquivo ‘index.html’ localizado na subpasta apropriada.
As principais pastas do sistema ABCD são resumidamente descritas abaixo:
bases Aqui, para cada base de dados (em uma subpasta dedicada), podem ser armazenados arquivos externos com links a partir de registros na base de dados, por exemplo, PDF’s de texto completo ou imagens. As fotos de usuários podem ser armazenados aqui em uma subpasta ‘users’, assim a foto do usuário será exibida sempre que um usuário do sistema de empréstimos é apresentado.
central Esta é, na verdade, como sugere o nome, a parte “central” do sistema, onde a maioria das atividades de administração de bases de dados e muitas atividades centrais do software estão incluídas. Vamos, portanto, lidar com subpastas importantes contidas aqui:
Alguns scripts iniciais estão localizados neste nível: homepage.php e inicio.php são páginas que dão a partida, que lêem para a memória os principais parâmetros definidos na configuração config.php (ou config.loans.php para o módulo de empréstimos). Os parâmetros definidos neste arquivo ‘config.php’ crucial são:
- $db_path : o caminho para a pasta onde as bases de dados são armazenados
- $Wxis_path : o caminho para o executável, ou seja, o servidor ISIS
- $wxis_URL : a URL para o servidor ISIS, que pode ser deixado vazio, a fim de não utilizar as chamadas CGI, mas sim as chamadas de executáveis diretamente a partir do PHP.
- $xWxis : caminho para os scripts wxis
- $lang : idioma padrão (default)
- $lang_db : idioma padrão para o módulo de administração de bases de dados
- $institution_name : o nome da instituição responsável
- $institution_URL : a URL da instituição responsável
- $FCKEditorPath : o caminho para o editor HTML embutido em ABCD
- $FCKConfigurationsPath : o caminho para a configuração do editor HTML
- $app_path : o caminho para a pasta base de onde todos os módulos centrais são executado (por exemplo /ABCD/www/htdocs/central/) As seguintes pastas lidam com uma função específica ou módulo do ABCD, armazenando os scripts PHP com uma série de elementos adicionais (imagens e folhas de estilo para as páginas web etc.): aquisições, entrada de dados, administração de bases, empréstimos, estatísticas e administração de usuários. Os nomes das pastas, nestes casos, são suficientemente auto-explicativos. Aqui gostaríamos somente de salientar a presença de um módulo “Administração de dados”, que permite a criação de qualquer estrutura ISIS para lidar com qualquer tipo de dados textuais, permitindo ao ABCD ser mais flexível do que a maioria dos outros sistemas e ser mais do que apenas um sistema de bibliotecas. Pastas especiais dedicadas a funções especiais no ABCD são as seguintes :
- common : aqui há alguns scripts php cruciais que são necessários em todos os módulos, por exemplo, ‘header’ e ‘footer’ mas também ‘wxis-llamar.php’ (que permite usar tanto o método cgi de chamada de executáveis (mais seguro) ou chamadas de executáveis direto de PHP (mais rápido). O script ‘instituational_info.php’ define o nome da instituição responsável pela instalação do ABCD, que será chamado em muitas páginas.
- documentacion : obviamente, esta pasta contém scripts para lidar com a ajuda online para as funções do ABCD.
- images : contém pequenas imagens utilizadas em muitas páginas (na sua maioria .png e .gif)
- css : contém as “Cascading Style Sheets” (folhas de estilo) utilizadas nesta parte central do ABCD
- styles : contém a stylesheet (folha de estilo) principal chamada ‘basic.css’
- lang : contém um script para cada módulo para facilitar a comutação de idioma ou reverter para o idioma default (padrão)
- test : contém alguns scripts que testam a instalação do ABCD e acesso ao executável cgi.
empweb
Esta pasta não é padrão e contém as subpastas e partes de software utilizadas pelo módulo de Empréstimos Avançados do ABCD, que não será detalhado neste manual.
iAH
iAH é o nome original da interface Web avançada de “Informações em Saúde” da BIREME que atua como o OPAC do ABCD, mas também como um motor de meta-pesquisa em outras fontes definidas-como-relavantes.
isisws
Esta pasta contém scripts para funções relacionadas ao SOAP do ABCD.
secs-web
Este módulo permite ao ABCD oferecer ferramentas avançadas de gestão de periódicos em ambiente web: Serials Control System.
site
Por último, o módulo ‘site’ combina pesquisa avançada do OPAC (com possibilidades de meta-busca) com um “portal” de serviços, oferecendo a opção de pesquisa dentro de um ambiente de rede com outras fontes de informação e comunicação com usuários. A estrutura e o conteúdo deste portal pode ser editado on-line com um Sistema de Gerenciamento de Conteúdo (Content Management System) interno do ABCD.
EmpWeb (somente se a instalação dele foi acrescentada!)
Esta pasta contém a maioria mas não todos os arquivos necessários para executar EmpWeb, por exemplo, o servidor Java Jetty e os scripts. EmpWeb, porém, também necessita scripts adicionais que são acrescentados ao ABCD Central (isto permite que Empréstimo Avançado seja compatível com o sistema integrado de empréstimos do ABCD) e - uma vez que utiliza uma base de dados SQL para armazenar as operações - uma instalação de um dos SQL comuns de bases de dados (MySQL, Postgres, Oracle …), precisa ser feito em separado - use as instruções de instalação de acordo com a solução SQL escolhida.
Temp
Esta pasta contém arquivos temporários geridos internamente. Não há ações relacionadas com gestão ou usuário a serem tomadas com relação a esta pasta.