Eventos

...

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.

...

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:

Image Modified

afterReleaseProcessVersion

Evento disparado após a criação ou modificação nas configurações de um determinado processo.

...

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:

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:

Image Removed

checkComplementsPermission

• Abaixo segue um exemplo de como implementar esse evento:

function afterReleaseProcessVersion(processXML){
    var pdv = getValue("ProcessDefinitionVersionDto");
    var processInfo = "\n### Nova versão de processo liberada: ###";
    processInfo += "\n User: " + getValue("WKUser");   
    processInfo += "\n processDescription: " + pdv.getProcessDescription();
    processInfo += "\n processId: " + pdv.getProcessId();
    processInfo += "\n version: " + pdv.getVersion();
    log.info(processInfo + "\n");
}

São disponibilizadas algumas propriedades referentes ao processo que esta sendo liberado, porém somente para consulta através do método getValue.

ProcessDefinitionVersion

ProcessDefinitionVersionDto

afterReleaseVersion

Ocorre após a liberação de uma versão do processo.

Parâmetro:

beforeStateEntry

Ocorre antes da entrada em uma nova atividade.

Parâmetro:

beforeTaskCreate

Ocorre antes que o usuário receba uma tarefa.

function beforeTaskCreate(colleagueId){
    
    // Impede que um determinado usuário assuma a tarefa
        if(colleagueId == "Administrador2" && getValue("takeTask") == true)  { 
            throw "Você não pode assumir esta tarefa"; 
        }
} 

Parâmetro:

afterTaskCreate

Ocorre após o usuário receber uma tarefa.

Parâmetro:

afterStateEntry

Ocorre após a entrada em uma nova atividade.

Parâmetro:

Exemplo (chamada do Dataset com varredura por colunas):

var datasetReturned = DatasetFactory.getDataset("Formuláriodelocal6", null, null, null);

log.info("===============COLUNAS=======================");

log.info("===============NOME COLUNAS=======================");

for (var j = 0; j < datasetReturned.rowsCount; j++) {

try {

log.info("******** COLUMN ---->" + datasetReturned.getColumnName(j));
    } catch (e) {
log.info("EEEEEEEEEEEEEEEEEE ->" + e);
    }

}

beforeSendData

É o último evento a ser executado. Possui integração com Analytics, podendo enviar dados específicos de processos Workflow. 

Para maiores detalhes sobre a utilização desse evento, acesse Guia de Implementação Fluig Analytics. 

validateAvailableStates

Ocorre após montada a lista de tarefas disponíveis para o usuário a partir da tarefa atual.

Exemplo:

function validateAvailableStates(iCurrentState, stateList) {
    // Código: 1 - Descrição: Atividade inicial
    // Código: 2 - Descrição: Atividade ordem 3
    // Código: 3 - Descrição: Atividade ordem 2
    // Código: 4 - Descrição: Atividade ordem 1
     
    // stateList atual: [2,3,4]
 
    var stateArray = new Array();
     
    if (iCurrentState == 1) {
        stateList.clear();
        stateArray.push(4,3,2);
    }
     
    stateArray.forEach(function(code) {
        stateList.add(new java.lang.Integer(code));
    });
     
    // stateList reordenado: [4,3,2]
    return stateList;
}

Parâmetro:

beforeTaskSave

Ocorre antes de salvar as informações selecionadas pelo usuário.

Parâmetros:

afterProcessCreate

Ocorre logo após a criação de um novo processo.

Parâmetro:

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.

Parâmetros:

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.

Parâmetros:

beforeStateLeave

Ocorre antes da saída de uma atividade.

Parâmetro:

afterStateLeave

Ocorre após a saída de uma atividade.

Parâmetro:

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.

checkComplementsPermission

Através dele 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 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.

...

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
    }
 
}

...

Atenção

...

Eventos

afterReleaseProcessVersion

Evento disparado após a criação ou modificação nas configurações de um determinado processo.

Abaixo segue um exemplo de como implementar esse evento:

São disponibilizadas algumas propriedades referentes ao processo que esta sendo liberado, porém somente para consulta através do método getValue.

ProcessDefinitionVersion

ProcessDefinitionVersionDto

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 da função

Exemplo de implementação

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 da função

Exemplos de implementação

subProcessCreated

Ocorre quando um sub-processo é criado.

Parâmetro:

afterProcessFinish

Ocorre após finalizada a solicitação.

Parâmetro:

beforeCancelProcess

Ocorre antes do cancelamento da solicitaçã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.

Parâmetros:

Eventos de Formulário Pai Filho

...

getChildrenFromTable
Esse evento retorna um mapa com todos os campos filhos de um Pai Filho a partir do seu tablename.

getChildrenIndexes
Esse evento retorna os índices dos registros (linhas) contidos em um Pai Filho a partir do seu tablename.

Quando utilizado em processos será necessário acessar a hAPI.

Exemplo:

var indexes = hAPI.getChildrenIndexes("itens");
 var total = 0;
 for (var i = 0; i < indexes.length; i++) {
 var fieldValue = parseInt(hAPI.getCardValue("descricao___" + indexes[i]));
 if (isNaN(fieldValue)){
 fieldValue = 0;
 }
 total = total + fieldValue;
 }

Eventos nas etapas dos processos

...

...

Liberar nova versão do processo

Quando liberar uma nova versão do processo configurado, o evento executado será:

• afterReleaseVersion

Salvar nova solicitação

Quando iniciar uma solicitação pelo menu Processos, é evento executado será:

...

• beforeStateEntry
• beforeTaskCreate
• afterTaskCreate
• afterStateEntry
• beforeSendData
• validateAvailableStates
• beforeTaskSave
• afterTaskSave
• afterProcessCreate

Criar nova solicitação

Quando iniciar uma solicitação pelo menu Processos, é evento executado será:

...

• beforeStateEntry
• beforeTaskCreate
• afterTaskCreate
• afterStateEntry
• beforeSendData
• validateAvailableStates
• beforeTaskSave
• afterTaskSave
• beforeTaskComplete
• afterTaskComplete
• beforeStateLeave
• afterStateLeave
• afterProcessCreatesetProcess
• onNotify

Visualizar solicitação

Quando acessar a Central de Tarefas, abrir uma solicitação já iniciada, os eventos executados serão:

• validateAvailableStatessetProcess
• checkComplementsPermission

...

Salvar solicitação

Quando acionar o botão Salvar a solicitação, os eventos executados serão:

...

• validateAvailableStates
• beforeTaskSave
• afterTaskSave

Movimentar solicitação

Quando movimentar a solicitação acionando o botão Enviar, os eventos executados serão:

...

• validateAvailableStates
• beforeTaskSave
• afterTaskSave
• beforeTaskComplete
• afterTaskComplete
• beforeStateLeave
• afterStateLeave
• beforeStateEntry
• beforeTaskCreate
• afterTaskCreate
• afterStateEntry
• beforeSendData
• onNotify

Movimentar para subprocesso

Quando movimentar a solicitação para subprocesso acionando o botão Enviar, os eventos executados serão:

• setProcess
• validateAvailableStates
• beforeTaskSave
• afterTaskSave
• beforeTaskComplete
• afterTaskComplete
• beforeStateLeave
• afterStateLeave
• beforeStateEntry
• subProcessCreated
• afterStateEntry
• BeforeSendData
• onNotify

Finalizar solicitação

Quando finalizar a solicitação acionando o botão Enviar, os eventos executados serão:

...

• validateAvailableStates
• beforeTaskSave
• afterTaskSave
• beforeTaskComplete
• afterTaskComplete
• beforeStateLeave
• afterStateLeave
• beforeStateEntry
• afterStateEntry
• afterProcessFinish
• beforeSendData

Cancelar solicitação

Quando usuário acessar solicitação já iniciada na Central de Tarefas para Cancelamento, os eventos executados serão:

...

o evento executado será:

• checkComplementsPermissions.

Quando acionar o botão Cancelar Solicitação, os eventos executados serão:

• setProcess
• beforeCancelProcess
• afterCancelProcess
• beforeSendData
• setProcess
• onNotify