Índice

Descrição

...

Este é um objeto de retorno do método de iniciar solicitação. Foi introduzido no fluig 1.8.1 e substitui o retorno anterior que era um mapa com chave do tipo string e valor do tipo Object. 

Por questões de retrocompatibilidade, este objeto também é um mapa. Então, todos os códigos que funcionavam antes, continuam funcionando sem problemas.

Atributos da instância

...

int processInstanceId

• Retorna um valor numérico com o id da solicitação.
• Caso a solicitação não tenha sido criada, retorna zero.

int taskSequence

• Retorna um valor numérico com o código da atividade atual.
• Caso a solicitação não tenha sido criada, retorna zero.

int condition

• Retorna um valor numérico referente a qual condição do gateway foi atendida para definir o próxima atividade.
• Caso a solicitação não tenha sido criada ou não tenha passado por um gateway, retorna zero.

int movementSequence

• Retorna um valor numérico com o código do histórico de movimentação .
• Caso a solicitação não tenha sido criada, retorna zero.

int documentId

• Retorna um valor numérico com o código do formulário associado à solicitação.
• Caso a solicitação não tenha sido criada ou não possua um formulário, retorna zero.

int documentVersion

• Retorna um valor numérico com a versão do formulário associado à solicitação.
• Caso a solicitação não tenha sido criada ou não possua um formulário, retorna zero.

boolean joint

• Retorna um valor booleano true quando a solicitação está em uma situação de paralelismo, ou seja, passou por um gateway paralelo (fork) ou inclusivo, ou false quando não passou.

String stateName

• Retorna uma string com o nome não traduzido da atividade atual da solicitação.
• Caso a solicitação não tenha sido criada, retorna uma string vazia.

String observation

• Retorna uma string com a observação criada na solicitação.
• Caso a solicitação não tenha sido criada ou nenhum comentário seja informado, retorna uma string vazia.

ProcessLink processLink

• Retorna um objeto ProcessLink indicando qual o fluxo foi utilizado para chegar na atividade atual da solicitação.
• Caso a solicitação não tenha sido criada, retorna null.

List<String>currentAssignees

• Retorna uma lista java de strings com as matrículas dos usuários responsáveis pela atividade.
• Caso a solicitação não tenha sido criada, retorna uma lista vazia.

boolean multipleUsers

• Retorna um valor booleano true indicando há mais um usuário possível para a atividade e que deve ser indicado qual o usuário correto ou false quando não há necessidade de escolha.
• No caso de uma atividade em consenso configurada para "Nunca selecionar colaboradores" ou atividades do tipo gateway esse retorno sempre será false.

List<Colleague> availableColleagues

• Retorna uma lista java de objetos do tipo Colleague com dados dos usuários que podem ser selecionados para a atividade no caso de não ter criado uma solicitação pois a múltiplos usuários que podem ser responsáveis pela atividade (multipleUsers).

boolean usingManagerUsers

• Retorna um valor booleano true quando, por não conseguir selecionar nenhum colaborador válido, atribuiu a atividade à um (ou mais) gestor do processo. Ou false quando não foi necessário ou possível utilizar o gestor.

List<Integer> subProcessInstancesIds

• Retorna uma lista java de valores numéricos com os códigos das solicitações de subprocessos que foram criadas após a movimentação.
• Caso nenhuma solicitação tenha sido criada por subprocessos, retorna uma lista vazia.

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 WorkflowSaveAndSendResultVO. 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.

Além disso, consegue tomar ações como transferir atividade e iniciar solicitações.

Pode ser utilizada em todos os eventos do processo (before, after, services e condicionais), evento de notificação (onNotify) e eventos globais (como displayCentralTask, afterSaveCard, entre outros). Neste último caso, por não estar associado diretamente à uma solicitação, nem todos os métodos está disponíveis e a documentação do método deve ser consultada antes do desenvolvimento.

Métodos da instância

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

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)

int getDocumentId()

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

int getVersion()

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

int getCardIndex()

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

int getValue(String fieldname)

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

depreciado:

getActualThread

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

<working in progress>

<