Files
Odoo-Modules/fusion_repairs/models/repair_flowchart_run.py
gsinghpal eb186cac3c feat(fusion_repairs): Bundle 11 - CS guided troubleshooting flowcharts + vendor PO
Two big workflow additions:

1. Visual drag-and-drop flowchart designer (Drawflow) + card-by-card runner
   (with show-whole-tree toggle) so admins build per-(category, symptom)
   decision trees with embedded photos/videos and CS walks callers through
   them on the phone. Resolved-on-call closes the repair; escalated copies
   the full transcript into internal_notes so the dispatched tech sees what
   was already tried before they arrive at the client.

2. Vendor + draft-PO + factory-tracking on the part-order capture. Tech on
   the phone with the factory picks the vendor from contacts, types the OEM
   part #, cost, ETA date (calendar widget), factory ticket #, RA #, ticks
   under_warranty, and the system auto-creates a draft purchase.order with
   the right product (looked up or created from OEM) + activity for the
   office on the ETA day + client email with ETA prominently shown and
   cost intentionally omitted.

NEW MODELS

fusion.repair.symptom.class - lookup table (category + name + code).
  Replaces the flat x_fc_issue_category Char on repair.order. Seeded with
  7 stairlift symptoms + lighter coverage for hospital bed / porch lift /
  lift chair. Equipment Class added to fusion.repair.product.category
  (this carried over from the Bundle 10 plan).

fusion.repair.flowchart + .node + .edge - design-time graph.
  - flowchart has name, category, symptom, version, published flag,
    canvas_layout (Drawflow JSON), node_ids, edge_ids, computed start_node
  - node has node_type (question / suggestion / info / outcome),
    content_html, media_ids (M2M ir.attachment for photos + videos),
    is_start, outcome_kind (resolved / escalate / order_part),
    canvas_x/y for Drawflow round-trip
  - edge has source, target, label, sequence - supports N-ary branching
    (not just Yes/No)
  - designer_load() and designer_save(payload) RPC API the OWL component
    consumes; save is atomic-replace + bumps version + soft-validates

fusion.repair.flowchart.run + .step - runtime sessions.
  - One run per repair, audited; runtime_start_or_resume() returns the
    existing in-progress run or creates a fresh one for the matching chart
  - runtime_choose(edge_id, cs_note) records a step + advances current_node
  - runtime_complete(outcome) snapshots final node + calls _apply_outcome:
      resolved   -> auto-close via action_repair_start + action_repair_end,
                    set x_fc_resolved_on_call, post transcript to chatter
      escalated  -> prepend transcript to repair.internal_notes so the tech
                    sees it first when they open the form
      order_part -> chatter note; tech opens visit-report wizard next
      abandoned  -> just save transcript
  - Each step snapshots node_name + chosen_label at write time so the
    transcript survives later chart edits without breaking.

REPAIR.ORDER EXTENSIONS

- x_fc_symptom_class_id (M2O) - new structured symptom field
- x_fc_resolved_on_call (Boolean, tracked) - true after a resolved outcome
- x_fc_flowchart_run_ids + x_fc_flowchart_run_count
- action_start_troubleshoot() - opens the runner client action, raises a
  helpful UserError if no symptom set or no published chart exists
- action_view_flowchart_runs() smart button
- x_fc_issue_category renamed string to "(legacy)" - kept for back-compat
  + AI prompt context; new intakes set the M2O

DRAWFLOW DESIGNER (OWL)

static/src/lib/drawflow/drawflow.min.{js,css} - vendored Drawflow 0.0.59
  (MIT). Loaded only in web.assets_backend, ~48KB total.

components/flowchart_designer/flowchart_designer.{js,xml,scss}:
  - Client action "fusion_repair_flowchart_designer" with full drag-drop
    canvas + zoom + pan
  - 4 custom node templates color-banded by type (question blue,
    suggestion green, info gray, outcome red/green/amber per outcome_kind)
  - Right-panel editor for selected node: title, type, outcome kind,
    content (HTML), media uploader (drag-drop or click), set-as-start
    toggle, per-outgoing-edge label editor
  - Save serializes Drawflow JSON to canvas_layout + atomic-replaces the
    structured node/edge rows via the designer_save RPC

CARD RUNNER (OWL)

components/flowchart_runner/flowchart_runner.{js,xml,scss}:
  - Client action "fusion_repair_flowchart_runner"
  - DEFAULT MODE: card-by-card. One big card per node, embedded photos +
    inline <video controls>, answer buttons sized for phone use, CS note
    textarea (saved as cs_note on the step), running transcript at the
    bottom
  - TOGGLE: "Show Whole Tree" loads the same Drawflow lib in read-only
    fixed mode, imports the canvas_layout JSON, highlights current node
    yellow / visited green via .fr-current / .fr-visited classes
  - Outcome buttons drive the right runtime_complete() call; success
    notifications + auto-return to the parent repair form
  - "Abandon & Escalate" header button at all times - transcript is saved
    even on bail-out so the dispatched tech still benefits

PART ORDER + VENDOR PO

repair.part.order new fields:
  vendor_partner_id (M2O res.partner, is_company domain), purchase_order_id
  (auto-created draft PO), product_id (auto-resolved or created),
  unit_cost (Monetary) + currency_id, internal_po_ref, factory_ticket_ref,
  factory_ra_number, under_warranty.

action_create_draft_po() - resolves product.product by OEM (default_code)
  or creates a new one in a "Spare Parts" product.category, creates a
  purchase.order in draft state with one line (product + qty + price_unit
  + date_planned from expected_date or +7d), stamps Westin's internal PO
  ref as partner_ref so the factory can find it on return. Office reviews
  and confirms via the normal Odoo flow.

_schedule_eta_activity() - schedules a Repair: Assign Technician activity
  on the parent repair.order due on expected_date, assigned to
  repair.user_id, so the office is reminded to call the client and book
  the return visit on the day parts arrive.

VISIT-REPORT WIZARD PARTLINE EXTENSIONS

Same new fields exposed inline on the partline list so the tech captures
everything on the phone with the factory in one form:
  vendor_partner_id (vendors-only filter), unit_cost + currency,
  expected_date (calendar widget) replacing expected_lead_days as the
  preferred input, under_warranty, internal_po_ref, factory_ticket_ref,
  factory_ra_number, create_draft_po (default True - auto-builds PO on
  submit when vendor + cost are both set).

CLIENT EMAIL TIGHTENED

email_template_parts_ordered:
  - Subject now includes ETA "Parts ordered for your stairlift - expected 2026-06-06"
  - Hero ETA panel: large blue-bordered card with "Expected Arrival" label
    and the date in 24px bold
  - Cost INTENTIONALLY OMITTED - "Our office will call you to confirm a
    return visit time. If you have any questions about pricing or
    scheduling, please reach out to our office directly."
  - "There is nothing for you to do right now." callout

UI

- repair.order form header: new "Start Troubleshooting" button (info
  style, sitemap icon, visible when state in (draft, confirmed,
  under_repair) AND symptom is set)
- repair.order form intake row: x_fc_symptom_class_id picker filtered to
  the category, x_fc_resolved_on_call display when true
- repair.part.order form: header button "Create Draft Purchase Order"
  + new Vendor / Cost / Warranty group + System group with the PO link
- Intake wizard equipment line: symptom_class_id picker
- New menus:
    Configuration > Symptom Classes
    Configuration > Troubleshooting Flowcharts
    Fusion Repairs > Troubleshooting Sessions (run history)

SECURITY

18 new ACL rows for the 6 new models, scoped Manager-full / User-read /
FieldTech-read. Flowchart runs and steps get write access for User so CS
can record steps; Manager owns flowchart + node + edge CRUD.

POST-MIGRATION (19.0.2.2.0)

Existing installs: walks all distinct (category, x_fc_issue_category) text
pairs on repair.order, creates a placeholder fusion.repair.symptom.class
per pair (or reuses an existing match by code/name), back-fills the new
x_fc_symptom_class_id M2O. Idempotent + safe to re-run.

DEPENDENCY

Added 'purchase' to depends (action_create_draft_po needs purchase.order).

VERIFIED END-TO-END on local westin-v19 (Margaret persona, 0 bugs):

  STEP 0 seed: chart v1 8 nodes / 12 edges / published, 7 stairlift
                  symptoms, stairlift class=lift_elevating
  STEP 1 CS creates RO-202605-60 with symptom Not Moving
  STEP 2 Start Troubleshooting -> client action tag returned
  STEP 3 walk run: Power on? Yes -> Seatbelt? Yes -> Swivel? Yes ->
                   outcome 'Still not moving - dispatch technician'
                   (outcome_kind=escalate)
  STEP 4 runtime_complete('escalated') -> internal_notes prepended with
                   CS troubleshooting summary
  STEP 5 visit-report parts_needed with vendor Handicare + cost $425 +
                   warranty + factory refs -> PART-00008 created + draft
                   PO 26690 auto-built with line "Handicare 1100 control
                   board" qty 1 @ $425, partner_ref WH-2026-1042
  STEP 6 mark_ordered -> client email queued (NO cost mentioned, ETA
                   shown prominently) + office activity scheduled for
                   2026-06-06
  STEP 7 fresh resume returns same run; resolved outcome auto-closes the
                   repair (state=done, x_fc_resolved_on_call=True)

Bumped to 19.0.2.2.0.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-27 12:50:06 -04:00

363 lines
15 KiB
Python

# -*- coding: utf-8 -*-
# Copyright 2024-2026 Nexa Systems Inc.
# License OPL-1 (Odoo Proprietary License v1.0)
"""Flowchart runtime - one fusion.repair.flowchart.run per CS troubleshooting
session, with one fusion.repair.flowchart.run.step per node the rep visited.
The transcript is the audit + handoff artefact: when CS resolves on-call we
post it to chatter; when they escalate we copy it to internal_notes so the
dispatched tech can see what was tried BEFORE arriving at the client.
"""
import logging
from markupsafe import Markup
from odoo import _, api, fields, models
from odoo.exceptions import UserError
_logger = logging.getLogger(__name__)
RUN_OUTCOMES = [
('in_progress', 'In Progress'),
('resolved', 'Resolved on Call'),
('escalated', 'Escalated to Technician'),
('order_part', 'Captured Part Order'),
('abandoned', 'Abandoned'),
]
class FusionRepairFlowchartRun(models.Model):
_name = 'fusion.repair.flowchart.run'
_inherit = ['mail.thread']
_description = 'Flowchart Troubleshooting Run'
_order = 'started_at desc, id desc'
name = fields.Char(
compute='_compute_name',
store=True,
)
repair_order_id = fields.Many2one(
'repair.order',
required=True,
index=True,
ondelete='cascade',
)
flowchart_id = fields.Many2one(
'fusion.repair.flowchart',
required=True,
index=True,
ondelete='restrict',
)
flowchart_version = fields.Integer(
string='Chart Version Snapshot',
help='Version of the flowchart at the time the run was started; '
'so the transcript stays valid even if the chart is later edited.',
)
partner_id = fields.Many2one(
related='repair_order_id.partner_id', store=True, readonly=True,
)
started_at = fields.Datetime(default=fields.Datetime.now, required=True)
started_by_id = fields.Many2one(
'res.users', default=lambda self: self.env.user, required=True,
)
completed_at = fields.Datetime()
completed_by_id = fields.Many2one('res.users')
outcome = fields.Selection(
RUN_OUTCOMES,
default='in_progress',
required=True,
tracking=True,
)
step_ids = fields.One2many(
'fusion.repair.flowchart.run.step', 'run_id',
string='Steps',
)
step_count = fields.Integer(compute='_compute_step_count')
current_node_id = fields.Many2one(
'fusion.repair.flowchart.node',
compute='_compute_current_node',
store=True,
help='Where the runner is right now - last step\'s node if no edge '
'was chosen yet, otherwise the edge\'s target node.',
)
transcript_html = fields.Html(
compute='_compute_transcript',
sanitize=False, # we control the markup
)
company_id = fields.Many2one(
'res.company',
default=lambda self: self.env.company,
)
@api.depends('repair_order_id.name', 'flowchart_id.name')
def _compute_name(self):
for r in self:
r.name = _('%s on %s') % (
r.flowchart_id.name or '?', r.repair_order_id.name or '?',
)
@api.depends('step_ids')
def _compute_step_count(self):
for r in self:
r.step_count = len(r.step_ids)
@api.depends('step_ids.chosen_edge_id', 'step_ids.node_id',
'flowchart_id.start_node_id')
def _compute_current_node(self):
for r in self:
if not r.step_ids:
r.current_node_id = r.flowchart_id.start_node_id
continue
last = r.step_ids[-1]
# If they chose an edge on the last step, we should already be
# showing the target. If not (just landed on a card), it's the
# current node itself.
if last.chosen_edge_id:
r.current_node_id = last.chosen_edge_id.target_node_id
else:
r.current_node_id = last.node_id
@api.depends('step_ids.node_name_snapshot', 'step_ids.chosen_label_snapshot',
'step_ids.cs_note', 'outcome')
def _compute_transcript(self):
for r in self:
if not r.step_ids:
r.transcript_html = '<p><em>No steps recorded yet.</em></p>'
continue
lines = ['<ol style="margin:0 0 8px 1.2em;padding:0;">']
for s in r.step_ids:
line = f'<li><strong>{s.node_name_snapshot or "?"}</strong>'
if s.chosen_label_snapshot:
line += f' &rarr; <em>{s.chosen_label_snapshot}</em>'
if s.cs_note:
line += f' <span style="color:#666;">(note: {s.cs_note})</span>'
line += '</li>'
lines.append(line)
lines.append('</ol>')
outcome_label = dict(self._fields['outcome'].selection).get(r.outcome, r.outcome)
lines.append(f'<p><strong>Outcome:</strong> {outcome_label}</p>')
r.transcript_html = ''.join(lines)
# ------------------------------------------------------------------
# RUNTIME RPC API (called from the OWL runner component)
# ------------------------------------------------------------------
@api.model
def runtime_start_or_resume(self, repair_id):
"""Open or resume a troubleshooting run for the given repair.
- If an in-progress run exists, return it.
- Otherwise resolve the flowchart from the repair's (category, symptom)
and create a fresh run starting at the chart's start node.
Returns the dict shape that the OWL runner consumes.
"""
repair = self.env['repair.order'].browse(repair_id).exists()
if not repair:
raise UserError(_('Repair order not found.'))
existing = self.search([
('repair_order_id', '=', repair.id),
('outcome', '=', 'in_progress'),
], limit=1)
if existing:
return existing._runtime_dict()
if not repair.x_fc_symptom_class_id:
raise UserError(_('Pick a Symptom on the repair before starting '
'troubleshooting.'))
chart = self.env['fusion.repair.flowchart'].sudo().search([
('category_id', '=', repair.x_fc_repair_category_id.id),
('symptom_class_id', '=', repair.x_fc_symptom_class_id.id),
('published', '=', True),
('active', '=', True),
], limit=1)
if not chart:
raise UserError(_(
'No published troubleshooting flowchart found for '
'%(cat)s + %(sym)s. Ask a manager to publish one in '
'Configuration > Troubleshooting Flowcharts.'
) % {
'cat': repair.x_fc_repair_category_id.name or '?',
'sym': repair.x_fc_symptom_class_id.name or '?',
})
run = self.sudo().create({
'repair_order_id': repair.id,
'flowchart_id': chart.id,
'flowchart_version': chart.version,
})
return run._runtime_dict()
def runtime_choose(self, edge_id, cs_note=''):
"""CS clicked an answer button on the current card.
Records a step (current_node + chosen_edge + note) and returns the
updated run dict (which the OWL component uses to render the next card).
"""
self.ensure_one()
if self.outcome != 'in_progress':
raise UserError(_('This run has already been completed.'))
edge = self.env['fusion.repair.flowchart.edge'].browse(edge_id).exists()
if not edge:
raise UserError(_('Chosen answer not found.'))
if edge.source_node_id != self.current_node_id:
raise UserError(_(
'That answer does not belong to the current step. The chart '
'may have been edited - please reload the runner.'
))
self.env['fusion.repair.flowchart.run.step'].sudo().create({
'run_id': self.id,
'sequence': len(self.step_ids) + 1,
'node_id': self.current_node_id.id,
'node_name_snapshot': self.current_node_id.name,
'chosen_edge_id': edge.id,
'chosen_label_snapshot': edge.label,
'cs_note': cs_note or False,
})
# current_node_id auto-recomputes via depends
self.invalidate_recordset(['current_node_id'])
return self._runtime_dict()
def runtime_complete(self, outcome, cs_note=''):
"""CS hit a terminal outcome (resolved / escalate / order_part) OR
manually abandoned. Closes the run and triggers downstream effects."""
self.ensure_one()
valid = {'resolved', 'escalated', 'order_part', 'abandoned'}
if outcome not in valid:
raise UserError(_('Unknown outcome %s.') % outcome)
if self.outcome != 'in_progress':
return self._runtime_dict()
# Snapshot the final node as a step so the transcript shows it.
node = self.current_node_id
if node and (not self.step_ids or self.step_ids[-1].node_id != node):
self.env['fusion.repair.flowchart.run.step'].sudo().create({
'run_id': self.id,
'sequence': len(self.step_ids) + 1,
'node_id': node.id,
'node_name_snapshot': node.name,
'cs_note': cs_note or False,
})
self.write({
'outcome': outcome,
'completed_at': fields.Datetime.now(),
'completed_by_id': self.env.uid,
})
# Dispatch the side-effects on the repair (see _apply_outcome).
self._apply_outcome()
return self._runtime_dict()
def _apply_outcome(self):
"""Run the side-effects on the parent repair depending on outcome."""
for r in self:
repair = r.repair_order_id
transcript = Markup(r.transcript_html or '')
if r.outcome == 'resolved':
repair.x_fc_resolved_on_call = True
repair.message_post(body=Markup(_(
'<p><b>Resolved on call</b> via troubleshooting flowchart '
'<i>%(name)s</i>:</p>%(transcript)s'
)) % {'name': r.flowchart_id.name, 'transcript': transcript})
# Close the repair through the Odoo state machine. Reuse the
# visit-report wizard helper pattern.
try:
if repair.state == 'draft':
try:
repair.action_validate()
except Exception:
repair._action_repair_confirm()
if repair.state == 'confirmed':
repair.action_repair_start()
if repair.state == 'under_repair':
repair.action_repair_end()
except Exception as e:
_logger.warning(
'Could not auto-close repair %s after on-call '
'resolution: %s', repair.name, e,
)
elif r.outcome == 'escalated':
# Prepend the transcript to internal_notes so the tech sees
# what was tried at the top of the form.
existing = repair.internal_notes or ''
header = Markup(
'<p><b>CS troubleshooting summary (flowchart %s):</b></p>'
) % r.flowchart_id.name
repair.internal_notes = (header + transcript +
Markup('<hr/>') + Markup(existing))
repair.message_post(body=Markup(_(
'<p><b>Escalated to technician</b> via troubleshooting '
'flowchart <i>%(name)s</i>:</p>%(transcript)s'
)) % {'name': r.flowchart_id.name, 'transcript': transcript})
elif r.outcome == 'order_part':
repair.message_post(body=Markup(_(
'<p><b>Part order needed</b> per troubleshooting flowchart '
'<i>%(name)s</i>:</p>%(transcript)s'
)) % {'name': r.flowchart_id.name, 'transcript': transcript})
else: # abandoned
repair.message_post(body=Markup(_(
'<p>Troubleshooting run abandoned by %(user)s.</p>'
'%(transcript)s'
)) % {
'user': self.env.user.name,
'transcript': transcript,
})
def _runtime_dict(self):
"""Serialise the run + current node + available edges for the OWL UI."""
self.ensure_one()
node = self.current_node_id
outgoing = self.env['fusion.repair.flowchart.edge'].sudo().search([
('source_node_id', '=', node.id),
], order='sequence, id') if node else self.env['fusion.repair.flowchart.edge']
return {
'run_id': self.id,
'repair_id': self.repair_order_id.id,
'repair_name': self.repair_order_id.name,
'partner_name': self.partner_id.name or '',
'flowchart_id': self.flowchart_id.id,
'flowchart_name': self.flowchart_id.name,
'canvas_layout': self.flowchart_id.canvas_layout or '',
'outcome': self.outcome,
'current_node': node._designer_dict() if node else None,
'options': [{
'edge_id': e.id,
'label': e.label or _('Continue'),
'target_node_id': e.target_node_id.id,
'target_node_type': e.target_node_id.node_type,
'target_outcome_kind': e.target_node_id.outcome_kind or '',
} for e in outgoing],
'transcript_html': self.transcript_html,
'visited_node_ids': [s.node_id.id for s in self.step_ids if s.node_id],
'visited_edge_ids': [s.chosen_edge_id.id for s in self.step_ids if s.chosen_edge_id],
'step_count': self.step_count,
}
class FusionRepairFlowchartRunStep(models.Model):
_name = 'fusion.repair.flowchart.run.step'
_description = 'Flowchart Run Step'
_order = 'run_id, sequence, id'
run_id = fields.Many2one(
'fusion.repair.flowchart.run',
required=True,
index=True,
ondelete='cascade',
)
sequence = fields.Integer(default=10)
node_id = fields.Many2one(
'fusion.repair.flowchart.node',
ondelete='set null',
index=True,
)
node_name_snapshot = fields.Char(
help='Frozen at the moment the step was recorded so transcript '
'survives later chart edits.',
)
chosen_edge_id = fields.Many2one(
'fusion.repair.flowchart.edge',
ondelete='set null',
)
chosen_label_snapshot = fields.Char()
cs_note = fields.Text()
recorded_at = fields.Datetime(default=fields.Datetime.now)