TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Thiago Venturelli

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Rafael Ferreira Bittencourt

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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

...

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, [] 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[].

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[].

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[].

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[].


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: [].

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[].

getSummaryColleagues

Retorna todos os usuários ativos.


Método:

getSummaryColleagues(int companyId)


Parâmetros:

  • companyId: código da empresa.


Retorno: ColleagueDto[].

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

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, [] 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


getRoles

Retorna os papéis associados ao usuário


Método:

getRoles(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: WorkflowRoleDto[].

Quadro 8: Métodos da ColleagueService.


...

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

createDataService

Cria um serviço externo.


Método:

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


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceDto: serviço externo que será criado.


Retorno: String.

deleteDataService 

Remove um serviço externo.


Método:

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


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceName: nome do serviço externo que será removido.

Retorno: void.

getAllServices

Retorna todos os serviços externos cadastrados.


Método:

getAllServices(int companyId, String user, String password)


Parâmetros:

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


Retorno: dataServiceDto[].

loadDataService

Retorna um serviço externo.


Método:

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


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceName: nome do serviço externo.


Retorno: dataServiceDto.

updateDataService

Atualiza um serviço externo.


Método:

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


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceDto: serviço externo que será atualizado.


Retorno: void.

createDataServiceAuthenticated

Cria um serviço externo com autenticação


Método:

createDataServiceAuthenticated(int companyId, String user, String password, DataServiceDto[] dataServiceDto, OauthDTO oauthDTO)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceDto: serviço externo que será criado.
  • oauthDTO:  objeto com as configurações para a autenticação no serviço.


Retorno: String.

updateDataServiceAuthenticated

Atualiza um serviço externo com autenticação


Método:

createDataServiceupdateDataServiceAuthenticated(int companyId, String user, String password, DataServiceDto[] dataServiceDto, OauthDTO oauthDTO)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceDto: serviço externo que será atualizado.
  • oauthDTO:  objeto com as configurações para a autenticação no serviço.


Retorno: void.

Quadro 12: Métodos da DataServiceService.


...

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


Exemplo de utilização com exclusão de anexo:

O exemplo de movimentação com exclusão de anexo está excluindo apenas um anexo, caso necessário excluir mais de um, adicione uma nova tag <item>

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.

Observação:

Caso necessite atualizar somente o título do anexo, basta enviar a tag attachments vazio, exemplo:

<attachments></attachments>

Caso queira atualizar o arquivo do anexo será preciso informar o filename. Caso não tenha enviado o arquivo na pasta upload via FTP informe também o filecontent, exemplo:

<attachments>
            <item>
             <fileName>arquivo.pdf</fileName>
             <filecontent>cid:884394243078</filecontent>
            </item>
  </attachments>


Retorno: String.

Estrutura de retorno com sucesso


Estrutura de retorno com erro



Quadro 24: Métodos da WorkflowEngineService


...