openfwpa Internacional Módulo Común de Documentación (MCD)

Transcripción

1 openfwpa Internacional (02. ManualConfiguracion_MCD_ _v1.0)

2 2 de 8 ÍNDICE 1. CONTROL DEL DOCUMENTO Información general Histórico de revisiones del documento INTRODUCCIÓN CONFIGURACIÓN DEL SERVICIO CONFIGURACIÓN DEL GESTOR DOCUMENTAL... 8

3 3 de 8 1. CONTROL DEL DOCUMENTO 1.1. Información general Título Creado por: A revisar por: A aprobar por: Estructura Documentación Consultor Junior: Víctor Cima Granda Consultores Senior: Juan José Parada Vales e Ignacio Álvarez Valdeón Jefe de Proyecto: Joaquín Fernández Juárez 1.2. Histórico de revisiones Versión Fecha Autor Observaciones /12/2011 Víctor Cima Granda /12/2011 Víctor Cima Granda 1.3. del documento Versión Fecha 0.1 Borrador 05/12/ /12/2011

4 4 de 8 2. INTRODUCCIÓN En el presente documento se describirán todos los pasos a seguir para lo correcta configuración del Módulo de Común de.

5 5 de 8 3. CONFIGURACIÓN DEL SERVICIO El componente Docmgmt-ws es el encargado de realizar el correcto despliegue del servicio web DocSgdService. Ilustración 1: Documentación Para la correcta configuración del componente procederemos en primer lugar a editar el archivo deploy.properties, que podemos encontrar en.\src\main\resources\. base.module.file = wsmcd.properties CONFIG.DIR = C:/gestionModulosComunes/MCD/config El parámetro base.module.file hace referencia al archivo de configuración del componente, en este caso: wsmcd.propiertes. Por otro lado el parámetro CONFIG.DIR hace referencia al directorio donde se pretende almacenar los ficheros de configuración y logs del módulo.

6 6 de 8 Se recomienda que este directorio sea único para todos los módulos comunes utilizados por la aplicación, almacenándose los datos específicos de cada módulo en una subcarpeta con su mismo nombre, en este caso MCD. Una posibilidad a la hora de referenciar el directorio es hacer uso de una variable de entorno o similar si se considerase de interés. Si se sigue este consejo se conseguirá centralizar toda la información de configuración y trazabilidad en una misma ubicación con las ventajas que esto proporciona a la hora de realizar mantenimientos, modificaciones Ya en el directorio establecido en CONFIG.DIR copiaremos los archivos que se encuentran en la siguiente ruta dentro del proyecto.\src\main\config\local Log4j.xml wsmcd.properties Nota: Si fuesen necesarios nuevos archivos de configuración para el gestor documental se incorporarían en este mismo directorio. Por último nos centraremos en la BBDD. Los scripts de creación, para MySQL, pueden encontrarse en la siguiente ruta.\src\main\config\db\docum_dba.sql. Si la BBDD seleccionada fuese MySQL el proceso de restauración sería trivial, si se decidiese utilizar otra BBDD el desarrollador debería realizar los cambios oportunos en el script. Una vez creada la BBDD configuraremos una conexión a la misma en el servidor de aplicaciones donde se desplegará el módulo, en nuestro caso Tomcat. Para que Tomcat tenga acceso al driver de MySQL, debemos poner el jar en el directorio adecuado de Tomcat. En este caso el driver está en el jar mysql-connector-java-bin.jar y se introduciría dentro de /tomcat7/common/lib. Una vez que ya tenemos en el servidor de aplicaciones el driver necesario, debemos proporcionarle todos los datos para la conexión con la BBDD. Para ello, editamos el fichero /tomcat7/context.xml y añadimos algo como esto <Resource name="jdbc/docmgmtds" auth="container" type="javax.sql.datasource" maxactive="100" maxidle="30" maxwait="10000" username="" password="" driverclassname="com.mysql.jdbc.driver" url="jdbc:mysql://localhost:3306/docum_dba"/>

7 7 de 8 jdbc/docmgmtds es el nombre que hemos decidido para referenciar nuestra conexión con la base de datos y es el nombre que debe conocer la aplicación. El usuario y la password serán las de acceso a la base de datos. El driverclassname es el nombre de la clase para la conexión con MySQL en este caso La url es la de la conexión con la base de datos docum_dba Para asegurarnos que la aplicación tiene conexión con la BBDD verificaremos que en el archivo web.xml del componente se encuentra la siguiente configuración de conexión. <resource-ref> <res-ref-name>jdbc/docmgmtds</res-ref-name> <res-type>javax.sql.datasource</res-type> <res-auth>container</res-auth> <res-sharing-scope>shareable</res-sharing-scope> </resource-ref>

8 8 de 8 4. CONFIGURACIÓN DEL GESTOR DOCUMENTAL En este MCD se ha desacoplado toda la parte relativa al gestor documental para que el propio equipo de desarrollo pueda tomar sus propias decisiones al respecto. Desde la clase SgdManagerImpl perteneciente al componente docmgmt-service se podrán realizar las reprogramaciones y configuraciones oportunas para comunicar el gestor documental y el MCD. Se aconseja realizar las operaciones necesarias con el gestor mediante un proxy o similar embebido en el docmgmt-service. Si en el proceso de comunicación se hiciese uso de algún fichero de configuración, se seguirá el protocolo de actuación tratado en el punto anterior. public interface SgdManager { DocumentVO almacena(documentvo documento,credentialsvo credentials); DocumentVO recupera(documentvo documento,credentialsvo credentials); DocumentVO recuperadatos(documentvo documento,credentialsvo CredentialsVO); void elimina(documentvo documento,credentialsvo CredentialsVO); DocumentVO modificar(documentvo document,credentialsvo CredentialsVO); void crearversion(documentvo document, CredentialsVO CredentialsVO); void restaurarversion(documentvo documento,string identificadorversion, CredentialsVO CredentialsVO); List recuperarversiones(documentvo documento,credentialsvo CredentialsVO); DocumentVO copiar(documentvo documento,string formato, CredentialsVO CredentialsVO); List recuperaenlaces(documentvo documento,credentialsvo CredentialsVO); void archivar(documentvo documento, CredentialsVO CredentialsVO); List recuperacopias(documentvo documento,credentialsvo CredentialsVO); DocumentVO crearenlace(documentvo documento,credentialsvo CredentialsVO); void adjuntarfirmas(documentvo document, List firmas,credentialsvo credentials); List buscars(searchcriteriavo criteria, CredentialsVO credentials); List recuperafirmas(documentvo documento,credentialsvo credentials); }