[Bug 43141] New: Add more flexibility to ILL type disclaimer workflows
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 Bug ID: 43141 Summary: Add more flexibility to ILL type disclaimer workflows Initiative type: --- Sponsorship --- status: Product: Koha Version: unspecified Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: ILL Assignee: koha-bugs@lists.koha-community.org Reporter: olivia.reynolds@openfifth.co.uk QA Contact: testopia@bugs.koha-community.org CC: lisette@bywatersolutions.com, pedro.amorim@openfifth.co.uk, tomascohen@gmail.com Target Milestone: --- The current type disclaimer workflow for ILL requests requires the disclaimer to be filled out when the request is created and is determined uniformly for the OPAC and staff interfaces. Some workflows require more flexibility. For example, if a staff member is creating an ILL request on behalf of a patron, they should not have to fill out the type disclaimer through the staff interface, but should have the option of sending the patron a notice to fill it out. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 Olivia Reynolds <olivia.reynolds@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |ASSIGNED Assignee|koha-bugs@lists.koha-commun |olivia.reynolds@openfifth.c |ity.org |o.uk -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 Olivia Reynolds <olivia.reynolds@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |Needs Signoff Patch complexity|--- |Medium patch Comma delimited| |NHS England list of Sponsors| | Sponsorship status|--- |Sponsored -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #1 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 202348 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=202348&action=edit Bug 43141: Save text of type disclaimer when submitted This patch saves the displayed text of a completed type disclaimer, so that it can be referenced later. This functionality is tested further in a later patch. Test plan: 1. Prove t/db_dependent/Koha/ILL/Request.t Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #2 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 202349 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=202349&action=edit Bug 43141: Allow bypassing type disclaimer per-interface This patch adds an "interface" option to "ILLModuleDisclaimerByType", similar to "bypass". It can take "both", "none", "staff", or "opac" to control which interfaces show the type disclaimer screen. Test plan: 1. Prove t/db_dependent/Koha/ILL/Request/Workflow/TypeDisclaimer.t Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #3 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 202350 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=202350&action=edit Bug 43141: Add type disclaimer modal to request views This patch includes the new type_disclaimer_text field in the ILL request views. As there is now more information associated with the disclaimer, it is all displayed together in a modal. Furthermore, on the staff side it is possible to clear and fill out the disclaimer on behalf of a patron. Test plan: 1. Enable the ILLModule syspref. 2. Set the ILLModuleDisclaimerByType syspref to the following: all: text: Test text av_category_code: YES_NO interface: opac 3. Create an ILL request through the staff UI. Verify you are not prompted for a type disclaimer during creation. 4. View the new ILL request in the staff UI. Verify there is a "Type disclaimer" row showing "Fill in disclaimer for patron". 5. Click "Fill in disclaimer for patron", fill in the type declaration, and verify you return to viewing the ILL request. 6. View the same ILL request in the OPAC, and verify there is a type disclaimer row with a link to "View details". 7. Click "View details", and verify appropriate type disclaimer information is displayed in a modal. 8. In the staff view of the ILL request, verify the "Type disclaimer" row also now has a link to "View details". 9. Click "View details", and verify appropriate type disclaimer information is displayed in a modal. 10. In the modal, click "Clear disclaimer information". 11. Verify the disclaimer information is deleted, and the row once again shows "Fill in disclaimer for patron". Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #4 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 202351 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=202351&action=edit Bug 43141: DB updates Adds a table for storing prompts to patrons for filling out type disclaimers. As these disclaimers will be sent via notices, a new messaging preference is also introduced and enabled by default. Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #5 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 202352 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=202352&action=edit Bug 43141: DBIC updates (DO NOT PUSH) Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #6 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 202353 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=202353&action=edit Bug 43141: Add public page for filling out type disclaimer prompts To allow patrons to fill out type disclaimer prompts without authenticating, a new unauthenticating controller is introduced to look up the type disclaimer prompt based on a UUID. This functionality is included in a later test plan. Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #7 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 202354 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=202354&action=edit Bug 43141: Allow sending type disclaimer prompts This patch allows sending a notice to the patron associated with an ILL request, giving them a unique link to fill in a type disclaimer. Only one link is created for each request and patron, but the notice may be resent. A new messaging preference is used for this notice type. Test plan: 1. Reset KTD to pick up the database updates and new sample notice. 2. Enable the ILLModule syspref. 3. Set the ILLModuleDisclaimerByType syspref to the following: all: text: Test text av_category_code: YES_NO interface: opac 4. Create an ILL request through the staff UI, assigned to a patron. 5. View the new ILL request. Verify there is a "Prompt type disclaimer to user" option in the "Send notice to patron" dropdown. 6. Click "Prompt type disclaimer to user" and verify sending the notice is successful. 7. Verify the patron has received a notice containing a link to fill in the type disclaimer. 8. Visit this unique link in a logged-out session. Verify the type disclaimer form is displayed. 9. Fill out and submit the type disclaimer form. Verify there is a confirmation screen. 10. Visit the unique link again in a logged-out session. Verify the confirmation screen is displayed instead of the form. 11. Return to the ILL request view in the staff interface. Verify the type disclaimer information has been filled out correctly. 12. Prove t/db_dependent/Koha/ILL/Requests.t Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #8 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 202355 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=202355&action=edit Bug 43141: Add ILL table column for type disclaimer prompt replies This patch adds a (default-hidden) column to the ILL requests table indicating whether each request has been replied to via a type disclaimer prompt. Test plan (following on from previous patch): 1. Enable the "Type disclaimer prompt replied" column in the ILL requests table. 2. Verify the value in this column is "1" for the ILL request used in the previous test plan, which has been replied to via a prompt. 3. Create a new ILL request through the staff interface. 4. Verify the value in the "Type disclaimer prompt replied" column is 0 for this new request. 5. Send a type disclaimer prompt for this new request. 6. Verify the value in the "Type disclaimer prompt replied" column is still 0 for this new request. Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #9 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 202356 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=202356&action=edit Bug 43141: Add cronjob to cancel expired disclaimer prompt requests This cronjob cancels requests that: 1. Have associated type disclaimer prompts. 2. All of which have expired without reply. Test plan (following on from previous patches): 1. Delete all existing ILL requests. 2. Create an ILL request "A" without sending any prompts. 3. Create an ILL request "B", send a prompt and fill it in. 5. Create an ILL request "C", send a prompt and don't fill it in. 6. In the database console, execute the following SQL to force all prompts to expire: UPDATE ill_type_disclaimer_prompts SET valid_until='2000-01-01 11:11:11'; 7. Run: perl misc/cronjobs/cancel_expired_ill_disclaimers.pl -v -t 8. Verify it identifies one request "C" to cancel. 9. Run: perl misc/cronjobs/cancel_expired_ill_disclaimers.pl -v -c 10. Verify request "C" has been cancelled. Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 Olivia Reynolds <olivia.reynolds@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |ASSIGNED -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 Olivia Reynolds <olivia.reynolds@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |44110 Status|ASSIGNED |Needs Signoff Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=44110 [Bug 44110] Allow specifying multiple type disclaimer fields -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 Olivia Reynolds <olivia.reynolds@openfifth.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #202348|0 |1 is obsolete| | Attachment #202349|0 |1 is obsolete| | Attachment #202350|0 |1 is obsolete| | Attachment #202351|0 |1 is obsolete| | Attachment #202352|0 |1 is obsolete| | Attachment #202353|0 |1 is obsolete| | Attachment #202354|0 |1 is obsolete| | Attachment #202355|0 |1 is obsolete| | Attachment #202356|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #10 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 211785 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=211785&action=edit Bug 43141: DB Updates Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #11 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 211786 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=211786&action=edit Bug 43141: DBIC Updates (DO NOT PUSH) Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #12 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 211787 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=211787&action=edit Bug 43141: Allow specifying interface for disclaimers This patch adds an "interface" option to "ILLModuleDisclaimerByType", similar to "bypass". It can take "both", "none", "staff", or "opac" to control which interfaces show the type disclaimer screen. Test plan: 1. Apply patch. 2. Prove t/db_dependent/Koha/ILL/Request/Workflow/TypeDisclaimer.t, and verify all the tests pass. Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #13 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 211788 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=211788&action=edit Bug 43141: Add prompt object classes Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #14 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 211789 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=211789&action=edit Bug 43141: Allow filling in and clearing disclaimers This patch allows clear and fill out the disclaimer on behalf of a patron. It is possible to fill out only some of the disclaimer fields at a time. Those remaining can be filled later, either by using the "fill-in" functionality, or through the following disclaimer prompts. Test plan: 1. Enable the ILLModule syspref. 2. Set the ILLModuleDisclaimerByType syspref to the following: all: fields: - text: Field one av_category_code: YES_NO code: one interface: opac - text: Field two av_category_code: YES_NO code: two interface: opac 3. Create an ILL request through the staff UI. Verify you are not prompted for a type disclaimer during creation. 4. View the new ILL request in the staff UI. Verify there is a "Type disclaimer" row showing "Fill in disclaimer for patron". 5. Click "Fill in disclaimer for patron", fill in the first field of the type declaration, and verify you return to viewing the ILL request. 6. View the same ILL request in the OPAC, and verify there is a type disclaimer row with a link to "View details". 7. Click "View details", and verify appropriate type disclaimer information for the first field is displayed in a modal. 8. In the staff view of the ILL request, verify the "Type disclaimer" row also now has a link to "View details". 9. Click "View details", and verify appropriate type disclaimer information is displayed in a modal. 9. In the modal, click "Fill in disclaimer". 10. Verify only the second field is shown as available to fill in, and fill it in. 11. Return to the staff disclaimer modal, and verify it now displays both disclaimer field responses. 12. Verify the "Fill in disclaimer" option is no longer displayed in the modal, now that all disclaimer fields have been filled out. 13. Additionally confirm both responses are displayed in the OPAC modal. 14. In the staff modal, click "Clear disclaimer information". 15. Verify the disclaimer information is deleted, and the row once again shows "Fill in disclaimer for patron". Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #15 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 211790 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=211790&action=edit Bug 43141: Allow responding to type disclaimer prompts To allow patrons to fill out type disclaimer prompts without authenticating, a new unauthenticating controller is introduced to look up the type disclaimer prompt based on a UUID. This functionality is tested in a later patch. Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #16 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 211791 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=211791&action=edit Bug 43141: Allow sending type disclaimer prompts This patch allows sending a notice to the patron associated with an ILL request, giving them a unique link to fill in a type disclaimer. Multiple prompts may be sent over time for the same request, but each prompt can only be used once and they are tracked separately. A new messaging preference is used for this notice type. Test plan: 1. Apply patch. 2. Reset KTD to pick up the database updates and new sample notice. 3. Enable the ILLModule syspref. 4. Set the ILLModuleDisclaimerByType syspref to the following: all: fields: - text: Field one av_category_code: YES_NO code: one interface: opac - text: Field two av_category_code: YES_NO code: two interface: opac 5. Create an ILL request through the staff UI, assigned to a patron. 6. View the new ILL request. Verify there is a "Prompt type disclaimer to user" option in the "Send notice to patron" dropdown. 7. Click "Prompt type disclaimer to user" and verify sending the notice is successful. 8. Verify the patron has received a notice containing a link to fill in the type disclaimer. 9. Visit this unique link in a logged-out session. Verify the type disclaimer form is displayed. 10. Fill out and submit the type disclaimer form. Verify there is a confirmation screen. 11. Visit the unique link again in a logged-out session. Verify the confirmation screen is displayed instead of the form. 12. Return to the ILL request view in the staff interface. Verify the type disclaimer information has been filled out correctly. 13. Prove t/db_dependent/Koha/ILL/Requests.t Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #17 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 211792 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=211792&action=edit Bug 43141: Add type disclaimer prompts to staff and OPAC tables This patch adds a (default-hidden) column to the staff ILL requests table indicating whether each request has been replied to via a type disclaimer prompt. Additionally, a button is added to the OPAC ILL requests table to access disclaimer prompts directly. Test plan (following on from previous patch): 1. Apply patch. 2. Enable the "Type disclaimer prompt replied" column in the ILL requests table. 3. Verify the value in this column is "1" for the ILL request used in the previous test plan, which has been replied to via a prompt. 4. Create a new ILL request through the staff interface. 5. Verify the value in the "Type disclaimer prompt replied" column is 0 for this new request. 6. Send a type disclaimer prompt for this new request. 7. Verify the value in the "Type disclaimer prompt replied" column is still 0 for this new request. 8. As the requesting patron, navigate to their list of ILL requests on the OPAC. 9. Verify this new request has a "Complete type disclaimer" button. 10. Use this button to access the type disclaimer, and verify you can successfully complete it. 11. Verify this request now has 1 in its "Type disclaimer prompt replied" column in the staff interface. Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=43141 --- Comment #18 from Olivia Reynolds <olivia.reynolds@openfifth.co.uk> --- Created attachment 211793 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=211793&action=edit Bug 43141: Add cronjob to clean up expired disclaimer prompts This cronjob cancels requests that: 1. Have associated type disclaimer prompts. 2. All of which have expired without reply. Test plan (following on from previous patches): 1. Apply patch. 2. Delete all existing ILL requests. 3. Create an ILL request "A" without sending any prompts. 4. Create an ILL request "B", send a prompt and fill it in. 5. Create an ILL request "C", send a prompt and don't fill it in. 6. In the database console, execute the following SQL to force all prompts to expire: UPDATE ill_type_disclaimer_prompts SET valid_until='2000-01-01 11:11:11'; 7. Run: perl misc/cronjobs/cancel_expired_ill_disclaimers.pl -v -t 8. Verify it identifies one request "C" to cancel. 9. Run: perl misc/cronjobs/cancel_expired_ill_disclaimers.pl -v -c 10. Verify request "C" has been cancelled. Sponsored-by: NHS England -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon@bugs.koha-community.org