Bug 29046: Fix and amend system preference description
[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          - '<br><strong>NOTE:</strong> If set to "first valid", the order in which the email addresses are checked is set in <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=EmailFieldPrecedence">EmailFieldPrecedence</a>.'
187      -
188          - "When <a href='/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=EmailFieldPrimary'>EmailFieldPrimary</a> is set to '<strong>first valid</strong>', check the patron email address fields in the following order and use the first valid email address found:"
189          - pref: EmailFieldPrecedence
190            class: multi
191          - '<br><strong>NOTE:</strong> All patron fields can be used, but to work correctly they must contain a valid email address or an empty string.'
192          - "Valid options are the <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a> of the borrowers table, separated by | (pipe)."
193          - "Example: email|emailpro|B_email"
194      -
195          - pref: TalkingTechItivaPhoneNotification
196            choices:
197                1: Enable
198                0: Disable
199          - patron phone notifications using Talking Tech i-tiva (overdues, predues and holds notices currently supported).
200          - <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.
201      -
202          - pref: PhoneNotification
203            choices:
204                1: Enable
205                0: Disable
206          - patron phone notifications generation. A plugin will be required to process the phone notifications.
207          - <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.
208      -
209          - "Use the SMS::Send::"
210          - pref: SMSSendDriver
211          - driver to send SMS messages.
212          - "<br>If you would prefer to send SMS via E-mail, set SMSSendDriver to: Email"
213          - "<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."
214      -
215          - "Define a username/login"
216          - pref: SMSSendUsername
217          - "and a password"
218          - pref: SMSSendPassword
219          - ". Override from address with"
220          - pref: EmailSMSSendDriverFromAddress
221            class: email
222          - "for emails sent using \"Email\" send driver."
223      -
224          - pref: FallbackToSMSIfNoEmail
225            choices:
226                1: Enable
227                0: Disable
228          - sending purchase suggestion messages by SMS if no patron email is defined.
229      -
230          - "Send automatic renewal notices: "
231          - pref: AutoRenewalNotices
232            choices:
233                never: never
234                preferences: according to patron messaging preferences
235                cron: (Deprecated) according to --send-notices cron switch
236     Patron forms:
237      -
238          - "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:"
239          - pref: BorrowerMandatoryField
240            type: modalselect
241            source: borrowers
242            exclusions: flags
243          - '<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>.'
244      -
245          - "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:"
246          - pref: BorrowerUnwantedField
247            type: modalselect
248            source: borrowers
249            exclusions: branchcode|categorycode|flags
250      -
251          - "Borrowers can have the following titles:"
252          - pref: BorrowersTitles
253            class: multi
254          - (separate multiple choices with |)
255      -
256          - pref: autoMemberNum
257            choices:
258                1: Do
259                0: "Don't"
260          - 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).
261          - '<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>.'
262      -
263          - Card numbers for patrons must be
264          - pref: CardnumberLength
265          - "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')."
266          - '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.'
267      -
268          - pref: uppercasesurnames
269            choices:
270                1: Do
271                0: "Don't"
272          - store and display surnames in upper case.
273      -
274          - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a>:"
275          - pref: PatronQuickAddFields
276            type: modalselect
277            source: borrowers
278          - "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."
279      -
280          - "When adding new patrons or editing existing patrons, collapse the following fields from the full form (can still be expanded later):"
281          - pref: CollapseFieldsPatronAddForm
282            multiple:
283                identity: "Patron identity"
284                guarantor: "Guarantor information"
285                primary_address: "Main address"
286                primary_contact: "Contact information"
287                alt_address: "Alternate address"
288                alt_contact: "Alternate contact"
289                lib_mgmt: "Library management"
290                lib_setup: "Library setup"
291                login: "OPAC/Staff interface login"
292                flags: "Patron account flags (existing patrons)"
293                debarments: "Patron restrictions (existing patrons)"
294                housebound: "Housebound roles"
295                additional: "Additional attributes and identifiers"
296                messaging: "Patron messaging preferences"
297      -
298          - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a>:"
299          - pref: PatronDuplicateMatchingAddFields
300            type: modalselect
301            source: borrowers
302          - "will be used to detect possible duplicates when adding a new patron."
303     Patron relationships:
304      -
305          - "Guarantors can be the following of those they guarantee:"
306          - pref: borrowerRelationship
307            class: multi
308          - (input multiple choices separated by |). Leave empty to deactivate.
309      -
310          - "When adding a guarantee to a guarantor patron fill the following fields in the guarantee's member entry form from the guarantors record:"
311          - pref: PrefillGuaranteeField
312            multiple:
313                surname: "Surname"
314                B_streettype: "Alternate address - Street type"
315                B_address: "Alternate address - Address"
316                B_address2: "Alternate address - Address 2"
317                B_city: "Alternate address - City"
318                contactnote: "Alternate address - Contact note"
319                B_country: "Alternate address - Country"
320                B_email: "Alternate address - Email"
321                B_phone: "Alternate address - Phone"
322                B_state: "Alternate address - State"
323                B_streetnumber: "Alternate address - Street number"
324                B_zipcode: "Alternate address - ZIP/Postal code"
325                altcontactaddress1: "Alternate contact - Address"
326                altcontactaddress2: "Alternate contact - Address 2"
327                altcontactaddress3: "Alternate contact - City"
328                altcontactcountry: "Alternate contact - Country"
329                altcontactfirstname: "Alternate contact - First name"
330                altcontactphone: "Alternate contact - Phone"
331                altcontactstate: "Alternate contact - State"
332                altcontactsurname: "Alternate contact - Surname"
333                altcontactzipcode: "Alternate contact - ZIP/Postal code"
334                fax: "Contact - Fax"
335                mobile: "Contact - Other phone"
336                email: "Contact - Primary email"
337                phone: "Contact - Primary phone"
338                emailpro: "Contact - Secondary email"
339                phonepro: "Contact - Secondary phone"
340                streettype: "Main address - Street type"
341                address: "Main address - Address"
342                address2: "Main address - Address 2"
343                city: "Main address - City"
344                country: "Main address - Country"
345                state: "Main address - State"
346                zipcode: "Main address - ZIP/Postal code"
347                streetnumber: "Main address - Street number"
348      -
349          - pref: AllowStaffToSetCheckoutsVisibilityForGuarantor
350            choices:
351                1: Allow
352                0: "Don't allow"
353          - staff to set the ability for a patron's checkouts to be viewed by linked patrons in the OPAC.
354      -
355          - pref: AllowStaffToSetFinesVisibilityForGuarantor
356            choices:
357                1: Allow
358                0: "Don't allow"
359          - staff to set the ability for a patron's charges to be viewed by linked patrons in the OPAC.
360
361     Privacy:
362      -
363          - Use the following URL
364          - pref: PrivacyPolicyURL
365            class: url
366          - 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.)
367          - '<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.'
368      -
369          - "Set data privacy policy consent to:"
370          - pref: PrivacyPolicyConsent
371            choices:
372                '': 'disabled'
373                Enforced: 'enforced'
374                Permissive: 'permissive'
375          - ". 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."
376          - '<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.'
377      -
378          - Lock/expire patrons that submitted an unsubscribe request (refused consent) after
379          - pref: UnsubscribeReflectionDelay
380          - days, anonymize locked/expired accounts after
381          - pref: PatronAnonymizeDelay
382          - days and remove anonymized patron accounts after
383          - pref: PatronRemovalDelay
384          - "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."
385     Security:
386      -
387          - Login passwords for staff and patrons must be at least
388          - pref: minPasswordLength
389            class: integer
390          - characters long.
391      -
392          - pref: RequireStrongPassword
393            choices:
394                1: "Require"
395                0: "Don't require"
396          - a strong password for staff and patrons
397          - (must contain at least one digit, one lowercase and one uppercase).
398      -
399          - pref: EnableExpiredPasswordReset
400            choices:
401                1: "Enable"
402                0: "Don't enable"
403          - the ability for patrons to directly reset their password when it is expired.
404          - If not enabled patrons must either use the 'Forgot your password' feature or have staff
405          - reset their password.
406      -
407          - Block a patron's account if it reaches
408          - pref: FailedLoginAttempts
409            class: integer
410          - failed login attempts.
411      -
412          - pref: Pseudonymization
413            choices:
414                1: Enable
415                0: Disable
416          - "pseudonymization to comply with data privacy policies and regulations like GDPR for managing personal information."
417          - "Patrons and transactions will be copied to a separate table for statistical purposes."
418          - "<br/>Use the following fields for patrons:"
419          - pref: PseudonymizationPatronFields
420            multiple:
421              title: "Patron's title"
422              city: "City"
423              state: "State"
424              zipcode: "ZIP/Postal code"
425              country: "Country"
426              branchcode: "Patron's library"
427              categorycode: "Patron category"
428              dateenrolled: "Date the patron was added to Koha"
429              sex: "Patron's gender"
430              sort1: "Sort 1"
431              sort2: "Sort 2"
432          - "<br/> And the following fields for the transactions:"
433          - pref: PseudonymizationTransactionFields
434            multiple:
435              datetime: "Date and time of the transaction"
436              transaction_branchcode: "Library where the transaction occurred"
437              transaction_type: "Transaction type"
438              itemnumber: "Itemnumber"
439              itemtype: "Item type"
440              holdingbranch: "Holding library"
441              homebranch: "Home library"
442              location: "Location"
443              itemcallnumber: "Item's callnumber"
444              ccode: "Collection"