#Evento de Ação Personalizada

#Introdução

NocoBase já vem com ações de dados comuns (adicionar, excluir, atualizar, visualizar, etc.). No entanto, quando essas ações não são suficientes para atender a necessidades de negócios mais complexas, você pode usar eventos de ação personalizada em um fluxo de trabalho. Ao vincular esse evento a um botão "Acionar Fluxo de Trabalho" em um bloco de página, um fluxo de trabalho de ação personalizada será acionado quando o usuário clicar nele.

#Criar um Fluxo de Trabalho

Ao criar um fluxo de trabalho, selecione "Evento de Ação Personalizada":

#Configuração do Acionador

#Tipo de Contexto

v.1.6.0+

O tipo de contexto define a quais botões de bloco o fluxo de trabalho pode ser vinculado:

• Sem Contexto: Um evento global que pode ser vinculado a botões de ação na Barra de Ações e em blocos de dados.
• Registro Único: Pode ser vinculado a botões de ação em blocos de dados como linhas de tabela, formulários e detalhes.
• Múltiplos Registros: Pode ser vinculado a botões de ação em massa em uma tabela.

#Coleção

Quando o tipo de contexto é Registro Único ou Múltiplos Registros, você precisa selecionar a coleção à qual o modelo de dados será vinculado:

#Dados de Associação a Serem Usados

Se você precisar usar os dados de associação da linha de dados acionadora no fluxo de trabalho, pode selecionar campos de associação profundos aqui:

Esses campos serão automaticamente pré-carregados no contexto do fluxo de trabalho após o evento ser acionado, tornando-os disponíveis para uso no fluxo de trabalho.

#Configuração da Ação

A configuração dos botões de ação em diferentes blocos varia de acordo com o tipo de contexto configurado no fluxo de trabalho.

#Sem Contexto

v.1.6.0+

Na Barra de Ações e em outros blocos de dados, você pode adicionar um botão "Acionar Fluxo de Trabalho":

Após adicionar o botão, vincule o fluxo de trabalho sem contexto criado anteriormente. Veja um exemplo usando um botão na Barra de Ações:

#Registro Único

Em qualquer bloco de dados, um botão "Acionar Fluxo de Trabalho" pode ser adicionado à barra de ações para um único registro, como em formulários, linhas de tabela, detalhes, etc.:

Após adicionar o botão, vincule o fluxo de trabalho criado anteriormente:

Em seguida, clicar neste botão acionará o evento de ação personalizada:

#Múltiplos Registros

v.1.6.0+

Na barra de ações de um bloco de tabela, ao adicionar um botão "Acionar Fluxo de Trabalho", há uma opção adicional para selecionar o tipo de contexto: "Sem Contexto" ou "Múltiplos Registros":

Quando "Sem Contexto" é selecionado, trata-se de um evento global e só pode ser vinculado a fluxos de trabalho do tipo sem contexto.

Quando "Múltiplos Registros" é selecionado, você pode vincular um fluxo de trabalho do tipo múltiplos registros, que pode ser usado para ações em massa após selecionar vários registros (atualmente, apenas tabelas suportam isso). Os fluxos de trabalho disponíveis são limitados àqueles configurados para corresponder à coleção do bloco de dados atual:

Ao clicar no botão para acionar, algumas linhas de dados na tabela devem estar selecionadas; caso contrário, o fluxo de trabalho não será acionado:

#Exemplo

Por exemplo, temos uma coleção de "Amostras". Para amostras com o status "Coletado", precisamos fornecer uma ação de "Enviar para Inspeção". Essa ação primeiro verificará as informações básicas da amostra, depois gerará um "Registro de Inspeção" e, por fim, mudará o status da amostra para "Enviado". Essa série de processos não pode ser concluída com simples cliques em botões de "adicionar, excluir, atualizar, visualizar", então um evento de ação personalizada pode ser usado para implementá-la.

Primeiro, crie uma coleção de "Amostras" e uma coleção de "Registros de Inspeção", e insira alguns dados de teste básicos na coleção de Amostras:

Em seguida, crie um fluxo de trabalho de "Evento de Ação Personalizada". Se você precisar de feedback rápido do processo da operação, pode escolher o modo síncrono (no modo síncrono, você não pode usar nós assíncronos como processamento manual):

Na configuração do acionador, selecione "Amostras" para a coleção:

Organize a lógica no processo de acordo com os requisitos de negócio. Por exemplo, permita o envio para inspeção apenas quando o parâmetro do indicador for maior que 90; caso contrário, exiba uma mensagem relevante:

Após configurar e habilitar o fluxo de trabalho, retorne à interface da tabela e adicione um botão "Acionar Fluxo de Trabalho" na coluna de ações da tabela:

Em seguida, no menu de configuração do botão, escolha vincular um fluxo de trabalho e abra a janela pop-up de configuração:

Adicione o fluxo de trabalho habilitado anteriormente:

Após enviar, altere o texto do botão para o nome da ação, como "Enviar para Inspeção". O processo de configuração está agora completo.

Para usar, selecione qualquer dado de amostra na tabela e clique no botão "Enviar para Inspeção" para acionar o evento de ação personalizada. Conforme a lógica organizada anteriormente, se o parâmetro do indicador da amostra for menor que 90, o seguinte aviso será exibido após o clique:

Se o parâmetro do indicador for maior que 90, o processo será executado normalmente, gerando um "Registro de Inspeção" e alterando o status da amostra para "Enviado".

Com isso, um evento de ação personalizada simples está completo. Da mesma forma, para negócios com operações complexas, como processamento de pedidos ou envio de relatórios, eventos de ação personalizada podem ser usados para a implementação.

#Chamada Externa

O acionamento de eventos de ação personalizada não se limita às ações da interface do usuário; ele também pode ser acionado por meio de chamadas de API HTTP. Especificamente, os eventos de ação personalizada fornecem um novo tipo de ação para todas as ações de coleção para acionar fluxos de trabalho: trigger, que pode ser chamado usando a API de ação padrão do NocoBase.

Um fluxo de trabalho acionado por um botão, como no exemplo, pode ser chamado assim:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' \
  "http://localhost:3000/api/samples:trigger/<:id>?triggerWorkflows=workflowKey"

Como esta ação é para um único registro, ao chamá-la em dados existentes, você precisa especificar o ID da linha de dados, substituindo a parte <:id> na URL.

Se for chamado para um formulário (como para criar ou atualizar), você pode omitir o ID para um formulário que cria novos dados, mas deve passar os dados enviados como contexto de execução:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "title": "Sample 1",
    "indicator": 91
  }'
  "http://localhost:3000/api/samples:trigger?triggerWorkflows=workflowKey"

Para um formulário de atualização, você precisa passar tanto o ID da linha de dados quanto os dados atualizados:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "title": "Sample 1",
    "indicator": 91
  }'
  "http://localhost:3000/api/samples:trigger/<:id>?triggerWorkflows=workflowKey"

Se um ID e dados forem passados simultaneamente, a linha de dados correspondente ao ID será carregada primeiro, e então as propriedades do objeto de dados passado serão usadas para sobrescrever a linha de dados original, obtendo assim o contexto final dos dados acionadores.

Além disso, o parâmetro de URL triggerWorkflows é a chave do fluxo de trabalho; múltiplas chaves de fluxo de trabalho são separadas por vírgulas. Essa chave pode ser obtida passando o mouse sobre o nome do fluxo de trabalho na parte superior da tela do fluxo de trabalho:

Após uma chamada bem-sucedida, o evento de ação personalizada para a coleção samples correspondente será acionado.

Se você precisar acionar um evento para dados de associação um-para-um (um-para-muitos não é suportado atualmente) nesta ação, pode usar ! no parâmetro para especificar os dados acionadores do campo de associação:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' \
  "http://localhost:3000/api/posts:trigger/<:id>?triggerWorkflows=workflowKey!category"

Após uma chamada bem-sucedida, o evento de ação personalizada para a coleção categories correspondente será acionado.