Versions Compared

Old Version 13

changes.mady.by.user Servicios Digitales de Aragón

Saved on

compared with

New Version Current

changes.mady.by.user Servicios Digitales de Aragón

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
languagexml
themeEclipse
titleIDocumentIntegrationService
<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
languagexml
themeEclipse
<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
languagexml
themeEclipse
<bean id="authorizeInterceptor" class="es.aragon.pfi.core.util.interceptors.AuthorizeOutInterceptor">
	<property name="applicationId" value="[código aplicación llamante]"/>
</bean>


...

Expand
titleMás detalles

Signatura

List<Signer> findQuickSignerList(SignerSearch signerSearch)

Parámetros de invocación

NombreTipoDescripción
signerSearch1241284867Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

NombreTipoDescripción
signerListList<1241284867>Lista de firmantes encontrados según los criterios de búsqueda indicados

Códigos error

CódigoDescripción
SIGNERSERVICEIMPL_FINDQUICKSIGNERLISTError genérico durante el servicio findQuickSignerList
ORGANISMLIST_XXError durante la consulta de los datos en SIU (XX indica el código de error en SIU)

Ejemplos de invocación

Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
SignerSearch signerSearch = new SignerSearch();
signerSearch.setSignerNif("25448659X");
List<Signer> signerList = iSignerImpl.findQuickSignerList(signerSearch);


Método '

...

findQuickSignerListWithAuditor'

Método que busca una lista de firmantes

...

titleMás detalles

Signatura

...

compuesta por -el usuario -su jefe -el jefe de su jefe -los cinco últimos firmantes en su histórico y los revisores de cada firmante.

Expand
titleMás detalles

Signatura

List<SignerWithAuditor> findQuickSignerListWithAuditor(SignerSearch signerSearch)

Parámetros de invocación

NombreTipoDescripción
signerSearch1241284867Manual de Integración PFI 4.7 - servicios para integradores#SignerSearchParámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

NombreTipoDescripción
signerListsignerAuditorListList<1241284867>
Lista de firmantes y auditores encontrados según los criterios de búsqueda indicados

Códigos error

Error durante la consulta de los datos en SIU (XX indica el código de error en SIU)
CódigoDescripción
SIGNERSERVICEIMPL_FINDSIGNERLISTError genérico durante el servicio findSignerList
GET_ORGANISM_HISTORICAL_INFORMATION_XXFIND_QUICKSIGNER_LIST_WITH_AUDITORError inesperado al buscar en la tabla de firmantes y/o auditores
PROPOSEDSIGNERMANAGER_FINDQUICKSIGNERLISTWITHAUDITORError genérico durante el servicio findQuickSignerList

Ejemplos de invocación

Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
SignerSearch signerSearch = new SignerSearch();
signerSearch.setOrganismCodesetApplicationId("ORG0001PFI");
List<Signer> signerListsignerSearch.setOrganismCode("ORG07458");
signerSearch.setSignerNif("00000000T");
			
			
List <SignerWithAuditor> listSignerAuditor = iSignerImplsignerServiceImpl.findSignerListfindQuickSignerListWithAuditor(signerSearch);


Método '

...

findSignerList'

Método que busca un firmante que busca una lista de firmantes atendiendo a unos parámetros de búsqueda establecidos en concreto se buscará el firmante que corresponde a un Nif

Expand
titleMás detalles

Signatura

Signer findSignerByNifList<Signer> findSignerList(SignerSearch signerSearch)

Parámetros de invocación

NombreTipoDescripción
signerSearch1241284867Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

NombreTipoDescripción
signersignerListList<1241284867Firmante cuyo nif coincida con el proporcionado en el parámetro de búsqueda>Lista de firmantes encontrados según los criterios de búsqueda indicados

Códigos error

CódigoDescripción
SIGNERSERVICEIMPL_FINDSIGNERBYNIFFINDSIGNERLISTError genérico durante el servicio findSignerByNiffindSignerList
GET_USERORGANISM_HISTORICAL_INFORMATION_XXError durante la consulta de los datos en SIU (XX indica el código de error en SIU)

Ejemplos de invocación

Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
SignerSearch signerSearch = new SignerSearch();
signerSearch.setUserNifsetOrganismCode("78965412XORG0001");
SignerList<Signer> signersignerList = iSignerImpl.findSignerByNiffindSignerList(signerSearch);


Método '

...

findSignerByNif'

Método que busca un firmante propuesto para un documento atendiendo a unos criterios parámetros de búsqueda establecidos en concreto se buscará el firmante que corresponde a un Nif

Expand
titleMás detalles

Signatura

ParamProposedSigner findProposedSigner(ParamProposedSignerSearch paramProposedSignerSearchSigner findSignerByNif(SignerSearch signerSearch)

Parámetros de invocación

NombreTipoDescripción
paramProposedSignerSearchsignerSearch1241284867Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

NombreTipoDescripción
proposedSignersigner1241284867Firmante propuesto encontrado según los criterios cuyo nif coincida con el proporcionado en el parámetro de búsqueda indicados

Códigos error

CódigoDescripción
SIGNERSERVICEIMPL_FINDPROPOSEDSIGNERFINDSIGNERBYNIFError genérico durante el servicio findProposedSignerfindSignerByNif
GET_USER_INFORMATION_XXError durante la consulta de los datos en SIU (XX indica el código de error en SIU)

Ejemplos de invocación

Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamProposedSignerSearchSignerSearch paramProposedSignerSearchsignerSearch = new ParamProposedSignerSearchSignerSearch();
paramProposedSignerSearchsignerSearch.setSignerNifsetUserNif("78965412X");
ParamProposedSignerSigner proposedSignersigner = iSignerImpl.findProposedSignerfindSignerByNif(paramProposedSignerSearchsignerSearch);


Método '

...

findProposedSigner'

Método que busca la lista de firmantes propuestos según los criterios establecidos en el parámetro de entradaun firmante propuesto para un documento atendiendo a unos criterios de búsqueda

Expand
titleMás detalles

Signatura

ParamProposedSignerList findProposedSignerListParamProposedSigner findProposedSigner(ParamProposedSignerSearch paramProposedSignerSearch)

Parámetros de invocación

NombreTipoDescripción
paramProposedSignerSearch1241284867Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)

Parámetros de respuesta

NombreTipoDescripción
proposedSignerListproposedSignerParamProposedSignerListObjeto que encapsula la lista de firmantes propuestos encontrados y el tamaño de dicha lista1241284867Firmante propuesto encontrado según los criterios de búsqueda indicados

Códigos error

CódigoDescripción
SIGNERSERVICEIMPL_FINDPROPOSEDSIGNERLISTSIGNERSERVICEIMPL_FINDPROPOSEDSIGNERLISTFINDPROPOSEDSIGNERError genérico durante el servicio findProposedSigner

Ejemplos de invocación

Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamProposedSignerSearch paramProposedSignerSearch = new ParamProposedSignerSearch();
paramProposedSignerSearch.setSignerNif("78965412X");
ParamProposedSignerListParamProposedSigner proposedSigner = iSignerImpl.findProposedSignerListfindProposedSigner(paramProposedSignerSearch);

...


Método '
...
findProposedSignerList'
Método que busca 
...
la lista de firmantes propuestos según los criterios 
...
 establecidos 
...
en el parámetro de entrada
 Expand
titleMás detalles
Signatura
Document findDocument(DocumentSearch documentSearchParamProposedSignerList findProposedSignerList(ParamProposedSignerSearch paramProposedSignerSearch)
Parámetros de invocación
NombreTipoDescripción
documentSearchparamProposedSignerSearch1241284867Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)
Parámetros de respuesta
NombreTipoDescripción
documentproposedSignerList1241284867Documento encontrado según el criterio de búsqueda proporcionadaParamProposedSignerListObjeto que encapsula la lista de firmantes propuestos encontrados y el tamaño de dicha lista
Códigos error
CódigoDescripción
DOCUMENTSERVICEIMPLSIGNERSERVICEIMPL_FINDDOCUMENTFINDPROPOSEDSIGNERLISTSIGNERSERVICEIMPL_02Error genérico durante el servicio findDocumentFINDPROPOSEDSIGNERLIST
Ejemplos de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
DocumentSearchParamProposedSignerSearch documentSearchparamProposedSignerSearch = new DocumentSearchParamProposedSignerSearch();
documentSearchparamProposedSignerSearch.setCsvsetSignerNif("CSV6F70H2A66T1E01PFI78965412X");
DocumentParamProposedSignerList documentproposedSigner = iDocumentImpliSignerImpl.findDocumentfindProposedSignerList(documentSearchparamProposedSignerSearch);


Servicios DocumentService
...
Método '
...
findDocument'
Método que busca una lista de documentos un documento utilizando los criterios de búsqueda establecidos como parámetro de entrada
 Expand
titleMás detalles
Signatura
List<Document> findDocumentListDocument findDocument(DocumentSearch documentSearch)
Parámetros de invocación
NombreTipoDescripción
documentSearch1241284867Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)
Parámetros de respuesta
NombreTipoDescripción
documentListdocumentList<1241284867>Lista de documentos encontrados según los parámetros de búsqueda indicadosDocumento encontrado según el criterio de búsqueda proporcionada
Códigos error
DOCUMENTSERVICEIMPL_FINDDOCUMENTLIST_ findDocumentList
CódigoDescripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTLIST_01Error genérico durante el servicio findDocumentListFINDDOCUMENT_02Error genérico durante el servicio findDocument
Ejemplos de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
DocumentSearch documentSearch = new DocumentSearch();
documentSearch.setStatesetCsv(2"CSV6F70H2A66T1E01PFI");
List<Document>Document documentListdocument = iDocumentImpl.findDocumentListfindDocument(documentSearch);


Método '
...
findDocumentList'
Método que permite la búsqueda de un listado de documentos para las bandejas a partir del objeto ParamTraySearchque busca una lista de documentos utilizando los criterios de búsqueda establecidos como parámetro de entrada
 Expand
titleMás detalles
Signatura
ResultTrayList findDocumentTray(ParamTraySearch paramTraySearchList<Document> findDocumentList(DocumentSearch documentSearch)
Parámetros de invocación
NombreTipoDescripción
paramTraySearchdocumentSearch1241284867Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)
Parámetros de respuesta
NombreTipoDescripción
resultTrayListdocumentListResultTrayListList<1241284867>Lista de documentos para la bandeja que cumplen los criterios encontrados según los parámetros de búsqueda indicados
Códigos error
CódigoDescripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTLIST_FINDDOCUMENTTRAY01Error genérico durante el servicio findDocumentTrayfindDocumentList
FINDDOCUMENTSERVICEIMPL_DOCUMENTFINDDOCUMENTLIST_LIST02Error al buscar los documentos en bbddgenérico durante el servicio findDocumentList
Ejemplos de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamTraySearchDocumentSearch paramTraySearchdocumentSearch = new ParamTraySearchDocumentSearch();
paramTraySearchdocumentSearch.setDraftsetState(true2);
ResultTrayListList<Document> resultTrayListdocumentList = iDocumentImpl.findDocumentTrayfindDocumentList(paramTraySearchdocumentSearch);


Método '
...
findDocumentTray'
Método que permite la búsqueda de un listado de documentos para las bandejas a partir del objeto ParamTraySearch incluyendo información de visibilidad
 Expand
titleMás detalles
Signatura
ResultTrayListVisibility findDocumentTrayVisibilityResultTrayList findDocumentTray(ParamTraySearch paramTraySearch)
Parámetros de invocación
NombreTipoDescripción
paramTraySearch1241284867Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)
Parámetros de respuesta
NombreTipoDescripción
resultTrayListVisibilityresultTrayListResultTrayListVisibilityResultTrayListLista de documentos para la bandeja que cumplen los criterios de búsqueda con información de visibilidad
Códigos error
Error en el sistema de autentificación. Se ha producido el siguiente error al buscar la lista de procedimientos del usuario desde PAU
CódigoDescripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTTRAYError genérico durante el servicio findDocumentTrayVisibilityPAUINTEGRATION_PROCEDURELISTBYUSERfindDocumentTray
FIND_DOCUMENT_LISTError al buscar los documentos en bbdd
Ejemplos de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamTraySearch paramTraySearch = new ParamTraySearch();
paramTraySearch.setDraft(true);
ResultTrayListVisibilityResultTrayList resultTrayListVisibilityresultTrayList = iDocumentImpl.findDocumentTrayVisibilityfindDocumentTray(paramTraySearch);


Método '
...
findDocumentTrayVisibility'
Método que busca que permite la búsqueda de un listado de bloques o carpetas documentos para las bandejas a partir del objeto de búsqueda del documentoParamTraySearch incluyendo información de visibilidad
 Expand
titleMás detalles
Signatura
List<ParamFolder> findDocumentFolderList(DocumentSearch documentResultTrayListVisibility findDocumentTrayVisibility(ParamTraySearch paramTraySearch)
Parámetros de invocación
NombreTipoDescripción
documentparamTraySearch1241284867Parámetros de búsqueda (ver detalle de campos en el apartado de objetos comunes)
Parámetros de respuesta
NombreTipoDescripción
paramFolderresultTrayListVisibilityList<ParamFolder>Error inesperado al buscar los diferentes folder a los que pertenecen los documentosResultTrayListVisibilityLista de documentos para la bandeja que cumplen los criterios de búsqueda con información de visibilidad
Códigos error
CódigoDescripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTFOLDERLISTFINDDOCUMENTTRAYError genérico durante el servicio findDocumentFolderListfindDocumentTrayVisibilityNOT_EXIST_DOCUMENT
PAUINTEGRATION_PROCEDURELISTBYUSERError en el sistema de autentificación. Se ha producido el siguiente error al buscar la lista de procedimientos del usuario desde PAU
FIND_DOCUMENT_LISTError al buscar los documentos en bbdd
Ejemplos de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
DocumentMetadataSearchParamTraySearch documentMetadataSearchparamTraySearch = new DocumentMetadataSearchParamTraySearch();
paramTraySearch.setDraft(true);
ResultTrayListVisibility resultTrayListVisibility = iDocumentImpl.findDocumentTrayVisibility(paramTraySearch);


Método '
...
findDocumentFolderList'
Método para obtener el estado del documentoque busca un listado de bloques o carpetas a partir del objeto de búsqueda del documento
 Expand
titleMás detalles
Signatura
Integer getDocumentState(ParamGetDocumentState paramGetDocumentStateList<ParamFolder> findDocumentFolderList(DocumentSearch document)
Parámetros de invocación
NombreTipoDescripción
paramGetDocumentStatedocument1241284867Parámetros de entrada búsqueda (ver detalle de campos en el apartado de objetos comunes)
Parámetros de respuesta
NombreTipoDescripción
stateparamFolderInteger
Numero de estado correspondiente en porta-firmas:
6 →  En paralelo
4 →  Anulado
3 →  Firma Programada
2 →  Firmado
1 →  Pendiente de firma
0 → Borrador
List<ParamFolder>Error inesperado al buscar los diferentes folder a los que pertenecen los documentos
Códigos error
GETDOCUMENTSTATE getDocumentState
CódigoDescripción
DOCUMENTSERVICEIMPL_FINDDOCUMENTFOLDERLISTError genérico durante el servicio findDocumentFolderList
FINDNOT_EXIST_DOCUMENTError inesperado al buscar un documento
DOCUMENTMANAGERIMPL_FINDDOCUMENTError buscando documento

Ejemplos de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamGetDocumentStateDocumentMetadataSearch paramGetDocumentStatedocumentMetadataSearch = new ParamGetDocumentStateDocumentMetadataSearch();
paramGetDocumentState.setCsv("CSVP55RYQS7R9AF01PFI");
Integer documentState = IDocumentService.getDocumentState(paramGetDocumentState);





Método '
...
getDocumentState'
Método para obtener la operación asociada al el estado del documento
 Expand
titleMás detalles
Signatura
ResultGetOperation getOperation(ParamGetOperation paramGetOperationInteger getDocumentState(ParamGetDocumentState paramGetDocumentState)
Parámetros de invocación
NombreTipoDescripción
paramGetOperationparamGetDocumentStateParamGetOperation1241284867Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)
Parámetros de respuesta
Objeto que encapsula el resultado de la operación
NombreTipoDescripciónresultGetOperationResultGetOperation
stateInteger
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ódigoDescripción
DOCUMENTSERVICEIMPL_GETOPERATIONGETDOCUMENTSTATE
Error genérico durante el servicio getOperationgetDocumentState
SCDEINTEGRATIONFIND_GETSTATUSDOCUMENTError al comprobar el estado de la operacion
LOAD_OPERATIONError buscando operación. El usuario no tiene permisos para ver la operación
FIND_OPERATIONError buscando operación
inesperado al buscar un documento
DOCUMENTMANAGERIMPL_FINDDOCUMENTError buscando documento
Ejemplos de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamGetOperationParamGetDocumentState paramGetOperationparamGetDocumentState = new ParamGetOperationParamGetDocumentState();
paramGetOperationparamGetDocumentState.setDocumentIdsetCsv(1L"CSVP55RYQS7R9AF01PFI");
ResultGetOperationInteger resultGetOperationdocumentState = IDocumentService.getOperationgetDocumentState(paramGetOperationparamGetDocumentState);


Método '
...
getOperation'
Método para obtener la operación asociada al documento
 Expand
titleMás detalles
Signatura
ResultDocumentExternalInfo findDocumentListByExternalSigned(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignatureResultGetOperation getOperation(ParamGetOperation paramGetOperation)
Parámetros de invocación
ParamFindDocumentListByExternalWithoutSignature:
NombreTipoObligatorioDescripción
applicationIdparamGetOperationStringSíAlias de la aplicación que realiza la consulta
userNifStringNoNIF/NIE del usuario identificado que realiza la consulta
signerNifStringSíNIF/NIE del usuario firmante
descriptionStringNoDescripción del documento
preparationDateFromDateNo. Altamente recomendable para evitar timeoutsFecha de preparación desde
preparationDateToDateNo. Altamente recomendable para evitar timeoutsFecha de preparación hasta. Si no se rellena, el valor por defecto será la fecha actual +1.
csvStringNoCSV
fromIndexIntegerNoÍndice de comienzo para la paginación
toIndexIntegerNoíndice final para la paginación
sortColumnStringNo. 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
ascendingBooleanNoOrdenar por la columna deseada de forma ascendente o descendente
Parámetros de respuesta
ResultDocumentExternalInfo:
NombreTipoDescripción
applicationIdStringAlias de la aplicación que ha realizado ParamGetOperationParámetros de entrada (ver detalle de campos en el apartado de objetos comunes)
Parámetros de respuesta
NombreTipoDescripción
resultGetOperationResultGetOperation
Objeto que encapsula el resultado de la operación
Códigos error
CódigoDescripción
DOCUMENTSERVICEIMPL_GETOPERATION
Error genérico durante el servicio getOperation
SCDEINTEGRATION_GETSTATUSError al comprobar el estado de la operacion
LOAD_OPERATIONError buscando operación. El usuario no tiene permisos para ver la operación
FIND_OPERATIONError buscando operación
Ejemplos de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
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.
Códigos error
Ejemplo de invocación
 Expand
titleMás detalles
Signatura
ResultDocumentExternalInfo findDocumentListByExternalSigned(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignature)
Parámetros de invocación
ParamFindDocumentListByExternalWithoutSignature:
NombreTipoObligatorioDescripción
applicationIdStringSíAlias de la aplicación que realiza la consulta
userNifStringNoNIF/NIE del usuario identificado 
documentsList<DocumentInfo>Lista de documentos paginada
sizeintNúmero total de documentos sin tener en cuenta la paginación
DocumentExternalInfo:
CSV del documento
NombreTipoDescripción
csvStringque realiza la consulta
signerNifStringSíNIF/NIE del usuario firmante
descriptionStringNoDescripción del documento
preparationDateFrom
procedureCodeStringCódigo de procedimiento
issuerStringNombre y apellidos del preparador
revisedbooleanSi el documento está revisado o no
stateint
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.
quorumintMínimo de firmas requeridas para pasar a firmar un documento.
quorumOnlyStringIndica, en el caso de multifirma, si se admiten más firmas que las mínimas requeridas (quorum).
quorumOnlyintSi el documento requiere de todas las firmas de los firmantes propuestos para pasar a estado firmado
signaturesintNúmero de firmas realizadas
totalSignaturesintNúmero de firmas totales
totalSignersNotRevisedinttotal de firmantes no revisados
preparationDateStringFecha de inicio de preparación del documento
preparationDateEndStringFecha fin de preparación del documento
signersList<DocumentSignerData>Listado de firmantes del documento con su nif, nombre y apellidos
DocumentSignerData:
NombreTipoDescripción
signerNifStringNIF/NIE del firmante
signerNameStringNombre y apellidos del firmante
signerRevisedbooleanIndica si el firmante está revisado
CódigoDescripción
GENERIC_FINDDOCUMENTLISTBYEXTERNALSIGNED
Error genérico en el servicio findDocumentListByExternalSigned
FINDDOCUMENTLISTBYEXTERNALSIGNED_01El nif del usuario firmante es obligatorio
FINDDOCUMENTLISTBYEXTERNALSIGNED_02El formato del nif del usuario firmante no es correcto
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
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
Parámetros de respuesta
ResultFindDocumentListCount
 Expand
titleMás detalles
Signatura
ResultDocumentExternalInfo findDocumentListByExternalSigned(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignature)
Parámetros de invocación
ParamFindDocumentListByExternalWithoutSignatureCount:
NombreTipoObligatorioDescripción
applicationIdStringSíAlias de la aplicación que realiza la consulta
userNifStringNoNIF/NIE del usuario identificado que realiza la consulta
signerNifStringNoNIF/NIE del usuario firmante
descriptionStringNoDescripción del documento
preparationDateFromDateNo. Altamente recomendable para evitar timeoutsFecha de preparación desde
preparationDateToDateNo. Altamente recomendable para evitar timeoutsFecha de preparación hasta. Si no se rellena, el valor por defecto será la fecha actual +1.
csvStringNoCSV
DateNo. Altamente recomendable para evitar timeoutsFecha de preparación desde
preparationDateToDateNo. Altamente recomendable para evitar timeoutsFecha de preparación hasta. Si no se rellena, el valor por defecto será la fecha actual +1.
csvStringNoCSV
fromIndexIntegerNoÍndice de comienzo para la paginación
toIndexIntegerNoíndice final para la paginación
sortColumnStringNo. 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
ascendingBooleanNoOrdenar por la columna deseada de forma ascendente o descendente
Parámetros de respuesta
ResultDocumentExternalInfo:
NombreTipoDescripción
applicationIdString
Alias de la aplicación que ha realizado la consulta
userNifStringNIF del usuario identificado
documentsList<DocumentInfo>Lista de documentos paginada
sizeintNúmero total de documentos sin tener en cuenta la paginación
DocumentExternalInfo:
NombreTipoDescripción
csvString
CSV del documento
descriptionStringDescripción del documento
procedureCodeStringCódigo de procedimiento
issuerStringNombre y apellidos del preparador
revisedbooleanSi el documento está revisado o no
stateint
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.
quorumintMínimo de firmas requeridas para pasar a firmar un documento.
quorumOnlyStringIndica, en el caso de multifirma, si se admiten más firmas que las mínimas requeridas (quorum).
quorumOnlyintSi el documento requiere de todas las firmas de los firmantes propuestos para pasar a estado firmado
signaturesintNúmero de firmas realizadas
totalSignaturesintNúmero de firmas totales
totalSignersNotRevisedinttotal de firmantes no revisados
preparationDateStringFecha de inicio de preparación del documento
preparationDateEndStringFecha fin de preparación del documento
signersList<DocumentSignerData>Listado de firmantes del documento con su nif, nombre y apellidos

DocumentSignerData:
NombreTipoDescripción
errorsCódigoDescripción
signerNif
boolean
Indica si se han producido errores. 
  • true → Hay errores. Se informa del error y del mensaje del error
  • false → No hay errores.
errorCodeStringCódigo del error producidoerrorMsgStringDescripción del error producidodocumentsintNúmero total de documentos que cumplen los criterios de búsqueda
Códigos error
StringNIF/NIE del firmante
signerNameStringNombre y apellidos del firmante
signerRevisedbooleanIndica si el firmante está revisado

Códigos error
CódigoDescripción
GENERIC_FINDDOCUMENTLISTBYEXTERNALSIGNED
Error genérico en el servicio findDocumentListByExternalSignedCountfindDocumentListByExternalSigned
FINDDOCUMENTLISTBYEXTERNALSIGNED_01El nif del usuario firmante es obligatorio
FINDDOCUMENTLISTBYEXTERNALSIGNED_02El formato del nif del usuario firmante no es correcto

Ejemplo de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamFindDocumentListByExternalWithoutSignatureCountParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalSigned = new ParamFindDocumentListByExternalWithoutSignatureCountParamFindDocumentListByExternalWithoutSignature();
paramFindDocumentListByExternalSigned.setSignerNif("SIGNER_NIF");
IDocumentService.findDocumentListByExternalSignedCountfindDocumentListByExternalSigned(paramFindDocumentListByExternalSigned);


Método '
...
findDocumentListByExternalSignedCount'
Servicio que consulta los documentos, en estado pendiente de firma o firma en paralelo, tiene firmado,  de un usuario externo.
DocumentExternalInfo:

DocumentSignerData
Parámetros de respuesta
ResultFindDocumentListCount:
 Expand
titleMás detalles
Signatura
ResultDocumentExternalInfo findDocumentListByExternalWithoutSignaturefindDocumentListByExternalSigned(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignature)
Parámetros de invocación
ParamFindDocumentListByExternalWithoutSignatureParamFindDocumentListByExternalWithoutSignatureCount:
NombreTipoObligatorioDescripción
applicationIdStringSíAlias de la aplicación que realiza la consulta
userNifStringNoNIF/NIE del usuario identificado que realiza la consulta
signerNifStringSíNoNIF/NIE del usuario firmante
descriptionStringNoDescripción del documento
preparationDateFromDateNo. Altamente recomendable para evitar timeoutsFecha de preparación desde
preparationDateToDateNo. Altamente recomendable para evitar timeoutsFecha de preparación hasta. Si no se rellena, el valor por defecto será la fecha actual +1.
csvStringNoCSV
fromIndexIntegerNoÍndice de comienzo para la paginación
toIndexIntegerNoíndice final para la paginación
sortColumnStringNo. 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
ascendingBooleanNoOrdenar por la columna deseada de forma ascendente o descendente
Parámetros de respuesta
ResultDocumentExternalInfo:
NombreTipoDescripción
applicationIdString
Alias de la aplicación que ha realizado la consulta
userNifStringNIF del usuario identificado
documentsList<DocumentInfo>Lista de documentos paginada
sizeintNúmero total de documentos sin tener en cuenta la paginación
NombreTipoDescripción
csvString
CSV del documento
descriptionStringDescripción del documento
procedureCodeStringCódigo de procedimiento
issuerStringNombre y apellidos del preparador
revisedbooleanSi el documento está revisado o no
stateint
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.
quorumintMínimo de firmas requeridas para pasar a firmar un documento.
quorumOnlyStringIndica, en el caso de multifirma, si se admiten más firmas que las mínimas requeridas (quorum).
quorumOnlyintSi el documento requiere de todas las firmas de los firmantes propuestos para pasar a estado firmado
signaturesintNúmero de firmas realizadas
totalSignaturesintNúmero de firmas totales
totalSignersNotRevisedinttotal de firmantes no revisados
preparationDateStringFecha de inicio de preparación del documento
preparationDateEndStringFecha fin de preparación del documento
signersList<DocumentSignerData>Listado de firmantes del documento con su nif, nombre y apellidos
NombreTipoDescripción
errorsboolean
Indica si se han producido errores. 
  • true → Hay errores. Se informa del error y del mensaje del error
  • false → No hay errores.
errorCodeStringCódigo del error producido
errorMsgStringDescripción del error producido
documentsintNúmero total de documentos que cumplen los criterios de búsqueda

Códigos error
CódigoDescripción
GENERIC_FINDDOCUMENTLISTBYEXTERNALSIGNED
Error genérico en el servicio findDocumentListByExternalSignedCount
FINDDOCUMENTLISTBYEXTERNALSIGNED_01El nif del usuario firmante es obligatorio
FINDDOCUMENTLISTBYEXTERNALSIGNED_02El formato del nif del usuario firmante no es correcto

Ejemplo de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
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.
signerName
 Expand
titleMás detalles
Signatura
ResultDocumentExternalInfo findDocumentListByExternalWithoutSignature(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignature)
Parámetros de invocación
ParamFindDocumentListByExternalWithoutSignature:
NombreTipoObligatorioDescripción
applicationIdStringSíAlias de la aplicación que realiza la consulta
userNifStringNoNIF/NIE del usuario identificado que realiza la consulta
signerNifStringSíNIF/NIE del usuario firmante
descriptionStringNoDescripción del documento
preparationDateFromDateNo. Altamente recomendable para evitar timeoutsFecha de preparación desde
preparationDateToDateNo. Altamente recomendable para evitar timeoutsFecha de preparación hasta. Si no se rellena, el valor por defecto será la fecha actual +1.
csvStringNoCSV
fromIndexIntegerNoÍndice de comienzo para la paginación
toIndexIntegerNoíndice final para la paginación
sortColumnStringNo. 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
ascendingBooleanNoOrdenar por la columna deseada de forma ascendente o descendente
Parámetros de respuesta
ResultDocumentExternalInfo:
NombreTipoDescripción
signerNif
applicationIdString
NIF/NIE del firmante
Alias de la aplicación que ha realizado la consulta
userNifString
Nombre y apellidos del firmantesignerRevisedbooleanIndica si el firmante está revisado
Códigos error
CódigoDescripción
GENERIC_FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE
Error genérico en el servicio findDocumentListByExternalWithoutSignatureFINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE_01El nif del usuario firmante es obligatorioFINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE_02El formato del nif del usuario firmante no es correcto
Ejemplo de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
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
...
titleMás detalles
Signatura
ResultDocumentExternalInfo findDocumentListByExternalWithoutSignatureCount(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignature)
Parámetros de invocación
ParamFindDocumentListByExternalWithoutSignatureCount:
...
Parámetros de respuesta
ResultFindDocumentListCount:
...
Indica si se han producido errores. 
...
Códigos error
...
GENERIC_FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE
...
Ejemplo de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamFindDocumentListByExternalWithoutSignatureCount paramFindDocumentListByExternalSigned = new ParamFindDocumentListByExternalWithoutSignatureCount();
paramFindDocumentListByExternalSigned.setSignerNif("SIGNER_NIF");
IDocumentService.findDocumentListByExternalSignedCount(paramFindDocumentListByExternalSigned);

Servicios DocumentIntegrationService
Método 'sendDocumentumDocument'
Cuando una aplicación que integra Porta-firmas almacena un documento en Documentum y desea que quede guardado en Porta-firmas, invoca este servicio para que posteriormente Porta-firmas pueda hacer uso de dicho documento. 
...
titleMás detalles
Signatura
ResultSendDocument sendDocumentumDocument(ParamSendDocument paramSendDocument)
Parámetros de invocación
...
Parámetros de respuesta
...
Objeto que encapsula el resultado de la operación, proporcionado información en caso de error
Códigos error
...
DOCUMENTINTEGRATIONMANAGERIMPL_SENDDOCUMENTUMDOCUMENT
...
SIUINTEGRATION_SENDPROPOSEDSIGNERS
...
Ejemplos de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamSendDocument paramSendDocument = new ParamSendDocument();
paramSendDocument.setCsv("CSVDA6FLBW3PNAX01PFI");
paramSendDocument.setApplicationId("PFI");
paramSendDocument.setUserNif("00000000T");
ResultSendDocument resultSendDocument = iDocumentIntegrationImpl.sendDocumentumDocument(paramSendDocument);

Método 'updateQuorumAndLimitDateDocument'
Método que actualiza el número mínimo de firmantes que deben firmar un documento y fecha límite de firma en los documentos con más de un firmante
Parámetros de respuesta
Códigos error
Ejemplos de 
 Expand
titleMás detalles
Signatura
ResultUpdateQuorumAndLimitDate updateQuorumAndLimitDateDocument (ParamUpdateQuorumAndLimitDate paramUpdateQuorumAndDate)
Parámetros de invocación
NombreTipoDescripción
paramUpdateQuorumAndDate1241284867Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)
NombreTipoDescripción
resultUpdateQuorum1241284867
Objeto que encapsula el resultado de la operación, proporcionado información en caso de error
CódigoDescripción
QUORUMTASK_DOCUMENTNONEXISTING
El documento con el CSV especificado no existe en la base de datos de PFI
QUORUMTASK_QUORUMWRONGEl 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_DATEWRONGLa fecha límite de firma del documento ha expirado
QUORUMTASK_NOMULTIFIRMAEl documento no es multifirma
QUORUMTASK_SIGNEDEl documento ya ha sido firmado por alguno de los firmantes
NIF del usuario identificado
documentsList<DocumentInfo>Lista de documentos paginada
sizeintNúmero total de documentos sin tener en cuenta la paginación
DocumentExternalInfo:
NombreTipoDescripción
csvString
CSV del documento
descriptionStringDescripción del documento
procedureCodeStringCódigo de procedimiento
issuerStringNombre y apellidos del preparador
revisedbooleanSi el documento está revisado o no
stateint
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.
quorumintMínimo de firmas requeridas para pasar a firmar un documento.
quorumOnlyStringIndica, en el caso de multifirma, si se admiten más firmas que las mínimas requeridas (quorum).
quorumOnlyintSi el documento requiere de todas las firmas de los firmantes propuestos para pasar a estado firmado
signaturesintNúmero de firmas realizadas
totalSignaturesintNúmero de firmas totales
totalSignersNotRevisedinttotal de firmantes no revisados
preparationDateStringFecha de inicio de preparación del documento
preparationDateEndStringFecha fin de preparación del documento
signersList<DocumentSignerData>Listado de firmantes del documento con su nif, nombre y apellidos

DocumentSignerData:
NombreTipoDescripción
signerNifStringNIF/NIE del firmante
signerNameStringNombre y apellidos del firmante
signerRevisedbooleanIndica si el firmante está revisado

Códigos error
CódigoDescripción
GENERIC_FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE
Error genérico en el servicio findDocumentListByExternalWithoutSignature
FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE_01El nif del usuario firmante es obligatorio
FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE_02El formato del nif del usuario firmante no es correcto

Ejemplo de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
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
titleMás detalles
Signatura
ResultDocumentExternalInfo findDocumentListByExternalWithoutSignatureCount(ParamFindDocumentListByExternalWithoutSignature paramFindDocumentListByExternalWithoutSignature)
Parámetros de invocación
ParamFindDocumentListByExternalWithoutSignatureCount:
NombreTipoObligatorioDescripción
applicationIdStringSíAlias de la aplicación que realiza la consulta
userNifStringNoNIF/NIE del usuario identificado que realiza la consulta
signerNifStringNoNIF/NIE del usuario firmante
descriptionStringNoDescripción del documento
preparationDateFromDateNo. Altamente recomendable para evitar timeoutsFecha de preparación desde
preparationDateToDateNo. Altamente recomendable para evitar timeoutsFecha de preparación hasta. Si no se rellena, el valor por defecto será la fecha actual +1.
csvStringNoCSV

Parámetros de respuesta
ResultFindDocumentListCount:
NombreTipoDescripción
errorsboolean
Indica si se han producido errores. 
  • true → Hay errores. Se informa del error y del mensaje del error
  • false → No hay errores.
errorCodeStringCódigo del error producido
errorMsgStringDescripción del error producido
documentsintNúmero total de documentos que cumplen los criterios de búsqueda

Códigos error
CódigoDescripción
GENERIC_FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE
Error genérico en el servicio findDocumentListByExternalWithoutSignatureCount
FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE_01El nif del usuario firmante es obligatorio
FINDDOCUMENTLISTBYEXTERNALWITHOUTSIGNATURE_02El formato del nif del usuario firmante no es correcto

Ejemplo de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamUpdateQuorumAndLimitDateParamFindDocumentListByExternalWithoutSignatureCount paramUpdateQuorumAndDateparamFindDocumentListByExternalSigned = new ParamUpdateQuorumAndLimitDateParamFindDocumentListByExternalWithoutSignatureCount();
paramUpdateQuorumAndDateparamFindDocumentListByExternalSigned.setCsvsetSignerNif("CSVP55RYQS7R9AF01PFISIGNER_NIF");
paramUpdateQuorumAndDateIDocumentService.setQuorumfindDocumentListByExternalSignedCount(2paramFindDocumentListByExternalSigned);
//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);


Servicios DocumentIntegrationService
...
Método 'sendDocumentumDocument'
Cuando una aplicación que integra Porta-firmas almacena un documento en Documentum y desea que quede guardado en Porta-firmas, invoca este servicio para que posteriormente Porta-firmas pueda hacer uso de dicho documento. 
 Expand
titleMás detalles
Signatura
ResultSendDocument sendDocumentumDocument(ParamSendDocument paramSendDocument)
Parámetros de invocación
NombreTipoDescripción
paramSendDocument1241284867Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)
Parámetros de respuesta
NombreTipoDescripción
resultSendDocument1241284867
Objeto que encapsula el resultado de la operación, proporcionado información en caso de error
Códigos error
CódigoDescripción
DOCUMENTINTEGRATIONMANAGERIMPL_SENDDOCUMENTUMDOCUMENT
Error inesperado al crear un documento en la tabla de PFI_DOCUMENT
DOCUMENTMANAGERIMPL_FINDDOCUMENTError inesperado al buscar un documento
LOAD_DOCUMENTError 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
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
ParamSendDocument paramSendDocument = new ParamSendDocument();
paramSendDocument.setCsv("CSVDA6FLBW3PNAX01PFI");
paramSendDocument.setApplicationId("PFI");
paramSendDocument.setUserNif("00000000T");
ResultSendDocument resultSendDocument = iDocumentIntegrationImpl.sendDocumentumDocument(paramSendDocument);


Método 'updateQuorumAndLimitDateDocument'
Método que actualiza el número mínimo de firmantes que deben firmar un documento y fecha límite de firma en los documentos con más de un firmante
 Expand
titleMás detalles
Signatura
ResultUpdateQuorumAndLimitDate updateQuorumAndLimitDateDocument (ParamUpdateQuorumAndLimitDate paramUpdateQuorumAndDate)
Parámetros de invocación
NombreTipoDescripción
paramUpdateQuorumAndDate1241284867Parámetros de entrada (ver detalle de campos en el apartado de objetos comunes)
Parámetros de respuesta
NombreTipoDescripción
resultUpdateQuorum1241284867
Objeto que encapsula el resultado de la operación, proporcionado información en caso de error
Códigos error
CódigoDescripción
QUORUMTASK_DOCUMENTNONEXISTING
El documento con el CSV especificado no existe en la base de datos de PFI
QUORUMTASK_QUORUMWRONGEl 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_DATEWRONGLa fecha límite de firma del documento ha expirado
QUORUMTASK_NOMULTIFIRMAEl documento no es multifirma
QUORUMTASK_SIGNEDEl documento ya ha sido firmado por alguno de los firmantes
Ejemplos de invocación
 Code Block
languagejava
firstline1
titleEjemplo de invocación
linenumberstrue
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);


Servicios ExternalUserService 
...
Método 'findEntityExternalUserByName'
Método que obtiene la entidad externa filtrando por su descripción
 Expand
titleMás detalles
Signatura
ParamEntityExternalUser findEntityExternalUserByName(ParamEntityExternalUser paramSearchEntityExternalUser)
Parámetros de invocación
NombreTipoDescripción
entityNameStringDescripción de la entidad
Parámetros de respuesta
NombreTipoDescripción
entityExternalUserIdLong
Identificador 
entityNameStringDescripción de la entidad
Códigos error
CódigoDescripción
DOCUMENT_SERVICE_GENERIC_ERROR
Error genérico durante el servicio
EXTERNALUSER_NOUSERSEARCHError parámetros de entrada nulos
EXTERNALUSER_NOUSERRESULTError no se obtiene entidad en función de los parámetros de entrada introducidos

Método 'findExternalUserByNif'
Método que obtiene un usuario externo a partir del NIF
 Expand
titleMás detalles
Signatura
ParamExternalUser findExternalUserByNif(ParamSearchExternalUser paramSearchExternalUser)
Parámetros de invocación
NombreTipoDescripción
nifStringNIF
Parámetros de respuesta
NombreTipoDescripción
externalUserIdlongIdentificador
emailStringCorreo electrónico
autonomousBooleanIndica si es autonomo
nameStringNombre
nifStringNIF
entityPositionStringCargo
surname1StringPrimer apellido
surname2StringSegundo apellido
entityParamEntityExternalUserEntidad
Códigos error
CódigoDescripción
DOCUMENT_SERVICE_GENERIC_ERROR
Error genérico durante el servicio
EXTERNALUSER_NOUSERSEARCHNo se ha encontrado el usuario buscado
EXTERNALUSER_NOUSERRESULTError no se obtiene entidad en función de los parámetros de entrada introducidos

Método 'addExternalUser'
Método que da de alta un usuario externo
 Expand
titleMás detalles
Signatura
ParamExternalUser addExternalUser(ParamExternalUser externalUser)
Parámetros de invocación
NombreTipoDescripción
emailStringCorreo electrónico
autonomousBooleanIndica si es autonomo
nameStringNombre
nifStringNIF
entityPositionStringCargo
surname1StringPrimer apellido
surname2StringSegundo apellido
entityParamEntityExternalUserEntidad
ParamEntityexternalUser
NombreTipoDescripción
entityExternalUserIdLong
Identificador 
entityNameStringDescripción de la entidad
Parámetros de respuesta
NombreTipoDescripción
emailStringCorreo electrónico
autonomousBooleanIndica si es autonomo
nameStringNombre
nifStringNIF
entityPositionStringCargo
surname1StringPrimer apellido
surname2StringSegundo apellido
entityParamEntityExternalUserEntidad
Códigos error
CódigoDescripción
DOCUMENT_SERVICE_GENERIC_ERROR
Error genérico durante el servicio
EXTERNALUSER_KONIFEl DNI del usuario no es válido

Método 'addEntityExternalUser'
Método que da de alta una entidad externa
 Expand
titleMás detalles
Signatura
addEntityExternalUser(ParamEntityExternalUser entityExternalUser)
Parámetros de invocación
NombreTipoDescripción
entityNameStringDescripción de la entidad
Códigos error
CódigoDescripción
DOCUMENT_SERVICE_GENERIC_ERROR
Error genérico durante el servicio
EXTERNALUSER_UKENTITYNAMEEl nombre de la entidad que se intenta añadir ya se encuentra en la base de datos


Suscripción a eventos
...
PFI se integra con SGA para el envío de eventos. Para que una aplicación pueda recibir los eventos de PFI, es necesario que esté dada de alta en SGA y que publique un servicio web para la recepción de los eventos. En el manual de SGA se explica cómo publicar el servicio web para poder recibir los eventos.
...
...
Objeto  
 Anchor
ParamProposedSigner
ParamProposedSigner
'ParamProposedSigner'
NombreTipoDescripción
proposedSignerIdLongId del firmante propuesto
signerNifStringNif del firmante propuesto
signerNameStringNombre del firmante propuesto
signerDateFromStringFecha de selección del firmante
signerOrderStringOrden de firma del firmante propuesto
signaturePositionStringTipo de posición de los pies de firma
positionStringCoordenadas donde se ha colocado el pie de firma del firmante propuesto
delegationTextStringTexto de delegación del firmante propuesto
signedStringIndica si el firmante propuesto ha firmando (1) o no (0)
signerOrgCodeStringCódigo de organismo del firmante propuesto
signerOrganismStringNombre de organismo del firmante propuesto
signerRoleStringCargo del firmante propuesto
signerStatusStringCondición del firmante
revisedStringIndica si el firmate propuesto ha sido revisado o no. Valores: S o N
deleteSignBooleanIndica si se ha de borrar la firma al actualizar el firmante propuesto
...
Objeto  
 Anchor
ParamSendDocument
ParamSendDocument
'ParamSendDocument'
NombreTipoDescripción
applicationIdStringAplicación que ejecuta el método
userNif
StringNif del usuario
csvStringCódigo seguro de verificación del documento
...