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 language js
  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 marca uma atividade comum como uma automática, isso significa que ela tem comportamentos semelhantes a uma atividade automática, incluindo que ela não gera 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.

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.
  
  

function afterTaskCreate(colleagueId) {
	var data = new Date();
	
	//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 processo = getValue("WKNumProces");
	
	// Seta o prazo para as 14:00
	hAPI.setDueDate(processo, 0, colleagueId, data, 50400);
}

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.

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

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

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:

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.
  
  

Exemplo:

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.

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

• documento: anexo workflow a ser publicado no GED.
  
  

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

attachDocument(documentId)

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

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:

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:

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

Ocorre após o cancelamento da solicitação. É recomendado não disparar exceções neste método, pois o cancelamento já foi realizado.

• Usuário corrente (String);
• Número do processo (Integer).

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

• Número do novo processo (Integer).

Ocorre após finalizada a solicitação.

• Número do processo (Integer).

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

• XML com a definição do processo (String).

• Sequência da atividade (Integer).

• Sequência da atividade (Integer).

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.

• Usuário corrente (String);
• Sequência da próxima atividade (Integer);
• Lista de usuários destino (List<String>).

• Matrícula do usuário (String).

Ocorre após salvar as informações selecionadas pelo usuário.

• Usuário corrente (String);
• Sequência da próxima atividade (Integer);
• Lista de usuários destino (List<String>).

Ocorre antes do cancelamento da solicitação.

• Usuário corrente (String);
• Número do processo (Integer).

• Sequência da atividade (Integer).

• Sequência da atividade (Integer).

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.

• Usuário corrente (String);
• Seqüência da próxima atividade (Integer);
• Lista de usuários destino (List<String>).

• Matrícula do usuário (String).

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

• Usuário corrente (String);
• Sequência da próxima atividade (Integer);
• Lista de usuários destino (List<String>).

Ocorre após o cálculo do consenso (somente para atividades conjuntas) e permite alterar os dados do consenso de uma atividade.

Exemplo:

function calculateAgreement(currentState, agreementData) {
	log.info("Consenso Atual: " + agreementData.get("currentPercentage"));
	log.info("Atividade Destino Atual: " +  agreementData.get("currentDestState"));
	log.info("Usuario Destino Atual: " + agreementData.get("currentDestUsers"));
	
	//Altera o consenso
	agreementData.put("currentPercentage", 100);
	agreementData.put("currentDestState", 2);
	agreementData.put("currentDestUsers", "adm,teste,super");
}

• currentState (Integer): atividade que terá o consenso alterado;
• agreementData (Map<String, Object>): mapa de dados com o percentual calculado, a atividade destino e os usuários de destino. Para obter os valores, utilize o método "get" e para atribuir um valor, utilize o método "put".

Se refere a um evento global que ocorre após a movimentação da solicitação e antes de enviar as notificações.

Ocorre quando um processo é "setado" na API.

• Número do processo (Integer).

• Número do sub-processo (Integer).

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

• Sequência da atividade atual (Integer);
• Lista das sequências das atividades (List<Integer>).  

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:

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:

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:

• documentId: id do documento;
• version: versão do documento;
  
  

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.

É executada quando o usuário pressiona o botão Movimentar antes de serem exibidas as opções de movimentação do processo.

Parâmetros:

• • numState: número da atividade atual.

Opcionais:

• • return false: impedirá a execução do processo. Esta opção permite que sejam exibidos erros personalizados no formulário.
  • throw(“Erro”): impedirá a execução e exibirá uma tela de erro padrão do fluig com o texto informado.

Exemplo:

var beforeMovementOptions = function(numState){
	console.log("-beforeMovementOptions-");
	console.log("numState: " + numState);	
	console.log("valor campo Email: " +document.formulario.email.value);
	if(document.cad01.nome.value === 'false'){
		return false;
	}
	if(document.cad01.nome.value !== ''){
		throw("Erro " + document.formulario.nome.value);
	}
}

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:

• • numState: número da atividade atual.
  • nextState: número da atividade destino.

Opcionais:

• • return false: impedirá a execução do processo. Esta opção permite que seja exibido um erro personalizado no formulário.
  • throw(“Erro”): impedirá a execução e exibirá uma tela de erro padrão do fluig com o texto informado.

Exemplo:

var beforeSendValidate = function(numState,nextState){
	console.log("-beforeSendValidate-");
	console.log("numState: " + numState);
	console.log("nextState: " + nextState);	
	throw("Erro Xyz");
}