Onboarding Toolbox

onboarding · odoo/odoo

    Repository
    odoo/odoo · module folder
    Module version
    1.2
    Category
    Hidden
    Folder size
    0.96 MB
    License
    LGPL-3
    Application
    No
    Auto-installable
    No
    Website
    None
    Last tracking update
    2026-08-15 22:44:14
    Authors
    Odoo S.A.
    Maintainers
    Odoo S.A.
    Committers
    Odoo Translation Bot, Julien Castiaux, Tiffany Chang (tic), Gorash, Mathieu Duckerts-Antoine, Victor Piryns (pivi), Dylan Kiss (dyki), Antoine Boonen, Krzysztof Magusiak (krma)
    Odoo dependencies
    odoo/odoo:
    - web
    - base
    Python dependencies
    None
    System dependencies
    None
    Required by
    account, payment
    Description
    This module allows to manage onboardings and their progress
================================================================================

    Code Analysis ⓘ

    Views touched (7)
    XML IDNameModelTypeStatus
    onboarding_container onboarding_container ir.ui.view qweb New
    onboarding_onboarding_step_view_form onboarding.onboarding.step.view.form onboarding.onboarding.step form New
    onboarding_onboarding_step_view_tree onboarding.onboarding.step.view.list onboarding.onboarding.step list New
    onboarding_onboarding_view_form onboarding.onboarding.view.form onboarding.onboarding form New
    onboarding_onboarding_view_tree onboarding.onboarding.view.list onboarding.onboarding list New
    onboarding_panel onboarding_panel ir.ui.view qweb New
    onboarding_step onboarding_step ir.ui.view qweb New
    HTTP endpoints (0)

    No HTTP endpoints found for this module.

    Models touched (4)

    New fields (11)
    • current_onboarding_state Selection
      compute='_compute_current_progress' readonly=True string='Completion State' args: ONBOARDING_PROGRESS_STATES
    • current_progress_id Many2one → onboarding.progress
      compute='_compute_current_progress' help='Onboarding Progress for the current context (company).' args: 'onboarding.progress', 'Onboarding Progress'
    • is_onboarding_closed Boolean
      compute='_compute_current_progress' string='Was panel closed?'
    • is_per_company Boolean
      compute='_compute_is_per_company' readonly=True store=False args: 'Should be done per company?'
    • name Char
      translate=True args: 'Name of the onboarding'
    • panel_close_action_name Char
      help='Name of the onboarding model action to execute when closing the panel.' args: 'Closing action'
    • progress_ids One2many → onboarding.progress
      help='All Onboarding Progress Records (across companies).' readonly=True string='Onboarding Progress Records' args: 'onboarding.progress', 'onboarding_id'
    • route_name Char
      required=True args: 'One word name'
    • sequence Integer
      default=10
    • step_ids Many2many → onboarding.onboarding.step
      string='Onboarding steps' args: 'onboarding.onboarding.step'
    • text_completed Char
      default=<expr> help='Text shown on onboarding when completed' args: 'Message at completion'
    Public methods (5)
    • action_close(self)
      Close the onboarding panel.
    • action_close_panel(self, xmlid)
      @api.model
      Close the onboarding panel identified by its `xmlid`. If not found, quietly do nothing.
    • action_refresh_progress_ids(self)
      Re-initialize onboarding progress records (after step is_per_company change). Meant to be called when `is_per_company` of linked steps is modified (or per-company steps are added to an onboarding).
    • action_toggle_visibility(self)
    • write(self, vals)
      Recompute progress step ids if new steps are added/removed.

    New fields (15)
    • button_text Char
      default=<expr> help="Text on the panel's button to start this step" required=True translate=True args: 'Button text'
    • current_progress_step_id Many2one → onboarding.progress.step
      compute='_compute_current_progress' help='Onboarding Progress Step for the current context (company).' string='Step Progress' args: 'onboarding.progress.step'
    • current_step_state Selection
      compute='_compute_current_progress' string='Completion State' args: ONBOARDING_PROGRESS_STATES
    • description Char
      translate=True args: 'Description'
    • done_icon Char
      default='fa-star' args: 'Font Awesome Icon when completed'
    • done_text Char
      default=<expr> translate=True args: 'Text to show when step is completed'
    • is_per_company Boolean
      default=True args: 'Is per company'
    • onboarding_ids Many2many → onboarding.onboarding
      string='Onboardings' args: 'onboarding.onboarding'
    • panel_step_open_action_name Char
      help='Name of the onboarding step model action to execute when opening the step, e.g. action_open_onboarding_1_step_1' required=False string='Opening action'
    • progress_ids One2many → onboarding.progress.step
      help='All related Onboarding Progress Step Records (across companies)' readonly=True string='Onboarding Progress Step Records' args: 'onboarding.progress.step', 'step_id'
    • sequence Integer
      default=10
    • step_image Binary
      args: 'Step Image'
    • step_image_alt Char
      default='Onboarding Step Image' help='Show when impossible to load the image' translate=True args: 'Alt Text for the Step Image'
    • step_image_filename Char
      args: 'Step Image Filename'
    • title Char
      translate=True args: 'Title'
    Public methods (4)
    • action_set_just_done(self)
    • action_validate_step(self, xml_id)
      @api.model
    • check_step_on_onboarding_has_action(self)
      @api.constrains('onboarding_ids')
    • write(self, vals)

    New fields (5)
    • company_id Many2one → res.company
      ondelete='cascade' args: 'res.company'
    • is_onboarding_closed Boolean
      args: 'Was panel closed?'
    • onboarding_id Many2one → onboarding.onboarding
      index=True ondelete='cascade' required=True args: 'onboarding.onboarding', 'Related onboarding tracked'
    • onboarding_state Selection
      compute='_compute_onboarding_state' store=True string='Onboarding progress' args: ONBOARDING_PROGRESS_STATES
    • progress_step_ids Many2many → onboarding.progress.step
      string='Progress Steps Trackers' args: 'onboarding.progress.step'
    Public methods (2)
    • action_close(self)
    • action_toggle_visibility(self)

    New fields (4)
    • company_id Many2one → res.company
      ondelete='cascade' args: 'res.company'
    • progress_ids Many2many → onboarding.progress
      string='Related Onboarding Progress Tracker' args: 'onboarding.progress'
    • step_id Many2one → onboarding.onboarding.step
      index=True ondelete='cascade' required=True string='Onboarding Step' args: 'onboarding.onboarding.step'
    • step_state Selection
      default='not_done' string='Onboarding Step Progress' args: ONBOARDING_PROGRESS_STATES
    Public methods (2)
    • action_consolidate_just_done(self)
    • action_set_just_done(self)

    Loading…

    Loading…

    Loading…