1 Evergreen 2.8 Release Notes
2 =============================
6 This release contains several bugfixes improving on Evergreen 2.8.4
10 * Protects the stock acquisitions cancel reasons from deletion since they
11 are required to properly handle EDI order responses.
12 * Changes the copy location dropdown so that users can view and select copy
13 locations owned outside the workstation branch if they have permission to do so.
14 This fix also adds the copy location's owning org unit to the display.
18 * Allows use of more special characters, including - and +, when
19 entering a library's main email address in the Organizational Units
21 * Fixes an issue where marc_export attempts to call a non-existent field
22 on MARC::Record if an error occurs while exporting authority records.
26 * Fixes the mapping between copies and the target part when using "Merge
27 Selected" in the Monographic Parts interface.
28 * Fixes an issue with the horizontal scrollbar bar in the MARC import
29 queue inspector so the focus no longer jumps to the top of the screen
30 when attempting to use the scrollbar.
31 * Hides the staff-client saved searches header from screen readers when
32 using the public catalog in non-staff mode.
36 * When placing a hold via the staff client and clicking Advanced Hold
37 Options, fixes an issue where the barcode formfield populated with the
38 staff member's barcode.
39 * Fixes an issue where some holds with a higher proximity were
40 preferred over holds with a lower proximity because the list of
41 proximities of elgible copies was sorting ASCIIbetically instead of
43 * Adds a delete flag for monographic parts, fixes staff client errors that
44 were previously caused by deleted parts, and cancels any holds attached to
46 * Fixes an internal error that appeared when trying to renew an item on the
47 booking resource list through the public catalog. Users will now get a message
48 saying they do not have permission to renew the item.
53 * Fixes an issue where unclosed phrase searches returned zero results and
54 tied up the open-ils.storage process.
55 * Fixes an issue where parameters weren't properly maintained when
56 searching by copy location group.
60 * Adds support for UTF-8 in the Reports interface.
64 This release contains several bugfixes improving on Evergreen 2.8.3
68 * Fixes an issue where transactions with checkin-generated fines that
69 previously had a balance of zero were prematurely closing.
70 * Fixes an issue where empty patron searches lead to heavy queries ending
71 in a client error. Empty patron searches will now exit early with no results.
72 * Provides validation on the patron self-registration form to prevent users
73 from entering the date of birth in the wrong date format.
77 * Fixes an issue where all matches were not displaying during a Vandelay
78 authority record import. The fix ensures a row is added for every authority
79 record match in the Vandelay match grid, even when multiple matches refer to
80 the same authority record.
82 Preventing improper data deletion from subfield $e
83 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
85 This release contains a fix for LP bug 1484281, "authority data may be
86 deleted during propagation with current values of
87 authority.control_set_authority_field."
89 For more details see: https://bugs.launchpad.net/evergreen/+bug/1484281
91 The related upgrade script from this release removes subfield $e
92 in authority tags 100 and 110, but only from the Evergreen default
93 "LoC" authority control set configuration. If your Evergreen system is
94 set up with additional authority control sets besides the default
95 "LoC" one, you will need to run the following pieces of SQL code.
97 First verify that you have an additional control set besides the
98 default of "LoC". Run the following SQL code and write down the ID
99 number for your additional control set. The number will be an integer
103 --------------------------------------------------------------------
105 from authority.control_set
108 --------------------------------------------------------------------
110 In the following code you will need to change the two sections of
111 "control_set = XYZ". Change the part labeled with the text "XYZ", with
112 the ID number from the above query.
114 If the above query displayed more than one additional authority
115 control set, then you will need to run the code below once for each
116 additional control set ID number.
119 --------------------------------------------------------------------
120 UPDATE authority.control_set_authority_field
121 SET sf_list = REGEXP_REPLACE( sf_list, 'e', '', 'i')
122 WHERE tag = '100' AND control_set = XYZ AND sf_list ILIKE '%e%';
124 UPDATE authority.control_set_authority_field
125 SET sf_list = REGEXP_REPLACE( sf_list, 'e', '', 'i')
126 WHERE tag = '110' AND control_set = XYZ AND sf_list ILIKE '%e%';
127 --------------------------------------------------------------------
131 This release contains several bugfixes improving on Evergreen 2.8.2
135 * Restores sort order in the patron's Items Out display so that overdue items
137 * Changes the behavior of the checkin API so that future backdates are
138 successfully ignored.
139 * Fixes a problem where amnesty mode was ignored when backdating checkins.
140 * Allows SIP to honor floating copy checkin locations.
145 * Changes the behavior of the authority linker to now ignore $e and $4 in bib
151 * Changes the behavior of the end-of-year process so that fund tags will now
152 remain on propagated funds.
153 * Allows staff with the CREAT_PURCHSE_ORDER permission to view distribution
154 formulas, making it possible to use them for PO batch update operations.
159 * Improves performance of OPAC searches using format filters.
160 * Removes opac_invisible copies from consideration when displaying copies
161 on the search results page.
162 * Fixes a UTF8 encoding issue with the SuperCat SRU service.
167 * Optimizes the extend_reporter.full_circ_count view to improve performance
168 for sites with large datasets.
174 * Fixes a JS TypeError that prevents stat cats from displaying in the stat cat
176 * Fixes a problem where where the Collections API would crash when encountering
177 users with null card values.
178 * Updates the XULRunner URL in Makefile.am, allowing makefile to continue
179 building the staff client.
180 * Fixes a problem where the added content handler was not properly closing
182 * Fixes a problem where the Library Settings History was not properly
183 keeping the latest five settings per org unit.
184 * Expands safe token generation to include user ID in the cached data, which
185 can be retrieved later for activity logging.
186 * Makes xpath-based record attribute definitions work.
191 This release contains several bugfixes improving on Evergreen 2.8.1
196 * Fixes an issue where a double-scan at checkin causes two holds to capture for
198 * In patron registration, fixes a broken link in the alert informing staff that
199 a patron with the same name already exists.
200 * Fixes an issue where fully-paid long overdue items still appeared in the
201 Other/Special Circulations window.
202 * Fixes an error that appeared when staff tried to renew lost, claims returned
203 or long overdue item.
204 * Fixes a "Return to Record" link on the call number texting confirmation
205 screen. The link previously broke in cases when the user was prompted to
206 authenticate before texting.
207 * Removes long overdue circs from the total items out count in My Account.
212 * Changes the behavior of the "Add Rows" link on the advanced search screen
213 so that it no longer opens duplicate rows.
214 * Removes the Bib Call Number from the query type selector.
215 * Removes publication-specific information from a metarecord search results
217 * Prevents the "you have permission to override some of the failed holds"
218 message from appearing when the user does not have permission to override holds.
219 * Removes a stray semicolon that was appearing in browse search entries.
224 * Prevents security warnings in the staff client when Google Analytics is
225 enabled in the catalog.
226 * Adds scrollbars when necessary to the item status alternate view tab.
231 * Fixes an issue where strings with apostrophes could no longer be used to
237 * Creates a script allowing EDI Ruby dependency installation on Ubuntu 14.04.
238 * Fixes compatibility issues with Debian Jessie.
239 * Removes "Safe" CPAN dependency from Debian/Ubuntu Makefile.install files.
240 * Removes the ability for staff to edit their own user accounts.
241 * Adds an index on authority.simple_heading.record so that full table scans
242 aren't needed during authority record reingest.
246 This release contains several bugfixes improving on Evergreen 2.8.0.
251 * Fixes an issue where direct charges were not disencumbered when the charge
252 was removed from the PO or the PO was canceled.
253 * Fixes an issue where direct charges were not calculated in the PO estimated price.
254 * Refreshes the PO summary ammounts (spent, encumbered, estimated) each time
255 an amount-changing event occurs.
257 Patron message center fixes and improvements
258 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
260 * Fixes an issue where the user didn't receive an ackowledgement after
262 * Displays the unread message count in the page title for increased visibility.
263 * Repositions the patron messages link to the dashboard button bar.
264 * For messages that originate from public notes, adjusts the sending library to be the workstation library, not the home library of the note creator.
265 * Improves styling for messages by using pre-wrap, which allows longer messages
267 * 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.
270 ~~~~~~~~~~~~~~~~~~~~~
272 * Fixes an issue where payment for a lost-then-returned item was not applied to overdues.
273 * Fixes an issue where overdue fines could be doubled if both
274 restore-overdue-on-lost-return and generate-new-overdues-on-lost-return
277 Clear hold shelf checkin modifier fix
278 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
279 Fixes a network error that occurred when using the Clear Hold Shelf checkin modifier.
281 Fix Crash in Collections User Balance Summary
282 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
283 Previously a patron in collections that paid off all transactions would cause a
284 crash and stop processing any balance summary file that they are supposed to
285 appear in. Now user balance summaries can be created in full even if some users
288 Remove the ‡biblios.net Z39.50 target from seed data
289 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
290 The Z39.50 target at z3950.biblios.net/bibliographic has not worked
291 for years, so its service definition is no longer provided in the
292 seed data for new installations of Evergreen.
294 Users of existing Evergreen systems should consider removing
295 the Z39.50 definition for ‡biblios.net. This can be done from
296 Admin | Server Administration | Z39.50 Servers in the staff
299 Set resource limits for Clark Kent
300 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
301 Several parameters are now available for the reporter daemon process
302 (`clark-kent.pl`) to control resource usage. These can be used to
303 reduce the chances that a malformed report can cause indigestion
304 on a database or reports server. The new parameters, which can be
305 set in `opensrf.xml` or as command-line switches for `clark-kent.pl` are
307 * `//reporter/setup/statement_timeout` / `--statement-timeout`
309 Number of minutes to allow a report's underlying SQL query
310 to run before it gets cancelled. Default value is
311 60 minutes. If a report's query gets cancelled, the
312 error_text value will be set to a valid that indicates that
313 the allowed time was exceeded.
315 * `//reporter/setup/max_rows_for_charts` / `--max-rows-for-charts`
317 Number of rows permitted in the query's output before
318 Clark Kent refuses to attempt to draw a graph. Default
321 * `//reporter/setup/resultset_limit` / `--resultset-limit`
323 If set, truncates the report's output to the specified
324 number of hits. Note that it will not be apparent
325 to a staff user if the report's output has been
326 truncated. Default value is unlimited.
328 The report concurrency (i.e., the number of reports that Clark
329 Kent will run in parallel) can now also be controlled via
330 the `opensrf.xml` setting `//reporter/setup/parallel`.
332 Install purge_pending_users.srfsh to /openils/bin by default
333 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
335 Since purge_pending_users.srfsh is in the example crontab, it should
336 be installed to the Evergreen binaries directory (typically /openils/bin)
340 Evergreen 2.8.0 Release Notes
341 =============================
355 ==== Duplicate Order Detection Improvements ====
357 Provides tools to make it more clear to staff when a purchase order or
358 items on an order have been ordered before.
360 ===== Prevent Duplicate PO Names =====
362 Staff now have the option to specify a PO name during PO creation.
363 If the selected name is already in use by another PO at or below
364 the ordering agency for the PO, the user is warned, the save/submit
365 operations are disabled, and a link to the existing PO is display. The
366 link opens the related PO in a new tab when clicked.
368 Selecting a name which is not yet used or clearing the name field
369 (which defaults upon creation to the PO ID) will clear the warning and
370 re-enable the submit/save operation.
372 Similarly, when editing a PO, if the user attempts to use a name already
373 used, the user will be warned and a link to the offending PO will be
376 ===== Show Existing Copies =====
378 In the select list and PO view interfaces, beside the lineitem ID #, we
379 now also display the number of catalog copies already owned at or below
380 the ordering agency for the bib record in question.
382 The count does not include copies linked to the lineitem in question
383 nor does it include copies that are in some form of lost, missing, or
386 ==== Sticky Org Unit Selector ====
388 The Context Org Unit Selector on the Funds screen will now remember and default
389 to the most-recently selected org unit. On first use, the selector will
390 continue to default to the workstation org unit.
396 Apache Access Handler: OpenILS::WWW::AccessHandler
397 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
398 This Perl module is intended for limiting patron access to configured locations
399 in Apache. These locations could be folder trees, static files, non-Evergreen
400 dynamic content, or other Apache features/modules. It is intended as a more
401 patron-oriented and transparent version of the OpenILS::WWW::Proxy and
402 OpenILS::WWW:Proxy::Authen modules.
404 Instead of using Basic Authentication the AccessHandler module instead redirects
405 to the OPAC for login. Once logged in additional checks can be performed, based
406 on configured variables:
408 * Permission Checks (at Home OU or specified location)
409 * Home OU Checks (Org Unit or Descendant)
410 * "Good standing" Checks (Not Inactive or Barred)
412 As the AccessHandler module does not actually serve the content it is
413 protecting, but instead merely hands control back to Apache when it is done
414 authenticating, you can protect almost anything you can serve with Apache.
418 The general use of this module is to protect access to something else.
419 Here are some examples of what you can protect:
422 ** Automatic Directory Indexes
424 *** Electronic Databases
425 *** Software on other servers/ports
426 * Non-Evergreen software
427 ** Timekeeping software for staff
428 ** Specialized patron request packages
429 * Static files and folders
430 ** Semi-public Patron resources
431 ** Staff-only downloads
434 Deleted flag for copy locations
435 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
436 A deleted flag is now available for copy locations, allowing them to be
437 "deleted" without losing statistical information for circulations in a given
438 copy location. It also allows copy locations that are only used by deleted
441 When a copy location is deleted, it will remain in the database, but will be
442 removed from display in the staff client and the catalog.
448 New TPAC config option: Show more details
449 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
450 There is a new option for TPAC to show more details by default.
452 The option to show full details as a default may be especially
453 important for e-content. Valid values are 'true', 'false' and 'hide'.
455 Setting this to 'true' shows full details by default but allows the link
456 to appear for 'Show Fewer Details'. The 'hide' option shows full details
457 and also suppresses the link from displaying at all.
459 Look for "show_more_details.default" in config.tt2.
469 ==== Vandelay Authority Record Match Sets ====
471 Vandelay MARC Batch Import/Export now supports match sets for authority
472 record import matching. Matches can be made against MARC tag/subfield
473 entries and against a record's normalized heading + thesaurus. Internal
474 identifier (901c) matches are also supported.
476 ===== UI Modifications =====
478 * Authority matches display the normalized heading/thesuarus for each
480 * Item import summary is not displayed for authority queues, since
481 items cannot be imported with authority records.
492 Active date display in OPAC
493 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
494 If a library uses the copy's active date to calculate holds age protection,
495 the active date will display with the copy details instead of the create date
496 in the staff client view of the catalog. Libraries that do not enable the
497 _Use Active Date for Age Protection_ library setting will continue to display
503 Option to stop billing activity on zero-balance billed transactions
504 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
505 A new setting is available via the Library Settings Editor to stop any billing
506 activity on fully-paid lost or longoverdue transactions. When the _Do not
507 change fines/fees on zero-balance LOST transaction_ setting is enabled, once a
508 lost of long overdue transaction
509 has been fully paid, no more lost fees will be voided or overdue fines restored
510 or generated if the item is returned. The setting will reduce, though not
511 eliminate, negative balances in the system.
515 * 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
516 fines/fees have been completely paid on the transaction, do not void or
517 reinstate any fines/fees EVEN IF circ.void_lost_on_checkin and/or
518 circ.void_lost_proc_fee_on_checkin are enabled.
523 Patron Message Center
524 ^^^^^^^^^^^^^^^^^^^^^
525 There is now a new mechanism via which messages can be sent to
526 patrons for them to read while logged into the public catalog.
528 Patron messages can be generated in two ways: when a new public
529 note is added to the patron's record, and when an A/T event
530 that is configured to generate messages is processed. Three
531 new default A/T event definitions are added to generate
532 patron messages when a hold is canceled due to lack of a target,
533 staff action, or the item expiring on the shelf.
535 In the public catalog, patrons can read their messages, mark
536 one or more messages as read or unread, or delete messages that
537 they do not want to see again. The XUL staff client has a new
538 menu option on the patron display, "Message Center", that allows
539 staff to view messages. Messages are intentionally not meant
540 to be editable by patrons or library staff.
542 During upgrade, existing public patron notes that are marked
543 public are copied over as new patron messages that are marked
546 There are four new fields available in the A/T event definition:
550 * Message Library Path
553 If these four fields are set, when the A/T event is processed,
554 a message is generated in addition to whatever reactor is
555 specified by the event definition. This means that, for example,
556 an email overdue notice can also generate a message that the
557 patron can view in the public catalog.
562 Void Lost and Long Overdue Bills on Claims Returned
563 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
564 Four new settings have been added to allow sites to void lost item and long
565 overdue billings and processing fees when an item is marked as Claims Returned.
569 * Void lost item billing when claims returned (circ.void_lost_on_claimsreturned)
570 * Void lost item processing fee when claims returned (circ.void_lost_proc_fee_on_claimsreturned)
571 * Void long overdue item billing when claims returned (circ.void_longoverdue_on_claimsreturned)
572 * Void long overdue item processing fee when claims returned (circ.void_longoverdue_proc_fee_on_claimsreturned)
576 Staff option to place another hold on same title
577 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
578 When a hold is successful in the client, staff will now see a link
579 to place another hold on the same title. This link provides some workflow
580 improvement for times when staff are placing holds for multiple patrons on a
581 newly-added title or when they are placing holds for book clubs.
590 TPAC Discoverability Enhancements
591 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
593 A number of discoverability enhancements have been made to the catalog
594 to better support search engines:
596 * Titles of catalog pages now follow a "Page title - Library name" pattern
597 to provide more specific titles in search results, bookmarks, and browser
599 * The OpenSearch title now specifies the library name instead of the generic
600 "Evergreen OpenSearch" at every scope.
601 * Subject headings are now exposed as http://schema.org/about[schema:about]
602 properties instead of http://schema.org/keyword[schema:keyword].
603 * Electronic resources are now assigned a http://schema.org/url[schema:url]
604 property, and any notes or link text are assigned a
605 http://schema.org/description[schema:description] property.
606 * Given a Library of Congress relator code for 1xx and 7xx fields, we now
607 surface the URL for that relator code along with
608 the http://schema.org/contributor[schema:contributor] property to give
609 machines a better chance of understanding how the person or organization
610 actually contributed to this work.
611 * Linking out to related records:
612 ** Given an LCCN (010 field), we link to the corresponding Library of Congress
613 record using http://schema.org/sameAs[schema:sameAs].
614 ** Given an OCLC number (035 field, subfield `a` beginning with `(OCoLC)`), we
615 link to the corresponding WorldCat record using
616 http://schema.org/sameAs[schema:sameAs].
617 ** Given a URI (024 field, subfield 2 = `'uri'`), we link to the
618 corresponding OCLC Work Entity record using
619 http://schema.org/exampleOfWork[schema:exampleOfWork].
620 * The sitemap generator script now includes located URIs as well as copies
621 listed in the `asset.opac_visible_copies` materialized view, and checks
622 the children or ancestors of the requested libraries for holdings as well.
623 * Links that robots should not crawl, such as search result links, are now
624 marked with the https://support.google.com/webmasters/answer/96569?hl=en[@rel="nofollow"]
626 * Catalog pages for record details and for library descriptions now express
627 a https://support.google.com/webmasters/answer/139066?hl=en[@rel="canonical"]
628 link to simplify the number of variations of page URLs that could otherwise
629 have been derived from different search parameters.
630 * Catalog pages that do not exist now return a proper 404 "HTTP_NOT_FOUND"
631 HTTP status code, and record detail pages for records that have been deleted
632 now return a proper 410 "HTTP_GONE" HTTP status code, instead of returning a
633 misleading 200 "OK" HTTP status code.
634 * Record detail and library pages now include http://ogp.me/[Open Graph Protocol]
640 Add new link to My Lists in My Account
641 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
642 There is now a direct link to "My Lists" from the "My Account" area in the
643 top upper-right part of the screen. This gives users the ability to quickly
644 access their lists while logged into the catalog.
649 The record summary page will now offer a link to a shorter permalink that
650 can be used for sharing the record with others. All URL parameters are stripped
651 from the link with the exception of the locg and copy_depth parameters. Those
652 parameters are maintained so that people can share a link that displays just
653 the holdings from one library/system or displays holdings from all libraries
654 with a specific library's holdings floating to the top.
658 Removal of Bib Call Number Search
659 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
660 The Bib Call Number Search has been removed as a default numeric search in
661 the catalog. Evergreen sites that wish to restore this search to the catalog
662 can add the following to the numeric_qtype menu in the numeric.tt2 file.
665 <option value="identifier|bibcn">[% l('Bib Call Number') %]</option>
671 Improved styling on Text call number screen
672 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
673 New styling on the _Text call number_ screen has added highlighting to the
674 displayed message, makes the font consistent with other text on the screen, and
675 displays better on mobile devices.
683 IMPORTANT SECURITY INFORMATION
684 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
685 A serious security flaw that allows unauthorized remote access to
686 organizational unit settings is fixed in the following releases of
687 Evergreen: 2.5.9, 2.6.7, and 2.7.4. All prior releases of Evergreen
688 are vulnerable to exploitation of this flaw to reveal sensitive system
689 information. If you are running a vulnerable release of Evergreen you
690 are *strongly* encouraged to upgrade to a non-vulnerable release as
696 The Evergreen project would like to acknowledge the following
697 organizations who commissioned developments in this release of
700 * Central/Western Massachusetts Automated Resource Sharing
701 * Georgia Public Library Service
702 * Massachusetts Library Network Cooperative
705 We would also like to thank the following individuals who contributed
706 code and documentations patches to this release of Evergreen:
739 We also thank the following organizations whose employees contributed
742 * Berklee College of Music
744 * British Columbia Libraries Cooperative
746 * Emerald Data Networks, Inc.
747 * Equinox Software, Inc.
748 * Georgia Public Library Service
749 * Grand Rapids Public Library
750 * Indiana State Library
751 * King County Library System
752 * Laurentian University
753 * Lake Agassiz Regional Library
754 * Massachusetts Library Network Cooperative
755 * Merrimack Valley Library Consortium
757 * North of Boston Library Exchange
758 * Northwest Regional Library System
759 * Pohjois-Karjalan Tietotekniikkakeskus Oy
760 * Rodgers Memorial Library
762 * University of Windsor
764 We regret any omissions. If a contributor has been inadvertantly
765 missed, please open a bug at http://bugs.launchpad.net/evergreen/