What is an Odoo Wizard?

A wizard in Odoo is a popup window primarily used to perform user-defined actions. It operates using a Transient Model, which means the data it handles is stored temporarily and is automatically deleted from the database at regular intervals.

Steps to Create an Odoo Wizard Model

  1. Create the Model
    Define the wizard model with the necessary fields in a .py file.

python

Python
1from odoo import models, fields, api
2

3class SaleOrderDiscountWizard(models.TransientModel):
4    _name = 'sale.order.discount.wizard'
5    _description = 'Apply Discount to Sale Orders'
6

7    discount = fields.Float(string='Discount (%)', required=True)
8    sale_order_ids = fields.Many2many(
9        'sale.order',
10        string='Sale Orders',
11        required=True
12    )
13

14    def apply_discount(self):
15        for order in self.sale_order_ids:
16            for line in order.order_line:
17                line.discount = self.discount

Calling the Wizard from a Menu Item

To trigger a wizard from a menu item, the action parameter of the menu should reference the view ID of the wizard.

  1. Define the Wizard View
    Create an .xml file to define the wizard's view.

xml

HTML / XML
1<?xml version="1.0" encoding="utf-8"?>
2<odoo>
3    <!-- Define the wizard form view -->
4    <record id="sale_order_discount_wizard_view_form" model="ir.ui.view">
5        <field name="name">sale.order.discount.wizard.form</field>
6        <field name="model">sale.order.discount.wizard</field>
7        <field name="arch" type="xml">
8            <form string="Apply Discount">
9                <group>
10                    <field name="discount"/>
11                    <field name="sale_order_ids" widget="many2many_tags"/>
12                </group>
13                <footer>
14                    <button string="Apply" type="object" name="apply_discount" class="btn-primary"/>
15                    <button string="Cancel" class="btn-secondary" special="cancel"/>
16                </footer>
17            </form>
18        </field>
19    </record>
20

21    <!-- Define the wizard action -->
22    <record id="sale_order_discount_wizard_action" model="ir.actions.act_window">
23        <field name="name">Apply Discount</field>
24        <field name="type">ir.actions.act_window</field>
25        <field name="res_model">sale.order.discount.wizard</field>
26        <field name="view_mode">form</field>
27        <field name="view_id" ref="sale_order_discount_wizard_view_form"/>
28        <field name="target">new</field> <!-- Opens in a popup -->
29    </record>
30

31    <!-- Add the menu item to call the wizard -->
32    <menuitem id="sale_order_discount_wizard_menu_action" sequence="10" name="Apply Discount"
33              parent="sale.sale_order_menu" action="sale_order_discount_wizard_action"/>
34</odoo>

Integrate the Wizard into the Module

  1. Update __init__.py
    Include the .py file in the __init__.py of the models folder.

python

Python
1from . import sale_order_discount_wizard
  1. Update __manifest__.py
    Add the .xml file to the data section of the module's manifest.

python

Plain text
1'data': [
2    'views/sale_order_discount_wizard.xml',
3],

Apply Changes

  • Restart the Odoo server.
  • Upgrade the custom module.

The wizard will now be accessible through the menu and will function as defined.