1 Evergreen 2.12 Release Notes
2 ============================
8 This release contains bug fixes improving on Evergreen 2.12.8:
10 * NodeJs is now installed from source, rather than using a pre-compiled binary.
11 * NodeJs is now at version 6.11.3, which is the most recent LTS release.
15 We would like to thank the following individuals who contributed code,
16 tests and documentation patches to the 2.12.8 point release of
25 This release contains several bug fixes improving on Evergreen 2.12.7:
27 * Many patron fields have been redacted from the web staff client's patron
28 and record holds grids, leaving patron name, username, and ID.
29 * Fixes two bugs where patron records could fail to be saved upon editing.
30 * The patron summary in the web staff client now correctly displays
31 primary and secondary ID values.
32 * Patron barcode search completion in the web staff client now allows
33 the user to select from all of the matching patron records.
34 * The web staff print templates for current and historical bills can
35 now include copy barcode and title.
36 * Fixes a bug that resulted in some catalog searches unexpectedly
38 * Fixes a bug where placing a hold request in the public catalog could result
39 in "forgetting" the type and library of the user's previous search.
40 * Fixes a bug that made using the volume/copy editor to change a copy's
42 * The administration interface for hard due dates now ensures that
43 new (or edited) ceiling dates have their time component set to end
44 of day, resolving an issue where ceiling dates would not be applied
45 during the ceiling date itself.
46 * Asset merging during bibliographic record merging now correctly
47 recognizes call number prefixes and suffixes and deletes disused
49 * The Concerto sample data set now includes data allowing for testing
50 placing holds on monographic parts.
51 * Fixes a bug where displaying user surveys could result in PCRUD
53 * Fixes a bug where pg_restore of an Evergreen database could fail
54 to create certain indexes on the `actor.usr` table.
58 We would like to thank the following individuals who contributed code,
59 tests and documentation patches to the 2.12.8 point release of
81 This release contains several bug fixes improving on Evergreen 2.12.6
83 * Fixes a bug in the web staff client that prevented initials from being
84 stored with copy notes.
85 * Adds billing types that may have been missed by systems that were
86 running Evergreen prior to the 1.4 release.
87 * Fixes a web staff client bug with the CSV export option available from
88 the Import Queue in the MARC Batch Import/Export interface.
89 * Adds the missing copy alert field in the web client's volume/copy
91 * Fixes a bug where the setting to require date of birth in patron
92 registration was not being honored in the web staff client.
93 * Fixes a bug in the web staff client patron registration form where the
94 password wasn't generating from the last four digits of the patron's
96 * Fixes an issue in the web staff client where the complete barcode did
97 not display in some interfaces when partial barcodes were scanned.
101 We would like to thank the following individuals who contributed code,
102 tests and documentation patches to the 2.12.7 point release of
119 This release contains several bug fixes improving on Evergreen 2.12.5.
121 * Removes the option to add a title to My List from Group Formats and
122 Editions searches where the option never worked correctly due to a bad id.
123 * Removes deleted shelving locations from the web client's volume/copy editor. Since there is no database constraint that prevents a copy from a deleted shelving location, if there are already copies attached to those shelving locations, the copy location selector will be blank. Evergreen admins can identify those items by running the following query:
126 select acp.id, acp.barcode, acpl.name
128 join asset.copy_location acpl on (acpl.id = acp.location)
129 where not acp.deleted
133 * Adds the patron opt-in check in the web client whenever a patron is retrieved
134 by barcode scan, patron search, or item circ history.
135 * Fixes a bug where the price and acquisitions cost fields did not display
137 * Fixes a bug where a patron's circulation history no longer moved to the lead
138 account when merging patron accounts.
139 * Now hides the ebook tabs in My Account for sites that have not yet enabled the
141 * Trims spaces from patron barcodes in the web client check out interface.
142 * Makes a string in the holds validation alert translatable.
143 * Fixes a bug that prevented the web client patron registration screen from
144 loading when there is an opt-in action triggers, such as the email checkout
145 receipt, t set to be a registration default.
146 * Fixes a bug where barcode validation in the web client patron editor was
147 using the incorrect regular expression.
148 * Replaces an empty string in the mobile carrier dropdown menu with a 'Please
149 select your mobile carrier' label to improve usability and resolve a problem
151 * Restores the ability to display a photo in the web client patron editor for
152 accounts that have an actor.usr.photo_url.
153 * Fixes a Firefox display issue in the web client that occurred when retrieving
154 a bib record by TCN when the MARC Edit tab was set as the default view.
155 * Fixes an bug where setting a patron's default pickup location in the web
156 client patron editor inadvertently changed the home library. It also disables
157 any locations that are not viable pickup locations.
158 * Fixes a bug where a misscan in a copy bucket failed silently.
162 We would like to thank the following individuals who contributed code,
163 tests and documentation patches to the 2.12.6 point release of
181 This release contains several bug fixes improving on Evergreen 2.12.4.
183 * Hides the _Hold is Behind Circ Desk_ checkbox in the XUL client's patron
184 registration screen for those libraries that have not enabled Behind Desk Pickup
185 support via the Library Settings Editor
186 * Adds a missing error string that appears when marking an item damaged from
188 * Changes the hold request form so that it no longer defaults to the first SMS
189 carrier for text notifications.
190 * Adds a requirement for users to enter a phone/SMS number when they have
191 enabled that notification method on the hold request form.
192 * Changes the URL pointing to catalog images, CSS and javascript files to a full
193 absolute URL instead of the relative URL previously used. This change fixes an
194 issue with the Open Graph image property, which requires a full URL.
195 * Fixes an issue where payment amounts sent to Stripe can be one cent less than
196 the actual Evergreen payment.
197 * Fixes an issue where the open-ils.storage OpenSRF module fails to start when
198 using perl 5.24 or higher.
199 * Fixes a problem in the web client where marking a transaction as claims
200 returned or claims never checked out at the same time the patron's record is
201 edited would not increase the count once the patron's record is saved.
202 * Changes the cursor to a pointer for the record menus in the web client.
203 * Fixes hardcoded patchs in srfsh support scripts.
204 * Prevents a "Use of freed value in iteration" error that appeared in logs when
205 adjusting a transaction to zero.
206 * Prevents the temporary list page from crashing when a user adds the same title
207 to the list more than once.
208 * Removes duplicate rows from localized 950.data.seed-values.sql files.
209 * Fixes the following two issues with conjoined items:
210 - Foreign items previously did not display there was no extra copy attached
212 - Conjoined items did not display unless there were two or more items in a
214 * Fixes an issue in the web client where the Hold Verify prompt did not display
215 for items in a Copy Location where the hold verify flag is enabled.
216 * Fixes support for automatic item barcode completion in the web client check in,
217 check out, renew, and item status interfaces.
218 * Makes the courier code variable available for transit slips in the web client.
219 * Fixes the ability to apply funds from the acquisitions selection list,
220 View/Place Order, and MARC Federated Search interfaces.
224 We would like to thank the following individuals who contributed code,
225 tests and documentation patches to the 2.12.5 point release of
249 * This release of Evergreen contains a fix to the _Hold/Copy Ratio per Bib
250 and Pickup Library (and Descendants)_ data source. Report templates using
251 this data source will need to be re-created to improve accuracy of the
252 data reported from this source.
253 * This release also contains a fix to downloading large checkout histories from
254 My Account. This feature no longer uses the action/trigger mechanism and the
255 OPAC now generates the CSV directly. The old action/trigger code is still
256 present in the database and should be removed at some point in the
261 This release contains several bug fixes improving on Evergreen 2.12.3
264 * A fix to a web client bug where adding copies through the _Add Volumes
265 and Copies_ menu item could fail silently.
266 * A fix to a bug that allowed users to access some web client admin interfaces
268 * A fix to the display of the loan duration and fine level fields in the web
269 client Item Status Detail view.
270 * A fix to the display of duplicate data on the bib record View Holds page when
271 toggling between the holds and OPAC view.
272 * A fix to a bug that prevented the web client patron registration page from
274 * Support for Org Unit Includes alert text, notice text, event text, header
275 text, and footer text in the web client print templates.
276 * A fix to make the web client MARC Editor's flat text editor selection sticky.
277 * A fix to make the Patron Search library selector sticky.
278 * A fix to a bug in the web client that prevented the user from saving a new
279 copy after using the MARC Edit _Add Item_ option.
280 * A fix to a patron registration bug that did not require the entry of a required
281 user statistical category for stat cats that do not allow free-text entries.
282 * The addition of the bad bacode image file in the web client.
283 * An improvement to the MARC Batch Edit progress indicator to reduce the
284 likelihood of system backlogs.
285 * Downloading checkout history as a CSV from My Account has been fixed
286 for users with a large circulation history. Previously, this would
287 time out for patrons with more than 100 or so circulations.
288 * A fix to syntax in the Spanish lang.dtd file that was creating an error
289 when using the Closed Date Editor.
290 * Improvements to CSS to silence some Mozilla extension warnings.
291 * A fix to a failure to update targeted circulations when utilzing the recall
293 * The addition of text wrapping in the copy details table on the bib
294 record to prevent contents from falling off the page.
295 * A fix to the adjust to zero option so that it can be applied correctly
296 to multiple billings.
297 * A fix to the "Hold/Copy Ratio per Bib and Pickup Library
298 (and Descendants)" data source so that it will now include counts of eligible
299 copies at locations that are not a pickup library for bib's holds.
300 * A fix to the XUL client Item Status -> Alternate View -> Holds / Transit
301 tab so that it properly refreshes all data when switching between copies.
305 We would like to thank the following individuals who contributed code,
306 tests and documentation patches to the 2.12.4 point release of
330 This release contains several bug fixes improving on Evergreen 2.12.2.
334 The web client, which is available for trial production use in libraries,
335 received several fixes in this release:
337 * The receipt on payment checkbox now prints a receipt at time of payment.
338 * The Items Out count in the patron screen now includes long overdue
340 * A fix was added to prevent values from a previously-edited patron from
341 appearing in the edit form of a subsequent patron.
342 * User notification preferences now save correctly in the patron
343 registration and edit forms.
344 * The UPDATE_MARC permission is no longer requested when performing a
345 search from the staff catalog.
346 * Non-cataloged circulations now display in the Items Out screen without
348 * Required statistical categories are now required to be entered in the
349 copy editor. (A similar bug for the patron editor was fixed in the 2.12.1
351 * Voiding bills now requires confirmation.
352 * Staff can no longer use the copy editor to put items into or out of the
353 following statuses: checked out, lost, in transit, on holds shelf, long
354 overdue, and canceled transit.
355 * The contrast is improved for alert text showing the amount a patron owes
357 * Circ modifiers now sort alphabetically in the copy editor.
361 * Code to prevent a hold already on the Holds Shelf from being
362 transferred to another title.
363 * A fix to a bug that prevented users from scheduling reports with a
364 relative month if the report template used a date that applied the Year +
365 Month transform with the On or After (>=) operator.
366 * A fix to a bug where the max fines threshold was reached prematurely
367 due to the presence of account adjustments.
368 * A check that prevents a SMS message from attempting to sending when the SMS
370 * For systems that provide search format as a filter on the advanced
371 search page, a fix so that the format selected in the search bar when
372 launching a new search from the results page overrides any previously-set
374 * The addition of an optional new Apache/mod_perl configuration variable for
375 defining the port Apache listens on for HTTP traffic. This resolves an issue
376 where added content lookups attempting HTTP requests on the local Apache
377 instance on port 80 failed because Apache was using non-standard ports.
378 * A fix to the public catalog's My List page responsive design so that it now
379 displays properly on mobile devices and allows users to place holds from My List.
380 * A fix to a bug where the second (and subsequent)
381 pages of search results in the public catalog (when group
382 formats and editions is in effect) does not correctly generate
383 links to hits that are not part of of a multi-bib metarecords.
387 We would like to thank the following individuals who contributed code,
388 testing and documentation patches to the 2.12.3 point release of
408 This release is a security release that also contains several other bug
409 fixes improving on Evergreen 2.12.1.
411 Security Issue: XSS Vulnerability in Public Catalog
412 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
413 This release fixes several cross-site scripting (XSS) vulnerabilities
414 in the public catalog. When upgrading, Evergreen administrators should
415 review whether any of the following templates have been customized
416 or overridden. If so, either the template should be replaced with the
417 stock version or the XSS fix (which entails adding the `| html` filter
418 in several places) applied to the customized version.
420 * `Open-ILS/src/templates/opac/parts/locale_picker.tt2`
421 * `Open-ILS/src/templates/opac/parts/login/form.tt2`
422 * `Open-ILS/src/templates/opac/parts/searchbar.tt2`
426 * Administrators of Evergreen who use RTL locales and who have customized
427 `style-rtl.css.tt2` should now incorporate their customizations into
429 * The `reporter.classic_current_circ` view, which is part of some
430 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
431 has been fixed to not exclude loans for patrons who do not have a
432 billing address set. Users of this view should rerun
433 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
435 Hold Targeter Repairs and Improvements
436 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
437 A series of changes were made to the new hold targeter available in 2.12.
439 * Make the batch targeter more resilient to a single-hold failure.
440 * Additional batch targeter info logging.
441 * Set OSRF_LOG_CLIENT in hold_targeter_v2.pl for log tracing
442 * Removes the confusingly named --target-all option
443 ** The same behavior can be achieved by using --retarget-interval "0s"
444 * Removes --skip-viable (see --soft-retarget-interval below)
446 New --next-check-interval Option
447 ++++++++++++++++++++++++++++++++
448 Specify how long after the current run time the targeter will retarget
449 the currently affected holds. Applying a specific interval is useful
450 when the retarget-interval is shorter than the time between targeter
453 For example, if the targeter is run nightly at midnight with a
454 --retarget-interval 36h, you would set --next-check-interval to 48hr,
455 since the holds won't be processed again until 48 hours later. This
456 ensures that the org unit closed date checks are looking at the correct
459 This setting overrides the default behavior of calculating the next
460 retarget time from the retarget-interval.
462 New --soft-retarget-interval Option
463 +++++++++++++++++++++++++++++++++++
464 This is a replacement for (and rebranding of) the --skip-viable option.
465 The new option allows for time-based soft-targeting instead simple binary
466 on/off soft-targeting.
468 How soft-targeting works:
469 * Update hold copy maps for all affected holds
470 * Holds with viable targets (on the pull list) are otherwise left alone.
471 * Holds without viable targets are retargeted in the usual manner.
475 * A fix to remove the Chilifresh patron reviews header for Evergreen sites
476 that do not use Chilifresh.
477 * A fix that marks acquisitions POs as received when all line items on the
478 PO are received or canceled.
479 * A typo fix to the long overdue override permission that prevented staff
480 from being able to override long overdue check ins.
481 * A fix to use a library's configured currency in SIP patron responses
482 instead of always using US dollars.
483 * A fix to SIP timeouts caused by invalid sessions
484 * A fix that allows boolean fields to be recognized in queries to the
486 * A fix to use the correct method during adjust to zero on negative
488 * A correction to the datatype for the Vandelay Default Record Match Set
490 * The removal of the _Keep_ field from MARC Batch Import Item Attributes.
491 The field was not previously implemented.
492 * A fix to set the complete time value for grouped Action/Trigger events
493 when an event's state reach complete, consistent with non-grouped events.
494 * A fix to a bug in the rollover_phone_to_print.pl script that kept failed
495 call files from being moved.
496 * A new index for acq.edi_message that speeds up the check for duplicate
498 * A fix that ensures JSON strings are converted to UTF8, ensuring that
499 non-ASCII data display correctly.
500 * A fix to avoid an erroneous unsaved data popup to appear during MARC
502 * A typo fix in the web client's bill payment receipt template.
503 * A correction to ebook account links on the My Account Summary page.
504 * Improved responsive design for the ebook My Account screens so that
505 they display better on mobile devices.
506 * A fix to a bug that prevented a patron opt-in dialog from loading.
507 * The RTL stylesheet for the public catalog,
508 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
509 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
510 template will emit RTL or LTR styles based on the value of
511 the `rtl` flag of the active locale. An `rtl` variable is also available
512 in the template to allow the correct style to be chosen.
513 * A fix to leaking of the internal port number to the client when
514 Apache is configured to use nonstandard ports in combination with a proxy
516 * The addition of the vandelay.auto_overlay_bib_record upgrade script,
517 which was missed in a 2.1-2.2 era upgrade script. It isn't necessary for
518 sites that began using Evergreen since then to run the script, but
519 it is harmless to run.
520 * A web staff client fix that will hid the behind-desk option for
521 for libraries that do not support "Behind Desk Pickup".
522 * A web staff client fix that caused hold transit check ins to fail
523 silently when the transit destination does not have a holds address.
524 * A web staff client fix that now requires the entry of user statistical
525 categories in the patron editor if those stat cats are configured to
527 * A fix to a problem with the "Exclude Electronic Resources" checkbox
528 that prevented users from removing a selection from the box.
529 * The removal of the search format limiters from the new advanced search
530 limiter block on the search results page. The search format limiters
531 should not display there because they can be selected from the search bar.
538 We would like to thank the following individuals who contributed code,
539 testing and documentation patches to the 2.12.2 point release of
562 This release contains several bug fixes improving on Evergreen 2.12.0
564 * A fix to the 2.12 upgrade of the subject|temporal and subject|geographic
565 indexes, where the above-mentioned browse indexes were not turned off in favor
566 of new browse versions of the indexes. Sites that are upgrading from 2.12.0
567 can cancel the browse reingest that comes with the new upgrade script.
569 * A change to the default pickup library when staff place a hold. The place hold
570 screen will now default to the preferred pickup location for the patron. If the
571 patron does not have a preferred pickup location, it will default to the
572 patron's home library.
573 * A fix to a problem where users could not change the selected Org Unit on the
574 MARC Tag Tables server admin page.
575 * A fix to the seed data for translations for some Coded Value Map entries.
576 * The ability to skip the XUL staff client build when in make_release.
577 * Revised layout and styling for the advanced search limiter block that displays
578 on the search results page.
579 * A fix that silences a log warning that appears for every checkout where a hard
580 due date is not used.
581 * Tweaks for sounds that are used in the web staff client.
582 * The addition of f4 and ctrl-f2 as hotkeys in the web staff client.
583 * Additional help text for receipt templates in the web staff client.
584 * The reinstatement of the Reprint Last Receipt functionality in the web staff client.
585 * The ability in the web staff client copy editor to add new volumes to
586 libraries that were not selected in holdings view.
587 * A fix to a billing issue where transactions were not re-opened after they
588 acquired a non-zero balance at check in.
589 * A change to the web staff client work log to prevent it from storing
591 * A fix to a translation issue for the record attributes displayed in the
592 advanced search limiter block on the search results page.
593 * A fix to hold targeting for metarecord holds when the new hold targeter is
594 run in parallel mode.
598 We would like to thank the following individuals who contributed code,
599 testing and documentation patches to the 2.12.1 point release of
620 Evergreen 2.12 now requires OpenSRF 2.5 or later; certain functionality
621 will not work if you attempt to run Evergreen 2.12 on OpenSRF 2.4. Evergreen
622 2.12 recommends PostgreSQL 9.4. The minimum supported version of PostgreSQL is
625 The stock schema upgrade script performs a browse and facet reingest,
626 recalculates bib fingerprints, and remaps metarecords.
628 This version also adds two new services, `open-ils.ebook_api` and
629 `open-ils.hold-targeter`.
636 Default status for received line items
637 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
638 A new Library Setting has been added to allow libraries to set the default
639 status for received line items. The previous behavior was to use the
640 "In process" status for all acquisitions items that are received.
648 Additional SMS Carriers
649 ^^^^^^^^^^^^^^^^^^^^^^^
650 SMS carrier definitions are now included for Google Fi and
651 Republic Wireless. These will be automatically loaded when
652 installing a new Evergreen system; admins who wish to
653 add these definitions during an upgrade can use the following
654 email gateway values:
656 * Google Fi: `$number@msg.fi.google.com`
657 * Republic Wireless: `$number@text.republicwireless.com`
662 Bibliographic Fingerprint Improvements
663 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
664 The bibliographic fingerprint will now incorporate subfields $n and $p from MARC
665 title fields to better distinguish among records of the same series that
666 may share the same title but have a different part. With this change, these
667 MARC records will no longer be grouped together in a 'Group Formats & Editions'
670 The bibliographic fingerprint was also changed to better distinguish among
671 the fields contributing to the fingerprint. This change will help the system
672 distinguish between a record for the movie _Blue Steel_ and another record for
673 the book _Blue_ written by Danielle Steel.
680 Batch Hold Targeter Speed-up and New Features
681 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
683 Adds a new `open-ils.hold-targeter` service, supporting new targeting options
684 and runtime optimizations to speed up targeting. The service is launched
685 from a new targeting script, `hold_targeter_v2.pl` (default location:
686 `/openils/bin/hold_targeter_v2.pl`).
688 This code has no effect on the existing hold targeter, which is still
689 available as of this release and functions as before.
694 * Adds a global configuration flag 'circ.holds.retarget_interval' for
695 setting the hold retarget interval.
697 * `--target-all` option forces the targeter to process all active
698 holds, regardless of when they were last targeted.
700 * `--retarget-interval` option make is possible to override the new
701 'circ.holds.retarget_interval' setting via the command line
702 when calling the hold targeter.
704 * `--skip-viable` option causes the hold targeter to avoid modifying
705 the currently targeted copy (i.e. the copy on the pull list) for holds
706 that target a viable (capturable) copy.
709 For skipped holds, no entry is added to the unfulfilled_hold_list.
710 The set of potential copies (hold copy maps) are refreshed for all
711 processed holds, regardless of target viability.
714 This option is useful for 1.) finding targets for holds that require
715 new targets and 2.) adding new/modified copies to the potential copy
716 lists (for opportunistic capture) more frequently than you may want to do full
717 retargeting of all holds.
719 * `--newest-first` option processes holds in reverse order of request_time,
720 so that newer holds are (re)targeted first. This is primarily useful
721 when a large backlog of old, un-targetable holds exist. With
722 `--newest-first`, the older holds will be processed last.
724 * `--parallel` option overrides the parallel settings found in `opensrf.xml`
725 for simpler modification and testing.
727 * `--lockfile` option allows the caller to specify a lock file instead
728 of using the default /tmp/hold_targeter-LOCK
730 * `--verbose` option prints progress info to STDOUT, showing the number of
731 holds processed per parallel targeter instance.
733 * When configured, hold target loops cycle through all org units (with
734 targetable copies) instead of repeatedly targeting copies at the pickup
735 library when multiple targetable copies exist at the pickup library.
737 * When configured, hold target loops prioritize (targetable) org units
738 first by the number of previous target attempts, then by their
739 weight/proximity. This effectively back-fills org units that had no
740 targetable copies during earlier target loops so that they are
741 targeted as many times as other org units (to the extent possible,
747 * Traditional daily hold targeter with a value set for
748 'circ.holds.retarget_interval'.
751 --------------------------------------------------------------------------
752 /openils/bin/hold_targeter_v2.pl
753 --------------------------------------------------------------------------
755 * (Re)target non-viable holds twice a day, only processing holds that
756 have never been targeter or those that have not been re-targeted in
760 --------------------------------------------------------------------------
761 /openils/bin/hold_targeter_v2.pl --skip-viable --retarget-interval "12h"
762 --------------------------------------------------------------------------
764 * (Re)target non-viable holds twice a day, processing all holds regardless
765 of when or if they were targeted before, running 3 targeters in
769 --------------------------------------------------------------------------
770 /openils/bin/hold_targeter_v2.pl --skip-viable --target-all --parallel 3
771 --------------------------------------------------------------------------
777 Add separate make target for translators
778 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
779 For those only interested in building Evergreen translations, a separate
780 "translator" make target has been added to allow for easier installation
781 of i18n prerequisites.
784 Allow admin to specify where Perl modules will be installed
785 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
786 Add `--with-perlbase` option to `configure` to specify an alternative
787 location for installing the Perl modules. This can be useful for setups
788 that want to run the Perl modules from a shared filesystem or
789 environments that need to run multiple versions of Evergreen
792 Users of `--with-perlbase` are responsible for ensuring that `PERL5LIB`
793 is set appropriately.
797 Addition of missing permissions
798 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
799 Required permissions that were previously missing from the stock data have now
800 been added. If Evergreen sites have already manually added these permissions,
801 the upgrade script will remove the old permission and create the new one,
802 maintaining any maps to permission groups, with the stock permission ID.
808 get_org_unit_ancestor_at_depth Helper Added to Action Trigger Reactor Helpers
809 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
810 In action trigger templates it's now possible to call
811 `helpers.get_org_unit_ancestor_at_depth($id_or_aou, $depth)` in order to retrieve
812 a fleshed aou for the target aou's ancestor at the chosen depth. This could be
813 used to retrieve the name of the library system rather than a specific branch
819 Removed unused selfcheck password setting
820 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
821 There was an unused duplicate selfcheck password setting that was removed
822 to avoid confusion over which library setting was supposed to be set to
823 enable passwords for selfcheck. After upgrading, verify that your library
824 policy remains consistent for this setting.
830 Credit Processor Stripe Settings Permissions
831 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
832 Unprivileged users can retrieve organizational unit setting values for
833 setting types lacking a "view" permission. When the feature adding
834 Stripe credit card processing was added, the upgrade script neglected
835 to add the VIEW_CREDIT_CARD_PROCESSING permission to the
836 organizational unit setting type. This means that anyone can retrieve
837 and view the settings for Stripe credit card processing.
839 Any system that upgraded from Evergreen version 2.5 to 2.6 is
840 affected. If you use Stripe for credit card processing, it is
841 strongly recommended that you apply this upgrade. Even if you do not
842 use Stripe, applying this upgrade is still recommended. If you did
843 not upgrade from version 2.5 to 2.6 of Evergreen, but started with a
844 later version, applying this upgrade is harmless.
854 New Access Points for MARC Merge/Overlay Profiles
855 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
856 Catalogers can now select a MARC merge/overlay profile to apply when
857 merging records in the (browser client) record bucket merge and Z39.50
858 record overlay interfaces. In both interfaces, if the user selects
859 a merge profile, the results of the merge are displayed, giving the
860 user the opportunity to choose a different merge profile or edit
861 the records involved prior to committing to the merge.
863 A new library setting, "Default Merge Profile (Z39.50 and Record Buckets)",
864 specifies the merge profile to preselect in the new merge profile
865 selectors in the record bucket merge and Z39.50 overlay logs. The
866 selectors will also remember the last selection that the user made.
876 Display Copy Alerts With In-House-Use
877 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
879 Two library settings are used to control the display of copy alert
880 messages or copy location check in alerts when recording in-house-use
883 Setting 'Display copy alert for in-house-use' to true for an
884 organization will cause an alert to appear with the copy's alert
885 message, if it has one, when recording in-house-use for the copy.
887 Setting 'Display copy location check in alert for in-house-use' to true
888 for an organization will cause an alert to display a message
889 indicating that the item needs to be routed to its location if the
890 location has check in alert set to true.
892 The settings are independent of one another because you may want to
893 display one and not the other when recording in-house-use.
903 Active Date Column Picker Option
904 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
905 The active date will now be available as a column picker option in the Item
911 Punctuation Insensitive Patron Search
912 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
913 When performing a patron search, punctuation characters will be
914 ignored. So if the patron is named O'Brien, then you can enter Obrien,
915 O'Brien, O Brien, etc. in the search box.
917 This behavior affects the Last Name (internally: family_name), First Name
918 (first_given_name), and Middle Name (second_given_name) fields of the search.
925 Touch screen improvements for Evergreen self-check interface
926 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
927 Improvements were made to the Evergreen self-check interface to make it easier
928 to use in a touch-screen environment.
930 * The pay fines link is now a pay fines button, matching other buttons on the
932 * The checkboxes have been enlarged, making them easier to activate when using
939 Trial Production Use of the Web Staff Client
940 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
941 The new web staff client is ready for trial production use in all functional
942 areas with the exception of serials and offline transactions. In addition to
943 many bug fixes in the areas of circulation, cataloging, administration and
944 reporting, Release 2.12 sees the following additions to web client
947 * Acquisitions interfaces and functionality have been integrated into the web
949 * Booking interfaces and functionality have been integrated into the web staff
951 * Hatch, the program that will allow for unmediated printing to multiple
952 printers, sharing of workstation settings, and, eventually, offline
953 transactions is now available. A windows installer for Hatch will be available
954 on the Evergreen-ILS Downloads page.
956 The Evergreen developers will keep pilot libraries updated about known web
957 client issues by posting known bugs to https://wiki.evergreen-ils.org/doku.php?id=dev:browser_staff:known_issues .
961 Hatch is not required to use the web client, but should be used for workstations
962 that need to perform the following tasks.
964 * Unmediated printing to multiple printers. Workstations can print to multiple
965 printers without Hatch, but will need to click through a dialog to select a
966 printer. Hatch allows workstations to automatically print, without dialog, to
968 * Storage of workstation settings in a place outside the browser. Storing local
969 preferences in hatch will prevent tampering with preferences via the browser
970 developer tools and protect the settings from possible deletion if the browser
971 deletes settings in local storage.
972 * When offline functionality is available, hatch will be required to perform
973 offline transactions.
975 Hatch is currently run as a Chrome extension and is not available in Firefox. To
976 use hatch on Windows, Evergreen sites should:
978 . install a java runtime environment version 8 (or higher) if not already
980 . download and execute the installer from the Evergreen downloads page,
981 . open Chrome and navigate to chrome://extensions,
982 . enable _Developer Mode_ along the top right of the page,
983 . click the _Load Unpacked Extension_ button,
984 . load the directory at Hatch -> extension -> app,
985 .. In Windows, the default location for the app directory will be
986 C:\Program Files (x86)\Hatch\extension\app
987 . enable hatch features in the web client by going to Administration ->
988 Workstation Administration -> Print/Storage Service ("Hatch") and choosing
989 which services to use with Hatch.
990 .. this page will also inform you that hatch is connected.
1000 Client Timezone Awareness
1001 ^^^^^^^^^^^^^^^^^^^^^^^^^
1003 Previously, adjusting the time zone in which a database session operates
1004 could not be done in any way except globally, directly within the database.
1005 However, allowing modification of the timezone parameter now supports
1006 localization efforts for those consortia that span multiple time zones.
1011 CStore and other services that interact with the primary Evergreen database
1012 make use of the functionality provided by LP#1485371 in OpenSRF in order to
1013 set the time zone configuration parameter available in PostgreSQL. This has
1014 the effect of interpreting all timestamps written to or read from the database
1015 in the client's time zone.
1017 Within CStore (and related, C-based services), all stateful sessions make use
1018 of this capability, setting the database time zone upon a successful CONNECT
1019 message from the client. The time zone is reset to the database default when
1020 a session is terminated either due to client DISCONNECT or server keepalive
1023 All stateless requests record the current database time zone, set the database
1024 time zone to that of the client's, run the query, and then reset the database
1025 time zone on each request that carries a client time zone value. It is expected
1026 that this will not cause any noticeable increase in latency or query execution
1027 time, as this setting is local to the specific PostgreSQL server backend process.
1029 Within the Storage service, the timezone will be set automatically by a simple
1030 wrapper method used by the existing method registration mechanism for method
1031 publishing. Disconnect and error callbacks are registered to revert the time
1032 zone setting within the database. This provides completely transparent time
1033 zone manipulation for backend services that make use of open-ils.storage.
1043 New Subject Browse Index Definitions
1044 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1045 New subject browse index definitions have been added that display the entire
1046 heading as a unit with hyphens between terms instead of displaying individual
1049 For example, the browse heading for:
1051 =650 \0$aCats$zUnited States$vCorrespondence.
1053 will display in a single entry as:
1055 Cats -- United States -- Correspondence
1057 Rather than separate entries for Cats and United States.
1059 Name subjects will continue to display as separate entries because additional
1060 work would be required for the heading to be punctuated correctly.
1065 Advanced Search Limiters Enhancement
1066 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1067 Advanced search limiters will no longer propagate to the basic search box in
1068 the catalog. Instead, the limiters applied to the search will appear underneath
1069 the search box where they can be easily cleared by clicking an 'x.' On a small,
1070 mobile device, the advanced search limiters can be seen by clicking an 'x filter
1073 The selected limiters will be applied to any search from the search bar until:
1074 * The user actively removes the filters from the search or
1075 * The user starts a new basic or advanced search from scratch.
1080 Arabic and Right-to-Left Language Support for the catalog
1081 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1082 New stylesheets and other changes to the catalog to allow for
1083 better support of right-to-left (RTL) languages, such as Arabic.
1085 Also adds Arabic (Jordan) as a new supported language.
1090 Ebook API integration
1091 ^^^^^^^^^^^^^^^^^^^^^
1092 Evergreen 2.12 supports partial integration with third-party APIs
1093 provided by OverDrive and OneClickdigital. When ebook API integration
1094 is enabled, bibliographic records from these vendors that appear in your
1095 public catalog will include vendor holdings and availability information. Also,
1096 when a user is logged in, the public catalog dashboard and My Account interface
1097 will include information about that user's checkouts and holds for
1100 For API integration to work, you need to request API access from the
1101 vendor and configure your Evergreen system according to the instructions
1102 below. You also need to configure the new `open-ils.ebook_api` service.
1104 This feature assumes that you are importing MARC records supplied by the
1105 vendor into your Evergreen system, using Vandelay or some other MARC
1106 import method. This feature does not search the vendor's online
1107 collections or automatically import vendor records into your system; it
1108 merely augments records that are already in Evergreen.
1110 A future Evergreen release will add the ability for users to check out
1111 titles, place holds, etc., directly via the public catalog.
1113 Ebook API service configuration
1114 +++++++++++++++++++++++++++++++
1115 This feature uses the new `open-ils.ebook_api` OpenSRF service. This
1116 service must be configured in your `opensrf.xml` and `opensrf_core.xml`
1117 config files for ebook API integration to work. See
1118 `opensrf.xml.example` and `opensrf_core.xml.example` for guidance.
1120 OverDrive API integration
1121 +++++++++++++++++++++++++
1122 Before enabling OverDrive API integration, you will need to request API
1123 access from OverDrive. OverDrive will provide the values to be used for
1124 the following new org unit settings:
1126 * *OverDrive Basic Token*: The basic token used for API client
1127 authentication. To generate your basic token, combine your client
1128 key and client secret provided by OverDrive into a single string
1129 ("key:secret"), and then base64-encode that string. On Linux, you
1130 can use the following command: `echo -n "key:secret" | base64 -`
1131 * *OverDrive Account ID*: The account ID (a.k.a. library ID) for your
1132 OverDrive API account.
1133 * *OverDrive Website ID*: The website ID for your OverDrive API
1135 * *OverDrive Authorization Name*: The authorization name (a.k.a.
1136 library name) designated by OverDrive for your library. If your
1137 OverDrive subscription includes multiple Evergreen libraries, you
1138 will need to add a separate value for this setting for each
1139 participating library.
1140 * *OverDrive Password Required*: If your library's OverDrive
1141 subscription requires the patron's PIN (password) to be provided
1142 during patron authentication, set this setting to "true." If you do
1143 not require the patron's PIN for OverDrive authentication, set this
1144 setting to "false." (If set to "true," the password entered by a
1145 patron when logging into the public catalog will be cached in plain text in
1147 * *OverDrive Discovery API Base URI* and *OverDrive Circulation API
1148 Base URI*: By default, Evergreen uses OverDrive's production API, so
1149 you should not need to set a value for these settings. If you want
1150 to use OverDrive's integration environment, you will need to add the
1151 appropriate base URIs for the discovery and circulation APIs. See
1152 OverDrive's developer documentation for details.
1153 * *OverDrive Granted Authorization Redirect URI*: Evergreen does not
1154 currently support granted authorization with OverDrive, so this
1155 setting is not currently in use.
1157 For more information, consult the
1158 https://developer.overdrive.com/docs/getting-started[OverDrive API
1161 To enable OverDrive API integration, adjust the following public catalog settings
1164 * `ebook_api.enabled`: set to "true".
1165 * `ebook_api.overdrive.enabled`: set to "true".
1166 * `ebook_api.overdrive.base_uris`: list of regular expressions
1167 matching OverDrive URLs found in the 856$9 field of older OverDrive
1168 MARC records. As of fall 2016, OverDrive's URL format has changed,
1169 and the record identifier is now found in the 037$a field of their
1170 MARC records, with "OverDrive" in 037$b. Evergreen will check the
1171 037 field for OverDrive record identifiers; if your system includes
1172 older-style OverDrive records with the record identifier embedded in
1173 the 856 URL, you need to specify URL patterns with this setting.
1175 OneClickdigital API integration
1176 +++++++++++++++++++++++++++++++
1177 Before enabling OneClickdigital API integration, you will need to
1178 request API access from OneClickdigital. OneClickdigital will provide
1179 the values to be used for the following new org unit settings:
1181 * *OneClickdigital Library ID*: The identifier assigned to your
1182 library by OneClickdigital.
1183 * *OneClickdigital Basic Token*: Your client authentication token,
1184 supplied by OneClickdigital when you request access to their API.
1186 For more information, consult the
1187 http://developer.oneclickdigital.us/[OneClickdigital API documentation].
1189 To enable OneClickdigital API integration, adjust the following public catalog
1190 settings in `config.tt2`:
1192 * `ebook_api.enabled`: set to "true".
1193 * `ebook_api.oneclickdigital.enabled`: set to "true".
1194 * `ebook_api.oneclickdigital.base_uris`: list of regular expressions
1195 matching OneClickdigital URLs found in the 859$9 field of your MARC
1196 records. Evergreen uses the patterns specified here to extract
1197 record identifiers for OneClickdigital titles.
1199 Additional configuration
1200 ++++++++++++++++++++++++
1201 Evergreen communicates with third-party vendor APIs using the new
1202 `OpenILS::Utils::HTTPClient` module. This module is configured using
1203 settings in `opensrf.xml`. The default settings should work for most
1204 environments by default, but you may need to specify a custom location
1205 for the CA certificates installed on your server. You can also disable
1206 SSL certificate verification on HTTPClient requests altogether, but
1207 doing so is emphatically discouraged.
1211 Links to Other Formats and Editions
1212 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1213 The record summary pages in the catalog will now link to other formats and
1214 editions of a title. The links will allow users to quickly jump to another
1215 format of the title or an edition written in another language.
1221 Metarecord Search Improvements
1222 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1223 This release brings several improvement to the Group Formats and Editions
1226 * Limiters on the advanced search page can now be successfully applied to
1227 Group Formats and Editions searches,
1228 * Electronic resources are now retrievable through these searches,
1229 * Paged navigation has improved.
1234 Allow Metarecord Search by default
1235 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1236 Before the TPAC, a site could configure the public catalog to use metarecord searching
1237 by default, via a configuration file. Here we bring that back.
1239 A new setting called search.metarecord_default is present in
1240 `templates/opac/parts/config.tt2` to enable this feature. By setting this to
1241 a true value (normally 1) the TPAC will silently include the #metabib search
1242 modifier in the search form on any interfaces that do not have a UI component
1243 that allows the user to control the setting.
1249 * Author fields are now normalized to strip ending periods so that authors from
1250 RDA and non-RDA records are collapsed in browse and facet headings.
1251 * All author/contributor roles will now display in the record detail page.
1252 Previously, some of the roles were omitted or were duplicated.
1255 Obalkyknih.cz Integration
1256 ^^^^^^^^^^^^^^^^^^^^^^^^^
1257 Evergreen now integrates with Czech added content provider obalkyknih.cz. A new
1258 setting called obalkyknih_cz.enabled is available in
1259 `templates/opac/parts/config.tt2` to enable this new feature.
1262 2.12.0 Acknowledgments
1263 ----------------------
1264 The Evergreen project would like to acknowledge the following
1265 organizations that commissioned developments in this release of
1269 * British Columbia Libraries Cooperative
1272 * King County Library System
1273 * Linn Libraries Consortium
1275 * Pennsylvania Integrated Library System
1276 * Pioneer Library System
1278 We would also like to thank the following individuals who contributed
1279 code, translations, documentations patches and tests to this release of
1312 * Job Diógenes Ribeiro Borges
1329 We also thank the following organizations whose employees contributed
1332 * British Columbia Libraries Cooperative
1336 * Emerald Data Networks, Inc.
1337 * Equinox Open Library Initiative
1339 * Indiana State Library
1340 * The Institute for the Study of Totalitarian Regimes, Prague
1342 * Jordanian Library and Information Association
1343 * King County Library System
1344 * Lake Agassiz Regional Library
1345 * Laurentian University
1346 * Linn-Benton Community College
1348 * Merrimack Valley Library Consortium
1350 * North of Boston Library Exchange
1351 * Pioneer Library System
1352 * Rodgers Memorial Library
1354 * Traverse Area District Library
1357 We regret any omissions. If a contributor has been inadvertently
1358 missed, please open a bug at https://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob