openFWPA Internacional
Módulo Común de Documentación (MCD)
Manual de Usuario
(03. ManualUsuario_MCD_20111230_v1.0)
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 2 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
ÍNDICE
1. CONTROL DEL DOCUMENTO ........................................................................................................ 5 1.1. Información general ....................................................................................................................... 5 1.2. Histórico de revisiones ................................................................................................................... 5
1.3. Estado del documento .................................................................................................................... 5
2. INTRODUCCIÓN ................................................................................................................................ 6 2.1. Descripción de la aplicación .......................................................................................................... 6 2.2. Alcance de la aplicación ................................................................................................................ 8
3. FUNCIONALIDADES ......................................................................................................................... 9 3.1. Almacenar documento ................................................................................................................... 9
3.2. Modificar documento ..................................................................................................................... 9 3.3. Modificar datos de un documento ................................................................................................ 10 3.4. Eliminar documento ..................................................................................................................... 10 3.5. Recuperar documento .................................................................................................................. 11 3.6. Recuperar datos de un documento ............................................................................................... 12
3.7. Buscar documentos ...................................................................................................................... 12 3.8. Crear versión de un documento ................................................................................................... 13
3.9. Recuperar versiones de un documento......................................................................................... 13 3.10. Restaurar versión de un documento ........................................................................................... 14 3.11. Añadir firmas a un documento ................................................................................................... 14 3.12. Recuperar firmas de un documento ........................................................................................... 15
3.13. Recuperar documentos por firma ............................................................................................... 16 3.14. Copiar documento ...................................................................................................................... 16 3.15. Copiar documento para impresión ............................................................................................. 17 3.16. Recuperar copias de un documento ........................................................................................... 18
3.17. Crear enlace a un documento ..................................................................................................... 18 3.18. Recuperar enlaces de documento ............................................................................................... 19 3.19. Archivar documento ................................................................................................................... 19
4. DEFINICIÓN DE TIPOS DE DATOS. .............................................................................................. 21 4.1. TDocumento................................................................................................................................. 21 4.2. TDocumentoFichero .................................................................................................................... 21 4.3. TDocumentoDatos ....................................................................................................................... 21 4.4. TDocumentoDatosIdentificativos ................................................................................................ 22
4.5. TDocumentoDatosDescriptivos ................................................................................................... 23 4.6. TDocumentoDatosControlAccesos .............................................................................................. 23
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 3 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
4.7. TDocumentoDatosTrazabilidad ................................................................................................... 24 4.8. TDocumentoDatosCopia .............................................................................................................. 24 4.9. TDocumentoDatosRelacion ......................................................................................................... 25
4.10. TDocumentoDatosDigitalizacion ............................................................................................... 25 4.11. TDocumentoDatosRegistro ........................................................................................................ 26
4.12. TDocumentoDatosTramitacion .................................................................................................. 26
4.13. TDocumentoDatosArchivo ........................................................................................................ 27 4.14. TDocumentosDatosFirma .......................................................................................................... 27 4.15. TIdioma ...................................................................................................................................... 28 4.16. TFormatoFichero ....................................................................................................................... 28
4.17. TEntornoTecnico ....................................................................................................................... 28 4.18. TNivelLOPD .............................................................................................................................. 28
4.19. TTipoCopia ................................................................................................................................ 29 4.20. TOriginalIncompleto .................................................................................................................. 29 4.21. TFuenteOriginal ......................................................................................................................... 29
4.22. TCalidadOriginal ....................................................................................................................... 29 4.23. TCustodiaOriginal ...................................................................................................................... 30
4.24. TVersionDocumento .................................................................................................................. 30
4.25. TFirmasDocumento ................................................................................................................... 30
4.26. TBuscarDocumentos .................................................................................................................. 31 4.27. TCondicion................................................................................................................................. 31
4.28. TAtributo .................................................................................................................................... 31 4.29. TOperadorBusqueda .................................................................................................................. 32
5. USO DEL MCD EN UNA APLICACIÓN CON OPENFWPA......................................................... 33 5.1. Fichero wsMCD.properties .......................................................................................................... 34 5.2. Ejemplos de llamada al servicio................................................................................................... 34
5.2.1. Credenciales .......................................................................................................................... 34 5.2.1.1. Ejemplo de uso: “Almacenar documento/s” .................................................................. 35
Almacenar documento no procedimentado ............................................................................. 35 Almacenar documento de registro .......................................................................................... 35 Almacenar documento de tramitación .................................................................................... 36
5.2.1.2. Ejemplo de uso: “Modificar documento” ...................................................................... 37 5.2.1.3. Ejemplo de uso: “Modificar datos de un documento” ................................................... 37 5.2.1.4. Ejemplo de uso: “Eliminar documento” ........................................................................ 38 5.2.1.5. Ejemplo de uso: “Recuperar documento” ...................................................................... 38
5.2.1.6. Ejemplo de uso: “Recuperar datos de un documento” ................................................... 38 5.2.1.7. Ejemplo de uso: “Buscar documentos” .......................................................................... 39 5.2.1.8. Ejemplo de uso: “Crear versión de un documento” ....................................................... 39 5.2.1.9. Ejemplo de uso: “Recuperar versiones de un documento” ............................................ 39 5.2.1.10. Ejemplo de uso: “Recuperar firmas de un documento” ............................................... 40
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 4 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
5.2.1.11. Ejemplo de uso: “Recuperar documentos de firma” .................................................... 40 5.2.1.12. Ejemplo de uso: “Copiar documento” ......................................................................... 40 5.2.1.13. Ejemplo de uso: “Recuperar copias de un documento” ............................................... 40
5.2.1.14. Ejemplo de uso: “Crear enlace de un documento” ...................................................... 41 5.2.1.15. Ejemplo de uso: “Recuperar enlaces de documento” .................................................. 41
5.2.1.16. Ejemplo de uso: “Archivar documento” ...................................................................... 41
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 5 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
1. CONTROL DEL DOCUMENTO
1.1. Información general
Título Estructura Módulo Común de Documentación
Creado por: Consultor Junior: Víctor Cima Granda
A revisar por: Consultores Senior: Juan José Parada Vales e Ignacio Álvarez Valdeón
A aprobar por: Jefe de Proyecto: Joaquín Fernández Juárez
1.2. Histórico de revisiones
Versión Fecha Autor Observaciones
0.1 05/12/2011 Víctor Cima Granda
1.0 30/12/2011 Víctor Cima Granda
1.3. Estado del documento
Versión Estado Fecha
0.1 Borrador 05/12/2011
1.0 Definitivo 30/12/2011
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 6 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
2. INTRODUCCIÓN
2.1. Descripción de la aplicación
El Módulo Común de Documentación (MCD) del openFWPA permite realizar diversas
operaciones sobre un sistema de gestión documental (SGD).
La operatividad del módulo se proporciona mediante el servicio web DocSgdService que sirve de
entrada a las diferentes operaciones a realizar sobre la gestión documental.
En la ilustración adjunta podemos encontrar una representación de los principales componentes
que integran el MCD y relaciones sus asociadas.
Ilustración 1: Componentes del módulo
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 7 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
El MCD está formado por los siguientes componentes:
Docmgmt-ws-proxy: Se trata del componente que se incrustará en la app desarrollada en
base al openFWPA y que será el encargado de gestionar desde el cliente las llamadas a las
diferentes operaciones soportadas por el gestor mediante invocaciones a los diferentes
métodos proporcionados por el servicio web DocSgdService. El acceso desde este
componente al servicio web se podrá configurar en el archivo wsMCD.properties. Entre
las diferentes posibilidades que pone a disposición del desarrollador dicho fichero de
configuración está la de determinar si el acceso al servicio se realizará de forma directa o
necesitará un “descubrimiento” via servidor UDDI.
Docmgmt-ws: Es el componente encargado del despliegue del servicio web. Este
elemento tendrá acceso a una BBDD (Mysql…) donde se almacenará información maestra
relativa al MCD.
o Docmgmt-service: Se trata del núcleo del servicio web. Estará embebido en el
Docmgmt-ws y su principal función será la de realizar las llamadas vía proxy al
gestor documental seleccionado: Alfresco, Sharepoint,...
Gestor documental: Será el sistema encargado del correcto almacenamiento y gestión de
los documentos utilizados. Los responsables técnicos del proyecto deberán seleccionar el
gestor deseado y la forma en que interactuará con el resto del módulo. Se recomienda que
el acceso al gestor documental se realice mediante el uso de un proxy incrustando dentro
del componente Docmgmt-service.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 8 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
2.2. Alcance de la aplicación
A continuación se describen, a modo de lista, las diferentes operaciones que permite realizar el
módulo:
Almacenar documento/s
Modificar documento
Modificar datos de un documento
Eliminar documento
Recuperar documento/s
Recuperar datos de uno o varios documentos
Recuperar identificadores de documentos
Recuperar identificadores de documentos avanzado
Buscar documentos
Buscar documentos avanzado
Recuperar versiones de un documento
Restaurar versión de un documento
Añadir firmas a un documento
Recuperar firmas de un documento
Recuperar documentos de firma
Copiar documento
Recuperar copias de un documento
Crear enlace de un documento
Recuperar enlaces de documento
Archivar documento
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 9 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
3. FUNCIONALIDADES
3.1. Almacenar documento
Servicio que permite almacenar un documento en el SGD, este documento será almacenado
automáticamente en la estructura de espacios del Gestor Documental en función del usuario que realiza
la operación y los metadatos del documento. En caso de que se produzca un error durante la creación
del documento, la operación será deshecha, dejando el SGD en el estado anterior a la ejecución de la
operación.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Datos erróneos: los metadatos del documento suministrados no son válidos
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de
“Almacenar documento” son:
TDocumento: objeto de petición de almacenar documento
TDocumentoDatos: objeto con los datos del documento almacenado
3.2. Modificar documento
Servicio que permite modificar un documento almacenado en el SGD, el documento se ubicará
automáticamente en la estructura de espacios del Gestor Documental en función de los valores de los
metadatos. En caso de que se produzca un error durante la modificación del documento, la operación
será deshecha, dejando el SGD en el estado anterior a la ejecución de la operación.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Datos erróneos: los metadatos del documento suministrados no son válidos.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para modificar el documento.
Estado incorrecto: el documento está marcado como solo lectura o firmado y no puede ser
modificado.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Modificar
documento” son:
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 10 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
TDocumento: objeto de petición de modificar un documento ya almacenado
TDocumentoDatos: objeto con los datos del documento almacenado modificado
Los objetos de petición y respuesta utilizados son los mismos que en el caso anterior.
3.3. Modificar datos de un documento
Servicio que permite modificar los metadatos de un documento almacenado en el SGD, los
documentos se ubicarán automáticamente en la estructura de espacios del Gestor Documental en
función de los valores de los metadatos. En caso de que se produzca un error durante la modificación
del documento, la operación será deshecha, dejando el SGD en el estado anterior a la ejecución de la
operación.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Datos erróneos: los metadatos del documento suministrados no son válidos.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para modificar el documento.
Estado incorrecto: el documento está marcado como solo lectura o firmado y no puede ser
modificado.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Modificar
datos de un documento” son:
TDocumentoDatos: objeto de petición de modificar los datos de un documento ya
almacenado
TDocumentoDatos: objeto con los datos del documento almacenado modificados
Se utilizará el mismo objeto para la entrada que para la salida, ya que se le proporcionan unos datos y
esos mismos datos son los que se nos devuelven una vez modificados.
3.4. Eliminar documento
Servicio que permite eliminar un documento almacenado en el SGD. Esta operación implica eliminar
los metadatos y el contenido del documento, así como las firmas asociadas al documento en caso de
existir. En caso de que se produzca un error durante el borrado del documento, la operación será
deshecha, dejando el SGD en el estado anterior a la ejecución de la operación.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 11 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para eliminar el documento.
Estado incorrecto: el documento está marcado como solo lectura y no puede ser eliminado.
Dependencias: el documento tiene dependencias (copias o accesos directos) y no puede ser
eliminado hasta que no se borren estas.
Los objetos usados en la petición en la funcionalidad de “Eliminar documento” es:
String: cadena con el identificador del documento a eliminar
El objeto de petición utilizado en este caso es una cadena de texto, no habrá objeto de respuesta, si
algo ha ido mal saltará una excepción.
3.5. Recuperar documento
Servicio que permite recuperar un documento almacenado en el SGD a partir de su identificador.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para eliminar el documento.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Recuperar
documento” son:
String: cadena con el identificador del documento a recuperar
TDocumento: objeto de respuesta de recuperar un documento ya almacenado
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento a
recuperar. El objeto de respuesta utilizado es el mismo que el objeto de entrada de almacenar
documento, es decir, será un objeto de la clase TDocumento.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 12 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
3.6. Recuperar datos de un documento
Servicio que permite recuperar los metadatos de un documento almacenado en el SGD a partir del
identificador.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para eliminar el documento.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Recuperar
datos de un documento” son:
String: cadena con el identificador del documento a recuperar.
TDocumentoDatos: objeto de respuesta de recuperar los datos de un documento ya
almacenado
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento
del que se quieren recuperar los datos. El objeto de respuesta utilizado será un objeto de la clase
TDocumentoDatos.
3.7. Buscar documentos
Servicio que retorna un conjunto configurable de metadatos de los documentos que cumplen los
criterios suministrados, estos criterios pueden ser definidos de manera más compleja que en la
operación básica, siendo posible utilizar operadores para aplicar a los pares de dato valor. Por motivos
de rendimiento se limitará la cantidad de documentos que retorna esta función.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Datos erróneos: los metadatos del documento suministrados no son válidos.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Buscar
documentos” son:
TBuscarDocumentos: objeto de entrada con las opciones de búsqueda de documentos.
TListaDocumentosAtributos: objeto de respuesta de recuperar para buscar documentos.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 13 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
El objeto de respuesta utilizado será un objeto de la clase TListaDocumentosAtributos, que será una
lista con las listas de atributos de los documentos buscados.
3.8. Crear versión de un documento
Servicio que permite modificar un documento almacenado en el SGD, creando una nueva versión de
este. En caso de que se produzca un error durante la modificación del documento, la operación será
deshecha, dejando el SGD en el estado anterior a la ejecución de la operación.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Datos erróneos: los metadatos del documento suministrados no son válidos.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para modificar el documento.
Estado incorrecto: el documento está marcado como solo lectura o firmado y no puede ser
modificado.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Crear
versión de un documento” son:
String: cadena con el identificador del documento del que se quiere crear la versión.
TDocumentoDatos: objeto de respuesta de la creación de una versión de un documento ya
almacenado
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento
del que se quiere crear la versión. El objeto de respuesta utilizado será un objeto de la clase
TDocumentoDatos.
3.9. Recuperar versiones de un documento
Servicio que retorna los metadatos de todas las versiones de un documento.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para eliminar el documento.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 14 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Recuperar
versiones de un documento” son:
String: cadena con el identificador del documento del que se quiere crear la versión.
TListaDocumentoDatos: objeto de respuesta que representa una lista con los datos de las
diferentes versiones del documento consultado.(TDocumentoDatos)
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento
del que se quieren recuperar los datos. El objeto de respuesta utilizado será un objeto de la clase
TListaDocumentoDatos que es una lista de TDocumentoDatos.
3.10. Restaurar versión de un documento
Servicio que establece una versión de un documento como vigente. Para establecer esta versión como
vigente, elimina todas las versiones posteriores.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Datos erróneos: los metadatos del documento suministrados no son válidos.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para modificar el documento.
Estado incorrecto: el documento está marcado como solo lectura o firmado y no puede ser
modificado.
El objeto usado en la petición en la funcionalidad de “Recuperar versiones de un documento” es:
TVersionDocumento: objeto con la versión de un documento que se quiere restaurar.
El objeto de petición utilizado en este caso es un objeto con la versión del documento a restaurar, no
habrá objeto de respuesta, si algo ha ido mal saltará una excepción.
3.11. Añadir firmas a un documento
Servicio que almacena las firmas de un documento en el SGD. Las firmas se crearán como contenidos
del Gestor Documental relacionados con el documento que firman.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 15 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
Datos erróneos: los metadatos del documento suministrados no son válidos.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para modificar el documento.
Estado incorrecto: el documento está marcado como solo lectura o firmado y no puede ser
modificado.
El objeto usado en la petición en la funcionalidad de “Añadir firmas a un documento” es:
TFirmasDocumento: objeto con las firmas a añadir al documento y el identificador del
documento.
El objeto de petición utilizado en este caso es un objeto con la firma o las firmas que se quieren añadir
a un documento, no habrá objeto de respuesta, si algo ha ido mal saltará una excepción.
3.12. Recuperar firmas de un documento
Servicio que recupera las firmas de un documento.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para eliminar el documento.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Recuperar
firmas de un documento” son:
String: cadena con el identificador del documento del que se quieren obtener las firmas.
TListaFirmasDocumento: objeto de respuesta que representa una lista con las firmas del
documento consultado.(TFirmasDocumento)
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento
del que se quieren recuperar los datos. El objeto de respuesta utilizado será un objeto de la clase
TListaFirmasDocumento que es una lista de TFirmasDocumento.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 16 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
3.13. Recuperar documentos por firma
Servicio que recupera documentos que tienen al menos una firma con los criterios de búsqueda
suministrados. Por motivos de rendimiento se limitará la cantidad de documentos que retorna esta
función.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para eliminar el documento.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Recuperar
documentos de firma” son:
TListaAtributos: objeto de respuesta que representa una lista con los atributos necesarios
para recuperar los documentos de firma.(TAtributos)
TListaDocumentoDatos: objeto de respuesta que representa una lista con los datos
recuperados.(TDocumentoDatos)
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento
del que se quieren crear la copia. El objeto de respuesta utilizado será un objeto de la clase
TDocumentoDatos.
3.14. Copiar documento
Servicio que crea una copia del documento, este documento será almacenado automáticamente en la
estructura de espacios del Gestor Documental en función del usuario que realiza la operación y los
metadatos del documento. El contenido de los documentos será independiente.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Datos erróneos: los metadatos del documento suministrados no son válidos.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para modificar el documento.
Estado incorrecto: el documento está marcado como solo lectura o firmado y no puede ser
modificado.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 17 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Copiar
Documento” son:
String: cadena con el identificador del documento del que se quiere hacer una copia.
TDocumentoDatos: objeto de respuesta de la creación de una copia de un documento ya
almacenado.
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento
del que se quieren crear la copia. El objeto de respuesta utilizado será un objeto de la clase
TDocumentoDatos.
3.15. Copiar documento para impresión
Servicio que crea una copia del documento, este documento será almacenado automáticamente en la
estructura de espacios del Gestor Documental en función del usuario que realiza la operación y los
metadatos del documento. El SGD utilizará el Módulo Común de Certificados para obtener el código
de verificación y el fichero con dicho código sobreimpreso que puede ser utilizado para imprimir.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Datos erróneos: los metadatos del documento suministrados no son válidos.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para modificar el documento.
Estado incorrecto: el documento está marcado como solo lectura o firmado y no puede ser
modificado.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Copiar
Documento de impresión” son:
String: cadena con el identificador del documento del que se quiere hacer una copia.
TDocumentoDatos: objeto de respuesta de la creación de un documento de impresión a partir
de un documento ya almacenado.
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento
del que se quieren crear la copia. El objeto de respuesta utilizado será un objeto de la clase
TDocumentoDatos.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 18 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
3.16. Recuperar copias de un documento
Servicio que recupera todas las copias realizadas a partir de un documento.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para eliminar el documento.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Recuperar
enlaces de un documento” son:
String: cadena con el identificador del documento del que se quiere recuperar los enlaces.
TListaDocumentoDatos: objeto de respuesta que representa una lista con los datos de los
diferentes enlaces recuperados.(TDocumentoDatos)
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento
del que se quieren recuperar los enlaces. El objeto de respuesta utilizado será un objeto de la clase
TListaDocumentoDatos que es una lista de TDocumentoDatos.
3.17. Crear enlace a un documento
Servicio que crea un acceso directo a un documento almacenado en el sistema, este acceso directo será
almacenado automáticamente en la estructura de espacios del Gestor Documental en función del
usuario que realiza la operación y los metadatos del documento. Tendrá metadatos independientes pero
utilizará el mismo fichero de contenido.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Datos erróneos: los metadatos del documento suministrados no son válidos.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para modificar el documento.
Estado incorrecto: el documento está marcado como solo lectura o firmado y no puede ser
modificado.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Crear
enlace de un documento” son:
String: cadena con el identificador del documento del que se quiere crear el enlace.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 19 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
TDocumentoDatos: objeto de respuesta de la creación de un enlace de un documento ya
almacenado
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento
del que se quieren crear el enlace. El objeto de respuesta utilizado será un objeto de la clase
TDocumentoDatos.
3.18. Recuperar enlaces de documento
Servicio que recupera todos los accesos directos de un documento.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Documento no encontrado: el documento no se encuentra en el SGD.
Permisos insuficientes: el usuario no tiene permisos para eliminar el documento.
Los objetos usados en la petición y en la respuesta, respectivamente, en la funcionalidad de “Recuperar
enlaces de un documento” son:
String: cadena con el identificador del documento del que se quiere recuperar los enlaces.
TListaDocumentoDatos: objeto de respuesta que representa una lista con los datos de los
diferentes enlaces recuperados.(TDocumentoDatos)
El objeto de petición utilizado en este caso es una cadena de texto con el identificador del documento
del que se quieren recuperar los enlaces. El objeto de respuesta utilizado será un objeto de la clase
TListaDocumentoDatos que es una lista de TDocumentoDatos.
3.19. Archivar documento
Servicio que mueve todas las copias y enlaces de un documento de aquellos espacios en los que se
encuentren al espacio de archivo. En el caso de que se el documento esté marcado como documento
auxiliar este será borrado del sistema.
Se pueden producir los siguientes casos de error:
Error de validación del usuario: el usuario no existe en el gestor documental o las
credenciales suministradas no son válidas.
Datos erróneos: los metadatos del documento suministrados no son válidos.
Documento no encontrado: el documento no se encuentra en el SGD.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 20 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
Permisos insuficientes: el usuario no tiene permisos para modificar el documento.
Estado incorrecto: el documento está marcado como solo lectura o firmado y no puede ser
modificado.
Los objetos usados en la petición en la funcionalidad de “Archivar documento” es:
String: cadena con el identificador del documento a eliminar
El objeto de petición utilizado en este caso es una cadena de texto, no habrá objeto de respuesta, si
algo ha ido mal saltará una excepción.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 21 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
4. DEFINICIÓN DE TIPOS DE DATOS.
4.1. TDocumento
El objeto TDocumento es un objeto utilizado para encapsular toda la información que se envía al
servicio. Este objeto tiene los siguientes atributos:
TDocumentoDatos datos: datos relativos al documento. Ver apartado “TDocumentoDatos”.
TDocumentoFichero fichero: datos relativos al fichero. Ver apartado
“TDocumentoFichero”.
4.2. TDocumentoFichero
El objeto TDocumentoFichero es un objeto utilizado para encapsular toda la información del fichero a
almacenar. Este objeto tiene los siguientes atributos:
String nombre: cadena con el nombre del fichero.
String mimeType: cadena de texto con el mimetype del fichero.
Byte [] contenido: Array de bytes con el contenido del fichero a almacenar
4.3. TDocumentoDatos
El objeto TDocumentoDatos es un objeto utilizado para almacenar datos del fichero a almacenar o de
un fichero almacenado. Este objeto tiene los siguientes atributos:
TDocumentoDatosIdentificativos datosIdentificativos: datos identificativos del
documento a almacenar. Ver apartado “TDocumentoDatosIdentificativos”.
TDocumentoDatosDescriptivos datosDescriptivos: datos descriptivos del documento a
almacenar. Ver apartado “TDocumentoDatosDescriptivos”.
TDocumentoDatosControlAccesos datosControlAccesos: datos de control de acceso del
documento a almacenar. Ver apartado “TDocumentoControlAccesos”.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 22 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
TDocumentoDatosTrazabilidad datosTrazabilidad: datos de trazabilidad del documento a
almacenar. Ver apartado “TDocumentoDatosTrazabilidad”.
TDocumentoDatosCopia datosCopia: datos de copia del documento a almacenar. Ver
apartado “TDocumentoDatosCopia”.
TDocumentoDatosRelacion datosRelacion: datos de relación del documento a almacenar.
Ver apartado “TDocumentoDatosRelacion”.
TDocumentoDatosDigitalizacion datosDigitalizacion: datos de digitalización del
documento a almacenar. Ver apartado “TDocumentoDatosDescriptivos”.
TDocumentoDatosRegistro datosRegistro: datos de registro del documento a almacenar.
Ver apartado “TDocumentoDatosRegistro”.
TDocumentoDatosTramitacion datosTramitacion: datos de tramitación del documento a
almacenar. Ver apartado “TDocumentoDatosTramitacion”.
TDocumentoDatosArchivo datosArchivo: datos de archivo del documento a almacenar. Ver
apartado “TDocumentoDatosArchivo”.
4.4. TDocumentoDatosIdentificativos
El objeto TDocumentoDatosIdentificativos es un objeto utilizado para almacenar datos identificativos
del fichero a almacenar o de un fichero almacenado. Este objeto tiene los siguientes atributos:
String uuid: cadena de texto con el identificador del fichero.
String version: cadena de texto con la versión del fichero.
String nombre: cadena de texto con el nombre del fichero.
String estado: cadena de texto con el estado del fichero.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 23 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
4.5. TDocumentoDatosDescriptivos
El objeto TDocumentoDatosDescriptivos es un objeto utilizado para almacenar datos descriptivos del
fichero a almacenar o de un fichero almacenado. Este objeto tiene los siguientes atributos:
String titulo: cadena de texto con el título del fichero.
String asunto: cadena de texto con el asunto del fichero.
String familia: cadena de texto con la familia del fichero.
String agrupacion: cadena de texto con la agrupación del fichero.
String tipoDocumental: cadena de texto con el tipo documental del fichero.
String descripcionTipoDocumental: cadena de texto con la descripción del tipo
documental del fichero.
String [] palabrasClave: conjunto de palabras clave del fichero.
String [] autores: conjunto de autores del fichero.
Boolean documentoAuxiliar: bandera booleana para indicar si se el documento es
auxiliar o no.
TIdioma [] idiomas: conjunto de idiomas del fichero. Ver apartado “TIdioma” para entrar
en detalle de cada idioma.
TFormatoFichero formato: objeto que encapsula el formato del fichero a almacenar o
almacenado. Ver apartado “TFormatoFichero”.
TEntornoTecnico entornoTecnico: objeto que encapsula el entorno técnico del fichero a
almacenar o almacenado. Ver apartado “TEntornoTecnico”.
4.6. TDocumentoDatosControlAccesos
El objeto TDocumentoDatosControlAccesos es un objeto utilizado para almacenar datos de control de
accesos del fichero a almacenar o de un fichero almacenado. Este objeto tiene los siguientes atributos:
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 24 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
String sistemaPropietario: cadena de texto con el sistema propietario del fichero.
Boolean editable: bandera booleana para indicar si se el fichero es editable o no.
4.7. TDocumentoDatosTrazabilidad
El objeto TDocumentoDatosTrazabilidad es un objeto utilizado para almacenar datos de trazabilidad
del fichero a almacenar o de un fichero almacenado. Este objeto tiene los siguientes atributos:
TNivelLOPD nivelLOPD: objeto que encapsula el nivel de la LOPD cumplido por el fichero.
Ver apartado “TNivelLOPD”.
Boolean auditable: bandera booleana para indicar si se el documento es auditable o no.
String creador: cadena de texto con el creador del fichero.
Calendar fechaCreacion: fecha de creación del fichero.
String modificador: cadena de texto con el modificador del fichero.
Calendar fechaModificacion: fecha de modificación del fichero.
Boolean documentoAuxiliar: bandera booleana para indicar si se el documento es
auxiliar o no.
4.8. TDocumentoDatosCopia
El objeto TDocumentoDatosCopia es un objeto utilizado para almacenar datos de copia del fichero a
almacenar o de un fichero almacenado. Este objeto tiene los siguientes atributos:
String documentoOriginal: cadena de texto con la referencia al documento original.
Calendar fechaCopia: fecha de copia del fichero.
String autorCopia: cadena de texto con la copia del fichero.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 25 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
String codigoVerificacion: cadena de texto con el código de verificación.
TTipoCopia tipoCopia: objeto que encapsula el tipo de copia del fichero a almacenar o
almacenado. Ver apartado “TTipoCopia”.
4.9. TDocumentoDatosRelacion
El objeto TDocumentoDatosRelacion es un objeto utilizado para almacenar datos de relación del
fichero a almacenar o de un fichero almacenado. Este objeto tiene los siguientes atributos:
String documentoRelacionado: cadena de texto con la referencia al documento
relacionado.
String tipoRelacion: cadena de texto con el tipo de relación entre dos documentos. Sólo
son válidos los valores que están definidos en la tabla de validación asociada
String autorRelacion: cadena de texto con el autor de la relación entre los ficheros.
Calendar fechaRelacion: fecha de relación entre ficheros.
4.10. TDocumentoDatosDigitalizacion
El objeto TDocumentoDatosDigitalización es un objeto utilizado para almacenar datos de
digitalización del fichero a almacenar o de un fichero almacenado. Este objeto tiene los siguientes
atributos:
Calendar fechaDigitalizacion: fecha de digitalización entre ficheros.
TOriginalIncompleto originalIncompleto: objeto que encapsula el original incompleto
del fichero a almacenar o almacenado. Ver apartado “TOriginalIncompleto”.
TFuenteOriginal fuenteOriginal: objeto que encapsula la fuente original del fichero a
almacenar o almacenado. Ver apartado “TFuenteOriginal”.
TCalidadOriginal calidadOriginal: objeto que encapsula la calidad del fichero original a
almacenar o almacenado. Ver apartado “TCalidadOriginal”.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 26 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
TCustodiaOriginal custodiaOriginal: objeto que encapsula la custodia original del
fichero a almacenar o almacenado. Ver apartado “TCustodiaOriginal”.
String operarioDigitalizacion: cadena de texto con el operario de digitalización.
String softwareDigitalizacion: cadena de texto con el software de digitalización
String parametrosDigitalizacion: cadena de texto con los parámetros de
digitalización.
4.11. TDocumentoDatosRegistro
El objeto TDocumentoDatosRegistro es un objeto utilizado para almacenar datos de registro del
fichero a almacenar o de un fichero almacenado. Este objeto tiene los siguientes atributos:
String tipoRegistro: cadena de texto con el tipo de registro del documento. Sólo son
válidos los valores que están definidos en la tabla de validación asociada
Calendar fechaRegistro: fecha de registro del documento
BigInteger numeroRegistro: número de registro del documento.
4.12. TDocumentoDatosTramitacion
El objeto TDocumentoDatosTramitacion es un objeto utilizado para almacenar datos de tramitación
del fichero a almacenar o de un fichero almacenado. Este objeto tiene los siguientes atributos:
String procedimiento: cadena de texto con el procedimiento de tramitación.
String numeroExpediente: cadena de texto con el número de expediente.
String entidad: cadena de texto con la entidad.
String idDepartamento: cadena de texto con el identificador del departamento
String departamento: cadena de texto con el departemento
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 27 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
4.13. TDocumentoDatosArchivo
El objeto TDocumentoDatosÇArchivo es un objeto utilizado para almacenar datos de archivo del
fichero a almacenar o de un fichero almacenado. Este objeto tiene los siguientes atributos:
Calendar fechaArchivo: fecha de archivo.
String serie: cadena de texto con el número de serie.
String numeroExpedienteArchivo: cadena de texto con el número de expediente del
archivo
4.14. TDocumentosDatosFirma
El objeto TDocumentosDatosFirma es un objeto utilizado para hacer referencia a los datos de firma de
un documento. Este objeto tiene los siguientes atributos:
BigInteger idFirmante: identificador del firmante.
String documentoFirmante: cadena de texto con el identificador del documento firmante.
String nombreFirmante: cadena de texto con nombre del firmante.
Calendar fechaFirma: fecha en la que se produce la firma.
String entidadesFirmadas: cadena de texto con las entidades firmadas.
String tipoFirma: cadena de texto con el tipo de firma. Sólo son válidos los valores que
están definidos en la tabla de validación asociada.
String entidadEmisora: cadena de texto con la entidad emisora del certificado con el que
se firma.
Calendar caducidad: fecha en la que se produce la caducidad de la firma.
String formatoFirma: cadena de texto con el formato de firma. Sólo son válidos los
valores que están definidos en la tabla de validación asociada.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 28 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
Byte [] firma: contenido de la firma.
4.15. TIdioma
El objeto TIdioma es un objeto utilizado para hacer referencia a los datos de un idioma. Este objeto
tiene los siguientes atributos:
String nombre: cadena de texto con el nombre del idioma.
String descripcion: cadena de texto con la descripción del idioma.
4.16. TFormatoFichero
El objeto TFormatoFichero es un objeto utilizado para hacer referencia a los datos de un formato. Este
objeto tiene los siguientes atributos:
String nombre: cadena de texto con el nombre del formato.
String descripcion: cadena de texto con la descripción del formato.
4.17. TEntornoTecnico
El objeto TEntornoTecnico es un objeto utilizado para hacer referencia a los datos de un entorno
técnico. Este objeto tiene los siguientes atributos:
String nombre: cadena de texto con el nombre del entorno técnico.
String descripcion: cadena de texto con la descripción del entorno técnico.
4.18. TNivelLOPD
El objeto TNivelLOPD es un objeto utilizado para hacer referencia a los datos del nivel de la LOPD.
Este objeto tiene los siguientes atributos:
String nombre: cadena de texto con el nombre del nivel de la LOPD.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 29 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
String descripcion: cadena de texto con la descripción del nivel de la LOPD.
4.19. TTipoCopia
El objeto TTipoCopia es un objeto utilizado para hacer referencia a los datos del tipo de copia. Este
objeto tiene los siguientes atributos:
String nombre: cadena de texto con el nombre del tipo de copia.
String descripcion: cadena de texto con la descripción del tipo de copia.
4.20. TOriginalIncompleto
El objeto TOriginalIncompleto es un objeto utilizado para hacer referencia a los datos del original
incompleto. Este objeto tiene los siguientes atributos:
String nombre: cadena de texto con el nombre del original incompleto.
String descripcion: cadena de texto con la descripción del original incompleto.
4.21. TFuenteOriginal
El objeto TFuenteOriginal es un objeto utilizado para hacer referencia a los datos de la fuente original.
Este objeto tiene los siguientes atributos:
String nombre: cadena de texto con el nombre de la fuente original.
String descripcion: cadena de texto con la descripción de la fuente original.
4.22. TCalidadOriginal
El objeto TCalidadOriginal es un objeto utilizado para hacer referencia a los datos de la calidad
original. Este objeto tiene los siguientes atributos:
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 30 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
String nombre: cadena de texto con el nombre de la calidad original.
String descripcion: cadena de texto con la descripción de la calidad original.
4.23. TCustodiaOriginal
El objeto TCustodiaOriginal es un objeto utilizado para hacer referencia a los datos de la custodia
original. Este objeto tiene los siguientes atributos:
String nombre: cadena de texto con el nombre de la custodia original.
String descripcion: cadena de texto con la descripción de la custodia original.
4.24. TVersionDocumento
El objeto TVersionDocumento es un objeto utilizado para hacer referencia a la versión de un
documento original. Este objeto tiene los siguientes atributos:
String identificadorDocumento: cadena de texto con el identificador del documento.
String identificadorVersion: cadena de texto con el identificador de la versión.
4.25. TFirmasDocumento
El objeto TFirmasDocumento es un objeto utilizado para hacer referencia a un documento firmado.
Este objeto tiene los siguientes atributos:
String identificadorDocumento: cadena de texto con el identificador del documento.
TDocumentosDatosFirma [] firmasDocumento: conjunto de firmas del documento. Ver
apartado “TDocumentosDatosFirma”.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 31 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
4.26. TBuscarDocumentos
El objeto TBuscarDocumentos es un objeto utilizado para hacer búsquedas de documentos. Este objeto
tiene los siguientes atributos:
String [] metadatosRespuesta: colección de cadenas de texto con los metadatos.
Boolean incluirVersiones: valor booleano que nos indica si en la búsqueda se incluirán
versiones o no.
BigInteger maxDocumentos: valor numérico que indica el número máximo de
documentos.
TCondicion [] valoresBusqueda: colección de los valores a buscar. Ver apartado
“TCustodiaOriginal”.
4.27. TCondicion
El objeto TCondicion es un objeto utilizado para hacer referencia a las condiciones. Este objeto tiene
los siguientes atributos:
TAtributo atributo: objeto atributo con el valor de la condición.
TOperadorBusqueda operador: objeto usado para guardar el operador de búsqueda.
4.28. TAtributo
El objeto TAtributo es un objeto utilizado para hacer referencia a los atributos del servicio. Este objeto
tiene los siguientes atributos:
String clave: cadena de texto con la clave o nombre del atributo.
String valor: cadena de texto con el valor del atributo, irá asociado a una clave.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 32 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
4.29. TOperadorBusqueda
El objeto TOperadorBusqueda es un objeto utilizado para hacer referencia al operador en una
búsqueda de documentos. Este objeto tiene los siguientes atributos:
String value: cadena de texto con el valor del operador.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 33 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
5. USO DEL MCD EN UNA APLICACIÓN CON OPENFWPA
Para facilitar a las aplicaciones la utilización del servicio web, se proporcionará la librería docmgmt-
proxy-3.x.jar .
Si no se dispusiese de este cliente será necesario regenerarlo a partir del fichero WSDL. Los pasos a
seguir en este caso serían los siguientes:
1. Configurar Maven.
2. Acceder al proyecto docmgmt-ws-proxy
3. Verificar el contenido del fichero pom.xml, comprobando que se está apuntando al archivo
WSDL correcto.
<sourceDirectory>
${pom.basedir}/../docmgmt-ws/src/main/wsdl
</sourceDirectory>
<wsdlFiles>
<wsdlFile>sgd.wsdl</wsdlFile>
</wsdlFiles>
4. Generar el .jar mediante la instrucción mvn::install o similar.
Una vez generado el cliente, el siguiente paso sería verificar y modificar si fuese necesario el archivo
wsMCD.properties.
Este archivo de configuración estará situado junto al resto de archivos de configuración de la app
openFWPA, y está compuesto por la siguiente información:
Nombre Descripción
urlRegistry URL del registro a través del cual se buscará el
proceso.
nameService Nombre del proceso en el registro.
versionService Versión del proceso en el registro
username
Nombre de usuario a insertar en la cabecera de
seguridad de la llamada al proceso.
password Contraseña a insertar en la cabecera de seguridad de
la llamada al proceso.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 34 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
5.1. Fichero wsMCD.properties
Un ejemplo del fichero de propiedades sería:
URL_REGISTRY=http://ipmaquinadespliegueuddi/registry/uddi/inquiry
SERVICE_USER=XXXXX
SERVICE_PASSWORD=XXXXX
SERVICE_NAME=DogSgdService
SERVICE_VERSION=3.0
USE_UDDI=TRUE
DIRECT_ENDPOINT=
El parámetro USE_UDDI en valor TRUE fuerza que las llamadas se realicen a través de un Servidor
UDDI. Si por algún motivo no se desease hacer uso del descubrimiento del servicio y atacar
directamente a la dirección donde esté desplegado, se configurarían los siguientes parámetros en este
fichero:
URL_REGISTRY=
SERVICE_USER=
SERVICE_PASSWORD=
SERVICE_NAME=
SERVICE_VERSION=
USE_UDDI=FALSE
DIRECT_ENDPOINT=http://ipmaquinadespliegeservicio/wsMCD/services/DocSgdService
Donde DIRECT_ENDPOINT sería la ubicación final del servicio de gestión documental.
5.2. Ejemplos de llamada al servicio
5.2.1. Credenciales
Todas las llamadas a los servicios documentales incluyen credenciales específicas del sistema de
gestión documental. Estas credenciales contienen la siguiente información:
SISTEMA Obligatorio Sistema originador de la llamada. Se corresponde con un usuario en
el gestor documental
PASSWORD Obligatorio Password del sistema originador de la llamada, es decir, del usuario
en el gestor documental.
USERNAME Opcional Usuario del sistema que realiza la llamada. Se utiliza para
operaciones de auditoría.
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 35 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
public SgdCredentialsVO getCredentials() {
return new SgdCredentialsVO("registroES", "xxxxxxx", "E11111111H");
}
5.2.1.1. Ejemplo de uso: “Almacenar documento/s”
Almacenar documento no procedimentado
TDocumentoFichero fichero = new TDocumentoFichero("test.pdf",
"application/pdf", FileUtils.readFileToByteArray(new File("test.pdf")));
TDocumentoDatos datos = new TDocumentoDatos();
TDocumentoDatosIdentificativos datosIdentificativos =
new TDocumentoDatosIdentificativos();
datosIdentificativos.setNombre("Mi documento de prueba");
datos.setDatosIdentificativos(datosIdentificativos);
TDocumento documento = new TDocumento(datos, fichero);
TDocumentoDatos response = _proxy.almacenarDocumento(documento,
getCredentials());
Almacenar documento de registro
TDocumentoFichero fichero = new TDocumentoFichero("test.txt", "text/plain",
FileUtils.readFileToByteArray(new File("remesa-no-
digitalizada.txt")));
TDocumentoDatos datos = new TDocumentoDatos();
TDocumentoDatosIdentificativos datosIdentificativos = new
TDocumentoDatosIdentificativos();
datosIdentificativos.setNombre("Mi documento de registro");
TNaturalezaDocumento naturaleza = new TNaturalezaDocumento();
naturaleza.setNombre("ELECTRONICO");
TOrigenDocumento origen = new TOrigenDocumento();
origen.setNombre("EXTERNO");
datosIdentificativos.setNaturaleza(naturaleza);
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 36 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
datosIdentificativos.setOrigen(origen);
datos.setDatosIdentificativos(datosIdentificativos);
TDocumentoDatosRegistro registro = new TDocumentoDatosRegistro();
registro.setFechaRegistro(Calendar.getInstance());
registro.setNumeroRegistro(new BigInteger("1231231313"));
registro.setTipoRegistro("E");
datos.setDatosRegistro(registro);
TDocumentoDatosTrazabilidad datosTrazabilidad = new TDocumentoDatosTrazabilidad();
datosTrazabilidad.setAuditable(Boolean.TRUE);
datosTrazabilidad.setCreador("TEST");
datosTrazabilidad.setModificador("TEST");
Calendar cal = Calendar.getInstance();
cal.setTime(new Date());
datosTrazabilidad.setFechaCreacion(cal);
datosTrazabilidad.setFechaModificacion(cal);
TNivelLOPD lopd = new TNivelLOPD();
lopd.setNombre("ALTO");
datosTrazabilidad.setNivelLOPD(lopd);
datos.setDatosTrazabilidad(datosTrazabilidad);
TDocumento documento = new TDocumento(datos, fichero);
TDocumentoDatos response = _proxy.almacenarDocumento(documento,
getCredentials());
Almacenar documento de tramitación
TDocumentoFichero fichero = new TDocumentoFichero("test.pdf",
"application/pdf", FileUtils.readFileToByteArray(new File(
TEST_DIR + "out.pdf")));
TDocumentoDatos datos = new TDocumentoDatos();
TDocumentoDatosIdentificativos datosIdentificativos = new
TDocumentoDatosIdentificativos();
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 37 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
datosIdentificativos.setNombre("Mi documento de prueba");
datos.setDatosIdentificativos(datosIdentificativos);
TDocumentoDatosTramitacion tramitacion = new TDocumentoDatosTramitacion();
tramitacion.setNumeroExpediente("99999/120123");
tramitacion.setProcedimiento("Procedimiento");
tramitacion.setEntidad("Entidad");
tramitacion.setIdDepartamento("123");
tramitacion.setDepartamento("Mi departamento");
datos.setDatosTramitacion(tramitacion);
TDocumento documento = new TDocumento(datos, fichero);
TDocumentoDatos response = _proxy.almacenarDocumento(documento,
getCredentials());
5.2.1.2. Ejemplo de uso: “Modificar documento”
TDocumento documento = new TDocumento();
TDocumentoDatos datos = new TDocumentoDatos();
TDocumentoDatosIdentificativos datosIdentificativos = new
TDocumentoDatosIdentificativos();
datosIdentificativos.setUuid("48967e68-4fc1-4b8b-a5e7-c750b0f54d5b");
datosIdentificativos.setNombre("barbacoa.pdf");
datos.setDatosIdentificativos(datosIdentificativos);
TDocumentoFichero fichero = new TDocumentoFichero("barbacoa.pdf",
"application/pdf", FileUtils.readFileToByteArray(new File(
TEST_DIR + "barbacoa.pdf")));
documento.setFichero(fichero);
documento.setDatos(datos);
_proxy.modificarDocumento(documento, getCredentials());
5.2.1.3. Ejemplo de uso: “Modificar datos de un documento”
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 38 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
TDocumentoDatos datos = new TDocumentoDatos();
TDocumentoDatosIdentificativos datosIdentificativos = new
TDocumentoDatosIdentificativos();
datosIdentificativos.setUuid("48967e68-4fc1-4b8b-a5e7-c750b0f54d5b");
datosIdentificativos.setNombre("Mi documento.pdf");
datos.setDatosIdentificativos(datosIdentificativos);
TDocumentoDatosTramitacion tramitacion = new TDocumentoDatosTramitacion();
tramitacion.setNumeroExpediente("99999/120123");
tramitacion.setProcedimiento("Procedimiento");
tramitacion.setEntidad("Entidad");
tramitacion.setIdDepartamento("123");
tramitacion.setDepartamento("Mi departamento");
datos.setDatosTramitacion(tramitacion);
TDocumentoDatosHolder holder = new TDocumentoDatosHolder(datos);
_proxy.modificarDatosDocumento(holder, getCredentials());
5.2.1.4. Ejemplo de uso: “Eliminar documento”
final String uuid = "48967e68-4fc1-4b8b-a5e7-c750b0f54d5b";
_proxy.eliminarDocumento(uuid, getCredentials());
5.2.1.5. Ejemplo de uso: “Recuperar documento”
final String uuid = "48967e68-4fc1-4b8b-a5e7-c750b0f54d5b";
TDocumento response = _proxy.recuperarDocumento(uuid, getCredentials());
5.2.1.6. Ejemplo de uso: “Recuperar datos de un documento”
final String uuid = "375a3d98-f53b-4adf-91a3-c39d0dfa0f77";
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 39 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
TDocumentoDatos response = _proxy.recuperarDatosDocumento(uuid,
getCredentials());
5.2.1.7. Ejemplo de uso: “Buscar documentos”
TBuscarDocumentos payload = new TBuscarDocumentos();
TCondicion[] valoresBusqueda = new TCondicion[1];
valoresBusqueda[0] = new TCondicion(
new TAtributo("entradaSalida", "E"), TOperadorBusqueda.EQUALS);
payload.setValoresBusqueda(valoresBusqueda);
payload.setMetadatosRespuesta(new String[] {});
TAtributo[][] response = _proxy.buscarDocumentos(payload,
getCredentials());
5.2.1.8. Ejemplo de uso: “Crear versión de un documento”
TDocumentoDatos response = _proxy.crearEnlaceDocumento(
"3335f931-5fbe-43c8-b4a5-d15e1514a5d5", getCredentials());
5.2.1.9. Ejemplo de uso: “Recuperar versiones de un documento”
TDocumentoDatos[] response = _proxy.recuperarVersionesDocumento(
"693a9b2e-d303-47d1-a25f-57f1e877ec38", getCredentials());
for (int i = 0; i < response.length; i++) {
TDocumentoDatos tDocumentoDatos = response[i];
}
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 40 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
5.2.1.10. Ejemplo de uso: “Recuperar firmas de un documento”
TDocumentoDatosFirma[] response = _proxy.recuperarFirmasDocumento(
"e51164e9-7eda-40df-abca-1a85a6ff319f", getCredentials());
for (int i = 0; i < response.length; i++) {
TDocumentoDatosFirma tDocumentoDatos = response[i];
}
5.2.1.11. Ejemplo de uso: “Recuperar documentos de firma”
TAtributo[] atributos = new TAtributo[] { new TAtributo(
"{http://www.asturias.es/model/sgd/1.0}documentoFirmante",
"71634131X") };
TDocumentoDatos[] response = _proxy.recuperarDocumentosPorFirmas(
atributos, getCredentials());
for (int i = 0; i < response.length; i++) {
TDocumentoDatos tDocumentoDatos = response[i];
}
5.2.1.12. Ejemplo de uso: “Copiar documento”
TCopiaDocumento payload = new TCopiaDocumento();
payload.setIdentificadorDocumento("09d63a61-6e40-4a37-86a7-64c05f7f2862");
TDocumentoDatos response = _proxy.copiarDocumento(payload, getCredentials());
5.2.1.13. Ejemplo de uso: “Recuperar copias de un documento”
TDocumentoDatos[] response = _proxy.recuperarCopiasDocumento(
"09d63a61-6e40-4a37-86a7-64c05f7f2862", getCredentials());
Proyecto
OpenFWPA Internacional
Módulo Común de Documentación (MCD)
Página 41 de 41
Estado Definitivo
Documento Manual de Usuario
Cluster TIC (www.clustertic.net) 03. ManualUsuario_MCD_20111230_v1.0.doc 06/09//2010
for (int i = 0; i < response.length; i++) {
TDocumentoDatos tDocumentoDatos = response[i];
}
5.2.1.14. Ejemplo de uso: “Crear enlace de un documento”
TDocumentoDatos response = _proxy.crearEnlaceDocumento(
"3335f931-5fbe-43c8-b4a5-d15e1514a5d5", getCredentials());
5.2.1.15. Ejemplo de uso: “Recuperar enlaces de documento”
TDocumentoDatos[] response = _proxy.recuperarEnlacesDocumento(
"693a9b2e-d303-47d1-a25f-57f1e877ec38", getCredentials());
for (int i = 0; i < response.length; i++) {
TDocumentoDatos tDocumentoDatos = response[i];
}
5.2.1.16. Ejemplo de uso: “Archivar documento”
String uuid = this.createTestDocument();
_proxy.archivarDocumento(uuid, getCredentials());
Top Related