[Koha-bugs] [Bug 31028] Add 'Report a concern' feature for patrons to report concerns about catalog records

Thu Nov 10 22:17:01 CET 2022

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=31028

--- Comment #368 from David Nind <david at davidnind.com> ---
Updated consolidated test plan/notes - may (or may not) make it easier for
testing/QA/documenting as there are so many patches:

1. Apply patches
2. Update database: updatedatabase
3. Build CSS:
   3.1 yarn install
   3.2 yarn build
   3.3 yarn build --opac

4. Setup for testing:
   4.1 Configure email for testing the work flow and notices - see [1] for
using Gmail and an app password
   4.2 Add an email address to the patron account used for testing the OPAC
(for example, koha)
   4.3 Add an email address to the staff account used for testing the staff
interface (for example, koha)
   4.4 Add an email address to the new CatalogerEmails system preference

5. Report a catalog concern from the OPAC:
   5.1 Enable the new system preference: OpacCatalogConcerns
   5.2 Search for a record and view the details page
   5.3 There is now a "Report a concern" link in the actions box on the
right-hand sidebar (under "Suggest a purchase")
   5.4 Click on "Report a concern"
   5.5 Add some information to the form (Title, information for each of the
headings) and click Submit
   5.6 Success message:"Your concern was successfully submitted."
   5.7 Repeat steps 5.2-5.6 for another record
   5.7 Log out from the OPAC and click on the "Report a concern" link for a
record - you should be prompted to log in. After logging in, you are then
redirected back to the record page and the form is displayed to report a
concern.
   5.8 Confirm emails received:
       . Patron that logged the cataloging concern should have received a
"Catalog concern acknowledgement" message
       . The email address configured for CatalogerEmails system preference
should have received a "Catalog concern reported" message

6. Manage catalog concerns from the staff interface:
   6.1 From the staff interface home page, select the "Catalog concerns
pending: 2" link after the main module links.
   OR
   6.0 Go to Cataloging > Reports > Catalog concerns
   6.4 The concern(s) you entered on the OPAC should be listed
   6.5 Click on "Details" in the actions column
       ==> Ticket details displayed in a modal window
   6.6 Add some text in the update field for the concern, select the Notify
checkbox, and click on the Comment button
   6.7 Click the "Details" action again, add an update, select the Notify
checkbox, and click on the Resolve button
   6.8 Check that the table filters for each column work as expected
   6.9 Check that "Hide resolved" and "Show all" filters for the page work as
expected
   6.10 Check that notifications are sent:
        . process the mail queue: misc/cronjobs/process_message_queue.pl
        . the patron should receive a "Catalog concern updated" and "Catalog
concern resolved" messages

7. Report a catalog concern from the staff interface:
   7.1 Enable the CatalogConcerns system preference
   7.1 Search for a record and view the details page
   7.2 Select New > New catalog concern
   7.4 Enter a title and details, and submit
   7.5 Catalog concerns created by staff are managed in the exact same way as
those reported from the OPAC - see 6. (includes email notifications)

8. View catalog concerns for a record in the staff interface:
   8.1 Go to the record that a concern was logged for in step 5
   8.2 Note that there is now a "Concerns" tab for the record
   8.3 The "Concerns" tab should list catalog concerns, and you can view the
"Details" and manage concern in the same way as step 6

9. Notifications: 
   9.1 There are four new notice templates in the Catalog category:
TICKET_NOTIFY, TICKET_ACKNOWLEDGE, TICKET_RESOLVE, TICKET_UPDATE (see Tools >
Patrons and circulation > Notices and slips)
   9.2 Prevous steps should have triggered the various notices:
       . TICKET_ACKNOWLEDGE: email to patron when they raise a concern
       . TICKET_NOTIFY: email to library staff when a concern is raised
       . TICKET_UPDATE: add an update to a concern
       . TICKET_RESOLVE: when concern marked as resolved
    9.3 Check that you can see the notices for the patron used in step 5 in
their account: Patron details > Notices section

10. Test with OPACReportProblem enabled:
    10.1 Enable the system preference
    10.2 Submit a "Report a problem" report from the OPAC
    10.3 Check that this works as expected in the staff interface, and that
both pending problem reports and catalog concerns are displayed
    10.4 BONUS tests (optional): test various combinations of enabling and
disabling suggestions, OPACReportProblem, AllowCheckoutNotes,
OpacCatalogConcerns, and CatalogConcerns system preferences

11. Test a non-super librarian and set them up so that they can manage catalog
concerns:
    11.1 Add a username and password to a staff user (for example: Henry
Acevedo)
    11.2 Set the account so that they have some permissions, such as staff
access, suggestion management, place and manage holds, but NOT Edit catalog
(editcatalogue)
    11.3 Log in to the staff interface
    11.4 With active concerns, you should not see "Catalog concerns pending: X"
on the home page or be able to access Cataloging > Reports > Catalog concerns
    11.5 Change their permissions so that they have the Edit catalog
(editcatalogue) permission
    11.6 You should now see the pending concerns on the home page and be able
to view and manage catalog concerns

12. Table configuration: have some active catalog concerns, click configure,
hide status column by default, check that you can toggle the status column on
and off.

13. Customise the catalog concern help text and template:
    13.1 Go to Tools > HTML customizations
    13.2 Note that there are two entries available for editing:
CatalogConcernHelp and CatalogConcernTemplate
    13.3 Make some edits to the CatalogConcernTemplate (note: only use the text
editor)
    13.4 Make some edits to the CatalogConcernHelp using the WYSIWYG editor -
add a bulleted list and some bold text
    13.5 Go to report a concern from the OPAC and staff interface
    13.6 The changes you made should be reflected in the report a concern forms

[1] Set up KTD so that email can be sent (using a Gmail address and an app
password):

Fromm your Gmail account, set up an App Password.

Add these lines (with <user_name> and <password> updated) to
/etc/koha/sites/kohadev/koha-conf.xml:

<smtp_server>
    <host>smtp.gmail.com</host>
    <port>587</port>
    <timeout>5</timeout>
    <ssl_mode>STARTTLS</ssl_mode>
    <user_name>YOURGMAILADDRESS</user_name>
    <password>GMAILAPPPASSORD</password>
    <debug>1</debug>
 </smtp_server>

restart_all

-- 
You are receiving this mail because:
You are watching all bug changes.