Koha/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref
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

129 lines
4.6 KiB
Text

Patrons:
-
- List
- pref: AddPatronLists
choices:
categorycode: specific categories
category_type: general patron types
- under the new patron menu.
-
- pref: AutoEmailOpacUser
choices:
yes: Send
no: "Don't send"
- an email to newly created patrons with their account details.
-
- "Use"
- pref: AutoEmailPrimaryAddress
default: "OFF"
choices:
email: home
emailpro: work
B_email: alternate
cardnumber: cardnumber as
"OFF": first valid
- "patron email address for sending out emails."
-
- pref: autoMemberNum
choices:
yes: Do
no: "Don't"
- default the card number field on the patron addition screen to the next available card number (for example, if the largest currently used card number is 26345000012941, then this field will default to 26345000012942).
-
- "The following <a href='http://schema.koha-community.org/tables/borrowers.html' target='blank'>database columns</a> must be filled in on the patron entry screen:"
- pref: BorrowerMandatoryField
class: multi
- (separate columns with |)
-
- "The following <a href='http://schema.koha-community.org/tables/borrowers.html' target='blank'>database columns</a> will not appear on the patron entry screen:"
- pref: BorrowerUnwantedField
class: multi
- (separate columns with |)
-
- "Guarantors can be the following of those they guarantee:"
- pref: borrowerRelationship
class: multi
- (input multiple choices separated by |). Leave empty to deactivate
-
- "Borrowers can have the following titles:"
- pref: BorrowersTitles
class: multi
- (separate multiple choices with |)
-
- pref: checkdigit
choices:
none: "Don't"
katipo: Do
- check and construct borrower card numbers in the Katipo style. This overrides <code>autoMemberNum</code> if on.
-
- pref: EnhancedMessagingPreferences
choices:
yes: Allow
no: "Don't allow"
- patrons to choose which notices they receive and when they receive them. Note that this only applies to certain kinds of notices.
-
- pref: ExtendedPatronAttributes
choices:
yes: Enable
no: "Don't enable"
- searching, editing and display of custom attributes on patrons.
-
- pref: intranetreadinghistory
choices:
yes: "Allow"
no: "Don't allow"
- "staff to access a patron's checkout history (it is stored regardless)."
-
- The late fine for a specific checkout will only go up to
- pref: MaxFine
class: currency
- '[% local_currency %].'
-
- pref: memberofinstitution
choices:
yes: Do
no: "Don't"
- allow patrons to be linked to institutions (which must be set up as Institution patrons).
-
- Login passwords for staff and patrons must be at least
- pref: minPasswordLength
class: integer
- characters long.
-
- Show a notice that a patron is about to expire
- pref: NotifyBorrowerDeparture
class: integer
- days beforehand.
-
- pref: patronimages
choices:
yes: Allow
no: "Don't allow"
- images to be uploaded and shown for patrons on the staff client.
-
- By default, show
- pref: PatronsPerPage
class: integer
- results per page in the staff client.
-
- "Use the SMS::Send::"
- pref: SMSSendDriver
- driver to send SMS messages.
-
- pref: uppercasesurnames
choices:
yes: Do
no: "Don't"
- store and display surnames in upper case.
-
- When renewing borrowers, base the new expiry date on
- pref: BorrowerRenewalPeriodBase
choices:
now: current date.
dateexpiry: current membership expiry date.
-
- pref: TalkingTechItivaPhoneNotification
choices:
yes: Enable
no: Disable
- patron phone notifications using Talking Tech i-tiva (overdues, predues and holds notices currently supported).