Assistente

Dividir os dados de um formulário por páginas com Voltar e Seguinte

O que é um assistente?

Um assistente (wizard) transforma um único formulário numa sequência de páginas. Cada página é construída a partir de um subform e o utilizador navega com os botões Voltar e Seguinte. A validação é aplicada página a página: o utilizador não pode avançar enquanto o passo atual não for válido, a menos que o passo esteja marcado como optional.

No fim de cada assistente é acrescentada automaticamente uma página de revisão só de leitura. Enumera cada passo com os valores recolhidos, para que o utilizador os possa confirmar antes de submeter. A página de revisão não é declarada em YAML; o seu título vem do idioma ativo.

Ao submeter, os valores recolhidos em todos os passos são juntados num único conjunto de extravars e enviados para o playbook, template ou workflow subjacente, exatamente como se o utilizador tivesse preenchido um único formulário grande.

Um formulário com wizard não precisa dos seus próprios fields, mas não pode definir enableForChat, e um subform não pode ter ele próprio um wizard. A validação no lançamento verifica o lançamento de um assistente passo a passo.

Para saber como um wizard difere de um workflow e como os dois se combinam, consulte a entrada das FAQ Qual é a diferença entre um assistente e um workflow?.

Propriedade ao nível do formulário

Um assistente ativa-se com uma única propriedade ao nível do formulário:

Atributo Comentários
wizard
array
adicionado na versão 6.4.0

Wizard steps (form-layer)

Turn a form into a multi-page wizard.
Where steps splits the execution into multiple jobs, wizard splits the input of a single form into multiple pages.
Each wizard step references a subform and is rendered as its own page with Back / Next navigation. A read-only review page is appended automatically as the last step — you do not declare it in YAML.
See the Wizard page for all step properties and examples.

Exemplos:

1) Three-step wizard

name: Provision host
type: ansible
roles:
  - default
playbook: provision.yml
wizard:
  - subform: basics
    title: Basics
  - subform: network
    title: Network
    defaultModel: net
  - subform: advanced
    title: Advanced
    optional: true
    when: $(__parent__.basics.kind) === 'vm'

2) Wizard mapped one-to-one onto multistep (defaultModel + key)

name: Provision and verify host
type: multistep
roles:
  - default
wizard:
  - subform: basics
    title: Basics
    defaultModel: basics      # wraps fields under `basics`
  - subform: network
    title: Network
    defaultModel: network     # wraps fields under `network`
steps:
  - name: Create host
    type: ansible
    playbook: create_host.yml
    key: basics                # receives only the basics payload
  - name: Configure network
    type: ansible
    playbook: configure_network.yml
    key: network                # receives only the network payload

Propriedades dos passos do assistente

Each wizard step references a subform and is rendered as its own page with Back and Next navigation. The user must validate one step before moving to the next; data from earlier steps is available in later steps via __parent__.

Review step is automatic. A read-only summary page that lists every step’s input is appended as the last page of the wizard. You do not declare it in YAML — its title is taken from the active locale (“Summary” / “Samenvatting” / “Zusammenfassung” / …).

Wizard vs Multistep. steps splits the execution into multiple sequential jobs (each step is its own playbook/template). wizard splits the input of a single form into multiple pages — only one job runs at the end. The two can be combined: a type: multistep form can also have a wizard: block to gather its extravars across pages.

Atributo Comentários
basic
subform
string / obrigatório

Subform reference
a valid subform name

The name of a type: subform form to render on this wizard page. The subform’s fields become this step’s inputs.

Exemplos:

1) Reference a subform

wizard:
  - subform: basics
  - subform: network
name
string

Step namespace key
alphanumeric + dash + underscore

The key under which this step’s values are exposed to later steps via $(__parent__.<name>.<field>).
Defaults to the value of subform when omitted.
Set this explicitly when you reuse the same subform multiple times in the same wizard, or when you want a stable key independent of the subform name.

Exemplos:

1) Override the namespace

wizard:
  - subform: address
    name: shipping
  - subform: address
    name: billing
title
string

Page title in the stepper
free text

Title shown in the wizard stepper and at the top of the page.
Defaults to the subform’s description, or to the step’s name if no description is set.

Exemplos:

1) Custom title

wizard:
  - subform: basics
    title: Tell us about your host
help
string

Help text shown on this page
free text (markdown supported)

Help text rendered on the wizard page. Defaults to the subform’s own help when omitted.
showHelp
boolean

Show help on load
true, false

When true, the help block is expanded by default when the user lands on this page. Falls back to the subform’s showHelp when omitted.

Predefinição:
false
defaultModel
string

Wrap this step's output under a prefix
a model path (dot notation allowed)

Wraps every field of this step under the given object key in the final extravars payload. Useful when you reuse a generic subform and want its values namespaced.
Without defaultModel, fields are merged into the top level of the extravars (still grouped per step under __parent__ for cross-step references).

Exemplos:

1) Wrap network fields under `net`

wizard:
  - subform: network
    defaultModel: net

# The subform has fields `hostname` and `ipv4`.
# Final extravars contain:
#   net:
#     hostname: ...
#     ipv4: ...
workflow
when
expression

Conditionally show this step
a JavaScript expression returning truthy/falsy

When the expression evaluates falsy, the step is hidden entirely — the user never sees it and its values are not collected.
The expression has access to all earlier steps via __parent__.<stepname>.<field>. Steps after a hidden one are renumbered automatically.
Note: when is purely about visibility; it is unrelated to optional, which is about whether the user is allowed to skip a visible step.

Exemplos:

1) Only show when kind is "vm"

wizard:
  - subform: basics       # has a `kind` enum field
  - subform: advanced
    when: $(__parent__.basics.kind) === 'vm'
optional
boolean

Allow skipping this step
true, false

When true, the user can press Next even if the step’s fields are not (yet) valid, and Submit is allowed without ever visiting this step.
The step is still shown in the stepper — use when if you want to hide it altogether.

Predefinição:
false

Exemplos:

1) Optional advanced page

wizard:
  - subform: basics
  - subform: advanced
    optional: true
Exemplos

1) Minimal wizard (review page is auto-added)

- name: Provision host
  type: ansible
  roles:
    - default
  playbook: provision.yml
  wizard:
    - subform: basics
    - subform: network

- name: basics
  type: subform
  fields:
    - name: hostname
      type: text
      required: true

- name: network
  type: subform
  fields:
    - name: ipv4
      type: text

2) Cross-step reference and namespace prefix

wizard:
  - subform: basics
    title: Basics
  - subform: network
    title: Network
    defaultModel: net          # wraps network fields under `net`

# In the `network` subform you can reference fields
# from the `basics` step like this:
#   default: $(__parent__.basics.hostname).local

Combinar um assistente com um workflow

Um assistente pode ser colocado por cima de um formulário de workflow. Quando o defaultModel de cada passo do assistente corresponde ao extra_vars_key do nó de workflow correspondente, cada playbook ou template recebe só os valores da sua própria página do assistente.

As FAQ contêm um exemplo completo e a estrutura das extravars juntadas: Qual é a diferença entre um assistente e um workflow? (secção Combinados (assistente por cima de um workflow)).

Um assistente num formulário multistep, que está obsoleto, funciona da mesma forma, com a key do passo em vez de extra_vars_key.

Ver também

Páginas e entradas das FAQ relacionadas: