]> git.evergreen-ils.org Git - working/Evergreen.git/blob - docs/RELEASE_NOTES_3_1.adoc
LP1739293 Record merge fits container
[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.10
7 ----------------
8
9 This release contains bug fixes improving on Evergreen 3.1.9.
10 All bug fixes refer to the web staff client unless otherwise specified.
11
12 Bug fixes
13 ~~~~~~~~~
14
15 Cataloging
16 ^^^^^^^^^^
17
18 * Catalogers can now set the Bib Source in the Z39.50 Overlay and Import interfaces (https://bugs.launchpad.net/evergreen/+bug/1727345[Bug #1727345])
19 * Fixes an issue where publishers display in the publication date column in copy buckets (https://bugs.launchpad.net/evergreen/+bug/1812698[Bug #1812698])
20 * Electronic reources no longer display a call number called _##URI##_ in the Volume Editor (https://bugs.launchpad.net/evergreen/+bug/1752665[Bug #1752665])
21 * Spine/pocket label templates can now include circulation library and owning library (https://bugs.launchpad.net/evergreen/+bug/1726568[Bug #1726568])
22
23 Reports
24 ^^^^^^^
25
26 * Fixes an issue where external documentation links can open in the reports module (https://bugs.launchpad.net/evergreen/+bug/1784893[Bug #1784893])
27 * Fixes an issue where publishers display as a publication date in reports (https://bugs.launchpad.net/evergreen/+bug/1812698[Bug #1812698])
28
29 System administration
30 ^^^^^^^^^^^^^^^^^^^^^
31
32 * The _DELETE_COPY_ALERT_ permission no longer needs to be granted on the consortium level (https://bugs.launchpad.net/evergreen/+bug/1783421[Bug #1783421])
33
34
35 Acknowledgments
36 ~~~~~~~~~~~~~~~
37 We would like to thank the following individuals who contributed code,
38 tests and documentation patches to the 3.1.10 point release of
39 Evergreen:
40
41 * John Amundson
42 * Galen Charlton
43 * Jeff Davis
44 * James Fournie
45 * Terran McCanna
46 * Mike Rylander
47 * Jane Sandberg
48 * Chris Sharp
49 * Jason Stephenson
50 * Ben Shum
51 * Cesar Velez
52 * Dan Wells
53
54
55 Evergreen 3.1.9
56 ----------------
57 This release contains bug fixes improving on Evergreen 3.1.8.
58 All bug fixes refer to the web staff client unless otherwise specified.
59
60 Bug fixes
61 ~~~~~~~~~
62
63 Acquisitions
64 ^^^^^^^^^^^^
65
66 * 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.
67
68 Cataloging
69 ^^^^^^^^^^
70
71 * The template dropdown in the holdings editor now provides more space to accommodate longer template names.
72 * The drop-down of copy tag types in the Manage Copy Tags dialog now includes the owning library of the copy tag type.
73
74 Circulation
75 ^^^^^^^^^^^
76
77 * Fixes an issue with recalling checked-out materials.
78 * Added several missing columns to the patron bills grid.
79 * Corrected the display of the Bill Type column in the patron bills grid.
80 * Clarified the names of the "Billing Location" and "Grocery Billing Location" columns in the patron bills grid.
81 * 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.
82 * The Billing History transactions grid now remembers any changes that users make to the column settings.
83 * Fixes an issue with printing multiple copies of bills.
84
85 Acknowledgments
86 ~~~~~~~~~~~~~~~
87 We would like to thank the following individuals who contributed code,
88 tests and documentation patches to the 3.1.9 point release of
89 Evergreen:
90
91 * John Amundson
92 * Jason Boyer
93 * Andrea Buntz Neiman
94 * Jeff Davis
95 * Bill Erickson
96 * Angela Kilsdonk
97 * Katie G. Martin
98 * Terran McCanna
99 * Mike Rylander
100 * Jane Sandberg
101 * Janet Schrader
102 * Chris Sharp
103 * Remington Steed
104 * Jason Stephenson
105 * Cesar Velez
106
107
108 Evergreen 3.1.8
109 ----------------
110 This release contains bug fixes improving on Evergreen 3.1.7.
111 All bug fixes refer to the web staff client unless otherwise specified.
112
113 Bug fixes
114 ~~~~~~~~~
115
116 General
117 ^^^^^^^
118
119 * Fixes a bug that blocked logging in from mobile browsers
120 * Fixes a readability issue with mobile menus
121 * Fixes performance issue related to grid tooltips.
122
123 Cataloging
124 ^^^^^^^^^^
125
126 * Improves the functionality of setting a default tab of a bib record
127 * The web client now remembers the most recently selected copy template
128 * Adds help tips to Print Item Labels Settings tab
129 * If you add or edit copies and/or volumes from the Holdings View tab,
130 the view now automatically refreshes to show your changes.
131 * Provides an upgrade to MODS 3.3 for older Evergreen installations.
132 * Improves usability of Z39.50 MARC View.
133
134 Circulation
135 ^^^^^^^^^^^
136
137 * Staff can now place multiple email addresses into the patron registration/
138 edit form, depending on the value of the `ui.patron.edit.au.email.regex`
139 library setting.
140 * Fixes an issue with the offline circulation module.
141 * When merging two users, the non-lead account is now completely purged from
142 the database, rather than simply being marked as deleted.
143
144 Public catalog
145 ^^^^^^^^^^^^^^
146
147 * Removes incorrect copy counts from metarecord search results pages
148 * Electronic resources now display in the browse interfaces
149
150 System administration
151 ^^^^^^^^^^^^^^^^^^^^^
152
153 * The example Apache 2.4 configuration now enables remoteip.
154 * Improves syntax in the fm_idl file.
155
156
157 Acknowledgements
158 ~~~~~~~~~~~~~~~~
159 We would like to thank the following individuals who contributed code,
160 tests and documentation patches to the 3.1.8 point release of
161 Evergreen:
162
163 * Jason Boyer
164 * Galen Charlton
165 * Garry Collum
166 * Bill Erickson
167 * Rogan Hamby
168 * Rosie Le Faive
169 * Jeanette Lundgren
170 * Kathy Lussier
171 * Mike Rylander
172 * Jane Sandberg
173 * Janet Schrader
174 * Chris Sharp
175 * Ben Shum
176 * Remington Steed
177 * Jason Stephenson
178 * Cesar Velez
179 * Dan Wells
180
181
182 Evergreen 3.1.7
183 ----------------
184 This release contains bug fixes improving on Evergreen 3.1.6.
185 All bug fixes refer to the web staff client unless otherwise specified.
186
187 Bug fixes
188 ~~~~~~~~~
189
190 * Adds several columns to the items out grid.
191 * Adds the ability to copy patron addresses to the clipboard.
192 * Fixes several issues with adding new items and call numbers.
193 * Adds links to catalog records from the query and pending tabs of the Record Buckets interface.
194 * Corrects the date format used in several bucket interfaces.
195 * Adds a loading spinner to interfaces that are embedded in the web staff client via iframe
196 (such as the catalog).
197
198 Acknowledgements
199 ~~~~~~~~~~~~~~~~
200 We would like to thank the following individuals who contributed code,
201 tests and documentation patches to the 3.1.7 point release of
202 Evergreen:
203
204 * John Amundson
205 * a. bellenir
206 * Jason Boyer
207 * Galen Charlton
208 * Garry Collum
209 * Dawn Dale
210 * Bill Erickson
211 * Jason Etheridge
212 * Kathy Lussier
213 * Mike Rylander
214 * Jane Sandberg
215 * Jason Stephenson
216 * Cesar Velez
217 * Dan Wells
218
219 Evergreen 3.1.6
220 ----------------
221 This release contains bug fixes improving on Evergreen 3.1.5.
222 All bug fixes refer to the web staff client unless otherwise specified.
223
224 Bug fixes
225 ~~~~~~~~~
226
227 * Fixes an issue that caused catalog searches to fail after a new library was added to the org tree.
228 * When you mouse over a grid cell in the client, a tooltip will display the full contents of the cell.
229 * Fixes issues with columns in the Item Status, Holdings View, Checkout, Patron Bill, Recent Circ History,
230 * Fixes various misspellings and capitalization issues in the interface.
231 * Circulation staff can now override a patron block that is placed from Messages/Apply Penalty.
232 * Fixes an issue with checking in hourly loans.
233 * Staff can now approve pending patron addresses in the patron edit interface.
234 * Prevents patron records from being merged with themselves.
235 * Fixes a bug where the patron card dialog would not allow the user to change the primary barcode under certain circumstances.
236 * Fixes issues with duplicate transit records.
237 * Adds the transit cancel time to the Most Recent Transits section of the Item Status Holds / Transit tab.
238 * Adds the "Show in Catalog" action back to the Item Status grid.
239 * Improvements to the Item Attribute Editor.
240 * Staff can now set a default search box in the Z39.50 search interface.
241 * Staff can now delete copy notes.
242 * Fixes an issue in which transferring items and vol/items caused statistical categories to disappear.
243 * In the MARC editor, the 007 physical characteristics wizard now has a different icon than the authority linker.
244 * Protects backordered acquisitions items from having their catalog items deleted.
245 * Fixes a problem where EDI ORDERS message were not visible in the EDI Messages interface.
246 * Fixes problems that occur when cloning a report template created in the XUL client.
247 * Fixes bugs that caused activity metric data when performing searches.
248 * Fixes an issue where the "Predict New Issues" button in the Serials module did not use the correct pattern. 
249 * The KPAC now respects the `opac.holds.org_unit_not_pickup_lib` setting.
250
251 Acknowledgements
252 ~~~~~~~~~~~~~~~~
253 We would like to thank the following individuals who contributed code,
254 tests and documentation patches to the 3.1.6 point release of
255 Evergreen:
256
257 * John Amundson
258 * a. bellenir
259 * Jason Boyer
260 * Steven Callender
261 * Galen Charlton
262 * Garry Collum
263 * Amy Constantino
264 * Jeff Davis
265 * Bill Erickson
266 * Jason Etheridge
267 * Joan Kranich
268 * Sam Link
269 * Jeanette Lundgren
270 * Kathy Lussier
271 * Michele Morgan
272 * Mike Rylander
273 * Jane Sandberg
274 * Dan Scott
275 * Chris Sharp
276 * Ben Shum
277 * Jason Stephenson
278 * Dan Wells
279 * Beth Willis
280
281
282 Evergreen 3.1.5
283 ----------------
284 This release contains bug fixes improving on Evergreen 3.1.4.
285 All bug fixes refer to the web staff client unless otherwise specified.
286
287 Bug fixes
288 ~~~~~~~~~
289
290 * Several strings are now displayed in the correct translation.
291 * Right clicking in grids results in more intuitive behavior.
292 * Usernames and barcodes containging the _%_ character no longer
293 experience problems logging in.
294 * Fixes cases in which the web client stops loading after the toolbar.
295 * Fixes problems in which using the web client in multiple tabs leads
296 to data inconsistency.
297 * Fixes an issue that caused authentication session checks to spam
298 the system and needlessly fill up logs.
299 * Boolean fields within grid views now say "Yes"/"No" instead of 
300 "true"/"false".
301 * Fixes sorting issues in the patron search.
302 * Staff can now choose to print out only a selection of items out,
303 instead of having to print them all.
304 * The patron triggered event screen now respects the
305 `circ.staff.max_visible_event_age` library setting.
306 * Fixes an issue which caused an exception to be thrown during
307 non-cataloged item checkout.
308 * Fixes permission issues related to merging users.
309 * The bibliographic record summary now displays the call number that
310 matches the library's classification system.
311 * The copy editor now makes shelving locations visible to catalogers
312 from other libraries as needed.
313 * Once a record is overlayed in the Z39.50 screen, it is no longer
314 marked for overlay.
315 * Fixes several issues with the item status list view.
316 * When adding new copies, the circulation library now defaults to the
317 call number's owning library.
318 * Fixes display issues with the Print Item Labels page.
319 * Fixes an issue in which the staff client and the OPAC displayed
320 different counts of available items.
321
322 Acknowledgements
323 ~~~~~~~~~~~~~~~~
324 We would like to thank the following individuals who contributed code,
325 tests and documentation patches to the 3.1.5 point release of
326 Evergreen:
327
328 * John Amundson
329 * a. bellenir
330 * Jason Boyer
331 * Garry Collum
332 * Jeff Davis
333 * Bill Erickson
334 * Rogan Hamby
335 * Kathy Lussier
336 * Terran McCanna
337 * Michele Morgan
338 * Mike Rylander
339 * Jane Sandberg
340 * Chris Sharp
341 * Jason Stephenson
342 * Ben Shum
343 * Cesar Velez
344 * John Yorio
345
346
347 Evergreen 3.1.4
348 ----------------
349 This release contains bug fixes improving on Evergreen 3.1.3.  Note that
350 all bug fixes refer to the web staff client unless otherwise specified.
351
352 Bug fixes
353 ~~~~~~~~~
354
355 * Fixes right-click issues with the Web client grids
356 * Fixes an issue with the Default SMS Carrier in the patron edit form.
357 * Fixes an issue that allowed overdue notices to be sent to a patron
358 whose long overdue item has been paid for.
359 * Checking in precat items now displays the "Route to Cataloging" alert each
360 time the item is checked in.
361 * Fixes an issue where alerts that had been cleared by a check-in continued
362 to display.
363 * Fixes an issue in which the Adjust to Zero feature
364 does not close a checked-in lost circ.
365 * Deleted copies that are still checked out can now be checked in.
366 * Fixes a mislabeled column in the patron checkout grid.
367 * Grocery bills are no longer styled the same way as overdue bills.
368 * Fixes an error with the missing pieces functionality.
369 * Courier codes now display in the transit slip receipt preview.
370 * Fixes several issues related to adding volumes.
371 * Fixes several issues related to empty volumes.
372 * Fixes several issues related to item and volume transfers.
373 * Fixes several issues with checkboxes in the volume/copy editor.
374 * The Item Status grid now displays OU shortnames instead of full names
375 for the "Circulation Library" column.
376 * The Volume/Copy editor now allows users to remove a value from the Age
377 Hold Protection field.
378 * Barcode completion now works in copy buckets.
379 * The Z39.50 interface now notices when another record has been marked
380 for overlay.
381 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
382 the Z39.50 interface.
383 * Fixes a performance issue for the Validate button in the MARC Editor.
384 * Fixes an incorrect close tag in the Print Item Labels toolbar.
385 * Better scoping of copy tags in search results.
386 * Prevents sending invalid search.highlight_display_fields calls.
387 * Electronic Resource links now open in a new tab.
388 * Fixes an issue with the fiscal year close-out operation.
389
390 Acknowledgements
391 ~~~~~~~~~~~~~~~~
392 We would like to thank the following individuals who contributed code,
393 tests and documentation patches to the 3.1.4 point release of
394 Evergreen:
395
396 * A. Bellenir
397 * Adam Bowling
398 * Jason Boyer
399 * Galen Charlton
400 * Garry Collum
401 * Jeff Davis
402 * Bill Erickson
403 * Kathy Lussier
404 * Terran McCanna
405 * Michele Morgan
406 * Jennifer Pringle
407 * Mike Rylander
408 * Jane Sandberg
409 * Chris Sharp
410 * Jason Stephenson
411 * Cesar Velez
412 * Dan Wells
413
414 Evergreen 3.1.3
415 ---------------
416 This release contains bug fixes improving on Evergreen 3.1.2.  Note that
417 all bug fixes refer to the web staff client unless otherwise specified.
418
419 Bug fixes
420 ~~~~~~~~~
421
422 * Fixes specific cases in which deleted records appear in search results.
423 * Fixes a performance issue with deleting patrons.
424 * The hold shelf dialog popup now lists the patron's notification
425 preferences.
426 * Fixes an issue that prevented editing items when a monograph part
427 is present.
428 * Patron information is now available for use in the bills_current
429 and bills_historical receipt templates.
430 * The browser's "This page may contain unsaved data" warning now 
431 appears when users click the update
432 expire date button in a patron account and attempt to navigate away
433 without saving.
434 * The holds tab of the patron record now includes a monograph part
435 column.
436 * The barcode box in the checkout screen
437 no longer hovers above patron record tabs when
438 staff users scroll down.
439 * Fixes an issue with the date of birth in the patron edit scren.
440 * The patron account bills grid are now color-coded by the item's
441 status.
442 * Fixes an issue with the dropdown of billing type options.
443 * The Item Status screen now includes as a floating group column.
444
445 Acknowledgements
446 ~~~~~~~~~~~~~~~~
447 We would like to thank the following individuals who contributed code,
448 tests and documentation patches to the 3.1.3 point release of
449 Evergreen:
450
451 * BC Libraries Cooperative
452 * A. Bellenir
453 * Jason Boyer
454 * Galen Charlton
455 * Garry Collum
456 * Dawn Dale
457 * Bill Erickson
458 * Blake Graham-Henderson
459 * Kyle Huckins
460 * Jeanette Lundgren
461 * Kathy Lussier
462 * Terran McCanna
463 * Michele Morgan
464 * Dan Pearl
465 * Mike Rylander
466 * Geoff Sams
467 * Jane Sandberg
468 * Chris Sharp
469 * Remington Steed
470 * Jason Stephenson
471 * Cesar Velez
472 * Dan Wells
473
474
475 Evergreen 3.1.2
476 ---------------
477
478 This release contains bug fixes improving on Evergreen 3.1.1.   Note that
479 all bug fixes refer to the web staff client unless otherwise specified.
480
481 Bug fixes
482 ~~~~~~~~~
483
484 Cataloging
485 ^^^^^^^^^^
486
487 * The MARC editor now handles 008 fields better.
488 * Adds spaces between subfields when suggesting a call
489 number for a new volume.
490 * MarcXML exports from the MARC Batch Import/Export ->
491 Export Records screen now downloads the file, rather than opening
492 it in the browser.
493 * The Item Status Circulation Library column now displays a 
494 shortname rather than the full library name.
495 * The Item Status Remaining Renewals column now displays
496 correctly.
497 * The Item Status now has a "Last Renewal Workstation" column
498 available.
499 * Fixes the circulation counts displayed in Item Status Details.
500 * Removes an error that got thrown in the Holdings View when a call number
501 contains no copy.
502 * Fixes an issue where multiple copies with different values for required
503 statistical categories could not be edited and saved in batch.
504 * Add an option to remove floating in the copy editor.
505 * Fixes an issue with the floating dropdown in the copy editor.
506 * Fixes a problem in which the copy template didn't properly copy
507 certain objects.
508 * Reduces the number of API calls that the MARC Editor requires.
509 * The order of the Z39.50 servers on the Z39.50 import screen
510 no longer relies on capitalization.
511
512 Circulation
513 ^^^^^^^^^^^
514
515 * Fixes an issue that prevented the offline patron registration
516 screen from loading.
517 * Fixes an issue with searching patrons by permission group.
518 * The barcodes in the patron search are now clickable.
519 * Staff members can now manually override the patron juvenile
520 flag value, regardless of the patron's date of birth.
521 * Checkboxes on patron registration screen are now properly aligned
522 with other fields.
523 * The user permission group dropdowns in the patron registration,
524 edit, and search interfaces now have scrollbars.
525 * The date picker on the checkout screen is now hidden unless
526 circ staff activates a specific due date option.
527 * The check-in screen now includes a copy status column.
528 * The Merge Patrons interface now displays the date of birth.
529 * The user bucket screen now displays the Bucket ID.
530 * The payment button on patron bills screen is now inactive if the
531 Payment Received field is blank.
532 * The Bill History receipt now includes a Finish date and a Last
533 Payment date.
534 * When a patron summary contains an image of the patron,
535 that image tag now has a null alt attribute to remove it from
536 the flow of a screen reader.
537 * Corrects an issue that caused the transit dialog to show the
538 wrong branch.
539 * Corrects an issue with printing transit lists.
540 * "Find another target" on transiting hold no longer leaves the 
541 copy "in-transit".
542 * The images now display to distinguish hold and transit slips.
543 * The Clearable Holds list printout now only shows holds that have
544 expired.
545 * Restores the call number prefix and suffix fields to the holds
546 pull list.
547 * The documentation at the top of the hold shelf slip template
548 adds `patron.alias`.
549 * The cursor in the in-house use screen now automatically goes
550 to the barcode field.
551 * The in-house use screen now shows a copy status column.
552 * Add support for converting change to patron credit in the patron bills
553 interface, consistent with the XUL feature.
554 * Fixes a bug that caused pickup/request library fields to be
555 blank sometimes.
556 * Fixes a bug in the offline org unit tree.
557
558 Command-line system administration
559 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
560
561 * The novelist entry in `eg_vhost.conf` includes two new
562 parameters.
563 * Corrects an issue with the `--max-sleep` argument on the
564 `action_trigger_runner.pl` support script.
565 * Corrects an issue with how the `eg_pbx_allocator.pl` script
566 detects an existing lock file.
567 * The 3.0.2-3.0.3 upgrade script disables triggers before
568 recalculating bib visibility.
569
570 Public catalog
571 ^^^^^^^^^^^^^^
572
573 * Fixes an issue that caused records with located URIs to be
574 retrieved in Copy Location and Copy Location Group searches.
575 * Fixes an error message that appeared in the search box
576 in the public catalog while placing hold after an advanced search.
577 * Restores the display of copy information for the user's
578 preferred library in the public catalog.
579 * Author and contributor names are no longer highlighted in 
580 search results when the user has turned off highlighting.
581 * Fixes regression errors in the search results page.
582 * Removes redundant call numbers from the Show More Details
583 search results.
584 * The cast field in the catalog is now taken from the 511 field
585 when first indicator = 1, rather than the 508.
586 * Fixes a display issue caused by editing holds.
587 * Repairs broken author search links on the catalog record page.
588
589 Serials
590 ^^^^^^^
591
592 * Fixes an issue that prevented users from searching for
593 receivable issues using Database ID or ISSN in the Serials
594 Batch Receive interface.
595
596 General
597 ^^^^^^^
598 * Pins AngularJS support to version 1.6, which prevents unsupported
599 AngularJS versions (such as 1.7) from breaking the build process.
600 * Adds some padding to the bottom of Web Client interfaces.
601 * Logins now honor all org unit timeout settings.
602 * Evergreen will now identify and handle invalid timezones.
603 * Fixes an issue where a column header in some interfaces were automatically
604 highlighted in green when retrieving the interface.
605 * The parts column in the Item Status screen now displays parts data.
606
607
608 Acknowledgements
609 ~~~~~~~~~~~~~~~~
610 We would like to thank the following individuals who contributed code,
611 tests and documentation patches to the 3.1.2 point release of
612 Evergreen:
613
614 * John Amundson
615 * Jason Boyer
616 * Galen Charlton
617 * Garry Collum
618 * Dawn Dale
619 * Jeff Davis
620 * Bill Erickson
621 * Lynn Floyd
622 * Rogan Hamby
623 * Kyle Huckins
624 * Sam Link
625 * Jeanette Lundgren
626 * Kathy Lussier
627 * Katie G. Martin
628 * Terran McCanna
629 * Michele Morgan
630 * Dan Pearl
631 * Mike Rylander
632 * Laura Sachjen
633 * Jane Sandberg
634 * Chris Sharp
635 * Ben Shum
636 * Remington Steed
637 * Jason Stephenson
638 * Josh Stompro
639 * Cesar Velez
640 * Dan Wells
641 * Bob Wicksall
642
643
644
645 Evergreen 3.1.1
646 ---------------
647 This release contains bug fixes improving on Evergreen 3.1.0.
648
649 * Fixes a performance issue with the Patron Billing History screen and
650 other screens that cause Flattener.pm to re-create joins
651 unnecessarily.
652 * Fixes an issue that prevented patron alerts from showing to staff at
653 other libraries.
654 * Corrects the "Holdable" attribute display on the Item Status detailed
655 view.
656 * Fixes the ability to delete multiple copies from Item Status.
657
658 Acknowledgements
659 ~~~~~~~~~~~~~~~~
660 We would like to thank the following individuals who contributed code,
661 tests and documentation patches to the 3.1.1 point release of
662 Evergreen:
663
664 * Jason Boyer
665 * Bill Erickson
666 * Morkor Quarshie
667 * Jane Sandberg
668 * Remington Steed
669 * Jason Stephenson
670 * Kevin Tran
671 * Dan Wells
672
673
674 3.1.0 Upgrade Notes
675 -------------------
676 Like many major Evergreen upgrades, 3.1 requires a full reingest of your
677 bibliographic records before the system is usable again.  While a basic reingest
678 is included at the end of the upgrade script, it happens after the main
679 COMMIT, so it is safe to cancel that and run the required reingest as you see
680 fit (e.g. via pingest.pl).
681
682
683 3.1.0 New Features
684 ------------------
685
686 Administration
687 ~~~~~~~~~~~~~~
688
689 New Latency Tester Tool
690 ^^^^^^^^^^^^^^^^^^^^^^^
691 The Evergreen Web Staff Client now includes a section called *Tests* linked from
692 *Administration -> Workstation*. The *Tests* page houses a simple tool
693 that can be used to test the latency of the websocket connection between the
694 client and the server (via the `opensrf.echo` service).
695
696 This page displays which Evergreen host server is being queried. Upon hitting
697 the blue "Start Test" button for the first time, it will issue 10 sequentially
698 fired requests in order to get a solid initial average. Clicking the button a
699 second time will take one more measurement and recalculate the average
700 latency. The results can be copied to clipboard for troubleshooting purposes
701 and also cleared from display.
702
703 marc_export --uris option
704 ^^^^^^^^^^^^^^^^^^^^^^^^^
705 The marc_export support script now has a `--uris` option (short form:
706 `-u`) to export records with located URIs (i.e. electronic resources).  When
707 used by itself, it will export only records that have located URIs.  When
708 used in conjunction with `--items`, it will add records with located URIs
709 but no items/copies to the output.  If combined with a `--library` or
710 `--descendants` option, this option will limit its output to those
711 records with URIs at the designated libraries.  The best way to use
712 this option is in combination with the `--items` and one of the
713 `--library` or `--descendants` options to export *all* of a library's
714 holdings both physical and electronic.
715
716
717 Architecture
718 ~~~~~~~~~~~~
719
720 Sample Data Includes Surveys
721 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
722 The Concerto sample data set now includes patron surveys, questions,
723 answers, and responses.
724
725 Virtual Index Definitions
726 ^^^^^^^^^^^^^^^^^^^^^^^^^
727 The practical purpose of Virtual Index Definitions is to supply an Evergreen
728 administrator with the ability to control the weighting and field inclusion of
729 values in the general keyword index, commonly referred to as "the blob,"
730 without requiring tricky configuration that has subtle semantics, an
731 over-abundance of index definitions which can slow search generally, or the
732 need to reingest all records on a regular basis as experiments are performed
733 and the configuration refined. Significant results of recasting keyword indexes
734 as a set of one or more Virtual Index Definitions will be simpler search
735 configuration management, faster search speed overall, and more practical
736 reconfiguration and adjustment as needed.
737
738 Previously, in order to provide field-specific weighting to
739 keyword matches against titles or authors, an administrator must duplicate many
740 other index definitions and supply overriding weights to those duplicates. This
741 not only complicates configuration, but slows down record ingest as well as
742 search. It is also fairly ineffective at achieving the goal of weighted keyword
743 fields. Virtual Index Definitions will substantially alleviate the need for
744 these workarounds and their consequences.
745
746   * A Virtual Index Definition does not require any configuration for
747 extracting bibliographic data from records, but instead can become a sink for
748 data collected by other index definitions, which is then colocated together to
749 supply a search target made up of the separately extracted data. Virtual Index
750 Definitions are effectively treated as aggregate definitions, matching across
751 all values extracted from constituent non-virtual index definitions.  They can
752 further make use of the Combined class functionality to colocate all values in a
753 class together for matching even across virtual fields.
754
755   * Configuration allows for weighting of constituent index definitions that
756 participate in a Virtual Index Definition. This weighting is separate from the
757 weighting supplied when the index definition itself is a search target.
758
759   * The Evergreen QueryParser driver returns the list of fields actually
760 searched using every user-supplied term set, including constituent expansion
761 when a Virtual Index Definition is searched. In particular, this will facilitate
762 Search Term Highlighting described below.
763
764   * Stock configuration changes make use of pre-existing, non-virtual index
765 definitions mapped to new a Virtual Index Definition that implements the
766 functionality provided by the `keyword|keyword` index definition. The
767 `keyword|keyword` definition is left in place for the time being, until more data
768 can be gathered about the real-world effect of removing it entirely and
769 replacing it with Virtual Index Definition mappings.
770
771   * New system administration functions will be created to facilitate
772 modification of Virtual Index Definition mapping, avoiding the need for a full
773 reingest when existing index definitions are added or removed from a virtual
774 field.
775
776 Increased use of Metabib Display Fields
777 +++++++++++++++++++++++++++++++++++++++
778 We use Metabib Display Fields (newly available in 3.0) to render catalog search
779 results, intermediate metarecord results, and record detail pages. This requires
780 the addition of several new Metabib Display Field definitions, as well as Perl
781 services to gather and render the data.
782
783 We also use more Metabib Display Fields in the client. As a result,
784 bibliographic fields will display in proper case in more client interfaces and
785 in Evergreen reports.
786
787 Interfaces
788 ++++++++++
789 A new AngularJS "MARC Search/Facet Fields" interface has been created to replace
790 the Dojo version, and both have been extended to support Virtual Index
791 Definition data supplier mapping and weighting.
792
793 Settings & Permissions
794 ++++++++++++++++++++++
795 The new Virtual Index Definition data supplier mapping table,
796 `config.metabib_field_virtual_map`, requires the same permissions as the
797 MARC Search/Facet Fields interface: CREATE_METABIB_FIELD, UPDATE_METABIB_FIELD,
798 DELETE_METABIB_FIELD, or ADMIN_METABIB_FIELD for all actions
799
800 Backend
801 +++++++
802 There now exist several new database tables and functions primarily in support
803 of search highlighting. Additionally, the QueryParser driver for Evergreen has
804 been augmented to be able to return a data structure describing how the search
805 was performed, in a way that allows a separate support API to gather a
806 highlighted version of the Display Field data for a given record.
807
808 Default Weights
809 +++++++++++++++
810 By default, the following fields will be weighted more heavily in keyword
811 searches. Administrators can change these defaults by changing the values in the
812  "All searchable fields" virtual index in the "MARC Search/Facet Fields"
813 interface.
814
815   * Title proper
816   * Main title (a new index limited to the words in the 245a)
817   * Personal author
818   * All subjects
819
820 In addition, note indexes and the physical description index will receive
821 less weight in default keyword searches.
822
823 Re-ingest or Indexing Dependencies
824 ++++++++++++++++++++++++++++++++++
825 With the addition and modification of many Index Definitions, a full reingest is
826 recommended.  However, search will continue to work as it did previously
827 for those records that have not yet been reingested. Therefore a slow, rolling
828 reingest is recommended.
829
830 Performance Implications or Concerns
831 ++++++++++++++++++++++++++++++++++++
832 Because the Metabib Display Fields infrastructure will eventually replace
833 functionality that is significantly more CPU-intensive in the various forms of
834 XML parsing, XSLT transformation, XPath calculation, and
835 Metabib Virtual Record construction, it is expected that the overall CPU load
836 will be reduced by this development, and ideally the overall time required to
837 perform and render a search will likewise drop. It is unlikely that the speed
838 increase will be visible to users on a per-search basis, but that search in
839 aggregate will become a smaller consumer of resources.
840
841
842 Cataloging
843 ~~~~~~~~~~
844
845 Track Record Merges
846 ^^^^^^^^^^^^^^^^^^^
847 When 2 or more bib records are merged, all records involved are stamped
848 with a new `merge_date` value.  For any bib record, this field indicates
849 the last time it was involved in a merge.  At the same time, all
850 subordinate records (i.e. those deleted as a product of the merge) are
851 stamped with a `merged_to` value indicating which bib record the source
852 record was merged with.
853
854 In the browser client bib record display, a warning alert now appears
855 along the top of the page (below the Deleted alert) indicating when a
856 record was used in a merge, when it was merged, and which record it was
857 merge with, rendered as a link to the target record.
858
859
860 Circulation
861 ~~~~~~~~~~~
862
863 Alternate Patron Hold Pickup
864 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
865 This feature adds a bit of convenience to a common task: checking out
866 an item on hold to another patron (typically a family member or helper).
867
868 When you checkout the item, you will get a pop-up window with warnings associated
869 with this item.  The "ITEM_ON_HOLDS_SHELF" message is now expanded to
870
871  * Let you know the name of the person who had placed the hold.
872  * Give you the option (in the form of a checkbox) of cancelling the
873    hold placed by the above-named patron.  (Checked = Cancel the hold;
874    Unchecked = Leave the hold in place)
875
876 The initial value of the checkbox is derived from the
877 `circ.clear_hold_on_checkout` organizational setting.
878
879 If the operator has CANCEL_HOLD privilege, then if the checkbox is checked and
880 the checkout is allowed to proceed, the hold will be cancelled with a note that
881 the item was checked out to another patron.
882
883 This feature is available in the browser-based staff client.
884
885 New Patron Billing Statement
886 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
887 The Evergreen web staff client now includes a patron billing statement,
888 which summarizes a patron's bills, credits and payments in a familiar
889 layout.  This can be found on the "Statement" tab of the Patron Bill
890 Details page. (From the Patron Bills page, double-click a row to view
891 its details, or choose "Full Details" from the Actions menu.)
892
893 Enhanced Billing Timestamp Support
894 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
895 Previously, billings had to make do with a single timestamp attempting
896 to fill two different roles.  In the case of an overdue fine, the
897 timestamp represented the *end* of the fine period for that billing,
898 while for all other fines, the timestamp was merely the time the bill
899 was created.  This setup generally worked, but not without confusion,
900 and limited our ability to understand and process the data.
901
902 Billings will now have up to three timestamps: a create date, and when
903 applicable, a fine period start and a fine period end.  This clarifies
904 and simplifies things like backdating, retrospective fine generation,
905 account balancing for negative balance avoidance, and billing timeline
906 views.
907
908 Copy Alerts and Suppression Matrix
909 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
910 The Copy Alerts feature allows library staff to add customized alert
911 messages to copies. The copy alerts will appear when a specific event
912 takes place, such as when the copy is checked in, checked out, or
913 renewed. Alerts can be temporary or persistent: temporary alerts will be
914 disabled after the initial alert and acknowledgement from staff, while
915 persistent alerts will display each time the alert event takes place.
916 Copy Alerts can be configured to display at the circulating or owning
917 library only or, alternatively, when the library at which the alert
918 event takes place is not the circulating or owning library.  Copy Alerts
919 can also be configured to provide options for the next copy status that
920 should be applied to an item.  Library administrators will have the
921 ability to create and customize Copy Alert Types and to suppress copy
922 alerts at specific org units.
923
924 Copy alerts can be added via the volume/creator and the check in,
925 check out, and renew pages.  Copy alerts can also be managed at the
926 item status page.
927
928 Copy alert types can be managed via the Copy Alert Types page in
929 Local Administration, and suppression of them can be administered
930 via the Copy Alert Suppression page under Local Administration.
931
932 Place Multiple Holds At Once
933 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
934 Users with the appropriate permissions now have the ability to place multiple
935 title/metarecords holds at once. This feature is especially beneficial for book
936 clubs and reading groups, which need to place holds on multiple copies of a
937 title.
938
939 In order to use the feature:
940
941   * Set the _Maximum number of duplicate holds allowed_ Library Setting
942     (`circ.holds.max_duplicate_holds`) to a number higher than 1
943   * Log in as a user with the CREATE_DUPLICATE_HOLDS
944
945 When placing a title or metarecord hold, a _Number of copies_ field will
946 display for these users. This field is not available when placing part, volume
947 or copy holds.
948
949 This feature does not change the way in which the system fills holds. The
950 multiple holds will fill in the same way that they would if the user had placed
951 multiple holds separately.
952
953 New Notice Columns in Items Out Grid
954 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
955 The grid in the patron "items out" page in the Evergreen web staff client has two new
956 columns indicating the number of notifications generated for a given loan and the date of
957 the most recent notification. These columns will allow circulation staff to better respond to
958 patron questions about whether they were sent notification about an overdue item.
959
960 The columns are based on the number of completed Action Trigger events on the
961 loan that have a 'checkout.due' hook. In other words, they would include overdue
962 and courtesy notices.
963
964 A new library setting, "Exclude Courtesy Notices from Patrons Itemsout Notices Count",
965 if set will cause the notice count and date fields to exclude courtesy notices.
966
967 Patron Email Addresses Now Clickable In Web Staff Client
968 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
969 Adds a mailto link to the patron's email in their profile so it can
970 be clicked to send and email to the patron. No new settings or
971 permissions are included in this feature.
972
973 Pickup Library for Staff-placed Holds
974 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
975 Adds a new library setting, _circ.staff_placed_holds_fallback_to_ws_ou_,
976 that helps determine the hold pickup library in cases where patrons don't
977 have a preferred hold pickup library in their account and a staff member
978 is placing the hold on their behalf.
979
980   * When this setting is true and the patron doesn't have a preferred
981   library listed, the hold pickup library will default to the
982   workstation's organizational unit.
983   * When this setting is false and the patron doesn't have a preferred
984   library listed, the hold pickup library will default to the
985   patron's home library.
986
987 Public Catalog
988 ~~~~~~~~~~~~~~
989
990 Search Term Highlighting
991 ^^^^^^^^^^^^^^^^^^^^^^^^
992 Evergreen now highlights search terms on the public catalog's main search
993 results page, the record detail page, and intermediate pages such as metarecord
994 grouped results page. Highlighting search terms will help the user determine why
995 a particular record (or set of records) was retrieved.
996
997 Highlighting of matched terms uses the same stemming used to accomplish the
998 search, as configured per field and class.
999
1000 This feature will help the user more quickly determine the relevance of a
1001 particular record by calling their attention to search terms in context. Lastly,
1002 it will help familiarize the user with how records are searched, including which
1003 fields are searched as well as exposing concepts like stemming.
1004
1005 You can turn off search term highlighting by uncommenting the line
1006 `search.no_highlight = 1;` in `config.tt2`.
1007
1008 When highlighting is generally enabled, it may be turned on or off on a per-page
1009 basis through the use of a UI component which will request the page again
1010 without highlighting.
1011
1012 Highlighting of terms uses Template::Toolkit-driven CSS. A generic CSS class
1013 identifying a highlighted term, along with CSS classes identifying the search
1014 class and each search field are available for use for customization of the
1015 highlighting. A stock CSS template is provided as a baseline upon which sites
1016 may expand.
1017
1018
1019 Copy Location Filter Displays for System Searches
1020 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1021 The Shelving Location filter now displays on the advanced search page when
1022 a search is scoped to a library system, not just to an individual branch. If
1023 a library system is selected as the Search Library, the shelving location
1024 limiter will display any shelving location that is owned by the selected system
1025 or by the consortium. It will NOT display shelving locations owned by child
1026 branches.
1027
1028 Multi-source Attributes
1029 ^^^^^^^^^^^^^^^^^^^^^^^
1030 We now allow record attribute definitions to extract data using more than
1031 one strategy (XPath, tag+subfield, fixed field, etc.) as long as the values
1032 from various sources would, after normalization, have the same shape.
1033
1034 Multilingual Search
1035 +++++++++++++++++++
1036 This change allows us to configure multilingual search, by extracting values
1037 from both the 008 controlfield and the 041 datafield.  Because the values
1038 in each can be normalized to the same controlled list (and, in practice, are
1039 already from the same normalized value set), catalog searches can now use normal
1040 boolean search semantics to find records with various combinations of
1041 language attributes.
1042
1043 E.g., in the concerto test data:
1044
1045   * `keyword: piano item_lang(eng) item_lang(ita)`
1046
1047
1048 Optional Display of Badges in Catalog
1049 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1050 A new setting controls whether badges (popularity, etc.) are displayed
1051 in the catalog. If you do not wish badges to be displayed, set the
1052 `ctx.hide_badge_scores` setting to "true" in `config.tt2`.
1053
1054
1055 Miscellaneous
1056 ~~~~~~~~~~~~~
1057
1058 Fixes to patron name/username search indexes
1059 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1060 When using pg_restore to restore an Evergreen database, some of the
1061 indexes used to speed up patron searches on names and usernames
1062 could be lost.
1063
1064 This release fixes the underlying issue and re-creates the indexes
1065 in question.
1066
1067 Details
1068 +++++++
1069 When using pg_restore to restore an affected database, the
1070 "unaccent" indexes on actor.usr would not be created due to an
1071 unqualified function reference in `evergreen.unaccent_and_squash`.
1072
1073 The function will be replaced to resolve the search path issue,
1074 and the following indexes on actor.usr will be dropped and then
1075 re-created:
1076
1077   * actor_usr_first_given_name_unaccent_idx;
1078   * actor_usr_second_given_name_unaccent_idx;
1079   * actor_usr_family_name_unaccent_idx;
1080   * actor_usr_usrname_unaccent_idx;
1081
1082 This will be done even if the indexes are already present, and may
1083 take a few minutes on a database with many patrons.
1084
1085
1086 3.1.0 Acknowledgments
1087 ---------------------
1088 The Evergreen project would like to acknowledge the following
1089 organizations that commissioned developments in this release of
1090 Evergreen:
1091
1092 * Albany Public Library (Oregon)
1093 * Consortium of Ohio Libraries
1094 * CW MARS
1095 * Indiana State Library
1096 * Georgia Public Library Service
1097 * Hagerstown - Jefferson Township Library
1098 * Linn-Benton Community College
1099 * MassLNC
1100 * Pennsylvania Integrated Library System
1101 * Sage Library System
1102 * Union County Public Library (Indiana)
1103
1104 We would also like to thank the following individuals who contributed
1105 code, translations, documentations patches and tests to this release of
1106 Evergreen:
1107
1108 * Eva Cerninakova
1109 * Andi Chandler
1110 * Galen Charlton
1111 * Jeff Davis
1112 * Bill Erickson
1113 * Jeff Godin
1114 * Rogan Hamby
1115 * Angela Kilsdonk
1116 * Sam Link
1117 * Jeanette Lundgren
1118 * Kathy Lussier
1119 * Fares Othman
1120 * Dan Pearl
1121 * Mike Rylander
1122 * Jane Sandberg
1123 * Chris Sharp
1124 * Ben Shum
1125 * Remington Steed
1126 * Jason Stephenson
1127 * Kevin Tran
1128 * Cesar Velez
1129 * Dan Wells
1130
1131
1132 We also thank the following organizations whose employees contributed
1133 patches:
1134
1135 * Bibliomation
1136 * British Columbia Libraries Cooperative
1137 * Calvin College
1138 * CW MARS
1139 * Equinox Open Library Initiative
1140 * Georgia Public Library Service
1141 * Greater Clarks Hill Regional Library System
1142 * Jordanian Library and Information Association
1143 * King County Library System
1144 * Knihovna Jabok
1145 * Linn-Benton Community College
1146 * MassLNC
1147 * Sigio
1148 * Traverse Area District Library
1149
1150 We regret any omissions.  If a contributor has been inadvertently
1151 missed, please open a bug at http://bugs.launchpad.net/evergreen/
1152 with a correction.