...
A continuación se muestran todos los métodos referentes a la gestión de documentos, carpetas , relaciones etc.
Métodos de manejo de documentos.
Método 'createDocument'
...
Almacena un documento en el gestor Documental Documentum.
...
| Expand |
|---|
|
Signatura ResultGetSubstituteDocument getSubstituteDocument(ParamGetSubstituteDocument paramGetSubstituteDocument) Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamGetSubstituteDocument (hereda de ParamBase) | csvAnnulled | String | Si | CSV del documento anulado. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
ResultGetSubstituteDocument (hereda de ResultError) | csvSubstitute | String | CSV del documento sustituto. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetSubstituteDocument Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el NIF del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU. | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con PAU | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la base de datos CCSV | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
| ParamGetSubstituteDocument paramGetSubstituteDocument = new ParamGetSubstituteDocument();
paramGetSubstituteDocument.setCsvAnnulled(“CCVXXXXXXXXXXXXXCCSV”);
ResultGetSubstituteDocument result = ccsvClient.getSubstituteDocument(paramGetSubstituteDocument)
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos de gestión de enlaces de documentos.
Método 'createDocumentLink'
...
| Expand |
|---|
|
Signatura ResultDeleteDocumentLink deleteDocumentLink(ParamDeleteDocumentLink paramDeleteDocumentLink). Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamDeleteDocumentLink(hereda de ParamBase) | csv | String | Si(1) | Csv del documento cuyo enlace se quiere borrar. | id | String | Si(1) | Identificador del documento cuyo enlace se quiere borrar. | folderId | String | Si | Identificador de la carpeta donde se borrará el enlace con el documento. |
NOTA : En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultDeleteDocumentLink |
|---|
| ResultDeleteDocumentLink |
|---|
|
ResultDeleteDocumentLink(hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultDeleteDocumentLink Código | Nombre | Descripción |
|---|
180 | ERROR_FOLDERID_NULO | Debe especificar el Id de la carpeta. | 156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
| ParamDeleteDocumentLink paramDeleteDocumentLink = new ParamDeleteDocumentLink();
paramDeleteDocumentLink.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramDeleteDocumentLink.setFolderId("09f54646511418");
ResultDeleteDocumentLink result = ccsvClient.deleteDocumentLink(paramDeleteDocumentLink);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos de búsqueda.
Método 'search'
...
Realiza la búsqueda de documentos y expedientes en el gestor documental filtrando por los metadatos de los mismos.
...
| Expand |
|---|
|
Signatura ResultGetDocumentSignatures getDocumentSignatures(ParamGetDocumentSignatures paramGetDocumentSignatures). Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamGetDocumentSignatures(hereda de ParamBase) | id | String | Si(1) | Código identificador de la firma en el repositorio documental. | csv | String | Si(1) | Código ccsv de la firma en el repositorio documental. |
NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetDocumentSignatures |
|---|
| ResultGetDocumentSignatures |
|---|
|
ResultGetDocumentSignatures(hereda de ResultError) | signatures | ArrayList<Signature> | Listado de firmas de un documento. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetDocumentSignatures. Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el identificador del documento o su CSV. | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado. | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del NIF solicitante al documento indicado. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el NIF del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con
PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 2019 | ERROR_FILE_TOO_LARGE | El documento es demasiado grande. Puede descargarlo llamando al servicio web de descarga de documentos de VAJE. | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. |
Ejemplo de invocación Invocación| Code Block |
|---|
| ParamGetDocumentSignatures paramGetDocumentSignatures = new ParamGetDocumentSignatures();
paramGetDocumentSignatures.setId("0906fca3801922bb");
ResultGetDocumentSignatures result = ccsvClient.getDocumentSignatures(paramGetDocumentSignatures);
if(result.getReturnCode().equals(ReturnCode.OK){
ArrayList<Signature> signatures = result.getSignatures();
}else{
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Método
| Anchor |
|---|
| initializeDocumentMetadata |
|---|
| initializeDocumentMetadata |
|---|
|
'initializeDocumentMetadata'
...
| Expand |
|---|
|
Signatura ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata). Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamUpdateMetadata(hereda de ParamBase) | id | String | Si(1) | Identificador del documento en Documentum. | csv | String | Si(1) | Código seguro de verificación del documento en Documentum. | metadataName | String | Si | Nombre del metadato que se quiere eliminar. | deleteAll | boolean | Si | Para metadatos repetitivos indica si se desean borrar todos los valores. | position | String | No | Indica la posición del metadato repetitivo que queremos borrar. |
NOTA: En caso de indicar el id no se deberá indicar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultUpdateMetadata |
|---|
| ResultUpdateMetadata |
|---|
|
ResultUpdateMetadata (hereda de ResultError) |
Códigos de error Los errores de la invocación se encapsulan en ResultUpdateMetadata Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Se ha producido un error con PAPIRO. | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado. | 133 | ERROR_METADATONOEXISTE | No existe el metadato buscado para ese documento. | 134 | ERROR_POSICIONMETADATONOEXISTE | No existe metadato con ese orden o posición | 158 | ERROR_VERIFY_NOT_VALUELIST | El valor indicado no está entre los valores válidos para ese metadato. | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el NIF del solicitante del servicio | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del NIF solicitante al documento indicado | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| Code Block |
|---|
| ParamDeleteMetadata paramDeleteMetadata = new ParamDeleteMetadata();
paramDeleteMetadata.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramDeleteMetadata.setMetadataName("dea_desc_descriptores");
paramDeleteMetadata.setDeleteAll(false);
paramDeleteMetadata.setPosition("1");
ResultDeleteMetadata result = ccsvClient.deleteMetadata(paramDeleteMetadata);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos de gestión de relaciones.
Método 'createRelationship'
...
| Expand |
|---|
|
Signatura ResultGetAllRelatedDocuments getAllRelatedDocuments(ParamGetAllRelatedDocuments paramGetAllRelatedDocuments). Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamGetAllRelatedDocuments(hereda de ParamBase) | id | String | Si(1) | Id del documento en Documentum cuyas relaciones queremos obtener. | csv | String | si(1) | CSV del documento cuyas relaciones queremos obtener. | role | String[] | No | Rol de las relaciones que queremos obtener. | dateStart | String | No | Fecha de inicio de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados. | dateEnd | String | No | Fecha de fin de la búsqueda que nos indicará si debemos incluir esa relación dentro de los resultados. | addContent | boolean | Si | Indica si se añaden los contenidos de los documentos. | metadataNames | String[] | No | Nombres de los metadatos que queremos que nos muestre del el objeto Document de vuelta. | searchType | DocumentRelationSearchType | Si | Tipo de búsqueda a realizar: indica si queremos recuperar los documentos hijos relacionados o los documentos padre relacionados. |
NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
| Anchor |
|---|
| ResultGetRelatedDocuments |
|---|
| ResultGetRelatedDocuments |
|---|
|
ResultGetAllRelatedDocuments(hereda de ResultError) | documentTreeNodes | DocumentTreeNode | Array de documentos relacionados encontrados con los datos de la relación |
Códigos de error Los errores de la invocación se encapsulan en ResultGetAllRelatedDocuments Código | Nombre | Descripción |
|---|
152 | ERROR_RELACION_ID_NULO | Faltan los parámetros para identificar el documento cuyas relaciones se desean buscar | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO | 153 | ERROR_RELACION_TIPOBUSQUEDA_NULO | Falta el parámetro que indica si se deben buscar los documentos hijos relacionados o los documentos padre relacionados | 148 | ERROR_DOCUMENTOS_RELACIONADOS | No se han encontrado documentos relacionados para el documento seleccionado. | 800 | ERROR_BASEDATOS_CSV | Error al conectar con la Base de Datos CSV | 191 | ERROR_INTEGRATIONAPPLICATION | Error al recuperar la información de la integración de aplicaciones. | 190 | ERROR_INTERNALACCESS_NOTALLOWED | No está permitido el acceso del NIF solicitante al documento indicado | 189 | ERROR_INTERNALACCESSCONTROL_NIFINVALID | Debe especificar el NIF del solicitante del servicio | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU. | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| Code Block |
|---|
| ParamGetAllRelatedDocuments paramGetAllRelatedDocuments = new ParamGetAllRelatedDocuments();
paramGetAllRelatedDocuments.setCsv("CSV0B31WVP5O1A21CCSV");
paramGetAllRelatedDocuments.setSearchType(DocumentRelationSearchType.CHILD);
ResultGetAllRelatedDocuments result =ccsvClient.getAllRelatedDocuments(paramGetAllRelatedDocuments);
if(result.getReturnCode().equals(ReturnCode.OK){
DocumentTreeNode = result.getDocumentTreeNode();
}else{
log.error(result.getErrorCode()+”:”+result.getErrorMessage());
} |
|
Métodos de gestión de trazas.
Método 'getTraces'
...
Recupera las trazas de un documento o expediente.
| Expand |
|---|
|
Signatura ResultGetTraces getTraces(ParamGetTraces paramGetTraces). Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamGetTraces (hereda de ParamBase) | csv | String | Si(1) | Código CSV asociado al documento del que se quieren recuperar las trazas. | id | String | Si(1) | Identificador del documento del que se quieren recuperar las trazas |
NOTA : en caso de indicar el id del documento no habrá que indicar el csv y viceversa.(1) Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
ResultGetTraces(hereda de ResultError) | metadata | HashMap<String, Object> | Información en documentum relativa a la traza |
Códigos de error Los errores de la invocación se encapsulan en ResultGetTraces Código | Nombre | Descripción |
|---|
156 | ERROR_CSV_E_ID_NULOS | Debe especificar el id de Documentum o el CSV | 127 | ERROR_CSV_NOEXISTE | No existe documento con el CSV especificado | 192 | ERROR_CONEXION_PAU | Se ha producido un error al realizar la conexión con PAU. | 141 | ERROR_CONEXION_SIU | Se ha producido un error al realizar la conexión con SIU . | 131 | ERROR_GENERICO_PAPIRO | Se ha producido un error con PAPIRO. | 101 | ERROR_CONEXION_PAPIRO | Error de conexión con documentum. | 801 | GENERIC_ERROR | Error genérico procesando la petición. | 733 | ERROR_DOCUMENTO_SUSTITUIDO | El documento ha sido anulado y sustituido por el documento: CSVXXXXXXXXXXXXXBENT | 732 | ERROR_DOCUMENTO_ANULADO | No se puede recuperar un documento anulado |
Ejemplo de invocación Invocación| Code Block |
|---|
| ParamGetTraces paramGetTraces = new ParamGetTraces();
paramGetTraces.setCsv("CSV0B31WVP5O1A21CCSV");
ResultGetTraces result = ccsvClient.getTraces(paramGetTraces);
if(result.getReturnCode().equals(ReturnCode.ERROR){
log.error(result.getErrorCode()+":"+result.getErrorMessage());
} |
|
Métodos de gestión de relaciones de agentes.
Método 'addAgentRelationships'
...
| Expand |
|---|
|
Signatura ResultGetDocumentSubtypeList getDocumentSubtypeList(ParamGetDocumentSubtypeList paramDocumentSubtypeList); Parámetros de invocación Nombre | Tipo | Obligatorio | Descripción |
|---|
ParamGetDocumentSubtypeList (hereda de ParamBase) | documentTypeName | String | Si | Nombre del tipo de documento. |
Parámetros de respuesta Nombre | Tipo | Descripción |
|---|
ResultGetDocumentSubtypeList (hereda de ResultError) | documentSubtypeList | List<DocumentSubtypeList> | Listado de los subtipos de documentos que se han recuperado a partir de los parámetros de búsqueda. |
Códigos de error Los errores de la invocación se encapsulan en ResultGetDocumentSubtypeList Código | Nombre | Descripción |
|---|
| ERROR_GET_DOCUMENTSUBTYPELIST | No existe ningún subtipo de documento para ese tipo de documento. | 130 | ERROR_BASEDATOS_CSVPAPIRO | Error al conectar con la Base de Datos CSV. | 801 | GENERIC_ERROR | Error genérico procesando la petición |
Ejemplo de invocación Invocación| Code Block |
|---|
| ParamGetDocumentSubtypeList paramGetDocumentSubtypeList = new ParamGetDocumentSubtypeList();
paramGetDocumentSubtypeList.setDocumentTypeName("documentTypeName");
ResultGetDocumentSubtypeList result = ccsvClient.documentSubtypeList(paramGetDocumentSubtypeList);
if(result.getReturnCode().equals(ReturnCode.OK){
List<DocumentSubtypeList> documentSubtypeList = result.getDocumentSubtypeList();
} |
|
Métodos obsoletos
Debido a la definición actual del servicio de gestión documentos existen varios métodos que han quedado obsoletos ya que pueden realizarse esas mismas tareas desde un método general cambiando ciertos parámetros. Con el fin de mejorar la mantenibilidad y el soporte del sistema se ha decidido que en próximas versiones se eliminaran los siguientes métodos.(En cada uno de los métodos se marca aquel que se recomienda usar en lugar del que se ha marcado como obsoleto)
...
Los servicios productores para CSVBroker son exclusivos para esta aplicación y, por tanto, no deben ser integrados por otras aplicaciones. La finalidad que implementan, obtener documentos de CCSV, es igualmente implementada en IDocumentMetadataSignatureServicePortType DocumentMetadataSignatureService, por lo que el resto de aplicaciones que deseen acceder a esta funcionalidad deberán utilizar este último servicio.
...