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