Expediente y Documento Electrónico G-EDE. Documento de...

33
Pastor y Landero, 19 41001 Sevilla (España) tel +34 954 56 25 40 www.guadaltel.com www.gonce.es Plataforma de Tramitación G·ONCE Expediente y Documento Electrónico G-EDE. Documento de diseño técnico cliente: fecha: viernes, 4 de agosto de 2017 versión: 1.6.2 Queda prohibido cualquier tipo de explotación y, en particular, la reproducción, distribución, comunicación pública y/o transformación, total o parcial, por cualquier medio, de este documento sin el previo consentimiento expreso y por escrito de Guadaltel, S.A.

Transcript of Expediente y Documento Electrónico G-EDE. Documento de...

Pastor y Landero, 1941001 Sevilla (España)tel +34 954 56 25 40www.guadaltel.comwww.gonce.es

Plataforma de Tramitación G·ONCE

Expediente y Documento Electrónico G-EDE. Documento de diseño técnico

cliente:

fecha:viernes, 4 de agosto de 2017

versión:1.6.2

Queda prohibido cualquier tipo de explotación y, en particular, la reproducción,distribución, comunicación pública y/o transformación, total o parcial, porcualquier medio, de este documento sin el previo consentimiento expreso y porescrito de Guadaltel, S.A.

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

ÍNDICE DE CONTENIDO

1.Descripción general........................................................................4

2.Catálogo de servicios.....................................................................52.1.Constructor del servício......................................................................................5

2.2.Alta de expedientes............................................................................................5

2.3.Búsqueda de expedientes..................................................................................6

2.4.Obtener metadatos Expediente..........................................................................6

2.5.Actualizar expediente.........................................................................................8

2.6.Eliminar expediente electrónico..........................................................................9

2.7.Crear documento electrónico..............................................................................9

2.8.Asociar documento a expediente.....................................................................10

2.9.Búsqueda de documentos electrónicos............................................................10

2.10.Obtener metadatos de documento electrónico...............................................11

2.11.Actualizar documento electrónico...................................................................11

2.12.Obtener documento electrónico......................................................................12

2.13. Adjuntar firma a documento electrónico........................................................12

2.14.Obtener documentos asociados a un expediente..........................................13

2.15.Eliminar documento de expediente................................................................13

2.16.Eliminar firma de documento electrónico........................................................14

2.17.Eliminar firmas de documento electrónico......................................................14

2.18.Eliminar documento electrónico......................................................................15

2.19.Generar subexpediente de remisión...............................................................16

2.20.Finalizar expediente........................................................................................16

2.21.Obtener tipos documentales de aplicación.....................................................17

2.22.Obtener binario de documento electrónico.....................................................17

2.23.Obtener firmas de documento electrónico......................................................18

2.24.Obtener metadatos de firma electrónica.........................................................18

2.25.Obtener binario de firma electrónica...............................................................18

2.26.Cerrar documento electrónico.........................................................................19

2.27.Consulta nivel qdc..........................................................................................19

2.28.Copiar documentos.........................................................................................20

[ 1.6.2 ] 04/08/17 Pág 2 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

2.29.Actualizar firma del documento electrónico....................................................20

3.Catálogo de servicios web para el almacenamiento simple..........223.1.Obtener un repositorio de una aplicación.........................................................22

3.2.Crear una carpeta en un repositorio.................................................................22

3.3.Crear un binario................................................................................................23

3.4.Actualizar carpeta de un repositorio.................................................................23

4.Diagrama de clases......................................................................244.1.Detalle de las clases.........................................................................................29

[ 1.6.2 ] 04/08/17 Pág 3 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

1. Descripción general

G-EDE es la Plataforma de Gestión de Expediente y Documento Electrónico.

El objetivo principal de G-EDE es informatizar el proceso de gestión de un archivo electrónicobasándose en el uso de gestores documentales como repositorio de documentos yexpedientes.

El funcionamiento del sistema se apoya en la combinación de un sistema de base de datosencargado de gestionar la lógica del archivo electrónico y el uso de gestores documentales,con soporte al estándar CMIS, para el almacenamiento de la información. El uso CMISpermite el acceso a cualquier gestor documental que soporte dicho estándar sin necesidad demodificar el sistema.

G-EDE ofrece un conjunto de servicios web que permiten a terceras aplicaciones laintegración con cualquier gestor documental de forma transparente, independientemente de suorigen, para el almacenamiento y/o gestión de documentos y expedientes electrónicos.

Otras funcionalidades destacables:• Definición del cuadro de clasificación de archivos.• Definición de tipos documentales con sus metadatos asociados permitiendo, entre

otras opciones, la herencia entre tipos documentales, gestión de tipos de datospermitidos o restricción de sus posibles valores.

• Gestión y uso de múltiples repositorios.• Gestión de terceras aplicaciones, clasificando sus documentos y expedientes.• Gestión de usuarios y perfiles de acceso.• Definición de normas de conservación de expedientes y documentos.

[ 1.6.2 ] 04/08/17 Pág 4 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

2. Catálogo de servicios

URL: http://<endpoint>:<puerto>/<nombreAplicacionGede>/services/gede?wsdl

2.1. Constructor del servício

Para utilizar el catálogo de servicios que ofrece Gede, lo primero que debemos hacer escrear una instancia del cliente.

GedeImplServiceLocator serv = new GedeImplServiceLocator();

Una vez tengamos el servicio inicializado, obtenemos la implementación del servicio, queserá el objeto con el que invoquemos cada uno de los servicios.

Gede serv. getGedeImplPort(Url url, String codUsuario, String password)

Parámetros de entrada:

url - - Url del servicio desplegado (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

password - - Contraseña del usuario (Obligatorio)

Salida:

Gede - Objeto que será utilizada para llamar a cada uno de los servicios.

2.2. Alta de expedientes

Realiza el alta de un expediente electrónico en el gestor documental. Se genera unacarpeta con el identificador del expediente que contendrá los metadatos asociados almismo.

GedeWsResponse altaExpediente(String codAplic, String codUser, String codOrg, String codExp, ContentType metadatos, String idExpePadre)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

codExp - - Código del Expediente (Obligatorio)

[ 1.6.2 ] 04/08/17 Pág 5 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

metadatos - - Metadatos Asociados del expediente, donde se incluye el Tipo Documentala utilizar (Obligatorio, en caso de no enviarse se intentarán recuperar a partir delconector de la aplicación)

idExpePadre - - Id. del Expediente Electrónico Padre

codNIvelQdc – Código nivel qdc al que se quiere incluir el expediente. En caso de noindicarlo, se intentará obtener desde el que tiene asociado por defecto la aplicación

Salida:

GedeWsResponse - Objeto encargado de devolver el Id. del Expediente en G-EDE, encaso de que vaya bien. En caso de error, devuelve lista de errores que se han producido

Notas:

1. Se genera el expediente inicialmente sin documentos, añadiéndolos posteriormentecon los servicios destinados a tal efecto.

2. Los metadatos mínimos obligatorios del expediente deberán ser proporcionados oestar disponibles para obtenerlos a la hora de crear el expediente, ya que según elapartado IV.1 (b) de la NTI de Expediente Electrónico, los metadatos mínimosobligatorios se asociarán en la formación del expediente. En caso de que no seestablezcan los metadatos mínimos, el expediente se considerará no iniciado.

2.3. Búsqueda de expedientes

Obtiene los identificadores de los expedientes que coinciden con los número de búsquedapor los que se filtra.

GedeWsResponse buscarExpedientes(String codAplic, String codUser, String codOrg, ContentTypemetadatos)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

metadatos - - Metadatos con los valores para filtrar los expedientes.

codExp - - Código de expediente.

codNivel - - Código del nivel qdc.

Salida:

GedeWsResponse – Objeto encargado de devolver una lista de identificadores deexpediente econtrados en G-EDE. En caso de error, devuelve una lista de errores que sehayan producido.

[ 1.6.2 ] 04/08/17 Pág 6 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

2.4. Obtener metadatos Expediente

Obtiene los metadatos asociados a un expediente que se pasa como parámetro.

GedeMetadataResponse obtenerMetadatosExpediente(String codAplic, String codUser, StringcodOrg, String codExpediente, String idExp)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

codExpediente - - Código del Expediente proporcionado por la aplicación que lo da dealta (Obligatorio*)

idExp - - Id. del Expediente Electrónico en G-EDE (Obligatorio*)

Salida:

Objeto GedeMetadataResponse que devuelve información sobre el resultado de laoperación, en caso de errores, devuelve una lista de éstos.

* Es necesario especificar uno de los dos parámetros de entrada.

[ 1.6.2 ] 04/08/17 Pág 7 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

2.5. Actualizar expediente

Permite actualizar la información de un expediente en función de su tipo documental, losmetadatos recibidos por parámetros y la serie documental asociada. La edición se permitesiempre que el expediente no se encuentre cerrado. En caso de que no se incluyanmetadatos como parámetros se tomarán los que estén disponibles en ese momento.

GedeWsResponse actualizarExpediente(String codAplic, String codUser, String codOrg, StringcodExp, String idExp, ContentType metadatos)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

codExp - - Código del Expediente (Obligatorio*)

idExp - - Id. del Expediente Electrónico (Obligatorio*)

metadatos - - Objeto con los metadatos

codNivelQdc - - Código del nivel qdc si se quiere reubicar el expediente

Salida:

Objeto GedeWsResponse que devuelve información sobre el resultado de la operación,en caso de errores, devuelve una lista de estos.

• Es obligatorio el “código de expediente” o el “id del expediente”

[ 1.6.2 ] 04/08/17 Pág 8 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

2.6. Eliminar expediente electrónico

Elimina el expediente de forma lógica, manteniendo en el repositorio el expediente y sucontenido, estableciendo en la base de datos el expediente como no vigente.

GedeWsResponse eliminarExpediente(String codAplic, String codUser, String codOrg, String idExp)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idExp - - Id. del Expediente Electrónico (Obligatorio)

Salida:

GedeWsResponse – Objeto encargado de devolver una lista de errores en caso de quese hayan producido.

2.7. Crear documento electrónico

Genera la carpeta del documento electrónico a la que se asociarán los metadatos deldocumento electrónico. Permite añadir binarios sin firmar, ya que las firmas se adjuntaránposteriormente haciendo uso del servicio web apropiado. Se calcula el hash del ficherobinario adjunto y si existe en el repositorio, se crea un enlace al mismo para evitar duplicarficheros iguales.

No es obligatorio que esté asociado a un expediente aunque, llegado el caso, se puedeasociar a un expediente existente haciendo uso del servicio destinado a tal fin, que sedetalla en el siguiente punto.

GedeWsResponse altaDocumentoElectronico(String codAplic, String codUser, String codOrg, StringcodExp, String idExp, EDocument docuE)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

codExp - - Código del Expediente (Obligatorio*)

idExp - - Id. del Expediente Electrónico (Obligatorio*)

codNivelQdc - - Código del nivel qdc

docuE - - Objeto con los datos del Documento Electrónico (Obligatorio)

Salida:

GedeWsResponse con información del resultado de la operación y el id del Documentoen G-EDE, en caso de errores, también devuelve una lista de estos.

* Es obligatorio el “código de expediente” o el “id del expediente”

[ 1.6.2 ] 04/08/17 Pág 9 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

Notas:

1. Genera el documento a partir de la información y si se le indica el id delexpediente o el código del expediente se asociará directamente a éste. En el caso deno indicarle un expediente al que asociar, si no se le indica el código del nivel qdc alque se quiere asociar el documento, éste lo cogerá del que tenga por defecto laaplicación.

2.8. Asociar documento a expediente

Relaciona un documento electrónico y un expediente existentes, si el documentoelectrónico existe en el repositorio pero no está vinculado a ningún expediente. Si elexpediente está cerrado, no se permitirá la vinculación del documento electrónico alexpediente.

GedeWsResponse asociarDocumentoAExpediente(String codAplic, String codUser, String codOrg,String codExp, String idExp, String idDocE)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

codExp - - Código del Expediente (Obligatorio*)

idExp - - Id. del Expediente Electrónico (Obligatorio*)

idDocE - - Id. del Documento Electrónico (Obligatorio)

Salida:

GedeWsResponse - Objeto encargado de devolver una lista de errores en caso de quese hayan producido.

* Es obligatorio el “código de expediente” o el “id del expediente”

2.9. Búsqueda de documentos electrónicos

Obtiene la lista de identificadores de documentos electrónicos cuyos metadatos coincidencon los parámetros de búsqueda por los que se filtra. Permite filtrar por el expediente paraobtener el conjunto de documentos del mismo.

GedeWsResponse buscarDocumentos (String codAplic,String codUser, String codOrg, StringcodExp, String idExp, ContentType metaDatos)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

codExp - - Código del Expediente

[ 1.6.2 ] 04/08/17 Pág 10 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

idExp - - Id. del Expediente Electrónico

metaDatos - - Metadatos del documento a buscar (Obligatorio)

notInProcessTransfer - - TRUE, si no se quiere obtener los documentos que estén enun proceso de transferencia. FALSE o NULL, si se quiere obtener todos.

Salida:

GedeWsResponse - objeto encargado de devolver la lista de los Ids de documentosencontrados en G-EDE , en caso de que vaya bien. En caso de error , devuelve una lista deerrores que se han producido.

2.10. Obtener metadatos de documento electrónico

Obtiene los metadatos asociados a un documento electrónico que se pasa comoparámetro.

GedeMetadataResponse obtenerMetadatosDocumento(String codAplic, String codUser, String codOrg, String idDoc)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idDoc - - Id. del Documento Electrónico (Obligatorio)

Salida:

Objeto GedeMetadataResponse que incluye un mapa con los Metadatos deDocumento así como información del resultado de la operación.

2.11. Actualizar documento electrónico

Actualiza un documento electrónico siempre que este se encuentre en un estado quepermita su edición con los metadatos que se reciban como parámetros si estos vienendefinidos. Si no se reciben metadatos, se tomarán aquellos que haya disponibles paraobtener.

Permite la actualización del binario del documento y de sus metadatos.

GedeWsResponse actualizarDocElectronico(String codAplic, String codUser, String codOrg EDocument edoc)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

[ 1.6.2 ] 04/08/17 Pág 11 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

edoc - - Objeto EDocument que contiene la información del documento, sus metadatos yel fichero binario a actualizar

Salida:

Objeto GedeWsResponse donde el atributo denominado 'exito' será TRUE si todo vabien o FALSE si existe algún error, que estará incluido en la lista de errores de dichoobjeto

Notas:

1. Método que actualiza los metadatos y/o el binario del fichero, según se pasenen la información del Edocument.

2.12. Obtener documento electrónico

Permite obtener la información de un documento electrónico: identificador, uuidDocumento,uuidFichero, si es expurgable, transferible, fecha de apertura, fecha de finalización, unalista con los expedientes a los que está asociado el documento,etc.

GedeDocumentResponse obtenerDocumentoElectronico(String codAplic, String codUser, StringcodOrg, String idDoc)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idDoc - - Id. del Documento Electrónico (Obligatorio)

Salida:

Objeto GedeDocumentResponse donde el atributo denominado 'exito' será TRUE sitodo va bien o FALSE si existe algún error, que estará incluido en la lista de errores dedicho objeto. Contiene un objeto UiDocumento, que contiene la información deldocumento y una lista de UiExpedientes, con la información de los expedientes a los queestá asociado.

2.13. Adjuntar firma a documento electrónico

Permite añadir la información de firma asociada a un documento electrónico. Los datos defirmas son obligatorios pero el binario de firma es opcional en caso de que el binario deldocumento electrónico tuviese alguna firma implícita.

GedeWsResponse adjuntarFirmaDocElectronico(String codAplic, String codUser, String codOrg,

[ 1.6.2 ] 04/08/17 Pág 12 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

String idDoc, Sign datosFirma)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idDoc - - Id. del Documento Electrónico (Obligatorio)

datosFirma - - Datos de la firma (Obligatorio)

Salida:

Objeto GedeWsResponse donde el atributo denominado 'exito' será TRUE si el procesose completa correctamente o FALSE si existe algún error, que estará incluido en la listade errores de dicho objeto

2.14. Obtener documentos asociados a un expediente

Obtiene el conjunto de documentos de un expediente con sus metadatos (no incluyebinarios)

GedeEDocumentResponse obtenerDocumentosExpediente(String codAplic, String codUser, String codOrg, String codExp, String idExp)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

codExp - - Código del Expediente (Obligatorio*)

idExp - - Id. del Expediente Electrónico (Obligatorio *)

Salida:

GedeEDocumentResponse – con la lista de Documentos electrónicos asociados alexpediente, así como información sobre el resultado de la operación.

* Es obligatorio el “código de expediente” o el “id del expediente”

2.15. Eliminar documento de expediente

Elimina la relación entre un documento electrónico y un expediente si el expediente no estácerrado. No se realiza borrado físico de la carpeta del documento electrónico ni se eliminael fichero binario.

[ 1.6.2 ] 04/08/17 Pág 13 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

GedeWsResponse eliminarDocumentoExpte(String codAplic, String codUser, String codOrg, StringidExp, String idDoc)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idExp - - Id. del Expediente Electrónico (Obligatorio)

idDoc - - Id. del Documento Electrónico (Obligatorio)

Salida:

GedeWsResponse - Objeto encargado de devolver una lista de errores en caso de quese hayan producido.

2.16. Eliminar firma de documento electrónicoPermite eliminar una firma del documento electrónico si este no se se encuentra cerrado.

public GedeWsResponse eliminarFirmaDocumento(String codAplic, String codUser, String codOrg,String idFirma);

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

IdFirma – Id.. de la firma del documento electrónico

Salida:

GedeWsResponse – Objeto encargado de devolver una lista de errores en caso de quese hayan producido.

2.17. Eliminar firmas de documento electrónicoPermite eliminar todas las firmas asociadas a un documento electrónico si este no se se

encuentra cerrado.

public GedeWsResponse eliminarFirmasDocumento(String codAplic, String codUser, String codOrg,String idDoc);

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idDoc - - Id. del Documento Electrónico (Obligatorio)

Salida:

[ 1.6.2 ] 04/08/17 Pág 14 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

GedeWsResponse – Objeto encargado de devolver una lista de errores en caso de quese hayan producido.

2.18. Eliminar documento electrónicoElimina un documento electrónico si el documento no está cerrado y, en caso de estarasociado a un expediente, este tampoco está cerrado. En caso de que un documento estérelacionado a más de un expediente, se requiere previamente que se desvincule(eliminarDocumentoExpte) de los expedientes antes de permitir el borrado.

Se realiza un borrado físico del documento electrónico: binario (si tuviera), metadatos,firmas asociadas y registros en la BB.DD. de G-EDE.

GedeWsResponse eliminarDocumentoElectronico(String codAplic, String codUser, String codOrg,String idDoc);

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idDoc - - Id. del Documento Electrónico (Obligatorio)

Salida:

GedeWsResponse – Objeto encargado de devolver una lista de errores en caso de quese hayan producido.

[ 1.6.2 ] 04/08/17 Pág 15 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

2.19. Generar subexpediente de remisión

Realiza un cierre del contenido del expediente parcial para remisión del mismo, incluyendoun índice firmado del contenido hasta ese momento. Este subexpediente se establece conestado “Indice de remisión cerrado” ya que no se realiza tramitación del mismo.

GedeWsResponse generarSubexpedienteRemision(String codAplic, String codUser, String codOrg, String idExp, EDocument[] docs)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idExp - - Id. del Expediente Electrónico (Obligatorio)

docs - - Documentos a incluir en el expediente de remisión, deben estar completos(Obligatorio)

Salida:

GedeWsResponse - Respuesta obtenida informando del resultado

Nota:

1. Los documentos electrónicos especificados, cuando sea el caso, deben estarcompletos, no permitiéndose añadir a un subexpediente de remisión documentoselectrónicos no completos.

2.20. Finalizar expediente

Realiza el cierre formal del expediente pasando su estado a terminado con lo que no sepermitiría realizar ninguna modificación sobre el mismo. Genera el índice del expediente yse firma con firma servidor.

GedeWsResponse finalizarExpediente(String codAplic, String codUser, String codOrg, String idExp)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idExp - - Id. del Expediente Electrónico (Obligatorio)

Salida:

GedeWsResponse - Respuesta obtenida informando del resultado

[ 1.6.2 ] 04/08/17 Pág 16 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

2.21. Obtener tipos documentales de aplicación

Obtiene los tipos documentales, definidos como el conjunto de metadatos asociados a losdistintos tipos de contenidos, dados de alta para la aplicación. (Cada aplicación debe teneral menos uno para documento electrónico y otro para expediente con los metadatosobligatorios del ENI).

GedeContentTypesResponse obtenerTiposDocumentales(String codAplic, String codUser, StringcodOrg, String operacion)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

operacion - - 'E' si se quiere obtener los tipos documentales vigentes para la búsqueda.'S' si se quiere obtener los tipos documentales vigentes para el alta. NULL, si se quierenobtener todos los tipos documentales

Salida:

GedeContentTypesResponse –istado de Tipos Documentales de la aplicación junto consus metadatos, así como información sobre el resultado de la operación.

2.22. Obtener binario de documento electrónico

Obtiene el fichero binario del documento electrónico

GedeBinaryResponse obtenerBinarioDocumento(String codAplic, String codUser, String codOrg,String idDoc)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idDoc - - Id. del Documento Electrónico (Obligatorio)

Salida:

[ 1.6.2 ] 04/08/17 Pág 17 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

GedeBinaryResponse - Binario del documento, nombre del documento, así comoinformación sobre el resultado de la operación

2.23. Obtener firmas de documento electrónico

Obtiene las firmas de un documento electrónico.

GedeSingsResponse obtenerFirmasDocElectronico(String codAplic, String codUser, String codOrg,String idDoc)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idDoc - - Id. del Documento Electrónico (Obligatorio)

Salida:

GedeSingsResponse - Lista de las firmas del documento , así como información sobreel resultado de la operación

2.24. Obtener metadatos de firma electrónica

Obtiene los metadatos asociados a una firma electrónica que se pasa como parámetro.

GedeMetadataResponse obtenerMetadatosDocumento(String codAplic, String codUser, String codOrg, String idFirm)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idFirm - - Id. de la firma (Obligatorio)

Salida:

Objeto GedeMetadataResponse que incluye un mapa con los Metadatos de Firma asícomo información del resultado de la operación.

2.25. Obtener binario de firma electrónica

Obtiene el fichero binario de una firma electrónica.

[ 1.6.2 ] 04/08/17 Pág 18 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

GedeBinaryResponse obtenerBinarioFirma(String codAplic, String codUser, String codOrg, StringidFirm)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idFirm - - Id. de la firma (Obligatorio)

Salida:

GedeBinaryResponse - Binario de la firma, nombre del fichero asociado a la firma , asícomo información sobre el resultado de la operación

2.26. Cerrar documento electrónico

Da por cerrado un documento electrónico actualizando su estado.

GedeWsResponse cerrarDocumento(String codAplic, String codUser, String codOrg, String idDoc)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idDoc - - Id. del documento (Obligatorio)

Salida:

GedeWsResponse – devuelve una lista de errores en caso de que se produzcan.

2.27. Consulta nivel qdc

Obtiene el arbol a partir del nivel qdc indicado. En caso de no indicárselo lo obtendrá apartir del código de aplicación y del organismo.

GedeNivelQdcResponse obtenerTreeNivelQdc(String codAplic, String codUser, String codOrg, StringcodNivelQdc)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio si no se indica el nivel qdc)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio si no se indica el nivel qdc)

[ 1.6.2 ] 04/08/17 Pág 19 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

codNivelQdc - - Código del nivel qdc (Obligatorio si no se indica el código deaplicación)

Salida:

GedeNivelQdcResponse – devuelve una lista con la información del árbol de nivel qdc(código del qdc, descripción, código qdc padre y si permite asociardocumentos/expedientes ) a partir del código del nivel qdc, o de la aplicación.

2.28. Copiar documentos

Copia un documento en un expediente generando un nuevo documento electrónico a partirde los metadatos y binarios del original.

GedeWsResponse copiarDocumentoAExpediente( String codAplic, String codUser, String codOrg,String codExp, String idExp, String idDocE)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

codExp - - Código del Expediente (Obligatorio*)

idExp - - Id. del Expediente Electrónico (Obligatorio *)

IdDocE - - Id. del Documento Electrónico (Obligatorio )

Salida:

GedeWsResponse – devuelve información del resultado de la operación

* Es obligatorio el “código de expediente” o el “id del expediente”

2.29. Actualizar firma del documento electrónico

Permite actualizar la firma de un documento electrónico que contenía un binario pendientede firmar.

GedeWsResponse actualizarFirmaDocElectronico( String codAplic, String codUser, String codOrg,String idDoc, Sign datosFirma)

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

codUser - - Usuario de la aplicación (Obligatorio)

codOrg - - Código de Órgano (Obligatorio)

idDoc - - Id. del Documento Electrónico (Obligatorio )datosFirma - - Datos de la firma(Obligatorio)

datosFirma - - Datos de la firma (Obligatorio)

[ 1.6.2 ] 04/08/17 Pág 20 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

Salida:

GedeWsResponse – devuelve información del resultado de la operación

[ 1.6.2 ] 04/08/17 Pág 21 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

3. Catálogo de servicios web para el almacenamientosimple

URL: http://<endpoint>:<puerto>/<nombreAplicacionGede/services/gedesimple?wsdl

3.1. Obtener un repositorio de una aplicación.Lleva a cabo la obtención de un repositorio dado un código de aplicación.

GedeRepositoryResponse obtenerRepositoriosAplic(String codAplic);

Parámetros de entrada:

codAplic - - Código de la aplicación (Obligatorio)

Salida:

GedeRepositoryResponse – Devuelve el repositorio .

3.2. Crear una carpeta en un repositorio.Crea una carpeta en un repositorio con su nombre y sus metadatos son opcionales.

GedeWsResponse crearCarpeta(RepositorioSimple repo, String folderParent, StringnombreCarpeta, Metadatos metadatos);

Parámetros de entrada:

repo - - Repositorio (Obligatorio)

FolderParent - - Carpeta padre de la nueva carpeta a crear(Obligatorio)

NombreCarpeta - -Nombre de la carpeta a crear(Obligatorio)

Metadatos - -Metadatos (Opcional)

Salida:

GedeWsResponse – devuelve una lista de errores en caso de que se hayan producido.

[ 1.6.2 ] 04/08/17 Pág 22 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

3.3. Crear un binario.Crea un binario dado un repositorio y una carpeta padre.

GedeWsResponse crearBinario (RepositorioSimple repo, String folderParent, Binariobinario);

Parámetros de entrada:

repo - - Repositorio (Obligatorio)

FolderParent - - Carpeta padre (Obligatorio)

Binario - - Objeto binario (Obligatorio)

Salida:

GedeWsResponse – devuelve una lista de errores en caso de que se hayan producido.

3.4. Actualizar carpeta de un repositorio. Actualiza una carpeta dado un repositorio y su uuid que la identifica, los metadatos sonobligatorios.

GedeWsResponse actualizarCarpeta(RepositorioSimple repo, String uuidFolder, Metadatosmetadatos);

Parámetros de entrada:

repo - - Repositorio de la carpeta (Obligatorio)

uuidFolder - - uuid de la propia carpeta que la identifica (Obligatorio)

Metadatos - -Metadatos (Obligatorio)

Salida:

GedeWsResponse – devuelve una lista de errores en caso de que se hayan producido.

[ 1.6.2 ] 04/08/17 Pág 23 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

4. Diagrama de clases

[ 1.6.2 ] 04/08/17 Pág 24 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

[ 1.6.2 ] 04/08/17 Pág 25 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

[ 1.6.2 ] 04/08/17 Pág 26 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

4.1. Detalle de las clasesClass GedeWsResponse

Clase que representa la respuesta de los Servicios Web de Gede.

Campos accesibles de la clase (get y set)

boolean exitoAtributo booleano que indica si el Servicio ha concluido de forma correcta (true) oincorrecta (false)

String successValue Atributo cadena con el valor correcto del Servicio

String searchValues Listado de los identicadores que resultan de una búsqueda

ArrayList<String> errores Listado de los posibles errores cometidos en la ejecución del Servicio web

Class GedeBinaryResponse

Clase que representa la respuesta de los Servicios Web de Gede.

Campos accesibles de la clase (get y set)

boolean exitoAtributo booleano que indica si el Servicio ha concluido de forma correcta (true) oincorrecta (false)

String nameBinarioAtributo que contiene el nombre del fichero binario

DataHandler binario Atributo Handler devuelto como un binario

ArrayList<String> errores Listado de los posibles errores cometidos en la ejecución del Servicio web

Class GedeMetadataResponse

Clase que representa la respuesta de los Servicios Web de Gede.

Campos accesibles de la clase (get y set)

boolean exitoAtributo booleano que indica si el Servicio ha concluido de forma correcta (true) oincorrecta (false)

String idAtributo que devuelve el identifcador -GEDE del expediente, documento o firma delque se devuelven los metadatos

ContentType metadatos Atributo ContentType devuelto con los metadatos de un elemento delrepositorio.

[ 1.6.2 ] 04/08/17 Pág 27 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

ArrayList<String> errores Listado de los posibles errores cometidos en la ejecución del Servicio web

Class GedeEDocumentResponse

Clase que representa la respuesta de los Servicios Web de Gede.

Campos accesibles de la clase (get y set)

boolean exitoAtributo booleano que indica si el Servicio ha concluido de forma correcta (true) oincorrecta (false)

EDocument[] documentos Atributo EDocument[] devuelto con los documentos electr nicos recuperados.ó

ArrayList<String> errores Listado de los posibles errores cometidos en la ejecución del Servicio web

Class GedeContentTypesResponse

Clase que representa la respuesta de los Servicios Web de Gede.

Campos accesibles de la clase (get y set)

boolean exitoAtributo booleano que indica si el Servicio ha concluido de forma correcta (true) oincorrecta (false)

ContentTypes[] tiposDocumentales Atributo ContentTypes[] devuelto con los tipos documentales recuperados.

ArrayList<String> errores Listado de los posibles errores cometidos en la ejecución del Servicio web

Class GedeSignsResponse

Clase que representa la respuesta de los Servicios Web de Gede.

Campos accesibles de la clase (get y set)

boolean exitoAtributo booleano que indica si el Servicio ha concluido de forma correcta (true) oincorrecta (false)

Signs[] firmas Atributo Signs[] devuelto con los documentos electr nicos recuperados.ó

ArrayList<String> errores Listado de los posibles errores cometidos en la ejecución del Servicio web

[ 1.6.2 ] 04/08/17 Pág 28 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

Class GedeRepositoryResponse

Clase que representa la respuesta de los Servicios Web de Gede.

Campos accesibles de la clase (get y set)

boolean exitoAtributo booleano que indica si el Servicio ha concluido de forma correcta (true) oincorrecta (false)

RepositorioSimple[] repositorios Array con los repositorios encontrados para la aplicaci nó

ArrayList<String> errores Listado de los posibles errores cometidos en la ejecución del Servicio web

Class RepositorioSimple

Clase que representa el repositorio.

Campos accesibles de la clase (get y set)

String codigoAtributo que indica el código del repositorio

String descripción Atributo que indica la descripci n del repositorio.ó

Class ContentType

Clase que representa el Tipo Documental (junto con su mapa de propiedades)

Campos accesibles de la clase (get y set)

HashMap

<String,Property>

metadatos Mapa de Metadatos del Tipo Documental

String name Nombre del Tipo Documental (compuesto por: prefijo del modelo + ":" +nombre del tipo documental)

String title Nombre del Tipo Documental

String use Ámbito de uso del Tipo Documental (E = Expedientes, D = Documentos, F =

[ 1.6.2 ] 04/08/17 Pág 29 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

Firmas)

String editingEnabled Indica si el tipo documental se puede utilizar para almacenar información

String searchEnabled Indica si el tipo documental se puede utilizar para realizar búsquedas

String activeSearch Indica si es vigente para la búsqueda

String activeHigh Indica si es vigente para el alta

Class EDocument

Clase que representa el Documento Electronico

Campos accesibles de la clase (get y set)

DataHandler binario Nombre fichero binario del Documento Electronico

Boolean completo Atributo booleano que indica si tiene todos sus metadatos obligatorios rellenos

String idDoc Identificador del Documento Electronico en Gede

ContentType metadatos Tipo Documental asociado al Documento Electronico

String nombre Nombre del fichero binario del Documento Electronico

String tipo_mime Tipo MIME del fichero binario del Documento Electronico

Long xDoc Id del documento

String tiempoConservacion Atributo que indica el plazo de la norma de conservación

String normaConservacion Atributo que indica la norma de conservación asociada

[ 1.6.2 ] 04/08/17 Pág 30 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

Date fechaAlta Atributo que indica la fecha de alta del documento

boolean esencial Atributo que indica si el documento es esencial o no

boolean transferenciaAprobada Atributo que indica si el documento se encuentra en un proceso detransferencia

boolean enArchivo Atributo que indica si el documento está en el gestor documental o en algunode los archivos

Class Sign

Clase que representa la firma de un documento

Campos accesibles de la clase (get y set)

DataHandler binario_firm Binario del fichero de firma

String id Identificador de la Firma en Gede

ContentType metadatos Tipo documental asociado a la firma

String nombre Nombre del fichero binario de firma

String tipo_mime Tipo MIME del fichero de firma

Class KeyValObject

Clase que permite añadir información extra a un valor, utlizado para devolver listas devalores válidos para un metadato, permitiendo diferenciar entre la información que sealmacena y la que se muestra al usuario en el formulario.

Campos accesibles de la clase (get y set)

String nombre Atributo nombre, que será mostrado al usuario. Será nulo en aquellos casos

[ 1.6.2 ] 04/08/17 Pág 31 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

que el valor a mostrar y almacenar para un metadato sea el mismo.

String valor Atributo valor, que será el almacenado internamente

Class Property

Clase que representa un metadato y que nos permite saber sus características yrestricciones.

Campos accesibles de la clase (get y set)

boolean multiple Atributo booleano para saber si el metadato admite múltiples valores

List

<KeyValObject>

optionsList Lista de opciones (si tiene restricción de lista de elementos)

Integer propMaxLength Longitud máxima del valor de la propiedad (si tiene restricción de tamaño)

Long propMaxValue Valor maximo de la propiedad (si tiene restricción de rango de valores)

Integer propMinLength Longitud mínima del valor de la propiedad (si tiene restricción de tamaño)

Long propMinValue Valor minimo de la propiedad (si tiene restricción de rango de valores)

String propName Nombre del metadato en el modelo (formato: prefijo + ":" + nombre delmetadato)

String propTitle Nombre del metadato en el formulario

String propType Tipo de Metadato:

list = Lista

text = Cadena

date = Fecha

hidden = Oculto (Si se trata un metadato que tiene un valor por defecto y

[ 1.6.2 ] 04/08/17 Pág 32 de 33

Expediente y Documento ElectrónicoG-EDE. Documento de diseño técnico

no se debe modificar)

String[] propValue Valor/es del metadato

boolean required Atributo booleano para saber si es obligatorio

Date dateRangeStart Valor inicial de una fecha en un rango dado

Date dateRangeEnd Valor máximo de una fecha en un rango dado

String propSoporte Tipo de soporte del metadato (ELECT= Electrónico, MIXTO= mixto,PAPEL=papel)

boolean editableAtClose Booleano que comprueba si el metadato es editable tras el cierre delexpediente.

[ 1.6.2 ] 04/08/17 Pág 33 de 33