From 2e036dbd2f955cf5e93449052dcd294239df9e8a Mon Sep 17 00:00:00 2001 From: BojanOD Date: Thu, 22 Dec 2022 15:21:35 +0100 Subject: [PATCH 1/8] [14.0][ADD] Helpdesk Stage Validation --- helpdesk_mgmt_stage_validation/README.rst | 79 ++++ helpdesk_mgmt_stage_validation/__init__.py | 3 + .../__manifest__.py | 13 + .../models/__init__.py | 6 + .../models/helpdesk_ticket.py | 41 ++ .../models/helpdesk_ticket_stage.py | 15 + .../readme/CONFIGURE.rst | 3 + .../readme/CONTRIBUTORS.rst | 1 + .../readme/DESCRIPTION.rst | 9 + .../readme/USAGE.rst | 3 + .../static/description/icon.png | Bin 0 -> 9455 bytes .../static/description/index.html | 438 ++++++++++++++++++ .../tests/__init__.py | 4 + .../test_helpdesk_ticket_stage_validation.py | 64 +++ .../views/helpdesk_ticket_stage.xml | 13 + 15 files changed, 692 insertions(+) create mode 100644 helpdesk_mgmt_stage_validation/README.rst create mode 100644 helpdesk_mgmt_stage_validation/__init__.py create mode 100644 helpdesk_mgmt_stage_validation/__manifest__.py create mode 100644 helpdesk_mgmt_stage_validation/models/__init__.py create mode 100644 helpdesk_mgmt_stage_validation/models/helpdesk_ticket.py create mode 100644 helpdesk_mgmt_stage_validation/models/helpdesk_ticket_stage.py create mode 100644 helpdesk_mgmt_stage_validation/readme/CONFIGURE.rst create mode 100644 helpdesk_mgmt_stage_validation/readme/CONTRIBUTORS.rst create mode 100644 helpdesk_mgmt_stage_validation/readme/DESCRIPTION.rst create mode 100644 helpdesk_mgmt_stage_validation/readme/USAGE.rst create mode 100644 helpdesk_mgmt_stage_validation/static/description/icon.png create mode 100644 helpdesk_mgmt_stage_validation/static/description/index.html create mode 100644 helpdesk_mgmt_stage_validation/tests/__init__.py create mode 100644 helpdesk_mgmt_stage_validation/tests/test_helpdesk_ticket_stage_validation.py create mode 100644 helpdesk_mgmt_stage_validation/views/helpdesk_ticket_stage.xml diff --git a/helpdesk_mgmt_stage_validation/README.rst b/helpdesk_mgmt_stage_validation/README.rst new file mode 100644 index 0000000000..d9f94b2571 --- /dev/null +++ b/helpdesk_mgmt_stage_validation/README.rst @@ -0,0 +1,79 @@ +================================ +Helpdesk Ticket Stage Validation +================================ + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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-BojanOD%2Fhelpdesk_stage_validation-lightgray.png?logo=github + :target: https://github.com/BojanOD/helpdesk_stage_validation/tree/14.0/helpdesk_mgmt_stage_validation + :alt: BojanOD/helpdesk_stage_validation + +|badge1| |badge2| |badge3| + +As the stage of a helpdesk ticket document progresses, it may be important for +specific fields of the document be completed. + +For example, when a helpdesk ticket enters the 'Complete' stage, the +fields for 'Actual End Date' and/or 'Resolution Notes' should be set. + +This module allows you to raise a Validation Error if the designated fields +are not set when moving to a new stage. Since stages can be used for helpdesk ticket, workers, locations, or equipments, this logic is available +to be applied to each document type. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +* Go to Helpdesk > Configuration > Stages +* Create or select a stage +* Select one or more fields to be validated + +Usage +===== + +* Follow steps outlined in Configuration. +* User will receive validation error if a field is not set when + attempting to move to a new stage. + +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 smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Camptocamp + +Contributors +~~~~~~~~~~~~ + +* Bojan Anchev + +Maintainers +~~~~~~~~~~~ + +This module is part of the `BojanOD/helpdesk_stage_validation `_ project on GitHub. + +You are welcome to contribute. diff --git a/helpdesk_mgmt_stage_validation/__init__.py b/helpdesk_mgmt_stage_validation/__init__.py new file mode 100644 index 0000000000..baafcef3cf --- /dev/null +++ b/helpdesk_mgmt_stage_validation/__init__.py @@ -0,0 +1,3 @@ +# Copyright 2022 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +from . import models diff --git a/helpdesk_mgmt_stage_validation/__manifest__.py b/helpdesk_mgmt_stage_validation/__manifest__.py new file mode 100644 index 0000000000..7f4b726496 --- /dev/null +++ b/helpdesk_mgmt_stage_validation/__manifest__.py @@ -0,0 +1,13 @@ +# Copyright 2022 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +{ + "name": "Helpdesk Ticket Stage Validation", + "summary": "Validate input data when reaching a Helpdesk Ticket stage", + "version": "14.0.1.0.0", + "category": "After-Sales", + "author": "Camptocamp, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/helpdesk", + "depends": ["helpdesk_mgmt"], + "data": ["views/helpdesk_ticket_stage.xml"], + "license": "AGPL-3", +} diff --git a/helpdesk_mgmt_stage_validation/models/__init__.py b/helpdesk_mgmt_stage_validation/models/__init__.py new file mode 100644 index 0000000000..c2de6ad377 --- /dev/null +++ b/helpdesk_mgmt_stage_validation/models/__init__.py @@ -0,0 +1,6 @@ +# Copyright 2022 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +from . import ( + helpdesk_ticket, + helpdesk_ticket_stage, +) diff --git a/helpdesk_mgmt_stage_validation/models/helpdesk_ticket.py b/helpdesk_mgmt_stage_validation/models/helpdesk_ticket.py new file mode 100644 index 0000000000..daeb62fff0 --- /dev/null +++ b/helpdesk_mgmt_stage_validation/models/helpdesk_ticket.py @@ -0,0 +1,41 @@ +# Copyright 2022 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import _, api, models +from odoo.exceptions import ValidationError + + +class HelpdeskTicket(models.Model): + _inherit = "helpdesk.ticket" + + def _check_ticket_has_empty_fields(self): + self.ensure_one() + error_message = False + field_ids = self.stage_id.validate_field_ids + field_names = [x.name for x in field_ids] + values = self.read(field_names) + fields = [ + field.field_description for field in field_ids if not values[0][field.name] + ] + fields = ", ".join(fields) + if fields: + error_message = _( + "Ticket %s can't be moved to the stage %s until " + "the following fields are set: %s." + ) % (self.name, self.stage_id.name, fields) + return error_message + + def _validate_stage_fields_error_message(self): + error_message = [] + for record in self: + message = record._check_ticket_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/helpdesk_mgmt_stage_validation/models/helpdesk_ticket_stage.py b/helpdesk_mgmt_stage_validation/models/helpdesk_ticket_stage.py new file mode 100644 index 0000000000..d707ba8292 --- /dev/null +++ b/helpdesk_mgmt_stage_validation/models/helpdesk_ticket_stage.py @@ -0,0 +1,15 @@ +# Copyright 2022 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class HelpdeskTicketStage(models.Model): + _inherit = "helpdesk.ticket.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", "=", "helpdesk.ticket")]', + ) diff --git a/helpdesk_mgmt_stage_validation/readme/CONFIGURE.rst b/helpdesk_mgmt_stage_validation/readme/CONFIGURE.rst new file mode 100644 index 0000000000..0bdd8e2bdf --- /dev/null +++ b/helpdesk_mgmt_stage_validation/readme/CONFIGURE.rst @@ -0,0 +1,3 @@ +* Go to Helpdesk > Configuration > Stages +* Create or select a stage +* Select one or more fields to be validated diff --git a/helpdesk_mgmt_stage_validation/readme/CONTRIBUTORS.rst b/helpdesk_mgmt_stage_validation/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000000..7d1a526704 --- /dev/null +++ b/helpdesk_mgmt_stage_validation/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* Bojan Anchev diff --git a/helpdesk_mgmt_stage_validation/readme/DESCRIPTION.rst b/helpdesk_mgmt_stage_validation/readme/DESCRIPTION.rst new file mode 100644 index 0000000000..0eb84ae12c --- /dev/null +++ b/helpdesk_mgmt_stage_validation/readme/DESCRIPTION.rst @@ -0,0 +1,9 @@ +As the stage of a helpdesk ticket document progresses, it may be important for +specific fields of the document be completed. + +For example, when a helpdesk ticket enters the 'Complete' stage, the +fields for 'Actual End Date' and/or 'Resolution Notes' should be set. + +This module allows you to raise a Validation Error if the designated fields +are not set when moving to a new stage. Since stages can be used for helpdesk ticket, workers, locations, or equipments, this logic is available +to be applied to each document type. diff --git a/helpdesk_mgmt_stage_validation/readme/USAGE.rst b/helpdesk_mgmt_stage_validation/readme/USAGE.rst new file mode 100644 index 0000000000..19d952495a --- /dev/null +++ b/helpdesk_mgmt_stage_validation/readme/USAGE.rst @@ -0,0 +1,3 @@ +* Follow steps outlined in Configuration. +* User will receive validation error if a field is not set when + attempting to move to a new stage. diff --git a/helpdesk_mgmt_stage_validation/static/description/icon.png b/helpdesk_mgmt_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/helpdesk_mgmt_stage_validation/static/description/index.html b/helpdesk_mgmt_stage_validation/static/description/index.html new file mode 100644 index 0000000000..f0f0445d7e --- /dev/null +++ b/helpdesk_mgmt_stage_validation/static/description/index.html @@ -0,0 +1,438 @@ + + + + + + +Helpdesk Ticket Stage Validation + + + +
+

Helpdesk Ticket Stage Validation

+ + +

Beta License: AGPL-3 BojanOD/helpdesk_stage_validation

+

As the stage of a helpdesk ticket document progresses, it may be important for +specific fields of the document be completed.

+

For example, when a helpdesk ticket enters the ‘Complete’ stage, the +fields for ‘Actual End Date’ and/or ‘Resolution Notes’ should be set.

+

This module allows you to raise a Validation Error if the designated fields +are not set when moving to a new stage. Since stages can be used for helpdesk ticket, workers, locations, or equipments, this logic is available +to be applied to each document type.

+

Table of contents

+ +
+

Configuration

+
    +
  • Go to Helpdesk > Configuration > Stages
    • +
  • Create or select a stage
    • +
  • Select one or more fields to be validated
    • +
+
+
+

Usage

+
    +
  • Follow steps outlined in Configuration.
    • +
  • User will receive validation error if a field is not set when +attempting to move to a new stage.
    • +
+
+
+

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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp
    • +
+
+ +
+

Maintainers

+

This module is part of the BojanOD/helpdesk_stage_validation project on GitHub.

+

You are welcome to contribute.

+
+
+
+ + diff --git a/helpdesk_mgmt_stage_validation/tests/__init__.py b/helpdesk_mgmt_stage_validation/tests/__init__.py new file mode 100644 index 0000000000..be050ba111 --- /dev/null +++ b/helpdesk_mgmt_stage_validation/tests/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2022 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from . import test_helpdesk_ticket_stage_validation diff --git a/helpdesk_mgmt_stage_validation/tests/test_helpdesk_ticket_stage_validation.py b/helpdesk_mgmt_stage_validation/tests/test_helpdesk_ticket_stage_validation.py new file mode 100644 index 0000000000..b30d376dd8 --- /dev/null +++ b/helpdesk_mgmt_stage_validation/tests/test_helpdesk_ticket_stage_validation.py @@ -0,0 +1,64 @@ +# Copyright 2022 Camptocamp SA +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import _, fields +from odoo.exceptions import ValidationError +from odoo.tests import SavepointCase + + +class TestHelpdeskStageValidation(SavepointCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.env = cls.env(context=dict(cls.env.context, tracking_disable=True)) + cls.stage = cls.env["helpdesk.ticket.stage"] + cls.helpdesk_ticket = cls.env["helpdesk.ticket"] + cls.ir_model_fields = cls.env["ir.model.fields"] + # Get some fields to use in the stages + cls.ticket_field = cls.ir_model_fields.search( + [("model", "=", "helpdesk.ticket"), ("name", "=", "assigned_date")] + ) + cls.stage_ticket_default = cls.stage.create( + { + "name": "Helpdesk Ticket Stage Default", + } + ) + cls.stage_ticket_assigned = cls.stage.create( + { + "name": "Helpdesk Ticket Assigned", + "validate_field_ids": [(6, 0, [cls.ticket_field.id])], + } + ) + cls.ticket = cls.helpdesk_ticket.create( + { + "name": "Helpdesk Ticket", + "description": "Helpdesk Ticket Description", + "stage_id": cls.stage_ticket_default.id, + } + ) + + def get_validate_message(self, ticket, stage): + validate_message = False + field_ids = stage.validate_field_ids + field_names = [x.name for x in field_ids] + values = ticket.read(field_names) + fields = [ + field.field_description for field in field_ids if not values[0][field.name] + ] + fields = ", ".join(fields) + if fields: + validate_message = _( + "Ticket %s can't be moved to the stage %s until " + "the following fields are set: %s." + ) % (ticket.name, stage.name, fields) + return validate_message + + def test_helpdesk_ticket_stage_validation(self): + validate_message = self.get_validate_message( + self.ticket, self.stage_ticket_assigned + ) + with self.assertRaisesRegex(ValidationError, validate_message): + self.ticket.write({"stage_id": self.stage_ticket_assigned.id}) + self.ticket.write({"assigned_date": fields.datetime.now()}) + self.ticket.write({"stage_id": self.stage_ticket_assigned.id}) + self.assertEqual(self.ticket.stage_id, self.stage_ticket_assigned) diff --git a/helpdesk_mgmt_stage_validation/views/helpdesk_ticket_stage.xml b/helpdesk_mgmt_stage_validation/views/helpdesk_ticket_stage.xml new file mode 100644 index 0000000000..bc26fc9060 --- /dev/null +++ b/helpdesk_mgmt_stage_validation/views/helpdesk_ticket_stage.xml @@ -0,0 +1,13 @@ + + + + helpdesk.ticket.stage + + + + + + + + + From e4e3ab6905aa2d52ca470f92c86becdf9af9326a Mon Sep 17 00:00:00 2001 From: oca-ci Date: Tue, 26 Mar 2024 08:21:30 +0000 Subject: [PATCH 2/8] [UPD] Update helpdesk_mgmt_stage_validation.pot --- .../i18n/helpdesk_mgmt_stage_validation.pot | 61 +++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 helpdesk_mgmt_stage_validation/i18n/helpdesk_mgmt_stage_validation.pot diff --git a/helpdesk_mgmt_stage_validation/i18n/helpdesk_mgmt_stage_validation.pot b/helpdesk_mgmt_stage_validation/i18n/helpdesk_mgmt_stage_validation.pot new file mode 100644 index 0000000000..2f34b8eee0 --- /dev/null +++ b/helpdesk_mgmt_stage_validation/i18n/helpdesk_mgmt_stage_validation.pot @@ -0,0 +1,61 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * helpdesk_mgmt_stage_validation +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 14.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: helpdesk_mgmt_stage_validation +#: model:ir.model.fields,field_description:helpdesk_mgmt_stage_validation.field_helpdesk_ticket__display_name +#: model:ir.model.fields,field_description:helpdesk_mgmt_stage_validation.field_helpdesk_ticket_stage__display_name +msgid "Display Name" +msgstr "" + +#. module: helpdesk_mgmt_stage_validation +#: model:ir.model.fields,field_description:helpdesk_mgmt_stage_validation.field_helpdesk_ticket_stage__validate_field_ids +msgid "Fields to Validate" +msgstr "" + +#. module: helpdesk_mgmt_stage_validation +#: model:ir.model,name:helpdesk_mgmt_stage_validation.model_helpdesk_ticket +msgid "Helpdesk Ticket" +msgstr "" + +#. module: helpdesk_mgmt_stage_validation +#: model:ir.model,name:helpdesk_mgmt_stage_validation.model_helpdesk_ticket_stage +msgid "Helpdesk Ticket Stage" +msgstr "" + +#. module: helpdesk_mgmt_stage_validation +#: model:ir.model.fields,field_description:helpdesk_mgmt_stage_validation.field_helpdesk_ticket__id +#: model:ir.model.fields,field_description:helpdesk_mgmt_stage_validation.field_helpdesk_ticket_stage__id +msgid "ID" +msgstr "" + +#. module: helpdesk_mgmt_stage_validation +#: model:ir.model.fields,field_description:helpdesk_mgmt_stage_validation.field_helpdesk_ticket____last_update +#: model:ir.model.fields,field_description:helpdesk_mgmt_stage_validation.field_helpdesk_ticket_stage____last_update +msgid "Last Modified on" +msgstr "" + +#. module: helpdesk_mgmt_stage_validation +#: model:ir.model.fields,help:helpdesk_mgmt_stage_validation.field_helpdesk_ticket_stage__validate_field_ids +msgid "Select fields which must be set on the document in this stage" +msgstr "" + +#. module: helpdesk_mgmt_stage_validation +#: code:addons/helpdesk_mgmt_stage_validation/models/helpdesk_ticket.py:0 +#: code:addons/helpdesk_mgmt_stage_validation/tests/test_helpdesk_ticket_stage_validation.py:0 +#, python-format +msgid "" +"Ticket %s can't be moved to the stage %s until the following fields are set:" +" %s." +msgstr "" From 3f46227244715925d4ca676646c09402227c58e8 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Tue, 26 Mar 2024 08:24:46 +0000 Subject: [PATCH 3/8] [BOT] post-merge updates --- helpdesk_mgmt_stage_validation/README.rst | 41 ++++++++++---- .../static/description/index.html | 54 ++++++++++--------- 2 files changed, 60 insertions(+), 35 deletions(-) diff --git a/helpdesk_mgmt_stage_validation/README.rst b/helpdesk_mgmt_stage_validation/README.rst index d9f94b2571..8a056df7c2 100644 --- a/helpdesk_mgmt_stage_validation/README.rst +++ b/helpdesk_mgmt_stage_validation/README.rst @@ -2,10 +2,13 @@ Helpdesk Ticket Stage Validation ================================ -.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:5d936cd9571b9a6a9218317dcc9a8d0ccf0aa6cf87060637d02109f2abb9319b + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png :target: https://odoo-community.org/page/development-status @@ -13,11 +16,17 @@ Helpdesk Ticket Stage Validation .. |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-BojanOD%2Fhelpdesk_stage_validation-lightgray.png?logo=github - :target: https://github.com/BojanOD/helpdesk_stage_validation/tree/14.0/helpdesk_mgmt_stage_validation - :alt: BojanOD/helpdesk_stage_validation - -|badge1| |badge2| |badge3| +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fhelpdesk-lightgray.png?logo=github + :target: https://github.com/OCA/helpdesk/tree/14.0/helpdesk_mgmt_stage_validation + :alt: OCA/helpdesk +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/helpdesk-14-0/helpdesk-14-0-helpdesk_mgmt_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/helpdesk&target_branch=14.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| As the stage of a helpdesk ticket document progresses, it may be important for specific fields of the document be completed. @@ -51,10 +60,10 @@ Usage Bug Tracker =========== -Bugs are tracked on `GitHub Issues `_. +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 smashing it by providing a detailed and welcomed -`feedback `_. +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. @@ -74,6 +83,16 @@ Contributors Maintainers ~~~~~~~~~~~ -This module is part of the `BojanOD/helpdesk_stage_validation `_ project on GitHub. +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/helpdesk `_ project on GitHub. -You are welcome to contribute. +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/helpdesk_mgmt_stage_validation/static/description/index.html b/helpdesk_mgmt_stage_validation/static/description/index.html index f0f0445d7e..39e6b06eba 100644 --- a/helpdesk_mgmt_stage_validation/static/description/index.html +++ b/helpdesk_mgmt_stage_validation/static/description/index.html @@ -1,20 +1,19 @@ - - + Helpdesk Ticket Stage Validation