Skip to main content

Workflow Button

Configuration reference: Botão de execução

Overview​

The Workflow Button component adds a button that a user clicks to run a workflow on demand. In the component picker it's listed simply as Workflow. Use it for actions that should stay behind an explicit click — approvals, status transitions, sending a document, generating a record in another feature — instead of firing automatically on a data change.

The dropdown lists workflows with a manual trigger, whatever the scope (the scope decides what data the run needs; see below).

Configuration​

SettingDescription
WorkflowThe manual-trigger workflow this button runs.
Texto do BotãoLabel shown on the button. Falls back to "Executar" when left empty.
Ícone do BotãoIcon shown on the button: Play, Transform, Enviar, Atualizar, Confirmar, Configurar.
Mensagem de Confirmação (Opcional)When set, a confirmation dialog with this message must be accepted before the workflow runs. Leave empty to run immediately on click.
Mostrar em TabelasShows the button in table views. On by default.
Mostrar em FormuláriosShows the button in form views. On by default.

Mostrar em Tabelas and Mostrar em Formulários only gate the Table and Form views. In the other views that can host this component - List, Calendar, Dashboard, Kiosk, Cards, Document - the button always renders. In card Kanban, the button only renders when the column is among the fields picked in "No cartão" (view config); with no fields picked (auto-pick), it doesn't render on its own.

In the Visibilidade section, the Mostrar apenas quando condition has an Efeito: Ocultar (the default) removes the button when the condition fails; Desativar keeps it visible but disabled, and the Mensagem quando desativado shows on hover and on click (with no message, "This action is not available for this record"). A disabled button never runs.

In different views​

View(s)Display
TableSmall filled icon button in the cell. Tooltip shows Texto do Botão (or "Executar" if left empty).
FormFull-width filled button with icon and label.
List, Calendar, Dashboard, DocumentSame full-width filled button as Form - always shown, regardless of the toggles above.
Kiosk, CardsCompact action chip with the label - always shown.
KanbanCompact action chip with the label - shown when the column is in the card's fields ("No cartão", in the view config), in the order set there.

What happens on click​

  1. If no workflow is selected, or the row/feature data the workflow needs isn't available, the click fails immediately with a warning — no dialog shown.
  2. The button resolves the workflow's scope first (Genérico, Linha, Feature or Vista):
    • Genérico — runs with no row data. Works from any view, including dashboards.
    • Feature — collects all rows from the workflow's source feature. Works from any view.
    • Linha — needs the record the button is attached to. If the button isn't placed inside a table row or an open form (for example, on a dashboard), it stops with: "Este workflow dispara a partir de uma linha — use o botão dentro de uma linha ou formulário".
    • Vista — not supported by this button. Clicking shows: "Este workflow dispara a partir da vista — use a ação global da vista (barra de ferramentas)". Use the view's own toolbar action for view-scoped workflows instead.
  3. Only once that resolves does the confirmation dialog appear, if Mensagem de Confirmação (Opcional) is set. Declining it cancels the run — nothing else happens.
  4. Once confirmed (or immediately, if there's no confirmation message), the workflow runs and a snackbar reports the outcome ("Run iniciado." on success, an error message otherwise).

Visibility rules​

The Visibilidade section takes one or more conditions, combined with and/or in order. Each condition compares a column of the current row (by column name) with a value. The Efeito decides what happens when the rules fail: Ocultar removes the button, Desativar keeps it visible but disabled with the optional Mensagem quando desativado. Old buttons with a single legacy condition keep working and are converted when edited.

Open form: view, prefill and workflow after save​

With Abrir formulário da feature:

  • Vista do formulário picks which form view of the target feature opens; empty uses the default one.
  • Parâmetros prefill the new record, each field from a column of the current row or from a fixed value. A name is in only one of the two lists.
  • Workflow depois de guardar runs a manual-trigger workflow once the form saves. The saved record is the workflow's row, and the button's record is available as vars.origin.

Tips​

  • If the button seems to do nothing, check that the selected workflow's scope matches where you placed the button — a Linha-scoped workflow needs to live inside a row or form, not on a dashboard.
  • Use Mensagem de Confirmação (Opcional) for destructive or hard-to-reverse actions (deletions, sending emails, external API calls).
  • If no workflow appears in the Workflow dropdown, the workspace has no eligible manual-trigger workflow yet — create one first in the Workflows admin section.