Summary: | No way to turn off OverDrive integrations without removing all system preference values | ||
---|---|---|---|
Product: | Koha | Reporter: | Liz Rea <wizzyrea> |
Component: | OPAC | Assignee: | Owen Leonard <oleonard> |
Status: | Needs documenting --- | QA Contact: | Lucas Gass (lukeg) <lucas> |
Severity: | enhancement | ||
Priority: | P5 - low | CC: | barbara.johnson, lucas |
Version: | Main | ||
Hardware: | All | ||
OS: | All | ||
Change sponsored?: | --- | Patch complexity: | Small patch |
Documentation contact: | Documentation submission: | ||
Text to go in the release notes: |
This patch adds the new system preference `OPACOverDrive`. It allows a library to disable OverDrive features without having to remove one or more of their OverDrive credentials.
|
Version(s) released in: |
24.11.00
|
Circulation function: | |||
Attachments: |
Bug 37221: Add preference to turn off OPAC Overdrive features
Bug 37221: Add preference to turn off OPAC Overdrive features Bug 37221: Add preference to turn off OPAC Overdrive features Bug 37221: Add preference to turn off OPAC Overdrive features |
Description
Liz Rea
2024-06-28 14:49:04 UTC
Created attachment 168760 [details] [review] Bug 37221: Add preference to turn off OPAC Overdrive features This patch adds the preference "OPACOverDrive" to control whether OverDrive features are shown in the OPAC. This allows a library to disable OverDrive features without having to remove one or more of their OverDrive credentials. The patch also adds a check for the OPACOverDrive preference in the OverDrive search results page. If OverDrive is disabled, navigating to that page should give a 404. To test you will need OverDrive credentials to test with. - Apply the patch and run updatedatabase. - If you already had data in the OverDriveLibraryID, OverDriveClientKey, and OverDriveClientSecret system preferences, the OPACOverDrive preference will be enabled when added. If not it will be disabled by default. - Rebuild the staff interface CSS (https://wiki.koha-community.org/wiki/Working_with_SCSS_in_the_OPAC_and_staff_interface) - Go to Administration -> System preferences -> Enhanced content -> OverDrive. - If necessary, enter valid credentials in the OverDriveLibraryID, OverDriveClientKey, and OverDriveClientSecret system preferences. - Set OPACOverDrive to "Don't enable." - In the OPAC perform a catalog search. Normally, if your credentials were correct OverDrive search results would automatically appear at the top of Koha's search results. Now there should be none. - Enable the OPACOverDrive preference and repeat your search. Now OverDrive results should appear. - Confirm that the OverDrive search results page works correctly. - Test that OverDrive circulation features are working by logging in to the OPAC as a user who has active OverDrive checkouts. - Enable the OPACOverDrive and OverDriveCirculation system preferences. - On the user's summary page there should be a tab for "OverDrive account." - The tab should not appear if either OPACOverDrive or OverDriveCirculation is disabled. Sponsored-by: Athens County Public Libraries Created attachment 169594 [details] [review] Bug 37221: Add preference to turn off OPAC Overdrive features This patch adds the preference "OPACOverDrive" to control whether OverDrive features are shown in the OPAC. This allows a library to disable OverDrive features without having to remove one or more of their OverDrive credentials. The patch also adds a check for the OPACOverDrive preference in the OverDrive search results page. If OverDrive is disabled, navigating to that page should give a 404. To test you will need OverDrive credentials to test with. - Apply the patch and run updatedatabase. - If you already had data in the OverDriveLibraryID, OverDriveClientKey, and OverDriveClientSecret system preferences, the OPACOverDrive preference will be enabled when added. If not it will be disabled by default. - Rebuild the staff interface CSS (https://wiki.koha-community.org/wiki/Working_with_SCSS_in_the_OPAC_and_staff_interface) - Go to Administration -> System preferences -> Enhanced content -> OverDrive. - If necessary, enter valid credentials in the OverDriveLibraryID, OverDriveClientKey, and OverDriveClientSecret system preferences. - Set OPACOverDrive to "Don't enable." - In the OPAC perform a catalog search. Normally, if your credentials were correct OverDrive search results would automatically appear at the top of Koha's search results. Now there should be none. - Enable the OPACOverDrive preference and repeat your search. Now OverDrive results should appear. - Confirm that the OverDrive search results page works correctly. - Test that OverDrive circulation features are working by logging in to the OPAC as a user who has active OverDrive checkouts. - Enable the OPACOverDrive and OverDriveCirculation system preferences. - On the user's summary page there should be a tab for "OverDrive account." - The tab should not appear if either OPACOverDrive or OverDriveCirculation is disabled. Sponsored-by: Athens County Public Libraries Signed-off-by: Barbara Johnson <barbara.johnson@bedfordtx.gov> Created attachment 173979 [details] [review] Bug 37221: Add preference to turn off OPAC Overdrive features This patch adds the preference "OPACOverDrive" to control whether OverDrive features are shown in the OPAC. This allows a library to disable OverDrive features without having to remove one or more of their OverDrive credentials. The patch also adds a check for the OPACOverDrive preference in the OverDrive search results page. If OverDrive is disabled, navigating to that page should give a 404. To test you will need OverDrive credentials to test with. - Apply the patch and run updatedatabase. - If you already had data in the OverDriveLibraryID, OverDriveClientKey, and OverDriveClientSecret system preferences, the OPACOverDrive preference will be enabled when added. If not it will be disabled by default. - Rebuild the staff interface CSS (https://wiki.koha-community.org/wiki/Working_with_SCSS_in_the_OPAC_and_staff_interface) - Go to Administration -> System preferences -> Enhanced content -> OverDrive. - If necessary, enter valid credentials in the OverDriveLibraryID, OverDriveClientKey, and OverDriveClientSecret system preferences. - Set OPACOverDrive to "Don't enable." - In the OPAC perform a catalog search. Normally, if your credentials were correct OverDrive search results would automatically appear at the top of Koha's search results. Now there should be none. - Enable the OPACOverDrive preference and repeat your search. Now OverDrive results should appear. - Confirm that the OverDrive search results page works correctly. - Test that OverDrive circulation features are working by logging in to the OPAC as a user who has active OverDrive checkouts. - Enable the OPACOverDrive and OverDriveCirculation system preferences. - On the user's summary page there should be a tab for "OverDrive account." - The tab should not appear if either OPACOverDrive or OverDriveCirculation is disabled. Sponsored-by: Athens County Public Libraries Created attachment 174036 [details] [review] Bug 37221: Add preference to turn off OPAC Overdrive features This patch adds the preference "OPACOverDrive" to control whether OverDrive features are shown in the OPAC. This allows a library to disable OverDrive features without having to remove one or more of their OverDrive credentials. The patch also adds a check for the OPACOverDrive preference in the OverDrive search results page. If OverDrive is disabled, navigating to that page should give a 404. To test you will need OverDrive credentials to test with. - Apply the patch and run updatedatabase. - If you already had data in the OverDriveLibraryID, OverDriveClientKey, and OverDriveClientSecret system preferences, the OPACOverDrive preference will be enabled when added. If not it will be disabled by default. - Rebuild the staff interface CSS (https://wiki.koha-community.org/wiki/Working_with_SCSS_in_the_OPAC_and_staff_interface) - Go to Administration -> System preferences -> Enhanced content -> OverDrive. - If necessary, enter valid credentials in the OverDriveLibraryID, OverDriveClientKey, and OverDriveClientSecret system preferences. - Set OPACOverDrive to "Don't enable." - In the OPAC perform a catalog search. Normally, if your credentials were correct OverDrive search results would automatically appear at the top of Koha's search results. Now there should be none. - Enable the OPACOverDrive preference and repeat your search. Now OverDrive results should appear. - Confirm that the OverDrive search results page works correctly. - Test that OverDrive circulation features are working by logging in to the OPAC as a user who has active OverDrive checkouts. - Enable the OPACOverDrive and OverDriveCirculation system preferences. - On the user's summary page there should be a tab for "OverDrive account." - The tab should not appear if either OPACOverDrive or OverDriveCirculation is disabled. Sponsored-by: Athens County Public Libraries Signed-off-by: Lucas Gass <lucas@bywatersolutions.com> I like seeing these big on/off switches. Everything looks good here so I am passing QA. Is there a reason I need to Rebuild the staff interface CSS? (In reply to Lucas Gass (lukeg) from comment #5) > Is there a reason I need to Rebuild the staff interface CSS? Obviously my mistake since there are no CSS changes. Perhaps I made a change which I later rejected. (In reply to Owen Leonard from comment #6) > (In reply to Lucas Gass (lukeg) from comment #5) > > Is there a reason I need to Rebuild the staff interface CSS? > > Obviously my mistake since there are no CSS changes. Perhaps I made a change > which I later rejected. Thanks for confirming. Pushed for 24.11! Well done everyone, thank you! Enhancement, no 24.05.x backport. |