1 Evergreen 3.2 Release Notes
2 ===========================
9 This release contains bug fixes improving on Evergreen 3.2.3.
10 All bug fixes refer to the web staff client unless otherwise specified.
18 * Adds appropriate alt text to the Evergreen splash page (https://bugs.launchpad.net/evergreen/+bug/1802594[Bug #1802594])
19 * 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])
24 * Fixes an issue that prevented purchase orders to not open in a new tab (https://bugs.launchpad.net/evergreen/+bug/1813290[Bug #1813290])
29 * The Billing History grids now save their configuration in the database (https://bugs.launchpad.net/evergreen/+bug/1806709[Bug #1806709])
34 * Catalogers can now set the Bib Source in the Z39.50 Overlay and Import interfaces (https://bugs.launchpad.net/evergreen/+bug/1727345[Bug #1727345])
35 * Fixes an issue where publishers display in the publication date column in copy buckets (https://bugs.launchpad.net/evergreen/+bug/1812698[Bug #1812698])
36 * Electronic reources no longer display a call number called _##URI##_ in the Volume Editor (https://bugs.launchpad.net/evergreen/+bug/1752665[Bug #1752665])
37 * Spine/pocket label templates can now include circulation library and owning library (https://bugs.launchpad.net/evergreen/+bug/1726568[Bug #1726568])
43 * Fixes an issue where external documentation links can open in the reports module (https://bugs.launchpad.net/evergreen/+bug/1784893[Bug #1784893])
44 * Fixes an issue where publishers display as a publication date in reports (https://bugs.launchpad.net/evergreen/+bug/1812698[Bug #1812698])
49 * Staff users can now set their prefered default Advanced Search pane (https://bugs.launchpad.net/evergreen/+bug/1799963[Bug #1799963])
50 * 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])
55 * The _DELETE_COPY_ALERT_ permission no longer needs to be granted on the consortium level (https://bugs.launchpad.net/evergreen/+bug/1783421[Bug #1783421])
60 * The angular client now uses Angular 7 (https://bugs.launchpad.net/evergreen/+bug/1801984[Bug #1801984])
61 * 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])
62 * Angular client pages now display their own titles in the browser tab, rather than _AngEG_ (https://bugs.launchpad.net/evergreen/+bug/1813647[Bug #1813647])
67 We would like to thank the following individuals who contributed code,
68 tests and documentation patches to the 3.2.4 point release of
91 This release contains bug fixes improving on Evergreen 3.2.3.
92 All bug fixes refer to the staff client unless otherwise specified.
100 * Hatch is now deprecated for local data storage. Hatch is
101 still recommended for printing in certain situations.
106 * The new `edi_order_pusher.pl` now only pushes purchase orders
107 with a state of "on-order", to prevent older purchase orders
108 from being unintentionally pushed to vendors.
113 * The Z39.50 and record bucket interfaces now open relevant
114 catalog records in new tabs.
115 * Fixes a bug that prevented batch importing authority records.
116 * The template dropdown in the holdings editor now provides more
117 space to accommodate longer template names.
118 * The drop-down of copy tag types in the Manage Copy Tags dialog
119 now includes the owning library of the copy tag type.
124 * Fixes an issue with recalling checked-out materials.
125 * Added several missing columns to the patron bills grid.
126 * Corrected the display of the Bill Type column in the patron bills grid.
127 * Clarified the names of the "Billing Location" and "Grocery Billing
128 Location" columns in the patron bills grid.
129 * The Bill Full Details grid now includes a billing location column
130 for both circulation and grocery bills, as well as the owning library for
132 * The Billing History transactions grid now remembers any changes that
133 users make to the column settings.
134 * Fixes an issue with printing multiple copies of bills.
135 * Fixes an issue with saving self-registered patron accounts.
136 * Staff can now delete self-registered patron accounts.
138 System administration
139 ^^^^^^^^^^^^^^^^^^^^^
141 * Fixes the marc_stream_importer to be compatible with Vandelay session
143 * Includes an accessibility improvement for the Acquisitions
144 Administration interfaces.
149 We would like to thank the following individuals who contributed code,
150 tests and documentation patches to the 3.2.3 point release of
155 * Andrea Buntz Neiman
173 This release contains bug fixes improving on Evergreen 3.2.1.
174 All bug fixes refer to the web staff client unless otherwise specified.
182 * Fixes a bug that blocked logging in from mobile browsers
183 * Fixes a readability issue with mobile menus
184 * Fixes performance issue related to grid tooltips.
185 * Fixes an issue that caused some grid columns to appear
191 * Improves the functionality of setting a default tab of a bib record
192 * The web client now remembers the most recently selected copy template
193 * Adds help tips to Print Item Labels Settings tab
194 * If you add or edit copies and/or volumes from the Holdings View tab,
195 the view now automatically refreshes to show your changes.
196 * Provides an upgrade to MODS 3.3 for older Evergreen installations.
197 * Improves usability of Z39.50 MARC View.
203 * Fixes a daylight savings time-related circulation bug.
204 * Fixes a bug that caused deleted items to show up on the holds shelf.
205 * Staff can now place multiple email addresses into the patron registration/
206 edit form, depending on the value of the `ui.patron.edit.au.email.regex`
208 * Fixes an issue with the offline circulation module.
209 * When merging two users, the non-lead account is now completely purged from
210 the database, rather than simply being marked as deleted.
211 * Fixes a bug which prevented the canceling of holds from the title
217 * Removes incorrect copy counts from metarecord search results pages
218 * Electronic resources now display in the browse interfaces
219 * Restores ability to request password resets
221 System administration
222 ^^^^^^^^^^^^^^^^^^^^^
224 * The example Apache 2.4 configuration now enables remoteip.
225 * Improves syntax in the fm_idl file.
230 We would like to thank the following individuals who contributed code,
231 tests and documentation patches to the 3.2.2 point release of
255 This release contains bug fixes improving on Evergreen 3.2.0.
260 * Adds several columns to the items out grid.
261 * Adds the ability to copy patron addresses to the clipboard.
262 * Fixes several issues with adding new items and call numbers.
263 * Adds links to catalog records from the query and pending tabs of the Record Buckets interface.
264 * Corrects the date format used in several bucket interfaces.
265 * Adds a loading spinner to interfaces that are embedded in the web staff client via iframe
266 (such as the catalog).
267 * The new Angular 6 interfaces now use the correct favicon.
271 We would like to thank the following individuals who contributed code,
272 tests and documentation patches to the 3.2.1 point release of
293 Disabling of Legacy XUL Staff Client
294 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
295 The legacy XUL staff client is no longer supported in Evergreen
296 3.2.x and the server-side installation no longer supports a
297 direct connection by a version XUL client by default. *All
298 users of Evergreen 3.2.x are strongly urged to complete their
299 switch to the web staff client as part of upgrading to 3.2.x.*
301 Evergreen administrators who for some reason continue to wish
302 to deploy the XUL staff client can do so at their risk by
303 supplying `STAFF_CLIENT_STAMP_ID` during the `make install` step
304 and using `make_release` to create installers for the staff client.
305 However, no community support will be provided for the XUL client.
312 Existing Acquisitions report templates that reference the invoice 'complete'
313 field should be modified to check whether the new close_date field is NOT NULL
316 At deploy time, all invoices with a 'complete' value of TRUE will have their
317 'close_date' field set to NOW. A value is required, since this field is
318 now the source of whether an invoice is open or closed.
320 However, no values will be applied to the closed_by field for already closed
324 Angular6 Base Application
325 ~~~~~~~~~~~~~~~~~~~~~~~~~
327 System Admin Upgrade Notes
328 ^^^^^^^^^^^^^^^^^^^^^^^^^^
330 Like the AngularJS application, Evergreen releases will come with all
331 web browser staff client code pre-compiled. Admins only need to add an
332 Apache configuration change.
334 Add the following stanza to /etc/apache2/eg_vhost.conf.
337 --------------------------------------------------------------------------
338 RewriteCond %{REQUEST_URI} ^/eg2/
339 RewriteCond %{REQUEST_URI} !^/eg2/([a-z]{2}-[A-Z]{2})/
340 RewriteRule ^/eg2/(.*) https://%{HTTP_HOST}/eg2/en-US/$1 [R=307,L]
342 <Directory "/openils/var/web/eg2/en-US">
343 FallbackResource /eg2/en-US/index.html
345 --------------------------------------------------------------------------
347 For multi-locale sites, see the bottom section of
348 Open-ILS/examples/apache[_24]/eg_vhost.conf.in for a sample fr-CA
349 configuration. The section starts with "/eg2/ client setup and locale
352 Developer Upgrade Notes
353 ^^^^^^^^^^^^^^^^^^^^^^^
355 Developers building Angular code on existing installations need to update
356 their version of NodeJS by re-running the -developer prereqs installer.
359 --------------------------------------------------------------------------
360 sudo make -f Open-ILS/src/extras/Makefile.install <osname>-developer
361 --------------------------------------------------------------------------
364 Asynchronous Vandelay Imports
365 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
367 Users of NGINX as a reverse proxy may need to set a suitable
368 `client_max_body_size` value in the NGINX configuration so that large
369 MARC record uploads are not truncated. Note that this would have
370 always been necessary, but since this feature allows larger files
371 to be more reliably queued and imported, the need to set `client_max_body_size`
372 became more apparent.
375 Browser Client Settings & Preferences Stored on the Server
376 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
378 A new permission APPLY_WORKSTATION_SETTING has been added to control who
379 may apply values to workstation settings. Use something like the following
380 to apply the permission to all staff accounts (mileage may vary):
383 --------------------------------------------------------------------------
384 INSERT INTO permission.grp_perm_map (grp, perm, depth)
386 (SELECT id FROM permission.grp_tree WHERE name = 'Staff'), -- name may vary
387 (SELECT id FROM permission.perm_list WHERE code =
388 'APPLY_WORKSTATION_SETTING'),
391 --------------------------------------------------------------------------
393 Workstation setting types matching values previously stored in the browser
394 (via localStorage or Hatch) are created as part of this feature. During
395 upgrade, admins should consider whether any of these new setting types
396 should be transferred to user and/or org unit settings instead. Setting
397 type changes can be made at any time, but when a setting type is deleted
398 all of its data is deleted, so a change in type means re-applying the
399 settings in the browser client.
401 Values stored in the browser will automatically migrate to server settings
402 as each setting is accessed in the browser client. Once migrated, the
403 in-browser copies are deleted.
405 If a setting type does not exist where the browser expects one, the
406 value is stored in-browser instead and a warning is issued in the console.
418 Auto-Cancel Line items When All Copies Are Canceled
419 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
420 When a copy (line item detail) is canceled through the Acquisitions interface,
421 the parent line item is also canceled if all copies for that line item are also
422 canceled. The cancel reason given will come from:
424 . The cancel reason for the just-canceled copy if it's a Keep Debits true
426 . The cancel reason from any other copy on the lineitem that has a Keep
427 Debits true cancel reason.
428 . The cancel reason for the just-canceled copy if no copies have a Keep
429 Debits true cancel reason.
432 Invoice Closed Date and Closed By Fields
433 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
434 Acquisitions invoices have 2 new fields:
436 * Close Date -- This is set to the time when the ACQ user clicks the "Close"
437 button in the invoice interface.
438 ** This field 'replaces' the existing 'complete' field. An invoice is
439 considered complete if a close date value is set.
440 * Closed By -- This is set to the logged in staff user who performs the
443 As with the now-defunct 'complete' field, but new fields are cleared in the
444 event an invoice is reopened.
446 These new fields are visible in the invoice interface under the
447 'Show Details' action for closed invoices.
449 Upgrading Invoice Reports
450 +++++++++++++++++++++++++
452 Existing report templates that reference the invoice 'complete' field
453 should be modified to check whether the new close_date field is NOT NULL
456 Other Upgrade Considerations
457 ++++++++++++++++++++++++++++
459 At deploy time, all invoices with a 'complete' value of TRUE will have their
460 'close_date' field set to NOW. A value is required, since this field is
461 now the source of whether an invoice is open or closed.
463 However, no values will be applied to the closed_by field for already closed
468 Patron Acquisitions Requests
469 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
471 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.
478 Hold Targeter Script has been Replaced
479 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
481 The original hold_targeter.pl script has been renamed to
482 "hold_targeter_legacy.pl", and the new-style hold targeting
483 script has been renamed to "hold_targeter.pl". Administrators
484 will want to change their crontab files to reflect this.
488 ---------------------------------------------------------------------
489 -*/15 * * * * . ~/.bashrc && $EG_BIN_DIR/hold_targeter.pl $SRF_CORE
490 ---------------------------------------------------------------------
494 -----------------------------------------------------------------------------------
495 -*/15 * * * * . ~/.bashrc && $EG_BIN_DIR/hold_targeter.pl --osrf-config
497 -----------------------------------------------------------------------------------
499 The sample crontab file at `Open-ILS/examples/crontab.example` reflects
507 Angular6 Base Application
508 ^^^^^^^^^^^^^^^^^^^^^^^^^
509 With Evergreen 3.2, we introduce the initial infrastructure for
510 migrating to a new version of Angular. The structure of the new code
511 is quite different from the AngularJS code and it runs as a separate
512 application which communicates with the AngularJS app via shared storage
513 and in-page URLs that link back and forth between the two.
515 For this release, users will only be directed to the new Angular site
516 when navigating to Administration => Acquisitions Administration. Once
517 on this page, some of the admin interfaces will presented as Angular6
518 interfaces, while others will direct users back to the AngularJS
519 application. The Angular6 interfaces are the simpler, grid-based
522 Acquisitions Admin Angular6 Interfaces
523 ++++++++++++++++++++++++++++++++++++++
528 * Claim Policy Actions
536 * Invoice Payment Method
538 * Line Item MARC Attribute Definitions
540 System Admin Upgrade Notes
541 ++++++++++++++++++++++++++
543 Like the AngularJS application, Evergreen releases will come with all
544 web browser staff client code pre-compiled. Admins only need to add an
545 Apache configuration change.
547 Add the following stanza to /etc/apache2/eg_vhost.conf.
550 --------------------------------------------------------------------------
551 RewriteCond %{REQUEST_URI} ^/eg2/
552 RewriteCond %{REQUEST_URI} !^/eg2/([a-z]{2}-[A-Z]{2})/
553 RewriteRule ^/eg2/(.*) https://%{HTTP_HOST}/eg2/en-US/$1 [R=307,L]
555 <Directory "/openils/var/web/eg2/en-US">
556 FallbackResource /eg2/en-US/index.html
558 --------------------------------------------------------------------------
560 For multi-locale sites, see the bottom section of
561 Open-ILS/examples/apache[_24]/eg_vhost.conf.in for a sample fr-CA
562 configuration. The section starts with "/eg2/ client setup and locale
565 Developer Upgrade Notes
566 +++++++++++++++++++++++
568 Developers building Angular code on existing installations need to update
569 their version of NodeJS by re-running the -developer prereqs installer.
572 --------------------------------------------------------------------------
573 sudo make -f Open-ILS/src/extras/Makefile.install <osname>-developer
574 --------------------------------------------------------------------------
580 Add UPC to z39.50 search for OCLC and LOC
581 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
582 Add UPC as a search attribute for both OCLC and LOC targets in
583 z39.50 for cataloging.
586 Asynchronous Vandelay Imports
587 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
589 Vandelay imports are now monitored from the browser client asynchronously,
590 meaning the client requests updates from the server instead of waiting for
591 the server to respond to the original import request. This changes allows
592 for incremental progress updates in the browser client.
597 This adds a new database table vandelay.session_tracker for tracking
598 in-progress vandelay upload activity. A new tracker row is added for
599 each of "upload", "enqueue", and "import" actions, linked for a given
600 session by the value stored in the "session_key" field.
602 The table tracks other potentially useful data, like the staff member
603 and workstation where the action was performed.
607 Users of NGINX as a reverse proxy may need to set a suitable
608 `client_max_body_size` value in the NGINX configuration so that large
609 MARC record uploads are not truncated. Note that this would have
610 always been necessary, but since this feature allows larger files
611 to be more reliably queued and imported, the need to set `client_max_body_size`
612 became more apparent.
617 Support for Last Inventory Date
618 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
619 Evergreen now provides an option to add an inventory date to items to facilitate
620 the process of performing inventory in libraries. Staff can add an inventory
621 date to an item in one of the following ways:
622 * From the check in screen, there is now an Update Inventory check in modifier.
623 When selected, scanned barcodes will have the current date/time added as the
624 inventory date while the item is checked in.
625 * From the Item Status screen, an action is available to add the current
626 date/time as the inventory date to selected items.
628 This new feature will also store the workstation that was used when the
629 inventory date was updated.
633 Parallel Ingest with pingest.pl
634 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
635 A program named pingest.pl is now installed to allow faster bibliographic record
636 ingest. It performs ingest in parallel so that multiple batches can
637 be done simultaneously. It operates by splitting the records to be
638 ingested up into batches and running all of the ingest methods on each
639 batch. You may pass in options to control how many batches are run at
640 the same time, how many records there are per batch, and which ingest
643 NOTE: The browse ingest is presently done in a single process over all
644 of the input records as it cannot run in parallel with itself. It
645 does, however, run in parallel with the other ingests.
649 pingest.pl accepts the following command line options:
652 The server where PostgreSQL runs (either host name or IP address).
653 The default is read from the PGHOST environment variable or
657 The port that PostgreSQL listens to on host. The default is read
658 from the PGPORT environment variable or 5432.
661 The database to connect to on the host. The default is read from
662 the PGDATABASE environment variable or "evergreen."
665 The username for database connections. The default is read from
666 the PGUSER environment variable or "evergreen."
669 The password for database connections. The default is read from
670 the PGPASSWORD environment variable or "evergreen."
673 Number of records to process per batch. The default is 10,000.
676 Max number of worker processes (i.e. the number of batches to
677 process simultaneously). The default is 8.
684 Skip the selected reingest component.
687 Start processing at this record ID.
690 Stop processing when this record ID is reached.
693 Read record IDs to reingest from standard input. This option
694 conflicts with --start-id and/or --end-id.
697 Stop processing after this many total seconds have passed. The
698 default is to run until all records have been processed.
705 View Authority Record by Database ID
706 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
708 A new interface allows catalogers to retrieve a specific
709 authority record using its database ID. Catalogers can
710 find those IDs in subfield $0 of matching fields in
711 bibliographic records.
713 To use the new authority record viewer:
715 . Click *Cataloging -> Retrieve Authority Record by ID*.
716 . Type in the ID number of the authority record you are
717 interested in. Don't include any prefixes, just the ID
720 . View or edit the authority record as needed.
731 Circulation policies in Evergreen can now be configured to automatically renew
732 certain items checked out on patron accounts. Circulations will be renewed
733 automatically up to a custom limit (the `max_auto_renewal` field) and patrons
734 will not need to log in to their OPAC accounts or ask library staff to manually
737 Two new action triggers have been added to Evergreen that permit the Auto-Renew
738 feature. They can be found, configured, and enabled in Administration>Local
739 Administration>Notifications/Action Triggers. They are named **Autorenew** and
742 The **Autorenew** A/T definition uses the `checkout.due` hook to automatically
743 validate and renew (in the reactor) circulations on the day they are due,
744 grouped by user. The output events of this definition is is the input used by
745 the related **AutorenewNotify** A/T that simply uses a new hook called
746 `autorenewal` to notify patrons via email of their currently due or
749 In the webstaff's Patron Items Out page, the new column `AutoRenewalsRemaining`
750 indicates how many autorenewals are available for a particular circulation.
756 Emergency Closing Handler
757 ^^^^^^^^^^^^^^^^^^^^^^^^
759 Staff are provided with interfaces and mechanisms to create library closings
760 that, in addition to affecting future circulation and booking due dates, and
761 hold shelf expirations, will automatically move existing circulation and booking
762 due dates and hold shelf expiration times. This new functionality is
763 conceptually described as Emergency Closings and business logic implementing it
764 as the Emergency Closing Handler. It contains additions and adjustments to the
765 user interface, business logic, and database layers. Access to this
766 functionality is available through the Closed Dates Editor interface in the
767 staff client which has been ported to AngularJS.
772 This development has created new business logic code to inspect, in real time,
773 existing circulation, booking, and hold records, and modify such date and time
774 stamps so that the circulation, booking, or hold will end in the same state it
775 would have if the closing had existed at the time the circulation or booking
776 occurred, or the hold was placed and captured. Of specific note, hourly loans
777 will have their due date adjusted to be the end of the day following the
780 When the Emergency Closing is saved, any fines accrued during the closing may be
781 voided, as settings dictate, with the exception of circulations that have been
782 marked as LOST or LONG OVERDUE. That is, even for LOST and LONG OVERDUE
783 circulations with due dates that fall within the Emergency Closing, no fine
784 adjustment will be applied. Emergency Closing processing is permanent, and
785 cannot be rolled back.
787 This functionality is explicitly initiated by staff action. If staff do not
788 request an Emergency Closing, existing circulations, bookings, and holds will
789 not be processed and adjusted. However, if staff request any Closing that starts
790 nearer in time than the length of the longest circulation duration configured
791 for use in the Evergreen instance they will be prompted with the option to
792 create the closing as an Emergency Closing.
794 Action/Trigger hooks have been created for circulations and bookings that are
795 adjusted by the Emergency Closing Handler. These will facilitate the creation of
796 notifications to patrons that the due date has changed and to alert them to
797 potential changes in accrued fines.
799 Booking start dates are explicitly ignored in this implementation. Because an
800 Emergency Closing is, by its nature, an unexpected event, it will be up to staff
801 to address any bookings which intersect with a new Emergency Closings. Reports
802 can be used to identify booking start dates that overlap with a closing and that
803 may require staff intervention.
805 Staff requesting and Emergency Closing must have the new EMERGENCY_CLOSING
806 permission. Some text describing the feature.
812 Patron Preferred Name and Name Search Keywords
813 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
818 Adds a new set of patron preferred name fields for prefix, first,
819 middle, last, and suffix allowing patrons to provide preferred name
820 information. Preferred names are optional and each acts as an overlay
821 to the analogous primary name field, making it possible to provide
822 preferred name values for individual fields.
824 For example, a patron named William Erickson may have a preferred first
825 name (pref_first_given_name) of Bill, in which case the preferred name
826 would be Bill Erickson. Note a preferred last name is not required in
827 this case as the code uses primary name values as defaults when not
828 replaced with a preferred version.
830 * Patrons will see primary names displayed in the catalog when set.
831 * Staff will see both primary name and preferred name in the patron
833 * Patron searches for any given name field will search both the primary
834 and preferred name data.
835 * Preferred name fields are available in Action/Trigger templates and
836 are present in various patron-focused print templates.
841 Adds a new field to store miscellaneous patron name search terms. These
842 values are only for searching and do not appear in any interfaces, apart
843 from the patron summary side bar and the patron edit UI.
845 Included is a new search field in the patron search UI which searches
846 keyword values and all other name fields. It's essentially a global patron
855 Disabling of legacy XUL staff client
856 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
857 The legacy XUL staff client is no longer supported in Evergreen
858 3.2.x and the server-side installation no longer supports a
859 direct connection by a version XUL client by default. All
860 users of Evergreen 3.2.x are strongly urged to complete their
861 switch to the web staff client as part of upgrading to 3.2.x.
863 Evergreen administrators who for some reason continue to wish
864 to deploy the XUL staff client can do so at their risk by
865 supplying `STAFF_CLIENT_STAMP_ID` during the `make install` step
866 and using `make_release` to create installers for the staff client.
867 However, no community support will be provided for the XUL client.
872 Permission Group Display Entries
873 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
874 In some cases, it is useful to have the ability to reorder permission, or to make
875 only specific groups available in the permission group selector for specific
876 Org Units. An interface has been made available to allow this.
878 Group Tree Display Entry Interface
879 ++++++++++++++++++++++++++++++++++
881 Permission Group Display Entries can be reordered, added, or removed via
882 _Administration -> Local Admin -> Permission Tree Display Entries_.
883 Select the Org Unit you wish to edit the entries in.
885 Entries may be added using the Add functionality, creating entries based
886 on permission groups that have not been added to the tree for the Org
887 Unit you wish to add them to.
889 image::media/pgtde_01.png[Group Tree Display Entry Admin UI]
893 Moving an entry will shift its position up or down in the patron profile
894 selector for a given Org Unit.
897 * Press either the *Move Up* or *Move Down* button. The entry will be
898 moved up or down, accordingly.
899 * Click *Save* to save your edits.
901 NOTE: You may only move up or down entries that have sibling entries.
905 If you want a particular Org Unit to not have access to specific
906 entries, you may remove an entry. Removing an entry will remove it from
907 view. The entry will be removed from the database.
909 * Select an entry and press the *Remove* button.
913 You may add entries from permission groups that are not currently
914 reflected in the permission group tree. This is useful for moving
915 entries to different parents, or making them root entries.
917 image::media/pgtde_02.png[Add Entry modal]
919 * If desired, select an entry to be used as the parent entry.
920 * Press the *Add* button.
921 * Select a permission group from the dropdown.
922 * If you've selected a parent entry, you may check the *Add Root Entry*
923 box to override that parent and add the entry on the root level.
924 * If you did not select a parent entry, the entry will be added on the root
929 Browser Client Settings & Preferences Stored on the Server
930 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
931 Browser client settings and preferences that should persist over time are
932 now stored as settings on the server. This allows settings to follow
933 users and workstations and reduces problems associated with losing settings
934 as a result of clearing browser data.
936 The browser client honors setting values stored as user settings, workstation
937 settings, and org unit settings, depending on which setting types are
943 * No setting can be both a user and workstation setting. They are mutually
945 * Any setting can be an org unit setting in addition to being a user or
951 Read-only settings are useful for defining values that staff can use but
952 not modify. For example, admins may wish to prevent users from locally
953 modifying the grid configuration for a given interface so it remains
954 consistent for all users.
956 A setting is read-only when an org unit setting type exists (regardless of
957 whether a value is applied) and no user or workstation setting type exists.
959 Server-Stored Workstation Settings Workstation Admin View
960 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
962 There's a new "Server Workstation Prefs" tab to the stored preferences
963 workstation admin interface. From here, users can view which
964 preferences are stored as server-stored workstation preferences and
965 delete select values.
970 A new permission APPLY_WORKSTATION_SETTING has been added to control who
971 may apply values to workstation settings. Use something like the following
972 to apply the permission to all staff accounts (mileage may vary):
975 --------------------------------------------------------------------------
976 INSERT INTO permission.grp_perm_map (grp, perm, depth)
978 (SELECT id FROM permission.grp_tree WHERE name = 'Staff'), -- name may vary
979 (SELECT id FROM permission.perm_list WHERE code = 'APPLY_WORKSTATION_SETTING'),
982 --------------------------------------------------------------------------
984 Workstation setting types matching values previously stored in the browser
985 (via localStorage or Hatch) are created as part of this feature. During
986 upgrade, admins should consider whether any of these new setting types
987 should be transferred to user and/or org unit settings instead. Setting
988 type changes can be made at any time, but when a setting type is deleted
989 all of its data is deleted, so a change in type means re-applying the
990 settings in the browser client.
992 Values stored in the browser will automatically migrate to server settings
993 as each setting is accessed in the browser client. Once migrated, the
994 in-browser copies are deleted.
996 If a setting type does not exist where the browser expects one, the
997 value is stored in-browser instead and a warning is issued in the console.
1000 More consistent terminology in the client
1001 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1002 Terminology has been updated in the staff client so that we consistently use
1003 the same name to describe the same thing. The following updates have been made:
1005 * The term 'item' is now consistently used to describe the barcoded entity
1006 that had been previously been called both an 'item' and a 'copy'. As a result,
1007 we now use the terms 'item buckets', 'item tags', and 'item alerts'.
1008 * The term 'volume' is no longer used in the client, with the exception of
1009 serials, where the term is used to describe serial volumes. The term 'call
1010 number' will replace volume in most other places.
1011 * 'Holdings' is a more general term used to describe a combination of items
1013 * The term 'Shelving Location' is used consistently in favor of 'Copy
1024 Batch Actions In the Public Catalog
1025 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1026 The public catalog now displays checkboxes on the bibliographic and
1027 metarecord constituents results pages. Selecting one or more titles
1028 by using the checkboxes will dynamically add those title to the
1029 temporary list, which is now renamed the cart.
1031 Above the results lists there is now a bar with a select-all checkbox,
1032 a link to the cart management page that also indicates the number of
1033 of titles in the cart, and a link to remove from the cart titles that
1034 are selected on the currently displayed results page.
1036 The search bar now includes an icon of a cart and displays the number
1037 of titles currently in the cart. Next to that icon is a menu of cart
1040 The cart actions available are Place Hold, Print Title Details,
1041 Email Title Details, Add Cart to Saved List, and Clear Cart. In the
1042 web staff client, the cart actions also include Add Cart to Bucket.
1043 When an action is selected from this menu, the user is given an
1044 opportunity to confirm the action and to optionally empty the cart
1045 when the action is complete. The action is applied to all titles
1048 Clicking on the cart icon brings the user to a page listing the
1049 titles in the cart. From there, the user can select specific records
1050 to request, print, email, add to a list, or remove from the cart.
1052 The list of actions on the record details page now provides separate
1053 links for adding the title to a cart or to a permanent list.
1055 The permanent list management page in the public catalog now also
1056 includes batch print and email actions.
1058 Additional information
1059 ++++++++++++++++++++++
1060 * The checkboxes do not display on the metarecord results page, as
1061 metarecords currently cannot be put into carts or lists.
1062 * The checkboxes are displayed only if JavaScript is enabled. However,
1063 users can still add items to the cart and perform batch actions on
1064 the cart and on lists.
1065 * A template `config.tt2` setting, `ctx.max_cart_size`, can be used to
1066 set a soft limit on the number of titles that can be added to the
1067 cart. If this limit is reached, checkboxes to add more records to the
1068 cart are disabled unless existing titles in the cart are removed
1069 first. The default value for this setting is 500.
1074 This patch adds to the public catalog two routes that return JSON
1077 * `GET /eg/opac/api/mylist/add?record=45`
1078 * `GET /eg/opac/api/mylist/delete?record=45`
1080 The JSON response is a hash containing a mylist key pointing to the list
1081 of bib IDs of contents of the cart.
1083 The record parameter can be repeated to allow adding or removing
1084 records as an atomic operation. Note that this change also now available
1085 to `/eg/opac/mylist/{add,delete}`
1087 More generally, this adds a way for EGWeb context loaders to specify that
1088 a response should be emitted as JSON rather than rendering an HTML
1089 page using `Template::Toolkit`.
1091 Specifically, if the context as munged by the context loader contains
1092 a `json_response` key, the contents of that key will to provide a
1093 JSON response. The `json_response_cookie` key, if present, can be used
1094 to set a cookie as part of the response.
1096 Template Toolkit processing is bypassed entirely when emitting a JSON
1097 response, so the context loader would be entirely responsible for
1098 localization of strings in the response meant for direct human
1104 New class for searchbar when on the homepage
1105 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1107 This adds the `.searchbar-home` class to the div that contains the searchbar
1108 when on the homepage. This allows sites to customize the searchbar differently
1109 on the homepage than in other places the search bar appears (for example,
1110 offering a large, Google-style search bar on the homepage only).
1115 To make customization easier, the username hint on the OPAC login page ("Please
1116 include leading zeros...") has been moved to a separate TT2 template. If you
1117 have customized the hint text, you will need to add your modifications to
1124 The Evergreen project would like to acknowledge the following
1125 organizations that commissioned developments in this release of
1128 * BC Libraries Cooperative
1129 * Consortium Of Ohio Libraries
1131 * Georgia Public Library Service
1132 * Indiana State Library
1133 * Lake Agassiz Regrional Library
1135 * North Texas Library Consortium
1136 * Northwest Regional Library
1137 * Pennsylvania Integrated Library System
1138 * South Carolina State Library
1140 We would also like to thank the following individuals who contributed
1141 code, translations, documentations patches and tests to this release of
1146 * Andrea Buntz Neiman
1155 * Blake Graham-Henderson
1156 * Francisco J Guel-Mendoza
1174 We also thank the following organizations whose employees contributed
1177 * BC Libraries Cooperative
1180 * Equinox Open Library Initiative
1181 * Government of Manitoba
1182 * Kenton County Public Library
1183 * King County Library System
1184 * Linn-Benton Community College
1188 We regret any omissions. If a contributor has been inadvertently
1189 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob