TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 198

changes.mady.by.user Julia Larissa Schultz

Gravado em

comparado com

Nova versão 211

changes.mady.by.user Thiago Venturelli

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: revisão do link do cardData

...

Para os métodos de update que recebem objetos complexos (DocumentDto, ColleagueDto, GroupDto, etc) é obrigatório passar todos os campos do objeto alterado. Os campos não informados serão substituídos por branco, nulo ou zero, dependendo do seu tipo.

Para evitar esta situação, sugerimos sempre utilizar os métodos get para recuperar o objeto, efetuar as alterações nos campos necessários e enviá-lo para o método update.

Nota
titleObservação
Identificamos em alguns objetos os
  • Identificação dos atributos: Os atributos de retorno dos métodos são identificados nos objetos. Caso não tenha encontrado o objeto que procura é possível fazer uma pesquisa nos datasets e assim identificar os atributos.

Image Removed

Figura 1: Consulta de Dataset.

Image Removed

Figura 2: Resultado da Consulta do Dataset Colleague.

Nota
titleObservação
  • Tratamento de exceção (try/catch): Quando o serviço utilizado não estiver disponível, não haverá retorno. Para esse tipo de caso, é aconselhável realizar o tratamento utilizando Try / Catch.


ECMAttributionMecanismService

...

Cloak
visibletrue
titleNo quadro 5, é mostrado todos os métodos disponíveis na classe CardService.

create

Cria um registro de formulário.


Método:

create(int companyId, String user, String password, CardDto[] carddtos)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • carddtos: formulário que será criado.


Retorno: WebServiceMessageArray.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


deleteCard

Exclui um formulário e envia para a lixeira.


Método:

deleteCard(int companyId, String user, String password, int cardId)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • cardId: número do formulário.


Retorno: WebServiceMessageArray.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


getCardVersion

Retorna a versão de um formulário.


Método:

getCardVersion(int companyId, String user, String password, int nrDocumentId, int version, String colleagueId)


Método:

Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • nrDocumentId: número do formulário.
  • version: versão do formulário.
  • colleagueId: matrícula do usuário.


Retorno: CardDto[], lista com ID do campo e seus valores.

updateCard

Altera os metadados de um formulário.


Método:

updateCard(int companyId, String user, String password, CardDto[] cardDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers, RelatedDocumentDto[] reldocs)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • cardDtos: formulário que será alterado.
  • attachs: anexos do formulário.
  • docsecurity: segurança do formulário.
  • docapprovers: aprovadores do formulário.
  • reldocs: documentos relacionados do formulário.


Retorno: WebServiceMessageArray.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateCardDataupdateCardData

Altera os campos de um formulário.


Método:

updateCardDataupdateCardData(int companyId, String user, String password, int cardId, CardFieldDto[] cardData)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • cardId: número do formulário.
  • cardData: campos do formulário que serão alterados.


Retorno: WebServiceMessageArray.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 5: Métodos da CardService.


...

Cloak
visibletrue
titleNo quadro 8, é mostrado todos os métodos disponíveis na classe ColleagueService.

createColleague

Cria um usuário.


Método:

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


Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagues: usuários.


Retorno: String.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


createColleaguewithDependencies

Cria um usuário com grupos e papéis.


Método:

createColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto [] grupos, WorkflowRoleDto[] papeis)


Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagues: usuários.
  • grupos: grupos.
  • papeis: papéis.


Retorno: String.


Estrutura de retorno com sucesso


Estrutura de retorno com erro


getColleague

Retorna um usuário.


Método:

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


Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.


Retorno: ColleagueDto[].

Atributos de Retorno:

  • active 

    • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

    • getColleagueByLogin 

    Retorna o usuário a partir do login.

    Método:

    getColleagueByLogin(String username, String password)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.


    Retorno: ColleagueDto[].

    Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

    • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

    • getColleagues

    Retorna todos os usuários ativos.


    Método:

    getColleagues(String username, String password, int companyId)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.


    Retorno: ColleagueDto[].

    Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

    • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

    • getColleaguesMail

    Retorna um usuário utilizando um e-mail.


    Método:

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


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • mail: e-mail do usuário.


    Retorno: ColleagueDto[].

    Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

    • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

  • volumeId


    • Estrutura de retorno com sucesso

    xml

    getColleagueWithMap

    Retorna uma mensagem informando se o usuário foi criado corretamente.


    Método:

    getColleagueWithMap(String colleagueXML, String username, String password)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • colleagueXML: lista normalizada de documentos.


    Retorno: String.

    getGroups

    Retorna os grupos que o usuário participa.


    Método:

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


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: GroupDto [].Atributos de Retorno:

    • companyId 

    • groupDescription

    • groupId

    getSimpleColleague

    Retorna o usuário.

    Método:

    getSimpleColleague(String username, String password)

    Parâmetros:

  • username: login do usuário.
    • password: senha do

    usuário.

    Retorno: ColleagueDto[].

    Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

    • usedSpace


    Método:

    getSimpleColleague(String username, String password)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.


    Retorno: ColleagueDto[].

    getSummaryColleagues

    Retorna todos os usuários ativos.


    Método:

    getSummaryColleagues(int companyId)


    Parâmetros:

    • companyId: código da empresa.


    Retorno: ColleagueDto[].

    Atributos de Retorno:

  • active 

    • colleagueId

  • colleagueName

  • companyId

  • maxPrivateSize

  • rowId

  • usedSpace

    • removeColleague

    Desativa um usuário.


    Método:

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


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    activateColleague

    Ativa um usuário.


    Método:

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


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    updateColleague

    Altera um usuário.


    Método:

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


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagues: usuários.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    updateColleaguewithDependencies

    Altera Esse método altera um usuário com grupos e papéis, permite adicionar os papéis a um usuário.


    Método:

    updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto [] grupos, WorkflowRoleDto[] papeis)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagues: usuários.
    • grupos: grupos.
    • papeis: papéis.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    validateColleagueLogin

    Valida o acesso de um usuário no produto.


    Método:

    validateColleagueLogin(int companyId, String colleagueId, String password)


    Parâmetros:

    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • password: senha do usuário.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    Quadro 8: Métodos da ColleagueService.


    ...

    Cloak
    visibletrue
    titleNo quadro 9, é mostrado todos os métodos disponíveis na classe CompanyService.

    createCompany

    Cria uma empresa no fluig.


    Método:

    createCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • description: descrição da empresa.
    • urlAccessName: URL de acesso.
    • phisicalPath: caminho físico.
    • webdeskServer: servidor.
    • webPort: porta.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro

    delete

    Exclui uma empresa do fluig.

    Método:

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

    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • deleteFiles: indica se deve excluir o caminho físico.

    Retorno: String.

    Estrutura de retorno com sucesso

    Estrutura de retorno com erro


    getCompanies

    Retorna todas as empresas cadastradas no fluig.


    Método:

    getCompanies(String username, String password, String companyId)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.


    Retorno: CompanyDto[].

    getCompany

    Retorna uma empresa cadastrada no fluig.


    Método:

    getCompany(int companyId)


    Parâmetros:

    • companyId: código da empresa.


    Retorno: CompanyDto.

    updateCompany

    Altera uma empresa no fluig.


    Método:

    updateCompany(String username, String password, String companyId, String description, String urlAccessName, String phisicalPath, String webdeskServer, String webPort)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • description: descrição da empresa.
    • urlAccessName: URL de acesso.
    • phisicalPath: caminho físico.
    • webdeskServer: servidor.
    • webPort: porta.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    Quadro 9: Métodos da CompanyService


    ...

    Cloak
    visibletrue
    titleNo quadro 10, é mostrado todos os métodos disponíveis na classe CustomFieldsService.

    createCustomFields

    Cria um campo customizado.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • customFieldsDto: campo customizado que será criado.


    Retorno: String, retorna OK caso os parâmetros da requisição estejam corretos.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    getAllCustomField

    Retorna todos os campos customizados.


    Método:

    getAllCustomField(String user, String password, int companyId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.


    Retorno: CustomFieldsDto.

    getAllDocumentCustomField

    Retorna todos os campos customizados de um documento.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • documentId: número do documento.
    • version: versão do documento.


    Retorno: DocumentCustomFieldsDto.

    removeCustomField

    Exclui um campo customizado.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • customFieldsId: código do campo customizado.


    Retorno: String, retorna OK caso os parâmetros da requisição estejam corretos. 


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    removeDocumentCustomField

    Exclui um campo customizado de um documento.


    Método:

    removeDocumentCustomField(String user, String password, int companyId, String customFieldsId, int documentId, int version)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • customFieldsId: código do campo customizado.
    • documentId: número do documento.
    • version: versão do documento.


    Retorno:

    Retorno: String, retorna OK caso os parâmetros da requisição estejam corretos.

    .


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    setDocumentCustomFields

    Cria ou altera um campo customizado em um documento.


    Método:

    setDocumentCustomFields(String user, String password, int companyId, DocumentCustomFieldsDto [] documentCustomFieldsDto)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • documentCustomFieldsDto: documento com campo customizado.


    Retorno: String, retorna OK caso os parâmetros da requisição estejam corretos. 


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    updateCustomFields

    Altera um campo customizado.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • customFieldsDto: campo customizado que será alterado.


    Retorno: String, retorna OK caso os parâmetros da requisição estejam corretos. 


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    Quadro 10: Métodos da CustomFieldsService


    ...

    Cloak
    visibletrue
    titleNo quadro 11, é mostrado todos os métodos disponíveis na classe DashBoardService.

    findMyDocuments

    Retorna os documentos do usuário que precisam ser aprovados.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].

    findMyDocumentsOnDemand

    Retorna os documentos do usuário que precisam ser aprovados, paginados.


    Método:

    findMyDocumentsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: DocumentDto[].

    findDocumentsToApprove

    Retorna os documentos que o usuário precisa aprovar.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].

    findDocumentsToApproveOnDemand

    Retorna os documentos que o usuário precisa aprovar, paginados.


    Método:

    findDocumentsToApproveOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: DocumentDto[].

    findAgreementDocuments

    Retorna os documentos do usuário que estão em consenso.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].

    findCheckoutDocuments

    Retorna os documentos do usuário que estão em checkout.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].

    findCancelledTasks

    Retorna as tarefas atribuidas ao usuário que foram canceladas.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findCompletedTasks

    Retorna as tarefas atribuidas ao usuário que foram finalizadas.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findConsensusTasks

    Retorna as tarefas atribuidas ao usuário que estão em consenso.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findTransferredTasks

    Retorna as tarefas atribuidas ao usuário que foram transferidas.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findWorkflowTasks

    Retorna as tarefas do usuário que estão abertas.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.



    Retorno: WorkflowProcessDto[].

    findWorkflowTasksOnDemand

    Retorna as tarefas do usuário que estão abertas, paginadas.


    Método:

    findWorkflowTasksOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.


    Retorno: WorkflowProcessDto[].

    findMyRequests

    Retorna as solicitações abertas que foram inicializadas pelo usuário.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findMyRequestsOnDemand

    Retorna as solicitações abertas que foram inicializadas pelo usuário, paginadas.


    Método:

    findMyRequestsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: WorkflowProcessDto[].

    findMyManagerTasks

    Retorna as tarefas gerenciadas pelo usuário.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowProcessDto[].

    findExpiredWorkflowTasks

    Retorna as tarefas do usuário que estão em atraso


    Método: findExpiredWorkflowTasks(String user, String password, int companyId, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.



    Retorno: WorkflowProcessDto[].

    fillStatusTask

    Retorna a quantidade de tarefas atrasadas, no prazo e sem prazo de um usuário.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.



    Retorno: List de int[], com a quantidade de tarefas atrasadas.

    fillChronoTasks

    Retorna a quantidade de tarefas com prazo de conclusão que foram atribuidas atribuídas ao usuário e não foram 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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • yearIni: ano inicial.
    • yearFin: ano final.
    • mounthIni: mês inicial.
    • mounthFin: mês final.
    • dayIni: dia inicial.
    • dayFin: dia final.
    • kindTask: tipo da tarefa.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.



    Retorno: : Lista de int[], com a quantidade de tarefas com prazo de conclusão atribuída ao usuário.

    fillTypeTasks

    Retorna os tipos de tarefas que o usuário possui.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: TaskVODto[].

    fillTypeTasksOfReplacement

    Retorna os tipos de tarefas que o usuário substituto possui.


    Método:

    fillTypeTasksOfReplacement(String user, String password, int companyId, String colleagueId, String replacementId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • replacementId: matrícula do usuário substituto.


    Retorno: TaskVODto[].

    getOpenTasksByColleagueGroups

    Retorna as tarefas atribuídas a um grupo que o usuário participa.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowTaskDto[].

    getOpenTasksByColleagueGroupsOnDemand

    Retorna as tarefas atribuídas a um grupo que o usuário participa, paginadas.


    Método:

    getOpenTasksByColleagueGroupsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: WorkflowTaskDto[].

    getOpenTasksByColleagueRoles

    Retorna as tarefas atribuídas a um papel que o usuário participa.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: WorkflowTaskDto[].

    getOpenTasksByColleagueRolesOnDemand

    Retorna as tarefas atribuidas atribuídas a um papel workflow que o usuário participa, paginadas.


    Método:

    getOpenTasksByColleagueRolesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: WorkflowTaskDto[].

    getSummaryRequests

    Retorna os contadores de pendências da Home.


    Método:

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


    Parâmetros:

    • companyId: código da empresa.
    • user: login do usuário.
    • password: senha do usuário.
    • colleagueId: matrícula do usuário.


    Atenção!

    O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes a eles.



    Retorno: HomeRequestSummaryDto[].

    getUrlEcm

    Retorna a url do servidor.


    Método:

    getUrlEcm(long companyId)


    Parâmetros:

    • companyId: código da empresa.

    Retorno: String , com a url da empresa. 

    Quadro 11: Métodos da ECMDashBoardService


    ...

    Cloak
    visibletrue
    titleNo quadro 14, é mostrado todos os métodos disponíveis na classe DocumentService.

    approveDocument

    Aprova ou reprova documento pendente de aprovação.


    Metodo:

    approveDocument(int companyId, String userId, String password, int documentId, int version, String approverId, boolean approved, String observation)


    Parâmetros:


    • user: código do usuário de integração.
    • password: senha do usuário de integração.
    • companyId: código da empresa.
    • documentId: código do documento a ser aprovado.
    • version: versão do documento a ser aprovado.
    • approverId: código do aprovador
    • approved: true se aprova o documento e false caso o documento sera reprovado.
    • observation: observação da aprovação ou rejeição.


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    copyDocumentToUploadArea

    Copia os arquivos (principal e anexos) de um documento para a area de upload do usuário. Isto permite que os documentos tornem-se acessíveis via FTP.

    Método:

    copyDocumentToUploadArea(String user, String password, int companyId, int documentId, int version, String colleagueId)

    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • documentId: número do documento que será copiado.
    • version: versão do documento
    • colleagueId: matrícula do usuário cuja área de upload será utilizada


    Retorno: String[] nome dos arquivos que foram disponibilizados na área de upload


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    createDocument createDocument

    Cria um documento.


    Método:

    createDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs,  DocumentSecurityConfigDto[] docSecurity, ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • docDtos: documento que será publicado (mais detalhes do parâmetro aqui).
    • attachs: arquivo anexado na publicação (mais detalhes do parâmetro aqui).
    • docSecurity: segurança do documento que será publicado   (mais detalhes do parâmetro aqui ).
    • docApprovers: aprovadores do documento que será publicado   (mais detalhes do parâmetro aqui ).
    • relDocs: documentos relacionados ao documento que será publicado   (mais detalhes do parâmetro aqui ).

    .


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro

    Veja nosso exemplo no repositório do fluig. Utilize o arquivo dataset-create-document.

    createDocumentWithApprovementLevels

    Cria um documento com nível de aprovação.


    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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • docDtos: documento que será publicado.
    • attachs: arquivo anexado na publicação.
    • docSecurity: segurança do documento que será publicado.
    • docApproversLevel: nível de aprovação que os aprovadores do documento estão inseridos.
    • levels: níveis de aprovação que o documento terá.
    • relDocs: documentos relacionados ao documento que será publicado.


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    createSimpleDocument

    Cria um documento simples.


    Método:

    createSimpleDocument(String user, String password, int company, int parentDocumentId, String publisherId, String documentDescription, Attachment[] attachments)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • parentDocumentId: número da pasta pai.
    • publisherId: matrícula do usuário que publicará o documento.
    • documentDescription: descrição do documento.
    • attachments: arquivo anexado na publicação (para utilização via TDS é necessário instanciar a classe Attachment. Confira um exemplo de utilização em Criação de documento a partir do método createSimpleDocument).


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    createSimpleDocumentPrivate

    Cria um documento simples na pasta particular.


    Método:

    createSimpleDocumentPrivate(String colleagueId, String password, int companyId, int parentDocumentId, String documentDescription, Attachment[] attachments)


    Parâmetros:

    • colleagueId: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • parentDocumentId: número da pasta pai.
    • documentDescription: descrição do documento.
    • attachments: arquivo anexado na publicação.


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    deleteDocument

    Exclui um documento e o envia para a lixeira.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • documentId: número do documento que será excluído.
    • colleagueId: matrícula do usuário.


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    destroyDocument

    Exclui um documento da lixeira.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • documentId: número do documento que será excluído.
    • colleagueId: matrícula do usuário.


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    destroyDocumentApproval

    Exclui documento pendente de aprovação.


    Metodo:

    destroyDocumentApproval(String userId, String password, int companyId, int documentId, String publisherId)


    Parâmetros:


    • user: código do usuário de integração.
    • password: senha do usuário de integração.
    • companyId: código da empresa.
    • documentId: código do documento a excluido.
    • publisherId: código do publicador.


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    findMostPopularDocuments

    Retorna os documentos mais acessados no fluig que o usuário tenha permissão de acesso.


    Método:

    findMostPopularDocuments(String user, String password, int companyId, String colleagueId, int nr_resultados)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.
    • nr_resultados: quantidade de documentos que serão retornados.


    Retorno: DocumentDto[].


    Atributos de Retorno:

    • 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

    Retorna os documentos mais acessados no fluig que o usuário tenha permissão de acesso, paginados.


    Método:

    findMostPopularDocuments(int companyId, String user, String password, String colleagueId, int limit, int lastRowId)


    Parâmetros:

    • companyId: código da empresa.
    • user: login do usuário.
    • password: senha do usuário.
    • colleagueId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: DocumentDto[].


    Atributos de Retorno:

    • 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

    Retorna os documentos da lixeira.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].


    Atributos de Retorno:

    • 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

    Retorna um documento ativo.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • nrDocumentId: número do documento.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].

    getApprovers

    Retorna os aprovadores de um documento.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • nrDocumentId: número do documento.
    • version: número da versão do documento.


    Retorno: ApproverWithLevelDto[].


    Atributos de Retorno:

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

    getDocumentApprovalHistory

    Retorna o histórico de aprovações do documento solicitado.


    Metodo:

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


    Parâmetros:

    • user: código do usuário de integração.
    • password: senha do usuário de integração.
    • companyId: código da empresa.
    • documentId: código do documento que se deseja visualizar o status.
    • version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento).


    Retorno: DocumentApprovementHistoryDto.


    Atributos de Retorno:

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

    getDocumentApprovalStatus

    Retorna o status do documento com relação a aprovação. O status do documento pode ser:

    0 - Aprovado.

    1 - Rejeitado.

    2- Em aprovação.


    Método:

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


    Parâmetros:


    • user: código do usuário de integração.
    • password: senha do usuário de integração.
    • companyId: código da empresa.
    • documentId: código do documento que se deseja visualizar o status.
    • version: versão do documento (caso seja informada a versão 0 sera solicitada a ultima versão do documento).


    Retorno: DocumentApprovalStatusDto.


    Atributos de Retorno:

    • companyId
    • documentId
    • status
    • version

    getDocumentByExternalId

    Retorna um documento pelo código externo.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • externalDocumentId: código externo do documento.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].

    getDocumentContent

    Retorna o byte do arquivo físico de um documento, caso o usuário tenha permissão para acessá-lo.


    Método:

    getDocumentContent(String user, String password, int companyId, int nrDocumentId, String colleagueId, int documentoVersao, String nomeArquivo)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • nrDocumentId: número do documento.
    • colleagueId: matrícula do usuário.
    • documentVersao: número da versão do documento.
    • nomeArquivo: nome do arquivo.


    Retorno: Lista de byte[].

    getDocumentVersion

    Retorna a versão de um documento.


    Método:

    getDocumentVersion(String user, String password, int companyId, int nrDocumentId, int version, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • nrDocumentId: número do documento.
    • version: número da versão do documento.
    • colleagueId: matrícula do usuário.


    Retorno: DocumentDto[].


    Atributos de Retorno:

    • 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

    Retorna todos os documentos relacionados de um documento.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • nrDocumentId: número do documento.
    • version: número da versão do documento.


    Retorno: RelatedDocumentDto.


    Atributos de Retorno:

    • companyId
    • documentId
    • relatedDocumentId
    • version

    getReportSubjectId

    Retorna o código do assunto de relatórios dentro do fluig.


    Método:

    getReportSubjectId(String user, String password, int companyId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.


    Retorno: topicId : int.

    getSecurity

    Retorna a segurança de um documento.


    Método:

    getSecurity(String user, String password, int company, int nrDocumentId, int version)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • nrDocumentId: número do documento.
    • version: número da versão do documento.


    Retorno: DocumentSecurityConfigDto[].


    Atributos de Retorno:

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

    getUserPermissions

    Retorna as permissões do usuário sobre um documento.


    Método:

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


    Parâmetros:

    • companyId: código da empresa.
    • user: login do usuário.
    • nrDocumentId: número do documento.
    • version: número da versão do documento.


    Retorno: Integer, retorna o valor correspondente a permissão..


    Atributos de Retorno:

    • result

    moveDocument

    Move documentos para pasta destino.


    Método:

    moveDocument(String user, String password, int companyId, int[] documentIds, String colleagueId, int destfolder)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • documentIds: lista com os números dos documentos que serão movidos.
    • colleagueId: matrícula do usuário com permissão para mover o documento
    • destFolder: número da pasta de destino.

    Retorno: Lista String[].


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    removeSecurity

    Remove a segurança de um documento.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • documentId: número do documento.
    • version: número da versão do documento.


    Retorno: Não há retorno.

    restoreDocument

    Restaura um documento da lixeira.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • documentId: número do documento que será restaurado.
    • colleagueId: matrícula do usuário.


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    updateDocument

    Altera um documento.


    Método:

    updateDocument(String user, String password, int companyId, DocumentDto[] docDtos, Attachment[] attachs,  DocumentSecurityConfigDto[] docSecurity,ApproverDto[] docApprovers, RelatedDocumentDto[] relDocs)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • docDtos: documento que será publicado (mais detalhes do parâmetro aqui).
    • attachs: arquivo anexado na publicação (mais detalhes do parâmetro aqui).
    • docSecurity: segurança do documento que será publicado  (mais detalhes do parâmetro aqui ).
    • docApprovers: aprovadores do documento que será publicado  (mais detalhes do parâmetro aqui ).
    • relDocs: documentos relacionados ao documento que será publicado  (mais detalhes do parâmetro aqui ).

    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro

    updateDocumentWithApprovementLevels

    Altera um documento com nível de aprovação.


    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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • docDtos: documento que será alterado.
    • attachs: arquivo anexado na alteração.
    • docSecurity: segurança do documento que será alterado.
    • docApprovers: nível de aprovação que os aprovadores do documento estão inseridos.
    • levels: níveis de aprovação que o documento terá.
    • relDocs: documentos relacionados ao documento que será alterado.


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    updateGroupSecurityType

    Modifica o tipo da segurança dos grupos na permissão e na restrição. Existem duas opções que são representadas por um inteiro:

    0 - TODOS os usuários dos Grupos.

    1 - SOMENTE usuários comuns dos 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 do usuário de integração.
    • password: senha do usuário de integração.
    • companyId: código da empresa.
    • documentId: código do documento.
    • version: versão do documento.
    • permissionType: tipo da permissão (0 - TODOS os usuários dos Grupos / 1 - SOMENTE usuários comuns dos grupos)
    • restrictionType: tipo da restrição (0 - TODOS os usuários dos Grupos / 1 - SOMENTE usuários comuns dos grupos)
    • colleagueId: matrícula do usuário


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    updateSimpleDocument

    Altera de forma simples um documento.


    Método:

    updateSimpleDocument(String username, String password, int companyId, int documentId, String publisherId, String documentDescription, Attachment[] attachments)


    Parâmetros:

    • username: login do usuário de integração.
    • password: senha do usuário de integração.
    • companyId: código da empresa.
    • documentId: número do documento que será alterado.
    • publisherId: matrícula do usuário que realizará a alteração do documento.
    • documentDescription: descrição do documento.
    • attachments: arquivos anexados na alteração.


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    validateIntegrationRequirements

    Verifica a integração do usuário no fluig.


    Método:

    validateIntegrationRequirements (String user, String password, int companyId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.


    Retorno: WebServiceMessageArray.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    Quadro 14: Métodos da DocumentService

    ...

    Cloak
    visibletrue
    titleNo quadro 23, é mostrado todos os métodos disponíveis na classe WorkflowEngineService.

    calculateDeadLineHours

    Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em horas.


    Método:

    calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)


    Parâmetros:

    • username - Usuário de Integração
    • password - Senha de Integração
    • companyId - Código da empresa
    • userId - Matrícula do usuário
    • data - data (Tipo String no formato "yyyy-MM-dd").
    • segundos - Quantidade de segundos após a meia noite
    • prazo - Prazo que será aplicado em horas (Variável int).
    • periodId - Código de Expediente


    Retorno: Objeto DeadLineDto que contem variáveis com a data e hora.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    calculateDeadLineTime

    Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em minutos.


    Método:

    calculateDeadLineHours(String username, String password, int companyId, String userId, String data, int segundos, int prazo, String periodId)


    Parâmetros:

    • username - Usuário de Integração
    • password - Senha de Integração
    • companyId - Código da empresa
    • userId - Matrícula do usuário
    • data - data (Tipo String no formato "yyyy-MM-dd").
    • segundos - Quantidade de segundos após a meia noite
    • prazo - Prazo que será aplicado em minutos (Variável int).
    • periodId - Código de Expediente


    Retorno: Objeto DeadLineDto que contem variáveis com a data e hora.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    cancelInstance

    Cancela uma solicitação.


    Método:

    cancelInstance(String user, String password, int companyId, int processInstanceId, String userId, String cancelText)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • userId: mátricula do usuário.
    • cancelText: comentários do cancelamento.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    cancelInstanceByReplacement

    Cancela uma solicitação utilizando usuário substituto.


    Método:

    cancelInstanceByReplacement(String user, String password, int companyId, int processInstanceId, String userId, String cancelText, String replacementId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • userId: mátricula do usuário.
    • cancelText: comentários do cancelamento.
    • replacementId: matrícula do usuário substituto.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    createWorkFlowProcessVersion

    Cria nova versão do processo workflow.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: número da solicitação.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    exportProcess

    Retorna o processo selecionado em uma String.


    Método:

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


    Parâmetros:

    • username - Usuário de Integração
    • password - Senha de Integração
    • companyId - Código da empresa
    • processId - Código do processo

    Retorno: String que contém a definição do processo.

    exportProcessInZipFormat

    Retorna o processo selecionado no formato zip.


    Método:

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


    Parâmetros:

    • username - Usuário de Integração
    • password - Senha de Integração
    • companyId - Código da empresa
    • processId - Código do processo

    Retorno: byte[] que contém a definição do processo.

    getActualThread

    Retorna a sequência da thread de uma solicitação.


    Método:

    getActualThread(String user, String password, int companyId, int processInstanceId, int stateSequence)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • userId: matrícula do usuário.
    • stateSequence: sequência do estado.


    Retorno: int.

    getAllActiveStates

    Retorna o número da atividade em que uma solicitação esta.


    Método:

    getAllActiveStates(String user, String password, int companyId, String userId, int processInstanceId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • userId: matrícula do usuário.
    • processInstanceId: número da solicitação.


    Retorno: Integer[].

    getAllProcessAvailableToExport

    Retorna uma lista de processos disponíveis para serem exportados.


    Método:

    getAllProcessAvailableToExport (String username, String password, int companyId)


    Parâmetros:

    • username - Usuário de Integração
    • password - Senha de Integração
    • companyId - Código da empresa


    Retorno: ProcessDefinitionDto[].

    getAllProcessAvailableToImport

    Retorna uma lista de processos disponíveis para serem importados.


    Método:

    getAllProcessAvailableToImport (String username, String password, int companyId)


    Parâmetros:

    • username - Usuário de Integração
    • password - Senha de Integração
    • companyId - Código da empresa


    Retorno: ProcessDefinitionDto[]

    getAttachments

    Retorna os anexos de uma solicitação.


    Método:

    getAttachments(String user, String password, int companyId, String userId, int processInstanceId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • userId: matrícula do usuário.
    • processInstanceId: número da solicitação.


    Retorno: ProcessAttachmentDto[].

    getAvailableProcess

    Retorna os processos que o usuário pode iniciar uma solicitação.


    Método:

    getAvailableProcess(String username, String password, int companyId, String userId)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • userId: matrícula do usuário.


    Retorno: ProcessDefinitionVersionDto[].

    getAvailableProcessOnDemand

    Retorna os processos que o usuário pode iniciar uma solicitação, paginados.


    Método:

    getAvailableProcessOnDemand(String username, String password, int companyId, String userId, int limit, int lastRowId)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • userId: matrícula do usuário.
    • limit: número de registros a serem retornados.
    • lastRowId: última linha retornada.


    Retorno: ProcessDefinitionVersionDto[].

    getAvailableStates

    Retorna o número da próxima atividade de uma solicitação.


    Método:

    getAvailableStates(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.
    • processInstanceId: número da solicitação.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.


    Retorno: Integer[].

    getAvailableStatesDetail

    Retorna detalhes das atividades disponíveis para seleção...

    Atenção

    Caso haja necessidade de utilizar este método na primeira instância do processo, favor consultar a .

    Método:

    getAvailableStatesDetail(String user, String password, int companyId, String processId, int processInstanceId, int threadSequence)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.
    • processInstanceId: número da solicitação.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.


    Retorno: ProcessStateDto[].

    getAvailableUsers

    Retorna os usuários que podem executar a tarefa corrente de uma solicitação.


    Método:

    getAvailableUsers(String username, String password, int companyId, int processInstanceId, int state, int threadSequence)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • state: número da atividade.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.


    Retorno: String[].

    getAvailableUsersOnDemand

    Retorna os usuários que podem executar a tarefa corrente de uma solicitação, paginados e com busca.


    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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • state: número da atividade.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
    • limit: número de registros a serem retornados.
    • initialUser: última linha retornada.
    • userSearch: texto a ser buscado.


    Retorno: AvailableUsersDto.

    getAvailableUsersStart

    Retorna os usuários disponíveis na abertura de uma solicitação.


    Método:

    getAvailableUsersStart (String username, String password, int companyId, String processId, int state, int threadSequence)


    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.
    • state: número da atividade.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.


    Retorno: String[].

    getAvailableUsersStartOnDemand

    Retorna os usuários disponíveis na abertura de uma solicitação, paginados e com busca.


    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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.
    • state: número da atividade.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
    • limit: número de registros a serem retornados.
    • initialUser: última linha retornada.
    • userSearch: texto a ser buscado.


    Retorno: AvailableUsersDto.

    getCardValue

    Retorna o valor de um campo do registro de formulário.


    Método:

    getCardValue(String user, String password, int companyId, int processInstanceId, String userId, String cardFieldName)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • userId: mátricula do usuário.
    • cardFieldName: nome do campo do registro de formulário.


    Retorno: String.

    getHistories

    Retorna lista de históricos de um processo.


    Método:

    getHistories (String username, String password, int companyId)


    Parâmetros:

    • username - Usuário de Integração
    • password - Senha de Integração
    • companyId - Código da empresa
    • userId - Matrícula do usuário
    • processInstanceId - número da solicitação workflow


    Retorno: ProcessHistoryDto[].


    getInstanceCardData

    Retorna o valor dos campos do registro de formulário de uma solicitação.


    Método:

    getInstanceCardData(String user, String password, int companyId, String userId, int processInstanceId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • userId: matrícula do usuário.
    • processInstanceId: número da solicitação.


    Retorno: String[][].

    getProcessFormId

    Retorna o código do formulário vinculado ao processo.


    Método:

    getProcessFormId(String user, String password, int companyId, string processId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.


    Retorno: int.

    getWorkFlowProcessVersion

    Retorna a versão de um processo.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: número da solicitação.


    Retorno: int.

    importProcess

    Importa processos workflow.


    Método:

    importProcess(String user, String password, int companyId, String processId, Attachment file, boolean newProcess, boolean overWrite, String colleagueId)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.
    • file: arquivo a ser importado.
    • newProcess: indica se deve ser criado um processo ou atualizado o existente.
    • overWrite: indica se as atividades e fluxos do processo existentes devem ser sobrescritas.
    • colleagueId : matrícula do usuário.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    importProcessWithCard

    Importa processos workflow e formulário.


    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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.
    • processAttachs: anexos do processo.
    • newProcess: indica se deve ser criado um processo ou atualizado o existente.
    • overWrite: indica se as atividades e fluxos do processo existentes devem ser sobrescritas.
    • colleagueId : matrícula do usuário.
    • parentDocId: número do formulário.
    • docDescription: descrição.
    • cardDescription: nome.
    • datasetName: nome do dataset.
    • cardAttachs: arquivo anexo.
    • customEvents: eventos.
    • update: caso verdadeiro ('true'), informa que será uma atualização.

    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    releaseProcess

    Libera processos workflow.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.

    Retorno: String.
    Estrutura de retorno com sucesso



    Estrutura de retorno com erro


    saveAndSendTask

    Movimenta solicitação para próxima atividade.

    Caso possua os campos preenchidos na solicitação e os valores não forem repassados no cardData ou estiverem vazios, a solicitação também ficará com o valor vazio, onde os valores preenchidos serão apagados caso não seja passado o valor.



    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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • choosedState: número da atividade.
    • colleagueIds: usuário que receberá a tarefa.
    • comments: comentários.
    • userId: matrícula do usuário que vai executar a tarefa.
    • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
    • attachments: anexos da solicitação.
    • cardData: dados do registro de formulário.
    • appointment: apontamentos da tarefa.
    • managerMode: indica se usuário esta executando a tarefa como gestor do processo.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.


    Retorno: String[][].


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    saveAndSendTaskByReplacement

    Movimenta solicitação para próxima atividade utilizando usuário substituto.

    Caso possua os campos preenchidos na solicitação e os valores não forem repassados no cardData ou estiverem vazios, a solicitação também ficará com o valor vazio, onde os valores preenchidos serão apagados caso não seja passado o valor.


    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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • choosedState: número da atividade.
    • colleagueIds: usuário que receberá a tarefa.
    • comments: comentários.
    • userId: matrícula do usuário que vai executar a tarefa.
    • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
    • attachments: anexos da solicitação.
    • cardData: dados do registro de formulário.
    • appointment: apontamentos da tarefa.
    • managerMode: indica se usuário esta executando a tarefa como gestor do processo.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
    • replacementId: matrícula do usuário substituto.


    Retorno: String[][].


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    saveAndSendTaskClassic

    Movimenta solicitação para próxima atividade e retorna um array de objeto com chave e valor.

    Caso possua os campos preenchidos na solicitação e os valores não forem repassados no cardData ou estiverem vazios, a solicitação também ficará com o valor vazio, onde os valores preenchidos serão apagados caso não seja passado o 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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • choosedState: número da atividade.
    • colleagueIds: usuário que receberá a tarefa.
    • comments: comentários.
    • userId: matrícula do usuário que vai executar a tarefa.
    • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
    • attachments: anexos da solicitação.
    • cardData: dados do registro de formulário.
    • appointment: apontamentos da tarefa.
    • managerMode: indica se usuário esta executando a tarefa como gestor do processo.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.


    Estrutura mínima para movimentação com anexo

    xmlExemplo usando SoapUI

    O exemplo de movimentação com anexo foi criado considerando do uso da pasta de upload do volume. Sendo assim, o arquivo para transferência deverá estar contido na pasta de upload do usuário.

    Considerando o exemplo acima, o arquivo pdf_para_teste.pdf deverá estar contido na pasta do usuário, que fica localizada dentro do diretório upload no volume do fluig.

    Caso não queira utilizar este tipo de transferência para anexo e sim a transferência via Bytes, devem ser adicionadas à estrutura, abaixo da tag <fileName>, as seguintes tags:

    <fileSize> = para indicar o tamanho do arquivo
    <filecontent> = que deverá conter os bytes referentes ao arquivo

    Adicionando estas tags será ignorada a busca no diretório de upload do usuário, sendo considerado o arquivo contido na tag <filecontent>.



    Retorno: KeyValueDto[].


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    searchProcess

    Busca processo disponíveis para inicialização.


    Método:

    searchProcess(String user, String Password, int companyId, String colleagueId, String content, boolean favorite)


    Parametros


    • user - Usuário de Integração
    • password - Senha de Integração
    • companyId - Código da empresa
    • colleagueId - Matrícula do usuário
    • content – nome do processo a ser pesquisado
    • favorite – busca da lista de processos favoritos ou da listagem padrão.


    Retorno: ProcessDefinitionVersionDto[]

    setAutomaticDecisionClassic

    Seleciona usuário(s) e avança atividade 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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • iTaskAutom: número da atividade automática.
    • iTask: número da atividade atual.
    • condition: número da condição da atividade automática.
    • colleagueIds: usuário que receberá a tarefa.
    • comments: comentários.
    • userId: matrícula do usuário que vai executar a tarefa.
    • managerMode: indica se usuário esta executando a tarefa como gestor do processo.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.


    Retorno: KeyValueDto[]


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    setDueDate

    Altera a data de prazo da tarefa.


    Método:

    setDueDate(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String newDueDate, int timeInSeconds)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • userId: matrícula do usuário. Quando é Para um Grupo ou Para um Papel deve ser passado da seguinte forma:
      Papel: "Pool:Role:CodigoDoPapel";
      Grupo: "Pool:Group:CodigoDoGrupo".
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
    • newDueDate: nova data de prazo da tarefa. Exemplo: "2014-08-20".
    • timeInSeconds: quantidade de segundos após a meia noite. Exemplo: "32000".


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    setTasksComments

    Altera os comentários da tarefa.


    Método:

    setTasksComments(String user, String password, int companyId, int processInstanceId, String userId, int threadSequence, String comments)


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação.
    • userId: mátricula do usuário.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
    • comments: comentários.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    simpleStartProcess

    Inicia uma solicitação simples.


    Método:

    simpleStartProcess(String user, String password, int companyId, String processId, String comments, ProcessAttachmentDto[] attachments, String cardData[][])


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.
    • comments: comentários.
    • attachments: anexos da solicitação.
    • cardData: dados do registro de formulário.


    Retorno: String[].


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro

    Para utilização do método, acesse o exemplo a seguir:

    Exemplo.

    startProcess

    Inicia uma solicitação.


    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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.
    • choosedState: número da atividade.
    • colleagueIds: usuário que receberá a tarefa. Caso a solicitação esteja sendo atribuída "Para um Papel" ou "Para um Grupo", o parâmetro colleagueIds deve ser informado da seguinte forma:
      Papel: Pool:Role:Nome_do_papel
      Grupo: Pool:Group:Nome_do_grupo
    • comments: comentários.

    • userId: matrícula do usuário que vai iniciar a solicitação.

    • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
    • attachments: anexos da solicitação.
    • cardData: dados do registro de formulário.
    • appointment: apontamentos da tarefa.
    • managerMode: indica se usuário esta iniciando a solicitação como gestor do processo.


    Retorno: String[][].


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro

    Para utilização do método, acesse o exemplo a seguir:

    .

    startProcessClassic

    Inicia uma solicitação e retorna um array de objeto com chave e 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 do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processId: código do processo.
    • choosedState: número da atividade.
    • colleagueIds: usuário que receberá a tarefa.
    • comments: comentários.
    • userId: matrícula do usuário que vai iniciar a solicitação.
    • completeTask: indica se deve completar a tarefa (true) ou somente salvar (false).
    • attachments: anexos da solicitação.
    • cardData: dados do registro de formulário.
    • appointment: apontamentos da tarefa.
    • managerMode: indica se usuário esta iniciando a solicitação como gestor do processo.


    Retorno: String[][].


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro

    Para utilização do método, acesse o exemplo a seguir:

    Exemplo.

    takeProcessTask

    Assume uma tarefa.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • userId: matrícula do usuário.
    • processInstanceId: número da solicitação.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    takeProcessTaskByReplacement

    Assume uma tarefa utilizando usuário substituto.


    Método:

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


    Parâmetros:

    • user: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • userId: matrícula do usuário.
    • processInstanceId: número da solicitação.
    • threadSequence: Indica se existe atividade paralela no processo. Se não existir o valor é 0 (zero), caso exista, este valor pode ser de 1 a infinito dependendo da quantidade de atividade paralelas existentes no processo.
    • replacementId: matrícula do usuário substituto.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro


    updateWorkflowAttachment

    Atualiza um documento do tipo 7.

    Retorna uma string contendo a descrição de sucesso ou falha da operação.

    Método:

    updateWorkflowAttachment(String username, String password, int companyId, int processInstanceId, String usuario, DocumentDto[] docdtos, Attachment[] attach)

    Parâmetros:

    • username: login do usuário.
    • password: senha do usuário.
    • companyId: código da empresa.
    • processInstanceId: número da solicitação workflow.
    • usuario: usuário responsável pela edição do documento.
    • documents: documento ou documentos que serão publicados.
    • attachments: arquivo(s) anexado(s) na publicação.


    Retorno: String.


    Estrutura de retorno com sucesso


    Estrutura de retorno com erro



    Quadro 24: Métodos da WorkflowEngineService


    ...

    Faça o download da classe ECMWorkflowEngineService.java, esta exemplifica a utilização dos principais métodos da classe WorkflowEngineService.

    ...