Wizard

Suddividere l’input di un modulo su più pagine con Indietro e Avanti

Che cos’è un wizard?

Un wizard trasforma un singolo modulo in una sequenza di pagine. Ogni pagina viene generata da un subform e l’utente si sposta con i pulsanti Indietro e Avanti. La convalida avviene pagina per pagina: l’utente non può andare avanti finché il passo corrente non è valido, a meno che il passo non sia contrassegnato come optional.

Alla fine di ogni wizard viene aggiunta automaticamente una pagina di riepilogo in sola lettura. Elenca ogni passo con i valori raccolti, così l’utente può confermarli prima dell’invio. La pagina di riepilogo non si dichiara in YAML; il suo titolo viene preso dalla lingua attiva.

All’invio, i valori raccolti in tutti i passi vengono uniti in un unico payload di extravars e inviati al playbook, template o workflow sottostante, esattamente come se l’utente avesse compilato un unico grande modulo.

Un modulo con un wizard non ha bisogno di fields propri, ma non può impostare enableForChat, e un subform non può avere a sua volta un wizard. La validazione all’avvio controlla l’avvio di un wizard passo per passo.

Per capire in cosa un wizard si differenzia da un workflow, e come si combinano, vedi la voce delle FAQ Qual è la differenza tra un wizard e un workflow?.

Proprietà a livello di modulo

Un wizard si attiva con una sola proprietà a livello di modulo:

Attributo Commenti
wizard
array
added in version 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.

Esempi:

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

Proprietà dei passi del wizard

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.

Attributo Commenti
basic
subform
string / obbligatorio

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.

Esempi:

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.

Esempi:

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.

Esempi:

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.

Predefinito:
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).

Esempi:

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.

Esempi:

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.

Predefinito:
false

Esempi:

1) Optional advanced page

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

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

Combinare un wizard con un workflow

Un wizard si può sovrapporre a un modulo workflow. Quando il defaultModel di ogni passo del wizard corrisponde alla extra_vars_key del nodo di workflow corrispondente, ogni playbook o template riceve solo i valori della propria pagina del wizard.

Le FAQ contengono un esempio completo e la struttura delle extravars unite: Qual è la differenza tra un wizard e un workflow? (sezione Combinati (wizard sopra un workflow)).

Un wizard su un modulo multistep, deprecato, funziona allo stesso modo, con la key del passo al posto di extra_vars_key.

Vedi anche

Pagine correlate e voci delle FAQ: