]> git.evergreen-ils.org Git - working/Evergreen.git/blob - docs/RELEASE_NOTES_NEXT/OPAC/patron_self_reg.txt
Remove manual TPAC locale applications
[working/Evergreen.git] / docs / RELEASE_NOTES_NEXT / OPAC / patron_self_reg.txt
1 New Feature: Web-Based Patron Self-Registration
2 ===============================================
3
4 Feature Summary
5 ---------------
6
7 Patrons may now fill out a web-based form from within the TPAC to create 
8 pending user accounts.  The goal is to make the registration process more 
9 efficient by allowing the patron to provide much of the registration 
10 details in advance of registering with staff.  
11
12 Pending user accounts have no privileges.  
13
14 The form supports hiding fields, requiring fields, applying format
15 validation, and displaying example text for selected fields by inspecting the 
16 relevant patron registration org unit settings.
17
18 The "Request Library Card" link appears as the second default "bottom link"
19 in the TPAC.  
20
21 If a user is logged in when clicking the register link, the logged in
22 user will be tracked as the requesting user for the pending account.
23 Additionally, the home org unit and some address fields will be pre-populated
24 for convenience (with the assumption that these will likely be the same for
25 the pending user -- they can of course be changed).  When a requesting user
26 is present on the pending user, a link to the requesting user will be 
27 displayed within the patron registration form in the staff client.
28
29 Pending patron accounts which sit unattended in the database for too long
30 are purged via a regularly running (CRON) script.
31
32 Technical Details
33 -----------------
34
35   * To activate the web form and allow pending patrons to be created, set
36     the 'opac.allow_pending_user' org unit setting to true where appropriate.
37   * To purge old pending user accounts, set an interval value for the new
38     'opac.pending_user_expire_interval' org unit setting.
39   * The org unit settings to indicate show/require/regex/example are 
40     loaded dynamically, so any similar org unit settings added in the future
41     will also be honored.  Any setting matching the following format is used:
42     ** ui.patron.edit.[au|aua].*.show
43     ** ui.patron.edit.[au|aua].*.require
44     ** ui.patron.edit.[au|aua].*.regex
45     ** ui.patron.edit.[au|aua].*.example
46
47 Upgrade Notes
48 -------------
49
50   * If a value is set for the 'opac.pending_user_expire_interval' for
51     any org units, the new /openils/bin/purge_pending_users.srfsh script 
52     should also be added the opensrf user's crontab.  Running the script once 
53     per day should suffice.