Florian Charlier
2c4bb38835
This technical module can be used to configure onboarding panels flows at company or global level (required for new Appointment onboarding, see ENT PR). This implementation, which should be able to support the migration of the other onboardings, separates the closed state from the completion state (allowing to know that steps are not completed even though the panel is closed). Basic tree and form view are included. Adding an onboarding with this module requires to provide records data for the models: - `onboarding.onboarding` + action to close the panel - `onboarding.onboarding.step` + actions for the 'opening' and 'saving' of each step. See related ENT PR for the `appointment` example, in particular `onboarding_data.xml` and `onboarding_onboarding.py` Several python tests are also included. Misc. In base, we slightly refresh the wording/style of the modal closing the onboarding panel. Task-2852375 Part of Task-2900763 Part-of: odoo/odoo#97105
74 lines
3.2 KiB
Python
74 lines
3.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
from odoo import api, fields, models
|
|
|
|
|
|
ONBOARDING_PROGRESS_STATES = [
|
|
('not_done', 'Not done'),
|
|
('just_done', 'Just done'),
|
|
('done', 'Done'),
|
|
]
|
|
|
|
|
|
class OnboardingProgress(models.Model):
|
|
_name = 'onboarding.progress'
|
|
_description = 'Onboarding Progress Tracker'
|
|
_rec_name = 'onboarding_id'
|
|
|
|
onboarding_state = fields.Selection(
|
|
ONBOARDING_PROGRESS_STATES, string='Onboarding progress', compute='_compute_onboarding_state', store=True)
|
|
is_onboarding_closed = fields.Boolean('Was panel closed?')
|
|
company_id = fields.Many2one('res.company')
|
|
onboarding_id = fields.Many2one(
|
|
'onboarding.onboarding', 'Related onboarding tracked', required=True, ondelete='cascade')
|
|
progress_step_ids = fields.One2many('onboarding.progress.step', 'progress_id', 'Progress Steps Trackers')
|
|
_sql_constraints = [
|
|
('onboarding_company_uniq', 'unique (onboarding_id,company_id)',
|
|
'There cannot be multiple records of the same onboarding completion for the same company.'),
|
|
]
|
|
|
|
@api.depends('onboarding_id.step_ids', 'progress_step_ids', 'progress_step_ids.step_state')
|
|
def _compute_onboarding_state(self):
|
|
progress_steps_data = self.env['onboarding.progress.step'].read_group(
|
|
[('progress_id', 'in', self.ids), ('step_state', 'in', ['just_done', 'done'])],
|
|
['progress_id'], ['progress_id']
|
|
)
|
|
result = dict((data['progress_id'][0], data['progress_id_count']) for data in progress_steps_data)
|
|
for progress in self:
|
|
progress.onboarding_state = (
|
|
'not_done' if result.get(progress.id, 0) != len(progress.onboarding_id.step_ids)
|
|
else 'done')
|
|
|
|
def action_close(self):
|
|
self.is_onboarding_closed = True
|
|
|
|
def action_toggle_visibility(self):
|
|
for progress in self:
|
|
progress.is_onboarding_closed = not progress.is_onboarding_closed
|
|
|
|
def _get_and_update_onboarding_state(self):
|
|
"""Used to fetch the progress of an onboarding for rendering its panel and is expected to
|
|
be called by the onboarding controller. It also has the responsibility of updating the
|
|
'just_done' states into 'done' so that the 'just_done' states are only rendered once.
|
|
"""
|
|
self.ensure_one()
|
|
onboarding_states_values = {}
|
|
progress_steps_to_consolidate = self.env['onboarding.progress.step']
|
|
|
|
# Iterate over onboarding step_ids and not self.progress_step_ids because 'not_done' steps
|
|
# may not have a progress_step record.
|
|
for step in self.onboarding_id.step_ids:
|
|
step_state = step.current_step_state
|
|
if step_state == 'just_done':
|
|
progress_steps_to_consolidate |= step.current_progress_step_id
|
|
onboarding_states_values[step.id] = step_state
|
|
|
|
progress_steps_to_consolidate.action_consolidate_just_done()
|
|
|
|
if self.is_onboarding_closed:
|
|
onboarding_states_values['onboarding_state'] = 'closed'
|
|
elif self.onboarding_state == 'done':
|
|
onboarding_states_values['onboarding_state'] = 'just_done' if progress_steps_to_consolidate else 'done'
|
|
return onboarding_states_values
|