[Bug 14723] New: Additional delivery notes to messages
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Bug ID: 14723 Summary: Additional delivery notes to messages Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Notices Assignee: koha-bugs@lists.koha-community.org Reporter: larit@student.uef.fi QA Contact: testopia@bugs.koha-community.org Currently at message_queue we are given only two delivery statuses for messages, "sent" and "failed". When the status becomes failed, we have no idea why it fails. Some SMS gateway providers send the customer a report about the status of delivery. For example, in our local library we have a provider that does this. With the SMS HTTP request to their Gateway, we also provide them a "report" parameter that includes an URL. Once the SMS delivery has been finished, they will notify us with the status to the given report URL. If they notify us that the delivery was failed, we will modify its status in the database accordingly. They also provide a short description of why the delivery was failed. To be able to store more detailed information about the delivery, I propose adding a new column (e.g "delivery_notes") to message_queue table. In our local library we sometimes have angry borrowers complaining that they have not received SMS messages, so this type of enhancement would be very useful to be able to find out why such has happened. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 --- Comment #1 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42053 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42053&action=edit Bug 14723 - Additional delivery notes to messages This patch adds additional delivery notes to messages in message queue. They are useful, because there can be multiple reasons for a delivery to fail. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |13799 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 [Bug 13799] Add base for building RESTful API -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |larit@student.uef.fi |ity.org | -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 --- Comment #2 from Lari Taskula <larit@student.uef.fi> --- To test template modifications: 1. Find a borrower with notices at members/notices.pl 2. Observe that there is no column for Delivery notes 3. Apply patch and run the given database update 4. Repeat step 1. 5. Observe that there is now a column for Delivery notes -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 --- Comment #3 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42074 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42074&action=edit Bug 14723: (follow-up) Example of handling custom SMS::Send Driver reports This patch presents an example of how SMS::Send driver can be configured to receive reports from your SMS Gateway provider if they support such feature. With Bug 14723 adding a delivery note column to message_queue, you are now able to update the error status provided by your SMS gateway provider to the message. It uses REST API, so make sure to include dependencies. Koha conf gets a new block "smsProviders", where you are able to define your SMS Gateway login data and the report URL that our provider will use. Koha httpd conf gets an example for blocking all traffic to the REST API address for modifying the message status, apart from our provider IPs. Here is a description of the protocol and common actions with the example driver. 1. message_queue gets processed as usual. 2. Letters.pm calls our example driver with phone number, content and message_id (new!). 3. Our example driver sends a POST request to the SMS Gateway provider as follows: - user: username, loaded from koha conf smsProviders->labyrintti - password: password, loaded from koha conf smsProviders->labyrintti - dests: destination phone number - text: content of the message - report: the URL that SMS Gateway provider will update the status of this delivery, loaded from koha conf (with REST API, it should be http://yourhost.com/v1/messages) smsProviders->labyrintti 4. We get (hopefully) an OK message from our SMS provider. It will already let us know if there was an error with the phone number. If so, we return it to Letters.pm via HASH: { status => 1/0, delivery_note => the message of error/success } 5. When the delivery is complete, our SMS Gateway will contact us via the report URL we provided. 6. Via Swagger definitions, we will use Koha::REST::V1::Messages delivery_report to handle the report. If the given status is "ERROR" (this is our example provider's protocol), we will update the message status (and add delivery note) in message_queue for the given message_id. 7. All done, we have now handled the report given by our SMS Gateway provider :) -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |14536 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14536 [Bug 14536] PageObject-pattern base implementation -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42053|0 |1 is obsolete| | --- Comment #4 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42159 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42159&action=edit Bug 14723 - Additional delivery notes to messages Test plan: 1. Find a borrower with notices at members/notices.pl 2. Observe that there is no column for Delivery notes 3. Apply patch and run the given database update 4. Repeat step 1. 5. Observe that there is now a column for Delivery notes Includes PageObject Selenium test for delivery failures in C4::Letters. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42074|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42159|0 |1 is obsolete| | --- Comment #5 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42170 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42170&action=edit Bug 14723 - Additional delivery notes to messages -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on|13799, 14536 |7174 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=7174 [Bug 7174] Authentication rewriting http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 [Bug 13799] Add base for building RESTful API http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14536 [Bug 14536] PageObject-pattern base implementation -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |14767 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14767 [Bug 14767] Message delivery notes from SMS Gateway provider reports -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 --- Comment #6 from Lari Taskula <larit@student.uef.fi> --- Selenium tests are using PageObjects and Authentication rewrite (therefore dependencey on Bug 7174). The patch only covers delivery notes at failure cases in C4::Letters. If you wish to see how delivery notes can be taken further with custom SMS::Send driver and SMS Gateway reports, please see Bug 14767. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 --- Comment #7 from Lari Taskula <larit@student.uef.fi> --- (In reply to Lari Taskula from comment #3)
Created attachment 42074 [details] [review] Bug 14723: (follow-up) Example of handling custom SMS::Send Driver reports
Patch moved to bug 14767. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42170|0 |1 is obsolete| | --- Comment #8 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42227 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42227&action=edit Bug 14723 - Additional delivery notes to messages -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42227|0 |1 is obsolete| | --- Comment #9 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42228 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42228&action=edit Bug 14723 - Additional delivery notes to messages -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Zeno Tajoli <z.tajoli@cineca.it> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch complexity|--- |Small patch -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42228|0 |1 is obsolete| | --- Comment #10 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42384 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42384&action=edit Bug 14723 - Additional delivery notes to messages Fixed PageObject test by enabling EnhancedMessagingPreferences system preference via SystemPreferenceFactory. Without this preference, the Notices tab will not be shown in left navigation menu. Test plan: 1. Enable EnhancedMessagingPreferences syspref 2. Find a borrower with notices at members/notices.pl 3. Observe that there is no column for Delivery notes 4. Apply patch and run the given database update 5. Repeat step 1. 6. Observe that there is now a column for Delivery notes -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42384|0 |1 is obsolete| | --- Comment #11 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42453 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42453&action=edit Bug 14723 - Additional delivery notes to messages Added unit tests. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42453|0 |1 is obsolete| | --- Comment #12 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42455 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42455&action=edit Bug 14723 - Additional delivery notes to messages -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |http://bugs.koha-community. | |org/bugzilla3/show_bug.cgi? | |id=14791 -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |http://bugs.koha-community. | |org/bugzilla3/show_bug.cgi? | |id=14767 -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42455|0 |1 is obsolete| | --- Comment #13 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42466 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42466&action=edit Bug 14723 - Additional delivery notes to messages -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |14791 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14791 [Bug 14791] Automatically attempt to resend failed notices -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on|7174 |14698 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=7174 [Bug 7174] Authentication rewriting http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14698 [Bug 14698] AtomicUpdater - Keeps track of which updates have been applied to a database -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42466|0 |1 is obsolete| | --- Comment #14 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42505 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42505&action=edit Bug 14723 - Additional delivery notes to messages Database updates are now using the AtomicUpdater (Bug 14698) -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |7174 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=7174 [Bug 7174] Authentication rewriting -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42505|0 |1 is obsolete| | --- Comment #15 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42553 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42553&action=edit Bug 14723 - Additional delivery notes to messages Fixes MessageQueueFactory parameters to match database format. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42553|0 |1 is obsolete| | --- Comment #16 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42574 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42574&action=edit Bug 14723 - Additional delivery notes to messages -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |http://bugs.koha-community. | |org/bugzilla3/show_bug.cgi? | |id=12426 -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |14843 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14843 [Bug 14843] Notifications and messages via REST API -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |12426 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=12426 [Bug 12426] Allow resending of emails from the notices tab in the patron account -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42574|0 |1 is obsolete| | --- Comment #17 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42668 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42668&action=edit Bug 14723 - Additional delivery notes to messages Adds delivery_note to SELECT in GetMessage() (bug 12426). Includes PageObject Selenium test for delivery failures in C4::Letters. -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Lari Taskula <larit@student.uef.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42668|0 |1 is obsolete| | --- Comment #18 from Lari Taskula <larit@student.uef.fi> --- Created attachment 42669 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42669&action=edit Bug 14723 - Additional delivery notes to messages -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Mike <black23@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |black23@gmail.com -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 --- Comment #19 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 44367 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=44367&action=edit Bug 14723 - Additional delivery notes to messages - fixed missing kohastructure -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #44367|0 |1 is obsolete| | --- Comment #20 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 44413 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=44413&action=edit Bug 14723 - Additional delivery notes to messages - fixed missing kohastructure -- You are receiving this mail because: You are watching all bug changes.
http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14723 Frédéric Demians <frederic@tamil.fr> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |frederic@tamil.fr Status|Needs Signoff |Patch doesn't apply --- Comment #21 from Frédéric Demians <frederic@tamil.fr> --- Get this: fatal: sha1 information is lacking or useless (C4/Letters.pm). error: could not build fake ancestor -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org