Manual Capa De Servicios CSGD CAIB Gestión Al V01r03
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 169 [warning: Documents this large are best viewed by clicking the View PDF Link!]
- 1 Objeto
- 2 Alcance
- 3 Siglas y Acrónimos
- 4 Documentos de Referencia
- 5 Visión Global de la Arquitectura de la Solución
- 6 Catálogo de Servicios
- 6.1 Servicios Repositorio y Migración
- 6.1.1 Tipos de Datos Comunes
- 6.1.2 Servicios Repositorio
- 6.1.2.1 CreateDocument
- 6.1.2.2 CreateDraftDocument
- 6.1.2.3 CreateFile
- 6.1.2.4 CreateChildFile
- 6.1.2.5 CreateFolder
- 6.1.2.6 DocumentSearch
- 6.1.2.7 EasyDocumentSearch
- 6.1.2.8 FileSearch
- 6.1.2.9 EasyFileSearch
- 6.1.2.10 GetDocument
- 6.1.2.11 GetFile
- 6.1.2.12 GetFolder
- 6.1.2.13 GetDocVersionList
- 6.1.2.14 GetFileVersionList
- 6.1.2.15 ValidateDocument
- 6.1.2.16 SetDocument
- 6.1.2.17 SetFile
- 6.1.2.18 SetFolder
- 6.1.2.19 SetFinalDocument
- 6.1.2.20 CopyDocument
- 6.1.2.21 CopyFolder
- 6.1.2.22 LinkDocument
- 6.1.2.23 LinkFile
- 6.1.2.24 LinkFolder
- 6.1.2.25 MoveDocument
- 6.1.2.26 MoveChildFile
- 6.1.2.27 MoveFolder
- 6.1.2.28 RemoveDocument
- 6.1.2.29 RemoveFile
- 6.1.2.30 RemoveFolder
- 6.1.2.31 GetENIDocument
- 6.1.2.32 GenerateDocCSV
- 6.1.2.33 ExportFile
- 6.1.2.34 GenerateFileIndex
- 6.1.2.35 GrantPermissionsOnDocs
- 6.1.2.36 GrantPermissionsOnFiles
- 6.1.2.37 GrantPermissionsOnFolders
- 6.1.2.38 CancelPermissionsOnDocs
- 6.1.2.39 CancelPermissionsOnFiles
- 6.1.2.40 CancelPermissionsOnFolders
- 6.1.2.41 LockDocument
- 6.1.2.42 LockFile
- 6.1.2.43 LockFolder
- 6.1.2.44 UnlockDocument
- 6.1.2.45 UnlockFile
- 6.1.2.46 UnlockFolder
- 6.1.2.47 GetEcmAutTicket
- 6.1.2.48 DispatchDocument
- 6.1.2.49 CloseFile
- 6.1.2.50 ReopenFile
- 6.1.3 Servicios Migración
- 6.2 Servicios Firma Electrónica
- 6.1 Servicios Repositorio y Migración
- 7 Configuración y Recursos
- 8 Librerías y Plugins Java
- Anexos
Oficina Tècnica de
Direcció de Projecte
[MANUAL CAPA DE
SERVICIOS CSGD]
01/01/16
Serveis d’AE de la
CAIB
Control de Comprobación y Aceptación
Documento nº: CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Revisión: 004
Fecha: 23/01/2017
Aprobado por: <pendiente>
Control de Modificaciones
Revisión Autor Fecha Descripción del Cambio
001 (v01r00) RICOH 18/08/201
6Versión inicial del documento
002 (v01r01) RICOH 27/09/201
6
Se incluyen nuevos recursos
(XSLT y Sequences), y se
modifican otros ya existentes
(Scripts).
Modificación peticiones de
servicios de búsqueda de
documentos y expedientes, y
transformación de documentos
migrados.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 2 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
Revisión Autor Fecha Descripción del Cambio
003 (v01r02) RICOH 10/10/201
6
Corrección de erratas menores.
Proceso de generación e
instalación de librerías y puglins
en componentes WSO2.
Especificación de tipos de datos,
detallando el retorno opcional de
arrays como objetos simples (lista
de un único elemento).
Modificación del tipo de datos de
la entidad documental agregación
documental, cm:folder por
eni:agregacionDoc.
Se incluyen nuevos recursos XSLT.
Modificaciones de los servicios
getDocument, createDocument,
copyDocument y
dispatchDocument.
Se habilita la posibilidad de tener
múltiples valores para los
metadatos perternecientes al
aspecto gdib:trasladado.
Se añade el perfil de firma BES.
Se incluye anexo donde se
detallan los formatos de firma
electrónica admitidos.
004 (v01r03) RICOH 23/01/201
7
Modificación de la configuración
de seguridad en la invocación de
servicios de la capa GDIB.
Modificación del servicio
transformMigratedDoc, valor del
parámetro de entrada fileId.
Servicio closeFile, comentarios
adicionales.
Tipo de datos adicional para
operaciones sobre expedientes en
RM (“rma:recordFolder”).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 3 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
Control de Distribución
Propiedad del documento:
Este documento pertenece a GOVERN DE LES ILLES BALEARS y posee un carácter
de PRIVADO para uso y distribución dentro del ámbito de la DIRECCIÓN GENERAL DE
DESARROLLO TECNOLÓGICO, según se recoge en la declaración de privacidad.
Declaración de privacidad:
El contenido de este documento está clasificado como restringido y no debe ser
distribuido, copiado, modificado o reproducido, total o parcialmente, de forma alguna sin
consentimiento expreso.
La distribución de éste documento queda restringida a lo especificado dentro del control
de distribución, ya sea de forma electrónica o papel. Cualquier contenido distribuido
fuera del contexto definido será responsabilidad de los usuarios de información.
Copias Electrónicas:
La distribución de este documento ha sido controlada a través del sistema de
información.
Control de distribución electrónica:
Nombre/Cargo Organización Fecha
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 4 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
Contenido
1 Objeto.............................................................................................................9
2 Alcance............................................................................................................9
3 Siglas y Acrónimos..........................................................................................10
4 Documentos de Referencia...............................................................................11
5 Visión Global de la Arquitectura de la Solución....................................................13
6 Catálogo de Servicios......................................................................................14
6.1 Servicios Repositorio y Migración..............................................................................14
6.1.1 Tipos de Datos Comunes...................................................................................................15
6.1.2 Servicios Repositorio.........................................................................................................33
6.1.3 Servicios Migración.........................................................................................................145
6.2 Servicios Firma Electrónica.....................................................................................148
6.2.1 DSSAfirmaArchiveRetrieval..............................................................................................148
6.2.2 DSSAfirmaSign...............................................................................................................150
6.2.3 DSSAfirmaVerify.............................................................................................................151
6.2.4 DSSAfirmaVerifyCertificate...............................................................................................152
6.2.5 DSSAsyncRequestStatus..................................................................................................153
6.2.6 DSSBatchVerifyCertificate................................................................................................155
6.2.7 DSSBatchVerifySignature.................................................................................................156
6.2.8 GetInfoCertificate...........................................................................................................157
7 Configuración y Recursos...............................................................................159
7.1 Definición de Servicios SOAP (WSDL).......................................................................160
7.2 Políticas de Seguridad (WS-Policy)..........................................................................163
7.3 Scripts (JavaScripts).............................................................................................164
7.4 Plantillas Secuencia (Template Sequence).................................................................168
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 5 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
7.5 Transformaciones XSL (XSLT).................................................................................179
8 Librerías y Plugins Java..................................................................................191
Anexos..............................................................................................................194
A.1 Metadatos y Aspectos de Entidades Documentales.....................................................194
A.2 Formatos de firma electrónica admitidos..................................................................213
A.3 Esquema índice electrónico foliación........................................................................214
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 6 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
1 Objeto
El objeto del presente documento es describir y especificar los servicios que habilitan la
integración de los SSII del Govern de les Illes Balears con el Sistema de Gestión
Documental y la plataforma @firma v6, denominada capa de servicios CSGD.
2 Alcance
El contenido del presente documento cubre los siguientes aspectos de la definición de la
capa de servicios CSGD:
Presentar la relación de servicios desplegados, organizándolos
modularmente, y especificando para cada uno de ellos lo siguiente:
Breve descripción funcional.
Puntos de acceso al servicio.
Protocolos de invocación y mensajería.
Configuración (recursos, componentes, seguridad, etc.).
Estructura de la petición y la respuesta del servicio.
Identificar los recursos y configuración requeridos por la capa de servicios para
su correcto funcionamiento.
Enumerar los componentes y librerías requeridos por los servicios para su
correcto funcionamiento.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 8 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
3 Siglas y Acrónimos
API Application Programming Interface
CAIB Comunidad Autónoma de les Illes Balears
CMIS Content Management Interoperability Services
CSV Código Seguro de Verificación
ENI Esquema Nacional de Interoperabilidad
ESB Enterprise Service bus
JSON JavaScript Object Notation
NTI Norma Técnica de Interoperabilidad
OSGi Open Services Gateway initiative
REST Representational State Transfer
SOAP Simple Object Access Protocol
SGD Sistema de Gestión Documental
SSII Sistemas de Información
URI Uniform Resource Identifier
WS Web Service
WSDL Web Services Description Language
XML eXtensible Markup Language
XSLT Extensible Stylesheet Language Transformations
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 9 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
4 Documentos de Referencia
Normativa de aplicación al documento y documentación de apoyo
Id Documento Nombre Documento Descripción
Manuales Web
Services @firma
v6
@Firma-Global-
XMLSOAP_PROFIL
E_DSS.
@Firma-Global-
XMLSOAP-MAN
Manuales que definen y describen los
Web Services publicados por la
plataforma @firma v6.
Normas Técnicas
de
Interoperabilidad
http://administracionelec
tronica.gob.es/pae_Home
/pae_Estrategias/pae_Int
eroperabilidad_Inicio/pae
_Normas_tecnicas_de_int
eroperabilidad.html
Normas Técnicas de Interoperabilidad
publicadas por ENI.
Documentación elaborada por RICOH durante la fase de análisis
Id Documento Nombre Documento Descripción
Análisis funcional
del Archivo
Digital
CAIB-GestiónDocumental
Análisis Funcional Archivo
Digital v05r00.pdf
Documento que refleja el análisis
funcional del Archivo Digital (DM +
RM).
Diseño técnico
del Archivo
Digital
CAIB-GestiónDocumental
Diseño Técnico Archivo
Digital v01r03.pdf
Documento que especifica el diseño
técnico del Archivo Digital (DM + RM).
Plan operativo de
migración
documental
CAIB-GestiónDocumental
Plan Operativo del
Proceso de Migración
Documental v01r04.pdf
Documento que define y detalla el
proceso de migración documental.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 10 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
5 Visión Global de la Arquitectura de la Solución
El siguiente diagrama ilustra gráficamente la arquitectura de la solución de Archivo
Digital, así como la interacción entre los diferentes actores que la conforman:
Ilustración 1: Arquitectura de la solución
En la arquitectura de la solución se pueden identificar 3 módulos principales:
Plataforma @firma v6, que pública servicios de firma electrónica y validación de
certificados electrónicos.
Módulo GDIB desplegado en el Sistema Gestor Documental Alfresco que
implementa la capa de servicios de gestión documental.
Módulo CSGD desplegado en el ESB que implementa servicios para la interacción
desde los SSII del Govern de les Illes Balears, tanto con la capa de servicios del
gestor documento, GDIB, como con los servicios desplegados por la plataforma
@firma v6.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 11 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6 Catálogo de Servicios
6.1 Servicios Repositorio y Migración
En este apartado se detalla y describe los servicios de la capa CSGD dispuestos y
publicados para la interacción con el Sistema de Gestión Documental y la consulta y
tratamiento de las entidades documentales almacenadas en el mismo.
Para cada uno de estos servicios se aportará la siguiente información:
Denominación. Nombre del servicio.
Descripción. Se detalla el propósito o funcionalidad desempeñada por el servicio.
Información de invocación. Datos requeridos para el uso e invocación del
servicio. La información incluida es la siguiente:
EndPoint. URL de acceso al servicio.
Protocolo. Protocolo de comunicación e invocación del servicio
(SOAP/XML o REST/JSON)
Seguridad. Especifica si la invocación del servicio esta securizada
mediante algún mecanismo, y, en caso afirmativo, los datos de
configuración del mismo.
Petición. Especificación del cuerpo de la petición del servicio. Se empleará
la siguiente nomenclatura para definir los tipos de datos intercambiados,
tanto en las peticiones, como en las respuestas de los servicios:
*. Indicador empleado para especificar que el dato, campo o
atributo es requerido.
?. Indicador empleado para especificar que el dato, campo o
atributo es opcional.
[tipoDatos]. Indicador utilizado para especificar que el dato,
campo o atributo es una lista de elementos, cuyo tipo de datos es
“tipoDatos”.
(c1|c2|…). Expresión empleada para especificar que c1 o c2 o…,
pueden ser establecidos. Es posible combinar esta expresión con
las anteriores.
Respuesta. Especificación del cuerpo de la petición del servicio.
Configuración ESB. Se enumeran en esta sección otros servicios y recursos,
desplegados en el componente ESB, requeridos para completar la funcionalidad
del servicio. Se detallará la siguiente información:
Servicios Backend. Listado de servicios que requiere el servicio para
lograr su correcto funcionamiento.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 12 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
Recursos. Listado de recursos requeridos por el servicio para lograr su
correcto funcionamiento (JavaScript, XSLT, Template Sequences, etc.).
Información adicional sobre el servicio.
6.1.1 Tipos de Datos Comunes
Se definen en este apartado, en notación JSON, los tipos de datos comunes utilizados
por los servicios de la capa CSGD dispuestos para operar sobre los repositorios
documentales alojados en el SGD.
UID
Descripción
Tipo de dato simple, cuyo tipo base es una cadena de caracteres, que
identifica unívocamente un nodo en el SGD, independientemente del tipo de
datos al que pertenezca (eni:documento, eni:expediente, etc.).
Representación “b24eeb92-aed8-439c-af4d-db25785b2fc4”
Información
adicional N/A
VersionUID
Descripción
Tipo de dato simple especifico de la capa de servicio GDIB, cuyo tipo base
es una cadena de caracteres, que identifica una versión de un nodo en el
SGD, independientemente del tipo de datos al que pertenezca
(eni:documento, eni:expediente, etc.).
Estos identificadores se componen por $IdVersion@$UID, donde $IdVersión
es el identificador de versión, y $UID el identificador de un nodo en el SGD.
Representación “1.1@b24eeb92-aed8-439c-af4d-db25785b2fc4”
Información
adicional N/A
RelativePathUID
Descripción
Tipo de dato simple especifico de la capa de servicio GDIB, cuyo tipo base
es una cadena de caracteres, que identifica un nodo en el SGD,
independientemente del tipo de datos al que pertenezca (eni:documento,
eni:expediente, etc.), mediante una relativa al mismo, calculada a partir de
algún elemento contendor, como por ejemplo un expediente.
Estos identificadores presentan las siguientes restricciones al ser formados:
El carácter de separación para formar la ruta “/”.
El primer carácter no puede ser “/”.
El primer nodo de la ruta debe corresponderse con el UID de un
nodo (típicamente un expediente).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 13 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
RelativePathUID
Representación “b24eeb92-aed8-439c-af4d-db25785b2fc4/ruta/al/nodo”
Información
adicional N/A
RequestNodeId
Descripción
Cadena de caracteres que identifica unívocamente un nodo del SGD,
independientemente del tipo de datos al que pertenezca.
Este identificador es empleado principalmente en las peticiones de los
servicios.
Representación (UID | VersionUID | RelativePathUID)*
Información
adicional N/A
RequestMigratedDocId
Descripción
Tipo de datos compuesto que representa un identificador de un documento
migrado desde ValCert. Incluye la siguiente información:
applicationId. Nombre de la aplicación que custodió el documento.
externalId. Identificador asignado por la aplicación que custodió el
documento.
Representación
{
“applicationId”: STRING*,
“externalId”: STRING*
}
Información
adicional N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 14 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
Metadata
value. Cadena de caracteres que representa el valor de la propiedad
o metadato.
Representació
n
{
“qname”: STRING*,
“value”: (STRING | NUMBER | BOOLEAN | [(STRING|NUMBER|
BOOLEAN)])?
}
Información
adicional
El valor de metadatos cuyo tipo de datos sea DATE o DATETIME, será
representado en formato cadena, según lo establecido por el estándar ISO-
8601, fecha y hora completa (YYYY-MM-DDTHH:mm:ss.sssZ).
Content
Descripción
Tipo de datos compuesto que representa un contenido binario de un nodo
en el SGD, como su contenido o firma electrónica. Incluye la siguiente
información:
binaryType. Tipo de contenido del nodo. Los valores posibles son
los siguientes: CONTENT, SIGNATURE, VALCERT_SIGNATURE,
MIGRATION_SIGNATURE y MIGRATION_ZIP.
mimetype. Tipo mime del contenido del nodo, por ejemplo
“text/plain”.
content. Cadena de caracteres, codificada en base64, que
representa el contenido.
encoding. Juego de caracteres del contenido (“UTF-8”).
Representación
{
“binaryType”: (CONTENT | SIGNATURE | VALCERT_SIGNATURE |
MIGRATION_SIGNATURE | MIGRATION_ZIP)*,
“mimetype”: STRING?,
“content”: STRING?,
“encoding”: STRING?
}
Información
adicional N/A
DocumentNode
Descripción Tipo de datos compuesto que representa un nodo de tipo eni:documento o
gdib:documentoMigrado. Incluye la siguiente información:
id. Identificador, tipo UID, del documento.
name. Nombre del documento.
type. Tipo de entidad documental. El tipo será representado
mediante su nombre cualificado, bien de forma extendida
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 15 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 16 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
DocumentNode
“metadataCollection”: (Metadata | [Metadata])?,
“aspects”: (STRING | [STRING])?,
“binaryContents”: (Content | [Content])?
}
Información
adicional
Para más información sobre el contenido y firmas electrónicas de un
documento, consultar el documento Diseño técnico del Archivo Digital.
Los aspectos que pueden ser establecidos actualmente son los
siguientes: “eni:firmadoBase”, “eni:firmado”, “eni:interoperable”,
“eni:registrable”, “eni:transferible”, “gdib:borrador”,
“gdib:firmadoMigracion”, “gdib:transformado” y “gdib:trasladado”.
summaryInfoNode
Descripción
Tipo de datos compuesto que encapsula, de forma resumida, la información
sobre una un nodo almacenado en SGD, independientemente del tipo al que
pertenezca. Incluye la siguiente información:
id. Identificador, tipo UID, del nodo.
name. Nombre del nodo.
type. Tipo de entidad documental. Cada tipo será representado
mediante su nombre cualificado, bien de forma extendida, bien de
forma resumida, en función de la configuración establecida, en
función de la configuración establecida. Los nodos pueden ser de
tipo eni:documento, gdib:documentoMigrado, eni:expediente o
eni:agregacionDoc.
Representación
{
“id”: STRING*,
“type”: STRING*,
“name”: STRING*
}
Información
adicional N/A
FileNode
Descripción Tipo de datos compuesto que representa un nodo de tipo eni:expediente.
Incluye la siguiente información:
id. Identificador, tipo UID, del expediente.
name. Nombre del documento.
type. Tipo de entidad documental (eni:expediente). El tipo será
representado mediante su nombre cualificado, bien de forma
extendida, bien de forma resumida, en función de la configuración
establecida.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 17 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
FileNode
metadaCollection. Relación de metadatos o propiedades del nodo.
aspects. Relación de aspectos del nodo. Cada aspecto será
representado mediante su nombre cualificado, bien de forma
extendida, bien de forma resumida, en función de la configuración
establecida.
childs. Nodos hijos de primer nivel del nodo.
Representación
{
“id”: STRING?,
“type”: STRING?,
“name”: STRING?,
“metadataCollection”: (Metadata | [Metadata])?,
“aspects”: (STRING | [STRING])?,
“childs”: (summaryInfoNode | [summaryInfoNode])?
}
Información
adicional
Los aspectos que pueden ser establecidos actualmente son los siguientes:
“eni:interoperable” y “eni:transferible”.
FolderNode
Descripción
Tipo de datos compuesto que representa un nodo de tipo eni:agregacionDoc
(agrupación documental). Incluye la siguiente información:
id. Identificador, tipo UID, de la agrupación documental.
name. Nombre de la agrupación documental.
type. Tipo de entidad documental (eni:agregacionDoc). El tipo será
representado mediante su nombre cualificado, bien de forma
extendida, bien de forma resumida, en función de la configuración
establecida.
childs. Relación de nodos hijos de primer nivel del nodo.
Representación
{
“id”: STRING?,
“type”: STRING?,
“name”: STRING?,
“childs”: (summaryInfoNode | [summaryInfoNode])?
}
Información
adicional N/A
versionNode
Descripción Tipo de datos compuesto que representa una versión de un nodo
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 18 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
versionNode
almacenado en el SGD, independientemente del tipo al que pertenezca.
Incluye la siguiente información:
id. Identificador, tipo UID, de la versión.
date. Fecha en la que es creada la versión.
Representación
{
“id”: STRING*,
“date”: STRING*
}
Información
adicional
El valor del atributo date, tipo fecha, será representado en formato cadena
según lo establecido por el estándar ISO-8601, fecha y hora completa
(YYYY-MM-DDTHH:mm:ss.sssZ).
datePeriod
Descripción
Tipo de datos compuesto que representa un periodo de tiempo, mediante su
fecha inicial y su fecha final. Los campos que conforman este tipo de datos
son los siguientes:
initialDate. Cadena de caracteres que representa la fecha inicial del
periodo.
endDate. Cadena de caracteres que representa la fecha final del
periodo.
Representación
{
“initialDate”: STRING?,
“finalDate”: STRING?
}
Información
adicional
El valor de los atributos initialDate y finalDate, tipo fecha, será representado
en formato cadena conforme a lo establecido por el estándar ISO-8601,
fecha y hora completa (YYYY-MM-DDTHH:mm:ss.sssZ).
Exception
Descripción
Tipo de datos compuesto que representa una excepción retornada al invocar
los servicios de repositorio y migración de la capa CSGD. Los campos que
conforman este tipo de datos son los siguientes:
code. Cadena de caracteres que representa el código de la
excepción lanzada por el servicio.
description. Mensaje de la excepción.
Representación
{
“code”: STRING*,
“description”: STRING?
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 19 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
Exception
Información
adicional N/A
ResultData
Descripción
Tipo de datos compuesto que representa el resultado retornado al invocar
los servicios de repositorio y migración de la capa CSGD. Los campos que
conforman este tipo de datos son los siguientes:
code. Cadena de caracteres que representa el código de resultado
del servicio.
description. Mensaje asociado al resultado de la operación.
Representación
{
“code”: STRING*,
“description”: STRING?
}
Información
adicional
El código de resultado “COD_000” informa al solicitante de la petición que el
servicio ha realizado la petición correctamente, efectuando adecuadamente
la operación solicitada.
DSSResult
Descripción
Tipo de datos compuesto que representa el resultado retornado al invocar
una operación de firma electrónica mediante los servicios de repositorio y
migración de la capa CSGD (formato DSS). Los campos que conforman este
tipo de datos son los siguientes:
resultMajor. Código de resultado global (URI’s DSS resultados
globales validación firma electrónica).
resultMinor. Código de resultado detallado (URI’s DSS resultados
detallados validación firma electrónica).
resultMessage. Descripción del resultado de la operación.
Representación
{
“resultMajor”: STRING*,
“resultMinor”: STRING?,
“resultMessage”: STRING?
}
Información
adicional
Para más detalle sobre los códigos de resultado de validación de una firma
electrónica, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
CertificateField
Descripción Tipo de datos compuesto que representa un campo o dato de un certificado
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 20 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CertificateField
electrónico. Los campos que conforman este tipo de datos son los
siguientes:
alias. Nombre lógico del campo o dato del certificado.
value. Valor o contenido del campo o dato del certificado.
Representación
{
“alias”: STRING*,
“value”: STRING?
}
Información
adicional N/A
ValidateCertificateResults
Descripción
Tipo de datos compuesto que representa el resultado de validación de un
certificado incluido en una firma electrónica. Los campos que conforman
este tipo de datos son los siguientes:
result. Resultado de validación del certificado, formado por los
siguientes campos:
code. Código de resultado (URI’s DSS resultados validación
certificado).
message. Descripción del resultado de la operación.
certificateFields. Campos extraídos del certificado.
Representación
{
“result”: {
“code”: STRING*,
“message”: STRING?
},
“certificateFields”: (certificateField | [certificateField])?
}
Información
adicional
Para más detalle sobre los códigos de resultado de validación de un
certificado electrónico, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
La información actualmente extraída de certificados se corresponde
a la incluida en los campos: serialNumber, IssuerName y Subject.
Timestamp
Descripción Tipo de datos compuesto que representa un sello de tiempo incluido en una
firma electrónica. Los campos que conforman este tipo de datos son los
siguientes:
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 21 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
Timestamp
type. Tipo de sello de tiempo. Los valores posibles son los
siguientes:
SIGNER. Sello de tiempo realizado sobre la firma
electrónica realizada por el firmante de la misma.
CUSTODY. Sello de tiempo efectuado sobre referencias de
certificados y evidencias de revocación incluidas en la firma.
ARCHIVE. Sello de tiempo de archivado.
genTime. Instante de tiempo en el que es efectuado el sello de
tiempo.
validateCertificateResults. Resultado de validación del certificado
mediante el que fue realizado el sello de tiempo.
Representación
{
“type”: (SIGNER | CUSTODY | ARCHIVE)*,
“genTime”: STRING*,
“validateCertificateResults”: ValidateCertificateResults?
}
Información
adicional
Para más detalle sobre los códigos de resultado de validación de un
certificado electrónico, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
La información actualmente extraída de certificados se corresponde
a la incluida en los campos: serialNumber, IssuerName y Subject.
SignatureFormat
Descripción
Tipo de datos compuesto que representa el formato de una firma
electrónica, expresado mediante URI’s DSS.
signatureType. Tipo o familia a la que pertenece la firma
electrónica.
signatureForm. Nivel o forma de la firma electrónica, asociado al
tipo e la firma (T, A, etc.).
Representación
{
“signatureType”: STRING*,
“signatureForm”: STRING?
}
Información
adicional N/A
SignatureDetailedInfo
Descripción Tipo de datos compuesto que representa el resultado de validación de una
firma electrónica por los servicios de repositorio y migración de la capa
CSGD. Los campos que conforman este tipo de datos son los siguientes:
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 22 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
SignatureDetailedInfo
result. Resultado de validación de la firma electrónica (formato
DSS).
signatureFormat. Formato de firma electrónica, expresado
mediante URI’s DSS.
validateCertificateResults. Resultado de validación de la cadena
de certificación del certificado firmante.
timestamps. Sellos de tiempo efectuados sobre la firma
electrónica.
Representación
{
“result”: DSSResult*,
“signatureFormat”: signatureFormat*,
“validateCertificateResults”: (ValidateCertificateResult |
[ValidateCertificateResult])?,
“timestamps”: (Timestamp | [Timestamp])?
}
Información
adicional N/A
PersonIdentAuditInfo
Descripción
Tipo de datos compuesto que representa la información de identificación de
una persona. Los campos que conforman este tipo de datos son los
siguientes:
document. Número de documento de identificación.
name. Nombre o razón social de la persona.
Representación
{
“document”: STRING?,
“name”: STRING?
}
Información
adicional N/A
PublicServantAuditInfo
Descripción
Tipo de datos compuesto que representa la información de identificación de
un funcionario público. Los campos que conforman este tipo de datos son
los siguientes:
identificationData. Información de identificación del funcionario.
organization. Unidad organizativa a la que pertenece el
funcionario.
Representación {
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 23 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
PublicServantAuditInfo
“identificationData”: PersonIdentAuditInfo?,
“organization”: STRING?
}
Información
adicional N/A
ProceedingsAuditInfo
Descripción
Tipo de datos compuesto que representa la información de identificación de
un procedimiento administrativo. Los campos que conforman este tipo de
datos son los siguientes:
id. Código de identificación único del procedimiento administrativo.
name. Nombre del procedimiento administrativo.
Representación
{
“id”: STRING?,
“name”: STRING?
}
Información
adicional N/A
FileAuditInfo
Descripción
Tipo de datos compuesto que representa la información de auditoría sobre
los expedientes administrativos que es incluida en la cabecera de las
peticiones de los servicios de repositorio y migración de la capa CSGD. Los
campos que conforman este tipo de datos son los siguientes:
id. Identificador del expediente administrativo.
proceedings. Información del procedimiento administrativo al cual
pertenece el expediente.
Representación
{
“id”: STRING*,
“proceedings”: ProceedingsAuditInfo?
}
Información
adicional N/A
ServiceAuditInfo
Descripción Tipo de datos compuesto que representa la información de auditoría incluida
en la cabecera de las peticiones de los servicios de repositorio y migración
de la capa CSGD. Los campos que conforman este tipo de datos son los
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 24 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
ServiceAuditInfo
siguientes:
applicant. Información de identificación de un ciudadano.
publicServant. Información de identificación de un funcionario
público.
file. Información de auditoría sobre un expediente administrativo.
application. Nombre de la aplicación desde la cual se efectúa la
petición.
Representación
{
“applicant”: PersonIdentificationInfo?,
“publicServant”: PublicServantAuditInfo?,
“file”: FileAuditInfo?,
“application”: STRING?
}
Información
adicional N/A
ServiceSecurityInfo
Descripción
Tipo de datos compuesto que representa la información de seguridad
incluida en la cabecera de las peticiones de los servicios de repositorio y
migración de la capa CSGD. Los campos que conforman este tipo de datos
son los siguientes:
user. Nombre del usuario del SGD que realiza la petición.
password o ticket. Password del usuario del SGD que realiza la
petición, ticket de autenticación previamente obtenido del SGD
(servicio getEcmAutTicket).
Representación
{
“user”: STRING*,
(“password” | “ticket”): STRING*
}
Información
adicional N/A
ServiceHeader
Descripción
Tipo de datos compuesto que representa la cabecera incluida en las
peticiones de los servicios de repositorio y migración de la capa CSGD, con
información de auditoria y seguridad. Los campos que conforman este tipo
de datos son los siguientes:
auditInfo. Información de auditoria de la petición.
securityInfo. Información de seguridad de la petición.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 25 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
ServiceHeader
Representación
{
“auditInfo”: ServiceAuditInfo?,
“securityInfo”: ServiceSecurityInfo*
}
Información
adicional N/A
6.1.2 Servicios Repositorio
En este apartado se enumeran y describen los servicios que habilitan la interacción con
la entidades documentales alojadas en el repositorio documental ENI, y, adicionalmente,
en ciertos casos (búsqueda, recuperación y validación de documentos), en el repositorio
documental de migración.
6.1.2.1 CreateDocument
CreateDocument
Descripción
Servicio mediante el que se solicita la creación y custodia de un nuevo
documento (versión definitiva), en un expediente administrativo almacenado en
el SGD (eni:documento).
Debe ser aportado el nombre del nuevo documento, el conjunto mínimo de
metadatos requeridos para la custodia de este tipo de nodos, los aspectos que
agrupan a estos últimos, el contenido y firma electrónica del documento, y el
identificador del nodo padre (UID o RelativePathUID).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/createDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/createDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 26 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CreateDocument
Petición
{
"createDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
"parent”: RequestNodeId*,
"document": DocumentNode*,
"retrieveNode": BOOLEAN?
}
}
}
Respuesta
{
"createDocumentResult": {
“result”: ResultData*,
"resParam": DocumentNode*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
createNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia CreateNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
createDocument.x
ml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
createAndSetNodeU
tils.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de creación y modificación
de nodos
CreateNodeSequen
ce.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
responsable de invocar el
método createNode del
servicio RepositoryService
(capa GDIB).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 27 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CreateDocument
Información
adicional
Los metadatos mínimos que deben ser informados en la petición del
servicio para este tipo de entidad documental, por los sistemas de
información, se encuentran especificados en el anexo A.1 Metadatos y
Aspectos e Entidades Documentales de este documento.
Si la firma electrónica es implícita (tipos de firma: “TF02”, “TF03”,
“TF05” y “TF06”), es decir, contenido del documento y firma electrónica
coinciden, no es requerido aportar la firma electrónica del documento,
bastaría con informar el contenido del mismo.
Si se informa el parámetro retrieveNode con valor true, el servicio
retornará toda la información registrada en el SGD para del nuevo
documento. En otro caso, solo retornará el identificador, tipo UID, del
nuevo documento en el SGD.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 28 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.2 CreateDraftDocument
CreateDraftDocument
Descripción
Servicio mediante el que se solicita la creación de un nuevo documento en
estado borrador, en un expediente administrativo almacenado en el SGD
(eni:documento).
Debe ser aportado el nombre del nuevo documento y el identificador del nodo
padre (UID o RelativePathUID).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/createDraftDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/createDraftDocumen
t
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"createDraftDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
"parent”: RequestNodeId*,
"document": DocumentNode*,
"retrieveNode": BOOLEAN?
}
}
}
Respuesta
{
"createDraftDocumentResult": {
“result”: ResultData*,
"resParam": DocumentNode*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
createNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia CreateNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 29 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CreateDraftDocument
createDraftDocume
nt.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
createAndSetNodeU
tils.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de creación y modificación
de nodos
CreateNodeSequen
ce.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
responsable de invocar el
método createNode del
servicio RepositoryService
(capa GDIB).
Información
adicional
Si se informa el parámetro retrieveNode con valor true, el servicio
retornará toda la información registrada en el SGD para el nuevo
documento. En otro caso, solo retornará el identificador, tipo UID, del
nuevo documento en el SGD.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
6.1.2.3 CreateFile
CreateFile
Descripción
Servicio mediante el que se solicita la creación de un nuevo expediente
administrativo en el SGD (eni:expediente).
Debe ser aportado el nombre del nuevo expediente, el conjunto mínimo de
metadatos requeridos para la custodia de este tipo de nodos, así como los
aspectos que los agrupan.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/createFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/createFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 30 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CreateFile
Petición
{
"createFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
"file": FileNode*,
"retrieveNode": BOOLEAN?
}
}
}
Respuesta
{
"createFileResult": {
“result”: ResultData*,
"resParam": FileNode*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
createNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia CreateNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
createFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
createAndSetNodeU
tils.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de creación y modificación
de nodos
CreateNodeSequen
ce.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
responsable de invocar el
método createNode del
servicio RepositoryService
(capa GDIB).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 31 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CreateFile
Información
adicional
Los metadatos mínimos que deben ser informados en la petición del
servicio para este tipo de entidad documental, por los sistemas de
información, se encuentran especificados en el anexo A.1 Metadatos y
Aspectos e Entidades Documentales de este documento.
Si se informa el parámetro retrieveNode con valor true, el servicio
retornará toda la información registrada en el SGD para el nuevo
expediente. En caso contrario, solo retornará el identificador, tipo UID,
del nuevo expediente en el SGD.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 32 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.4 CreateChildFile
CreateChildFile
Descripción
Servicio mediante el que se solicita la creación de un nuevo subexpediente en
un expediente administrativo almacenado en el SGD (eni:expediente).
Debe ser aportado el nombre del nuevo subexpediente, el conjunto mínimo de
metadatos requeridos para la custodia de este tipo de nodos, así como los
aspectos que los agrupan, y el identificador del nodo padre (UID o
RelativePathUID).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/createChildFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/createChildFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"createChildFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
"parent”: RequestNodeId*,
"file": FileNode*,
"retrieveNode": BOOLEAN?
}
}
}
Respuesta
{
"createChildFileResult": {
“result”: ResultData*,
"resParam": FileNode*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
createNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia CreateNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
createChildFile.xml Proxy N/A Implementación servicio
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 33 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CreateChildFile
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
createAndSetNodeU
tils.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de creación y modificación
de nodos
CreateNodeSequen
ce.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
responsable de invocar el
método createNode del
servicio RepositoryService
(capa GDIB).
Información
adicional
Los metadatos mínimos que deben ser informados en la petición del
servicio para este tipo de entidad documental, por los sistemas de
información, se encuentran especificados en el anexo A.1 Metadatos y
Aspectos e Entidades Documentales de este documento.
Si se informa el parámetro retrieveNode con valor true, el servicio
retornará toda la información registrada en el SGD para el nuevo
subexpediente. En otro caso, solo retornará el identificador, tipo UID,
del nuevo subexpediente en el SGD.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
6.1.2.5 CreateFolder
CreateFolder
Descripción
Servicio mediante el que se solicita la creación de una nueva agrupación
documental en un expediente administrativo almacenado en el SGD
(eni:agregacionDoc).
Debe ser aportado el nombre de la nueva agrupación documental, y el
identificador del nodo padre (UID o RelativePathUID).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/createFolder
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/createFolder
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 34 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CreateFolder
Petición
{
"createFolderRequest": {
"serviceHeader": ServiceHeader*,
"param": {
"parent”: RequestNodeId*,
"folder": FolderNode*,
"retrieveNode": BOOLEAN?
}
}
}
Respuesta
{
"createFolderResult": {
“result”: ResultData*,
"resParam": FolderNode*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
createNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia CreateNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
createFolder.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
createAndSetNodeU
tils.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de creación y modificación
de nodos
CreateNodeSequen
ce.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
responsable de invocar el
método createNode del
servicio RepositoryService
(capa GDIB).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 35 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CreateFolder
Información
adicional
Si se informa el parámetro retrieveNode con valor true, el servicio
retornará toda la información registrada en el SGD para la nueva
agrupación documental. En otro caso, solo retornará el identificador,
tipo UID, de la nueva agrupación documental en el SGD.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
6.1.2.6 DocumentSearch
documentSearch
Descripción
Servicio mediante el que se solicita la ejecución de una consulta sobre el
conjunto de documentos almacenados en el Archivo Digital (eni:documento y
gdib:documentoMigrado), devolviendo los documentos recuperados mediante la
consulta, el número total y la pagina o ventana de resultados retornados
(paginación). Para cada documento obtenido solo se retornará sus metadatos y
aspectos.
Debe ser informada la consulta Lucene a ejecutar por el servicio sobre el
conjunto de documentos almacenados en el Archivo Digital, y opcionalmente el
número de página de resultados a recuperar (paginación).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/documentSearch
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/documentSearch
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición {
"searchDocsRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“query”: STRING*,
“pageNumber”: INTEGER?
}
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 36 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
documentSearch
Respuesta
{
"searchDocsResult": {
“result”: ResultData*,
“resParam”: {
“totalNumberOfResults”: INTEGER?,
“pageNumber”: INTEGER?,
“documents”: (DocumentNode | [DocumentNode])?
}
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
searchNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia SearchNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
documentSearch.x
ml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
luceneQueryUtils.js Script conf:/repository/esb/
registry/js
Utilidades sobre consultas
Lucene.
SearchNodeSequen
ce.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
responsable de invocar el
método searchNode del
servicio RepositoryService
(capa GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
Número de resultados retornados por página configurable en el SGD.
Por defecto, 50 resultados.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 37 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.7 EasyDocumentSearch
easyDocumentSearch
Descripción
Servicio mediante el que se solicita la ejecución de una consulta, cuyos filtros
se encuentran predefinidos por los parámetros de entrada del servicio, sobre el
conjunto de documentos almacenados en el Archivo Digital (eni:documento y
gdib:documentoMigrado), devolviendo los documentos recuperados mediante la
consulta, el número total y la pagina o ventana de resultados retornados
(paginación). Para cada documento obtenido solo se retornará sus metadatos y
aspectos.
Los filtros de búsqueda pueden ser requeridos (son incluidos en la consulta
mediante el operador lógico “AND”), u opcionales (son incluidos en la consulta
mediante el operador lógico “OR”), debiéndose al menos informar un criterio de
búsqueda requerido. Los criterios de búsqueda predefinidos para documentos
son los siguientes:
Nombre (filtro tipo contiene).
Fecha de creación de documento (rango de fechas).
Fecha de última modificación del documento (rango de fechas).
Autor.
Aplicación que crea el documento.
Identificador ENI.
Búsqueda por contenido (filtro tipo contiene).
Mimetype.
Serie/Tipo documental.
Adicionalmente, y de forma opcional, se puede especificar el número de página
de resultados a recuperar.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/easyDocumentSearch
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/easyDocumentSearc
h
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 38 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
easyDocumentSearch
Petición {
"searchDocsRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“requiredFilters”: {
“name”: STRING?,
“custDate”: datePeriod?,
“lastModDate”: datePeriod?,
“author”: STRING?,
“appName”: STRING?,
“eniId”: STRING?,
“content”: STRING?,
“mimetype”: STRING?,
“docSeries”: STRING?
},
“optionalFilters”: {
“name”: [STRING]?,
“custDate”: [datePeriod]?,
“lastModDate”: [datePeriod]?,
“author”: [STRING]?,
“appName”: [STRING]?,
“eniId”: [STRING]?,
“content”: [STRING]?,
“mimetype”: [STRING]?,
“docSeries”: [STRING]?
},
“pageNumber”: INTEGER?
}
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 39 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
easyDocumentSearch
Respuesta
{
"searchDocsResult": {
“result”: ResultData*,
“resParam”: {
“totalNumberOfResults”: INTEGER?,
“pageNumber”: INTEGER?,
“documents”: (DocumentNode | [DocumentNode])?
}
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD http://$ESB_HOST:
$ESB_PORT/esb/services/documentSearch
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
easyDocumentSear
ch.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
luceneQueryUtils.js Script conf:/repository/esb/
registry/js
Utilidades sobre consultas
Lucene.
Información
adicional
El valor de filtros correspondientes a fechas, será representado en
formato cadena, según lo establecido por el estándar ISO-8601, fecha y
hora completa (YYYY-MM-DDTHH:mm:ss.sssZ).
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
Número de resultados retornados por página configurable en el SGD.
Por defecto, 50 resultados.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 40 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.8 FileSearch
fileSearch
Descripción
Servicio mediante el que se solicita la ejecución de una consulta sobre el
conjunto de expedientes y subexpedientes almacenados en el Archivo Digital
(eni:expediente o rma:recordFolder), devolviendo los expedientes recuperados
mediante la consulta, el número total y la pagina o ventana de resultados
retornados (paginación). Para cada expediente/subexpediente obtenido solo se
retornará sus metadatos, aspectos e hijos de primer nivel.
Debe ser informada la consulta Lucene a ejecutar por el servicio sobre el
conjunto de expedientes y subexpedientes almacenados en el Archivo Digital, y
opcionalmente el número de página de resultados a recuperar (paginación).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/fileSearch
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/fileSearch
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"searchFilesRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“query”: STRING*,
“pageNumber”: INTEGER?
}
}
}
Respuesta
{
"searchFilesResult": {
“result”: ResultData*,
“resParam”: {
“totalNumberOfResults”: INTEGER?,
“pageNumber”: INTEGER?,
“files”: (FileNode | [FileNode])?
}
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 41 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
fileSearch
GDIB
searchNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia SearchNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
searchFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
luceneQueryUtils.js Script conf:/repository/esb/
registry/js
Utilidades sobre consultas
Lucene.
SearchNodeSequen
ce.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
responsable de invocar el
método searchNode del
servicio RepositoryService
(capa GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
Número de resultados retornados por página configurable en el SGD.
Por defecto, 50 resultados.
El tipo de datos de los expedientes en RM es “rma:recordFolder”,
aunque el servicio los retornará como “eni:expediente”.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 42 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.9 EasyFileSearch
easyFileSearch
Descripción
Servicio mediante el que se solicita la ejecución de una consulta, cuyos filtros
se encuentran predefinidos por los parámetros de entrada del servicio, sobre el
conjunto de expedientes y subexpedientes almacenados en el Archivo Digital
(eni:expediente o rma:recordFolder), devolviendo los documentos recuperados
mediante la consulta, el número total y la pagina o ventana de resultados
retornados (paginación). Para cada expediente/subexpediente obtenido solo se
retornará sus metadatos, aspectos e hijos de primer nivel.
Los filtros de búsqueda pueden ser requeridos (son incluidos en la consulta
mediante el operador lógico “AND”), u opcionales (son incluidos en la consulta
mediante el operador lógico “OR”), debiéndose al menos informar un criterio de
búsqueda requerido. Los criterios de búsqueda predefinidos para expedientes
son los siguientes:
Nombre (filtro tipo contiene).
Fecha de creación de alta del expediente (rango de fechas).
Fecha de cierre del expediente (rango de fechas).
Autor.
Aplicación que da de alta el expediente.
Identificador ENI.
Interesados.
Serie/Tipo documental.
Adicionalmente, y de forma opcional, se puede especificar el número de página
de resultados a recuperar.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/easyFileSearch
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/easyFileSearch
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 43 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
easyFileSearch
Petición
{
"searchFilesRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“requiredFilters”: {
“name”: STRING?,
“custDate”: datePeriod?,
“closingDate”: datePeriod?,
“author”: STRING?,
“appName”: STRING?,
“eniId”: STRING?,
“applicants”: [STRING]?,
“docSeries”: STRING?
},
“optionalFilters”: {
“name”: [STRING]?,
“custDate”: [datePeriod]?,
“closingDate”: [datePeriod]?,
“author”: [STRING]?,
“appName”: [STRING]?,
“eniId”: [STRING]?,
“applicants”: [STRING]?,
“docSeries”: [STRING]?
},
“pageNumber”: INTEGER?
}
}
}
Respuesta
{
"searchFilesResult": {
“result”: ResultData*,
“resParam”: {
“totalNumberOfResults”: INTEGER?,
“pageNumber”: INTEGER?,
“files”: (FileNode | [FileNode])?
}
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 44 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
easyFileSearch
Configuración
ESB
Servicios Backend
@firma N/A
CSGD http://$ESB_HOST:$ESB_PORT/esb/services/fileSearch
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
easyFileSearch.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
luceneQueryUtils.js Script conf:/repository/esb/
registry/js
Utilidades sobre consultas
Lucene.
Información
adicional
El valor de filtros correspondientes a fechas, será representado en
formato cadena, según lo establecido por el estándar ISO-8601, fecha y
hora completa (YYYY-MM-DDTHH:mm:ss.sssZ).
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
6.1.2.10 GetDocument
getDocument
Descripción
Servicio que recupera la información y, opcionalmente, el contenido y firma
electrónica de un documento, almacenado en el Archivo Digital (eni:documento,
gdib:documentoMigrado), o una versión determinada de estos (exclusivo para
documentos tipo eni:documento).
El documento puede ser recuperado a partir de los siguientes datos:
Identificador de nodo (UID, versionUID o ruta relativa al nodo).
CSV (Código Seguro de Verificación).
Identificador de documento migrado (exclusivo para documentos
pertenecientes al repositorio documental de migración,
gdib:documentoMigrado).
Al menos uno de estos datos debe ser informado como parte del parámetro de
entrada de la petición del servicio.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/getDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/getDocument
Protocolo REST/JSON (HTTP/POST)
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 45 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getDocument
Seguridad No Método N/A
Petición
{
"getDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“documentId”: {
“nodeId”: RequestNodeId?,
“csv”: STRING?,
“migratedDocId”: RequestMigratedDocId?
}
“content”: BOOLEAN?
}
}
}
Respuesta
{
"getDocumentResult": {
“result”: ResultData*,
“resParam”: DocumentNode?
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
getNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia GetNodeSequence.
getMigrationInfo (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia GetNodeSequence.
getMigrationNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/migration).
Mediante la plantilla secuencia
GetMigrationNodeSequence.
searchNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
SearchNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
getDocument.xml Proxy N/A Implementación servicio
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 46 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getDocument
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
GetNodeSequence.
xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método getNode del servicio
RepositoryService (Capa
GDIB).
getMigrationNodeS
equence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método getMigrationNode
del servicio MigrationService
(Capa GDIB).
SearchNodeSequen
ce
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
responsable de invocar el
método searchNode del
servicio RepositoryService
(capa GDIB).
getDocByCSVXMLR
esponse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL que
filtra la información a
retornar sobre un
documento cuando se
solicita su recuperación por
CSV.
getNumDocsReturn
edByCSVXMLRespo
nse.xslt
XSLT conf:/repository/esb/
registry/xslt
Transformación XSL que
calcula el número de
diferentes documentos
obtenidos tras efectuar una
búsqueda sobre el SGD.
Información
adicional
Si se informa el parámetro content con valor true, el servicio retornará
los contenidos y firmas electrónicas almacenadas del documento en el
SGD. En otro caso, solo retornará los metadatos y aspectos del
documento.
Si el documento es recuperado mediante su CSV, el servicio retornará el
contenido y firma electrónica del documento (parámetro content igual a
true), y los metadatos:
eni:app_tramite_doc,eni:csv,eni:tipoFirma,eni:perfil_firma,eni:id,eni:or
gano,eni:v_nti,eni:origen,eni:id_origen,eni:estado_elaboracion,eni:nom
bre_formato,eni:extensión_formato,eni:def_csv.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 47 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.11 GetFile
getFile
Descripción
Servicio que recupera la información de un expediente o subexpediente
almacenado en el Archivo Digital (eni:expediente o rma:recordFolder), o una
versión determinada de estos.
El expediente/subexpediente puede ser recuperado a partir de su identificador
de nodo (UID, versionUID o ruta relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/getFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/getFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"getFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"getFileResult": {
“result”: ResultData*,
“resParam”: FileNode?
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
getNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia GetNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
getFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 48 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getFile
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
getNodeSequence.x
ml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método getNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
El tipo de datos de los expedientes en RM es “rma:recordFolder”,
aunque el servicio los retornará como “eni:expediente”.
6.1.2.12 GetFolder
getFolder
Descripción
Servicio que recupera la información de una agrupación documental
almacenada en el Archivo Digital (eni:agregacionDoc), o una versión
determinada de estas.
La agrupación documental puede ser recuperada a partir de su identificador de
nodo (UID, versionUID o ruta relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/getFolder
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/getFolder
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición {
"getFolderRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 49 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getFolder
Respuesta
{
"getFolderResult": {
“result”: ResultData*,
“resParam”: FolderNode?
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
getNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia GetNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
getFolder.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
getNodeSequence.x
ml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método getNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.13 GetDocVersionList
getDocVersionList
Descripción
Servicio que recupera la relación de versiones de un documento, perteneciente
al repositorio documental ENI (eni:documento), almacenado en el Archivo
Digital.
El listado de versiones del documento puede ser recuperado a partir de su
identificador de nodo (UID o ruta relativa al nodo).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 50 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getDocVersionList
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/getDocVersionList
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/getDocVersionList
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"getDocVersionListRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"getDocVersionListResult": {
“result”: ResultData*,
“resParam”: (versionNode | [versionNode])?
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
getNodeVersionList (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
getDocVersionList.x
ml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
s
Script conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 51 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getDocVersionList
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
getNodeVersionList del
servicio RepositoryService
(Capa GDIB).
getDocVersionListX
MLResponse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio getNodeVersionList
(capa GDIB)
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.14 GetFileVersionList
getFileVersionList
Descripción
Servicio que recupera la relación de versiones de un expediente/subexpediente
almacenado en el Archivo Digital (eni:expediente o rma:recordFolder).
El listado de versiones del expediente/subexpediente puede ser recuperado a
partir de su identificador de nodo (UID o ruta relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/getFileVersionList
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/getFileVersionList
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"getFileVersionListRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"getFileVersionListResult": {
“result”: ResultData*,
“resParam”: (versionNode | [versionNode])?
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 52 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getFileVersionList
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
getNodeVersionList (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
getFileVersionList.x
ml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
getNodeVersionList del
servicio RepositoryService
(Capa GDIB).
getFileVersionListX
MLResponse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio getNodeVersionList
(capa GDIB)
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 53 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.15 ValidateDocument
validateDocument
Descripción
Servicio que verifica un documento almacenado en el Archivo Digital
(eni:documento, gdib:documentoMigrado), a partir de la validación de la firma
electrónica efectuada sobre el mismo.
El documento puede ser verificado a partir de los siguientes datos:
Identificador de nodo (UID, versionUID o ruta relativa al nodo).
CSV (Código Seguro de Verificación).
Identificador de documento migrado (exclusivo para documentos
pertenecientes al repositorio documental de migración,
gdib:documentoMigrado).
Al menos uno de estos datos debe ser informado como parte del parámetro de
entrada de la petición del servicio.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/validateDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/validateDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición {
"validateDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“documentId”: {
“nodeId”: RequestNodeId?,
“csv”: STRING?,
“migratedDocId”: RequestMigratedDocId?
}
}
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 54 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
validateDocument
Respuesta
{
"validateDocumentResult": {
“result”: DSSResult*,
“resParam”: {
“document”: DocumentNode?,
“signaturesDetailedInfo”: (SignatureDetailedInfo |
[SignatureDetailedInfo])?
}
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD
http://$ESB_HOST:
$ESB_PORT/esb/services/getDocument
http://$ESB_HOST:
$ESB_PORT/esb/services/DSSAfirmaVerify
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
validateDocument.x
ml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
getDocumentUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de la
respuesta del servicio
getDocument
validateDocXMLRes
ponse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL que
forma la respuesta
retornada por el servicio
UTHashedPassFrom
RestGD.xml WS-Policy conf:/repository/esb/
registry/wsPolicy
Política WSS mediante la
que se incluye una sección
Usernametoken a las
peticiones SOAP (password
ofuscada)
UsernameTokenRes
tMediator.java
Java
Mediator
$CARBON_HOME/rep
ository/component/li
b/ gib-esb-java-
mediators-1.0.0.jar
Mediador que configura el
usuario y password WSS-
Usernametoken
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 55 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
validateDocument
GenerateAfirmaDSS
VerifySignatureReq
uestMediator.java
Java
Mediator
$CARBON_HOME/rep
ository/component/li
b/ gib-esb-java-
mediators-1.0.0.jar
Mediador que construye el
parámetro de entrada del
servicio @firma
DSSAfirmaVerify (operación
verificar firma)
ParseAfirmaDSSVeri
fySignatureRespons
eMediator.java
Java
Mediator
$CARBON_HOME/rep
ository/component/li
b/ gib-esb-java-
mediators-1.0.0.jar
Mediador que parsea el
resultado retornado por el
servicio @firma
DSSAfirmaVerify (operación
verificar firma)
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.16 SetDocument
setDocument
Descripción
Servicio que modifica metadatos, aspectos, contenido y firma electrónica de un
documento almacenado en el repositorio documental ENI del Archivo Digital
(eni:documento).
En función del estado de elaboración del documento será posibles efectuar
cambios sobre la siguiente información:
Versión definitiva (documento custodiado). El servicio solo habilita la
modificación, incorporación o eliminación de ciertos metadatos y
aspectos.
Borrador (documento en elaboración). El servicio habilita la
modificación, incorporación o eliminación de todos metadatos, aspectos
del documento, de su contenido y firma electrónica.
El servicio requiere que sea informado el identificador del documento a
modificar en el parámetro de entrada de la petición (UID o ruta relativa al
nodo).
Para eliminar un metadato o aspecto tan solo es necesario establecer como
prefijo del identificador de estos la cadena “-“ (Ej.: “-eni:tipo_doc_ENI”).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/setDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/setDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 56 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
setDocument
Petición
{
"setDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“document”: documentNode*
}
}
}
Respuesta
{
"setDocumentResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
modifyNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
ReusableServiceReqSequence.
Recursos
Nombre Tipo Ruta Descripción
setDocument.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
createAndSetNodeU
tils.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de creación y modificación
de nodos
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
modifyNode del servicio
RepositoryService (Capa
GDIB).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 57 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
setDocument
Información
adicional
Los metadatos y aspectos que pueden que pueden ser modificados o
eliminados por los sistemas de información se encuentran especificados
en el anexo A.1 Metadatos y Aspectos e Entidades Documentales de
este documento, detallándose además aquellos que pueden ser
cambiados una vez el documento ha sido custodiado.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
6.1.2.17 SetFile
setFile
Descripción
Servicio que modifica metadatos, incluido el nombre, y aspectos de un
expediente/subexpediente almacenado en el Archivo Digital (eni:expediente).
El servicio requiere que sea informado el identificador del
expediente/subexpediente a modificar en el parámetro de entrada de la petición
(UID o ruta relativa al nodo).
Para eliminar un metadato o aspecto tan solo es necesario establecer como
prefijo del identificador de estos la cadena “-“ (Ej.: “-eni:tipo_doc_ENI”).
Invocación
EndPoint
http://$ESB_HOST:$ESB_PORT/esb/services/setFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/s etFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"setFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“file”: FileNode*
}
}
}
Respuesta
{
"setFileResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 58 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
setFile
GDIB
modifyNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
ReusableServiceReqSequence.
Recursos
Nombre Tipo Ruta Descripción
setFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
createAndSetNodeU
tils.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de creación y modificación
de nodos
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
modifyNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
Los metadatos y aspectos que pueden que pueden ser modificados o
eliminados por los sistemas de información se encuentran especificados
en el anexo A.1 Metadatos y Aspectos e Entidades Documentales de
este documento.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
6.1.2.18 SetFolder
setFolder
Descripción
Servicio que modifica el nombre de una agrupación documental almacenada en
el Archivo Digital (eni:agregacionDoc).
El servicio requiere que sea informado el identificador de la agrupación
documental a modificar en el parámetro de entrada de la petición (UID o ruta
relativa al nodo).
Invocación EndPoint http://$ESB_HOST:
$ESB_PORT/esb/services/setFolder
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/setFolder
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 59 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
setFolder
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"setFolderRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“folder”: FolderNode*
}
}
}
Respuesta
{
"setFolderResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
modifyNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
ReusableServiceReqSequence.
Recursos
Nombre Tipo Ruta Descripción
setFolder.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
createAndSetNodeU
tils.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de creación y modificación
de nodos
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
modifyNode del servicio
RepositoryService (Capa
GDIB).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 60 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
setFolder
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.19 SetFinalDocument
setFinalDocument
Descripción
Servicio que custodia un documento almacenado en el repositorio documental
ENI del Archivo Digital (eni:documento), estableciéndolo como versión
definitiva, y permitiendo adicionalmente modificar metadatos, aspectos, el
contenido y la firma electrónica del documento.
El servicio requiere que sea informado el identificador del documento a
modificar en el parámetro de entrada de la petición (UID o ruta relativa al
nodo).
Para eliminar un metadato o aspecto tan solo es necesario establecer como
prefijo del identificador de estos la cadena “-“ (Ej.: “-eni:tipo_doc_ENI”).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/setFinalDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/setFinalDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"setFinalDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“document”: documentNode*
}
}
}
Respuesta
{
"setFinalDocumentResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 61 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
setFinalDocument
GDIB
modifyNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
ReusableServiceReqSequence.
Recursos
Nombre Tipo Ruta Descripción
setFinalDocument.x
ml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
createAndSetNodeU
tils.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de creación y modificación
de nodos
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
modifyNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
Los metadatos y aspectos que pueden que pueden ser modificados o
eliminados por los sistemas de información se encuentran especificados
en el anexo A.1 Metadatos y Aspectos e Entidades Documentales de
este documento.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
6.1.2.20 CopyDocument
copyDocument
Descripción
Servicio que crea una copia lógica de un documento almacenado en el
repositorio documental ENI del Archivo Digital (eni:documento), en una
agrupación documental, expediente o subexpediente existente en el repositorio
documental ENI del Archivo Digital, que posea la misma clasificación
documental (serie documental).
El servicio requiere que sea informado el identificador del documento y el
identificador del nodo destino donde será copiado (UID o ruta relativa al nodo).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 62 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
copyDocument
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/copyDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/copyDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"copyDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*,
“targetParent”: RequestNodeId*
}
}
}
Respuesta
{
"copyDocumentResult": {
“result”: ResultData*,
“resParam”: UID*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
linkNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia LinkNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
copyDocument.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
s
Script conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 63 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
copyDocument
LinkNodeSequence.
xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método linkNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.21 CopyFolder
copyFolder
Descripción
Servicio que crea una copia lógica de una agrupación documental almacenada
en el repositorio documental ENI del Archivo Digital (eni:agregacionDoc), en
una agrupación documental, expediente o subexpediente existente en el
repositorio documental ENI del Archivo Digital, cuyo contenido posea la misma
clasificación documental (serie documental).
El servicio requiere que sea informado el identificador de la agrupación
documental y el identificador del nodo destino donde será copiada (UID o ruta
relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/copyFolder
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/copyFolder
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
" copyFolderRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*,
“targetParent”: RequestNodeId*
}
}
}
Respuesta
{
"copyFolderResult": {
“result”: ResultData*,
“resParam”: UID*
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 64 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
copyFolder
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
linkNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia LinkNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
copyFolder.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
LinkNodeSequence.
xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método linkNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.22 LinkDocument
linkDocument
Descripción
Servicio que crea un enlace o referencia de un documento almacenado en el
repositorio documental ENI del Archivo Digital (eni:documento), en una
agrupación documental, expediente o subexpediente existente en el repositorio
documental ENI del Archivo Digital.
El servicio requiere que sea informado el identificador del documento a enlazar
y el identificador del nodo destino (UID o ruta relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/linkDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/linkDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 65 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
linkDocument
Petición
{
"linkDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*,
“targetParent”: RequestNodeId*
}
}
}
Respuesta
{
"linkDocumentResult": {
“result”: ResultData*,
“resParam”: UID?
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
linkNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia LinkNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
linkDocument.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
LinkNodeSequence.
xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método linkNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 66 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.23 LinkFile
linkFile
Descripción
Servicio que crea un enlace o referencia de un expediente almacenado en el
repositorio documental ENI del Archivo Digital (eni:expediente), en una
agrupación documental, expediente o subexpediente existente en el repositorio
documental ENI del Archivo Digital.
El servicio requiere que sea informado el identificador del expediente a enlazar
y el identificador del nodo destino (UID o ruta relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/linkFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/linkFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"linkFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*,
“targetParent”: RequestNodeId*
}
}
}
Respuesta
{
"linkFileResult": {
“result”: ResultData*,
“resParam”: UID?
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
linkNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia LinkNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
linkFile.xml Proxy N/A Implementación servicio
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 67 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
linkFile
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
LinkNodeSequence.
xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método linkNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.24 LinkFolder
linkFolder
Descripción
Servicio que crea un enlace o referencia de una agrupación documental
almacenada en el repositorio documental ENI del Archivo Digital
(eni:agregacionDoc), en una agrupación documental, expediente o
subexpediente existente en el repositorio documental ENI del Archivo Digital.
El servicio requiere que sea informado el identificador de la agrupación
documental a enlazar y el identificador del nodo destino (UID o ruta relativa al
nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/linkFolder
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/linkFolder
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición {
"linkFolderRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*,
“targetParent”: RequestNodeId*
}
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 68 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
linkFolder
Respuesta
{
"linkFolderResult": {
“result”: ResultData*,
“resParam”: UID?
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
linkNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia LinkNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
linkFolder.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
LinkNodeSequence.
xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método linkNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.25 MoveDocument
moveDocument
Descripción
Servicio que traslada un documento almacenado en el repositorio documental
ENI del Archivo Digital (eni:documento), a una agrupación documental,
expediente o subexpediente existente en el repositorio documental ENI del
Archivo Digital, que posea la misma clasificación documental (serie
documental).
El servicio requiere que sea informado el identificador del documento a mover y
el identificador del nodo destino (UID o ruta relativa al nodo).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 69 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
moveDocument
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/moveDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/moveDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"moveDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*,
“targetParent”: RequestNodeId*
}
}
}
Respuesta
{
"moveDocumentResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
moveNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia MoveNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
moveDocument.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
s
Script conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 70 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
moveDocument
MoveNodeSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método moveNode del
servicio RepositoryService
(Capa GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.26 MoveChildFile
moveChildFile
Descripción
Servicio que traslada un subexpediente almacenado en el repositorio
documental ENI del Archivo Digital (eni:expediente), a una agrupación
documental, expediente o subexpediente existente en el repositorio documental
ENI del Archivo Digital, que posea la misma clasificación documental (serie
documental).
El servicio requiere que sea informado el identificador del subexpediente a
mover y el identificador del nodo destino (UID o ruta relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/moveChildFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/moveChildFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"moveChildFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*,
“targetParent”: RequestNodeId*
}
}
}
Respuesta
{
"moveChildFileResult": {
“result”: ResultData*
}
}
Servicios Backend
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 71 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
moveChildFile
Configuración
ESB
@firma N/A
CSGD N/A
GDIB
moveNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia MoveNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
moveChildFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
MoveNodeSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método moveNode del
servicio RepositoryService
(Capa GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.27 MoveFolder
moveFolder
Descripción
Servicio que traslada una agrupación documental almacenada en el repositorio
documental ENI del Archivo Digital (eni:agregacionDoc), a una agrupación
documental, expediente o subexpediente existente en el repositorio documental
ENI del Archivo Digital, cuyo contenido posea la misma clasificación documental
(serie documental).
El servicio requiere que sea informado el identificador de la agrupación
documental a mover y el identificador del nodo destino (UID o ruta relativa al
nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/moveFolder
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/moveFolder
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 72 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
moveFolder
Petición
{
"moveFolderRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*,
“targetParent”: RequestNodeId*
}
}
}
Respuesta
{
"moveFolderResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
moveNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia MoveNodeSequence.
Recursos
Nombre Tipo Ruta Descripción
moveFolder.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
MoveNodeSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar el
método moveNode del
servicio RepositoryService
(Capa GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 73 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.28 RemoveDocument
removeDocument
Descripción
Servicio que elimina un documento almacenado en el repositorio documental
ENI del Archivo Digital (eni:documento).
El servicio requiere que sea informado el identificador del documento a eliminar
(UID o ruta relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/removeDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/removeDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"removeDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"removeDocumentResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
removeNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
removeDocument.x
ml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 74 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
removeDocument
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
removeNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.29 RemoveFile
removeFile
Descripción
Servicio que elimina un expediente/subexpediente almacenado en el repositorio
documental ENI del Archivo Digital (eni:expediente)
El servicio requiere que sea informado el identificador del
expediente/subexpediente a eliminar (UID o ruta relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/removeFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/removeFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"removeFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"removeFileResult": {
“result”: ResultData*
}
}
Servicios Backend
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 75 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
removeFile
Configuración
ESB
@firma N/A
CSGD N/A
GDIB
removeNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
removeFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
removeNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.30 RemoveFolder
removeFolder
Descripción
Servicio que elimina una agrupación documental almacenada en el repositorio
documental ENI del Archivo Digital (eni:agregacionDoc)
El servicio requiere que sea informado el identificador de la agrupación
documental a eliminar (UID o ruta relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/removeFolder
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/removeFolder
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 76 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
removeFolder
Petición
{
"removeFolderRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"removeFolderResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
removeNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
removeFolder.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
removeNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 77 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.31 GetENIDocument
getENIDocument
Descripción
Servicio que obtiene la estructura XML de intercambio de documentos de un
documento almacenado en el repositorio documental ENI del Archivo Digital
(eni:documento), conforme a lo especificado por la NTI de documento
electrónico del ENI
(http://administracionelectronica.gob.es/ENI/XSD/v1.0/documento-e).
El servicio requiere que sea informado el identificador del documento (UID o
ruta relativa al nodo).
La estructura XML es retornada por el servicio codificada en Base64.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/getENIDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/getENIDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"getENIDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"getENIDocumentResult": {
“result”: ResultData*,
“resParam”: STRING*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD http://$ESB_HOST:$ESB_PORT/esb/services/getDocument
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
getENIDocument.x
ml
Proxy N/A Implementación servicio
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 78 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getENIDocument
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
getDocumentUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de la
respuesta del servicio
getDocument
generateENIDocum
ent.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL que
genera la una estructura
XML ENIDOC a partir de la
información de un
documento retornada por el
servicio getDocument
Base64Mediator.jav
a
Java
Mediator
$CARBON_HOME/rep
ository/component/li
b/ gib-esb-java-
mediators-1.0.0.jar
Mediador que
codifica/decodifica en
Base64
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.32 GenerateDocCSV
generateDocCSV
Descripción Servicio que genera un nuevo Código Seguro de Verificación (CSV).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/generateDocCSV
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/generateDocCSV
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición {
"generateDocCSVRequest": {
"serviceHeader": ServiceHeader*
}
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 79 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
generateDocCSV
Respuesta
{
"generateDocCSVResult": {
“result”: ResultData*,
“resParam”: STRING*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB getCSV (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Recursos
Nombre Tipo Ruta Descripción
generateDocCSV.x
ml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.33 ExportFile
exportFile
Descripción
Servicio mediante el que se solicita la generación de las estructuras necesarias
para el intercambio de un expediente almacenado en el repositorio documental
ENI del Archivo Digital (eni:expediente o rma:recordFolder). El servicio
generará un subexpediente de intercambio, el cual incluirá, además del
contenido del expediente en el momento de la solicitud, el índice electrónico de
intercambio (formato XML), conforme a lo especificado por la NTI de expediente
electrónico del ENI
(http://administracionelectronica.gob.es/ENI/XSD/v1.0/expediente-e). Este
índice electrónico de intercambio (archivo XML), será retornado como respuesta
del servicio codificado en Base64.
El servicio requiere que sea informado el identificador del expediente (UID o
ruta relativa al nodo).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 80 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
exportFile
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/getENIDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/getENIDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"exportFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"exportFileResult": {
“result”: ResultData*,
“resParam”: STRING*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
exportNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
exportFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método exportNode
del servicio
RepositoryService (Capa
GDIB).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 81 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
exportFile
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.34 GenerateFileIndex
generateFileIndex
Descripción
Servicio que obtiene una estructura XML que representa el índice electrónico
interno del Govern de les Illes Balears de un expediente/subexpediente
almacenado en el repositorio documental ENI del Archivo Digital
(eni:expediente o rma:recordFolder).
El servicio requiere que sea informado el identificador del expediente (UID o
ruta relativa al nodo).
La estructura XML es retornada por el servicio codificada en Base64.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/generateFileIndex
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/generateFileIndex
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"generateFileIndexRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"generateFileIndexResult": {
“result”: ResultData*,
“resParam”: STRING*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 82 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
generateFileIndex
GDIB
foliateNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
generateFileIndex.x
ml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método foliateNode
del servicio
RepositoryService (Capa
GDIB).
Información
adicional
La estructura y contenido de la estructura XML que representa el índice
electrónico de un expediente almacenado en el Archivo Digital se
encuentra especificada en el anexo A.2 Esquema índice electrónico
foliación de este documento.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
6.1.2.35 GrantPermissionsOnDocs
grantPermissionsOnDocs
Descripción
Servicio mediante el que los SSII pueden otorgar permisos de lectura o
escritura sobre un conjunto de documentos almacenados en el repositorio
documental ENI del Archivo Digital (eni:documento), a otras autoridades
(usuario, grupo de usuarios, etc.).
Los permisos que pueden ser otorgados son los siguientes:
read. Permiso de lectura.
write. Permiso de escritura, que habilita la modificación y borrado del
nodo a la autoridades.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/grantPermissionsOnDocs
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/grantPermissionsOn
Docs
Protocolo REST/JSON (HTTP/POST)
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 83 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
grantPermissionsOnDocs
Seguridad No Método N/A
Petición
{
"grantPermissionsOnDocsRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeIds”: [RequestNodeId]*,
"authorities": [STRING]*,
"permission": (“read” | “write”)*
}
}
}
Respuesta
{
"grantPermissionsOnDocsResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
authorizeNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
ReusableServiceReqSequence.
Recursos
Nombre Tipo Ruta Descripción
grantPermissionsOn
Docs.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
permissionsNodeUti
ls.js
Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de concesión y cancelación
de permisos sobre nodos
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 84 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
grantPermissionsOnDocs
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
authorizeNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.36 GrantPermissionsOnFiles
grantPermissionsOnFiles
Descripción
Servicio mediante el que los SSII pueden otorgar permisos de lectura o
escritura sobre un conjunto de expedientes/subexpedientes almacenados en el
repositorio documental ENI del Archivo Digital (eni:expediente), a otras
autoridades (usuario, grupo de usuarios, etc.). Los permisos otorgados son
propagados sobre todos los nodos hijos de los expedientes.
Los servicios que pueden ser otorgados son los siguientes:
read. Permiso de lectura.
write. Permiso de escritura, que habilita la modificación y borrado del
nodo a la autoridad.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/grantPermissionsOnFiles
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/grantPermissionsOn
Files
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición {
"grantPermissionsOnFilesRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeIds”: [RequestNodeId]*,
"authorities": [STRING]*,
"permission": (“read” | “write”)*
}
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 85 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
grantPermissionsOnFiles
Respuesta
{
"grantPermissionsOnFilesResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
authorizeNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
ReusableServiceReqSequence.
Recursos
Nombre Tipo Ruta Descripción
grantPermissionsOn
Files.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
permissionsNodeUti
ls.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de concesión y cancelación
de permisos sobre nodos
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
authorizeNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 86 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.2.37 GrantPermissionsOnFolders
grantPermissionsOnFolders
Descripción
Servicio mediante el que los SSII pueden otorgar permisos de lectura o
escritura sobre un conjunto de agrupaciones documentales almacenadas en el
repositorio documental ENI del Archivo Digital (eni:agregacionDoc), a otras
autoridades (usuario, grupo de usuarios, etc.). Los permisos otorgados son
propagados sobre todos los nodos hijos de las agrupaciones documentales.
Los permisos que pueden ser otorgados son los siguientes:
read. Permiso de lectura.
write. Permiso de escritura, que habilita la modificación y borrado del
nodo a las autoridades.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/grantPermissionsOnFolder
s
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/grantPermissionsOn
Folders
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"grantPermissionsOnFoldersRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeIds”: [RequestNodeId]*,
"authorities": [STRING]*,
"permission": (“read” | “write”)*
}
}
}
Respuesta
{
"grantPermissionsOnFoldersResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB authorizeNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
ReusableServiceReqSequence.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 87 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
grantPermissionsOnFolders
Recursos
Nombre Tipo Ruta Descripción
grantPermissionsOn
Folders.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
permissionsNodeUti
ls.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de concesión y cancelación
de permisos sobre nodos
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
authorizeNode del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.38 CancelPermissionsOnDocs
cancelPermissionsOnDocs
Descripción
Servicio mediante el que los SSII pueden cancelar los permisos otorgados a
una o más autoridades previamente sobre un conjunto de documentos
almacenados en el repositorio documental ENI del Archivo Digital
(eni:documento).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/cancelPermissionsOnDocs
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/cancelPermissionsOn
Docs
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 88 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
cancelPermissionsOnDocs
Petición
{
"cancelPermissionsOnDocsRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeIds”: [RequestNodeId]*,
"authorities": [STRING]*
}
}
}
Respuesta
{
"cancelPermissionsOnDocsResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
removeAuthority (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
ReusableServiceReqSequence.
Recursos
Nombre Tipo Ruta Descripción
cancelPermissionsO
nDocs.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
permissionsNodeUti
ls.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de concesión y cancelación
de permisos sobre nodos
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
removeAuthority del servicio
RepositoryService (Capa
GDIB).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 89 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
cancelPermissionsOnDocs
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.39 CancelPermissionsOnFiles
cancelPermissionsOnFiles
Descripción
Servicio mediante el que los SSII pueden cancelar los permisos otorgados a
una o más autoridades previamente sobre un conjunto de
expedientes/subexpedientes almacenados en el repositorio documental ENI del
Archivo Digital (eni:expediente). La cancelación de permisos es propagada
sobre todos los nodos hijos de los expedientes.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/cancelPermissionsOnFiles
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/cancelPermissionsOn
Files
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"cancelPermissionsOnFilesRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeIds”: [RequestNodeId]*,
"authorities": [STRING]*
}
}
}
Respuesta
{
"cancelPermissionsOnFilesResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB removeAuthority (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
ReusableServiceReqSequence.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 90 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
cancelPermissionsOnFiles
Recursos
Nombre Tipo Ruta Descripción
cancelPermissionsO
nFiles.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
permissionsNodeUti
ls.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de concesión y cancelación
de permisos sobre nodos
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
removeAuthority del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.40 CancelPermissionsOnFolders
cancelPermissionsOnFolders
Descripción
Servicio mediante el que los SSII pueden cancelar los permisos otorgados a
una o más autoridades previamente sobre un conjunto de agrupaciones
documentales almacenadas en el repositorio documental ENI del Archivo Digital
(eni:agregacionDoc). La cancelación de permisos es propagada sobre todos los
nodos hijos de las agrupaciones documentales.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/grantPermissionsOnFolder
s
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/grantPermissionsOn
Folders
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 91 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
cancelPermissionsOnFolders
Petición
{
"grantPermissionsOnFoldersRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeIds”: [RequestNodeId]*,
"authorities": [STRING]*
}
}
}
Respuesta
{
"grantPermissionsOnFoldersResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
removeAuthority (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia
ReusableServiceReqSequence.
Recursos
Nombre Tipo Ruta Descripción
cancelPermissionsO
nFolders.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
permissionsNodeUti
ls.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de concesión y cancelación
de permisos sobre nodos
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método
removeAuthority del servicio
RepositoryService (Capa
GDIB).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 92 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
cancelPermissionsOnFolders
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.41 LockDocument
lockDocument
Descripción
Servicio mediante el que los SSII pueden bloquear un documento almacenado
en el repositorio documental ENI del Archivo Digital (eni:documento).
El servicio requiere que sea informado el identificador del documento a
bloquear en el parámetro de entrada de la petición (UID o ruta relativa al
nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/lockDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/lockDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"lockDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"lockDocumentResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
lockNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 93 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
lockDocument
lockDocument.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método lockNode
del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.42 LockFile
lockFile
Descripción
Servicio mediante el que los SSII pueden bloquear un
expediente/subexpediente almacenado en el repositorio documental ENI del
Archivo Digital (eni:expediente). El bloqueo es propagado a todos los nodos
hijos del expediente.
El servicio requiere que sea informado el identificador del
expediente/subexpediente a bloquear en el parámetro de entrada de la petición
(UID o ruta relativa al nodo).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/lockFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/lockFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición {
"lockFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 94 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
lockFile
Respuesta
{
"lockFileResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
lockNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
lockFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método lockNode
del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.43 LockFolder
lockFolder
Descripción
Servicio mediante el que los SSII pueden bloquear una agrupación documental
almacenada en el repositorio documental ENI del Archivo Digital
(eni:agregacionDoc). El bloqueo es propagado a todos los nodos hijos de la
agrupación documental.
El servicio requiere que sea informado el identificador de la agrupación
documental a bloquear en el parámetro de entrada de la petición (UID o ruta
relativa al nodo).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 95 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
lockFolder
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/lockFolder
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/lockFolder
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"lockFolderRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"lockFolderResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
lockNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
lockFolder.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método lockNode
del servicio
RepositoryService (Capa
GDIB).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 96 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
lockFolder
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.44 UnlockDocument
unlockDocument
Descripción
Servicio mediante el que los SSII pueden cancelar el bloqueo efectuado
previamente sobre un documento almacenado en el repositorio documental ENI
del Archivo Digital (eni:documento).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/unlockDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/unlockDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
" unlockDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"unlockDocumentResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
unlockNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
unlockDocument.x
ml
Proxy N/A Implementación servicio
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 97 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
unlockDocument
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método unlockNode
del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.45 UnlockFile
unlockFile
Descripción
Servicio mediante el que los SSII pueden cancelar el bloqueo efectuado
previamente sobre un expediente/subexpediente almacenado en el repositorio
documental ENI del Archivo Digital (eni:expediente). El desbloqueo es
propagado a todos los nodos hijos del expediente.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/unlockFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/unlockFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición {
"unlockFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 98 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
unlockFile
Respuesta
{
"unlockFileResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
unlockNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
unlockFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método unlockNode
del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.46 UnlockFolder
unlockFolder
Descripción
Servicio mediante el que los SSII pueden cancelar el bloqueo efectuado
previamente sobre una agrupación documental almacenado en el repositorio
documental ENI del Archivo Digital (eni:agregacionDoc). El desbloqueo es
propagado a todos los nodos hijos de la agrupación documental.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 99 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
unlockFolder
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/unlockFolder
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/unlockFolder
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"unlockFolderRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"unlockFolderResult": {
“result”: ResultData*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
unlockNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
unlockFolder.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método unlockNode
del servicio
RepositoryService (Capa
GDIB).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 100 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
unlockFolder
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.47 GetEcmAutTicket
getEcmAutTicket
Descripción Servicio que genera un nuevo ticket de autenticación para un usuario del
Archivo Digital.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/getEcmAutTicket
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/getEcmAutTicket
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"getEcmAutTicketRequest": {
"serviceHeader": ServiceHeader*
}
}
}
Respuesta
{
"getEcmAutTicketResult": {
“result”: ResultData*,
“resParam”: STRING*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB getTicket (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Recursos
Nombre Tipo Ruta Descripción
getEcmAutTicket.x
ml
Proxy N/A Implementación servicio
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 101 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getEcmAutTicket
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.48 DispatchDocument
dispatchDocument
Descripción
Servicio dispuesto para la solicitud del traslado de un documento a otro
expediente, con seríe documental diferente, almacenado en el Archivo Digital
del Govern de les Illes Balears (eni:documento).
Debe ser aportado el identificador del documento a trasladar (UID o ruta
relativa al nodo), el identificador del nodo destino donde será copiado,
expediente/subexpediente o agrupación documental (UID o ruta relativa al
nodo), su destino (Por ejemplo: “Registro Salida” o “Expediente”), y la nueva
serie y/o tipo documental del documento.
El documento origen del trasladado será modificado, añadiéndole el aspecto
gdib:trasladado y sus metadatos.
El servicio retornará el nuevo identificador de documento, correspondiente al
documento creado en el destino definitivo del mismo (UID).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/dispatchDocument
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/dispatchDocument
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 102 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
dispatchDocument
Petición
{
"dispatchDocumentRequest": {
"serviceHeader": ServiceHeader*,
"param": {
"sourceNodeId": RequestNodeId*,
"targetNode”: {
"id”: RequestNodeId*,
"docClassification”: {
“serie”: STRING*,
“type”: STRING?,
},
"targetType": STRING*
}
}
}
}
Respuesta
{
"dispatchDocumentResult": {
“result”: ResultData*,
"resParam": UID*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD
http://$ESB_HOST:
$ESB_PORT/esb/services/getDocument
http://$ESB_HOST:
$ESB_PORT/esb/services/createDocument
http://$ESB_HOST:
$ESB_PORT/esb/services/setDocument
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
dispatchRegDocum
ent.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 103 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
dispatchDocument
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
createAndSetNodeU
tils.js Script conf:/repository/esb/
registry/js
Utilidades sobre peticiones
de creación y modificación
de nodos
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
6.1.2.49 CloseFile
closeFile
Descripción
Servicio mediante el que los SSII pueden solicitar el cierre de un expediente
almacenado en el repositorio documental ENI del Archivo Digital
(eni:expediente), y su transferencia a la fase semi-activa o histórica (RM),
generando para ello previamente su índice electrónico.
El servicio requiere que sea informado el identificador del expediente a cerrar
(UID).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/closeFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/closeFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
Petición
{
"closeFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"closeFileResult": {
“result”: ResultData*,
“resParam”: UID*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 104 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
closeFile
CSGD N/A
GDIB
closeFile (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
closeFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método closeFile
del servicio
RepositoryService (Capa
GDIB).
Información
adicional
El cierre de un expediente, que ha sido recuperado del RM (reapertura),
no puede ser efectuado el mismo día que se produje el cierre incial, ado
que colisionarían en el RM.
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
6.1.2.50 ReopenFile
reopenFile
Descripción
Servicio mediante el que los SSII pueden solicitar la reapertura de un
expediente almacenado en el repositorio documental ENI del Archivo Digital
(eni:expediente o rma:recordFolder), y en fase semi-activa o histórica (RM).
El servicio requiere que sea informado el identificador del expediente (UID).
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/reopenFile
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/reopenFile
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 105 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
reopenFile
Petición
{
"reopenFileRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“nodeId”: RequestNodeId*
}
}
}
Respuesta
{
"reopenFileResult": {
“result”: ResultData*,
“resParam”: UID*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
openFile (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Mediante la plantilla secuencia ReusableNodeOpSequence.
Recursos
Nombre Tipo Ruta Descripción
reopenFile.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de invocar, entre
otros, el método openNode
del servicio
RepositoryService (Capa
GDIB).
Información
adicional
En caso de producirse una excepción, el servicio la retornará como
resultado del servicio (Tipo de datos Exception).
El tipo de datos de los expedientes en RM es “rma:recordFolder”.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 106 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.1.3 Servicios Migración
En este apartado se enumeran y describen los servicios que habilita a los SSII la
interacción con los documentos alojados exclusivamente en el repositorio documental de
migración.
6.1.3.1 TransformMigratedDoc
transformMigratedDoc
Descripción
Servicio mediante el que se solicita la conversión de un documento
perteneciente al repositorio documental de migración
(gdib:documentoMigrado), a un documento ENI (eni:documento), perteneciente
al repositorio documental ENI.
El servicio requiere que sean informados los siguientes datos:
Información para la conversión del documento migrado a documento
interoperable:
El identificador del documento migrado.
La relación de metadatos que serán añadidos al documento
transformado para ser interoperable.
Identificador del nodo, expediente, subexpediente o agragación
documental, donde será almacenado el documento transformado (UID o
RelativePathUID).
El servicio el identificador del nuevo documento, el cual incluirá un nuevo
aspecto, denominado gdib:transformado.
Invocación
EndPoint
http://$ESB_HOST:$ESB_PORT/esb/services/
transformMigratedDoc
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/transformMigratedD
oc
Protocolo REST/JSON (HTTP/POST)
Seguridad No Método N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 107 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
transformMigratedDoc
Petición
{
"transformMigratedDocRequest": {
"serviceHeader": ServiceHeader*,
"param": {
“fileId”: RequestNodeId*,
“transformInfoDoc”: {
“migratedDocId”: RequestMigratedDocId*,
“metadataCollection”: [Metadata]*
}
}
}
}
Respuesta
{
"transformMigratedDocResult": {
“result”: ResultData*,
“resParam”: UID*
}
}
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB transformNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/migration)
Recursos
Nombre Tipo Ruta Descripción
transformMigratedD
oc.xml Proxy N/A Implementación servicio
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
serviceHeaderUtils.j
sScript conf:/repository/esb/
registry/js
Procesamiento de cabecera
de la petición del servicio
migrationRepoUtils.
js Script conf:/repository/esb/
registry/js
Generación y parseo de
peticiones y respuestas de
servicios relativos a
documentos migrados
Información
adicional
En caso de producirse una excepción, el servicio la retornará como resultado
del servicio (Tipo de datos Exception).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 108 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.2 Servicios Firma Electrónica
Los servicios de firma electrónica del catálogo de servicios web proporcionado por la
plataforma @firma v6, accesibles mediante protocolo SOAP v1.1, y disponibles como
servicios tipo proxy en el ESB, son descritos en los siguientes apartados.
6.2.1 DSSAfirmaArchiveRetrieval
DSSAfirmaArchiveRetrieval
Descripción
Servicio de Obtención de Firmas Registradas. Este servicio permite la
recuperación de una firma registrada en la plataforma @firma v6 a partir de un
identificador único de registro, siguiendo las recomendaciones del perfil Archive
de OASIS.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/DSSAfirmaArchiveRetrieval
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/DSSAfirmaArchiveRet
rieval
Protocolo SOAP v1.1
Seguridad Si Método WSS - UsernameToken
Petición Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Respuesta Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Configuración
ESB
Servicios Backend
@firma
http://$AFIRMA_HOST:
$AFIRMA_PORT/afirmaws/services/DSSAfirmaArchiv
eRetrieval
https://$AFIRMA_HOST:
$AFIRMA_SEC_PORT/afirmaws/services/DSSAfirmaA
rchiveRetrieval
CSGD N/A
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
DSSAfirmaArchive
Retrieval.xml Proxy N/A Implementación servicio
DSSAfirmaArchive
Retrieval.wsdl WSDL conf:/repository/esb/r
egistry/wsdl Definición servicio.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 109 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
DSSAfirmaArchiveRetrieval
Información
adicional
Para más detalle sobre el servicio, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 110 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.2.2 DSSAfirmaSign
DSSAfirmaSign
Descripción Servicio de Firma Delegada. Habilita la realización de operaciones de firma y
multifirma de servidor en los formatos soportados por la plataforma @firma v6.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/DSSAfirmaSign
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/DSSAfirmaSign
Protocolo SOAP v1.1
Seguridad Si Método WSS - UsernameToken
Petición Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Respuesta Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Configuración
ESB
Servicios Backend
@firma
http://$AFIRMA_HOST:
$AFIRMA_PORT/afirmaws/services/DSSAfirmaSign
https://$AFIRMA_HOST:
$AFIRMA_SEC_PORT/afirmaws/services/DSSAfirmaSi
gn
CSGD N/A
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
DSSAfirmaSign.x
ml Proxy N/A Implementación servicio
DSSAfirmaSign.w
sdl WSDL conf:/repository/esb/re
gistry/wsdl Definición servicio.
Información
adicional
Para más detalle sobre el servicio, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
6.2.3 DSSAfirmaVerify
DSSAfirmaVerify
Descripción
Servicio de Verificación y Actualización de Firma. Permite la verificación de una
firma electrónica y la obtención de información adicional sobre dicha firma. El
servicio de verificación permitirá además, de forma opcional, la realización de
operaciones de upgrade sobre una firma electrónica, pudiendo completar dicha
firma a un formato más avanzado.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 111 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
DSSAfirmaVerify
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/DSSAfirmaVerify
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/DSSAfirmaVerify
Protocolo SOAP v1.1
Seguridad Si Método WSS - UsernameToken
Petición Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Respuesta Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Configuración
ESB
Servicios Backend
@firma
http://$AFIRMA_HOST:
$AFIRMA_PORT/afirmaws/services/DSSAfirmaVerify
https://$AFIRMA_HOST:
$AFIRMA_SEC_PORT/afirmaws/services/DSSAfirmaV
erify
CSGD N/A
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
DSSAfirmaVerify.x
ml Proxy N/A Implementación servicio
DSSAfirmaVerify.
wsdl WSDL conf:/repository/esb/re
gistry/wsdl Definición servicio.
Información
adicional
Para más detalle sobre el servicio, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
6.2.4 DSSAfirmaVerifyCertificate
DSSAfirmaVerifyCertificate
Descripción
Servicio de Verificación de Certificado. Mediante esta interfaz Web Service se
puede solicitar la verificación de certificados X509 así como extraer la
información del certificado mediante la aplicación del mapeo definido para su
tipo en la utilidad de administración de la plataforma.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/DSSAfirmaVerifyCertificate
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/DSSAfirmaVerifyCertif
icate
Protocolo SOAP v1.1
Seguridad Si Método WSS - UsernameToken
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 112 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
DSSAfirmaVerifyCertificate
Petición Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Respuesta Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Configuración
ESB
Servicios Backend
@firma
http://$AFIRMA_HOST:
$AFIRMA_PORT/afirmaws/services/DSSAfirmaVerifyC
ertificate
https://$AFIRMA_HOST:
$AFIRMA_SEC_PORT/afirmaws/services/DSSAfirmaV
erifyCertificate
CSGD N/A
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
DSSAfirmaVerifyC
ertificate.xml Proxy N/A Implementación servicio
DSSAfirmaVerifyC
ertificate.wsdl WSDL conf:/repository/esb/re
gistry/wsdl Definición servicio.
Información
adicional
Para más detalle sobre el servicio, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
6.2.5 DSSAsyncRequestStatus
DSSAsyncRequestStatus
Descripción Servicio de Consulta de Peticiones Asíncrona. Este servicio permite la consulta y
obtención de respuesta de peticiones asíncronas.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/DSSAsyncRequestStatus
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/DSSAsyncRequestStat
us
Protocolo SOAP v1.1
Seguridad Si Método WSS - UsernameToken
Petición Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Respuesta Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Servicios Backend
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 113 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
DSSAsyncRequestStatus
Configuración
ESB
@firma
http://$AFIRMA_HOST:
$AFIRMA_PORT/afirmaws/services/DSSAsyncRequest
Status
https://$AFIRMA_HOST:
$AFIRMA_SEC_PORT/afirmaws/services/DSSAsyncRe
questStatus
CSGD N/A
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
DSSAsyncRequest
Status.xml Proxy N/A Implementación servicio
DSSAsyncRequest
Status.wsdl WSDL conf:/repository/esb/re
gistry/wsdl Definición servicio.
Información
adicional
Para más detalle sobre el servicio, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 114 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
6.2.6 DSSBatchVerifyCertificate
DSSBatchVerifyCertificate
Descripción Servicio de Validación Masiva de Certificados. Mediante este servicio se puede
solicitar la verificación asíncrona de un conjunto de certificados.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/DSSBatchVerifyCertificate
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/DSSBatchVerifyCertifi
cate
Protocolo SOAP v1.1
Seguridad Si Método WSS - UsernameToken
Petición Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Respuesta Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Configuración
ESB
Servicios Backend
@firma
http://$AFIRMA_HOST:
$AFIRMA_PORT/afirmaws/services/DSSBatchVerifyCe
rtificate
https://$AFIRMA_HOST:
$AFIRMA_SEC_PORT/afirmaws/services/DSSBatchVe
rifyCertificate
CSGD N/A
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
DSSBatchVerifyCe
rtificate.xml Proxy N/A Implementación servicio
DSSBatchVerifyCe
rtificate.wsdl WSDL conf:/repository/esb/re
gistry/wsdl Definición servicio.
Información
adicional
Para más detalle sobre el servicio, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
6.2.7 DSSBatchVerifySignature
DSSBatchVerifySignature
Descripción Servicio de Validación Masiva de Firmas. Mediante este servicio se puede solicitar
la verificación asíncrona de un conjunto de firmas.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 115 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
DSSBatchVerifySignature
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/DSSBatchVerifySignature
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/DSSBatchVerifySignatur
e
Protocolo SOAP v1.1
Seguridad Si Método WSS - UsernameToken
Petición Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Respuesta Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Configuració
n ESB
Servicios Backend
@firma
http://$AFIRMA_HOST:
$AFIRMA_PORT/afirmaws/services/DSSBatchVerifySign
ature
https://$AFIRMA_HOST:
$AFIRMA_SEC_PORT/afirmaws/services/DSSBatchVerify
Signature
CSGD N/A
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
DSSBatchVerify
Signature.xml Proxy N/A Implementación servicio
DSSBatchVerify
Signature.wsdl WSDL conf:/repository/esb/
registry/wsdl Definición servicio.
Información
adicional
Para más detalle sobre el servicio, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
6.2.8 GetInfoCertificate
GetInfoCertificate
Descripción
Servicio web que permite extraer la información de un certificado mediante la
aplicación del mapeo definido para su tipo en la utilidad de administración de la
plataforma. Este proceso verificará que el tipo de certificado se encuentra
definido en la plataforma y que la aplicación que realiza la petición tiene acceso a
dicho tipo de certificado.
Invocación
EndPoint
http://$ESB_HOST:
$ESB_PORT/esb/services/GetInfoCertificate
https://$ESB_HOST:
$ESB_SEC_PORT/esb/services/GetInfoCertificate
Protocolo SOAP v1.1
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 116 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
GetInfoCertificate
Seguridad Si Método WSS - UsernameToken
Petición Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Respuesta Ver documento @Firma-Global-XMLSOAP_PROFILE_DSS.
Configuració
n ESB
Servicios Backend
@firma
http://$AFIRMA_HOST:
$AFIRMA_PORT/afirmaws/services/GetInfoCertificate
https://$AFIRMA_HOST:
$AFIRMA_SEC_PORT/afirmaws/services/GetInfoCertifica
te
CSGD N/A
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
GetInfoCertificat
e.xml Proxy N/A Implementación servicio
GetInfoCertificat
e.wsdl WSDL conf:/repository/esb/
registry/wsdl Definición servicio.
Información
adicional
Para más detalle sobre el servicio, consultar el documento @Firma-Global-
XMLSOAP_PROFILE_DSS.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 117 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
7 Configuración y Recursos
Este apartado detalla y describe los diferentes recursos empleados por los servicios de la
capa CSGD, desplegada en el componente ESB, de forma que efectúen la funcionalidad
para la que han sido desarrollados. Para cada uno de estos recursos se especificarán las
siguientes características:
Nombre / Denominación. Nombre del recurso.
Descripción. Se detalla el propósito o funcionalidad desempeñada por el recurso.
Tipo de recurso. Determina el tipo de recurso, pudiendo ser estos los siguientes:
Implementación servicio ESB (Proxy). Recursos que representan la
implementación de un servicio desplegado en el ESB.
Definición de servicios SOAP (WSDL). Estos recursos son utilizados
para definir y describir servicios web SOAP.
Políticas de seguridad (WS-Policy). Mediantes estos recursos se
configurar las políticas de seguridad empleadas en la invocación (cliente),
y securización de servicios web SOAP (servidor).
Scripts (JavaScripts). Scripts, tipo JavaScript, empleados por los servicios
web pertenecientes a la capa CSGD, y desplegados en el componente ESB.
Plantilla Secuencia (Template Sequence). Flujos de procesamiento de
mensajes predefinidos que llevan a cabo determinadas funcionalidades,
aceptando la recepción de parámetros. La especificación de estos recursos
será realizará de forma análoga a la efectuada sobre los servicios descritos
en apartados anteriores.
Transformaciones XSL (XSLT). Archivos que incluyen hojas o plantillas
de transformación XSL.
Ruta de instalación. Localización del recurso en el registro del componente ESB.
Información adicional sobre el recurso.
En los siguientes apartados se enumeran los recursos desarrollados y desplegados en el
componente ESB.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 118 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
7.1 Definición de Servicios SOAP (WSDL)
Las siguientes tablas recogen la descripción de los recursos de tipo WSDL desplegados
en el componente ESB.
DSSAfirmaArchiveRetrieval.wsdl
Nombre DSSAfirmaArchiveRetrieval.wsdl
Descripción Definición y descripción del servicio web DSSAfirmaArchiveRetrieval.
Tipo de
Recurso WSDL
Ruta de
instalación conf1:/repository/esb/registry/wsdl
Información
adicional N/A
DSSAfirmaSign.wsdl
Nombre DSSAfirmaSign.wsdl
Descripción Definición y descripción del servicio web DSSAfirmaSign.
Tipo de
Recurso WSDL
Ruta de
instalación conf:/repository/esb/registry/wsdl
Información
adicional N/A
1 La localización “conf:” representa la ruta “/_system/config” en el registro del componente ESB.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 119 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
DSSAfirmaVerify.wsdl
Nombre DSSAfirmaVerify.wsdl
Descripción Definición y descripción del servicio web DSSAfirmaVerify.
Tipo de
Recurso WSDL
Ruta de
instalación conf:/repository/esb/registry/wsdl
Información
adicional N/A
DSSAfirmaVerifyCertificate.wsdl
Nombre DSSAfirmaVerifyCertificate.wsdl
Descripción Definición y descripción del servicio web DSSAfirmaVerifyCertificate.
Tipo de
Recurso WSDL
Ruta de
instalación conf:/repository/esb/registry/wsdl
Información
adicional N/A
DSSAsyncRequestStatus.wsdl
Nombre DSSAsyncRequestStatus.wsdl
Descripción Definición y descripción del servicio web DSSAsyncRequestStatus.
Tipo de
Recurso WSDL
Ruta de
instalación conf:/repository/esb/registry/wsdl
Información
adicional N/A
DSSBatchVerifyCertificate.wsdl
Nombre DSSBatchVerifyCertificate.wsdl
Descripción Definición y descripción del servicio web DSSBatchVerifyCertificate.
Tipo de
Recurso WSDL
Ruta de
instalación conf:/repository/esb/registry/wsdl
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 120 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
DSSBatchVerifyCertificate.wsdl
Información
adicional N/A
DSSBatchVerifySignature.wsdl
Nombre DSSBatchVerifySignature.wsdl
Descripción Definición y descripción del servicio web DSSBatchVerifySignature.
Tipo de
Recurso WSDL
Ruta de
instalación conf:/repository/esb/registry/wsdl
Información
adicional N/A
GetInfoCertificate.wsdl
Nombre GetInfoCertificate.wsdl
Descripción Definición y descripción del servicio web GetInfoCertificate.
Tipo de
Recurso WSDL
Ruta de
instalación conf:/repository/esb/registry/wsdl
Información
adicional N/A
7.2 Políticas de Seguridad (WS-Policy)
Las siguientes tablas recogen la descripción de los recursos de tipo WS-Policy
desplegados en el componente ESB.
UTFromRestGD.xml
Nombre UTFromRestGD.xml
Descripción
Política de seguridad empleada para securizar las peticiones SOAP efectuadas
sobre servicios web cuyo método de autenticación es WSS-Usernametoken,
siendo la password incluida en claro en la cabecera de seguridad.
Tipo de
Recurso WS-Policy
Ruta de
instalación conf:/repository/esb/registry/wsPolicy
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 121 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
UTFromRestGD.xml
Información
adicional
El establecimiento del nombre de usuario y password es efectuado mediante
un mediador tipo class, implementado mediante la clase
es.caib.archivodigital.esb.services.mediators.wss.UsernameTokenRestMediator
(librería gib-esb-java-mediators-1.0.0.jar).
UTHashedPassFromRestGD.xml
Nombre UTHashedPassFromRestGD.xml
Descripción
Política de seguridad empleada para securizar las peticiones SOAP efectuadas
sobre servicios web cuyo método de autenticación es WSS-Usernametoken,
siendo la password incluida de forma no legible en la cabecera de seguridad.
Tipo de
Recurso WS-Policy
Ruta de
instalación conf:/repository/esb/registry/wsPolicy
Información
adicional
El establecimiento del nombre de usuario y password es efectuado mediante
un mediador tipo class, implementado mediante la clase
es.caib.archivodigital.esb.services.mediators.wss.UsernameTokenRestMediator
(librería gib-esb-java-mediators-1.0.0.jar).
7.3 Scripts (JavaScripts)
Las siguientes tablas recogen la descripción de los recursos de tipo script desplegados en
el componente ESB.
createAndSetNodeUtils.js
Nombre createAndSetNodeUtils.js
Descripción
Script que implementa funciones para la construcción del parámetro de las
peticiones de los métodos createNode y modifyNode del servicio
RepositoryService, incluido en la capa GDIB.
Tipo de
Recurso Script
Ruta de
instalación conf:/repository/esb/registry/js
Información
adicional
Las funciones implementadas son: buildCreateFileRequest,
buildCreateChildFileRequest, buildCreateFolderRequest,
buildCreateDraftDocRequest, buildSetDocRequest, buildSetFileRequest,
buildSetFolderRequest, buildSetFinalDocRequest,
buildCreateTargetDocRequest, buildSetDispatchedDocRequest,
dateToISOString, generatePropertiesReqElement y
generateBinaryContentsReqElement.
El uso de este script, y sus funciones, es realizado mediante el mediador
script.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 122 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getDocumentUtils.js
Nombre getDocumentUtils.js
Descripción
Script que implementa funciones para la extracción de información de los
documentos incluida en las respuestas del servicio getDocument de la capa
CSGD.
Tipo de
Recurso Script
Ruta de
instalación conf:/repository/esb/registry/js
Información
adicional
Las funciones implementadas son: getTypeDocId,
extractContentAndSignatureGetDocResp, extractDocumentInfo y
extractDocumentInfoAndContents.
El uso de este script, y sus funciones, es realizado mediante el mediador
script.
luceneQueryUtils.js
Nombre luceneQueryUtils.js
Descripción
Script que implementa funciones para la construcción y verificación de
consultas Lucene incluidas como parámetro de entrada del método
searchNode del servicio RepositoryService, incluido en la capa GDIB.
Tipo de
Recurso Script
Ruta de
instalación conf:/repository/esb/registry/js
Información
adicional
Las funciones implementadas son: checkDocLuceneQuery,
checkFileLuceneQuery, buildFileLuceneQuery y buildDocLuceneQuery.
El uso de este script, y sus funciones, es realizado mediante el mediador
script.
migrationRepoUtils.js
Nombre migrationRepoUtils.js
Descripción
Script que implementa funciones para la extracción de información de las
respuestas, y formación de peticiones, de los métodos del servicio
MigrationService de la capa GDIB.
Tipo de
Recurso Script
Ruta de
instalación conf:/repository/esb/registry/js
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 123 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
migrationRepoUtils.js
Información
adicional
Las funciones implementadas son: buildTransformMigratedDocRequest.
El uso de este script, y sus funciones, es realizado mediante el mediador
script.
permissionsNodeUtils.js
Nombre permissionsNodeUtils.js
Descripción
Script que implementa funciones para la construcción de peticiones de los
métodos authorizeNode y removeAuthority del servicio RepositoryService,
incluido en la capa GDIB.
Tipo de
Recurso Script
Ruta de
instalación conf:/repository/esb/registry/js
Información
adicional
Las funciones implementadas son: buildAuthorizeDocsRequest,
buildCancelPermissionsOnDocsRequest, buildAuthorizeFilesRequest,
buildCancelPermissionsOnFilesRequest, buildAuthorizeFoldersRequest y
buildCancelPermissionsOnFoldersRequest.
El uso de este script, y sus funciones, es realizado mediante el mediador
script.
serviceHeaderUtils.js
Nombre serviceHeaderUtils.js
Descripción
Script que implementa funciones para la verificación de la cabecera de los
servicios REST/JSON de la capa CSGD, y la construcción de la cabecera
incluida en las peticiones de los métodos de los servicios pertenecientes a la
capa GDIB (gdibHeader).
Tipo de
Recurso Script
Ruta de
instalación conf:/repository/esb/registry/js
Información
adicional
Las funciones implementadas son: parseServiceHeader y
parseGetEcmAutTicketServiceHeader.
El uso de este script, y sus funciones, es realizado mediante el mediador
script.
7.4 Plantillas Secuencia (Template Sequence)
Las siguientes tablas recogen la descripción de los recursos de tipo Template Sequence
desplegados en el componente ESB.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 124 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CreateNodeSequence
Descripción
Secuencia que invoca el método createNode del servicio RepositoryService
habilitando la creación de nuevos nodos para las entidades de tipo
eni:documento, eni:expediente y eni:agregacionDoc.
Parámetros
reqService Información y contenido del nodo a crear en el SGD,
incluido el nodo padre (opcional).
retrieveNode Indica si se desea recuperar el contenido del nodo creado.
nodeType Tipo de datos del nodo a crear (eni:documento,
eni:expediente y eni:agregacionDoc).
serviceHeaderS
tring
Fragmento XML correspondiente a la cabecera de auditoria,
gdibHeader, incluida como parte del parámetro de entrada
de las peticiones del servicio RepositoryService.
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB createNode o createAndGetNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Recursos
Nombre Tipo Ruta Descripción
CreateNodeSequen
ce.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
createDocumentXM
LResponse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio createNode (capa
GDIB), entidades de tipo
eni:documento, versión
definitiva.
createDraftDocume
ntXMLResponse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio createNode (capa
GDIB), entidades de tipo
eni:documento, versión
borrador.
createFileXMLRespo
nse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio createNode (capa
GDIB), entidades de tipo
eni:expediente.
createChildFileXML
Response.xslt
XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio createNode (capa
GDIB), entidades de tipo
eni:expediente
(subexpedientes).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 125 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
CreateNodeSequence
createFolderXMLRes
ponse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio createNode (capa
GDIB), entidades de tipo
eni:agregacionDoc
Información
adicional
Requiere el establecimiento de la URL del servicio RepositoryService en el
endpoint definido en el mediador call, que efectúa la invocación de dicho
servicio.
ExceptionSequence.xml
Descripción Secuencia que procesa, parsea y retorna de las excepciones producidas en los
servicios de la capa CSGD (incluyendo las secuencias invocadas).
Parámetros N/A N/A
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB N/A
Recursos
Nombre Tipo Ruta Descripción
ExceptionSequence
.xml.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
Información
adicional La excepción es retornada en notación JSON, tipo de datos Exception.
GetMigrationNodeSequence
Descripción
Secuencia que invoca el método getMigrationNode del servicio MigrationService
habilitando la recuperación de información para las entidades de tipo
gdib:documentoMigrado.
Parámetros
appId Nombre de la aplicación propietaria del documento
migrado.
externalId Identificador externo del documento migrado.
getContent Indica si se desea recuperar el contenido del nodo
(Habilitado solo para entidades de tipo eni:documento).
serviceHeaderS
tring
Fragmento XML correspondiente a la cabecera de auditoria,
gdibHeader, incluida como parte del parámetro de entrada
de las peticiones del servicio RepositoryService.
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 126 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
GetMigrationNodeSequence
GDIB getMigrationNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/migration).
Recursos
Nombre Tipo Ruta Descripción
GetMigrationNodeS
equence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
getMigrationDocXM
LResponse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio getMigrationNode
(capa GDIB), entidades de
tipo gdib:documentoMigrado
Información
adicional
Requiere el establecimiento de la URL del servicio MigrationService en el
endpoint definido en el mediador call, que efectúa la invocación de dicho
servicio.
GetNodeSequence
Descripción
Secuencia que invoca el método getNode del servicio RepositoryService
habilitando la recuperación de información para las entidades de tipo
eni:documento, eni:expediente y eni:agregacionDoc.
Parámetros
nodeId Identificador del nodo a recuperar del SGD (Tipo
RequestNodeId)
getContent Indica si se desea recuperar el contenido del nodo
(Habilitado solo para entidades de tipo eni:documento).
nodeType Tipo de datos del nodo a recuperar (eni:documento,
eni:expediente y eni:agregacionDoc).
serviceHeaderS
tring
Fragmento XML correspondiente a la cabecera de auditoria,
gdibHeader, incluida como parte del parámetro de entrada
de las peticiones del servicio RepositoryService.
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
getNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
getMigrationInfo (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Recursos
Nombre Tipo Ruta Descripción
GetNodeSequence.
xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 127 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
GetNodeSequence
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
getDocumentXMLRe
sponse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio getNode (capa
GDIB), entidades de tipo
eni:documento
getMigrationInfoXM
LResponse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio getMigrationInfo
(capa GDIB)
getFileXMLRespons
e.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio getNode (capa
GDIB), entidades de tipo
eni:expediente
getFolderXMLRespo
nse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio getNode (capa
GDIB), entidades de tipo
eni:agregacionDoc
Información
adicional
Requiere el establecimiento de la URL del servicio RepositoryService en los
endpoints definidos en los mediadores call, que efectúan la invocación de dicho
servicio.
LinkNodeSequence
Descripción
Secuencia que invoca el método linkNode del servicio RepositoryService
habilitando la copia y generación de referencias sobre nodos almacenados en el
SGD para las entidades de tipo eni:documento, eni:expediente y
eni:agregacionDoc.
Parámetros
nodeId Identificador del nodo que será referenciado o copiado en
una nueva ubicación (Tipo RequestNodeId).
targetParent Identificador del nuevo nodo padre (Tipo RequestNodeId).
linkMode Modo en el que es agregado el nodo a su nuevo padre,
copia (copy), o referencia (reference).
serviceHeaderS
tring
Fragmento XML correspondiente a la cabecera de auditoria,
gdibHeader, incluida como parte del parámetro de entrada
de las peticiones del servicio RepositoryService.
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB linkNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Recursos
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 128 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
LinkNodeSequence
Nombre Tipo Ruta Descripción
LinkNodeSequence.
xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
Información
adicional
Requiere el establecimiento de la URL del servicio RepositoryService en el
endpoint definido en el mediador call, que efectúa la invocación de dicho
servicio.
MoveNodeSequence
Descripción
Secuencia que invoca el método moveNode del servicio RepositoryService
habilitando el cambio de localización de un determinado nodo almacenado en el
SGD para las entidades de tipo eni:documento, eni:expediente y
eni:agregacionDoc.
Parámetros
nodeId Identificador del nodo que será movido a una nueva
ubicación (Tipo RequestNodeId).
targetParent Identificador del nuevo nodo padre (Tipo RequestNodeId).
serviceHeaderS
tring
Fragmento XML correspondiente a la cabecera de auditoria,
gdibHeader, incluida como parte del parámetro de entrada
de las peticiones del servicio RepositoryService.
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB moveNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Recursos
Nombre Tipo Ruta Descripción
MoveNodeSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
Información
adicional
Requiere el establecimiento de la URL del servicio RepositoryService en el
endpoint definido en el mediador call, que efectúa la invocación de dicho
servicio.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 129 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
ReusableNodeOpSequence
Descripción
Secuencia que invoca el servicio RepositoryService, habilitando previamente la
construcción de las peticiones de los siguientes métodos: lockNode,
unlockNode, removeNode, getNodeVersionList, foliateNode, openNode y
closeFile.
Parámetros
nodeId
Identificador del nodo para el cual se solicita la operación
(bloqueo, reapertura de expediente, generación de índice
electrónico, etc.).
gdibOperation Nombre de la operación a efectuar (método del servicio
RepositoryService).
serviceHeaderS
tring
Fragmento XML correspondiente a la cabecera de auditoria,
gdibHeader, incluida como parte del parámetro de entrada
de las peticiones del servicio RepositoryService.
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB
lockNode, unlockNode, removeNode, getNodeVersionList,
foliateNode, exportNode, openNode y closeFile (http://
$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Recursos
Nombre Tipo Ruta Descripción
ReusableNodeOpSe
quence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
Información
adicional
Requiere el establecimiento de la URL del servicio RepositoryService en el
endpoint definido en el mediador call, que efectúa la invocación de dicho
servicio.
ReusableServiceReqSequence
Descripción
Secuencia que invoca el servicio RepositoryService, habilitando previamente la
construcción de las peticiones de los siguientes métodos: modifyNode,
authorizeNode y removeAuthority.
Parámetros
reqService Parámetro de entrada, sin cabecera, de la petición.
gdibOperation Nombre de la operación a efectuar (método del servicio
RepositoryService).
serviceHeaderS
tring
Fragmento XML correspondiente a la cabecera de auditoria,
gdibHeader, incluida como parte del parámetro de entrada
de las peticiones del servicio RepositoryService.
Configuración
ESB
Servicios Backend
@firma N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 130 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
ReusableServiceReqSequence
CSGD N/A
GDIB
modifyNode, authorizeNode, removeAuthority (http://
$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Recursos
Nombre Tipo Ruta Descripción
ReusableServiceReq
Sequence.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
Información
adicional
Requiere el establecimiento de la URL del servicio RepositoryService en el
endpoint definido en el mediador call, que efectúa la invocación de dicho
servicio.
SearchNodeSequence
Descripción
Secuencia que invoca el método searchNode del servicio RepositoryService
habilitando la búsqueda de nodos almacenados en el SGD para las entidades de
tipo eni:documento, gdib:documentoMigrado y eni:expediente.
Parámetros
luceneQuery Consulta Lucene a ejecutar sobre el SGD.
serviceHeaderS
tring
Fragmento XML correspondiente a la cabecera de auditoria,
gdibHeader, incluida como parte del parámetro de entrada
de las peticiones del servicio RepositoryService.
nodeType Tipo de datos de los nodos a devolver (documento o
eni:expediente).
Configuración
ESB
Servicios Backend
@firma N/A
CSGD N/A
GDIB searchNode (http://$SGD_HOST:
$SGD_PORT/alfresco/webservice/gdib/repository).
Recursos
Nombre Tipo Ruta Descripción
SearchNodeSequen
ce.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
ExceptionSequence
.xml
Template
Sequence
conf:/repository/esb/
registry/sequences
Implementación de la
plantilla secuencia
encargada de la captura y
retorno de excepciones.
searchDocumentsX
MLResponse.xslt
XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio searchNode (capa
GDIB), para documentos.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 131 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
SearchNodeSequence
searchFilesXMLResp
onse.xslt XSLT conf:/repository/esb/
registry/xslt
Transformación XSL de
respuesta retornada por el
servicio searchNode (capa
GDIB), para entidades de
tipo eni:expediente.
Información
adicional
Requiere el establecimiento de la URL del servicio RepositoryService en el
endpoint definido en el mediador call, que efectúa la invocación de dicho
servicio.
7.5 Transformaciones XSL (XSLT)
Las siguientes tablas recogen la descripción de los recursos de tipo XSLT desplegados en
el componente ESB.
parseDocumentXMLResponse.xslt
Nombre parseDocumentXMLResponse.xslt
Descripción
Plantila XSLT reutilazable que transforma la información relativa a
documentos incluida en las respuestas de los métodos del servicio
RepositoryService perteneciente a la capa GDIB (eni:documento), a una
estructura XML equivalente al tipo de datos DocumentNode en notación
JSON.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
Recibe el parámetro retrieveContent para determinar si debe incluir el
contenido y firma del documento.
parseFileXMLResponse.xslt
Nombre parseFileXMLResponse.xslt
Descripción
Plantila XSLT reutilazable que transforma la información relativa a
expedientes/subexpedientes incluida en las respuestas de los métodos del
servicio RepositoryService perteneciente a la capa GDIB (eni:expediente), a
una estructura XML equivalente al tipo de datos FileNode en notación JSON.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional N/A
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 132 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
parseFolderXMLResponse.xslt
Nombre parseFileXMLResponse.xslt
Descripción
Plantila XSLT reutilazable que transforma la información relativa a
agrupaciones documentales incluida en las respuestas de los métodos del
servicio RepositoryService perteneciente a la capa GDIB
(eni:agregacionDoc), a una estructura XML equivalente al tipo de datos
FolderNode en notación JSON.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional N/A
createChildFileXMLResponse.xslt
Nombre createChildFileXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método createNode, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
createChildFile de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el
mediador xslt.
Hace uso de la plantilla parseFileXMLResponse.xslt, identificada
como fillFile.xslt.
createDocumentXMLResponse.xslt
Nombre createDocumentXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método createNode, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
createDocument de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el mediador
xslt.
Hace uso de la plantilla parseDocumentXMLResponse.xslt,
identificada como fillDocument.xslt.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 133 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
createDraftDocumentXMLResponse.xslt
Nombre createDocumentXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método createNode, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
createDraftDocument de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el mediador
xslt.
Hace uso de la plantilla parseDocumentXMLResponse.xslt,
identificada como fillDocument.xslt.
createFileXMLResponse.xslt
Nombre createFileXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método createNode, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
createFile de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el
mediador xslt.
Hace uso de la plantilla parseFileXMLResponse.xslt, identificada
como fillFile.xslt.
createFolderXMLResponse.xslt
Nombre createFolderXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método createNode, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
createFolder de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 134 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
createFolderXMLResponse.xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el
mediador xslt.
Hace uso de la plantilla parseFolderXMLResponse.xslt, identificada
como fillFolder.xslt.
generateENIDocument.xslt
Nombre generateENIDocument.xslt
Descripción
Genera la estructura XML de intercambio de documentos, conforme a lo
especificado por la NTI de documento electrónico del ENI
(http://administracionelectronica.gob.es/ENI/XSD/v1.0/documento-e), a
partir de la información de un documento, tipo eni:documento, incluida en la
respuesta retornada por el servicio getDocument (previamente convertida a
formato XML).
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional El uso de este plantilla u hoja XSL es realizado mediante el mediador xslt.
getDocByCSVXMLResponse.xslt
Nombre getDocByCSVXMLResponse.xslt
Descripción
Filtra la información retornada por el servicio getDocument, de la capa
GSGD, sobre un documento, incluyendo exclusivamente su contenido y
firma electrónica, y los metadatos:
eni:app_tramite_doc,eni:csv,eni:tipoFirma,eni:perfil_firma,eni:id,eni:organo
,eni:v_nti,eni:origen,eni:id_origen,eni:estado_elaboracion,eni:nombre_form
ato,eni:extensión_formato,eni:def_csv.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el
mediador xslt.
getDocumentXMLResponse.xslt
Nombre getDocumentXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método getNode, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
getDocument de la capa CSGD.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 135 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getDocumentXMLResponse.xslt
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el mediador
xslt.
Hace uso de la plantilla parseDocumentXMLResponse.xslt,
identificada como fillDocument.xslt.
getDocVersionListXMLResponse.xslt
Nombre getDocVersionListXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método getNodeVersionList, del
servicio RepositoryService perteneciente a la capa GDIB, a una estructura
XML equivalente, en notación JSON, a la respuesta retornada por el servicio
getDocVersionList de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional El uso de este plantilla u hoja XSL es realizado mediante el mediador xslt.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 136 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getEcmAutTicketXMLResponse.xslt
Nombre getEcmAutTicketXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método getTicket, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
getEcmAutTicket de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional El uso de este plantilla u hoja XSL es realizado mediante el mediador xslt.
getFileVersionListXMLResponse.xslt
Nombre getFileVersionListXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método getNodeVersionList, del
servicio RepositoryService perteneciente a la capa GDIB, a una estructura
XML equivalente, en notación JSON, a la respuesta retornada por el servicio
getFileVersionList de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional El uso de este plantilla u hoja XSL es realizado mediante el mediador xslt.
getFileXMLResponse.xslt
Nombre getFileVersionListXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método getNode, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
getFile de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el
mediador xslt.
Hace uso de la plantilla parseFileXMLResponse.xslt, identificada
como fillFile.xslt.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 137 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getFolderXMLResponse.xslt
Nombre getFolderXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método getNode, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
getFolder de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el
mediador xslt.
Hace uso de la plantilla parseFolderXMLResponse.xslt, identificada
como fillFolder.xslt.
getMigrationDocXMLResponse.xslt
Nombre getMigrationDocXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método getMigrationNode, del
servicio MigrationService perteneciente a la capa GDIB, a una estructura
XML equivalente, en notación JSON, a la respuesta retornada por el servicio
getDocument de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional El uso de este plantilla u hoja XSL es realizado mediante el mediador xslt.
getMigrationInfoXMLResponse.xslt
Nombre getMigrationInfoXMLResponse.xslt
Descripción
Genera una estructura XML interna a partir de la respuesta retornada por el
método getMigrationInfo del servicio RepositoryService, perteneciente a la
capa GDIB.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional El uso de este plantilla u hoja XSL es realizado mediante el mediador xslt.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 138 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
getNumDocsReturnedByCSVXMLResponse.xslt
Nombre getNumDocsReturnedByCSVXMLResponse.xslt
Descripción
Filtra la información retornada por el servicio documentSearch, de la capa
GSGD, calculando el número de documentos distintos retornados de la
búsqueda solicitada.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el
mediador xslt.
searchDocumentsXMLResponse.xslt
Nombre searchDocumentsXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método searchNode, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
searchDocuments de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el
mediador xslt.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 139 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
searchFilesXMLResponse.xslt
Nombre searchFilesXMLResponse.xslt
Descripción
Transforma la respuesta retornada por el método searchNode, del servicio
RepositoryService perteneciente a la capa GDIB, a una estructura XML
equivalente, en notación JSON, a la respuesta retornada por el servicio
searchFiles de la capa CSGD.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional
El uso de este plantilla u hoja XSL es realizado mediante el
mediador xslt.
validateDocXMLResponse.xslt
Nombre validateDocXMLResponse.xslt
Descripción
Genera una estructura XML equivalente, en notación JSON, a la respuesta
retornada por el servicio validateDocument de la capa CSGD, incluyendo
exclusivamente el informe de validación de las firmas electrónicas y el
resultado del servicio.
Tipo de
Recurso XSLT
Ruta de
instalación conf:/repository/esb/registry/xslt
Información
adicional El uso de este plantilla u hoja XSL es realizado mediante el mediador xslt.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 140 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
8 Librerías y Plugins Java
Este apartado detalla y describe las diferentes librerías y plugins Java desarrollados, para
su uso desde los servicios desplegados y pertenecientes a la capa de servicios CSGD, e
implantados en el componente WSO2-ESB. Para cada una de estas librerías se
especificarán las siguientes características:
Nombre / Denominación. Nombre de la librería.
Versión de la librería.
Fuentes de la librería. Nombre del proyecto Java que contiene los fuentes de la
librería o plugin (bundle OSGi).
Descripción. Se detalla las funcionalidades aportadas por la librería o plugin
(bundle OSGi).
Dependencias. Librerías Java que deben ser instaladas en el componente WSO2
para el correcto funcionamiento de la librería o plugin (bundle OSGi).
Ruta de instalación. Localización de la librería en el componente WSO2 donde es
desplegada.
Información adicional sobre la librería.
csgd-caib-java-mediators-1.0
Nombre csgd-caib-java-mediators-1.0.jar
Versión 1.0
Fuentes
Proyecto: JavaMediators (localizado en directorio CAIB/ESB)
Tipo proyecto: Maven. No obstante, como componente WSO2, el proyecto
debe ser creado como proyecto “Java Library Project” (El archivo pom.xml
debe incluir la propiedad CApp.type, con el valor lib/library/bundle).
JVM 7.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 141 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
csgd-caib-java-mediators-1.0
Descripción
Bundle OSGi que agrupa mediadores WSO2 desarrollados a medida para llevar a
cabo ciertas funcionalidades tales como:
Codificación y descodificación en Base64 de cadenas de caracteres. La
clase que implementa el mediador es
es.caib.archivodigital.esb.services.mediators.Base64Mediator.
Establecimiento de usuario/password a incluir en cabeceras WSS en la
invocación de servicios web mediante SOAP. La clase que implementa el
mediador es
es.caib.archivodigital.esb.services.mediators.wss.UsernameTokenRestMedi
ator.
Generación del parámetro de entrada incluido en la petición del servicio
DSSAfirmaVerify para la validación de una firma electrónica, tomando
como base el componente Integr@ de la suite @firma v6. La clase que
implementa el mediador es
es.caib.archivodigital.esb.services.mediators.afirma.GenerateAfirmaDSSV
erifySignatureRequestMediator.
Extracción de información de la respuesta retornada por el servicio
DSSAfirmaVerify al solicitar la validación de una firma electrónica,
tomando como base el componente Integr@ de la suite @firma v6. La
clase que implementa el mediador es
es.caib.archivodigital.esb.services.mediators.afirma.ParseAfirmaDSSVerify
SignatureResponseMediator.
Dependencias
bcprov-jdk15on-1.55.jar
bcpkix-jdk15on-1.55.jar
itextpdf-5.5.9.jar
xmlsec-1.5.0.jar
Ruta de
instalación $CARBON_HOME/repository/components/dropins
Información
adicional
Una actualización de este bundle OSGi exige el reinicio del componente WSO2
donde se encuentra desplegado.
Las instrucciones para la instalación de estas librerías y plugins en un componente WSO2
son las siguientes:
1. Generar binarios. Para ello es necesario situarse en el directorio raíz del
proyecto, y ejecutar por ejemplo la siguiente instrucción2:
user@workStation:~#mvn -l salidaGenBinarios.log clean install
2 Previa a la ejecución del comando Maven que genera la distribución binaria del componente, es necesario
verificar la correcta definición de las variables de entorno JAVA_HOME y M2_HOME, así como la inclusión de las
rutas $JAVA_HOME/jre/bin y $M2_HOME/bin en la variable de entorno PATH.
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 142 / 169
Fecha: 18/05/2017
Serveis d’AE de la
CAIB
2. Detener el componente WSO2 donde será desplegado la librería, por ejemplo
mediante la ejecución del siguiente comando:
user@workStation:~# /etc/init.d/wso2-esb-4.9.0 stop
3. Desplegar la librería o plugin generado al componente WSO2.
a. Si es una librería Java, será copiada al directorio
$CARBON_HOME/repository/components/lib:
user@workStation:~#mv target/csgd-caib-libreria-1.0.jar /app/wso2esb-
4.9.0/repository/components/lib
b. Si es un plugin o bundle OSGi, será copiado al directorio
$CARBON_HOME/repository/components/dropins:
user@workStation:~#mv target/csgd-caib-bundle-1.0.jar /app/wso2esb-
4.9.0/repository/components/dropins
4. Iniciar la ejecución del componente WSO2, por ejemplo mediante la
ejecución del siguiente comando:
user@workStation:~# /etc/init.d/wso2-esb-4.9.0 start
Para obtener más información sobre el desarrollo y despliegue Custom Mediators, visitar
la web de WSO2-ESB v4.9.0
(https://docs.wso2.com/display/ESB490/Writing+a+WSO2+ESB+Mediator).
CAIB-GestiónDocumental Manual Capa de Servicios CSGD
v01r03.docx
Pàgina 143 / 169
Fecha: 18/05/2017
Anexos
A.1 Metadatos y Aspectos de Entidades Documentales
La capa de servicios desarrollada se apoya en un modelo de datos Alfresco desplegado
en el SGD, el cual define las entidades de datos y aspectos asociados a las entidades
documentales que conforman los repositorios documentales del Govern.
ENI
Prefijo eni
Namespace http://www.administracionelectronica.gob.es/model/eni/1.0
Tipos de datos
eni:documento.
eni:expediente.
eni:agregacionDoc.
Aspectos
eni:firmadoBase. Características base de la firma electrónica de un
documento.
eni:firmado. Firma electrónica de un documento.
eni:interoperable. Agrupa el conjunto de metadatos ENI que
configuran un documento o expediente con la información mínima
para ser interoperable conforme a las NTI de expediente y
documento electrónico v1.0, y complementaria recomendada por ENI
para la correcta gestión de los documentos y expedientes.
eni:registrable. Agrupa las propiedades correspondientes a la
información de registro de los documentos.
eni:transferible. Propiedades de archivo, transferencia y clasificación
de documentos y expedientes.
CAIB
Prefijo gdib
Namespace http://www.caib.es/model/gdib/1.0
Tipos de datos gdib:documentoMigrado.
Aspectos
gdib:borrador. Informa si un documento se encuentra en elaboración
o borrador, o, por el contrario, es una versión definitiva y custodiada.
gdib:firmadoMigracion. Firma electrónica y contenido firmado en el
proceso de migración.
gdib:transformado. Establece que un documento, migrado desde el
Sistema de Custodia ValCert al Archivo Digital, ha sido transformado
en un documento interoperable (ENI).
gdib:trasladado. Agrupa la información correspondiente al
movimiento de un documento de registro a su ubicación definitiva.
Para cada uno de estos tipos de datos y aspectos se especificará las propiedades o
metadatos que aportan, detallando las siguientes características:
Denominación. Nombre de la propiedad o metadato.
Tipo de dato. Determina el tipo de datos Alfresco empleado para el
establecimiento de los valores del metadato o propiedad.
Origen. Permite conocer que actor o componente es el responsable de establecer
o informar el valor del metadato. Las fuentes actualmente contempladas son las
siguientes:
SSII - Sistemas de información o aplicaciones (SSII).
AD - Archivo Digital (servicio o configuración, clasificación y valoración
documental, etc.).
Custodia. Cualidades del metadato una vez es custodiada la entidad documental
a la que pertenecen en la fase activa. Estas características son las siguientes
Entidad documental sobre la que es aplicado, expediente, documento
ENI o documento migrado (E/D).
Requerido. Indica si el metadato es obligatorio u opcional en el momento
de la custodia.
Modificable. Permite conocer si el metadato puede ser actualizado tras la
custodia de la entidad documental a la que pertenecen por sistemas de
información o aplicaciones mediante la capa de servicios.
Descripción. Observaciones y detalles no recogidos en el resto de campos que
ayuden a la comprensión del metadato.
Metadato Tipo Dato Origen Custodia Descripción
E.D. Req. Mod.
id UUID AD D/E Sí No
Identificador del nodo.
Esta propiedad será empleada para
establecer lo siguiente:
Expedientes. Atributo eni:id
del elemento
eniexp:expediente.
Documentos. Atributo eni:id
del elemento
enidoc:documento.
type text AD D/E Sí No
Tipo documental definido. Lista de
valores posibles:
eni:documento.
eni:expediente.
gdib:documentoMigrado.
eni:agregacionDoc.
name text SSII D/E Sí No Nombre o denominación de la entidad
documental.
Tipo eni:docBase
eni:app_tram
ite_doc text SSII D Sí Sí Código de la aplicación de trámite que
generó el documento.
Tipo eni:expediente
eni:app_tram
ite_exp text SSII E Sí Sí Código de la aplicación de trámite que
generó el expediente.
Tipo eni:agregacionDoc
Sin metadatos
Tipo gdib:documentoMigrado
gdib:fecha_
migracion date AD D Sí No
Fecha en la que fue migrado el
documento del Sistema de Custodia
ValCert.
gdib:codigo int AD D Sí No Código único del documento en el
Sistema de Custodia ValCert.
gdib:fecha_c
ustodia date AD D Sí No
Fecha en la que se inició la custodia
del documento en el Sistema de
Custodia ValCert.
gdib:vigente boolean AD D Sí No Indica si el documento ha caducado.
gdib:fecha_fi
n_vigencia date AD D Sí No Fecha limite tras la cual el documento
no será vigente.
gdib:tipo_do
cumental text AD D Sí No Nombre del tipo de documento en el
Sistema de Custodia ValCert.
gdib:codigo_
externo text AD D Sí No
Código identificador generado
externamente por la aplicación de
tramitación que custodio el
documento.
gdib:fecha_c
reacion date AD D Sí No Fecha en la que se creó el documento.
gdib:fecha_e
liminacion date AD D No No
Fecha en la que se eliminó el
documento en el Sistema de Custodia
ValCert.
Metadato Tipo Dato Origen Custodia Descripción
E.D. Req. Mod.
gdib:fecha_p
urgado date AD D No No
Fecha en la que fue purgado el
documento en el sistema de Custodia
ValCert.
gdib:clase
text (List /
Selección
única)
AD D Sí No
Tipo de documento establecido en el
sistema de Custodia ValCert. Los
posibles valores asignables son los
siguientes:
PDF_FIRMADO
SMIME
XADES
SIN_FIRMAR
gdib:hash text AD D Sí No
Secuencia de caracteres alfanumérica
que identifica la reserva de custodia de
un documento efectuada por una
aplicación en el Sistema de Custodia
ValCert.
Aspecto eni:firmadoBase
eni:csv text SSII D Sí No Valor del Código Seguro de Verificación
del documento.
eni:tipoFirma
text (List /
Selección
única)
SSII D Sí No
Denominación normalizada del tipo de
firma. Los posibles valores asignables
son los siguientes:
TF01 - CSV.
TF02 - XAdES internally
detached signature.
TF03 - XAdES enveloped
signature.
TF04 - CAdES
detached/explicit signature.
TF05 - CAdES attached/implicit
signature.
TF06 - PAdES.
El tipo TF04 será establecido por
defecto para documentos firmados,
exceptuando los documentos en
formato PDF o PDF/A, cuyo tipo será
TF06.
Metadato Tipo Dato Origen Custodia Descripción
E.D. Req. Mod.
eni:origen
int (List /
Selección
única)
SSII D/E Sí No
Origen del contenido: Ciudadano o
administración. Los posibles valores
asignables son los siguientes:
1 (Administración).
0 (Ciudadano).
eni:id_origen text SSII D No No
Identificador normalizado del
documento origen al que corresponda
la copia, si este es un documento
electrónico. Requerido si
estado_elaboracion =EE02 o = EE03, o
= EE04.
Formato del identificador descrito en
metadato id de este aspecto
(ES_<ORGANO>_<AAAA>_<ID_ESP>
).
eni:estado_e
laboracion
text (List /
Selección
única)
SSII D Sí No
Estado de la situación de elaboración
del documento. Los posibles valores
asignables son los siguientes:
EE01 (Original).
EE02 (Copia electrónica
auténtica con cambio de
formato).
EE03 (Copia electrónica
auténtica de documento
papel )
EE04 (Copia electrónica parcial
auténtica).
EE99 (Otros)
eni:tipo_doc
_ENI
text (List /
Selección
única)
SSII D Sí Sí
Tipo de documento ENI. Los posibles
valores asignables son los siguientes:
TD01 (Resolución), TD02 (Acuerdo),
TD03 (Contrato), TD04 (Convenio),
TD05 (Declaración), TD06
(Comunicación), TD07 (Notificación),
TD08 (Publicación), TD09 (Acuse de
recibo), TD10 (Acta), TD11
(Certificado), TD12 (Diligencia), TD13
(Informe), TD14 (Solicitud), TD15
(Denuncia), TD16 (Alegación), TD17
(Recursos), TD18 (Comunicación
ciudadano), TD19 (Factura), TD20
(Otros incautados) y TD99 (Otros).
eni:fecha_ini
cio date SSII/AD D/E No Sí
Fecha de captura del documento o
apertura del expediente en el sistema.
Si no es informada por el sistema de
información, se establece la fecha de
creación del nodo en el SGD.
eni:cod_clasi
ficacion text SSII D/E Sí No
Identificador único codificado que
determina una categoría en el Cuadro
de Clasificación de CAIB.
Metadato Tipo Dato Origen Custodia Descripción
E.D. Req. Mod.
eni:nombre_f
ormato text SSII D No Sí
Denominación del formato lógico del
fichero contenido en el documento
electrónico.
Requerido solo para documentos en
formato electrónico (“soporte”
=Digital).
eni:extensio
n_formato text SSII D No Sí
Requerido solo para documentos en
formato electrónico (“soporte”
=Digital).
eni:def_csv text AD D Sí No
Referencia a la disposición normativa
que define la creación y uso del CSV
correspondiente.
eni:resolucio
ntext SSII D No Sí
Medida de la capacidad para capturar
los detalles del documento original, a
menudo cuantificada en píxeles por
pulgada.
eni:idioma text SSII D No Sí
Idioma o lengua utilizada en un
documento, hablada o usada por un
agente al realizar una actividad.
eni:estado_e
xp
text (List /
Selección
única)
AD E Sí No
Estado del expediente en el momento
de traslado (Abierto, Cerrado, Índice
para remisión cerrado).
Los posibles valores asignables son los
siguientes:
E01 (Abierto).
E02 (Cerrado).
E03 (Índice para remisión
cerrado, exclusivo para
subexpedientes de
intercambio).
eni:tamano_l
ogico text SSII D/E No Sí
Tamaño lógico del documento o
expediente (para este último,
calculado como el número de unidades
que lo componen).
eni:interesad
os_exp
text
(Múltiple) SSII E No Sí Lista de identificadores de interesados
en el expediente.
eni:descripci
on text SSII D/E No Sí Información adicional sobre el
documento o expediente.
eni:termino_
punto_acces
o
text SSII D No Sí Palabra clave que describe el contenido
del documento o de la regulación.
eni:id_punto
_acceso text SSII D No Sí
Identificador asignado a una palabra
clave dentro de un esquema de puntos
de acceso.
eni:esquema
_punto_acce
so
text SSII D No Sí
Referencia al esquema del que el
punto de acceso se ha extraído.
Condicionado al uso de taxonomías de
las que se extrae los metadatos
“Término punto de acceso” o “ID de
punto de acceso”.
Metadato Tipo Dato Origen Custodia Descripción
E.D. Req. Mod.
eni:soporte
text (List /
Selección
única)
SSII/AD D/E No Sí
Objeto físico donde se almacena un
expediente o documento. Los posibles
valores asignables son los siguientes:
Digital
CD-ROM
DVD
Disco duro externo
Memoria USB
Caja
Otros
Si no es informado por el sistema de
información, se establece el valor
“Digital”.
eni:loc_archi
vo_central text SSII D/E No Sí
Localización física del expediente en el
archivo central (Número de instalación
o caja remitida al archivo general)
eni:loc_archi
vo_general text SSII D/E No Sí
Localización física del expediente en el
archivo general (Número de instalación
o caja en el archivo general).
eni:unidades text SSII D/E No Sí
Elemento de medida utilizado para
registrar las dimensiones de un
documento físico o el tamaño o
duración lógica de un documento
digital.
eni:subtipo_
doc text SSII D No No Tipo documental específico establecido
por los procedimientos del Govern.
eni:id_tramit
etext SSII E Sí Sí
Identificador único del procedimiento
administrativo con el que se relaciona
el expediente.
Este identificador puede
corresponderse, bien con el
identificador del Sistema de
Información Administrativa (SIA), bien
con un identificador propio con el
siguiente formato:
<ORGANO>_PRO_<ID_PROC>
Donde,
ORGANO: código DIR3 de
organismo/unidad.
ID_PROC: código alfanumérico
que identifica unívocamente al
procedimiento dentro de los
propios de la administración
(Longitud: 30 caracteres).
Aspecto eni:registrable
eni:tipo_asie
nto_registral
int (List /
Selección
única)
SSII D No Sí
Tipo de asiento registral. Los posibles
valores asignables son los siguientes:
0 (Registro de entrada).
1 (Registro de salida).
Metadato Tipo Dato Origen Custodia Descripción
E.D. Req. Mod.
eni:codigo_o
ficina_registr
o
text SSII D No Sí Código de la Entidad Registral de
origen o de destino del documento.
eni:fecha_asi
ento_registr
al
date SSII D No Sí
Fecha y hora de entrada del
documento en la entidad registral de
origen o de destino.
eni:numero_
asiento_regi
stral
text SSII D No Sí
Número de registro del documento en
el registro general de la entidad de
origen o de destino.
Aspecto eni:transferible
eni:estado_a
rchivo
text (List /
Selección
única)
AD3E No No
Determina el estado de la fase semi-
activa e histórica en la que se
encuentra un expediente. Los posibles
valores asignables son los siguientes:
Preingreso.
Ingresado.
Pendiente de eliminación
total.
Pendiente de eliminación
parcial.
Pendiente de transferencia.
Eliminado.
Transferido.
Enviado.
eni:categoria
text (List /
Selección
única)
AD D/E Sí No
Tipo de entidad que se está
describiendo. Los posibles valores
asignables son los siguientes:
Serie
Expediente.
Documento simple.
eni:lopd
text (List /
Selección
única)
AD D/E Sí No
Los posibles valores asignables son los
siguientes:
Básico
Medio
Alto
En caso de no estar definido el nivel de
seguridad LOPD para la serie
documental o tipo documental del
documento o expediente, se establece
por defecto el nivel básico.
3 Una vez se encuentre el documento o expediente en fase semi activa o histórica (RM).
Metadato Tipo Dato Origen Custodia Descripción
E.D. Req. Mod.
eni:confidenc
ialidad
text (List /
Selección
única)
AD D/E Sí No
Nivel de confidencialidad de la
información contenida en el
documento acorde con el ENS. Los
posibles valores asignables son los
siguientes:
Bajo.
Medio.
Alto.
En caso de no estar definido el nivel de
confidencialidad, según ENS, para la
serie documental o tipo documental
del documento o expediente, se
establece por defecto el nivel bajo.
eni:tipo_acce
so
text (List /
Selección
única)
AD D/E Sí No
El documento se rige por el régimen
general de libre acceso o sujeto a
alguna de las limitaciones recogidas en
la legislación o normativa de
aplicación. Los posibles valores
asignables son los siguientes:
Libre.
Limitado.
En caso de no estar definido el tipo de
acceso para la serie documental o tipo
documental del documento o
expediente, se establece por defecto el
tipo libre.
Metadato Tipo Dato Origen Custodia Descripción
E.D. Req. Mod.
eni:codigo_c
ausa_limitaci
on
text (List /
Selección
única)
AD D/E No No
Asigna una codificación a la causa de
limitación de acceso que facilita las
consiguientes acciones automáticas
precisas sobre el documento, siempre
que tipo_acceso=”Limitado”.
Los posibles valores asignables son los
siguientes:
A (La seguridad nacional).
B (La defensa).
C (Las relaciones exteriores).
D (La seguridad pública).
E (La prevención,
investigación y sanción de los
ilícitos penales,
administrativos o
disciplinarios).
F (La igualdad de las partes
en los procesos judiciales y la
tutela judicial efectiva).
G (Las funciones
administrativas de vigilancia,
inspección y control).
H (Los intereses económicos y
comerciales).
I (La política económica y
monetaria).
J (El secreto profesional y la
propiedad intelectual e
industrial).
K (La garantía de la
confidencialidad o el secreto
requerido en procesos de
toma de decisión).
L (La protección del medio
ambiente).
M (Otros).
eni:normativ
atext AD D/E No No
Referencia a la ley o norma específica
que afecta al expediente o documento
en cuanto a su régimen de acceso.
eni:fase_arc
hivo
text (List /
Selección
única)
AD D/E Sí No
Fase de archivo correspondiente al
ciclo de vida del expediente que se
transfiere. Los posibles valores
asignables son los siguientes:
Archivo activo (DM).
Archivo semiactivo (RM).
Archivo histórico (RM).
eni:fecha_fin
_exp date AD E No No Fecha en que se considera finalizado el
expediente.
eni:cond_reu
tilizacion text AD D/E No No
Indica bajo qué condiciones un
expediente o documento de acceso
libre es reutilizable.
Usado si tipo_acceso= “Libre”.
Metadato Tipo Dato Origen Custodia Descripción
E.D. Req. Mod.
eni:tipo_valo
r
text (List /
Selección
única)
AD D/E Sí No
Identifica los diferentes valores
primarios de expedientes y
documentos especificados en la Tabla
de valoración. Los posibles valores
asignables son los siguientes:
Administrativo.
Fiscal.
Jurídico.
Otros.
En caso de no estar definido el valor
para la serie documental o tipo
documental del documento o
expediente, se establece por defecto el
valor “Administrativo”.
eni:plazo int AD D/E Sí No
Determinación del plazo de
prescripción de los valores primarios
(número de días).
Requerido para proceso de resellado,
una vez se cumpla el plazo establecido
para el valor primario de un
documento, este no volverá a ser
resellado.
eni:valor_sec
undario
text (List /
Selección
única)
AD D/E No No
Determinación de la existencia de
valores secundarios en los documentos
y expedientes cuya consecuencia será
la conservación permanente. Los
posibles valores asignables son los
siguientes:
Sí
No
Sin cobertura de calificación
eni:tipo_dict
amen
text (List /
Selección
única)
AD D/E Sí No
Decisión emitida por la autoridad
calificadora que debe aplicarse sobre
los documentos a lo largo de su ciclo
de vida y una vez realizada su
valoración. Los posibles valores
asignables son los siguientes:
CP (Conservación
permanente).
EP (Eliminación parcial).
ET (Eliminación total).
PD (Pendiente de dictamen).
En caso de no estar definida la
valoración para la serie documental o
tipo documental del documento o
expediente, se establece por defecto el
valor “PD”.
eni:accion_di
ctaminada text AD D/E No No
Acción concreta que se aplica al
documento en base al dictamen
adoptado por una autoridad
calificadora.
Metadato Tipo Dato Origen Custodia Descripción
E.D. Req. Mod.
gdib:zipMigr
acion content AD D Sí No
Archivo ZIP generado en el proceso de
migración.
Es retornado como un contenido
vinculado al documento, y no como un
metadato.
gdib:transfor
m_uuid UUID AD D Sí No
Identificador del nuevo documento
obtenido como resultado de la
transformación de un documento
gdib:documentoMigrado.
Aspecto gdib:trasladado
gdib:fecha_tr
aslado
date
(Múltiple) AD D No No
Fechas en las que se produce el
traslado de un documento a otro
expediente.
gdib:autor_tr
aslado
text
(Múltiple) SSII D No No
Nombres de la aplicaciones que
solicitan los diferentes traslados de un
documento a otro expediente.
gdib:destino
_traslado
text
(Múltiple) SSII D No No
Identificador de los expedientes,
subexpedientes o agrupaciones
documentales donde es trasladado un
documento.
gdib:id_nodo
_nueva_loc
UUID
(Múltiple) AD D No No
Relación de identificadores del
documento trasladado en sus nuevas
localizaciones.
gdib:tipo_de
stino
text
(Múltiple) SSII D No No
Descripción de la localización de
destino del documento a trasladar (Ej.:
“Registro de Salida” o “Expediente”).
A.2 Formatos de firma electrónica admitidos
El formato avanzado de firma electrónica de los documentos es establecido mediante los
metadatos “eni:tipoFirma”, tipo o familia de firma electrónica, y “eni:perfil_firma”, forma
o modo de la firma.
La siguiente tabla muestra las combinaciones admitidas para ambos metadatos.
Tipo Firma Perfil Firma
TF02 BES, EPES, T, C, X, XL, A
TF03 BES, EPES, T, C, X, XL, A
TF04 BES, EPES, T, C, X, XL, A
TF05 BES, EPES, T, C, X, XL, A
TF06 BES, EPES, LTV
A.3 Esquema índice electrónico foliación
Este apartado de describe detalladamente la estructura y contenido que presentarán los
índices electrónicos de los expedientes custodiados en el Archivo Digital del Govern de
les Illes Balears. El índice electrónico se corresponderá con un documento XML, cuyo
contenido estará definido mediante la versión 1.0 del esquema XML identificado
mediante el namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-
e:indice-e:1.0, y cuya integridad se será garantizada por una firma electrónica formato
XAdES-T Enveloped v1.3.2.
Este esquema está compuesto por los elementos y tipos recogidos en la siguiente tabla:
Elementos Tipos Complejos Tipos Simples
IndiceElectronico TipoContenidoCarpetaIndizada TipoEstadoExpediente
TipoContenidoCarpetas TipoFormatoFirma
TipoContenidoDocIndizado TipoFuncionHash
TipoContenidoDocReferenciado
TipoContenidoDocsIndizados
TipoContenidoDocsReferenciados
TipoContenidoExpediente
TipoContenidoExpedientes
TipoContenidoExpReferenciados
TipoContenidoFirma
TipoExpediente
TipoExpedienteReferenciado
TipoFirmaElectronica
TipoIndiceElectronico
TipoMetadatosExpediente
Otros esquema XML referenciados
XMLDSI
G
targetNamespace: http://www.w3.org/2000/09/xmldsig#
schema location: http://www.w3.org/TR/2002/REC-xmldsig-core-
20020212/xmldsig-core-schema.xsd
A continuación se definen cada uno de los elementos y tipos definido en el esquema
urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0.
Elemento IndiceElectronico
Descripció
nElemento que representa el índice electrónico de un expediente
Diagrama
namespac
eurn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Tipo caibexpind:TipoIndiceElectronico
Hijos
Nombre Tipo Req. Card.
caibexpind:contenidoExpedient
ecaibexpind:TipoExpediente Sí 1
caibexpind:firma caibexpind:TipoFirmaElectronic
aSí 1
Atributos
Nombre Tipo Uso Valor
Defecto Descripción
fechaGeneracion xsd:dateTime required Fecha de generación del
índice.
Tipo Complejo TipoContenidoCarpetaIndizada
Descripción
Define el contenido de una agrupación documental, carpeta, incluida en el
índice. Inicialmente, los elementos que pueden formar parte de un expediente
son: documentos simples, agrupaciones documentales, sub expedientes.
Tipo Complejo TipoContenidoCarpetaIndizada
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos
Nombre Tipo Req. Card.
caibexpind:documentosIndiza
dos
caibexpind:TipoContenidoDoc
sIndizados No 0..1
caibexpind:documentosRefere
nciados
caibexpind:TipoContenidoDoc
sReferenciados No 0..1
caibexpind:subexpedientes caibexpind:TipoContenidoExp
edientes No 0..1
caibexpind:expedientesRefere
nciados
caibexpind:TipoContenidoExp
Referenciados No 0..1
caibexpind:carpetasIndizadas caibexpind:TipoContenidoCar
petas No 0..1
Usado por TipoContenidoCarpetas/carpetaIndizada
Atributos
Nombre Tipo Uso Valor
Defecto Descripción
id xsd:ID optional
Identificador interno de
agrupación documental
o carpeta.
nombre xsd:string required
Nombre de la
agrupación documental
o carpeta.
Tipo Complejo TipoContenidoCarpetas
Descripción Lista de carpetas de un expediente o agrupación documental.
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos
Nombre Tipo Req. Card.
caibexpind:carpetaIndizada caibexpind:TipoContenidoCar
petaIndizada Sí 1..*
Usado por
TipoContenidoExpediente/carpetasIndizadas
TipoContenidoCarpetaIndizada/carpetasIndizadas
Atributos N/A
Tipo Complejo TipoContenidoDocIndizado
Descripción Define el contenido de un documento simple incluido en el índice de un
expediente.
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos Nombre Tipo Req. Card.
caibexpind:nombre xsd:string Sí 1
caibexpind:hash xsd:string Sí 1
caibexpind:funcionHash caibexpind:TipoFuncionHash Sí 1
caibexpind:fechaIncorporacio xsd:dateTime Sí 1
Tipo Complejo TipoContenidoDocIndizado
n
caibexpind:ordenDocumento xsd:int Sí 1
Usado por TipoContenidoDocsIndizados/docIndizado
Atributos
Nombre Tipo Uso Valor
Defecto Descripción
id xsd:ID optional Identificador interno de
documento.
Tipo Complejo TipoContenidoDocReferenciado
Descripción Define el contenido en el índice de un documento referenciado en un
expediente.
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos Nombre Tipo Req. Card.
caibexpind:nombre xsd:string Sí 1
Usado por TipoContenidoDocsReferenciados/docReferenciado
Atributos
Nombre Tipo Uso Valor
Defecto Descripción
id xsd:ID optional Identificador interno de
documento.
Tipo Complejo TipoContenidoDocsIndizados
Descripción Lista de documentos de un expediente o agrupación documental.
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos
Nombre Tipo Req. Card.
caibexpind:docIndizado caibexpind:TipoContenidoDocI
ndizado Sí 1..*
Usado por
TipoContenidoExpediente/documentosIndizados
TipoContenidoCarpetaIndizada/documentosIndizados
Atributos N/A
Tipo Complejo TipoContenidoDocsReferenciados
Descripción Lista de documentos referenciados de un expediente o agrupación documental.
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos
Nombre Tipo Req. Card.
caibexpind:docReferenciado caibexpind:TipoContenidoDoc
Referenciado Sí 1..*
Usado por
TipoContenidoExpediente/documentosReferenciados
TipoContenidoCarpetaIndizada/documentosReferenciados
Atributos N/A
Tipo Complejo TipoContenidoExpediente
Descripción
Define el contenido del expediente que será incluido en el índice. Inicialmente,
los elementos que pueden formar parte de un expediente son: documentos
simples, agrupaciones documentales, sub expedientes, y documentos y
expedientes asociados o referenciados.
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos Nombre Tipo Req. Card.
caibexpind:documentosIndiza
dos
caibexpind:TipoContenidoDoc
sIndizados No 0..1
caibexpind:documentosRefere
nciados
caibexpind:TipoContenidoDoc
sReferenciados No 0..1
caibexpind:subexpedientes caibexpind:TipoContenidoExp
edientes No 0..1
caibexpind:expedientesRefere
nciados
caibexpind:TipoContenidoExp
Referenciados No 0..1
Tipo Complejo TipoContenidoExpediente
caibexpind:carpetasIndizadas caibexpind:TipoContenidoCar
petas No 0..1
Usado por TipoExpediente/contenido
Atributos N/A
Tipo Complejo TipoContenidoExpedientes
Descripción Lista de subexpedientes de un expediente o agrupación documental.
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos Nombre Tipo Req. Card.
caibexpind:subexpediente caibexpind:TipoExpediente Sí 1..*
Usado por
TipoContenidoCarpetaIndizada/subexpedientes
TipoContenidoExpediente/subexpedientesIndizados
Atributos N/A
Tipo Complejo TipoContenidoExpReferenciados
Descripción Lista de expedientes referenciados para un expediente, sub expediente, o
agrupación documental.
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos
Nombre Tipo Req. Card.
caibexpind:expReferenciado caibexpind:TipoExpedienteRef
erenciado Sí 1..*
Usado por
TipoContenidoExpediente/expedientesReferenciados
TipoContenidoCarpetaIndizada/expedientesReferenciados
Atributos N/A
Tipo Complejo TipoContenidoFirma
Descripción Contenido de la firma electrónica del índice electrónico.
Diagrama
Tipo Complejo TipoContenidoFirma
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos Nombre Tipo Req. Card.
dsig:Signature ds:SignatureType Sí 1
Usado por TipoFirmaElectronica/contenidoFirma
Atributos N/A
Tipo Complejo TipoExpediente
Descripción Define la información incluida para un expediente o sub expediente en el índice
electrónico.
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos
Nombre Tipo Req. Card.
caibexpind:metadatos caibexpind:TipoMetadatosExp
ediente Sí 1
caibexpind:contenido caibexpind:TipoContenidoExp
ediente Sí 1
Usado por
TipoIndiceElectronico/contenidoExpediente
ipoContenidoExpedientes/subexpediente
Atributos
Nombre Tipo Uso Valor
Defecto Descripción
id xsd:ID optional Identificador interno de
un expediente.
Tipo Complejo TipoExpedienteReferenciado
Descripción Define la información incluida en el índice para los expedientes referenciados.
Tipo Complejo TipoExpedienteReferenciado
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos Nombre Tipo Req. Card.
caibexpind:numero xsd:string Sí 1
Usado por TipoContenidoExpReferenciados/expReferenciado
Atributos
Nombre Tipo Uso Valor
Defecto Descripción
id xsd:ID optional Identificador interno de
un expediente.
Tipo Complejo TipoFirmaElectronica
Descripción Define la información de la firma electrónica que garantiza la integridad del
índice electrónico.
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos
Nombre Tipo Req. Card.
caibexpind:tipoFirma caibexpind:TipoFormatoFirma Sí 1
caibexpind:contenidoFirma caibexpind:TipoContenidoFirm
aSí 1
Usado por TipoIndiceElectronico/firma
Atributos N/A
Tipo Complejo TipoIndiceElectronico
Descripción Define la información de incluida en el índice electrónico de un expediente.
Tipo Complejo TipoIndiceElectronico
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos
Nombre Tipo Req. Card.
caibexpind:contenidoExpedien
te caibexpind:TipoExpediente Sí 1
caibexpind:firma caibexpind:TipoFirmaElectroni
ca Sí 1
Usado por IndiceElectronico
Atributos
Nombre Tipo Uso Valor
Defecto Descripción
fechaGeneracion xsd:dateTime required Fecha de generación del
índice.
Tipo Complejo TipoMetadatosExpediente
Descripción Define los metadatos del expediente que serán incluidos en el índice
Diagrama
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Hijos
Nombre Tipo Req. Card.
caibexpind:numero xsd:string Sí 1
caibexpind:fechaApertura xsd:dateTime Sí 1
caibexpind:fechaCierre xsd:dateTime Sí 1
caibexpind:estado caibexpind:TipoEstadoExpedie
nte Sí 1
Usado por TipoExpediente/metadatos
Tipo Complejo TipoMetadatosExpediente
Atributos N/A
Tipo Simple TipoEstadoExpediente
Descripción
Conjunto de estados posibles para un expediente administrativo:
E01 - Abierto.
E02 - Cerrado.
E03 - Índice para remisión cerrado.
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Tipo base xsd:string
Modalidad
Tipo Valor
enumeration E01
enumeration E02
enumeration E03
Usado por TipoMetadatosExpediente/estado
Atributos N/A
Tipo Simple TipoFormatoFirma
Descripción Formatos de firma electrónica admitidos:
TF01 - XAdES enveloped signature
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Tipo base xsd:string
Modalidad Tipo Valor
enumeration TF01
Usado por TipoFirmaElectronica/tipoFirma
Atributos N/A
Tipo Simple TipoFuncionHash
Descripción
Conjunto de posibles funciones de hash empleado para generar la huella digital
de los documentos:
SHA256.
SHA512.
namespace urn:es:gdib:archivodigital:gestiondocumental:expediente-e:indice-e:1.0
Tipo base xsd:string
Modalidad
Tipo Valor
enumeration SHA256
enumeration SHA512
Usado por TipoContenidoDocIndizado/funcionHash
Atributos N/A
