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