From 7afa95906e1c0aafad742190bfb50635d6f3bb48 Mon Sep 17 00:00:00 2001 From: Marcel Savegnago Date: Thu, 4 Dec 2025 09:34:24 -0300 Subject: [PATCH] [ADD] crm_stage_validation: add new module --- crm_stage_validation/README.rst | 258 ++++++++ crm_stage_validation/__init__.py | 1 + crm_stage_validation/__manifest__.py | 13 + crm_stage_validation/models/__init__.py | 2 + crm_stage_validation/models/crm_lead.py | 49 ++ crm_stage_validation/models/crm_stage.py | 15 + crm_stage_validation/readme/CONFIGURE.md | 38 ++ crm_stage_validation/readme/CONTRIBUTORS.md | 2 + crm_stage_validation/readme/DESCRIPTION.md | 21 + crm_stage_validation/readme/USAGE.md | 74 +++ .../static/description/icon.png | Bin 0 -> 9455 bytes .../static/description/index.html | 600 ++++++++++++++++++ crm_stage_validation/tests/__init__.py | 1 + .../tests/test_crm_stage_validation.py | 70 ++ .../views/crm_stage_views.xml | 17 + .../odoo/addons/crm_stage_validation | 1 + setup/crm_stage_validation/setup.py | 6 + 17 files changed, 1168 insertions(+) create mode 100644 crm_stage_validation/README.rst create mode 100644 crm_stage_validation/__init__.py create mode 100644 crm_stage_validation/__manifest__.py create mode 100644 crm_stage_validation/models/__init__.py create mode 100644 crm_stage_validation/models/crm_lead.py create mode 100644 crm_stage_validation/models/crm_stage.py create mode 100644 crm_stage_validation/readme/CONFIGURE.md create mode 100644 crm_stage_validation/readme/CONTRIBUTORS.md create mode 100644 crm_stage_validation/readme/DESCRIPTION.md create mode 100644 crm_stage_validation/readme/USAGE.md create mode 100644 crm_stage_validation/static/description/icon.png create mode 100644 crm_stage_validation/static/description/index.html create mode 100644 crm_stage_validation/tests/__init__.py create mode 100644 crm_stage_validation/tests/test_crm_stage_validation.py create mode 100644 crm_stage_validation/views/crm_stage_views.xml create mode 120000 setup/crm_stage_validation/odoo/addons/crm_stage_validation create mode 100644 setup/crm_stage_validation/setup.py diff --git a/crm_stage_validation/README.rst b/crm_stage_validation/README.rst new file mode 100644 index 00000000000..add8c275dac --- /dev/null +++ b/crm_stage_validation/README.rst @@ -0,0 +1,258 @@ +==================== +CRM Stage Validation +==================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:5a586501d683052bb479588f34a634e8f0c4d481c2bcc945c64507636070b295 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fcrm-lightgray.png?logo=github + :target: https://github.com/OCA/crm/tree/16.0/crm_stage_validation + :alt: OCA/crm +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/crm-16-0/crm-16-0-crm_stage_validation + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/crm&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module extends the CRM functionality by allowing you to validate +that specific fields are filled when moving a lead/opportunity to a +certain stage. + +Main Features +------------- + +- **Field Validation per Stage**: Configure which fields must be filled + when a lead/opportunity reaches a specific stage +- **Flexible Configuration**: Select any field from the CRM lead model + to be validated +- **Clear Error Messages**: Users receive detailed validation errors + indicating which fields need to be filled +- **Multi-record Support**: Validation works when moving multiple + leads/opportunities at once + +Benefits +-------- + +- Ensure data quality by requiring important fields at specific pipeline + stages +- Prevent leads from advancing without crucial information +- Customize validation rules for each stage of your sales pipeline +- Improve reporting accuracy by ensuring complete data at each stage + +Dependencies +------------ + +This module requires: + +- ``crm``: Odoo's CRM module + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +This module requires configuration of the fields to validate for each +stage. + +Installation +------------ + +1. Go to the **Apps** menu +2. Remove the "Apps" filter if necessary +3. Search for "CRM Stage Validation" +4. Click **Install** + +Configuration +------------- + +**Setting up Field Validation for Stages** + +1. Go to **CRM > Configuration > Stages** +2. Select a stage you want to configure +3. In the **Stage Validation** section, find the **Fields to Validate** + field +4. Select one or more fields that must be filled when a lead/opportunity + reaches this stage +5. Save the stage + +**Example Configuration** + +For a "Proposition" stage, you might require: + +- **Expected Closing** - to ensure a deadline is set +- **Expected Revenue** - to track potential revenue +- **Contact Name** - to ensure a contact person is identified + +For a "Won" stage, you might require: + +- **Expected Revenue** - to ensure the deal value is recorded +- **Partner** - to ensure a customer is linked + +Permissions +----------- + +The module uses the same access permissions as the base CRM module: + +- Users with access to **CRM Configuration** can configure field + validation on stages +- All CRM users are subject to the validation rules when moving + leads/opportunities + +No additional permission configuration is required. + +Usage +===== + +This guide explains how to use the CRM Stage Validation module to +enforce data quality in your sales pipeline. + +How Validation Works +-------------------- + +When a user attempts to move a lead/opportunity to a stage that has +validation rules configured, the system will: + +1. Check if all required fields are filled +2. If any required field is empty, display a validation error +3. Block the stage change until all required fields are completed + +Working with Validated Stages +----------------------------- + +**Moving a Lead/Opportunity** + +1. Open a lead/opportunity in the CRM +2. Try to move it to a stage with validation rules (drag-and-drop in + kanban or change stage in form) +3. If validation fails, you will see an error message like: + "Lead/Opportunity [Name] can't be moved to the stage [Stage Name] + until the following fields are set: [Field Names]." + +4. Fill in the required fields +5. Try moving the lead/opportunity again + +**Bulk Operations** + +When moving multiple leads/opportunities at once: + +- Each record is validated individually +- All validation errors are displayed together +- No records are moved until all validations pass + +Validation Error Messages +------------------------- + +The validation error message includes: + +- The name of the lead/opportunity that failed validation +- The name of the target stage +- A list of all fields that need to be filled + +**Example Error Message:** + + Lead/Opportunity "Big Deal Corp" can't be moved to the stage + "Proposition" until the following fields are set: Expected Closing, + Expected Revenue. + +Usage Examples +-------------- + +**Example 1: Requiring Expected Revenue at Proposition Stage** + +1. Configure the "Proposition" stage to require "Expected Revenue" +2. User tries to move a lead to "Proposition" without filling expected + revenue +3. System displays: "Lead/Opportunity can't be moved to the stage + Proposition until the following fields are set: Expected Revenue." +4. User fills in the expected revenue +5. Lead is successfully moved to "Proposition" + +**Example 2: Multiple Required Fields** + +1. Configure the "Negotiation" stage to require "Expected Closing" and + "Contact Name" +2. User tries to move an opportunity to "Negotiation" with only contact + name filled +3. System displays the validation error for "Expected Closing" +4. User fills in the expected closing date +5. Opportunity is successfully moved to "Negotiation" + +**Example 3: Batch Move Validation** + +1. User selects 5 opportunities in kanban view +2. User drags them to a stage requiring "Expected Revenue" +3. 2 opportunities don't have expected revenue filled +4. System displays validation errors for those 2 opportunities +5. User fills in the missing data +6. Retries the batch move successfully + +Tips +---- + +- Start with key fields that are essential for your sales process +- Don't over-configure - too many required fields can slow down your + team +- Use validation strategically at milestone stages (Qualification, + Proposition, Negotiation) +- Review your validation rules periodically to ensure they match your + current process +- Train your team on the validation requirements to avoid frustration + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Escodoo + +Contributors +------------ + +- `ESCODOO `__: + + - Marcel Savegnago marcel.savegnago@escodoo.com.br + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/crm `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/crm_stage_validation/__init__.py b/crm_stage_validation/__init__.py new file mode 100644 index 00000000000..0650744f6bc --- /dev/null +++ b/crm_stage_validation/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/crm_stage_validation/__manifest__.py b/crm_stage_validation/__manifest__.py new file mode 100644 index 00000000000..80d8e9be6e8 --- /dev/null +++ b/crm_stage_validation/__manifest__.py @@ -0,0 +1,13 @@ +# Copyright 2025 Escodoo +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +{ + "name": "CRM Stage Validation", + "summary": "Validate input data when reaching a CRM Lead/Opportunity stage", + "version": "16.0.1.0.0", + "category": "Sales/CRM", + "author": "Escodoo, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/crm", + "depends": ["crm"], + "data": ["views/crm_stage_views.xml"], + "license": "AGPL-3", +} diff --git a/crm_stage_validation/models/__init__.py b/crm_stage_validation/models/__init__.py new file mode 100644 index 00000000000..40635a2a948 --- /dev/null +++ b/crm_stage_validation/models/__init__.py @@ -0,0 +1,2 @@ +from . import crm_lead +from . import crm_stage diff --git a/crm_stage_validation/models/crm_lead.py b/crm_stage_validation/models/crm_lead.py new file mode 100644 index 00000000000..c99c5028e28 --- /dev/null +++ b/crm_stage_validation/models/crm_lead.py @@ -0,0 +1,49 @@ +# Copyright 2025 Marcel Savegnago - Escodoo +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import _, api, models +from odoo.exceptions import ValidationError + + +class CrmLead(models.Model): + _inherit = "crm.lead" + + def _check_lead_has_empty_fields(self): + self.ensure_one() + error_message = False + field_ids = self.stage_id.sudo().validate_field_ids + field_names = [x.name for x in field_ids] + if not field_names: + return error_message + values = self.sudo().read(field_names) + labels = self.sudo().fields_get(field_names, attributes=["string"]) + fields = [ + labels[field.name]["string"] + for field in field_ids + if not values[0][field.name] + ] + fields = ", ".join(fields) + if fields: + error_message = _( + "Lead/Opportunity %(lead)s can't be moved to the stage %(stage)s " + "until the following fields are set: %(fields)s.", + lead=self.name, + stage=self.stage_id.name, + fields=fields, + ) + return error_message + + def _validate_stage_fields_error_message(self): + error_message = [] + for record in self: + message = record._check_lead_has_empty_fields() + if message: + error_message.append(message) + return error_message + + @api.constrains("stage_id") + def _validate_stage_fields(self): + message = self._validate_stage_fields_error_message() + if message: + message = "\n".join(message) + raise ValidationError(message) diff --git a/crm_stage_validation/models/crm_stage.py b/crm_stage_validation/models/crm_stage.py new file mode 100644 index 00000000000..a4f1207f71a --- /dev/null +++ b/crm_stage_validation/models/crm_stage.py @@ -0,0 +1,15 @@ +# Copyright 2025 Marcel Savegnago - Escodoo +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class CrmStage(models.Model): + _inherit = "crm.stage" + + validate_field_ids = fields.Many2many( + "ir.model.fields", + string="Fields to Validate", + help="Select fields which must be set on the document in this stage", + domain='[("model", "=", "crm.lead")]', + ) diff --git a/crm_stage_validation/readme/CONFIGURE.md b/crm_stage_validation/readme/CONFIGURE.md new file mode 100644 index 00000000000..fbc454ee953 --- /dev/null +++ b/crm_stage_validation/readme/CONFIGURE.md @@ -0,0 +1,38 @@ +This module requires configuration of the fields to validate for each stage. + +## Installation + +1. Go to the **Apps** menu +2. Remove the "Apps" filter if necessary +3. Search for "CRM Stage Validation" +4. Click **Install** + +## Configuration + +**Setting up Field Validation for Stages** + +1. Go to **CRM > Configuration > Stages** +2. Select a stage you want to configure +3. In the **Stage Validation** section, find the **Fields to Validate** field +4. Select one or more fields that must be filled when a lead/opportunity reaches this stage +5. Save the stage + +**Example Configuration** + +For a "Proposition" stage, you might require: +* **Expected Closing** - to ensure a deadline is set +* **Expected Revenue** - to track potential revenue +* **Contact Name** - to ensure a contact person is identified + +For a "Won" stage, you might require: +* **Expected Revenue** - to ensure the deal value is recorded +* **Partner** - to ensure a customer is linked + +## Permissions + +The module uses the same access permissions as the base CRM module: +* Users with access to **CRM Configuration** can configure field validation on stages +* All CRM users are subject to the validation rules when moving leads/opportunities + +No additional permission configuration is required. + diff --git a/crm_stage_validation/readme/CONTRIBUTORS.md b/crm_stage_validation/readme/CONTRIBUTORS.md new file mode 100644 index 00000000000..42d5a47f647 --- /dev/null +++ b/crm_stage_validation/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- [ESCODOO](https://escodoo.com.br): + - Marcel Savegnago diff --git a/crm_stage_validation/readme/DESCRIPTION.md b/crm_stage_validation/readme/DESCRIPTION.md new file mode 100644 index 00000000000..0d266c014fd --- /dev/null +++ b/crm_stage_validation/readme/DESCRIPTION.md @@ -0,0 +1,21 @@ +This module extends the CRM functionality by allowing you to validate that specific fields are filled when moving a lead/opportunity to a certain stage. + +## Main Features + +* **Field Validation per Stage**: Configure which fields must be filled when a lead/opportunity reaches a specific stage +* **Flexible Configuration**: Select any field from the CRM lead model to be validated +* **Clear Error Messages**: Users receive detailed validation errors indicating which fields need to be filled +* **Multi-record Support**: Validation works when moving multiple leads/opportunities at once + +## Benefits + +* Ensure data quality by requiring important fields at specific pipeline stages +* Prevent leads from advancing without crucial information +* Customize validation rules for each stage of your sales pipeline +* Improve reporting accuracy by ensuring complete data at each stage + +## Dependencies + +This module requires: +* `crm`: Odoo's CRM module + diff --git a/crm_stage_validation/readme/USAGE.md b/crm_stage_validation/readme/USAGE.md new file mode 100644 index 00000000000..d43ada5313e --- /dev/null +++ b/crm_stage_validation/readme/USAGE.md @@ -0,0 +1,74 @@ +This guide explains how to use the CRM Stage Validation module to enforce data quality in your sales pipeline. + +## How Validation Works + +When a user attempts to move a lead/opportunity to a stage that has validation rules configured, the system will: + +1. Check if all required fields are filled +2. If any required field is empty, display a validation error +3. Block the stage change until all required fields are completed + +## Working with Validated Stages + +**Moving a Lead/Opportunity** + +1. Open a lead/opportunity in the CRM +2. Try to move it to a stage with validation rules (drag-and-drop in kanban or change stage in form) +3. If validation fails, you will see an error message like: + > "Lead/Opportunity [Name] can't be moved to the stage [Stage Name] until the following fields are set: [Field Names]." +4. Fill in the required fields +5. Try moving the lead/opportunity again + +**Bulk Operations** + +When moving multiple leads/opportunities at once: +* Each record is validated individually +* All validation errors are displayed together +* No records are moved until all validations pass + +## Validation Error Messages + +The validation error message includes: +* The name of the lead/opportunity that failed validation +* The name of the target stage +* A list of all fields that need to be filled + +**Example Error Message:** + +> Lead/Opportunity "Big Deal Corp" can't be moved to the stage "Proposition" until the following fields are set: Expected Closing, Expected Revenue. + +## Usage Examples + +**Example 1: Requiring Expected Revenue at Proposition Stage** + +1. Configure the "Proposition" stage to require "Expected Revenue" +2. User tries to move a lead to "Proposition" without filling expected revenue +3. System displays: "Lead/Opportunity can't be moved to the stage Proposition until the following fields are set: Expected Revenue." +4. User fills in the expected revenue +5. Lead is successfully moved to "Proposition" + +**Example 2: Multiple Required Fields** + +1. Configure the "Negotiation" stage to require "Expected Closing" and "Contact Name" +2. User tries to move an opportunity to "Negotiation" with only contact name filled +3. System displays the validation error for "Expected Closing" +4. User fills in the expected closing date +5. Opportunity is successfully moved to "Negotiation" + +**Example 3: Batch Move Validation** + +1. User selects 5 opportunities in kanban view +2. User drags them to a stage requiring "Expected Revenue" +3. 2 opportunities don't have expected revenue filled +4. System displays validation errors for those 2 opportunities +5. User fills in the missing data +6. Retries the batch move successfully + +## Tips + +* Start with key fields that are essential for your sales process +* Don't over-configure - too many required fields can slow down your team +* Use validation strategically at milestone stages (Qualification, Proposition, Negotiation) +* Review your validation rules periodically to ensure they match your current process +* Train your team on the validation requirements to avoid frustration + diff --git a/crm_stage_validation/static/description/icon.png b/crm_stage_validation/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/crm_stage_validation/static/description/index.html b/crm_stage_validation/static/description/index.html new file mode 100644 index 00000000000..f5ce3ae9c3e --- /dev/null +++ b/crm_stage_validation/static/description/index.html @@ -0,0 +1,600 @@ + + + + + +CRM Stage Validation + + + +
+

CRM Stage Validation

+ + +

Beta License: AGPL-3 OCA/crm Translate me on Weblate Try me on Runboat

+

This module extends the CRM functionality by allowing you to validate +that specific fields are filled when moving a lead/opportunity to a +certain stage.

+
+

Main Features

+
    +
  • Field Validation per Stage: Configure which fields must be filled +when a lead/opportunity reaches a specific stage
    • +
  • Flexible Configuration: Select any field from the CRM lead model +to be validated
    • +
  • Clear Error Messages: Users receive detailed validation errors +indicating which fields need to be filled
    • +
  • Multi-record Support: Validation works when moving multiple +leads/opportunities at once
    • +
+
+
+

Benefits

+
    +
  • Ensure data quality by requiring important fields at specific pipeline +stages
    • +
  • Prevent leads from advancing without crucial information
    • +
  • Customize validation rules for each stage of your sales pipeline
    • +
  • Improve reporting accuracy by ensuring complete data at each stage
    • +
+
+
+

Dependencies

+

This module requires:

+
    +
  • crm: Odoo’s CRM module
    • +
+

Table of contents

+ +
+

Configuration

+

This module requires configuration of the fields to validate for each +stage.

+
+
+
+

Installation

+
    +
  1. Go to the Apps menu
    2. +
  2. Remove the “Apps” filter if necessary
    3. +
  3. Search for “CRM Stage Validation”
    4. +
  4. Click Install
    5. +
+
+
+

Configuration

+

Setting up Field Validation for Stages

+
    +
  1. Go to CRM > Configuration > Stages
    2. +
  2. Select a stage you want to configure
    3. +
  3. In the Stage Validation section, find the Fields to Validate +field
    4. +
  4. Select one or more fields that must be filled when a lead/opportunity +reaches this stage
    5. +
  5. Save the stage
    6. +
+

Example Configuration

+

For a “Proposition” stage, you might require:

+
    +
  • Expected Closing - to ensure a deadline is set
    • +
  • Expected Revenue - to track potential revenue
    • +
  • Contact Name - to ensure a contact person is identified
    • +
+

For a “Won” stage, you might require:

+
    +
  • Expected Revenue - to ensure the deal value is recorded
    • +
  • Partner - to ensure a customer is linked
    • +
+
+
+

Permissions

+

The module uses the same access permissions as the base CRM module:

+
    +
  • Users with access to CRM Configuration can configure field +validation on stages
    • +
  • All CRM users are subject to the validation rules when moving +leads/opportunities
    • +
+

No additional permission configuration is required.

+
+

Usage

+

This guide explains how to use the CRM Stage Validation module to +enforce data quality in your sales pipeline.

+
+
+
+

How Validation Works

+

When a user attempts to move a lead/opportunity to a stage that has +validation rules configured, the system will:

+
    +
  1. Check if all required fields are filled
    2. +
  2. If any required field is empty, display a validation error
    3. +
  3. Block the stage change until all required fields are completed
    4. +
+
+
+

Working with Validated Stages

+

Moving a Lead/Opportunity

+
    +
  1. Open a lead/opportunity in the CRM
    2. +
  2. Try to move it to a stage with validation rules (drag-and-drop in +kanban or change stage in form)
    3. +
  3. +
    If validation fails, you will see an error message like:
    +
    “Lead/Opportunity [Name] can’t be moved to the stage [Stage Name] +until the following fields are set: [Field Names].”
    +
    +
    4. +
  4. Fill in the required fields
    5. +
  5. Try moving the lead/opportunity again
    6. +
+

Bulk Operations

+

When moving multiple leads/opportunities at once:

+
    +
  • Each record is validated individually
    • +
  • All validation errors are displayed together
    • +
  • No records are moved until all validations pass
    • +
+
+
+

Validation Error Messages

+

The validation error message includes:

+
    +
  • The name of the lead/opportunity that failed validation
    • +
  • The name of the target stage
    • +
  • A list of all fields that need to be filled
    • +
+

Example Error Message:

+
+Lead/Opportunity “Big Deal Corp” can’t be moved to the stage +“Proposition” until the following fields are set: Expected Closing, +Expected Revenue.
+
+
+

Usage Examples

+

Example 1: Requiring Expected Revenue at Proposition Stage

+
    +
  1. Configure the “Proposition” stage to require “Expected Revenue”
    2. +
  2. User tries to move a lead to “Proposition” without filling expected +revenue
    3. +
  3. System displays: “Lead/Opportunity can’t be moved to the stage +Proposition until the following fields are set: Expected Revenue.”
    4. +
  4. User fills in the expected revenue
    5. +
  5. Lead is successfully moved to “Proposition”
    6. +
+

Example 2: Multiple Required Fields

+
    +
  1. Configure the “Negotiation” stage to require “Expected Closing” and +“Contact Name”
    2. +
  2. User tries to move an opportunity to “Negotiation” with only contact +name filled
    3. +
  3. System displays the validation error for “Expected Closing”
    4. +
  4. User fills in the expected closing date
    5. +
  5. Opportunity is successfully moved to “Negotiation”
    6. +
+

Example 3: Batch Move Validation

+
    +
  1. User selects 5 opportunities in kanban view
    2. +
  2. User drags them to a stage requiring “Expected Revenue”
    3. +
  3. 2 opportunities don’t have expected revenue filled
    4. +
  4. System displays validation errors for those 2 opportunities
    5. +
  5. User fills in the missing data
    6. +
  6. Retries the batch move successfully
    7. +
+
+
+

Tips

+
    +
  • Start with key fields that are essential for your sales process
    • +
  • Don’t over-configure - too many required fields can slow down your +team
    • +
  • Use validation strategically at milestone stages (Qualification, +Proposition, Negotiation)
    • +
  • Review your validation rules periodically to ensure they match your +current process
    • +
  • Train your team on the validation requirements to avoid frustration
    • +
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+
+
+

Authors

+
    +
  • Escodoo
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/crm project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+ + diff --git a/crm_stage_validation/tests/__init__.py b/crm_stage_validation/tests/__init__.py new file mode 100644 index 00000000000..3f0fd75f696 --- /dev/null +++ b/crm_stage_validation/tests/__init__.py @@ -0,0 +1 @@ +from . import test_crm_stage_validation diff --git a/crm_stage_validation/tests/test_crm_stage_validation.py b/crm_stage_validation/tests/test_crm_stage_validation.py new file mode 100644 index 00000000000..9fbbebb5653 --- /dev/null +++ b/crm_stage_validation/tests/test_crm_stage_validation.py @@ -0,0 +1,70 @@ +# Copyright 2025 Marcel Savegnago - Escodoo +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import _, fields +from odoo.exceptions import ValidationError +from odoo.tests.common import TransactionCase + +from odoo.addons.base.tests.common import DISABLED_MAIL_CONTEXT + + +class TestCrmStageValidation(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.env = cls.env["base"].with_context(**DISABLED_MAIL_CONTEXT).env + cls.stage = cls.env["crm.stage"] + cls.crm_lead = cls.env["crm.lead"] + cls.ir_model_fields = cls.env["ir.model.fields"] + # Get some fields to use in the stages + cls.lead_field = cls.ir_model_fields.search( + [("model", "=", "crm.lead"), ("name", "=", "date_deadline")] + ) + cls.stage_lead_default = cls.stage.create( + { + "name": "CRM Stage Default", + } + ) + cls.stage_lead_validated = cls.stage.create( + { + "name": "CRM Stage Validated", + "validate_field_ids": [(6, 0, [cls.lead_field.id])], + } + ) + cls.lead = cls.crm_lead.create( + { + "name": "Test Lead", + "stage_id": cls.stage_lead_default.id, + } + ) + + def get_validate_message(self, lead, stage): + validate_message = False + field_ids = stage.sudo().validate_field_ids + field_names = [x.name for x in field_ids] + values = lead.sudo().read(field_names) + fields_list = [ + field.field_description for field in field_ids if not values[0][field.name] + ] + fields_str = ", ".join(fields_list) + if fields_str: + validate_message = _( + "Lead/Opportunity %(lead)s can't be moved to the stage %(stage)s " + "until the following fields are set: %(fields)s." + % { + "lead": lead.name, + "stage": stage.name, + "fields": fields_str, + } + ) + return validate_message + + def test_crm_stage_validation(self): + validate_message = self.get_validate_message( + self.lead, self.stage_lead_validated + ) + with self.assertRaisesRegex(ValidationError, validate_message): + self.lead.write({"stage_id": self.stage_lead_validated.id}) + self.lead.write({"date_deadline": fields.Date.today()}) + self.lead.write({"stage_id": self.stage_lead_validated.id}) + self.assertEqual(self.lead.stage_id, self.stage_lead_validated) diff --git a/crm_stage_validation/views/crm_stage_views.xml b/crm_stage_validation/views/crm_stage_views.xml new file mode 100644 index 00000000000..f2ec9aeccb0 --- /dev/null +++ b/crm_stage_validation/views/crm_stage_views.xml @@ -0,0 +1,17 @@ + + + + + + crm.stage + + + + + + + + + + diff --git a/setup/crm_stage_validation/odoo/addons/crm_stage_validation b/setup/crm_stage_validation/odoo/addons/crm_stage_validation new file mode 120000 index 00000000000..e95f4887382 --- /dev/null +++ b/setup/crm_stage_validation/odoo/addons/crm_stage_validation @@ -0,0 +1 @@ +../../../../crm_stage_validation \ No newline at end of file diff --git a/setup/crm_stage_validation/setup.py b/setup/crm_stage_validation/setup.py new file mode 100644 index 00000000000..28c57bb6403 --- /dev/null +++ b/setup/crm_stage_validation/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)