Pastor y Landero, 19

41001 Sevilla (España)

tel +34 954 56 25 40

www.gonce.es

Plataforma de Tramitación G·ONCE

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

viernes, 12 de mayo de 2017

1.5.9

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.

Índice de contenido

1.Descripción general 4

2.Catálogo de servicios 5

2.1.Alta de expedientes 5

2.2.Búsqueda de expedientes 5

2.3.Obtener metadatos Expediente 6

2.4.Actualizar expediente 7

2.5.Eliminar expediente electrónico 8

2.6.Crear documento electrónico 8

2.7.Asociar documento a expediente 9

2.8.Búsqueda de documentos electrónicos 9

2.9.Obtener metadatos de documento electrónico 10

2.10.Actualizar documento electrónico 10

2.11.Obtener documento electrónico 11

2.12. Adjuntar firma a documento electrónico 11

2.13.Obtener documentos asociados a un expediente 12

2.14.Eliminar documento de expediente 12

2.15.Eliminar firma de documento electrónico 13

2.16.Eliminar firmas de documento electrónico 13

2.17.Eliminar documento electrónico 14

2.18.Generar subexpediente de remisión 15

2.19.Finalizar expediente 15

2.20.Obtener tipos documentales de aplicación 16

2.21.Obtener binario de documento electrónico 16

2.22.Obtener firmas de documento electrónico 17

2.23.Obtener metadatos de firma electrónica 17

2.24.Obtener binario de firma electrónica 17

2.25.Cerrar documento electrónico 18

2.26.Consulta nivel qdc 18

2.27.Copiar documentos 19

2.28.Actualizar firma del documento electrónico 19

3.Catálogo de servicios web para el almacenamiento simple 21

3.1.Obtener un repositorio de una aplicación. 21

3.2.Crear una carpeta en un repositorio. 21

3.3.Crear un binario. 22

3.4.Actualizar carpeta de un repositorio. 22

4.Diagrama de clases 23

4.1.Detalle de las clases 26

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ónico basándose en el uso de gestores documentales como repositorio de documentos y expedientes.

El funcionamiento del sistema se apoya en la combinación de un sistema de base de datos encargado 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 CMIS permite el acceso a cualquier gestor documental que soporte dicho estándar sin necesidad de modificar el sistema.

G-EDE ofrece un conjunto de servicios web que permiten a terceras aplicaciones la integración con cualquier gestor documental de forma transparente, independientemente de su origen, 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 datos permitidos 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.

2.Catálogo de servicios

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

2.1.Alta de expedientes

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

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)

metadatos - - Metadatos Asociados del expediente, donde se incluye el Tipo Documental a utilizar (Obligatorio, en caso de no enviarse se intentarán recuperar a partir del conector 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 no indicarlo, 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, en caso 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 posteriormente con los servicios destinados a tal efecto.
2.Los metadatos mínimos obligatorios del expediente deberán ser proporcionados o estar disponibles para obtenerlos a la hora de crear el expediente, ya que según el apartado IV.1 (b) de la NTI de Expediente Electrónico, los metadatos mínimos obligatorios se asociarán en la formación del expediente. En caso de que no se establezcan los metadatos mínimos, el expediente se considerará no iniciado.

2.2.Búsqueda de expedientes

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

GedeWsResponse buscarExpedientes(String codAplic, String codUser, String codOrg, 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)

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 de expediente econtrados en G-EDE. En caso de error, devuelve una lista de errores que se hayan producido.

2.3.Obtener metadatos Expediente

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

GedeMetadataResponse obtenerMetadatosExpediente(String codAplic, String codUser, String codOrg, 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 de alta (Obligatorio*)

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

Salida:

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

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

2.4.Actualizar expediente

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

GedeWsResponse actualizarExpediente(String codAplic, String codUser, String codOrg, String codExp, 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”

2.5.Eliminar expediente electrónico

Elimina el expediente de forma lógica, manteniendo en el repositorio el expediente y su contenido, 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 que se hayan producido.

2.7.Crear documento electrónico

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

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

GedeWsResponse altaDocumentoElectronico(String codAplic, String codUser, String codOrg, String codExp, 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 Documento en 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”

Notas:

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

2.8.Asociar documento a expediente

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

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 que se 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 coinciden con los parámetros de búsqueda por los que se filtra. Permite filtrar por el expediente para obtener el conjunto de documentos del mismo.

GedeWsResponse buscarDocumentos (String codAplic,String codUser, String codOrg, String codExp, 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

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 en un proceso de transferencia. FALSE o NULL, si se quiere obtener todos.

Salida:

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

2.10.Obtener metadatos de documento electrónico

Obtiene los metadatos asociados a un documento electrónico que se pasa como pará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 de Documento 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 que permita su edición con los metadatos que se reciban como parámetros si estos vienen definidos. Si no se reciben metadatos, se tomarán aquellos que haya disponibles para obtener.

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)

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

Salida:

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

Notas:

1.Método que actualiza los metadatos y/o el binario del fichero, según se pasen en 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, una lista con los expedientes a los que está asociado el documento,etc.

GedeDocumentResponse obtenerDocumentoElectronico(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 GedeDocumentResponse donde el atributo denominado 'exito' será TRUE si todo va bien o FALSE si existe algún error, que estará incluido en la lista de errores de dicho objeto. Contiene un objeto UiDocumento, que contiene la información del documento y una lista de UiExpedientes, con la información de los expedientes a los que está 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 de firmas son obligatorios pero el binario de firma es opcional en caso de que el binario del documento electrónico tuviese alguna firma implícita.

GedeWsResponse adjuntarFirmaDocElectronico(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)

Salida:

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

2.14.Obtener documentos asociados a un expediente

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

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 al expediente, 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 elimina el fichero binario.

GedeWsResponse eliminarDocumentoExpte(String codAplic, String codUser, String codOrg, String idExp, 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 que se hayan producido.

2.16.Eliminar firma de documento electrónico

Permite 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 que se hayan producido.

2.17.Eliminar firmas de documento electrónico

Permite 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:

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

2.18.Eliminar documento electrónico

Elimina un documento electrónico si el documento no está cerrado y, en caso de estar asociado 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 que se hayan producido.

2.20.Generar subexpediente de remisión

Realiza un cierre del contenido del expediente parcial para remisión del mismo, incluyendo un índice firmado del contenido hasta ese momento. Este subexpediente se establece con estado “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 estar completos, no permitiéndose añadir a un subexpediente de remisión documentos electrónicos no completos.

2.21.Finalizar expediente

Realiza el cierre formal del expediente pasando su estado a terminado con lo que no se permitiría realizar ninguna modificación sobre el mismo. Genera el índice del expediente y se 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

2.22.Obtener tipos documentales de aplicación

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

GedeContentTypesResponse obtenerTiposDocumentales(String codAplic, String codUser, String codOrg, 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 quieren obtener todos los tipos documentales

Salida:

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

2.23.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:

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

2.24.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 sobre el resultado de la operación

2.25.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.26.Obtener binario de firma electrónica

Obtiene el fichero binario de una firma electrónica.

GedeBinaryResponse obtenerBinarioFirma(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:

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

2.27.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.28.Consulta nivel qdc

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

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

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)

codNivelQdc - - Código del nivel qdc (Obligatorio si no se indica el código de aplicació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 asociar documentos/expedientes ) a partir del código del nivel qdc, o de la aplicación.

2.30.Copiar documentos

Copia un documento en un expediente generando un nuevo documento electrónico a partir de 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.31.Actualizar firma del documento electrónico

Permite actualizar la firma de un documento electrónico que contenía un binario pendiente de 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)

Salida:

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

3.Catálogo de servicios web para el almacenamiento simple

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, String nombreCarpeta, 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.

3.3.Crear un binario.

Crea un binario dado un repositorio y una carpeta padre.

GedeWsResponse crearBinario (RepositorioSimple repo, String folderParent, Binario binario);

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.

1. 1. 1. Actualiza una carpeta dado un repositorio y su uuid que la identifica, los metadatos son obligatorios.

GedeWsResponse actualizarCarpeta(RepositorioSimple repo, String uuidFolder, Metadatos metadatos);

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.

4.Diagrama de clases

4.1.Detalle de las clases

Class GedeWsResponse

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

Campos accesibles de la clase (get y set)
boolean	exito Atributo booleano que indica si el Servicio ha concluido de forma correcta (true) o incorrecta (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	exito Atributo booleano que indica si el Servicio ha concluido de forma correcta (true) o incorrecta (false)
String	nameBinario Atributo 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	exito Atributo booleano que indica si el Servicio ha concluido de forma correcta (true) o incorrecta (false)
String	id Atributo que devuelve el identifcador -GEDE del expediente, documento o firma del que se devuelven los metadatos
ContentType	metadatos Atributo ContentType devuelto con los metadatos de un elemento del repositorio.
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	exito Atributo booleano que indica si el Servicio ha concluido de forma correcta (true) o incorrecta (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	exito Atributo booleano que indica si el Servicio ha concluido de forma correcta (true) o incorrecta (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	exito Atributo booleano que indica si el Servicio ha concluido de forma correcta (true) o incorrecta (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

Class GedeRepositoryResponse

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

Campos accesibles de la clase (get y set)
boolean	exito Atributo booleano que indica si el Servicio ha concluido de forma correcta (true) o incorrecta (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

codigo

Atributo 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 = 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
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 de transferencia
boolean	enArchivo Atributo que indica si el documento está en el gestor documental o en alguno de 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 de valores válidos para un metadato, permitiendo diferenciar entre la información que se almacena 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 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 y restricciones.

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 del metadato)
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 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 del expediente.