Ações

As ações são utilizadas para executar determinadas atividades a partir de uma interação do usuário com algum menu ou botão da plataforma. Ações podem estar em elementos do tipo botão dentro de um widget, podem ser definidas como itens do menu de um painel, ou mesmo diretamente como um botão de ação em um slot.

Criar uma ação

Para criar uma ação devemos definir alguns atibutos.

[
  {
    "code": "validate",
    "hideCondition": "${data.custom.valid}",
    "json": "{\"custom.valid\":true}",
    "label__translation": {
      "pt": "Validar"
    },
    "method": "patch",
    "securityAction": "kpi-validation",
    "url": "/structures/kpi/instances/${data.code}"
  }
]

O campo json define os dados que serão gravados no banco quando essa ação for executada. O valor desse atributo deve estar no formato json e como uma string.

O campo securityAction define um código que estará disponível na parte de segurança para que seja possível definir quais usuários podem executar essa ação.

INFO

Caso você queira definir uma permissção única para multiplas ações basta colocar o mesmo código no campo securityAction em todas as ações assim quando o usuário receber essa permissão ele vai ter acesso a todas as ações.

O campo method é utilizado para definir como será executada essa ação se será uma atualização, metodo patch, ou uma criação de uma nova instância, método post.

O campos url define qual será a URL utilizada para acessar a API da plataforma para salvar o dado.

O campo hideCondition é utilizado para saber se essa ação deve ser exibida ou não.

ATENÇÃO

Caso essa ação esteja sendo executada em um menu de um painel, lembre-se que todos os campos que você pretende usar tanto como referencia para o campo de "Regra para ocultar", seja para ser usado na URL, ou no próprio JSON devem estar disponíveis na fonte de dados do painel.

Clique aqui para saber mais sobre como incluir campos que não estão sendo utilizados como colunas pelo painel.