feat(jobs): Sub 14 — configurable workflow state bar (Path B)
Replaces the generic Draft/Confirmed/In Progress/Done statusbar with
a shop-configurable list of plating-specific milestones. Bar advances
automatically as recipe steps complete; no manual button clicks.
What ships
==========
* New model: fp.job.workflow.state
Catalog of milestones (name, code, sequence, color, triggers).
Triggers can be:
- trigger_default_kinds: "receiving,inspect" matches by step.default_kind
- trigger_first_step_started: any wet/bake/mask/rack step started
- trigger_all_steps_done: every non-cancelled step in done/skipped
- block_when_quality_hold: held back while NCR/hold open
Plus per-recipe-node override (see below).
* Default 7-state seed (data/fp_workflow_state_data.xml):
Draft → Confirmed → Received → In Progress → Inspected → Shipped → Done
noupdate=1 so per-shop edits survive module upgrade.
* Recipe-side trigger field on fusion.plating.process.node:
triggers_workflow_state_id (Many2one, optional)
Wins over default_kind matching. Lets the recipe author pin a
specific step as a milestone trigger even when default_kind isn't
set or doesn't match. Exposed in the Recipe Tree Editor properties
panel (dropdown sourced from the catalog).
* fp.job.workflow_state_id (computed, stored)
Iterates the catalog in sequence order; lands at the highest passed
milestone. Recomputes on step state / kind / recipe_node / quality
hold changes. Replaces fp.job.state on the form's statusbar.
* Settings UI: Configuration > Workflow States
Standard list+form pages so admins can add / edit / deactivate
states. Manager-group write permission, supervisor read.
What this does NOT do
=====================
* Doesn't drop fp.job.state — that field still drives the internal
state machine (button_confirm, action_cancel, etc.). Only the
UI statusbar is reassigned.
* No migration for existing jobs — they auto-recompute on next read
because workflow_state_id is a stored compute with the right
api.depends. Existing WH/JOB/00342 will display its current
workflow state on next page load.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
gsinghpal
@@ -5,6 +5,7 @@
|
||||
# Phase 2 of the native plating job model migration. Models are added
|
||||
# task-by-task in Tasks 2.2 onwards.
|
||||
|
||||
from . import fp_job_workflow_state # Sub 14 — must load before fp_job (FK target)
|
||||
from . import fp_job
|
||||
from . import fp_job_step
|
||||
from . import fp_job_node_override
|
||||
|
||||
@@ -80,6 +80,46 @@ class FpJob(models.Model):
|
||||
'idempotency. Cleared post-cutover.',
|
||||
)
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Sub 14 — Configurable workflow state (status bar milestone)
|
||||
# ------------------------------------------------------------------
|
||||
# workflow_state_id auto-advances along the highest passed milestone
|
||||
# in fp.job.workflow.state's sequence order. Replaces the hardcoded
|
||||
# state Selection on the form's statusbar.
|
||||
workflow_state_id = fields.Many2one(
|
||||
'fp.job.workflow.state',
|
||||
string='Workflow Stage',
|
||||
compute='_compute_workflow_state_id',
|
||||
store=True,
|
||||
readonly=True,
|
||||
help='Highest workflow milestone this job has passed, computed '
|
||||
'from step states + per-state trigger conditions. Updates '
|
||||
'automatically — the operator never sets it.',
|
||||
)
|
||||
|
||||
@api.depends(
|
||||
'state',
|
||||
'step_ids',
|
||||
'step_ids.state',
|
||||
'step_ids.kind',
|
||||
'step_ids.recipe_node_id',
|
||||
'step_ids.recipe_node_id.default_kind',
|
||||
'step_ids.recipe_node_id.triggers_workflow_state_id',
|
||||
'quality_hold_count',
|
||||
)
|
||||
def _compute_workflow_state_id(self):
|
||||
WS = self.env['fp.job.workflow.state']
|
||||
all_states = WS.search([], order='sequence, id')
|
||||
for job in self:
|
||||
passed = WS.browse()
|
||||
for ws in all_states:
|
||||
if ws._fp_is_passed_for_job(job):
|
||||
passed = ws
|
||||
else:
|
||||
# First non-passed state stops the bar's progress
|
||||
break
|
||||
job.workflow_state_id = passed
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Smart-button counts (Feature A — operator workflow)
|
||||
#
|
||||
@@ -1350,3 +1390,26 @@ class FpJobStep(models.Model):
|
||||
'migrated from. Used by the migration script for '
|
||||
'idempotency. Cleared post-cutover.',
|
||||
)
|
||||
|
||||
|
||||
# ==========================================================================
|
||||
# Sub 14 — Recipe-side trigger field
|
||||
# ==========================================================================
|
||||
# Adds an optional Many2one on every recipe operation node so the recipe
|
||||
# author can explicitly map "completion of this step triggers workflow
|
||||
# state X". Wins over the default-kind matching defined on the workflow
|
||||
# state itself. Lives here (not core) because the target model
|
||||
# (fp.job.workflow.state) is defined in this module.
|
||||
|
||||
class FusionPlatingProcessNodeWorkflow(models.Model):
|
||||
_inherit = 'fusion.plating.process.node'
|
||||
|
||||
triggers_workflow_state_id = fields.Many2one(
|
||||
'fp.job.workflow.state',
|
||||
string='Triggers Workflow State',
|
||||
ondelete='set null',
|
||||
help='When a job step generated from this recipe node finishes '
|
||||
'(or is skipped/cancelled), the job advances to this '
|
||||
'workflow state. Leave blank to fall back to default-kind '
|
||||
'matching defined on the workflow state catalog.',
|
||||
)
|
||||
|
||||
@@ -0,0 +1,230 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright 2026 Nexa Systems Inc.
|
||||
# License OPL-1 (Odoo Proprietary License v1.0)
|
||||
# Part of the Fusion Plating product family.
|
||||
"""Sub 14 — Configurable workflow status bar.
|
||||
|
||||
Each job carries a workflow_state_id that auto-advances along a
|
||||
shop-configurable sequence of milestones (Draft → Confirmed → Received
|
||||
→ In Progress → Inspected → Shipped → Done — by default).
|
||||
|
||||
Recipe authors tag specific recipe steps as "this step's completion
|
||||
triggers workflow state X" via process_node.triggers_workflow_state_id.
|
||||
The default mapping is by step.default_kind (so out-of-the-box recipes
|
||||
just work), with per-recipe override on each operation node.
|
||||
|
||||
Why this lives in fusion_plating_jobs (not core):
|
||||
* It depends on fp.job.step which is implemented here
|
||||
* Recipe-side trigger fields are added via _inherit on
|
||||
fusion.plating.process.node (also here, in fp_job.py)
|
||||
|
||||
The catalog seed lives in data/fp_workflow_state_data.xml and ships
|
||||
the 7 default milestones. Settings UI lets shops add more.
|
||||
"""
|
||||
|
||||
from odoo import _, api, fields, models
|
||||
|
||||
|
||||
class FpJobWorkflowState(models.Model):
|
||||
_name = 'fp.job.workflow.state'
|
||||
_description = 'Fusion Plating — Job Workflow State (status bar milestone)'
|
||||
_order = 'sequence, id'
|
||||
_rec_name = 'name'
|
||||
|
||||
name = fields.Char(
|
||||
string='State Name',
|
||||
required=True,
|
||||
translate=True,
|
||||
help='Operator-facing label shown in the job status bar '
|
||||
'(e.g. "Received", "Inspected", "Shipped").',
|
||||
)
|
||||
code = fields.Char(
|
||||
string='Code',
|
||||
required=True,
|
||||
help='Stable identifier — used by code/migrations to reference '
|
||||
'this state without depending on the (translatable) name. '
|
||||
'Lowercase snake_case (e.g. "received", "inspected").',
|
||||
)
|
||||
sequence = fields.Integer(
|
||||
string='Sequence',
|
||||
default=10,
|
||||
required=True,
|
||||
help='Position of this state on the bar (left to right). '
|
||||
'10-spacing convention so authors can insert new states '
|
||||
'between existing ones without renumbering.',
|
||||
)
|
||||
color = fields.Selection(
|
||||
[
|
||||
('grey', 'Grey'),
|
||||
('blue', 'Blue'),
|
||||
('cyan', 'Cyan'),
|
||||
('yellow', 'Yellow'),
|
||||
('orange', 'Orange'),
|
||||
('green', 'Green'),
|
||||
('success', 'Success Green'),
|
||||
('danger', 'Danger Red'),
|
||||
('purple', 'Purple'),
|
||||
],
|
||||
string='Color',
|
||||
default='grey',
|
||||
help='Status pill colour on the bar.',
|
||||
)
|
||||
is_initial = fields.Boolean(
|
||||
string='Initial State',
|
||||
default=False,
|
||||
help='Marks this as the starting state for new jobs. Only one '
|
||||
'state should be marked initial.',
|
||||
)
|
||||
is_terminal = fields.Boolean(
|
||||
string='Terminal State',
|
||||
default=False,
|
||||
help='Marks this as the final state. The bar stops advancing '
|
||||
'once a job reaches it. Only one state should be marked '
|
||||
'terminal.',
|
||||
)
|
||||
active = fields.Boolean(default=True)
|
||||
description = fields.Text(
|
||||
string='Description',
|
||||
help='Internal notes on what this milestone represents and '
|
||||
'when it should fire. Not shown to operators.',
|
||||
)
|
||||
|
||||
# ---- Trigger conditions --------------------------------------------------
|
||||
#
|
||||
# A state is "passed" when ALL recipe steps matching its trigger
|
||||
# conditions are in done/skipped/cancelled. Two ways to define
|
||||
# which steps trigger:
|
||||
# 1. trigger_default_kinds — match on recipe step's default_kind
|
||||
# Selection. Easiest path — covers standard recipes that use
|
||||
# the curated kind values (receiving, final_inspect, ship, etc.)
|
||||
# 2. Per-recipe-node override via
|
||||
# fusion.plating.process.node.triggers_workflow_state_id
|
||||
# (defined in fp_job.py). Wins over default_kind matching.
|
||||
|
||||
trigger_default_kinds = fields.Char(
|
||||
string='Trigger Default Kinds',
|
||||
help='Comma-separated list of step.default_kind values. When the '
|
||||
'last recipe step matching any of these kinds is finished, '
|
||||
'the state passes. Example: "receiving,inspect" for a '
|
||||
'"Received" state. Leave blank if you only want to use '
|
||||
'per-recipe-node overrides.',
|
||||
)
|
||||
|
||||
trigger_first_step_started = fields.Boolean(
|
||||
string='Trigger on First Step Started',
|
||||
default=False,
|
||||
help='Special trigger — passes as soon as the first wet step '
|
||||
'(or any step with kind not in inspection/admin) starts. '
|
||||
'Used for the "In Progress" milestone.',
|
||||
)
|
||||
|
||||
trigger_all_steps_done = fields.Boolean(
|
||||
string='Trigger on All Steps Done',
|
||||
default=False,
|
||||
help='Special trigger — passes when every non-cancelled step '
|
||||
'is in done/skipped state. Used for the "Done" milestone.',
|
||||
)
|
||||
|
||||
block_when_quality_hold = fields.Boolean(
|
||||
string='Blocked by Quality Hold',
|
||||
default=False,
|
||||
help='If True, this state will NOT pass while there is an open '
|
||||
'quality hold on the job. Used for the "Inspected" '
|
||||
'milestone — you can finish the inspection step but the '
|
||||
'state stays at the previous milestone until the NCR clears.',
|
||||
)
|
||||
|
||||
_sql_constraints = [
|
||||
('fp_workflow_state_code_uniq', 'unique(code)',
|
||||
'Workflow state code must be unique.'),
|
||||
]
|
||||
|
||||
@api.depends('name', 'code')
|
||||
def _compute_display_name(self):
|
||||
for s in self:
|
||||
s.display_name = '%s [%s]' % (s.name or '', s.code or '')
|
||||
|
||||
# ---- Trigger evaluation --------------------------------------------------
|
||||
|
||||
def _fp_kinds_set(self):
|
||||
"""Parse trigger_default_kinds into a set of kind strings."""
|
||||
self.ensure_one()
|
||||
if not self.trigger_default_kinds:
|
||||
return set()
|
||||
return {
|
||||
k.strip() for k in self.trigger_default_kinds.split(',')
|
||||
if k.strip()
|
||||
}
|
||||
|
||||
def _fp_is_passed_for_job(self, job):
|
||||
"""Return True if this state's trigger conditions are met by
|
||||
the given fp.job. Called from the job's compute method.
|
||||
"""
|
||||
self.ensure_one()
|
||||
# Initial state — always passed (every job starts here)
|
||||
if self.is_initial:
|
||||
return True
|
||||
|
||||
Step = self.env['fp.job.step']
|
||||
steps = job.step_ids
|
||||
|
||||
# Special trigger: all steps done
|
||||
if self.trigger_all_steps_done:
|
||||
non_cancelled = steps.filtered(lambda s: s.state != 'cancelled')
|
||||
if not non_cancelled:
|
||||
return False
|
||||
return all(s.state in ('done', 'skipped') for s in non_cancelled)
|
||||
|
||||
# Special trigger: first wet step started
|
||||
if self.trigger_first_step_started:
|
||||
wet_kinds = ('wet', 'bake', 'mask', 'rack')
|
||||
production_started = any(
|
||||
s.state in ('in_progress', 'paused', 'done')
|
||||
and (s.kind in wet_kinds)
|
||||
for s in steps
|
||||
)
|
||||
if not production_started:
|
||||
return False
|
||||
# Production milestone — not blocked by quality hold here
|
||||
return True
|
||||
|
||||
# Standard trigger: ALL recipe steps matching the trigger
|
||||
# (default_kind in our list OR per-node override pointing at
|
||||
# us) must be in a terminal state.
|
||||
kinds = self._fp_kinds_set()
|
||||
matching_steps = steps.filtered(
|
||||
lambda s: (
|
||||
# Per-node override wins
|
||||
(s.recipe_node_id
|
||||
and s.recipe_node_id.triggers_workflow_state_id
|
||||
and s.recipe_node_id.triggers_workflow_state_id.id == self.id)
|
||||
or
|
||||
# Default-kind match
|
||||
(kinds and s.recipe_node_id
|
||||
and s.recipe_node_id.default_kind in kinds)
|
||||
)
|
||||
)
|
||||
if not matching_steps:
|
||||
# Nothing matches — this state can't pass for this recipe.
|
||||
# Treat as not-passed so the bar stays at the previous state.
|
||||
return False
|
||||
|
||||
# Every matching step must be terminal
|
||||
if not all(
|
||||
s.state in ('done', 'skipped', 'cancelled')
|
||||
for s in matching_steps
|
||||
):
|
||||
return False
|
||||
|
||||
# Quality-hold gate (optional)
|
||||
if self.block_when_quality_hold:
|
||||
QH = self.env.get('fusion.plating.quality.hold')
|
||||
if QH is not None:
|
||||
open_holds = QH.search_count([
|
||||
('x_fc_job_id', '=', job.id),
|
||||
('state', 'not in', ('closed', 'cancelled')),
|
||||
])
|
||||
if open_holds:
|
||||
return False
|
||||
|
||||
return True
|
||||
Reference in New Issue
Block a user