Bug 35027: Add 'hold' to patron activity triggers
[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 (checkout history is still stored, regardless of staff being allowed access or not)."
30      -
31          - pref: IntranetReadingHistoryHolds
32            choices:
33                1: "Allow"
34                0: "Don't allow"
35          - "staff to access a patron's hold history (hold history is still stored, regardless of staff being allowed access or not)."
36      -
37          - "When deleting a patron who owns public or shared lists,"
38          - pref: ListOwnershipUponPatronDeletion
39            choices:
40             delete: "delete these lists."
41             transfer: "change owner of these lists."
42          - 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.
43          - "<br/>When changing owner at patron deletion, use borrowernumber "
44          - pref: ListOwnerDesignated
45            class: integer
46          - as new list owner, or leave this field empty in order to change owner to the active staff member who deletes the patron.
47      -
48          - The late fine for all checkouts will only go up to
49          - pref: MaxFine
50            class: currency
51          - '[% local_currency %].'
52          - Empty value means no limit. Single item caps are specified in the circulation rules matrix.
53      -
54          - pref: patronimages
55            choices:
56                1: Allow
57                0: "Don't allow"
58          - images to be uploaded and shown for patrons on the staff interface.
59      -
60          - By default, show
61          - pref: PatronsPerPage
62            class: integer
63          - results per page in the staff interface.
64      -
65          - "Pipe separated list defining the default fields to be used during a patron search using the \"standard\" option in the patrons or circulation module:"
66          - pref: DefaultPatronSearchFields
67            type: modalselect
68            source: borrowers
69            exclusions: anonymized|auth_method|autorenew_checkouts|date_renewed|dateenrolled|dateexpiry|lang|lastseen|login_attempts|overdrive_auth_token|password|password_expiration_date|primary_contact_method|gonenoaddress|lost|debarred|debarredcomment|branchcode|categorycode|flags|guarantorid|relationship|privacy|privacy_guarantor_checkouts|privacy_guarantor_fines|pronouns|secret|sms_provider_id|updated_on|checkprevcheckout
70          - "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."
71      -
72          - pref: DefaultPatronSearchMethod
73            choices:
74                starts_with: "Starts with"
75                contains: "Contains"
76          - Enable this search method to determine whether to use Starts with or Contains for autocomplete patron searches.
77      -
78          - "Show the following fields from the items database table as columns on the statistics tab on the patron record: "
79          - pref: StatisticsFields
80            type: modalselect
81            source: items
82          - "If empty, defaults to: location|itype|ccode"
83      -
84          - pref: EnableBorrowerFiles
85            choices:
86                1: Do
87                0: "Don't"
88          - enable the ability to upload and attach arbitrary files to a borrower record.
89      -
90          - pref: useDischarge
91            choices:
92                1: Allow
93                0: "Don't allow"
94          - librarians to discharge borrowers and borrowers to request a discharge.
95      -
96          - pref: FeeOnChangePatronCategory
97            choices:
98                1: Do
99                0: "Don't"
100          - charge a fee when a patron changes to a category with an enrollment fee.
101      -
102          - Select which patron activities should be tracked to signify patron activity. The first time each day that one of these activities occurs, borrowers.lastseen will update with the current date and time.
103          - pref: TrackLastPatronActivityTriggers
104            multiple:
105                login: "Login"
106                connection: "Connection to Koha via SIP or ILSDI"
107                check_out: "Checking out an item"
108                renewal: "Renewing an item"
109                check_in: "Returning an item"
110                hold: "Placing a hold on an item"
111      -
112          - pref: AutoApprovePatronProfileSettings
113            choices:
114                1: Enable
115                0: Disable
116          - "automatic approval of patron detail changes from the OPAC."
117          - Requires <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OPACPatronDetails">OPACPatronDetails</a> to be activated.
118      -
119          - pref: ProtectSuperlibrarianPrivileges
120            choices:
121                1: Allow only superlibrarians
122                0: Allow all permitted users
123          - "to access/change superlibrarian privileges."
124          - "<br><strong>NOTE:</strong> A permitted user needs to have the 'permissions' flag (if no superlibrarian)."
125      -
126          - pref: AllowPatronToControlAutorenewal
127            choices:
128                1: Allow patrons
129                0: Allow only staff
130          - "to allow/disallow auto-renewal for account. If allowed a patron will be able to update their own account to allow/disallow auto-renewal."
131      -
132          - Lock expired patrons after
133          - pref: LockExpiredDelay
134            class: integer
135          - days. Leave empty to disable this behavior.
136          - "<br><strong>NOTE:</strong> This system preference requires the misc/cronjobs/cleanup_database.pl cronjob. Ask your system administrator to schedule it."
137
138     Membership expiry:
139      -
140          - When renewing borrowers, base the new expiry date on
141          - pref: BorrowerRenewalPeriodBase
142            choices:
143                now: current date.
144                dateexpiry: current membership expiry date.
145                combination: the latter of the current and expiry date.
146      -
147          - Show a notice if the patron is about to expire or has expired
148          - pref: NotifyBorrowerDeparture
149            class: integer
150          - days beforehand.
151      -
152          - Send an account expiration notice when a patron's card will expire in
153          - pref: MembershipExpiryDaysNotice
154            class: integer
155          - days.
156          - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/membership_expiry.pl</code> cronjob. Ask your system administrator to schedule it."
157     Notices and notifications:
158      -
159          - pref: EnhancedMessagingPreferences
160            choices:
161                1: Allow
162                0: "Don't allow"
163          - "staff to manage which notices patrons will receive and when they will receive them."
164          - '<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>.'
165          - "<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."
166      -
167          - pref: EnhancedMessagingPreferencesOPAC
168            choices:
169                1: Show
170                0: "Don't show"
171          - "patron messaging setting on the OPAC."
172          - '<br><strong>NOTE:</strong> <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=EnhancedMessagingPreferences">EnhancedMessagingPreferences</a> must be enabled.'
173      -
174          - pref: AutoEmailNewUser
175            choices:
176                1: Send
177                0: "Don't send"
178          - an email to newly created patrons.
179          - '<br><strong>NOTE:</strong> This uses the WELCOME notice.'
180      -
181          - pref: NotifyPasswordChange
182            choices:
183                1: Notify
184                0: "Don't notify"
185          - patrons whenever their password is changed.
186      -
187          - pref: UseEmailReceipts
188            choices:
189                1: Send
190                0: "Don't send"
191          - email receipts to patrons for payments and writeoffs.
192      -
193          - "Use the patron's"
194          - pref: EmailFieldPrimary
195            default: "OFF"
196            choices:
197                email: primary email
198                emailpro: secondary email
199                B_email: alternate email
200                cardnumber: cardnumber
201                "OFF": first valid email address
202          - 'for sending out email notices.'
203          - '<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>.'
204      -
205          - "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:"
206          - pref: EmailFieldPrecedence
207            class: multi
208          - '<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.'
209          - "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)."
210          - "Example: email|emailpro|B_email"
211      -
212          - pref: TalkingTechItivaPhoneNotification
213            choices:
214                1: Enable
215                0: Disable
216          - patron phone notifications using Talking Tech i-tiva (overdues, predues and holds notices currently supported).
217          - <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.
218      -
219          - pref: PhoneNotification
220            choices:
221                1: Enable
222                0: Disable
223          - patron phone notifications generation. A plugin will be required to process the phone notifications.
224          - <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.
225      -
226          - "Use the SMS::Send::"
227          - pref: SMSSendDriver
228          - driver to send SMS messages.
229          - "<br>If you would prefer to send SMS via E-mail, set SMSSendDriver to: Email"
230          - "<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."
231      -
232          - "Define a username/login"
233          - pref: SMSSendUsername
234          - "and a password"
235          - pref: SMSSendPassword
236          - ". Override from address with"
237          - pref: EmailSMSSendDriverFromAddress
238            class: email
239          - "for emails sent using \"Email\" send driver."
240      -
241          - pref: FallbackToSMSIfNoEmail
242            choices:
243                1: Enable
244                0: Disable
245          - sending purchase suggestion messages by SMS if no patron email is defined.
246      -
247          - "Send automatic renewal notices: "
248          - pref: AutoRenewalNotices
249            choices:
250                never: never
251                preferences: according to patron messaging preferences
252                cron: (Deprecated) according to --send-notices cron switch
253     Patron forms:
254      -
255          - "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:"
256          - pref: BorrowerMandatoryField
257            type: modalselect
258            source: borrowers
259            exclusions: flags
260          - '<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>.'
261      -
262          - "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:"
263          - pref: BorrowerUnwantedField
264            type: modalselect
265            source: borrowers
266            exclusions: branchcode|categorycode|flags
267      -
268          - "Borrowers can have the following titles:"
269          - pref: BorrowersTitles
270            class: multi
271          - (separate multiple choices with |)
272      -
273          - pref: autoMemberNum
274            choices:
275                1: Do
276                0: "Don't"
277          - 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).
278          - '<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>.'
279      -
280          - Card numbers for patrons must be
281          - pref: CardnumberLength
282          - "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')."
283          - '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.'
284      -
285          - pref: uppercasesurnames
286            choices:
287                1: Do
288                0: "Don't"
289          - store and display surnames in upper case.
290      -
291          - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a>:"
292          - pref: PatronQuickAddFields
293            type: modalselect
294            source: borrowers
295          - "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."
296      -
297          - "When adding new patrons or editing existing patrons, collapse the following fields from the full form (can still be expanded later):"
298          - pref: CollapseFieldsPatronAddForm
299            multiple:
300                identity: "Patron identity"
301                guarantor: "Guarantor information"
302                primary_address: "Main address"
303                primary_contact: "Contact information"
304                alt_address: "Alternate address"
305                alt_contact: "Alternate contact"
306                lib_mgmt: "Library management"
307                lib_setup: "Library setup"
308                login: "OPAC/Staff interface login"
309                flags: "Patron account flags (existing patrons)"
310                debarments: "Patron restrictions (existing patrons)"
311                housebound: "Housebound roles"
312                additional: "Additional attributes and identifiers"
313                messaging: "Patron messaging preferences"
314      -
315          - "The following <a href='http://schema.koha-community.org/__VERSION__/tables/borrowers.html' target='blank'>database columns</a>:"
316          - pref: PatronDuplicateMatchingAddFields
317            type: modalselect
318            source: borrowers
319          - "will be used to detect possible duplicates when adding a new patron."
320     Patron relationships:
321      -
322          - "Guarantors can be the following of those they guarantee:"
323          - pref: borrowerRelationship
324            class: multi
325          - (input multiple choices separated by |). Leave empty to deactivate.
326      -
327          - "When adding a guarantee to a guarantor patron fill the following fields in the guarantee's member entry form from the guarantors record:"
328          - pref: PrefillGuaranteeField
329            multiple:
330                surname: "Surname"
331                B_streettype: "Alternate address - Street type"
332                B_address: "Alternate address - Address"
333                B_address2: "Alternate address - Address 2"
334                B_city: "Alternate address - City"
335                contactnote: "Alternate address - Contact note"
336                B_country: "Alternate address - Country"
337                B_email: "Alternate address - Email"
338                B_phone: "Alternate address - Phone"
339                B_state: "Alternate address - State"
340                B_streetnumber: "Alternate address - Street number"
341                B_zipcode: "Alternate address - ZIP/Postal code"
342                altcontactaddress1: "Alternate contact - Address"
343                altcontactaddress2: "Alternate contact - Address 2"
344                altcontactaddress3: "Alternate contact - City"
345                altcontactcountry: "Alternate contact - Country"
346                altcontactfirstname: "Alternate contact - First name"
347                altcontactphone: "Alternate contact - Phone"
348                altcontactstate: "Alternate contact - State"
349                altcontactsurname: "Alternate contact - Surname"
350                altcontactzipcode: "Alternate contact - ZIP/Postal code"
351                fax: "Contact - Fax"
352                mobile: "Contact - Other phone"
353                email: "Contact - Primary email"
354                phone: "Contact - Primary phone"
355                emailpro: "Contact - Secondary email"
356                phonepro: "Contact - Secondary phone"
357                streettype: "Main address - Street type"
358                address: "Main address - Address"
359                address2: "Main address - Address 2"
360                city: "Main address - City"
361                country: "Main address - Country"
362                state: "Main address - State"
363                zipcode: "Main address - ZIP/Postal code"
364                streetnumber: "Main address - Street number"
365      -
366          - pref: AllowStaffToSetCheckoutsVisibilityForGuarantor
367            choices:
368                1: Allow
369                0: "Don't allow"
370          - staff to set the ability for a patron's checkouts to be viewed by linked patrons in the OPAC.
371      -
372          - pref: RedirectGuaranteeEmail
373            choices:
374                yes: Enable
375                no: Disable
376          - sending emails to both guarantees and their guarantor. This does not affect patrons without guarantors.
377      -
378          - pref: AllowStaffToSetFinesVisibilityForGuarantor
379            choices:
380                1: Allow
381                0: "Don't allow"
382          - staff to set the ability for a patron's charges to be viewed by linked patrons in the OPAC.
383
384     Privacy:
385      -
386          - Use the following URL
387          - pref: PrivacyPolicyURL
388            class: url
389          - 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.)
390          - '<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.'
391      -
392          - "Set data privacy policy consent to:"
393          - pref: PrivacyPolicyConsent
394            choices:
395                '': 'disabled'
396                Enforced: 'enforced'
397                Permissive: 'permissive'
398          - ". 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."
399          - '<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.'
400      -
401          - Lock/expire patrons that submitted an unsubscribe request (refused consent) after
402          - pref: UnsubscribeReflectionDelay
403          - days, anonymize locked/expired accounts after
404          - pref: PatronAnonymizeDelay
405          - days and remove anonymized patron accounts after
406          - pref: PatronRemovalDelay
407          - "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."
408      -
409          - pref: CookieConsent
410            choices:
411                1: Require
412                0: "Don't require"
413          - cookie consent to be displayed in the OPAC and staff interface.
414      -
415          - Run the following JavaScript if cookie consent is provided (e.g. tracking code).
416          - pref: CookieConsentedJS
417            type: modaljs
418            initiator: populateCookieConsentedJS
419            processor: prepareCookieConsentedJS
420     Security:
421      -
422          - Login passwords for staff and patrons must be at least
423          - pref: minPasswordLength
424            class: integer
425          - characters long.
426      -
427          - pref: RequireStrongPassword
428            choices:
429                1: "Require"
430                0: "Don't require"
431          - a strong password for staff and patrons
432          - (must contain at least one digit, one lowercase and one uppercase).
433      -
434          - pref: EnableExpiredPasswordReset
435            choices:
436                1: "Enable"
437                0: "Don't enable"
438          - the ability for patrons to directly reset their password when it is expired.
439          - If not enabled patrons must either use the 'Forgot your password' feature or have staff
440          - reset their password.
441      -
442          - Block a patron's account if it reaches
443          - pref: FailedLoginAttempts
444            class: integer
445          - failed login attempts.
446      -
447          - pref: Pseudonymization
448            choices:
449                1: Enable
450                0: Disable
451          - "pseudonymization to comply with data privacy policies and regulations like GDPR for managing personal information."
452          - "Patrons and transactions will be copied to a separate table for statistical purposes."
453          - "<br/>Use the following fields for patrons:"
454          - pref: PseudonymizationPatronFields
455            multiple:
456              title: "Patron's title"
457              city: "City"
458              state: "State"
459              zipcode: "ZIP/Postal code"
460              country: "Country"
461              branchcode: "Patron's library"
462              categorycode: "Patron category"
463              dateenrolled: "Date the patron was added to Koha"
464              sex: "Patron's gender"
465              sort1: "Sort 1"
466              sort2: "Sort 2"
467          - "<br/> And the following fields for the transactions:"
468          - pref: PseudonymizationTransactionFields
469            multiple:
470              datetime: "Date and time of the transaction"
471              transaction_branchcode: "Library where the transaction occurred"
472              transaction_type: "Transaction type"
473              itemnumber: "Itemnumber"
474              itemtype: "Item type"
475              holdingbranch: "Holding library"
476              homebranch: "Home library"
477              location: "Location"
478              itemcallnumber: "Item's callnumber"
479              ccode: "Collection"