Histórico da Página

Permite acessar o valor de um campo do formulário do processo, onde:

• nomeCampo: nome do campo do formulário. 

var campoCheckbox = hAPI.getCardValue("campoCheckbox") == "on" ? true : false;

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;

function beforeStateEntry(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");
         
    }
}

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.

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:

• numProcesso: número da solicitação;
• numThread: número da thread (normalmente 0, quando não se utiliza atividades paralelas);
• userId: o usuário responsável pela tarefa;
• dataConclusao: a nova data de conclusão;

• tempoSeg: tempo que representa a nova hora de conclusão, calculado em segundos após a meia-noite.

  Informações

  Recomendamos a utilização deste método no evento afterTaskCreate, pois será executado logo após a criação da tarefa. Exemplo: Bloco de código language js theme Eclipse firstline 1 linenumbers true function afterTaskCreate(colleagueId) { var atividade = getValue('WKCurrentState'); // Atividade de sequência 5 é a da tarefa criada e que vou alterar o prazo de conclusão if (atividade == 5) { // Recuperando a data informada no campo do formulário var prazoFormulario = hAPI.getCardValue('prazoConclusao'); if (prazoFormulario != undefined && prazoFormulario != '') { var numeroDaSolicitacao = getValue('WKNumProces'); var threadDaSolicitacao = 0; // Normalmente 0, quando não for atividade paralela var responsavelPelaTarefa = colleagueId; /* Nesse caso o formato da data salva pelo formulário no exemplo é DD/MM/AAAA, mas isso pode variar de acordo com a formatação utilizada,  mudando assim as posições das informações dentro do array */ /* Extrai os dados da data do formulário para um array, para posteriormente transformar em data do Javascript */ var arrayPrazoConclusao = prazoFormulario.split("/"); var dia = arrayPrazoConclusao[0]; // Posição 0 do array é o dia var mes = arrayPrazoConclusao[1] - 1; // Posição 1 do array é o mês (Subtraímos 1 porque na data do Javascript o mês vai de 0 a 11) var ano = arrayPrazoConclusao[2]; // Posição 2 do array é o ano var horaDoPrazo = (24*60*60) - 1; /* A hora é em milisegundos, e esse cálculo tem resultado de 23:59:59, ou seja,  o prazo de conclusão vai ser até o último segundo do dia informado no formulário */ // Cria a data no Javascript var dataDoPrazo = new Date(); dataDoPrazo.setDate(dia); dataDoPrazo.setMonth(mes); dataDoPrazo.setFullYear(ano); // Altera o prazo de conclusão hAPI.setDueDate(numeroDaSolicitacao, threadDaSolicitacao, responsavelPelaTarefa, dataDoPrazo, horaDoPrazo); } } }

Inicia uma solicitação workflow, onde:

• processId: código do processo;
• ativDest: código da 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.

Exemplo de inicialização de uma solicitação pelo método hAPI.startProcess enviando a atividade para um papel:

function beforeStateEntry(sequenceId){
	
	if (sequenceId == 5) {
		//A tarefa destino tem o mecanismo de atribuição para um papel, cujo o código é papelUser
		var users = new java.util.ArrayList();
		users.add("Pool:Role:papelUser");
		
		var formData = new java.util.HashMap();
 
		formData.put("Nome_do_Campo1", "Valor do Campo 1");
        formData.put("Nome_do_Campo2", "Valor do Campo 2");
						
		hAPI.startProcess("pool", 4, users, "Solicitação inicializada pela função hAPI", true, formData, false);
	}
	
}

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.
  
  

Retorna um Mapa com todos os campos e valores do formulário da solicitação.

• numProcesso: número da solicitação de processo.
  
  

calculateDeadLineHours(data, segundos, prazo, periodId)

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:

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:

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

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

• workflowProcessInstanceId: número da solicitação workflow no qual se deseja criar as tarefas;
• sequenceId: código de sequencia da atividade de SubprocessoAdhoc;
• Assunto: assunto da listagem das tarefas que será repassado ao formulário de atividade ad-hoc;
• Detalhe: texto com o detalhamento das atividades em questão. Esse texto também será repassado para o formulário da atividade ad-hoc;

• listaAtividadesAdhoc: é a lista de atividades contento o que, quando e quem executará as tarefas ad-hoc.
  
  

  Nota
  title Atenção
  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:

function beforeStateEntry(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.

DocumentDto[ ]

Veja aqui os paramêtros do objeto DocumentDto e aqui os métodos para acesso as variáveis.

function beforeTaskSave(colleagueId, nextSequenceId, userList) {
    var attachments = hAPI.listAttachments();
    var hasAttachment = false;
 
    for (var i = 0; i < attachments.size(); i++) {
        var attachment = attachments.get(i);
        if (attachment.getDocumentDescription() == "fluig.pdf") {
            hasAttachment = true;
        }
    }
 
    if (!hasAttachment) {
        throw "Attachment not found!";
    }
}

Permite publicar anexos workflow da solicitação no GED do fluig, onde:

• documento: anexo workflow a ser publicado no GED.
  
  

  Nota
  title Atenção
  É obrigatório informar o id da pasta destino do documento através do método setParentDocumentId, conforme o exemplo abaixo.

  Dica
  title Importante
  Utiliza os parâmetros do objeto DocumentDto.

Exemplo:

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

Permite anexar documentos do GED a solicitação workflow, onde:

• documentId: código do documento a ser anexado a solicitação.
  
  

Exemplo:

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

Retorna uma lista com os números das solicitações filhas, onde:

• processInstanceId: número da solicitação pai.

Exemplo:

function beforeStateEntry(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:

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:

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

Remove uma linha de uma tabela Pai X Filho.

Utilize o método removeCardChild, passando o nome da tabela (valor do atributo name) e o número da linha que deseja deletar.

Exemplo:

removeCardChild(tableName, 1);

var indexes = hAPI.getChildrenIndexes("tableName");
for (var i = indexes.length-1; i >= 0; i--)
{ hAPI.removeCardChild("tableName", indexes[i]); }

var indexes = hAPI.getChildrenIndexes("tableName");
for (var i = indexes.length-1; i >= 0; i--)
{ if (indexes[i] == 1) \{ hAPI.removeCardChild("tableName", indexes[i]); }