1 Evergreen 2.12-beta Release Notes
2 =================================
8 Evergreen 2.12 now requires OpenSRF 2.5 or later; certain functionality
9 will not work if you attempt to run Evergreen 2.12 on OpenSRF 2.4. Evergreen
10 2.12 recommends PostgreSQL 9.4. The minimum supported version of PostgreSQL is
13 The stock schema upgrade script performs a browse reingest,
14 recalculates bib fingerprints, and remaps metarecords.
16 This version also adds two new services, `open-ils.ebook_api` and
17 `open-ils.hold-targeter`.
29 Additional SMS Carriers
30 ^^^^^^^^^^^^^^^^^^^^^^^
31 SMS carrier definitions are now included for Google Fi and
32 Republic Wireless. These will be automatically loaded when
33 installing a new Evergreen system; admins who wish to
34 add these definitions during an upgrade can use the following
37 * Google Fi: `$number@msg.fi.google.com`
38 * Republic Wireless: `$number@text.republicwireless.com`
43 Bibliographic Fingerprint Improvements
44 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
45 The bibliographic fingerprint will now incorporate subfield $n and $p from MARC
46 title fields to better distinguish between records of the same series that
47 may share the same title but have a different part. With this change, these
48 MARC records will no longer be grouped together in a 'Group Formats & Editions'
51 The bibliographic fingerprint was also changed to better distinguish between
52 the fields contributing to the fingerprint. This change will help the system
53 distinguish between a record for the movie _Blue Steel_ and another record for
54 the book _Blue_ written by Danielle Steel.
61 Batch Hold Targeter Speed-up and New Features
62 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
64 Adds a new `open-ils.hold-targeter` service, supporting new targeting options
65 and runtime optimizations to speed up targeting. The service is launched
66 from a new targeting script, `hold_targeter_v2.pl` (default location:
67 `/openils/bin/hold_targeter_v2.pl`).
69 This code has no effect on the existing hold targeter, which is still
70 available as of this release and functions as before.
75 * Adds a global configuration flag 'circ.holds.retarget_interval' for
76 setting the hold retarget interval.
78 * `--target-all` option forces the targeter to process all active
79 holds, regardless of when they were last targeted.
81 * `--retarget-interval` option make is possible to override the new
82 'circ.holds.retarget_interval' setting via the command line
83 when calling the hold targeter.
85 * `--skip-viable` option causes the hold targeter to avoid modifying
86 the currently targeted copy (i.e. the copy on the pull list) for holds
87 that target a viable (capturable) copy.
90 For skipped holds, no entry is added to the unfulfilled_hold_list.
91 The set of potential copies (hold copy maps) are refreshed for all
92 processed holds, regardless of target viability.
95 This option is useful for 1.) finding targets for holds that require
96 new targets and 2.) adding new/modified copies to the potential copy
97 lists (for opportunistic capture) more frequently than you may want to do full
98 retargeting of all holds.
100 * `--newest-first` option processes holds in reverse order of request_time,
101 so that newer holds are (re)targeted first. This is primarily useful
102 when a large backlog of old, un-targetable holds exist. With
103 `--newest-first`, the older holds will be processed last.
105 * `--parallel` option overrides the parallel settings found in `opensrf.xml`
106 for simpler modification and testing.
108 * `--lockfile` option allows the caller to specify a lock file instead
109 of using the default /tmp/hold_targeter-LOCK
111 * `--verbose` option prints progress info to STDOUT, showing the number of
112 holds processed per parallel targeter instance.
114 * When configured, hold target loops cycle through all org units (with
115 targetable copies) instead of repeatedly targeting copies at the pickup
116 library when multiple targetable copies exist at the pickup library.
118 * When configured, hold target loops prioritize (targetable) org units
119 first by the number of previous target attempts, then by their
120 weight/proximity. This effectively back-fills org units that had no
121 targetable copies during earlier target loops so that they are
122 targeted as many times as other org units (to the extent possible,
128 * Traditional daily hold targeter with a value set for
129 'circ.holds.retarget_interval'.
132 --------------------------------------------------------------------------
133 /openils/bin/hold_targeter_v2.pl
134 --------------------------------------------------------------------------
136 * (Re)target non-viable holds twice a day, only processing holds that
137 have never been targeter or those that have not been re-targeted in
141 --------------------------------------------------------------------------
142 /openils/bin/hold_targeter_v2.pl --skip-viable --retarget-interval "12h"
143 --------------------------------------------------------------------------
145 * (Re)target non-viable holds twice a day, processing all holds regardless
146 of when or if they were targeted before, running 3 targeters in
150 --------------------------------------------------------------------------
151 /openils/bin/hold_targeter_v2.pl --skip-viable --target-all --parallel 3
152 --------------------------------------------------------------------------
158 Add separate make target for translator
159 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
160 Add a separate make target during installation for translator to allow
161 for easier installation of i18n prerequisites.
167 Addition of missing permissions
168 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
169 Required permissions that were previously missing from the stock data have now
170 been added. If Evergreen sites have already manually added these permissions,
171 the upgrade script will remove the old permission and create the new one,
172 maintaining any maps to permission groups, with the stock permission ID.
178 get_org_unit_ancestor_at_depth Helper Added to Action Trigger Reactor Helpers
179 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
180 In action trigger templates it's now possible to call
181 `helpers.get_org_unit_ancestor_at_depth($id_or_aou, $depth)` in order to retrieve
182 a fleshed aou for the target aou's ancestor at the chosen depth. This could be
183 used to retrieve the name of the library system rather than a specific branch
189 Removed unused selfcheck password setting
190 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
191 There was an unused duplicate selfcheck password setting that was removed
192 to avoid confusion over which library setting was supposed to be set to
193 enable passwords for selfcheck. After upgrading, verify that your library
194 policy remains consistent for this setting.
200 Credit Processor Stripe Settings Permissions
201 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
202 Unprivileged users can retrieve organizational unit setting values for
203 setting types lacking a "view" permission. When the feature adding
204 Stripe credit card processing was added, the upgrade script neglected
205 to add the VIEW_CREDIT_CARD_PROCESSING permission to the
206 organizational unit setting type. This means that anyone can retrieve
207 and view the settings for Stripe credit card processing.
209 Any system that upgraded from Evergreen version 2.5 to 2.6 is
210 affected. If you use Stripe for credit card processing, it is
211 strongly recommended that you apply this upgrade. Even if you do not
212 use Stripe, applying this upgrade is still recommended. If you did
213 not upgrade from version 2.5 to 2.6 of Evergreen, but started with a
214 later version, applying this upgrade is harmless.
224 New Access Points for MARC Merge/Overlay Profiles
225 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
226 Catalogers can now select a MARC merge/overlay profile to apply when
227 merging records in the (browser client) record bucket merge and Z39.50
228 record overlay interfaces. In both interfaces, if the user selects
229 a merge profile, the results of the merge are displayed, giving the
230 user the opportunity to choose a different merge profile or edit
231 the records involved prior to committing to the merge.
233 A new library setting, "Default Merge Profile (Z39.50 and Record Buckets)",
234 specifies the merge profile to preselect in the new merge profile
235 selectors in the record bucket merge and Z39.50 overlay logs. The
236 selectors will also remember the last selection that the user made.
246 Display Copy Alerts With In-House-Use
247 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
249 Two library settings are used to control the display of copy alert
250 messages or copy location check in alerts when recording in-house-use
253 Setting 'Display copy alert for in-house-use' to true for an
254 organization will cause an alert to appear with the copy's alert
255 message, if it has one, when recording in-house-use for the copy.
257 Setting 'Display copy location check in alert for in-house-use' to true
258 for an organization will cause an alert to display a message
259 indicating that the item needs to be routed to its location if the
260 location has check in alert set to true.
262 The settings are independent of one another because you may want to
263 display one and not the other when recording in-house-use.
273 Active Date Column Picker Option
274 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
275 The active date will now be available as a column picker option in the Item
281 Punctuation Insensitive Patron Search
282 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
283 When performing a patron search, punctuation characters will be
284 ignored. So if the patron is named O'Brien, then you can enter Obrien,
285 O'Brien, O Brien, etc. in the search box.
287 This behavior affects the Last Name (internally: family_name), First Name
288 (first_given_name), and Middle Name (second_given_name) fields of the search.
295 Touch screen improvements for Evergreen self-check interface
296 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
297 Improvements were made to the Evergreen self-check interface to make it easier
298 to use in a touch-screen environment.
300 * The pay fines link is now a pay fines button, matching other buttons on the
302 * The checkboxes have been enlarged, making them easier to activate when using
309 Trial Production Use of the Web Staff Client
310 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
311 The new web staff client is ready for trial production use in all functional
312 areas with the exception of serials and offline transactions. In addition to
313 many bug fixes in the areas of circulation, cataloging, administration and
314 reporting, Release 2.12 sees the following additions to web client
317 * Acquisitions interfaces and functionality have been integrated into the web
319 * Booking interfaces and functionality have been integrated into the web staff
321 * Hatch, the program that will allow for unmediated printing to multiple
322 printers, sharing of workstation settings, and, eventually, offline
323 transactions is now available. A windows installer for Hatch will be available
324 on the Evergreen-ILS Downloads page.
326 The Evergreen developers will keep pilot libraries updated about known web
327 client issues by posting known bugs to https://wiki.evergreen-ils.org/doku.php?id=dev:browser_staff:known_issues .
331 Hatch is not required to use the web client, but should be used for workstations
332 that need to perform the following tasks.
334 * Unmediated printing to multiple printers. Workstations can print to multiple
335 printers without Hatch, but will need to click through a dialog to select a
336 printer. Hatch allows workstations to automatically print, without dialog, to
338 * Storage of workstation settings in a place outside the browser. Storing local
339 preferences in hatch will prevent tampering with preferences via the browser
340 developer tools and protect the settings from possible deletion if the browser
341 deletes settings in local storage.
342 * When offline functionality is available, hatch will be required to perform
343 offline transactions.
345 Hatch is currently run as a Chrome extension and is not available in Firefox. To
346 use hatch on Windows, Evergreen sites should:
348 . install a java runtime environment version 8 (or higher) if not already
350 . download and execute the installer from the Evergreen downloads page,
351 . open Chrome and navigate to chrome://extensions,
352 . enable _Developer Mode_ along the top right of the page,
353 . click the _Load Unpacked Extension_ button,
354 . load the directory at Hatch -> extension -> app,
355 .. In Windows, the default location for the app directory will be
356 C:\Program Files (x86)\Hatch\extension\app
357 . enable hatch features in the web client by going to Administration ->
358 Workstation Administration -> Print/Storage Service ("Hatch") and choosing
359 which services to use with Hatch.
360 .. this page will also inform you that hatch is connected.
370 Client Timezone Awareness
371 ^^^^^^^^^^^^^^^^^^^^^^^^^
373 Previously, adjusting the time zone in which a database session operates
374 could not be done in any way except globally, directly within the database.
375 However, allowing modification of the timezone parameter now supports
376 localization efforts for those consortia that span multiple time zones.
381 CStore and other services that interact with the primary Evergreen database
382 make use of the functionality provided by LP#1485371 in OpenSRF in order to
383 set the time zone configuration parameter available in PostgreSQL. This has
384 the effect of interpreting all timestamps written to or read from the database
385 in the client's time zone.
387 Within CStore (and related, C-based services), all stateful sessions make use
388 of this capability, setting the database time zone upon a successful CONNECT
389 message from the client. The time zone is reset to the database default when
390 a session is terminated either due to client DISCONNECT or server keepalive
393 All stateless requests record the current database time zone, set the database
394 time zone to that of the client's, run the query, and then reset the database
395 time zone on each request that carries a client time zone value. It is expect
396 that this will not cause any noticeable increase in latency or query execution
397 time, as this setting is local to the specific PostgreSQL server backend process.
399 Within the Storage service, the timezone will be set automatically by a simple
400 wrapper method used by the existing method registration mechanism for method
401 publishing. Disconnect and error callbacks are registered to revert the time
402 zone setting within the database. This provides completely transparent time
403 zone manipulation for backend services that make use of open-ils.storage.
413 New Subject Browse Index Definitions
414 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
415 New subject browse index definitions have been added that display the entire
416 heading as a unit with hyphens between terms instead of displaying individual
419 For example, the browse heading for:
421 =650 \0$aCats$zUnited States$vCorrespondence.
423 will display in a single entry as:
425 Cats -- United States -- Correspondence
427 Rather than separate entries for Cats and United States.
429 Name subjects will continue to display as separate entries because additional
430 work would be required for the heading to be punctuated correctly.
435 Advanced Search Limiters Enhancement
436 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
437 Advanced search limiters will no longer propagate to the basic search box in
438 the catalog. Instead, the limiters applied to the search will appear in the
439 left sidebar of the search results screen where they can be easily cleared by
440 clicking an 'x.' On a small, mobile device, the advanced search limiters can
441 be seen by clicking an 'x filter applied' link or by clicking the 'Refine
442 these results' button that typically shows facets to the user.
444 The selected limiters will be applied to any search from the search bar until:
445 * The user actively removes the filters from the search or
446 * The user starts a new basic or advanced search from scratch.
451 Arabic and Right-to-Left Language Support for the catalog
452 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
453 New stylesheets and other changes to the catalog to allow for
454 better support of right-to-left (RTL) languages, such as Arabic.
456 Also add Arabic (Jordan) as a new supported language.
461 Ebook API integration
462 ^^^^^^^^^^^^^^^^^^^^^
463 Evergreen 2.12 supports partial integration with third-party APIs
464 provided by OverDrive and OneClickdigital. When ebook API integration
465 is enabled, bibliographic records from these vendors that appear in your
466 public catalog will include vendor holdings and availability information. Also,
467 when a user is logged in, the public catalog dashboard and My Account interface
468 will include information about that user's checkouts and holds for
471 For API integration to work, you need to request API access from the
472 vendor and configure your Evergreen system according to the instructions
473 below. You also need to configure the new `open-ils.ebook_api` service.
475 This feature assumes that you are importing MARC records supplied by the
476 vendor into your Evergreen system, using Vandelay or some other MARC
477 import method. This feature does not search the vendor's online
478 collections or automatically import vendor records into your system; it
479 merely augments records that are already in Evergreen.
481 A future Evergreen release will add the ability for users to check out
482 titles, place holds, etc., directly via the public catalog.
484 Ebook API service configuration
485 +++++++++++++++++++++++++++++++
486 This feature uses the new `open-ils.ebook_api` OpenSRF service. This
487 service must be configured in your `opensrf.xml` and `opensrf_core.xml`
488 config files for ebook API integration to work. See
489 `opensrf.xml.example` and `opensrf_core.xml.example` for guidance.
491 OverDrive API integration
492 +++++++++++++++++++++++++
493 Before enabling OverDrive API integration, you will need to request API
494 access from OverDrive. OverDrive will provide the values to be used for
495 the following new org unit settings:
497 * *OverDrive Basic Token*: The basic token used for API client
498 authentication. To generate your basic token, combine your client
499 key and client secret provided by OverDrive into a single string
500 ("key:secret"), and then base64-encode that string. On Linux, you
501 can use the following command: `echo -n "key:secret" | base64 -`
502 * *OverDrive Account ID*: The account ID (a.k.a. library ID) for your
503 OverDrive API account.
504 * *OverDrive Website ID*: The website ID for your OverDrive API
506 * *OverDrive Authorization Name*: The authorization name (a.k.a.
507 library name) designated by OverDrive for your library. If your
508 OverDrive subscription includes multiple Evergreen libraries, you
509 will need to add a separate value for this setting for each
510 participating library.
511 * *OverDrive Password Required*: If your library's OverDrive
512 subscription requires the patron's PIN (password) to be provided
513 during patron authentication, set this setting to "true." If you do
514 not require the patron's PIN for OverDrive authentication, set this
515 setting to "false." (If set to "true," the password entered by a
516 patron when logging into the public catalog will be cached in plain text in
518 * *OverDrive Discovery API Base URI* and *OverDrive Circulation API
519 Base URI*: By default, Evergreen uses OverDrive's production API, so
520 you should not need to set a value for these settings. If you want
521 to use OverDrive's integration environment, you will need to add the
522 appropriate base URIs for the discovery and circulation APIs. See
523 OverDrive's developer documentation for details.
524 * *OverDrive Granted Authorization Redirect URI*: Evergreen does not
525 currently support granted authorization with OverDrive, so this
526 setting is not currently in use.
528 For more information, consult the
529 https://developer.overdrive.com/docs/getting-started[OverDrive API
532 To enable OverDrive API integration, adjust the following public catalog settings
535 * `ebook_api.enabled`: set to "true".
536 * `ebook_api.overdrive.enabled`: set to "true".
537 * `ebook_api.overdrive.base_uris`: list of regular expressions
538 matching OverDrive URLs found in the 856$9 field of older OverDrive
539 MARC records. As of fall 2016, OverDrive's URL format has changed,
540 and the record identifier is now found in the 037$a field of their
541 MARC records, with "OverDrive" in 037$b. Evergreen will check the
542 037 field for OverDrive record identifiers; if your system includes
543 older-style OverDrive records with the record identifier embedded in
544 the 856 URL, you need to specify URL patterns with this setting.
546 OneClickdigital API integration
547 +++++++++++++++++++++++++++++++
548 Before enabling OneClickdigital API integration, you will need to
549 request API access from OneClickdigital. OneClickdigital will provide
550 the values to be used for the following new org unit settings:
552 * *OneClickdigital Library ID*: The identifier assigned to your
553 library by OneClickdigital.
554 * *OneClickdigital Basic Token*: Your client authentication token,
555 supplied by OneClickdigital when you request access to their API.
557 For more information, consult the
558 http://developer.oneclickdigital.us/[OneClickdigital API documentation].
560 To enable OneClickdigital API integration, adjust the following public catalog
561 settings in `config.tt2`:
563 * `ebook_api.enabled`: set to "true".
564 * `ebook_api.oneclickdigital.enabled`: set to "true".
565 * `ebook_api.oneclickdigital.base_uris`: list of regular expressions
566 matching OneClickdigital URLs found in the 859$9 field of your MARC
567 records. Evergreen uses the patterns specified here to extract
568 record identifiers for OneClickdigital titles.
570 Additional configuration
571 ++++++++++++++++++++++++
572 Evergreen communicates with third-party vendor APIs using the new
573 `OpenILS::Utils::HTTPClient` module. This module is configured using
574 settings in `opensrf.xml`. The default settings should work for most
575 environments by default, but you may need to specify a custom location
576 for the CA certificates installed on your server. You can also disable
577 SSL certificate verification on HTTPClient requests altogether, but
578 doing so is emphatically discouraged.
582 Links to Other Formats and Editions
583 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
584 The record summary pages in the catalog will now link to other formats and
585 editions of a title. The links will allow users to quickly jump to another
586 format of the title or an edition written in another language.
592 Metarecord Search Improvements
593 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
594 This release brings several improvement to the Group Formats and Editions
597 * Limiters on the advanced search page can now be successfully applied to
598 Group Formats and Editions searches,
599 * Electronic resources are now retrievable through these searches,
600 * Paged navigation has improved.
605 Allow Metarecord Search by default
606 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
607 Before the TPAC, a site could configure the public catalog to use metarecord searching
608 by default, via a configuration file. Here we bring that back.
610 A new setting called search.metarecord_default is present in
611 `templates/opac/parts/config.tt2` to enable this feature. By setting this to
612 a true value (normally 1) the TPAC will silently include the #metabib search
613 modifier in the search form on any interfaces that do not have a UI component
614 that allows the user to control the setting.
620 * Author fields are now normalized to strip ending periods so that authors from
621 RDA and non-RDA records are collapsed in browse and facet headings.
622 * All author/contributor roles will now display in the record detail page.
623 Previously, some of the roles were omitted or were duplicated.
626 Obalkyknih.cz Integration
627 ^^^^^^^^^^^^^^^^^^^^^^^^^
628 Evergreen now integrates with Czech added content provider obalkyknih.cz. A new
629 setting called obalkyknih_cz.enabled is available in
630 `templates/opac/parts/config.tt2` to enable this new feature.
635 The Evergreen project would like to acknowledge the following
636 organizations that commissioned developments in this release of
640 * British Columbia Libraries Cooperative
643 * King County Library System
644 * Linn Libraries Consortium
646 * Pennsylvania Integrated Library System
647 * Pioneer Library System
649 We would also like to thank the following individuals who contributed
650 code, translations, documentations patches and tests to this release of
683 * Job Diógenes Ribeiro Borges
700 We also thank the following organizations whose employees contributed
703 * British Columbia Libraries Cooperative
706 * Emerald Data Networks, Inc.
707 * Equinox Open Library Initiative
709 * Indiana State Library
710 * The Institute for the Study of Totalitarian Regimes, Prague
711 * Jordanian Library and Information Association
712 * King County Library System
714 * Lake Agassiz Regional Library
715 * Laurentian University
716 * Linn-Benton Community College
718 * Merrimack Valley Library Consortium
720 * National Library of the Czech Republic
721 * North of Boston Library Exchange
722 * Pioneer Library System
723 * Rodgers Memorial Library
725 * Traverse Area District Library
728 We regret any omissions. If a contributor has been inadvertently
729 missed, please open a bug at http://bugs.launchpad.net/evergreen/