v 13.0 Third Party 955
Download for v 13.0 Deploy on Odoo.sh
Odoo Online
On Premise
Lines of code 80
Technical Name multi_step_wizard
Versions 14.0 12.0 13.0 11.0 15.0 16.0
You bought this module and need support? Click here!

Multi-Steps Wizards

Beta License: AGPL-3 OCA/server-ux Translate me on Weblate Try me on Runboat

This module is a base for creating multi-steps wizards. It does nothing by itself.

Table of contents


Example of class:

class MyWizard(models.TransientModel):
    _name = 'my.wizard'
    _inherit = ['multi.step.wizard.mixin']

    project_id = fields.Many2one(
        default=lambda self: self._default_project_id(),
    name = fields.Char()
    field1 = fields.Char()
    field2 = fields.Char()
    field3 = fields.Char()

    def _selection_state(self):
        return [
            ('start', 'Start'),
            ('configure', 'Configure'),
            ('custom', 'Customize'),
            ('final', 'Final'),

    def _default_project_id(self):
        return self.env.context.get('active_id')

    def state_exit_start(self):
        self.state = 'configure'

    def state_exit_configure(self):
        self.state = 'custom'

    def state_exit_custom(self):
        self.state = 'final'

Example of view (note the mode, must be primary):

<?xml version="1.0" encoding="utf-8"?>

  <record id="my_wizard_form" model="ir.ui.view">
    <field name="name">my.wizard.form</field>
    <field name="model">my.wizard</field>
    <field name="mode">primary</field>
    <field name="inherit_id" ref="multi_step_wizard.multi_step_wizard_form"/>
    <field name="arch" type="xml">
      <xpath expr="//footer" position="before">
          <field name="name"
                attrs="{'readonly': [('state', '!=', 'start')]}"
        <group name="configure" attrs="{'invisible': [('state', '!=', 'configure')]}">
            <field name="field1"/>
            <field name="field2"/>
        <group name="custom" attrs="{'invisible': [('state', '!=', 'custom')]}">
            <field name="field3"/>
        <div name="final" attrs="{'invisible': [('state', '!=', 'final')]}">
          <p>The project is now configured.</p>

  <act_window id="open_my_wizard"
              name="My Wizard"
              view_mode="form" target="new" view_type="form" />

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.



  • Camptocamp



This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/server-ux project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author, please use the developer contact information. They can usually be found in the description.
Please choose a rating from 1 to 5 for this module.