Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.



Painel
borderColor#f2f2f2
bgColor#f2f2f2

A hAPI é uma API (Application Programming Interface) disponibilizada pela plataforma Fluig que permite o acesso a diversas funcionalidades do sistema. Essa API é amplamente utilizada no desenvolvimento de processos e aplicações personalizadas, e é fundamental para quem deseja tirar o máximo proveito da plataforma. Nesta documentação, apresentaremos as principais funções da hAPI e como utilizá-las.


Descrição

...

O objeto mais importante nos eventos de processo é a hAPI (nova). Com ele o desenvolvedor pode consultar e atribuir dados do formulário, obter informações da movimentação como id do histórico de movimentação, thread, atividades para onde a solicitação atual pode ser movimentada, outras atividades ativas, solicitação que gerou a solicitação atual (no caso de ser um sub-processo), link para uma determinada atividade (que pode ser usado para o envio de notificações), calcular prazo de conclusão dinamicamente, trabalhar com os anexos da solicitação (adicionando, listando, ou publicando os itens atuais no GED) e atribuir valores como prazo de conclusão, comentários.

...

String getCardValue(String fieldName)

  • Retorna o valor do campo fieldName no formulário 


void setCardValue(String fieldName, String newValue)

  • Define o valor newValue ao campo de formulário fieldName


Map<String,String> getCardData(int instanceId)

  • Retorna todos os dados do formulário da solicitação instanceId.


void addCardChild(String tableName, Map<String, String> childData)

  • Adiciona um novo registro filho na tabela tableName com os dados childData.


boolean removeCardChild(String tableName, int index)

  • Remove o registro filho de ordem index da tabela tableName.


List<Integer> getChildrenInstances(int instanceId)

  • Retorna uma lista com os número de solicitações da solicitações geradas diretamente a partir da solicitação instanceId.


Integer Integer getParentInstance(int instanceId)

  • Retorna o número da solicitação que originou a solicitação atual, ou zero, caso não seja um subprocesso.


List<Integer> getActiveStates()

  • Retorna uma lista com os códigos de atividades ativas na solicitação atual


void setDueDate(int instanceId, int threadSequence, String userId, Object data, int timeInSeconds)

  • Define a data data e horário timeInSeconds a tarefa atual da thread threadSequence do usuário userId da solicitação instanceId


void transferTask(List<String> users, String comment, int threadSequence)

  • Transfere uma atividade ativa na thread threadSequence da solicitação atual para os usuários users e adiciona o comentário comment.


void transferTask(List<String> users, String comment)

  • Transfere uma atividade ativa na thread 0 da solicitação atual para os usuários users e adiciona o comentário comment.


WorkflowSaveAndSendResultVO startProcess(String processId, int chosenState, List<String> colleagues, String comments, boolean completeTask, Map cardData, Boolean managerMode)

  • Inicia uma solicitação do processo processId, encaminhando pra tarefa chosenState e para os usuários colleagues com o comentário comments  e dados de formulário cardData.


Cloak

setColleagueReplacement(userId)

setTaskComments("userId", numProcesso,  numThread, "obs")


getAdvancedProperty("propriedade")

calculateDeadLineHours(data, segundos, prazo, periodId)

calculateDeadLineTime(data, segundos, prazo, periodId)

getUserTaskLink(numAtiv)

createAdHocTasks(workflowProcessInstanceId, sequenceId, assunto, detalhamento, listatvidadesAhoc)

listAttachments()

publishWorkflowAttachment(documento)

attachDocument(documentId)

getAvailableStatesDetail(companyId, userId, processId, processInstanceId, threadSequence)


Retorna o código de documento do registro de formulário atual


Retorna a versão do registro de formulário atual


Retorna o código do formulário do qual o registro de formulário pertence


Retorna o valor do campo fieldname no registro de formulário atual. 


depreciadoDepreciado:

getActualThread

setDueDate(long companyId, int processInstanceId, int movementSequence, String userId, Date newDueDate,
            int timeInSeconds)


<working in progress>

<

...