Go to file
Ian Walls d29efac4f3 Talking Tech Support - Phase I
Implements support for Talking Tech I-tiva phone notification for OVERDUE, PREDUE and HOLD notifications.
Overdues respect triggers as configured for the patron's branch.
Predue and Holds notifications respect patron's messaging preference choices.
A new column for phone notification is added if the TalkingTechItivaPhoneNotification system preference is turned on

Record of phone messages being sent to patrons is added to the patron's Notices
tab; notice of success or failure can be retrieved from I-tiva.

See the TalkingTech.README for installation and set-up instructions.

Aside from the control system preference, and the necessary changes to Messaging Preferences
forms to make use of phone notifications, the bulk of the code resides in external
cronjobs.

TalkingTech_itiva_outbound.pl generates the Spec C file to send to I-tiva.  Actual transmission
of the file must be handled by the system administrator.

TalkingTech_itiva_inbound.pl processes the received Results file from I-tiva.  Getting the
file from I-tiva to Koha is the job of the system administrator, as well.

Both scripts have a --help option with full documentation.

The only necessary change to core Koha behavior is in C4::Letters::EnqueueLetter.  The return
value was changed from 0 or 1 (successful addition of letter to message_queue or not), to the actual
insert ID of the letter.  This was required by the outbound script to present a unique Transaction ID
for the notice added to the patron's record (so a 'sent' or 'failed' status could be updated).  Since
the dbh and sth are not shared, and the last_insert_id() command is table-specific, this should be thread-safe.
No changes are necessary to any parts of Koha, as all usage of EnqueueLetter currently ignores the return value.

To Test:

1. Turn on TalkingTechItivaPhoneNotification system preference
2. Verify that 'phone' is now a valid notification option for patrons on both staff and OPAC side
3. Attempt to set a 'phone' preference for PREDUE or HOLD messaging; attempt should succeed
4. Set up the patron for notices to triggers:
   a. include checked out items due in a range of days, including the value set up in their messaging preferences.
   b. place several holds, some in position, others waiting for pickup, others in transit.
   c. set the patron up to have overdues, overdue by a range of days that includes the delay values for
the patrons branch and categorycode
5. Run TalkingTech_itiva_outbound.pl --type=RESERVE --type=PREOVERDUE --type=OVERDUE --outfile=/tmp/talkingtechtest.csv

The resulting talkingtechtest.csv file should include all the items due on X days (where X is the patrons' preference),
and none of the ones due in other increments.  Similarly, overdues messages should be added for each item due by a delay
value as configured; overdues of other numbers of days should be ignore.  Holds that are waiting pick up or in transit should
have messages, those still pending should not.

Messages should be added to the patron's notices tab for each issue sent.  Verify these messages exist, and all Notices
tokens are replaced with appropriate information.

Repeat, this time with 4c making use of the default branch overdue triggers, instead of branch-specific triggers.

To test the inbound script, create a CSV with rows in the format "<<Message_id>>","<<SUCCESS or FAIL>>"
Message ID should correspond to the final column of the talkingtechtest.csv file (the transaction id) for the message.

Primary Authorship: Ian Walls
Additional modifications: Kyle M Hall

http://bugs.koha-community.org/show_bug.cgi?id=4246
Signed-off-by: Nicole C. Engard <nengard@bywatersolutions.com>

Tested and in use in production by two public libraries : Middletown
and Washoe. Both have given their sign off, but don't have git to
actually sign off.

Signed-off-by: Paul Poulain <paul.poulain@biblibre.com>
2012-06-10 17:46:52 +02:00
C4 Talking Tech Support - Phase I 2012-06-10 17:46:52 +02:00
Koha Bug 8092: Convert Koha::Cache to use CHI 2012-06-09 13:08:13 +02:00
acqui Bug 5337: EAN management : Adds ean for various searches 2012-06-09 18:26:34 +02:00
admin Talking Tech Support - Phase I 2012-06-10 17:46:52 +02:00
authorities Bug 7747 - Replace YUI autocomplete with jQueryUI 2012-05-31 18:07:55 +02:00
basket Bug 6050 Make calls to GetItemsInfo consistent 2011-06-14 14:12:02 +12:00
catalogue Bug 5337: EAN management : Adds ean for various searches 2012-06-09 18:26:34 +02:00
cataloguing Bug 7652: Add item barcode on top of its editing form 2012-06-10 11:49:31 +02:00
circ Bug 8178 - circ/circulation.pl under plack duplicates checkout rows 2012-06-10 13:02:05 +02:00
debian Bug 6684: Fixes to koha-remove 2012-05-28 11:14:27 +02:00
docs Adding Shari Perkins as contributor 2012-06-10 13:56:26 +02:00
errors Housekeeping in errors scripts 2010-05-12 07:29:03 -04:00
etc Bug 7586 - Search: Language restriction does NOT show expected results (no items shown) 2012-06-10 11:00:14 +02:00
install_misc Bug 7818: update miscellaneous installer scripts 2012-06-09 11:43:59 +02:00
installer Talking Tech Support - Phase I 2012-06-10 17:46:52 +02:00
koha-tmpl Talking Tech Support - Phase I 2012-06-10 17:46:52 +02:00
labels Bug 8140 - [SIGNED-OFF] Error when exporting label xml 2012-05-28 18:15:31 +02:00
members Talking Tech Support - Phase I 2012-06-10 17:46:52 +02:00
misc Talking Tech Support - Phase I 2012-06-10 17:46:52 +02:00
offline_circ Bug 4976 - Status of item returned with process_koc.pl is empty in Intranet 2012-03-19 16:23:10 +01:00
opac Talking Tech Support - Phase I 2012-06-10 17:46:52 +02:00
patroncards Bug 7318: Fixes category display in patroncards Patron Search results. 2012-02-27 18:01:00 +01:00
reports Bug 4330 : Fixing FSF address and copyright headers 2012-05-28 17:53:40 +02:00
reserve Bug 7815 : Order pickup libraries list by name rather than by code 2012-06-10 13:09:00 +02:00
reviews Bug 1623 - Provide view of approved comments 2011-12-27 18:26:50 +01:00
rotating_collections Bug 6553 : Follow up adding license statements 2011-08-13 19:54:38 +12:00
selenium Adding selenium tests for filterMembers 2009-09-30 11:30:37 +02:00
serials Bug 5337: EAN management : Adds ean for various searches 2012-06-09 18:26:34 +02:00
services Bug 7178: Acquisition item creation improvement 2012-03-26 11:07:23 +02:00
skel installer: fixed chown invocation; added skel for KOHA_LOG_DIR 2007-12-17 09:13:53 -06:00
sms Bug 2505 - Add commented use warnings where missing in the sms/ directory 2010-04-21 20:25:08 +12:00
suggestion Bug 7871: prevents crash when suggestion linked to erased budget 2012-04-10 13:41:16 +02:00
svc Bug 7248 follow-up (alternative) 2012-05-15 18:05:58 +02:00
t Bug 5337: EAN management : Adds ean for various searches 2012-06-09 18:26:34 +02:00
tags Bug 6933 follow-up, perltyding new script list.pl 2012-02-02 10:17:43 +01:00
test Bug 5449: JSON malformed in Koha - Blocker with jQuery 1.4.x 2011-03-12 08:53:41 +13:00
tmp/modified_authorities changing DO_NOT_REMOVE to README.txt 2007-10-21 19:14:41 -05:00
tools Bug 7977: Fixing a bug which results in quote fields being incorrectly offset when saving uploaded quotes 2012-05-24 14:15:05 +02:00
virtualshelves Bug 7788: [SIGNED-OFF] Followup: GetShelf call in addbybiblio script corrected 2012-05-22 12:06:26 +02:00
xt Bug 8022: Permissions test doesn't check all languages 2012-05-14 15:05:16 +02:00
.htaccess Fix file permissions: if it is not a script, it should not be executable. 2010-04-16 00:40:34 -04:00
.mailmap 7439 Mailmap for master 2012-01-27 12:27:58 +01:00
INSTALL Bug 7759, update of install files to use background indexing (and some whitespace tidy) 2012-04-20 16:11:52 +02:00
INSTALL.debian Bug 8092 follow-up: Add optional dependency on CHI 2012-06-09 13:08:18 +02:00
INSTALL.fedora7 Bug 8092 follow-up: Add optional dependency on CHI 2012-06-09 13:08:18 +02:00
INSTALL.opensuse Bug 7759, update of install files to use background indexing (and some whitespace tidy) 2012-04-20 16:11:52 +02:00
INSTALL.ubuntu Bug 8092 follow-up: Add optional dependency on CHI 2012-06-09 13:08:18 +02:00
INSTALL.ubuntu.lucid Bug 8092 follow-up: Add optional dependency on CHI 2012-06-09 13:08:18 +02:00
LICENSE Update LICENSE with a fresh copy from upstream. This updates the FSF address, and refers to the LGPL with its current name, and changes a few other minor things of the typographical sort. No semantic changes. 2010-03-16 20:17:48 -04:00
MANIFEST.SKIP Bug Fixing : 3334 2009-06-19 06:33:34 -05:00
Makefile.PL Bug 7818: update installer for biblio DOM indexing 2012-06-09 11:43:56 +02:00
README updated links in README 2010-05-24 08:14:16 -04:00
README.robots Bug 6411 add another example to README.robots 2011-07-05 14:48:05 +12:00
about.pl Bug 7164 follow-up history.txt and perlcritic compliance 2011-12-14 15:10:28 +01:00
changelanguage.pl Bug 6755 Problems with switching languages 2011-09-23 09:47:09 +12:00
edithelp.pl Bug 7038 Contextual help is always in English 2011-10-18 16:01:25 +13:00
fix-perl-path.PL installer: improvements to fix-path-perl.PL on Win32 2007-12-20 19:20:12 -06:00
help.pl Bug 6628 : Stopping a potential vulnerability 2011-11-28 10:05:58 +01:00
install-CPAN.pl Bug 5370: Fix all the references to koha.org 2010-11-08 09:41:49 +13:00
koha_perl_deps.pl Bug 6914 - fixes for the color option of koha_perl_deps.pl 2011-12-03 07:47:38 +01:00
kohaversion.pl Bug 7601 follow-up DBRev number 2012-06-10 10:54:39 +02:00
mainpage.pl Bug 6875 cleaning mainpage.pl 2012-02-15 14:58:31 +01:00
rewrite-config.PL Bug 7818: update installer for biblio DOM indexing 2012-06-09 11:43:56 +02:00

README

Koha is a free software integrated library system.

Koha is distributed under the GNU GPL version 2 or later.
Please read the file LICENSE for more details.

To install or upgrade Koha, please see the INSTALL file appropriate
to your platform.

Report bugs at http://bugs.koha-community.org/

Visit the Koha Project website at http://www.koha-community.org/