- 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. | 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. | 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. | 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. | 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. | 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.. 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 da ficha. 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 da ficha.
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 da ficha 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 userId, int processId) Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- userId: matrícula do usuário.
- processId: número da solicitação.
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 atividade e fluxos do processo existente dever ser sobrescritas.
- colleagueId : matrícula do usuário.
Retorno: String. | 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 atividade e fluxos do processo existente dever 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. | releaseProcess | Libera rocessos 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. | saveAndSendTask | Movimenta solicitação para próxima atividade. 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 da ficha.
- 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[][]. | saveAndSendTaskByReplacement | Movimenta solicitação para próxima atividade utilizando usuário substituto. 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 da ficha.
- 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[][]. | saveAndSendTaskClassic | Movimenta solicitação para próxima atividade e retorna um array de objeto com chave e 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 da ficha.
- 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: KeyValueDto[]. | 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: numero da atividade atual.
- condition: numero 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[] | 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: 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.
- newDueDate: nova data de prazo da tarefa.
- timeInSeconds: quantidade de segundos após a meia noite.
Retorno: String. | 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. | 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 da ficha.
Retorno: String[]. | 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.
- 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 da ficha.
- appointment: apontamentos da tarefa.
- managerMode: indica se usuário esta iniciando a solicitação como gestor do processo.
Retorno: String[][]. | 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 da ficha.
- appointment: apontamentos da tarefa.
- managerMode: indica se usuário esta iniciando a solicitação como gestor do processo.
Retorno: String[][]. | 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. | 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. | 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.
- docDtos: documento ou documentos que serão publicados.
- attachs: arquivo(s) anexado(s) na publicação.
|
Quadro 23: Métodos da WorkflowEngineService |