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