Servicios para la gestión de documentos

Servicios para la gestión de documentos

Servicio DocumentMetadataSignatureService

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.

NOTA: Se recomienda antes de crear un documento usando este método llamar al método de inicializacion de metadatos (initializeDocumentMetadata) sin enviar el contenido del documento.

Para crear expedientes o índices habría que usar los métodos referentes al servicio AdministrativeFileService

Signatura

ResultCreateDocument createDocument(ParamCreateDocument paramCreateDocument).

Parámetros de invocación

Nombre

Tipo 

Obligatorio

Descripción

Nombre

Tipo 

Obligatorio

Descripción

ParamCreateDocument(hereda de ParamBase)

document

Document

Si

Documento que se quiere almacenar en Documentum.

aclName

String

No

Nombre de la lista de control de accesos al fichero.

folderId

String

No

Identificador de la carpeta.

Parámetros de respuesta

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

ResultCreateDocument(hereda de ResultError)

id

String

Identificador en Documentum del documento creado.

Códigos de error

Los errores de la invocación se encapsulan en ResultCreateDocument

Código

Nombre

Descripción

Código

Nombre

Descripción

101

ERROR_CONEXION_PAPIRO

Error de conexión con documentum.

128

ERROR_CSV_YAEXISTE

Ya existe un documento con el CSV especificado.

130

ERROR_BASEDATOS_CSVPAPIRO

Error al conectar con la base de datos CCSV.

131

ERROR_GENERICO_PAPIRO

Se ha producido un error con PAPIRO.

155

ERROR_VERIFYDOCUMENTMETADATA

Hay errores en la validación de metadatos

168

ERROR_CREAR_ANULADO

No se puede crear un documento con estado Anulado

169

ERROR_CREAR_COPIA_SIMPLE

No se puede crear un documento con Tipo de Copia = Copia Simple y Estado distinto a Copia

181

ERROR_CREAR_SINFIRMA

No se puede crear un documento sin firmar en estado Original o Copia.

197

MENSAJE_ERROR_COPIA_SIMPLE_SIGN

Error al firmar con sello de órgano el documento cuando es tipo de copia simple

209

ERROR_MESSAGE_DIGEST

Error al generar el SHA-1

2009

ERROR_METADATA_HASH

El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado

2010

ERROR_UPDATE_METADATA_HASH

No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido

801

GENERIC_ERROR

Error genérico procesando la petición.

Ejemplo de invocación

Invocación
ParamCreateDocument paramCreateDocument = new ParamCreateDocument(); paramCreateDocument.setDocument(document);//se entiende que el "document" es un documento con sus metadatos ya inicializados. ResultCreateDocument result = ccsvClient.createDocument(paramCreateDocument); if(result.getReturnCode().equals(ReturnCode.OK){ String id = result.getId(); }else{ log.error(result.getErrorCode()+":"+result.getErrorMessage()); }

 

Método 'updateDocument'

Método deprecado, utilizar updateDocumentAdv.

Método 'updateDocumentAdv'


Actualiza un documento en el gestor documental Documentum. No permite la actualización de trazas ni agentes.

Signatura

ResultUpdateDocument updateDocumentAdv(ParamUpdateDocument paramUpdateDocument).

Parámetros de invocación

Nombre

Tipo 

Obligatorio

Descriprición

Nombre

Tipo 

Obligatorio

Descriprición

ParamUpdateDocumentAdv

document

Document

Si

Documento con los nuevos datos que se van a actualizar en Documentum.

aclName

String

NO

Nombre de la lista de control de accesos al fichero.

updateContent

boolean

Si

Indica si actualiza el contenido del documento.

updateMetadata

boolean

 

Indica si se actualizan los metadatos del documento.

traceData

TraceData

Si

Información acerca de los cambios en el documento.

Parámetros de respuesta

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

ResultUpdateDocument(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultUpdateDocument

Código

Nombre

Descripción

Código

Nombre

Descripción

156

ERROR_CSV_E_ID_NULOS

Debe especificar el id de Documentum o el CSV.

126

ERROR_CSV_NOVALIDO

Debe especificar el CSV.

2010

ERROR_UPDATE_METADATA_HASH

No se puede modificar el metadato dea_verificacion_resumen sin modificar también el contenido.

2009

ERROR_METADATA_HASH

El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado.

123

ERROR_NOMBREDOCUMENTO_NOVALIDO

Debe especificar el nombre del documento.

162

ERROR_TIPO_DOCUMENTAL_NOVALIDO

Debe especificar el tipo documental del documento.

124

ERROR_FORMATO_NOVALIDO

Debe especificar el formato del documento.

125

ERROR_CODIGOAPLICACION_NOVALIDO

Debe especificar el código de la aplicación.

155

ERROR_VERIFYDOCUMENTMETADATA

Hay errores en la validación de metadatos.

209

ERROR_MESSAGE_DIGEST

Se ha producido un error al generar el hash del documento.

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

131

ERROR_GENERICO_PAPIRO

Se ha producido un error con PAPIRO

101

ERROR_CONEXION_PAPIRO

Error de conexión con documentum

130

ERROR_BASEDATOS_CSVPAPIRO

Error al conectar con la base de datos CCSV

127

ERROR_CSV_NOEXISTE

No existe documento con el CSV especificado

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
ParamUpdateDocument paramUpdateDocument = new ParamUpdateDocument(); paramUpdateDocument.setDocument(document);//se entiende que el "document" es un documento que ya está creado. paramUpdateDocument.setAddMetadata(true); ResultUpdateDocument result = ccsvClient.updateDocument(paramCreateDocument); if(result.getReturnCode().equals(ReturnCode.ERROR){ log.error(result.getErrorCode()+":"+result.getErrorMessage()); }

 

Método 'getDocumentByCitizen'


Recupera un documento desde portales públicos a partir de su identificador.

Signatura

ResultGetDocumentByCitizen getDocumentByCitizen(ParamGetDocumentByCitizen paramGetDocumentByCitizen).

Parámetros de invocación

Nombre

Tipo 

Obligatorio

Descripción

Nombre

Tipo 

Obligatorio

Descripción

ParamGetDocumentByCitizen(hereda de ParamBase)

csv

String

Si

Código seguro de verificación del documento que se desea recuperar.

attachSignatures

boolean

No

Indica si se quieres adjuntar las firmas asociadas al documento.

Parámetros de respuesta

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

ResultGetDocumentByCitizen (hereda de ResultError)

document

Document

Documento devuelto por el servicio al realizar la consulta.

signatures

ArrayList<Signature>

Firmas asociadas al documento que se devuelve.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentByCitizen 

Código

Nombre

Descripción

Código

Nombre

Descripción

126

ERROR_CSV_NOVALIDO

Debe especificar el CSV.

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.

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
ParamGetDocumentByCitizen paramGetDocumentByCitizen = new ParamGetDocumentByCitizen(); paramGetDocumentByCitizen.setCsv("CSV5478454446454CCSV"); paramGetDocumentByCitizen.setAttachSignatures(true); paramGetDocumentByCitizen.setNif("17588888H"); ResultGetDocumentByCitizen result = ccsvClient.getDocumentByCitizen(paramGetDocumentByCitizen); if(result.getReturnCode().equals(ReturnCode.OK){ Document document = result.getDocument(); ArrayList<Signatures> signatures = result.getSignatures(); }else{ log.error(result.getErrorCode()+":"+result.getErrorMessage()); }

 

Método
'getDocument'

Método deprecado, utilizar getDocumentAdv.

Método 'getDocumentAdv'


Recupera un documento almacenado en el gestor documental a partir del identificador de Documentum o de su CSV. Da la opción de indicar si se quiere devolver el contenido del documento, los metadatos o las firmas. En el caso de indicar que nos devuelva los metadatos podemos indicar si queremos que nos devuelva los agentes y las trazas.

Signatura 

ResultGetDocumentAdv getDocumentAdv(ParamGetDocumentAdv paramGetDocumentAdv).

Parámetros de invocación

Nombre

Tipo 

Obligatorio

Descripción

Nombre

Tipo 

Obligatorio

Descripción

ParamGetDocumentAdv(hereda de ParamBase)

id

String

Si(1)

Identificador del documento en el gestor documental Documentum

csv

String

Si(1)

Código Seguro de Verificación del documento que se quiere recuperar.

addContent

boolean

No

Indica si adjunta el contenido del documento.

addMetadata

boolean

No

Indica si adjunta los metadatos del documento.

addSignatures

boolean

No

Indica si adjunta las firmas asociadas al documento.

addAgents

boolean

No(2)

Indica si adjunta los agentes asociados al documento

addTraces

boolean

No(2)

Indica si adjunta las trazas asociadas al documento.

NOTA : En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1)

NOTA 2 : En caso de indicar addAgents o addTraces a true se debe indicar el parámetro addMetadata a true.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

ResultGetDocument(hereda de ResultError)

document

DocumentAdv

Documento devuelto por el servicio al realizar la consulta.

signatures

ArrayList<Signature>

Firmas asociadas al documento que se devuelve.

Códigos de error

Los errores de la invocación se encapsulan en ResultGetDocumentAdv

Código

Nombre

Descripción

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.

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

2019

ERROR_FILE_TOO_LARGE

El documento es demasiado grande. Puede descargarlo llamando al servicio web de descarga de documentos de VAJE.

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
ParamGetDocumentAdv paramGetDocumentAdv = new ParamGetDocumentAdv(); paramGetDocumentAdv.setId("0906fca3801922bb"); paramGetDocumentAdv.addContent(true); paramGetDocumentAdv.setAttachSignatures(true); paramGetDocumentAdv.setAddMetadata(false); ResultGetDocumentAdv result = ccsvClient.getDocumentAdv(paramGetDocumentAdv); if(result.getReturnCode().equals(ReturnCode.OK){ DocumentAdv document = result.getDocument(); // en este caso document.getMetadata será nulo ya que no lo hemos recuperado ArrayList<Signatures> signatures = result.getSignatures(); }else{ log.error(result.getErrorCode()+":"+result.getErrorMessage()); }

 

Método 'deleteDocument'


Elimina un documento almacenado en el gestor documental a partir del identificador de Documentum o de su csv.

Signatura 

ResultDeleteDocument deleteDocument(ParamDeleteDocument paramDeleteDocument).

Parámetros de invocación

Nombre

Tipo 

Obligatorio

Descripción

Nombre

Tipo 

Obligatorio

Descripción

ParamDeleteDocument(hereda de ParamBase)

id

String

Si(1)

Identificador del documento en el gestor documental Documentum

csv

String

Si(1)

Código Seguro de Verificación del documento que se quiere recuperar.

NOTA : En caso de rellanar el id no habrá que rellenar el csv y viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

Nombre

Tipo

Descripción

ResultDeleteDocument (hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en ResultDeleteDocument

Código

Nombre

Descripción

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.

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

2019

ERROR_FILE_TOO_LARGE

El documento es demasiado grande. Puede descargarlo llamando al servicio web de descarga de documentos de VAJE.

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
ParamDeleteDocument paramDeleteDocument = new ParamDeleteDocument(); paramDeleteDocument.setCsv("CSV3G2ZOOM5NGAG1CCSV"); ResultDeleteDocument result = ccsvClient.deleteDocument(paramDeleteDocument); if(result.getReturnCode().equals(ReturnCode.ERROR){ log.error(result.getErrorCode()+":"+result.getErrorMessage()); }

 

Método 'getSubstituteDocument'


Recupera el CSV del documento que sustituye al documento anulado que se indica en los parámetros.

Signatura

ResultGetSubstituteDocument getSubstituteDocument(ParamGetSubstituteDocument paramGetSubstituteDocument)

Parámetros de invocación

Nombre

Tipo 

Obligatorio

Descripció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

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

Código

Nombre

Descripción