Servicio AdministrativeFileService

A continuación se muestran todos los métodos referentes a la administración de expedientes. Los métodos que a continuación se definen permiten realizar  las operaciones de apertura, recuperación, borrado de expedientes así como las operaciones necesarias para la incorporación de documentos o subexpedientes al expediente. 

Métodos para la gestión de expedientes

Método 'getAdministrativeFile'

Recupera un expediente a partir del CSV u oid del mismo. Permite indicar los metadatos a devolver, si se desea recuperar todos los contenidos del expediente, si se desea recuperar el índice actual y si se desea la firma asociada al índice.

Método 'getAdminFileLiteAdv'

Recupera el conjunto de datos mínimo pero suficiente para la consulta de expedientes. Permite filtrar los datos a devolver; si se desean recuperar todos los agentes del expediente, si se desean recuperar los documentos del expediente, si se desean recuperar las carpetas del expediente y si se desean recuperar los subexpedientes del expediente.

Método 'getDocumentXml'

Recupera el documento xml del expediente codificado en Base64

Método 'initializeAdministrativeFileMetadata'

Inicializa los metadatos del expediente electrónico en función de los parámetros aportados y, opcionalmente, de un documento ya existente en el gestor documental

Método 'openAdministrativeFile'

Crea un nuevo expediente en estado "Abierto" proporcionándole un documento asociado al mismo

Método 'closeAdministrativeFile'

Pasa el expediente a estado "Cerrado". En caso de contener subexpedientes también realiza el cerrado de los mismos.

Método 'reopenAdministrativeFile'

Cambia el estado de un expediente a estado abierto (si esta cerrado). En caso de contener subexpedientes, también los vuelve a abrir.

Método 'changeAdministrativeFileState'

Permite cambiar el estado del expediente actuando sobre el metadato expediente_estado. Los cambios posibles serán:

• De Abierto a Cerrado

• De Abierto a Índice para Remisión Cerrado.

NOTA: Se puede cambiar el estado de un expediente de abierto a cerrado. También se puede pasar al estado Índice para Remisión Cerrado. ¿Qué implica este cambio de pasar a Índice para Remisión Cerrado en el expediente?
Este estado fue definido en la resolución del BOE https://www.boe.es/buscar/doc.php?id=BOE-A-2011-13170 como una de los posibles opciones en el esquema de valores para el estado de un expediente en el momento del intercambio y su definición seria “Estado cuando se intercambia un expediente y en ese momento se cierra el índice para garantizar que los documentos que se mandan asociados a dicho expediente son los de ese índice en concreto”. Actualmente no se esta haciendo uso de este estado.

Método 'annulateAdminFile'

Permite anular un expediente. Este método está deprecado. En su lugar hay que usar el annulateAdminFileWithReason.

Método 'annulateAdminFileWithReason'

Permite anular un expediente añadiendo un motivo.

Métodos para la gestión de índices de expedientes.

Método 'getAdministrativeFileIndex'

Recupera el índice del expediente

Método 'regenerateAdministrativeFileIndex'

 Regenera el índice del expediente dejando el índice antiguo en un documento aparte con relación con rol: "ES VERSIÓN DE". Recuperando si se indica en los parámetros, el objeto expediente con el índice regenerado o su firma.

Métodos para la gestión de los contenidos de los expedientes.

Método 'addDocumentsToAdminFile'

Incluye la lista de documentos existentes en el gestor documental a un expediente en estado "Abierto". Si este expediente tiene carpetas puede identificarse esta para incluirlos dentro y no en la raíz del expediente. Nota: Si se quiere incluir un documento de registro, se deberá subir a la vez, todos los documentos que tenga la relación REGISTRA y/o ADJUNTA. El resultado de incluir uno o varios documentos a un expediente, crea una relación CONTIENE entre el expediente y dichos documentos. Será necesario una vez incluidos, regenerar el índice del expediente para su actualización.

Método 'addAdministrativeFileToAdminFile'

Añade el expediente existente en el gestor documental a un expediente en estado "Abierto". Para ello se deberá crear una relación entre el expediente y el subexpediente con rol "CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Método 'deleteDocumentFromAdminFile'

Quita un documento de un expediente en estado "Abierto". Para ello elimina la relación entre el expediente y el documento con rol "CONTIENE". No borra el documento de CCSV.

Método 'moveDocumentToRecycleFolder'

Servicio que elimina la relación entre un documento en cualquier estado y un expediente abierto, moviendo físicamente el documento a la carpeta dmFolder de “Papelera de reciclaje”. Si el documento se encuentra dentro de una carpeta en el expediente también eliminará la relación. El documento puede estar en cualquier estado. Se añadirá el expediente a la lista de expedientes pendientes de regeneración de su índice por el proceso nocturno.

Métodos para la gestión de carpetas.

Método 'createAdministrativeFileFolder'

Crea una carpeta dentro del expediente, para ello habrá que relacionar el expediente con la carpeta con una relación con rol CONTIENE". Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Método 'deleteAdministrativeFileFolder'

Elimina una carpeta dentro del expediente. Deberá mover las relaciones con los documentos contenidos en la carpeta directamente sobre el expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Método 'getAdministrativeFileFolder'

Obtiene una carpeta del expediente y los documentos contenidos en ella.

Método 'moveDocumentToFolder'

NOTA: Se recomienda el uso del método moveDocumentsToFolder por motivos de eficiencia.

Mueve un documento a una carpeta especificada. Si ya está dentro de una carpeta, se deberá cambiar la relación "CONTIENE" a la nueva carpeta conservando la fecha que es la de incorporación del documento al expediente. Deberá añadir el expediente a la tabla de regeneración de índices  para que el proceso nocturno se encargue de regenerarlo.

Método 'moveDocumentsToFolder'

Mueve un grupo de documentos a una carpeta especificada. Si ya está dentro de una carpeta, se deberá cambiar la relación "CONTIENE" a la nueva carpeta conservando la fecha que es la de incorporación del documento al expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Método 'removeDocumentFromFolder'

Mueve un documento de una carpeta a la raíz del expediente, cambiando la relación "CONTIENE" al expediente. Deberá añadir el expediente a la tabla de regeneración de índices para que el proceso nocturno se encargue de regenerarlo.

Método 'lastAddedContents'

Recupera los últimos documentos, expedientes, carpetas, añadidos desde la fecha indicada.