Índice.
- 1 Índice
- 2 Objetivo
- 3 Crear Stubs
- 4 Consideraciones Métodos de Update
- 5 ECMAttributionMecanismService
- 6 ECMBusinessPeriedService
- 7 ECMCardIndexService
- 8 ECMCardService
- 9 ECMColleagueGroupService
- 10 ECMColleagueReplacementService
- 11 ECMColleagueService
- 12 ECMCompanyService
- 13 ECMCustomFieldsService
- 14 ECMDashBoardService
- 15 ECMDataServiceService
- 16 ECMDatasetService
- 17 ECMDocumentService
- 18 ECMFavoritesService
- 19 ECMFolderService
- 20 ECMGlobalParamService
- 21 ECMGroupService
- 22 ECMOutstandingService
- 23 ECMReportService
- 24 ECMSearchDocumentService
- 25 ECMSignalService
- 26 ECMTokenService
- 27 ECMWorkflowEngineService
- 28 ECMWorkflowRoleService
Objetivo
El objetivo de este documento es describir el uso de Webservices, mostrar y explicar todos sus métodos, aportar ejemplos de clases que utilizan estos Webservices y mostrar ejemplos de generación de stubs, los cuales son necesarios para que los client´s puedan comunicarse con el servicio.
Crear Stubs
Los stubs son necesarios para que los client’s que utilizan los métodos de los Webservices puedan comunicarse con el servicio.
Para crear un stub el servicio Fluig debe haberse comenzado. Después de iniciar el servicio, se debe abrir el Prompt de comando y utilizar la sintaxis: wsimport -d <output_directory> <wsdl_url>, donde output_directory es el directorio en el que se creará el stub y wsdl_url es la url de acceso al servicio. Después de esto, solo se debe apretar Enter y el resultado aparecerá, según se muestra en la figura 1.
Figura 1: Ejemplo de creación de stub
En el cuadro 1, se muestra el comando necesario para crear stubs de cada servicio disponible en Fluig.
Webservices (WSDL) |
Comando |
ECMAttributionMecanismService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMAttributionMecanismService?wsdl |
ECMBusinessPeriodService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMBusinessPeriodService?wsdl |
ECMCardIndexService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardIndexService?wsdl |
ECMCardService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCardService?wsdl |
ECMColleagueGroupService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueGroupService?wsdl |
ECMColleagueReplacementService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueReplacementService?wsdl |
ECMColleagueService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMColleagueService?wsdl |
ECMCompanyService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCompanyService?wsdl |
ECMCustomFieldsService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMCustomFieldsService?wsdl |
ECMDashBoardService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDashBoardService?wsdl |
ECMDataServiceService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDataServiceService?wsdl |
ECMDatasetService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDatasetService?wsdl |
ECMDocumentService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMDocumentService?wsdl |
ECMFavoritesService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFavoritesService?wsdl |
ECMFolderService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMFolderService?wsdl |
ECMGlobalParamService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGlobalParamService?wsdl |
ECMGroupService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMGroupService?wsdl |
ECMOutstandingService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMOutstandingService?wsdl |
ECMReportService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMReportService?wsdl |
ECMSearchDocumentService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSearchDocumentService?wsdl |
ECMSignalService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMSignalService?wsdl |
ECMTokenService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMTokenService?wsdl |
ECMWorkflowEngineService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowEngineService?wsdl |
ECMWorkflowRoleService |
wsimport -d C:\Webservices\tmp http://<SERVER>:<PORT>/webdesk/ECMWorkflowRoleService?wsdl |
Cuadro 1: Comandos para la creación de stubs.
Consideraciones Métodos de Update
Para los métodos de update que reciben objetos complejos (DocumentDto, ColleagueDto, GroupDto, etc) es obligatorio pasar todos los campos del objeto alterado. Los campos no informados serán sustituidos por blanco, nulo o cero, dependiendo de su tipo.
Para evitar esta situación, sugerimos utilizar siempre los métodos get para recuperar el objeto, efectuar los cambios en los campos necesarios y enviarlo al método update.
ECMAttributionMecanismService
Webservice responsable de realizar operaciones referentes a los mecanismos de asignación registrados en Fluig. Puede utilizarse para buscar los mecanismos de asignación de una determinada empresa.
Métodos
getAttributionMecanism |
Devuelve los mecanismos de asignación de la empresa.
Método: getAttributionMecanism(String user, String password, int companyId)
Parámetros:
Devolución: AttributionMecanismDto[]. |
Cuadro 2: Métodos del AttributionMecanismService.
Ejemplo de uso:
Descargue la clase AttributionMecanismServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase AttributionMecanismService.
ECMBusinessPeriedService
Webservice responsable de realizar operaciones referentes a los expedientes registrados en Fluig. Puede utilizarse para buscar los expedientes de una determinada empresa.
Métodos
getBusinessPeriods | Devuelve los expedientes de la empresa.
Método: getBusinessPeriods(String user, String password, int companyId)
Parámetros:
Devolución: BusinessPeriodDto[]. |
Cuadro 3: Métodos de BusinessPeriodService.
Ejemplo de uso:
Descargue la clase BusinessPeriodServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase BusinessPeriodService.
ECMCardIndexService
Webservice responsable de realizar operaciones referentes a los formularios registrados en Fluig.
Métodos
createSimpleCardIndex |
Creación simple de un formulario.
Método: createSimpleCardIndex (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, AttachmentArray attachments, CardEventDtoArray customEvents)
Parámetros:
Devolución: WebServiceMessageArray []. |
createSimpleCardIndexWithDataset |
Creación simple de un formulario con datasets.
Método: createSimpleCardIndexWithDataset (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents)
Parámetros:
Devolución: WebServiceMessageArray []. |
createSimpleCardIndexWithDatasetPersisteType |
Creación simple de un formulario con datasets, determinando el tipo de la persistencia (Formulário o Lista).
createSimpleCardIndexWithDatasetPersisteType (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents, Integer persistenceType)
Parámetros:
Devolución: WebServiceMessageArray []. |
getActiveCardIndex |
Devuelve el formulario activo.
Método: getActiveCardIndex (String user, String password, int companyId, int documentId, String colleagueId)
Parámetros:
Devolución: DocumentDtoArray []. |
getAttachmentsList |
Devuelve la lista de adjuntos del formulario.
Método: getAttachmentsList (String user, String password, int companyId, int documentId)
Parámetros:
Devolución: StringArray []. |
getCardIndexContent |
Devuelve el contenido de un formulario.
Método: getCardIndexContent (String user, String password, int companyId, int documentId, String colleagueId, int version, String nomeArquivo)
Parámetros:
Retorno: byte[]. |
getCardIndexesWithoutApprover |
Devuelve los formularios sin aprobadores de los que el usuario tenga permiso.
Método: getCardIndexesWithoutApprover(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
getCustomizationEvents |
Devuelve los eventos del formulario.
Método: getCustomizationEvents (String user, String password, int companyId, int documentId)
Parámetros:
Devolución: CardEventDtoArray []. |
getFormFields |
Devuelve los campos del formulario
Método: getFormFields(String user, String password, int companyId, int documentId)
Parámetros:
Devolución: String. |
updateSimpleCardIndex |
Actualización simple del formulario.
Método: updateSimpleCardIndex (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, AttachmentArray attachments, CardEventDtoArray customEvents)
Parámetros:
Devolución: WebServiceMessageArray []. |
updateSimpleCardIndexWithDataset |
Actualización simple del formulario con datasets.
Método: updateSimpleCardIndexWithDataset (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents)
Parámetros:
Devolución: WebServiceMessageArray []. |
Cuadro 4: Métodos de CardIndexService.
Ejemplo de uso:
Descargue la clase CardIndexServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase CardIndexService.
ECMCardService
Webservice, responsable por realizar operaciones referentes a formularios en Fluig. Puede utilizarse para crear, alterar, excluir e investigar formularios, entre otras funcionalidades.
Métodos
create |
Crea un formulario.
Método: create(int companyId, String user, String password, CardDto[] carddtos)
Parámetros:
Devolución: WebServiceMessage[]. |
deleteCard |
Elimina un formulario y lo envía a la papelera de reciclaje.
Método: deleteCard(int companyId, String user, String password, int cardId)
Parámetros:
Devolución: WebServiceMessage[]. |
getCardVersion |
Devuelve la versión de un formulario.
Método: getCardVersion(int companyId, String user, String password, int nrDocumentId, int version, String colleagueId)
Método: Parámetros:
Devolución: CardDto[]. |
updateCard |
Cambiar los metadatos de un formulario.
Método: updateCard(int companyId, String user, String password, CardDto[] cardDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers, RelatedDocumentDto[] reldocs)
Parámetros:
Devolución: WebServiceMessage[]. |
updateCardData |
Altera los campos de un formulario.
Método: updateCardData(int companyId, String user, String password, int cardId, CardFieldDto[] cardData)
Parámetros:
Devolución: WebServiceMessage[]. |
Cuadro 5: Métodos de CardService.
Ejemplo de uso:
Descargue la clase CardServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase CardService.
ECMColleagueGroupService
Webservice responsable por realizar operaciones referentes a los grupos de usuarios en Fluig. Puede utilizarse para relacionar un usuario a un grupo de usuarios y sirve también para alterar, excluir y buscar esas relaciones creadas.
Métodos
createColleagueGroup |
Asocia un usuario a un grupo.
Método: createColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)
Parámetros:
Devolución: String. |
deleteColleagueGroup |
Elimina un usuario de un grupo.
Método: deleteColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)
Parámetros:
Devolución: String. |
getAllColleagueGroups |
Devuelve todos los grupos que tienen usuarios relacionados.
Método: getAllColleagueGroups(String username, String password, int companyId)
Parámetros:
Devolución: ColleagueGroupDto[]. |
getColleagueGroup |
Devuelve solamente un grupo del que determinado usuario participa.
Método: getColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)
Parámetros:
Devolución: ColleagueGroupDto[].
Atributos de devolución:
|
getColleagueGroupsByColleagueId |
Devuelte los grupos de los que un usuario participa.
Método: getColleagueGroupsByColleagueId(String username, String password, int companyId, String colleagueId)
Parámetros:
Devolución: ColleagueGroupDto[].
Atributos de devolución:
|
getColleagueGroupsByGroupId |
Devuelve los usuarios que participan de un grupo de usuarios.
Método: getColleagueGroupsByGroupId(String username, String password, int companyId, String groupId)
Parámetros:
Devolución: ColleagueGroupDto[].
Atributos de devolución:
|
updateColleagueGroup |
Altera la asociación de un usuario a un grupo.
Método: updateColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)
Parámetros:
Devolución: String. |
Cuadro 6: Métodos de ColleagueGroupService.
Ejemplo de uso:
Descargue la clase ColleagueGroupServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase ColleagueGroupService.
ECMColleagueReplacementService
Webservice responsable por realizar operaciones referentes a usuarios sustitutos en Fluig. Puede utilizarse para crear, alterar, excluir e investigar usuarios sustitutos, entre otras funcionalidades.
Métodos
createColleagueReplacement |
Crea un sustituto.
Método: createColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)
Parámetros:
Devolución: String. |
deleteColleagueReplacement |
Elimina el registro de un sustituto.
Método: deleteColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)
Parámetros:
Devolución: String. |
getColleagueReplacement |
Devuelve un sustituto de un usuario.
Método: getColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)
Parámetros:
Devolución: ColleagueReplacementDto. |
getReplacementsOfUser |
Resuelve todos los sustitutos de un usuario.
Método: getReplacementsOfUser(String username, String password, int companyId, String colleagueId)
Parámetros:
Devolución: ColleagueReplacementDto[]. |
getValidReplacedUsers |
Devuelve todos los usuarios sustituidos por un sustituto válido.
Método: getValidReplacedUsers(String username, String password, int companyId, String replacementId)
Parámetros:
Devolución: ColleagueReplacementDto[]. |
getValidReplacement |
Devuelve un sustituto válido de un usuario.
Método: getValidReplacement(String username, String password, int companyId, String colleagueId, String replacementId)
Parámetros:
Devolución: ColleagueReplacementDto. |
getValidReplacementsOfUser |
Devuelve todos los sustitutos válidos de un usuario.
Método: getValidReplacementsOfUser(String username, String password, int companyId, String colleagueId)
Parámetros:
Devolución: ColleagueReplacementDto[]. |
updateColleagueReplacement |
Altera el registro de un sustituto.
Método: updateColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)
Parámetros:
Devolución: String. |
Cuadro 7: Métodos de la ColleagueReplacementService
Ejemplo de uso:
Descargue la clase ColleagueReplacementServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase ColleagueReplacementService.
ECMColleagueService
Webservice responsable por realizar operaciones referentes a usuarios en Fluig. Puede utilizarse para crear, alterar, excluir e investigar usuarios, entre otras funcionalidades.
Atención: Los métodos createColleague, createColleaguewithDependencies, updateColleague y updateColleaguewithDependencies, en uno de sus parámetros, recibe una lista de ColleagueDto, en los objetos de estas listas, los valores para los campos de contraseña (password) deben ser criptografiados con el algoritmo de hash MD5.
Métodos
createColleague |
Crea un usuario.
Método: createColleague(String username, String password, int companyId, ColleagueDto[] colleagues)
Parámetros:
Devolución: String. |
createColleaguewithDependencies |
Crea un usuario con grupos y papeles.
Método: createColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)
Parámetros:
Devolución: String. |
getColleague |
Devuelve un usuario.
Método: getColleague(String username, String password, int companyId, String colleagueId)
Parámetros:
Devolución: ColleagueDto[].
Atributos de devolución:
|
getColleagueByLogin |
Devuelve el usuario a partir del login. Método: getColleagueByLogin(String username, String password)
Parámetros:
Devolución: ColleagueDto.
Atributos de devolución:
|
getColleagues |
Devuelve todos los usuarios activos.
Método: getColleagues(String username, String password, int companyId)
Parámetros:
Devolución: ColleagueDto[].
Atributos de devolución:
|
getColleaguesMail |
Devuelve un usuario utilizando un e-mail.
Método: getColleaguesMail(String username, String password, int companyId, String mail)
Parámetros:
Devolución: ColleagueDto[].
Atributos de devolución:
|
getColleagueWithMap |
Devuelve un mensaje informando si el usuario fue creado correctamente.
Método: getColleagueWithMap(String colleagueXML, String username, String password)
Parámetros:
Devolución: String. |
getGroups |
Devuelve los grupos de los que el usuario participa.
Método: getGroups(String username, String password, int companyId, String colleagueId)
Parámetros:
Devolución: GroupDto[].
Atributos de devolución:
|
getSimpleColleague |
Devuelve el usuario.
Método: getSimpleColleague(String username, String password)
Parámetros:
Devolución: ColleagueDto.
Atributos de devolución:
|
getSummaryColleagues |
Devuelve todos los usuarios activos.
Método: getSummaryColleagues(int companyId)
Parámetros:
Devolución: ColleagueDto[].
Atributos de devolución:
|
removeColleague |
Desactiva un usuario.
Método: removeColleague(String username, String password, int companyId, String colleagueId)
Parámetros:
Devolución: String. |
activateColleague | Activa un usuario.
Método: activateColleague(String username, String password, int companyId, String colleagueId)
Parámetros:
Devolución: String. |
updateColleague |
Altera un usuario.
Método: updateColleague(String username, String password, int companyId, ColleagueDto[] colleagues)
Parámetros:
Devolución: String. |
updateColleaguewithDependencies |
Altera un usuario con grupos y papeles.
Método: updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)
Parámetros:
Devolución: String. |
validateColleagueLogin |
Valida el acceso de un usuario en el producto.
Método: validateColleagueLogin(int companyId, String colleagueId, String password)
Parámetros:
Devolución: String. |
Cuadro 8: Métodos de ColleagueService.
Ejemplo de uso:
Descargue la clase ColleagueServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase ColleagueService.
ECMCompanyService
Webservice responsable por realizar operaciones referentes a la empresa en Fluig. Puede ser utilizado para crear, alterar, excluir e investigar empresas, entre otras funcionalidades.
Métodos
createCompany |
Crea una empresa en Fluig.
Método: createCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)
Parámetros:
Devolución: String. |
delete |
Elimina una empresa de Fluig.
Método: delete(String username, String password, String companyId, Boolean deleteFiles)
Parámetros:
Devolución: String. |
getCompanies |
Devuelve todas las empresas registradas en Fluig.
Método: getCompanies(String username, String password, String companyId)
Parámetros:
Devolución: CompanyDto[]. |
getCompany |
Devuelve una empresa registrada en Fluig.
Método: getCompany(int companyId)
Parámetros:
Devolución: CompanyDto. |
updateCompany |
Altera una empresa en Fluig.
Método: updateCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)
Parámetros:
Devolución: String. |
Cuadro 9: Métodos de CompanyService
Ejemplo de uso:
Descargue la clase CompanyServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase CompanyService.
ECMCustomFieldsService
WebService responsable de interactuar con los campos personalizados de Fluig. Puede utilizarse para crear, alterar, excluir e investigar campos personalizados, entre otras funcionalidades.
Métodos
createCustomFields |
Crea un campo estandarizado.
Método: createCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)
Parámetros:
Devolución: String. |
getAllCustomField |
Devuelve todos los campos personalizados.
Método: getAllCustomField(String user, String password, int companyId)
Parámetros:
Devolución: CustomFieldsDto[]. |
getAllDocumentCustomField |
Devuelve todos los campos personalizados de un documento.
Método: getAllDocumentCustomField(String user, String password, int companyId, int documentId, int version)
Parámetros:
Devolución: DocumentCustomFieldsDto[]. |
removeCustomField |
Excluye un campo personalizado.
Método: removeCustomField(String user, String password, int companyId, String customFieldsId)
Parámetros:
Devolución: String. |
removeDocumentCustomField |
Excluye un campo personalizado de un documento.
Método: removeDocumentCustomField(String user, String password, int companyId, String customFieldsId, int documentId, int version)
Parámetros:
Devolución: String. |
setDocumentCustomFields |
Crea o altera un campo personalizado en un documento.
Método: setDocumentCustomFields(String user, String password, int companyId, DocumentCustomFieldsDto[] documentCustomFieldsDto)
Parámetros:
Devolución: String. |
updateCustomFields |
Altera un campo estandarizado.
Método: updateCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)
Parámetros:
Devolución: String. |
Cuadro 10: Métodos de CustomFieldsService
Ejemplo de uso:
Descargue la clase CustomFieldsServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase CustomFieldsService.
ECMDashBoardService
WebService responsable de interactuar con la central de tareas de Fluig. Puede utilizarse para buscar la información disponible en la central de tareas.
Métodos
findMyDocuments |
Devuelve los documentos del usuario que necesitan ser aprobados.
Método: findMyDocuments(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
findMyDocumentsOnDemand |
Devuelve los documentos del usuario que necesitan ser aprobados, paginados.
Método: findMyDocumentsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)
Parámetros:
Devolución: DocumentDto[]. |
findDocumentsToApprove |
Devuelve los documentos que el usuario debe aprobar.
Método: findDocumentsToApprove(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
findDocumentsToApproveOnDemand |
Devuelve los documentos que el usuario debe aprobar, paginados.
Método: findDocumentsToApproveOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)
Parámetros:
Devolución: DocumentDto[]. |
findAgreementDocuments |
Devuelve los documentos del usuario que están en consenso.
Método: findAgreementDocuments(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
findCheckoutDocuments |
Devuelve los documentos del usuario que están en checkout.
Método: findCheckoutDocuments(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
findCancelledTasks |
Devuelve las tareas asignadas al usuario que fueron canceladas.
Método: findCancelledTasks(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: WorkflowProcessDto[]. |
findCompletedTasks |
Devuelve las tareas asignadas al usuario que fueron finalizadas.
Método: findCompletedTasks(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: WorkflowProcessDto[]. |
findConsensusTasks |
Devuelve las tareas asignadas al usuario que están en consenso.
Método: findConsensusTasks(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: WorkflowProcessDto[]. |
findTransferredTasks |
Devuelve las tareas asignadas al usuario que fueron transferidas.
Método: findTransferredTasks(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: WorkflowProcessDto[]. |
findWorkflowTasks |
Devuelve las tareas del usuario que están abiertas.
Método: findWorkflowTasks(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: WorkflowProcessDto[]. |
findWorkflowTasksOnDemand |
Devuelve las tareas del usuario que están abiertas, paginadas.
Método: findWorkflowTasksOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)
Parámetros:
Devolución: WorkflowProcessDto[]. |
findMyRequests |
Devuelve las solicitudes abiertas que fueron iniciadas por el usuario.
Método: findMyRequests(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: WorkflowProcessDto[]. |
findMyRequestsOnDemand |
Devuelve las solicitudes abiertas que fueron iniciadas por el usuario, paginadas.
Método: findMyRequestsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)
Parámetros:
Devolución: WorkflowProcessDto[]. |
findMyManagerTasks |
Devuelve las tareas gestionadas por el usuario.
Método: findMyManagerTasks(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: WorkflowProcessDto[]. |
findExpiredWorkflowTasks |
Devuelve las tareas del usuario que están atrasadas.
Método: findExpiredWorkflowTasks(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: WorkflowProcessDto[]. |
fillStatusTask |
Devuelve la cantidad de tareas atrasadas, dentro del plazo, y sin plazo de un usuario.
Método: fillStatusTask(String user, String password, int companyId, String colleagueId)
Parámetros:
Retorno: int[]. |
fillChronoTasks |
Devuelve la cantidad de tareas con plazo de finalización que se asignaron al usuario y no fueron finalizadas.
Método: fillChronoTasks(String user, String password, int companyId, String colleagueId, int yearIni, int yearFin, int mounthIni, int mounthFin, int dayIni, int dayFin, int kindTask)
Parámetros:
Retorno: int[]. |
fillTypeTasks |
Devuelve los tipos de tareas que el usuario posee.
Método: fillTypeTasks(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: TaskVODto[]. |
fillTypeTasksOfReplacement |
Devuelve los tipos de tareas que el usuario sustituto posee.
Método: fillTypeTasksOfReplacement(String user, String password, int companyId, String colleagueId, String replacementId)
Parámetros:
Devolución: TaskVODto[]. |
getOpenTasksByColleagueGroups |
Devuelve las tareas asignadas a un grupo del que el usuario participa.
Método: getOpenTasksByColleagueGroups(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: WorkflowTaskDto[]. |
getOpenTasksByColleagueGroupsOnDemand |
Devuelve las tareas asignadas a un grupo del que el usuario participa, paginadas.
Método: getOpenTasksByColleagueGroupsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)
Parámetros:
Devolución: WorkflowTaskDto[]. |
getOpenTasksByColleagueRoles |
Devuelve las tareas asignadas a un papel del que el usuario participa.
Método: getOpenTasksByColleagueRoles(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: WorkflowTaskDto[]. |
getOpenTasksByColleagueRolesOnDemand |
Devuelve las tareas asignadas a un papel workflow del que el usuario participa, paginadas.
Método: getOpenTasksByColleagueRolesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)
Parámetros:
Devolución: WorkflowTaskDto[]. |
getSummaryRequests |
Devuelve los contadores de pendencias de Home.
Método: getSummaryRequests(int companyId, String user, String password, String colleagueId)
Parámetros:
Devolución: HomeRequestSummaryDto[]. |
getUrlEcm | Devuelve la url del servidor
Método: getUrlEcm(long companyId)
Parámetros:
Devolución: String. |
Cuadro 11: Métodos de DashBoardService
Ejemplo de uso:
Descargue la clase DashBoardClient.java, ésta ejemplifica el uso de los principales métodos de la clase DashBoardService.
ECMDataServiceService
WebService responsable de interactuar con los servicios externos de Fluig. Puede ser utilizado para crear, alterar, excluir y buscar los servicios externos existentes.
Métodos
createDataService |
Crea un servicio externo.
Método: createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)
Parámetros:
Devolución: String. |
deleteDataService | Elimina un servicio externo.
Método: deleteDataService(int companyId, String user, String password, String dataServiceName)
Parámetros:
Devolución: void. |
getAllServices | Devuelve todos los servicios externos registrados.
Método: getAllServices(int companyId, String user, String password)
Parámetros:
Devolución: dataServiceDto[]. |
loadDataService | Regresa un servicio externo.
Método: loadDataService(int companyId, String user, String password, String dataServiceName)
Parámetros:
Devolución: dataServiceDto. |
updateDataService | Actualiza un servicio externo.
Método: createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)
Parámetros:
Devolución: void. |
Cuadro 12: Métodos de DataServiceService.
ECMDatasetService
WebService responsable de interactuar con los datasets de Fluig. Puede utilizarse para buscar los datasets existentes.
Métodos
addDataset |
Crea un dataset.
Método: addDataset(int companyId, String user, String password, String datasetName, String description, String impl)
Parámetros:
Devolución: String. |
deleteDataset |
Elimina un dataset
Método: deleteDataset(int companyId, String user, String password, String datasetName)
Parámetros:
Devolución: void. |
getAvailableDatasets |
Devuelve todos los datasets disponibles.
Método: getAvailableDatasets(int companyId, String user, String password)
Parámetros:
Devolución: Object[]. |
getDataset |
Devuelve la información de un dataset.
Método: getDataset(int companyId, String user, String password, String name, String[] fields, SearchConstraintDto[] constraintsDto, String[] order)
Parámetros:
Devolución: DatasetDto. |
updateDataset |
Actualiza un dataset.
Método: updateDataset(int companyId, String user, String password, String datasetName, String description, String impl)
Parámetros:
Devolución: void. |
Cuadro 13: Métodos de DatasetService
Ejemplo de uso:
Descargue la clase DatasetServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase DatasetService.
ECMDocumentService
Webservice responsable por realizar operaciones referentes a documentos en Fluig. Puede utilizarse para crear, alterar, excluir y buscar documentos, entre otras funcionalidades.
Métodos
approveDocument |
Aprueba o desaprueba el documento pendiente de aprobación.
Método: approveDocument(int companyId, String userId, String password, int documentId, int version, String approverId, boolean approved, String observation)
Parámetros:
Devolución: WebServiceMessage[].
|
copyDocumentToUploadArea |
Copia los archivos (principal y adjuntos) de un documento al área de upload del usuario. Esto permite que los documentos sean accesibles vía FTP. Método: copyDocumentToUploadArea(String user, String password, int companyId, int documentId, int version, String colleagueId) Parámetros:
Devolución: String[] nombre de los archivos disponibles en el área de upload |
createDocument |
Crea un documento
Método: createDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)
Parámetros:
Devolución: WebServiceMessage[]. |
createDocumentWithApprovementLevels |
Crea un documento con nivel de aprobación.
Método: createDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docSecurity, ApproverWithLevelDto[] docApproversLevels, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)
Parámetros:
Devolución: WebServiceMessage[]. |
createSimpleDocument |
Crea un documento simple.
Método: createSimpleDocument(String user, String password, int company, int parentDocumentId, String publisherId, String documentDescription, Attachment[] attachments)
Parámetros:
Devolución: WebServiceMessage[]. |
createSimpleDocumentPrivate |
Crea un documento simple en la carpeta en particular.
Método: createSimpleDocumentPrivate(String colleagueId, String password, int companyId, int parentDocumentId, String documentDescription, Attachment[] attachments)
Parámetros:
Devolución: WebServiceMessage[]. |
deleteDocument |
Elimina un documento y lo envía a la papelera de reciclaje.
Método: deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)
Parámetros:
Devolución: WebServiceMessage[]. |
destroyDocument |
Elimina un documento de la papelera de reciclaje.
Método: destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)
Parámetros:
Devolución: WebServiceMessage[]. |
destroyDocumentApproval |
Excluye documento pendiente de aprobación
Método: destroyDocumentApproval(String userId, String password, int companyId, int documentId, String publisherId)
Parámetros:
Devolución: WebServiceMessage[]. |
findMostPopularDocuments |
Devuelve los documentos más accedidos en el Fluig a los que el usuario tiene permiso de acceso.
Método: findMostPopularDocuments(String user, String password, int companyId, String colleagueId, int nr_resultados)
Parámetros:
Devolución: DocumentDto[].
Atributos de devolución:
|
findMostPopularDocumentsOnDemand |
Devuelve los documentos más accedidos en el Fluig a los que el usuario tiene permiso de acceso, paginados.
Método: findMostPopularDocuments(int companyId, String user, String password, String colleagueId, int limit, int lastRowId)
Parámetros:
Devolución: DocumentDto[].
Atributos de devolución:
|
findRecycledDocuments |
Devuelve los documentos de la papelera de reciclaje.
Método: findRecycledDocuments(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: DocumentDto[].
Atributos de devolución:
|
getActiveDocument |
Devuelve un documento activo.
Método: getActiveDocument(String user, String password, int companyId, int nrDocumentId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
getApprovers |
Devuelve los aprobadores de un documento.
Método: getApprovers(String user, String password, int companyId, int nrDocumentId, int version)
Parámetros:
Devolución: ApproverWithLevelDto[].
Atributos de devolución:
|
getDocumentApprovalHistory |
Devuelve el historial de aprobaciones del documento solicitado.
Método: getDocumentApprovalHistory(String user, String password, int companyId, int documentId, int version)
Parámetros:
Devolución: DocumentApprovementHistoryDto[]
Atributos de devolución:
|
getDocumentApprovalStatus |
Devuelve el estado del documento en relación a su aprobación. El estado del documento puede ser: 0 - Aprobado. 1 - Rechazado 2 - En aprobación
Método: getDocumentApprovalStatus(String user, String password, int companyId, int documentId, int version)
Parámetros:
Devolución: DocumentApprovalStatusDto[]
Atributos de devolución:
|
getDocumentByExternalId |
Devuelve un documento por el código externo.
Método: getDocumentByExternalId(String user, String password, int companyId, String externalDocumentId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
getDocumentContent |
Devuelve el byte del archivo físico de un documento, si el usuario tiene permiso para acceder al mismo.
Método: getDocumentContent(String user, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String nomeArquivo)
Parámetros:
Retorno: byte[]. |
getDocumentVersion |
Devuelve la versión de un documento.
Método: getDocumentVersion(String user, String password, int companyId, int nrDocumentId, int version, String colleagueId)
Parámetros:
Devolución: DocumentDto[].
Atributos de devolución:
|
getRelatedDocuments |
Devuelve todos los documentos relacionados de un documento.
Método: getRelatedDocuments(String user, String password, int companyId, int nrDocumentId, int version)
Parámetros:
Devolución: RelatedDocumentDto[].
Atributos de devolución:
|
getReportSubjectId |
Devuelve el código del asunto de informes dentro de Fluig.
Método: getReportSubjectId(String user, String password, int companyId)
Parámetros:
Devolución: int. |
getSecurity |
Devuelve la seguridad de un documento.
Método: getSecurity(String user, String password, int company, int nrDocumentId, int version)
Parámetros:
Devolución: DocumentSecurityConfigDto[].
Atributos de devolución:
|
getUserPermissions |
Devuelve los permisos del usuario sobre un documento.
Método: getUserPermissions(int companyId, String user, int nrDocumentId, int version)
Parámetros:
Devolución: Integer.
Atributos de devolución:
|
moveDocument |
Mover documentos a la carpeta de destino.
Método: moveDocument(String user, String password, int companyId, int[] documentIds, String colleagueId, int destfolder)
Parámetros:
Devolución: String[] |
removeSecurity |
Quita la seguridad de un documento.
Método: removeSecurity(String user, String password, int companyId, int documentId, int version)
Parámetros:
Devolución: No hay devolución. |
restoreDocument |
Restaura un documento de la papelera de reciclaje.
Método: restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)
Parámetros:
Devolución: WebServiceMessage[]. |
updateDocument |
Altera un documento
Método: updateDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)
Parámetros:
Devolución: WebServiceMessage[]. |
updateDocumentWithApprovementLevels |
Altera un documento con nivel de aprobación.
Métodos updateDocumentWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attach, DocumentSecurityConfigDto[] docSecutiry, ApproverWithLevelDto[] docApprovers, ApprovalLevelDto[] levels, RelatedDocumentDto[] relDocs)
Parámetros:
Devolución: WebServiceMessage[]. |
updateGroupSecurityType |
Modifica el tipo de seguridad de los grupos en la autorización y la restricción. Existen dos opciones que son representadas por un número entero: 0 - TODOS los usuarios de los Grupos. 1 - SOLAMENTE usuarios comunes de los grupos.
Método: updateGroupSecurityType(String user, String password, int companyId, int documentId, int version, int permissionType, int restrictionType, String colleagueId)
Parámetros:
Devolución: WebServiceMessage[]. |
updateSimpleDocument |
Cambia de manera simple un documento.
Método: updateSimpleDocument(String username, String password, int companyId, int documentId, String publisherId, String documentDescription, Attachment[] attachments)
Parámetros:
Devolución: WebServiceMessage[]. |
validateIntegrationRequirements |
Verifica la integración del usuario en Fluig.
Método: validateIntegrationRequirements (String user, String password, int companyId)
Parámetros:
Devolución: String. |
Cuadro 14: Métodos de DocumentService
Ejemplo de uso:
Descargue la clase DocumentServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase DocumentService.
ECMFavoritesService
WebService responsable de interactuar con los documentos y procesos favoritos de Fluig. Puede ser utilizado para buscar los documentos y procesos favoritos de cada usuario.
Métodos
addDocumentToFavorites |
Agrega un documento a los favoritos del usuario informado.
Método: addDocumentToFavorites(String username, String password, int companyId, int nrDocument, int nrVersao, String colleagueId)
Parámetros:
Devolución: void. |
addProcessToFavorites |
Agrega un proceso a los favoritos del usuario informado.
Método: addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId)
Parámetros:
Devolución: void. |
findFavorites |
Devuelve los documentos favoritos del usuario.
Método: findFavorites(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
findFavoritesOnDemand |
Devuelve los documentos favoritos del usuario, paginados.
Método: findFavoritesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)
Parámetros:
Devolución: DocumentDto[]. |
findFavoritesProcess |
Devuelve los procesos favoritos del usuario.
Método: findFavoritesProcess (String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: ProcessDefinitionVersionDto[] . |
findFavoritesProcessOnDemand |
Devuelve los procesos favoritos del usuario, paginados.
Método: findFavoritesProcess (String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: ProcessDefinitionVersionDto[] . |
isFavoriteDocument |
Verifica si el documento es favorito.
Método: isFavoriteDocument(String username, String password, int companyId, int nrDocument, String colleagueId)
Parámetros:
Devolución: Boolean |
removeFavoriteDocument |
Quita un documento de los favoritos del usuario informado.
Método: removeFavoriteDocument (String username, String password, int companyId, int nrDocument, String colleagueId)
Parámetros:
Devolución: void. |
removeFavoriteProcess |
Quita un proceso de los favoritos del usuario informado.
Método: addProcessToFavorites(String username, String password, int companyId,String processId, String colleagueId)
Parámetros:
Devolución: void. |
Cuadro 15: Métodos de FavoritesService
Ejemplo de uso:
Descargue la clase FavoritesServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase FavoritesService.
ECMFolderService
Webservice responsable por realizar operaciones referentes a carpetas en Fluig. Puede ser utilizado para crear, alterar, excluir y buscar carpetas, entre otras funcionalidades.
Métodos
createFolder |
Crea una carpeta.
Método: createFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers )
Parámetros:
Devolución: WebServiceMessage[]. |
createFolderWithApprovementLevels |
Crea una carpeta con nivel de aprobación.
Método: createFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)
Parámetros:
Devolución: WebServiceMessage[]. |
createSimpleFolder |
Crea una carpeta simple.
Método: createSimpleFolder(String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription)
Parámetros:
Devolución: WebServiceMessage[]. |
deleteDocument |
Elimina una carpeta y la envía a la papelera de reciclaje.
Método: deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)
Parámetros:
Devolución: WebServiceMessage[]. |
destroyDocument |
Elimina una carpeta de la papelera de reciclaje.
Método: destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)
Parámetros:
Devolución: WebServiceMessage[]. |
findRecycledDocuments |
Devuelve todos los documentos de la papelera de reciclaje de un usuario.
Método: findRecycledDocuments(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
getApprovers |
Devuelve los aprobadores de una carpeta.
Método: getApprovers(String user, String password, int companyId, int nrDocumentId)
Parámetros:
Devolución: ApproverWithLevelDto[]. |
getChildren |
Devuelve todos los documentos de una carpeta.
Método: getChildren(String user, String password, int companyId, int documentId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
getFolder |
Devuelve una carpeta.
Método: getFolder(String user, String password, int companyId, int nrDocumentId, String colleagueId )
Parámetros:
Devolución: DocumentDto[]. |
getPrivateChildren |
Devuelve todos los documentos de una carpeta en particular.
Método: getPrivateChildren(String user, String password, int companyId, int parentDocumentId)
Parámetros:
Devolución: DocumentDto[].
|
getRootFolders |
Devuelve las carpetas root a las que un usuario tiene acceso, excepto la carpeta particular.
Método: getRootFolders(String user, String password, int companyId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
getSecurity |
Devuelve la seguridad de una carpeta.
Método: getSecurity(String user, String password, int companyId, int nrDocumentId)
Parámetros:
Devolución: DocumentSecurityConfigDto[]. |
getSubFolders |
Devuelve todas las subcarpetas y archivos de una carpeta.
Método: getSubFolders(String user, String password, int companyId, int documentId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
getSubFoldersOnDemand |
Devuelve todas las subcarpetas y archivos de una carpeta., paginados
Método: getSubFoldersOnDemand(int companyId, String user, String password, int documentId, boolean privatefolder, String[] documenttypes, int limit , int lastRowId, String colleagueId)
Parámetros:
Devolución: DocumentDto[]. |
getSubFoldersPermission |
Devuelve todos los subcarpetas en las que el usuario tiene permiso informado.
Método: getSubFoldersPermission(String user, String password, int companyId, int documentId, String colleagueId, int permission)
Parámetros:
Devolución: DocumentDto[]. |
getSubPrivateFolders |
Devuelve todas las subcarpetas de una carpeta en particular.
Método: getSubPrivateFolders(String colleagueId, String password, int companyId, int documentId)
Parámetros:
Devolución: DocumentDto[]. |
getUserPermissions |
Devuelve el permiso de un usuario sobre una carpeta.
Método: getUserPermissions(int companyId, String user, int nrDocumentId, int version)
Parámetros:
Devolución: Integer. |
restoreDocument |
Restaura una carpeta de la papelera de reciclaje.
Método: restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)
Parámetros:
Devolución: WebServiceMessage[]. |
updateFolder |
Altera una carpeta.
Método: updateFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers)
Parámetros:
Devolución: WebServiceMessage[]. |
updateFolderWithApprovementLevels |
Altera una carpeta con nivel de aprobación.
Método: updateFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)
Parámetros:
Devolución: WebServiceMessage[]. |
updateSimpleFolder |
Cambia de manera simple una carpeta.
Método: updateSimpleFolder(String user, String Password, int companyId, DocumentDto[] docdtos)
Parámetros:
Devolución: WebServiceMessage[]. |
Cuadro 16: Métodos de FolderService
Ejemplo de uso:
Descargue la clase FolderServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase FolderServiceClient.
ECMGlobalParamService
WebService responsable de interactuar con las configuraciones de los parámetros generales de Fluig. Puede utilizarse para crear, alterar y buscar los parámetros generales.
Métodos
createGlobalParam |
Crea parámetros generales para una empresa.
Método: createGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)
Parámetros:
Devolución: String. |
getGlobalParam |
Devuelve los parámetros generales de una empresa.
Método: getGlobalParam(String username, String password, int companyId)
Parámetros:
Devolución: GlobalParamDto[]. |
getVolumes |
Devuelve los volúmenes de la empresa.
Método: getVolumes(String user, String password, int companyId)
Parámetros:
Devolución: VolumeDto[]. |
updateConfigurations |
Altera las configuraciones del sistema.
Método:
Parámetros:
Devolución: String. |
updateGlobalParam |
Altera parámetros generales de una empresa.
Método: updateGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)
Parámetros:
Devolución: String. |
Cuadro 17: Métodos de GlobalParamService.
Ejemplo de uso:
Descargue la clase GlobalParamServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase GlobalParamService.
ECMGroupService
Webservice responsable de realizar operaciones referentes a grupos en Fluig. Puede utilizarse para crear, alterar, excluir y buscar grupos, entre otras funcionalidades.
Métodos
createGroup |
Crea un grupo en Fluig.
Método: createGroup(String username, String password, int companyId, GroupDto[] grupos)
Parámetros:
Devolución: String. |
deleteGroup |
Elimina un grupo de Fluig.
Método: deleteGroup(String username, String password, int companyId, String groupId)
Parámetros:
Devolución: String. |
getGroup |
Devuelve un grupo registrado en Fluig.
Método: getGroups(String username, String password, int companyId, String groupId)
Parámetros:
Devolución: GroupDto[].
Atributos de devolución:
|
getGroups |
Devuelve todos los grupos registrados en Fluig.
Método: getGroups(String username, String password, int companyId)
Parámetros:
Devolución: GroupDto[].
Atributos de devolución:
|
getGroupsByDescription |
Devuelve un grupo por la descripción.
Método: getGroupsByDescription(String username, String password, int companyId, String desc)
Parámetros:
Devolución: GroupDto[].
Atributos de devolución:
|
getOcurrenceByKey |
Devuelve si hay configuración de seguridad para la asignación y el valor de asignación.
Método: getOcurrenceByKey(String username, String password, int companyId, int pIdiAtribuic, String pDesValAtribuic)
Parámetros:
Devolución: boolean. |
updateGroup |
Altera un grupo en Fluig.
Método: updateGroup(String username, String password, int companyId, GroupDto[] grupos)
Parámetros:
Devolución: String. |
Cuadro 18: Métodos de GroupService.
Ejemplo de uso:
Descargue la clase GroupServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase GroupService.
ECMOutstandingService
WebService responsable de interactuar con las transferencias de pendencias de Fluig. Puede utilizarse para transferir pendencias de un usuario a otro usuario.
Métodos
transfer |
Transfiere pendencias de un usuario a otro usuario.
Método: transfer(String user, String password, int companyId, String colleagueIdFrom, String colleagueIdTo, String[] parameters)
Parámetros:
Devolución: String. |
Cuadro 19: Métodos de OutstandingService.
Ejemplo de uso
Descargue la clase OutstandingServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase OutstandingService.
ECMReportService
Webservice responsable por realizar operaciones referentes a informes en Fluig. Puede utilizarse para crear, alterar, excluir y buscar informes, entre otras funcionalidades.
Métodos
createSimpleReport |
Crea un informe de manera simplificada en Fluig.
Método: createSimpleReport(String username, String password, int companyId, int parentDocId, String reportDescription, Attachment[] attachments)
Parámetros:
Devolución: WebServiceMessage[]. |
getActiveReport |
Devuelve un informe activo en Fluig.
Método: getActiveReport(int companyId, String username, String password, String documentId)
Parámetros:
Devolución: DocumentDto |
getAttachmentsList |
Devuelve una lista de adjuntos del informe en Fluig.
Método: getAttachmentsList(String username, String password, int companyId, String documentId)
Parámetros:
Devolución: String. |
getReportContent |
Devuelve el archivo físico de un informe.
Método: getReportContent(String username, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String fileName)
Parámetros:
Retorno: byte[]. |
getRepots |
Devuelve los informes disponibles.
Método: getRepots(String username, String password, int companyId)
Parámetros:
Devolución: DocumentDto[]. |
updateSimpleReport |
Actualiza un informe de manera simplificada en Fluig.
Método: createSimpleReport(String username, String password, int companyId, int docId, String reportDescription, Attachment[] attachments, String versionOption)
Parámetros:
Devolución: WebServiceMessage[]. |
Cuadro 20: Métodos de ReportService.
Ejemplo de uso:
Descargue la clase ReportServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase ReportService.
ECMSearchDocumentService
Webservice responsable por realizar operaciones referentes a búsquedas en Fluig. Puede utilizarse para buscar documentos utilizando la búsqueda simple y avanzada.
Métodos
advancedSearchDocuments |
Utiliza una búsqueda avanzada.
Método: advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, boolean findAllDocumentTypes, boolean findFolders, boolean findDocuments, boolean findCardIndex, boolean findCards, boolean findExternalDocument, int documentParentId, Date startDate, Date finalDate)
Parámetros:
Devolución: SearchResultDto[]. |
advancedSearchDocumentsWithMetadata | Utiliza búsqueda avanzada a través de las opciones de metadatos y campos personalizados.
Método: advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, SearchFields[] metadata, SearchFields[] customfields, boolean findAllDocumentTypes, boolean findFolders, boolean findDocuments, boolean findCardIndex, boolean findCards, boolean findExternalDocument, int documentParentId, Date startDate, Date finalDate)
Parámetros:
Devolución: SearchResultDto[]. |
searchDocuments |
Utiliza búsqueda simple.
Método: searchDocuments(String user, String password, int companyId, String colleagueId, String content)
Parámetros:
Devolución: SearchResultDto[]. |
searchFavoritesDocuments |
Búsqueda de documentos favoritos.
Método: searchFavoritesDocuments(String user, String Password, int companyId, String colleagueId, String content)
Parámetros:
Devolución: SearchResultDto[] |
Cuadro 21: Métodos de SearchDocumentService
Ejemplo de uso:
Descargue la clase SearchDocumentServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase SearchDocumentService.
ECMSignalService
WebService responsable de interactuar con las señales creadas en Fluig. Puede utilizarse para crear, eliminar o enviar señales, o consultar las señales
Métodos
createSignal |
Crea una señal en Fluig.
Método: createSignal(String login, String password, int companyId, String description)
Parámetros:
Devolución: String. |
deleteSignal |
Elimina una señal creada en Fluig.
Método: deleteSignal(String login, String password, int companyId, int signalId)
Parámetros:
Devolución: String. |
fireSignal |
Envía/Dispara la señal existente.
Método: fireSignal (String login, String password, int companyId, int signalId)
Parámetros:
Devolución: String. |
getSignals |
Devuelve las señales existentes en Fluig.
Método: getSignals(String login, String password, int companyId)
Parámetro:
Devolución: Signal[]. |
Cuadro 22: Métodos de SignalService.
Ejemplo de uso:
Descargue la clase SignalServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase SignalService.
ECMTokenService
WebService responsable de interactuar con los token’s de Fluig. Puede utilizarse para buscar y validar los token’s existentes.
Métodos
getToken |
Devuelve un token de seguridad.
Método: getToken(String login, String password)
Parámetros:
Devolución: String. |
getTokenByLogin |
Devuelve un token de seguridad para el login solicitado.
Método: getTokenByLogin(int companyId, String colleagueId, String password, String login)
Parámetros:
Devolución: String. |
getTokenEmail |
Devuelve un token de seguridad para el e-mail solicitado.
Método: getTokenEmail(int companyId, String email, String password)
Parámetros:
Devolución: String. |
validateToken |
Valida el token de seguridad y devuelve el login del usuario.
Método: validateToken(String token)
Parámetro:
Devolución: String. |
Cuadro 23: Métodos de TokenService.
Ejemplo de uso:
Descargue la clase TokenServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase TokenService.
ECMWorkflowEngineService
Webservice responsable de realizar operaciones referentes a workflow en Fluig. Puede ser utilizado para mover las peticiones, entre otras características.
Métodos
calculateDeadLineHours |
Calcula un plazo a partir de una fecha basada en el expediente y feriados registrados en el producto informando el plazo en horas.
Método: calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)
Parámetros:
Devolución: Objeto DeadLineDto que contiene variables con la fecha y la hora. |
calculateDeadLineTime |
Calcula un plazo a partir de una fecha basada en el expediente y feriados registrados en el producto informando el plazo en minutos.
Método: calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)
Parámetros:
Devolución: Objeto DeadLineDto que contiene variables con la fecha y la hora. |
cancelInstance |
Anula una solicitud.
Método: cancelInstance(String user, String password, int companyId, int processInstanceId, String userId, String cancelText)
Parámetros:
Devolución: String. |
cancelInstanceByReplacement |
Cancela una solicitud utilizando usuario sustituto.
Método: cancelInstanceByReplacement(String user, String password, int companyId, int processInstanceId, String userId, String cancelText, String replacementId)
Parámetros:
Devolución: String. |
createWorkFlowProcessVersion | Crea nueva versión del proceso workflow.
Método: createWorkFlowProcessVersion(String user, String password, int companyId, int processId)
Parámetros:
Devolución: String. |
exportProcess |
Devuelve el proceso seleccionado en una String.
Método: exportProcess (String username, String password, int companyId, String processId)
Parámetros:
Devolución: String que contiene la definición del proceso. |
exportProcessInZipFormat | Devuelve el proceso seleccionado en formato zip.
Método: exportProcessInZipFormat(String username, String password, int companyId, String processId)
Parámetros:
Devolución: byte[] que contiene la definición del proceso. |
getActualThread |
Devuelve la secuencia de la thread de una solicitud.
Método: getActualThread(String user, String password, int companyId, int processInstanceId, int stateSequence)
Parámetros:
Devolución: int. |
getAllActiveStates |
Devuelve el número de la actividad en la que una solicitud se encuentra.
Método: getAllActiveStates(String user, String password, int companyId, String userId, int processInstanceId)
Parámetros:
Devolución: Integer[]. |
getAllProcessAvailableToExport |
Devuelve una lista de procesos disponibles para ser exportados.
Método: getAllProcessAvailableToExport (String username, String password, int companyId)
Parámetros:
Devolución: ProcessDefinitionDto[]. |
getAllProcessAvailableToImport |
Devuelve una lista de procesos disponibles para ser importados.
Método: getAllProcessAvailableToImport (String username, String password, int companyId)
Parámetros:
Devolución: ProcessDefinitionDto[] |
getAttachments |
Devuelve los adjuntos de una solicitud.
Método: getAttachments(String user, String password, int companyId, String userId, int processInstanceId)
Parámetros:
Devolución: ProcessAttachmentDto[]. |
getAvailableProcess |
Devuelve los procesos en los que el usuario puede iniciar una solicitud.
Método: getAvailableProcess(String username, String password, int companyId, String userId)
Parámetros:
Devolución: ProcessDefinitionVersionDto[]. |
getAvailableProcessOnDemand |
Devuelve los procesos en los que el usuario puede iniciar una solicitud, paginados.
Método: getAvailableProcessOnDemand(String username, String password, int companyId, String userId, int limit, int lastRowId)
Parámetros:
Devolución: ProcessDefinitionVersionDto[]. |
getAvailableStates |
Devuelve el número de la próxima actividad de una solicitud.
Método: getAvailableStates(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)
Parámetros:
Devolución: Integer[]. |
getAvailableStatesDetail |
Devuelve detalles de las actividades disponibles para la selección..
Método: getAvailableStatesDetail(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)
Parámetros:
Devolución: ProcessStateDto[]. |
getAvailableUsers |
Devuelve los usuarios que pueden realizar la tarea corriente de una solicitud.
Método: getAvailableUsers(String username, String password, int companyId, int processInstanceId, int state, int threadSequence)
Parámetros:
Devolución: String. |
getAvailableUsersOnDemand |
Devuelve los usuarios que pueden realizar la tarea corriente de una solicitud, paginados y con búsqueda.
Método: getAvailableUsersOnDemand(String username, String password, int companyId, int processInstanceId, int state, int threadSequence, int limit, int initialUser, String userSearch)
Parámetros:
Devolución: AvailableUsersDto. |
getAvailableUsersStart |
Devuelve los usuarios disponibles en la apertura de una solicitud.
Método: getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence)
Parámetros:
Devolución: String. |
getAvailableUsersStartOnDemand |
Devuelve los usuarios disponibles en la apertura de una solicitud, paginados y con búsqueda.
Método: getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence, int limit, int initialUser, String userSearch)
Parámetros:
Devolución: AvailableUsersDto. |
getCardValue |
Devuelve el valor de un campo de la ficha.
Método: getCardValue(String user, String password, int companyId, int processInstanceId, String userId, String cardFieldName)
Parámetros:
Devolución: String. |
getHistories |
Devuelve una lista de historiales de un proceso.
Método: getHistories (String username, String password, int companyId)
Parámetros:
Devolución: ProcessHistoryDto[].
|
getInstanceCardData |
Devuelve el valor de los campos de la ficha de una solicitud.
Método: getInstanceCardData(String user, String password, int companyId, String userId, int processInstanceId)
Parámetros:
Devolución: String[][]. |
getProcessFormId | Devuelve el código del formulario vinculado al proceso.
Método: getProcessFormId(String user, String password, int companyId, String userId, int processId)
Parámetros:
Devolución: int. |
getWorkFlowProcessVersion | Devuelve la versión de un proceso.
Método: getWorkFlowProcessVersion(String user, String password, int companyId, int processId)
Parámetros:
Devolución: int. |
importProcess |
Importa procesos workflow.
Método: importProcess(String user, String password, int companyId, String processId, Attachment file, boolean newProcess, boolean overWrite, String colleagueId)
Parámetros:
Devolución: String. |
importProcessWithCard | Importa procesos workflow y formulario.
Método: importProcessWithCard(String user, String password, int companyId, String processId, Attachment[] processAttachs, boolean newProcess, boolean overWrite, String colleagueId, int parentDocId, String docDescription, String cardDescription, String datasetName, Attachment[] cardAttachs, CardEventDto[] customEvents, boolean update)
Parámetros:
Devolución: String. |
releaseProcess | Libera procesos workflow.
Método: releaseProcess(String user, String password, int companyId, String processId)
Parámetros:
Devolución: String. |
saveAndSendTask |
Mueve solicitud para próxima actividad.
Método: saveAndSendTask(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)
Parámetros:
Devolución: String[][]. |
saveAndSendTaskByReplacement |
Envía una solicitud para la próxima actividad, utilizando usuario sustituto.
Método: saveAndSendTaskByReplacement (String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence, String replacementId)
Parámetros:
Devolución: String[][]. |
saveAndSendTaskClassic |
Envía una solicitud para la próxima actividad y devuelve un array de objeto con llave y valor.
Método: saveAndSendTaskClassic(String user, String password, int companyId, int processInstanceId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode, int threadSequence)
Parámetros:
Devolución: KeyValueDto[]. |
searchProcess |
Busca procesos disponibles para inicio
Método: searchProcess(String user, String Password, int companyId, String colleagueId, String content, boolean favorite)
Parámetros
Devolución: ProcessDefinitionVersionDto[]
|
setAutomaticDecisionClassic |
Selecciona usuario(s) y avanza actividad automática.
Método: setAutomaticDecisionClassic(String user, String password, int companyId, int processInstanceId, int iTaskAutom, int iTask, int condition, String[] colleagueIds, String comments, String userId, boolean managerMode, int threadSequence)
Parámetros:
Devolución: KeyValueDto[] |
setDueDate |
Altera la fecha límite para realizar la tarea.
Método: setDueDate(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String newDueDate, int timeInSeconds)
Parámetros:
Devolución: String. |
setTasksComments |
Altera los comentarios de la tarea.
Método: setTasksComments(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String comments)
Parámetros:
Devolución: String. |
simpleStartProcess |
Inicia una solicitud simple.
Método: simpleStartProcess(String user, String password, int companyId, String processId, String comments, ProcessAttachmentDto[] attachments, String cardData[][])
Parámetros:
Devolución: String. |
startProcess |
Inicia una solicitud.
Método: startProcess(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, String[][] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode)
Parámetros:
Devolución: String[][]. |
startProcessClassic |
Inicia una solicitud y devuelve un array de objeto con llave y valor.
Método: startProcessClassic(String user, String password, int companyId, String processId, int choosedState, String[] colleagueIds, String comments, String userId, boolean completeTask, ProcessAttachmentDto[] attachments, KeyValueDto[] cardData, ProcessTaskAppointmentDto[] appointment, boolean managerMode)
Parámetros:
Devolución: String[][]. |
takeProcessTask |
Asume una tarea.
Método: takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence)
Parámetros:
Devolución: String. |
takeProcessTaskByReplacement |
Asume una tarea usando usuario sustituto.
Método: takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence, String replacementId)
Parámetros:
Devolución: String. |
updateWorkflowAttachment |
Actualiza un documento de tipo 7. Devuelve una string que contiene la descripción del éxito o fracaso de la operación. Método: updateWorkflowAttachment(String username, String password, int companyId, int processInstanceId, String usuario, DocumentDto[] docdtos, Attachment[] attach) Parámetros:
|
Cuadro 24: Métodos de WorkflowEngineService
Ejemplo de uso:
Descargue la clase WorkflowEngineServiceClient.java, ésta ejemplifica el uso de los principales métodos de la clase WorkflowEngineService.
ECMWorkflowRoleService
Webservice responsable por realizar operaciones referentes a papeles en Fluig. Puede utilizarse para crear, alterar, excluir y buscar papeles, entre otras funcionalidades.
Métodos
createWorkflowRole |
Crea un papel en Fluig.
Método: createWorkflowRole(String username, String password, int companyId, workflowRoleDto role)
Parámetros:
Devolución: String. |
deleteWorkflowRole |
Elimina un papel de Fluig.
Método: deleteWorkflowRole(String username, String password, int companyId, String roleId)
Parámetros:
Devolución: String. |
getWorkflowRole |
Devuelve un papel registrado en Fluig.
Método: getWorkflowRole(String username, String password, int companyId, String roleId)
Parámetros:
Devolución: WorkflowRoleDto.
Atributos de devolución:
|
getWorkflowRoles |
Devuelve todos los papeles registrados en Fluig.
Método: getWorkflowRoles(String username, String password, int companyId)
Parámetros:
Devolución: WorkflowRoleDto[].
Atributos de devolución:
|
updateWorkflowRole |
Actualiza un papel en Fluig.
Método: updateWorkflowRole(String username, String password, int companyId, workflowRoleDto role)
Parámetros:
Devolución: String. |
Cuadro 25: Métodos de WorkflowRoleService