Summary: | Allow to send email receipts for payments/writeoff manually instead of automatically | ||
---|---|---|---|
Product: | Koha | Reporter: | Katrin Fischer <katrin.fischer> |
Component: | Fines and fees | Assignee: | Jake Deery <jake.deery> |
Status: | Needs documenting --- | QA Contact: | Testopia <testopia> |
Severity: | enhancement | ||
Priority: | P5 - low | CC: | chloe.zermatten, fridolin.somers, martin.renvoize |
Version: | Main | ||
Hardware: | All | ||
OS: | All | ||
GIT URL: | Change sponsored?: | --- | |
Patch complexity: | --- | Documentation contact: | |
Documentation submission: | Text to go in the release notes: |
**Summary:**
Email receipts were previously either sent automatically for all transactions or not at all, with no manual option.
**Enhancement:**
Staff can now manually email a receipt from the payment line using the new **'Receipt' → 'Email'** option.
The system preference `UseEmailReceipts` has been renamed to `AutomaticEmailReceipts` for clarity.
**Impact:**
Provides more flexibility and control over patron communication, and improves clarity in system configuration.
**Sponsored by** *Open Fifth*
|
|
Version(s) released in: |
25.05.00
|
Circulation function: | |
Bug Depends on: | 31448 | ||
Bug Blocks: | |||
Attachments: |
Bug 33473: Rename UseEmailReceipts to AutomaticEmailReceipts
Bug 33473: Rename UseEmailReceipts to AutomaticEmailReceipts Bug 33473: Rename UseEmailReceipts to AutomaticEmailReceipts Bug 33473: Rename UseEmailReceipts to AutomaticEmailReceipts Bug 33473: Rename UseEmailReceipts to AutomaticEmailReceipts |
Description
Katrin Fischer
2023-04-10 15:41:17 UTC
Created attachment 170314 [details] [review] Bug 33473: Rename UseEmailReceipts to AutomaticEmailReceipts This bug will rename the UseEmailReceipts to AutomaticEmailReceipts, to make it clearer the purpose of this syspref. This is because the receipts dropdown is no longer conditional, and will always show, even if AutomaticEmailReceipts is switched off. To test (steps a-e before applying patch): a) search sysprefs for 'EmailReceipts' 1) note the name is currently 'UseEmailReceipts' 2) enable this syspref b) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm c) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is visible d) go to members/notices.pl?borrowernumber=51 1) note that a receipt was automatically sent e) apply the patch, upgrade the db schema f) search sysprefs for 'EmailReceipts' 1) note the name is now 'AutomaticEmailReceipts' g) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm h) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is still visible i) go to members/notices.pl?borrowernumber=51 1) note that a receipt was automatically sent again j) disable the 'AutomaticEmailReceipts' syspref k) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm l) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is STILL visible m) go to members/notices.pl?borrowernumber=51 1) note that a receipt was NOT automatically sent n) go to members/boraccount.pl?borrowernumber=51 1) on any account line where a payment is made, click receipts > email o) go to members/notices.pl?borrowernumber=51 1) confirm a manual notice has been generated p) make coffee & have a mini disco Happy for there to be some discussion on this one, but my thoughts were that it would probably be best to rename the SysPref to 'AutomaticEmailReceipts', and remove the conditional logic for the receipt dropdown. If we think that having the option to explicitly turn off all email receipts is wise in 2024, I can write up a second patch for that and add a new SysPref called 'ShowEmailReceiptOption'. But do we really think it is necessary to do? Librarians can just choose not to use email receipts if they are undesirable? Let me know what your thoughts are! Minor request here.. we might want to check that the patron->notice_email_address is populated before displaying the button. Good point – let me add that in Created attachment 170980 [details] [review] Bug 33473: Rename UseEmailReceipts to AutomaticEmailReceipts This bug will rename the UseEmailReceipts to AutomaticEmailReceipts, to make it clearer the purpose of this syspref. This is because the receipts dropdown is no longer conditional, and will always show, even if AutomaticEmailReceipts is switched off. To test (steps a-e before applying patch): a) search sysprefs for 'EmailReceipts' 1) note the name is currently 'UseEmailReceipts' 2) enable this syspref b) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm c) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is visible d) go to members/notices.pl?borrowernumber=51 1) note that a receipt was automatically sent e) apply the patch, upgrade the db schema f) search sysprefs for 'EmailReceipts' 1) note the name is now 'AutomaticEmailReceipts' g) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm h) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is no longer visible i) go to members/notices.pl?borrowernumber=51 1) note that a receipt was automatically sent again j) disable the 'AutomaticEmailReceipts' syspref k) go to members/memberentry.pl?op=edit_form&destination=circ&borrowernumber=19 1) add a valid email address k) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm l) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is now visible m) go to members/notices.pl?borrowernumber=51 1) note that a receipt was NOT automatically sent n) go to members/boraccount.pl?borrowernumber=51 1) on any account line where a payment is made, click receipts > email o) go to members/notices.pl?borrowernumber=51 1) confirm a manual notice has been generated p) make coffee & have a mini disco Quick silly question: in the test plan, should the path in step k) finish with borrowernumber=51 instead of borrowernumber=19? (There also seem to be two step k)) Otherwise, I've gone through the test plan and it all seems to be working as intended (provided the right patron is updated with a working email address), so I'm happy to sign off! Well spotted Chloe, a lazy copy-paste from me. Fixing the patch note as we speak. Thanks in advance for the sign-off! Jake. Created attachment 171012 [details] [review] Bug 33473: Rename UseEmailReceipts to AutomaticEmailReceipts This bug will rename the UseEmailReceipts to AutomaticEmailReceipts, to make it clearer the purpose of this syspref. This is because the receipts dropdown is no longer conditional, and will always show, even if AutomaticEmailReceipts is switched off. To test (steps a-e before applying patch): a) search sysprefs for 'EmailReceipts' 1) note the name is currently 'UseEmailReceipts' 2) enable this syspref b) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm c) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is visible d) go to members/notices.pl?borrowernumber=51 1) note that a receipt was automatically sent e) apply the patch, upgrade the db schema f) search sysprefs for 'EmailReceipts' 1) note the name is now 'AutomaticEmailReceipts' g) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm h) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is no longer visible i) go to members/notices.pl?borrowernumber=51 1) note that a receipt was automatically sent again j) disable the 'AutomaticEmailReceipts' syspref k) go to members/memberentry.pl?op=edit_form&destination=circ&borrowernumber=51 1) add a valid email address k) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm l) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is now visible m) go to members/notices.pl?borrowernumber=51 1) note that a receipt was NOT automatically sent n) go to members/boraccount.pl?borrowernumber=51 1) on any account line where a payment is made, click receipts > email o) go to members/notices.pl?borrowernumber=51 1) confirm a manual notice has been generated p) make coffee & have a mini disco Created attachment 171013 [details] [review] Bug 33473: Rename UseEmailReceipts to AutomaticEmailReceipts This bug will rename the UseEmailReceipts to AutomaticEmailReceipts, to make it clearer the purpose of this syspref. This is because the receipts dropdown is no longer conditional, and will always show, even if AutomaticEmailReceipts is switched off. To test (steps a-e before applying patch): a) search sysprefs for 'EmailReceipts' 1) note the name is currently 'UseEmailReceipts' 2) enable this syspref b) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm c) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is visible d) go to members/notices.pl?borrowernumber=51 1) note that a receipt was automatically sent e) apply the patch, upgrade the db schema f) search sysprefs for 'EmailReceipts' 1) note the name is now 'AutomaticEmailReceipts' g) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm h) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is no longer visible i) go to members/notices.pl?borrowernumber=51 1) note that a receipt was automatically sent again j) disable the 'AutomaticEmailReceipts' syspref k) go to members/memberentry.pl?op=edit_form&destination=circ&borrowernumber=19 1) add a valid email address l) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm m) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is now visible n) go to members/notices.pl?borrowernumber=51 1) note that a receipt was NOT automatically sent o) go to members/boraccount.pl?borrowernumber=51 1) on any account line where a payment is made, click receipts > email p) go to members/notices.pl?borrowernumber=51 1) confirm a manual notice has been generated q) make coffee & have a mini disco Signed-off-by: Chloe Zermatten <chloe.zermatten@ptfs-europe.com> Once we're over the hump of 24.11, it would be nice to get a SO from someone outside of PTFS Europe :-) Jake. Created attachment 180328 [details] [review] Bug 33473: Rename UseEmailReceipts to AutomaticEmailReceipts This bug will rename the UseEmailReceipts to AutomaticEmailReceipts, to make it clearer the purpose of this syspref. This is because the receipts dropdown is no longer conditional, and will always show, even if AutomaticEmailReceipts is switched off. To test (steps a-e before applying patch): a) search sysprefs for 'EmailReceipts' 1) note the name is currently 'UseEmailReceipts' 2) enable this syspref b) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm c) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is visible d) go to members/notices.pl?borrowernumber=51 1) note that a receipt was automatically sent e) apply the patch, upgrade the db schema f) search sysprefs for 'EmailReceipts' 1) note the name is now 'AutomaticEmailReceipts' g) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm h) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is no longer visible i) go to members/notices.pl?borrowernumber=51 1) note that a receipt was automatically sent again j) disable the 'AutomaticEmailReceipts' syspref k) go to members/memberentry.pl?op=edit_form&destination=circ&borrowernumber=19 1) add a valid email address k) go to members/maninvoice.pl?borrowernumber=51 1) enter an amount (e.g. 100) 2) save & pay, confirm l) go to members/boraccount.pl?borrowernumber=51 1) note that the receipt dropdown is now visible m) go to members/notices.pl?borrowernumber=51 1) note that a receipt was NOT automatically sent n) go to members/boraccount.pl?borrowernumber=51 1) on any account line where a payment is made, click receipts > email o) go to members/notices.pl?borrowernumber=51 1) confirm a manual notice has been generated p) make coffee & have a mini disco Promtping to PQA to promote to Katrin for a final review as the original requestor... I'm comfortable with it but I'm biased ;) (In reply to Jake Deery from comment #10) > Once we're over the hump of 24.11, it would be nice to get a SO from someone > outside of PTFS Europe :-) > > Jake. Looks like we didn't manage that in the end, but I tried to be thorough. 1) QA script I fixed these up: OK Koha/Account.pm FAIL installer/data/mysql/atomicupdate/bug_33473-Add-option-to-resend-email-receipt-when-UseEmailReceipts-is-enabled.pl FAIL tidiness File is not tidy, please run `perl misc/devel/tidy.pl installer/data/mysql/atomicupdate/bug_33473-Add-option-to-resend-email-receipt-when-UseEmailReceipts-is-enabled.pl` FAIL installer/data/mysql/mandatory/sysprefs.sql FAIL sysprefs_order Not blocker: Sysprefs AutomaticEmailReceipts is bad placed (see bug 10610) OK koha-tmpl/intranet-tmpl/prog/en/modules/members/boraccount.tt FAIL t/db_dependent/Accounts.t FAIL tidiness File is not tidy, please run `perl misc/devel/tidy.pl t/db_dependent/Accounts.t` OK t/db_dependent/Koha/Account.t 2) Please use say_success for future db updates :) Pushed for 25.05! Well done everyone, thank you! Enhancement not pushed to 24.11.x |