Table of Contents

Servicio IDocumentMetadataSignatureServicePortType

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

...

Crea una carpeta en Documentum.

...

Expand

title	Ver detalles

Signatura

ResultCreateDocument createDocument(ParamCreateDocument paramCreateDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateDocument(hereda de ParamBase)
document	CCSV_3.5.0_Manual de integración#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

Anchor

	ResultCreateDocument
	ResultCreateDocument

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 CCSV_3.5.0_Manual de integración#ResultCreateDocumenten ResultCreateDocument

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

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultUpdateDocument updateDocument(ParamUpdateDocument paramUpdateDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateDocument (hereda de ParamBase)
document	CCSV_3.5.0_Manual de integración#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	CCSV_3.5.0_Manual de integración#TraceData TraceData	Si	Información acerca de los cambios en el documento.

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultUpdateDocument
	ResultUpdateDocument

ResultUpdateDocument(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultUpdateDocumentResultUpdateDocument

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

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultGetDocumentByCitizen getDocumentByCitizen(ParamGetDocumentByCitizen paramGetDocumentByCitizen).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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

Anchor

	ResultGetDocumentByCitizen
	ResultGetDocumentByCitizen

ResultGetDocumentByCitizen (hereda de ResultError)

document

CCSV_3.5.0_Manual de integración#Document Document

Documento devuelto por el servicio al realizar la consulta.

signatures

ArrayList<CCSV_3.5.0_Manual de integración#Signature Signature>

Firmas asociadas al documento que se devuelve.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentByCitizenen ResultGetDocumentByCitizen

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

Code Block

language	java

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());
}

...

Expand

title	Ver detalles

Signatura

ResultGetDocument getDocument(ParamGetDocument paramGetDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocument(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	Si(2)	Indica si adjunta el contenido del documento.
addMetadata	boolean	Si(2)	Indica si adjunta los metadatos del documento.
addSignatures	boolean	Si	Indica si adjunta las firmas asociadas al documento.

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

NOTA 2 : Si no se indican los datos que quieren devolverse se devuelven por defecto el contenido y los metadatos.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultGetDocument
	ResultGetDocument

ResultGetDocument(hereda de ResultError)

document

CCSV_3.5.0_Manual de integración#Document Document

Documento devuelto por el servicio al realizar la consulta.

signatures

ArrayList<CCSV_3.5.0_Manual de integración#Signature Signature>

Firmas asociadas al documento que se devuelve.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentResultGetDocument

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

Code Block

language	java

ParamGetDocument paramGetDocument = new ParamGetDocument();
paramGetDocument.setId("0906fca3801922bb");
paramGetDocument.addContent(true);
paramGetDocument.setAttachSignatures(true);
paramGetDocument.setAddMetadata(false);
ResultGetDocument result = ccsvClient.getDocument(paramGetDocument);
if(result.getReturnCode().equals(ReturnCode.OK){
	Document 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());
}

...

Expand

title	Ver detalles

ResultDeleteDocument deleteDocument(ParamDeleteDocument paramDeleteDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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

Anchor

	ResultDeleteDocument
	ResultDeleteDocument

ResultDeleteDocument (hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteDocumentResultDeleteDocument

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

Code Block

language	java

ParamDeleteDocument paramDeleteDocument = new ParamDeleteDocument();
paramDeleteDocument.setCsv("CSV3G2ZOOM5NGAG1CCSV");
ResultDeleteDocument result = ccsvClient.deleteDocument(paramDeleteDocument);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultGetSubstituteDocument getSubstituteDocument(ParamGetSubstituteDocument paramGetSubstituteDocument)

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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 CCSV_3.5.0_Manual de integración#ResultGetSubstituteDocumentResultGetSubstituteDocument

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

language	java

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

title	Ver detalles

Signatura

ResultCreateDocumentLink createDocumentLink(ParamCreateDocumentLink paramCreateDocumentLink).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateDocumentLink(hereda de ParamBase)
csv	String	Si(1)	Csv del documento que se quiere enlazar en otra carpeta.
id	String	Si(1)	Identificador del documento que se quiere enlazar en otra carpeta.
folderId	String	Si	Identificador de la carpeta donde se creará el link del 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

	ResultCreateDocumentLink
	ResultCreateDocumentLink

ResultCreateDocumentLink(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultCreateDocumentLinkResultCreateDocumentLink

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 conexion con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

ParamCreateDocumentLink paramCreateDocumentLink = new ParamCreateDocumentLink();
paramCreateDocumentLink.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramCreateDocumentLink.setFolderId("059874j45444fff4");
ResultCreateDocumentLink result = ccsvClient.createDocumentLink(paramCreateDocumentLink);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultDeleteDocumentLink deleteDocumentLink(ParamDeleteDocumentLink paramDeleteDocumentLink).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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 CCSV_3.5.0_Manual de integración#ResultDeleteDocumentLinkResultDeleteDocumentLink

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 conexion con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

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

title	Ver detalles

Signatura

ResultSearch search(ParamSearch paramSearchDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamSearch (hereda de ParamBase)
searchType	CCSV_3.5.0_Manual de integración#SearchType SearchType	Si	Tipo de búsqueda que se quiere realizar.
fileFilter	CCSV_3.5.0_Manual de integración#FileFilter FileFilter[]	Si	Tipos de documentos que se desea buscar.
metadataList	String[]	No	Lista de metadatos que se desea recuperar como resultado. Si no se especifica, se devolverá un listado de id's
int	pageNumber	No	Indica el número de página de los resultados que se quiere obtener
int	pageSize	No	Indica el tamaño de página de los resultados que se quieren obtener
sortMetadataName	String	No	Nombre del metadato por el que se quiere ordenar los resultados de la búsqueda
sortType	CCSV_3.5.0_Manual de integración#SortType SortType	No	Tipo de ordenación de los resultados por el metadato especificado
historical	Boolean	No	Indica si tiene que buscarse por históricos del organismo.

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultSearch
	ResultSearch

ResultSearch(hereda de ResultError)

documentSearchResult

CCSV_3.5.0_Manual de integración#DocumentSearchResult DocumentSearchResult[]

Listado de documentos que coinciden con la búsqueda.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultSearchResultSearch

Código	Nombre	Descripción
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.
141	ERROR_CONEXION_SIU	Se ha producido un error al realizar la conexión con SIU
101	ERROR_CONEXION_PAPIRO	Error de conexion con documentum.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

ParamSearch paramSearchDocument = new ParamSearch();
paramSearchDocument.setSearchType(SearchType.DOCUMENTO);
String[] metadataList = new String [5]; //Metadatos a devolver
metadataList[0]= DocumentumConstants.NombreMetadatos.PAEGA_IDENT_CSV;
metadataList[1]= DocumentumConstants.NombreMetadatos.PAEGA_DESC_DESCRIPCION;
metadataList[2]= DocumentumConstants.NombreMetadatos.PAEGA_IDENT_FECHA_CAPTURA;
metadataList[3]= DocumentumConstants.NombreMetadatos.PAEGA_DESC_NOMBRE;
metadataList[4]= DocumentumConstants.NombreMetadatos.PAEGA_DESC_TIPO_DOCUMENTO;
paramSearchDocument.setMetadataList(metadataList);//Se crea una lista de filtros de tipos documentales
FileFilter[] fileFilterList= new FileFilter[1];//Se crea un filtro para tipos documentales DEA
FileFilter fileFilter = new FileFilter();//Se establece como tipo documental de búsqueda el DEA
fileFilter.setDocumentumType(DocumentumConstants.TipoDocumental.DEA);//Se inicializa la lista de filtros de rama de metadatos
DocumentFilter[] documentFilterList = new DocumentFilter[1];//Se inicializa un filtro de rama
DocumentFilter documentFilter = new DocumentFilter();//Se inicializa la lista de filtros de cada filtro de rama de metadatos
Filter[] filterList = new Filter[1];//Se define un filtro
Filter filter = new Filter();
filter.setName(DocumentumConstants.NombreMetadatos.PAEGA_IDENT_CSV);//CSV
filter.setFilterType(FilterType.IN);
filter.setValue(new String[]{"CSVSJ074D05PZAK1SCDE","CSV6B41D7L4OUA801SSS"});//Se asigna el filtro por lista de CSV's a la lista de filtros
filterList[0] = filter;//Se asigna la lista de filtros al filtro de rama de metadatos
documentFilter.setFilters(filterList);//Se asigna el filtro de rama a la lista de filtros
documentFilterList[0] = documentFilter;//Se asigna la lista de filtros de rama al filtro por tipo documental
fileFilter.setDocumentFilterList(documentFilterList);//Al ser una búsqueda de documentos sólo se informa un elemento de tipo FileFilter
fileFilterList[0]= fileFilter;//Se asigna la lista de filtros de tipos documentales
paramSearchDocument.setFileFilter(fileFilterList);
paramSearch.setPageNumber(1);//Valores de paginación
paramSearch.setPageSize(10);//Valores de ordenación
paramSearch.setSortMetadataName(DocumentumConstants.NombreMetadatos.PAEGA_IDENT_FECHA_CAPTURA);
paramSearch.setSortType(SortType.ASCENDING);
ResultSearch resultSearchDocument = documentMetadataSignatureBL.getDocumentMetadataSignatureWs().search(paramSearchDocument);
if (resultSearchDocument.getReturnCode().equals(ReturnCode.ERROR)){
	log.error("Error al recuperar documentos: "+resultSearchDocument.getErrorMessage());
}else{
	DocumentSearchResult[] results = resultSearchDocument.getDocumentSearchResult();
}

...

Expand

title	Ver detalles

Signatura

ResultExecuteDQL executeDQL(ParamExecuteDQL paramExecuteDQL).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamExecuteDQL(hereda de ParamBase)
dql	String	Si	Sentencia DQL que se desea ejecutar.
metadata	ArrayList<String>	No	Metadatos que queremos que se devuelvan la búsqueda.

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultExecuteDQL
	ResultExecuteDQL

ResultExecuteDQL(hereda de ResultError)

resultDQL

ArrayList<HashMap<String, Object>>

Array con los datos que se han devuelto de realizar la consulta DQL.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultExecuteDQL.ResultExecuteDQL

Código	Nombre	Descripción
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

language	java

ParamExecuteDQL paramExecuteDQL = new ParamExecuteDQL();
String id="0906fca3801922bb";
String dql = "select * from dm_document where r_object_id='"+id+"'";
paramExecuteDQL.setDql(dql);
ResultExecuteDQL result = ccsvClient.executeDQL(paramExecuteDQL);
if(result.getReturnCode().equals(ReturnCode.OK){
	ArrayList<HashMap<String, Object>> resultDQL = result.getResultDQL();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultSearchDQL searchDQL(ParamSearchDQL paramSearchDQL).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamSearchDQL (hereda de ParamBase)
codDQL	String	Si	Identificador de la DQL
attributesRecovered	String[]	Si	Metadatos que queremos que devuelva la búsqueda.
attributesSearch	SearchAttribute[]	Si	Filtros de búsqueda
sortAttributes	SortAttribute[]	Si	Filtros de ordenación
maxResults	int	Si	Numero máximo de resultados
pagination	boolean	Si	Activar/Desactivar la paginación
resultsPerPage	int	Si	Resultados por pagina
page	int	Si	Numero de pagina a recuperar

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultSearchDQL
	ResultSearchDQL

ResultSearchDQL(hereda de ResultError)

resultDQL

ArrayList<HashMap<String, Object>>

Array con los datos que se han devuelto de realizar la consulta DQL.

numRegistrosEncontrados

int

Número total de registros obtenidos de la consulta

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultSearchDQL.ResultSearchDQL

Código	Nombre	Descripción
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

language	java

metodo = "searchDQL";
String codDQL = "ExpedientesPAEGA";
String[] atributosRecuperados = new String[13];
atributosRecuperados[0] = "r_object_id";
atributosRecuperados[1] = "dea_ident_csv";
atributosRecuperados[2] = "expediente_estado";
atributosRecuperados[3] = "expediente_fecha_apertura";
atributosRecuperados[4] = "expediente_num_expediente";
atributosRecuperados[5] = "dea_desc_descripcion";
atributosRecuperados[6] = "dea_cont_codprocedimiento";
atributosRecuperados[7] = "dea_cont_nom_procedimiento";
atributosRecuperados[8] = "expediente_csv_indice";
atributosRecuperados[9] = "expediente_fecha_cierre";
atributosRecuperados[10] = "dea_desc_tipo_documento";
atributosRecuperados[11] = "dea_desc_estado";
atributosRecuperados[12] = "dea_ident_fecha_captura";
AtributoBusqueda[] atributosBusqueda = new AtributoBusqueda[4];
AtributoBusqueda atributoBusqueda = new AtributoBusqueda();
atributoBusqueda.setName("expediente_fecha_apertura");
atributoBusqueda.setOperator(">=");
atributoBusqueda.setValue("2017-01-01T00:00:00");
atributosBusqueda[0] = atributoBusqueda;
atributoBusqueda = new AtributoBusqueda();
atributoBusqueda.setName("expediente_fecha_apertura");
atributoBusqueda.setOperator("<=");
atributoBusqueda.setValue("2017-01-31T23:59:59");
atributosBusqueda[1] = atributoBusqueda;
atributoBusqueda = new AtributoBusqueda();
atributoBusqueda.setName("agente_ident_identificacion");
atributoBusqueda.setOperator("IN");
atributoBusqueda.setValue("00000000T");
atributosBusqueda[2] = atributoBusqueda;
atributoBusqueda = new AtributoBusqueda();
atributoBusqueda.setName("relacion_rol");
atributoBusqueda.setOperator("=");
atributoBusqueda.setValue("APORTADOR");
atributosBusqueda[3] = atributoBusqueda;
AtributoOrdenacion[] atributosOrdenacion = new AtributoOrdenacion[1];
AtributoOrdenacion atributoOrdenacion = new AtributoOrdenacion();
atributoOrdenacion.setName("expediente_fecha_apertura");
atributoOrdenacion.setSentido(AtributoOrdenacion.ORDENACION_DESCENDENTE);
atributosOrdenacion[0] = atributoOrdenacion;
int maxResultados = 100000;
boolean paginacion = true;
int numResultadosPagina = 10;
int pagina = 1;
RetSearchDQL retsearchDQL = accesoSGCE.searchDQL(papiroSession, codDQL, atributosRecuperados, atributosBusqueda, atributosOrdenacion, paginacion, maxResultados, numResultadosPagina, pagina, idPeticion);

...

Expand

title	Ver detalles

Signatura

ResultCreateAndVerifySignature createAndVerifySignature(ParamCreateAndVerifySignature paramCreateAndVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateAndVerifySignature(hereda de ParamBase)
document	CCSV_3.5.0_Manual de integración#Document Document	Si(2)	Documento con la firma que se va a archivar en el repositorio documental.
signature	DataHandler	Si	Firma del documento sin codificar en base64.
id	String	Si(1)	Identificador del documento en Documentum si no hay que crearlo nuevo.
csv	String	Si(1)	CSV del documento si no hay que crearlo de nuevo.
createDocument	boolean	Si(2)	Indica si queremos crear el documento o no.
signatureType	int	Si	Tipo de firma.
initFormat	int	Si	Subformato de la firma.
finalFormat	int	No	Se indica al subformato de firma si se quiere elevar.
attachedSignature	boolean	Si	Indica si se trata de una firma adjunta.
aclName	String	No	Nombre de la lista de control de accesos al fichero.
folderId.	String	No	Identificador de la carpeta.

NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.

NOTA 2 : En caso de marcar createDocument como true habrá que proporcionar el documento completo en caso contrario o habrá que indicar el CSV o el id.

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultCreateAndVerifySignature
	ResultCreateAndVerifySignature

ResultCreateAndVerifySignature(hereda de ResultError)

signatureId

String

id de la firma guardada en documentum

documentumId

String

id del documento guardado en documentum

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultSearchResultSearch

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el id de Documentum o el CSV.
136	ERROR_FIRMA_FORMATONULO	Debe especificar el formato de la firma para su verificación.
177	ERROR_SIGNATURETYPE_INVALID	El tipo de firma indicado no se corresponde con el tipo de la firma proporcionada.
178	ERROR_SUBFORMAT_INVALID_FOR_FORMAT	El formato de firma no se puede elevar al subformato indicado.
179	ERROR_SUBFORMAT_INVALID_FOR_INITFORMAT	El subformato al que se desea elevar no puede ser inferior al formato actual de la firma proporcionada.
2005	ERROR_SUBFORMAT_INVALID	El subformato de la firma es inferior al permitido.
203	ERROR_DATAHANDLER_ARRAYBYTE_CSV	Error al pasar dataHandler a ArrayByte
138	ERROR_DOCUMENTONULO	Debe especificar el parámetro documento.
139	ERROR_FIRMANULA	Debe especificar el parámetro firma.
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
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.
1131	ERROR_ASF_VALIDATE_SIGNATURE	Error al validar la firma.
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

language	java

ParamCreateAndVerifySignature paramCreateAndVerifySignature = new ParamCreateAndVerifySignature();
paramCreateAndVerifySignature.setDocument(document);//se entiende que el objeto document es un objeto completo de un documento.
paramCreateAndVerifySignature.setSignature(signature);
paramCreateAndVerifySignature.setCreateDocument(true);//al indicar esta propiedad como verdadera no se pasan el csv y el id.
paramCreateAndVerifySignature.setSignatureType(com.tbsolutions.asf.util.Constants.CADES_FORMAT);
paramCreateAndVerifySignature.setInitFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_T));
paramCreateAndVerifySignature.setFinalFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_A));
paramCreateAndVerifySignature.setAttachedSignature(false);
ResultCreateAndVerifySignature result = ccsvClient.createAndVerifySignature(paramCreateAndVerifySignature);
if(result.getReturnCode().equals(ReturnCode.OK){
	String documentId = result.getDocumentId();
	String signatureId = result.getSignatureId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Este método del servicio almacena y asocia la firma de un documento en Documentum. El documento puede estar ya almacenado o ser almacenado a la vez. La diferencia con con el CCSV_3.5.0_Manual de integración#createAndVerifySignature createAndVerifySignature es que no se verifican las firmas que se van a insertar.

Expand

title	Ver detalles

Signatura

ResultCreateWithoutVerifySignature createWithoutVerifySignature(ParamCreateWithoutVerifySignature paramCreateWithoutVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateWithoutVerifySignature (hereda de ParamBase)
document	CCSV_3.5.0_Manual de integración#Document Document	Si(2)	Documento que se desea almacenar junto con la firma proporcionada.
id	String	Si(1)	Identificador del documento al que se desea asociar la firma, en el caso de que no haya que crearlo.
csv	String	Si(1)	CSV del documento al que se desea asociar la firma, en el caso de que no haya que crearlo.
createDocument	boolean	Si(2)	Indica si hay que almacenar primero el documento pasado por parámetro o la firma se debe vincular al documento cuyo id se proporciona.
attachedSignature	boolean	Si	Indica si se trata de una firma adjunta
aclName	String	No	Nombre de la lista de control de acceso o ACL con la que se quiere almacenar el documento. En caso de no informarse se utilizará el ACL por defecto proporcionado por CCSV.
folderId	String	No	Identificador de la carpeta donde se quiere almacenar el documento. En caso de no rellenarse se almacenará en la carpeta proporcionada por CCSV.

NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.(1)

NOTA 2 : En caso de marcar createDocument como true habrá que proporcionar el documento completo en caso contrario o habrá que indicar el CSV o el id.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultCreateWithoutVerifySignature
	ResultCreateWithoutVerifySignature

ResultCreateWithoutVerifySignature(hereda de ResultError)

documentId

String

Identificador en Documentum del documento almacenado.

signatureId

String

Identificador en Documentum de la firma asociada al documento-

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultCreateWithoutVerifySignature.ResultCreateWithoutVerifySignature

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el identificador del documento o su CSV.
203	ERROR_DATAHANDLER_ARRAYBYTE_CSV	Error al pasar dataHandler a ArrayByte.
138	ERROR_DOCUMENTONULO	Debe especificar el parámetro documento.
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.
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.
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

language	java

ParamCreateWithoutVerifySignature paramCreateWithoutVerifySignature = new ParamCreateWithoutVerifySignature();
paramCreateWithoutVerifySignature.setDocument(document);
paramCreateWithoutVerifySignature.setCreateDocument(true);
paramCreateWithoutVerifySignature.setAttachedSignature(false);
ResultCreateWithoutVerifySignature result = ccsvClient.createWithoutVerifySignature(paramCreateWithoutVerifySignature);
if(result.getReturnCode().equals(ReturnCode.OK){
	String documentId = result.getDocumentId();
	String signatureId = result.getSignatureId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultDeleteSignature deleteSignature(ParamDeleteSignature paramDeleteSignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteSignature(hereda de ParamBase)
signatureId	String	Si	Identificador de la firma en Documentum.

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultDeleteSignature
	ResultDeleteSignature

ResultDeleteSignature(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultDeleteSignature.ResultDeleteSignature

Código	Nombre	Descripción
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

language	java

ParamDeleteSignature paramDeleteSignature = new ParamDeleteSignature();
paramDeleteSignature.setId("0906fca3801922bb");
ResultDeleteSignature result = ccsvClient.deleteSignature(paramDeleteSignature);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultUpdateAndVerifySignature updateAndVerifySignature(ParamUpdateAndVerifySignature paramUpdateAndVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateAndVerifySignature(hereda de ParamBase)
aclName	String	No	Nombre de la lista de control de accesos al fichero.
folderId	String	No	Identificador de la carpeta.
csv	String	Si(1)	CSV del documento en Documentum.
id	String	Si(1)	Identificador del documento en Documentum.
signatureId	String	Si	Identificador de la firma.
attachedSignature	boolean	Si	Indica si se trata de una firma adjunta.
signatureType	int	Si	Indica el tipo de firma.
initFormat	int	Si	Subformato de la firma.
finalFormat	int	No	Se indica al subformato de firma si se quiere elevar.
signature	DataHandler	Si	Firma en binario y sin codificar en base64 que se desea verificar y almacenar en el sistema de gestión documental asociada al documento indicado sustituyendo a la firma indicada.

NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultUpdateAndVerifySignature
	ResultUpdateAndVerifySignature

ResultUpdateAndVerifySignature(hereda de ResultError)

signatureId

String

Identificador en Documentum de la firma reemplazada.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultUpdateAndVerifySignature.ResultUpdateAndVerifySignature.

Código	Nombre	Descripción
175	ERROR_IDFIRMANULA	Debe especificar el parámetro ID de la firma.
156	ERROR_CSV_E_ID_NULOS	Debe especificar el identificador del documento o su CSV.
177	ERROR_SIGNATURETYPE_INVALID	El tipo de firma indicado no se corresponde con el tipo de la firma proporcionada.
178	ERROR_SUBFORMAT_INVALID_FOR_FORMAT	El formato de firma no se puede elevar al subformato indicado.
179	ERROR_SUBFORMAT_INVALID_FOR_INITFORMAT	El subformato al que se desea elevar no puede ser inferior al formato actual de la firma proporcionada.
2005	ERROR_SUBFORMAT_INVALID	El subformato de la firma es inferior al permitido.
203	ERROR_DATAHANDLER_ARRAYBYTE_CSV	Error al pasar dataHandler a ArrayByte.
176	ERROR_SIGNATUREID_NOTFOUND	No existe la firma indicada para el documento cuyo identificador o csv se ha proporcionado.
139	ERROR_FIRMANULA	Debe especificar el parámetro firma
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
1131	ERROR_ASF_VALIDATE_SIGNATURE	Error al validar firma
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

language	java

ParamUpdateAndVerifySignature paramUpdateAndVerifySignature = new ParamUpdateAndVerifySignature();
paramUpdateAndVerifySignature.setCSV("CSV3G2ZOOM5NGAG1CCSV");
paramUpdateAndVerifySignature.setSignature(signature);
paramUpdateAndVerifySignature.setSignatureId("0906fca380173f47");
paramUpdateAndVerifySignature.setSignatureType(com.tbsolutions.asf.util.Constants.CADES_FORMAT);
paramUpdateAndVerifySignature.setInitFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_T));
paramUpdateAndVerifySignature.setFinalFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_A));
paramUpdateAndVerifySignature.setAttachedSignature(false);
ResultUpdateAndVerifySignature result = ccsvClient.updateAndVerifySignature(paramUpdateAndVerifySignature);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultUpdateWithoutVerifySignature updateWithoutVerifySignature(ParamUpdateWithoutVerifySignature paramUpdateWithoutVerifySignature).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateWithoutVerifySignature (hereda de ParamBase)
id	String	Si(1)	Identificador del documento al que se desea asociar la firma, en el caso de que no haya que crearlo.
csv	String	Si(1)	CSV del documento al que se desea asociar la firma, en el caso de que no haya que crearlo.
signature	DataHandler	Si	Firma en binario y sin codificar en base64 que se desea verificar y almacenar en el sistema de gestión documental asociada al documento indicado sustituyendo a la firma indicada.
attachedSignature	boolean	Si	Indica si se trata de una firma adjunta.
aclName	String	No	Nombre de la lista de control de acceso o ACL con la que se quiere almacenar el documento. En caso de no informarse se utilizará el ACL por defecto proporcionado por CCSV.
folderId	String	No	Identificador de la carpeta.

NOTA : En caso de indicarse el CSV no se deberá indicar el id y viceversa.

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultUpdateWithoutVerifySignature
	ResultUpdateWithoutVerifySignature

ResultUpdateWithoutVerifySignature (hereda de ResultError)

signatureId

String

Identificador en Documentum de la firma reemplazada.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultUpdateWithoutVerifySignatureResultUpdateWithoutVerifySignature.

Código	Nombre	Descripción
156	ERROR_CSV_E_ID_NULOS	Debe especificar el identificador del documento o su CSV.
203	ERROR_DATAHANDLER_ARRAYBYTE_CSV	Error al pasar dataHandler a ArrayByte
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
1131	ERROR_ASF_VALIDATE_SIGNATURE	Error al validar firma
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

language	java

ParamUpdateWithoutVerifySignature paramUpdateWithoutVerifySignature = new ParamUpdateWithoutVerifySignature();
paramUpdateWithoutVerifySignature.setCSV("CSV3G2ZOOM5NGAG1CCSV");
paramUpdateWithoutVerifySignature.setAttachedSignature(false);
ResultUpdateWithoutVerifySignature result = ccsvClient.updateWithoutVerifySignature(paramUpdateWithoutVerifySignature);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultUpdateAndSignDocument updateAndSignDocument(ParamUpdateAndSignDocument paramUpdateAndSignDocument).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamUpdateAndSignDocument (hereda de ParamBase)
document	CCSV_3.5.0_Manual de integración#Document Document	Si	Documento que se desea almacenar junto con la firma proporcionada.
signature	DataHandler	Si	Firma en binario y sin codificar en base64 que se desea verificar y almacenar en el sistema de gestión documental asociada al documento indicado..
signatureType	int	Si	Tipo de firma.
initFormat	int	Si	Subformato de la firma.
finalFormat	int	No	Se indica al subformato de firma si se quiere elevar.
attachedSignature	boolean	Si	Indica si la firma es adjunta.
updateMetadata	boolean	No	Indica si se tienen que actualizar los metadatos del documento.En este caso, el objeto document debe venir relleno con los mismos.
aclName	String	No	Nombre de la lista de control de acceso o ACL con la que se quiere almacenar el documento. En caso de no informarse se utilizará el ACL por defecto proporcionado por CCSV.
folderId	String	No	Identificador de la carpeta donde se quiere almacenar el documento. En caso de no rellenarse se almacenará en la carpeta proporcionada por CCSV.
traceData	TraceData	Si	Metadatos de la traza

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultUpdateAndSignDocument
	ResultUpdateAndSignDocument

ResultUpdateAndSignDocument (hereda de ResultError)

signatureId

String

id de la firma guardada en documentum.

documentumId

String

id del documento guardado en documentum.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultUpdateAndSignDocument.ResultUpdateAndSignDocument.

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.
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.
130	ERROR_BASEDATOS_CSVPAPIRO	Error al conectar con la base de datos CCSV
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
136	ERROR_FIRMA_FORMATONULO	Debe especificar el formato de la firma para su verificación.
177	ERROR_SIGNATURETYPE_INVALID	El tipo de firma indicado no se corresponde con el tipo de la firma proporcionada.
178	ERROR_SUBFORMAT_INVALID_FOR_FORMAT	El formato de firma no se puede elevar al subformato indicado.
179	ERROR_SUBFORMAT_INVALID_FOR_INITFORMAT	El subformato al que se desea elevar no puede ser inferior al formato actual de la firma proporcionada.
2005	ERROR_SUBFORMAT_INVALID	El subformato de la firma es inferior al permitido.
203	ERROR_DATAHANDLER_ARRAYBYTE_CSV	Error al pasar dataHandler a ArrayByte
138	ERROR_DOCUMENTONULO	Debe especificar el parámetro documento.
139	ERROR_FIRMANULA	Debe especificar el parámetro firma.
2009	ERROR_METADATA_HASH	El valor del metadato dea_verificacion_resumen está mal calculado respecto al algoritmo indicado
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.
1131	ERROR_ASF_VALIDATE_SIGNATURE	Error al validar la firma.
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

language	java

ParamUpdateAndSignDocument paramUpdateAndSignDocument = new ParamUpdateAndSignDocument();
paramUpdateAndSignDocument.setDocument(document);
paramUpdateAndSignDocument.setSignature(signature);
paramUpdateAndSignDocument.setSignatureType(com.tbsolutions.asf.util.Constants.CADES_FORMAT);
paramUpdateAndSignDocument.setInitFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_T));
paramUpdateAndSignDocument.setFinalFormat(new Long(com.tbsolutions.asf.signatureserver.util.Constants.CADES_A));
paramUpdateAndSignDocument.setAttachedSignature(false);
ResultUpdateAndSignDocument result = ccsvClient.updateAndSignDocument(paramUpdateAndSignDocument);
if(result.getReturnCode().equals(ReturnCode.OK){
	String documentId = result.getDocumentId();
	String signatureId = result.getSignatureId();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultGetDocumentSignatures getDocumentSignatures(ParamGetDocumentSignatures paramGetDocumentSignatures).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentSignatures(hereda de ParamBase)
id	String	Si(1)	Codigo 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<CCSV_3.5.0_Manual de integración#Signature Signature>

Listado de firmas de un documento.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentSignatures.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

language	java

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étodos de gestión de metadatos.

Método
Anchor
initializeDocumentMetadata
initializeDocumentMetadata
'initializeDocumentMetadata'

...

Expand

title	Ver detalles

Signatura

ResultInitializeDocumentMetadata initializeDocumentMetadata(ParamInitializeDocumentMetadata paramInitializeDocumentMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	DescripriciónDescripción
ParamInitializeDocumentMetadata(hereda de ParamBase)
document	CCSV_3.5.0_Manual de integración#Document Document	Si	Documento cuyos metadatos es preciso inicializar.
documentType	String	No(1)	Firma del documento sin codificar en base64.
procedureCode	String	No	Código de procedimiento.

NOTA: Se recomienda rellenar siempre que sea posible el tipo de dcumento(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultInitializeDocumentMetadata
	ResultInitializeDocumentMetadata

ResultInitializeDocumentMetadata(hereda de ResultError)

document

CCSV_3.5.0_Manual de integración#Document Document

Documento con los metadatos inicializados.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultInitializeDocumentMetadatade la invocación se encapsulan en ResultInitializeDocumentMetadata

Código	Nombre	Descripción
144	ERROR_INITIALIZE_DOCUMENTTYPE_NOEXISTE	No existe el tipo de documento indicado
145	ERROR_INITIALIZE_DOCUMENTUMTYPE_NOEXISTE	No existe el tipo documental indicado
146	ERROR_INITIALIZE_DOCUMENTTYPE_DOCUMENTUMTYPE_NULO	Debe indicar el tipo de documento (documentType) o el tipo documental (document.type)
143	ERROR_METADATA_MODEL	Error al recuperar la información del modelo de metadatos
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

Document document = new Document();// Establecemos el código de la aplicación
document.setApplicationCode("CCSV");// Establecemos el nombre de la aplicación
document.setApplicationName("Sistema de Comprobación de Documentos mediante CSV");
//documentContent es el DataHandler con el contenido del documento y no nos interesa pasarlo para la inicialización de metadatos
// Establecemos la extensión
document.setExtension("pdf");
/* Si no se sabe el tipo documental se puede indicar el tipo de documento documentType
dentro del ParamInitializeDocument */
document.setType("dga_doc_dea");
//Formato del documento según el catálogo de estándares
document.setFormat("PDF/A");
// Establecemos el nombre del documento
document.setName("solicitud1232243434343.pdf");
ParamInitializeDocumentMetadata paramInitializeDocumentMetada = new ParamInitializeDocumentMetadata();
paramInitializeDocumentMetadata.setDocument(document);
paramInitializeDocumentMetadata.setDocumentType("DECLARACION");
paramInitializeDocumentMetadata.setApplicationId("CCSV");
ResultInitializeDocumentMetadata result = ccsvClient.initializeDocumentMetadata(paramInitializeDocumentMetadata);
if(result.getReturnCode().equals(ReturnCode.OK){
	document = result.getDocument();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultInitializeStructuredMetadata initializeStructuredMetadata(ParamInitializeStructuredMetadata paramInitializeStructuredMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamInitializeStructuredMetadata (hereda de ParamBase)
metadataName	String	si	Nombre del metadato estructurado que se quiere inicializar.

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultInitializeStructuredMetadata
	ResultInitializeStructuredMetadata

ResultInitializeStructuredMetadata(hereda de ResultError)

document

CCSV_3.5.0_Manual de integración#Document Document

Documento con la estructura de metadatos del metadato estructurado correspondiente.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultInitializeStructuredMetadataResultInitializeStructuredMetadata

Código	Nombre	Descripción
147	ERROR_NOT_STRUCTUREDMETADATAID	El id facilitado no pertenece a un metadato estructurado.
143	ERROR_METADATA_MODEL	Error al recuperar la información del modelo de metadatos.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

ParamInitializeStructuredMetadata paramInitializeStructuredMetadata = new ParamInitializeStructuredMetadata();
paramInitializeStructuredMetadata.setMetadataName("agente");
ResultInitializeStructuredMetadata result = ccsvClient.initializeStructuredMetadata(paramInitializeStructuredMetadata);
if(result.getReturnCode().equals(ReturnCode.OK){
	Document document = result.getDocument();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultVerifyMetadataValue verifyMetadataValue(ParamVerifyMetadataValue paramVerifyMetadataValue);.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamVerifyMetadataValue(hereda de ParamBase)
metadataName	String	Si	Nombre del metadato simple que se va a verificar.
value	String	Si	Valor que se quiere validar para ese metadato.

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultVerifyMetadataValue
	ResultVerifyMetadataValue

ResultVerifyMetadataValue (hereda de ResultError)

metadataValueVerification

CCSV_3.5.0_Manual de integración#MetadataValueVerification MetadataValueVerification

Indica el nombre del metadato y el error por el cual no es válido el valor verificado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultVerifyMetadataValueResultVerifyMetadataValue

Código	Nombre	Descripción
143	ERROR_METADATA_MODEL	Error al recuperar la información del modelo de metadatos.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Code Block

ParamVerifyMetadataValue paramVerifyMetadataValue = new ParamVerifyMetadataValue();
paramVerifyMetadataValue.setMetadataName("dea_desc_estado");
paramVerifyMetadataValue.setValue("0");
ResultVerifyMetadataValue result = ccsvClient.verifyMetadataValue(paramVerifyMetadataValue);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getMetadataValueVerification().getErrorMessage());
	if (resultVerifyMetadataValue.getMetadataValueVerification() != null){
		MetadataValueVerification error = resultVerifyMetadataValue.getMetadataValueVerification();
	}
}

...

Expand

title	Ver detalles

Signatura

ResultVerifyDocumentMetadata verifyDocumentMetadata(ParamVerifyDocumentMetadata paramVerifyDocumentMetadata);.

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamVerifyDocumentMetadata(hereda de ParamBase)
document	CCSV_3.5.0_Manual de integración#Document Document	Si(1)	Documento cuyos metadatos se quiere verificar.
documentType	String	Si	Tipo de documento del documento cuyos metadatos se quiere verificar.

NOTA:El parámetro "content" debera ir obligatoriamente nulo.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultVerifyDocumentMetadata
	ResultVerifyDocumentMetadata

ResultVerifyDocumentMetadata(hereda de ResultError)

metadataValueVerificationList

List<MetadataValueVerification >

En caso de producirse errores en la
validación de los metadatos del
documento, almacena la lista de
errores de validación.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultVerifyDocumentMetadataResultVerifyDocumentMetadata

Código	Nombre	Descripción
143	ERROR_METADATA_MODEL	Error al recuperar la información del modelo de metadatos.
144	ERROR_INITIALIZE_DOCUMENTTYPE_NOEXISTE	No existe el tipo de documento indicado
145	ERROR_INITIALIZE_DOCUMENTUMTYPE_NOEXISTE	No existe el tipo documental indicado
146	ERROR_INITIALIZE_DOCUMENTTYPE_DOCUMENTUMTYPE_NULO	Debe indicar el tipo de documento (documentType) o el tipo documental (document.type)
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

ParamVerifyDocumentMetadata paramVerifyDocumentMetadata = new ParamVerifyMetadataValue();
paramVerifyDocumentMetadata.setDocument(document);
paramVerifyDocumentMetadata.setDocumentType("DECLARACION");
ResultVerifyDocumentMetadata result = ccsvClient.verifyDocumentMetadata(paramVerifyDocumentMetadata);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getMetadataValueVerification().getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultGetMetadataValueList getMetadataValueList(ParamGetMetadataValueList paramGetMetadataValueList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataValueList(hereda de ParamBase)
metadataName	String	Si(1)	Nombre del metadato tal y como se está dado de alta en Documentum.
metadataNameNTI	String	Si(1)	Nombre del metadato según la norma técnica de interoperabilidad(NTI)).
defaultOnly	boolean	Si	Indica si sólo se desea obtener el valor por defecto o todos los valores.

NOTA: En caso de rellenar el metadataName no se indicará el metadataNameNTI y viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultGetMetadataValueList
	ResultGetMetadataValueList

ResultGetMetadataValueList(hereda de ResultError)

metadataValueList

List<CCSV_3.5.0_Manual de integración#MetadataValue MetadataValue>

Lista de valores posibles del metadato indicado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetMetadataValueListResultGetMetadataValueList

Código	Nombre	Descripción
154	ERROR_METADATANAME_METADATANAMEID_NULO	Debe indicar el nombre del metadato en Documentum o el nombre del metadato según la NTI.
707	ERROR_METADATAID_NOEXISTE	No existe un metadato con el identificador especificado
143	ERROR_METADATA_MODEL	Error al recuperar la información del modelo de metadatos
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

ParamGetMetadataValueList paramGetMetadataValueList = new ParamGetMetadataValueList();
paramGetMetadataValueList.setMetadata("dea_desc_estado");
paramGetMetadataValueList.setDefaultOnly(false);
ResultGetMetadataValueList result = ccsvClient.getMetadataValueList(paramGetMetadataValueList);
if(result.getReturnCode().equals(ReturnCode.OK){
	List<MetadataValue> metadataValueList = result.getMetadataValueList();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultGetMetadataList getMetadataList(ParamGetMetadataList paramGetMetadataList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataList(hereda de ParamBase)
documentumTypeName	String	Si(1)	Nombre del tipo del documento tal y como se está dado de alta en Documentum.
documentumTypeNameNTI	String	Si(1)	Nombre del tipo del documento según la norma técnica de interoperabilidad(NTI)).

NOTA: En caso de rellenar el documentumTypeName no se indicará el documentumTypeNameNTI y viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultGetMetadataList
	ResultGetMetadataList

ResultGetMetadataList(hereda de ResultError)

metadataList

List<CCSV_3.5.0_Manual de integración#Metadata Metadata>

Lista de valores posibles del metadato indicado.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetMetadataListResultGetMetadataList

Código	Nombre	Descripción
159	ERROR_DOCUMENTUMTYPENAME_NULO	Faltan los parámetros para identificar al tipo documental.
160	ERROR_DOCUMENTUMTYPE_NOEXISTE	No existe el tipo de documento indicado.
722	ERROR_GET_METADATALIST	No existe ningún metadato para ese tipo documental.
143	ERROR_METADATA_MODEL	Error al recuperar la información del modelo de metadatos.
801	GENERIC_ERROR	Error genérico procesando la petición.

Ejemplo de invocación

Invocación

Code Block

language	java

ParamGetMetadataList paramGetMetadataList = new ParamGetMetadataList();
paramGetMetadataList.setDocumentumTypeName("dga_paega_relacion");
ResultGetMetadataList result = ccsvClient.getMetadataList(paramGetMetadataList);
if(result.getReturnCode().equals(ReturnCode.OK){
	List<Metadata> metadataList = result.getMetadataList();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultGetMetadata getMetadata(ParamGetMetadata paramGetMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetMetadataList(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	csv del documento en Documentum.
metadataNames	String	Si	Nombres de los metadatos cuyos valores se quieren recuperar.

NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultGetMetadata
	ResultGetMetadata

ResultGetMetadata(hereda de ResultError)

metadata

HashMap<String,Object>

Estructura que almacena por cada clave o nombre del metadato, los valores de los mismos.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetMetadataResultGetMetadata

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
131	ERROR_GENERICO_PAPIRO	Se ha producido un error con PAPIRO
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

language	java

ParamGetMetadata paramGetMetadata = new ParamGetMetadata();
paramGetMetadata.setCsv("CSV3G2ZOOM5NGAG1CCSV");
String[] metadataNames = new String[3];
metadataNames[0] = "dea_desc_descripcion";
metadataNames[1] = "dea_desc_descriptores";
metadataNames[2] = "relacion";
paramGetMetadata.setMetadataNames(metadataNames);
ResultGetMetadata result = ccsvClient.getMetadata(paramGetMetadata);
if(result.getReturnCode().equals(ReturnCode.OK){
	HashMap<String,Object> metadata = result.getMetadata();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultChangeState changeState(ParamChangeState paramchangeState).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamChangeState(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	csv del documento en Documentum.
state	String	Si	Nuevo valor para el estado del documento.
typeCopy	String	No	Nuevo tipo de copia del documento en Documentum.
traceData	CCSV_3.5.0_Manual de integración#TraceData TraceData	Si(2)	Datos de traza del cambio

NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1)

NOTA 2 : En caso de cambiarse el documento a estado anulado habrá que rellenar el parámetro traceData.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultChangeState
	ResultChangeState

ResultChangeState(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultChangeStateResultChangeState

Código	Nombre	Descripción
169	ERROR_CHANGESTATE	No se puede modificar el estado
197	ERROR_COPIA_SIMPLE_SIGN	Error al firmar con sello de órgano el documento cuando es tipo de copia simple.
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
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
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
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

language	java

ParamChangeState paramChangeState = new ParamChangeState();
paramChangeState.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramChangeState.setState("P");
ResultChangeState result = ccsvClient.changeState(paramChangeState);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultChangeExternalLock changeExternalLock(ParamChangeExternalLock paramChangeExternalLock).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamChangeExternalLock(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	csv del documento en Documentum.
documentLock	String	Si	Nuevo valor para el metadato bloqueo del documento.

NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultChangeExternalLock
	ResultChangeExternalLock

ResultChangeExternalLock(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultChangeExternalLockResultChangeExternalLock

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 SIU
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
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
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

language	java

ParamChangeExternalLock paramChangeExternalLock = new ParamChangeExternalLock();
paramChangeExternalLock.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramChangeExternalLock.setDocumentLock("S");
ResultChangeExternalLock result =ccsvClient.changeExternalLock(paramChangeExternalLock);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultChangeDocumentVisibility changeDocumentVisibility(ParamChangeDocumentVisibility paramChangeDocumentVisibility).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamChangeDocumentVisibility(hereda de ParamBase)
id	String	Si(1)	Identificador del documento en Documentum.
csv	String	Si(1)	csv del documento en Documentum.
documentVisibility	String	Si	Nuevo valor para la visibilidad del documento.

NOTA: En caso de indicar el id no se indicara el csv o viceversa.(1)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultChangeDocumentVisibility
	ResultChangeDocumentVisibility

ResultChangeDocumentVisibility(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultChangeDocumentVisibilityencapsulan en ResultChangeDocumentVisibility

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 SIU
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato.
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
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

language	java

ParamChangeDocumentVisibility paramChangeDocumentVisibility = new ParamChangeDocumentVisibility();
paramChangeDocumentVisibility.setCsv("CSV3G2ZOOM5NGAG1CCSV");
paramChangeDocumentVisibility.setDocumentVisibility("N");
ResultChangeDocumentVisibility result = ccsvClient.changeDocumentVisibility(paramChangeDocumentVisibility);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":”+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultGetDocumentTypeList getDocumentTypeList(ParamGetDocumentTypeList paramDocumentTypeList).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentTypeList(hereda de ParamBase)
highlight	boolean	Si	Indica si se desea obtener sólo los tipos de documentos más utilizados o todos

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultGetDocumentTypeList
	ResultGetDocumentTypeList

ResultGetDocumentTypeList(hereda de ResultError)

documentTypeList

List<CCSV_3.5.0_Manual de integración#DocumentTypeList DocumentTypeList>

Lista de tipos de documento devueltos por el servicio

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentTypeListResultGetDocumentTypeList

Código	Nombre	Descripción
130	ERROR_BASEDATOS_CSVPAPIRO	Error al conectar con la base de datos CCSV.
718	ERROR_GET_HIGHLIGHT	No existe ningún tipo de documento destacado para ese modelo de metadatos.
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

language	java

ParamGetDocumentTypeList paramGetDocumentTypeList = new ParamGetDocumentTypeList();
paramGetDocumentTypeList.setHighlight(true);
ResultGetDocumentTypeList result = ccsvClient.getDocumentTypeList(paramGetDocumentTypeList);
if(result.getReturnCode().equals(ReturnCode.OK){
	List<DocumentTypeList> documentTypeList = result.getDocumentTypeList ();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultGetDocumentXml getDocumentXml(ParamGetDocumentXml paramGetDocumentXml).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamGetDocumentXml (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.

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

	ResultGetDocumentXml
	ResultGetDocumentXml

ResultGetDocumentXml(hereda de ResultError)

base64

String

String en base64 del fichero xml.

nombre

String

Nombre por defecto del fichero resultante.

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultGetDocumentXmlResultGetDocumentXml

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

language	java

ParamGetDocumentXml paramGetDocumentXml = new ParamGetDocumentXml();
paramGetDocumentXml.setCsv("CSV0B31WVP5O1A21CCSV");
ResultGetADocumentXml result = ccsvClient.getDocumentXml(paramGetDocumentXml);
if(result.getReturnCode().equals(ReturnCode.OK){
	String base64Xml = resultGetDocumentXml.getBase64Xml();
}else{
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultUpdateMetadata updateMetadata(ParamUpdateMetadata paramUpdateMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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.
newMetadata	HashMap<String,Object>	Si	Contiene los metadatos a actualizar.
addValues	boolean	Si	Indica si los valores se añaden a los existentes: true o se sustituyen los existentes por los que se pasan: false. Solo para metadatos repetitivos.
traceData	CCSV_3.5.0_Manual de integración#TraceData TraceData	Si	Contiene los datos de la traza de los cambios que se realizan.

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 CCSV_3.5.0_Manual de integración#ResultUpdateMetadataResultUpdateMetadata

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

language	java

ParamUpdateMetadata paramUpdateMetadata = new ParamUpdateMetadata();
paramUpdateMetadata.setCsv("CSV3G2ZOOM5NGAG1CCSV");
// creamos un metadata con todos los metadatos que queremos modificar
HashMap<String, Object> metadata = new HashMap<String, Object> ();
// modificaremos el metadato de la descripción
metadata.put("dea_desc_descripcion", "Nueva descripción");
// y modificaremos un metadato repetitivo estructurado por ejemplo el de verificación
Object[] verificacion = new Object[2];
Document verifi1 = new Document();
verifi1.setType("dga_paega_verificacion");
verifi1.setName("verificacion");
HashMap<String, Object> metadataVerif1 = new HashMap<String, Object>();
metadataVerif1.put("verificacion_nombre","Nombre1");
metadataVerif1.put("verificacion_valor", "Valor1");
verifi1.setMetadata(metadataVerif1);
Document verifi2 = new Document();
verifi2.setType("dga_paega_verificacion");
verifi2.setName("verificacion");
HashMap<String, Object> metadataVerif2 = new HashMap<String, Object>();
metadataVerif2.put("verificacion_nombre","Nombre2");
metadataVerif2.put("verificacion_valor", "Valor2");
verifi2.setMetadata(metadataVerif2);
verificacion[0]=verifi1;
verificacion[1]=verifi2;
metadata.put("verificacion", verificacion);
paramUpdateMetadata.setNewMetadata(metadata);
paramUpdateMetadata.setAddValues(false);
ResultUpdateMetadata result = ccsvClient.updateMetadata (paramUpdateMetadata);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultDeleteMetadata deleteMetadata(ParamDeleteMetadata paramDeleteMetadata).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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 posicion 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 CCSV_3.5.0_Manual de integración#ResultUpdateMetadataResultUpdateMetadata

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

language	java

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

title	Ver detalles

Signatura

ResultCreateRelationship createRelationship(ParamCreateRelationship paramCreateRelationship).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateRelationship (hereda de ParamBase)
idParent	String	Si(1)	Identificador del documento padre de la relación en Documentum.
csvParent	String	Si(1)	Csv del documento padre de la relación.
idChild	String	Si(2)	Identificador del documento hijo de la relación en Documentum.
csvChild	String	Si(2)	Csv del documento hijo de la relacion.
relationship	CCSV_3.5.0_Manual de integración#DocumentRelation DocumentRelation	si	Datos propios de la relación.

NOTA : en caso de indicar el id del documento padre no habrá que indicar el csv y viceversa.(1)

NOTA 2: en caso de indicar el id del documento hijo no habrá que indicar el csv y viceversa.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultCreateRelationship
	ResultCreateRelationship

ResultCreateRelationship(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultCreateRelationshipResultCreateRelationship

Código	Nombre	Descripción
149	ERROR_RELACION_IDPADRE_NULO	Faltan los parámetros para identificar al documento Padre.
150	ERROR_RELACION_IDHIJO_NULO	Faltan los parámetros para identificar al documento Hijo
151	ERROR_RELACION_DATOS_NULO	Falta el parámetro con la información de la relación
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un erro con PAPIRO
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos CSV
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato
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

language	java

ParamCreateRelationship paramCreateRelationship = new ParamCreateRelationship();
paramCreateRelationship.setCsvParent("CSV0B31WVP5O1A21CCSV");
paramCreateRelationship.setCsvChild("CSVVV3X02P6OXAK1CCSV");
DocumentRelation relationship = new DocumentRelation();
relationship.setRole("Autoriza a")
paramCreateRelationship.setRelationship(relationship);
ResultCreateRelationship result = ccsvClient.createRelationship(paramCreateRelationship);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultCreateRelationships createRelationships(ParamCreateRelationships paramCreateRelationships).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamCreateRelationships (hereda de ParamBase)
idParent	String	Si(1)	Identificador del documento padre de la relación en Documentum.
csvParent	String	Si(1)	Csv del documento padre de la relación.
idsChild	String[]	Si(2)	Identificador de los documentos hijo de la relación en Documentum.
csvsChild	String[]	Si(2)	Csv de los documentos hijo de la relacion.
relationship	CCSV_3.5.0_Manual de integración#DocumentRelation	Si	Datos propios de la relación.

NOTA : en caso de indicar el id del documento padre no habrá que indicar el csv y viceversa.(1)

NOTA 2: en caso de indicar el id del documento hijo no habrá que indicar el csv y viceversa.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultCreateRelationships
	ResultCreateRelationships

ResultCreateRelationships(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultCreateRelationshipsResultCreateRelationships

Código	Nombre	Descripción
149	ERROR_RELACION_IDPADRE_NULO	Faltan los parámetros para identificar al documento Padre.
150	ERROR_RELACION_IDHIJO_NULO	Faltan los parámetros para identificar al documento Hijo
151	ERROR_RELACION_DATOS_NULO	Falta el parámetro con la información de la relación
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un erro con PAPIRO
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos CSV
158	ERROR_VERIFY_NOT_VALUELIST	El valor indicado no está entre los valores válidos para ese metadato
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

language	java

ParamCreateRelationship paramCreateRelationship = new ParamCreateRelationship();
paramCreateRelationship.setCsvParent("CSV0B31WVP5O1A21CCSV");
paramCreateRelationship.setCsvChild("CSVVV3X02P6OXAK1CCSV");
DocumentRelation relationship = new DocumentRelation();
relationship.setRole("Autoriza a")
paramCreateRelationship.setRelationship(relationship);
ResultCreateRelationship result = ccsvClient.createRelationship(paramCreateRelationship);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultDeleteRelationship deleteRelationship (ParamDeleteRelationship paramDeleteRelationship).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprición
ParamDeleteRelationship(hereda de ParamBase)
idParent	String	Si(1)	Identificador del documento padre de la relación en Documentum.
csvParent	String	Si(1)	Csv del documento padre de la relación.
idChild	String	Si(2)	Identificador del documento hijo de la relación en Documentum.
csvChild	String	Si(2)	Csv del documento hijo de la relación.

NOTA : en caso de indicar el id del documento padre no habrá que indicar el csv y viceversa.(1)

NOTA 2: en caso de indicar el id del documento hijo no habrá que indicar el csv y viceversa.(2)

Parámetros de respuesta

Nombre

Tipo

Descripción

Anchor

	ResultDeleteRelationship
	ResultDeleteRelationship

ResultDeleteRelationship(hereda de ResultError)

Códigos de error

Los errores de la invocación se encapsulan en CCSV_3.5.0_Manual de integración#ResultCreateRelationshipsResultCreateRelationships

Código	Nombre	Descripción
149	ERROR_RELACION_IDPADRE_NULO	Faltan los parámetros para identificar al documento Padre.
150	ERROR_RELACION_IDHIJO_NULO	Faltan los parámetros para identificar al documento Hijo
127	ERROR_CSV_NOEXISTE	No existe documento con el CSV especificado
131	ERROR_GENERICO_PAPIRO	Se ha producido un erro con PAPIRO
800	ERROR_BASEDATOS_CSV	Error al conectar con la Base de Datos CSV
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

language	java

ParamDeleteRelationship paramDeleteRelationship = new ParamDeleteRelationship();
paramDeleteRelationship.setCsvParent("CSV0B31WVP5O1A21CCSV");
paramDeleteRelationship.setCsvChild("CSVVV3X02P6OXAK1CCSV");
ResultDeleteRelationship result =ccsvClient.deleteRelationship(paramDeleteRelationship);
if(result.getReturnCode().equals(ReturnCode.ERROR){
	log.error(result.getErrorCode()+":"+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultGetRelatedDocuments getRelatedDocuments(ParamGetRelatedDocuments paramGetRelatedDocuments).

Parámetros de invocación

Nombre	Tipo		Descriprición
ParamGetRelatedDocuments(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	CCSV_3.5.0_Manual de integración#DocumentRelationSearchType 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

ResultGetRelatedDocuments(hereda de ResultError)

documentTreeNodes

CCSV_3.5.0_Manual de integración#DocumentTreeNode 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 CCSV_3.5.0_Manual de integración#ResultGetRelatedDocumentsResultGetRelatedDocuments

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

language	java

ParamGetRelatedDocuments paramGetRelatedDocuments = new ParamGetRelatedDocuments();
paramGetRelatedDocuments.setCsv("CSV0B31WVP5O1A21CCSV");
paramGetRelatedDocuments.setSearchType(DocumentRelationSearchType.CHILD);
ResultGetRelatedDocuments result = ccsvClient.getRelatedDocuments(paramGetRelatedDocuments);
if(result.getReturnCode().equals(ReturnCode.OK){
	DocumentTreeNodes[] = result.getDocumentTreeNodes();
}else{
	log.error(result.getErrorCode()+”:”+result.getErrorMessage());
}

...

Expand

title	Ver detalles

Signatura

ResultGetAllRelatedDocuments getAllRelatedDocuments(ParamGetAllRelatedDocuments paramGetAllRelatedDocuments).

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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	CCSV_3.5.0_Manual de integración#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

CCSV_3.5.0_Manual de integración#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 CCSV_3.5.0_Manual de integración#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

language	java

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 relaciones de agentes.

Método 'addAgentRelationship'

...

Expand

title	Ver detalles

Signatura

ResultGetDocumentSubtypeList getDocumentSubtypeList(ParamGetDocumentSubtypeList paramDocumentSubtypeList);

Parámetros de invocación

Nombre	Tipo	Obligatorio	Descriprició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<CCSV_3.5.0_Manual de integración#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

language	java

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)

...

Se recomienda usar el método CCSV_3.5.0_Manual de integración#updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.

Servicio ISendAdminFileCloudWSPortType

El protocolo de Remisión en la Nube pretende ser un estándar para el intercambio de expedientes electrónicos en formato ENI (Esquema Nacional de Interoperabilidad) entre dos administraciones públicas cualesquiera, sean estas administrativas o judiciales.

...

Nombre	Tipo	Descripción
adminFileContent	Object	Contenido del expediente.Se estable como object ya que puede ser CCSV_3.5.0_Manual de integración#Document Document , CCSV_3.5.0_Manual de integración#AdministrativeFile o CCSV_3.5.0_Manual de integración#AdministrativeFileFolder
relations	AdministrativeFileRelation[]	Relaciones del documento relacionado con el expediente. Puede venir vacío si el expediente no tiene relaciones.

...

Nombre	Tipo	Descripción
document	CCSV_3.5.0_Manual de integración#Document Document	Contiene los metadatos asociados al documento
documentRelation	CCSV_3.5.0_Manual de integración#DocumentRelation	Contiene la relación del documento con el documento con el padre.
documentTreeNodes	CCSV_3.5.0_Manual de integración#DocumentTreeNode[]	Contiene el resto de nodos documentales asociados al actual.

...

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

Servicio IDocumentMetadataSignatureServicePortType

Métodos de manejo de documentos.

Método 'createFolder'

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Métodos de gestión de enlaces de documentos.

Método 'createDocumentLink'

Invocación

Invocación

Métodos de búsqueda.

Método 'search'

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Métodos de gestión de metadatos.

Método AnchorinitializeDocumentMetadatainitializeDocumentMetadata'initializeDocumentMetadata'

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Invocación

Métodos de gestión de relaciones.

Método 'createRelationship'

Invocación

Invocación

Invocación

Invocación

Invocación

Métodos de gestión de relaciones de agentes.

Método 'addAgentRelationship'

Invocación

Métodos obsoletos

Servicio ISendAdminFileCloudWSPortType

Método
Anchor
initializeDocumentMetadata
initializeDocumentMetadata
'initializeDocumentMetadata'