En este apartado se explicarán los servicios de pfi y cómo inicializar su cliente java

Inicialización del cliente mediante CXF

Mediante sintaxis xml podemos definir fácilmente la configuración del cliente CXF para que acceda a los servicios de PFI. Inicialmente deberemos definir la referencia a la interfaz del servicio, que se encuentra dentro del cliente suministrado, así como a la dirección a la que apunta el wsdl levantado.

Code Block

language	xml
theme	Eclipse
title	IDocumentIntegrationService

<simple:client id="pfiClient" 
			   serviceClass="es.aragon.pfi.core.ws.IDocumentIntegrationService" 
			   address="http://[entorno:puerto]/pfi_core/services/IDocumentIntegrationServiceWS"
			   serviceName="s:IDocumentIntegrationService" 
			   xmlns:s="http://ws.core.pfi.aragon.es/ "
		       endpointName="s:IDocumentIntegrationServiceWS"
>
	<simple:outInterceptors>
		<ref bean="authorizeInterceptor" />
	</simple:outInterceptors>
</simple:client>

Como se puede observar en la definición XML del cliente CXF, se deberán configurar las urls donde se ubica el servicio IDocumentIntegrationServiceWS, para ello habrá que sustituir entorno y puerto por los valores correctos.
Las aplicaciones que se integran con PFI deben proporcionar en todas las peticiones el código de aplicación.

Para ello, utilizando los denominados interceptores, es posible rellenar este valor automáticamente en todas las peticiones. Como se ve en la definición del cliente se ha definido un interceptor de salida que entra en funcionamiento en el momento de construir la petición SOAP y que inserta el valor del código de aplicación en los parámetros de todos los métodos de PFI invocados.

Code Block

language	xml
theme	Eclipse

<simple:outInterceptors>
	<ref bean="authorizeInterceptor" />
</simple:outInterceptors>

La definición al bean authotizeInterceptor que se incluye a continuación, permite indicarle el código de la aplicación, de esta manera el interceptor se encarga de establecer dicho valor en todos los parámetros de las llamadas a los servicios PFI. La clase con el interceptor de salida AuthorizeOutInterceptor se proporciona junto con el cliente de PFI.

Code Block

language	xml
theme	Eclipse

<bean id="authorizeInterceptor" class="es.aragon.pfi.core.util.interceptors.AuthorizeOutInterceptor">
	<property name="applicationId" value="[código aplicación llamante]"/>
</bean>

...

Expand

title	Más detalles

Signatura

List<Signer> findQuickSignerList(SignerSearch signerSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
signerSearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
signerList	List<1241284867>	Lista de firmantes encontrados según los criterios de búsqueda indicados

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_FINDQUICKSIGNERLIST	Error genérico durante el servicio findQuickSignerList
ORGANISMLIST_XX	Error durante la consulta de los datos en SIU (XX indica el código de error en SIU)

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

SignerSearch signerSearch = new SignerSearch();
signerSearch.setSignerNif("25448659X");
List<Signer> signerList = iSignerImpl.findQuickSignerList(signerSearch);

...

Expand

title	Más detalles

Signatura

List<Signer> findSignerList(SignerSearch signerSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
signerSearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
signerList	List<1241284867>	Lista de firmantes encontrados según los criterios de búsqueda indicados

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_FINDSIGNERLIST	Error genérico durante el servicio findSignerList
GET_ORGANISM_HISTORICAL_INFORMATION_XX	Error durante la consulta de los datos en SIU (XX indica el código de error en SIU)

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

SignerSearch signerSearch = new SignerSearch();
signerSearch.setOrganismCode("ORG0001");
List<Signer> signerList = iSignerImpl.findSignerList(signerSearch);

...

Expand

title	Más detalles

Signatura

Signer findSignerByNif(SignerSearch signerSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
signerSearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
signer	1241284867	Firmante cuyo nif coincida con el proporcionado en el parámetro de búsqueda

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_FINDSIGNERBYNIF	Error genérico durante el servicio findSignerByNif
GET_USER_INFORMATION_XX	Error durante la consulta de los datos en SIU (XX indica el código de error en SIU)

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

SignerSearch signerSearch = new SignerSearch();
signerSearch.setUserNif("78965412X");
Signer signer = iSignerImpl.findSignerByNif(signerSearch);

...

Expand

title	Más detalles

Signatura

ParamProposedSigner findProposedSigner(ParamProposedSignerSearch paramProposedSignerSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
paramProposedSignerSearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
proposedSigner	1241284867	Firmante propuesto encontrado según los criterios de búsqueda indicados

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_FINDPROPOSEDSIGNER	Error genérico durante el servicio findProposedSigner

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamProposedSignerSearch paramProposedSignerSearch = new ParamProposedSignerSearch();
paramProposedSignerSearch.setSignerNif("78965412X");
ParamProposedSigner proposedSigner = iSignerImpl.findProposedSigner(paramProposedSignerSearch);

...

Expand

title	Más detalles

Signatura

ParamProposedSignerList findProposedSignerList(ParamProposedSignerSearch paramProposedSignerSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
paramProposedSignerSearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
proposedSignerList	ParamProposedSignerList	Objeto que encapsula la lista de firmantes propuestos encontrados y el tamaño de dicha lista

Códigos error

Código	Descripción
SIGNERSERVICEIMPL_FINDPROPOSEDSIGNERLIST	SIGNERSERVICEIMPL_FINDPROPOSEDSIGNERLIST

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamProposedSignerSearch paramProposedSignerSearch = new ParamProposedSignerSearch();
paramProposedSignerSearch.setSignerNif("78965412X");
ParamProposedSignerList proposedSigner = iSignerImpl.findProposedSignerList(paramProposedSignerSearch);

...

Expand

title	Más detalles

Signatura

Document findDocument(DocumentSearch documentSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
documentSearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
document	1241284867	Documento encontrado según el criterio de búsqueda proporcionada

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENT_02	Error genérico durante el servicio findDocument

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setCsv("CSV6F70H2A66T1E01PFI");
Document document = iDocumentImpl.findDocument(documentSearch);

...

Expand

title	Más detalles

Signatura

List<Document> findDocumentList(DocumentSearch documentSearch)

Parámetros de invocación

Nombre	Tipo	Descripción
documentSearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
documentList	List<1241284867>	Lista de documentos encontrados según los parámetros de búsqueda indicados

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTLIST_01	Error genérico durante el servicio findDocumentList
DOCUMENTSERVICEIMPL_FINDDOCUMENTLIST_02	Error genérico durante el servicio findDocumentList

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setState(2);
List<Document> documentList = iDocumentImpl.findDocumentList(documentSearch);

...

Expand

title	Más detalles

Signatura

ResultTrayList findDocumentTray(ParamTraySearch paramTraySearch)

Parámetros de invocación

Nombre	Tipo	Descripción
paramTraySearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultTrayList	ResultTrayList	Lista de documentos para la bandeja que cumplen los criterios de búsqueda

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTTRAY	Error genérico durante el servicio findDocumentTray
FIND_DOCUMENT_LIST	Error al buscar los documentos en bbdd

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamTraySearch paramTraySearch = new ParamTraySearch();
paramTraySearch.setDraft(true);
ResultTrayList resultTrayList = iDocumentImpl.findDocumentTray(paramTraySearch);

...

Expand

title	Más detalles

Signatura

ResultTrayListVisibility findDocumentTrayVisibility(ParamTraySearch paramTraySearch)

Parámetros de invocación

Nombre	Tipo	Descripción
paramTraySearch	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultTrayListVisibility	ResultTrayListVisibility	Lista de documentos para la bandeja que cumplen los criterios de búsqueda con información de visibilidad

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTTRAY	Error genérico durante el servicio findDocumentTrayVisibility
PAUINTEGRATION_PROCEDURELISTBYUSER	Error en el sistema de autentificación. Se ha producido el siguiente error al buscar la lista de procedimientos del usuario desde PAU
FIND_DOCUMENT_LIST	Error al buscar los documentos en bbdd

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamTraySearch paramTraySearch = new ParamTraySearch();
paramTraySearch.setDraft(true);
ResultTrayListVisibility resultTrayListVisibility = iDocumentImpl.findDocumentTrayVisibility(paramTraySearch);

...

Expand

title	Más detalles

Signatura

List<ParamFolder> findDocumentFolderList(DocumentSearch document)

Parámetros de invocación

Nombre	Tipo	Descripción
document	1241284867	Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
paramFolder	List<ParamFolder>	Error inesperado al buscar los diferentes folder a los que pertenecen los documentos

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTFOLDERLIST	Error genérico durante el servicio findDocumentFolderList
NOT_EXIST_DOCUMENT

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

DocumentMetadataSearch documentMetadataSearch = new DocumentMetadataSearch();

...

Expand

title	Más detalles

Signatura

Integer getDocumentState(ParamGetDocumentState paramGetDocumentState)

Parámetros de invocación

Nombre	Tipo	Descripción
paramGetDocumentState	1241284867	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre

Tipo

Descripción

state

Integer

Numero de estado correspondiente en porta-firmas:

6 → En paralelo

4 → Anulado

3 → Firma Programada

2 → Firmado

1 → Pendiente de firma

0 → Borrador

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_GETDOCUMENTSTATE	Error genérico durante el servicio getDocumentState
FIND_DOCUMENT	Error inesperado al buscar un documento
DOCUMENTMANAGERIMPL_FINDDOCUMENT	Error buscando documento

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamGetDocumentState paramGetDocumentState = new ParamGetDocumentState();
paramGetDocumentState.setCsv("CSVP55RYQS7R9AF01PFI");
Integer documentState = IDocumentService.getDocumentState(paramGetDocumentState);

...

Expand

title	Más detalles

Signatura

ResultGetOperation getOperation(ParamGetOperation paramGetOperation)

Parámetros de invocación

Nombre	Tipo	Descripción
paramGetOperation	ParamGetOperation	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultGetOperation	ResultGetOperation	Objeto que encapsula el resultado de la operación

Códigos error

Código	Descripción
DOCUMENTSERVICEIMPL_GETOPERATION	Error genérico durante el servicio getOperation
SCDEINTEGRATION_GETSTATUS	Error al comprobar el estado de la operacion
LOAD_OPERATION	Error buscando operación. El usuario no tiene permisos para ver la operación
FIND_OPERATION	Error buscando operación

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamGetOperation paramGetOperation = new ParamGetOperation();
paramGetOperation.setDocumentId(1L);
ResultGetOperation resultGetOperation = IDocumentService.getOperation(paramGetOperation);

Método 'findDocumentListByExternalsigned'

Servicio que consulta los documentos, en estado firmado, tiene un usuario externo.

Expand

title	Más detalles

Signatura

ResultDocumentExternalInfo findDocumentListByExternalSigned(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignature)

Parámetros de invocación

ParamFindDocumentListByExternalWithoutSignature:

Nombre	Tipo	Obligatorio	Descripción
applicationId	String	Sí	Alias de la aplicación que realiza la consulta
userNif	String	No	NIF/NIE del usuario identificado que realiza la consulta
signerNif	String	Sí	NIF/NIE del usuario firmante
description	String	No	Descripción del documento
preparationDateFrom	Date	No. Altamente recomendable para evitar timeouts	Fecha de preparación desde
preparationDateTo	Date	No. Altamente recomendable para evitar timeouts	Fecha de preparación hasta. Si no se rellena, el valor por defecto será la fecha actual +1.
csv	String	No	CSV
fromIndex	Integer	No	Índice de comienzo para la paginación
toIndex	Integer	No	índice final para la paginación
sortColumn	String	No. Si no se rellena, se ordena por defecto por la fecha de preparación final más reciente	Columna por la cual se desea ordenar los documentos. Los valores que admite son los siguientes: signerNif description preparationDateEnd csv state
ascending	Boolean	No	Ordenar por la columna deseada de forma ascendente o descendente

Parámetros de respuesta

ResultDocumentExternalInfo:

Nombre	Tipo	Descripción
applicationId	String	Alias de la aplicación que ha realizado la consulta
userNif	String	NIF del usuario identificado
documents	List<DocumentInfo>	Lista de documentos paginada
size	int	Número total de documentos sin tener en cuenta la paginación

DocumentExternalInfo:

Nombre	Tipo	Descripción
csv	String	CSV del documento
description	String	Descripción del documento
procedureCode	String	Código de procedimiento
issuer	String	Nombre y apellidos del preparador
revised	boolean	Si el documento está revisado o no
state	int	Estado del documento IMPORTANTE: Además de los estados 1 (pendiente de firma) y 2 (firmado), se puede obtener el estado 6 (firma paralela). Este estado significa que el documento tiene varios firmantes y alguno de ellos ya ha firmado pero otros no y todavía no se cumple el total de firmas del documento (Quorum) Si se filtra por NIF firmante y estado 1 (pendiente de firma), al obtener el estado 6 en un documento significará que ese firmante no ha firmado pero alguno de los otros firmantes del documento sí. Si se filtra por NIF firmante y estado 2 (firmado), al obtener el estado 6 en un documento significará que ese firmante sí que ha firmado pero faltan por firmar el resto de firmantes del documento.
quorum	int	Mínimo de firmas requeridas para pasar a firmar un documento.
quorumOnly	String	Indica, en el caso de multifirma, si se admiten más firmas que las mínimas requeridas (quorum).
quorumOnly	int	Si el documento requiere de todas las firmas de los firmantes propuestos para pasar a estado firmado
signatures	int	Número de firmas realizadas
totalSignatures	int	Número de firmas totales
totalSignersNotRevised	int	total de firmantes no revisados
preparationDate	String	Fecha de inicio de preparación del documento
preparationDateEnd	String	Fecha fin de preparación del documento
signers	List<DocumentSignerData>	Listado de firmantes del documento con su nif, nombre y apellidos

DocumentSignerData:

Nombre	Tipo	Descripción
signerNif	String	NIF/NIE del firmante
signerName	String	Nombre y apellidos del firmante
signerRevised	boolean	Indica si el firmante está revisado

Códigos error

Código	Descripción
GENERIC_FINDDOCUMENTLISTBYEXTERNALSIGNED	Error genérico en el servicio findDocumentListByExternalSigned
FINDDOCUMENTLISTBYEXTERNALSIGNED_01	El nif del usuario firmante es obligatorio
FINDDOCUMENTLISTBYEXTERNALSIGNED_02	El formato del nif del usuario firmante no es correcto

Ejemplo de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalSigned = new ParamFindDocumentListByExternalWithoutSignature();
paramFindDocumentListByExternalSigned.setSignerNif("SIGNER_NIF");
IDocumentService.findDocumentListByExternalSigned(paramFindDocumentListByExternalSigned);

Método 'findDocumentListByExternalSignedCount'

Servicio que consulta los documentos, en estado firmado, de un usuario externo

Expand

title	Más detalles

Signatura

ResultDocumentExternalInfo findDocumentListByExternalSigned(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignature)

Parámetros de invocación

ParamFindDocumentListByExternalWithoutSignatureCount:

Nombre	Tipo	Obligatorio	Descripción
applicationId	String	Sí	Alias de la aplicación que realiza la consulta
userNif	String	No	NIF/NIE del usuario identificado que realiza la consulta
signerNif	String	No	NIF/NIE del usuario firmante
description	String	No	Descripción del documento
preparationDateFrom	Date	No. Altamente recomendable para evitar timeouts	Fecha de preparación desde
preparationDateTo	Date	No. Altamente recomendable para evitar timeouts	Fecha de preparación hasta. Si no se rellena, el valor por defecto será la fecha actual +1.
csv	String	No	CSV

Parámetros de respuesta

ResultFindDocumentListCount:

Nombre	Tipo	Descripción
errors	boolean	Indica si se han producido errores. true → Hay errores. Se informa del error y del mensaje del error false → No hay errores.
errorCode	String	Código del error producido
errorMsg	String	Descripción del error producido
documents	int	Número total de documentos que cumplen los criterios de búsqueda

Códigos error

Código	Descripción
GENERIC_FINDDOCUMENTLISTBYEXTERNALSIGNED	Error genérico en el servicio findDocumentListByExternalSignedCount
FINDDOCUMENTLISTBYEXTERNALSIGNED_01	El nif del usuario firmante es obligatorio
FINDDOCUMENTLISTBYEXTERNALSIGNED_02	El formato del nif del usuario firmante no es correcto

Ejemplo de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamFindDocumentListByExternalWithoutSignatureCount paramFindDocumentListByExternalSigned = new ParamFindDocumentListByExternalWithoutSignatureCount();
paramFindDocumentListByExternalSigned.setSignerNif("SIGNER_NIF");
IDocumentService.findDocumentListByExternalSignedCount(paramFindDocumentListByExternalSigned);

Método 'findDocumentListByExternalWithoutSignature'

Servicio que consulta los documentos, en estado pendiente de firma o firma en paralelo, tiene un usuario externo.

Expand

title	Más detalles

Signatura

ResultDocumentExternalInfo findDocumentListByExternalWithoutSignature(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignature)

Parámetros de invocación

ParamFindDocumentListByExternalWithoutSignature:

Nombre	Tipo	Obligatorio	Descripción
applicationId	String	Sí	Alias de la aplicación que realiza la consulta
userNif	String	No	NIF/NIE del usuario identificado que realiza la consulta
signerNif	String	Sí	NIF/NIE del usuario firmante
description	String	No	Descripción del documento
preparationDateFrom	Date	No. Altamente recomendable para evitar timeouts	Fecha de preparación desde
preparationDateTo	Date	No. Altamente recomendable para evitar timeouts	Fecha de preparación hasta. Si no se rellena, el valor por defecto será la fecha actual +1.
csv	String	No	CSV
fromIndex	Integer	No	Índice de comienzo para la paginación
toIndex	Integer	No	índice final para la paginación
sortColumn	String	No. Si no se rellena, se ordena por defecto por la fecha de preparación final más reciente	Columna por la cual se desea ordenar los documentos. Los valores que admite son los siguientes: signerNif description preparationDateEnd csv state
ascending	Boolean	No	Ordenar por la columna deseada de forma ascendente o descendente

Parámetros de respuesta

ResultDocumentExternalInfo:

Nombre	Tipo	Descripción
applicationId	String	Alias de la aplicación que ha realizado la consulta
userNif	String	NIF del usuario identificado
documents	List<DocumentInfo>	Lista de documentos paginada
size	int	Número total de documentos sin tener en cuenta la paginación

DocumentExternalInfo:

Nombre	Tipo	Descripción
csv	String	CSV del documento
description	String	Descripción del documento
procedureCode	String	Código de procedimiento
issuer	String	Nombre y apellidos del preparador
revised	boolean	Si el documento está revisado o no
state	int	Estado del documento IMPORTANTE: Además de los estados 1 (pendiente de firma) y 2 (firmado), se puede obtener el estado 6 (firma paralela). Este estado significa que el documento tiene varios firmantes y alguno de ellos ya ha firmado pero otros no y todavía no se cumple el total de firmas del documento (Quorum) Si se filtra por NIF firmante y estado 1 (pendiente de firma), al obtener el estado 6 en un documento significará que ese firmante no ha firmado pero alguno de los otros firmantes del documento sí. Si se filtra por NIF firmante y estado 2 (firmado), al obtener el estado 6 en un documento significará que ese firmante sí que ha firmado pero faltan por firmar el resto de firmantes del documento.
quorum	int	Mínimo de firmas requeridas para pasar a firmar un documento.
quorumOnly	String	Indica, en el caso de multifirma, si se admiten más firmas que las mínimas requeridas (quorum).
quorumOnly	int	Si el documento requiere de todas las firmas de los firmantes propuestos para pasar a estado firmado
signatures	int	Número de firmas realizadas
totalSignatures	int	Número de firmas totales
totalSignersNotRevised	int	total de firmantes no revisados
preparationDate	String	Fecha de inicio de preparación del documento
preparationDateEnd	String	Fecha fin de preparación del documento
signers	List<DocumentSignerData>	Listado de firmantes del documento con su nif, nombre y apellidos

DocumentSignerData:

Nombre	Tipo	Descripción
signerNif	String	NIF/NIE del firmante
signerName	String	Nombre y apellidos del firmante
signerRevised	boolean	Indica si el firmante está revisado

Códigos error

Código	Descripción
GENERIC_FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE	Error genérico en el servicio findDocumentListByExternalWithoutSignature
FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE_01	El nif del usuario firmante es obligatorio
FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE_02	El formato del nif del usuario firmante no es correcto

Ejemplo de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalSigned = new ParamFindDocumentListByExternalWithoutSignature();
paramFindDocumentListByExternalSigned.setSignerNif("SIGNER_NIF");
IDocumentService.findDocumentListByExternalWithoutSignature(paramFindDocumentListByExternalSigned);

Método 'findDocumentListByExternalWithoutSignatureCount'

Servicio que consulta los documentos, en estado pendiente de firma o firma en paralelo, de un usuario externo

Expand

title	Más detalles

Signatura

ResultDocumentExternalInfo findDocumentListByExternalWithoutSignatureCount(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignature)

Parámetros de invocación

ParamFindDocumentListByExternalWithoutSignatureCount:

Nombre	Tipo	Obligatorio	Descripción
applicationId	String	Sí	Alias de la aplicación que realiza la consulta
userNif	String	No	NIF/NIE del usuario identificado que realiza la consulta
signerNif	String	No	NIF/NIE del usuario firmante
description	String	No	Descripción del documento
preparationDateFrom	Date	No. Altamente recomendable para evitar timeouts	Fecha de preparación desde
preparationDateTo	Date	No. Altamente recomendable para evitar timeouts	Fecha de preparación hasta. Si no se rellena, el valor por defecto será la fecha actual +1.
csv	String	No	CSV

Parámetros de respuesta

ResultFindDocumentListCount:

Nombre	Tipo	Descripción
errors	boolean	Indica si se han producido errores. true → Hay errores. Se informa del error y del mensaje del error false → No hay errores.
errorCode	String	Código del error producido
errorMsg	String	Descripción del error producido
documents	int	Número total de documentos que cumplen los criterios de búsqueda

Códigos error

Código	Descripción
GENERIC_FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE	Error genérico en el servicio findDocumentListByExternalWithoutSignatureCount
FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE_01	El nif del usuario firmante es obligatorio
FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE_02	El formato del nif del usuario firmante no es correcto

Ejemplo de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamFindDocumentListByExternalWithoutSignatureCount paramFindDocumentListByExternalSigned = new ParamFindDocumentListByExternalWithoutSignatureCount();
paramFindDocumentListByExternalSigned.setSignerNif("SIGNER_NIF");
IDocumentService.findDocumentListByExternalSignedCount(paramFindDocumentListByExternalSigned);

Servicios DocumentIntegrationService

...

Expand

title	Más detalles

Signatura

ResultSendDocument sendDocumentumDocument(ParamSendDocument paramSendDocument)

Parámetros de invocación

Nombre	Tipo	Descripción
paramSendDocument	1241284867	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultSendDocument	1241284867	Objeto que encapsula el resultado de la operación, proporcionado información en caso de error

Códigos error

Código	Descripción
DOCUMENTINTEGRATIONMANAGERIMPL_SENDDOCUMENTUMDOCUMENT	Error inesperado al crear un documento en la tabla de PFI_DOCUMENT
DOCUMENTMANAGERIMPL_FINDDOCUMENT	Error inesperado al buscar un documento
LOAD_DOCUMENT	Error cargando documentos
SIUINTEGRATION_SENDPROPOSEDSIGNERS	Error en el sistema de identificación. El firmante propuesto debe estar dado de alta en el sistema de identificación de usuarios (SIU)

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamSendDocument paramSendDocument = new ParamSendDocument();
paramSendDocument.setCsv("CSVDA6FLBW3PNAX01PFI");
paramSendDocument.setApplicationId("PFI");
paramSendDocument.setUserNif("00000000T");
ResultSendDocument resultSendDocument = iDocumentIntegrationImpl.sendDocumentumDocument(paramSendDocument);

...

Expand

title	Más detalles

Signatura

ResultUpdateQuorumAndLimitDate updateQuorumAndLimitDateDocument (ParamUpdateQuorumAndLimitDate paramUpdateQuorumAndDate)

Parámetros de invocación

Nombre	Tipo	Descripción
paramUpdateQuorumAndDate	1241284867	Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

Nombre	Tipo	Descripción
resultUpdateQuorum	1241284867	Objeto que encapsula el resultado de la operación, proporcionado información en caso de error

Códigos error

Código	Descripción
QUORUMTASK_DOCUMENTNONEXISTING	El documento con el CSV especificado no existe en la base de datos de PFI
QUORUMTASK_QUORUMWRONG	El valor de quorum indicado es incorrecto. Debe ser mayor que 0 y menor o igual que el número de firmantes propuestos del documento
QUORUMTASK_DATEWRONG	La fecha límite de firma del documento ha expirado
QUORUMTASK_NOMULTIFIRMA	El documento no es multifirma
QUORUMTASK_SIGNED	El documento ya ha sido firmado por alguno de los firmantes

Ejemplos de invocación

Code Block

language	java
firstline	1
title	Ejemplo de invocación
linenumbers	true

ParamUpdateQuorumAndLimitDate paramUpdateQuorumAndDate = new ParamUpdateQuorumAndLimitDate();
paramUpdateQuorumAndDate.setCsv("CSVP55RYQS7R9AF01PFI");
paramUpdateQuorumAndDate.setQuorum(2);
//queremos de fecha límite por ejemplo el día de hoy más una semana
Calendar cal = Calendar.getInstance();
cal.setTime(new Date());
Integer incFecha = 7;
cal.add(Calendar.DATE, incFecha);
paramCheckQuorumAndDate.setDate(cal.getTime());
paramCheckQuorumAndDate.setQuorumOnly(false);

ResultUpdateQuorumAndLimitDate resultCheckQuorumAndDate = iDocumentIntegrationImpl.updateQuorumAndLimitDateDocument(paramUpdateQuorumAndDate);

...

sendEvent → Método que informa sobre los cambios de estado de los documentos de PFI. Para poder recibir estos eventos de cambios de estado, los documentos deben tener asignado el alias de la aplicación receptora en el metadato dea_ident_codigo_aplicacion. De lo contrario, no se recibirán los eventos. El evento se compone de clave y valor. La clave es el CSV del documento y el valor es el estado del documento. Los cambios de estado que se notifican son los siguientes:
- Estado 3 (Firmando asíncronamente) → Estado al que se pasan los documentos al inicio del proceso de firma para indicar que se está realizando la firma del documento.
- Estado 6 (Firma paralela) → Se alcanza este estado cuando un documento tiene varios firmantes propuestos y alguno de ellos ya ha firmado pero todavía no se cumple el quorum.
- Estado 2 (Firmado) → Documento firmado.
- Estado 0 (Borrador) → Se recibe este evento cuando se rechaza un documento pendiente de firma.
- Estado 9 (Anulado) → Se recibe este evento cuando se anula un documento.

...

Objeto
Anchor
ParamProposedSigner
ParamProposedSigner
'ParamProposedSigner'

Nombre	Tipo	Descripción
proposedSignerId	Long	Id del firmante propuesto
signerNif	String	Nif del firmante propuesto
signerName	String	Nombre del firmante propuesto
signerDateFrom	String	Fecha de selección del firmante
signerOrder	String	Orden de firma del firmante propuesto
signaturePosition	String	Tipo de posición de los pies de firma
position	String	Coordenadas donde se ha colocado el pie de firma del firmante propuesto
delegationText	String	Texto de delegación del firmante propuesto
signed	String	Indica si el firmante propuesto ha firmando (1) o no (0)
signerOrgCode	String	Código de organismo del firmante propuesto
signerOrganism	String	Nombre de organismo del firmante propuesto
signerRole	String	Cargo del firmante propuesto
signerStatus	String	Condición del firmante
revised	String	Indica si el firmate propuesto ha sido revisado o no. Valores: S o N
deleteSign	Boolean	Indica si se ha de borrar la firma al actualizar el firmante propuesto

...

Objeto
Anchor
ParamSendDocument
ParamSendDocument
'ParamSendDocument'

Nombre	Tipo	Descripción
applicationId	String	Aplicación que ejecuta el método
userNif	String	Nif del usuario
csv	String	Código seguro de verificación del documento

...

Version	Old Version 12	New Version 13
Changes made by	Servicios Digitales de Aragón	Servicios Digitales de Aragón
Saved on	18 Oct 2023	25 Jun 2024

Versions Compared

Key

Inicialización del cliente mediante CXF

Método 'findDocumentListByExternalsigned'

Método 'findDocumentListByExternalSignedCount'

Método 'findDocumentListByExternalWithoutSignature'

Método 'findDocumentListByExternalWithoutSignatureCount'

Servicios DocumentIntegrationService

Objeto
Anchor
ParamProposedSigner
ParamProposedSigner
'ParamProposedSigner'

Objeto
Anchor
ParamSendDocument
ParamSendDocument
'ParamSendDocument'

Content Comparison

Versions Compared

Key

Inicialización del cliente mediante CXF

Método 'findDocumentListByExternalsigned'

Método 'findDocumentListByExternalSignedCount'

Método 'findDocumentListByExternalWithoutSignature'

Método 'findDocumentListByExternalWithoutSignatureCount'

Servicios DocumentIntegrationService

Objeto AnchorParamProposedSignerParamProposedSigner'ParamProposedSigner'

Objeto AnchorParamSendDocumentParamSendDocument'ParamSendDocument'

Objeto
Anchor
ParamProposedSigner
ParamProposedSigner
'ParamProposedSigner'

Objeto
Anchor
ParamSendDocument
ParamSendDocument
'ParamSendDocument'