1 Evergreen 2.12 Release Notes
2 ============================
8 This release contains several bug fixes improving on Evergreen 2.12.7:
10 * Many patron fields have been redacted from the web staff client's patron
11 and record holds grids, leaving patron name, username, and ID.
12 * Fixes two bugs where patron records could fail to be saved upon editing.
13 * The patron summary in the web staff client now correctly displays
14 primary and secondary ID values.
15 * Patron barcode search completion in the web staff client now allows
16 the user to select from all of the matching patron records.
17 * The web staff print templates for current and historical bills can
18 now include copy barcode and title.
19 * Fixes a bug that resulted in some catalog searches unexpectedly
21 * Fixes a bug where placing a hold request in the public catalog could result
22 in "forgetting" the type and library of the user's previous search.
23 * Fixes a bug that made using the volume/copy editor to change a copy's
25 * The administration interface for hard due dates now ensures that
26 new (or edited) ceiling dates have their time component set to end
27 of day, resolving an issue where ceiling dates would not be applied
28 during the ceiling date itself.
29 * Asset merging during bibliographic record merging now correctly
30 recognizes call number prefixes and suffixes and deletes disused
32 * The Concerto sample data set now includes data allowing for testing
33 placing holds on monographic parts.
34 * Fixes a bug where displaying user surveys could result in PCRUD
36 * Fixes a bug where pg_restore of an Evergreen database could fail
37 to create certain indexes on the `actor.usr` table.
41 We would like to thank the following individuals who contributed code,
42 tests and documentation patches to the 2.12.8 point release of
64 This release contains several bug fixes improving on Evergreen 2.12.6
66 * Fixes a bug in the web staff client that prevented initials from being
67 stored with copy notes.
68 * Adds billing types that may have been missed by systems that were
69 running Evergreen prior to the 1.4 release.
70 * Fixes a web staff client bug with the CSV export option available from
71 the Import Queue in the MARC Batch Import/Export interface.
72 * Adds the missing copy alert field in the web client's volume/copy
74 * Fixes a bug where the setting to require date of birth in patron
75 registration was not being honored in the web staff client.
76 * Fixes a bug in the web staff client patron registration form where the
77 password wasn't generating from the last four digits of the patron's
79 * Fixes an issue in the web staff client where the complete barcode did
80 not display in some interfaces when partial barcodes were scanned.
84 We would like to thank the following individuals who contributed code,
85 tests and documentation patches to the 2.12.7 point release of
102 This release contains several bug fixes improving on Evergreen 2.12.5.
104 * Removes the option to add a title to My List from Group Formats and
105 Editions searches where the option never worked correctly due to a bad id.
106 * 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:
109 select acp.id, acp.barcode, acpl.name
111 join asset.copy_location acpl on (acpl.id = acp.location)
112 where not acp.deleted
116 * Adds the patron opt-in check in the web client whenever a patron is retrieved
117 by barcode scan, patron search, or item circ history.
118 * Fixes a bug where the price and acquisitions cost fields did not display
120 * Fixes a bug where a patron's circulation history no longer moved to the lead
121 account when merging patron accounts.
122 * Now hides the ebook tabs in My Account for sites that have not yet enabled the
124 * Trims spaces from patron barcodes in the web client check out interface.
125 * Makes a string in the holds validation alert translatable.
126 * Fixes a bug that prevented the web client patron registration screen from
127 loading when there is an opt-in action triggers, such as the email checkout
128 receipt, t set to be a registration default.
129 * Fixes a bug where barcode validation in the web client patron editor was
130 using the incorrect regular expression.
131 * Replaces an empty string in the mobile carrier dropdown menu with a 'Please
132 select your mobile carrier' label to improve usability and resolve a problem
134 * Restores the ability to display a photo in the web client patron editor for
135 accounts that have an actor.usr.photo_url.
136 * Fixes a Firefox display issue in the web client that occurred when retrieving
137 a bib record by TCN when the MARC Edit tab was set as the default view.
138 * Fixes an bug where setting a patron's default pickup location in the web
139 client patron editor inadvertently changed the home library. It also disables
140 any locations that are not viable pickup locations.
141 * Fixes a bug where a misscan in a copy bucket failed silently.
145 We would like to thank the following individuals who contributed code,
146 tests and documentation patches to the 2.12.6 point release of
164 This release contains several bug fixes improving on Evergreen 2.12.4.
166 * Hides the _Hold is Behind Circ Desk_ checkbox in the XUL client's patron
167 registration screen for those libraries that have not enabled Behind Desk Pickup
168 support via the Library Settings Editor
169 * Adds a missing error string that appears when marking an item damaged from
171 * Changes the hold request form so that it no longer defaults to the first SMS
172 carrier for text notifications.
173 * Adds a requirement for users to enter a phone/SMS number when they have
174 enabled that notification method on the hold request form.
175 * Changes the URL pointing to catalog images, CSS and javascript files to a full
176 absolute URL instead of the relative URL previously used. This change fixes an
177 issue with the Open Graph image property, which requires a full URL.
178 * Fixes an issue where payment amounts sent to Stripe can be one cent less than
179 the actual Evergreen payment.
180 * Fixes an issue where the open-ils.storage OpenSRF module fails to start when
181 using perl 5.24 or higher.
182 * Fixes a problem in the web client where marking a transaction as claims
183 returned or claims never checked out at the same time the patron's record is
184 edited would not increase the count once the patron's record is saved.
185 * Changes the cursor to a pointer for the record menus in the web client.
186 * Fixes hardcoded patchs in srfsh support scripts.
187 * Prevents a "Use of freed value in iteration" error that appeared in logs when
188 adjusting a transaction to zero.
189 * Prevents the temporary list page from crashing when a user adds the same title
190 to the list more than once.
191 * Removes duplicate rows from localized 950.data.seed-values.sql files.
192 * Fixes the following two issues with conjoined items:
193 - Foreign items previously did not display there was no extra copy attached
195 - Conjoined items did not display unless there were two or more items in a
197 * Fixes an issue in the web client where the Hold Verify prompt did not display
198 for items in a Copy Location where the hold verify flag is enabled.
199 * Fixes support for automatic item barcode completion in the web client check in,
200 check out, renew, and item status interfaces.
201 * Makes the courier code variable available for transit slips in the web client.
202 * Fixes the ability to apply funds from the acquisitions selection list,
203 View/Place Order, and MARC Federated Search interfaces.
207 We would like to thank the following individuals who contributed code,
208 tests and documentation patches to the 2.12.5 point release of
232 * This release of Evergreen contains a fix to the _Hold/Copy Ratio per Bib
233 and Pickup Library (and Descendants)_ data source. Report templates using
234 this data source will need to be re-created to improve accuracy of the
235 data reported from this source.
236 * This release also contains a fix to downloading large checkout histories from
237 My Account. This feature no longer uses the action/trigger mechanism and the
238 OPAC now generates the CSV directly. The old action/trigger code is still
239 present in the database and should be removed at some point in the
244 This release contains several bug fixes improving on Evergreen 2.12.3
247 * A fix to a web client bug where adding copies through the _Add Volumes
248 and Copies_ menu item could fail silently.
249 * A fix to a bug that allowed users to access some web client admin interfaces
251 * A fix to the display of the loan duration and fine level fields in the web
252 client Item Status Detail view.
253 * A fix to the display of duplicate data on the bib record View Holds page when
254 toggling between the holds and OPAC view.
255 * A fix to a bug that prevented the web client patron registration page from
257 * Support for Org Unit Includes alert text, notice text, event text, header
258 text, and footer text in the web client print templates.
259 * A fix to make the web client MARC Editor's flat text editor selection sticky.
260 * A fix to make the Patron Search library selector sticky.
261 * A fix to a bug in the web client that prevented the user from saving a new
262 copy after using the MARC Edit _Add Item_ option.
263 * A fix to a patron registration bug that did not require the entry of a required
264 user statistical category for stat cats that do not allow free-text entries.
265 * The addition of the bad bacode image file in the web client.
266 * An improvement to the MARC Batch Edit progress indicator to reduce the
267 likelihood of system backlogs.
268 * Downloading checkout history as a CSV from My Account has been fixed
269 for users with a large circulation history. Previously, this would
270 time out for patrons with more than 100 or so circulations.
271 * A fix to syntax in the Spanish lang.dtd file that was creating an error
272 when using the Closed Date Editor.
273 * Improvements to CSS to silence some Mozilla extension warnings.
274 * A fix to a failure to update targeted circulations when utilzing the recall
276 * The addition of text wrapping in the copy details table on the bib
277 record to prevent contents from falling off the page.
278 * A fix to the adjust to zero option so that it can be applied correctly
279 to multiple billings.
280 * A fix to the "Hold/Copy Ratio per Bib and Pickup Library
281 (and Descendants)" data source so that it will now include counts of eligible
282 copies at locations that are not a pickup library for bib's holds.
283 * A fix to the XUL client Item Status -> Alternate View -> Holds / Transit
284 tab so that it properly refreshes all data when switching between copies.
288 We would like to thank the following individuals who contributed code,
289 tests and documentation patches to the 2.12.4 point release of
313 This release contains several bug fixes improving on Evergreen 2.12.2.
317 The web client, which is available for trial production use in libraries,
318 received several fixes in this release:
320 * The receipt on payment checkbox now prints a receipt at time of payment.
321 * The Items Out count in the patron screen now includes long overdue
323 * A fix was added to prevent values from a previously-edited patron from
324 appearing in the edit form of a subsequent patron.
325 * User notification preferences now save correctly in the patron
326 registration and edit forms.
327 * The UPDATE_MARC permission is no longer requested when performing a
328 search from the staff catalog.
329 * Non-cataloged circulations now display in the Items Out screen without
331 * Required statistical categories are now required to be entered in the
332 copy editor. (A similar bug for the patron editor was fixed in the 2.12.1
334 * Voiding bills now requires confirmation.
335 * Staff can no longer use the copy editor to put items into or out of the
336 following statuses: checked out, lost, in transit, on holds shelf, long
337 overdue, and canceled transit.
338 * The contrast is improved for alert text showing the amount a patron owes
340 * Circ modifiers now sort alphabetically in the copy editor.
344 * Code to prevent a hold already on the Holds Shelf from being
345 transferred to another title.
346 * A fix to a bug that prevented users from scheduling reports with a
347 relative month if the report template used a date that applied the Year +
348 Month transform with the On or After (>=) operator.
349 * A fix to a bug where the max fines threshold was reached prematurely
350 due to the presence of account adjustments.
351 * A check that prevents a SMS message from attempting to sending when the SMS
353 * For systems that provide search format as a filter on the advanced
354 search page, a fix so that the format selected in the search bar when
355 launching a new search from the results page overrides any previously-set
357 * The addition of an optional new Apache/mod_perl configuration variable for
358 defining the port Apache listens on for HTTP traffic. This resolves an issue
359 where added content lookups attempting HTTP requests on the local Apache
360 instance on port 80 failed because Apache was using non-standard ports.
361 * A fix to the public catalog's My List page responsive design so that it now
362 displays properly on mobile devices and allows users to place holds from My List.
363 * A fix to a bug where the second (and subsequent)
364 pages of search results in the public catalog (when group
365 formats and editions is in effect) does not correctly generate
366 links to hits that are not part of of a multi-bib metarecords.
370 We would like to thank the following individuals who contributed code,
371 testing and documentation patches to the 2.12.3 point release of
391 This release is a security release that also contains several other bug
392 fixes improving on Evergreen 2.12.1.
394 Security Issue: XSS Vulnerability in Public Catalog
395 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
396 This release fixes several cross-site scripting (XSS) vulnerabilities
397 in the public catalog. When upgrading, Evergreen administrators should
398 review whether any of the following templates have been customized
399 or overridden. If so, either the template should be replaced with the
400 stock version or the XSS fix (which entails adding the `| html` filter
401 in several places) applied to the customized version.
403 * `Open-ILS/src/templates/opac/parts/locale_picker.tt2`
404 * `Open-ILS/src/templates/opac/parts/login/form.tt2`
405 * `Open-ILS/src/templates/opac/parts/searchbar.tt2`
409 * Administrators of Evergreen who use RTL locales and who have customized
410 `style-rtl.css.tt2` should now incorporate their customizations into
412 * The `reporter.classic_current_circ` view, which is part of some
413 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
414 has been fixed to not exclude loans for patrons who do not have a
415 billing address set. Users of this view should rerun
416 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
418 Hold Targeter Repairs and Improvements
419 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
420 A series of changes were made to the new hold targeter available in 2.12.
422 * Make the batch targeter more resilient to a single-hold failure.
423 * Additional batch targeter info logging.
424 * Set OSRF_LOG_CLIENT in hold_targeter_v2.pl for log tracing
425 * Removes the confusingly named --target-all option
426 ** The same behavior can be achieved by using --retarget-interval "0s"
427 * Removes --skip-viable (see --soft-retarget-interval below)
429 New --next-check-interval Option
430 ++++++++++++++++++++++++++++++++
431 Specify how long after the current run time the targeter will retarget
432 the currently affected holds. Applying a specific interval is useful
433 when the retarget-interval is shorter than the time between targeter
436 For example, if the targeter is run nightly at midnight with a
437 --retarget-interval 36h, you would set --next-check-interval to 48hr,
438 since the holds won't be processed again until 48 hours later. This
439 ensures that the org unit closed date checks are looking at the correct
442 This setting overrides the default behavior of calculating the next
443 retarget time from the retarget-interval.
445 New --soft-retarget-interval Option
446 +++++++++++++++++++++++++++++++++++
447 This is a replacement for (and rebranding of) the --skip-viable option.
448 The new option allows for time-based soft-targeting instead simple binary
449 on/off soft-targeting.
451 How soft-targeting works:
452 * Update hold copy maps for all affected holds
453 * Holds with viable targets (on the pull list) are otherwise left alone.
454 * Holds without viable targets are retargeted in the usual manner.
458 * A fix to remove the Chilifresh patron reviews header for Evergreen sites
459 that do not use Chilifresh.
460 * A fix that marks acquisitions POs as received when all line items on the
461 PO are received or canceled.
462 * A typo fix to the long overdue override permission that prevented staff
463 from being able to override long overdue check ins.
464 * A fix to use a library's configured currency in SIP patron responses
465 instead of always using US dollars.
466 * A fix to SIP timeouts caused by invalid sessions
467 * A fix that allows boolean fields to be recognized in queries to the
469 * A fix to use the correct method during adjust to zero on negative
471 * A correction to the datatype for the Vandelay Default Record Match Set
473 * The removal of the _Keep_ field from MARC Batch Import Item Attributes.
474 The field was not previously implemented.
475 * A fix to set the complete time value for grouped Action/Trigger events
476 when an event's state reach complete, consistent with non-grouped events.
477 * A fix to a bug in the rollover_phone_to_print.pl script that kept failed
478 call files from being moved.
479 * A new index for acq.edi_message that speeds up the check for duplicate
481 * A fix that ensures JSON strings are converted to UTF8, ensuring that
482 non-ASCII data display correctly.
483 * A fix to avoid an erroneous unsaved data popup to appear during MARC
485 * A typo fix in the web client's bill payment receipt template.
486 * A correction to ebook account links on the My Account Summary page.
487 * Improved responsive design for the ebook My Account screens so that
488 they display better on mobile devices.
489 * A fix to a bug that prevented a patron opt-in dialog from loading.
490 * The RTL stylesheet for the public catalog,
491 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
492 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
493 template will emit RTL or LTR styles based on the value of
494 the `rtl` flag of the active locale. An `rtl` variable is also available
495 in the template to allow the correct style to be chosen.
496 * A fix to leaking of the internal port number to the client when
497 Apache is configured to use nonstandard ports in combination with a proxy
499 * The addition of the vandelay.auto_overlay_bib_record upgrade script,
500 which was missed in a 2.1-2.2 era upgrade script. It isn't necessary for
501 sites that began using Evergreen since then to run the script, but
502 it is harmless to run.
503 * A web staff client fix that will hid the behind-desk option for
504 for libraries that do not support "Behind Desk Pickup".
505 * A web staff client fix that caused hold transit check ins to fail
506 silently when the transit destination does not have a holds address.
507 * A web staff client fix that now requires the entry of user statistical
508 categories in the patron editor if those stat cats are configured to
510 * A fix to a problem with the "Exclude Electronic Resources" checkbox
511 that prevented users from removing a selection from the box.
512 * The removal of the search format limiters from the new advanced search
513 limiter block on the search results page. The search format limiters
514 should not display there because they can be selected from the search bar.
521 We would like to thank the following individuals who contributed code,
522 testing and documentation patches to the 2.12.2 point release of
545 This release contains several bug fixes improving on Evergreen 2.12.0
547 * A fix to the 2.12 upgrade of the subject|temporal and subject|geographic
548 indexes, where the above-mentioned browse indexes were not turned off in favor
549 of new browse versions of the indexes. Sites that are upgrading from 2.12.0
550 can cancel the browse reingest that comes with the new upgrade script.
552 * A change to the default pickup library when staff place a hold. The place hold
553 screen will now default to the preferred pickup location for the patron. If the
554 patron does not have a preferred pickup location, it will default to the
555 patron's home library.
556 * A fix to a problem where users could not change the selected Org Unit on the
557 MARC Tag Tables server admin page.
558 * A fix to the seed data for translations for some Coded Value Map entries.
559 * The ability to skip the XUL staff client build when in make_release.
560 * Revised layout and styling for the advanced search limiter block that displays
561 on the search results page.
562 * A fix that silences a log warning that appears for every checkout where a hard
563 due date is not used.
564 * Tweaks for sounds that are used in the web staff client.
565 * The addition of f4 and ctrl-f2 as hotkeys in the web staff client.
566 * Additional help text for receipt templates in the web staff client.
567 * The reinstatement of the Reprint Last Receipt functionality in the web staff client.
568 * The ability in the web staff client copy editor to add new volumes to
569 libraries that were not selected in holdings view.
570 * A fix to a billing issue where transactions were not re-opened after they
571 acquired a non-zero balance at check in.
572 * A change to the web staff client work log to prevent it from storing
574 * A fix to a translation issue for the record attributes displayed in the
575 advanced search limiter block on the search results page.
576 * A fix to hold targeting for metarecord holds when the new hold targeter is
577 run in parallel mode.
581 We would like to thank the following individuals who contributed code,
582 testing and documentation patches to the 2.12.1 point release of
603 Evergreen 2.12 now requires OpenSRF 2.5 or later; certain functionality
604 will not work if you attempt to run Evergreen 2.12 on OpenSRF 2.4. Evergreen
605 2.12 recommends PostgreSQL 9.4. The minimum supported version of PostgreSQL is
608 The stock schema upgrade script performs a browse and facet reingest,
609 recalculates bib fingerprints, and remaps metarecords.
611 This version also adds two new services, `open-ils.ebook_api` and
612 `open-ils.hold-targeter`.
619 Default status for received line items
620 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
621 A new Library Setting has been added to allow libraries to set the default
622 status for received line items. The previous behavior was to use the
623 "In process" status for all acquisitions items that are received.
631 Additional SMS Carriers
632 ^^^^^^^^^^^^^^^^^^^^^^^
633 SMS carrier definitions are now included for Google Fi and
634 Republic Wireless. These will be automatically loaded when
635 installing a new Evergreen system; admins who wish to
636 add these definitions during an upgrade can use the following
637 email gateway values:
639 * Google Fi: `$number@msg.fi.google.com`
640 * Republic Wireless: `$number@text.republicwireless.com`
645 Bibliographic Fingerprint Improvements
646 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
647 The bibliographic fingerprint will now incorporate subfields $n and $p from MARC
648 title fields to better distinguish among records of the same series that
649 may share the same title but have a different part. With this change, these
650 MARC records will no longer be grouped together in a 'Group Formats & Editions'
653 The bibliographic fingerprint was also changed to better distinguish among
654 the fields contributing to the fingerprint. This change will help the system
655 distinguish between a record for the movie _Blue Steel_ and another record for
656 the book _Blue_ written by Danielle Steel.
663 Batch Hold Targeter Speed-up and New Features
664 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
666 Adds a new `open-ils.hold-targeter` service, supporting new targeting options
667 and runtime optimizations to speed up targeting. The service is launched
668 from a new targeting script, `hold_targeter_v2.pl` (default location:
669 `/openils/bin/hold_targeter_v2.pl`).
671 This code has no effect on the existing hold targeter, which is still
672 available as of this release and functions as before.
677 * Adds a global configuration flag 'circ.holds.retarget_interval' for
678 setting the hold retarget interval.
680 * `--target-all` option forces the targeter to process all active
681 holds, regardless of when they were last targeted.
683 * `--retarget-interval` option make is possible to override the new
684 'circ.holds.retarget_interval' setting via the command line
685 when calling the hold targeter.
687 * `--skip-viable` option causes the hold targeter to avoid modifying
688 the currently targeted copy (i.e. the copy on the pull list) for holds
689 that target a viable (capturable) copy.
692 For skipped holds, no entry is added to the unfulfilled_hold_list.
693 The set of potential copies (hold copy maps) are refreshed for all
694 processed holds, regardless of target viability.
697 This option is useful for 1.) finding targets for holds that require
698 new targets and 2.) adding new/modified copies to the potential copy
699 lists (for opportunistic capture) more frequently than you may want to do full
700 retargeting of all holds.
702 * `--newest-first` option processes holds in reverse order of request_time,
703 so that newer holds are (re)targeted first. This is primarily useful
704 when a large backlog of old, un-targetable holds exist. With
705 `--newest-first`, the older holds will be processed last.
707 * `--parallel` option overrides the parallel settings found in `opensrf.xml`
708 for simpler modification and testing.
710 * `--lockfile` option allows the caller to specify a lock file instead
711 of using the default /tmp/hold_targeter-LOCK
713 * `--verbose` option prints progress info to STDOUT, showing the number of
714 holds processed per parallel targeter instance.
716 * When configured, hold target loops cycle through all org units (with
717 targetable copies) instead of repeatedly targeting copies at the pickup
718 library when multiple targetable copies exist at the pickup library.
720 * When configured, hold target loops prioritize (targetable) org units
721 first by the number of previous target attempts, then by their
722 weight/proximity. This effectively back-fills org units that had no
723 targetable copies during earlier target loops so that they are
724 targeted as many times as other org units (to the extent possible,
730 * Traditional daily hold targeter with a value set for
731 'circ.holds.retarget_interval'.
734 --------------------------------------------------------------------------
735 /openils/bin/hold_targeter_v2.pl
736 --------------------------------------------------------------------------
738 * (Re)target non-viable holds twice a day, only processing holds that
739 have never been targeter or those that have not been re-targeted in
743 --------------------------------------------------------------------------
744 /openils/bin/hold_targeter_v2.pl --skip-viable --retarget-interval "12h"
745 --------------------------------------------------------------------------
747 * (Re)target non-viable holds twice a day, processing all holds regardless
748 of when or if they were targeted before, running 3 targeters in
752 --------------------------------------------------------------------------
753 /openils/bin/hold_targeter_v2.pl --skip-viable --target-all --parallel 3
754 --------------------------------------------------------------------------
760 Add separate make target for translators
761 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
762 For those only interested in building Evergreen translations, a separate
763 "translator" make target has been added to allow for easier installation
764 of i18n prerequisites.
767 Allow admin to specify where Perl modules will be installed
768 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
769 Add `--with-perlbase` option to `configure` to specify an alternative
770 location for installing the Perl modules. This can be useful for setups
771 that want to run the Perl modules from a shared filesystem or
772 environments that need to run multiple versions of Evergreen
775 Users of `--with-perlbase` are responsible for ensuring that `PERL5LIB`
776 is set appropriately.
780 Addition of missing permissions
781 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
782 Required permissions that were previously missing from the stock data have now
783 been added. If Evergreen sites have already manually added these permissions,
784 the upgrade script will remove the old permission and create the new one,
785 maintaining any maps to permission groups, with the stock permission ID.
791 get_org_unit_ancestor_at_depth Helper Added to Action Trigger Reactor Helpers
792 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
793 In action trigger templates it's now possible to call
794 `helpers.get_org_unit_ancestor_at_depth($id_or_aou, $depth)` in order to retrieve
795 a fleshed aou for the target aou's ancestor at the chosen depth. This could be
796 used to retrieve the name of the library system rather than a specific branch
802 Removed unused selfcheck password setting
803 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
804 There was an unused duplicate selfcheck password setting that was removed
805 to avoid confusion over which library setting was supposed to be set to
806 enable passwords for selfcheck. After upgrading, verify that your library
807 policy remains consistent for this setting.
813 Credit Processor Stripe Settings Permissions
814 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
815 Unprivileged users can retrieve organizational unit setting values for
816 setting types lacking a "view" permission. When the feature adding
817 Stripe credit card processing was added, the upgrade script neglected
818 to add the VIEW_CREDIT_CARD_PROCESSING permission to the
819 organizational unit setting type. This means that anyone can retrieve
820 and view the settings for Stripe credit card processing.
822 Any system that upgraded from Evergreen version 2.5 to 2.6 is
823 affected. If you use Stripe for credit card processing, it is
824 strongly recommended that you apply this upgrade. Even if you do not
825 use Stripe, applying this upgrade is still recommended. If you did
826 not upgrade from version 2.5 to 2.6 of Evergreen, but started with a
827 later version, applying this upgrade is harmless.
837 New Access Points for MARC Merge/Overlay Profiles
838 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
839 Catalogers can now select a MARC merge/overlay profile to apply when
840 merging records in the (browser client) record bucket merge and Z39.50
841 record overlay interfaces. In both interfaces, if the user selects
842 a merge profile, the results of the merge are displayed, giving the
843 user the opportunity to choose a different merge profile or edit
844 the records involved prior to committing to the merge.
846 A new library setting, "Default Merge Profile (Z39.50 and Record Buckets)",
847 specifies the merge profile to preselect in the new merge profile
848 selectors in the record bucket merge and Z39.50 overlay logs. The
849 selectors will also remember the last selection that the user made.
859 Display Copy Alerts With In-House-Use
860 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
862 Two library settings are used to control the display of copy alert
863 messages or copy location check in alerts when recording in-house-use
866 Setting 'Display copy alert for in-house-use' to true for an
867 organization will cause an alert to appear with the copy's alert
868 message, if it has one, when recording in-house-use for the copy.
870 Setting 'Display copy location check in alert for in-house-use' to true
871 for an organization will cause an alert to display a message
872 indicating that the item needs to be routed to its location if the
873 location has check in alert set to true.
875 The settings are independent of one another because you may want to
876 display one and not the other when recording in-house-use.
886 Active Date Column Picker Option
887 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
888 The active date will now be available as a column picker option in the Item
894 Punctuation Insensitive Patron Search
895 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
896 When performing a patron search, punctuation characters will be
897 ignored. So if the patron is named O'Brien, then you can enter Obrien,
898 O'Brien, O Brien, etc. in the search box.
900 This behavior affects the Last Name (internally: family_name), First Name
901 (first_given_name), and Middle Name (second_given_name) fields of the search.
908 Touch screen improvements for Evergreen self-check interface
909 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
910 Improvements were made to the Evergreen self-check interface to make it easier
911 to use in a touch-screen environment.
913 * The pay fines link is now a pay fines button, matching other buttons on the
915 * The checkboxes have been enlarged, making them easier to activate when using
922 Trial Production Use of the Web Staff Client
923 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
924 The new web staff client is ready for trial production use in all functional
925 areas with the exception of serials and offline transactions. In addition to
926 many bug fixes in the areas of circulation, cataloging, administration and
927 reporting, Release 2.12 sees the following additions to web client
930 * Acquisitions interfaces and functionality have been integrated into the web
932 * Booking interfaces and functionality have been integrated into the web staff
934 * Hatch, the program that will allow for unmediated printing to multiple
935 printers, sharing of workstation settings, and, eventually, offline
936 transactions is now available. A windows installer for Hatch will be available
937 on the Evergreen-ILS Downloads page.
939 The Evergreen developers will keep pilot libraries updated about known web
940 client issues by posting known bugs to https://wiki.evergreen-ils.org/doku.php?id=dev:browser_staff:known_issues .
944 Hatch is not required to use the web client, but should be used for workstations
945 that need to perform the following tasks.
947 * Unmediated printing to multiple printers. Workstations can print to multiple
948 printers without Hatch, but will need to click through a dialog to select a
949 printer. Hatch allows workstations to automatically print, without dialog, to
951 * Storage of workstation settings in a place outside the browser. Storing local
952 preferences in hatch will prevent tampering with preferences via the browser
953 developer tools and protect the settings from possible deletion if the browser
954 deletes settings in local storage.
955 * When offline functionality is available, hatch will be required to perform
956 offline transactions.
958 Hatch is currently run as a Chrome extension and is not available in Firefox. To
959 use hatch on Windows, Evergreen sites should:
961 . install a java runtime environment version 8 (or higher) if not already
963 . download and execute the installer from the Evergreen downloads page,
964 . open Chrome and navigate to chrome://extensions,
965 . enable _Developer Mode_ along the top right of the page,
966 . click the _Load Unpacked Extension_ button,
967 . load the directory at Hatch -> extension -> app,
968 .. In Windows, the default location for the app directory will be
969 C:\Program Files (x86)\Hatch\extension\app
970 . enable hatch features in the web client by going to Administration ->
971 Workstation Administration -> Print/Storage Service ("Hatch") and choosing
972 which services to use with Hatch.
973 .. this page will also inform you that hatch is connected.
983 Client Timezone Awareness
984 ^^^^^^^^^^^^^^^^^^^^^^^^^
986 Previously, adjusting the time zone in which a database session operates
987 could not be done in any way except globally, directly within the database.
988 However, allowing modification of the timezone parameter now supports
989 localization efforts for those consortia that span multiple time zones.
994 CStore and other services that interact with the primary Evergreen database
995 make use of the functionality provided by LP#1485371 in OpenSRF in order to
996 set the time zone configuration parameter available in PostgreSQL. This has
997 the effect of interpreting all timestamps written to or read from the database
998 in the client's time zone.
1000 Within CStore (and related, C-based services), all stateful sessions make use
1001 of this capability, setting the database time zone upon a successful CONNECT
1002 message from the client. The time zone is reset to the database default when
1003 a session is terminated either due to client DISCONNECT or server keepalive
1006 All stateless requests record the current database time zone, set the database
1007 time zone to that of the client's, run the query, and then reset the database
1008 time zone on each request that carries a client time zone value. It is expected
1009 that this will not cause any noticeable increase in latency or query execution
1010 time, as this setting is local to the specific PostgreSQL server backend process.
1012 Within the Storage service, the timezone will be set automatically by a simple
1013 wrapper method used by the existing method registration mechanism for method
1014 publishing. Disconnect and error callbacks are registered to revert the time
1015 zone setting within the database. This provides completely transparent time
1016 zone manipulation for backend services that make use of open-ils.storage.
1026 New Subject Browse Index Definitions
1027 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1028 New subject browse index definitions have been added that display the entire
1029 heading as a unit with hyphens between terms instead of displaying individual
1032 For example, the browse heading for:
1034 =650 \0$aCats$zUnited States$vCorrespondence.
1036 will display in a single entry as:
1038 Cats -- United States -- Correspondence
1040 Rather than separate entries for Cats and United States.
1042 Name subjects will continue to display as separate entries because additional
1043 work would be required for the heading to be punctuated correctly.
1048 Advanced Search Limiters Enhancement
1049 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1050 Advanced search limiters will no longer propagate to the basic search box in
1051 the catalog. Instead, the limiters applied to the search will appear underneath
1052 the search box where they can be easily cleared by clicking an 'x.' On a small,
1053 mobile device, the advanced search limiters can be seen by clicking an 'x filter
1056 The selected limiters will be applied to any search from the search bar until:
1057 * The user actively removes the filters from the search or
1058 * The user starts a new basic or advanced search from scratch.
1063 Arabic and Right-to-Left Language Support for the catalog
1064 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1065 New stylesheets and other changes to the catalog to allow for
1066 better support of right-to-left (RTL) languages, such as Arabic.
1068 Also adds Arabic (Jordan) as a new supported language.
1073 Ebook API integration
1074 ^^^^^^^^^^^^^^^^^^^^^
1075 Evergreen 2.12 supports partial integration with third-party APIs
1076 provided by OverDrive and OneClickdigital. When ebook API integration
1077 is enabled, bibliographic records from these vendors that appear in your
1078 public catalog will include vendor holdings and availability information. Also,
1079 when a user is logged in, the public catalog dashboard and My Account interface
1080 will include information about that user's checkouts and holds for
1083 For API integration to work, you need to request API access from the
1084 vendor and configure your Evergreen system according to the instructions
1085 below. You also need to configure the new `open-ils.ebook_api` service.
1087 This feature assumes that you are importing MARC records supplied by the
1088 vendor into your Evergreen system, using Vandelay or some other MARC
1089 import method. This feature does not search the vendor's online
1090 collections or automatically import vendor records into your system; it
1091 merely augments records that are already in Evergreen.
1093 A future Evergreen release will add the ability for users to check out
1094 titles, place holds, etc., directly via the public catalog.
1096 Ebook API service configuration
1097 +++++++++++++++++++++++++++++++
1098 This feature uses the new `open-ils.ebook_api` OpenSRF service. This
1099 service must be configured in your `opensrf.xml` and `opensrf_core.xml`
1100 config files for ebook API integration to work. See
1101 `opensrf.xml.example` and `opensrf_core.xml.example` for guidance.
1103 OverDrive API integration
1104 +++++++++++++++++++++++++
1105 Before enabling OverDrive API integration, you will need to request API
1106 access from OverDrive. OverDrive will provide the values to be used for
1107 the following new org unit settings:
1109 * *OverDrive Basic Token*: The basic token used for API client
1110 authentication. To generate your basic token, combine your client
1111 key and client secret provided by OverDrive into a single string
1112 ("key:secret"), and then base64-encode that string. On Linux, you
1113 can use the following command: `echo -n "key:secret" | base64 -`
1114 * *OverDrive Account ID*: The account ID (a.k.a. library ID) for your
1115 OverDrive API account.
1116 * *OverDrive Website ID*: The website ID for your OverDrive API
1118 * *OverDrive Authorization Name*: The authorization name (a.k.a.
1119 library name) designated by OverDrive for your library. If your
1120 OverDrive subscription includes multiple Evergreen libraries, you
1121 will need to add a separate value for this setting for each
1122 participating library.
1123 * *OverDrive Password Required*: If your library's OverDrive
1124 subscription requires the patron's PIN (password) to be provided
1125 during patron authentication, set this setting to "true." If you do
1126 not require the patron's PIN for OverDrive authentication, set this
1127 setting to "false." (If set to "true," the password entered by a
1128 patron when logging into the public catalog will be cached in plain text in
1130 * *OverDrive Discovery API Base URI* and *OverDrive Circulation API
1131 Base URI*: By default, Evergreen uses OverDrive's production API, so
1132 you should not need to set a value for these settings. If you want
1133 to use OverDrive's integration environment, you will need to add the
1134 appropriate base URIs for the discovery and circulation APIs. See
1135 OverDrive's developer documentation for details.
1136 * *OverDrive Granted Authorization Redirect URI*: Evergreen does not
1137 currently support granted authorization with OverDrive, so this
1138 setting is not currently in use.
1140 For more information, consult the
1141 https://developer.overdrive.com/docs/getting-started[OverDrive API
1144 To enable OverDrive API integration, adjust the following public catalog settings
1147 * `ebook_api.enabled`: set to "true".
1148 * `ebook_api.overdrive.enabled`: set to "true".
1149 * `ebook_api.overdrive.base_uris`: list of regular expressions
1150 matching OverDrive URLs found in the 856$9 field of older OverDrive
1151 MARC records. As of fall 2016, OverDrive's URL format has changed,
1152 and the record identifier is now found in the 037$a field of their
1153 MARC records, with "OverDrive" in 037$b. Evergreen will check the
1154 037 field for OverDrive record identifiers; if your system includes
1155 older-style OverDrive records with the record identifier embedded in
1156 the 856 URL, you need to specify URL patterns with this setting.
1158 OneClickdigital API integration
1159 +++++++++++++++++++++++++++++++
1160 Before enabling OneClickdigital API integration, you will need to
1161 request API access from OneClickdigital. OneClickdigital will provide
1162 the values to be used for the following new org unit settings:
1164 * *OneClickdigital Library ID*: The identifier assigned to your
1165 library by OneClickdigital.
1166 * *OneClickdigital Basic Token*: Your client authentication token,
1167 supplied by OneClickdigital when you request access to their API.
1169 For more information, consult the
1170 http://developer.oneclickdigital.us/[OneClickdigital API documentation].
1172 To enable OneClickdigital API integration, adjust the following public catalog
1173 settings in `config.tt2`:
1175 * `ebook_api.enabled`: set to "true".
1176 * `ebook_api.oneclickdigital.enabled`: set to "true".
1177 * `ebook_api.oneclickdigital.base_uris`: list of regular expressions
1178 matching OneClickdigital URLs found in the 859$9 field of your MARC
1179 records. Evergreen uses the patterns specified here to extract
1180 record identifiers for OneClickdigital titles.
1182 Additional configuration
1183 ++++++++++++++++++++++++
1184 Evergreen communicates with third-party vendor APIs using the new
1185 `OpenILS::Utils::HTTPClient` module. This module is configured using
1186 settings in `opensrf.xml`. The default settings should work for most
1187 environments by default, but you may need to specify a custom location
1188 for the CA certificates installed on your server. You can also disable
1189 SSL certificate verification on HTTPClient requests altogether, but
1190 doing so is emphatically discouraged.
1194 Links to Other Formats and Editions
1195 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1196 The record summary pages in the catalog will now link to other formats and
1197 editions of a title. The links will allow users to quickly jump to another
1198 format of the title or an edition written in another language.
1204 Metarecord Search Improvements
1205 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1206 This release brings several improvement to the Group Formats and Editions
1209 * Limiters on the advanced search page can now be successfully applied to
1210 Group Formats and Editions searches,
1211 * Electronic resources are now retrievable through these searches,
1212 * Paged navigation has improved.
1217 Allow Metarecord Search by default
1218 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1219 Before the TPAC, a site could configure the public catalog to use metarecord searching
1220 by default, via a configuration file. Here we bring that back.
1222 A new setting called search.metarecord_default is present in
1223 `templates/opac/parts/config.tt2` to enable this feature. By setting this to
1224 a true value (normally 1) the TPAC will silently include the #metabib search
1225 modifier in the search form on any interfaces that do not have a UI component
1226 that allows the user to control the setting.
1232 * Author fields are now normalized to strip ending periods so that authors from
1233 RDA and non-RDA records are collapsed in browse and facet headings.
1234 * All author/contributor roles will now display in the record detail page.
1235 Previously, some of the roles were omitted or were duplicated.
1238 Obalkyknih.cz Integration
1239 ^^^^^^^^^^^^^^^^^^^^^^^^^
1240 Evergreen now integrates with Czech added content provider obalkyknih.cz. A new
1241 setting called obalkyknih_cz.enabled is available in
1242 `templates/opac/parts/config.tt2` to enable this new feature.
1245 2.12.0 Acknowledgments
1246 ----------------------
1247 The Evergreen project would like to acknowledge the following
1248 organizations that commissioned developments in this release of
1252 * British Columbia Libraries Cooperative
1255 * King County Library System
1256 * Linn Libraries Consortium
1258 * Pennsylvania Integrated Library System
1259 * Pioneer Library System
1261 We would also like to thank the following individuals who contributed
1262 code, translations, documentations patches and tests to this release of
1295 * Job Diógenes Ribeiro Borges
1312 We also thank the following organizations whose employees contributed
1315 * British Columbia Libraries Cooperative
1319 * Emerald Data Networks, Inc.
1320 * Equinox Open Library Initiative
1322 * Indiana State Library
1323 * The Institute for the Study of Totalitarian Regimes, Prague
1325 * Jordanian Library and Information Association
1326 * King County Library System
1327 * Lake Agassiz Regional Library
1328 * Laurentian University
1329 * Linn-Benton Community College
1331 * Merrimack Valley Library Consortium
1333 * North of Boston Library Exchange
1334 * Pioneer Library System
1335 * Rodgers Memorial Library
1337 * Traverse Area District Library
1340 We regret any omissions. If a contributor has been inadvertently
1341 missed, please open a bug at https://bugs.launchpad.net/evergreen/
projects / Evergreen.git / blob