Bug 29046: Add 'EmailFieldPrecedence' preference
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / modules / admin / preferences / patrons.pref
1 Patrons:
2     General:
3      -
4          - pref: CheckPrevCheckout
5            default: no
6            choices:
7                hardyes: "Do"
8                softyes: "Unless overridden by patron category, do"
9                softno: "Unless overridden by patron category, do not"
10                hardno: "Do not"
11          - " check borrower checkout history to see if the current item has been checked out before."
12      -
13          - "Trigger a warning if the current item has been checked out no longer than"
14          - pref: CheckPrevCheckoutDelay
15            default: 0
16          - "days ago."
17          - "Requires <a href='/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=CheckPrevCheckout'>CheckPrevCheckout</a> to be enabled. There is no time limit if 0 or empty."
18      -
19          - pref: ExtendedPatronAttributes
20            choices:
21                1: Enable
22                0: "Don't enable"
23          - searching, editing and display of custom attributes on patrons.
24      -
25          - pref: intranetreadinghistory
26            choices:
27                1: "Allow"
28                0: "Don't allow"
29          - "staff to access a patron's checkout and hold history (checkout history is still stored, regardless of staff being allowed access or not)."
30      -
31          - "When deleting a patron who owns public or shared lists,"
32          - pref: ListOwnershipUponPatronDeletion
33            choices:
34             delete: "delete these lists."
35             transfer: "change owner of these lists."
36          - All public or shared lists of this patron are either deleted or transferred to a new owner according to your choice; other private lists (not shared) are deleted.
37          - "<br/>When changing owner at patron deletion, use borrowernumber "
38          - pref: ListOwnerDesignated
39            class: integer
40          - as new list owner, or leave this field empty in order to change owner to the active staff member who deletes the patron.
41      -
42          - The late fine for all checkouts will only go up to
43          - pref: MaxFine
44            class: currency
45          - '[% local_currency %].'
46          - Empty value means no limit. Single item caps are specified in the circulation rules matrix.
47      -
48          - pref: patronimages
49            choices:
50                1: Allow
51                0: "Don't allow"
52          - images to be uploaded and shown for patrons on the staff interface.
53      -
54          - By default, show
55          - pref: PatronsPerPage
56            class: integer
57          - results per page in the staff interface.
58      -
59          - "Comma separated list defining the default fields to be used during a patron search using the \"standard\" option in the patrons or circulation module:"
60          - pref: DefaultPatronSearchFields
61            class: multi
62          - "If empty Koha will default to \"firstname,middle_name,surname,othernames,cardnumber,userid\". Additional fields added to this preference will be added as search options in the dropdown menu on the patron search page."
63      -
64          - "Show the following fields from the items database table as columns on the statistics tab on the patron record: "
65          - pref: StatisticsFields
66            type: modalselect
67            source: items
68          - "If empty, defaults to: location|itype|ccode"
69      -
70          - pref: EnableBorrowerFiles
71            choices:
72                1: Do
73                0: "Don't"
74          - enable the ability to upload and attach arbitrary files to a borrower record.
75      -
76          - pref: useDischarge
77            choices:
78                1: Allow
79                0: "Don't allow"
80          - librarians to discharge borrowers and borrowers to request a discharge.
81      -
82          - pref: FeeOnChangePatronCategory
83            choices:
84                1: Do
85                0: "Don't"
86          - charge a fee when a patron changes to a category with an enrollment fee.
87      -
88          - pref: TrackLastPatronActivity
89            choices:
90                1: Do
91                0: "Don't"
92          - track last patron activity.
93          - The first time each day that a patron logs into the OPAC, connects to Koha via SIP or ILS-DI, or checks an item out the borrowers.lastseen will update with the current date and time.
94      -
95          - pref: AutoApprovePatronProfileSettings
96            choices:
97                1: Enable
98                0: Disable
99          - "automatic approval of patron detail changes from the OPAC."
100          - Requires <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OPACPatronDetails">OPACPatronDetails</a> to be activated.
101      -
102          - pref: ProtectSuperlibrarianPrivileges
103            choices:
104                1: Allow only superlibrarians
105                0: Allow all permitted users
106          - "to access/change superlibrarian privileges."
107          - "<br><strong>NOTE:</strong> A permitted user needs to have the 'permissions' flag (if no superlibrarian)."
108      -
109          - pref: AllowPatronToControlAutorenewal
110            choices:
111                1: Allow patrons
112                0: Allow only staff
113          - "to allow/disallow auto-renewal for account. If allowed a patron will be able to update their own account to allow/disallow auto-renewal."
114      -
115          - Lock expired patrons after
116          - pref: LockExpiredDelay
117            class: integer
118          - days. Leave empty to disable this behavior.
119          - "<br><strong>NOTE:</strong> This system preference requires the misc/cronjobs/cleanup_database.pl cronjob. Ask your system administrator to schedule it."
120
121     Membership expiry:
122      -
123          - When renewing borrowers, base the new expiry date on
124          - pref: BorrowerRenewalPeriodBase
125            choices:
126                now: current date.
127                dateexpiry: current membership expiry date.
128                combination: the latter of the current and expiry date.
129      -
130          - Show a notice if the patron is about to expire or has expired
131          - pref: NotifyBorrowerDeparture
132            class: integer
133          - days beforehand.
134      -
135          - Send an account expiration notice when a patron's card will expire in
136          - pref: MembershipExpiryDaysNotice
137            class: integer
138          - days.
139          - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/membership_expiry.pl</code> cronjob. Ask your system administrator to schedule it."
140     Notices and notifications:
141      -
142          - pref: EnhancedMessagingPreferences
143            choices:
144                1: Allow
145                0: "Don't allow"
146          - "staff to manage which notices patrons will receive and when they will receive them."
147          - '<br><strong>NOTE:</strong> This only applies to courtesy notices. To manage if patrons have also access to these settings, use <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=EnhancedMessagingPreferencesOPAC">EnhancedMessagingPreferencesOPAC</a>.'
148          - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/process_message_queue.pl</code> and the <code>misc/cronjobs/advance_notices.pl</code> cronjob. Ask your system administrator to schedule them."
149      -
150          - pref: EnhancedMessagingPreferencesOPAC
151            choices:
152                1: Show
153                0: "Don't show"
154          - "patron messaging setting on the OPAC."
155          - '<br><strong>NOTE:</strong> <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=EnhancedMessagingPreferences">EnhancedMessagingPreferences</a> must be enabled.'
156      -
157          - pref: AutoEmailNewUser
158            choices:
159                1: Send
160                0: "Don't send"
161          - an email to newly created patrons.
162          - '<br><strong>NOTE:</strong> This uses the WELCOME notice.'
163      -
164          - pref: NotifyPasswordChange
165            choices:
166                1: Notify
167                0: "Don't notify"
168          - patrons whenever their password is changed.
169      -
170          - pref: UseEmailReceipts
171            choices:
172                1: Send
173                0: "Don't send"
174          - email receipts to patrons for payments and writeoffs.
175      -
176          - "Use the patron's"
177          - pref: EmailFieldPrimary
178            default: "OFF"
179            choices:
180                email: primary email
181                emailpro: secondary email
182                B_email: alternate email
183                cardnumber: cardnumber
184                "OFF": first valid email address
185          - 'for sending out email notices.'
186      -
187          - Use the following patron email fields in order of highest precedence first
188          - pref: EmailFieldPrecedence
189            class: multi
190          - when selecting which email address to use to send patron notices.
191          - '<br><strong>NOTE:</strong> This preference only takes effect if <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=AutoEmailPrimaryAddress">AutoEmailPrimaryAddress</a> is set to <strong>first valid<strong>'
192      -
193          - pref: TalkingTechItivaPhoneNotification
194            choices:
195                1: Enable
196                0: Disable
197          - patron phone notifications using Talking Tech i-tiva (overdues, predues and holds notices currently supported).
198          - <br/><i class="fa fa-exclamation-triangle"></i> If <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</a> is enabled, <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=PhoneNotification">PhoneNotification</a> should be disabled.
199      -
200          - pref: PhoneNotification
201            choices:
202                1: Enable
203                0: Disable
204          - patron phone notifications generation. A plugin will be required to process the phone notifications.
205          - <br/><i class="fa fa-exclamation-triangle"></i> If <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=PhoneNotification">PhoneNotification</a> is enabled, <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=TalkingTechItivaPhoneNotification">TalkingTechItivaPhoneNotification</a> should be disabled.
206      -
207          - "Use the SMS::Send::"
208          - pref: SMSSendDriver
209          - driver to send SMS messages.
210          - "<br>If you would prefer to send SMS via E-mail, set SMSSendDriver to: Email"
211          - "<br><strong>NOTE:</strong> Many mobile providers have deprecated support for this feature and it is not recommended for use unless you have a dedicated SMS to Email gateway."
212      -
213          - "Define a username/login"
214          - pref: SMSSendUsername
215          - "and a password"
216          - pref: SMSSendPassword
217          - ". Override from address with"
218          - pref: EmailSMSSendDriverFromAddress
219            class: email
220          - "for emails sent using \"Email\" send driver."
221      -
222          - pref: FallbackToSMSIfNoEmail
223            choices:
224                1: Enable
225                0: Disable
226          - sending purchase suggestion messages by SMS if no patron email is defined.
227      -
228          - "Send automatic renewal notices: "
229          - pref: AutoRenewalNotices
230            choices:
231                never: never
232                preferences: according to patron messaging preferences
233                cron: (Deprecated) according to --send-notices cron switch
234     Patron forms:
235      -
236          - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a> must be filled in on the patron entry screen:"
237          - pref: BorrowerMandatoryField
238            type: modalselect
239            source: borrowers
240            exclusions: flags
241          - '<strong>NOTE:</strong> If <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=autoMemberNum">autoMemberNum</a> is enabled, the system preference <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=BorrowerMandatoryField">BorrowerMandatoryField</a> must not contain the field <code>cardnumber</code>.'
242      -
243          - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a> will not appear on the patron entry screen:"
244          - pref: BorrowerUnwantedField
245            type: modalselect
246            source: borrowers
247            exclusions: branchcode|categorycode|flags
248      -
249          - "Borrowers can have the following titles:"
250          - pref: BorrowersTitles
251            class: multi
252          - (separate multiple choices with |)
253      -
254          - pref: autoMemberNum
255            choices:
256                1: Do
257                0: "Don't"
258          - 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).
259          - '<strong>NOTE:</strong> If <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=autoMemberNum">autoMemberNum</a> is enabled, the system preference <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=BorrowerMandatoryField">BorrowerMandatoryField</a> must not contain the field <code>cardnumber</code>.'
260      -
261          - Card numbers for patrons must be
262          - pref: CardnumberLength
263          - "characters long. The length can be a single number to specify an exact length, a range separated by a comma (i.e., 'Min,Max'), or a maximum with no minimum (i.e., ',Max')."
264          - 'If <code>cardnumber</code> is included in the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=BorrowerMandatoryField">BorrowerMandatoryField</a> list, the minimum length, if not specified here, defaults to one. Maximum cannot be bigger than the database field size of 32.'
265      -
266          - pref: uppercasesurnames
267            choices:
268                1: Do
269                0: "Don't"
270          - store and display surnames in upper case.
271      -
272          - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a>:"
273          - pref: PatronQuickAddFields
274            type: modalselect
275            source: borrowers
276          - "will be added to the patron quick add form when entering a new patron. Displays only mandatory fields and fields specified here. If applicable the guarantor form will be shown as well, individual fields in that form will be ignored."
277      -
278          - "When adding new patrons or editing existing patrons, collapse the following fields from the full form (can still be expanded later):"
279          - pref: CollapseFieldsPatronAddForm
280            multiple:
281                identity: "Patron identity"
282                guarantor: "Guarantor information"
283                primary_address: "Main address"
284                primary_contact: "Contact information"
285                alt_address: "Alternate address"
286                alt_contact: "Alternate contact"
287                lib_mgmt: "Library management"
288                lib_setup: "Library setup"
289                login: "OPAC/Staff interface login"
290                flags: "Patron account flags (existing patrons)"
291                debarments: "Patron restrictions (existing patrons)"
292                housebound: "Housebound roles"
293                additional: "Additional attributes and identifiers"
294                messaging: "Patron messaging preferences"
295      -
296          - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a>:"
297          - pref: PatronDuplicateMatchingAddFields
298            type: modalselect
299            source: borrowers
300          - "will be used to detect possible duplicates when adding a new patron."
301     Patron relationships:
302      -
303          - "Guarantors can be the following of those they guarantee:"
304          - pref: borrowerRelationship
305            class: multi
306          - (input multiple choices separated by |). Leave empty to deactivate.
307      -
308          - "When adding a guarantee to a guarantor patron fill the following fields in the guarantee's member entry form from the guarantors record:"
309          - pref: PrefillGuaranteeField
310            multiple:
311                surname: "Surname"
312                B_streettype: "Alternate address - Street type"
313                B_address: "Alternate address - Address"
314                B_address2: "Alternate address - Address 2"
315                B_city: "Alternate address - City"
316                contactnote: "Alternate address - Contact note"
317                B_country: "Alternate address - Country"
318                B_email: "Alternate address - Email"
319                B_phone: "Alternate address - Phone"
320                B_state: "Alternate address - State"
321                B_streetnumber: "Alternate address - Street number"
322                B_zipcode: "Alternate address - ZIP/Postal code"
323                altcontactaddress1: "Alternate contact - Address"
324                altcontactaddress2: "Alternate contact - Address 2"
325                altcontactaddress3: "Alternate contact - City"
326                altcontactcountry: "Alternate contact - Country"
327                altcontactfirstname: "Alternate contact - First name"
328                altcontactphone: "Alternate contact - Phone"
329                altcontactstate: "Alternate contact - State"
330                altcontactsurname: "Alternate contact - Surname"
331                altcontactzipcode: "Alternate contact - ZIP/Postal code"
332                fax: "Contact - Fax"
333                mobile: "Contact - Other phone"
334                email: "Contact - Primary email"
335                phone: "Contact - Primary phone"
336                emailpro: "Contact - Secondary email"
337                phonepro: "Contact - Secondary phone"
338                streettype: "Main address - Street type"
339                address: "Main address - Address"
340                address2: "Main address - Address 2"
341                city: "Main address - City"
342                country: "Main address - Country"
343                state: "Main address - State"
344                zipcode: "Main address - ZIP/Postal code"
345                streetnumber: "Main address - Street number"
346      -
347          - pref: AllowStaffToSetCheckoutsVisibilityForGuarantor
348            choices:
349                1: Allow
350                0: "Don't allow"
351          - staff to set the ability for a patron's checkouts to be viewed by linked patrons in the OPAC.
352      -
353          - pref: AllowStaffToSetFinesVisibilityForGuarantor
354            choices:
355                1: Allow
356                0: "Don't allow"
357          - staff to set the ability for a patron's charges to be viewed by linked patrons in the OPAC.
358
359     Privacy:
360      -
361          - Use the following URL
362          - pref: PrivacyPolicyURL
363            class: url
364          - to refer to your local privacy policy in messages about privacy and data protection. (If you enforce a data privacy policy, make sure that this page is not blocked.)
365          - '<br><strong>NOTE:</strong> The URL will only be displayed if <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=PrivacyPolicyConsent">PrivacyPolicyConsent</a> is set.'
366      -
367          - "Set data privacy policy consent to:"
368          - pref: PrivacyPolicyConsent
369            choices:
370                '': 'disabled'
371                Enforced: 'enforced'
372                Permissive: 'permissive'
373          - ". When you enforce a data privacy policy, patrons need to give consent before using the OPAC. If you set to permissive, Koha will warn but not enforce."
374          - '<br><strong>NOTE:</strong> If you enable this you will also have to set the URL of your public privacy policy with the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=PrivacyPolicyURL">PrivacyPolicyURL</a> setting.'
375      -
376          - Lock/expire patrons that submitted an unsubscribe request (refused consent) after
377          - pref: UnsubscribeReflectionDelay
378          - days, anonymize locked/expired accounts after
379          - pref: PatronAnonymizeDelay
380          - days and remove anonymized patron accounts after
381          - pref: PatronRemovalDelay
382          - "days.<br>IMPORTANT: No action is performed when these delays are empty (no text). But a zero value ('0') is interpreted as no delay (do it now)! The actions are performed by the cleanup database cron job."
383     Security:
384      -
385          - Login passwords for staff and patrons must be at least
386          - pref: minPasswordLength
387            class: integer
388          - characters long.
389      -
390          - pref: RequireStrongPassword
391            choices:
392                1: "Require"
393                0: "Don't require"
394          - a strong password for staff and patrons
395          - (must contain at least one digit, one lowercase and one uppercase).
396      -
397          - pref: EnableExpiredPasswordReset
398            choices:
399                1: "Enable"
400                0: "Don't enable"
401          - the ability for patrons to directly reset their password when it is expired.
402          - If not enabled patrons must either use the 'Forgot your password' feature or have staff
403          - reset their password.
404      -
405          - Block a patron's account if it reaches
406          - pref: FailedLoginAttempts
407            class: integer
408          - failed login attempts.
409      -
410          - pref: Pseudonymization
411            choices:
412                1: Enable
413                0: Disable
414          - "pseudonymization to comply with data privacy policies and regulations like GDPR for managing personal information."
415          - "Patrons and transactions will be copied to a separate table for statistical purposes."
416          - "<br/>Use the following fields for patrons:"
417          - pref: PseudonymizationPatronFields
418            multiple:
419              title: "Patron's title"
420              city: "City"
421              state: "State"
422              zipcode: "ZIP/Postal code"
423              country: "Country"
424              branchcode: "Patron's library"
425              categorycode: "Patron category"
426              dateenrolled: "Date the patron was added to Koha"
427              sex: "Patron's gender"
428              sort1: "Sort 1"
429              sort2: "Sort 2"
430          - "<br/> And the following fields for the transactions:"
431          - pref: PseudonymizationTransactionFields
432            multiple:
433              datetime: "Date and time of the transaction"
434              transaction_branchcode: "Library where the transaction occurred"
435              transaction_type: "Transaction type"
436              itemnumber: "Itemnumber"
437              itemtype: "Item type"
438              holdingbranch: "Holding library"
439              homebranch: "Home library"
440              location: "Location"
441              itemcallnumber: "Item's callnumber"
442              ccode: "Collection"