1 Evergreen 3.1 Release Notes
2 ===========================
8 This release is a security release that fixes cross-site scripting
9 (XSS) vulnerabilities in the Evergreen public catalog. This release
10 also includes several other bugfixes improving on Evergreen 3.1.14.
12 Security Issue: XSS Vulnerability in Public Catalog
13 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 This release fixes several cross-site scripting (XSS) vulnerabilities
15 in the public catalog. When upgrading, Evergreen administrators should
16 review whether any of the following templates have been customized
17 or overridden. If so, either the template should be replaced with the
18 stock version or the XSS fix (which entails adding the `| html` filter
19 in several places) applied to the customized version.
21 * `Open-ILS/src/templates/opac/browse.tt2`
22 * `Open-ILS/src/templates/opac/parts/ebook_api/base_js.tt2`
23 * `Open-ILS/src/templates/opac/parts/header.tt2`
24 * `Open-ILS/src/templates/opac/parts/place_hold.tt2`
25 * `Open-ILS/src/templates/opac/parts/place_hold_result.tt2`
26 * `Open-ILS/src/templates/opac/parts/result/adv_filter.tt2`
28 They should also review the following templates. If these templates have
29 been customized or overridden, either the template should be replaced with
30 the stock version or the XSS fix (which entails adding `rel="nofollow` to
31 external links) applied to the customized version.
33 * `Open-ILS/src/templates/opac/parts/record/summary.tt2`
34 * `Open-ILS/src/templates/opac/parts/result/table.tt2`
39 Evergreen 3.1.15 also includes the following changes:
44 * Default hold transit slips no longer include patron's personal
45 information (https://bugs.launchpad.net/evergreen/+bug/1735847[Bug 1735847])
46 * Fixes an issue with the reshelving process
47 (https://bugs.launchpad.net/evergreen/+bug/1018011[Bug 1018011])
52 * Fixes issues related to cloning templates made in the XUL client
53 (https://bugs.launchpad.net/evergreen/+bug/1796945[Bug 1796945])
58 We would like to thank the following individuals who contributed code,
59 tests and documentation patches to the 3.1.15 security release of
65 * Blake Graham-Henderson
77 This release contains bug fixes improving on Evergreen 3.1.13.
78 All bug fixes refer to the web staff client unless otherwise specified.
86 * Accessibility improvements to the date picker calendar button (https://bugs.launchpad.net/evergreen/+bug/1796903[Bug #1796903])
87 * Blank values in CSV grid downloads now show as blank instead of 'null' (https://bugs.launchpad.net/evergreen/+bug/1766982[Bug #1766982])
88 * Fixes invalid language codes in the staff client and KPAC (https://bugs.launchpad.net/evergreen/+bug/1802593[Bug #1802593])
89 * Fixes display issue with menus at certain screen resolutions (https://bugs.launchpad.net/evergreen/+bug/1813078[Bug 1813078])
94 * Adds fund year to Distribution Formula fund dropdown menu (https://bugs.launchpad.net/evergreen/+bug/1329920[Bug 1329920])
99 * Extra whitespace in 856$9 subfields no longer prevents located URIs from being displayed
100 in electronic resource records. (https://bugs.launchpad.net/evergreen/+bug/1722827[Bug #1722827])
101 * Fixes issue in Item Status import where spaces or empty lines in barcode files caused an import failure (https://bugs.launchpad.net/evergreen/+bug/1798187[Bug #1798187])
102 * Fixes issue in Bucket grids where grid configurations were not saving correctly (https://bugs.launchpad.net/evergreen/+bug/1805895[Bug# 1805895])
103 * "Local catalog" is now at the top of the list of Z39.50 sources. (https://bugs.launchpad.net/evergreen/+bug/1787676[Bug #1787676])
104 * Fixes issue with authority_control_field.pl script (https://bugs.launchpad.net/evergreen/+bug/1650409[Bug #1650409])
109 * Fixes slowness issues with checkin and checkout grids (https://bugs.launchpad.net/evergreen/+bug/1777207[Bug #1777207])
110 * Fixes an issue that allowed staff to renew items to dates in the past. (https://bugs.launchpad.net/evergreen/+bug/1034058[Bug #1034058])
111 * Fixes an error that occured when checking in lost items when a certain setting was enabled. (https://bugs.launchpad.net/evergreen/+bug/1511765[Bug #1511765])
112 * Fixes an issue that caused the money summary to be missing from the patron record Bills tab. (https://bugs.launchpad.net/evergreen/+bug/1800484[Bug #1800484])
113 * Improves translations in Mark Damaged Popup. (https://bugs.launchpad.net/evergreen/+bug/1742523[Bug #1742523])
119 * Users can now hard code a list of filter values in a report template (https://bugs.launchpad.net/evergreen/+bug/1785061[Bug #1785061])
120 * Fixes an issue that caused column labels to re-sort when deleting fields in a template. (https://bugs.launchpad.net/evergreen/+bug/1751800[Bug #1751800])
121 * Fixes column type for Billing Totals and Billing Paid columns (https://bugs.launchpad.net/evergreen/+bug/1681930[Bug #1681930])
126 We would like to thank the following individuals who contributed code,
127 testing and documentation patches to the 3.1.14 point release of
133 * Andrea Buntz Neiman
154 This release contains bug fixes improving on Evergreen 3.1.12.
155 All bug fixes refer to the web staff client unless otherwise specified.
162 * Corrects a rounding error that caused fines to exceed the max fines
164 (https://bugs.launchpad.net/evergreen/+bug/1704819[Bug #1704819])
165 * Corrects an issue with printing Items Out receipts
166 (https://bugs.launchpad.net/evergreen/+bug/1790896[Bug #1790896])
167 * SIP Visa payments are now recorded as credit card, rather than cash
169 (https://bugs.launchpad.net/evergreen/+bug/1796942[Bug #1796942])
170 * Converting change to patron credit no longer requires staff members
171 to refresh the screen to see the new credit
172 (https://bugs.launchpad.net/evergreen/+bug/1775639[Bug #1775639])
173 * The patron summary now includes tooltips that were available in
175 (https://bugs.launchpad.net/evergreen/+bug/1772206[Bug #1772206])
176 * The patron holds grid now includes a SMS Carrier column
177 (https://bugs.launchpad.net/evergreen/+bug/1748265[Bug #1748265])
178 * When registering a new patron from Pending Patrons, the address
179 type dropdown now supports a default value
180 (https://bugs.launchpad.net/evergreen/+bug/1816180[Bug #1816180])
181 * The Items Out grid now includes a Monograph Parts column
182 (https://bugs.launchpad.net/evergreen/+bug/1789257[Bug #1789257])
183 * The annotate checkbox on the bill payment screen is now sticky
184 (https://bugs.launchpad.net/evergreen/+bug/1759343[Bug #1759343])
189 * The holdings editor saves default values more consistently
190 (https://bugs.launchpad.net/evergreen/+bug/1812900[Bug #1812900])
191 * Statistical categories and their entries are now alphabetized in the
192 holdings editor (Bugs
193 https://bugs.launchpad.net/evergreen/+bug/1744386[Bug #1744386] and
194 https://bugs.launchpad.net/evergreen/+bug/1777184[Bug #1777184])
195 * The holdings editor now lists monograph parts in reverse alphabetical
197 (https://bugs.launchpad.net/evergreen/+bug/1760893[Bug #1760893])
198 * Buckets created from the MARC Batch Import process are now available
199 in the MARC Batch Edit interface
200 (https://bugs.launchpad.net/evergreen/+bug/1440890[Bug #1440890])
201 * The record bucket interface only displays the Merge action when
202 multiple records are selected
203 (https://bugs.launchpad.net/evergreen/+bug/1760599[Bug #1760599])
208 * The menu in the top right corner is now named "Logout and more..."
209 (https://bugs.launchpad.net/evergreen/+bug/1796914[Bug #1796914])
214 * Avoids Internal Server Errors on search result page
215 (https://bugs.launchpad.net/evergreen/+bug/1155706[Bug #1155706])
216 * Double clicking the Place Hold button can no longer result in
218 (https://bugs.launchpad.net/evergreen/+bug/1029601[Bug #1029601])
223 * Adds a more user-friendly interface for boolean filters
224 (https://bugs.launchpad.net/evergreen/+bug/1642337[Bug #1642337])
226 System administration
227 ^^^^^^^^^^^^^^^^^^^^^
229 * Improves consistency in terminology in the Local Administration
231 (https://bugs.launchpad.net/evergreen/+bug/1776913[Bug #1776913])
235 * Fixes an automated test related to translations and internationalization
236 (https://bugs.launchpad.net/evergreen/+bug/1768987[Bug #1768987])
241 * Adds some foreign key functions that may be missing from your database
242 (https://bugs.launchpad.net/evergreen/+bug/1772028[Bug #1772028])
247 We would like to thank the following individuals who contributed code,
248 testing and documentation patches to the 3.1.13 point release of
280 This release contains bug fixes improving on Evergreen 3.1.11.
281 All bug fixes refer to the web staff client unless otherwise specified.
289 * Fixes a bug in the Booking URL path that failed with newer Apache
290 (https://bugs.launchpad.net/evergreen/+bug/1823387[Bug #1823387])
295 * Fixes a display bug with the patron record Group Members list
296 (https://bugs.launchpad.net/evergreen/+bug/1642036[Bug #1642036])
297 * Fixes title sort on the patron Items Out Screen
298 (https://bugs.launchpad.net/evergreen/+bug/1782014[Bug #1782014])
299 * Fixes the ability to place holds from item buckets
300 (https://bugs.launchpad.net/evergreen/+bug/1806394[Bug #1806394])
301 * Fixes a bug with editing the due date of an hourly loan that would lose the
302 time (https://bugs.launchpad.net/evergreen/+bug/1552778[Bug #1552778])
307 * Fixes a bug where copy templates would not apply properly
308 (https://bugs.launchpad.net/evergreen/+bug/1788680[Bug #1788680])
309 * Fixes the default cursor focus on the holdings editor
310 (https://bugs.launchpad.net/evergreen/+bug/1752968[Bug #1752968])
311 * Fixes a bug that failed to honor the "Retain empty bib records"
312 (cat.bib.keep_on_empty) setting when transferring items
313 (https://bugs.launchpad.net/evergreen/+bug/1333893[Bug #1333893])
318 * Restores ability to request password resets
319 (https://bugs.launchpad.net/evergreen/+bug/1804038[Bug #1804038])
321 System administration
322 ^^^^^^^^^^^^^^^^^^^^^
324 * Fixes the help text in action_trigger_aggregator.pl related to the remote-acct
325 argument (https://bugs.launchpad.net/evergreen/+bug/1803729[Bug #1803729])
326 * Adds a missing page title for the Statistical Popularity Badges admin page
327 (https://bugs.launchpad.net/evergreen/+bug/1826890[Bug #1826890])
332 We would like to thank the following individuals who contributed code,
333 testing and documentation patches to the 3.1.12 point release of
342 * Blake Graham-Henderson
359 This release contains bug fixes improving on Evergreen 3.1.10.
360 All bug fixes refer to the web staff client unless otherwise specified.
368 * Allows the Title Hold screen to remember previously selected pickup library
369 (https://bugs.launchpad.net/evergreen/+bug/1665534[Bug #1665534])
370 * Sorting improvements for printing the Holds Pull List
371 (https://bugs.launchpad.net/evergreen/+bug/1749502[Bug #1749502])
372 * Better display for non-catalogued checkouts in the offline checkout preview
373 pane (https://bugs.launchpad.net/evergreen/+bug/1818576[Bug #1818576])
378 * Fixes a bug that changed subfield order in bib record after editing a linked
379 authority (https://bugs.launchpad.net/evergreen/+bug/712490[Bug #712490])
380 * Allows opening multiple selected copies in Item Status screen from the
381 Holdings View (https://bugs.launchpad.net/evergreen/+bug/1734775[Bug
383 * Adds missing "Deleted?" column choice to Record Buckets
384 (https://bugs.launchpad.net/evergreen/+bug/1746360[Bug #1746360])
385 * Fixes the batch Call Number label field on the Volume editor to populate from
386 the MARC record (https://bugs.launchpad.net/evergreen/+bug/1793196[Bug
388 * Fixes a bug to allow editing the call number label for some but not all
389 attached copies (https://bugs.launchpad.net/evergreen/+bug/1794588[Bug
391 * Fixes the sort order of Parts on the Holdings View
392 (https://bugs.launchpad.net/evergreen/+bug/1800178[Bug #1800178])
394 System administration
395 ^^^^^^^^^^^^^^^^^^^^^
397 * Web client (websocket) logins are now properly tracked as user activity
398 (https://bugs.launchpad.net/evergreen/+bug/1818153[Bug #1818153])
399 * Fixes some log warnings related to Holds Depth
400 (https://bugs.launchpad.net/evergreen/+bug/1667497[Bug #1667497])
401 * Fixes a bug in the fine generator related to Bookings
402 (https://bugs.launchpad.net/evergreen/+bug/1819796[Bug #1819796])
407 We would like to thank the following individuals who contributed code,
408 testing and documentation patches to the 3.1.11 point release of
431 This release contains bug fixes improving on Evergreen 3.1.9.
432 All bug fixes refer to the web staff client unless otherwise specified.
440 * Catalogers can now set the Bib Source in the Z39.50 Overlay and Import interfaces (https://bugs.launchpad.net/evergreen/+bug/1727345[Bug #1727345])
441 * Fixes an issue where publishers display in the publication date column in copy buckets (https://bugs.launchpad.net/evergreen/+bug/1812698[Bug #1812698])
442 * Electronic reources no longer display a call number called _##URI##_ in the Volume Editor (https://bugs.launchpad.net/evergreen/+bug/1752665[Bug #1752665])
443 * Spine/pocket label templates can now include circulation library and owning library (https://bugs.launchpad.net/evergreen/+bug/1726568[Bug #1726568])
448 * Fixes an issue where external documentation links can open in the reports module (https://bugs.launchpad.net/evergreen/+bug/1784893[Bug #1784893])
449 * Fixes an issue where publishers display as a publication date in reports (https://bugs.launchpad.net/evergreen/+bug/1812698[Bug #1812698])
451 System administration
452 ^^^^^^^^^^^^^^^^^^^^^
454 * The _DELETE_COPY_ALERT_ permission no longer needs to be granted on the consortium level (https://bugs.launchpad.net/evergreen/+bug/1783421[Bug #1783421])
459 We would like to thank the following individuals who contributed code,
460 tests and documentation patches to the 3.1.10 point release of
479 This release contains bug fixes improving on Evergreen 3.1.8.
480 All bug fixes refer to the web staff client unless otherwise specified.
488 * The new `edi_order_pusher.pl` now only pushes purchase orders with a state of "on-order", to prevent older purchase orders from being unintentionally pushed to vendors.
493 * The template dropdown in the holdings editor now provides more space to accommodate longer template names.
494 * The drop-down of copy tag types in the Manage Copy Tags dialog now includes the owning library of the copy tag type.
499 * Fixes an issue with recalling checked-out materials.
500 * Added several missing columns to the patron bills grid.
501 * Corrected the display of the Bill Type column in the patron bills grid.
502 * Clarified the names of the "Billing Location" and "Grocery Billing Location" columns in the patron bills grid.
503 * The Bill Full Details grid now includes a billing location column for both circulation and grocery bills, as well as the owning library for circulation bills.
504 * The Billing History transactions grid now remembers any changes that users make to the column settings.
505 * Fixes an issue with printing multiple copies of bills.
509 We would like to thank the following individuals who contributed code,
510 tests and documentation patches to the 3.1.9 point release of
515 * Andrea Buntz Neiman
532 This release contains bug fixes improving on Evergreen 3.1.7.
533 All bug fixes refer to the web staff client unless otherwise specified.
541 * Fixes a bug that blocked logging in from mobile browsers
542 * Fixes a readability issue with mobile menus
543 * Fixes performance issue related to grid tooltips.
548 * Improves the functionality of setting a default tab of a bib record
549 * The web client now remembers the most recently selected copy template
550 * Adds help tips to Print Item Labels Settings tab
551 * If you add or edit copies and/or volumes from the Holdings View tab,
552 the view now automatically refreshes to show your changes.
553 * Provides an upgrade to MODS 3.3 for older Evergreen installations.
554 * Improves usability of Z39.50 MARC View.
559 * Staff can now place multiple email addresses into the patron registration/
560 edit form, depending on the value of the `ui.patron.edit.au.email.regex`
562 * Fixes an issue with the offline circulation module.
563 * When merging two users, the non-lead account is now completely purged from
564 the database, rather than simply being marked as deleted.
569 * Removes incorrect copy counts from metarecord search results pages
570 * Electronic resources now display in the browse interfaces
572 System administration
573 ^^^^^^^^^^^^^^^^^^^^^
575 * The example Apache 2.4 configuration now enables remoteip.
576 * Improves syntax in the fm_idl file.
581 We would like to thank the following individuals who contributed code,
582 tests and documentation patches to the 3.1.8 point release of
606 This release contains bug fixes improving on Evergreen 3.1.6.
607 All bug fixes refer to the web staff client unless otherwise specified.
612 * Adds several columns to the items out grid.
613 * Adds the ability to copy patron addresses to the clipboard.
614 * Fixes several issues with adding new items and call numbers.
615 * Adds links to catalog records from the query and pending tabs of the Record Buckets interface.
616 * Corrects the date format used in several bucket interfaces.
617 * Adds a loading spinner to interfaces that are embedded in the web staff client via iframe
618 (such as the catalog).
622 We would like to thank the following individuals who contributed code,
623 tests and documentation patches to the 3.1.7 point release of
643 This release contains bug fixes improving on Evergreen 3.1.5.
644 All bug fixes refer to the web staff client unless otherwise specified.
649 * Fixes an issue that caused catalog searches to fail after a new library was added to the org tree.
650 * When you mouse over a grid cell in the client, a tooltip will display the full contents of the cell.
651 * Fixes issues with columns in the Item Status, Holdings View, Checkout, Patron Bill, Recent Circ History,
652 * Fixes various misspellings and capitalization issues in the interface.
653 * Circulation staff can now override a patron block that is placed from Messages/Apply Penalty.
654 * Fixes an issue with checking in hourly loans.
655 * Staff can now approve pending patron addresses in the patron edit interface.
656 * Prevents patron records from being merged with themselves.
657 * Fixes a bug where the patron card dialog would not allow the user to change the primary barcode under certain circumstances.
658 * Fixes issues with duplicate transit records.
659 * Adds the transit cancel time to the Most Recent Transits section of the Item Status Holds / Transit tab.
660 * Adds the "Show in Catalog" action back to the Item Status grid.
661 * Improvements to the Item Attribute Editor.
662 * Staff can now set a default search box in the Z39.50 search interface.
663 * Staff can now delete copy notes.
664 * Fixes an issue in which transferring items and vol/items caused statistical categories to disappear.
665 * In the MARC editor, the 007 physical characteristics wizard now has a different icon than the authority linker.
666 * Protects backordered acquisitions items from having their catalog items deleted.
667 * Fixes a problem where EDI ORDERS message were not visible in the EDI Messages interface.
668 * Fixes problems that occur when cloning a report template created in the XUL client.
669 * Fixes bugs that caused activity metric data when performing searches.
670 * Fixes an issue where the "Predict New Issues" button in the Serials module did not use the correct pattern.
671 * The KPAC now respects the `opac.holds.org_unit_not_pickup_lib` setting.
675 We would like to thank the following individuals who contributed code,
676 tests and documentation patches to the 3.1.6 point release of
706 This release contains bug fixes improving on Evergreen 3.1.4.
707 All bug fixes refer to the web staff client unless otherwise specified.
712 * Several strings are now displayed in the correct translation.
713 * Right clicking in grids results in more intuitive behavior.
714 * Usernames and barcodes containging the _%_ character no longer
715 experience problems logging in.
716 * Fixes cases in which the web client stops loading after the toolbar.
717 * Fixes problems in which using the web client in multiple tabs leads
718 to data inconsistency.
719 * Fixes an issue that caused authentication session checks to spam
720 the system and needlessly fill up logs.
721 * Boolean fields within grid views now say "Yes"/"No" instead of
723 * Fixes sorting issues in the patron search.
724 * Staff can now choose to print out only a selection of items out,
725 instead of having to print them all.
726 * The patron triggered event screen now respects the
727 `circ.staff.max_visible_event_age` library setting.
728 * Fixes an issue which caused an exception to be thrown during
729 non-cataloged item checkout.
730 * Fixes permission issues related to merging users.
731 * The bibliographic record summary now displays the call number that
732 matches the library's classification system.
733 * The copy editor now makes shelving locations visible to catalogers
734 from other libraries as needed.
735 * Once a record is overlayed in the Z39.50 screen, it is no longer
737 * Fixes several issues with the item status list view.
738 * When adding new copies, the circulation library now defaults to the
739 call number's owning library.
740 * Fixes display issues with the Print Item Labels page.
741 * Fixes an issue in which the staff client and the OPAC displayed
742 different counts of available items.
746 We would like to thank the following individuals who contributed code,
747 tests and documentation patches to the 3.1.5 point release of
771 This release contains bug fixes improving on Evergreen 3.1.3. Note that
772 all bug fixes refer to the web staff client unless otherwise specified.
777 * Fixes right-click issues with the Web client grids
778 * Fixes an issue with the Default SMS Carrier in the patron edit form.
779 * Fixes an issue that allowed overdue notices to be sent to a patron
780 whose long overdue item has been paid for.
781 * Checking in precat items now displays the "Route to Cataloging" alert each
782 time the item is checked in.
783 * Fixes an issue where alerts that had been cleared by a check-in continued
785 * Fixes an issue in which the Adjust to Zero feature
786 does not close a checked-in lost circ.
787 * Deleted copies that are still checked out can now be checked in.
788 * Fixes a mislabeled column in the patron checkout grid.
789 * Grocery bills are no longer styled the same way as overdue bills.
790 * Fixes an error with the missing pieces functionality.
791 * Courier codes now display in the transit slip receipt preview.
792 * Fixes several issues related to adding volumes.
793 * Fixes several issues related to empty volumes.
794 * Fixes several issues related to item and volume transfers.
795 * Fixes several issues with checkboxes in the volume/copy editor.
796 * The Item Status grid now displays OU shortnames instead of full names
797 for the "Circulation Library" column.
798 * The Volume/Copy editor now allows users to remove a value from the Age
799 Hold Protection field.
800 * Barcode completion now works in copy buckets.
801 * The Z39.50 interface now notices when another record has been marked
803 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
804 the Z39.50 interface.
805 * Fixes a performance issue for the Validate button in the MARC Editor.
806 * Fixes an incorrect close tag in the Print Item Labels toolbar.
807 * Better scoping of copy tags in search results.
808 * Prevents sending invalid search.highlight_display_fields calls.
809 * Electronic Resource links now open in a new tab.
810 * Fixes an issue with the fiscal year close-out operation.
814 We would like to thank the following individuals who contributed code,
815 tests and documentation patches to the 3.1.4 point release of
838 This release contains bug fixes improving on Evergreen 3.1.2. Note that
839 all bug fixes refer to the web staff client unless otherwise specified.
844 * Fixes specific cases in which deleted records appear in search results.
845 * Fixes a performance issue with deleting patrons.
846 * The hold shelf dialog popup now lists the patron's notification
848 * Fixes an issue that prevented editing items when a monograph part
850 * Patron information is now available for use in the bills_current
851 and bills_historical receipt templates.
852 * The browser's "This page may contain unsaved data" warning now
853 appears when users click the update
854 expire date button in a patron account and attempt to navigate away
856 * The holds tab of the patron record now includes a monograph part
858 * The barcode box in the checkout screen
859 no longer hovers above patron record tabs when
860 staff users scroll down.
861 * Fixes an issue with the date of birth in the patron edit scren.
862 * The patron account bills grid are now color-coded by the item's
864 * Fixes an issue with the dropdown of billing type options.
865 * The Item Status screen now includes as a floating group column.
869 We would like to thank the following individuals who contributed code,
870 tests and documentation patches to the 3.1.3 point release of
873 * BC Libraries Cooperative
880 * Blake Graham-Henderson
900 This release contains bug fixes improving on Evergreen 3.1.1. Note that
901 all bug fixes refer to the web staff client unless otherwise specified.
909 * The MARC editor now handles 008 fields better.
910 * Adds spaces between subfields when suggesting a call
911 number for a new volume.
912 * MarcXML exports from the MARC Batch Import/Export ->
913 Export Records screen now downloads the file, rather than opening
915 * The Item Status Circulation Library column now displays a
916 shortname rather than the full library name.
917 * The Item Status Remaining Renewals column now displays
919 * The Item Status now has a "Last Renewal Workstation" column
921 * Fixes the circulation counts displayed in Item Status Details.
922 * Removes an error that got thrown in the Holdings View when a call number
924 * Fixes an issue where multiple copies with different values for required
925 statistical categories could not be edited and saved in batch.
926 * Add an option to remove floating in the copy editor.
927 * Fixes an issue with the floating dropdown in the copy editor.
928 * Fixes a problem in which the copy template didn't properly copy
930 * Reduces the number of API calls that the MARC Editor requires.
931 * The order of the Z39.50 servers on the Z39.50 import screen
932 no longer relies on capitalization.
937 * Fixes an issue that prevented the offline patron registration
939 * Fixes an issue with searching patrons by permission group.
940 * The barcodes in the patron search are now clickable.
941 * Staff members can now manually override the patron juvenile
942 flag value, regardless of the patron's date of birth.
943 * Checkboxes on patron registration screen are now properly aligned
945 * The user permission group dropdowns in the patron registration,
946 edit, and search interfaces now have scrollbars.
947 * The date picker on the checkout screen is now hidden unless
948 circ staff activates a specific due date option.
949 * The check-in screen now includes a copy status column.
950 * The Merge Patrons interface now displays the date of birth.
951 * The user bucket screen now displays the Bucket ID.
952 * The payment button on patron bills screen is now inactive if the
953 Payment Received field is blank.
954 * The Bill History receipt now includes a Finish date and a Last
956 * When a patron summary contains an image of the patron,
957 that image tag now has a null alt attribute to remove it from
958 the flow of a screen reader.
959 * Corrects an issue that caused the transit dialog to show the
961 * Corrects an issue with printing transit lists.
962 * "Find another target" on transiting hold no longer leaves the
964 * The images now display to distinguish hold and transit slips.
965 * The Clearable Holds list printout now only shows holds that have
967 * Restores the call number prefix and suffix fields to the holds
969 * The documentation at the top of the hold shelf slip template
971 * The cursor in the in-house use screen now automatically goes
972 to the barcode field.
973 * The in-house use screen now shows a copy status column.
974 * Add support for converting change to patron credit in the patron bills
975 interface, consistent with the XUL feature.
976 * Fixes a bug that caused pickup/request library fields to be
978 * Fixes a bug in the offline org unit tree.
980 Command-line system administration
981 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
983 * The novelist entry in `eg_vhost.conf` includes two new
985 * Corrects an issue with the `--max-sleep` argument on the
986 `action_trigger_runner.pl` support script.
987 * Corrects an issue with how the `eg_pbx_allocator.pl` script
988 detects an existing lock file.
989 * The 3.0.2-3.0.3 upgrade script disables triggers before
990 recalculating bib visibility.
995 * Fixes an issue that caused records with located URIs to be
996 retrieved in Copy Location and Copy Location Group searches.
997 * Fixes an error message that appeared in the search box
998 in the public catalog while placing hold after an advanced search.
999 * Restores the display of copy information for the user's
1000 preferred library in the public catalog.
1001 * Author and contributor names are no longer highlighted in
1002 search results when the user has turned off highlighting.
1003 * Fixes regression errors in the search results page.
1004 * Removes redundant call numbers from the Show More Details
1006 * The cast field in the catalog is now taken from the 511 field
1007 when first indicator = 1, rather than the 508.
1008 * Fixes a display issue caused by editing holds.
1009 * Repairs broken author search links on the catalog record page.
1014 * Fixes an issue that prevented users from searching for
1015 receivable issues using Database ID or ISSN in the Serials
1016 Batch Receive interface.
1020 * Pins AngularJS support to version 1.6, which prevents unsupported
1021 AngularJS versions (such as 1.7) from breaking the build process.
1022 * Adds some padding to the bottom of Web Client interfaces.
1023 * Logins now honor all org unit timeout settings.
1024 * Evergreen will now identify and handle invalid timezones.
1025 * Fixes an issue where a column header in some interfaces were automatically
1026 highlighted in green when retrieving the interface.
1027 * The parts column in the Item Status screen now displays parts data.
1032 We would like to thank the following individuals who contributed code,
1033 tests and documentation patches to the 3.1.2 point release of
1069 This release contains bug fixes improving on Evergreen 3.1.0.
1071 * Fixes a performance issue with the Patron Billing History screen and
1072 other screens that cause Flattener.pm to re-create joins
1074 * Fixes an issue that prevented patron alerts from showing to staff at
1076 * Corrects the "Holdable" attribute display on the Item Status detailed
1078 * Fixes the ability to delete multiple copies from Item Status.
1082 We would like to thank the following individuals who contributed code,
1083 tests and documentation patches to the 3.1.1 point release of
1098 Like many major Evergreen upgrades, 3.1 requires a full reingest of your
1099 bibliographic records before the system is usable again. While a basic reingest
1100 is included at the end of the upgrade script, it happens after the main
1101 COMMIT, so it is safe to cancel that and run the required reingest as you see
1102 fit (e.g. via pingest.pl).
1111 New Latency Tester Tool
1112 ^^^^^^^^^^^^^^^^^^^^^^^
1113 The Evergreen Web Staff Client now includes a section called *Tests* linked from
1114 *Administration -> Workstation*. The *Tests* page houses a simple tool
1115 that can be used to test the latency of the websocket connection between the
1116 client and the server (via the `opensrf.echo` service).
1118 This page displays which Evergreen host server is being queried. Upon hitting
1119 the blue "Start Test" button for the first time, it will issue 10 sequentially
1120 fired requests in order to get a solid initial average. Clicking the button a
1121 second time will take one more measurement and recalculate the average
1122 latency. The results can be copied to clipboard for troubleshooting purposes
1123 and also cleared from display.
1125 marc_export --uris option
1126 ^^^^^^^^^^^^^^^^^^^^^^^^^
1127 The marc_export support script now has a `--uris` option (short form:
1128 `-u`) to export records with located URIs (i.e. electronic resources). When
1129 used by itself, it will export only records that have located URIs. When
1130 used in conjunction with `--items`, it will add records with located URIs
1131 but no items/copies to the output. If combined with a `--library` or
1132 `--descendants` option, this option will limit its output to those
1133 records with URIs at the designated libraries. The best way to use
1134 this option is in combination with the `--items` and one of the
1135 `--library` or `--descendants` options to export *all* of a library's
1136 holdings both physical and electronic.
1142 Sample Data Includes Surveys
1143 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1144 The Concerto sample data set now includes patron surveys, questions,
1145 answers, and responses.
1147 Virtual Index Definitions
1148 ^^^^^^^^^^^^^^^^^^^^^^^^^
1149 The practical purpose of Virtual Index Definitions is to supply an Evergreen
1150 administrator with the ability to control the weighting and field inclusion of
1151 values in the general keyword index, commonly referred to as "the blob,"
1152 without requiring tricky configuration that has subtle semantics, an
1153 over-abundance of index definitions which can slow search generally, or the
1154 need to reingest all records on a regular basis as experiments are performed
1155 and the configuration refined. Significant results of recasting keyword indexes
1156 as a set of one or more Virtual Index Definitions will be simpler search
1157 configuration management, faster search speed overall, and more practical
1158 reconfiguration and adjustment as needed.
1160 Previously, in order to provide field-specific weighting to
1161 keyword matches against titles or authors, an administrator must duplicate many
1162 other index definitions and supply overriding weights to those duplicates. This
1163 not only complicates configuration, but slows down record ingest as well as
1164 search. It is also fairly ineffective at achieving the goal of weighted keyword
1165 fields. Virtual Index Definitions will substantially alleviate the need for
1166 these workarounds and their consequences.
1168 * A Virtual Index Definition does not require any configuration for
1169 extracting bibliographic data from records, but instead can become a sink for
1170 data collected by other index definitions, which is then colocated together to
1171 supply a search target made up of the separately extracted data. Virtual Index
1172 Definitions are effectively treated as aggregate definitions, matching across
1173 all values extracted from constituent non-virtual index definitions. They can
1174 further make use of the Combined class functionality to colocate all values in a
1175 class together for matching even across virtual fields.
1177 * Configuration allows for weighting of constituent index definitions that
1178 participate in a Virtual Index Definition. This weighting is separate from the
1179 weighting supplied when the index definition itself is a search target.
1181 * The Evergreen QueryParser driver returns the list of fields actually
1182 searched using every user-supplied term set, including constituent expansion
1183 when a Virtual Index Definition is searched. In particular, this will facilitate
1184 Search Term Highlighting described below.
1186 * Stock configuration changes make use of pre-existing, non-virtual index
1187 definitions mapped to new a Virtual Index Definition that implements the
1188 functionality provided by the `keyword|keyword` index definition. The
1189 `keyword|keyword` definition is left in place for the time being, until more data
1190 can be gathered about the real-world effect of removing it entirely and
1191 replacing it with Virtual Index Definition mappings.
1193 * New system administration functions will be created to facilitate
1194 modification of Virtual Index Definition mapping, avoiding the need for a full
1195 reingest when existing index definitions are added or removed from a virtual
1198 Increased use of Metabib Display Fields
1199 +++++++++++++++++++++++++++++++++++++++
1200 We use Metabib Display Fields (newly available in 3.0) to render catalog search
1201 results, intermediate metarecord results, and record detail pages. This requires
1202 the addition of several new Metabib Display Field definitions, as well as Perl
1203 services to gather and render the data.
1205 We also use more Metabib Display Fields in the client. As a result,
1206 bibliographic fields will display in proper case in more client interfaces and
1207 in Evergreen reports.
1211 A new AngularJS "MARC Search/Facet Fields" interface has been created to replace
1212 the Dojo version, and both have been extended to support Virtual Index
1213 Definition data supplier mapping and weighting.
1215 Settings & Permissions
1216 ++++++++++++++++++++++
1217 The new Virtual Index Definition data supplier mapping table,
1218 `config.metabib_field_virtual_map`, requires the same permissions as the
1219 MARC Search/Facet Fields interface: CREATE_METABIB_FIELD, UPDATE_METABIB_FIELD,
1220 DELETE_METABIB_FIELD, or ADMIN_METABIB_FIELD for all actions
1224 There now exist several new database tables and functions primarily in support
1225 of search highlighting. Additionally, the QueryParser driver for Evergreen has
1226 been augmented to be able to return a data structure describing how the search
1227 was performed, in a way that allows a separate support API to gather a
1228 highlighted version of the Display Field data for a given record.
1232 By default, the following fields will be weighted more heavily in keyword
1233 searches. Administrators can change these defaults by changing the values in the
1234 "All searchable fields" virtual index in the "MARC Search/Facet Fields"
1238 * Main title (a new index limited to the words in the 245a)
1242 In addition, note indexes and the physical description index will receive
1243 less weight in default keyword searches.
1245 Re-ingest or Indexing Dependencies
1246 ++++++++++++++++++++++++++++++++++
1247 With the addition and modification of many Index Definitions, a full reingest is
1248 recommended. However, search will continue to work as it did previously
1249 for those records that have not yet been reingested. Therefore a slow, rolling
1250 reingest is recommended.
1252 Performance Implications or Concerns
1253 ++++++++++++++++++++++++++++++++++++
1254 Because the Metabib Display Fields infrastructure will eventually replace
1255 functionality that is significantly more CPU-intensive in the various forms of
1256 XML parsing, XSLT transformation, XPath calculation, and
1257 Metabib Virtual Record construction, it is expected that the overall CPU load
1258 will be reduced by this development, and ideally the overall time required to
1259 perform and render a search will likewise drop. It is unlikely that the speed
1260 increase will be visible to users on a per-search basis, but that search in
1261 aggregate will become a smaller consumer of resources.
1269 When 2 or more bib records are merged, all records involved are stamped
1270 with a new `merge_date` value. For any bib record, this field indicates
1271 the last time it was involved in a merge. At the same time, all
1272 subordinate records (i.e. those deleted as a product of the merge) are
1273 stamped with a `merged_to` value indicating which bib record the source
1274 record was merged with.
1276 In the browser client bib record display, a warning alert now appears
1277 along the top of the page (below the Deleted alert) indicating when a
1278 record was used in a merge, when it was merged, and which record it was
1279 merge with, rendered as a link to the target record.
1285 Alternate Patron Hold Pickup
1286 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1287 This feature adds a bit of convenience to a common task: checking out
1288 an item on hold to another patron (typically a family member or helper).
1290 When you checkout the item, you will get a pop-up window with warnings associated
1291 with this item. The "ITEM_ON_HOLDS_SHELF" message is now expanded to
1293 * Let you know the name of the person who had placed the hold.
1294 * Give you the option (in the form of a checkbox) of cancelling the
1295 hold placed by the above-named patron. (Checked = Cancel the hold;
1296 Unchecked = Leave the hold in place)
1298 The initial value of the checkbox is derived from the
1299 `circ.clear_hold_on_checkout` organizational setting.
1301 If the operator has CANCEL_HOLD privilege, then if the checkbox is checked and
1302 the checkout is allowed to proceed, the hold will be cancelled with a note that
1303 the item was checked out to another patron.
1305 This feature is available in the browser-based staff client.
1307 New Patron Billing Statement
1308 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1309 The Evergreen web staff client now includes a patron billing statement,
1310 which summarizes a patron's bills, credits and payments in a familiar
1311 layout. This can be found on the "Statement" tab of the Patron Bill
1312 Details page. (From the Patron Bills page, double-click a row to view
1313 its details, or choose "Full Details" from the Actions menu.)
1315 Enhanced Billing Timestamp Support
1316 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1317 Previously, billings had to make do with a single timestamp attempting
1318 to fill two different roles. In the case of an overdue fine, the
1319 timestamp represented the *end* of the fine period for that billing,
1320 while for all other fines, the timestamp was merely the time the bill
1321 was created. This setup generally worked, but not without confusion,
1322 and limited our ability to understand and process the data.
1324 Billings will now have up to three timestamps: a create date, and when
1325 applicable, a fine period start and a fine period end. This clarifies
1326 and simplifies things like backdating, retrospective fine generation,
1327 account balancing for negative balance avoidance, and billing timeline
1330 Copy Alerts and Suppression Matrix
1331 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1332 The Copy Alerts feature allows library staff to add customized alert
1333 messages to copies. The copy alerts will appear when a specific event
1334 takes place, such as when the copy is checked in, checked out, or
1335 renewed. Alerts can be temporary or persistent: temporary alerts will be
1336 disabled after the initial alert and acknowledgement from staff, while
1337 persistent alerts will display each time the alert event takes place.
1338 Copy Alerts can be configured to display at the circulating or owning
1339 library only or, alternatively, when the library at which the alert
1340 event takes place is not the circulating or owning library. Copy Alerts
1341 can also be configured to provide options for the next copy status that
1342 should be applied to an item. Library administrators will have the
1343 ability to create and customize Copy Alert Types and to suppress copy
1344 alerts at specific org units.
1346 Copy alerts can be added via the volume/creator and the check in,
1347 check out, and renew pages. Copy alerts can also be managed at the
1350 Copy alert types can be managed via the Copy Alert Types page in
1351 Local Administration, and suppression of them can be administered
1352 via the Copy Alert Suppression page under Local Administration.
1354 Place Multiple Holds At Once
1355 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1356 Users with the appropriate permissions now have the ability to place multiple
1357 title/metarecords holds at once. This feature is especially beneficial for book
1358 clubs and reading groups, which need to place holds on multiple copies of a
1361 In order to use the feature:
1363 * Set the _Maximum number of duplicate holds allowed_ Library Setting
1364 (`circ.holds.max_duplicate_holds`) to a number higher than 1
1365 * Log in as a user with the CREATE_DUPLICATE_HOLDS
1367 When placing a title or metarecord hold, a _Number of copies_ field will
1368 display for these users. This field is not available when placing part, volume
1371 This feature does not change the way in which the system fills holds. The
1372 multiple holds will fill in the same way that they would if the user had placed
1373 multiple holds separately.
1375 New Notice Columns in Items Out Grid
1376 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1377 The grid in the patron "items out" page in the Evergreen web staff client has two new
1378 columns indicating the number of notifications generated for a given loan and the date of
1379 the most recent notification. These columns will allow circulation staff to better respond to
1380 patron questions about whether they were sent notification about an overdue item.
1382 The columns are based on the number of completed Action Trigger events on the
1383 loan that have a 'checkout.due' hook. In other words, they would include overdue
1384 and courtesy notices.
1386 A new library setting, "Exclude Courtesy Notices from Patrons Itemsout Notices Count",
1387 if set will cause the notice count and date fields to exclude courtesy notices.
1389 Patron Email Addresses Now Clickable In Web Staff Client
1390 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1391 Adds a mailto link to the patron's email in their profile so it can
1392 be clicked to send and email to the patron. No new settings or
1393 permissions are included in this feature.
1395 Pickup Library for Staff-placed Holds
1396 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1397 Adds a new library setting, _circ.staff_placed_holds_fallback_to_ws_ou_,
1398 that helps determine the hold pickup library in cases where patrons don't
1399 have a preferred hold pickup library in their account and a staff member
1400 is placing the hold on their behalf.
1402 * When this setting is true and the patron doesn't have a preferred
1403 library listed, the hold pickup library will default to the
1404 workstation's organizational unit.
1405 * When this setting is false and the patron doesn't have a preferred
1406 library listed, the hold pickup library will default to the
1407 patron's home library.
1412 Search Term Highlighting
1413 ^^^^^^^^^^^^^^^^^^^^^^^^
1414 Evergreen now highlights search terms on the public catalog's main search
1415 results page, the record detail page, and intermediate pages such as metarecord
1416 grouped results page. Highlighting search terms will help the user determine why
1417 a particular record (or set of records) was retrieved.
1419 Highlighting of matched terms uses the same stemming used to accomplish the
1420 search, as configured per field and class.
1422 This feature will help the user more quickly determine the relevance of a
1423 particular record by calling their attention to search terms in context. Lastly,
1424 it will help familiarize the user with how records are searched, including which
1425 fields are searched as well as exposing concepts like stemming.
1427 You can turn off search term highlighting by uncommenting the line
1428 `search.no_highlight = 1;` in `config.tt2`.
1430 When highlighting is generally enabled, it may be turned on or off on a per-page
1431 basis through the use of a UI component which will request the page again
1432 without highlighting.
1434 Highlighting of terms uses Template::Toolkit-driven CSS. A generic CSS class
1435 identifying a highlighted term, along with CSS classes identifying the search
1436 class and each search field are available for use for customization of the
1437 highlighting. A stock CSS template is provided as a baseline upon which sites
1441 Copy Location Filter Displays for System Searches
1442 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1443 The Shelving Location filter now displays on the advanced search page when
1444 a search is scoped to a library system, not just to an individual branch. If
1445 a library system is selected as the Search Library, the shelving location
1446 limiter will display any shelving location that is owned by the selected system
1447 or by the consortium. It will NOT display shelving locations owned by child
1450 Multi-source Attributes
1451 ^^^^^^^^^^^^^^^^^^^^^^^
1452 We now allow record attribute definitions to extract data using more than
1453 one strategy (XPath, tag+subfield, fixed field, etc.) as long as the values
1454 from various sources would, after normalization, have the same shape.
1458 This change allows us to configure multilingual search, by extracting values
1459 from both the 008 controlfield and the 041 datafield. Because the values
1460 in each can be normalized to the same controlled list (and, in practice, are
1461 already from the same normalized value set), catalog searches can now use normal
1462 boolean search semantics to find records with various combinations of
1463 language attributes.
1465 E.g., in the concerto test data:
1467 * `keyword: piano item_lang(eng) item_lang(ita)`
1470 Optional Display of Badges in Catalog
1471 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1472 A new setting controls whether badges (popularity, etc.) are displayed
1473 in the catalog. If you do not wish badges to be displayed, set the
1474 `ctx.hide_badge_scores` setting to "true" in `config.tt2`.
1480 Fixes to patron name/username search indexes
1481 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1482 When using pg_restore to restore an Evergreen database, some of the
1483 indexes used to speed up patron searches on names and usernames
1486 This release fixes the underlying issue and re-creates the indexes
1491 When using pg_restore to restore an affected database, the
1492 "unaccent" indexes on actor.usr would not be created due to an
1493 unqualified function reference in `evergreen.unaccent_and_squash`.
1495 The function will be replaced to resolve the search path issue,
1496 and the following indexes on actor.usr will be dropped and then
1499 * actor_usr_first_given_name_unaccent_idx;
1500 * actor_usr_second_given_name_unaccent_idx;
1501 * actor_usr_family_name_unaccent_idx;
1502 * actor_usr_usrname_unaccent_idx;
1504 This will be done even if the indexes are already present, and may
1505 take a few minutes on a database with many patrons.
1508 3.1.0 Acknowledgments
1509 ---------------------
1510 The Evergreen project would like to acknowledge the following
1511 organizations that commissioned developments in this release of
1514 * Albany Public Library (Oregon)
1515 * Consortium of Ohio Libraries
1517 * Indiana State Library
1518 * Georgia Public Library Service
1519 * Hagerstown - Jefferson Township Library
1520 * Linn-Benton Community College
1522 * Pennsylvania Integrated Library System
1523 * Sage Library System
1524 * Union County Public Library (Indiana)
1526 We would also like to thank the following individuals who contributed
1527 code, translations, documentations patches and tests to this release of
1554 We also thank the following organizations whose employees contributed
1558 * British Columbia Libraries Cooperative
1561 * Equinox Open Library Initiative
1562 * Georgia Public Library Service
1563 * Greater Clarks Hill Regional Library System
1564 * Jordanian Library and Information Association
1565 * King County Library System
1567 * Linn-Benton Community College
1570 * Traverse Area District Library
1572 We regret any omissions. If a contributor has been inadvertently
1573 missed, please open a bug at http://bugs.launchpad.net/evergreen/