1 Evergreen 3.2 Release Notes
2 ===========================
9 This release contains bug fixes improving on Evergreen 3.2.6.
10 All bug fixes refer to the web staff client unless otherwise specified.
17 * Corrects a rounding error that caused fines to exceed the max fines
19 (https://bugs.launchpad.net/evergreen/+bug/1704819[Bug #1704819])
20 * Corrects an issue with printing Items Out receipts
21 (https://bugs.launchpad.net/evergreen/+bug/1790896[Bug #1790896])
22 * SIP Visa payments are now recorded as credit card, rather than cash
24 (https://bugs.launchpad.net/evergreen/+bug/1796942[Bug #1796942])
25 * Converting change to patron credit no longer requires staff members
26 to refresh the screen to see the new credit
27 (https://bugs.launchpad.net/evergreen/+bug/1775639[Bug #1775639])
28 * The patron summary now includes tooltips that were available in
30 (https://bugs.launchpad.net/evergreen/+bug/1772206[Bug #1772206])
31 * The patron holds grid now includes a SMS Carrier column
32 (https://bugs.launchpad.net/evergreen/+bug/1748265[Bug #1748265])
33 * When registering a new patron from Pending Patrons, the address
34 type dropdown now supports a default value
35 (https://bugs.launchpad.net/evergreen/+bug/1816180[Bug #1816180])
36 * The Items Out grid now includes a Monograph Parts column
37 (https://bugs.launchpad.net/evergreen/+bug/1789257[Bug #1789257])
38 * The annotate checkbox on the bill payment screen is now sticky
39 (https://bugs.launchpad.net/evergreen/+bug/1759343[Bug #1759343])
40 * Group member details grid settings can now be saved
41 (https://bugs.launchpad.net/evergreen/+bug/1774707[Bug #1774707])
42 * The patron registration date of birth field can now display a
44 (https://bugs.launchpad.net/evergreen/+bug/1819181[Bug #1819181])
49 * The MARC editor displays a warning when a cataloger attempts to
50 close the tab without saving
51 (https://bugs.launchpad.net/evergreen/+bug/1538678[Bug #1538678])
52 * The MARC editor displays a warning when permissions issues
53 prevent a record from saving
54 (https://bugs.launchpad.net/evergreen/+bug/1693580[Bug #1693580])
55 * The holdings editor saves default values more consistently
56 (https://bugs.launchpad.net/evergreen/+bug/1812900[Bug #1812900])
57 * The flat-text editor now uses a monospace font
58 (https://bugs.launchpad.net/evergreen/+bug/1817601[Bug #1817601])
59 * Statistical categories and their entries are now alphabetized in the
61 https://bugs.launchpad.net/evergreen/+bug/1744386[Bug #1744386] and
62 https://bugs.launchpad.net/evergreen/+bug/1777184[Bug #1777184])
63 * The holdings editor now lists monograph parts in reverse alphabetical
65 (https://bugs.launchpad.net/evergreen/+bug/1760893[Bug #1760893])
66 * Buckets created from the MARC Batch Import process are now available
67 in the MARC Batch Edit interface
68 (https://bugs.launchpad.net/evergreen/+bug/1440890[Bug #1440890])
69 * The record bucket interface only displays the Merge action when
70 multiple records are selected
71 (https://bugs.launchpad.net/evergreen/+bug/1760599[Bug #1760599])
72 * Fixes an issue with the displayed number of items out
73 (https://bugs.launchpad.net/evergreen/+bug/1770217[Bug #1770217])
78 * Fixes conflicting dependency information caused be the release of
80 (https://bugs.launchpad.net/evergreen/+bug/1830972[Bug #1830972])
81 * Angular grids include several new accessibility features and
83 (https://bugs.launchpad.net/evergreen/+bug/1816480[Bug #1816480])
84 * The menu in the top right corner is now named "Logout and more..."
85 (https://bugs.launchpad.net/evergreen/+bug/1796914[Bug #1796914])
86 * Several dropdown menus now require less scrolling
87 (https://bugs.launchpad.net/evergreen/+bug/1669120[Bug #1669120])
93 * Avoids Internal Server Errors on search result page
94 (https://bugs.launchpad.net/evergreen/+bug/1155706[Bug #1155706])
95 * Double clicking the Place Hold button can no longer result in
97 (https://bugs.launchpad.net/evergreen/+bug/1029601[Bug #1029601])
102 * Adds a more user-friendly interface for boolean filters
103 (https://bugs.launchpad.net/evergreen/+bug/1642337[Bug #1642337])
105 System administration
106 ^^^^^^^^^^^^^^^^^^^^^
108 * Improves consistency in terminology in the Local Administration
110 (https://bugs.launchpad.net/evergreen/+bug/1776913[Bug #1776913])
111 * The Library Settings Editor now displays some example timezones
112 for the lib.timezone setting
113 (https://bugs.launchpad.net/evergreen/+bug/1817332[Bug #1817332])
117 * Fixes an automated test related to translations and internationalization
118 (https://bugs.launchpad.net/evergreen/+bug/1768987[Bug #1768987])
123 * Adds some foreign key functions that may be missing from your database
124 (https://bugs.launchpad.net/evergreen/+bug/1772028[Bug #1772028])
129 We would like to thank the following individuals who contributed code,
130 testing and documentation patches to the 3.2.7 point release of
164 This release contains bug fixes improving on Evergreen 3.2.5.
165 All bug fixes refer to the web staff client unless otherwise specified.
173 * Fixes a compatibility problem with the Item Status screen related to
174 JavaScript arrow functions
175 (https://bugs.launchpad.net/evergreen/+bug/1821196[Bug #1821196])
180 * Fixes a bug in the Booking URL path that failed with newer Apache
181 (https://bugs.launchpad.net/evergreen/+bug/1823387[Bug #1823387])
186 * Fixes a display bug with the patron record Group Members list
187 (https://bugs.launchpad.net/evergreen/+bug/1642036[Bug #1642036])
188 * Fixes title sort on the patron Items Out Screen
189 (https://bugs.launchpad.net/evergreen/+bug/1782014[Bug #1782014])
190 * Fixes a refresh bug on the catalog record Holds View tab when moving between
191 records (https://bugs.launchpad.net/evergreen/+bug/1792188[Bug #1792188])
192 * Fixes the ability to place holds from item buckets
193 (https://bugs.launchpad.net/evergreen/+bug/1806394[Bug #1806394])
198 * Fixes a bug where copy templates would not apply properly
199 (https://bugs.launchpad.net/evergreen/+bug/1788680[Bug #1788680])
200 * Fixes the default cursor focus on the holdings editor
201 (https://bugs.launchpad.net/evergreen/+bug/1752968[Bug #1752968])
202 * Fixes a bug that failed to honor the "Retain empty bib records"
203 (cat.bib.keep_on_empty) setting when transferring items
204 (https://bugs.launchpad.net/evergreen/+bug/1333893[Bug #1333893])
205 * Fixes a bug that failed to include deleted bib records in TCN search
206 (https://bugs.launchpad.net/evergreen/+bug/1813633[Bug #1813633])
208 System administration
209 ^^^^^^^^^^^^^^^^^^^^^
211 * Added database indexes to speed up purging of Action Trigger event output
212 fields (https://bugs.launchpad.net/evergreen/+bug/1778940[Bug #1778940])
213 * Fixes the help text in action_trigger_aggregator.pl related to the remote-acct
214 argument (https://bugs.launchpad.net/evergreen/+bug/1803729[Bug #1803729])
215 * Adds a missing page title for the Closed Dates Editor
216 (https://bugs.launchpad.net/evergreen/+bug/1814943[Bug #1814943])
217 * Adds a missing page title for the Statistical Popularity Badges admin page
218 (https://bugs.launchpad.net/evergreen/+bug/1826890[Bug #1826890])
223 We would like to thank the following individuals who contributed code,
224 testing and documentation patches to the 3.2.6 point release of
233 * Blake Graham-Henderson
251 This release contains bug fixes improving on Evergreen 3.2.4.
252 All bug fixes refer to the web staff client unless otherwise specified.
260 * Improves the web client splash screen by linking the images along with their links
261 (https://bugs.launchpad.net/evergreen/+bug/1802662[Bug #1802662])
266 * Allows the Title Hold screen to remember previously selected pickup library
267 (https://bugs.launchpad.net/evergreen/+bug/1665534[Bug #1665534])
268 * Sorting improvements for printing the Holds Pull List
269 (https://bugs.launchpad.net/evergreen/+bug/1749502[Bug #1749502])
270 * Better display for non-catalogued checkouts in the offline checkout preview
271 pane (https://bugs.launchpad.net/evergreen/+bug/1818576[Bug #1818576])
276 * Fixes a bug that changed subfield order in bib record after editing a linked
277 authority (https://bugs.launchpad.net/evergreen/+bug/712490[Bug #712490])
278 * Allows opening multiple selected items in Item Status screen from the Holdings
279 View (https://bugs.launchpad.net/evergreen/+bug/1734775[Bug #1734775])
280 * Adds missing "Deleted?" column choice to Record Buckets
281 (https://bugs.launchpad.net/evergreen/+bug/1746360[Bug #1746360])
282 * Fixes the batch Call Number label field on the Call Number editor to populate
283 from the MARC record (https://bugs.launchpad.net/evergreen/+bug/1793196[Bug
285 * Fixes a bug to allow editing the call number label for some but not all
286 attached items (https://bugs.launchpad.net/evergreen/+bug/1794588[Bug
288 * Fixes the sort order of Parts on the Holdings View
289 (https://bugs.launchpad.net/evergreen/+bug/1800178[Bug #1800178])
290 * Adds missing action "Find Originating Acquisition" to Cataloging actions menu
291 (https://bugs.launchpad.net/evergreen/+bug/1705497[Bug #1705497])
292 * Keeps the Item Status screen updated after editing items
293 (https://bugs.launchpad.net/evergreen/+bug/1721109[Bug #1721109])
294 * Fixes a bug with the "checked" state of the Item note "Public Note" checkbox
295 (https://bugs.launchpad.net/evergreen/+bug/1778571[Bug #1778571])
296 * Fixes a bug with Item Alert counts in the Holdings view
297 (https://bugs.launchpad.net/evergreen/+bug/1798628[Bug #1798628])
298 * Improved display when merging bib records from a bucket (side by side, with
299 optional holdings) (https://bugs.launchpad.net/evergreen/+bug/1739293[Bug
301 * Fixes issues where edits to MARC records would fail to save during merge
302 (https://bugs.launchpad.net/evergreen/+bug/1776736[Bug #1776736])
304 System administration
305 ^^^^^^^^^^^^^^^^^^^^^
307 * Web client (websocket) logins are now properly tracked as user activity
308 (https://bugs.launchpad.net/evergreen/+bug/1818153[Bug #1818153])
309 * Fixes some log warnings related to Holds Depth
310 (https://bugs.launchpad.net/evergreen/+bug/1667497[Bug #1667497])
311 * Fixes a bug in the fine generator related to Bookings
312 (https://bugs.launchpad.net/evergreen/+bug/1819796[Bug #1819796])
313 * Fixes the Group Penalty Threshold link under the Local Administration menu
314 (https://bugs.launchpad.net/evergreen/+bug/1812389[Bug #1812389])
315 * Fixes a typo in seed data and all related PO files for translation
316 (https://bugs.launchpad.net/evergreen/+bug/1759238[Bug #1759238])
317 * Fixes an error in the sitemap_generator script when using the shortname
318 parameter (https://bugs.launchpad.net/evergreen/+bug/1808006[Bug #1808006])
323 We would like to thank the following individuals who contributed code,
324 testing and documentation patches to the 3.2.5 point release of
356 This release contains bug fixes improving on Evergreen 3.2.3.
357 All bug fixes refer to the web staff client unless otherwise specified.
365 * Adds appropriate alt text to the Evergreen splash page (https://bugs.launchpad.net/evergreen/+bug/1802594[Bug #1802594])
366 * The public catalog search box now only autofocuses when searching is the main purpose of the page (https://bugs.launchpad.net/evergreen/+bug/1796225[Bug #1796225])
371 * Fixes an issue that prevented purchase orders to not open in a new tab (https://bugs.launchpad.net/evergreen/+bug/1813290[Bug #1813290])
376 * The Billing History grids now save their configuration in the database (https://bugs.launchpad.net/evergreen/+bug/1806709[Bug #1806709])
381 * Catalogers can now set the Bib Source in the Z39.50 Overlay and Import interfaces (https://bugs.launchpad.net/evergreen/+bug/1727345[Bug #1727345])
382 * Fixes an issue where publishers display in the publication date column in copy buckets (https://bugs.launchpad.net/evergreen/+bug/1812698[Bug #1812698])
383 * Electronic reources no longer display a call number called _##URI##_ in the Volume Editor (https://bugs.launchpad.net/evergreen/+bug/1752665[Bug #1752665])
384 * Spine/pocket label templates can now include circulation library and owning library (https://bugs.launchpad.net/evergreen/+bug/1726568[Bug #1726568])
390 * Fixes an issue where external documentation links can open in the reports module (https://bugs.launchpad.net/evergreen/+bug/1784893[Bug #1784893])
391 * Fixes an issue where publishers display as a publication date in reports (https://bugs.launchpad.net/evergreen/+bug/1812698[Bug #1812698])
396 * Staff users can now set their prefered default Advanced Search pane (https://bugs.launchpad.net/evergreen/+bug/1799963[Bug #1799963])
397 * The public catalog search box now only autofocuses when searching is the main purpose of the page (https://bugs.launchpad.net/evergreen/+bug/1796225[Bug #1796225])
399 System administration
400 ^^^^^^^^^^^^^^^^^^^^^
402 * The _DELETE_COPY_ALERT_ permission no longer needs to be granted on the consortium level (https://bugs.launchpad.net/evergreen/+bug/1783421[Bug #1783421])
407 * The angular client now uses Angular 7 (https://bugs.launchpad.net/evergreen/+bug/1801984[Bug #1801984])
408 * The angular client grid actions can now be disabled depending on the criteria of which rows are selected (https://bugs.launchpad.net/evergreen/+bug/1808268[Bug #1808268])
409 * Angular client pages now display their own titles in the browser tab, rather than _AngEG_ (https://bugs.launchpad.net/evergreen/+bug/1813647[Bug #1813647])
414 We would like to thank the following individuals who contributed code,
415 tests and documentation patches to the 3.2.4 point release of
438 This release contains bug fixes improving on Evergreen 3.2.3.
439 All bug fixes refer to the staff client unless otherwise specified.
447 * Hatch is now deprecated for local data storage. Hatch is
448 still recommended for printing in certain situations.
453 * The new `edi_order_pusher.pl` now only pushes purchase orders
454 with a state of "on-order", to prevent older purchase orders
455 from being unintentionally pushed to vendors.
460 * The Z39.50 and record bucket interfaces now open relevant
461 catalog records in new tabs.
462 * Fixes a bug that prevented batch importing authority records.
463 * The template dropdown in the holdings editor now provides more
464 space to accommodate longer template names.
465 * The drop-down of copy tag types in the Manage Copy Tags dialog
466 now includes the owning library of the copy tag type.
471 * Fixes an issue with recalling checked-out materials.
472 * Added several missing columns to the patron bills grid.
473 * Corrected the display of the Bill Type column in the patron bills grid.
474 * Clarified the names of the "Billing Location" and "Grocery Billing
475 Location" columns in the patron bills grid.
476 * The Bill Full Details grid now includes a billing location column
477 for both circulation and grocery bills, as well as the owning library for
479 * The Billing History transactions grid now remembers any changes that
480 users make to the column settings.
481 * Fixes an issue with printing multiple copies of bills.
482 * Fixes an issue with saving self-registered patron accounts.
483 * Staff can now delete self-registered patron accounts.
485 System administration
486 ^^^^^^^^^^^^^^^^^^^^^
488 * Fixes the marc_stream_importer to be compatible with Vandelay session
490 * Includes an accessibility improvement for the Acquisitions
491 Administration interfaces.
496 We would like to thank the following individuals who contributed code,
497 tests and documentation patches to the 3.2.3 point release of
502 * Andrea Buntz Neiman
520 This release contains bug fixes improving on Evergreen 3.2.1.
521 All bug fixes refer to the web staff client unless otherwise specified.
529 * Fixes a bug that blocked logging in from mobile browsers
530 * Fixes a readability issue with mobile menus
531 * Fixes performance issue related to grid tooltips.
532 * Fixes an issue that caused some grid columns to appear
538 * Improves the functionality of setting a default tab of a bib record
539 * The web client now remembers the most recently selected copy template
540 * Adds help tips to Print Item Labels Settings tab
541 * If you add or edit copies and/or volumes from the Holdings View tab,
542 the view now automatically refreshes to show your changes.
543 * Provides an upgrade to MODS 3.3 for older Evergreen installations.
544 * Improves usability of Z39.50 MARC View.
550 * Fixes a daylight savings time-related circulation bug.
551 * Fixes a bug that caused deleted items to show up on the holds shelf.
552 * Staff can now place multiple email addresses into the patron registration/
553 edit form, depending on the value of the `ui.patron.edit.au.email.regex`
555 * Fixes an issue with the offline circulation module.
556 * When merging two users, the non-lead account is now completely purged from
557 the database, rather than simply being marked as deleted.
558 * Fixes a bug which prevented the canceling of holds from the title
564 * Removes incorrect copy counts from metarecord search results pages
565 * Electronic resources now display in the browse interfaces
566 * Restores ability to request password resets
568 System administration
569 ^^^^^^^^^^^^^^^^^^^^^
571 * The example Apache 2.4 configuration now enables remoteip.
572 * Improves syntax in the fm_idl file.
577 We would like to thank the following individuals who contributed code,
578 tests and documentation patches to the 3.2.2 point release of
602 This release contains bug fixes improving on Evergreen 3.2.0.
607 * Adds several columns to the items out grid.
608 * Adds the ability to copy patron addresses to the clipboard.
609 * Fixes several issues with adding new items and call numbers.
610 * Adds links to catalog records from the query and pending tabs of the Record Buckets interface.
611 * Corrects the date format used in several bucket interfaces.
612 * Adds a loading spinner to interfaces that are embedded in the web staff client via iframe
613 (such as the catalog).
614 * The new Angular 6 interfaces now use the correct favicon.
618 We would like to thank the following individuals who contributed code,
619 tests and documentation patches to the 3.2.1 point release of
640 Disabling of Legacy XUL Staff Client
641 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
642 The legacy XUL staff client is no longer supported in Evergreen
643 3.2.x and the server-side installation no longer supports a
644 direct connection by a version XUL client by default. *All
645 users of Evergreen 3.2.x are strongly urged to complete their
646 switch to the web staff client as part of upgrading to 3.2.x.*
648 Evergreen administrators who for some reason continue to wish
649 to deploy the XUL staff client can do so at their risk by
650 supplying `STAFF_CLIENT_STAMP_ID` during the `make install` step
651 and using `make_release` to create installers for the staff client.
652 However, no community support will be provided for the XUL client.
659 Existing Acquisitions report templates that reference the invoice 'complete'
660 field should be modified to check whether the new close_date field is NOT NULL
663 At deploy time, all invoices with a 'complete' value of TRUE will have their
664 'close_date' field set to NOW. A value is required, since this field is
665 now the source of whether an invoice is open or closed.
667 However, no values will be applied to the closed_by field for already closed
671 Angular6 Base Application
672 ~~~~~~~~~~~~~~~~~~~~~~~~~
674 System Admin Upgrade Notes
675 ^^^^^^^^^^^^^^^^^^^^^^^^^^
677 Like the AngularJS application, Evergreen releases will come with all
678 web browser staff client code pre-compiled. Admins only need to add an
679 Apache configuration change.
681 Add the following stanza to /etc/apache2/eg_vhost.conf.
684 --------------------------------------------------------------------------
685 RewriteCond %{REQUEST_URI} ^/eg2/
686 RewriteCond %{REQUEST_URI} !^/eg2/([a-z]{2}-[A-Z]{2})/
687 RewriteRule ^/eg2/(.*) https://%{HTTP_HOST}/eg2/en-US/$1 [R=307,L]
689 <Directory "/openils/var/web/eg2/en-US">
690 FallbackResource /eg2/en-US/index.html
692 --------------------------------------------------------------------------
694 For multi-locale sites, see the bottom section of
695 Open-ILS/examples/apache[_24]/eg_vhost.conf.in for a sample fr-CA
696 configuration. The section starts with "/eg2/ client setup and locale
699 Developer Upgrade Notes
700 ^^^^^^^^^^^^^^^^^^^^^^^
702 Developers building Angular code on existing installations need to update
703 their version of NodeJS by re-running the -developer prereqs installer.
706 --------------------------------------------------------------------------
707 sudo make -f Open-ILS/src/extras/Makefile.install <osname>-developer
708 --------------------------------------------------------------------------
711 Asynchronous Vandelay Imports
712 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
714 Users of NGINX as a reverse proxy may need to set a suitable
715 `client_max_body_size` value in the NGINX configuration so that large
716 MARC record uploads are not truncated. Note that this would have
717 always been necessary, but since this feature allows larger files
718 to be more reliably queued and imported, the need to set `client_max_body_size`
719 became more apparent.
722 Browser Client Settings & Preferences Stored on the Server
723 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
725 A new permission APPLY_WORKSTATION_SETTING has been added to control who
726 may apply values to workstation settings. Use something like the following
727 to apply the permission to all staff accounts (mileage may vary):
730 --------------------------------------------------------------------------
731 INSERT INTO permission.grp_perm_map (grp, perm, depth)
733 (SELECT id FROM permission.grp_tree WHERE name = 'Staff'), -- name may vary
734 (SELECT id FROM permission.perm_list WHERE code =
735 'APPLY_WORKSTATION_SETTING'),
738 --------------------------------------------------------------------------
740 Workstation setting types matching values previously stored in the browser
741 (via localStorage or Hatch) are created as part of this feature. During
742 upgrade, admins should consider whether any of these new setting types
743 should be transferred to user and/or org unit settings instead. Setting
744 type changes can be made at any time, but when a setting type is deleted
745 all of its data is deleted, so a change in type means re-applying the
746 settings in the browser client.
748 Values stored in the browser will automatically migrate to server settings
749 as each setting is accessed in the browser client. Once migrated, the
750 in-browser copies are deleted.
752 If a setting type does not exist where the browser expects one, the
753 value is stored in-browser instead and a warning is issued in the console.
765 Auto-Cancel Line items When All Copies Are Canceled
766 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
767 When a copy (line item detail) is canceled through the Acquisitions interface,
768 the parent line item is also canceled if all copies for that line item are also
769 canceled. The cancel reason given will come from:
771 . The cancel reason for the just-canceled copy if it's a Keep Debits true
773 . The cancel reason from any other copy on the lineitem that has a Keep
774 Debits true cancel reason.
775 . The cancel reason for the just-canceled copy if no copies have a Keep
776 Debits true cancel reason.
779 Invoice Closed Date and Closed By Fields
780 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
781 Acquisitions invoices have 2 new fields:
783 * Close Date -- This is set to the time when the ACQ user clicks the "Close"
784 button in the invoice interface.
785 ** This field 'replaces' the existing 'complete' field. An invoice is
786 considered complete if a close date value is set.
787 * Closed By -- This is set to the logged in staff user who performs the
790 As with the now-defunct 'complete' field, but new fields are cleared in the
791 event an invoice is reopened.
793 These new fields are visible in the invoice interface under the
794 'Show Details' action for closed invoices.
796 Upgrading Invoice Reports
797 +++++++++++++++++++++++++
799 Existing report templates that reference the invoice 'complete' field
800 should be modified to check whether the new close_date field is NOT NULL
803 Other Upgrade Considerations
804 ++++++++++++++++++++++++++++
806 At deploy time, all invoices with a 'complete' value of TRUE will have their
807 'close_date' field set to NOW. A value is required, since this field is
808 now the source of whether an invoice is open or closed.
810 However, no values will be applied to the closed_by field for already closed
815 Patron Acquisitions Requests
816 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
818 The existing interface for staff-mediated patron acquisition requests has been replaced in the web staff client with a re-implementation written in AngularJS, with some minor bug fixes (including access from the Patron interface) and other improvements.
825 Hold Targeter Script has been Replaced
826 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
828 The original hold_targeter.pl script has been renamed to
829 "hold_targeter_legacy.pl", and the new-style hold targeting
830 script has been renamed to "hold_targeter.pl". Administrators
831 will want to change their crontab files to reflect this.
835 ---------------------------------------------------------------------
836 -*/15 * * * * . ~/.bashrc && $EG_BIN_DIR/hold_targeter.pl $SRF_CORE
837 ---------------------------------------------------------------------
841 -----------------------------------------------------------------------------------
842 -*/15 * * * * . ~/.bashrc && $EG_BIN_DIR/hold_targeter.pl --osrf-config
844 -----------------------------------------------------------------------------------
846 The sample crontab file at `Open-ILS/examples/crontab.example` reflects
854 Angular6 Base Application
855 ^^^^^^^^^^^^^^^^^^^^^^^^^
856 With Evergreen 3.2, we introduce the initial infrastructure for
857 migrating to a new version of Angular. The structure of the new code
858 is quite different from the AngularJS code and it runs as a separate
859 application which communicates with the AngularJS app via shared storage
860 and in-page URLs that link back and forth between the two.
862 For this release, users will only be directed to the new Angular site
863 when navigating to Administration => Acquisitions Administration. Once
864 on this page, some of the admin interfaces will presented as Angular6
865 interfaces, while others will direct users back to the AngularJS
866 application. The Angular6 interfaces are the simpler, grid-based
869 Acquisitions Admin Angular6 Interfaces
870 ++++++++++++++++++++++++++++++++++++++
875 * Claim Policy Actions
883 * Invoice Payment Method
885 * Line Item MARC Attribute Definitions
887 System Admin Upgrade Notes
888 ++++++++++++++++++++++++++
890 Like the AngularJS application, Evergreen releases will come with all
891 web browser staff client code pre-compiled. Admins only need to add an
892 Apache configuration change.
894 Add the following stanza to /etc/apache2/eg_vhost.conf.
897 --------------------------------------------------------------------------
898 RewriteCond %{REQUEST_URI} ^/eg2/
899 RewriteCond %{REQUEST_URI} !^/eg2/([a-z]{2}-[A-Z]{2})/
900 RewriteRule ^/eg2/(.*) https://%{HTTP_HOST}/eg2/en-US/$1 [R=307,L]
902 <Directory "/openils/var/web/eg2/en-US">
903 FallbackResource /eg2/en-US/index.html
905 --------------------------------------------------------------------------
907 For multi-locale sites, see the bottom section of
908 Open-ILS/examples/apache[_24]/eg_vhost.conf.in for a sample fr-CA
909 configuration. The section starts with "/eg2/ client setup and locale
912 Developer Upgrade Notes
913 +++++++++++++++++++++++
915 Developers building Angular code on existing installations need to update
916 their version of NodeJS by re-running the -developer prereqs installer.
919 --------------------------------------------------------------------------
920 sudo make -f Open-ILS/src/extras/Makefile.install <osname>-developer
921 --------------------------------------------------------------------------
927 Add UPC to z39.50 search for OCLC and LOC
928 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
929 Add UPC as a search attribute for both OCLC and LOC targets in
930 z39.50 for cataloging.
933 Asynchronous Vandelay Imports
934 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
936 Vandelay imports are now monitored from the browser client asynchronously,
937 meaning the client requests updates from the server instead of waiting for
938 the server to respond to the original import request. This changes allows
939 for incremental progress updates in the browser client.
944 This adds a new database table vandelay.session_tracker for tracking
945 in-progress vandelay upload activity. A new tracker row is added for
946 each of "upload", "enqueue", and "import" actions, linked for a given
947 session by the value stored in the "session_key" field.
949 The table tracks other potentially useful data, like the staff member
950 and workstation where the action was performed.
954 Users of NGINX as a reverse proxy may need to set a suitable
955 `client_max_body_size` value in the NGINX configuration so that large
956 MARC record uploads are not truncated. Note that this would have
957 always been necessary, but since this feature allows larger files
958 to be more reliably queued and imported, the need to set `client_max_body_size`
959 became more apparent.
964 Support for Last Inventory Date
965 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
966 Evergreen now provides an option to add an inventory date to items to facilitate
967 the process of performing inventory in libraries. Staff can add an inventory
968 date to an item in one of the following ways:
969 * From the check in screen, there is now an Update Inventory check in modifier.
970 When selected, scanned barcodes will have the current date/time added as the
971 inventory date while the item is checked in.
972 * From the Item Status screen, an action is available to add the current
973 date/time as the inventory date to selected items.
975 This new feature will also store the workstation that was used when the
976 inventory date was updated.
980 Parallel Ingest with pingest.pl
981 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
982 A program named pingest.pl is now installed to allow faster bibliographic record
983 ingest. It performs ingest in parallel so that multiple batches can
984 be done simultaneously. It operates by splitting the records to be
985 ingested up into batches and running all of the ingest methods on each
986 batch. You may pass in options to control how many batches are run at
987 the same time, how many records there are per batch, and which ingest
990 NOTE: The browse ingest is presently done in a single process over all
991 of the input records as it cannot run in parallel with itself. It
992 does, however, run in parallel with the other ingests.
996 pingest.pl accepts the following command line options:
999 The server where PostgreSQL runs (either host name or IP address).
1000 The default is read from the PGHOST environment variable or
1004 The port that PostgreSQL listens to on host. The default is read
1005 from the PGPORT environment variable or 5432.
1008 The database to connect to on the host. The default is read from
1009 the PGDATABASE environment variable or "evergreen."
1012 The username for database connections. The default is read from
1013 the PGUSER environment variable or "evergreen."
1016 The password for database connections. The default is read from
1017 the PGPASSWORD environment variable or "evergreen."
1020 Number of records to process per batch. The default is 10,000.
1023 Max number of worker processes (i.e. the number of batches to
1024 process simultaneously). The default is 8.
1031 Skip the selected reingest component.
1034 Start processing at this record ID.
1037 Stop processing when this record ID is reached.
1040 Read record IDs to reingest from standard input. This option
1041 conflicts with --start-id and/or --end-id.
1044 Stop processing after this many total seconds have passed. The
1045 default is to run until all records have been processed.
1052 View Authority Record by Database ID
1053 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1055 A new interface allows catalogers to retrieve a specific
1056 authority record using its database ID. Catalogers can
1057 find those IDs in subfield $0 of matching fields in
1058 bibliographic records.
1060 To use the new authority record viewer:
1062 . Click *Cataloging -> Retrieve Authority Record by ID*.
1063 . Type in the ID number of the authority record you are
1064 interested in. Don't include any prefixes, just the ID
1067 . View or edit the authority record as needed.
1076 Autorenewal of Loans
1077 ^^^^^^^^^^^^^^^^^^^^
1078 Circulation policies in Evergreen can now be configured to automatically renew
1079 certain items checked out on patron accounts. Circulations will be renewed
1080 automatically up to a custom limit (the `max_auto_renewal` field) and patrons
1081 will not need to log in to their OPAC accounts or ask library staff to manually
1084 Two new action triggers have been added to Evergreen that permit the Auto-Renew
1085 feature. They can be found, configured, and enabled in Administration>Local
1086 Administration>Notifications/Action Triggers. They are named **Autorenew** and
1087 **AutorenewNotify**.
1089 The **Autorenew** A/T definition uses the `checkout.due` hook to automatically
1090 validate and renew (in the reactor) circulations on the day they are due,
1091 grouped by user. The output events of this definition is is the input used by
1092 the related **AutorenewNotify** A/T that simply uses a new hook called
1093 `autorenewal` to notify patrons via email of their currently due or
1096 In the webstaff's Patron Items Out page, the new column `AutoRenewalsRemaining`
1097 indicates how many autorenewals are available for a particular circulation.
1103 Emergency Closing Handler
1104 ^^^^^^^^^^^^^^^^^^^^^^^^
1106 Staff are provided with interfaces and mechanisms to create library closings
1107 that, in addition to affecting future circulation and booking due dates, and
1108 hold shelf expirations, will automatically move existing circulation and booking
1109 due dates and hold shelf expiration times. This new functionality is
1110 conceptually described as Emergency Closings and business logic implementing it
1111 as the Emergency Closing Handler. It contains additions and adjustments to the
1112 user interface, business logic, and database layers. Access to this
1113 functionality is available through the Closed Dates Editor interface in the
1114 staff client which has been ported to AngularJS.
1119 This development has created new business logic code to inspect, in real time,
1120 existing circulation, booking, and hold records, and modify such date and time
1121 stamps so that the circulation, booking, or hold will end in the same state it
1122 would have if the closing had existed at the time the circulation or booking
1123 occurred, or the hold was placed and captured. Of specific note, hourly loans
1124 will have their due date adjusted to be the end of the day following the
1127 When the Emergency Closing is saved, any fines accrued during the closing may be
1128 voided, as settings dictate, with the exception of circulations that have been
1129 marked as LOST or LONG OVERDUE. That is, even for LOST and LONG OVERDUE
1130 circulations with due dates that fall within the Emergency Closing, no fine
1131 adjustment will be applied. Emergency Closing processing is permanent, and
1132 cannot be rolled back.
1134 This functionality is explicitly initiated by staff action. If staff do not
1135 request an Emergency Closing, existing circulations, bookings, and holds will
1136 not be processed and adjusted. However, if staff request any Closing that starts
1137 nearer in time than the length of the longest circulation duration configured
1138 for use in the Evergreen instance they will be prompted with the option to
1139 create the closing as an Emergency Closing.
1141 Action/Trigger hooks have been created for circulations and bookings that are
1142 adjusted by the Emergency Closing Handler. These will facilitate the creation of
1143 notifications to patrons that the due date has changed and to alert them to
1144 potential changes in accrued fines.
1146 Booking start dates are explicitly ignored in this implementation. Because an
1147 Emergency Closing is, by its nature, an unexpected event, it will be up to staff
1148 to address any bookings which intersect with a new Emergency Closings. Reports
1149 can be used to identify booking start dates that overlap with a closing and that
1150 may require staff intervention.
1152 Staff requesting and Emergency Closing must have the new EMERGENCY_CLOSING
1153 permission. Some text describing the feature.
1159 Patron Preferred Name and Name Search Keywords
1160 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1165 Adds a new set of patron preferred name fields for prefix, first,
1166 middle, last, and suffix allowing patrons to provide preferred name
1167 information. Preferred names are optional and each acts as an overlay
1168 to the analogous primary name field, making it possible to provide
1169 preferred name values for individual fields.
1171 For example, a patron named William Erickson may have a preferred first
1172 name (pref_first_given_name) of Bill, in which case the preferred name
1173 would be Bill Erickson. Note a preferred last name is not required in
1174 this case as the code uses primary name values as defaults when not
1175 replaced with a preferred version.
1177 * Patrons will see primary names displayed in the catalog when set.
1178 * Staff will see both primary name and preferred name in the patron
1180 * Patron searches for any given name field will search both the primary
1181 and preferred name data.
1182 * Preferred name fields are available in Action/Trigger templates and
1183 are present in various patron-focused print templates.
1188 Adds a new field to store miscellaneous patron name search terms. These
1189 values are only for searching and do not appear in any interfaces, apart
1190 from the patron summary side bar and the patron edit UI.
1192 Included is a new search field in the patron search UI which searches
1193 keyword values and all other name fields. It's essentially a global patron
1194 name keyword search.
1202 Disabling of legacy XUL staff client
1203 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1204 The legacy XUL staff client is no longer supported in Evergreen
1205 3.2.x and the server-side installation no longer supports a
1206 direct connection by a version XUL client by default. All
1207 users of Evergreen 3.2.x are strongly urged to complete their
1208 switch to the web staff client as part of upgrading to 3.2.x.
1210 Evergreen administrators who for some reason continue to wish
1211 to deploy the XUL staff client can do so at their risk by
1212 supplying `STAFF_CLIENT_STAMP_ID` during the `make install` step
1213 and using `make_release` to create installers for the staff client.
1214 However, no community support will be provided for the XUL client.
1219 Permission Group Display Entries
1220 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1221 In some cases, it is useful to have the ability to reorder permission, or to make
1222 only specific groups available in the permission group selector for specific
1223 Org Units. An interface has been made available to allow this.
1225 Group Tree Display Entry Interface
1226 ++++++++++++++++++++++++++++++++++
1228 Permission Group Display Entries can be reordered, added, or removed via
1229 _Administration -> Local Admin -> Permission Tree Display Entries_.
1230 Select the Org Unit you wish to edit the entries in.
1232 Entries may be added using the Add functionality, creating entries based
1233 on permission groups that have not been added to the tree for the Org
1234 Unit you wish to add them to.
1236 image::media/pgtde_01.png[Group Tree Display Entry Admin UI]
1240 Moving an entry will shift its position up or down in the patron profile
1241 selector for a given Org Unit.
1244 * Press either the *Move Up* or *Move Down* button. The entry will be
1245 moved up or down, accordingly.
1246 * Click *Save* to save your edits.
1248 NOTE: You may only move up or down entries that have sibling entries.
1252 If you want a particular Org Unit to not have access to specific
1253 entries, you may remove an entry. Removing an entry will remove it from
1254 view. The entry will be removed from the database.
1256 * Select an entry and press the *Remove* button.
1260 You may add entries from permission groups that are not currently
1261 reflected in the permission group tree. This is useful for moving
1262 entries to different parents, or making them root entries.
1264 image::media/pgtde_02.png[Add Entry modal]
1266 * If desired, select an entry to be used as the parent entry.
1267 * Press the *Add* button.
1268 * Select a permission group from the dropdown.
1269 * If you've selected a parent entry, you may check the *Add Root Entry*
1270 box to override that parent and add the entry on the root level.
1271 * If you did not select a parent entry, the entry will be added on the root
1276 Browser Client Settings & Preferences Stored on the Server
1277 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1278 Browser client settings and preferences that should persist over time are
1279 now stored as settings on the server. This allows settings to follow
1280 users and workstations and reduces problems associated with losing settings
1281 as a result of clearing browser data.
1283 The browser client honors setting values stored as user settings, workstation
1284 settings, and org unit settings, depending on which setting types are
1290 * No setting can be both a user and workstation setting. They are mutually
1292 * Any setting can be an org unit setting in addition to being a user or
1293 workstation setting.
1298 Read-only settings are useful for defining values that staff can use but
1299 not modify. For example, admins may wish to prevent users from locally
1300 modifying the grid configuration for a given interface so it remains
1301 consistent for all users.
1303 A setting is read-only when an org unit setting type exists (regardless of
1304 whether a value is applied) and no user or workstation setting type exists.
1306 Server-Stored Workstation Settings Workstation Admin View
1307 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1309 There's a new "Server Workstation Prefs" tab to the stored preferences
1310 workstation admin interface. From here, users can view which
1311 preferences are stored as server-stored workstation preferences and
1312 delete select values.
1317 A new permission APPLY_WORKSTATION_SETTING has been added to control who
1318 may apply values to workstation settings. Use something like the following
1319 to apply the permission to all staff accounts (mileage may vary):
1322 --------------------------------------------------------------------------
1323 INSERT INTO permission.grp_perm_map (grp, perm, depth)
1325 (SELECT id FROM permission.grp_tree WHERE name = 'Staff'), -- name may vary
1326 (SELECT id FROM permission.perm_list WHERE code = 'APPLY_WORKSTATION_SETTING'),
1329 --------------------------------------------------------------------------
1331 Workstation setting types matching values previously stored in the browser
1332 (via localStorage or Hatch) are created as part of this feature. During
1333 upgrade, admins should consider whether any of these new setting types
1334 should be transferred to user and/or org unit settings instead. Setting
1335 type changes can be made at any time, but when a setting type is deleted
1336 all of its data is deleted, so a change in type means re-applying the
1337 settings in the browser client.
1339 Values stored in the browser will automatically migrate to server settings
1340 as each setting is accessed in the browser client. Once migrated, the
1341 in-browser copies are deleted.
1343 If a setting type does not exist where the browser expects one, the
1344 value is stored in-browser instead and a warning is issued in the console.
1347 More consistent terminology in the client
1348 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1349 Terminology has been updated in the staff client so that we consistently use
1350 the same name to describe the same thing. The following updates have been made:
1352 * The term 'item' is now consistently used to describe the barcoded entity
1353 that had been previously been called both an 'item' and a 'copy'. As a result,
1354 we now use the terms 'item buckets', 'item tags', and 'item alerts'.
1355 * The term 'volume' is no longer used in the client, with the exception of
1356 serials, where the term is used to describe serial volumes. The term 'call
1357 number' will replace volume in most other places.
1358 * 'Holdings' is a more general term used to describe a combination of items
1360 * The term 'Shelving Location' is used consistently in favor of 'Copy
1371 Batch Actions In the Public Catalog
1372 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1373 The public catalog now displays checkboxes on the bibliographic and
1374 metarecord constituents results pages. Selecting one or more titles
1375 by using the checkboxes will dynamically add those title to the
1376 temporary list, which is now renamed the cart.
1378 Above the results lists there is now a bar with a select-all checkbox,
1379 a link to the cart management page that also indicates the number of
1380 of titles in the cart, and a link to remove from the cart titles that
1381 are selected on the currently displayed results page.
1383 The search bar now includes an icon of a cart and displays the number
1384 of titles currently in the cart. Next to that icon is a menu of cart
1387 The cart actions available are Place Hold, Print Title Details,
1388 Email Title Details, Add Cart to Saved List, and Clear Cart. In the
1389 web staff client, the cart actions also include Add Cart to Bucket.
1390 When an action is selected from this menu, the user is given an
1391 opportunity to confirm the action and to optionally empty the cart
1392 when the action is complete. The action is applied to all titles
1395 Clicking on the cart icon brings the user to a page listing the
1396 titles in the cart. From there, the user can select specific records
1397 to request, print, email, add to a list, or remove from the cart.
1399 The list of actions on the record details page now provides separate
1400 links for adding the title to a cart or to a permanent list.
1402 The permanent list management page in the public catalog now also
1403 includes batch print and email actions.
1405 Additional information
1406 ++++++++++++++++++++++
1407 * The checkboxes do not display on the metarecord results page, as
1408 metarecords currently cannot be put into carts or lists.
1409 * The checkboxes are displayed only if JavaScript is enabled. However,
1410 users can still add items to the cart and perform batch actions on
1411 the cart and on lists.
1412 * A template `config.tt2` setting, `ctx.max_cart_size`, can be used to
1413 set a soft limit on the number of titles that can be added to the
1414 cart. If this limit is reached, checkboxes to add more records to the
1415 cart are disabled unless existing titles in the cart are removed
1416 first. The default value for this setting is 500.
1421 This patch adds to the public catalog two routes that return JSON
1424 * `GET /eg/opac/api/mylist/add?record=45`
1425 * `GET /eg/opac/api/mylist/delete?record=45`
1427 The JSON response is a hash containing a mylist key pointing to the list
1428 of bib IDs of contents of the cart.
1430 The record parameter can be repeated to allow adding or removing
1431 records as an atomic operation. Note that this change also now available
1432 to `/eg/opac/mylist/{add,delete}`
1434 More generally, this adds a way for EGWeb context loaders to specify that
1435 a response should be emitted as JSON rather than rendering an HTML
1436 page using `Template::Toolkit`.
1438 Specifically, if the context as munged by the context loader contains
1439 a `json_response` key, the contents of that key will to provide a
1440 JSON response. The `json_response_cookie` key, if present, can be used
1441 to set a cookie as part of the response.
1443 Template Toolkit processing is bypassed entirely when emitting a JSON
1444 response, so the context loader would be entirely responsible for
1445 localization of strings in the response meant for direct human
1451 New class for searchbar when on the homepage
1452 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1454 This adds the `.searchbar-home` class to the div that contains the searchbar
1455 when on the homepage. This allows sites to customize the searchbar differently
1456 on the homepage than in other places the search bar appears (for example,
1457 offering a large, Google-style search bar on the homepage only).
1462 To make customization easier, the username hint on the OPAC login page ("Please
1463 include leading zeros...") has been moved to a separate TT2 template. If you
1464 have customized the hint text, you will need to add your modifications to
1471 The Evergreen project would like to acknowledge the following
1472 organizations that commissioned developments in this release of
1475 * BC Libraries Cooperative
1476 * Consortium Of Ohio Libraries
1478 * Georgia Public Library Service
1479 * Indiana State Library
1480 * Lake Agassiz Regrional Library
1482 * North Texas Library Consortium
1483 * Northwest Regional Library
1484 * Pennsylvania Integrated Library System
1485 * South Carolina State Library
1487 We would also like to thank the following individuals who contributed
1488 code, translations, documentations patches and tests to this release of
1493 * Andrea Buntz Neiman
1502 * Blake Graham-Henderson
1503 * Francisco J Guel-Mendoza
1521 We also thank the following organizations whose employees contributed
1524 * BC Libraries Cooperative
1527 * Equinox Open Library Initiative
1528 * Government of Manitoba
1529 * Kenton County Public Library
1530 * King County Library System
1531 * Linn-Benton Community College
1535 We regret any omissions. If a contributor has been inadvertently
1536 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob