Histórico da Página
Nas páginas abaixo dessa estrutura, é possível verificar as documentações para Desenvolvimento Workflow:
- Tradução de Processos: Nesta página você pode verificar o sistema de tradução de processos do fluig. Acesse a documentação e confira mais informações.
- Gestão de Lista de Tarefas: Configure listas a fim de organizar atividades diárias, permitindo informar qual atividade será desempenhada, quem desempenhará e o prazo de conclusão. Verifique o link da documentação e saiba mais detalhes.
- Visão de utilização de workflows: Verifique as orientações e padrões a serem seguidos para a criação de workflows. Acesse o link da documentação e saiba mais detalhes.
- Integração assíncrona via processos workflow: Verifique os modos de processamentos assíncronos por meio de solicitações workflow. Acesse a documentação e confira mais informações.
Caso necessite utilizar integrações no seu workflow, acesse as páginas abaixo e verifique nossas documentações para obter mais informações:
...
- Desenvolvimento sobre a plataforma: Permite visualizar os tópicos referentes ao desenvolvimento sobre a plataforma.
- hAPI: Permite verificar os métodos disponíveis. Acesse o link para conferir.
- docAPI: Variável que permite acesso a funções relacionadas a documentos, podendo ser utilizada nos eventos. Acesse o link da documentação para visualizar os métodos disponíveis.
- Mecanismo de atribuição: Permite que o usuário os utilize para criar uma lista de possíveis usuários para uma atividade. Acesse o link para ter acesso a todos os detalhes.
- Mensagens de log para processos: Guia que permite auxiliar na ativação e compreensão do conjunto de mensagens de log que podem trazer informações sobre solicitações de processo. Acesse o link para conferir a documentação.
- Parâmetros: Permite conferir os tipos de parâmetros utilizados no desenvolvimento do processo sob a plataforma. Acesse o link para conferir mas informações.
- Tratamento de exceções: Permite acessar os modelos de tratamentos de exceções para cada um dos eventos citados. Acesse o link e confira os modelos para utilização.
- Eventos de processos: Permite visualizar todos os eventos e exemplos de implementação de cada um deles. Acesse o link da documentação e confira as informações de todos os eventos.
- Eventos finais de processo: Permite visualizar a descrição dos tipos de eventos finais de um processo. Acesse o link da documentação e veja as informações referente a cada um deles.
- Eventos de notificação: Guia que permite visualizar a configuração do widget específico e um evento de notificação. Acesse a documentação e confira os detalhes passo a passo.
- Acompanhamento de eventos: Permite acompanhar a execução de eventos pelo componente loading. Acesse a documentação através do link e confira os exemplos de utilização deste componente.
Índice
Índice | ||||||
---|---|---|---|---|---|---|
|
Propriedades extensão
As propriedades de extensão contêm informações especiais que podem alterar o comportamento padrão do processo em algum ponto. Elas devem ser utilizadas principalmente durante a fase de desenvolvimento sob a plataforma ou conter "flags" especiais que alterem alguma lógica interna (apenas em casos especiais).
O cadastro de propriedades de extensão do processo é realizado pelo fluig Studio, sendo necessário que o diagrama do processo já esteja criado. Para cadastrar um novo atributo, é necessário abrir o processo para edição e na visão 'Properties' acessar a aba Extensão:
Deve-se utilizar os botões Adicionar novo Atributo, para adicionar uma propriedade de extensão. Abaixo o formulário para a criação de um novo atributo.
Neste exemplo iremos criar atividades automáticas desenvolvidas sob a plataforma.
Na imagem a seguir é possível visualizar o atributo adicionado, definindo as atividades 2 e 4 (separadas por vírgula) como atividades automáticas do processo.
Eventos do processo
Os eventos de um processo são um conjunto de scripts carregados pela API de workflow. Tais scripts são desenvolvidos com o uso da linguagem JavaScript e chamados ao longo da execução do processo em momentos predeterminados, como por exemplo a criação da solicitação do processo ou a entrada em uma nova atividade.
A implementação dos eventos do processo é realizada pelo fluig Studio, sendo necessário já existir um projeto fluig com pelo menos um diagrama de processo.
Para criar um novo evento do processo, clicar com o botão direito do mouse no projeto, acessar a opção New e, em seguida, a opção Other. No assistente aberto, selecionar a opção "Script evento workflow", presente na pasta fluig, e clicar no botão Next. Na nova tela, selecionar qual o evento que será criado e relacionar ele a um processo já existente. Para finalizar, clicar no botão Finish:
Acompanhamento de eventos
A partir do fluig 1.4.9, é possível acompanhar a execução dos eventos pelo novo componente loading. Com este acompanhamento, é possível apresentar mensagens para o usuário tomar conhecimento das rotinas que estão sendo executadas quando a solicitação é encaminhada para a próxima atividade. Essa ferramenta também pode ser muito útil para o desenvolvedor identificar pontos de baixa performance nos desenvolvimentos realizados sob a plataforma.
Para a utilização desta funcionalidade, basta utilizar o trecho loading.setMessage(String message) na implementação do evento, conforme exemplo no trecho de código abaixo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function validateForm(form){
loading.setMessage("Validando campos de formulário");
if(form.getValue('nome') == null || form.getValue('nome') == '') {
throw "Campo nome não está preenchido";
}
loading.setMessage("");
} |
Assim, durante a execução deste evento, a mensagem definida na sua implementação será exibida na tela para o usuário acompanhar, conforme imagem abaixo:
Nota | ||
---|---|---|
| ||
|
checkComplementsPermission
A partir do fluig 1.5.8, é possível configurar a adição de complementos extras para solicitações workflow. Também é possível definir um evento chamado checkComplementsPermission aonde é possível determinar se o usuário corrente do processo poderá ou não adicionar complementos mesmo com permissionamento ligado na modelagem do processo. Este evento possui acesso a todas as propriedades dos processos workflow (quando disponíveis) bem como acesso a hAPI, FLUIG e seus métodos. O Exemplo abaixo irá procurar o usuário corrente no dataset de colleagueGroups. Caso o usuário não esteja neste grupo não será possível para este usuário adicionar complementos extras.
Bloco de código | ||||
---|---|---|---|---|
| ||||
function checkComplementsPermission() {
var user = getValue("WKUser");
var company = getValue("WKCompany");
var group = "Auditoras";
var Id = DatasetFactory.createConstraint('colleagueGroupPK.colleagueId',
user, user, ConstraintType.MUST);
var group = DatasetFactory.createConstraint('colleagueGroupPK.groupId',
group, group, ConstraintType.MUST);
var company = DatasetFactory.createConstraint('colleagueGroupPK.companyId',
company, company, ConstraintType.MUST);
var colleagueGroup = DatasetFactory.getDataset('colleagueGroup', null,
new Array(Id, group, company), null);
if (colleagueGroup != null && colleagueGroup.getRowsCount() == 1) {
return true;
} else {
return false
}
} |
Nota | ||
---|---|---|
| ||
|
hAPI
Em todos os eventos do processo é possível obter informações da API de Workflow. Cada evento possui acesso ao handle da API de workflow pela variável global hAPI. Os seguintes métodos estão disponíveis através da hAPI:
...
Permite acessar o valor de um campo do formulário do processo, onde:
- nomeCampo: nome do campo do formulário.
...
Permite definir o valor de um campo do formulário do processo, onde:
- nomeCampo: nome do campo do formulário;
- valor: valor a ser definido para o campo do formulário.
...
Permite definir o fluxo de saída de uma atividade de forma automática, onde:
- numAtiv: número da atividade destino;
- listaColab: lista (do tipo String) dos usuários que receberão a tarefa;
- Deve ser passada a matricula dos usuários que receberão a tarefa.
- Se a atividade destino for automática ou um evento intermediário que não possui usuário, deve ser informado "System:Auto" no lugar da matrícula.
obs: observação da tarefa;
Bloco de código language js theme Eclipse function afterStateEntry(sequenceId){ if(sequenceId == 4){ var users = new java.util.ArrayList(); //Caso a próxima atividade seja uma automática utilizar users.add("System:Auto"); users.add("adm"); hAPI.setAutomaticDecision(7, users, "Decisao tomada automaticamente pelo Fluig"); } }
Informações É necessário adicionar na Extensão do Processo a propriedade AutomaticTasks com a lista de todas as atividades que terão decisão delegada por desenvolvimento sob a plataforma. Exemplo: AutomaticTasks=4
Nota A propriedade AutomaticTasks caracteriza uma atividade comum como uma atividade automática, esta passará a possuir o mesmo comportamento, incluindo que não irá gerar mais notificações durante sua execução.
...
Retorna a thread da atividade que está ativa, lembrando que em caso de atividades paralelas, retorna 0, 1, 2 e assim sucessivamente.
- numEmpresa: número da empresa;
- numProcesso: número da solicitação;
- numAtiv: número da atividade.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterTaskCreate(colleagueId) {
var nrProxAtividade = getValue("WKNextState");
if (nrProxAtividade == "5"){ //atividade entre paralelas
var data = new Date();
var numEmpresa = getValue("WKCompany");
//seta o dia, mês (Janeiro é 0) e ano
data.setDate(20);
data.setMonth(10);
data.setFullYear(2010);
// Recupera o numero da solicitação
var numProcesso = getValue("WKNumProces");
// Seta o prazo para as 14:00
hAPI.setDueDate(numProcesso, hAPI.getActualThread(numEmpresa, numProcesso, nrProxAtividade), colleagueId, data, 50400);
}
} |
...
Permite alterar o prazo de conclusão para uma determinada atividade do processo, onde:
...
Informações | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Recomendamos a utilização deste método no evento afterTaskCreate, pois será executado logo após a criação da tarefa. Exemplo:
|
...
Transfere uma tarefa de um usuário para outro(s) usuário(s).
- transferUsers: lista (do tipo String) de usuários;
- obs: a observação;
- numThread: sequência da thread, em caso de atividades paralelas.
...
Transfere uma tarefa de um usuário para outro(s) usuário(s). Este método não pode ser usado em processos com atividades paralelas:
- transferUsers: lista (do tipo String) de usuários;
- obs: a observação.
...
Inicia uma solicitação workflow, onde:
- processId: código do processo;
- ativDest: atividade de destino;
- listaColab: lista (do tipo String) de usuários;
- obs: texto da observação;
- completarTarefa: indica se deve completar a tarefa (true) ou apenas salvar (false);
- valoresForm: um Mapa com os valores do formulário do processo;
- modoGestor: indica que o usuário iniciará a solicitação como gestor (true) ou que o usuário iniciará a solicitação apenas como solicitante (false).
Retorna um mapa com informações da solicitação criada. Entre elas, o iProcess que é o número da solicitação criada.
...
Seta um usuário substituto, onde:
- userId: código do usuário substituto.
...
Define uma observação para uma determinada tarefa do processo, onde:
- userId: usuário responsável pela tarefa;
- numProcesso: número da solicitação de processo;
- numThread: é o número da thread (normalmente 0, quando não se utiliza atividades paralelas);
- obs: a observação.
Nota | ||
---|---|---|
| ||
É recomendado utilizar em eventos do tipo 'after', pois o comentário será criado no histórico da solicitação, então é necessário que já exista uma movimentação do processo para atribuir este comentário. |
...
Retorna um Mapa com todos os campos e valores do formulário da solicitação.
- numProcesso: número da solicitação de processo.
Informações |
---|
Para formulários pai e filho, os campos são identificados da seguinte forma: campo1___1, sendo campo1 o nome atribuído ao campo através da tag name do campo HTML + ___ (3 underlines) + número sequencial do registro.
Por exemplo, em um formulário de nota fiscal com os seguintes campos:
O retorno do Mapa seria:
|
...
Retorna o valor da propriedade avançada de um processo.
- propriedade: nome da propriedade avançada.
...
Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em horas:
- data: data inicial (tipo Date);
- segundos: quantidade de segundos após a meia noite;
- prazo: prazo que será aplicado em horas (tipo int);
- periodId: código de expediente.
Retorno: Array de Objeto, onde a primeira posição do array é a data e a segunda a hora.
Exemplo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterTaskCreate(colleagueId) {
var data = new Date();
//Calcula o prazo
var obj = hAPI.calculateDeadLineHours(data, 50000, 2, "Default");
var dt = obj[0];
var segundos = obj[1];
//Recupera o numero da solicitação
var processo = getValue("WKNumProces");
//Altera o prazo do processo
hAPI.setDueDate(processo,0,colleagueId, dt, segundos);
} |
...
Calcula um prazo a partir de uma data com base no expediente e feriados cadastrados no produto passando o prazo em minutos:
- data: data inicial (tipo Date);
- segundos: quantidade de segundos após a meia noite;
- prazo: prazo que será aplicado em minutos (tipo int);
- periodId: código de expediente.
Retorno: Array de Objeto, onde a primeira posição do array é a data e a segunda a hora.
Exemplo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterTaskCreate(colleagueId) {
var data = new Date();
//Calcula o prazo
var obj = hAPI.calculateDeadLineTime(data, 50000, 120, "Default");
var dt = obj[0];
var segundos = obj[1];
//Recupera o numero da solicitação
var processo = getValue("WKNumProces");
// Altera o prazo do processo
hAPI.setDueDate(processo,0,colleagueId, dt, segundos);
} |
...
Permite buscar o link para movimentação de uma determinada atividade, e utilizá-lo para enviar um e-mail com template personalizado, por exemplo.
- numAtiv: número da atividade
Nota | ||
---|---|---|
| ||
Este método não retorna link para atividades que ainda não foram criadas, ou seja, não pode ser utilizado em eventos como afterTaskComplete(colleagueId,nextSequenceId,userList) para obter o link da atividade com "nextSequenceId". |
Exemplo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterTaskCreate(colleagueId) {
var sequenceId = getValue("WKCurrentState");
if (sequenceId == 2) {
var destinatarios = new java.util.ArrayList();
destinatarios.add(colleagueId);
var parametros = new java.util.HashMap();
parametros.put("WDK_CompanyId", getValue("WKCompany"));
parametros.put("WDK_TaskLink", hAPI.getUserTaskLink(sequenceId));
notifier.notify(getValue("WKUser"), "tplCustomizado", parametros, destinatarios, "text/html");
}
} |
...
Permite a criação de atividades adhoc dentro dos eventos do fluig
...
Nota | ||
---|---|---|
| ||
Certifique-se que o sequenceId é a sequência da atividade ad-hoc. Normalmente esta atividade contém o símbolo do sub-processo comum acompanhado do identificador "~", conforme exemplo abaixo : A sequência pode ser consultada a partir do plugin fluig Designer verificando o campo código ao visualizar as propriedades da atividade de subprocesso ad-hoc. |
Exemplo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterStateEntry(sequenceId){
//lista das tarefas
var adHocTasks = new Array();
// variavel com o código da solicitação do processo.
var process = getValue("WKNumProces");
//criando uma tarefa
var task = { name:"nome da tarefas", responsible:"adm", dueDate:"10/10/2014"};
//adicionando a tarefa criada para a lista de tarefas
adHocTasks.push(task);
// process = numero da solicitacao
// sequenceId = codigo processstate da atividade que tem o processo ad-hoc
// meeting = nome do assunto em questao
// detalhe = detalhamento do assunto
// adHocTasks lista te tarefas
hAPI.createAdHocTasks(process, sequenceId, "Assunto das tarefas", "Detalhamento do assunto ", adHocTasks);
} |
...
Retorna a lista de anexos do processo.
Nota | ||
---|---|---|
| ||
O formulário do processo não é retornado, apenas anexos do tipo GED e Workflow. |
...
Permite publicar anexos workflow da solicitação no GED do fluig, onde:
...
Nota | ||
---|---|---|
| ||
É obrigatório informar o id da pasta destino do documento através do método setParentDocumentId, conforme o exemplo abaixo. |
Exemplo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function beforeStateEntry(sequenceId){
if (sequenceId == 4) {
var calendar = java.util.Calendar.getInstance().getTime();
var docs = hAPI.listAttachments();
for (var i = 0; i < docs.size(); i++) {
var doc = docs.get(i);
if (doc.getDocumentType() != "7") {
continue;
}
doc.setParentDocumentId(27);
doc.setVersionDescription("Processo: " + getValue("WKNumProces"));
doc.setExpires(false);
doc.setCreateDate(calendar);
doc.setInheritSecurity(true);
doc.setTopicId(1);
doc.setUserNotify(false);
doc.setValidationStartDate(calendar);
doc.setVersionOption("0");
doc.setUpdateIsoProperties(true);
hAPI.publishWorkflowAttachment(doc);
}
}
} |
attachDocument(documentId)
...
Permite anexar documentos do GED a solicitação workflow, onde:
...
Exemplo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function beforeStateEntry(sequenceId) {
var docList = [44, 46, 135];
if (sequenceId == 2) {
for (var i = 0; i < docList.length; i++) {
var docId = docList[i];
hAPI.attachDocument(docId);
};
}
} |
...
getAvailableStatesDetail(companyId, userId, processId, processInstanceId, threadSequence)
...
Retorna detalhes das atividades disponíveis para seleção.
Parâmetros:
- companyId: código da empresa;
- userId: id do usuário;
- 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[].
...
Retorna uma lista com os números das solicitações filhas, onde:
- processInstanceId: número da solicitação pai.
Exemplo:
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
function afterStateEntry(sequenceId){
if (sequenceId == 5) {
var numProcess = getValue("WKNumProces");
// Busca a Lista com o número da solicitação dos filhos
var childrenProcess = hAPI.getChildrenInstances(numProcess);
for (var i = 0; i < childrenProcess.size(); i++) {
// Busca os dados do formulário da solicitação filha
var childCardData = hAPI.getCardData(childrenProcess.get(i));
// Replica um dado do formulário da solicitação filha para o formulário da solicitação pai
var obs = childCardData.get("obs");
hAPI.setCardValue("obs", obs );
}
}
} |
...
Retorna o número da solicitação pai, onde:
- processInstanceId: número da solicitação filha.
Exemplo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function beforeStateEntry(sequenceId) {
if (sequenceId == 2) {
var numProcess = getValue("WKNumProces");
// Busca o número da solicitação pai
var parentProcess = hAPI.getParentInstance(numProcess);
// Busca os dados do formulário da solicitação pai
var parentCardData = hAPI.getCardData(parentProcess);
// Replica um dado do formulário da solicitação pai para o formulário da solicitação filha
var cnpj = parentCardData.get("cnpj");
hAPI.setCardValue("cnpj", cnpj);
}
} |
...
Adiciona um filho no formulário pai e filho do processo, onde:
- tableName: nome da tabela filha onde será criado o filho;
- cardData: mapa com os campos do filho e seus valores.
Exemplo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function beforeStateEntry(sequenceId) {
if (sequenceId == 4) {
var childData = new java.util.HashMap();
childData.put("matricula", "0041");
childData.put("nome", "João Silva");
childData.put("cpf", "44455889987");
hAPI.addCardChild("funcionarios", childData);
}
} |
Nos eventos existe a possibilidade de integração com serviços de dados. Tais serviços podem ser WebServices, AppServer Progress® e Dataset.
O acesso a WebServices ou AppServer Progress® deve ser previamente configurado no cadastro de Serviços. Para mais detalhes consulte em Integração com aplicativos externos, no capítulo "Acessando WebServices a partir do fluig".
Abaixo um exemplo de como executar o WebService de Colleague para criar um usuário no fluig após executar uma tarefa:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterTaskComplete(colleagueId, nextSequenceId, userList) {
if (nextSequenceId == 2) {
//Busca o webservices de Colaborador
var colleagueServiceProvider = ServiceManager.getServiceInstance("Colleague");
var colleagueServiceLocator = colleagueServiceProvider.instantiate("com.totvs.technology.ecm.foundation.ws.ECMColleagueServiceService");
var colleagueService = colleagueServiceLocator.getColleagueServicePort();
//Cria o ColleagueDto – Verificar a lista de métodos na visualização do serviço
var colleagueDto = colleagueServiceProvider.instantiate("com.totvs.technology.ecm.foundation.ws.ColleagueDto");
colleagueDto.setCompanyId(1);
colleagueDto.setColleagueId("teste");
colleagueDto.setColleagueName("Usuario Teste");
colleagueDto.setActive(true);
colleagueDto.setVolumeId("Default");
colleagueDto.setLogin("teste");
colleagueDto.setMail("[email protected]");
colleagueDto.setPasswd("teste");
colleagueDto.setAdminUser(false);
colleagueDto.setEmailHtml(true);
colleagueDto.setDialectId("pt_BR");
//Cria o colleagueDtoArray e adiciona
var colleagueDtoArray = colleagueServiceProvider.instantiate("com.totvs.technology.ecm.foundation.ws.ColleagueDtoArray");
colleagueDtoArray.getItem().add(colleagueDto);
var result = colleagueService.createColleague("adm", "adm", 1, colleagueDtoArray);
log.info("Result: " + result);
}
} |
Abaixo um outro exemplo utilizando o WebService ECMCardService para alterar o valor do campo de um registro de formulário após a entrada em uma nova atividade:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterStateEntry(sequenceId){
if (sequenceId == 2) {
//Servico "<url_fluig>/webdesk/ECMCardService?wsdl"cadastrado com o código "CardService"
var cardServiceProvider = ServiceManager.getServiceInstance("CardService");
var cardServiceLocator = cardServiceProvider.instantiate("com.totvs.technology.ecm.dm.ws.ECMCardServiceServiceLocator");
var cardService = cardServiceLocator.getCardServicePort();
var cardFieldDtoArray = cardServiceProvider.instantiate("com.totvs.technology.ecm.dm.ws.CardFieldDtoArray");
var cardField = cardServiceProvider.instantiate("com.totvs.technology.ecm.dm.ws.CardFieldDto");
//Seta valor no campo com name = 'nome'
cardField.setField("nome");
cardField.setValue("Valor alterado via WS dentro de um evento workflow");
var vetCardFields = new Array();
vetCardFields.push(cardField);
cardFieldDtoArray.setItem(vetCardFields);
//Altera o(s) campo(s) do registro de formulário.
//updateCardData(tenantId, login, senha, codRegistroForm, cardFieldDtoArray);
cardService.updateCardData(1, "adm", "adm", 8, cardFieldDtoArray);
}
} |
Os seguintes eventos são disparados pela API de Workflow:
Evento | Descrição | Parâmetros | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
afterCancelProcess | Ocorre após o cancelamento da solicitação. É recomendado não disparar exceções neste método, pois o cancelamento já foi realizado. |
| |||||||||||
afterProcessCreate | Ocorre logo após a criação de um novo processo.
|
| |||||||||||
afterProcessFinish | Ocorre após finalizada a solicitação. |
| |||||||||||
afterReleaseVersion | Ocorre após a liberação de uma versão do processo. |
| |||||||||||
afterStateEntry | Ocorre após a entrada em uma nova atividade. |
| |||||||||||
afterStateLeave | Ocorre após a saída de uma atividade. |
| |||||||||||
afterTaskComplete | Ocorre após o usuário completar uma tarefa, porém as informações de próxima tarefa e usuários destino já foram salvas. |
| |||||||||||
afterTaskCreate | Ocorre após o usuário receber uma tarefa. |
| |||||||||||
afterTaskSave | Ocorre após salvar as informações selecionadas pelo usuário. |
| |||||||||||
beforeCancelProcess | Ocorre antes do cancelamento da solicitação. |
| |||||||||||
beforeStateEntry | Ocorre antes da entrada em uma nova atividade. |
| |||||||||||
beforeStateLeave | Ocorre antes da saída de uma atividade. |
| |||||||||||
beforeTaskComplete | Ocorre antes que o usuário complete uma tarefa, porém as informações de próxima tarefa e usuários destino já foram salvas.
|
| |||||||||||
beforeTaskCreate | Ocorre antes que o usuário receba uma tarefa. |
| |||||||||||
beforeTaskSave | Ocorre antes de salvar as informações selecionadas pelo usuário. |
| |||||||||||
calculateAgreement | Ocorre após o cálculo do consenso (somente para atividades conjuntas) e permite alterar os dados do consenso de uma atividade. Exemplo:
|
| |||||||||||
onNotify | Se refere a um evento global que ocorre após a movimentação da solicitação e antes de enviar as notificações. | Para mais detalhes consulte a página Desenvolvimento de eventos - On Notify. | |||||||||||
setProcess | Ocorre quando um processo é "setado" na API.
|
| |||||||||||
subProcessCreated | Ocorre quando um sub-processo é criado. |
| |||||||||||
validateAvailableStates | Ocorre após montada a lista de tarefas disponíveis para o usuário a partir da tarefa atual. |
|
Informações |
---|
|
Nota | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Não é possível capturar (hAPI.getCardValue) ou adicionar (hAPI.setCardValue) dados no formulário na inicialização do processo, sendo possível somente a partir da segunda tarefa. Para isso pode ser utilizada a seguinte lógica:
|
docAPI
Para ter acesso a funções relacionadas a documentos é possível utilizar nos eventos a variável global docAPI. Os métodos disponíveis através da docAPI são:
...
Copia os arquivos físicos de um documento existente para a área de upload do usuário logado, onde:
- documentId: id do documento a ser copiado;
- version: versão do documento a ser copiado;
Retorno: Array de Strings contendo os nomes dos arquivos que foram disponibilizados na área de upload.
...
Cria um novo documento no GED de acordo com os parâmetros informados, onde:
- document: documento a ser criado;
- attachments: lista de anexos do documento;
- securityConfig: lista de configurações de segurança do documento;
- approvers: lista de aprovadores do documento;
- relatedDocs: lista de documentos relacionados ao documento;
Retorno: DocumentDto do documento criado.
Exemplo de utilização desta função em conjunto com a função copyDocumentToUploadArea:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function beforeStateEntry(sequenceId) {
if (sequenceId == 5) {
var attachments = hAPI.listAttachments();
for ( var i = 0; i < attachments.size(); i++) {
var docDto = attachments.get(i);
if (docDto.getDocumentType() == "7") {
docAPI.copyDocumentToUploadArea(docDto.getDocumentId(), docDto.getVersion());
docDto.setDocumentId(0);
docDto.setParentDocumentId(20);
var attachArray = new java.util.ArrayList();
var mainAttach = docAPI.newAttachment();
mainAttach.setFileName(docDto.getPhisicalFile());
mainAttach.setPrincipal(true);
mainAttach.setAttach(false);
attachArray.add(mainAttach);
try {
var doc = docAPI.createDocument(docDto, attachArray, null, null,null);
log.info("DOCUMENTO CRIADO COM O ID: " + doc.getDocumentId());
} catch (e) {
log.error("Problemas na criação do documento:\n" + e);
}
}
}
}
} |
...
Cria uma nova pasta no GED de acordo com os parâmetros informados, onde:
- document: pasta a ser criada;
- securityConfig: lista de configurações de segurança da pasta;
- approvers: lista de aprovadores da pasta;
Retorno: DocumentDto da pasta criada.
Exemplo de utilização desta função:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterProcessFinish(processId) {
try {
var dto = docAPI.newDocumentDto();
dto.setDocumentDescription("Planilhas");
dto.setDocumentType("1");
dto.setParentDocumentId(20);
dto.setDocumentTypeId("");
var folder = docAPI.createFolder(dto, null, null);
log.info("PASTA CRIADA COM O ID :" + folder.getDocumentId());
} catch (e) {
log.error("Problemas na criação da pasta:\n" + e);
}
}
|
...
Retorna o DocumentDto de um documento com base no seu id e sua versão, onde:
- documentId: id do documento a ser retornado;
- version: versão do documento a ser retornado;
...
Retorna o nível de permissão do usuário logado no documento informado, onde:
...
Retorna se o usuário logado faz parte do grupo informado, onde:
- group: código do grupo a ser verificado;
...
Retorna uma nova instância de Attachment.
...
Retorna uma nova instância de RelatedDocumentDto.
...
Retorna uma nova instancia de DocumentSecurityConfigDto.
...
Retorna uma nova instância de ApproverDto.
...
Retorna uma nova instância de DocumentDto, com o tipo 2 (Documento) como padrão.
Desenvolvimento de processo sob a plataforma
Com o uso de eventos, o fluig permite que um processo seja desenvolvido sob a plataforma, possibilitando a execução de ações definidas pelo usuário, tais como:
- validar o ato de completar uma atividade;
- tomar decisões automaticamente;
- realizar integrações com outros sistemas;
- iniciar novas solicitações automaticamente.
Existem algumas propriedades que contém informações referentes à solicitação que podem ser utilizadas no desenvolvimento do processo sob a plataforma, são elas:
Parâmetro | Descrição |
---|---|
WKDef | Código do processo. |
WKVersDef | Versão do processo. |
WKNumProces | Número da solicitação de processo. |
WKNumState | Número da atividade. |
WKCompany | Número da empresa. |
WKUser | Código do usuário corrente. |
WKUserComment | Comentário feito pelo usuário na atividade ou no cancelamento da solicitação. Esse parâmetro irá retornar apenas o comentário da atividade corrente ou o texto informado durante o procedimento de cancelamento da solicitação. |
WKCompletTask | Se a tarefa foi completada (true/false). |
WKNextState | Número da próxima atividade (destino). |
WKCardId | Código do formulário do processo. |
WKFormId | Código da definição de formulário do processo. |
WKIdentityCompany | Identificador da empresa selecionada para Experiências de uso TOTVS. |
WKMobile | Identifica se a ação foi realizada através de um dispositivo mobile. |
WKIsService | Identifica se a solicitação de cancelamento foi realizada através de um serviço. Esta variável só pode ser consultada nos eventos beforeCancelProcess e afterCancelProcess. |
WKUserLocale | Identifica o idioma corrente do usuário. |
Além dessas propriedades já alimentadas pela plataforma, é possível criar propriedades desenvolvidas sob a plataforma que podem ser utilizadas nos eventos. O produto disponibiliza a variável globalVars, que é um mapa de dados (Map<String, String>) e estará disponível em todos os eventos.
Para adicionar uma propriedade e seu valor, utilize o método globalVars.put("name", "value"), onde "name" é o nome da propriedade e "value" o seu valor. Exemplo: globalVars.put("WDAprovador","adm");
Para recuperar os valores da variável globalVars, utilize o método globalVars.get("name"), onde "name" é o nome da propriedade a ser retornado o valor. Exemplo: globalVars.get("WDAprovador");
...
effectDuration | 0.5 |
---|---|
history | false |
id | samples |
effectType | fade |
Card | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Para validar se o usuário está completando uma atividade corretamente, basta utilizar o evento beforeTaskSave e retornar alguma mensagem caso queira disparar um erro. Por exemplo, segue parte de um código de desenvolvimento de um processo sob a plataforma:
|
Card | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
Para fazer com que uma decisão seja tomada automaticamente, os seguintes procedimentos devem ser executados:
|
...
id | 3 |
---|---|
label | Exemplo 3 |
Para iniciar uma nova solicitação de um outro processo ao finalizar uma solicitação podem ser executados os seguintes procedimentos:
...
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function afterProcessFinish(processId) {
// Servico <url_fluig>/webdesk/ECMWorkflowEngineService?wsdl
// Busca o webservice cadastrado com o código "WorkflowEngineService"
var workflowEngineServiceProvider = ServiceManager.getServiceInstance("WorkflowEngineService");
var workflowEngineServiceLocator = workflowEngineServiceProvider.instantiate("com.totvs.technology.ecm.workflow.ws.ECMWorkflowEngineServiceService");
var workflowEngineService = workflowEngineServiceLocator.getWorkflowEngineServicePort();
// Cria o ProcessAttachmentDtoArray
var processAttachmentDtoArray = workflowEngineServiceProvider.instantiate("com.totvs.technology.ecm.workflow.ws.ProcessAttachmentDtoArray");
// Cria o ObjectFactory
var objectFactory = workflowEngineServiceProvider.instantiate("net.java.dev.jaxb.array.ObjectFactory");
// Cria um String[][]
var cardData = objectFactory.createStringArrayArray();
// Cria uma solicitação
workflowEngineService.simpleStartProcess("adm", "adm", 1, "process2", "Comment", processAttachmentDtoArray, cardData);
} |
Informações |
---|
Existem outros métodos parar iniciar uma solicitação, consulte-os aqui. Lembre-se de consultar a classe ObjectFactory do serviço, essa classe possui diversos métodos para criar instância de objetos necessários para utilização do serviço. |
Tratamento de exceções
As exceções podem ser tratadas nos seguintes eventos: beforeStateEntry, beforeTaskSave e beforeCancelProcess. O tratamento de exceção no evento beforeStateEntry pode ser utilizado na inicialização de solicitações, pois ele impede que a solicitação seja iniciada. O tratamento de exceção no evento beforeTaskSave pode ser utilizado somente se a solicitação já estiver inicializada.
Abaixo é apresentado os modelos para utilização em cada um dos eventos:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function beforeStateEntry(sequenceId) {
var activity = getValue("WKNumState");
if (activity == 0 || activity == 1) {
//Outra condição.
throw "TRATAMENTO DE EXCEÇÃO";
}
}
function beforeTaskSave(colleagueId, nextSequenceId, userList) {
var activity = getValue("WKNumState");
if (activity != 0 && activity != 1) {
//Outra condição
throw "TRATAMENTO DE EXCEÇÃO";
}
}
function beforeCancelProcess(colleagueId, processId) {
//Condição.
throw "TRATAMENTO DE EXCEÇÃO";
} |
É possível consultar o campo Observação de uma solicitação de processo, verificando se ele foi preenchido ou não. Para isto, é necessário validar a propriedade WKUserComment no evento beforeTaskSave ou no evento beforeCancelProcess. Exemplo:
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
function beforeTaskSave(colleagueId, nextSequenceId, userList) {
if (getValue("WKUserComment") == null || getValue("WKUserComment") == "") {
throw "A observação deve ser preenchida";
}
}
function beforeCancelProcess(colleagueId, processId) {
if (getValue("WKUserComment") == null || getValue("WKUserComment") == "") {
throw "A observação deve ser preenchida";
}
} |
Mecanismo de atribuição
Os mecanismos de atribuição são instrumentos utilizados durante um processo de workflow que permitem criar, segundo um critério estabelecido pelo próprio mecanismo, uma lista de possíveis usuários para uma atividade. Esta lista pode ser utilizada em dois momentos:
- na inicialização do processo, onde o sistema verifica se o usuário corrente faz parte desta lista e, portanto, pode iniciá-lo;
- no momento do encaminhamento de uma tarefa, quando esta lista é apresentada ao usuário corrente com opções de encaminhamento da solicitação.
No primeiro caso, a lista é gerada de acordo com o mecanismo de atribuição existente na primeira atividade do processo (que representa a atividade inicial). Nas demais atividades é adotado o segundo procedimento. Quando não houver um mecanismo de atribuição associado a uma atividade (seja ela inicial ou não), todos os usuários são considerados válidos.
O fluig possui alguns mecanismos de atribuição padrão, conforme abaixo:
Mecanismo de Atribuição | Descrição |
---|---|
Para um papel (Pool) | Permite atribuir tarefas a um papel e não apenas a um usuário. Assim, qualquer um dos usuários neste papel pode assumir as tarefas para completá-las. |
Para um grupo (Pool) | Permite atribuir tarefas a um grupo e não apenas a um usuário. Assim, qualquer um dos usuários deste grupo pode assumir as tarefas para completá-las. |
Por associação | Permite compor lógicas complexas de atribuição por intermédio da associação de vários mecanismos. |
Por campo de formulário | Permite atribuir tarefas ao usuário informado em um campo do formulário do processo. |
Por executor de atividade | Permite selecionar os usuários que executaram uma atividade anterior. |
Por grupo | Permite filtrar apenas os usuários que façam parte de um determinado grupo. |
Por grupos do usuário | Permite filtrar apenas os usuários que pertençam a um dos grupos do usuário corrente, ou do usuário que iniciou o processo (solicitante). Também permite filtrar apenas os usuários cujo grupo de trabalho seja o mesmo do usuário (corrente ou solicitante). |
Por papel | Permite filtrar apenas os usuários que possuam um determinado papel. |
Por usuário | Permite atribuir tarefas a um usuário específico. |
Nota | ||
---|---|---|
| ||
Os mecanismos "Por executor de atividade" e "Por usuário", selecionam um usuário específico, seja ele pré-determinado (Por usuário) ou variável conforme o fluxo da solicitação (Por executor). Caso o usuário destino esteja inativo, a atividade vai ser enviada ao gestor do processo. |
Como criar um mecanismo de atribuição
A criação de um mecanismo de atribuição é realizada pelo fluig Studio, sendo necessário já existir um projeto fluig.
Utilize o passo-a-passo para conhecer o processo de criação de um mecanismo de atribuição de exemplo:
...
startHidden | false |
---|---|
effectDuration | 0.5 |
history | false |
id | mecatrib |
effectType | fade |
Card | ||||||
---|---|---|---|---|---|---|
| ||||||
Para criar um novo mecanismo de atribuição desenvolvido sob a plataforma, clicar com o botão direito do mouse no projeto do fluig, acessar a opção New e então a opção Other. No assistente aberto, selecionar a opção "Mecanismo customizado fluig" presente na pasta fluig e clicar no botão Next:
|
Card | ||||
---|---|---|---|---|
| ||||
O assistente Novo mecanismo fluig é aberto. Informar o código e uma descrição e clicar no botão Finish:
|
Card | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||
O arquivo JavaScript do mecanismo de atribuição é adicionado ao projeto na pasta mechanisms e aberto para edição. O script de mecanismo de atribuição desenvolvido sob a plataforma recebe como parâmetro o código do processo e o usuário corrente. Este script deve retornar uma lista dos usuários que podem assumir a tarefa. Abaixo, exemplo de implementação:
|
...
id | 4 |
---|---|
label | Último Passo (Exportação) |
Por fim, o mecanismo de atribuição desenvolvido sob a plataforma deve ser exportado para o servidor do fluig e ao realizar a exportação deve ser informado obrigatoriamente seu código e nome, e opcionalmente uma descrição:
Parâmetros workflow para desenvolvimento de formulários sob a plataforma
Para processos que possuem uma definição de formulário são passados alguns parâmetros com informações sobre o processo para serem utilizados nos eventos da definição do formulário, conforme abaixo:
Parâmetro | Descrição |
---|---|
WKDef | Código do processo. |
WKVersDef | Versão do processo. |
WKNumProces | Número da solicitação de processo. |
WKNumState | Número da atividade movimentada. |
WKCurrentState | Número da atividade atual. |
WKCompany | Número da empresa. |
WKUser | Código do usuário corrente. |
WKCompletTask | Se a tarefa foi completada (true/false). |
WKNextState | Número da próxima atividade (destino). |
WKCardId | Código do formulário do processo. |
WKFormId | Código da definição de formulário do processo. |
WKIdentityCompany | Identificador da empresa selecionada para Experiências de uso TOTVS. |
WKReplacement | Código do usuário substituto |
Observação: Para processos que estejam sendo acessados por um usuário substituto, o usuário logado será o retorno do parâmetro WKReplacement
Nos scripts dos eventos da definição de formulário basta recuperar as informações com o comando getValue, conforme exemplo:
Bloco de código | ||||
---|---|---|---|---|
| ||||
var vCodProcess = getValue("WKDef"); |
Eventos para validação de formulário
Em processos que possuem um formulário desenvolvido sob a plataforma é possível implementar funções JavaScript dentro do formulário, para serem executadas automaticamente durante a movimentação do processo.
Estão disponíveis:
Evento | Descrição | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
beforeMovementOptions | É executada quando o usuário pressiona o botão Movimentar antes de serem exibidas as opções de movimentação do processo.
Parâmetros:
Opcionais:
Exemplo:
| |||||||||||||
beforeSendValidate | Ocorre antes da solicitação ser movimentada, após já ter sido selecionada a atividade destino, o usuário e demais informações necessárias à solicitação. Parâmetros:
Opcionais:
Exemplo:
|
Nota | ||
---|---|---|
| ||
Sobre personalização de notificações e e-mail acompanhe informações detalhadas em:
|
...