LP1864056: Don't compare multiple new Date()s
[working/Evergreen.git] / docs / RELEASE_NOTES_3_1.adoc
1 Evergreen 3.1 Release Notes
2 ===========================
3 :toc:
4 :numbered:
5
6 Evergreen 3.1.16
7 ----------------
8
9 This release contains bug fixes improving on Evergreen 3.1.15.
10
11 Bug Fixes
12 ~~~~~~~~~
13
14 * Add missing columns to patron record (https://bugs.launchpad.net/evergreen/+bug/1739607[Bug 1739607])
15 * Mark the permission.grp_descendants database table as STABLE (https://bugs.launchpad.net/evergreen/+bug/1768141[Bug 1768141])
16 * Webstaff locale picker repair (https://bugs.launchpad.net/evergreen/+bug/1560805[Bug 1560805])
17 * Assign copy alert permissions (https://bugs.launchpad.net/evergreen/+bug/1811442[Bug 1811442])
18 * Fix issue where reports interface was partially loaded (https://bugs.launchpad.net/evergreen/+bug/1845050[Bug 1845050])
19 * Reduce the cost of utility functions, speeding up search (https://bugs.launchpad.net/evergreen/+bug/1836963[Bug 1836963])
20 * Fixes Current Date in Date Returned in Circ History CSV (https://bugs.launchpad.net/evergreen/+bug/1813056[Bug 1813056])
21 * Only include OPAC-visible copies in SRU/Z39.50 holdings (https://bugs.launchpad.net/evergreen/+bug/1609556[Bug 1609556])
22 * Allow saving Bill Full Details grids (https://bugs.launchpad.net/evergreen/+bug/1729435[Bug 1729435])
23 * Improve usability of Patron Bill History date selector (https://bugs.launchpad.net/evergreen/+bug/1841089[Bug 1841089])
24 * Fix when the "duplicate barcode" alert appears (https://bugs.launchpad.net/evergreen/+bug/1777698[Bug 1777698])
25 * Fix paging of pending patrons (https://bugs.launchpad.net/evergreen/+bug/1749970[Bug 1749970])
26 * Check bib visibility for located URI auto suggest (https://bugs.launchpad.net/evergreen/+bug/1802952[Bug 1802952])
27 * Do not include Tag Owner in Tag (https://bugs.launchpad.net/evergreen/+bug/1825403[Bug 1825403])
28 * Require some Storage submodules instead of use them (https://bugs.launchpad.net/evergreen/+bug/1835620[Bug 1835620])
29
30 Acknowledgements
31 ~~~~~~~~~~~~~~~~
32 We would like to thank the following individuals who contributed code,
33 testing and documentation patches to the 3.1.16 point release of Evergreen:
34
35 * Bill Erickson
36 * Chris Sharp
37 * Dan Briem
38 * Dan Wells
39 * Galen Charlton
40 * Garry Collum
41 * Jane Sandberg
42 * Jason Boyer
43 * Jason Stephenson
44 * Jeff Davis
45 * Jeff Godin
46 * Jennifer Pringle
47 * Josh Stompro
48 * Kyle Huckins
49 * Michele Morgan
50 * Mike Rylander
51 * Remington Steed
52 * Terran McCanna
53
54 Evergreen 3.1.15
55 ----------------
56 This release is a security release that fixes cross-site scripting
57 (XSS) vulnerabilities in the Evergreen public catalog. This release
58 also includes several other bugfixes improving on Evergreen 3.1.14.
59
60 Security Issue: XSS Vulnerability in Public Catalog
61 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
62 This release fixes several cross-site scripting (XSS) vulnerabilities
63 in the public catalog. When upgrading, Evergreen administrators should
64 review whether any of the following templates have been customized
65 or overridden. If so, either the template should be replaced with the
66 stock version or the XSS fix (which entails adding the `| html` filter
67 in several places) applied to the customized version.
68
69  * `Open-ILS/src/templates/opac/browse.tt2`
70  * `Open-ILS/src/templates/opac/parts/ebook_api/base_js.tt2`
71  * `Open-ILS/src/templates/opac/parts/header.tt2`
72  * `Open-ILS/src/templates/opac/parts/place_hold.tt2`
73  * `Open-ILS/src/templates/opac/parts/place_hold_result.tt2`
74  * `Open-ILS/src/templates/opac/parts/result/adv_filter.tt2`
75
76 They should also review the following templates.  If these templates have
77 been customized or overridden, either the template should be replaced with
78 the stock version or the XSS fix (which entails adding `rel="nofollow` to
79 external links) applied to the customized version.
80
81 * `Open-ILS/src/templates/opac/parts/record/summary.tt2`
82 * `Open-ILS/src/templates/opac/parts/result/table.tt2`
83
84
85 Other Bugfixes
86 ~~~~~~~~~~~~~~
87 Evergreen 3.1.15 also includes the following changes:
88
89 Circulation
90 ^^^^^^^^^^^
91
92 * Default hold transit slips no longer include patron's personal
93 information (https://bugs.launchpad.net/evergreen/+bug/1735847[Bug 1735847])
94 * Fixes an issue with the reshelving process
95 (https://bugs.launchpad.net/evergreen/+bug/1018011[Bug 1018011])
96
97 Reports
98 ^^^^^^^
99
100 * Fixes issues related to cloning templates made in the XUL client
101 (https://bugs.launchpad.net/evergreen/+bug/1796945[Bug 1796945])
102
103
104 Acknowledgements
105 ~~~~~~~~~~~~~~~~
106 We would like to thank the following individuals who contributed code,
107 tests and documentation patches to the 3.1.15 security release of
108 Evergreen:
109
110 * Thomas Berezansky
111 * Jason Boyer
112 * Jeff Davis
113 * Blake Graham-Henderson
114 * Andrea Buntz Neiman
115 * Debbie Luchenbill
116 * Jane Sandberg
117 * Chris Sharp
118 * Jason Stephenson
119 * Dan Wells
120
121
122 Evergreen 3.1.14
123 ----------------
124
125 This release contains bug fixes improving on Evergreen 3.1.13.
126 All bug fixes refer to the web staff client unless otherwise specified.
127
128 Bug fixes
129 ~~~~~~~~~
130
131 General
132 ^^^^^^^
133
134 * Accessibility improvements to the date picker calendar button (https://bugs.launchpad.net/evergreen/+bug/1796903[Bug #1796903])
135 * Blank values in CSV grid downloads now show as blank instead of 'null' (https://bugs.launchpad.net/evergreen/+bug/1766982[Bug #1766982])
136 * Fixes invalid language codes in the staff client and KPAC (https://bugs.launchpad.net/evergreen/+bug/1802593[Bug #1802593])
137 * Fixes display issue with menus at certain screen resolutions (https://bugs.launchpad.net/evergreen/+bug/1813078[Bug 1813078])
138
139 Acquisitions
140 ^^^^^^^^^^^^
141
142 * Adds fund year to Distribution Formula fund dropdown menu (https://bugs.launchpad.net/evergreen/+bug/1329920[Bug 1329920])
143
144 Cataloging
145 ^^^^^^^^^^
146
147 * Extra whitespace in 856$9 subfields no longer prevents located URIs from being displayed
148 in electronic resource records. (https://bugs.launchpad.net/evergreen/+bug/1722827[Bug #1722827])
149 * Fixes issue in Item Status import where spaces or empty lines in barcode files caused an import failure (https://bugs.launchpad.net/evergreen/+bug/1798187[Bug #1798187])
150 * Fixes issue in Bucket grids where grid configurations were not saving correctly (https://bugs.launchpad.net/evergreen/+bug/1805895[Bug# 1805895])
151 * "Local catalog" is now at the top of the list of Z39.50 sources. (https://bugs.launchpad.net/evergreen/+bug/1787676[Bug #1787676])
152 * Fixes issue with authority_control_field.pl script (https://bugs.launchpad.net/evergreen/+bug/1650409[Bug #1650409])
153
154 Circulation
155 ^^^^^^^^^^^
156
157 * Fixes slowness issues with checkin and checkout grids (https://bugs.launchpad.net/evergreen/+bug/1777207[Bug #1777207])
158 * Fixes an issue that allowed staff to renew items to dates in the past. (https://bugs.launchpad.net/evergreen/+bug/1034058[Bug #1034058])
159 * Fixes an error that occured when checking in lost items when a certain setting was enabled. (https://bugs.launchpad.net/evergreen/+bug/1511765[Bug #1511765])
160 * Fixes an issue that caused the money summary to be missing from the patron record Bills tab. (https://bugs.launchpad.net/evergreen/+bug/1800484[Bug #1800484])
161 * Improves translations in Mark Damaged Popup. (https://bugs.launchpad.net/evergreen/+bug/1742523[Bug #1742523])
162
163
164 Reports
165 ^^^^^^^
166
167 * Users can now hard code a list of filter values in a report template (https://bugs.launchpad.net/evergreen/+bug/1785061[Bug #1785061])
168 * Fixes an issue that caused column labels to re-sort when deleting fields in a template. (https://bugs.launchpad.net/evergreen/+bug/1751800[Bug #1751800])
169 * Fixes column type for Billing Totals and Billing Paid columns (https://bugs.launchpad.net/evergreen/+bug/1681930[Bug #1681930])
170
171
172 Acknowledgments
173 ~~~~~~~~~~~~~~~
174 We would like to thank the following individuals who contributed code,
175 testing and documentation patches to the 3.1.14 point release of
176 Evergreen:
177
178 * Kristy Bauman
179 * Jason Boyer
180 * Dan Briem
181 * Andrea Buntz Neiman
182 * Galen Charlton
183 * Garry Collum
184 * Jeff Davis
185 * James Fournie
186 * Rogan Hamby
187 * Kyle Huckins
188 * Tiffany Little
189 * Geoff Sams
190 * Jane Sandberg
191 * Chris Sharp
192 * Remington Steed
193 * Jason Stephenson
194 * Josh Stompro
195 * Meg Stroup
196 * Dan Wells
197
198
199 Evergreen 3.1.13
200 ----------------
201
202 This release contains bug fixes improving on Evergreen 3.1.12.
203 All bug fixes refer to the web staff client unless otherwise specified.
204
205 Bug fixes
206 ~~~~~~~~~
207
208 Circulation
209 ^^^^^^^^^^^
210 * Corrects a rounding error that caused fines to exceed the max fines
211 amount
212 (https://bugs.launchpad.net/evergreen/+bug/1704819[Bug #1704819])
213 * Corrects an issue with printing Items Out receipts
214 (https://bugs.launchpad.net/evergreen/+bug/1790896[Bug #1790896])
215 * SIP Visa payments are now recorded as credit card, rather than cash
216 payments
217 (https://bugs.launchpad.net/evergreen/+bug/1796942[Bug #1796942])
218 * Converting change to patron credit no longer requires staff members
219 to refresh the screen to see the new credit
220 (https://bugs.launchpad.net/evergreen/+bug/1775639[Bug #1775639])
221 * The patron summary now includes tooltips that were available in
222 the XUL client
223 (https://bugs.launchpad.net/evergreen/+bug/1772206[Bug #1772206])
224 * The patron holds grid now includes a SMS Carrier column
225 (https://bugs.launchpad.net/evergreen/+bug/1748265[Bug #1748265])
226 * When registering a new patron from Pending Patrons, the address
227 type dropdown now supports a default value
228 (https://bugs.launchpad.net/evergreen/+bug/1816180[Bug #1816180])
229 * The Items Out grid now includes a Monograph Parts column
230 (https://bugs.launchpad.net/evergreen/+bug/1789257[Bug #1789257])
231 * The annotate checkbox on the bill payment screen is now sticky
232 (https://bugs.launchpad.net/evergreen/+bug/1759343[Bug #1759343])
233
234 Cataloging
235 ^^^^^^^^^^
236
237 * The holdings editor saves default values more consistently
238 (https://bugs.launchpad.net/evergreen/+bug/1812900[Bug #1812900])
239 * Statistical categories and their entries are now alphabetized in the
240 holdings editor (Bugs
241 https://bugs.launchpad.net/evergreen/+bug/1744386[Bug #1744386] and
242 https://bugs.launchpad.net/evergreen/+bug/1777184[Bug #1777184])
243 * The holdings editor now lists monograph parts in reverse alphabetical
244 order
245 (https://bugs.launchpad.net/evergreen/+bug/1760893[Bug #1760893])
246 * Buckets created from the MARC Batch Import process are now available
247 in the MARC Batch Edit interface
248 (https://bugs.launchpad.net/evergreen/+bug/1440890[Bug #1440890])
249 * The record bucket interface only displays the Merge action when
250 multiple records are selected
251 (https://bugs.launchpad.net/evergreen/+bug/1760599[Bug #1760599])
252
253 Client
254 ^^^^^^
255
256 * The menu in the top right corner is now named "Logout and more..."
257 (https://bugs.launchpad.net/evergreen/+bug/1796914[Bug #1796914])
258
259 Public Catalog
260 ^^^^^^^^^^^^^^
261
262 * Avoids Internal Server Errors on search result page
263 (https://bugs.launchpad.net/evergreen/+bug/1155706[Bug #1155706])
264 * Double clicking the Place Hold button can no longer result in
265 multiple holds
266 (https://bugs.launchpad.net/evergreen/+bug/1029601[Bug #1029601])
267
268 Reports
269 ^^^^^^^
270
271 * Adds a more user-friendly interface for boolean filters
272 (https://bugs.launchpad.net/evergreen/+bug/1642337[Bug #1642337])
273
274 System administration
275 ^^^^^^^^^^^^^^^^^^^^^
276
277 * Improves consistency in terminology in the Local Administration
278 screen
279 (https://bugs.launchpad.net/evergreen/+bug/1776913[Bug #1776913])
280
281 Automated tests
282 ^^^^^^^^^^^^^^^
283 * Fixes an automated test related to translations and internationalization
284 (https://bugs.launchpad.net/evergreen/+bug/1768987[Bug #1768987])
285
286 Database
287 ^^^^^^^^
288
289 * Adds some foreign key functions that may be missing from your database
290 (https://bugs.launchpad.net/evergreen/+bug/1772028[Bug #1772028])
291
292
293 Acknowledgments
294 ~~~~~~~~~~~~~~~
295 We would like to thank the following individuals who contributed code,
296 testing and documentation patches to the 3.1.13 point release of
297 Evergreen:
298
299 * John Amundson
300 * a. bellenir
301 * Jason Boyer
302 * Galen Charlton
303 * Garry Collum
304 * Dawn Dale
305 * Jeff Davis
306 * Bill Erickson
307 * Jason Etheridge
308 * Lynn Floyd
309 * Jeff Godin
310 * Rogan Hamby
311 * Kyle Huckins
312 * Sam Link
313 * Terran McCanna
314 * Bill Ott
315 * Suzanne Paterno
316 * Dan Pearl
317 * Geoff Sams
318 * Janet Schrader
319 * Remington Steed
320 * Jason Stephenson
321 * Josh Stompro
322 * Cesar Velez
323 * Dan Wells
324
325 Evergreen 3.1.12
326 ----------------
327
328 This release contains bug fixes improving on Evergreen 3.1.11.
329 All bug fixes refer to the web staff client unless otherwise specified.
330
331 Bug fixes
332 ~~~~~~~~~
333
334 Booking
335 ^^^^^^^
336
337 * Fixes a bug in the Booking URL path that failed with newer Apache
338   (https://bugs.launchpad.net/evergreen/+bug/1823387[Bug #1823387])
339
340 Circulation
341 ^^^^^^^^^^^
342
343 * Fixes a display bug with the patron record Group Members list
344   (https://bugs.launchpad.net/evergreen/+bug/1642036[Bug #1642036])
345 * Fixes title sort on the patron Items Out Screen
346   (https://bugs.launchpad.net/evergreen/+bug/1782014[Bug #1782014])
347 * Fixes the ability to place holds from item buckets
348   (https://bugs.launchpad.net/evergreen/+bug/1806394[Bug #1806394])
349 * Fixes a bug with editing the due date of an hourly loan that would lose the
350   time (https://bugs.launchpad.net/evergreen/+bug/1552778[Bug #1552778])
351
352 Cataloging
353 ^^^^^^^^^^
354
355 * Fixes a bug where copy templates would not apply properly
356   (https://bugs.launchpad.net/evergreen/+bug/1788680[Bug #1788680])
357 * Fixes the default cursor focus on the holdings editor
358   (https://bugs.launchpad.net/evergreen/+bug/1752968[Bug #1752968])
359 * Fixes a bug that failed to honor the "Retain empty bib records"
360   (cat.bib.keep_on_empty) setting when transferring items
361   (https://bugs.launchpad.net/evergreen/+bug/1333893[Bug #1333893])
362
363 Public Catalog
364 ^^^^^^^^^^^^^^
365
366 * Restores ability to request password resets
367   (https://bugs.launchpad.net/evergreen/+bug/1804038[Bug #1804038])
368
369 System administration
370 ^^^^^^^^^^^^^^^^^^^^^
371
372 * Fixes the help text in action_trigger_aggregator.pl related to the remote-acct
373   argument (https://bugs.launchpad.net/evergreen/+bug/1803729[Bug #1803729])
374 * Adds a missing page title for the Statistical Popularity Badges admin page
375   (https://bugs.launchpad.net/evergreen/+bug/1826890[Bug #1826890])
376
377
378 Acknowledgments
379 ~~~~~~~~~~~~~~~
380 We would like to thank the following individuals who contributed code,
381 testing and documentation patches to the 3.1.12 point release of
382 Evergreen:
383
384 * John Amundson
385 * Jason Boyer
386 * Galen Charlton
387 * Garry Collum
388 * Jeff Davis
389 * Bill Erickson
390 * Blake Graham-Henderson
391 * Rogan Hamby
392 * Kathy Lussier
393 * Millissa Macomber
394 * Mike Rylander
395 * Jane Sandberg
396 * Janet Schrader
397 * Remington Steed
398 * Jason Stephenson
399 * Josh Stompro
400 * Dan Wells
401 * Beth Willis
402
403
404 Evergreen 3.1.11
405 ----------------
406
407 This release contains bug fixes improving on Evergreen 3.1.10.
408 All bug fixes refer to the web staff client unless otherwise specified.
409
410 Bug fixes
411 ~~~~~~~~~
412
413 Circulation
414 ^^^^^^^^^^^
415
416 * Allows the Title Hold screen to remember previously selected pickup library
417   (https://bugs.launchpad.net/evergreen/+bug/1665534[Bug #1665534])
418 * Sorting improvements for printing the Holds Pull List
419   (https://bugs.launchpad.net/evergreen/+bug/1749502[Bug #1749502])
420 * Better display for non-catalogued checkouts in the offline checkout preview
421   pane (https://bugs.launchpad.net/evergreen/+bug/1818576[Bug #1818576])
422
423 Cataloging
424 ^^^^^^^^^^
425
426 * Fixes a bug that changed subfield order in bib record after editing a linked
427   authority (https://bugs.launchpad.net/evergreen/+bug/712490[Bug #712490])
428 * Allows opening multiple selected copies in Item Status screen from the
429   Holdings View (https://bugs.launchpad.net/evergreen/+bug/1734775[Bug
430   #1734775])
431 * Adds missing "Deleted?" column choice to Record Buckets
432   (https://bugs.launchpad.net/evergreen/+bug/1746360[Bug #1746360])
433 * Fixes the batch Call Number label field on the Volume editor to populate from
434   the MARC record (https://bugs.launchpad.net/evergreen/+bug/1793196[Bug
435   #1793196])
436 * Fixes a bug to allow editing the call number label for some but not all
437   attached copies (https://bugs.launchpad.net/evergreen/+bug/1794588[Bug
438   #1794588])
439 * Fixes the sort order of Parts on the Holdings View
440   (https://bugs.launchpad.net/evergreen/+bug/1800178[Bug #1800178])
441
442 System administration
443 ^^^^^^^^^^^^^^^^^^^^^
444
445 * Web client (websocket) logins are now properly tracked as user activity
446   (https://bugs.launchpad.net/evergreen/+bug/1818153[Bug #1818153])
447 * Fixes some log warnings related to Holds Depth
448   (https://bugs.launchpad.net/evergreen/+bug/1667497[Bug #1667497])
449 * Fixes a bug in the fine generator related to Bookings
450   (https://bugs.launchpad.net/evergreen/+bug/1819796[Bug #1819796])
451
452
453 Acknowledgments
454 ~~~~~~~~~~~~~~~
455 We would like to thank the following individuals who contributed code,
456 testing and documentation patches to the 3.1.11 point release of
457 Evergreen:
458
459 * John Amundson
460 * Jason Boyer
461 * Garry Collum
462 * Bill Erickson
463 * Jason Etheridge
464 * Rogan Hamby
465 * Kyle Huckins
466 * Terran McCanna
467 * Michele Morgan
468 * Jane Sandberg
469 * Janet Schrader
470 * Remington Steed
471 * Jason Stephenson
472 * Josh Stompro
473 * Dan Wells
474
475
476 Evergreen 3.1.10
477 ----------------
478
479 This release contains bug fixes improving on Evergreen 3.1.9.
480 All bug fixes refer to the web staff client unless otherwise specified.
481
482 Bug fixes
483 ~~~~~~~~~
484
485 Cataloging
486 ^^^^^^^^^^
487
488 * Catalogers can now set the Bib Source in the Z39.50 Overlay and Import interfaces (https://bugs.launchpad.net/evergreen/+bug/1727345[Bug #1727345])
489 * Fixes an issue where publishers display in the publication date column in copy buckets (https://bugs.launchpad.net/evergreen/+bug/1812698[Bug #1812698])
490 * Electronic reources no longer display a call number called _##URI##_ in the Volume Editor (https://bugs.launchpad.net/evergreen/+bug/1752665[Bug #1752665])
491 * Spine/pocket label templates can now include circulation library and owning library (https://bugs.launchpad.net/evergreen/+bug/1726568[Bug #1726568])
492
493 Reports
494 ^^^^^^^
495
496 * Fixes an issue where external documentation links can open in the reports module (https://bugs.launchpad.net/evergreen/+bug/1784893[Bug #1784893])
497 * Fixes an issue where publishers display as a publication date in reports (https://bugs.launchpad.net/evergreen/+bug/1812698[Bug #1812698])
498
499 System administration
500 ^^^^^^^^^^^^^^^^^^^^^
501
502 * The _DELETE_COPY_ALERT_ permission no longer needs to be granted on the consortium level (https://bugs.launchpad.net/evergreen/+bug/1783421[Bug #1783421])
503
504
505 Acknowledgments
506 ~~~~~~~~~~~~~~~
507 We would like to thank the following individuals who contributed code,
508 tests and documentation patches to the 3.1.10 point release of
509 Evergreen:
510
511 * John Amundson
512 * Galen Charlton
513 * Jeff Davis
514 * James Fournie
515 * Terran McCanna
516 * Mike Rylander
517 * Jane Sandberg
518 * Chris Sharp
519 * Jason Stephenson
520 * Ben Shum
521 * Cesar Velez
522 * Dan Wells
523
524
525 Evergreen 3.1.9
526 ----------------
527 This release contains bug fixes improving on Evergreen 3.1.8.
528 All bug fixes refer to the web staff client unless otherwise specified.
529
530 Bug fixes
531 ~~~~~~~~~
532
533 Acquisitions
534 ^^^^^^^^^^^^
535
536 * The new `edi_order_pusher.pl` now only pushes purchase orders with a state of "on-order", to prevent older purchase orders from being unintentionally pushed to vendors.
537
538 Cataloging
539 ^^^^^^^^^^
540
541 * The template dropdown in the holdings editor now provides more space to accommodate longer template names.
542 * The drop-down of copy tag types in the Manage Copy Tags dialog now includes the owning library of the copy tag type.
543
544 Circulation
545 ^^^^^^^^^^^
546
547 * Fixes an issue with recalling checked-out materials.
548 * Added several missing columns to the patron bills grid.
549 * Corrected the display of the Bill Type column in the patron bills grid.
550 * Clarified the names of the "Billing Location" and "Grocery Billing Location" columns in the patron bills grid.
551 * The Bill Full Details grid now includes a billing location column for both circulation and grocery bills, as well as the owning library for circulation bills.
552 * The Billing History transactions grid now remembers any changes that users make to the column settings.
553 * Fixes an issue with printing multiple copies of bills.
554
555 Acknowledgments
556 ~~~~~~~~~~~~~~~
557 We would like to thank the following individuals who contributed code,
558 tests and documentation patches to the 3.1.9 point release of
559 Evergreen:
560
561 * John Amundson
562 * Jason Boyer
563 * Andrea Buntz Neiman
564 * Jeff Davis
565 * Bill Erickson
566 * Angela Kilsdonk
567 * Katie G. Martin
568 * Terran McCanna
569 * Mike Rylander
570 * Jane Sandberg
571 * Janet Schrader
572 * Chris Sharp
573 * Remington Steed
574 * Jason Stephenson
575 * Cesar Velez
576
577
578 Evergreen 3.1.8
579 ----------------
580 This release contains bug fixes improving on Evergreen 3.1.7.
581 All bug fixes refer to the web staff client unless otherwise specified.
582
583 Bug fixes
584 ~~~~~~~~~
585
586 General
587 ^^^^^^^
588
589 * Fixes a bug that blocked logging in from mobile browsers
590 * Fixes a readability issue with mobile menus
591 * Fixes performance issue related to grid tooltips.
592
593 Cataloging
594 ^^^^^^^^^^
595
596 * Improves the functionality of setting a default tab of a bib record
597 * The web client now remembers the most recently selected copy template
598 * Adds help tips to Print Item Labels Settings tab
599 * If you add or edit copies and/or volumes from the Holdings View tab,
600 the view now automatically refreshes to show your changes.
601 * Provides an upgrade to MODS 3.3 for older Evergreen installations.
602 * Improves usability of Z39.50 MARC View.
603
604 Circulation
605 ^^^^^^^^^^^
606
607 * Staff can now place multiple email addresses into the patron registration/
608 edit form, depending on the value of the `ui.patron.edit.au.email.regex`
609 library setting.
610 * Fixes an issue with the offline circulation module.
611 * When merging two users, the non-lead account is now completely purged from
612 the database, rather than simply being marked as deleted.
613
614 Public catalog
615 ^^^^^^^^^^^^^^
616
617 * Removes incorrect copy counts from metarecord search results pages
618 * Electronic resources now display in the browse interfaces
619
620 System administration
621 ^^^^^^^^^^^^^^^^^^^^^
622
623 * The example Apache 2.4 configuration now enables remoteip.
624 * Improves syntax in the fm_idl file.
625
626
627 Acknowledgements
628 ~~~~~~~~~~~~~~~~
629 We would like to thank the following individuals who contributed code,
630 tests and documentation patches to the 3.1.8 point release of
631 Evergreen:
632
633 * Jason Boyer
634 * Galen Charlton
635 * Garry Collum
636 * Bill Erickson
637 * Rogan Hamby
638 * Rosie Le Faive
639 * Jeanette Lundgren
640 * Kathy Lussier
641 * Mike Rylander
642 * Jane Sandberg
643 * Janet Schrader
644 * Chris Sharp
645 * Ben Shum
646 * Remington Steed
647 * Jason Stephenson
648 * Cesar Velez
649 * Dan Wells
650
651
652 Evergreen 3.1.7
653 ----------------
654 This release contains bug fixes improving on Evergreen 3.1.6.
655 All bug fixes refer to the web staff client unless otherwise specified.
656
657 Bug fixes
658 ~~~~~~~~~
659
660 * Adds several columns to the items out grid.
661 * Adds the ability to copy patron addresses to the clipboard.
662 * Fixes several issues with adding new items and call numbers.
663 * Adds links to catalog records from the query and pending tabs of the Record Buckets interface.
664 * Corrects the date format used in several bucket interfaces.
665 * Adds a loading spinner to interfaces that are embedded in the web staff client via iframe
666 (such as the catalog).
667
668 Acknowledgements
669 ~~~~~~~~~~~~~~~~
670 We would like to thank the following individuals who contributed code,
671 tests and documentation patches to the 3.1.7 point release of
672 Evergreen:
673
674 * John Amundson
675 * a. bellenir
676 * Jason Boyer
677 * Galen Charlton
678 * Garry Collum
679 * Dawn Dale
680 * Bill Erickson
681 * Jason Etheridge
682 * Kathy Lussier
683 * Mike Rylander
684 * Jane Sandberg
685 * Jason Stephenson
686 * Cesar Velez
687 * Dan Wells
688
689 Evergreen 3.1.6
690 ----------------
691 This release contains bug fixes improving on Evergreen 3.1.5.
692 All bug fixes refer to the web staff client unless otherwise specified.
693
694 Bug fixes
695 ~~~~~~~~~
696
697 * Fixes an issue that caused catalog searches to fail after a new library was added to the org tree.
698 * When you mouse over a grid cell in the client, a tooltip will display the full contents of the cell.
699 * Fixes issues with columns in the Item Status, Holdings View, Checkout, Patron Bill, Recent Circ History,
700 * Fixes various misspellings and capitalization issues in the interface.
701 * Circulation staff can now override a patron block that is placed from Messages/Apply Penalty.
702 * Fixes an issue with checking in hourly loans.
703 * Staff can now approve pending patron addresses in the patron edit interface.
704 * Prevents patron records from being merged with themselves.
705 * Fixes a bug where the patron card dialog would not allow the user to change the primary barcode under certain circumstances.
706 * Fixes issues with duplicate transit records.
707 * Adds the transit cancel time to the Most Recent Transits section of the Item Status Holds / Transit tab.
708 * Adds the "Show in Catalog" action back to the Item Status grid.
709 * Improvements to the Item Attribute Editor.
710 * Staff can now set a default search box in the Z39.50 search interface.
711 * Staff can now delete copy notes.
712 * Fixes an issue in which transferring items and vol/items caused statistical categories to disappear.
713 * In the MARC editor, the 007 physical characteristics wizard now has a different icon than the authority linker.
714 * Protects backordered acquisitions items from having their catalog items deleted.
715 * Fixes a problem where EDI ORDERS message were not visible in the EDI Messages interface.
716 * Fixes problems that occur when cloning a report template created in the XUL client.
717 * Fixes bugs that caused activity metric data when performing searches.
718 * Fixes an issue where the "Predict New Issues" button in the Serials module did not use the correct pattern. 
719 * The KPAC now respects the `opac.holds.org_unit_not_pickup_lib` setting.
720
721 Acknowledgements
722 ~~~~~~~~~~~~~~~~
723 We would like to thank the following individuals who contributed code,
724 tests and documentation patches to the 3.1.6 point release of
725 Evergreen:
726
727 * John Amundson
728 * a. bellenir
729 * Jason Boyer
730 * Steven Callender
731 * Galen Charlton
732 * Garry Collum
733 * Amy Constantino
734 * Jeff Davis
735 * Bill Erickson
736 * Jason Etheridge
737 * Joan Kranich
738 * Sam Link
739 * Jeanette Lundgren
740 * Kathy Lussier
741 * Michele Morgan
742 * Mike Rylander
743 * Jane Sandberg
744 * Dan Scott
745 * Chris Sharp
746 * Ben Shum
747 * Jason Stephenson
748 * Dan Wells
749 * Beth Willis
750
751
752 Evergreen 3.1.5
753 ----------------
754 This release contains bug fixes improving on Evergreen 3.1.4.
755 All bug fixes refer to the web staff client unless otherwise specified.
756
757 Bug fixes
758 ~~~~~~~~~
759
760 * Several strings are now displayed in the correct translation.
761 * Right clicking in grids results in more intuitive behavior.
762 * Usernames and barcodes containging the _%_ character no longer
763 experience problems logging in.
764 * Fixes cases in which the web client stops loading after the toolbar.
765 * Fixes problems in which using the web client in multiple tabs leads
766 to data inconsistency.
767 * Fixes an issue that caused authentication session checks to spam
768 the system and needlessly fill up logs.
769 * Boolean fields within grid views now say "Yes"/"No" instead of 
770 "true"/"false".
771 * Fixes sorting issues in the patron search.
772 * Staff can now choose to print out only a selection of items out,
773 instead of having to print them all.
774 * The patron triggered event screen now respects the
775 `circ.staff.max_visible_event_age` library setting.
776 * Fixes an issue which caused an exception to be thrown during
777 non-cataloged item checkout.
778 * Fixes permission issues related to merging users.
779 * The bibliographic record summary now displays the call number that
780 matches the library's classification system.
781 * The copy editor now makes shelving locations visible to catalogers
782 from other libraries as needed.
783 * Once a record is overlayed in the Z39.50 screen, it is no longer
784 marked for overlay.
785 * Fixes several issues with the item status list view.
786 * When adding new copies, the circulation library now defaults to the
787 call number's owning library.
788 * Fixes display issues with the Print Item Labels page.
789 * Fixes an issue in which the staff client and the OPAC displayed
790 different counts of available items.
791
792 Acknowledgements
793 ~~~~~~~~~~~~~~~~
794 We would like to thank the following individuals who contributed code,
795 tests and documentation patches to the 3.1.5 point release of
796 Evergreen:
797
798 * John Amundson
799 * a. bellenir
800 * Jason Boyer
801 * Garry Collum
802 * Jeff Davis
803 * Bill Erickson
804 * Rogan Hamby
805 * Kathy Lussier
806 * Terran McCanna
807 * Michele Morgan
808 * Mike Rylander
809 * Jane Sandberg
810 * Chris Sharp
811 * Jason Stephenson
812 * Ben Shum
813 * Cesar Velez
814 * John Yorio
815
816
817 Evergreen 3.1.4
818 ----------------
819 This release contains bug fixes improving on Evergreen 3.1.3.  Note that
820 all bug fixes refer to the web staff client unless otherwise specified.
821
822 Bug fixes
823 ~~~~~~~~~
824
825 * Fixes right-click issues with the Web client grids
826 * Fixes an issue with the Default SMS Carrier in the patron edit form.
827 * Fixes an issue that allowed overdue notices to be sent to a patron
828 whose long overdue item has been paid for.
829 * Checking in precat items now displays the "Route to Cataloging" alert each
830 time the item is checked in.
831 * Fixes an issue where alerts that had been cleared by a check-in continued
832 to display.
833 * Fixes an issue in which the Adjust to Zero feature
834 does not close a checked-in lost circ.
835 * Deleted copies that are still checked out can now be checked in.
836 * Fixes a mislabeled column in the patron checkout grid.
837 * Grocery bills are no longer styled the same way as overdue bills.
838 * Fixes an error with the missing pieces functionality.
839 * Courier codes now display in the transit slip receipt preview.
840 * Fixes several issues related to adding volumes.
841 * Fixes several issues related to empty volumes.
842 * Fixes several issues related to item and volume transfers.
843 * Fixes several issues with checkboxes in the volume/copy editor.
844 * The Item Status grid now displays OU shortnames instead of full names
845 for the "Circulation Library" column.
846 * The Volume/Copy editor now allows users to remove a value from the Age
847 Hold Protection field.
848 * Barcode completion now works in copy buckets.
849 * The Z39.50 interface now notices when another record has been marked
850 for overlay.
851 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
852 the Z39.50 interface.
853 * Fixes a performance issue for the Validate button in the MARC Editor.
854 * Fixes an incorrect close tag in the Print Item Labels toolbar.
855 * Better scoping of copy tags in search results.
856 * Prevents sending invalid search.highlight_display_fields calls.
857 * Electronic Resource links now open in a new tab.
858 * Fixes an issue with the fiscal year close-out operation.
859
860 Acknowledgements
861 ~~~~~~~~~~~~~~~~
862 We would like to thank the following individuals who contributed code,
863 tests and documentation patches to the 3.1.4 point release of
864 Evergreen:
865
866 * A. Bellenir
867 * Adam Bowling
868 * Jason Boyer
869 * Galen Charlton
870 * Garry Collum
871 * Jeff Davis
872 * Bill Erickson
873 * Kathy Lussier
874 * Terran McCanna
875 * Michele Morgan
876 * Jennifer Pringle
877 * Mike Rylander
878 * Jane Sandberg
879 * Chris Sharp
880 * Jason Stephenson
881 * Cesar Velez
882 * Dan Wells
883
884 Evergreen 3.1.3
885 ---------------
886 This release contains bug fixes improving on Evergreen 3.1.2.  Note that
887 all bug fixes refer to the web staff client unless otherwise specified.
888
889 Bug fixes
890 ~~~~~~~~~
891
892 * Fixes specific cases in which deleted records appear in search results.
893 * Fixes a performance issue with deleting patrons.
894 * The hold shelf dialog popup now lists the patron's notification
895 preferences.
896 * Fixes an issue that prevented editing items when a monograph part
897 is present.
898 * Patron information is now available for use in the bills_current
899 and bills_historical receipt templates.
900 * The browser's "This page may contain unsaved data" warning now 
901 appears when users click the update
902 expire date button in a patron account and attempt to navigate away
903 without saving.
904 * The holds tab of the patron record now includes a monograph part
905 column.
906 * The barcode box in the checkout screen
907 no longer hovers above patron record tabs when
908 staff users scroll down.
909 * Fixes an issue with the date of birth in the patron edit scren.
910 * The patron account bills grid are now color-coded by the item's
911 status.
912 * Fixes an issue with the dropdown of billing type options.
913 * The Item Status screen now includes as a floating group column.
914
915 Acknowledgements
916 ~~~~~~~~~~~~~~~~
917 We would like to thank the following individuals who contributed code,
918 tests and documentation patches to the 3.1.3 point release of
919 Evergreen:
920
921 * BC Libraries Cooperative
922 * A. Bellenir
923 * Jason Boyer
924 * Galen Charlton
925 * Garry Collum
926 * Dawn Dale
927 * Bill Erickson
928 * Blake Graham-Henderson
929 * Kyle Huckins
930 * Jeanette Lundgren
931 * Kathy Lussier
932 * Terran McCanna
933 * Michele Morgan
934 * Dan Pearl
935 * Mike Rylander
936 * Geoff Sams
937 * Jane Sandberg
938 * Chris Sharp
939 * Remington Steed
940 * Jason Stephenson
941 * Cesar Velez
942 * Dan Wells
943
944
945 Evergreen 3.1.2
946 ---------------
947
948 This release contains bug fixes improving on Evergreen 3.1.1.   Note that
949 all bug fixes refer to the web staff client unless otherwise specified.
950
951 Bug fixes
952 ~~~~~~~~~
953
954 Cataloging
955 ^^^^^^^^^^
956
957 * The MARC editor now handles 008 fields better.
958 * Adds spaces between subfields when suggesting a call
959 number for a new volume.
960 * MarcXML exports from the MARC Batch Import/Export ->
961 Export Records screen now downloads the file, rather than opening
962 it in the browser.
963 * The Item Status Circulation Library column now displays a 
964 shortname rather than the full library name.
965 * The Item Status Remaining Renewals column now displays
966 correctly.
967 * The Item Status now has a "Last Renewal Workstation" column
968 available.
969 * Fixes the circulation counts displayed in Item Status Details.
970 * Removes an error that got thrown in the Holdings View when a call number
971 contains no copy.
972 * Fixes an issue where multiple copies with different values for required
973 statistical categories could not be edited and saved in batch.
974 * Add an option to remove floating in the copy editor.
975 * Fixes an issue with the floating dropdown in the copy editor.
976 * Fixes a problem in which the copy template didn't properly copy
977 certain objects.
978 * Reduces the number of API calls that the MARC Editor requires.
979 * The order of the Z39.50 servers on the Z39.50 import screen
980 no longer relies on capitalization.
981
982 Circulation
983 ^^^^^^^^^^^
984
985 * Fixes an issue that prevented the offline patron registration
986 screen from loading.
987 * Fixes an issue with searching patrons by permission group.
988 * The barcodes in the patron search are now clickable.
989 * Staff members can now manually override the patron juvenile
990 flag value, regardless of the patron's date of birth.
991 * Checkboxes on patron registration screen are now properly aligned
992 with other fields.
993 * The user permission group dropdowns in the patron registration,
994 edit, and search interfaces now have scrollbars.
995 * The date picker on the checkout screen is now hidden unless
996 circ staff activates a specific due date option.
997 * The check-in screen now includes a copy status column.
998 * The Merge Patrons interface now displays the date of birth.
999 * The user bucket screen now displays the Bucket ID.
1000 * The payment button on patron bills screen is now inactive if the
1001 Payment Received field is blank.
1002 * The Bill History receipt now includes a Finish date and a Last
1003 Payment date.
1004 * When a patron summary contains an image of the patron,
1005 that image tag now has a null alt attribute to remove it from
1006 the flow of a screen reader.
1007 * Corrects an issue that caused the transit dialog to show the
1008 wrong branch.
1009 * Corrects an issue with printing transit lists.
1010 * "Find another target" on transiting hold no longer leaves the 
1011 copy "in-transit".
1012 * The images now display to distinguish hold and transit slips.
1013 * The Clearable Holds list printout now only shows holds that have
1014 expired.
1015 * Restores the call number prefix and suffix fields to the holds
1016 pull list.
1017 * The documentation at the top of the hold shelf slip template
1018 adds `patron.alias`.
1019 * The cursor in the in-house use screen now automatically goes
1020 to the barcode field.
1021 * The in-house use screen now shows a copy status column.
1022 * Add support for converting change to patron credit in the patron bills
1023 interface, consistent with the XUL feature.
1024 * Fixes a bug that caused pickup/request library fields to be
1025 blank sometimes.
1026 * Fixes a bug in the offline org unit tree.
1027
1028 Command-line system administration
1029 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1030
1031 * The novelist entry in `eg_vhost.conf` includes two new
1032 parameters.
1033 * Corrects an issue with the `--max-sleep` argument on the
1034 `action_trigger_runner.pl` support script.
1035 * Corrects an issue with how the `eg_pbx_allocator.pl` script
1036 detects an existing lock file.
1037 * The 3.0.2-3.0.3 upgrade script disables triggers before
1038 recalculating bib visibility.
1039
1040 Public catalog
1041 ^^^^^^^^^^^^^^
1042
1043 * Fixes an issue that caused records with located URIs to be
1044 retrieved in Copy Location and Copy Location Group searches.
1045 * Fixes an error message that appeared in the search box
1046 in the public catalog while placing hold after an advanced search.
1047 * Restores the display of copy information for the user's
1048 preferred library in the public catalog.
1049 * Author and contributor names are no longer highlighted in 
1050 search results when the user has turned off highlighting.
1051 * Fixes regression errors in the search results page.
1052 * Removes redundant call numbers from the Show More Details
1053 search results.
1054 * The cast field in the catalog is now taken from the 511 field
1055 when first indicator = 1, rather than the 508.
1056 * Fixes a display issue caused by editing holds.
1057 * Repairs broken author search links on the catalog record page.
1058
1059 Serials
1060 ^^^^^^^
1061
1062 * Fixes an issue that prevented users from searching for
1063 receivable issues using Database ID or ISSN in the Serials
1064 Batch Receive interface.
1065
1066 General
1067 ^^^^^^^
1068 * Pins AngularJS support to version 1.6, which prevents unsupported
1069 AngularJS versions (such as 1.7) from breaking the build process.
1070 * Adds some padding to the bottom of Web Client interfaces.
1071 * Logins now honor all org unit timeout settings.
1072 * Evergreen will now identify and handle invalid timezones.
1073 * Fixes an issue where a column header in some interfaces were automatically
1074 highlighted in green when retrieving the interface.
1075 * The parts column in the Item Status screen now displays parts data.
1076
1077
1078 Acknowledgements
1079 ~~~~~~~~~~~~~~~~
1080 We would like to thank the following individuals who contributed code,
1081 tests and documentation patches to the 3.1.2 point release of
1082 Evergreen:
1083
1084 * John Amundson
1085 * Jason Boyer
1086 * Galen Charlton
1087 * Garry Collum
1088 * Dawn Dale
1089 * Jeff Davis
1090 * Bill Erickson
1091 * Lynn Floyd
1092 * Rogan Hamby
1093 * Kyle Huckins
1094 * Sam Link
1095 * Jeanette Lundgren
1096 * Kathy Lussier
1097 * Katie G. Martin
1098 * Terran McCanna
1099 * Michele Morgan
1100 * Dan Pearl
1101 * Mike Rylander
1102 * Laura Sachjen
1103 * Jane Sandberg
1104 * Chris Sharp
1105 * Ben Shum
1106 * Remington Steed
1107 * Jason Stephenson
1108 * Josh Stompro
1109 * Cesar Velez
1110 * Dan Wells
1111 * Bob Wicksall
1112
1113
1114
1115 Evergreen 3.1.1
1116 ---------------
1117 This release contains bug fixes improving on Evergreen 3.1.0.
1118
1119 * Fixes a performance issue with the Patron Billing History screen and
1120 other screens that cause Flattener.pm to re-create joins
1121 unnecessarily.
1122 * Fixes an issue that prevented patron alerts from showing to staff at
1123 other libraries.
1124 * Corrects the "Holdable" attribute display on the Item Status detailed
1125 view.
1126 * Fixes the ability to delete multiple copies from Item Status.
1127
1128 Acknowledgements
1129 ~~~~~~~~~~~~~~~~
1130 We would like to thank the following individuals who contributed code,
1131 tests and documentation patches to the 3.1.1 point release of
1132 Evergreen:
1133
1134 * Jason Boyer
1135 * Bill Erickson
1136 * Morkor Quarshie
1137 * Jane Sandberg
1138 * Remington Steed
1139 * Jason Stephenson
1140 * Kevin Tran
1141 * Dan Wells
1142
1143
1144 3.1.0 Upgrade Notes
1145 -------------------
1146 Like many major Evergreen upgrades, 3.1 requires a full reingest of your
1147 bibliographic records before the system is usable again.  While a basic reingest
1148 is included at the end of the upgrade script, it happens after the main
1149 COMMIT, so it is safe to cancel that and run the required reingest as you see
1150 fit (e.g. via pingest.pl).
1151
1152
1153 3.1.0 New Features
1154 ------------------
1155
1156 Administration
1157 ~~~~~~~~~~~~~~
1158
1159 New Latency Tester Tool
1160 ^^^^^^^^^^^^^^^^^^^^^^^
1161 The Evergreen Web Staff Client now includes a section called *Tests* linked from
1162 *Administration -> Workstation*. The *Tests* page houses a simple tool
1163 that can be used to test the latency of the websocket connection between the
1164 client and the server (via the `opensrf.echo` service).
1165
1166 This page displays which Evergreen host server is being queried. Upon hitting
1167 the blue "Start Test" button for the first time, it will issue 10 sequentially
1168 fired requests in order to get a solid initial average. Clicking the button a
1169 second time will take one more measurement and recalculate the average
1170 latency. The results can be copied to clipboard for troubleshooting purposes
1171 and also cleared from display.
1172
1173 marc_export --uris option
1174 ^^^^^^^^^^^^^^^^^^^^^^^^^
1175 The marc_export support script now has a `--uris` option (short form:
1176 `-u`) to export records with located URIs (i.e. electronic resources).  When
1177 used by itself, it will export only records that have located URIs.  When
1178 used in conjunction with `--items`, it will add records with located URIs
1179 but no items/copies to the output.  If combined with a `--library` or
1180 `--descendants` option, this option will limit its output to those
1181 records with URIs at the designated libraries.  The best way to use
1182 this option is in combination with the `--items` and one of the
1183 `--library` or `--descendants` options to export *all* of a library's
1184 holdings both physical and electronic.
1185
1186
1187 Architecture
1188 ~~~~~~~~~~~~
1189
1190 Sample Data Includes Surveys
1191 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1192 The Concerto sample data set now includes patron surveys, questions,
1193 answers, and responses.
1194
1195 Virtual Index Definitions
1196 ^^^^^^^^^^^^^^^^^^^^^^^^^
1197 The practical purpose of Virtual Index Definitions is to supply an Evergreen
1198 administrator with the ability to control the weighting and field inclusion of
1199 values in the general keyword index, commonly referred to as "the blob,"
1200 without requiring tricky configuration that has subtle semantics, an
1201 over-abundance of index definitions which can slow search generally, or the
1202 need to reingest all records on a regular basis as experiments are performed
1203 and the configuration refined. Significant results of recasting keyword indexes
1204 as a set of one or more Virtual Index Definitions will be simpler search
1205 configuration management, faster search speed overall, and more practical
1206 reconfiguration and adjustment as needed.
1207
1208 Previously, in order to provide field-specific weighting to
1209 keyword matches against titles or authors, an administrator must duplicate many
1210 other index definitions and supply overriding weights to those duplicates. This
1211 not only complicates configuration, but slows down record ingest as well as
1212 search. It is also fairly ineffective at achieving the goal of weighted keyword
1213 fields. Virtual Index Definitions will substantially alleviate the need for
1214 these workarounds and their consequences.
1215
1216   * A Virtual Index Definition does not require any configuration for
1217 extracting bibliographic data from records, but instead can become a sink for
1218 data collected by other index definitions, which is then colocated together to
1219 supply a search target made up of the separately extracted data. Virtual Index
1220 Definitions are effectively treated as aggregate definitions, matching across
1221 all values extracted from constituent non-virtual index definitions.  They can
1222 further make use of the Combined class functionality to colocate all values in a
1223 class together for matching even across virtual fields.
1224
1225   * Configuration allows for weighting of constituent index definitions that
1226 participate in a Virtual Index Definition. This weighting is separate from the
1227 weighting supplied when the index definition itself is a search target.
1228
1229   * The Evergreen QueryParser driver returns the list of fields actually
1230 searched using every user-supplied term set, including constituent expansion
1231 when a Virtual Index Definition is searched. In particular, this will facilitate
1232 Search Term Highlighting described below.
1233
1234   * Stock configuration changes make use of pre-existing, non-virtual index
1235 definitions mapped to new a Virtual Index Definition that implements the
1236 functionality provided by the `keyword|keyword` index definition. The
1237 `keyword|keyword` definition is left in place for the time being, until more data
1238 can be gathered about the real-world effect of removing it entirely and
1239 replacing it with Virtual Index Definition mappings.
1240
1241   * New system administration functions will be created to facilitate
1242 modification of Virtual Index Definition mapping, avoiding the need for a full
1243 reingest when existing index definitions are added or removed from a virtual
1244 field.
1245
1246 Increased use of Metabib Display Fields
1247 +++++++++++++++++++++++++++++++++++++++
1248 We use Metabib Display Fields (newly available in 3.0) to render catalog search
1249 results, intermediate metarecord results, and record detail pages. This requires
1250 the addition of several new Metabib Display Field definitions, as well as Perl
1251 services to gather and render the data.
1252
1253 We also use more Metabib Display Fields in the client. As a result,
1254 bibliographic fields will display in proper case in more client interfaces and
1255 in Evergreen reports.
1256
1257 Interfaces
1258 ++++++++++
1259 A new AngularJS "MARC Search/Facet Fields" interface has been created to replace
1260 the Dojo version, and both have been extended to support Virtual Index
1261 Definition data supplier mapping and weighting.
1262
1263 Settings & Permissions
1264 ++++++++++++++++++++++
1265 The new Virtual Index Definition data supplier mapping table,
1266 `config.metabib_field_virtual_map`, requires the same permissions as the
1267 MARC Search/Facet Fields interface: CREATE_METABIB_FIELD, UPDATE_METABIB_FIELD,
1268 DELETE_METABIB_FIELD, or ADMIN_METABIB_FIELD for all actions
1269
1270 Backend
1271 +++++++
1272 There now exist several new database tables and functions primarily in support
1273 of search highlighting. Additionally, the QueryParser driver for Evergreen has
1274 been augmented to be able to return a data structure describing how the search
1275 was performed, in a way that allows a separate support API to gather a
1276 highlighted version of the Display Field data for a given record.
1277
1278 Default Weights
1279 +++++++++++++++
1280 By default, the following fields will be weighted more heavily in keyword
1281 searches. Administrators can change these defaults by changing the values in the
1282  "All searchable fields" virtual index in the "MARC Search/Facet Fields"
1283 interface.
1284
1285   * Title proper
1286   * Main title (a new index limited to the words in the 245a)
1287   * Personal author
1288   * All subjects
1289
1290 In addition, note indexes and the physical description index will receive
1291 less weight in default keyword searches.
1292
1293 Re-ingest or Indexing Dependencies
1294 ++++++++++++++++++++++++++++++++++
1295 With the addition and modification of many Index Definitions, a full reingest is
1296 recommended.  However, search will continue to work as it did previously
1297 for those records that have not yet been reingested. Therefore a slow, rolling
1298 reingest is recommended.
1299
1300 Performance Implications or Concerns
1301 ++++++++++++++++++++++++++++++++++++
1302 Because the Metabib Display Fields infrastructure will eventually replace
1303 functionality that is significantly more CPU-intensive in the various forms of
1304 XML parsing, XSLT transformation, XPath calculation, and
1305 Metabib Virtual Record construction, it is expected that the overall CPU load
1306 will be reduced by this development, and ideally the overall time required to
1307 perform and render a search will likewise drop. It is unlikely that the speed
1308 increase will be visible to users on a per-search basis, but that search in
1309 aggregate will become a smaller consumer of resources.
1310
1311
1312 Cataloging
1313 ~~~~~~~~~~
1314
1315 Track Record Merges
1316 ^^^^^^^^^^^^^^^^^^^
1317 When 2 or more bib records are merged, all records involved are stamped
1318 with a new `merge_date` value.  For any bib record, this field indicates
1319 the last time it was involved in a merge.  At the same time, all
1320 subordinate records (i.e. those deleted as a product of the merge) are
1321 stamped with a `merged_to` value indicating which bib record the source
1322 record was merged with.
1323
1324 In the browser client bib record display, a warning alert now appears
1325 along the top of the page (below the Deleted alert) indicating when a
1326 record was used in a merge, when it was merged, and which record it was
1327 merge with, rendered as a link to the target record.
1328
1329
1330 Circulation
1331 ~~~~~~~~~~~
1332
1333 Alternate Patron Hold Pickup
1334 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1335 This feature adds a bit of convenience to a common task: checking out
1336 an item on hold to another patron (typically a family member or helper).
1337
1338 When you checkout the item, you will get a pop-up window with warnings associated
1339 with this item.  The "ITEM_ON_HOLDS_SHELF" message is now expanded to
1340
1341  * Let you know the name of the person who had placed the hold.
1342  * Give you the option (in the form of a checkbox) of cancelling the
1343    hold placed by the above-named patron.  (Checked = Cancel the hold;
1344    Unchecked = Leave the hold in place)
1345
1346 The initial value of the checkbox is derived from the
1347 `circ.clear_hold_on_checkout` organizational setting.
1348
1349 If the operator has CANCEL_HOLD privilege, then if the checkbox is checked and
1350 the checkout is allowed to proceed, the hold will be cancelled with a note that
1351 the item was checked out to another patron.
1352
1353 This feature is available in the browser-based staff client.
1354
1355 New Patron Billing Statement
1356 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1357 The Evergreen web staff client now includes a patron billing statement,
1358 which summarizes a patron's bills, credits and payments in a familiar
1359 layout.  This can be found on the "Statement" tab of the Patron Bill
1360 Details page. (From the Patron Bills page, double-click a row to view
1361 its details, or choose "Full Details" from the Actions menu.)
1362
1363 Enhanced Billing Timestamp Support
1364 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1365 Previously, billings had to make do with a single timestamp attempting
1366 to fill two different roles.  In the case of an overdue fine, the
1367 timestamp represented the *end* of the fine period for that billing,
1368 while for all other fines, the timestamp was merely the time the bill
1369 was created.  This setup generally worked, but not without confusion,
1370 and limited our ability to understand and process the data.
1371
1372 Billings will now have up to three timestamps: a create date, and when
1373 applicable, a fine period start and a fine period end.  This clarifies
1374 and simplifies things like backdating, retrospective fine generation,
1375 account balancing for negative balance avoidance, and billing timeline
1376 views.
1377
1378 Copy Alerts and Suppression Matrix
1379 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1380 The Copy Alerts feature allows library staff to add customized alert
1381 messages to copies. The copy alerts will appear when a specific event
1382 takes place, such as when the copy is checked in, checked out, or
1383 renewed. Alerts can be temporary or persistent: temporary alerts will be
1384 disabled after the initial alert and acknowledgement from staff, while
1385 persistent alerts will display each time the alert event takes place.
1386 Copy Alerts can be configured to display at the circulating or owning
1387 library only or, alternatively, when the library at which the alert
1388 event takes place is not the circulating or owning library.  Copy Alerts
1389 can also be configured to provide options for the next copy status that
1390 should be applied to an item.  Library administrators will have the
1391 ability to create and customize Copy Alert Types and to suppress copy
1392 alerts at specific org units.
1393
1394 Copy alerts can be added via the volume/creator and the check in,
1395 check out, and renew pages.  Copy alerts can also be managed at the
1396 item status page.
1397
1398 Copy alert types can be managed via the Copy Alert Types page in
1399 Local Administration, and suppression of them can be administered
1400 via the Copy Alert Suppression page under Local Administration.
1401
1402 Place Multiple Holds At Once
1403 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1404 Users with the appropriate permissions now have the ability to place multiple
1405 title/metarecords holds at once. This feature is especially beneficial for book
1406 clubs and reading groups, which need to place holds on multiple copies of a
1407 title.
1408
1409 In order to use the feature:
1410
1411   * Set the _Maximum number of duplicate holds allowed_ Library Setting
1412     (`circ.holds.max_duplicate_holds`) to a number higher than 1
1413   * Log in as a user with the CREATE_DUPLICATE_HOLDS
1414
1415 When placing a title or metarecord hold, a _Number of copies_ field will
1416 display for these users. This field is not available when placing part, volume
1417 or copy holds.
1418
1419 This feature does not change the way in which the system fills holds. The
1420 multiple holds will fill in the same way that they would if the user had placed
1421 multiple holds separately.
1422
1423 New Notice Columns in Items Out Grid
1424 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1425 The grid in the patron "items out" page in the Evergreen web staff client has two new
1426 columns indicating the number of notifications generated for a given loan and the date of
1427 the most recent notification. These columns will allow circulation staff to better respond to
1428 patron questions about whether they were sent notification about an overdue item.
1429
1430 The columns are based on the number of completed Action Trigger events on the
1431 loan that have a 'checkout.due' hook. In other words, they would include overdue
1432 and courtesy notices.
1433
1434 A new library setting, "Exclude Courtesy Notices from Patrons Itemsout Notices Count",
1435 if set will cause the notice count and date fields to exclude courtesy notices.
1436
1437 Patron Email Addresses Now Clickable In Web Staff Client
1438 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1439 Adds a mailto link to the patron's email in their profile so it can
1440 be clicked to send and email to the patron. No new settings or
1441 permissions are included in this feature.
1442
1443 Pickup Library for Staff-placed Holds
1444 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1445 Adds a new library setting, _circ.staff_placed_holds_fallback_to_ws_ou_,
1446 that helps determine the hold pickup library in cases where patrons don't
1447 have a preferred hold pickup library in their account and a staff member
1448 is placing the hold on their behalf.
1449
1450   * When this setting is true and the patron doesn't have a preferred
1451   library listed, the hold pickup library will default to the
1452   workstation's organizational unit.
1453   * When this setting is false and the patron doesn't have a preferred
1454   library listed, the hold pickup library will default to the
1455   patron's home library.
1456
1457 Public Catalog
1458 ~~~~~~~~~~~~~~
1459
1460 Search Term Highlighting
1461 ^^^^^^^^^^^^^^^^^^^^^^^^
1462 Evergreen now highlights search terms on the public catalog's main search
1463 results page, the record detail page, and intermediate pages such as metarecord
1464 grouped results page. Highlighting search terms will help the user determine why
1465 a particular record (or set of records) was retrieved.
1466
1467 Highlighting of matched terms uses the same stemming used to accomplish the
1468 search, as configured per field and class.
1469
1470 This feature will help the user more quickly determine the relevance of a
1471 particular record by calling their attention to search terms in context. Lastly,
1472 it will help familiarize the user with how records are searched, including which
1473 fields are searched as well as exposing concepts like stemming.
1474
1475 You can turn off search term highlighting by uncommenting the line
1476 `search.no_highlight = 1;` in `config.tt2`.
1477
1478 When highlighting is generally enabled, it may be turned on or off on a per-page
1479 basis through the use of a UI component which will request the page again
1480 without highlighting.
1481
1482 Highlighting of terms uses Template::Toolkit-driven CSS. A generic CSS class
1483 identifying a highlighted term, along with CSS classes identifying the search
1484 class and each search field are available for use for customization of the
1485 highlighting. A stock CSS template is provided as a baseline upon which sites
1486 may expand.
1487
1488
1489 Copy Location Filter Displays for System Searches
1490 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1491 The Shelving Location filter now displays on the advanced search page when
1492 a search is scoped to a library system, not just to an individual branch. If
1493 a library system is selected as the Search Library, the shelving location
1494 limiter will display any shelving location that is owned by the selected system
1495 or by the consortium. It will NOT display shelving locations owned by child
1496 branches.
1497
1498 Multi-source Attributes
1499 ^^^^^^^^^^^^^^^^^^^^^^^
1500 We now allow record attribute definitions to extract data using more than
1501 one strategy (XPath, tag+subfield, fixed field, etc.) as long as the values
1502 from various sources would, after normalization, have the same shape.
1503
1504 Multilingual Search
1505 +++++++++++++++++++
1506 This change allows us to configure multilingual search, by extracting values
1507 from both the 008 controlfield and the 041 datafield.  Because the values
1508 in each can be normalized to the same controlled list (and, in practice, are
1509 already from the same normalized value set), catalog searches can now use normal
1510 boolean search semantics to find records with various combinations of
1511 language attributes.
1512
1513 E.g., in the concerto test data:
1514
1515   * `keyword: piano item_lang(eng) item_lang(ita)`
1516
1517
1518 Optional Display of Badges in Catalog
1519 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1520 A new setting controls whether badges (popularity, etc.) are displayed
1521 in the catalog. If you do not wish badges to be displayed, set the
1522 `ctx.hide_badge_scores` setting to "true" in `config.tt2`.
1523
1524
1525 Miscellaneous
1526 ~~~~~~~~~~~~~
1527
1528 Fixes to patron name/username search indexes
1529 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1530 When using pg_restore to restore an Evergreen database, some of the
1531 indexes used to speed up patron searches on names and usernames
1532 could be lost.
1533
1534 This release fixes the underlying issue and re-creates the indexes
1535 in question.
1536
1537 Details
1538 +++++++
1539 When using pg_restore to restore an affected database, the
1540 "unaccent" indexes on actor.usr would not be created due to an
1541 unqualified function reference in `evergreen.unaccent_and_squash`.
1542
1543 The function will be replaced to resolve the search path issue,
1544 and the following indexes on actor.usr will be dropped and then
1545 re-created:
1546
1547   * actor_usr_first_given_name_unaccent_idx;
1548   * actor_usr_second_given_name_unaccent_idx;
1549   * actor_usr_family_name_unaccent_idx;
1550   * actor_usr_usrname_unaccent_idx;
1551
1552 This will be done even if the indexes are already present, and may
1553 take a few minutes on a database with many patrons.
1554
1555
1556 3.1.0 Acknowledgments
1557 ---------------------
1558 The Evergreen project would like to acknowledge the following
1559 organizations that commissioned developments in this release of
1560 Evergreen:
1561
1562 * Albany Public Library (Oregon)
1563 * Consortium of Ohio Libraries
1564 * CW MARS
1565 * Indiana State Library
1566 * Georgia Public Library Service
1567 * Hagerstown - Jefferson Township Library
1568 * Linn-Benton Community College
1569 * MassLNC
1570 * Pennsylvania Integrated Library System
1571 * Sage Library System
1572 * Union County Public Library (Indiana)
1573
1574 We would also like to thank the following individuals who contributed
1575 code, translations, documentations patches and tests to this release of
1576 Evergreen:
1577
1578 * Eva Cerninakova
1579 * Andi Chandler
1580 * Galen Charlton
1581 * Jeff Davis
1582 * Bill Erickson
1583 * Jeff Godin
1584 * Rogan Hamby
1585 * Angela Kilsdonk
1586 * Sam Link
1587 * Jeanette Lundgren
1588 * Kathy Lussier
1589 * Fares Othman
1590 * Dan Pearl
1591 * Mike Rylander
1592 * Jane Sandberg
1593 * Chris Sharp
1594 * Ben Shum
1595 * Remington Steed
1596 * Jason Stephenson
1597 * Kevin Tran
1598 * Cesar Velez
1599 * Dan Wells
1600
1601
1602 We also thank the following organizations whose employees contributed
1603 patches:
1604
1605 * Bibliomation
1606 * British Columbia Libraries Cooperative
1607 * Calvin College
1608 * CW MARS
1609 * Equinox Open Library Initiative
1610 * Georgia Public Library Service
1611 * Greater Clarks Hill Regional Library System
1612 * Jordanian Library and Information Association
1613 * King County Library System
1614 * Knihovna Jabok
1615 * Linn-Benton Community College
1616 * MassLNC
1617 * Sigio
1618 * Traverse Area District Library
1619
1620 We regret any omissions.  If a contributor has been inadvertently
1621 missed, please open a bug at http://bugs.launchpad.net/evergreen/
1622 with a correction.