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