MANUAL TÉCNICO PLATAFORMA IE MODULO SERVIDOR

Transcripción

1 MANUAL TÉCNICO PLATAFORMA IE MODULO SERVIDOR PROYECTO: MODULO SERVIDOR PLATAFORMA IE AUTOR: ATTEST VERSION : 1.0 WEB : sw-libre@attest.es

2 INDICE 1. INTRODUCCIÓN DESCRIPCION MODULO GESTION DE CONECTORES MÓDULO DE AUTENTICACIÓN MÓDULO DE CONFIGURACIÓN DE FUENTES MÓDULO DE MONITORIZACIÓN DE SERVIDOR MÓDULO DE METABUSQUEDA MÓDULO DE COMUNICACIÓN ACTUALIZACIÓN FUENTES LANZAMIENTO DE BÚSQUEDAS ESPECIFICACIONES TECNICAS PROTOCOLO DE COMUNICACIÓN OTRAS CONSIDERACIONES OPTIMIZACIÓN DEL SERVIDOR MODELO ENTIDAD RELACIÓN PLATAFORMA DE EJECUCION ARQUITECTURA DE DESARROLLO ESTRUCTURA GENERAL DE DIRECTORIOS FLUJO DE LA APLICACIÓN Página 2 de 14

3 1. Intrducción En este dcument se presenta la manual técnic que describe el desarrll del módul servidr de la Platafrma de Inteligencia Estratégica. El módul servidr se divide a su vez en varis móduls de acuerd a su funcinalidad, a cntinuación se describe cada un de dichs móduls. Página 3 de 14

4 2. DESCRIPCION MODULO GESTION DE CONECTORES 2.1. MÓDULO DE AUTENTICACIÓN Este módul se encarga de cntrlar el acces a la administración del servidr. El acces se permite en función de un usuari y cntraseña, y una vez validads dichs dats, se trga el acces durante tda la sesión de navegación. Este módul pr tant, cnsta de una página inicial de lgin, dnde se slicita al administradr un usuari y cntraseña. Si ls dats intrducids sn incrrects, n se le permite la entrada al usuari, vlviend tra vez a la página de lgin y mstrándle un mensaje de alerta. Si ls dats intrducids sn crrects, al usuari se le muestra el menú de Administración, que cnstará de un enlace al Módul de Cnfiguración de Cnectres y tr enlace al Módul de Mnitrización del Servidr. El usuari puede navegar pr ambs móduls hasta el cierre de la sesión MÓDULO DE CONFIGURACIÓN DE FUENTES Se define fuente cm el cnectr que permite realizar una búsqueda desde el sistema cntra un buscadr determinad en Internet. Estas fuentes deben cnfigurarse a través de este módul, ya que cada una tiene unas características determinadas que deben ser definidas. Este módul, pr tant, permite el alta, mdificación y eliminación de las distintas fuentes que cmpnen el sistema de búsqueda. Al usuari administradr, al entrar en este módul, se le muestra un listad de las distintas fuentes dadas de alta en el sistema. Dich listad se muestra categrizad en función de la categría a la que pertenece cada fuente. Asciad a cada una de éstas, aparecen ds icns adicinales: un que indica si existe una incidencia cn dicha fuente, y tr para indicar si la fuente está activada n. Asciad a cada fuente en el listad, existe un btón para la eliminación de ésta del sistema. Si se pulsa dich btón, un mensaje de alerta indicará que se está a punt de eliminar dicha fuente. Si se hace click en Cnfirmar, la fuente queda eliminada definitivamente. Para dar de alta una nueva fuente, en el listad existe una caja libre de text que permite la intrducción del nmbre de ésta. Una vez intrducid, se pulsará el btón Añadir, que intrduce la fuente al sistema, redirigend al usuari a la página de mdificación de dicha fuente. El nmbre de las fuentes en el listad, es un enlace, que al ser pulsad, envia al usuari a la página de mdificación de ésta. La página de mdificación de una fuente se cmpne de las siguientes pestañas: Dats Generales: Baj esta pestaña, se pueden editar ls dats más genérics asciads a una fuente. Ests dats sn ls siguientes: Nmbre de la fuente: text libre de 255 caracteres. Descripción: text libre de 255 caracteres. Categría: categría a la que pertenece. desplegable que muestra un listad de las categrías existentes en el sistema. Página 4 de 14

5 Idima de la fuente: desplegable a seleccinar entre ls idimas existentes en el sistema. Númer de resultads pr búsqueda: camp numéric que permite al administradr determinar cuánts resultads, cm máxim, se pdrá btener en una búsqueda a través de esta fuente. El administradr puede utilizar este camp para ptimizar el rendimient del servidr. Activada: checkbx que indica si la fuente se debe mstrar al cliente n. Incidencia: checkbx que indica si la fuente tiene una incidencia. Tant las categrías cm ls idimas están predefinids en el sistema y sn fijs. Las categrías predefinids sn las siguientes: - Bibligafía tecnlógica: Patentes, Artículs, Librs - I+D realizada cn financiación pública - Ofertas cn tecnlgías dispnibles: Oferta tecnlógica madura - Tesis Dctrales - Nrmativa y regulación - Infrmación sbre reisgs de sustancias químicas - Mercads - Ntas de prensa (Press Releases) mercad anglsajón - Cnferencias y events químics - Páginas web - Prveedres - Oprtunidades Cmerciales Ls idimas predefinids que existen en la aplicación sn: - Castellan - Inglés - Euskera - Francés - Alemán - Italian Si el módul meta-buscadr, encargad de realizar las búsquedas sbre las distintas fuentes, cmprueba que n es capaz de btener resultads a través de la cnfiguración actual (bien pr prblemas de cnexión, bien prque ls parámetrs están mal definids bien prque la fuente ha cambiad), marcará autmáticamente el camp Incidencia, de frma que el Administradr pdrá cmprbar si existen incidencias cn las fuentes activas de un sl vistaz. En el cas de que el usuari haya detectad alguna incidencia, también pdrá marcar manualmente para recrdarse a sí mism que existe un prblema cn la fuente marcada. Dats de Búsqueda: Baj esta pestaña, el administradr puede parametrizar la fuente l cual permite que el metabuscadr pueda lanzar la búsqueda a la fuente de Internet. Pr tant, en esta pestaña se especifica la traducción de ls camps intrducids pr el usuari (text y peradr) en scripts cuy resultad sean ls camps que admite el buscadr. Pr l tant, ls camps que muestran dicha pestaña sn ls siguientes: Página de búsqueda: camp libre de 255 caracteres en el que se debe intrducir la URL de la página de búsqueda (n del buscadr del frmulari, sin l que se denmina actin del fmrulari ). Métd: Desplegable a seleccinar entre GET / POST, que indica el métd de prtcl http al que atiende el buscadr. Parámetrs estátics: parámetrs que se enviarán siempre al buscadr independientemente de ls términs intrducids pr el usuari. Se intrducirán en frmat query_string (parametr1=valr1&parametr2=valr2& ), pr l que el camp será text libre sin lngitud limitada. Parámetrs dinámics: Ests parámetrs deben intrducirse mediante scripts de traducción de text + peradr a parámetrs dinámics dependientes de la fuente. Página 5 de 14

6 Ls scripts de traducción se basan en pequeñas funcines que se aplican sbre el camp text y el camp peradr para btener ls parámetrs deseads. Pr l tant, para cada parámetr de la fuente que se desea btener, se tienen que definir las funcines que se desean aplicar. Dichas funcines se aplican de frma secuencial pr cada parámetr. Las instruccines pueden hacerse en base a camps (text u peradr) en base al resultad de la anterir función. Las funcines que se pueden intrducir sn las siguientes: SI: cmparación de literales: parametr 2 = { SI peradr = AND, funcin literal } Replace: reemplaza cadenas en el text. Ejempl: parametr1 = { replace(text,, AND ) } Cncat: cncatena al resultad pr delante (F) pr detrás (B). Ejempl: parametr 3 = { cncat(text, WITHIN TITLE,F) } Asign: asigna un valr al resultad. A cntinuación, se muestra un ejempl en el que el parametr search de un buscadr debe ser de la siguiente frma termin1 AND termin2 AND termin3 AND termin4 WITHIN TITLE. En cas de ser OR, sería termin1 OR termin2 OR termin3 OR termin4 WITHIN TITLE y en cas de ser frase exacta, debería ser termin1 termin2 termin3 termin4 WITHIN TITLE : Search= { SI peradr= AND, replace(text,, AND ) ; SI peradr= OR, replace(text,. OR ); SI peradr= FE, cncat(text,,f); SI peradr= FE, cncat(resultad,,b); Cncat(resultad, WITHIN TITLE,B); } NOTA: ver apartad 5.2 Dats de Resultads: Baj esta pestaña, el administradr puede mdificar las prpiedades de la fuente relativas a cóm se btienen ls resultads. Ls resultads btenids de un buscadr de Internet deben analizarse para btener de ésts el titul, enlace y text. Este análisis, cn el bjetiv de flexibilizar la herramienta cn distints buscadres, se realiza mediante expresines regulares. Ls camps que ns encntrarems en esta pestaña serán, pr tant: Suprimir retrns de carr: checkbx. Debid a que ls retrns de carr generalmente suelen dar prblemas cn las expresines regulares, esta pción suele ser útil. Psición enlace, títul y entradilla: En este camp de text libre, deben ir las psicines de ests camps en el resultad de la expresión regular. Pr ejempl 2,1,3. Expresión Regular: Textarea, para almacenar la expresión regular, que aplicada a la página HTML resultante, devlverá N resultads del buscadr. Prbar: un camp de text libre, un desplegable de peradr y un btón de prbar, permitirán testear las expresines regulares in situ MÓDULO DE MONITORIZACIÓN DE SERVIDOR Este módul permite al Administradr cmprbar el funcinamient y us del servidr y las fuentes cnfiguradas en el sistema, a través de listads que le prprcinen infrmación sbre las búsquedas. De esta frma, al entrar al módul, el usuari se encuentra cn un menú en el que puede escger ds listads: - Listad de búsquedas: Este listad cnsta de una página cn un filtr de fechas (fecha desde y fecha hasta) el cual permite ver tdas las búsquedas realizadas el dich rang de fechas. De cada búsqueda realizada se btiene la siguiente infrmación: Página 6 de 14

7 fecha búsqueda, hra de búsqueda, categría, fuente, text, númer de resultads btenids, incidencia (si la búsqueda ha terminad en incidencia n). - Listad de prcesamient de búsquedas: Este listad permite al usuari btener las búsquedas cn incidencias realizadas en el sistema categrizad pr fuente. Pr l tant, y a través de un filtr de fechas igual que en el anterir cas, btendrems pr cada fuente, el númer de peticines realizadas y el númer de incidencias en dich rang. Al pulsar sbre esa infrmación, accederems a un listad detallad de las búsquedas (la página anterir) per sl para la fuente seleccinada, en el rang seleccinad. Debid a que ls lgs de búsqueda se irán acumuland cn el tiemp, es necesari realizar un prces de mantenimient que brre ls registrs de fechas anterires. Cn este bjetiv, se dispne de un btón en el listad que permite dich brrad intrduciend una fecha límite. Al intrducir la fecha y pulsar el btón, el sistema avisa de que se eliminarán ls registrs de las búsquedas anterires a esa fecha. Al cnfirmar dicha acción, el sistema ejecuta el brrad. 3. MÓDULO DE METABUSQUEDA Este módul se encargará de prcesar las búsquedas slicitadas pr ls usuaris cn el bjet de btener la infrmación que cincida cn el criteri de búsqueda. Pr tant, este módul es una función cn la siguiente frma: text peradr fuente MÓDULO METABUSQUEDA Resultads [0..n] errr Pr l tant, ls parámetrs de este módul sn: - Parámetrs de entrada: Text: camp de text Operadr: peradr Fuente: identificadr numéric de la fuente sbre la que actuar - Parámetrs de salida: Errr: un blean, que indicará si la búsqueda ha funcinad crrectamente. Resultads: array en el que cada element cntendrá la siguiente infrmación: Titul Enlace Text A cntinuación, se detalla el fluj del Módul Metabúsqueda: Página 7 de 14

8 text peradr fuente Cnversión parámetrs Query_string Lanzamient búsqueda OK? SI html Parse resultads OK? SI Errr=0 Resultads[] NO NO SI NO Marcar RETRY? Incidencia Errr=1 Página 8 de 14

9 4. MÓDULO DE COMUNICACIÓN Este módul permite la cmunicación entre el cmpnente cliente de la platafrma y el cmpnente servidr. En particular, permitirá al cmpnente cliente btener infrmación sbre las fuentes dispnibles en las que el usuari puede realizar cnsultas, y btener la infrmación que cincida cn el criteri de búsqueda slicitad pr el usuari en las fuentes de infrmación dispnibles. El módul de cmunicacines cnstará ds funcinalidades que se describen a cntinuación: 4.1. ACTUALIZACIÓN FUENTES Permite al cmpnente cliente btener infrmación sbre las fuentes dispnibles, es decir aquellas sbre las cuales el usuari pdrá realizar las peticines de búsqueda. Esta acción se debe invcarse regularmente, principalmente al iniciar el cmpnente cliente para el crrect funcinamient de la platafrma. Se recge la petición realizada pr el cliente y cmprueba que es una slicitud válida - cmprbación de un identificadr asciad al cliente (ID), a cntinuación invca al prces de recgida de cnfiguración de fuentes, el cual una vez finalizad entrega ls resultads al cliente para su prcesad. Ls resultads estan cmpuests pr aquellas fuentes que están marcadas cm ACTIVAS. Es de reseñar que las fuentes, aun marcadas cm INCIDENCIA, sí que se entregarán al usuari, pues puede que la incidencia que afectó a la fuente fuera sól tempral. Pr tant, es deber del Administradr realizar un mantenimient periódic que permita el seguimient de las fuentes cn incidencias y desactivarlas si es el cas. En esta primera fase n se infrma al mdul cliente de una psible incidencia en las fuentes LANZAMIENTO DE BÚSQUEDAS Página 9 de 14

10 Permite al cmpnente cliente btener la infrmación que cincida cn el criteri de búsqueda slicitad pr el usuari en las fuentes de infrmación dispnibles en el sistema. El criteri de búsqueda se cmpne de una cadena de búsqueda (términs de búsqueda), un peradr básic que actúa sbre ls términs y las fuentes de infrmación en las que se desea lcalizar la infrmación. Se recge la petición realizada pr el cliente y cmprueba que es una slicitud válida - cmprbación de un identificadr asciad al cliente, a cntinuación, pr cada fuente, se invca al módul meta-buscadr (siempre y cuand n se rebase el númer máxim de resultads pr búsqueda permitids). Una vez finalizad entrega ls resultads al módul. Este módul incrpra a ls resultads las prpiedades referidas a la fuente en cuestión (idima y nmbre de fuente) y une ls resultads de tds sus meta-buscadres. Este cnjunt de resultads se entrega de frma íntegra al cliente. Para la n saturación del servidr, este módul debe encargarse de cmprbar que el númer de prcess existentes de meta-busqueda es inferir al máxim sprtad pr el servidr. Si así es el cas, el módul debe encla la petición hasta que el servidr esté dispnible. Página 10 de 14

11 5. ESPECIFICACIONES TECNICAS 5.1. PROTOCOLO DE COMUNICACIÓN El módul servidr expne un WebService el cual estará definid en base a su wsdl crrespndiente. En la fase de desarrll se pndrá a dispsición el wsdl a través de la url siguiente: El WebService dispne de ds funcines: FUNCTION "GETFUENTES" Esta función permite btener las fuentes dispnibles en el módul servidr. Parámetrs de entrada: - "ID", de tip string. Identificadr del cliente Parámetrs de salida: - "FUENTES" de tip array, cada element del array es un array de 5 elements: [0] - id_fuente [1] - Nmbre fuente [2] - id_categria [3] - Categría Fuente. [4] - Operadres Tds ls elements interns sn strings. El camp "Operadres" (el element 4 -últim- del array), indica el peradr/es que permite la fuente en cuestión. Dich camp es un string cn ls siguientes valres psibles "AND", "OR" "FE", separads pr la puntuación cma (,). Pr tant, una fuente que sprtara ls tres peradres, tendría en este camp el siguiente literal "and,r,fe". FUNCTION "LANZARBUSQUEDA" Esta función permite btener ls resultads en base al criteri de búsqueda slicitad pr un cliente. Parámetrs de entrada: - "ID", de tip string. Identificadr del cliente. - "TEXTO", de tip string. Términs a buscar. Lngitud máxima: 255 caracteres. - "OPERADOR", string. Operadr relacinad cn el text. valres: "AND", "OR", "FE" - "FUENTES", de tip string. Frmat: idfuente1, idfuente2, idfuente3,... (fuentes separadas pr cmas). Lngitud máxima: 255 caracteres (suficientes para 100 fuentes). Parámetrs de salida: - "RESULTADOS", de tip array, cada element del array es tr array cn: [0] => Titul [1] => Enlace [2] => Text Página 11 de 14

12 [3] => Fecha [4] => Idima (literal) [5] => Fuente (literal) Tds ls elements interns sn strings. Cm se puede cmprbar, en el cas de incidencia, al cliente n se le ntifica de este hech, para n abrumarle cn más infrmación de la necesaria OTRAS CONSIDERACIONES En esta primera fase se pueden realizar búsquedas sbre varias fuentes de frma simultanea, únicamente en el cas en que tdas las fuentes elegidas pr el usuari dispngan del peradr elegid pr el cliente al cnfigurar la búsqueda. La restricción es cntrlada pr el mdul cliente. El máxim númer de resultads pr fuente es un parámetr que se almacena en esta fase en el módul servidr. El idima de cada fuente es un parámetr que se almacena en esta fase en el módul servidr. Debid a que la inicialización de un WebService es cmpleja (ya que el cliente recmpne las funcines que puede invcar a través de un XML), el mdul cliente inicializa el bjet WebService al inicializar la aplicación; y psterirmente, se utiliza dich bjet para ir realizand las distintas búsquedas OPTIMIZACIÓN DEL SERVIDOR Para permitir una ptimización en el rendimient del servidr dnde irá albergad el módul en función de las características de éste y del númer de cliente, existen tres variables glbales que permiten una cierta flexibilidad. Ls parámetrs sn ls siguientes: Máxim númer de resultads pr fuente Máxim númer de resultads ttales pr búsqueda Máxim númer de prcess simultánes de meta-búsqueda pr búsqueda Time-ut de cnexión. Para ell se ha de mdificar la tabla t_ie_parámetrs. Ls parámetrs y sus valres pr defect sn: Máxim númer de resultads pr fuente: dependiente de cada fuente Máxim númer de resultads ttales pr búsqueda: 200 resultads Máxim númer de prcess simultanes de meta-búsqueda pr servidr pr búsqueda: 10 Time-ut de cnexión: 20 seg Página 12 de 14

13 5.4. MODELO ENTIDAD RELACIÓN El mdel entidad relación de la base de dats es el siguiente: 5.5. PLATAFORMA DE EJECUCION Servidr de Aplicacines: Recmendad Tmcat 5.5 Servidr de Base de Dats: MySQL 4.1 JRE: Versión ARQUITECTURA DE DESARROLLO La aplicación se ha implementad mediante el us de varias tecnlgías: J2EE, el FrameWrk Jakarta Struts, Ibatis, axis, Jakarta lg4j. Ls jar de Jakarta Struts, Ibatis, axis, Jakarta lg4j se han incluid en WEB-INF/lib ESTRUCTURA GENERAL DE DIRECTORIOS El directri raíz cntiene tda la aplicación. En el nivel /admin. se encuentran tdas las páginas JSP que implementan la funcinalidad de la aplicación. Página 13 de 14

14 El rest de directris que cmpnen la aplicación crrespnden a: estils: ls archivs de estils img: archivs de imágenes includes: archivs cmunes a tdas las páginas JSP js: archivs de códig javascript cmunes a tda la aplicación La estructura que se utiliza en cuant a paquetería es: ie.admin.xx: Ie..admin.bd referente a la cnexión a BD Ie..admin.frms referente a ls frms de struts y beans de ibatis. Ie..admin.actins referente a ls actin de struts Ie..admin.sql referente a las cnsultas SQL de ibatis. De igual frma, la estructura asciada a ls webservices es: Ie.web.bd Ie.web.frms Ie.web.sql Ie.web.services Y las clases asciadas al meta-buscadr están en paquetes ie.cre.xxx Ie..cre.bd Ie..cre.frms Ie..cre.sql Ie..cre.services 5.8. FLUJO DE LA APLICACIÓN A. lginactin B. listarfuentesactin C. mdificarfuenteactin D. nuevafuenteactin E. eliminarfuenteactin F. guardarfuenteactin G. verbusquedaactin H. verprcesamientactin I. verbusqudasfuenteactin J. mantenerlgsactin K. nuevparametractin Página 14 de 14