Bug 22844: Simplify the process of selecting database columns for system preferences
[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          - pref: ExtendedPatronAttributes
14            choices:
15                yes: Enable
16                no: "Don't enable"
17          - searching, editing and display of custom attributes on patrons.
18      -
19          - pref: intranetreadinghistory
20            choices:
21                yes: "Allow"
22                no: "Don't allow"
23          - "staff to access a patron's checkout and hold history (reading history is still stored, regardless of staff being allowed access or not)."
24      -
25          - The late fine for all checkouts will only go up to
26          - pref: MaxFine
27            class: currency
28          - '[% local_currency %].'
29          - Empty value means no limit. Single item caps are specified in the circulation rules matrix.
30      -
31          - pref: patronimages
32            choices:
33                yes: Allow
34                no: "Don't allow"
35          - images to be uploaded and shown for patrons on the staff client.
36      -
37          - By default, show
38          - pref: PatronsPerPage
39            class: integer
40          - results per page in the staff client.
41      -
42          - pref: DefaultPatronSearchFields
43            class: multi
44          - "Comma separated list defining the default fields to be used during a patron search using the \"standard\" option. If empty Koha will default to \"surname,firstname,othernames,cardnumber,userid\". Additional fields added to this preference will be added as search options in the dropdown menu on the patron search page."
45      -
46          - "Show the following fields from the items database table as columns on the statistics tab on the patron record: "
47          - pref: StatisticsFields
48            class: multi
49          - "(separate fields with |, without trailing |). Default if empty: location|itype|ccode"
50      -
51          - pref: EnableBorrowerFiles
52            choices:
53                yes: Do
54                no: "Don't"
55          - enable the ability to upload and attach arbitrary files to a borrower record.
56      -
57          - pref: useDischarge
58            choices:
59                yes: Allow
60                no: "Don't allow"
61          - librarians to discharge borrowers and borrowers to request a discharge.
62      -
63          - pref: FeeOnChangePatronCategory
64            choices:
65                yes: Do
66                no: "Don't"
67          - charge a fee when a patron changes to a category with an enrollment fee.
68      -
69          - pref: TrackLastPatronActivity
70            choices:
71                yes: Do
72                no: "Don't"
73          - track last patron activity.
74          - Every time a patron will connect, the borrowers.lastseen will be updated with the current time.
75      -
76          - pref: ProtectSuperlibrarianPrivileges
77            choices:
78                yes: Allow only superlibrarians
79                no: Allow all permitted users
80          - "to access/change superlibrarian privileges."
81          - "<br><strong>NOTE:</strong> A permitted user needs to have the 'permissions' flag (if no superlibrarian)."
82      -
83          - pref: AllowPatronToControlAutorenewal
84            choices:
85                yes: Allow patrons
86                no: Allow only staff
87          - "to allow/disallow auto-renewal for account. If allowed a patron will be able to update their own account to allow/disallow auto-renewal"
88     Membership expiry:
89      -
90          - When renewing borrowers, base the new expiry date on
91          - pref: BorrowerRenewalPeriodBase
92            choices:
93                now: current date.
94                dateexpiry: current membership expiry date.
95                combination: the latter of the current and expiry date.
96      -
97          - Show a notice if the patron is about to expire or has expired
98          - pref: NotifyBorrowerDeparture
99            class: integer
100          - days beforehand.
101      -
102          - Send an account expiration notice when a patron's card will expire in
103          - pref: MembershipExpiryDaysNotice
104            class: integer
105          - days.
106          - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/membership_expiry.pl</code> cronjob. Ask your system administrator to schedule it."
107     Notices and notifications:
108      -
109          - pref: EnhancedMessagingPreferences
110            choices:
111                yes: Allow
112                no: "Don't allow"
113          - "Staff to manage which notices patrons will receive and when they will receive them."
114          - "<br><strong>NOTE:</strong> This only applies to courtesy notices. To manage if patrons have also access to these settings, use EnhancedMessagingPreferencesOPAC."
115          - "<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."
116      -
117          - pref: EnhancedMessagingPreferencesOPAC
118            choices:
119                yes: Show
120                no: "Don't show"
121          - "patron messaging setting on the OPAC."
122          - "<br><strong>NOTE:</strong> EnhancedMessagingPreferences must be enabled."
123      -
124          - pref: AutoEmailOpacUser
125            choices:
126                yes: Send
127                no: "Don't send"
128          - an email to newly created patrons with their account details.
129      -
130          - pref: UseEmailReceipts
131            choices:
132                yes: Send
133                no: "Don't send"
134          - email receipts to patrons for payments and writeoffs.
135      -
136          - "Use"
137          - pref: AutoEmailPrimaryAddress
138            default: "OFF"
139            choices:
140                email: home
141                emailpro: work
142                B_email: alternate
143                cardnumber: cardnumber as
144                "OFF": first valid
145          - "patron email address for sending out emails."
146      -
147          - pref: TalkingTechItivaPhoneNotification
148            choices:
149                yes: Enable
150                no: Disable
151          - patron phone notifications using Talking Tech i-tiva (overdues, predues and holds notices currently supported).
152      -
153          - "Use the SMS::Send::"
154          - pref: SMSSendDriver
155          - driver to send SMS messages.
156          - "<br>If you would prefer to send SMS via E-mail, set SMSSendDriver to: Email"
157      -
158          - "Define a username/login"
159          - pref: SMSSendUsername
160          - "and a password"
161          - pref: SMSSendPassword
162          - ". Override from address with"
163          - pref: EmailSMSSendDriverFromAddress
164          - "for emails sent using \"Email\" send driver."
165      -
166          - pref: FallbackToSMSIfNoEmail
167            choices:
168                yes: Enable
169                no: Disable
170          - Send purchase suggestion messages by SMS if no patron email is defined.
171     Patron forms:
172      -
173          - "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:"
174          - pref: BorrowerMandatoryField
175            type: modalselect
176            source: borrowers
177          - "<strong>NOTE:</strong> If autoMemberNum is enabled, the system preference BorrowerMandatoryField must not contain the field cardnumber."
178      -
179          - "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:"
180          - pref: BorrowerUnwantedField
181            type: modalselect
182            source: borrowers
183          - (separate columns with |)
184      -
185          - "Borrowers can have the following titles:"
186          - pref: BorrowersTitles
187            class: multi
188          - (separate multiple choices with |)
189      -
190          - pref: autoMemberNum
191            choices:
192                yes: Do
193                no: "Don't"
194          - 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).
195          - "<strong>NOTE:</strong> If autoMemberNum is enabled, the system preference BorrowerMandatoryField must not contain the field cardnumber."
196      -
197          - Card numbers for patrons must be
198          - pref: CardnumberLength
199          - "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')."
200          - "If 'cardnumber' is included in the BorrowerMandatoryField list, the minimum length, if not specified here, defaults to one. Maximum cannot be bigger than the database field size of 32."
201      -
202          - pref: uppercasesurnames
203            choices:
204                yes: Do
205                no: "Don't"
206          - store and display surnames in upper case.
207      -
208          - pref: PatronQuickAddFields
209            class: multi
210          - (separate columns with |)
211          - "add these fields 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."
212      -
213          - When adding new patrons or editing existing patrons, collapse the following fields from the full form (can still be expanded later)
214          - pref: CollapseFieldsPatronAddForm
215            multiple:
216                identity: "Organization/Patron identity"
217                guarantor: "Guarantor information"
218                primary_address: "Main address"
219                primary_contact: "Contact information"
220                alt_address: "Alternate address"
221                alt_contact: "Alternate contact"
222                lib_mgmt: "Library management"
223                lib_setup: "Library setup"
224                login: "OPAC/Staff login"
225                flags: "Patron account flags (existing patrons)"
226                debarments: "Patron restrictions (existing patrons)"
227                housebound: "Housebound roles"
228                additional: "Additional attributes and identifiers"
229                messaging: "Patron messaging preferences"
230     Patron relationships:
231      -
232          - "Guarantors can be the following of those they guarantee:"
233          - pref: borrowerRelationship
234            class: multi
235          - (input multiple choices separated by |). Leave empty to deactivate
236      -
237          - "When adding a guarantee to a guarantor patron fill the following fields in the guarantee's member entry form from the guarantors record:"
238          - pref: PrefillGuaranteeField
239            multiple:
240                B_address: "Alternate address - Address"
241                B_address2: "Alternate address - Address 2"
242                B_city: "Alternate address - City"
243                contactnote: "Alternate address - Contact note"
244                B_country: "Alternate address - Country"
245                B_email: "Alternate address - Email"
246                B_phone: "Alternate address - Phone"
247                B_state: "Alternate address - State"
248                B_streetnumber: "Alternate address - Street number"
249                B_zipcode: "Alternate address - ZIP/Postal code"
250                altcontactaddress1: "Alternate contact: Address"
251                altcontactaddress2: "Alternate contact: Address 2"
252                altcontactaddress3: "Alternate contact: City"
253                altcontactcountry: "Alternate contact: Country"
254                altcontactfirstname: "Alternate contact: First name"
255                altcontactphone: "Alternate contact: Phone"
256                altcontactstate: "Alternate contact: State"
257                altcontactsurname: "Alternate contact: Surname"
258                altcontactzipcode: "Alternate contact: ZIP/Postal code"
259                fax: "Contact - Fax"
260                mobile: "Contact - Other phone"
261                email: "Contact - Primary email"
262                phone: "Contact - Primary phone"
263                emailpro: "Contact - Secondary email"
264                phonepro: "Contact - Secondary phone"
265                address: "Main address - Address"
266                address2: "Main address - Address 2"
267                city: "Main address - City"
268                country: "Main address - Country"
269                state: "Main address - State"
270                zipcode: "Main address - ZIP/Postal code"
271                streetnumber: "Main address - street number"
272      -
273          - pref: AllowStaffToSetCheckoutsVisibilityForGuarantor
274            choices:
275                yes: Allow
276                no: "Don't allow"
277          - staff to set the ability for a patron's checkouts to be viewed by linked patrons in the OPAC.
278      -
279          - pref: AllowStaffToSetFinesVisibilityForGuarantor
280            choices:
281                yes: Allow
282                no: "Don't allow"
283          - staff to set the ability for a patron's fines to be viewed by linked patrons in the OPAC.
284     Privacy:
285      -
286          - Use the following URL
287          - pref: PrivacyPolicyURL
288          - to refer to your local privacy policy in messages about privacy and data protection. (If you enforce GDPR policy, make sure that this page is not blocked.)
289          - "<br><strong>NOTE:</strong> The URL will only be displayed if GDPR_Policy is set."
290      -
291          - Set GDPR policy to
292          - pref: GDPR_Policy
293            choices:
294                '': 'Disabled'
295                Enforced: 'Enforced'
296                Permissive: 'Permissive'
297          - "GDPR is the EU General Data Protection Regulation. When you enforce, patrons need to give consent before using the OPAC. If you set to permissive, Koha will warn but not enforce."
298          - "<br><strong>NOTE:</strong> If you enable this you will also have to set the URL of your public privacy policy with the PrivacyPolicyURL setting."
299      -
300          - Lock/expire patrons that submitted an unsubscribe request (refused consent) after
301          - pref: UnsubscribeReflectionDelay
302          - days, anonymize locked/expired accounts after
303          - pref: PatronAnonymizeDelay
304          - days and remove anonymized patron accounts after
305          - pref: PatronRemovalDelay
306          - "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."
307     Security:
308      -
309          - Login passwords for staff and patrons must be at least
310          - pref: minPasswordLength
311            class: integer
312          - characters long.
313      -
314          - pref: RequireStrongPassword
315            choices:
316                yes: "Require"
317                no: "Don't require"
318          - a strong password for staff and patrons
319          - (Must contain at least one digit, one lowercase and one uppercase).
320      -
321          - Block a patron's account if it reaches
322          - pref: FailedLoginAttempts
323            class: integer
324          - failed login attempts.
325      -
326          - pref: Pseudonymization
327            choices:
328                yes: Enable
329                no: Disable
330          - "pseudonymization to comply with GDPR for personal information."
331          - "Patrons and transactions will be copied to a separate table for statistics purpose."
332          - "<br/>Use the following fields for patrons:"
333          - pref: PseudonymizationPatronFields
334            multiple:
335              title: "Patron's title"
336              city: "City"
337              state: "State"
338              zipcode: "Zipcode"
339              country: "Country"
340              branchcode: "Patron's library"
341              categorycode: "Patron's category"
342              dateenrolled: "Date the patron was added to Koha"
343              sex: "Patron's gender"
344              sort1: "Sort1"
345              sort2: "Sort2"
346          - "<br/> And the following fields for the transactions:"
347          - pref: PseudonymizationTransactionFields
348            multiple:
349              datetime: "Date and time of the transaction"
350              transaction_branchcode: "Library where the transaction occurred"
351              transaction_type: "Transaction type"
352              itemnumber: "Itemnumber"
353              itemtype: "Item type"
354              holdingbranch: "Holding branch"
355              homebranch: "Home branch"
356              location: "Location"
357              itemcallnumber: "Item's callnumber"
358              ccode: "Collection code"