Árvore de páginas

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

Versão 1 Próxima »

Índice.

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. 

Observación

Icon
Un facilitador fue creado para generar todos los stubs, solo hay que descargar el documento Cliente Web Service.zip. Solo hay que descomprimirlo y ejecutar el archivo "fluig-ws.sh", informando el nombre y el portal del servidor. Después de ejecutarlo, se generará el "fluig-ws-client.jar". Importe el .jar para acceder al servicio.

 


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.

Observación

Icon

Identificamos en algunos objetos los atributos de devolución de los métodos. Si no ha encontrado el objeto que busca, se puede realizar una búsqueda en los datasets para identificar los atributos.

 

Figura 1: Consulta de Dataset.



Figura 2: Resultado de la consulta del Dataset Colleague.


 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • parentDocumentId: número del formulario.
  • publisherId: código del autor.
  • documentDescription: descripción.
  • cardDescription: nombre.
  • attachments: archivo adjunto.
  • customEvents: eventos.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • parentDocumentId: número del formulario.
  • publisherId: código del autor.
  • documentDescription: descripción.
  • cardDescription: nombre.
  • datasetName: nombre del dataset.
  • attachments: archivo adjunto.
  • customEvents: eventos.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa;
  • parentDocumentId: número del formulario.
  • publisherId: código del autor.
  • documentDescription: descripción.
  • cardDescription: nombre.
  • datasetName: nombre del dataset.
  • attachments: archivo adjunto.
  • customEvents: eventos.
  • persistenceType: tipo de persistencia que será utilizado.

 

Devolución: WebServiceMessageArray [].

getActiveCardIndex

Devuelve el formulario activo.

 

Método:

getActiveCardIndex (String user, String password, int companyId, int documentId, String colleagueId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de formulario.
  • colleagueId: número de usuario.

 

Devolución: DocumentDtoArray [].

getAttachmentsList

Devuelve la lista de adjuntos del formulario.

 

Método:

getAttachmentsList (String user, String password, int companyId, int documentId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: numero del formulario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: numero del formulario.
  • colleagueId: matrícula del usuario para la verificación de permisos en los formularios.
  • version: número de la versión del formulario.
  • nombreArchivo: nombre del archivo adjunto.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario para la verificación de permisos en los formularios.

 

Devolución: DocumentDto[].

getCustomizationEvents

Devuelve los eventos del formulario.

 

Método:

getCustomizationEvents (String user, String password, int companyId, int documentId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de formulario.

 

Devolución: CardEventDtoArray [].

getFormFields

Devuelve los campos del formulario

 

Método:

getFormFields(String user, String password, int companyId, int documentId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de formulario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de formulario.
  • publisherId: código del autor.
  • cardDescription: nombre.
  • descriptionField: descripción.
  • attachments: archivo adjunto.
  • customEvents: eventos.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de formulario.
  • publisherId: código del autor.
  • cardDescription: nombre.
  • descriptionField: descripción.
  • datasetName: nombre del dataset.
  • attachments: archivo adjunto.
  • customEvents: eventos.

 

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:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • carddtos: formulario que se creará.

 

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:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • cardId: número del formulario.

 

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:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • nrDocumentId: número del formulario.
  • version: versión del formulario.
  • colleagueId: matrícula del usuario.

 

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:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • cardDtos: formulario que será alterado.
  • attachs: adjuntos del formulario.
  • docsecurity: seguridad del formulario.
  • docapprovers: aprobadores del formulario.
  • reldocs: documentos relacionados del formulario.

 

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:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • cardId: número del formulario.
  • cardData: campos del formulario que se alterarán.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa;
  • grupo_colaborador: grupo que estará asociado a un usuario.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • groupId: código del grupo.
  • colleagueId: matrícula del usuario.

 

Devolución: String.

getAllColleagueGroups

Devuelve todos los grupos que tienen usuarios relacionados.

 

Método:

getAllColleagueGroups(String username, String password, int companyId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • groupId: código del grupo.
  • colleagueId: matrícula del usuario.

 

Devolución: ColleagueGroupDto[].

 

Atributos de devolución:

  • colleagueId

  • companyId

  • groupId

getColleagueGroupsByColleagueId

Devuelte los grupos de los que un usuario participa.

 

Método:

getColleagueGroupsByColleagueId(String username, String password, int companyId, String colleagueId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

Devolución: ColleagueGroupDto[].

 

Atributos de devolución:

  • colleagueId

  • companyId

  • groupId

 getColleagueGroupsByGroupId

Devuelve los usuarios que participan de un grupo de usuarios.

 

Método:

getColleagueGroupsByGroupId(String username, String password, int companyId, String groupId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • groupId: código del grupo.

 

Devolución: ColleagueGroupDto[].

 

Atributos de devolución:

  • colleagueId

  • companyId

  • groupId

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • grupo_colaborador: grupo de usuarios que será alterado.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • crDto: registro del sustituto.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario origen.
  • replacementId: matrícula del usuario sustituto.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario origen.
  • replacementId: matrícula del usuario sustituto.

 

Devolución: ColleagueReplacementDto.

 getReplacementsOfUser

 

Resuelve todos los sustitutos de un usuario.

 

Método:

getReplacementsOfUser(String username, String password, int companyId, String colleagueId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario origen.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa;
  • replacementId: matrícula del usuario sustituto.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario origen.
  • replacementId: matrícula del usuario sustituto.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa;
  • colleagueId: matrícula del usuario origen.

 

Devolución: ColleagueReplacementDto[].

updateColleagueReplacement

Altera el registro de un sustituto.

 

Método:

updateColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • crDto: registro del usuario.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagues: usuarios.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagues: usuarios.
  • grupos: grupos.
  • papeles: papeles.

 

Devolución: String.

getColleague

Devuelve un usuario.

 

Método:

getColleague(String username, String password, int companyId, String colleagueId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

Devolución: ColleagueDto[].

 

Atributos de devolución:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

getColleagueByLogin 

Devuelve el usuario a partir del login.

Método:

getColleagueByLogin(String username, String password)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.

 

Devolución: ColleagueDto.

 

Atributos de devolución:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

getColleagues

Devuelve todos los usuarios activos.

 

Método:

getColleagues(String username, String password, int companyId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

Devolución: ColleagueDto[].

 

Atributos de devolución:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

getColleaguesMail

Devuelve un usuario utilizando un e-mail.

 

Método:

getColleaguesMail(String username, String password, int companyId, String mail)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • mail: e-mail del usuario.

 

Devolución: ColleagueDto[].

 

Atributos de devolución:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

  • volumeId

getColleagueWithMap

Devuelve un mensaje informando si el usuario fue creado correctamente.

 

Método:

getColleagueWithMap(String colleagueXML, String username, String password)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • colleagueXML: lista normalizada de documentos.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

Devolución: GroupDto[].

 

Atributos de devolución:

  • companyId 

  • groupDescription
  • groupId

getSimpleColleague

Devuelve el usuario.

 

Método:

getSimpleColleague(String username, String password)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.

 

Devolución: ColleagueDto.

 

Atributos de devolución:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

getSummaryColleagues

Devuelve todos los usuarios activos.

 

Método:

getSummaryColleagues(int companyId)

 

Parámetros:

  • companyId: código de la empresa.

 

Devolución: ColleagueDto[].

 

Atributos de devolución:

  • active 

  • colleagueId

  • colleagueName

  • companyId

  • maxPrivateSize

  • rowId

  • usedSpace

removeColleague

Desactiva un usuario.

 

Método:

removeColleague(String username, String password, int companyId, String colleagueId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

Devolución: String.

activateColleague

Activa un usuario.

 

Método:

activateColleague(String username, String password, int companyId, String colleagueId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

Devolución: String.

updateColleague

Altera un usuario.

 

Método:

updateColleague(String username, String password, int companyId, ColleagueDto[] colleagues)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagues: usuarios.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagues: usuarios.
  • grupos: grupos.
  • papeles: papeles.

 

Devolución: String.

validateColleagueLogin

Valida el acceso de un usuario en el producto.

 

Método:

validateColleagueLogin(int companyId, String colleagueId, String password)

 

Parámetros:

  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • password: contraseña del usuario.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • description: descripción de la empresa.
  • urlAccessName: URL de acceso.
  • phisicalPath: camino físico.
  • webdeskServer: servidor.
  • webPort: portal.

 

Devolución: String.

delete

Elimina una empresa de Fluig.

 

Método:

delete(String username, String password, String companyId, Boolean deleteFiles)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • deleteFiles: indica que se debe eliminar la ruta física.

 

Devolución: String.

getCompanies

Devuelve todas las empresas registradas en Fluig.

 

Método:

getCompanies(String username, String password, String companyId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

Devolución: CompanyDto[].

getCompany

Devuelve una empresa registrada en Fluig.

 

Método:

getCompany(int companyId)

 

Parámetros:

  • companyId: código de la empresa.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • description: descripción de la empresa.
  • urlAccessName: URL de acceso.
  • phisicalPath: camino físico.
  • webdeskServer: servidor.
  • webPort: portal.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • customFieldsDto: campo personalizado que se creará.

 

Devolución: String.

getAllCustomField

Devuelve todos los campos personalizados.

 

Método:

getAllCustomField(String user, String password, int companyId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número del documento.
  • version: versión del documento.

 

Devolución: DocumentCustomFieldsDto[].

removeCustomField

Excluye un campo personalizado.

 

Método:

removeCustomField(String user, String password, int companyId, String customFieldsId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • customFieldsId: código del campo personalizado.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • customFieldsId: código del campo personalizado.
  • documentId: número del documento.
  • version: versión del documento.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentCustomFieldsDto: documento con campo personalizado.

 

Devolución: String.

updateCustomFields

Altera un campo estandarizado.

 

Método:

updateCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • customFieldsDto: campo personalizado que se alterará.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.

 

Devolución: WorkflowProcessDto[].

findMyManagerTasks

Devuelve las tareas gestionadas por el usuario.

 

Método:

findMyManagerTasks(String user, String password, int companyId, String colleagueId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • yearIni: año inicial.
  • yearFin: año final.
  • mounthIni: mes inicial.
  • mounthFin: mes final.
  • dayIni: día inicial.
  • dayFin: día final.
  • kindTask: tipo de tarea.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • replacementId: matrícula del usuario sustituto.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.

 

Devolución: WorkflowTaskDto[].

getSummaryRequests

Devuelve los contadores de pendencias de Home.

 

Método:

getSummaryRequests(int companyId, String user, String password, String colleagueId)

 

Parámetros:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • colleagueId: matrícula del usuario.

 

Devolución: HomeRequestSummaryDto[].

getUrlEcm

Devuelve la url del servidor

 

Método:

getUrlEcm(long companyId)

 

Parámetros:

  • companyId: código de la empresa.

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:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • dataServiceDto: servicio externo que se creará.

 

Devolución: String.

deleteDataService 

Elimina un servicio externo.

 

Método:

deleteDataService(int companyId, String user, String password, String dataServiceName)

 

Parámetros:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • dataServiceName: nombre del servicio externo que se eliminará.

Devolución: void.

getAllServices

Devuelve todos los servicios externos registrados.

 

Método:

getAllServices(int companyId, String user, String password)

 

Parámetros:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.

 

Devolución: dataServiceDto[].

loadDataService

Regresa un servicio externo.

 

Método:

loadDataService(int companyId, String user, String password, String dataServiceName)

 

Parámetros:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • dataServiceName: nombre del servicio externo.

 

Devolución: dataServiceDto.

updateDataService

Actualiza un servicio externo.

 

Método:

createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)

 

Parámetros:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • dataServiceDto: servicio externo que se actualizará.

 

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:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • datasetName: nombre del dataset que se creará.
  • description: descripción del dataset.
  • impl: implementación para la creación del dataset.

 

Devolución: String.

deleteDataset

Elimina un dataset

 

Método:

deleteDataset(int companyId, String user, String password, String datasetName)

 

Parámetros:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • datasetName: nombre del dataset que se eliminará.

 

Devolución: void.

getAvailableDatasets

Devuelve todos los datasets disponibles.

 

Método:

getAvailableDatasets(int companyId, String user, String password)

 

Parámetros:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.

 

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:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • name: nombre del dataset.
  • fields: campos que se devolverán del dataset.
  • constraintsDto: filtro de los registros que compondrán el dataset.
  • order: campos utilizados para ordenar el dataset.

 

Devolución: DatasetDto.

updateDataset

Actualiza un dataset.

 

Método:

updateDataset(int companyId, String user, String password, String datasetName, String description, String impl)

 

Parámetros:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • datasetName: nombre del dataset que se actualizará.
  • description: descripción del dataset.
  • impl: implementación del dataset.

 

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:

 

  • user: código del usuario de integración.
  • password: contraseña del usuario de integración.
  • companyId: código de la empresa.
  • documentId: código del documento que será aprobado.
  • version: versión del documento que será aprobado.
  • approverId: código del aprobador
  • approved: true si aprueba el documento y false si el documento sera reprobado.
  • observation: observación de aprobación o rechazo.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número del documento que se copiará.
  • version: versión del documento.
  • colleagueId: matrícula del usuario cuya área de upload se utilizará

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • docDtos: documento que será publicado.
  • attachs: archivo adjunto en la publicación.
  • docSecurity: seguridad del documento que será publicado.
  • docApprovers: aprobadores del documento a publicarse.
  • relDocs: documentos relativos al documento que se publicará.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • docDtos: documento que será publicado.
  • attachs: archivo adjunto en la publicación.
  • docSecurity: seguridad del documento que será publicado.
  • docApproversLevel: nivel de aprobación en el que los aprobadores del documento se encuentran.
  • niveles: niveles de aprobación que tendrá el documento.
  • relDocs: documentos relativos al documento que se publicará.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • parentDocumentId: número de la carpeta principal.
  • publisherId: matrícula del usuario que publicará el documento.
  • documentDescription: descripción del documento.
  • attachnents: archivo adjunto en la publicación.

 

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:

  • colleagueId: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • parentDocumentId: número de la carpeta principal.
  • documentDescription: descripción del documento.
  • attachnents: archivo adjunto en la publicación.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número del documento que se excluirá.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número del documento que se excluirá.
  • colleagueId: matrícula del usuario.

 

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:

 

  • user: código del usuario de integración.
  • password: contraseña del usuario de integración.
  • companyId: código de la empresa.
  • documentId: código del documento que será excluido.
  • publisherId: código del publicador.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • nr_resultados: cantidad de documentos que se devolverán.

 

Devolución: DocumentDto[].

 

Atributos de devolución:

  • accesCount
  • activeVersion
  • additionalComments
  • allowMuiltiCardsPerUser
  • approved
  • colleagueId
  • companyId
  • crc
  • createDate
  • datasetName
  • deleted
  • documentDescription
  • documentId
  • documentType
  • documentTypeId
  • downloadEnabled
  • draft
  • expirationDate
  • expires
  • iconId
  • imutable
  • indexed
  • inheritSecurity
  • isEncrypted
  • keyWord
  • lastModifiedDate
  • metaListId
  • metaListRecordId
  • parentDocumentId
  • permissionType
  • phisicalFile
  • phisicalFileSize
  • privateDocument
  • protectedCopy
  • publisherId
  • restrictionType
  • rowId
  • securityLevel
  • topicId
  • translated
  • UUID
  • updateIsoProperties
  • userNotify
  • validationStartDate
  • version
  • versionDescription
  • volumeId

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:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • colleagueId: matrícula del usuario.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.

 

Devolución: DocumentDto[].

 

Atributos de devolución:

  • accesCount
  • activeVersion
  • additionalComments
  • allowMuiltiCardsPerUser
  • approved
  • colleagueId
  • companyId
  • crc
  • createDate
  • datasetName
  • deleted
  • documentDescription
  • documentId
  • documentType
  • documentTypeId
  • downloadEnabled
  • draft
  • expirationDate
  • expires
  • iconId
  • imutable
  • indexed
  • inheritSecurity
  • isEncrypted
  • keyWord
  • lastModifiedDate
  • metaListId
  • metaListRecordId
  • parentDocumentId
  • permissionType
  • phisicalFile
  • phisicalFileSize
  • privateDocument
  • protectedCopy
  • publisherId
  • restrictionType
  • rowId
  • securityLevel
  • topicId
  • translated
  • UUID
  • updateIsoProperties
  • userNotify
  • validationStartDate
  • version
  • versionDescription
  • volumeId

findRecycledDocuments

Devuelve los documentos de la papelera de reciclaje.

 

Método:

findRecycledDocuments(String user, String password, int companyId, String colleagueId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

Devolución: DocumentDto[].

 

Atributos de devolución:

  • accesCount
  • activeVersion
  • additionalComments
  • allowMuiltiCardsPerUser
  • approved
  • colleagueId
  • companyId
  • crc
  • createDate
  • datasetName
  • deleted
  • documentDescription
  • documentId
  • documentType
  • documentTypeId
  • downloadEnabled
  • draft
  • expirationDate
  • expires
  • iconId
  • imutable
  • indexed
  • inheritSecurity
  • isEncrypted
  • keyWord
  • lastModifiedDate
  • metaListId
  • metaListRecordId
  • parentDocumentId
  • permissionType
  • phisicalFile
  • phisicalFileSize
  • privateDocument
  • protectedCopy
  • publisherId
  • restrictionType
  • rowId
  • securityLevel
  • topicId
  • translated
  • UUID
  • updateIsoProperties
  • userNotify
  • validationStartDate
  • version
  • versionDescription
  • volumeId

getActiveDocument

Devuelve un documento activo.

 

Método:

getActiveDocument(String user, String password, int companyId, int nrDocumentId, String colleagueId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocumentId: número del documento.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocumentId: número del documento.
  • version: número de la versión del documento.

 

Devolución: ApproverWithLevelDto[].

 

Atributos de devolución:

  • approverType
  • colleagueId
  • companyId
  • documentId
  • levelId
  • version

getDocumentApprovalHistory

Devuelve el historial de aprobaciones del documento solicitado.

 

Método:

getDocumentApprovalHistory(String user, String password, int companyId, int documentId, int version)

 

Parámetros:

  • user: código del usuario de integración.
  • password: contraseña del usuario de integración.
  • companyId: código de la empresa.
  • documentId: código del documento del que se desea ver el estado.
  • versión: versión del documento (si se informa la versión 0, se solicitará la última versión del documento).

 

Devolución: DocumentApprovementHistoryDto[]

 

Atributos de devolución:

  • colleagueId
  • documentVersion
  • iterationSequence
  • levelId
  • movementSequence
  • observation
  • signed
  • status

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:

 

  • user: código del usuario de integración.
  • password: contraseña del usuario de integración.
  • companyId: código de la empresa.
  • documentId: código del documento del que se desea ver el estado.
  • versión: versión del documento (si se informa la versión 0, se solicitará la última versión del documento).

 

Devolución: DocumentApprovalStatusDto[]

 

Atributos de devolución:

  • companyId
  • documentId
  • status
  • version

getDocumentByExternalId

Devuelve un documento por el código externo.

 

Método:

getDocumentByExternalId(String user, String password, int companyId, String externalDocumentId, String colleagueId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • externalDocumentId: código externo del documento.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocumentId: número del documento.
  • colleagueId: matrícula del usuario.
  • documentVersao: número de la versión del documento.
  • nombreArchivo: nombre del archivo.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocumentId: número del documento.
  • version: número de la versión del documento.
  • colleagueId: matrícula del usuario.

 

Devolución: DocumentDto[].

 

Atributos de devolución:

  • accesCount
  • activeVersion
  • additionalComments
  • allowMuiltiCardsPerUser
  • approved
  • colleagueId
  • companyId
  • crc
  • createDate
  • datasetName
  • deleted
  • documentDescription
  • documentId
  • documentType
  • documentTypeId
  • downloadEnabled
  • draft
  • expirationDate
  • expires
  • iconId
  • imutable
  • indexed
  • inheritSecurity
  • isEncrypted
  • keyWord
  • lastModifiedDate
  • metaListId
  • metaListRecordId
  • parentDocumentId
  • permissionType
  • phisicalFile
  • phisicalFileSize
  • privateDocument
  • protectedCopy
  • publisherId
  • restrictionType
  • rowId
  • securityLevel
  • topicId
  • translated
  • UUID
  • updateIsoProperties
  • userNotify
  • validationStartDate
  • version
  • versionDescription
  • volumeId

getRelatedDocuments

Devuelve todos los documentos relacionados de un documento.

 

Método:

getRelatedDocuments(String user, String password, int companyId, int nrDocumentId, int version)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocumentId: número del documento.
  • version: número de la versión del documento.

 

Devolución: RelatedDocumentDto[].

 

Atributos de devolución:

  • companyId
  • documentId
  • relatedDocumentId
  • version

getReportSubjectId

Devuelve el código del asunto de informes dentro de Fluig.

 

Método:

getReportSubjectId(String user, String password, int companyId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocumentId: número del documento.
  • version: número de la versión del documento.

 

Devolución: DocumentSecurityConfigDto[].

 

Atributos de devolución:

  • attributionType
  • attributionValue
  • companyId
  • documentId
  • permission
  • securityLevel
  • sequence
  • showContent
  • version

getUserPermissions

Devuelve los permisos del usuario sobre un documento.

 

Método:

getUserPermissions(int companyId, String user, int nrDocumentId, int version)

 

Parámetros:

  • companyId: código de la empresa.
  • user: login del usuario.
  • nrDocumentId: número del documento.
  • version: número de la versión del documento.

 

Devolución: Integer.

 

Atributos de devolución:

  • result

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentIds: lista con los números de los documentos que se moverán.
  • colleagueId: matrícula de usuario con permiso para mover el documento
  • destFolder: número de la carpeta de destino.

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número del documento.
  • version: número de la versión del documento.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número del documento que se restaurará.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • docDtos: documento que será alterado.
  • attachs: archivo adjunto en la alteración.
  • docSecurity: seguridad del documento que será alterado.
  • docApprovers: aprobadores del documento que se alterará.
  • relDocs: documentos relativos al documento que se alterará.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • docDtos: documento que será alterado.
  • attachs: archivo adjunto en la alteración.
  • docSecurity: seguridad del documento que será alterado.
  • docApproversLevel: nivel de aprobación en el que los aprobadores del documento se encuentran.
  • niveles: niveles de aprobación que tendrá el documento.
  • relDocs: documentos relativos al documento que se alterará.

 

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:

  • user: código del usuario de integración.
  • password: contraseña del usuario de integración.
  • companyId: código de la empresa.
  • documentId: código del documento.
  • version: versión del documento.
  • permissionType: tipo de permiso (0 - TODOS los usuarios de los Grupos / 1 - SOLAMENTE usuarios comunes de los grupos)
  • restrictionType: tipo de restricción (0 - TODOS los usuarios de los Grupos / 1 - SOLAMENTE usuarios comunes de los grupos)
  • colleagueId: matrícula del usuario.

 

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:

  • username: login del usuario de integración.
  • password: contraseña del usuario de integración.
  • companyId: código de la empresa.
  • documentId: número del documento que se alterará.
  • publisherId: matrícula del usuario que realizará la alteración del documento.
  • documentDescription: descripción del documento.
  • attachments: archivos adjuntados en el cambio.

 

Devolución: WebServiceMessage[].

validateIntegrationRequirements

Verifica la integración del usuario en Fluig.

 

Método:

validateIntegrationRequirements (String user, String password, int companyId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

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.

Nota

Icon
Algunos campos, como ser Approved, ApprovedDate, CreateDate, LastModifiedDate, a pesar de aparecer en el ejemplo dado, no pueden modificarse, ya que se trata de campos de uso interno del sistema.
Los campos se mantienen en el objeto del Documento porque son necesarios para el rescate de esta información.

Integraciones

Icon

Para los métodos de creación de documentos (createDocument, createSimpleDocument, etc...), se puede utilizar un usuario para la autenticación y otro para su publicación, ya que puede ser necesario validar el permiso de otro usuario en el momento de crear el documento en Fluig.

En este caso, cuando el archivo a ser publicado no se envía en la solicitud (campo filecontent del parámetro Attachment), se lo podrá obtener en la carpeta de upload del usuario publicador, o del usuario utilizado para autenticar en Fluig vía WS. Para ello, el documento debe estar en la carpeta de upload del usuario en cuestión, lo cual puede realizarse a través de FTP. Esto puede ser útil en integraciones que utilizan el mismo usuario (integrador) para autenticar en el FTP y en los servicios.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocument: número del documento
  • nrVersao: versión del documento
  • colleagueId : matrícula del usuario.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso
  • colleagueId : matrícula del usuario.
Devolución: void.

findFavorites

Devuelve los documentos favoritos del usuario.

 

Método:

findFavorites(String user, String password, int companyId, String colleagueId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId : matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId : matrícula del usuario.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.

 

Devolución: DocumentDto[].

findFavoritesProcess

Devuelve los procesos favoritos del usuario.

 

Método:

findFavoritesProcess (String user, String password, int companyId, String colleagueId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId : matrícula del usuario.

 

Devolución: ProcessDefinitionVersionDto[] .

findFavoritesProcessOnDemand

Devuelve los procesos favoritos del usuario, paginados.

 

Método:

findFavoritesProcess (String user, String password, int companyId, String colleagueId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId : matrícula del usuario.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.

 

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:

  • username: login del usuario de integración.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocument: código del documento.
  • colleagueId: matrícula del usuario.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocument: número del documento
  • colleagueId : matrícula del usuario.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.
  • colleagueId : matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • docdtos: carpeta que se creará.
  • docsecurity: seguridad de la carpeta.
  • docapprovers: aprobadores de la carpeta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • docdtos: carpeta que se creará.
  • docsecurity: seguridad de la carpeta.
  • docapprovers: aprobadores en niveles.
  • levels: niveles de aprobación de la carpeta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • parentDocumentId: número del documento principal.
  • publisherId: matrícula del usuario publicador.
  • documentDescription: descripción de la carpeta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de la carpeta.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de la carpeta.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

Devolución: DocumentDto[].

getApprovers

Devuelve los aprobadores de una carpeta.

 

Método:

getApprovers(String user, String password, int companyId, int nrDocumentId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocumentId: número de la carpeta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de la carpeta.
  • colleagueId: matrícula del usuario.

 

Devolución: DocumentDto[].

getFolder

Devuelve una carpeta.

 

Método:

getFolder(String user, String password, int companyId, int nrDocumentId, String colleagueId )

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocumentId: número de la carpeta.
  • colleagueId: matrícula del usuario origen.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de la carpeta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.

 

Devolución: DocumentDto[].

getSecurity

Devuelve la seguridad de una carpeta.

 

Método:

getSecurity(String user, String password, int companyId, int nrDocumentId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocumentId: número de la carpeta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de la carpeta.
  • colleagueId: matrícula del usuario.

 

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:

  • companyId: código de la empresa.
  • user: login del usuario.
  • password: contraseña del usuario.
  • documentId: número de la carpeta.
  • privatefolder: identifica si es una carpeta en particular.
  • documenttypes: tipos de documentos de las carpetas.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.
  • colleagueId: matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de la carpeta en particular.
  • colleagueId: matrícula del usuario.
  • permission: permiso sobre la carpeta.

 

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:

  • colleagueId: matrícula del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de la carpeta en particular.

 

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:

  • companyId: código de la empresa.
  • user: matrícula del usuario.
  • nrDocumentId: número de la carpeta.
  • version: versión de la carpeta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: número de la carpeta.
  • colleagueId: matrícula del usuario.

 

Devolución: WebServiceMessage[].

updateFolder

Altera una carpeta.

 

Método:

updateFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • docdtos: carpeta que se alterará.
  • docsecurity: seguridad de la carpeta.
  • docapprovers: aprobadores de la carpeta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • docdtos: carpeta que se alterará.
  • docsecurity: seguridad de la carpeta.
  • docapprovers: aprobadores en niveles.
  • levels: niveles de aprobación de la carpeta.

 

Devolución: WebServiceMessage[].

updateSimpleFolder

Cambia de manera simple una carpeta.

 

Método:

updateSimpleFolder(String user, String Password, int companyId, DocumentDto[] docdtos)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • docdtos: carpeta que se alterará.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • global: parámetros generales de la empresa.

 

Devolución: String.

getGlobalParam

Devuelve los parámetros generales de una empresa.

 

Método:

getGlobalParam(String username, String password, int companyId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

Devolución: GlobalParamDto[].

getVolumes

Devuelve los volúmenes de la empresa.

 

Método:

getVolumes(String user, String password, int companyId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

Devolución: VolumeDto[].

updateConfigurations

Altera las configuraciones del sistema.

 

Método:
updateConfigurations( String username,String password, int companyId, String dbDriver, String dbUser, String dbPassword, String dbServer,
String dbPort,String dbScheme, String dbInstance, String emailServer, String emailPort, String emailSender, boolean emailDefaultSender, String emailUser, String emailPassword, boolean emailTLS,String paramsRMTPTPort, String lsType, String paramsLSHost, String paramsLSPort, String paramsOpenOfficeDir, String paramsOpenOfficePorts, String portsSetName)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • dbDriver: driver del banco de datos (MySql- com.mysql.jdbc.Driver. SQLServer - net.sourceforge.jtds.jdbc.Driver. Oracle -oracle.jdbc.driver.OracleDriver)
  • dbUser: username banco de datos.
  • dbPassword: password banco de datos.
  • dbServer: servidor de conexión del banco de datos.
  • dbPort: portal servidor banco de datos.
  • dbScheme: database.
  • dbInstance: instancia del banco, utilizada para SQLServer, de no ser el caso, pasar en blanco ("").
  • mailServer: nombre del servidor SMTP.
  • emailSender: e-mail del remitente estándar del producto.
  • emailPort: portal del servidor SMTP.
  • emailDefaultSender:
  • emailUser: usuario de e-mail, sólo si el servidor requiere autenticación.
  • emailPassword: password del email, sólo si el servidor requiere autenticación.
  • emailTLS: el servidor utilizará criptografía al enviar el email (true/false)
  • paramsRMTPTPort: portal utilizado por Flex.
  • lsType: tipo de licencia utilizada, LM/LS.
  • paramsLSHost: servidor de licencias.
  • paramsLSPort: portal servidor de licencias.
  • paramsOpenOfficeDir: directorio de instalación del OpenOffice
  • paramsOpenOfficePorts: portal utilizado por OpenOffice
  • portsSetName: portal utilizado por el sistema (ports-default, ports-01, ports-02)

 

Devolución: String.

updateGlobalParam

Altera parámetros generales de una empresa.

 

Método:

updateGlobalParam(String username, String password, int companyId, GlobalParamDto[] global)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • global: parámetros generales de la empresa.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • grupos: grupo que será creado.

 

Devolución: String.

deleteGroup

Elimina un grupo de Fluig.

 

Método:

deleteGroup(String username, String password, int companyId, String groupId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • groupId: código del grupo.

 

Devolución: String.

getGroup

Devuelve un grupo registrado en Fluig.

 

Método:

getGroups(String username, String password, int companyId, String groupId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • groupId: código del grupo.

 

Devolución: GroupDto[].

 

Atributos de devolución:

  • companyId

  • groupDescription

  • groupId

getGroups

Devuelve todos los grupos registrados en Fluig.

 

Método:

getGroups(String username, String password, int companyId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

Devolución: GroupDto[].

 

Atributos de devolución:

  • companyId

  • groupDescription

  • groupId

getGroupsByDescription

Devuelve un grupo por la descripción.

 

Método:

getGroupsByDescription(String username, String password, int companyId, String desc)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • desc: descripción del grupo.

 

Devolución: GroupDto[].

 

Atributos de devolución:

  • companyId

  • groupDescription

  • groupId

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • pIdiAtribuic: código de la asignación.
  • pDesValAtribuic: valor de la asignación.

 

Devolución: boolean.

updateGroup

Altera un grupo en Fluig.

 

Método:

updateGroup(String username, String password, int companyId, GroupDto[] grupos)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • grupos: grupo que será alterado.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueIdFrom: matrícula del usuario origen (sus pendencias serán transferidas al usuario destino).
  • colleagueIdTo: matrícula del usuario destino (recibirá las pendencias del usuario origen).
  • parameters: array de pendencias que serán transferidas al usuario destino.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • parentDocId: código de la carpeta principal.
  • reportDescription: descripción del informe.
  • attachments: adjuntos del informe.

 

Devolución: WebServiceMessage[].

getActiveReport

Devuelve un informe activo en Fluig.

 

Método:

getActiveReport(int companyId, String username, String password, String documentId)

 

Parámetros:

  • companyId: código de la empresa.
  • username: login del usuario.
  • password: contraseña del usuario.
  • documentId: código del documento.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • documentId: código del documento.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • nrDocumentId: número del documento.
  • colleagueId: matrícula del usuario.
  • documentoVersao: versión del documento.
  • fileName: nombre del archivo.

 

Retorno: byte[].

getRepots

Devuelve los informes disponibles.

 

Método:

getRepots(String username, String password, int companyId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • docId: código de la carpeta principal.
  • reportDescription: descripción del informe.
  • attachments: adjuntos del informe.
  • versionOption: informa si desea actualizar la versión del informe.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • content: contenido de la búsqueda.
  • findAllDocumentTypes: indica si debe buscar todos los tipos de documentos.
  • findFolders: indica si debe buscar carpetas.
  • findDocuments: indica si debe buscar documentos.
  • findCardIndex: indica si debe buscar ficheros.
  • findCards: indica si debe buscar fichas.
  • findExternalDocument: indica que se deben buscar documentos externos.
  • documentParentId: número del documento principal.
  • startDate: fecha inicial.
  • finalDate: fecha final.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • content: contenido de la búsqueda.
  • metadatos: información para buscar a partir de metadatos.
  • customfields: información para la búsqueda a partir de campos personalizados.
  • findAllDocumentTypes: indica si debe buscar todos los tipos de documentos.
  • findFolders: indica si debe buscar carpetas.
  • findDocuments: indica si debe buscar documentos.
  • findCardIndex: indica si debe buscar ficheros.
  • findCards: indica si debe buscar fichas.
  • findExternalDocument: indica que se deben buscar documentos externos.
  • documentParentId: número del documento principal.
  • startDate: fecha inicial.
  • finalDate: fecha final.

 

Devolución: SearchResultDto[].

searchDocuments

Utiliza búsqueda simple.

 

Método:

searchDocuments(String user, String password, int companyId, String colleagueId, String content)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • content: contenido de la búsqueda.

 

Devolución: SearchResultDto[].

searchFavoritesDocuments

Búsqueda de documentos favoritos.

 

Método:

searchFavoritesDocuments(String user, String Password, int companyId, String colleagueId, String content)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • content: contenido a ser buscado

 

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:

  • login: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • description: descripción de la señal.

 

Devolución: String.

deleteSignal

Elimina una señal creada en Fluig.

 

Método:

deleteSignal(String login, String password, int companyId, int signalId)

 

Parámetros:

  • login: login del usuario que se generará por el token.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • signalId: código de la señal.

 

Devolución: String.

fireSignal

Envía/Dispara la señal existente.

 

Método:

fireSignal (String login, String password, int companyId, int signalId)

 

Parámetros:

  • login: login del usuario que se generará por el token.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • signalId: código de la señal.

 

Devolución: String.

getSignals

Devuelve las señales existentes en Fluig.

 

Método:

getSignals(String login, String password, int companyId)

 

Parámetro:

  • login: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

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:

  • login: login del usuario.
  • password: contraseña del usuario.

 

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:

  • companyId: código de la empresa.
  • colleagueId: matrícula del usuario.
  • password: contraseña del usuario.
  • login: login del usuario que se generará por el token.

 

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:

  • companyId: código de la empresa.
  • e-mail: e-mail del usuario.
  • password: contraseña del usuario.

 

Devolución: String.

validateToken

Valida el token de seguridad y devuelve el login del usuario.

 

Método:

validateToken(String token)

 

Parámetro:

  • token: token del usuario.

 

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:

  • username - Usuario de Integración
  • password - contraseña de integración
  • companyId - Código de la empresa
  • userId - Matrícula del usuario
  • fecha - fecha (Tipo String en formato "yyyy-MM-dd").
  • segundos - Cantidad de segundos después de la medianoche
  • plazo - Plazo que será aplicado en horas (Variable int).
  • periodId - Código de Expediente

 

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:

  • username - Usuario de Integración
  • password - contraseña de integración
  • companyId - Código de la empresa
  • userId - Matrícula del usuario
  • fecha - fecha (Tipo String en formato "yyyy-MM-dd").
  • segundos - Cantidad de segundos después de la medianoche
  • plazo - Plazo que será aplicado en minutos (Variable int).
  • periodId - Código de Expediente

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • userId: matrícula del usuario.
  • cancelText: comentarios de la cancelación.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • userId: matrícula del usuario.
  • cancelText: comentarios de la cancelación.
  • replacementId: matrícula del usuario sustituto.

 

Devolución: String.

createWorkFlowProcessVersion

Crea nueva versión del proceso workflow.

 

Método:

createWorkFlowProcessVersion(String user, String password, int companyId, int processId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: número de la solicitud.

 

Devolución: String.

exportProcess

Devuelve el proceso seleccionado en una String.

 

Método:

exportProcess (String username, String password, int companyId, String processId)

 

Parámetros:

  • username - Usuario de Integración
  • password - contraseña de integración
  • companyId - Código de la empresa
  • processId - Código del proceso.

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:

  • username - Usuario de Integración
  • password - contraseña de integración
  • companyId - Código de la empresa
  • processId - Código del proceso.

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • userId: matrícula del usuario.
  • stateSequence: secuencia del estado.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • userId: matrícula del usuario.
  • processInstanceId: número de la solicitud.

 

Devolución: Integer[].

getAllProcessAvailableToExport

Devuelve una lista de procesos disponibles para ser exportados.

 

Método:

getAllProcessAvailableToExport (String username, String password, int companyId)

 

Parámetros:

  • username - Usuario de Integración
  • password - contraseña de integración
  • companyId - Código de la empresa

 

Devolución: ProcessDefinitionDto[].

getAllProcessAvailableToImport

Devuelve una lista de procesos disponibles para ser importados.

 

Método:

getAllProcessAvailableToImport (String username, String password, int companyId)

 

Parámetros:

  • username - Usuario de Integración
  • password - contraseña de integración
  • companyId - Código de la empresa

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • userId: matrícula del usuario.
  • processInstanceId: número de la solicitud.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • userId: matrícula del usuario.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • userId: matrícula del usuario.
  • limit: número de registros que deben devolverse.
  • lastRowId: última línea devuelta.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.
  • processInstanceId: número de la solicitud.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.
  • processInstanceId: número de la solicitud.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • state: número de la actividad.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • state: número de la actividad.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.
  • limit: número de registros que deben devolverse.
  • initialUser: última línea devuelta.
  • userSearch: texto a ser buscado.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.
  • state: número de la actividad.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.
  • state: número de la actividad.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.
  • limit: número de registros que deben devolverse.
  • initialUser: última línea devuelta.
  • userSearch: texto a ser buscado.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • userId: matrícula del usuario.
  • cardFieldName: nombre del campo de la ficha.

 

Devolución: String.

getHistories

Devuelve una lista de historiales de un proceso.

 

Método:

getHistories (String username, String password, int companyId)

 

Parámetros:

  • username - Usuario de Integración
  • password - contraseña de integración
  • companyId - Código de la empresa
  • userId - Matrícula del usuario
  • processInstanceId - número de la solicitud workflow

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • userId: matrícula del usuario.
  • processInstanceId: número de la solicitud.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • userId: matrícula del usuario.
  • processId: número de la solicitud.

 

Devolución: int.

getWorkFlowProcessVersion

Devuelve la versión de un proceso.

 

Método:

getWorkFlowProcessVersion(String user, String password, int companyId, int processId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: número de la solicitud.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.
  • file: archivo a ser importado.
  • newProcess: indica si debe crearse un proceso o se debe actualizar el existente.
  • overWrite: indica si se deben sobrescribir las actividades y flujos del proceso existente.
  • colleagueId : matrícula del usuario.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.
  • processAttachs: adjuntos del proceso.
  • newProcess: indica si debe crearse un proceso o se debe actualizar el existente.
  • overWrite: indica si se deben sobrescribir las actividades y flujos del proceso existente.
  • colleagueId : matrícula del usuario.
  • parentDocId: número del formulario.
  • docDescription: descripción.
  • cardDescription: nombre.
  • datasetName: nombre del dataset.
  • cardAttachs: archivo adjunto.
  • customEvents: eventos.
  • update: de ser verdadero ('true'), informa que será una actualización.

Devolución: String.

releaseProcess

Libera procesos workflow.

 

Método:

releaseProcess(String user, String password, int companyId, String processId)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • choosedState: número de la actividad.
  • colleagueIds: usuario que recibirá la tarea.
  • comments: comentarios.
  • userId: matrícula del usuario que ejecutará la tarea.
  • completeTask: indica si debe completar la tarea (true) o solamente guardar (false).
  • attachments: adjuntos de la solicitud.
  • cardData: datos de la ficha.
  • appointment: anotaciones de la tarea.
  • managerMode: indica si el usuario está ejecutando la tarea como gestor del proceso.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • choosedState: número de la actividad.
  • colleagueIds: usuario que recibirá la tarea.
  • comments: comentarios.
  • userId: matrícula del usuario que ejecutará la tarea.
  • completeTask: indica si debe completar la tarea (true) o solamente guardar (false).
  • attachments: adjuntos de la solicitud.
  • cardData: datos de la ficha.
  • appointment: anotaciones de la tarea.
  • managerMode: indica si el usuario está ejecutando la tarea como gestor del proceso.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.
  • replacementId: matrícula del usuario sustituto.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • choosedState: número de la actividad.
  • colleagueIds: usuario que recibirá la tarea.
  • comments: comentarios.
  • userId: matrícula del usuario que ejecutará la tarea.
  • completeTask: indica si debe completar la tarea (true) o solamente guardar (false).
  • attachments: adjuntos de la solicitud.
  • cardData: datos de la ficha.
  • appointment: anotaciones de la tarea.
  • managerMode: indica si el usuario está ejecutando la tarea como gestor del proceso.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.

 

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

 

  • user - Usuario de integración
  • password - contraseña de integración
  • companyId - Código de la empresa
  • colleagueId - Matrícula del usuario
  • content – nombre del proceso a ser estudiado
  • favorite – búsqueda de la lista de procesos favoritos o del listado estándar.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • iTaskAutom: número de la actividad automática.
  • iTask: número de la actividad actual.
  • condition: número de la condición de la actividad automática.
  • colleagueIds: usuario que recibirá la tarea.
  • comments: comentarios.
  • userId: matrícula del usuario que ejecutará la tarea.
  • managerMode: indica si el usuario está ejecutando la tarea como gestor del proceso.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • userId: matrícula del usuario. Cuando es para un grupo o un papel, se lo debe pasar de la siguiente forma:
    Papel: "Pool:Role:CodigoDoPapel";
    Grupo: "Pool:Group:CodigoDoGrupo".
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.
  • newDueDate: nueva fecha de plazo de la tarea. Ejemplo: "2014-08-20".
  • timeInSeconds: cantidad de segundos después de media noche. Ejemplo: "32000".

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud.
  • userId: matrícula del usuario.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.
  • comments: comentarios.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.
  • comments: comentarios.
  • attachments: adjuntos de la solicitud.
  • cardData: datos de la ficha.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.
  • choosedState: número de la actividad.
  • colleagueIds: usuario que recibirá la tarea.
  • comments: comentarios.
  • userId: matrícula del usuario que iniciará la solicitud.
  • completeTask: indica si debe completar la tarea (true) o solamente guardar (false).
  • attachments: adjuntos de la solicitud.
  • cardData: datos de la ficha.
  • appointment: anotaciones de la tarea.
  • managerMode: indica si el usuario está iniciando la solicitud como gestor del proceso.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processId: código del proceso.
  • choosedState: número de la actividad.
  • colleagueIds: usuario que recibirá la tarea.
  • comments: comentarios.
  • userId: matrícula del usuario que iniciará la solicitud.
  • completeTask: indica si debe completar la tarea (true) o solamente guardar (false).
  • attachments: adjuntos de la solicitud.
  • cardData: datos de la ficha.
  • appointment: anotaciones de la tarea.
  • managerMode: indica si el usuario está iniciando la solicitud como gestor del proceso.

 

Devolución: String[][].

takeProcessTask

Asume una tarea.

 

Método:

takeProcessTask(String user, String password, int companyId, String userId, int processInstanceId, int threadSequence)

 

Parámetros:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • userId: matrícula del usuario.
  • processInstanceId: número de la solicitud.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.

 

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:

  • user: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • userId: matrícula del usuario.
  • processInstanceId: número de la solicitud.
  • threadSequence: Indica si existe una actividad paralela en el proceso. Si no existe, el valor es 0 (cero), si existe, este valor puede ser de 1 a infinito, dependiendo de la cantidad de actividades paralelas existentes en el proceso.
  • replacementId: matrícula del usuario sustituto.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • processInstanceId: número de la solicitud workflow.
  • usuario: usuario responsable por la edición del documento.
  • docDtos: documento o documentos que serán publicados.
  • attachs: archivo(s) adjuntado(s) en la publicación.

 

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:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • role: papel que será creado.

 

Devolución: String.

deleteWorkflowRole

Elimina un papel de Fluig.

 

Método:

deleteWorkflowRole(String username, String password, int companyId, String roleId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • roleId: código del papel que será excluido.

 

Devolución: String.

getWorkflowRole

Devuelve un papel registrado en Fluig.

 

Método:

getWorkflowRole(String username, String password, int companyId, String roleId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • roleId: código de papel.

 

Devolución: WorkflowRoleDto.

 

Atributos de devolución:

  • companyId
  • roleDescription
  • roleId

getWorkflowRoles

Devuelve todos los papeles registrados en Fluig.

 

Método:

getWorkflowRoles(String username, String password, int companyId)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.

 

Devolución: WorkflowRoleDto[].

 

Atributos de devolución:

  • companyId
  • roleDescription
  • roleId

updateWorkflowRole

Actualiza un papel en Fluig.

 

Método:

updateWorkflowRole(String username, String password, int companyId, workflowRoleDto role)

 

Parámetros:

  • username: login del usuario.
  • password: contraseña del usuario.
  • companyId: código de la empresa.
  • role: papel que será creado.

 

Devolución: String.

Cuadro 25: Métodos de WorkflowRoleService