Manual de Utilização

Dicas e instruções de uso para a realização de buscas e gestão do cadastro das fontes.

Administração das Fontes de Busca

Os administradores encontram no painel administrativo diversos recursos para o gerenciamento das fontes de busca, tais como: criar e configurar novas fontes, definir e atribuir parser de resultados e administrar grupos de fontes para melhor organizá-las na interface de busca.

É muito importante que estas instruções sejam lidas antes do cadastramento inicial das fontes, evitando assim a inserção de dados incorretos, o que pode acarretar no mal funcionamento do sistema. Se após a leitura deste manual ainda houver alguma dúvida, pode se entrar em contato com o grupo de desenvolvedores por meio do email metabus@….

As seções seguintes detalham os principais recursos mostrando as telas administrativas do sistema com ajuda sensitiva ao contexto.

Página Inicial

O portal administrativo requer autenticação para garantir que somente os usuários autorizados tenham acesso ao gerenciamento do sistema. Após a autenticação, o usuário tem acesso aos principais recursos para a administração do sistema. A figura abaixo mostra a página principal da administração do Metabus.

Nessa página é possível selecionar quais os dados que se deseja gerenciar. Ao selecionar um dos itens dessa lista são exibidos todos os cadastros referentes ao item selecionado.

Como foi dito, para assegurar que apenas usuários autorizados alterem as configurações do metabuscador, os administradores devem cadastrar as pessoas responsáveis por adicionar e/ou editar as fontes, grupos e parsers de busca. Para isto, o sistema provê um cadastro de usuários e grupos que podem se autenticar no sistema.

Para adicionar um novo usuário é necessário preencher um formulário informando os dados básicos como: username, email e password. É possível também alterar as permissões de cada usuário no painel administrativo (restringindo edição a uma determinada tabela, por exemplo) assim como criar grupos de usuários e definir permissões específicas para este grupo.

Os recursos disponibilizados para manutenção das fontes de busca do sistema serão descritos em maiores detalhes na próxima seção.

Cadastramento de Fontes de Busca

Para a utilização do Metabus é necessário efetuar o cadastramento de duas ou mais fontes. Isto porque um metabuscador é interessante quando pretende-se realizar uma busca em sistemas distintos.

Ao clicar em Fontes na tela inicial é possível visualizar e editar as fontes salvas anteriormente. Para editar uma fonte basta clicar em um registro listado, para inserir um novo registro clique no botão adicionar no canto superior direito da tela como mostra a Figura abaixo.

Para cadastrar uma nova fonte é necessário preencher o formulário com as informações básicas das fontes. Para cada campo é apresentado um texto de ajuda como mostra a Figura abaixo.

Segue detalhes para o preenchimento dos campos desse formulário:

Nome: Este será o nome exibido na tela de busca e em todas as listagens de fontes do sistema.

URL de pesquisa: As fontes de busca cadastradas têm uma URL de pesquisa que é efetuada para realizar as busca. Por exemplo, o google utiliza a seguinte url:

A Câmara Municipal de Votorantim utiliza:

Para realizar o cadastro dessas fontes no Metabus deve ser utilizado como valor desse campo respectivamente:

Expiração do Cache: Tempo em segundos que os resultados ficam armazenados no cache do sistema (valor padrão: um dia).

Retorna RSS: RSS é um formato específico de documento XML. Algumas fontes retornam os resultados da busca nesse formato que é o esperado pelo Metabus.

Parser: Caso a fonte não retorne os resultados da busca em RSS, é necessário associar um parser á esta esta fonte para que o resultado seja transformado no formato RSS (ver mais informações nas próximas seções).

Grupos: Este campo é utilizado para agrupar fontes na interface de busca que o usuário final utilizará. Deve-se selecionar todos os grupos em que a fonte deverá aparecer (ver mais informações nas próximas seções).

Grupos e Parsers são elementos do sistema que também devem ser cadastrados. O Admistrador poderá cadastrar novos Grupos e Parsers no momento da edição de fontes, clicando no simbolo + do lado direito desses campos ou através da página principal do sistema de administração.

Cadastramento de Grupos

Com o objetivo de facilitar a escolha das fontes a serem pesquisadas em uma consulta pode-se incluir as fontes cadastradas em grupos.

Para adicionar um novo grupo pode-se clicar em "+" no formulário de cadastro/edição de fontes ou adicionar a partir da tela inicial. A Figura abaixo apresenta o formulário de criação de grupos a partir do formulário de fontes.

Segue detalhes para o preenchimento dos campos desse formulário:

Nome: Este será o nome exibido na tela de busca e em todas as listagens de grupos do sistema.

Parent: Este campo é opcional, pois um grupo pode (ou não) conter sub-grupos para melhor organizar as fontes.

Cadastramento de Parsers

O metabus processa automaticamente resultados em RSS. À todas as fontes, cuja saída não utiliza essa formatação, deve estar associada um parser, que tem por objetivo transformar um documento HTML em RSS, para que o servidor possa interpretar os resultados.

O formulário apresentado abaixo mostra como adicionar um parser a uma fonte de busca caso tenha-se clicado em "+" no formulário de cadastro/edição de fontes (um parser também pode ser adicionado/editado na tela inicial).

Segue detalhes para o preenchimento dos campos desse formulário:

Nome: Este será o nome exibido na tela de busca e em todas as listagens de grupos do sistema.

Descrição: Este campo é opcional, entretanto é essencial prover a documentação necessária para modificar este código, caso o padrão de resposta da fonte de pesquisa seja modificado.

Tipo: Tipo do arquivo que será carregado (atualmente apenas XSLT)

Arquivo: Documento XSLT que descreve as transformações necessárias para se obter um documento RSS a partir do documento retornado pela pesquisa.

Realização de Buscas

Todos os usuários têm permissão para realizar buscas nas fontes e grupos cadastrados no Metabus sem ser necessária a identificação através de login. Apenas para a interface de administração é necessário o login. Dessa forma, para realizar uma busca basta acessar a URL do metabus e digitar as palavras-chaves pelas quais se deseja buscar.

A interface de realização de buscas é semelhante aos buscadores web existentes e contém elementos simples e claros para a realização das buscas. Para preencher o formulário de busca basta digitar a palavra (com mais de dois caracteres) ou frase no campo de texto e selecionar ao menos uma fonte ou grupo disponível. Para realizar a consulta é necessário pressionar enter ou clicar no botão pesquisar ao lado da caixa de texto como pode ser visto em http://busca.interlegis.leg.br

Última modificação 5 anos atrás Última modificação em 22/03/2013 17:57:42

Anexos (5)

Download de todos os anexos como .zip

 

The contents and data of this website are published under license:
Creative Commons 4.0 Brasil - Atribuir Fonte - Compartilhar Igual.