-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathindex.html
More file actions
1364 lines (1245 loc) · 89.5 KB
/
index.html
File metadata and controls
1364 lines (1245 loc) · 89.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
<title>OpenSPP Change Request V2</title>
<style type="text/css">
/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
Despite the name, some widely supported CSS2 features are used.
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/
/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
border: 0 }
table.borderless td, table.borderless th {
/* Override padding for "table.docutils td" with "! important".
The right padding separates the table cells. */
padding: 0 0.5em 0 0 ! important }
.first {
/* Override more specific margin styles with "! important". */
margin-top: 0 ! important }
.last, .with-subtitle {
margin-bottom: 0 ! important }
.hidden {
display: none }
.subscript {
vertical-align: sub;
font-size: smaller }
.superscript {
vertical-align: super;
font-size: smaller }
a.toc-backref {
text-decoration: none ;
color: black }
blockquote.epigraph {
margin: 2em 5em ; }
dl.docutils dd {
margin-bottom: 0.5em }
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
overflow: hidden;
}
/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
font-weight: bold }
*/
div.abstract {
margin: 2em 5em }
div.abstract p.topic-title {
font-weight: bold ;
text-align: center }
div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
margin: 2em ;
border: medium outset ;
padding: 1em }
div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
font-weight: bold ;
font-family: sans-serif }
div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
color: red ;
font-weight: bold ;
font-family: sans-serif }
/* Uncomment (and remove this text!) to get reduced vertical space in
compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
margin-bottom: 0.5em }
div.compound .compound-last, div.compound .compound-middle {
margin-top: 0.5em }
*/
div.dedication {
margin: 2em 5em ;
text-align: center ;
font-style: italic }
div.dedication p.topic-title {
font-weight: bold ;
font-style: normal }
div.figure {
margin-left: 2em ;
margin-right: 2em }
div.footer, div.header {
clear: both;
font-size: smaller }
div.line-block {
display: block ;
margin-top: 1em ;
margin-bottom: 1em }
div.line-block div.line-block {
margin-top: 0 ;
margin-bottom: 0 ;
margin-left: 1.5em }
div.sidebar {
margin: 0 0 0.5em 1em ;
border: medium outset ;
padding: 1em ;
background-color: #ffffee ;
width: 40% ;
float: right ;
clear: right }
div.sidebar p.rubric {
font-family: sans-serif ;
font-size: medium }
div.system-messages {
margin: 5em }
div.system-messages h1 {
color: red }
div.system-message {
border: medium outset ;
padding: 1em }
div.system-message p.system-message-title {
color: red ;
font-weight: bold }
div.topic {
margin: 2em }
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
margin-top: 0.4em }
h1.title {
text-align: center }
h2.subtitle {
text-align: center }
hr.docutils {
width: 75% }
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
img.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left }
.align-center {
clear: both ;
text-align: center }
.align-right {
text-align: right }
/* reset inner alignment in figures */
div.align-right {
text-align: inherit }
/* div.align-center * { */
/* text-align: left } */
.align-top {
vertical-align: top }
.align-middle {
vertical-align: middle }
.align-bottom {
vertical-align: bottom }
ol.simple, ul.simple {
margin-bottom: 1em }
ol.arabic {
list-style: decimal }
ol.loweralpha {
list-style: lower-alpha }
ol.upperalpha {
list-style: upper-alpha }
ol.lowerroman {
list-style: lower-roman }
ol.upperroman {
list-style: upper-roman }
p.attribution {
text-align: right ;
margin-left: 50% }
p.caption {
font-style: italic }
p.credits {
font-style: italic ;
font-size: smaller }
p.label {
white-space: nowrap }
p.rubric {
font-weight: bold ;
font-size: larger ;
color: maroon ;
text-align: center }
p.sidebar-title {
font-family: sans-serif ;
font-weight: bold ;
font-size: larger }
p.sidebar-subtitle {
font-family: sans-serif ;
font-weight: bold }
p.topic-title {
font-weight: bold }
pre.address {
margin-bottom: 0 ;
margin-top: 0 ;
font: inherit }
pre.literal-block, pre.doctest-block, pre.math, pre.code {
margin-left: 2em ;
margin-right: 2em }
pre.code .ln { color: gray; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}
span.classifier {
font-family: sans-serif ;
font-style: oblique }
span.classifier-delimiter {
font-family: sans-serif ;
font-weight: bold }
span.interpreted {
font-family: sans-serif }
span.option {
white-space: nowrap }
span.pre {
white-space: pre }
span.problematic, pre.problematic {
color: red }
span.section-subtitle {
/* font-size relative to parent (h1..h6 element) */
font-size: 80% }
table.citation {
border-left: solid 1px gray;
margin-left: 1px }
table.docinfo {
margin: 2em 4em }
table.docutils {
margin-top: 0.5em ;
margin-bottom: 0.5em }
table.footnote {
border-left: solid 1px black;
margin-left: 1px }
table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
padding-left: 0.5em ;
padding-right: 0.5em ;
vertical-align: top }
table.docutils th.field-name, table.docinfo th.docinfo-name {
font-weight: bold ;
text-align: left ;
white-space: nowrap ;
padding-left: 0 }
/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
border: 0px;
border-top: 2px solid;
border-bottom: 2px solid;
border-collapse: collapse;
}
table.docutils.booktabs * {
border: 0px;
}
table.docutils.booktabs th {
border-bottom: thin solid;
text-align: left;
}
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
font-size: 100% }
ul.auto-toc {
list-style-type: none }
</style>
</head>
<body>
<div class="document" id="openspp-change-request-v2">
<h1 class="title">OpenSPP Change Request V2</h1>
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:0f7067f1ca64cd4381c7eaf0905e67b186f599e0770e59ff61d8cc2c523cf8cf
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_change_request_v2"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
<p>Configuration-driven change request system for managing registrant data
updates. Supports approval workflows, conflict detection, duplicate
prevention, and document management. Enables field operators and
administrators to submit structured requests for updating individual or
group/household registrant data, with validation and audit trails.</p>
<div class="section" id="key-capabilities">
<h1>Key Capabilities</h1>
<ul class="simple">
<li>Create change requests using configurable request types with custom
detail models</li>
<li>Multi-tier approval workflows with automatic routing based on approval
definitions</li>
<li>Dynamic approval: route CRs to different approval workflows based on
which field is being modified, with CEL condition evaluation for
field-specific escalation</li>
<li>Detect conflicting change requests (same registrant, same group, or
same field)</li>
<li>Prevent duplicate submissions with configurable similarity thresholds</li>
<li>Validate required fields and documents before submission</li>
<li>Preview changes before applying them to registrant records</li>
<li>Apply changes via field mapping or custom strategies</li>
<li>Track audit trail of all state changes via event data</li>
<li>Attach supporting documents organized in DMS directories</li>
</ul>
</div>
<div class="section" id="key-models">
<h1>Key Models</h1>
<table border="1" class="docutils">
<colgroup>
<col width="52%" />
<col width="48%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Model</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="docutils literal">spp.change.request</tt></td>
<td>Main change request record with
approval workflow</td>
</tr>
<tr><td><tt class="docutils literal">spp.change.request.type</tt></td>
<td>Configuration for CR types:
target, detail model, workflow</td>
</tr>
<tr><td><tt class="docutils literal">spp.change.request.type.mapping</tt></td>
<td>Field mappings for automatic
application</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.conflict.rule</tt></td>
<td>Rules for detecting conflicting
change requests</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.duplicate.config</tt></td>
<td>Configuration for duplicate
detection thresholds</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.conflict.mixin</tt></td>
<td>Mixin providing conflict and
duplicate detection</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.base</tt></td>
<td>Base model for all change
request detail types</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.add_member</tt></td>
<td>Detail model for adding members
to groups</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.edit_individual</tt></td>
<td>Detail model for editing
individual registrant data</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.edit_group</tt></td>
<td>Detail model for editing
group/household data</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.remove_member</tt></td>
<td>Detail model for removing
members from groups</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.change_hoh</tt></td>
<td>Detail model for changing head
of household</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.exit_registrant</tt></td>
<td>Detail model for marking
registrants as exited</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.transfer_member</tt></td>
<td>Detail model for transferring
members between groups</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.update_id</tt></td>
<td>Detail model for updating
registrant ID numbers</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.create_group</tt></td>
<td>Detail model for creating new
groups/households</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.merge_registrants</tt></td>
<td>Detail model for merging
duplicate registrant records</td>
</tr>
<tr><td><tt class="docutils literal">spp.cr.detail.split_household</tt></td>
<td>Detail model for splitting
households into separate groups</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="form-tabs">
<h1>Form Tabs</h1>
<p>Change request form view includes the following tabs:</p>
<ul class="simple">
<li><strong>Details</strong>: Split-pane view showing current registrant data and
proposed changes</li>
<li><strong>Documents</strong>: Upload and manage supporting documents via DMS
integration</li>
<li><strong>Notes</strong>: Description and internal notes fields</li>
<li><strong>Revision Requested</strong>: Feedback from reviewers (visible when changes
requested)</li>
<li><strong>Status History</strong>: Timeline of approval reviews and state transitions</li>
</ul>
</div>
<div class="section" id="configuration">
<h1>Configuration</h1>
<p>After installing:</p>
<ol class="arabic simple">
<li>Navigate to <strong>Change Requests > Configuration > Change Request
Types</strong></li>
<li>Create or configure CR types: set target type (individual/group),
detail model, and approval workflow</li>
<li>Define required fields and documents for each CR type</li>
<li>Configure conflict rules under <strong>Change Requests > Configuration >
Conflict Rules</strong> (optional)</li>
<li>Configure duplicate detection under <strong>Change Requests > Configuration
> Duplicate Detection</strong> (optional)</li>
<li>Assign users to security groups: User, Validator, Validator HQ, or
Manager</li>
</ol>
</div>
<div class="section" id="ui-location">
<h1>UI Location</h1>
<ul class="simple">
<li><strong>Menu</strong>: Change Requests (top-level menu)<ul>
<li><strong>All Requests</strong>: View all change requests with filtering</li>
<li><strong>New Request</strong>: Launch wizard to create change request</li>
<li><strong>Pending Approval</strong>: Queue of requests awaiting validator action
(validators only)</li>
<li><strong>Reporting > Analytics</strong>: Pivot and graph views for change request
analysis (managers only)</li>
<li><strong>Configuration</strong>: Change request types, conflict rules, duplicate
detection (managers only)</li>
</ul>
</li>
<li><strong>Registrant Profile</strong>: Change requests appear in registrant form
under smart buttons and related tabs</li>
<li><strong>Wizards</strong>: New Request wizard for guided CR creation, batch approval
for validators</li>
</ul>
</div>
<div class="section" id="security">
<h1>Security</h1>
<table border="1" class="docutils">
<colgroup>
<col width="61%" />
<col width="39%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Group</th>
<th class="head">Access</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="docutils literal">spp_change_request_v2.group_cr_user</tt></td>
<td>Create and submit change
requests (read/write/create)</td>
</tr>
<tr><td><tt class="docutils literal">spp_change_request_v2.group_cr_validator</tt></td>
<td>Approve/reject, field-level
validation (read/write/create)</td>
</tr>
<tr><td><tt class="docutils literal">spp_change_request_v2.group_cr_validator_hq</tt></td>
<td>HQ-level approval with registry
write (read/write/create)</td>
</tr>
<tr><td><tt class="docutils literal">spp_change_request_v2.group_cr_manager</tt></td>
<td>Full CRUD including
configuration</td>
</tr>
<tr><td><tt class="docutils literal">spp_change_request_v2.group_cr_conflict_approver</tt></td>
<td>Override blocking conflict
detections
(specialized/functional)</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="extension-points">
<h1>Extension Points</h1>
<ul class="simple">
<li>Inherit <tt class="docutils literal">spp.change.request.type</tt> and override
<tt class="docutils literal">get_apply_strategy()</tt> to add custom application logic</li>
<li>Inherit <tt class="docutils literal">spp.cr.conflict.mixin</tt> and override
<tt class="docutils literal">_check_custom_conflicts()</tt> for custom conflict detection</li>
<li>Create new detail models inheriting <tt class="docutils literal">spp.cr.detail.base</tt> for custom
change request types</li>
<li>Override <tt class="docutils literal">_validate_documents()</tt> on <tt class="docutils literal">spp.change.request</tt> for
custom document validation</li>
<li>Use <tt class="docutils literal">_pre_enrollment_hook()</tt> and <tt class="docutils literal">_post_enrollment_hook()</tt>
patterns for side effects during application</li>
</ul>
</div>
<div class="section" id="dependencies">
<h1>Dependencies</h1>
<p><tt class="docutils literal">base</tt>, <tt class="docutils literal">mail</tt>, <tt class="docutils literal">spp_base_common</tt>, <tt class="docutils literal">spp_registry</tt>,
<tt class="docutils literal">spp_security</tt>, <tt class="docutils literal">spp_approval</tt>, <tt class="docutils literal">spp_event_data</tt>, <tt class="docutils literal">spp_dms</tt>,
<tt class="docutils literal">spp_vocabulary</tt></p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
</ul>
</div>
<div class="section" id="usage">
<h2><a class="toc-backref" href="#toc-entry-1">Usage</a></h2>
</div>
</div>
<div class="section" id="developer-guide-creating-custom-cr-types">
<h1>Developer Guide: Creating Custom CR Types</h1>
<p>This guide walks through creating a new change request type, from a
minimal single-field example to advanced dynamic approval with
multi-tier workflows.</p>
<p><strong>Architecture overview</strong></p>
<p>A CR type consists of four parts:</p>
<table border="1" class="docutils">
<colgroup>
<col width="32%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Part</th>
<th class="head">What it does</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><strong>Detail model</strong></td>
<td>Python model holding the proposed changes
(inherits <tt class="docutils literal">spp.cr.detail.base</tt>)</td>
</tr>
<tr><td><strong>Detail form view</strong></td>
<td>XML view rendered inside the CR form</td>
</tr>
<tr><td><strong>CR type record</strong></td>
<td>XML data linking the detail model, view,
approval workflow, and field mappings</td>
</tr>
<tr><td><strong>Field mappings</strong></td>
<td>XML records defining how detail fields map to
registrant fields at apply time</td>
</tr>
</tbody>
</table>
<p>When a user creates a change request, the system:</p>
<ol class="arabic simple">
<li>Creates a <tt class="docutils literal">spp.change.request</tt> record</li>
<li>Auto-creates the linked detail record via <tt class="docutils literal">_ensure_detail()</tt></li>
<li>Pre-fills detail fields from the registrant via
<tt class="docutils literal">prefill_from_registrant()</tt></li>
<li>On submission, selects the approval workflow (static or dynamic)</li>
<li>After approval, applies changes to the registrant via field mappings
or custom logic</li>
</ol>
</div>
<div class="section" id="example-1-basic-cr-type-static-approval">
<h1>Example 1: Basic CR Type (Static Approval)</h1>
<p>A CR type that lets users update a single field with one-tier approval.</p>
<p><strong>Detail model</strong></p>
<pre class="code python literal-block">
<span class="c1"># models/cr_detail_update_widget.py</span><span class="w">
</span><span class="kn">from</span><span class="w"> </span><span class="nn">odoo</span><span class="w"> </span><span class="kn">import</span> <span class="n">fields</span><span class="p">,</span> <span class="n">models</span><span class="w">
</span><span class="k">class</span><span class="w"> </span><span class="nc">SPPCRDetailUpdateWidget</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span><span class="w">
</span> <span class="n">_name</span> <span class="o">=</span> <span class="s2">"spp.cr.detail.update_widget"</span><span class="w">
</span> <span class="n">_description</span> <span class="o">=</span> <span class="s2">"CR Detail: Update Widget"</span><span class="w">
</span> <span class="n">_inherit</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"spp.cr.detail.base"</span><span class="p">,</span> <span class="s2">"mail.thread"</span><span class="p">]</span><span class="w">
</span> <span class="n">widget_id</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Many2one</span><span class="p">(</span><span class="w">
</span> <span class="s2">"spp.vocabulary.code"</span><span class="p">,</span><span class="w">
</span> <span class="n">string</span><span class="o">=</span><span class="s2">"Widget"</span><span class="p">,</span><span class="w">
</span> <span class="n">domain</span><span class="o">=</span><span class="s2">"[('namespace_uri', '=', 'urn:example:widget')]"</span><span class="p">,</span><span class="w">
</span> <span class="n">tracking</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span><span class="w">
</span> <span class="p">)</span><span class="w">
</span> <span class="k">def</span><span class="w"> </span><span class="nf">_get_prefill_mapping</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span><span class="w">
</span> <span class="k">return</span> <span class="p">{</span><span class="s2">"widget_id"</span><span class="p">:</span> <span class="s2">"widget_id"</span><span class="p">}</span>
</pre>
<p>Key points:</p>
<ul class="simple">
<li>Always inherit <tt class="docutils literal">spp.cr.detail.base</tt> (required) and <tt class="docutils literal">mail.thread</tt>
(for tracking)</li>
<li>Never use <tt class="docutils literal">required=True</tt> on detail fields — the detail record is
created empty by <tt class="docutils literal">_ensure_detail()</tt> and populated later</li>
<li><tt class="docutils literal">_get_prefill_mapping()</tt> returns
<tt class="docutils literal">{detail_field: registrant_field}</tt> — the base class copies current
registrant values into the detail on creation</li>
</ul>
<p><strong>Detail form view</strong></p>
<pre class="code xml literal-block">
<span class="cm"><!-- views/detail_update_widget_views.xml --></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"spp_cr_detail_update_widget_form"</span><span class="w"> </span><span class="na">model=</span><span class="s">"ir.ui.view"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>spp.cr.detail.update_widget.form<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"model"</span><span class="nt">></span>spp.cr.detail.update_widget<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"arch"</span><span class="w"> </span><span class="na">type=</span><span class="s">"xml"</span><span class="nt">></span><span class="w">
</span><span class="nt"><form</span><span class="w"> </span><span class="na">string=</span><span class="s">"Update Widget"</span><span class="nt">></span><span class="w">
</span><span class="nt"><header></span><span class="w">
</span><span class="nt"><button</span><span class="w"> </span><span class="na">name=</span><span class="s">"action_proceed_to_cr"</span><span class="w"> </span><span class="na">string=</span><span class="s">"Proceed"</span><span class="w">
</span><span class="na">type=</span><span class="s">"object"</span><span class="w"> </span><span class="na">class=</span><span class="s">"btn-primary"</span><span class="w">
</span><span class="na">invisible=</span><span class="s">"approval_state != 'draft'"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><button</span><span class="w"> </span><span class="na">name=</span><span class="s">"action_proceed_to_cr"</span><span class="w"> </span><span class="na">string=</span><span class="s">"Proceed"</span><span class="w">
</span><span class="na">type=</span><span class="s">"object"</span><span class="w"> </span><span class="na">class=</span><span class="s">"btn-primary"</span><span class="w">
</span><span class="na">invisible=</span><span class="s">"approval_state != 'revision'"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_state"</span><span class="w"> </span><span class="na">widget=</span><span class="s">"statusbar"</span><span class="w">
</span><span class="na">statusbar_visible=</span><span class="s">"draft,pending,approved,applied"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"></header></span><span class="w">
</span><span class="nt"><sheet></span><span class="w">
</span><span class="nt"><group></span><span class="w">
</span><span class="nt"><group></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"widget_id"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"></group></span><span class="w">
</span><span class="nt"></group></span><span class="w">
</span><span class="nt"></sheet></span><span class="w">
</span><span class="nt"></form></span><span class="w">
</span><span class="nt"></field></span><span class="w">
</span><span class="nt"></record></span>
</pre>
<p>The <tt class="docutils literal">action_proceed_to_cr</tt> button navigates back to the parent CR
form. <tt class="docutils literal">approval_state</tt> is a related field from <tt class="docutils literal">spp.cr.detail.base</tt>.</p>
<p><strong>Approval definition and CR type data</strong></p>
<pre class="code xml literal-block">
<span class="cm"><!-- data/cr_type_update_widget.xml --></span><span class="w">
</span><span class="nt"><odoo</span><span class="w"> </span><span class="na">noupdate=</span><span class="s">"1"</span><span class="nt">></span><span class="w">
</span><span class="cm"><!-- Approval definition: single-tier group approval --></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"approval_def_update_widget"</span><span class="w"> </span><span class="na">model=</span><span class="s">"spp.approval.definition"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>Update<span class="w"> </span>Widget<span class="w"> </span>Approval<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"model_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"spp_change_request_v2.model_spp_change_request"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_type"</span><span class="nt">></span>group<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_group_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"my_module.group_validator"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"is_require_comment"</span><span class="nt">></span>True<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"sla_days"</span><span class="nt">></span>5<span class="nt"></field></span><span class="w">
</span><span class="nt"></record></span><span class="w">
</span><span class="cm"><!-- CR type --></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"cr_type_update_widget"</span><span class="w"> </span><span class="na">model=</span><span class="s">"spp.change.request.type"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>Update<span class="w"> </span>Widget<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"code"</span><span class="nt">></span>update_widget<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"description"</span><span class="nt">></span>Update<span class="w"> </span>widget<span class="w"> </span>assignment<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"target_type"</span><span class="nt">></span>individual<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"detail_model"</span><span class="nt">></span>spp.cr.detail.update_widget<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"detail_form_view_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"spp_cr_detail_update_widget_form"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"apply_strategy"</span><span class="nt">></span>field_mapping<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"auto_apply_on_approve"</span><span class="nt">></span>True<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_definition_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"approval_def_update_widget"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"icon"</span><span class="nt">></span>fa-cog<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"sequence"</span><span class="nt">></span>50<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"is_system_type"</span><span class="nt">></span>True<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"source_module"</span><span class="nt">></span>my_module<span class="nt"></field></span><span class="w">
</span><span class="nt"></record></span><span class="w">
</span><span class="cm"><!-- Field mapping: detail.widget_id → registrant.widget_id --></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"cr_type_update_widget_mapping"</span><span class="w"> </span><span class="na">model=</span><span class="s">"spp.change.request.type.mapping"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"type_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"cr_type_update_widget"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"source_field"</span><span class="nt">></span>widget_id<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"target_field"</span><span class="nt">></span>widget_id<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"sequence"</span><span class="nt">></span>10<span class="nt"></field></span><span class="w">
</span><span class="nt"></record></span><span class="w">
</span><span class="nt"></odoo></span>
</pre>
<p><strong>Access control</strong></p>
<p>Add rows to <tt class="docutils literal">security/ir.model.access.csv</tt>:</p>
<pre class="literal-block">
access_spp_cr_detail_update_widget_user,...,group_cr_user,1,1,1,0
access_spp_cr_detail_update_widget_validator,...,group_cr_validator,1,1,1,0
access_spp_cr_detail_update_widget_validator_hq,...,group_cr_validator_hq,1,1,1,0
access_spp_cr_detail_update_widget_manager,...,group_cr_manager,1,1,1,1
</pre>
<p><strong>Manifest</strong></p>
<pre class="code python literal-block">
<span class="p">{</span><span class="w">
</span> <span class="s2">"depends"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"spp_change_request_v2"</span><span class="p">],</span><span class="w">
</span> <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span><span class="w">
</span> <span class="s2">"security/ir.model.access.csv"</span><span class="p">,</span><span class="w">
</span> <span class="s2">"views/detail_update_widget_views.xml"</span><span class="p">,</span> <span class="c1"># views BEFORE data</span><span class="w">
</span> <span class="s2">"data/cr_type_update_widget.xml"</span><span class="p">,</span><span class="w">
</span> <span class="p">],</span><span class="w">
</span><span class="p">}</span>
</pre>
<p>Views must load before data that references them via
<tt class="docutils literal">detail_form_view_id</tt>.</p>
</div>
<div class="section" id="example-2-multi-field-cr-type-with-multi-tier-approval">
<h1>Example 2: Multi-Field CR Type with Multi-Tier Approval</h1>
<p>A CR type with several fields and a two-tier approval chain (Tier 1 then
Tier 2).</p>
<p><strong>Detail model with boolean prefill override</strong></p>
<pre class="code python literal-block">
<span class="kn">from</span><span class="w"> </span><span class="nn">odoo</span><span class="w"> </span><span class="kn">import</span> <span class="n">fields</span><span class="p">,</span> <span class="n">models</span><span class="w">
</span><span class="k">class</span><span class="w"> </span><span class="nc">SPPCRDetailUpdateProfile</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span><span class="w">
</span> <span class="n">_name</span> <span class="o">=</span> <span class="s2">"spp.cr.detail.update_profile"</span><span class="w">
</span> <span class="n">_description</span> <span class="o">=</span> <span class="s2">"CR Detail: Update Profile"</span><span class="w">
</span> <span class="n">_inherit</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"spp.cr.detail.base"</span><span class="p">,</span> <span class="s2">"mail.thread"</span><span class="p">]</span><span class="w">
</span> <span class="n">status_id</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Many2one</span><span class="p">(</span><span class="w">
</span> <span class="s2">"spp.vocabulary.code"</span><span class="p">,</span><span class="w">
</span> <span class="n">string</span><span class="o">=</span><span class="s2">"Status"</span><span class="p">,</span><span class="w">
</span> <span class="n">domain</span><span class="o">=</span><span class="s2">"[('namespace_uri', '=', 'urn:example:status')]"</span><span class="p">,</span><span class="w">
</span> <span class="n">tracking</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span><span class="w">
</span> <span class="p">)</span><span class="w">
</span> <span class="n">is_active</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Boolean</span><span class="p">(</span><span class="n">string</span><span class="o">=</span><span class="s2">"Active"</span><span class="p">,</span> <span class="n">tracking</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span><span class="w">
</span> <span class="n">notes</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Text</span><span class="p">(</span><span class="n">string</span><span class="o">=</span><span class="s2">"Notes"</span><span class="p">)</span><span class="w">
</span> <span class="k">def</span><span class="w"> </span><span class="nf">_get_prefill_mapping</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span><span class="w">
</span> <span class="k">return</span> <span class="p">{</span><span class="w">
</span> <span class="s2">"status_id"</span><span class="p">:</span> <span class="s2">"status_id"</span><span class="p">,</span><span class="w">
</span> <span class="s2">"is_active"</span><span class="p">:</span> <span class="s2">"is_active"</span><span class="p">,</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span> <span class="k">def</span><span class="w"> </span><span class="nf">prefill_from_registrant</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span><span class="w">
</span><span class="sd">"""Override: base class skips False booleans; use 'is not None' instead."""</span><span class="w">
</span> <span class="bp">self</span><span class="o">.</span><span class="n">ensure_one</span><span class="p">()</span><span class="w">
</span> <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">registrant_id</span><span class="p">:</span><span class="w">
</span> <span class="k">return</span><span class="w">
</span> <span class="n">mapping</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_prefill_mapping</span><span class="p">()</span><span class="w">
</span> <span class="n">values</span> <span class="o">=</span> <span class="p">{}</span><span class="w">
</span> <span class="k">for</span> <span class="n">detail_field</span><span class="p">,</span> <span class="n">registrant_field</span> <span class="ow">in</span> <span class="n">mapping</span><span class="o">.</span><span class="n">items</span><span class="p">():</span><span class="w">
</span> <span class="n">value</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">registrant_id</span><span class="p">,</span> <span class="n">registrant_field</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span><span class="w">
</span> <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span><span class="w">
</span> <span class="n">values</span><span class="p">[</span><span class="n">detail_field</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span><span class="w">
</span> <span class="k">if</span> <span class="n">values</span><span class="p">:</span><span class="w">
</span> <span class="bp">self</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">values</span><span class="p">)</span>
</pre>
<p><strong>Multi-tier approval definition (XML)</strong></p>
<p>Multi-tier definitions require a three-step pattern — Odoo enforces a
constraint that tiers must exist before <tt class="docutils literal">use_multitier</tt> can be
enabled:</p>
<pre class="code xml literal-block">
<span class="nt"><odoo</span><span class="w"> </span><span class="na">noupdate=</span><span class="s">"1"</span><span class="nt">></span><span class="w">
</span><span class="cm"><!-- Step 1: Create definition WITHOUT use_multitier --></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"approval_def_update_profile"</span><span class="w"> </span><span class="na">model=</span><span class="s">"spp.approval.definition"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>Update<span class="w"> </span>Profile<span class="w"> </span>-<span class="w"> </span>Two-Tier<span class="w"> </span>Approval<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"model_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"spp_change_request_v2.model_spp_change_request"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_type"</span><span class="nt">></span>group<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_group_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"my_module.group_tier1"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"is_require_comment"</span><span class="nt">></span>True<span class="nt"></field></span><span class="w">
</span><span class="nt"></record></span><span class="w">
</span><span class="cm"><!-- Step 2: Create tier records --></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"tier_update_profile_1"</span><span class="w"> </span><span class="na">model=</span><span class="s">"spp.approval.tier"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"definition_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"approval_def_update_profile"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>Tier<span class="w"> </span>1<span class="w"> </span>-<span class="w"> </span>Field<span class="w"> </span>Review<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"sequence"</span><span class="nt">></span>10<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_type"</span><span class="nt">></span>group<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_group_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"my_module.group_tier1"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"></record></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"tier_update_profile_2"</span><span class="w"> </span><span class="na">model=</span><span class="s">"spp.approval.tier"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"definition_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"approval_def_update_profile"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>Tier<span class="w"> </span>2<span class="w"> </span>-<span class="w"> </span>HQ<span class="w"> </span>Review<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"sequence"</span><span class="nt">></span>20<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_type"</span><span class="nt">></span>group<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_group_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"my_module.group_tier2"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"></record></span><span class="w">
</span><span class="cm"><!-- Step 3: Enable multi-tier AFTER tiers exist --></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"approval_def_update_profile"</span><span class="w"> </span><span class="na">model=</span><span class="s">"spp.approval.definition"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"use_multitier"</span><span class="nt">></span>True<span class="nt"></field></span><span class="w">
</span><span class="nt"></record></span><span class="w">
</span><span class="nt"></odoo></span>
</pre>
</div>
<div class="section" id="example-3-dynamic-approval">
<h1>Example 3: Dynamic Approval</h1>
<p>Dynamic approval lets the user select a single field to modify per
change request. The selected field determines which approval workflow
applies, using CEL-based conditions to route sensitive changes to
stricter workflows.</p>
<p>Three things are needed:</p>
<ol class="arabic simple">
<li>Override <tt class="docutils literal">_get_field_to_modify_selection()</tt> on the detail model</li>
<li>Create candidate approval definitions with CEL conditions</li>
<li>Set <tt class="docutils literal">use_dynamic_approval=True</tt> on the CR type and link the
candidates</li>
</ol>
<p><strong>Detail model with field selector</strong></p>
<pre class="code python literal-block">
<span class="kn">from</span><span class="w"> </span><span class="nn">odoo</span><span class="w"> </span><span class="kn">import</span> <span class="n">api</span><span class="p">,</span> <span class="n">fields</span><span class="p">,</span> <span class="n">models</span><span class="w">
</span><span class="k">class</span><span class="w"> </span><span class="nc">SPPCRDetailUpdateInfo</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span><span class="w">
</span> <span class="n">_name</span> <span class="o">=</span> <span class="s2">"spp.cr.detail.update_info"</span><span class="w">
</span> <span class="n">_description</span> <span class="o">=</span> <span class="s2">"CR Detail: Update Info"</span><span class="w">
</span> <span class="n">_inherit</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"spp.cr.detail.base"</span><span class="p">,</span> <span class="s2">"mail.thread"</span><span class="p">]</span><span class="w">
</span> <span class="n">status_id</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Many2one</span><span class="p">(</span><span class="s2">"spp.vocabulary.code"</span><span class="p">,</span> <span class="n">string</span><span class="o">=</span><span class="s2">"Status"</span><span class="p">)</span><span class="w">
</span> <span class="n">category_id</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Many2one</span><span class="p">(</span><span class="s2">"spp.vocabulary.code"</span><span class="p">,</span> <span class="n">string</span><span class="o">=</span><span class="s2">"Category"</span><span class="p">)</span><span class="w">
</span> <span class="n">is_priority</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Boolean</span><span class="p">(</span><span class="n">string</span><span class="o">=</span><span class="s2">"Priority"</span><span class="p">)</span><span class="w">
</span> <span class="nd">@api</span><span class="o">.</span><span class="n">model</span><span class="w">
</span> <span class="k">def</span><span class="w"> </span><span class="nf">_get_field_to_modify_selection</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span><span class="w">
</span><span class="sd">"""Define which fields appear in the 'Field to Modify' dropdown."""</span><span class="w">
</span> <span class="k">return</span> <span class="p">[</span><span class="w">
</span> <span class="p">(</span><span class="s2">"status_id"</span><span class="p">,</span> <span class="s2">"Status"</span><span class="p">),</span><span class="w">
</span> <span class="p">(</span><span class="s2">"category_id"</span><span class="p">,</span> <span class="s2">"Category"</span><span class="p">),</span><span class="w">
</span> <span class="p">(</span><span class="s2">"is_priority"</span><span class="p">,</span> <span class="s2">"Priority Flag"</span><span class="p">),</span><span class="w">
</span> <span class="p">]</span><span class="w">
</span> <span class="k">def</span><span class="w"> </span><span class="nf">_get_prefill_mapping</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span><span class="w">
</span> <span class="k">return</span> <span class="p">{</span><span class="w">
</span> <span class="s2">"status_id"</span><span class="p">:</span> <span class="s2">"status_id"</span><span class="p">,</span><span class="w">
</span> <span class="s2">"category_id"</span><span class="p">:</span> <span class="s2">"category_id"</span><span class="p">,</span><span class="w">
</span> <span class="s2">"is_priority"</span><span class="p">:</span> <span class="s2">"is_priority"</span><span class="p">,</span><span class="w">
</span> <span class="p">}</span>
</pre>
<p><strong>Detail form view with field visibility</strong></p>
<p>When dynamic approval is on, only the selected field is shown. Use the
<tt class="docutils literal">use_dynamic_approval</tt> related field (available on
<tt class="docutils literal">spp.cr.detail.base</tt>) instead of traversing
<tt class="docutils literal">change_request_id.request_type_id.use_dynamic_approval</tt>:</p>
<pre class="code xml literal-block">
<span class="nt"><form</span><span class="w"> </span><span class="na">string=</span><span class="s">"Update Info"</span><span class="nt">></span><span class="w">
</span><span class="nt"><header></span><span class="w">
</span><span class="nt"><button</span><span class="w"> </span><span class="na">name=</span><span class="s">"action_proceed_to_cr"</span><span class="w"> </span><span class="na">string=</span><span class="s">"Proceed"</span><span class="w">
</span><span class="na">type=</span><span class="s">"object"</span><span class="w"> </span><span class="na">class=</span><span class="s">"btn-primary"</span><span class="w">
</span><span class="na">invisible=</span><span class="s">"approval_state != 'draft'"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_state"</span><span class="w"> </span><span class="na">widget=</span><span class="s">"statusbar"</span><span class="w">
</span><span class="na">statusbar_visible=</span><span class="s">"draft,pending,approved,applied"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"></header></span><span class="w">
</span><span class="nt"><sheet></span><span class="w">
</span><span class="cm"><!-- Field selector: visible only when dynamic approval is on --></span><span class="w">
</span><span class="nt"><group</span><span class="w"> </span><span class="na">invisible=</span><span class="s">"not use_dynamic_approval"</span><span class="nt">></span><span class="w">
</span><span class="nt"><group></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"field_to_modify"</span><span class="w">
</span><span class="na">required=</span><span class="s">"use_dynamic_approval"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"></group></span><span class="w">
</span><span class="nt"></group></span><span class="w">
</span><span class="cm"><!-- Each field hidden when dynamic approval is on and not selected --></span><span class="w">
</span><span class="nt"><group></span><span class="w">
</span><span class="nt"><group></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"status_id"</span><span class="w">
</span><span class="na">invisible=</span><span class="s">"use_dynamic_approval
and field_to_modify != 'status_id'"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"category_id"</span><span class="w">
</span><span class="na">invisible=</span><span class="s">"use_dynamic_approval
and field_to_modify != 'category_id'"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"is_priority"</span><span class="w">
</span><span class="na">invisible=</span><span class="s">"use_dynamic_approval
and field_to_modify != 'is_priority'"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"></group></span><span class="w">
</span><span class="nt"></group></span><span class="w">
</span><span class="nt"></sheet></span><span class="w">
</span><span class="nt"></form></span>
</pre>
<p><strong>Candidate approval definitions with CEL conditions</strong></p>
<p>Candidates are evaluated in <tt class="docutils literal">sequence</tt> order. The first matching CEL
condition wins. A definition without a CEL condition acts as a catch-all
fallback.</p>
<pre class="code xml literal-block">
<span class="nt"><odoo</span><span class="w"> </span><span class="na">noupdate=</span><span class="s">"1"</span><span class="nt">></span><span class="w">
</span><span class="cm"><!-- Catch-all fallback (sequence=100, no CEL) — evaluated LAST --></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"approval_def_update_info_default"</span><span class="w"> </span><span class="na">model=</span><span class="s">"spp.approval.definition"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>Update<span class="w"> </span>Info<span class="w"> </span>-<span class="w"> </span>Default<span class="w"> </span>Approval<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"model_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"spp_change_request_v2.model_spp_change_request"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_type"</span><span class="nt">></span>group<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_group_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"my_module.group_basic_approver"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"sequence"</span><span class="nt">></span>100<span class="nt"></field></span><span class="w">
</span><span class="nt"></record></span><span class="w">
</span><span class="cm"><!-- Status changes require stricter approval (sequence=10) --></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"approval_def_update_info_status"</span><span class="w"> </span><span class="na">model=</span><span class="s">"spp.approval.definition"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>Update<span class="w"> </span>Info<span class="w"> </span>-<span class="w"> </span>Status<span class="w"> </span>Change<span class="w"> </span>(Escalated)<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"model_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"spp_change_request_v2.model_spp_change_request"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_type"</span><span class="nt">></span>group<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_group_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"my_module.group_senior_approver"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"sequence"</span><span class="nt">></span>10<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"use_cel_condition"</span><span class="nt">></span>True<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"cel_condition"</span><span class="nt">></span>record.selected_field_name<span class="w"> </span>==<span class="w"> </span>"status_id"<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"is_require_comment"</span><span class="nt">></span>True<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"sla_days"</span><span class="nt">></span>10<span class="nt"></field></span><span class="w">
</span><span class="nt"></record></span><span class="w">
</span><span class="cm"><!-- CR type with dynamic approval enabled --></span><span class="w">
</span><span class="nt"><record</span><span class="w"> </span><span class="na">id=</span><span class="s">"cr_type_update_info"</span><span class="w"> </span><span class="na">model=</span><span class="s">"spp.change.request.type"</span><span class="nt">></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"name"</span><span class="nt">></span>Update<span class="w"> </span>Info<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"code"</span><span class="nt">></span>update_info<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"target_type"</span><span class="nt">></span>individual<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"detail_model"</span><span class="nt">></span>spp.cr.detail.update_info<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"detail_form_view_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"spp_cr_detail_update_info_form"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"apply_strategy"</span><span class="nt">></span>field_mapping<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"auto_apply_on_approve"</span><span class="nt">></span>True<span class="nt"></field></span><span class="w">
</span><span class="cm"><!-- Static fallback --></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"approval_definition_id"</span><span class="w"> </span><span class="na">ref=</span><span class="s">"approval_def_update_info_default"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="cm"><!-- Dynamic approval --></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"use_dynamic_approval"</span><span class="nt">></span>True<span class="nt"></field></span><span class="w">
</span><span class="nt"><field</span><span class="w"> </span><span class="na">name=</span><span class="s">"candidate_definition_ids"</span><span class="w"> </span><span class="na">eval=</span><span class="s">"[
Command.link(ref('approval_def_update_info_status')),
Command.link(ref('approval_def_update_info_default')),
]"</span><span class="w"> </span><span class="nt">/></span><span class="w">
</span><span class="nt"></record></span><span class="w">
</span><span class="nt"></odoo></span>
</pre>
<p><strong>CEL condition reference</strong></p>
<p>CEL conditions have access to these variables:</p>
<table border="1" class="docutils">
<colgroup>
<col width="46%" />
<col width="11%" />
<col width="43%" />
</colgroup>
<thead valign="bottom">