Bug 28833: Speed up holds queue builder via parallel processing
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / modules / admin / preferences / circulation.pref
1 Circulation:
2     Interface:
3         -
4             - pref: CircSidebar
5               choices:
6                   1: Activate
7                   0: Deactivate
8             - the navigation sidebar on all circulation pages.
9         -
10             - pref: CircConfirmItemParts
11               choices:
12                   1: "Require"
13                   0: "Don't require"
14             - staff to confirm that all parts of an item are present at checkin/checkout.
15         -
16             - pref: AutoSwitchPatron
17               choices:
18                   1: "Enable"
19                   0: "Don't enable"
20             - the automatic redirection to another patron when a patron barcode is scanned instead of a book.
21             - This should not be enabled if you have overlapping patron and book barcodes.
22         -
23             - pref: PatronAutoComplete
24               choices:
25                   1: Try
26                   0: "Don't try"
27             - to guess the patron being entered while typing a patron search for circulation or patron search.
28             - Only returns the first 10 results at a time.
29         -
30             - pref: itemBarcodeInputFilter
31               choices:
32                   OFF: "Don't filter"
33                   whitespace: Remove spaces from
34                   cuecat: Convert from CueCat form
35                   T-prefix: Remove the first number from T-prefix style
36                   libsuite8: Convert from Libsuite8 form
37                   EAN13: EAN-13 or zero-padded UPC-A form
38             - scanned item barcodes.
39         -
40             - pref: itemBarcodeFallbackSearch
41               choices:
42                   1: "Enable"
43                   0: "Don't enable"
44             - the automatic use of a keyword catalog search if the phrase entered as a barcode on the checkout page does not turn up any results during an item barcode search.
45         -
46             - Sort previous checkouts on the circulation page from
47             - pref: previousIssuesDefaultSortOrder
48               choices:
49                   asc: earliest to latest
50                   desc: latest to earliest
51             - due date.
52         -
53             - "Sort today's checkouts on the circulation page from"
54             - pref: todaysIssuesDefaultSortOrder
55               type: choice
56               choices:
57                   asc: earliest to latest
58                   desc: latest to earliest
59             - checkout time.
60         -
61             - pref: SpecifyDueDate
62               choices:
63                   1: Allow
64                   0: "Don't allow"
65             - staff to specify a due date for a checkout.
66         -
67             - pref: SpecifyReturnDate
68               choices:
69                   1: Allow
70                   0: "Don't allow"
71             - staff to specify a return date for a check in.
72         -
73             - Set the default start date for the Holds to pull list to
74             - pref: HoldsToPullStartDate
75               class: integer
76             - day(s) ago. Note that the default end date is controlled by the system preference <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=ConfirmFutureHolds">ConfirmFutureHolds</a>.
77         -
78             - When building the holds queue, calculate hold matches using
79             - pref: HoldsQueueParallelLoopsCount
80               class: integer
81             - parallel loop(s). The more loops used, the faster it will calculate and the more computing resources it will use.
82         -
83             - pref: AllowAllMessageDeletion
84               choices:
85                   1: Allow
86                   0: "Don't allow"
87             - staff to delete messages added from other libraries.
88         -
89             - Show the
90             - pref: numReturnedItemsToShow
91               class: integer
92             - last returned items on the checkin screen.
93         -
94             - pref: FineNotifyAtCheckin
95               choices:
96                   1: Notify
97                   0: "Don't notify"
98             - librarians of overdue fines on the items they are checking in.
99         -
100             - pref: WaitingNotifyAtCheckin
101               choices:
102                   1: Notify
103                   0: "Don't notify"
104             - librarians of waiting holds for the patron whose items they are checking in.
105         -
106             - pref: FilterBeforeOverdueReport
107               choices:
108                   1: Require
109                   0: "Don't require"
110             - staff to choose which checkouts to show before running the overdues report.
111         -
112             - pref: DisplayClearScreenButton
113               choices:
114                   1: Show
115                   0: "Don't show"
116             - a button to clear the current patron from the screen on the circulation screen.
117         -
118             - pref: RecordLocalUseOnReturn
119               choices:
120                   1: Record
121                   0: "Don't record"
122             - local use when an unissued item is checked in.
123         -
124             - When an empty barcode field is submitted in circulation
125             - pref: CircAutoPrintQuickSlip
126               choices:
127                   clear: "clear the screen"
128                   qslip: "open a print quick slip window"
129                   slip: "open a print slip window"
130             - .
131         -
132             - Include the stylesheet at
133             - pref: NoticeCSS
134               class: url
135             - on notices. (This should be a complete URL, starting with <code>http://</code>)
136         -
137             - pref: UpdateTotalIssuesOnCirc
138               choices:
139                   1: Do
140                   0: "Don't"
141             - update a bibliographic record's total checkouts count whenever an item is checked out (WARNING! This increases server load significantly; if performance is a concern, use the update_totalissues.pl cron job to update the total checkouts count).
142         -
143             - pref: ExportCircHistory
144               choices:
145                   1: Show
146                   0: "Don't show"
147             - the export patron checkout history options.
148         -
149             - "The following fields should be excluded from the patron checkout history CSV or MARC (ISO 2709) export:"
150             - pref: ExportRemoveFields
151             - (separate fields with space, e.g. 100a 200b 300c).
152         -
153             - pref: AllowOfflineCirculation
154               choices:
155                   1: Enable
156                   0: "Don't enable"
157             - "offline circulation on regular circulation computers. (<strong>NOTE:</strong> This system preference does not affect the Firefox add-on or the desktop application)."
158         -
159             - pref: ShowAllCheckins
160               choices:
161                   1: Show
162                   0: "Don't show"
163             - all items in the "Checked-in items" list, even items that were not checked out.
164         -
165             - pref: AllowCheckoutNotes
166               choices:
167                   1: Allow
168                   0: "Don't allow"
169             - patrons to submit notes about checked out items.
170         -
171             - pref: UseCirculationDesks
172               choices:
173                   1: "Use"
174                   0: "Don't use"
175             - circulation desks with circulation.
176
177     Checkout policy:
178         -
179             - pref: OnSiteCheckoutAutoCheck
180               choices:
181                   1: Enable
182                   0: Don't enable
183             - on-site checkout by default if last checkout was an on-site one.
184         -
185             - pref: AutoReturnCheckedOutItems
186               choices:
187                   1: Don't
188                   0: Do
189             - require librarians to manually confirm a checkout where the item is already checked out to another patron.
190         -
191             - pref: AllowTooManyOverride
192               choices:
193                   1: Allow
194                   0: "Don't allow"
195             - staff to override and check out items when the patron has reached the maximum number of allowed checkouts.
196         -
197             - pref: AutoRemoveOverduesRestrictions
198               choices:
199                   1: "Do"
200                   0: "Don't"
201             - allow OVERDUES restrictions triggered by sent notices to be cleared automatically when all overdue items are returned by a patron.
202         -
203             - pref: AllowNotForLoanOverride
204               choices:
205                   1: Allow
206                   0: "Don't allow"
207             - staff to override and check out items that are marked as not for loan.
208         -
209             - pref: AllowRenewalLimitOverride
210               choices:
211                   1: Allow
212                   0: "Don't allow"
213             - staff to manually override renewal blocks and renew a checkout when it would go over the renewal limit or be premature for the "No renewal before" setting in the circulation policy or has been scheduled for automatic renewal.
214         -
215             - pref: AllowRenewalOnHoldOverride
216               choices:
217                   1: Allow
218                   0: "Don't allow"
219             - staff to renew items that are on hold by manually specifying a due date.
220         -
221             - pref: AllowItemsOnHoldCheckoutSIP
222               choices:
223                   1: Allow
224                   0: "Don't allow"
225             - checkouts of items reserved to someone else via SIP checkout messages.
226             - If allowed do not generate RESERVED warning.
227             - This allows self checkouts for those items. If using the holds queue items with pending holds will be marked as "unavailable" if this set to "Don't allow".
228         -
229             - pref: AllowItemsOnHoldCheckoutSCO
230               choices:
231                   1: Allow
232                   0: "Don't allow"
233             - checkouts of items reserved to someone else in the SCO module. If allowed do not generate RESERVE_WAITING and RESERVED warning. This allows self checkouts for those items.
234         -
235             - pref: AllFinesNeedOverride
236               choices:
237                   1: Require
238                   0: "Don't require"
239             - staff to manually override all fines, even fines less than set in the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=noissuescharge">noissuescharge</a> system preference.
240         -
241             - pref: AllowFineOverride
242               choices:
243                   1: Allow
244                   0: "Don't allow"
245             - staff to manually override and check out items to patrons who have more in fines than set in the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=noissuescharge">noissuescharge</a> system preference.
246         -
247             - pref: AutomaticItemReturn
248               choices:
249                   1: Do
250                   0: "Don't"
251             - automatically transfer items to their home library when they are checked in.
252         -
253             - pref: UseBranchTransferLimits
254               choices:
255                   1: Enforce
256                   0: "Don't enforce"
257             - library transfer limits based on
258             - pref: BranchTransferLimitsType
259               choices:
260                   ccode: collection code
261                   itemtype: item type
262             - .
263         -
264             - pref: UseTransportCostMatrix
265               choices:
266                   1: Use
267                   0: "Don't use"
268             - the transport cost matrix for calculating optimal holds filling between libraries.
269         -
270             - Use the calendar and circulation rules of
271             - pref: CircControl
272               type: choice
273               choices:
274                   PickupLibrary: the library you are logged in at.
275                   PatronLibrary: the library the patron is from.
276                   ItemHomeLibrary: the library the item is from.
277         -
278             - Use the checkout and fines rules of
279             - pref: HomeOrHoldingBranch
280               type: choice
281               choices:
282                   homebranch: the item's home library (homebranch).
283                   holdingbranch: the item's holding library (holdingbranch).
284         -
285             - Allow items to be checked in
286             - pref: AllowReturnToBranch
287               type: choice
288               choices:
289                   anywhere: at any library.
290                   homebranch: only at the library the item is from.
291                   holdingbranch: only at the library the item was checked out from.
292                   homeorholdingbranch: either at the library the item is from or the library it was checked out from.
293         -
294             - For search results in the staff interface, display
295             - pref: StaffSearchResultsDisplayBranch
296               type: choice
297               choices:
298                   homebranch: the library the item is from.
299                   holdingbranch: the library the item is held by.
300         -
301             - pref: useDaysMode
302               choices:
303                   Days: Ignore the calendar
304                   Calendar: Use the calendar to skip days the library is closed
305                   Datedue: Use the calendar to push the due date to the next open day
306                   Dayweek: Use the calendar to push the due date to the next open matching weekday for weekly loan periods, or the next open day otherwise
307             - when calculating the date due.
308         -
309             - Calculate "No renewal before" based on
310             - pref: NoRenewalBeforePrecision
311               choices:
312                   date: date.
313                   exact_time: exact time.
314             - Only relevant for loans calculated in days, hourly loans are not affected.
315         -
316             - When renewing checkouts, base the new due date on
317             - pref: RenewalPeriodBase
318               choices:
319                   date_due: the old due date of the checkout.
320                   now: the current date.
321         -
322             - pref: RenewalSendNotice
323               choices:
324                   1: Send
325                   0: "Don't send"
326             - "a renewal notice according to patron's messaging preferences for 'Item checkout'."
327         -
328             - pref: UnseenRenewals
329               choices:
330                   1: Allow
331                   0: "Don't allow"
332             - renewals to be recorded as "unseen" by the library, and count against the patrons unseen renewals limit.
333         -
334             - Prevent patrons from making holds on the OPAC if they owe more than
335             - pref: maxoutstanding
336               class: currency
337             - '[% local_currency %] in fines.'
338         -
339             - Show a warning on the "Transfers to receive" screen if the transfer has not been received
340             - pref: TransfersMaxDaysWarning
341               class: integer
342             - days after it was sent.
343         -
344             - pref: IssuingInProcess
345               choices:
346                   1: "Don't prevent"
347                   0: "Prevent"
348             - patrons from checking out an item whose rental charge would take them over the limit.
349         -
350             - "Restrict patrons with the following target audience values from checking out inappropriate materials:"
351             - pref: AgeRestrictionMarker
352             - ". For example, enter target audience keyword(s) split by | (bar) FSK|PEGI|Age| (No white space near |). Be sure to map agerestriction in Koha to MARC mapping (e.g. 521$a). A MARC field value of FSK 12 or PEGI 12 would mean: Borrower must be 12 years old. Leave empty to not apply an age restriction."
353         -
354             - pref: AgeRestrictionOverride
355               choices:
356                   1: Allow
357                   0: "Don't allow"
358             - staff to check out an item with age restriction.
359         -
360             - Prevent patrons from checking out items if they have more than
361             - pref: noissuescharge
362               class: integer
363             - '[% local_currency %] in fines.'
364         -
365             - Prevent a patron from checking out if the patron has guarantees owing in total more than
366             - pref: NoIssuesChargeGuarantees
367               class: integer
368             - '[% local_currency %] in fines.'
369         -
370             - Prevent a patron from checking out if the patron has guarantors and those guarantor's guarantees owing in total more than
371             - pref: NoIssuesChargeGuarantorsWithGuarantees
372               class: integer
373             - '[% local_currency %] in fines.'
374         -
375             - pref: RentalsInNoissuesCharge
376               choices:
377                   1: Include
378                   0: "Don't include"
379             - rental charges when summing up charges for limit set in the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=noissuescharge">noissuescharge</a> system preference.
380         -
381             - pref: ManInvInNoissuesCharge
382               choices:
383                   1: Include
384                   0: "Don't include"
385             - custom debit type charges when summing up charges for limit set in the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=noissuescharge">noissuescharge</a> system preference.
386         -
387             - pref: HoldsInNoissuesCharge
388               choices:
389                   1: Include
390                   0: "Don't include"
391             - hold charges when summing up charges for limit set in the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=noissuescharge">noissuescharge</a> system preference.
392         -
393             - pref: ReturnBeforeExpiry
394               choices:
395                   1: Require
396                   0: "Don't require"
397             - "patrons to return items before their accounts expire (by restricting due dates to before the patron's expiration date)."
398         -
399             - "Send all notices as a BCC to this email address:"
400             - pref: NoticeBcc
401               class: email
402         -
403             - pref: OverdueNoticeCalendar
404               choices:
405                   1: "Use calendar"
406                   0: "Ignore calendar"
407             - "when working out the period for overdue notices."
408         -
409             - Include up to
410             - pref: PrintNoticesMaxLines
411               class: integer
412             - "item lines in a printed overdue notice. If the number of items is greater than this number, the notice will end with a warning asking the patron to check their online account for a full list of overdue items. Set to 0 to include all overdue items in the notice, no matter how many there are."
413         -
414             - pref: OverduesBlockCirc
415               choices:
416                   block: Block
417                   noblock: "Don't block"
418                   confirmation: Ask for confirmation
419             - "when checking out to a patron that has overdues outstanding."
420         -
421             - "When checking out an item with rental fees, "
422             - pref: RentalFeesCheckoutConfirmation
423               choices:
424                   1: ask
425                   0: "don't ask"
426             - "for confirmation."
427         -
428             - By default, set the LOST value of an item to
429             - pref: DefaultLongOverdueLostValue
430               class: integer
431             - when the item has been overdue for more than
432             - pref: DefaultLongOverdueDays
433               class: integer
434             - days.
435             - <br>WARNING â€” These preferences will activate the automatic item loss process. Leave these fields empty if you don't want to activate this feature.
436             - "<br>Example: [1] [30] Sets an item to the LOST value 1 when it has been overdue for more than 30 days."
437             - <br>(Used when the longoverdue.pl script is called without the --lost parameter)
438             - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/longoverdue.pl</code> cronjob. Ask your system administrator to schedule it."
439         -
440             - "Charge a lost item to the patron's account when the LOST value of the item changes to:"
441             - pref: DefaultLongOverdueChargeValue
442               class: integer
443             - <br>Leave this field empty if you don't want to charge the patron for lost items.
444             - <br>(Used when the longoverdue.pl script is called without the --charge parameter)
445             - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/longoverdue.pl</code> cronjob. Ask your system administrator to schedule it."
446         -
447             - When using the automatic item loss process, skip items with lost values matching any of
448             - pref: DefaultLongOverdueSkipLostStatuses
449             - "."
450             - <br>Leave this field empty if you don't want to skip any lost statuses.
451             - <br>Set to a list of comma separated values, e.g. <em>5,6,7</em>.
452         -
453             - "When issuing an item that has been marked as lost, "
454             - pref: IssueLostItem
455               choices:
456                   confirm: "require confirmation"
457                   alert: "display a message"
458                   nothing : "do nothing"
459             - .
460         -
461             - "When checking out an item, "
462             - pref: RecordStaffUserOnCheckout
463               choices:
464                   1: "record"
465                   0: "don't record"
466             - "the user who checked out the item."
467         -
468             - "Mark items as returned when flagged as lost "
469             - pref: MarkLostItemsAsReturned
470               multiple:
471                 cronjob: "from the longoverdue cronjob"
472                 batchmod: "from the batch item modification tool"
473                 additem: "when cataloguing an item"
474                 moredetail: "from the items tab of the catalog module"
475                 pendingreserves: "from the 'Holds to pull' list"
476                 onpayment: "when receiving payment for the item"
477                 claim_returned: "when marking an item as a return claim"
478             - .
479         -
480             - pref: AllowMultipleIssuesOnABiblio
481               choices:
482                   1: Allow
483                   0: "Don't allow"
484             - "patrons to check out multiple items from the same record. (<strong>NOTE:</strong> This will only affect records without a subscription attached.)"
485         -
486             - pref: OnSiteCheckouts
487               choices:
488                   1: Enable
489                   0: Disable
490             - the on-site checkouts feature.
491         -
492             - pref: OnSiteCheckoutsForce
493               choices:
494                   1: Enable
495                   0: Disable
496             - the on-site checkout for all cases (even if a patron is debarred, etc.).
497         -
498             - pref: ConsiderOnSiteCheckoutsAsNormalCheckouts
499               choices:
500                   1: Consider
501                   0: "Don't consider"
502             - on-site checkouts as normal checkouts.
503             - If enabled, on-site checkouts will count toward the checkout limit for regular checkouts. The on-site limit will still apply for on-site checkouts.
504             - If disabled, both values will be checked separately.
505         -
506             - pref: SwitchOnSiteCheckouts
507               choices:
508                   1: Switch
509                   0: "Don't switch"
510             - on-site checkouts to normal checkouts when checked out.
511         -
512             - When a patron's checked out item is overdue,
513             - pref: OverduesBlockRenewing
514               type: choice
515               choices:
516                   allow: allow renewing.
517                   blockitem: block renewing only for this item.
518                   block: block renewing for all the patron's items.
519         -
520             - If a patron is restricted,
521             - pref: RestrictionBlockRenewing
522               choices:
523                   1: block
524                   0: allow
525             - renewing of items from the staff interface.
526         -
527             - If a patron owes more than the value of <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OPACFineNoRenewals">OPACFineNoRenewals</a>,
528             - pref: OPACFineNoRenewalsBlockAutoRenew
529               choices:
530                   1: block
531                   0: allow
532             - their auto-renewals.
533         -
534             - If a patron pays off all fines on an overdue item that is accruing fines,
535             - pref: RenewAccruingItemWhenPaid
536               choices:
537                   1: renew
538                   0: "don't renew"
539             - the item automatically. If the system preference <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=RenewalPeriodBase">RenewalPeriodBase</a> is set to "due date", renewed items may still be overdue.
540         -
541             - If a patron pays off all fines on an overdue item that is accruing fines in the OPAC via a payment plugin,
542             - pref: RenewAccruingItemInOpac
543               choices:
544                   1: renew
545                   0: "don't renew"
546             - the item automatically. If the system preference <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=RenewalPeriodBase">RenewalPeriodBase</a> is set to "due date", renewed items may still be overdue.
547         -
548             - pref: ItemsDeniedRenewal
549               type: textarea
550               syntax: text/x-yaml
551               class: code
552             - Define custom rules to deny specific items from renewal.
553             - "<br />Can name any field in the items table followed by a colon then a space then"
554             - "a bracketed list of values separated by commas."
555             - "For example:"
556             - "<br />ccode: [NEWFIC,NULL,DVD]"
557             - "<br />itype: [NEWBK,\"\"]"
558             - "<br /> <strong>NOTE:</strong> The word 'NULL' can be used to block renewal on undefined fields, while an empty string \"\" will block on an empty (but defined) field."
559     Checkin policy:
560         -
561             - pref: TrapHoldsOnOrder
562               choices:
563                   1: Trap
564                   0: "Don't trap"
565             - items that are not for loan but holdable ( notforloan < 0 ) to fill holds.
566         -
567             - Never trap items with 'not for loan' values of
568             - pref: SkipHoldTrapOnNotForLoanValue
569               class: integer
570             - to fill holds.
571             - "(list of not for loan values separated with a pipe '|')"
572         -
573             - pref: HoldsAutoFill
574               choices:
575                   1: Do
576                   0: "Don't"
577             - automatically fill holds instead of asking the librarian.
578         -
579             - pref: HoldsNeedProcessingSIP
580               choices:
581                   1: "Don't fulfill"
582                   0: Fulfill
583             - holds automatically if matching item is returned via SIP protocol.
584         -
585             - pref: HoldsAutoFillPrintSlip
586               choices:
587                   1: Do
588                   0: "Don't"
589             - automatically display the hold slip dialog for auto-filled holds.
590         -
591             - pref: BlockReturnOfWithdrawnItems
592               choices:
593                   1: Block
594                   0: "Don't block"
595             - returning of items that have been withdrawn.
596         -
597             - pref: BlockReturnOfLostItems
598               choices:
599                   1: Block
600                   0: "Don't block"
601             - returning of items that have been lost.
602         -
603             - pref: CalculateFinesOnReturn
604               choices:
605                   1: Do
606                   0: "Don't"
607             - calculate and update overdue charges when an item is returned.
608             - "<br /><strong>NOTE:</strong> If you are doing hourly loans then you should have this on."
609             - '<br /><strong>NOTE:</strong> This system preference requires <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=FinesMode">FinesMode</a> to be set to "Calculate and charge."'
610         -
611             - pref: CalculateFinesOnBackdate
612               choices:
613                   1: Do
614                   0: "Don't"
615             - calculate and update overdue charges when an item is returned with a backdated return date.
616         -
617             - pref: UpdateItemLocationOnCheckin
618               type: textarea
619               syntax: text/x-yaml
620               class: code
621             - "This is a list of value pairs. The first value is followed immediately by colon space then the second value.<br/><br/>"
622             - "Examples:<br/>"
623             - "PROC: FIC - causes an item in the Processing Center location to be updated into the Fiction location on check in.<br/>"
624             - "FIC: GEN - causes an item in the Fiction location to be updated into the General stacks location on check in.<br/>"
625             - "_BLANK_: FIC - causes an item that has no location to be updated into the Fiction location on check in.<br/>"
626             - "FIC: _BLANK_ - causes an item in location FIC to be updated to a blank location on check in.<br/>"
627             - "_ALL_: FIC - causes all items to be updated into the Fiction location on check in.<br/>"
628             - "PROC: _PERM_ - causes an item that is in the Processing Center to be updated to it's permanent location.<br/><br/>"
629             - "General rule: if the location value on the left of the colon (:) matches the item's current location, it will be updated to match the location value on the right of the colon (:).<br/>"
630             - "Note: PROC and CART are special values, for these locations the location and permanent_location can differ, in all other cases an update will affect both. Items in the CART location will be returned to their permanent location on checkout.<br/>"
631             - "The special term _BLANK_ may be used on either side of a value pair to update or remove the location from items with no location assigned.<br/>"
632             - "The special term _ALL_ is used on the left side of the colon (:) to affect all items, <strong>and overrides all other rules.</strong>"
633         -
634             - pref: UpdateNotForLoanStatusOnCheckin
635               type: textarea
636               syntax: text/x-yaml
637               class: code
638             - This is a list of value pairs. When an item is checked in, if the not for loan value on the left matches the items not for loan value
639             - "it will be updated to the right-hand value. For example, '-1: 0' will cause an item that was set to 'Ordered' to now be available for loan."
640             - Each pair of values should be on a separate line.
641         -
642             - pref: CumulativeRestrictionPeriods
643               choices:
644                   1: Cumulate
645                   0: "Don't cumulate"
646             - the restriction periods.
647         -
648             - pref: HidePersonalPatronDetailOnCirculation
649               choices:
650                   1: "Hide"
651                   0: "Don't hide"
652             - "a patron's phone number, email address, street address and city on the circulation page."
653         -
654             - pref: TransfersBlockCirc
655               choices:
656                   1: "Block"
657                   0: "Don't block"
658             - staff from continuing to checkin items when a transfer is triggered.
659         -
660             - pref: StoreLastBorrower
661               default: 0
662               choices:
663                   1: Store
664                   0: "Don't store"
665             - 'the last patron to return an item. This setting is independent of the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=opacreadinghistory">opacreadinghistory</a> and <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=AnonymousPatron">AnonymousPatron</a> system preferences.'
666     Holds policy:
667         -
668             - In the staff interface, split the holds queue into separate tables by
669             - pref: HoldsSplitQueue
670               choices:
671                   nothing: nothing
672                   branch: "pickup library"
673                   itemtype: "hold item type"
674                   branch_itemtype: "pickup library and item type"
675             - "."
676         -
677             - If the holds queue is split, show librarians
678             - pref: HoldsSplitQueueNumbering
679               choices:
680                   actual: "the actual priority, which may be out of order"
681                   virtual: "'virtual' priorities, where each group is numbered separately"
682             - "."
683         -
684             - pref: AllowHoldItemTypeSelection
685               choices:
686                   1: Allow
687                   0: "Don't allow"
688             - hold fulfillment to be limited by item type.
689         -
690             - pref: AllowRenewalIfOtherItemsAvailable
691               choices:
692                   1: Allow
693                   0: "Don't allow"
694             - a patron to renew an item with unfilled holds if other available items can fill that hold.
695         -
696             - pref: AllowHoldPolicyOverride
697               choices:
698                   1: Allow
699                   0: "Don't allow"
700             - staff to override hold policies when placing holds.
701         -
702             - pref: AllowHoldsOnDamagedItems
703               choices:
704                   1: Allow
705                   0: "Don't allow"
706             - hold requests to be placed on and filled by damaged items.
707         -
708             - pref: AllowHoldDateInFuture
709               choices:
710                   1: Allow
711                   0: "Don't allow"
712             - hold requests to be placed that do not enter the waiting list until a certain future date.
713         -
714             - pref: OPACAllowHoldDateInFuture
715               choices:
716                   1: Allow
717                   0: "Don't allow"
718             - patrons to place holds that don't enter the waiting list until a certain future date. (<a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=AllowHoldDateInFuture">AllowHoldDateInFuture</a> must also be enabled).
719         -
720             - Confirm future hold requests (starting no later than
721             - pref: ConfirmFutureHolds
722               class: integer
723             - days from now) at checkin time. Note that this number of days will be used too in calculating the default end date for the Holds to pull-report. But it does not interfere with issuing, renewing or transferring items.
724         -
725             - Check the rule from the
726             - pref: ReservesControlBranch
727               choices:
728                   ItemHomeLibrary: "item's home library"
729                   PatronLibrary: "patron's home library"
730             - to see if the patron can place a hold on the item.    
731         -
732             - Mark a hold as problematic if it has been waiting for more than
733             - pref: ReservesMaxPickUpDelay
734               class: integer
735             - days.
736         -
737             - pref: ExpireReservesMaxPickUpDelay
738               choices:
739                   1: Allow
740                   0: "Don't allow"
741             - 'holds to expire automatically if they have not been picked by within the time period specified in the <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=ReservesMaxPickUpDelay">ReservesMaxPickUpDelay</a> system preference.<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/holds/cancel_expired_holds.pl</code> cronjob. Ask your system administrator to schedule it.'
742         -
743             - If using <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=ExpireReservesMaxPickUpDelay">ExpireReservesMaxPickUpDelay</a>, charge a patron who allows their waiting hold to expire a fee of
744             - pref: ExpireReservesMaxPickUpDelayCharge
745               class: currency
746             - "."
747         -
748             - Satisfy holds using items from the libraries
749             - pref: StaticHoldsQueueWeight
750               class: multi
751             - (as branchcodes, separated by commas; if empty, uses all libraries)
752             - when they are
753             - pref: HoldsQueueSkipClosed
754               choices:
755                   1: open
756                   0: open or closed
757             - pref: RandomizeHoldsQueueWeight
758               choices:
759                   1: in random order.
760                   0: in that order.
761             - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/holds/build_holds_queue.pl</code> cronjob. Ask your system administrator to schedule it."
762             -
763         -
764             - pref: canreservefromotherbranches
765               choices:
766                   1: Allow
767                   0: "Don't allow (with independentbranches)"
768             - a user from one library to place a hold on an item from another library
769         -
770             - pref: OPACAllowUserToChooseBranch
771               choices:
772                   1: Allow
773                   0: "Don't allow"
774             - a user to choose the library to pick up a hold from.
775         -
776             - pref: ReservesNeedReturns
777               choices:
778                   1: "Don't automatically"
779                   0: Automatically
780             - mark a hold as found and waiting when a hold is placed on a specific item and that item is already checked in.
781         -
782             - Patrons can only have
783             - pref: maxreserves
784               class: integer
785             - holds at once.
786         -
787             - pref: emailLibrarianWhenHoldIsPlaced
788               choices:
789                   1: Enable
790                   0:  "Don't enable"
791             - "sending an email to the Koha administrator email address whenever a hold request is placed."
792         -
793             - pref: DisplayMultiPlaceHold
794               choices:
795                   1: Enable
796                   0:  "Don't enable"
797             - "the ability to place holds on multiple bibliographic records from the search results"
798         -
799             - pref: TransferWhenCancelAllWaitingHolds
800               choices:
801                   1: Transfer
802                   0: "Don't transfer"
803             - items when cancelling all waiting holds.
804         -
805             - pref: AutoResumeSuspendedHolds
806               choices:
807                   1: Allow
808                   0: "Don't allow"
809             - "suspended holds to be automatically resumed by a set date."
810             - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/holds/auto_unsuspend_holds.pl</code> cronjob. Ask your system administrator to schedule it."
811         -
812             - pref: SuspendHoldsIntranet
813               choices:
814                   1: Allow
815                   0: "Don't allow"
816             - holds to be suspended from the staff interface.
817         -
818             - pref: SuspendHoldsOpac
819               choices:
820                   1: Allow
821                   0: "Don't allow"
822             - holds to be suspended from the OPAC.
823         -
824             - pref: ExpireReservesOnHolidays
825               choices:
826                   1: Allow
827                   0: "Don't allow"
828             - expired holds to be canceled on days the library is closed.
829         -
830             - pref: ExcludeHolidaysFromMaxPickUpDelay
831               choices:
832                   1: Use the calendar
833                   0: Ignore the calendar
834             - when calculating the period for a hold's max pickup delay.
835         -
836             - pref: decreaseLoanHighHolds
837               choices:
838                   1: Enable
839                   0:  "Don't enable"
840             - the reduction of loan period to
841             - pref: decreaseLoanHighHoldsDuration
842               class: integer
843             - days for high demand items with more than
844             - pref: decreaseLoanHighHoldsValue
845               class: integer
846             - holds
847             - pref: decreaseLoanHighHoldsControl
848               choices:
849                   static: "on the record"
850                   dynamic: "over the number of holdable items on the record"
851             - ". Ignore items with the following statuses when counting items:"
852             - pref: decreaseLoanHighHoldsIgnoreStatuses
853               multiple:
854                 damaged: Damaged
855                 itemlost: Lost
856                 withdrawn: Withdrawn
857                 notforloan: Not for loan
858             - "Note: The reduced loan period can also be set up in the circulation conditions and will then overwrite the setting here."
859         -
860             - pref: AllowHoldsOnPatronsPossessions
861               choices:
862                   1: Allow
863                   0: "Don't allow"
864             - a patron to place a hold on a record where the patron already has one or more items attached to that record checked out.
865         -
866             - pref: LocalHoldsPriority
867               choices:
868                   1: Give
869                   0: "Don't give"
870             - priority for filling holds to patrons whose
871             - pref: LocalHoldsPriorityPatronControl
872               choices:
873                   PickupLibrary: "pickup library"
874                   HomeLibrary: "home library"
875             - matches the item's
876             - pref: LocalHoldsPriorityItemControl
877               choices:
878                   homebranch: "home library"
879                   holdingbranch: "holding library"
880         -
881             - pref: OPACHoldsIfAvailableAtPickup
882               choices:
883                   1: Allow
884                   0: "Don't allow"
885             - to pickup holds at libraries where the item is available.
886         -
887             - 'Patron categories not affected by <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=OPACHoldsIfAvailableAtPickup">OPACHoldsIfAvailableAtPickup</a>:'
888             - pref: OPACHoldsIfAvailableAtPickupExceptions
889               choices: patron-categories
890               class: multiple
891         -
892             - pref: CanMarkHoldsToPullAsLost
893               choices:
894                   do_not_allow: "Do not allow to mark items as lost"
895                   allow: "Allow to mark items as lost"
896                   allow_and_notify: "Allow to mark items as lost and notify the patron"
897             - from the 'Holds to pull' page. Values to be applied must be defined in <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=UpdateItemWhenLostFromHoldList">UpdateItemWhenLostFromHoldList</a>.
898         -
899             - A list of values to update an item's values with when it is marked as lost from the 'Holds to pull' page.
900             - 'Example: "itemlost: 1" to set items.itemlost to 1 when the item is marked as lost. (Requires <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=CanMarkHoldsToPullAsLost">CanMarkHoldsToPullAsLost</a>)'
901             - pref: UpdateItemWhenLostFromHoldList
902               type: textarea
903               syntax: text/x-yaml
904         -
905             - pref: DefaultHoldExpirationdate
906               default: 0
907               choices:
908                   yes: Set
909                   no: Don't set
910             - default expiration date for holds automatically.
911             - If enabled, set expiration date
912             - pref: DefaultHoldExpirationdatePeriod
913               default: 0
914               class: integer
915             - pref: DefaultHoldExpirationdateUnitOfTime
916               default: days
917               choices:
918                   days: days
919                   months: months
920                   years: years
921             - from reserve date.
922     Interlibrary loans:
923         -
924             - pref: ILLModule
925               default: 0
926               choices:
927                   1: Enable
928                   0: Disable
929             - the interlibrary loans module (master switch).
930         -
931             - "Adding text will enable the copyright clearance stage in request creation. The text you enter will be the text displayed."
932             - pref: ILLModuleCopyrightClearance
933               type: textarea
934               class: long
935         -
936             - "Enabled ILL backends for OPAC initiated requests:"
937             - pref: ILLOpacbackends
938               class: multi
939             - (separated with |). If left empty, all installed backends will be enabled.
940         -
941             - pref: ILLModuleUnmediated
942               default: 0
943               choices:
944                   1: Enable
945                   0: Disable
946             - unmediated interlibrary loan requests. If enabled and the ILL backend supports it, the newly created requests are immediately requested by backend.
947         -
948             - pref: CirculateILL
949               default: 0
950               choices:
951                   1: Enable
952                   0: Disable
953             - the circulation of ILL requested items.
954         -
955             - pref: ILLCheckAvailability
956               default: 0
957               choices:
958                   1: Check
959                   0: "Don't check"
960             - external sources for availability during the request process.
961         -
962             - "ILL statuses that are considered finished and should not be displayed in the ILL module: "
963             - pref: ILLHiddenRequestStatuses
964               class: multi
965             - (separated with |). If left empty, all ILL requests will be displayed. The request codes can be found in the ILLSTATUS authorized value category.
966         -
967             - "Send these ILL notices to staff when appropriate:"
968             - pref: ILLSendStaffNotices
969               class: multi
970             - "(separated with |). e.g. ILL_REQUEST_CANCEL|ILL_REQUEST_MODIFIED If left empty, no staff ILL notices will be sent."
971         -
972             - "Fallback email address for staff ILL notices to be sent to in the absence of a library address:"
973             - pref: ILLDefaultStaffEmail
974               class: email
975     Fines Policy:
976         -
977             - pref: finesCalendar
978               type: choice
979               choices:
980                   ignoreCalendar: Ignore the calendar
981                   noFinesWhenClosed: Use the calendar
982             - when calculating the period for fines.
983         -
984             - pref: SuspensionsCalendar
985               type: choice
986               choices:
987                   ignoreCalendar: Ignore the calendar
988                   noSuspensionsWhenClosed: Use the calendar
989             - when calculating the period for suspension expiration.
990         -
991             - pref: finesMode
992               type: choice
993               choices:
994                   off: "Don't calculate"
995                   production: Calculate and charge
996             - fines (when <code>cronjobs/fines.pl</code> is being run).
997             - '<br><strong>NOTE:</strong> If the cronjobs/fines.pl cronjob is being run, accruing and final fines will be calculated when the cron runs and accruing fines will be finalized when an item is returned. If <a href="/cgi-bin/koha/admin/preferences.pl?op=search&searchfield=CalculateFinesOnReturn">CalculateFinesOnReturn</a> is enabled, final fines will be calculated when an item is returned.<br/>'
998             - pref: ChargeFinesOnClosedDays
999               type: choice
1000               choices:
1001                   0: "Don't charge"
1002                   1: Charge
1003             - on close days. If set the fines.pl cronjob will not generate fines when run on days marked as closed in the calendar.
1004         -
1005             - If a lost item is returned, apply the refunding rules defined for the
1006             - pref: RefundLostOnReturnControl
1007               choices:
1008                   CheckinLibrary: "check-in library."
1009                   ItemHomeBranch: "item's home library."
1010                   ItemHoldingBranch: "item's holding library."
1011         -
1012             - pref: FinesIncludeGracePeriod
1013               choices:
1014                   1: Include
1015                   0: "Don't include"
1016             - the grace period when calculating the fine for an overdue item.
1017         -
1018             - pref: WhenLostForgiveFine
1019               choices:
1020                   1: Forgive
1021                   0: "Don't forgive"
1022             - the fines on an item when it is marked as lost.
1023         -
1024             - "Don't refund lost fees if a lost item is checked in more than"
1025             - pref: NoRefundOnLostReturnedItemsAge
1026               class: integer
1027             - days after it was marked lost.
1028         -
1029             - pref: WhenLostChargeReplacementFee
1030               choices:
1031                   1: Charge
1032                   0: "Don't charge"
1033             - the replacement price when a patron loses an item.
1034         -
1035             - Charge a hold fee
1036             - pref: HoldFeeMode
1037               choices:
1038                   any_time_is_placed: "any time a hold is placed."
1039                   not_always: "only if all items are checked out and the record has at least one hold already."
1040                   any_time_is_collected: "any time a hold is collected."
1041         -
1042             - pref: useDefaultReplacementCost
1043               choices:
1044                   1: Use
1045                   0: "Don't use"
1046             - the default replacement cost defined for the item type.
1047         -
1048             - "Text to be recorded in the column 'note', table 'accountlines' when the processing fee (defined for the item type) is applied:"
1049             - pref: ProcessingFeeNote
1050               type: textarea
1051               class: code
1052     Self check-in module:
1053         -
1054             - "Include the following HTML on the self check-in screen:"
1055             - pref: SelfCheckInMainUserBlock
1056               type: textarea
1057               syntax: text/html
1058               class: code
1059         -
1060             - pref: SelfCheckInModule
1061               choices:
1062                   1: Enable
1063                   0: "Don't enable"
1064             - "the standalone self check-in module (available at: /cgi-bin/koha/sci/sci-main.pl)."
1065         -
1066             - "Reset the current self check-in screen after"
1067             - pref: SelfCheckInTimeout
1068               class: integer
1069             - seconds.
1070         -
1071             - "Include the following CSS on all the self check-in screens:"
1072             - pref: SelfCheckInUserCSS
1073               type: textarea
1074               syntax: css
1075               class: code
1076         -
1077             - "Include the following JavaScript on all the self check-in screens:"
1078             - pref: SelfCheckInUserJS
1079               type: textarea
1080               syntax: javascript
1081               class: code
1082     Self check-out module:
1083         -
1084             - "Include the following JavaScript on all pages in the web-based self checkout:"
1085             - pref: SCOUserJS
1086               type: textarea
1087               syntax: javascript
1088               class: code
1089         -
1090             - "Include the following HTML on the the web-based self checkout screen:"
1091             - pref: SCOMainUserBlock
1092               type: textarea
1093               syntax: text/html
1094               class: code
1095         -
1096             - "Include the following CSS on all pages in the web-based self checkout:"
1097             - pref: SCOUserCSS
1098               type: textarea
1099               syntax: css
1100               class: code
1101         -
1102             - pref: ShowPatronImageInWebBasedSelfCheck
1103               choices:
1104                   1: Show
1105                   0: "Don't show"
1106             - "the patron's picture (if one has been added) when they use the web-based self checkout."
1107         -
1108             - pref: WebBasedSelfCheck
1109               choices:
1110                   1: Enable
1111                   0: "Don't enable"
1112             - "the web-based self checkout system (available at: /cgi-bin/koha/sco/sco-main.pl)."
1113         -
1114             - Have patrons log into the web-based self checkout system with their
1115             - pref: SelfCheckoutByLogin
1116               choices:
1117                   1: username and password
1118                   0: cardnumber
1119             - "."
1120         -
1121             - "Time out the current patron's web-based self checkout system login after"
1122             - pref: SelfCheckTimeout
1123               class: integer
1124             - seconds.
1125         -
1126             - pref: SCOAllowCheckin
1127               choices:
1128                   1: Allow
1129                   0: "Don't allow"
1130             - patrons to return items through web-based self checkout system. 
1131         -
1132             - "Include the following HTML in the Help page of the web-based self checkout system:"
1133             - pref: SelfCheckHelpMessage
1134               type: textarea
1135               syntax: text/html
1136               class: code
1137         -
1138             - pref: AutoSelfCheckAllowed
1139               choices:
1140                   1: Allow
1141                   0: "Don't allow"
1142             - "the web-based self checkout system to automatically log in with this staff login"
1143             - pref: AutoSelfCheckID
1144             - and this password
1145             - pref: AutoSelfCheckPass
1146               class: password
1147             - .
1148             - "Note: Any patron entered here will be unable to log into the OPAC."
1149         -
1150             - pref: SelfCheckReceiptPrompt
1151               choices:
1152                   1: Show
1153                   0: "Don't show"
1154             - "the print receipt popup dialog when self checkout is finished."
1155         -
1156             - "Allow access to the self check from the following IP addresses:"
1157             - pref: SelfCheckAllowByIPRanges
1158               class: short
1159             - (Leave blank if not used. Use ranges or simple IP addresses separated by spaces, like <code>192.168.1.1 192.168.0.0/24</code>.)
1160     Course reserves:
1161         -
1162             - pref: UseCourseReserves
1163               choices:
1164                   1: Use
1165                   0: "Don't use"
1166             - "course reserves."
1167     Batch checkout:
1168         -
1169             - pref: BatchCheckouts
1170               choices:
1171                   1: Allow
1172                   0: "Don't allow"
1173             - "batch checkouts."
1174         -
1175             - "Patron categories allowed to checkout in a batch:"
1176             - pref: BatchCheckoutsValidCategories
1177               choices: patron-categories
1178               class: multiple
1179     Housebound module:
1180         -
1181             - pref: HouseboundModule
1182               choices:
1183                   1: Enable
1184                   0: Disable
1185             - "the housebound module."
1186     Stock rotation module:
1187         -
1188             - pref: StockRotation
1189               choices:
1190                   1: Enable
1191                   0: Disable
1192             - "the stock rotation module."
1193     Article requests:
1194         -
1195             - pref: ArticleRequests
1196               choices:
1197                   1: Enable
1198                   0: "Don't enable"
1199             - patrons to place article requests.
1200         -
1201             - pref: ArticleRequestsLinkControl
1202               choices:
1203                   always: Always show
1204                   calc: Use algorithm to show or hide
1205             - article request links on search results.
1206         -
1207             - "For records that are record level or item level requestable, make the following fields mandatory:"
1208             - pref: ArticleRequestsMandatoryFields
1209               multiple:
1210                 title: Title
1211                 author: Author
1212                 volume: Volume
1213                 issue: Issue
1214                 date: Date
1215                 pages: Pages
1216                 chapters: Chapters
1217             -
1218         -
1219             - "For records that are only record level requestable, make the following fields mandatory:"
1220             - pref: ArticleRequestsMandatoryFieldsRecordOnly
1221               multiple:
1222                 title: Title
1223                 author: Author
1224                 volume: Volume
1225                 issue: Issue
1226                 date: Date
1227                 pages: Pages
1228                 chapters: Chapters
1229             -
1230         -
1231             - "For records that are only item level requestable, make the following fields mandatory:"
1232             - pref: ArticleRequestsMandatoryFieldsItemOnly
1233               multiple:
1234                 title: Title
1235                 author: Author
1236                 volume: Volume
1237                 issue: Issue
1238                 date: Date
1239                 pages: Pages
1240                 chapters: Chapters
1241             -
1242     Return claims:
1243         -
1244             - When marking a checkout as "claims returned",
1245             - pref: ClaimReturnedChargeFee
1246               default: ask
1247               choices:
1248                   ask: ask if a lost fee should be charged
1249                   charge: charge a lost fee
1250                   no_charge: don't charge a lost fee
1251             - .
1252         -
1253             - Use the LOST authorised value
1254             - pref: ClaimReturnedLostValue
1255             - to represent 'claims returned'.
1256         -
1257             - Warn librarians that a patron has excessive return claims if the patron has claimed the return of more than
1258             - pref: ClaimReturnedWarningThreshold
1259               class: integer
1260             - items.