FRAMEWORK ATLAS Manual de de integración del componente FICA Versión 1.0 UNIDAD DE ARQUITECTURA DE SOFTWARE DE APLICACIONES

DIRECCIÓN DE INGENIERIA

Hoja de Control Título

Manual de de integración de componente FICA en un proyecto Atlas

Documento de Referencia

NORMATIVA ATLAS

Responsable

Unidad de Arquitectura Software de Aplicaciones

Versión

1.0

Fecha Versión

14/01/2015

Registro de Cambios Versión 1.0

Causa del Cambio

Responsable del Cambio

Fecha del Cambio

Versión inicial del documento Unidad de Arquitectura Software de Aplicaciones

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

1

DIRECCIÓN DE INGENIERIA

Índice 1

INTRODUCCIÓN ............................................................................................................................... 3 1.1 1.2

AUDIENCIA OBJETIVO ............................................................................................................ 3 CONOCIMIENTOS PREVIOS .................................................................................................... 3

2

DESCRIPCIÓN ................................................................................................................................... 3

3

INSTALACIÓN Y CONFIGURACIÓN ........................................................................................... 5 3.1 INSTALACIÓN ........................................................................................................................... 5 3.1.1 CONFIGURACIÓN .................................................................................................................. 5 3.1.2 Añadir definiciones de beans en el contexto Spring ................................................................. 5 3.1.3 Dependencias y ficheros de configuración ............................................................................... 5 3.1.4 Importar fichero de configuración de Beans de Spring de Documentum ................................ 6 3.1.5 Añadir los ficheros dfc.properties y dfc.keystore al proyecto .................................................. 7 3.1.6 Añadir variables de configuración DFC a enviroment.properties ........................................... 7 3.1.7 Cambios en los ficheros environment.properties ..................................................................... 8

4

USO....................................................................................................................................................... 9 4.1 USO DE LA INTERFAZ DEL SERVICIO FICA ...................................................................... 11 4.1.1 Guardar .................................................................................................................................. 12 4.1.2 Actualizar................................................................................................................................ 13 4.1.3 ActualizarMetadatos ............................................................................................................... 14 4.1.4 Recuperar ............................................................................................................................... 15 4.1.5 RecuperarPorIdExterno ......................................................................................................... 16 4.1.6 Borrar ..................................................................................................................................... 17 4.1.7 RecuperarMetadatos............................................................................................................... 18 4.1.8 BusquedaMetadatos................................................................................................................ 19 4.2 RECOMENDACIONES Y BUENAS PRÁCTICAS ................................................................. 21

5

PREGUNTAS MÁS FRECUENTES ............................................................................................... 21

6

ENLACES RELACIONADOS ........................................................................................................ 22

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

2

DIRECCIÓN DE INGENIERIA

1 INTRODUCCIÓN Este manual explica cómo integrar el servicio FICA en un proyecto web de ATLAS ya existente o en un proyecto ATLAS.

1.1 AUDIENCIA OBJETIVO Este documento está dirigido a desarrolladores de proyectos java para ICM en los que se desee integrar el componente FICA en su proyecto.

1.2 CONOCIMIENTOS PREVIOS Para un completo entendimiento del documento, el lector deberá tener conocimientos previos sobre las siguientes tecnologías: Spring Framework. Hibernate. Documentum (ver apartado Recomendaciones y buenas prácticas). Para saber más sobre dichas tecnologías, consultar el apartado de este documento, Enlaces Relacionados.

2 DESCRIPCIÓN FICA es un componente back-end de tipo servicio que nos permite la manipulación de ficheros de forma independiente del sistema de almacenamiento subyacente. Para ello debemos gestionar una serie de metadatos asociados a los mismos y definir el sistema de almacenamiento en el que deseamos gestionarlos. Actualmente se contemplan los siguientes sistemas de almacenamiento: Documentum Filesystem Para utilizar el servicio, una vez configurado, el usuario crea un objeto con una serie de metadatos lógicos del fichero que desea gestionar, usa la operación guardar y el sistema nos devuelve un identificador interno único (secuencia de tipo Integer) para la manipulación posterior del fichero. Para ello se proporcionan las siguientes operaciones sobre el sistema de almacenamiento elegido: 1. 2. 3. 4. 5. 6. 7. 8.

Guardar un fichero (incluye el alta de los metadatos del mismo). Recuperar un fichero (a partir de un identificador interno). Recuperar metadatos de un fichero (a partir de su identificador interno). Buscar los metadatos de un fichero a partir de su identificador interno (incluyendo o no el fichero). Buscar uno o varios ficheros a partir de un identificador externo. Búsqueda textual sobre un conjunto de ficheros. Eliminar un fichero (se eliminan de igual modo los metadatos). Actualizar un fichero.

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

3

DIRECCIÓN DE INGENIERIA Para poder usar dichas operaciones, se necesita una autorización previa en función de los siguientes parámetros (ver paso 2 del apartado configuración): Grupo de ficheros. Módulo técnico. Password. De manera análoga, el acceso a cada fichero puede ser de los siguientes tipos: No autorizado. Solo lectura. Lectura y escritura.

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

4

DIRECCIÓN DE INGENIERIA

3 INSTALACIÓN Y CONFIGURACIÓN 3.1 INSTALACIÓN 3.1.1 CONFIGURACIÓN El acceso de cualquier módulo a FICA debe realizarse obligatoriamente a través de las librerías ATLAS de acceso a FICA. En principio podemos añadir el componente a cualquier aplicación, independientemente del arquetipo con el que la hayamos generado. No es necesario añadir ninguna dependencia en nuestro pom.xml, puesto que ya tenemos integrados los JAR en el proyecto padre.

IMPORTANTE Si la aplicación ya está usando Documentum a través de servicios web, consultar con Arquitectura a través de MANTIS.

3.1.2 Añadir definiciones de beans en el contexto Spring Para poder usar el servicio, deberá añadirse al fichero applicationContext-services.xml de la aplicación la siguiente directiva: applicationContext-services.xml



3.1.3 Dependencias y ficheros de configuración Tal y como ya hemos indicado, no es necesario añadir dependencias en ningún pom.xml, puesto que el JAR de la librería que obtenemos a través del pom padre ya nos provee de todas las dependencias transitivas que necesitamos para usar el servicio. No es necesario añadir propiedades en el environment.properties, puesto que los datos de conexión a Documentum no son fijos y se obtienen de forma dinámica durante la ejecución de la aplicación. De igual modo, tampoco es necesario añadir ningún bean en nuestro applicationContext-services.xml, puesto que el import anterior ya incluye todos los que necesitamos.

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

5

DIRECCIÓN DE INGENIERIA

3.1.4 Importar fichero de configuración de Beans de Spring de Documentum Dependiendo de si se está haciendo una aplicación Batch o Web hay que hacer diferentes cosas para incluir el fichero de bean de Spring de Documentum, según se indica en los siguientes sub-apartados. 3.1.4.1 Si se está haciendo una aplicación Batch Incluir el fichero de configuración applicationContext-gdoc.xml en el arranque del batch, de forma que se cargue este fichero al ejecutar la clase BatchRunner.java: Antes: BatchRunner.java /** * Metodo main que se ejecuta al iniciar el programa * @param args Argumentos del programa (no requeridos). */ public static void main(String[] args) { log.info("Iniciando contexto de Spring"); AbstractApplicationContext context = new ClassPathXmlApplicationContext( new String[] {"/conf/applicationContext-batch.xml"}); …

Después: BatchRunner.java /** * Metodo main que se ejecuta al iniciar el programa * @param args Argumentos del programa (no requeridos). */ public static void main(String[] args) { log.info("Iniciando contexto de Spring"); AbstractApplicationContext context = new ClassPathXmlApplicationContext( new String[] {"/conf/applicationContext-batch.xml", "/conf/applicationContext-gdoc.xml"}); …

3.1.4.2 Si se está haciendo una aplicación Web o un Servicio Web Incluir el fichero de configuración applicationContext-gdoc.xml en el fichero web.xml para que se cargue en el contexto de Spring al arrancar la aplicación Web:

web.xml Este parametro indica la localización exacta de los ficheros de configuración de SPRING contextConfigLocation classpath:/conf/applicationContext-systemProperties.xml; Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

6

DIRECCIÓN DE INGENIERIA classpath:/conf/applicationContext-general.xml; classpath:/conf/applicationContext-services.xml; classpath:/conf/applicationContext-dao.xml; classpath:/conf/applicationContext-database.xml; classpath:/conf/atlas-trazas-application-context.xml; classpath:/conf/applicationContext-gdoc.xml;

3.1.5 Añadir los ficheros dfc.properties y dfc.keystore al proyecto En la misma zona de la web de ArquitecturaSw donde se encuentra este manual, deberán encontrarse dos ficheros que se descargarán y se situarán en el directorio src/main/resources de nuestra aplicación: dfc.properties dfc.keystore 3.1.6 Añadir variables de configuración DFC a enviroment.properties Incluir las siguientes variables de configuración en todos los ficheros environment.properties situados en: En el directorio src/main/resources En todos los subdirectorios del directorio war si es en una aplicación web En todos los subdirectorios del directorio zip si es en una aplicación batch environment.properties # Variables para configurar las DFC's dfc.data.dir=D\:/Documentum dfc.docbroker.host0 = icmsvlds009 dfc.docbroker.port0 = 1489 dfc.globalregistry.repository=desdocum_01 dfc.globalregistry.username=dm_bof_registry dfc.globalregistry.password=GrRNPhLJrkoTDAZE0RGJow\=\= dfc.search.ecis.ssl.enable = false dfc.security.keystore.password = dfc dfc.security.keystore.privatekey.password = !!dfc!! dfc.session.allow_trusted_login = false

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

7

DIRECCIÓN DE INGENIERIA

3.1.7 Cambios en los ficheros environment.properties En el fichero environment.properties se deben meter los datos de la autorización de uso de fica. Estos datos hay que solicitarlos por cada aplicación, mediante un MANTIS a Arquitectura. La autorización de uso se dará para un módulo técnico y un grupo de ficheros (esto es un grupo lógico de ficheros). A este modulo técnico / grupo de ficheros se le autorizará a leer o escribir a uno o más sistemas de almacenamiento (por ejemplo Documentum y/o FileSystem) environment.properties # Autorización de uso de FICA fica.grupoficheros=REGISTRO fica.modulotecnico=ATLAS_COMPONENTES fica.password=1234

AVISO Cuando se vaya a proceder al pase entre entornos, no olvidar añadir los properties en las subcarpetas war

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

8

DIRECCIÓN DE INGENIERIA

4 USO El usuario del servicio posee un grupo de clases (instanciadas normalmente, no son beans de Spring) para poder utilizar el API, de forma que tanto los metadatos como el contenido del fichero se guardan de forma transaccional, es decir, si se almacena un fichero en alguno de los sistemas de almacenamiento, se guardan en base de datos los metadatos asociados. Si borramos el fichero, se eliminan sus metadatos. En el caso de que recuperemos un fichero, podemos optar por recuperar bien sus metadatos o bien los metadatos y su contenido binario (array de bytes) que el usuario deberá manipular posteriormente. Las clases son: FicaMetadatos, con los siguientes atributos para cada fichero individual: Identificador interno (secuencia única que se genera al almacenar el fichero, generada por el servicio). En lo sucesivo lo llamaremos idFicheroInterno. Grupo de ficheros (agrupación lógica que el usuario define para clasificar determinados ficheros, ej: CONTABILIDAD). Módulo técnico. Nombre del fichero. Extensión del fichero. Carpeta (es una agrupación lógica, no un path físico). Todos los ficheros se almacenan físicamente bien en un repositorio Documentum o en una carpeta base del filesystem, pero no existe una jerarquía de carpetas. Este atributo podría servir para agruparlos y poder realizar búsquedas posteriormente por este metadato. Identificador externo (útil para efectuar asociaciones lógicas entre la aplicación y el identificador único). Fecha del fichero. Título del fichero. Usuario del fichero. Sistema de Almacenamiento, que podrá ser: FicaConstantes.SA_DOCUMENTUM, en cuyo caso se guardarán todos los ficheros en una carpeta preconfigurada en un repositorio del gestor documental Documentum de ICM, que deberá tener activada la característica de indexación para poder efectuar búsquedas textuales (en otro caso no se garantiza la devolución correcta de resultados). FicaConstantes.SA_FILESYSTEM, en cuyo caso se almacenarán todos los ficheros en una carpeta base que servirá como path físico dentro de un sistema de ficheros. El usuario debe encargarse de obtener y pasar el array de bytes con el contenido real del fichero cuando haga la llamada a la operación guardar, junto con los metadatos descritos anteriormente. En ningún caso forma parte de esta clase ni se contemplan aspectos como tipos MIME, que son dependientes de la aplicación. Una vez almacenado el fichero, se almacena su configuración en base de datos para poder realizar el resto de operaciones en el futuro (búsqueda, recuperación, eliminación, actualización,...).

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

9

DIRECCIÓN DE INGENIERIA

AVISO Una vez almacenado el fichero, el usuario no podrá cambiar el sistema de almacenamiento en el que resida durante la vida del mismo.

FicaFichero, clase que incluye, además de la información de los metadatos, el contenido real (array de bytes) del fichero. FicaInfoBusqueda, clase de tipo helper que se utiliza para realizar búsquedas a través de metadatos (ver método busquedaMetadatos y ejemplos de código). Esta clase tiene dos métodos: addCampoBusqueda, para asignar los campos por los cuales queremos buscar, así como el tipo de búsqueda. Los posibles valores se encuentran en los enum CamposBusqueda y TipoBusqueda. Podemos añadir tantos campos como queramos del mismo tipo, excepto para FECHA_DESDE y FECHA_HASTA, que solo se pueden añadir una sola vez. addOrden, para indicar que orden queremos para cada campo, con su correspondiente enum OrdenBusqueda. AVISO La búsqueda funciona haciendo OR entre campos iguales y AND entre campos distintos. Es obligatorio añadir al menos un campo de búsqueda (el orden es opcional). También disponemos de dos métodos de conveniencia para poder cargar o guardar ficheros desde o hacia un path local, según se necesite: FicaUtils.loadFileFromPath(String path_local); FicaUtils.saveFileToPath(String fichero, byte[] datos_fichero);

Donde path_local podría declararse por ejemplo así: String pathLocal = (new File("temporal/fichero.pdf")).getAbsolutePath();

Y fichero de este modo: String ficheroLocal = "/temporal/fichero_recuperado.extension";

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

10

DIRECCIÓN DE INGENIERIA

4.1 USO DE LA INTERFAZ DEL SERVICIO FICA El uso del componente consiste en instanciar las clases comentadas anteriormente con los valores disponibles y usar los métodos del siguiente bean: Bean ficaService

Descripción Implementación del interfaz atlas.fica.services.FicaService

Para utilizar este bean en nuestra aplicación simplemente tendremos que inyectarlo en las clases de Servicio en las que sea necesario su uso. Todas las operaciones pueden lanzar una ServiceException que deberá capturar y procesar el usuario del servicio. Como en cualquier otra aplicación, podemos configurar nuestro logger añadiendo una categoría para poder mostrar los mensajes en modo DEBUG, añadiendo la siguiente entrada en el log4j.xml de /src/main/resources log4j.xml

IMPORTANTE Cuando se vaya a proceder al pase entre entornos, no olvidar cambiar el valor level de debug a info

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

11

DIRECCIÓN DE INGENIERIA Las operaciones disponibles disponibles son: 4.1.1 Guardar Guardar un fichero en FICA, a partir de su contenido en byte[] y un objeto FicaMetadatos:

FicaService.java public FicaFichero guardar(byte[] fichero, FicaMetadatos metadatos) throws ServiceException;

Ejemplo de código para guardar un fichero en FICA byte[] contenidoFichero = null; // cargar aquí contenidoFichero FicaMetadatos ficaMetadatos = new FicaMetadatos(); ficaMetadatos.setNombreFichero("clientes2014"); ficaMetadatos.setSistemaAlmacenamiento(FicaConstantes.SA_DOCUMENTUM); ficaMetadatos.setExtension("pdf"); ficaMetadatos.setCarpeta("Contabilidad"); ficaMetadatos.setFechaFichero(new Date()); ficaMetadatos.setTituloFichero("Listado de clientes"); ficaMetadatos.setUsuario(FicaUtils.getUserName()); ficaMetadatos.setIdExterno("LC2014"); FicaFichero ficheroTest = null; ficheroTest = ficaService.guardar(contenidoFichero,ficaMetadatos);

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

12

DIRECCIÓN DE INGENIERIA 4.1.2 Actualizar Actualizar el contenido de un fichero a partir de sus metadatos y su idFicheroInterno: FicaService.java public FicaFichero actualizar(int idFicheroInterno, byte[] fichero, FicaMetadatos metadatos) throws ServiceException;

Ejemplo de código para actualizar un fichero en FICA byte[] contenidoFichero = función_del_usuario_para_cargar_fichero(); … // modificar aquí contenidoFichero si se desea FicaMetadatos ficaMetadatos = new FicaMetadatos(); ficaMetadatos.setNombreFichero("clientes2015"); ficaMetadatos.setSistemaAlmacenamiento(FicaConstantes.SA_DOCUMENTUM); ficaMetadatos.setExtension("pdf"); ficaMetadatos.setCarpeta("Contabilidad"); ficaMetadatos.setFechaFichero(new Date()); ficaMetadatos.setTituloFichero("Listado de clientes BIS"); ficaMetadatos.setUsuario(FicaUtils.getUserName()); ficaMetadatos.setIdExterno("LC2015"); FicaFichero ficheroTest = null; ficheroTest = ficaService.actualizar(idFicheroInterno,contenidoFichero,ficaMetadatos); // usar a partir de aquí getters de ficheroTest

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

13

DIRECCIÓN DE INGENIERIA 4.1.3 ActualizarMetadatos Actualizar los metadatos de un fichero FICA (no modifica el contenido del fichero):

FicaService.java public FicaFichero actualizarMetadatos(int idFicheroInterno, FicaMetadatos metadatos) throws ServiceException;

Ejemplo de código para actualizar metadatos de un fichero en FICA FicaMetadatos ficaMetadatos = new FicaMetadatos(); ficaMetadatos.setNombreFichero("clientes2017"); ficaMetadatos.setSistemaAlmacenamiento(FicaConstantes.SA_DOCUMENTUM); ficaMetadatos.setExtension("pdf"); ficaMetadatos.setCarpeta("Almacen"); ficaMetadatos.setFechaFichero(new Date()); ficaMetadatos.setTituloFichero("Listado de clientes BIS"); ficaMetadatos.setUsuario(FicaUtils.getUserName()); ficaMetadatos.setIdExterno("LC2015"); FicaFichero ficheroTest = null; ficheroTest = ficaService.actualizarMetadatos(idFicheroInterno,ficaMetadatos); // usar a partir de aquí getters de ficheroTest

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

14

DIRECCIÓN DE INGENIERIA 4.1.4 Recuperar Recuperar un fichero del sistema FICA a partir de su idFicheroInterno: FicaService.java public FicaFichero recuperar(int idFicheroInterno) throws ServiceException;

Ejemplo de código para recuperar un fichero de FICA FicaFichero ficheroTest = null; int idFicheroInterno = 150; ficheroTest = ficaService.recuperar(idFicheroInterno); System.out.println(ficheroTest.toString());

Recuperar un fichero del sistema FICA a partir de su idFicheroInterno, si soloMetadatos es true, no recuperamos el contenido, sólo los metadatos: FicaService.java public FicaFichero recuperar(int idFicheroInterno, boolean soloMetadatos) throws ServiceException;

Ejemplo de código para recuperar un fichero de FICA (metadatos) FicaFichero ficheroTest = null; int idFicheroInterno = 150; ficheroTest = ficaService.recuperar(idFicheroInterno, true); System.out.println(ficheroTest.toString());

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

15

DIRECCIÓN DE INGENIERIA 4.1.5 RecuperarPorIdExterno Recuperar un fichero del sistema FICA a partir de un idExterno. Si alguno de los ficheros no se puede recuperar, no devolverá ninguno de ellos: FicaService.java public List recuperarPorIdExterno(String idFicheroExterno) throws ServiceException;

Ejemplo de código para recuperar un fichero de FICA por id externo List listaFicheros = ficaService.recuperarPorIdExterno(“ID001”); // procesar listaFicheros

Recuperar un fichero del sistema FICA por IdExterno (si soloMetadatos es true, no recuperamos el contenido): FicaService.java public List recuperarPorIdExterno(String idFicheroExterno, boolean soloMetadatos) throws ServiceException;

Ejemplo de código para recuperar un fichero de FICA por id externo List listaFicheros = ficaService.recuperarPorIdExterno(“ID001”,true); // procesar listaFicheros

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

16

DIRECCIÓN DE INGENIERIA 4.1.6 Borrar Borrar un fichero FICA a partir de su idFicheroInterno. Borra físicamente el fichero en su sistema de almacenamiento. FicaService.java public boolean borrar(int idFicheroInterno) throws ServiceException;

Ejemplo de código para borrar un fichero de FICA Boolean borrado = ficaService.borrar(25);

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

17

DIRECCIÓN DE INGENIERIA 4.1.7 RecuperarMetadatos Recuperar metadatos de un fichero FICA a partir de su idFicheroInterno: FicaService.java public FicaFichero recuperarMetadatos(int idFicheroInterno) throws ServiceException;

Ejemplo de código para recuperar metadatos de un fichero de FICA FicaFichero fichero = ficaService.recuperarMetadatos(34);

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

18

DIRECCIÓN DE INGENIERIA 4.1.8 BusquedaMetadatos Buscar metadatos de los ficheros en función de los parámetros de búsqueda. Para ello debemos crear tres parámetros: infoBusqueda, objeto de tipo FicaInfoBusqueda donde añadirle los campos por los que deseamos buscar. index, punto a partir del cual queremos devolver resultados. pageSize, tamaño máximo del bloque a devolver. FicaService.java public List busquedaMetadatos(FicaInfoBusqueda infoBusqueda, int index, int pageSize) throws ServiceException;

Ejemplo de código para buscar metadatos en FICA FicaInfoBusqueda ficaInfoBusqueda = new FicaInfoBusqueda(); ficaInfoBusqueda.addCampoBusqueda(CamposBusqueda.CARPETA, "testBORRAR", TipoBusqueda.NORMAL); ficaInfoBusqueda.addCampoBusqueda(CamposBusqueda.FECHA_DESDE, "15/10/2011 00:00:00", TipoBusqueda.NORMAL); ficaInfoBusqueda.addCampoBusqueda(CamposBusqueda.FECHA_HASTA, "26/11/2011 00:00:00", TipoBusqueda.NORMAL); ficaInfoBusqueda.addOrden(CamposBusqueda.NOMBRE_DOCUMENTO, OrdenBusqueda.ASCENDENTE); ficaInfoBusqueda.addOrden(CamposBusqueda.CARPETA, OrdenBusqueda.DESCENDENTE); List listaFicaFichero = new ArrayList(); listaFicaFichero = ficaService.busquedaMetadatos(ficaInfoBusqueda, 0,200);

// procesar listaFicaFichero

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

19

DIRECCIÓN DE INGENIERIA 4.1.9 Búsqueda textual en ficheros. Nos devuelve la lista de ficheros que contienen los textos de búsqueda que indiquemos. Es obligatorio incluir una lista de idInternos para filtrar la búsqueda (podemos llamar a busquedaMetadatos() para obtener una lista de idInternos). Actualmente solo está definida la búsqueda para el sistema DOCUMENTUM: FicaService.java public List busquedaTextual(List listaIdInternos, List textosBusqueda) throws ServiceException;

Ejemplo de código para efectuar búsqueda textual en ficheros de FICA List listaIdFicheroInternos = new ArrayList(); List textosBusqueda = new ArrayList(); List listaFicaFichero= new ArrayList(); listaIdFicheroInternos.add(1); listaIdFicheroInternos.add(2); textosBusqueda.add("texto1"); textosBusqueda.add("texto2"); listaFicaFichero = ficaService.busquedaTextual(listaIdFicheroInternos, textosBusqueda);

AVISO Para poder realizar búsquedas textuales, el repositorio debe tener activada la característica de indexación. Consultar con Arquitectura.

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

20

DIRECCIÓN DE INGENIERIA

4.2 RECOMENDACIONES Y BUENAS PRÁCTICAS Para familiarizarse con la terminología Documentum sería recomendable leer previamente los siguientes documentos: ATLAS_MUS_Integrar_Documentum.pdf

5 PREGUNTAS MÁS FRECUENTES En este apartado se incluyen una lista de preguntas más frecuentes sobre el componente. Pregunta: ¿Dónde puedo encontrar información general sobre los componentes? Respuesta: En la aplicación de demostración de los componentes del Framework Atlas 2.0, así como en la aplicación de integración. Pregunta: ¿Es necesario tener integrado el gestor Documentum en mi aplicación para poder usar FICA? Respuesta: No. En el apartado de instalación se pueden seguir los pasos para evitar esta integración. Pregunta: He integrado el componente en mi proyecto y al ejecutar alguna operación del servicio, aparecen carpetas extrañas en la carpeta raíz de mi proyecto ¿es normal? Respuesta: Si. Eso se debe a que el API Documentum genera una serie de carpetas (log, export, etc). Tan solo debemos tener cuidado de no subirlas a nuestro repo SVN.

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

21

DIRECCIÓN DE INGENIERIA

6 ENLACES RELACIONADOS Producto

URL

Versión

Hibernate

http://www.hibernate.org/

Hibernate Annotations

http://www.hibernate.org/hib_docs/annotations/reference/en/html_single/ 3.3.0.ga

JPA

http://java.sun.com/developer/technicalArticles/J2EE/jpa/

1.0

Log4J

http://logging.apache.org/log4j/

1.2.14

Spring

http://www.springframework.org/

2.5.5

Spring Security

http://www.springframework.org/

2.0.4

Framework: ATLAS Manual: MANUAL DE INTEGRACIÓN FICA EN UN PROYECTO ATLAS Versión: 1.0 Fecha: 15/12/2014

3.2.6.ga

22