Punto de Consulta


El Punto de Consulta OpenProdoc (en ocasiones denominado en esta documentación con el término tradicional OPAC por analogía), permite a personas externas al sistema consultar de forma sencilla los documentos (o carpetas) del mismo sin necesidad de disponer de usuario o autenticarse. Básicamente el Punto de Consulta permitirá elegir el tipo de documento (o carpeta) a buscar, introducir los criterios de consulta y elegir el formato de presentacion de los resultados.

Esto requiere parametrización para simplificar el uso y también para añadir seguridad, ya que estamos permitiendo el acceso a personas a las que no hemos dado una identificación y que podrían acceder a documentación confidencial o causar daños por error o intencionadamente. La parametrización se hace por medio de un fichero de propiedades con los elementos que se detallan a continuación. Al final se incluye un ejemplo (las líneas que empiezan por # se toman como comentarios y se ignoran, al igual que las líneas en blanco) :

Con la función "OPAC" puede crearse formularios como:

OPAC Example

OPAC Example2

OPAC Example3

Diseño Athena creado por Lucycons3 y Nosturi

OPAC Example4

Este fichero sigue el estandar habitual de los ficheros de propiedades (etiqueta+"="+Valor), admitiendo comentarios (líneas que empiezan con el caracter '#'). El significado de cada etiqueta (que no puede repetirse) es el siguiente:

El proceso de parametrizar un punto de consulta consiste en crear un archivo de texto con el contenido citado (puede utilizarse como base el ejemplo incluido y modificarlo), introduciendo los valores adecuados a la instalación de OpenProdoc concreta.

Previamente debe modificarse el fichero de configuración de OpenProdoc (Prodoc.properties o el nombre utilizado) y añadirse 2 líneas:

User=Usuario1

Pass=ClaveUsuario1

Donde Usuario1 y ClaveUsuario1 serán datos de un usuario que tenga acceso a los distintos documentos que configuración (OPAC y OPAC_CS) que se describen a continuación. Se recomienda que sea un usuario con un rol (perfil) limitado y con un mínimo de permisos, ya que solo debe poder acceder en modo lectura a los ficheros de configuración de las consultas. Como todo cambio en el fichero de configuración (Prodoc.properties), debe reiniciarse el servidor para que se lea de nuevo.

A continuación debe crearse (o modificarse el ejemplo incluido) el CSS para adaptarlo al estilo de la institución o empresa correspondiente. Luego deberá añadirse el CSS al repositorio OpenProdoc y anotar el PdId generado. Ese PdId es el que deberá referenciarse como parámetro FormSearchCSS del fichero de configuración del punto de consulta. A continuacion se subirá ese fichero de configuración de consulta.

Con el Id generado deberá invocarse la url de OpenProdoc (Ej.: http://localhost:8080/ProdocWeb2/OPAC?Id= + el identificador del nuevo documento subido, por ejemplo http://localhost:8080/ProdocWeb2/OPAC?Id=566b6464a654-9696e68d686 ).

Si la búsqueda se refiere a carpetas deberá invocarse la url de OpenProdoc (Ej.: http://localhost:8080/ProdocWeb2/OPACf?Id= + el identificador del nuevo documento subido, por ejemplo http://localhost:8080/ProdocWeb2/OPACf?Id=56aa4a633-111e68d644 )

OpenProdoc presentará una página de acuerdo a los parámetros definidos en ese fichero, incluido hoja de estilo, literales, tipos documentales, etc. En ella, los usuarios, sin introducir datos de acceso (usuario/password), podrán elegir uno de los tipos documentales por los que quieren buscar, introducir palabras del contenido o metadatos conocidos, elegir el formato de los resultados y buscar. Al pulsar el botón de búsqueda, Openprodoc se conectará con el usuario indicado en la parametrización, buscará de acuerdo a los criterios incluidos y devolverá lo sresultados en el formato elegido. El formato puede ser html para presentar con un formato más estético, txt o csv para un tratamiento automático, o xml para poder intercambiar o procesar.

Dado que toda la apariecia es parametrizable, incluidas tipologías documentales, metadatos, etc, y que está orientado a usuarios esporádicos, es razonable asumir que sea necesaria una ayuda peronalizada. Para eso se dispone de un botón que abrirá la página html cuya url se indique en a configuración. Podría ser una página externa o un documento html almacenado en OpenProdoc.

Hay que resaltar que el fichero de configuración, como cualquier documento de Openprodoc puede ser editado y versionado, utilizándose siempre para componer el punto de consulta la última versión publicada. No obstante la actualización puede llevar cierto tiempo, ya que para mejorar el rendimiento la configuración no se actualiza inmediatamente.

Dado que la parametrización se basa en un documento de Openprodoc y el estilo en otro, es posible tener diversas parametrizaciones simultaneamente, que presenten diferentes conjunts de documentos, distinto idioma del interfaz, distinto estilo o diferente usuario de consulta. Suministrando a cada colectivo de usuarios la url adecuada (que solo se diferenciará en el Identificador de documento, puede ofrecerse simultaneamente muchos puntos de consulta distintos con muy poco esfuerzo.

Si la plantilla html de OPAC incluida en OpenProdoc se desea modificar más aún de lo que permite los CSS, o adaptar la página a cada navegador, es posible referenciar diferentes plantillas. Para ello debe incluirse unas entradas opcionales en el fichero:

Si el User-Agent del navegador no contiene ninguna de las entradas indicadas, entonces se utilizará la plantilla interna incluida en OpenProdoc.

Ejemplo de Archivo de configuración de punto de consulta:

#############################################
####                                OPAC                               ####
#############################################
# Nombres de los Tipos de documentos por lo que podrá buscar un usuario
DocTipesList=Article|ECM_Standards|InternetProfile|MusicRecords|Picture
# Nombres (Internos) de los Metadatos/Campos (de cualquiera de los tipos de documentos) por lo que podrá buscar un usuario
FieldsToInclude=Author|Authors|Keywords|Player|Title|Country|CreativeCommons
# Operators de búsqueda/comparacion. 1 for cada metadato. Por defecto es igualdad EQ
# Posibles valores = EQ, <> NE, > GT, >= GE, < LT, <= LE, Contains CT
FieldsComp=EQ|EQ|EQ|EQ|CT|EQ|EQ
# Carpeta por debajo de la cual se realizarán las búsquedas
BaseFolder=/Examples - Ejemplos
#Búsqueda ampliada a los subtipos
Inheritance=1
# Códigos identificadores (PDId) de los documentos de tipo PD_REPORTS que se utilizaran para presentar los resultados. Debe inckuirse al menos 1.
ResultForm=150c9be080c-3fe46f69eb1b2cb7|150c9be8462-3fd76612bb72fece|15dc854acbf-3fedc1977572a008
# Máximo numero de resultados que se devolverá. (0=sin límite)
MaxResults=0
# Código identificador (PDId) de la hoja de estilo (CSS) que se utilizará para el punto de consulta
FormSearchCSS=15db73b6628-3fee99cd40e27fee
# Url (interno o externo) de la imagen utilizada como logo
FormSearchLogo=img/LogoProdoc.jpg
# Usuario con el que se realizará la consulta
User=Invitado
# Clave de acceso del Usuario con el que se realizaá la consulta
Pass=PassInvit
# Cabecera del formulario de consulta
Title=Punto de Consulta Simplificada
# Etiqueta de la lista desplegable de tipos documentales a buscar
DTLabel=Seleccionar tipo de documento a buscar
# Etiqueta del campo de búsqueda por texto completo de los documentos.
FTLabel=Introducir algunas palabras de búsqueda
# Etiqueta de la lista desplegable de formatos de salida.
FormatLabel=Seleccionar formato de salida de los resultados
# Texto de la ayuda emergente al situarse en el combo de selección de tipos de documento
HelpForDocType=Ayuda Tipos Documentales
# Texto de la ayuda emergente al situarse en el campo de búsqueda por texto completo de los documentos.
HelpForFullText=Ayuda Búsqueda Texto Completo<br>Introduzca cualquier palabra(s) del contenido de documento para recuperar por criterios aproximados. Si se desea que el docuemnto contenga la palabra, debe incluirse un signo +. Si desea buscar literalmente debe incluirse la palabra entre comillas. Para buscar documentos que NO contengan una palabra debe incluirse un signo menos -<br>Puede combinarse con la búsqueda por metadatos de los documentos.
# Texto de la ayuda emergente al situarse en el combo de selección de formatos de salida
HelpForFormatType=Ayuda Formatos Salida
# Url de la página de ayuda
UrlHelp=help/EN/HelpIndex.html
#OPCIONALMENTE, en lugar de usar la plantilla html de OPAC incluida en OpenProdoc puede definirse plantillas adicionales #Número de Htmls alternativos
NumHtmlOpac=2
#2 entradas para cada número de Htmls, empezando en 0
#------- 0 --
ListAgent0=Edge|Explorer
HtmlAgent0=1632c1c280b-3fa2b6496a3c3250
#------- 1 --
ListAgent1=Firefox
HtmlAgent1=1632c1dd6a2-3fe55f2e09ab3605

Índice Ayuda OpenProdoc