...
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'
...
Permite anular un expediente. Este método está deprecado. En su lugar hay que usar el annulateAdminFileWithReason.
| Expand |
|---|
|
Signatura ResultAnnulateAdminFile annulateAdminFile(ParamAnnulateAdminFile param); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamAnnulateAdminFile (hereda de ParamBase) | csv | String | Si | CSV del expediente a anular. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
ResultAnnulateAdminFile (hereda de ResultError) |
Códigos de error Código | Nombre | Descripción |
|---|
127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 1044 | ERROR_IS_NOT_ADMINFILE | El documento no es un expediente administrativo. | 1045 | ERROR_ADMINFILE_CLOSED | El expediente administrativo no se encuentra abierto. | 1046 | ERROR_ADMINFILE_ANNULATED | El expediente administrativo se encuentra ANULADO y no puede ser modificado. | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
| ParamAnnulateAdminFile paramAnnulateAdminFile = new ParamAnnulateAdminFile();
paramAnnulateAdminFile.setApplicationId("appCode");
paramAnnulateAdminFile.setAdminFileCsv("CCSVXXXXXXXXXXCSV");
ResultAnnulateAdminFile resultAnnulateAdminFile = ccsvClient.annulateAdminFile(paramAnnulateAdminFile);
|
|
Métodos para la gestión de índices de expedientes.
Método '
...
annulateAdminFileWithReason'
...
Recupera el índice del expedientePermite anular un expediente añadiendo un motivo.
| Expand |
|---|
|
Signatura ResultGetAdministrativeFileIndex getAdministrativeFileIndex(ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndexResultAnnulateAdminFileWithReason annulateAdminFileWithReason(ParamAnnulateAdminFileWithReason param); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamGetAdministrativeFileIndex ParamAnnulateAdminFileWithReason (hereda de |
ParamBasecsv(1) del índice consultaridSi(1) | Identificador del índice del expediente a consultar. | No | Motivo de la anulacion del expediente. |
Parámetros de respuesta | Anchor |
|---|
ResultGetAdministrativeFileIndex | ResultGetAdministrativeFileIndex | ResultGetAdministrativeFileIndex(hereda de ResultError)content | DataHandler | Contenido del índice electrónico del expediente electrónico administrativoCódigos de errorLos errores de la invocación se encapsulan en ResultGetAdministrativeFileIndex 1017ADMINFILE_CSV_E_ID_NULOSDebe especificar el id o el CSV del expediente | 1034CSV_NOEXISTE | No existe documento con el CSV especificado | 1044 | ERROR_IS_NOT_ADMINFILE | El documento no es un expediente administrativo. | 1045 | ERROR_ADMINFILE_ |
STATENULO índice del expediente solicitado está pendiente de regenerarse1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManagerexpediente administrativo no se encuentra abierto. | 1046 | ERROR_ADMINFILE_ANNULATED | El expediente administrativo se encuentra ANULADO y no puede ser modificado. | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
| ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndexParamAnnulateAdminFileWithReason paramAnnulateAdminFileWithReason = new ParamGetAdministrativeFileIndexParamAnnulateAdminFileWithReason();
paramGetAdministrativeFileIndexparamAnnulateAdminFileWithReason.setIdsetApplicationId("0906fca3801922bbappCode");
ResultGetAdministrativeFileIndex result = ccsvClient.getAdministrativeFileIndex(paramGetAdministrativeFileIndexparamAnnulateAdminFileWithReason.setAdminFileCsv("CCSVXXXXXXXXXXCSV");
if(resultparamAnnulateAdminFileWithReason.getReturnCode().equals(ReturnCode.OK){
DataHandler contentsetReason("Motivo de la anulación");
ResultAnnulateAdminFileWithReason resultAnnulateAdminFileWithReason = resultccsvClient.getContentannulateAdminFileWithReason();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'regenerateAdministrativeFileIndex'
...
paramAnnulateAdminFileWithReason); |
|
Métodos para la gestión de índices de expedientes.
Método 'getAdministrativeFileIndex'
...
Recupera el índice del expediente
| Expand |
|---|
|
Signatura ResultRegenerateAdministrativeFileIndex regenerateAdministrativeFileIndex(ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndexResultGetAdministrativeFileIndex getAdministrativeFileIndex(ParamGetAdministrativeFileIndex paramGetAdministrativeFileIndex); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamRegenerateAdministrativeFileIndex ParamGetAdministrativeFileIndex (hereda de ParamBase) | csv | String | Si(1) | CSV del |
expediente del que se va a regenerar el índicea consultar. | id | String | Si(1) | Identificador del índice del expediente |
del que se va a regenerar el índice.includeAdminFile | boolean | No(2) | Indica si se desea recuperar el objeto expediente con el índice regenerado | attachIndexSignature | boolean | No(2) | Indica si se desea recuperar la firma asociada al índice | NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1)NOTA 2 : Si no se indican por defecto son falsos.(2) Parámetros de respuesta ResultRegenerateAdministrativeFileIndex | ResultGetAdministrativeFileIndex |
|---|
|
|
ResultRegenerateAdministrativeFileIndex | ResultGetAdministrativeFileIndex |
|---|
|
|
ResultRegenerateAdministrativeFileIndex ResultGetAdministrativeFileIndex(hereda de ResultError) |
adminFileAdministrativeFile | Documento con el índice y metadatos del expediente | signatures | ArrayList<Signature> | Firmas asociadas al índice del expedienteDataHandler | Contenido del índice electrónico del expediente electrónico administrativo |
Códigos de error Los errores de la invocación se encapsulan en ResultRegenerateAdministrativeFileIndex ResultGetAdministrativeFileIndex 1002DOCUMENTMETADATAError del ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente | 1034 | ERROR_ADMINFILE_STATENULO | El índice del expediente solicitado está pendiente de regenerarse | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager | 801 | GENERIC_ERROR | Error genérico procesando la petición |
.1019 | ERROR_ADMINFILE_OPENORIGINALCOPIA | El expediente carece de contenido por lo que no se puede generar el índice Ejemplo de invocación Invocación| Code Block |
|---|
| ParamRegenerateAdministrativeFileIndexParamGetAdministrativeFileIndex paramRegenerateAdministrativeFileIndexparamGetAdministrativeFileIndex = new ParamRegenerateAdministrativeFileIndexParamGetAdministrativeFileIndex();
paramRegenerateAdministrativeFileIndexparamGetAdministrativeFileIndex.setId("0906fca3801922bb");
paramRegenerateAdministrativeFileIndex.setIncludeAdminFile(true);
ResultRegenerateAdministrativeFileIndexResultGetAdministrativeFileIndex result = ccsvClient.regenerateAdministrativeFileIndexgetAdministrativeFileIndex(paramRegenerateAdministrativeFileIndexparamGetAdministrativeFileIndex);
if(result.getReturnCode().equals(ReturnCode.OK){
AdministrativeFileDataHandler adminFilecontent = result.getAdminFilegetContent();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos para la gestión de los contenidos de los expedientes.
Método '
...
regenerateAdministrativeFileIndex'
...
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 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.
...
ResultRegenerateAdministrativeFileIndex regenerateAdministrativeFileIndex(ParamRegenerateAdministrativeFileIndex paramRegenerateAdministrativeFileIndex); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
|
...
ParamAddDocumentsToAdminFile (hereda de ParamBase)
...
csv
...
String
...
Si(1)
...
CSV del expediente donde se va a añadir el documento.
...
id
...
String
...
Si(1)
...
Identificador del expediente donde se va a añadir el documento.
...
contentsCsv
...
String[]
...
Si(2)
...
Array de CSV's de los documentos a añadir.
...
contentsId
...
String[]
...
Si(2)
...
Array de Identificadores de los documentos a añadir.
...
adminFileFolderCode
...
String
...
No(3)
...
Código de la carpeta donde incluir el documento.
...
adminFileFolderId
...
String
...
No(3)
...
Identificador de la carpeta donde incluir el documento.
...
organismCode
...
String
...
No
...
Código del organismo que se añadirá como gestor.
ParamRegenerateAdministrativeFileIndex (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente del expediente del que se va a regenerar el índice. | id | String | Si(1) | Identificador del expediente del que se va a regenerar el índice. | includeAdminFile | boolean | No(2) | Indica si se desea recuperar el objeto expediente con el índice regenerado | attachIndexSignature | boolean | No(2) | Indica si se desea recuperar la firma asociada al índice |
NOTA: Si se consulta por csv no se rellena el campo id y viceversa.(1) NOTA 2 : Si |
...
...
indican por defecto son falsos.(2 |
...
...
Descripción
...
Códigos de error
...
...
Código
...
Nombre
...
1017
...
ERROR_ADMINFILE_CSV_E_ID_NULOS
...
Debe especificar el id o el CSV del expediente.
...
1014
...
ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_NULOS
...
Debe especificar contentsId o contentsCsv de los documentos que contiene el expediente.
...
1015
...
ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_DUP
...
Sólo debe especificar o contentsId o contentsCsv con los documentos que contiene el expediente.
...
1028
...
ERROR_NOTEXIST_FOLDERINADMINFILE
...
No existe esa carpeta en el expediente especificado.
...
1001
...
ERROR_OPEN_STATE
...
|
|---|
| Anchor |
|---|
| ResultRegenerateAdministrativeFileIndex |
|---|
| ResultRegenerateAdministrativeFileIndex |
|---|
|
ResultRegenerateAdministrativeFileIndex (hereda de ResultError) | adminFile | AdministrativeFile | Documento con el índice y metadatos del expediente | signatures | ArrayList<Signature> | Firmas asociadas al índice del expediente |
Códigos de error Los errores de la invocación se encapsulan en ResultRegenerateAdministrativeFileIndex Código | Nombre | Descripción |
|---|
1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager |
|
...
| 801 | GENERIC_ERROR | Error genérico procesando la petición. | 1019 | ERROR_ADMINFILE_OPENORIGINALCOPIA | El expediente carece de contenido por lo que no se puede generar el índice. |
Ejemplo de invocación Invocación |
...
ParamRegenerateAdministrativeFileIndex |
|
...
paramRegenerateAdministrativeFileIndex = new |
|
...
ParamRegenerateAdministrativeFileIndex();
|
|
...
paramRegenerateAdministrativeFileIndex.setId("0906fca3801922bb");
paramRegenerateAdministrativeFileIndex.setIncludeAdminFile(true);
ResultRegenerateAdministrativeFileIndex result = ccsvClient. |
|
...
regenerateAdministrativeFileIndex( |
|
...
paramRegenerateAdministrativeFileIndex);
if(result.getReturnCode().equals(ReturnCode |
|
...
.OK){
AdministrativeFile adminFile = result.getAdminFile();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage( |
|
...
Método 'addNewDocumentsToAdminFile'
...
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.
...
ResultAddDocumentsToAdminFile addDocumentsToAdminFile(ParamAddDocumentsToAdminFile paramAddDocumentsToAdminFile); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
|
...
ParamAddDocumentsToAdminFile (hereda de ParamBase) | csv | String | Si(1) | CSV del expediente donde se va a añadir el documento. | id | String | Si(1) | Identificador del expediente donde se va a añadir el documento. |
|
...
...
...
folderId
...
String
...
No
...
Identificador de la carpeta de Documentum.
...
aclName
...
String
...
No
...
CSV's de los documentos a añadir. | contentsId | String[] | Si(2) | Array de Identificadores de los documentos a añadir. | adminFileFolderCode | String | No(3) | Código de la carpeta donde incluir |
|
...
el documento. | adminFileFolderId | String | No(3) | Identificador de la carpeta donde incluir |
|
...
el documento. | organismCode | String | No | Código del organismo que se añadirá como gestor. |
NOTA: Si se rellena el csv no se rellena el campo id y viceversa.(1) NOTA |
...
2: Si se rellena el contentsCsv no se rellena el contentsId y viceversa.(2) NOTA 3: Si se rellena el adminFileFolderCode no se rellena el adminFileFolderId y viceversa.(3) Parámetros de respuesta |
...
| ResultAddDocumentsToAdminFile |
|---|
|
|
|
...
| ResultAddDocumentsToAdminFile |
|---|
|
|
|
...
...
id
...
...
Identificadores de los documentos creados
Códigos de error Los errores de la invocación se encapsulan |
...
en ResultAddDocumentsToAdminFile Código | Nombre | Descripción |
|---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. |
|
...
1014 | ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_ |
|
...
...
contentsId o contentsCsv de los documentos que contiene el expediente. | 1015 | ERROR_ADMINFILE_CSVS_E_IDS_DOC_CONTENIDOS_DUP | Sólo debe especificar o contentsId o contentsCsv con los documentos que contiene el expediente. | 1028 | ERROR_NOTEXIST_FOLDERINADMINFILE | No existe esa carpeta en el expediente especificado. | 1001 | ERROR_OPEN_STATE | No se puede modificar la estructura de un expediente que no esté en estado Abierto. | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación |
...
ParamAddDocumentsToAdminFile |
|
...
paramAddDocumentsToAdminFile = new |
|
...
ParamAddDocumentsToAdminFile();
// |
|
...
añadimos 2 documentos ya existentes identificados por su id en una carpeta de un expediente
paramAddDocumentsToAdminFile.setId("0906fca3801922bb");
String[] ids = {"0907lca3801958jk", "0907lca3587459jk"}
paramAddDocumentsToAdminFile.setContentsId(ids);
paramAddDocumentsToAdminFile.setAdminFileFolderCode("codigoCarpeta");
ResultAddDocumentsToAdminFile result = ccsvClient. |
|
...
...
paramAddDocumentsToAdminFile);
if(result.getReturnCode().equals(ReturnCode. |
|
...
ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método 'addAdministrativeFileToAdminFile'
...
| Expand |
|---|
|
Signatura ResultMoveDocumentToRecycleFolder moveDocumentToRecycleFolder(ParamMoveDocumentToRecycleFolder paramMoveDocumentToRecycleFolder); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamMoveDocumentToRecycleFolder(hereda de ParamBase) | adminFileCsv | String | Si(1) | csv del expediente donde se encuentra el documento a mover, en caso de que el documento esté directamente en el expediente. | adminFileId | String | Si(1) | Identificador en Documentum del expediente donde se encuentra el documento a mover, en caso de que el documento esté directamente en el expediente. | documentCsv | String | Si(2) | csv del documento a mover. | documentId | String | Si(2) | Identificador en Documentum del documento a mover. | reasonToMove | String | Si | Razón por la que se solicita el movimiento a la papelera de reciclaje. |
NOTA: Si se rellena el adminFileCsv no se rellena el campo adminFileId y viceversa.(1) NOTA 2: Si se rellena el documentCsv no se rellena el campo documentId y viceversa.(2) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultMoveDocumentToRecycleFolder |
|---|
| ResultMoveDocumentToRecycleFolder |
|---|
|
ResultMoveDocumentToRecycleFolder(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultMoveDocumentToRecycleFolder Código | Nombre | Descripción |
|---|
1017 | ERROR_ADMINFILE_CSV_E_ID_NULOS | Debe especificar el id o el CSV del expediente. | 1039 | ERROR_ADMINFILE_NIF_USER_REQUESTING_MOVE_NULL | El NIF del usuario que solicita el movimiento
es obligatorio | 1007 | ERROR_ADMINFILE_CSV_E_ID_DOC_CONTENIDO_NULOS | Debe especificar el id o el CSV del documento contenido del expediente | 1040 | ERROR_ADMINFILE_REASON_TO_MOVE_NULL | La razón por la que solicita el movimiento
es obligatoria | 1029 | ERROR_NOTEXIST_DOCINADMINFILE | No existe ese documento en el expediente especificado | 1002 | ERROR_DOCUMENTMETADATA | Error del DocumentMetadataManager. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
| ParamMoveDocumentToRecycleFolder paramMoveDocumentToRecycleFolder = new ParamMoveDocumentToRecycleFolder();
paramMoveDocumentToRecycleFolder.setAdminFileCsv("CCSV54641878471CCSV");
paramMoveDocumentToRecycleFolder.setNif("00000000T");
ResultMoveDocumentToRecycleFolder result = ccsvClient.moveDocumentToRecycleFolder(paramMoveDocMétodos para la gestión de carpetas.umentToRecycleFolder);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos para la gestión de carpetas.
Método 'createAdministrativeFileFolder'
...
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.
...