1 Evergreen 2.8 Release Notes
2 =============================
6 This release contains several bugfixes improving on Evergreen 2.8.3
10 * Fixes an issue where transactions with checkin-generated fines that
11 previously had a balance of zero were prematurely closing.
12 * Fixes an issue where empty patron searches lead to heavy queries ending
13 in a client error. Empty patron searches will now exit early with no results.
14 * Provides validation on the patron self-registration form to prevent users
15 from entering the date of birth in the wrong date format.
19 * Fixes an issue where all matches were not displaying during a Vandelay
20 authority record import. The fix ensures a row is added for every authority
21 record match in the Vandelay match grid, even when multiple matches refer to
22 the same authority record.
24 Preventing improper data deletion from subfield $e
25 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27 This release contains a fix for LP bug 1484281, "authority data may be
28 deleted during propagation with current values of
29 authority.control_set_authority_field."
31 For more details see: https://bugs.launchpad.net/evergreen/+bug/1484281
33 The related upgrade script from this release removes subfield $e
34 in authority tags 100 and 110, but only from the Evergreen default
35 "LoC" authority control set configuration. If your Evergreen system is
36 set up with additional authority control sets besides the default
37 "LoC" one, you will need to run the following pieces of SQL code.
39 First verify that you have an additional control set besides the
40 default of "LoC". Run the following SQL code and write down the ID
41 number for your additional control set. The number will be an integer
45 --------------------------------------------------------------------
47 from authority.control_set
50 --------------------------------------------------------------------
52 In the following code you will need to change the two sections of
53 "control_set = XYZ". Change the part labeled with the text "XYZ", with
54 the ID number from the above query.
56 If the above query displayed more than one additional authority
57 control set, then you will need to run the code below once for each
58 additional control set ID number.
61 --------------------------------------------------------------------
62 UPDATE authority.control_set_authority_field
63 SET sf_list = REGEXP_REPLACE( sf_list, 'e', '', 'i')
64 WHERE tag = '100' AND control_set = XYZ AND sf_list ILIKE '%e%';
66 UPDATE authority.control_set_authority_field
67 SET sf_list = REGEXP_REPLACE( sf_list, 'e', '', 'i')
68 WHERE tag = '110' AND control_set = XYZ AND sf_list ILIKE '%e%';
69 --------------------------------------------------------------------
73 This release contains several bugfixes improving on Evergreen 2.8.2
77 * Restores sort order in the patron's Items Out display so that overdue items
79 * Changes the behavior of the checkin API so that future backdates are
81 * Fixes a problem where amnesty mode was ignored when backdating checkins.
82 * Allows SIP to honor floating copy checkin locations.
87 * Changes the behavior of the authority linker to now ignore $e and $4 in bib
93 * Changes the behavior of the end-of-year process so that fund tags will now
94 remain on propagated funds.
95 * Allows staff with the CREAT_PURCHSE_ORDER permission to view distribution
96 formulas, making it possible to use them for PO batch update operations.
101 * Improves performance of OPAC searches using format filters.
102 * Removes opac_invisible copies from consideration when displaying copies on
103 the search results page.
104 * Fixes a UTF8 encoding issue with the SuperCat SRU service.
109 * Optimizes the extend_reporter.full_circ_count view to improve performance
110 for sites with large datasets.
116 * Fixes a JS TypeError that prevents stat cats from displaying in the stat cat
118 * Fixes a problem where where the Collections API would crash when encountering
119 users with null card values.
120 * Updates the XULRunner URL in Makefile.am, allowing makefile to continue
121 building the staff client.
122 * Fixes a problem where the added content handler was not properly closing
124 * Fixes a problem where the Library Settings History was not properly
125 keeping the latest five settings per org unit.
126 * Expands safe token generation to include user ID in the cached data, which
127 can be retrieved later for activity logging.
128 * Makes xpath-based record attribute definitions work.
133 This release contains several bugfixes improving on Evergreen 2.8.1
138 * Fixes an issue where a double-scan at checkin causes two holds to capture for
140 * In patron registration, fixes a broken link in the alert informing staff that
141 a patron with the same name already exists.
142 * Fixes an issue where fully-paid long overdue items still appeared in the
143 Other/Special Circulations window.
144 * Fixes an error that appeared when staff tried to renew lost, claims returned
145 or long overdue item.
146 * Fixes a "Return to Record" link on the call number texting confirmation
147 screen. The link previously broke in cases when the user was prompted to
148 authenticate before texting.
149 * Removes long overdue circs from the total items out count in My Account.
154 * Changes the behavior of the "Add Rows" link on the advanced search screen
155 so that it no longer opens duplicate rows.
156 * Removes the Bib Call Number from the query type selector.
157 * Removes publication-specific information from a metarecord search results
159 * Prevents the "you have permission to override some of the failed holds"
160 message from appearing when the user does not have permission to override holds.
161 * Removes a stray semicolon that was appearing in browse search entries.
166 * Prevents security warnings in the staff client when Google Analytics is
167 enabled in the catalog.
168 * Adds scrollbars when necessary to the item status alternate view tab.
173 * Fixes an issue where strings with apostrophes could no longer be used to
179 * Creates a script allowing EDI Ruby dependency installation on Ubuntu 14.04.
180 * Fixes compatibility issues with Debian Jessie.
181 * Removes "Safe" CPAN dependency from Debian/Ubuntu Makefile.install files.
182 * Removes the ability for staff to edit their own user accounts.
183 * Adds an index on authority.simple_heading.record so that full table scans
184 aren't needed during authority record reingest.
188 This release contains several bugfixes improving on Evergreen 2.8.0.
193 * Fixes an issue where direct charges were not disencumbered when the charge
194 was removed from the PO or the PO was canceled.
195 * Fixes an issue where direct charges were not calculated in the PO estimated price.
196 * Refreshes the PO summary ammounts (spent, encumbered, estimated) each time
197 an amount-changing event occurs.
199 Patron message center fixes and improvements
200 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202 * Fixes an issue where the user didn't receive an ackowledgement after
204 * Displays the unread message count in the page title for increased visibility.
205 * Repositions the patron messages link to the dashboard button bar.
206 * For messages that originate from public notes, adjusts the sending library to be the workstation library, not the home library of the note creator.
207 * Improves styling for messages by using pre-wrap, which allows longer messages
209 * Fixes an issue where users already viewing a message cannot return to the message list by clicking on the 'Message" button in the patron dashboard.
212 ~~~~~~~~~~~~~~~~~~~~~
214 * Fixes an issue where payment for a lost-then-returned item was not applied to overdues.
215 * Fixes an issue where overdue fines could be doubled if both
216 restore-overdue-on-lost-return and generate-new-overdues-on-lost-return
219 Clear hold shelf checkin modifier fix
220 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
221 Fixes a network error that occurred when using the Clear Hold Shelf checkin modifier.
223 Fix Crash in Collections User Balance Summary
224 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
225 Previously a patron in collections that paid off all transactions would cause a
226 crash and stop processing any balance summary file that they are supposed to
227 appear in. Now user balance summaries can be created in full even if some users
230 Remove the ‡biblios.net Z39.50 target from seed data
231 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
232 The Z39.50 target at z3950.biblios.net/bibliographic has not worked
233 for years, so its service definition is no longer provided in the
234 seed data for new installations of Evergreen.
236 Users of existing Evergreen systems should consider removing
237 the Z39.50 definition for ‡biblios.net. This can be done from
238 Admin | Server Administration | Z39.50 Servers in the staff
241 Set resource limits for Clark Kent
242 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
243 Several parameters are now available for the reporter daemon process
244 (`clark-kent.pl`) to control resource usage. These can be used to
245 reduce the chances that a malformed report can cause indigestion
246 on a database or reports server. The new parameters, which can be
247 set in `opensrf.xml` or as command-line switches for `clark-kent.pl` are
249 * `//reporter/setup/statement_timeout` / `--statement-timeout`
251 Number of minutes to allow a report's underlying SQL query
252 to run before it gets cancelled. Default value is
253 60 minutes. If a report's query gets cancelled, the
254 error_text value will be set to a valid that indicates that
255 the allowed time was exceeded.
257 * `//reporter/setup/max_rows_for_charts` / `--max-rows-for-charts`
259 Number of rows permitted in the query's output before
260 Clark Kent refuses to attempt to draw a graph. Default
263 * `//reporter/setup/resultset_limit` / `--resultset-limit`
265 If set, truncates the report's output to the specified
266 number of hits. Note that it will not be apparent
267 to a staff user if the report's output has been
268 truncated. Default value is unlimited.
270 The report concurrency (i.e., the number of reports that Clark
271 Kent will run in parallel) can now also be controlled via
272 the `opensrf.xml` setting `//reporter/setup/parallel`.
274 Install purge_pending_users.srfsh to /openils/bin by default
275 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
277 Since purge_pending_users.srfsh is in the example crontab, it should
278 be installed to the Evergreen binaries directory (typically /openils/bin)
282 Evergreen 2.8.0 Release Notes
283 =============================
297 ==== Duplicate Order Detection Improvements ====
299 Provides tools to make it more clear to staff when a purchase order or
300 items on an order have been ordered before.
302 ===== Prevent Duplicate PO Names =====
304 Staff now have the option to specify a PO name during PO creation.
305 If the selected name is already in use by another PO at or below
306 the ordering agency for the PO, the user is warned, the save/submit
307 operations are disabled, and a link to the existing PO is display. The
308 link opens the related PO in a new tab when clicked.
310 Selecting a name which is not yet used or clearing the name field
311 (which defaults upon creation to the PO ID) will clear the warning and
312 re-enable the submit/save operation.
314 Similarly, when editing a PO, if the user attempts to use a name already
315 used, the user will be warned and a link to the offending PO will be
318 ===== Show Existing Copies =====
320 In the select list and PO view interfaces, beside the lineitem ID #, we
321 now also display the number of catalog copies already owned at or below
322 the ordering agency for the bib record in question.
324 The count does not include copies linked to the lineitem in question
325 nor does it include copies that are in some form of lost, missing, or
328 ==== Sticky Org Unit Selector ====
330 The Context Org Unit Selector on the Funds screen will now remember and default
331 to the most-recently selected org unit. On first use, the selector will
332 continue to default to the workstation org unit.
338 Apache Access Handler: OpenILS::WWW::AccessHandler
339 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
340 This Perl module is intended for limiting patron access to configured locations
341 in Apache. These locations could be folder trees, static files, non-Evergreen
342 dynamic content, or other Apache features/modules. It is intended as a more
343 patron-oriented and transparent version of the OpenILS::WWW::Proxy and
344 OpenILS::WWW:Proxy::Authen modules.
346 Instead of using Basic Authentication the AccessHandler module instead redirects
347 to the OPAC for login. Once logged in additional checks can be performed, based
348 on configured variables:
350 * Permission Checks (at Home OU or specified location)
351 * Home OU Checks (Org Unit or Descendant)
352 * "Good standing" Checks (Not Inactive or Barred)
354 As the AccessHandler module does not actually serve the content it is
355 protecting, but instead merely hands control back to Apache when it is done
356 authenticating, you can protect almost anything you can serve with Apache.
360 The general use of this module is to protect access to something else.
361 Here are some examples of what you can protect:
364 ** Automatic Directory Indexes
366 *** Electronic Databases
367 *** Software on other servers/ports
368 * Non-Evergreen software
369 ** Timekeeping software for staff
370 ** Specialized patron request packages
371 * Static files and folders
372 ** Semi-public Patron resources
373 ** Staff-only downloads
376 Deleted flag for copy locations
377 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
378 A deleted flag is now available for copy locations, allowing them to be
379 "deleted" without losing statistical information for circulations in a given
380 copy location. It also allows copy locations that are only used by deleted
383 When a copy location is deleted, it will remain in the database, but will be
384 removed from display in the staff client and the catalog.
390 New TPAC config option: Show more details
391 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
392 There is a new option for TPAC to show more details by default.
394 The option to show full details as a default may be especially
395 important for e-content. Valid values are 'true', 'false' and 'hide'.
397 Setting this to 'true' shows full details by default but allows the link
398 to appear for 'Show Fewer Details'. The 'hide' option shows full details
399 and also suppresses the link from displaying at all.
401 Look for "show_more_details.default" in config.tt2.
411 ==== Vandelay Authority Record Match Sets ====
413 Vandelay MARC Batch Import/Export now supports match sets for authority
414 record import matching. Matches can be made against MARC tag/subfield
415 entries and against a record's normalized heading + thesaurus. Internal
416 identifier (901c) matches are also supported.
418 ===== UI Modifications =====
420 * Authority matches display the normalized heading/thesuarus for each
422 * Item import summary is not displayed for authority queues, since
423 items cannot be imported with authority records.
434 Active date display in OPAC
435 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
436 If a library uses the copy's active date to calculate holds age protection,
437 the active date will display with the copy details instead of the create date
438 in the staff client view of the catalog. Libraries that do not enable the
439 _Use Active Date for Age Protection_ library setting will continue to display
445 Option to stop billing activity on zero-balance billed transactions
446 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
447 A new setting is available via the Library Settings Editor to stop any billing
448 activity on fully-paid lost or longoverdue transactions. When the _Do not
449 change fines/fees on zero-balance LOST transaction_ setting is enabled, once a
450 lost of long overdue transaction
451 has been fully paid, no more lost fees will be voided or overdue fines restored
452 or generated if the item is returned. The setting will reduce, though not
453 eliminate, negative balances in the system.
457 * Do not change fines/fees on zero-balance LOST transaction (circ.checkin.lost_zero_balance.do_not_change') - When an item has been marked lost and all
458 fines/fees have been completely paid on the transaction, do not void or
459 reinstate any fines/fees EVEN IF circ.void_lost_on_checkin and/or
460 circ.void_lost_proc_fee_on_checkin are enabled.
465 Patron Message Center
466 ^^^^^^^^^^^^^^^^^^^^^
467 There is now a new mechanism via which messages can be sent to
468 patrons for them to read while logged into the public catalog.
470 Patron messages can be generated in two ways: when a new public
471 note is added to the patron's record, and when an A/T event
472 that is configured to generate messages is processed. Three
473 new default A/T event definitions are added to generate
474 patron messages when a hold is canceled due to lack of a target,
475 staff action, or the item expiring on the shelf.
477 In the public catalog, patrons can read their messages, mark
478 one or more messages as read or unread, or delete messages that
479 they do not want to see again. The XUL staff client has a new
480 menu option on the patron display, "Message Center", that allows
481 staff to view messages. Messages are intentionally not meant
482 to be editable by patrons or library staff.
484 During upgrade, existing public patron notes that are marked
485 public are copied over as new patron messages that are marked
488 There are four new fields available in the A/T event definition:
492 * Message Library Path
495 If these four fields are set, when the A/T event is processed,
496 a message is generated in addition to whatever reactor is
497 specified by the event definition. This means that, for example,
498 an email overdue notice can also generate a message that the
499 patron can view in the public catalog.
504 Void Lost and Long Overdue Bills on Claims Returned
505 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
506 Four new settings have been added to allow sites to void lost item and long
507 overdue billings and processing fees when an item is marked as Claims Returned.
511 * Void lost item billing when claims returned (circ.void_lost_on_claimsreturned)
512 * Void lost item processing fee when claims returned (circ.void_lost_proc_fee_on_claimsreturned)
513 * Void long overdue item billing when claims returned (circ.void_longoverdue_on_claimsreturned)
514 * Void long overdue item processing fee when claims returned (circ.void_longoverdue_proc_fee_on_claimsreturned)
518 Staff option to place another hold on same title
519 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
520 When a hold is successful in the client, staff will now see a link
521 to place another hold on the same title. This link provides some workflow
522 improvement for times when staff are placing holds for multiple patrons on a
523 newly-added title or when they are placing holds for book clubs.
532 TPAC Discoverability Enhancements
533 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
535 A number of discoverability enhancements have been made to the catalog
536 to better support search engines:
538 * Titles of catalog pages now follow a "Page title - Library name" pattern
539 to provide more specific titles in search results, bookmarks, and browser
541 * The OpenSearch title now specifies the library name instead of the generic
542 "Evergreen OpenSearch" at every scope.
543 * Subject headings are now exposed as http://schema.org/about[schema:about]
544 properties instead of http://schema.org/keyword[schema:keyword].
545 * Electronic resources are now assigned a http://schema.org/url[schema:url]
546 property, and any notes or link text are assigned a
547 http://schema.org/description[schema:description] property.
548 * Given a Library of Congress relator code for 1xx and 7xx fields, we now
549 surface the URL for that relator code along with
550 the http://schema.org/contributor[schema:contributor] property to give
551 machines a better chance of understanding how the person or organization
552 actually contributed to this work.
553 * Linking out to related records:
554 ** Given an LCCN (010 field), we link to the corresponding Library of Congress
555 record using http://schema.org/sameAs[schema:sameAs].
556 ** Given an OCLC number (035 field, subfield `a` beginning with `(OCoLC)`), we
557 link to the corresponding WorldCat record using
558 http://schema.org/sameAs[schema:sameAs].
559 ** Given a URI (024 field, subfield 2 = `'uri'`), we link to the
560 corresponding OCLC Work Entity record using
561 http://schema.org/exampleOfWork[schema:exampleOfWork].
562 * The sitemap generator script now includes located URIs as well as copies
563 listed in the `asset.opac_visible_copies` materialized view, and checks
564 the children or ancestors of the requested libraries for holdings as well.
565 * Links that robots should not crawl, such as search result links, are now
566 marked with the https://support.google.com/webmasters/answer/96569?hl=en[@rel="nofollow"]
568 * Catalog pages for record details and for library descriptions now express
569 a https://support.google.com/webmasters/answer/139066?hl=en[@rel="canonical"]
570 link to simplify the number of variations of page URLs that could otherwise
571 have been derived from different search parameters.
572 * Catalog pages that do not exist now return a proper 404 "HTTP_NOT_FOUND"
573 HTTP status code, and record detail pages for records that have been deleted
574 now return a proper 410 "HTTP_GONE" HTTP status code, instead of returning a
575 misleading 200 "OK" HTTP status code.
576 * Record detail and library pages now include http://ogp.me/[Open Graph Protocol]
582 Add new link to My Lists in My Account
583 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
584 There is now a direct link to "My Lists" from the "My Account" area in the
585 top upper-right part of the screen. This gives users the ability to quickly
586 access their lists while logged into the catalog.
591 The record summary page will now offer a link to a shorter permalink that
592 can be used for sharing the record with others. All URL parameters are stripped
593 from the link with the exception of the locg and copy_depth parameters. Those
594 parameters are maintained so that people can share a link that displays just
595 the holdings from one library/system or displays holdings from all libraries
596 with a specific library's holdings floating to the top.
600 Removal of Bib Call Number Search
601 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
602 The Bib Call Number Search has been removed as a default numeric search in
603 the catalog. Evergreen sites that wish to restore this search to the catalog
604 can add the following to the numeric_qtype menu in the numeric.tt2 file.
607 <option value="identifier|bibcn">[% l('Bib Call Number') %]</option>
613 Improved styling on Text call number screen
614 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
615 New styling on the _Text call number_ screen has added highlighting to the
616 displayed message, makes the font consistent with other text on the screen, and
617 displays better on mobile devices.
625 IMPORTANT SECURITY INFORMATION
626 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
627 A serious security flaw that allows unauthorized remote access to
628 organizational unit settings is fixed in the following releases of
629 Evergreen: 2.5.9, 2.6.7, and 2.7.4. All prior releases of Evergreen
630 are vulnerable to exploitation of this flaw to reveal sensitive system
631 information. If you are running a vulnerable release of Evergreen you
632 are *strongly* encouraged to upgrade to a non-vulnerable release as
638 The Evergreen project would like to acknowledge the following
639 organizations who commissioned developments in this release of
642 * Central/Western Massachusetts Automated Resource Sharing
643 * Georgia Public Library Service
644 * Massachusetts Library Network Cooperative
647 We would also like to thank the following individuals who contributed
648 code and documentations patches to this release of Evergreen:
677 We also thank the following organizations whose employees contributed
680 * Berklee College of Music
682 * British Columbia Libraries Cooperative
684 * Emerald Data Networks, Inc.
685 * Equinox Software, Inc.
686 * Georgia Public Library Service
687 * Grand Rapids Public Library
688 * Indiana State Library
689 * King County Library System
690 * Laurentian University
691 * Lake Agassiz Regional Library
692 * Massachusetts Library Network Cooperative
693 * Merrimack Valley Library Consortium
695 * North of Boston Library Exchange
696 * Pohjois-Karjalan Tietotekniikkakeskus Oy
698 * University of Windsor
700 We regret any omissions. If a contributor has been inadvertantly
701 missed, please open a bug at http://bugs.launchpad.net/evergreen/