1. Upgrade notes

Evergreen 2.12 now requires OpenSRF 2.5 or later; certain functionality will not work if you attempt to run Evergreen 2.12 on OpenSRF 2.4. Evergreen 2.12 recommends PostgreSQL 9.4. The minimum supported version of PostgreSQL is 9.3.

The stock schema upgrade script performs a browse and facet reingest, recalculates bib fingerprints, and remaps metarecords.

This version also adds two new services, open-ils.ebook_api and open-ils.hold-targeter.

2. New Features

2.1. Administration

2.1.1. Additional SMS Carriers

SMS carrier definitions are now included for Google Fi and Republic Wireless. These will be automatically loaded when installing a new Evergreen system; admins who wish to add these definitions during an upgrade can use the following email gateway values:

  • Google Fi: $number@msg.fi.google.com

  • Republic Wireless: $number@text.republicwireless.com

2.1.2. Bibliographic Fingerprint Improvements

The bibliographic fingerprint will now incorporate subfields $n and $p from MARC title fields to better distinguish among records of the same series that may share the same title but have a different part. With this change, these MARC records will no longer be grouped together in a Group Formats & Editions search.

The bibliographic fingerprint was also changed to better distinguish among the fields contributing to the fingerprint. This change will help the system distinguish between a record for the movie Blue Steel and another record for the book Blue written by Danielle Steel.

2.1.3. Batch Hold Targeter Speed-up and New Features

Adds a new open-ils.hold-targeter service, supporting new targeting options and runtime optimizations to speed up targeting. The service is launched from a new targeting script, hold_targeter_v2.pl (default location: /openils/bin/hold_targeter_v2.pl).

This code has no effect on the existing hold targeter, which is still available as of this release and functions as before.

New Features/Options
  • Adds a global configuration flag circ.holds.retarget_interval for setting the hold retarget interval.

  • --target-all option forces the targeter to process all active holds, regardless of when they were last targeted.

  • --retarget-interval option make is possible to override the new circ.holds.retarget_interval setting via the command line when calling the hold targeter.

  • --skip-viable option causes the hold targeter to avoid modifying the currently targeted copy (i.e. the copy on the pull list) for holds that target a viable (capturable) copy.

    For skipped holds, no entry is added to the unfulfilled_hold_list. The set of potential copies (hold copy maps) are refreshed for all processed holds, regardless of target viability.

    This option is useful for 1.) finding targets for holds that require new targets and 2.) adding new/modified copies to the potential copy lists (for opportunistic capture) more frequently than you may want to do full retargeting of all holds.

  • --newest-first option processes holds in reverse order of request_time, so that newer holds are (re)targeted first. This is primarily useful when a large backlog of old, un-targetable holds exist. With --newest-first, the older holds will be processed last.

  • --parallel option overrides the parallel settings found in opensrf.xml for simpler modification and testing.

  • --lockfile option allows the caller to specify a lock file instead of using the default /tmp/hold_targeter-LOCK

  • --verbose option prints progress info to STDOUT, showing the number of holds processed per parallel targeter instance.

  • When configured, hold target loops cycle through all org units (with targetable copies) instead of repeatedly targeting copies at the pickup library when multiple targetable copies exist at the pickup library.

  • When configured, hold target loops prioritize (targetable) org units first by the number of previous target attempts, then by their weight/proximity. This effectively back-fills org units that had no targetable copies during earlier target loops so that they are targeted as many times as other org units (to the extent possible, anyway).

  • Traditional daily hold targeter with a value set for circ.holds.retarget_interval.

  • (Re)target non-viable holds twice a day, only processing holds that have never been targeter or those that have not been re-targeted in the last 12 hours.

/openils/bin/hold_targeter_v2.pl --skip-viable --retarget-interval "12h"
  • (Re)target non-viable holds twice a day, processing all holds regardless of when or if they were targeted before, running 3 targeters in parallel.

/openils/bin/hold_targeter_v2.pl --skip-viable --target-all --parallel 3

2.1.4. Add separate make target for translators

For those only interested in building Evergreen translations, a separate "translator" make target has been added to allow for easier installation of i18n prerequisites.

2.1.5. Allow admin to specify where Perl modules will be installed

Add --with-perlbase option to configure to specify an alternative location for installing the Perl modules. This can be useful for setups that want to run the Perl modules from a shared filesystem or environments that need to run multiple versions of Evergreen simultaneously.

Users of --with-perlbase are responsible for ensuring that PERL5LIB is set appropriately.

2.1.6. Addition of missing permissions

Required permissions that were previously missing from the stock data have now been added. If Evergreen sites have already manually added these permissions, the upgrade script will remove the old permission and create the new one, maintaining any maps to permission groups, with the stock permission ID.

2.1.7. get_org_unit_ancestor_at_depth Helper Added to Action Trigger Reactor Helpers

In action trigger templates it’s now possible to call helpers.get_org_unit_ancestor_at_depth($id_or_aou, $depth) in order to retrieve a fleshed aou for the target aou’s ancestor at the chosen depth. This could be used to retrieve the name of the library system rather than a specific branch name, for instance.

2.1.8. Removed unused selfcheck password setting

There was an unused duplicate selfcheck password setting that was removed to avoid confusion over which library setting was supposed to be set to enable passwords for selfcheck. After upgrading, verify that your library policy remains consistent for this setting.

2.1.9. Credit Processor Stripe Settings Permissions

Unprivileged users can retrieve organizational unit setting values for setting types lacking a "view" permission. When the feature adding Stripe credit card processing was added, the upgrade script neglected to add the VIEW_CREDIT_CARD_PROCESSING permission to the organizational unit setting type. This means that anyone can retrieve and view the settings for Stripe credit card processing.

Any system that upgraded from Evergreen version 2.5 to 2.6 is affected. If you use Stripe for credit card processing, it is strongly recommended that you apply this upgrade. Even if you do not use Stripe, applying this upgrade is still recommended. If you did not upgrade from version 2.5 to 2.6 of Evergreen, but started with a later version, applying this upgrade is harmless.

2.2. Cataloging

2.2.1. New Access Points for MARC Merge/Overlay Profiles

Catalogers can now select a MARC merge/overlay profile to apply when merging records in the (browser client) record bucket merge and Z39.50 record overlay interfaces. In both interfaces, if the user selects a merge profile, the results of the merge are displayed, giving the user the opportunity to choose a different merge profile or edit the records involved prior to committing to the merge.

A new library setting, "Default Merge Profile (Z39.50 and Record Buckets)", specifies the merge profile to preselect in the new merge profile selectors in the record bucket merge and Z39.50 overlay logs. The selectors will also remember the last selection that the user made.

2.3. Circulation

2.3.1. Display Copy Alerts With In-House-Use

Two library settings are used to control the display of copy alert messages or copy location check in alerts when recording in-house-use in Evergreen.

Setting Display copy alert for in-house-use to true for an organization will cause an alert to appear with the copy’s alert message, if it has one, when recording in-house-use for the copy.

Setting Display copy location check in alert for in-house-use to true for an organization will cause an alert to display a message indicating that the item needs to be routed to its location if the location has check in alert set to true.

The settings are independent of one another because you may want to display one and not the other when recording in-house-use.

2.4. Client

2.4.1. Active Date Column Picker Option

The active date will now be available as a column picker option in the Item Status screen.

When performing a patron search, punctuation characters will be ignored. So if the patron is named O’Brien, then you can enter Obrien, O’Brien, O Brien, etc. in the search box.

This behavior affects the Last Name (internally: family_name), First Name (first_given_name), and Middle Name (second_given_name) fields of the search.

2.4.3. Touch screen improvements for Evergreen self-check interface

Improvements were made to the Evergreen self-check interface to make it easier to use in a touch-screen environment.

  • The pay fines link is now a pay fines button, matching other buttons on the page.

  • The checkboxes have been enlarged, making them easier to activate when using a touch screen.

2.4.4. Trial Production Use of the Web Staff Client

The new web staff client is ready for trial production use in all functional areas with the exception of serials and offline transactions. In addition to many bug fixes in the areas of circulation, cataloging, administration and reporting, Release 2.12 sees the following additions to web client functionality.

  • Acquisitions interfaces and functionality have been integrated into the web staff client.

  • Booking interfaces and functionality have been integrated into the web staff client.

  • Hatch, the program that will allow for unmediated printing to multiple printers, sharing of workstation settings, and, eventually, offline transactions is now available. A windows installer for Hatch will be available on the Evergreen-ILS Downloads page.

The Evergreen developers will keep pilot libraries updated about known web client issues by posting known bugs to https://wiki.evergreen-ils.org/doku.php?id=dev:browser_staff:known_issues .

About Hatch

Hatch is not required to use the web client, but should be used for workstations that need to perform the following tasks.

  • Unmediated printing to multiple printers. Workstations can print to multiple printers without Hatch, but will need to click through a dialog to select a printer. Hatch allows workstations to automatically print, without dialog, to different printers.

  • Storage of workstation settings in a place outside the browser. Storing local preferences in hatch will prevent tampering with preferences via the browser developer tools and protect the settings from possible deletion if the browser deletes settings in local storage.

  • When offline functionality is available, hatch will be required to perform offline transactions.

Hatch is currently run as a Chrome extension and is not available in Firefox. To use hatch on Windows, Evergreen sites should:

  1. install a java runtime environment version 8 (or higher) if not already installed,

  2. download and execute the installer from the Evergreen downloads page,

  3. open Chrome and navigate to chrome://extensions,

  4. enable Developer Mode along the top right of the page,

  5. click the Load Unpacked Extension button,

  6. load the directory at Hatch → extension → app,

    1. In Windows, the default location for the app directory will be C:\Program Files (x86)\Hatch\extension\app

  7. enable hatch features in the web client by going to Administration → Workstation Administration → Print/Storage Service ("Hatch") and choosing which services to use with Hatch.

    1. this page will also inform you that hatch is connected.

2.5. Infrastructure

2.5.1. Client Timezone Awareness

Previously, adjusting the time zone in which a database session operates could not be done in any way except globally, directly within the database. However, allowing modification of the timezone parameter now supports localization efforts for those consortia that span multiple time zones.


CStore and other services that interact with the primary Evergreen database make use of the functionality provided by LP#1485371 in OpenSRF in order to set the time zone configuration parameter available in PostgreSQL.  This has the effect of interpreting all timestamps written to or read from the database in the client’s time zone.

Within CStore (and related, C-based services), all stateful sessions make use of this capability, setting the database time zone upon a successful CONNECT message from the client.  The time zone is reset to the database default when a session is terminated either due to client DISCONNECT or server keepalive timeout.

All stateless requests record the current database time zone, set the database time zone to that of the client’s, run the query, and then reset the database time zone on each request that carries a client time zone value.  It is expected that this will not cause any noticeable increase in latency or query execution time, as this setting is local to the specific PostgreSQL server backend process.

Within the Storage service, the timezone will be set automatically by a simple wrapper method used by the existing method registration mechanism for method publishing.  Disconnect and error callbacks are registered to revert the time zone setting within the database.  This provides completely transparent time zone manipulation for backend services that make use of open-ils.storage.

2.6. Public Catalog

2.6.1. New Subject Browse Index Definitions

New subject browse index definitions have been added that display the entire heading as a unit with hyphens between terms instead of displaying individual terms separately.

For example, the browse heading for:

=650 \0$aCats$zUnited States$vCorrespondence.

will display in a single entry as:

Cats — United States — Correspondence

Rather than separate entries for Cats and United States.

Name subjects will continue to display as separate entries because additional work would be required for the heading to be punctuated correctly.

2.6.2. Advanced Search Limiters Enhancement

Advanced search limiters will no longer propagate to the basic search box in the catalog. Instead, the limiters applied to the search will appear in the left sidebar of the search results screen where they can be easily cleared by clicking an x. On a small, mobile device, the advanced search limiters can be seen by clicking an x filter applied link or by clicking the Refine these results button that typically shows facets to the user.

The selected limiters will be applied to any search from the search bar until: * The user actively removes the filters from the search or * The user starts a new basic or advanced search from scratch.

2.6.3. Arabic and Right-to-Left Language Support for the catalog

New stylesheets and other changes to the catalog to allow for better support of right-to-left (RTL) languages, such as Arabic.

Also adds Arabic (Jordan) as a new supported language.

2.6.4. Ebook API integration

Evergreen 2.12 supports partial integration with third-party APIs provided by OverDrive and OneClickdigital. When ebook API integration is enabled, bibliographic records from these vendors that appear in your public catalog will include vendor holdings and availability information. Also, when a user is logged in, the public catalog dashboard and My Account interface will include information about that user’s checkouts and holds for supported vendors.

For API integration to work, you need to request API access from the vendor and configure your Evergreen system according to the instructions below. You also need to configure the new open-ils.ebook_api service.

This feature assumes that you are importing MARC records supplied by the vendor into your Evergreen system, using Vandelay or some other MARC import method. This feature does not search the vendor’s online collections or automatically import vendor records into your system; it merely augments records that are already in Evergreen.

A future Evergreen release will add the ability for users to check out titles, place holds, etc., directly via the public catalog.

Ebook API service configuration

This feature uses the new open-ils.ebook_api OpenSRF service. This service must be configured in your opensrf.xml and opensrf_core.xml config files for ebook API integration to work. See opensrf.xml.example and opensrf_core.xml.example for guidance.

OverDrive API integration

Before enabling OverDrive API integration, you will need to request API access from OverDrive. OverDrive will provide the values to be used for the following new org unit settings:

  • OverDrive Basic Token: The basic token used for API client authentication. To generate your basic token, combine your client key and client secret provided by OverDrive into a single string ("key:secret"), and then base64-encode that string. On Linux, you can use the following command: echo -n "key:secret" | base64 -

  • OverDrive Account ID: The account ID (a.k.a. library ID) for your OverDrive API account.

  • OverDrive Website ID: The website ID for your OverDrive API account.

  • OverDrive Authorization Name: The authorization name (a.k.a. library name) designated by OverDrive for your library. If your OverDrive subscription includes multiple Evergreen libraries, you will need to add a separate value for this setting for each participating library.

  • OverDrive Password Required: If your library’s OverDrive subscription requires the patron’s PIN (password) to be provided during patron authentication, set this setting to "true." If you do not require the patron’s PIN for OverDrive authentication, set this setting to "false." (If set to "true," the password entered by a patron when logging into the public catalog will be cached in plain text in memcached.)

  • OverDrive Discovery API Base URI and OverDrive Circulation API Base URI: By default, Evergreen uses OverDrive’s production API, so you should not need to set a value for these settings. If you want to use OverDrive’s integration environment, you will need to add the appropriate base URIs for the discovery and circulation APIs. See OverDrive’s developer documentation for details.

  • OverDrive Granted Authorization Redirect URI: Evergreen does not currently support granted authorization with OverDrive, so this setting is not currently in use.

For more information, consult the OverDrive API documentation.

To enable OverDrive API integration, adjust the following public catalog settings in config.tt2:

  • ebook_api.enabled: set to "true".

  • ebook_api.overdrive.enabled: set to "true".

  • ebook_api.overdrive.base_uris: list of regular expressions matching OverDrive URLs found in the 856$9 field of older OverDrive MARC records. As of fall 2016, OverDrive’s URL format has changed, and the record identifier is now found in the 037$a field of their MARC records, with "OverDrive" in 037$b. Evergreen will check the 037 field for OverDrive record identifiers; if your system includes older-style OverDrive records with the record identifier embedded in the 856 URL, you need to specify URL patterns with this setting.

OneClickdigital API integration

Before enabling OneClickdigital API integration, you will need to request API access from OneClickdigital. OneClickdigital will provide the values to be used for the following new org unit settings:

  • OneClickdigital Library ID: The identifier assigned to your library by OneClickdigital.

  • OneClickdigital Basic Token: Your client authentication token, supplied by OneClickdigital when you request access to their API.

For more information, consult the OneClickdigital API documentation.

To enable OneClickdigital API integration, adjust the following public catalog settings in config.tt2:

  • ebook_api.enabled: set to "true".

  • ebook_api.oneclickdigital.enabled: set to "true".

  • ebook_api.oneclickdigital.base_uris: list of regular expressions matching OneClickdigital URLs found in the 859$9 field of your MARC records. Evergreen uses the patterns specified here to extract record identifiers for OneClickdigital titles.

Additional configuration

Evergreen communicates with third-party vendor APIs using the new OpenILS::Utils::HTTPClient module. This module is configured using settings in opensrf.xml. The default settings should work for most environments by default, but you may need to specify a custom location for the CA certificates installed on your server. You can also disable SSL certificate verification on HTTPClient requests altogether, but doing so is emphatically discouraged.

The record summary pages in the catalog will now link to other formats and editions of a title. The links will allow users to quickly jump to another format of the title or an edition written in another language.

2.6.6. Metarecord Search Improvements

This release brings several improvement to the Group Formats and Editions search.

  • Limiters on the advanced search page can now be successfully applied to Group Formats and Editions searches,

  • Electronic resources are now retrievable through these searches,

  • Paged navigation has improved.

2.6.7. Allow Metarecord Search by default

Before the TPAC, a site could configure the public catalog to use metarecord searching by default, via a configuration file. Here we bring that back.

A new setting called search.metarecord_default is present in templates/opac/parts/config.tt2 to enable this feature. By setting this to a true value (normally 1) the TPAC will silently include the #metabib search modifier in the search form on any interfaces that do not have a UI component that allows the user to control the setting.

2.6.8. RDA Improvements

  • Author fields are now normalized to strip ending periods so that authors from RDA and non-RDA records are collapsed in browse and facet headings.

  • All author/contributor roles will now display in the record detail page. Previously, some of the roles were omitted or were duplicated.

2.6.9. Obalkyknih.cz Integration

Evergreen now integrates with Czech added content provider obalkyknih.cz. A new setting called obalkyknih_cz.enabled is available in templates/opac/parts/config.tt2 to enable this new feature.

3. Acknowledgments

The Evergreen project would like to acknowledge the following organizations that commissioned developments in this release of Evergreen:

  • Bibliomation

  • British Columbia Libraries Cooperative

  • C/W MARS

  • Georgia PINES

  • King County Library System

  • Linn Libraries Consortium

  • MassLNC

  • Pennsylvania Integrated Library System

  • Pioneer Library System

We would also like to thank the following individuals who contributed code, translations, documentations patches and tests to this release of Evergreen:

  • Adam Bowling

  • Anahi Valdez

  • Ben Shum

  • Bill Erickson

  • Billy Horn

  • Blake Henderson

  • Bob Wicksall

  • Chris Sharp

  • Christine Burns

  • Christine Morgan

  • Clare Sobotka

  • Dan Pearl

  • Dan Scott

  • Dan Wells

  • Darrell Rodgers

  • Debbie Luchenbill

  • Eva Cerninakova

  • Fares Othman

  • Galen Charlton

  • Jakub Kotrla

  • Jane Sandberg

  • Jason Boyer

  • Jason Etheridge

  • Jason Stephenson

  • Jeanette Lundgren

  • Jeff Davis

  • Jeff Godin

  • Jennifer Pringle

  • Jillianne Presley

  • Jim Keenan

  • Job Diógenes Ribeiro Borges

  • Jonathan Schatz

  • Josh Stompro

  • Kate Butler

  • Kathy Lussier

  • Kyle Huckins

  • Linda Jansová

  • Michele Morgan

  • Michelle Purcell

  • Mike Rylander

  • Nawras Othman

  • Remington Steed

  • Rogan Hamby

  • Terran McCanna

  • Thomas Berezansky

  • Victoria Lewis

We also thank the following organizations whose employees contributed patches:

  • British Columbia Libraries Cooperative

  • Calvin College

  • Catalyst DevWorks

  • C/W MARS

  • Emerald Data Networks, Inc.

  • Equinox Open Library Initiative

  • Georgia PINES

  • Indiana State Library

  • The Institute for the Study of Totalitarian Regimes, Prague

  • Jabok Library

  • Jordanian Library and Information Association

  • King County Library System

  • Lake Agassiz Regional Library

  • Laurentian University

  • Linn-Benton Community College

  • MassLNC

  • Merrimack Valley Library Consortium

  • MOBIUS Consortium

  • North of Boston Library Exchange

  • Pioneer Library System

  • Rodgers Memorial Library

  • Sigio

  • Traverse Area District Library

We regret any omissions. If a contributor has been inadvertently missed, please open a bug at http://bugs.launchpad.net/evergreen/ with a correction.