Servicio DocumentMetadataSignatureService

A continuación se muestran todos los métodos referentes a la gestión de documentos, carpetas , relaciones etc.

Métodos de manejo de documentos.

Método 'createDocument'

Almacena un documento en el gestor Documental Documentum.

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

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

Método 'updateDocument'

Método deprecado, utilizar updateDocumentAdv.

Método 'updateDocumentAdv'

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

Método 'getDocumentByCitizen'

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

Método 'getDocument'

Método deprecado, utilizar getDocumentAdv.

Método 'getDocumentAdv'

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

Método 'deleteDocument'

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

Signatura 

Método 'getSubstituteDocument'

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

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

Método 'createDocumentLink'

Permite crear un enlace de un documento existente en otra carpeta determinada.

Método 'deleteDocumentLink'

Elimina un enlace de un documento existente a una carpeta determinada.

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.

Método 'searchDQL'

Realiza una búsqueda a partir de una dql previamente almacenada gestor documental. Este método solo debe utilizarse en casos en los que sea estrictamente necesario y no haya ninguna otra manera de realizar las consultas. Consultar el siguiente enlace para obtener información de como crear la dql:

Métodos de gestión de firmas.

Método 'createAndVerifySignature'

Verifica y almacena una firma en el gestor documental almacenando adicionalmente el documento según los parámetros.

Método 'createWithoutVerifySignature'

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 createAndVerifySignature es que no se verifican las firmas que se van a insertar.

Método 'deleteSignature'

Servicio que elimina una firma vinculada a un documento.

Método 'updateAndVerifySignature'

Verifica y reemplaza una firma en el gestor documental.

Método 'updateWithoutVerifySignature'

Este método actualiza una firma existente de un documento almacenado en Documentum. La firma puede estar adjunta en el documento, entonces el contenido de éste será reemplazado por el de la firma en Documentum.

Método 'updateAndSignDocument'

Servicio que recupera las firmas asociadas a un documento.

Método 'getDocumentSignatures'

Recupera una firma del gestor documental.

Métodos de gestión de metadatos.

Método 'initializeDocumentMetadata'

Inicializa los metadatos del Documento proporcionado en función del tipo de documento o del tipo documental al que pertenezca.

Método 'initializeStructuredMetadata'

Inicializa la estructura de un documento con el nombre del metadato proporcionado.

Método 'verifyMetadataValue'

Verifica si un valor es correcto para un metadato simple proporcionado.

Método 'verifyDocumentMetadata'

Verifica si la estructura de metadatos de un documento es correcta respecto al tipo de documento indicado.

Método 'getMetadataValueList'

Devuelve la lista de valores para ese metadato.

Método 'getMetadataList'

Permite obtener la lista de metadatos de un tipo documental.

Método 'getMetadata'

Servicio que devuelve los valores de los metadatos indicados de un documento almacenado en el sistema de gestión documental.

Método 'changeState'

Modifica el valor de un metadato simple concreto state.

Método 'changeExternalLock'

Modifica el valor de un metadato simple concreto Lock.

Método 'changeDocumentVisibility'

Servicio que modifica el valor del metadato que indica si el documento es visible desde los portales públicos de acceso al ciudadano.

Método 'getDocumentTypeList'

Recupera una lista de tipos de documentos, toda la lista para el modelo de metadatos actual o sólo los destacados.

Método 'getDocumentXml'

Recupera el fichero xml del documento en base64.

Método 'updateMetadata'

Modifica los valores de los metadatos informados independientemente del tipo que sean estos.

Método 'deleteMetadata'

Borra o resetea los valores de un metadato (sea repetitivo o no).

Métodos de gestión de relaciones.

Método 'createRelationship'

Crea una relación entre documentos, pudiéndose especificar el rol de la relación, fecha de inicio y fecha de fin de la misma.

Método 'createRelationships'

Crea una relación entre varios documentos y un mismo documento padre, pudiéndose especificar el rol de la relación, fecha de inicio y fecha de fin.

Método 'deleteRelationship '

Servicio que elimina una relación entre documentos.

Método 'getRelatedDocuments'

Recupera relaciones de primer nivel entre documentos según los parámetros especificados.

Método 'getAllRelatedDocuments'

Recupera todas las relaciones entre documentos según los parámetros especificados.

Métodos de gestión de trazas.

Método 'getTraces'

 Recupera las trazas de un documento o expediente.

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

Método 'addAgentRelationships'

  Añade relaciones al documento con id o csv indicado guardando el cambio en documentum.

Método 'deleteAgentRelationship'

  Elimina una relación del documento con id o csv indicado guardando el cambio en documentum.

Método 'updateAgentRelationship'

  Reemplaza una relación del documento con id o csv indicado guardando el cambio en documentum.

Método 'getAgentRelationship'

  Devuelve la relación del documento con id o csv indicado que tenga ese role o identificationNumber o ambos

Método 'getAgentRelationships'

 Devuelve los datos de las relaciones del documento con id o csv indicado que sean de los roles indicados, estén activas o no o tengan el
 identificador de agente identificationNumber. Si no se indican roles, devuelve todas las relaciones

Método 'generateIframeToken'

 Genera un token firmado para los integradores del iframe del portal privado. Este token deberá ser devuelto para comprobar que el que carga el iframe es el mismo que lo ha pedido.

Método 'validateIframeToken'

 Valida el token que se pasa en la llamada del iframe para que el portal privado deje acceso.

Método 'getDocumentSubtypeList'

 Recupera una lista de subtipos de documentos según un tipo de documento, toda la lista para el modelo de metadatos actual o sólo los destacados.

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)

Método 'getDocumentByCSV' 

Se recomienda usar el método getDocument ya que devuelve los mismos datos si rellenamos el csv y además podemos indicar los datos que queremos que se nos devuelvan.

Método 'getDocumentContentByCSV' 

Se recomienda usar el método getDocument ya que devuelve los mismos datos si rellenamos el csv y además podemos indicar los datos que queremos que se nos devuelvan en este caso pasando el atributo addContent como true.

Método 'getDocumentById' 

Se recomienda usar el método getDocument ya que devuelve los mismos datos si rellenamos el id y además podemos indicar los datos que queremos que se nos devuelvan.

Método 'getDocumentContentById' 

Se recomienda usar el método getDocument que devuelve los mismos datos si rellenamos el id y además podemos indicar los datos que queremos que se nos devuelvan en este caso pasando el atributo addContent como true.

Método 'getDocumentMetadata' 

Se recomienda usar el método getDocument ya que podemos obtener los metadatos de un documento pasando el atributo addMetadata como true.

Método 'updateDocumentMetadata' 

Se recomienda usar el método updateDocument ya que en caso de querer actualizar los metadatos marcaremos el atributo updateMetadata como true.

Método 'updateDocumentContent' 

Se recomienda usar el método updateDocument ya que en caso de querer actualizar los metadatos marcaremos el atributo updateContent como true.

Método 'createSignature' 

Se recomienda usar el método createAndVerifySignature que realiza las mismas funcionalidades pero está más actualizado.

Método 'updateSignature' 

Se recomienda usar el método updateAndVerifySignature que realiza las mismas funcionalidades pero está más actualizado.

Método 'getSimpleMetadata' 

Se recomienda usar el método getMetadata.

Método 'getRepetitiveSimpleMetadata' 

Se recomienda usar el método getMetadata.

Método 'getRepetitiveSimpleMetadata' 

Se recomienda usar el método getMetadata.

Método 'updateSimpleMetadata' 

Se recomienda usar el método updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.

Método 'updateStructuredMetadata' 

Se recomienda usar el método updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.

Método 'updateSimpleMetadata' 

Se recomienda usar el método updateMetadata ya que puede usarse independientemente del tipo de metadato que se intenta actualizar.

Servicios CSVQueryDocumentService, CSVQueryDocumentWSService y CSVQueryDocumentCertificateService

Los servicios productores para CSVBroker son exclusivos para esta aplicación y, por tanto, no deben ser integrados por otras aplicaciones. La finalidad que implementan, obtener documentos de CCSV, es igualmente implementada en DocumentMetadataSignatureService, por lo que el resto de aplicaciones que deseen acceder a esta funcionalidad deberán utilizar este último servicio.

Estos servicios están descritos en detalle en la documentación para integradores de INSIDE: https://administracionelectronica.gob.es/ctt/inside/descargas

ANEXOS

Objetos comunes

A continuación se detallas aquellos objetos o tipos de datos que se utilizan en más de un método.

Objeto 'AdministrativeFile'

Este objeto se utiliza para almacenar la información de un expediente. Este objeto hereda las propiedades de Document.

Objeto 'CsvBrokerDocument'

Clase donde se almacena la información de los documentos electrónicos recibida a través de CSVBroker.

Objeto 'DocumentBase'

Clase donde se almacena la información de los documentos electrónicos con el contenido.

Objeto 'Document'

Clase donde se almacena la información de los documentos electrónicos con el contenido y sus metadatos. Este objeto hereda las propiedades de DocumentBase.

Objeto 'DocumentAdv'

Clase donde se almacena la información de los documentos electrónicos con el contenido y sus metadatos. Este objeto hereda las propiedades de DocumentBase.

Objeto 'DocumentRelation'

Clase donde se almacena la información de metadatos propios de una relación entre documentos.

Objeto 'AdministrativeFileRelation'

Clase utilizada para almacenar la información de la relación entre un expediente y su contenido.

Objeto 'AdministrativeFileFolder'

Clase utilizada para almacenar la información de una carpeta de expediente.

Objeto 'Signature'

Clase con la información de la firma y sus firmantes.

Objeto 'Signer'

Clase que contiene la información de un firmante.

Objeto 'Agent'

Clase donde se almacenan los metadatos de un Documento tipo Agente.

Objeto 'AgentContactData'

Clase utilizada para almacenar la información de la persona de contacto

Objeto 'AgentRelationship'

Clase donde se almacenan los metadatos de un Documento tipo relación

Objeto 'ParamBase'

Clase utilizada como base para la creación de objetos que encapsulen datos de parámetros de entrada a los servicios Web.

Objeto 'ResultError'

Clase utilizada como base para la encapsulación de errores en las invocaciones a los servicios Web. Los objetos que encapsulan los resultados de las llamadas a los servicios heredan de esta clase para devolver los errores en caso de que se presenten.

Objeto 'SignedDocument'

Clase utilizada para almacenar  un documento y su firma asociada

Objeto 'MetadataModel'

Clase utilizada para el almacenar la información de las versiones de los modelos de metadatos.

Objeto 'DocumentType'

Clase utilizada para almacenar un tipo de documento.

Objeto 'DocumentSubtypeList'

Clase con la información de un subtipo de documento.

Objeto 'DocumentumType'

Clase que almacena los datos sobre tipos documentales.

Objeto 'Metadata' 

Clase que almacena los metadatos de un tipo documental.

Objeto 'MetadataValue' 

Clase que almacena los posibles valores un metadato.

Objeto 'DocumentSearchResult' 

Clase que se utiliza para guardar la información del resultado de una búsqueda documental.

Objeto 'TraceData' 

Clase que almacena los datos a cerca de la traza de cambios que se producen en un documento.

Objeto 'Filter' 

Clase que permite almacenar los filtros de búsqueda en las búsquedas por metadatos.

Objeto 'DocumentFilter'

Clase utilizada para almacenar la información del filtro de documentos.

Objeto 'FileFilter'

Clase que se utiliza para guardar la infromacion del filtro de busqueda.

Objeto 'MetadataValueVerification'

Clase que se utiliza para almacenar el nombre del metadato y el error que ha dado la validación con respecto al modelo de metadatos actual.

Objeto 'DocumentTypeList'

Clase que contiene la información de un tipo de documento.

Objeto 'DocumentTreeNode'

Clase que almacena la información de un nodo documental

Objeto 'ParamSendJustice'

Clase que contiene parámetros adicionales para remitir a justicia.

Enum 'SearchType' 

Enum 'SortType' 

Enum 'FilterType' 

Enum 'DocumentRelationSearchType' 

Objeto 'AdministrativeFileLite' 

Clase que se utiliza para guardar los datos básicos de un expediente.

Objeto 'AdministrativeFileDocumentLite' 

Clase que se utiliza para guardar los datos básicos de los documentos de un expediente.