Docs: small Asciisoc table syntax fix

[working/Evergreen.git] / docs / admin / librarysettings.adoc

Library Settings Editor
-----------------------
(((Library Settings Editor)))

With the *Library Settings Editor* one can optionally customize
Evergreen's behavior for a particular library or library system. For
descriptions of available settings see the <<_settings_overview,Settings
Overview>> table below.

Editing Library Settings
~~~~~~~~~~~~~~~~~~~~~~~~

1. To open the *Library Settings Editor* select *Admin* -> *Local
Administration* -> *Library Settings Editor*.
2. Settings having effects on the same function or module are grouped
together. You may browse the list or search for the entry you want to
edit. Type in your search term in the filter box. You may clear or
re-apply the filter by clicking *Clear Filter* or *Filter*.
+
image::media/lse-1.png[]
+
3. To edit an entry click *Edit* in the line.
4. Read the instruction in the pop-up window. Make the change. Click
*Update Setting* to save the change. Click *Delete Setting* if you wish
to delete it.
+
image::media/lse-2.png[]
+
5. Click *History* to view the previous values, if any, of a setting.
You can revert back to an old value by clicking *revert*.
+
image::media/lse-3.png[]

NOTE: Please note that different settings may require different data
formats, which are listed in the <<_settings_overview,Settings
Overview>> table. Refer to the <<_data_types,Data Types>> table at the
bottom of this page for more information.

Exporting/Importing Library Settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
((("Exporting", "Library Settings Editor")))
((("Importing", "Library Settings Editor")))

1. To export library settings, click the *Export* button on the above
*Library Setting Editor* screen. Click *Copy* in the pop-up window.
Those settings displayed on the screen are copied to the clipboard.
Paste the contents to a text editor, such as Notepad. Save the file on
your computer.
+
image::media/lse-4.png[]
+
2. To import library settings, click the *Import* button on the *Library
Settings Editor* screen. Open your previously saved file and copy the
contents. Click *Paste* in the pop-up window. Click *Submit*.
+
image::media/lse-5.png[]

Settings Overview
~~~~~~~~~~~~~~~~~

The settings are grouped together in separate tables based on functions
and modules, which are affected by the setting. They are in the same
sequence as you see in the staff client. Each table describes the
available settings in the group and shows which can be changed on a
per-library basis. At the bottom is the table with a list of
<<_data_types, data types>> with details about acceptable settings
values.

((("Acquisitions", "Library Settings Editor")))

[[lse-acq]]
.Acquisitions
[options="header"]
|========
|Setting|Description|Data type|Notes
|Allow funds to be rolled over without bringing money along|Allow funds to be rolled over without bringing the money along. This makes money left in the old fund disappear, modeling its return to some outside entity.|True/False|
|Allows patrons to create automatic holds from purchase requests.|Allows patrons to create automatic holds from purchase requests.|True/False|
|Default circulation modifier|Sets the default circulation modifier for use in acquisitions.|Text|
|Default copy location|Sets the default copy location(shelving location) for use in acquisitions.|Selection list|
|Fund Spending Limit for Block|When the amount remaining in the fund, including spent money and encumbrances, goes below this percentage, attempts to spend from the fund will be blocked.|Number|
|Fund Spending Limit for Warning|When the amount remaining in the fund, including spent money and encumbrances, goes below this percentage, attempts to spend from the fund will result in a warning to the staff.|Number|
|Rollover Distribution Formulae Funds|During fiscal rollover, update distribution formalae to use new funds|True/False|
|Set copy creator as receiver|When receiving a copy in acquisitions, set the copy "creator" to be the staff that received the copy|True/False|
|Temporary barcode prefix|Temporary barcode prefix added to temporary item records.|Text|
|Temporary call number prefix|Temporary call number prefix|Text|
|Upload Activate PO|Activate the purchase order by default during ACQ file upload|True/False|
|Upload Create PO|Create a purchase order by default during ACQ file upload|True/False|
|Upload Default Insufficient Quality Fall-Thru Profile|Default low-quality fall through profile used during ACQ file upload|Selection List|Match Only Merge and Full Overlay are the selections.
|Upload Default Match Set|Default match set to use during ACQ file upload|Selection List|Can be set to authority test or biblio
|Upload Default Merge Profile|Default merge profile to use during ACQ file upload|Selection List|Match Only Merge and Full Overlay are the selections.
|Upload Default Min. Quality Ratio|Default minimum quality ratio used during ACQ file upload|Number|
|Upload Default Provider|Default provider to use during ACQ file upload|Selection List|This list is populated by your Providers.
|Upload Import Non Matching by Default|Import non-matching records by default during ACQ file upload|True/False|
|Upload Load Items for Imported Records by Default|Load items for imported records by default during ACQ file upload|True/False|
|Upload Merge on Best Match by Default|Merge records on best match by default during ACQ file upload|True/False|
|Upload Merge on Exact Match by Default|Merge records on exact match by default during ACQ file upload|True/False|
|Upload Merge on Single Match by Default|Merge records on single match by default during ACQ file upload|True/False|
|========

((("Booking", "Library Settings Editor")))
((("Cataloging", "Library Settings Editor")))

[[lse-cataloging]]
.Booking and Cataloging
[options="header"]
|======================
|Setting|Description|Data type|Notes
|Allow email notify|Permit email notification when a reservation is ready for pick-up.|True/false|
|Elbow room|Elbow room specifies how far in the future you must make a reservation on an item if that item will have to transit to reach its pick-up location. It secondarily defines how soon a reservation on a given item must start before the check-in process will opportunistically capture it for the reservation shelf.|Duration|
|Default Classification Scheme|Defines the default classification scheme for new call numbers: 1 = Generic; 2 = Dewey; 3 = LC|Number|It has effect on call number sorting.
|Default copy status (fast add)|Default status when a copy is created using the "Fast Item Add" interface.|Selection list|Default: In process
|Default copy status (normal)|Default status when a copy is created using the normal volume/copy creator interface.|Selection list|
|Defines the control number identifier used in 003 and 035 fields||Text|
|Delete bib if all copies are deleted via Acquisitions line item cancellation.||True/False|
|Delete volume with last copy|Automatically delete a volume when the last linked copy is deleted.|True/False|Default TRUE
|Maximum Parallel Z39.50 Batch Searches|The maximum number of Z39.50 searches that can be in-flight at any given time when performing batch Z39.50 searches|Number|
|Maximum Z39.50 Batch Search Results|The maximum number of search results to retrieve and queue for each record + Z39 source during batch Z39.50 searches|Number|
|Spine and pocket label font family|Set the preferred font family for spine and pocket labels. You can specify a list of fonts, separated by commas, in order of preference; the system will use the first font it finds with a matching name. For example, "Arial, Helvetica, serif".|Text|
|Spine and pocket label font size|Set the default font size for spine and pocket labels|Number|
|Spine and pocket label font weight|Set the preferred font weight for spine and pocket labels. You can specify "normal", "bold", "bolder", or "lighter".|Text|
|Spine label left margin|Set the left margin for spine labels in number of characters.|Number|
|Spine label line width|Set the default line width for spine labels in number of characters. This specifies the boundary at which lines must be wrapped.|Number|
|Spine label maximum lines|Set the default maximum number of lines for spine labels.|Number|
|======================

((("Circulation", "Library Settings Editor")))

[[lse-circulation]]
.Circulation
[options="header"]
|===========
|Setting|Description|Data type|Notes
|Auto-extend grace periods|When enabled grace periods will auto-extend. By default this will be only when they are a full day or more and end on a closed date, though other options can alter this.|True/False|
|Auto-extending grace periods extend for all closed dates|It works when the above setting "Auto-Extend Grace Periods" is set to TRUE. If enabled, when the grace period falls on a closed date(s), it will be extended past all closed dates that intersect, but within the hard-coded limits (your library's grace period).|True/False|
|Auto-extending grace periods include trailing closed dates|It works when the above setting "Auto-Extend Grace Periods" is set to TRUE. If enabled, grace periods will include closed dates that directly follow the last day of the grace period. A backdated check-in with effective date on the closed dates will assume the item is returned after hours on the last day of the grace period.|True/False|Useful when libraries' book drop equipped with AMH.
|Block hold request if hold recipient privileges have expired||True/False|
|Cap max fine at item price|This prevents the system from charging more than the item price in overdue fines|True/False|
|Charge fines on overdue circulations when closed|When set to True, fines will be charged during scheduled closings and normal weekly closed days.|True/False|
|Checkout fills related hold|When a patron checks out an item and they have no holds that directly target the item, the system will attempt to find a hold for the patron that could be fulfilled by the checked out item and fulfills it. On the Staff Client you may notice that when a patron checks out an item under a title on which he/she has a hold, the hold will be treated as filled though the item has not been assigned to the patron's hold.|True/false|
|Checkout fills related hold on valid copy only|When filling related holds on checkout only match on items that are valid for opportunistic capture for the hold. Without this set a Title or Volume hold could match when the item is not holdable. With this set only holdable items will match.|True/False|
|Checkout auto renew age|When an item has been checked out for at least this amount of time, an attempt to check out the item to the patron that it is already checked out to will simply renew the circulation. If the checkout attempt is done within this time frame, Evergreen will prompt for choosing Renewing or Check-in then Checkout the item.|Duration|
|Do not change fines/fees on zero-balance LOST transaction|When an item has been marked lost and all fines/fees have been completely paid on the transaction, do not void or reinstate any fines/fees EVEN IF "Void lost item billing when returned" and/or "Void processing fee on lost item return" are enabled|True/False|
|Do not include outstanding Claims Returned circulations in lump sum tallies in Patron Display.|In the Patron Display interface, the number of total active circulations for a given patron is presented in the Summary sidebar and underneath the Items Out navigation button. This setting will prevent Claims Returned circulations from counting toward these tallies.|True/False|
|Hold shelf status delay|The purpose is to provide an interval of time after an item goes into the on-holds-shelf status before it appears to patrons that it is actually on the holds shelf. This gives staff time to process the item before it shows as ready-for-pick-up.|Duration|
|Include Lost circulations in lump sum tallies in Patron Display.|In the Patron Display interface, the number of total active circulations for a given patron is presented in the Summary sidebar and underneath the Items Out navigation button. This setting will include Lost circulations as counting toward these tallies.|True/False|
|Invalid patron address penalty|When set, if a patron address is set to invalid, a penalty is applied.|True/False|
|Item status for missing pieces|This is the Item Status to use for items that have been marked or scanned as having Missing Pieces. In the absence of this setting, the Damaged status is used.|Selection list|
|Load patron from Checkout|When scanning barcodes into Checkout auto-detect if a new patron barcode is scanned and auto-load the new patron.|True/False|
|Long-Overdue Check-In Interval Uses Last Activity Date|Use the long-overdue last-activity date instead of the due_date to determine whether the item has been checked out too long to perform long-overdue check-in processing. If set, the system will first check the last payment time, followed by the last billing time, followed by the due date. See also "Long-Overdue Max Return Interval"|True/False|
|Long-Overdue Items Usable on Checkin|Long-overdue items are usable on checkin instead of going "home" first|True/False|
|Long-Overdue Max Return Interval|Long-overdue check-in processing (voiding fees, re-instating overdues, etc.) will not take place for items that have been overdue for (or have last activity older than) this amount of time|Duration|
|Lost check-in generates new overdues|Enabling this setting causes retroactive creation of not-yet-existing overdue fines on lost item check-in, up to the point of check-in time (or max fines is reached). This is different than "restore overdue on lost", because it only creates new overdue fines. Use both settings together to get the full complement of overdue fines for a lost item|True/False|
|Lost items usable on checkin|Lost items are usable on checkin instead of going 'home' first|True/false|
|Max patron claims returned count|When this count is exceeded, a staff override is required to mark the item as claims returned.|Number|
|Maximum visible age of User Trigger Events in Staff Interfaces|If this is unset, staff can view User Trigger Events regardless of age. When this is set to an interval, it represents the age of the oldest possible User Trigger Event that can be viewed.|Duration|
|Minimum transit checkin interval|In-Transit items checked in this close to the transit start time will be prevented from checking in|Duration|
|Patron merge address delete|Delete address(es) of subordinate user(s) in a patron merge.|True/False|
|Patron merge barcode delete|Delete barcode(s) of subordinate user(s) in a patron merge|True/False|
|Patron merge deactivate card|Mark barcode(s) of subordinate user(s) in a patron merge as inactive.|True/False|
|Patron Registration: Cloned patrons get address copy|If True, in the Patron editor, addresses are copied from the cloned user. If False, addresses are linked from the cloned user which can only be edited from the cloned user record.|True/False|
|Printing: custom JavaScript file|Full URL path to a JavaScript File to be loaded when printing. Should implement a print_custom function for DOM manipulation. Can change the value of the do_print variable to false to cancel printing.|Text|
|Require matching email address for password reset requests||True/False|
|Restore Overdues on Long-Overdue Item Return||True/False|
|Restore overdues on lost item return|If true when a lost item is checked in overdue fines are charged (up to the maximum fines amount)|True/False|
|Specify search depth for the duplicate patron check in the patron editor|When using the patron registration page, the duplicate patron check will use the configured depth to scope the search for duplicate patrons.|Number|
|Suppress hold transits group|To create a group of libraries to suppress Hold Transits among them. All libraries in the group should use the same unique value. Leave it empty if transits should not be suppressed.|Text|
|Suppress non-hold transits group|To create a group of libraries to suppress Non-Hold Transits among them. All libraries in the group should use the same unique value. Leave it empty if Non-Hold Transits should not be suppressed.|Text|
|Suppress popup-dialogs during check-in.|When set to True, no pop-up window for exceptions on check-in. But the accompanying sound will be played.|True/False|
|Target copies for a hold even if copy's circ lib is closed|If this setting is true at a given org unit or one of its ancestors, the hold targeter will target copies from this org unit even if the org unit is closed (according to the Org Unit's closed dates.).|True/False|Set the value to True if you want to target copies for holds at closed circulating libraries. Set the value to False, or leave it unset, if you do not want to enable this feature.
|Target copies for a hold even if copy's circ lib is closed IF the circ lib is the hold's pickup lib|If this setting is true at a given org unit or one of its ancestors, the hold targeter will target copies from this org unit even if the org unit is closed (according to the Org Unit's closed dates) IF AND ONLY IF the copy's circ lib is the same as the hold's pickup lib.|True/False| Set the value to True if you want to target copies for holds at closed circulating libraries when the circulating library of the item and the pickup library of the hold are the same. Set the value to False, or leave it unset, if you do not want to enable this feature.
|Truncate fines to max fine amount||True/False|Default:TRUE
|Use Lost and Paid copy status|Use Lost and Paid copy status when lost or long overdue billing is paid|True/False|
|Void Long-Overdue Item Billing When Returned||True/False|
|Void Processing Fee on Long-Overdue Item Return||True/False|
|Void longoverdue item billing when claims returned||True/False|
|Void longoverdue item processing fee when claims returned||True/False|
|Void lost item billing when claims returned||True/False|
|Void lost item billing when returned|If true,when a lost item is checked in the item replacement bill (item price) is voided.|True/False|
|Void lost item processing fee when claims returned|When an item is marked claims returned that was marked Lost, the item processing fee will be voided.|True/False|
|Void lost max interval|Items that have been overdue this long will not result in lost charges being voided when returned, and the overdue fines will not be restored, either. Only applies if *Circ: Void lost item billing* or *Circ: Void processing fee on lost item* are true.|Duration|
|Void processing fee on lost item return|Void processing fee when lost item returned|True/False|
|Warn when patron account is about to expire|If set, the staff client displays a warning this number of days before the expiry of a patron account. Value is in number of days.|Duration|
|===========

((("Credit Card Processing", "Library Settings Editor")))

[[lse-credit-cards]]
.Credit Card Processing
[options="header"]
|======================
|Setting|Description|Data type|Notes
|AuthorizeNet login|Authorize.Net Username|Text|Obtain from Authorize.Net at http://www.authorize.net
|AuthorizeNet password|Authorize.Net Password|Text|Obtain from Authorize.Net
|AuthorizeNet server|Required if using a developer/test account with Authorize.Net.|Text|Enter the server name from Authorize.Net. This is for use on test or developer account. If using live, leave blank.
|AuthorizeNet test mode|Places Authorize.Net transactions in Test Mode|True/False|
|Enable AuthorizeNet payments|This actually enables use of Authorize.Net|True/False|
|Enable PayPal payments|This will enable use of PayPal payments through the staff client.|True/False|
|Enable PayflowPro payments|This will enable the use of PayPal's Payflow Pro. This is not the same is PayPal.|True/False|
|Enable Stripe payments|This will enable the use of the stripe credit card processing.|True/False|https://stripe.com
|Name default credit processor|This might be "AuthorizeNet", "PayPal", "PayflowPro", or "Stripe".|Text|This sets the company that you will use to process the credit cards.
|PayPal login|Enter the PayPal login Username|Text|Obtain from PayPal
|PayPal password|Enter the PayPal password.|Text|Obtain from PayPal.
|PayPal signature|HASH Signature for PayPal|Text|Enter the HASH obtained from PayPal.
|PayPal test mode|Places the PayPal credit card payments in test mode.|True/False|This sends the transactions to PayPal's development.paypal.com server for testing only.
|PayflowPro login/merchant ID|Enter the PayflowPro Merchant ID|Text|Obtain from Payflow Pro Partner.
|PayflowPro partner|Enter the Partner ID from your Payflow Partner|Text|This will obtained from your Payflow Pro partner. This can be "PayPal" or "VeriSign", sometimes others.
|PayflowPro password|Password for PayflowPro|Text|Obtain from Payflow Pro Partner
|PayflowPro test mode|Place Payflow Pro in test mode.|True/False|Do not really process transactions, but stay in test mode - uses pilot-payflowpro.paypal.com instead of the usual host.
|PayflowPro vendor|Currently the same as the Payflow Pro login.|Text|Obtain from Payflow Pro partner.
|Stripe publishable key|Publishable API Key from stripe.|Text|
|Stripe secret key|Secret API key from stripe.|Text|
|======================

((("Finances", "Library Settings Editor")))

[[lse-finances]]
.Finances
[options="header"]
|========
|Setting|Description|Data type|Notes
|Allow credit card payments|If enabled, patrons will be able to pay fines accrued at this location via credit card.|True/False|
|Charge item price when marked damaged|If true Evergreen bills item price to the last patron who checked out the damaged item. Staff receive an alert with patron information and must confirm the billing.| True/false|
|Charge lost on zero|If set to True, default item price will be charged when an item is marked lost even though the price in item record is 0.00 (same as no price). If False, only processing fee, if used, will be charged.|True/false|
|Charge processing fee for damaged items|Optional processing fee billed to last patron who checked out the damaged item. Staff receive an alert with patron information and must confirm the billing.|Number(Dollar)| Disabled when set to 0
|Default item price|Replacement charge for lost items if price is unset in the *Copy Editor*. Does not apply if item price is set to $0|Number(dollars)|
|Disable Patron Credit|Do not allow patrons to accrue credit or pay fines/fees with accrued credit|True/False|
|Leave transaction open when long overdue balance equals zero|Leave transaction open when long-overdue balance equals zero. This leaves the lost copy on the patron record when it is paid|True/False|
|Leave transaction open when lost balance equals zero|Leave transaction open when lost balance equals zero. This leaves the lost copy on the patron record when it is paid|True/False|
|Long-Overdue Materials Processing Fee|The amount charged in addition to item price when an item is marked Long-Overdue|Number|Currency
|Lost materials processing fee|The amount charged in addition to item price when an item is marked lost.| Number|Currency
|Maximum Item Price|When charging for lost items, limit the charge to this as a maximum.|Number|Currency
|Minimum Item Price|When charging for lost items, charge this amount as a minimum.|Number|Currency
|Negative Balance Interval (DEFAULT)|Amount of time after which no negative balances (refunds) are allowed on circulation bills. The "Prohibit negative balance on bills" setting must also be set to "true".|Duration|
|Negative Balance Interval for Lost|Amount of time after which no negative balances (refunds) are allowed on bills for lost/long overdue materials. The "Prohibit negative balance on bills for lost materials" setting must also be set to "true".|Duration|
|Negative Balance Interval for Overdues|Amount of time after which no negative balances (refunds) are allowed on bills for overdue materials. The "Prohibit negative balance on bills for overdue materials" setting must also be set to "true".|Duration|
|Prohibit negative balance on bills (Default)|Default setting to prevent negative balances (refunds) on circulation related bills. Set to "true" to prohibit negative balances at all times or, when used in conjunction with an interval setting, to prohibit negative balances after a set period of time.|True/False|
|Prohibit negative balance on bills for lost materials|Prevent negative balances (refunds) on bills for lost/long overdue materials. Set to "true" to prohibit negative balances at all times or, when used in conjunction with an interval setting, to prohibit negative balances after an interval of time.|True/False|
|Prohibit negative balance on bills for overdue materials|Prevent negative balances (refunds) on bills for lost/long overdue materials. Set to "true" to prohibit negative balances at all times or, when used in conjunction with an interval setting, to prohibit negative balances after an interval of time.|True/False|
|Void Overdue Fines When Items are Marked Long-Overdue|If true overdue fines are voided when an item is marked Long-Overdue|True/False|
|Void overdue fines when items are marked lost|If true overdue fines are voided when an item is marked lost|True/False|
|========

((("GUI", "Library Settings Editor")))
((("Graphic User Interface", "Library Settings Editor")))
((("Patron Registration Settings", "Library Settings Editor")))

[[lse-gui]]
.GUI: Graphic User Interface
[options="header",separator="!"]
!===========================
!Setting!Description!Data type!Notes
!Alert on empty bib records!Alert staff when the last copy for a record is being deleted.!True/False!
!Button bar!If TRUE, the staff client button bar appears by default on all workstations registered to your library; staff can override this setting at each login.!True/False!
!Cap results in Patron Search at this number.!The maximum number of results returned per search. If 100 is set up here, any search will return 100 records at most.!Number!
!Default Country for New Addresses in Patron Editor!This is the default Country for new addresses in the patron editor.!Text!
!Default hotkeyset!Default Hotkeyset for clients (filename without the .keyset). Examples: Default, Minimal, and None!Text!Individual workstations' default overrides this setting.
!Default ident type for patron registration!This is the default Ident Type for new users in the patron editor.!Selection list!
!Default showing suggested patron registration fields!Instead of All fields, show just suggested fields in patron registration by default.!True/False!
!Disable the ability to save list column configurations locally.!GUI: Disable the ability to save list column configurations locally. If set, columns may still be manipulated, however, the changes do not persist. Also, existing local configurations are ignored if this setting is true.!True/False!
!Example for Day_phone field on patron registration!The example on validation on the Day_phone field in patron registration.!Text!
!Example for Email field on patron registration!The example on validation on the Email field in patron  registration.!Text!
!Example for Evening-phone on patron registration!The example on validation on the Evening-phone field in patron registration.!Text!
!Example for Other-phone on patron registration!The example on validation on the Other-phone field in patron registration.!Text!
!Example for phone fields on patron registration!The example on validation on phone fields in patron registration. Applies to all phone fields without their own setting.!Text!
!Example for Postal Code field on patron registration!The example on validation on the Postal Code field in patron registration.!Text!
!Format Dates with this pattern.!Format Dates with this pattern (examples: "yyyy-MM-dd" for "2010-04-26, "MMM d, yyyy" for "Apr 26, 2010"). Formats are effective in display (not editing) area.!Text!
!Format Times with this pattern.!Format Times with this pattern '(examples: "h:m:s.SSS a z" for "2:07:20.666 PM Eastern Daylight Time", "HH:mm" for "14:07")'. Formats are effective in display (not editing) area.!Text!
!GUI: Hide these fields within the Item Attribute Editor.!Sets which fields in the Item Attribute Editor to hide in the staff client.!Text!This is useful to hide attributes that are not used.
!Horizontal layout for Volume/Copy Creator/Editor.!The main entry point for this interface is in Holdings Maintenance, Actions for Selected Rows, Edit Item Attributes / Call Numbers / Replace Barcodes. This setting changes the top and bottom panes (if FALSE) for that interface into left and right panes (if TRUE).!True/False!
!Idle timeout!If you want staff client windows to be minimized after a certain amount of system idle time, set this to the number of seconds of idle time that you want to allow before minimizing (requires staff client restart).!Number!
!Items Out Claims Returned display setting!Value is a numeric code, describing which list the circulation should appear while checked out and whether the circulation should continue to appear in the bottom list, when checked in with outstanding fines. 1 = top list, bottom list. 2 = bottom list, bottom list. 5 = top list, do not display. 6 = bottom list, do not display.!Number!
!Items Out Long-Overdue display setting!Value is a numeric code, describing which list the circulation should appear while checked out and whether the circulation should continue to appear in the bottom list, when checked in with outstanding fines. 1 = top list, bottom list. 2 = bottom list, bottom list. 5 = top list, do not display. 6 = bottom list, do not display.!Number!
!Items Out Lost display setting!Value is a numeric code, describing which list the circulation should appear while checked out and whether the circulation should continue to appear in the bottom list, when checked in with outstanding fines. 1 = top list, bottom list. 2 = bottom list, bottom list. 5 = top list, do not display. 6 = bottom list, do not display.!Number!
!Max user activity entries to retrieve (staff client)!Sets the maximum number of recent user activity entries to retrieve for display in the staff client.!Number!
!Maximum previous checkouts displayed! The maximum number of previous circulations the staff client will display when investigating item details!Number!
!Patron circulation summary is horizontal!!True/False!
!Record in-house use: # of uses threshold for Are You Sure? dialog.!In the Record In-House Use interface, a submission attempt will warn if the # of uses field exceeds the value of this setting.!Number!
!Record In-House Use: Maximum # of uses allowed per entry.!The # of uses entry in the Record In-House Use interface may not exceed the value of this setting.!Number!
!Regex for barcodes on patron registration!The Regular Expression for validation on barcodes in patron registration.!Regular Expression!
!Regex for Day_phone field on patron registration! The Regular Expression for validation on the Day_phone field in patron registration. Note: The first capture group will be used for the "last 4 digits of phone number" as patron password feature, if enabled. Ex: "[2-9]\d{2}-\d{3}-(\d{4})( x\d+)?" will ignore the extension on a NANP number.!Regular expression!
!Regex for Email field on patron registration!The Regular Expression on validation on the Email field in patron registration.!Regular expression!
!Regex for Evening-phone on patron registration!The Regular Expression on validation on the Evening-phone field in patron registration.!Regular expression!
!Regex for Other-phone on patron registration!The Regular Expression on validation on the Other-phone field in patron registration.!Regular expression!
!Regex for phone fields on patron registration!The Regular Expression on validation on phone fields in patron registration. Applies to all phone fields without their own setting.!Regular expression!`^(?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?([0-9]{4})(?:\s*(?:#|x\.?|ext\.?|extension)\s*(\d+))?$` is a US phone number
!Regex for Postal Code field on patron registration!The Regular Expression on validation on the Postal Code field in patron registration.!Regular expression!
!Require at least one address for Patron Registration!Enforces a requirement for having at least one address for a patron during registration. If set to False, you need to delete the empty address before saving the record. If set to True, deletion is not allowed.!True/False!
!Require XXXXX field on patron registration!The XXXXX field will be required on the patron registration screen.!True/False!XXXXX can be Country, State, Day-phone, Evening-phone, Other-phone, DOB, Email, or Prefix.
!Require staff initials for entry/edit of patron standing penalties and messages.!Appends staff initials and edit date into patron standing penalties and messages.!True/False!
!Require staff initials for entry/edit of patron notes.!Appends staff initials and edit date into patron note content.!True/False!
!Require staff initials for entry/edit of copy notes.!Appends staff initials and edit date into copy note content.!True/False!
!Show billing tab first when bills are present!If true accounts for patrons with bills will open to the billing tab instead of check out!True/false!
!Show XXXXX field on patron registration!The XXXXX field will be shown on the patron registration screen. Showing a field makes it appear with required fields even when not required. If the field is required this setting is ignored.!True/False!
!Suggest XXXXX field on patron registration!The XXXXX field will be suggested on the patron registration screen. Suggesting a field makes it appear when suggested fields are shown. If the field is shown or required this setting is ignored.!True/False!
!Toggle off the patron summary sidebar after first view.!When true, the patron summary sidebar will collapse after a new patron sub-interface is selected.!True/False!
!URL for remote directory containing list column settings.!The format and naming convention for the files found in this directory match those in the local settings directory for a given workstation. An administrator could create the desired settings locally and then copy all the tree_columns_for_* files to the remote directory.!Text!
!Uncheck bills by default in the patron billing interface!Uncheck bills by default in the patron billing interface, and focus on the Uncheck All button instead of the Payment Received field.!True/False!
!Unified Volume/Item Creator/Editor!If True, combines the Volume/Copy Creator and Item Attribute Editor in some instances.!True/False!
!Work Log: maximum actions logged!Maximum entries for "Most Recent Staff Actions" section of the Work Log interface.!Number!
!Work Log: maximum patrons logged!Maximum entries for "Most Recently Affected Patrons..." section of the Work Log interface.!Number!
!===========================

((("Global", "Library Settings Editor")))

[[lse-global]]
.Global
[options="header"]
|======
|Setting|Description|Data type|Notes
|Allow multiple username changes|If enabled (and Lock Usernames is not set) patrons will be allowed to change their username when it does not look like a barcode. Otherwise username changing in the OPAC will only be allowed when the patron's username looks like a barcode.|True/False|Default TRUE.
|Global default locale||Number|
|Lock Usernames|If enabled username changing via the OPAC will be disabled.|Default FALSE|
|Password format|Defines acceptable format for OPAC account passwords|Regular expression|Default requires that passwords "be at least 7 characters in length,contain at least one letter (a-z/A-Z), and contain at least one number.
|Patron barcode format|Defines acceptable format for patron barcodes|Regular expression|
|Patron username format|Regular expression defining the patron username format, used for patron registration and self-service username changing only|Regular expression|
|======

((("Holds", "Library Settings Editor")))

[[lse-holds]]
.Holds
[options="header"]
|=====
|Setting|Description|Data type|Notes
|Behind desk pickup supported|If a branch supports both a public holds shelf and behind-the-desk pickups, set this value to true. This gives the patron the option to enable behind-the-desk pickups for their holds by selecting Hold is behind Circ Desk flag in patron record.|True/False|
|Best-hold selection sort order|Defines the sort order of holds when selecting a hold to fill using a given copy at capture time|Selection list|
|Block renewal of items needed for holds|When an item could fulfill a hold, do not allow the current patron to renew|True/False|
|Cancelled holds display age|Show all cancelled holds that were cancelled within this amount of time|Duration|
|Cancelled holds display count|How many cancelled holds to show in patron holds interfaces|Number|
|Clear shelf copy status|Any copies that have not been put into reshelving, in-transit, or on-holds-shelf (for a new hold) during the clear shelf process will be put into this status. This is basically a purgatory status for copies waiting to be pulled from the shelf and processed by hand|Selection list|
|Default estimated wait|When predicting the amount of time a patron will be waiting for a hold to be fulfilled, this is the default estimated length of time to assume an item will be checked out.|Duration|
|Default hold shelf expire interval|Hold Shelf Expiry Time is calculated and inserted into hold record based on this interval when capturing a hold.|Duration|
|Expire alert interval|Time before a hold expires at which to send an email notifying the patron|Duration|
|Expire interval|Amount of time until an unfulfilled hold expires|Duration|
|FIFO|Force holds to a more strict First-In, First-Out capture. Default is SAVE-GAS, which gives priority to holds with pickup location the same as checkin library.|True/False|Applies only to multi-branch libraries. Default is SAVE-GAS.
|Hard boundary||Number|
|Hard stalling interval||Duration|
|Has local copy alert|If there is an available copy at the requesting library that could fulfill a hold during hold placement time, alert the patron.|True/False|
|Has local copy block|If there is an available copy at the requesting library that could fulfill a hold during hold placement time, do not allow the hold to be placed.|True/False|
|Max foreign-circulation time|Time a copy can spend circulating away from its circ lib before returning there to fill a hold|Duration|For multi-branch libraries.
|Maximum library target attempts|When this value is set and greater than 0, the system will only attempt to find a copy at each possible branch the configured number of times|Number|For multi-branch libraries.
|Minimum estimated wait|When predicting the amount of time a patron will be waiting for a hold to be fulfilled, this is the minimum estimated length of time to assume an item will be checked out.|Duration |
|Org unit target weight|Org Units can be organized into hold target groups based on a weight. Potential copies from org units with the same weight are chosen at random.|Number|
|Reset request time on un-cancel|When a hold is uncancelled, reset the request time to push it to the end of the queue|True/False|
|Skip for hold targeting|When true, don't target any copies at this org unit for holds|True/False|
|Soft boundary|Holds will not be filled by copies outside this boundary if there are holdable copies within it.|Number |
|Soft stalling interval|For this amount of time, holds will not be opportunistically captured at non-pickup branches.|Duration|
For multiple branch libraries
|Use Active Date for age protection|When calculating age protection rules use the Active date instead of the Creation Date.|True/False|Default TRUE
|Use weight-based hold targeting|Use library weight based hold targeting|True/False|
|=====

((("Library", "Library Settings Editor")))

[[lse-library]]
.Library
[options="header"]
|=======
|Setting|Description|Data type|Notes
|Change reshelving status interval|Amount of time to wait before changing an item from “Reshelving” status to “available”|Duration|
The default is at midnight each night for items with "Reshelving" status for over 24 hours.
|Claim never checked out: mark copy as missing|When a circ is marked as claims-never-checked-out, mark the copy as missing|True/False|
|Claim return copy status|Claims returned copies are put into this status. Default is to leave the copy in the Checked Out status|Selection list|
|Courier code|Courier Code for the library. Available in transit slip templates as the %courier_code% macro.|Text|
|Juvenile age threshold|Upper cut-off age for patrons to be considered juvenile, calculated from date of birth in patron accounts|Duration  (years)|
|Library information URL (such as "http://example.com/about.html")|URL for information on this library, such as contact information, hours of operation, and directions. Use a complete URL, such as "http://example.com/hours.html".|Text|
|Mark item damaged voids overdues|When an item is marked damaged, overdue fines on the most recent circulation are voided.|True/False|
|Pre-cat item circ lib|Override the default circ lib of "here" with a pre-configured circ lib for pre-cat items. The value should be the "shortname" (aka policy name) of the org unit|Text |
|Telephony: Arbitrary line(s) to include in each notice callfile|This overrides lines from opensrf.xml. Line(s) must be valid for your target server and platform (e.g. Asterisk 1.4).|Text|
|=======

((("OPAC", "Library Settings Editor")))

[[lse-opac]]
.OPAC
[options="header"]
|====
|Setting|Description|Data type|Notes
|Allow Patron Self-Registration|Allow patrons to self-register, creating pending user accounts|True/False|
|Allow pending addresses|If true patrons can edit their addresses in the OPAC. Changes must be approved by staff|True/False|
|Auto-Override Permitted Hold Blocks (Patrons)|This will allow patrons with the permission "HOLD_ITEM_CHECKED_OUT.override" to automatically override permitted holds.|True/False|When a patron places a hold in the OPAC that fails, and the patron has the permission to override the failed hold, this automatically overrides the failed hold rather than requiring the patron to manually override the hold. Default is False.
|Jump to details on 1 hit (OPAC)|When a search yields only 1 result, jump directly to the record details page. This setting only affects the public OPAC|True/False|
|Jump to details on 1 hit (staff client)|When a search yields only 1 result, jump directly to the record details page. This setting only affects the PAC within the staff client|True/False|
|OPAC: Number of staff client saved searches to display on left side of results and record details pages|If unset, the OPAC (only when wrapped in the staff client!) will default to showing you your ten most recent searches on the left side of the results and record details pages. If you actually don't want to see this feature at all, set this value to zero at the top of your organizational tree.|Number|
|OPAC: Org Unit is not a hold pickup library|If set, this org unit will not be offered to the patron as an option for a hold pickup location. This setting has no affect on searching or hold targeting.|True/False|
|Org unit hiding depth|This will hide certain org units in the public OPAC if the Original Location (url param "ol") for the OPAC inherits this setting. This setting specifies an org unit depth, that together with the OPAC Original Location determines which section of the Org Hierarchy should be visible in the OPAC. For example, a stock Evergreen installation will have a 3-tier hierarchy (Consortium/System/Branch), where System has a depth of 1 and Branch has a depth of 2. If this setting contains a depth of 1 in such an installation, then every library in the System in which the Original Location belongs will be visible, and everything else will be hidden. A depth of 0 will effectively make every org visible. The embedded OPAC in the staff client ignores this setting.|Number|
|Paging shortcut links for OPAC Browse|The characters in this string, in order, will be used as shortcut links for quick paging in the OPAC browse interface. Any sequence surrounded by asterisks will be taken as a whole label, not split into individual labels at the character level, but only the first character will serve as the basis of the search.|Text|
|Patron Self-Reg. Display Timeout|Number of seconds to wait before reloading the patron self-registration interface to clear sensitive data|Duration|
|Patron Self-Reg. Expire Interval|If set, this is the amount of time a pending user account will be allowed to sit in the database. After this time, the pending user information will be purged|Duration|
|Payment history age limit|The OPAC should not display payments by patrons that are older than any interval defined here.|Duration|
|Tag Circulated Items in Results|When a user is both logged in and has opted in to circulation history tracking, turning on this setting will cause previous (or currently) circulated items to be highlighted in search results|True/False|
|Tag Circulated Items in Results|When a user is both logged in and has opted in to circulation history tracking, turning on this setting will cause previous (or currently) circulated items to be highlighted in search results.|True/False|Default TRUE
|Use fully compressed serial holdings|Show fully compressed serial holdings for all libraries at and below the current context unit|True/False|
|Warn patrons when adding to a temporary book list|Present a warning dialogue when a patron adds a book to the temporary book list.|True/False|
|====

((("Offline", "Library Settings Editor")))
((("Program", "Library Settings Editor")))

[[lse-offline]]
.Offline and Program
[options="header"]
|===================
|Setting|Description|Data type|Notes
|Skip offline checkin if newer item Status Changed Time.|Skip offline checkin transaction (raise exception when processing) if item Status Changed Time is newer than the recorded transaction time. WARNING: The Reshelving to Available status rollover will trigger this.|True/False|
|Skip offline checkout if newer item Status Changed Time.|Skip offline checkout transaction (raise exception when processing) if item Status Changed Time is newer than the recorded transaction time. WARNING: The Reshelving to Available status rollover will trigger this.|True/False|
|Skip offline renewal if newer item Status Changed Time.|Skip offline renewal transaction (raise exception when processing) if item Status Changed Time is newer than the recorded transaction time. WARNING: The Reshelving to Available status rollover will trigger this.|True/False|
|Disable automatic print attempt type list|Disable automatic print attempts from staff client interfaces for the receipt types in this list. Possible values: "Checkout", "Bill Pay", "Hold Slip", "Transit Slip", and "Hold/Transit Slip". This is different from the Auto-Print checkbox in the pertinent interfaces in that it disables automatic print attempts altogether, rather than encouraging silent printing by suppressing the print dialogue. The Auto-Print checkbox in these interfaces have no effect on the behavior for this setting. In the case of the Hold, Transit, and Hold/Transit slips, this also suppresses the alert dialogues that precede the print dialogue (the ones that offer Print and Do Not Print as options).|Text|
|Retain empty bib records|Retain a bib record even when all attached copies are deleted|True/False|
|Sending email address for patron notices|This email address is for automatically generated patron notices (e.g. email overdues, email holds notification).  It is good practice to set up a generic account, like info@nameofyourlibrary.org, so that one person’s individual email inbox doesn’t get cluttered with emails that were not delivered.|Text|
|===================

((("Receipt Templates", "Library Settings Editor")))
((("SMS Settings", "Library Settings Editor")))
((("Text Messaging", "Library Settings Editor")))

[[lse-receipt]]
.Receipt Templates and SMS Text Message
[options="header"]
|======================================
|Setting|Description|Data type|Notes
|Content of alert_text include|Text/HTML/Macros to be inserted into receipt templates in place of %INCLUDE(alert_text)%|Text|
|Content of event_text include|Text/HTML/Macros to be inserted into receipt templates in place of %INCLUDE(event_text)%|Text|
|Content of footer_text include|Text/HTML/Macros to be inserted into receipt templates in place of %INCLUDE(footer_text)%|Text|
|Content of header_text include|Text/HTML/Macros to be inserted into receipt templates in place of %INCLUDE(header_text)%|Text|
|Content of notice_text include|Text/HTML/Macros to be inserted into receipt templates in place of %INCLUDE(notice_text)%|Text|
|Disable auth requirement for texting call numbers.|Disable authentication requirement for sending call number information via SMS from the OPAC.|True/False|
|Enable features that send SMS text messages.|Current features that use SMS include hold-ready-for-pickup notifications and a "Send Text" action for call numbers in the OPAC. If this setting is not enabled, the SMS options will not be offered to the user. Unless you are carefully silo-ing patrons and their use of the OPAC, the context org for this setting should be the top org in the org hierarchy, otherwise patrons can trample their user settings when jumping between orgs.|True/False|
|======================================

((("Security", "Library Settings Editor")))

[[lse-security]]
.Security
[options="header"]
|========
|Setting|Description|Data type|Notes
|Default level of patrons' internet access|Enter numbers 1 (Filtered), 2 (Unfiltered), or 3 (No Access)|Number|
|Maximum concurrently active self-serve password reset requests|Prevent the creation of new self-serve password reset requests until the number of active requests drops back below this number.|Number|
|Maximum concurrently active self-serve password reset requests per user|When a user has more than this number of concurrently active self-serve password reset requests for their account, prevent the user from creating any new self-serve password reset requests until the number of active requests for the user drops back below this number.|Number|
|OPAC Inactivity Timeout (in seconds)|Number of seconds of inactivity before OPAC accounts are automatically logged out.|Number|
|Obscure the Date of Birth field|When true, the Date of Birth column in patron lists will default to Not Visible, and in the Patron Summary sidebar the value will display as unless the field label is clicked.|True/False|
|Offline: Patron usernames allowed|During offline circulations, allow patrons to identify themselves with
usernames in addition to barcode. For this setting to work, a barcode format must also be defined|True/False|
|Patron opt-in boundary|This determines at which depth above which patrons must be opted in, and below which patrons will be assumed to be opted in.|Text|
|Patron opt-in default|This is the default depth at which a patron is opted in; it is calculated as an org unit relative to the current workstation.|Text|
|Patron: password from phone #|If true the last 4 digits of the patron's phone number is the password for new accounts (password must still be changed at first OPAC login)|True/false|
|Persistent login duration|How long a persistent login lasts, e.g. '2 weeks'|Duration|
|Self-serve password reset request time-to-live|Length of time (in seconds) a self-serve password reset request should remain active.|Duration|
|Staff login inactivity timeout (in seconds)|Number of seconds of inactivity before staff client prompts for login and password.|Number|
|========

((("Self Check", "Library Settings Editor")))

[[lse-selfcheck]]
.Self Check and Others
[options="header"]
|=====================
|Setting|Description|Data type|Notes
|Audio Alerts|Use audio alerts for selfcheck events.|True/false|
|Block copy checkout status|List of copy status IDs that will block checkout even if the generic COPY_NOT_AVAILABLE event is overridden.|Number|Look up copy status ID from Server Admin.
|Patron login timeout (in seconds)|Number of seconds of inactivity before the patron is logged out of the selfcheck interface.|Duration|
|Pop-up alert for errors|If true, checkout/renewal errors will cause a pop-up window in addition to the on-screen message.|True/False|
|Require Patron Password|If true, patrons will be required to enter their password in addition to their username/barcode to log into the selfcheck interface.|True/False|This replaced "Require patron password"
|Require patron password||True/False|This was replaced by "Require Patron Password" and is currently invalid.
|Selfcheck override events list|List of checkout/renewal events that the selfcheck interface should automatically override instead instead of alerting and stopping the transaction.|Text|
|Workstation Required|All selfcheck stations must use a workstation.|True/False|
|Default display grouping for serials distributions presented in the OPAC.|Default display grouping for serials distributions presented in the OPAC. This can be "enum" or "chron".|Text|
|Previous issuance copy location|When a serial issuance is received, copies (units) of the previous issuance will be automatically moved into the configured shelving location.|Selection List|
|Maximum redirect lookups|For URLs returning 3XX redirects, this is the maximum number of redirects we will follow before giving up.|Number|
|Maximum wait time (in seconds) for a URL to lookup|If we exceed the wait time, the URL is marked as a "timeout" and the system moves on to the next URL|Duration|
|Number of URLs to test in parallel|URLs are tested in batches. This number defines the size of each batch and it directly relates to the number of back-end processes performing URL verification.|Number|
|Number of seconds to wait between URL test attempts|Throttling mechanism for batch URL verification runs. Each running process will wait this number of seconds after a URL test before performing the next.|Duration|
|=====================

((("Vandelay", "Library Settings Editor")))

[[lse-vandelay]]
.Vandelay
[options="header"]
|========
|Setting|Description|Data type|Notes
|Default Record Match Set|Sets the Default Record Match set |Selection List|Populated by the Vandelay Record Match Sets
|Vandelay Default Barcode Prefix|Apply this prefix to any auto-generated item barcode|Text|
|Vandelay Default Call Number Prefix|Apply this prefix to any auto-generated item call numbers.|Text|
|Vandelay Default Circulation Modifier|Default circulation modifier value for imported items|Selection List|Populated by your Circulation Modifiers.
|Vandelay Default Copy Location|Default copy location value for imported items|Selection List|Populated from Shelving Locations
|Vandelay Generate Default Barcodes|Auto-generate default item barcodes when no item barcode is present|True/False|
|Vandelay Generate Default Call Numbers|Auto-generate default item call numbers when no item call number is present|True/False|These are pulled from the MARC Record.
|========

Data Types
^^^^^^^^^^
((("Data Types", "Library Settings Editor")))

Acceptable formats for each setting type are listed below. Quotation
marks are never required when updating settings in the staff client.

.Data Types in the Library Settings Editor
[options="header"]
|=============
|Data type|Formatting
|True/False|Boolean True/False drop down
|Number|Enter a numerical value (decimals allowed in price settings)
|Duration|Enter a number followed by a space and any of the following units: minutes, hours, days, months (30 minutes, 2 days, etc)
|Selection list|Choose from a drop-down list of options (e.g. copy status, copy location)
|Text|Free text
|=============