648c2b40ef77e177322fefd62215edc6c76d0927
[Evergreen.git] / docs / RELEASE_NOTES_3_0.adoc
1 Evergreen 3.0 Release Notes
2 ===========================
3 :toc:
4 :numbered:
5
6 Evergreen 3.0.10
7 ----------------
8 This release contains bug fixes improving on Evergreen 3.0.9.  Note that
9 all bug fixes refer to the web staff client unless otherwise specified.
10
11 Bug fixes
12 ~~~~~~~~~
13
14 * Fixes right-click issues with the Web client grids
15 * Fixes an issue with the Default SMS Carrier in the patron edit form.
16 * Fixes an issue that allowed overdue notices to be sent to a patron
17 whose long overdue item has been paid for.
18 * Checking in precat items now displays the "Route to Cataloging" alert each
19 time the item is checked in.
20 * Fixes an issue in which the Adjust to Zero feature
21 does not close a checked-in lost circ.
22 * Deleted copies that are still checked out can now be checked in.
23 * Fixes a mislabeled column in the patron checkout grid.
24 * Fixes an error with the missing pieces functionality.
25 * Courier codes now display in the transit slip receipt preview.
26 * The Item Status grid now displays OU shortnames instead of full names
27 for the "Circulation Library" column.
28 * The Volume/Copy editor now allows users to remove a value from the Age
29 Hold Protection field.
30 * Barcode completion now works in copy buckets.
31 * The Z39.50 interface now notices when another record has been marked
32 for overlay.
33 * Fixes a display issue for the Remove MARC Field Groups checkboxes in
34 the Z39.50 interface.
35 * Fixes a performance issue for the Validate button in the MARC Editor.
36 * Fixes an incorrect close tag in the Print Item Labels toolbar.
37 * Better scoping of copy tags in search results.
38 * Electronic Resource links now open in a new tab.
39 * Fixes an issue with the fiscal year close-out operation.
40
41 Acknowledgements
42 ~~~~~~~~~~~~~~~~
43 We would like to thank the following individuals who contributed code,
44 tests and documentation patches to the 3.0.10 point release of
45 Evergreen:
46
47 * A. Bellenir
48 * Adam Bowling
49 * Jason Boyer
50 * Galen Charlton
51 * Garry Collum
52 * Jeff Davis
53 * Bill Erickson
54 * Kathy Lussier
55 * Terran McCanna
56 * Michele Morgan
57 * Jennifer Pringle
58 * Mike Rylander
59 * Jane Sandberg
60 * Chris Sharp
61 * Jason Stephenson
62 * Cesar Velez
63 * Dan Wells
64
65
66
67 Evergreen 3.0.9
68 ---------------
69 This release contains bug fixes improving on Evergreen 3.0.8.  Note that
70 all bug fixes refer to the web staff client unless otherwise specified.
71
72 Bug fixes
73 ~~~~~~~~~
74
75 * Fixes specific cases in which deleted records appear in search results.
76 * Fixes a performance issue with deleting patrons.
77 * The hold shelf dialog popup now lists the patron's notification
78 preferences.
79 * Fixes an issue that prevented editing items when a monograph part
80 is present.
81 * Patron information is now available for use in the bills_current
82 and bills_historical receipt templates.
83 * The browser's "This page may contain unsaved data" warning now 
84 appears when users click the update
85 expire date button in a patron account and attempt to navigate away
86 without saving.
87 * The holds tab of the patron record now includes a monograph part
88 column.
89 * The barcode box in the checkout screen
90 no longer hovers above patron record tabs when
91 staff users scroll down.
92 * Fixes an issue with the date of birth in the patron edit scren.
93 * Fixes an issue with the dropdown of billing type options.
94 * The Item Status screen now includes as a floating group column.
95
96 Acknowledgements
97 ~~~~~~~~~~~~~~~~
98 We would like to thank the following individuals who contributed code,
99 tests and documentation patches to the 3.0.9 point release of
100 Evergreen:
101
102 * BC Libraries Cooperative
103 * A. Bellenir
104 * Jason Boyer
105 * Galen Charlton
106 * Garry Collum
107 * Bill Erickson
108 * Blake Graham-Henderson
109 * Jeanette Lundgren
110 * Kathy Lussier
111 * Terran McCanna
112 * Michele Morgan
113 * Dan Pearl
114 * Mike Rylander
115 * Geoff Sams
116 * Jane Sandberg
117 * Chris Sharp
118 * Remington Steed
119 * Jason Stephenson
120 * Cesar Velez
121
122
123 Evergreen 3.0.8
124 ---------------
125 This release contains bug fixes improving on Evergreen 3.0.7.  Note that
126 all bug fixes refer to the web staff client unless otherwise specified.
127
128 Bug fixes
129 ~~~~~~~~~
130
131 Cataloging
132 ^^^^^^^^^^
133
134 * The MARC editor now handles 008 fields better.
135 * Adds spaces between subfields when suggesting a call
136 number for a new volume.
137 * MarcXML exports from the MARC Batch Import/Export ->
138 Export Records screen now downloads the file, rather than opening
139 it in the browser.
140 * The Item Status Circulation Library column now displays a 
141 shortname rather than the full library name.
142 * The Item Status Remaining Renewals column now displays
143 correctly.
144 * The Item Status now has a "Last Renewal Workstation" column
145 available.
146 * Fixes the circulation counts displayed in Item Status Details.
147 * Fixes an issue where multiple copies with different values for required
148 statistical categories could not be edited and saved in batch.
149 * Add an option to remove floating in the copy editor.
150 * Fixes an issue with the floating dropdown in the copy editor.
151 * Fixes a problem in which the copy template didn't properly copy
152 certain objects.
153 * Reduces the number of API calls that the MARC Editor requires.
154
155 Circulation
156 ^^^^^^^^^^^
157
158 * Fixes an issue that prevented the offline patron registration
159 screen from loading.
160 * Fixes an issue with searching patrons by permission group.
161 * The barcodes in the patron search are now clickable.
162 * Staff members can now manually override the patron juvenile
163 flag value, regardless of the patron's date of birth.
164 * Checkboxes on patron registration screen are now properly aligned
165 with other fields.
166 * The user permission group dropdowns in the patron registration,
167 edit, and search interfaces now have scrollbars.
168 * The date picker on the checkout screen is now hidden unless
169 circ staff activates a specific due date option.
170 * The check-in screen now includes a copy status column.
171 * The Merge Patrons interface now displays the date of birth.
172 * The user bucket screen now displays the Bucket ID.
173 * The payment button on patron bills screen is now inactive if the
174 Payment Received field is blank.
175 * The Bill History receipt now includes a Finish date and a Last
176 Payment date.
177 * When a patron summary contains an image of the patron,
178 that image tag now has a null alt attribute to remove it from
179 the flow of a screen reader.
180 * Corrects an issue that caused the transit dialog to show the
181 wrong branch.
182 * Corrects an issue with printing transit lists.
183 * "Find another target" on transiting hold no longer leaves the 
184 copy "in-transit".
185 * The images now display to distinguish hold and transit slips.
186 * The Clearable Holds list printout now only shows holds that have
187 expired.
188 * Restores the call number prefix and suffix fields to the holds
189 pull list.
190 * The documentation at the top of the hold shelf slip template
191 adds `patron.alias`.
192 * The cursor in the in-house use screen now automatically goes
193 to the barcode field.
194 * The in-house use screen now shows a copy status column.
195 * Add support for converting change to patron credit in the patron bills
196 interface, consistent with the XUL feature.
197 * Fixes a bug that caused pickup/request library fields to be
198 blank sometimes.
199 * Fixes a bug in the offline org unit tree.
200
201 Command-line system administration
202 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
203
204 * The novelist entry in `eg_vhost.conf` includes two new
205 parameters.
206 * Corrects an issue with the `--max-sleep` argument on the
207 `action_trigger_runner.pl` support script.
208 * Corrects an issue with how the `eg_pbx_allocator.pl` script
209 detects an existing lock file.
210 * The 3.0.2-3.0.3 upgrade script disables triggers before
211 recalculating bib visibility.
212
213 Public catalog
214 ^^^^^^^^^^^^^^
215
216 * Fixes an issue that caused records with located URIs to be
217 retrieved in Copy Location and Copy Location Group searches.
218 * Fixes an error message that appeared in the search box
219 in the public catalog while placing hold after an advanced search.
220 * Restores the display of copy information for the user's
221 preferred library in the public catalog.
222 * Fixes regression errors in the search results page.
223 * Removes redundant call numbers from the Show More Details
224 search results.
225 * The cast field in the catalog is now taken from the 511 field
226 when first indicator = 1, rather than the 508.
227 * Fixes a display issue caused by editing holds.
228
229 Serials
230 ^^^^^^^
231
232 * Fixes an issue that prevented users from searching for
233 receivable issues using Database ID or ISSN in the Serials
234 Batch Receive interface.
235
236 General
237 ^^^^^^^
238
239 * Adds some padding to the bottom of Web Client interfaces.
240 * Logins now honor all org unit timeout settings.
241 * Evergreen will now identify and handle invalid timezones.
242 * Fixes an issue where a column header in some interfaces were automatically
243 highlighted in green when retrieving the interface.
244 * The parts column in the Item Status screen now displays parts data.
245
246
247
248 Acknowledgements
249 ~~~~~~~~~~~~~~~~
250 We would like to thank the following individuals who contributed code,
251 tests and documentation patches to the 3.0.8 point release of
252 Evergreen:
253
254 * John Amundson
255 * Jason Boyer
256 * Galen Charlton
257 * Garry Collum
258 * Dawn Dale
259 * Jeff Davis
260 * Bill Erickson
261 * Lynn Floyd
262 * Rogan Hamby
263 * Kyle Huckins
264 * Sam Link
265 * Jeanette Lundgren
266 * Kathy Lussier
267 * Katie G. Martin
268 * Terran McCanna
269 * Michele Morgan
270 * Dan Pearl
271 * Mike Rylander
272 * Laura Sachjen
273 * Jane Sandberg
274 * Chris Sharp
275 * Ben Shum
276 * Remington Steed
277 * Jason Stephenson
278 * Josh Stompro
279 * Cesar Velez
280 * Dan Wells
281 * Bob Wicksall
282
283
284 Evergreen 3.0.7
285 ---------------
286 This release contains bug fixes improving on Evergreen 3.0.6.
287
288 * Fixes a performance issue with the Patron Billing History screen and
289 other screens that cause Flattener.pm to re-create joins
290 unnecessarily.
291 * Fixes an issue that prevented patron alerts from showing to staff at
292 other libraries.
293 * Corrects the "Holdable" attribute display on the Item Status detailed
294 view.
295 * Fixes the ability to delete multiple copies from Item Status.
296
297 Acknowledgements
298 ~~~~~~~~~~~~~~~~
299 We would like to thank the following individuals who contributed code,
300 tests and documentation patches to the 3.0.7 point release of
301 Evergreen:
302
303 * Jason Boyer
304 * Bill Erickson
305 * Morkor Quarshie
306 * Remington Steed
307 * Jason Stephenson
308 * Kevin Tran
309 * Dan Wells
310
311
312 Evergreen 3.0.6
313 ---------------
314 This release is a security release that fixes cross-site scripting
315 (XSS) vulnerabilities in the Evergreen public catalog. This release
316 also includes several other bugfixes improving on Evergreen 3.0.5.
317
318 Security Issue: XSS Vulnerability in Public Catalog
319 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
320 This release fixes several cross-site scripting (XSS) vulnerabilities
321 in the public catalog. When upgrading, Evergreen administrators should
322 review whether any of the following templates have been customized
323 or overridden. If so, either the template should be replaced with the
324 stock version or the XSS fix (which entails adding the `| html` filter
325 in several places) applied to the customized version.
326
327 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
328 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
329 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
330
331 Note that exploiting the XSS vulnerabilities fixed in this release
332 would require either the ability to create maliciously-constructed
333 MARC bibliographic or holdings records or the ability to set a
334 maliciously constructed organizational unit name.
335
336 Other Bugfixes
337 ~~~~~~~~~~~~~~
338 Evergreen 3.0.6 also includes the following changes:
339
340 * When using 'Selection Lists -> Edit MARC Order Record' in the web
341   staff client, now only one click is required to save the MARC
342   record rather than two.
343 * The volume/copy editor in the web staff client now better handles
344   editing multiple items that have different sets of statistical
345   category values assigned to them.
346 * The act of merging bibliographic records now updates bookbags
347   that referred to the source bibliographic record rather than
348   effectively deleting entries for that record.
349 * Additional columns were added to the Holds Pull List in the
350   web staff client.
351 * The patron registration form in the web staff client now correctly
352   manages setting user preferences.
353 * An error in a pgTAP unit test was corrected.
354
355 Acknowledgements
356 ~~~~~~~~~~~~~~~~
357 We would like to thank the following individuals who contributed code,
358 tests and documentation patches to the 3.0.6 security release of
359 Evergreen:
360
361 * Galen Charlton
362 * Bill Erickson
363 * Rogan Hamby
364 * Kathy Lussier
365 * Terran McCanna
366 * Andrea Neiman
367 * Mike Rylander
368 * Dan Scott
369 * Chris Sharp
370 * Cesar Velez
371
372 Evergreen 3.0.5
373 ---------------
374 This release contains bug fixes improving on Evergreen 3.0.4.
375
376 * The MARC Editor in the Web staff client now wraps long fields.
377 * The MARC Editor no longer allows catalogers to enter new lines
378 into MARC subfields.
379 * Fixes an issue that prevented serials items from being deleted or
380 modified.
381 * The Web staff client Check In screen no longer reloads the whole
382 page multiple times each time an item is scanned.
383 * Fixes an issue that displayed the oldest -- rather than the newest
384 -- transit in the Web staff client Item Status page.
385 * Fixes an issue that prevented the reports module from being displayed
386 in the Web client.
387 * Fixes an issue in the Web staff client reports module that caused
388 syntax errors in reports that use virtual fields and joins.
389 * Fixes an issue that prevented several dropdown menus in the Web staff
390 client from activating.
391 * Fixes an issue that created duplicate copy data when copies or
392 volumes with parts were transferred.
393 * Fixes the Trim List feature in the Web staff client Check In screen.
394 * The Item Status grid now displays the Circulation Modifier.
395 * Restores missing data from the Profile column in Place Hold patron
396 search results.
397 * Fixes an issue with the http -> https redirect on Apache 2.4.
398 * Fixes an color contrast accessibility issue in the Web staff
399 client and adds underlining to links in grid cells for added accessibility.
400 * Adds automated regression and unit tests for the Web staff client
401 reports module.
402 * Adds a process for spell-checking the official documentation.
403 * Adds a script that simplifies the release process related to translations.
404
405
406 Acknowledgements
407 ~~~~~~~~~~~~~~~~
408 We would like to thank the following individuals who contributed code,
409 tests and documentation patches to the 3.0.5 point release of
410 Evergreen:
411
412 * Galen Charlton
413 * Jeff Davis
414 * Blake Graham-Henderson
415 * Kathy Lussier
416 * Morkor Quarshie
417 * Mike Rylander
418 * Jane Sandberg
419 * Dan Scott
420 * Chris Sharp
421 * Remington Steed
422 * Jason Stephenson
423 * Kevin Tran
424 * Cesar Velez
425
426
427 Evergreen 3.0.4
428 ---------------
429 This release contains bug fixes improving on Evergreen 3.0.3:
430
431 * Fixes a bug that caused all searches limited by shelving location to
432 return 0 results.
433 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
434 rather than the ordering agency's SAN.
435 * Fixes a bug that prevented Safari/iOS users from logging in to the
436 web client.
437 * Fixes a bug that prevented users from using the browse interface.
438 * Fixes a bug in the Item Status List view that caused incorrect due
439 dates to display.
440 * Approval code is now a required field in the web client's patron
441 credit card payment form.
442 * Fixes a bug with credit card payments that caused a receipt to print
443 showing that the patron paid the bill when the payment had not actually
444 been applied.
445 * Fixes a bug that prevented the EDI translator from being installed on
446 Ubuntu 16.04.
447 * Fixes a bug that caused entries to show up multiple times in the
448 Items Out and Holds tabs in the patron record.
449 * Fixes a bug that caused grids on Bills and Patron Messages
450 screens to not display properly.
451 * The following fields are now available for the Checkout and Items Out
452 receipt templates:
453 ** first_given_name
454 ** second_given_name
455 ** family_name
456 ** suffix
457 ** barcode
458 ** money_summary.balance_owed
459 ** money_summary.total_paid
460 ** money_summary.total_owed
461 ** expire_date
462 ** alias
463 ** has_email
464 ** has_phone
465 * The following fields are now available on the Bill Payment receipt templates:
466 ** first_given_name
467 ** second_given_name
468 ** family_name
469 ** suffix
470 ** barcode
471 ** expire_date
472 ** alias
473 ** has_email
474 ** has_phone
475 * Payment type is now a column in the payments tab of the patron record
476 Bill History section.
477 * The "Replace Barcode" function now makes it more difficult for staff
478 members to attempt to create blank patron barcodes.
479 * The patron bills screen now prevents staff members from double-clicking
480 on the Apply Payment button (which otherwise would apply two payments).
481 * Fixes a bug that prevented patrons attached to statistical categories
482 from displaying in the patron search-to-hold dialog.
483 * Fixes a performance issue related to uploading CSV files of barcodes
484 to the item status and patron bucket interfaces.
485 * Fixes several small bugs in the Spanish translation.
486 * Fixes a performance bug related to patrons logging in by barcode.
487
488 Acknowledgements
489 ~~~~~~~~~~~~~~~~
490 We would like to thank the following individuals who contributed code,
491 tests and documentation patches to the 3.0.4 point release of
492 Evergreen:
493
494 * Jason Boyer
495 * Galen Charlton
496 * Bill Erickson
497 * Jason Etheridge
498 * Kathy Lussier
499 * Terran McCanna
500 * Mike Rylander
501 * Chris Sharp
502 * Ben Shum
503 * Remington Steed
504 * Jason Stephenson
505 * Cesar Velez
506 * Dan Wells
507
508
509 Evergreen 3.0.3
510 ----------------
511 Upgrade Notes
512 ~~~~~~~~~~~~~
513 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
514 update the visibility attributes of all bibs that make use of Located URIs or
515 bib sources. It may take a while to run on large datasets.  If it it running
516 too long, it can be canceled and the following psql commands will create and
517 run a script that will perform the same action serially over time without
518 blocking writes to bibs:
519 ----
520 \t
521 \o /tmp/luri_visibility_update.sql
522 SELECT 'UPDATE biblio.record_entry SET ' ||
523   'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
524   'WHERE id = ' || id || '; SELECT ' || id || ';'
525 FROM biblio.record_entry
526   WHERE id IN (
527             SELECT  DISTINCT cn.record
528               FROM  asset.call_number cn
529               WHERE NOT cn.deleted
530                     AND cn.label = '##URI##'
531                     AND EXISTS (
532                         SELECT  1
533                           FROM  asset.uri_call_number_map m
534                           WHERE m.call_number = cn.id
535                     )
536                 UNION
537             SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
538
539         );
540 \o
541 \t
542 \i /tmp/luri_visibility_update.sql
543 ----
544
545 It will output the id of each updated bib so that the script can be killed
546 and then edited to remove completed bibs.  The remainder can be run at a
547 later time.
548
549 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
550 we do NOT update the bib's visibility attributes, as doing so causes a loop
551 and an eventual trigger stack violation.  This flag should ONLY be used when
552 forcing reingest of record attributes (NOT visibility attributes), search,
553 facet, and display fields, so if using this flag under normal operation,
554 proceed at your own risk and know that Located URI and bib source changes
555 will not be reflected in the visibility attributes of the record.
556
557 Bug Fixes
558 ~~~~~~~~~
559 This release contains several bug fixes improving on Evergreen 3.0.1:
560
561 * Fixes several issues related to the display of located URIs and records with
562 bib sources in search results.
563 * Setting `opac_visible` to false for a copy location group now hides only
564 the location group itself, rather than also hiding every single copy in the
565 group.
566 * Fixes a bug that prevented the copy editor from displaying the _fine level_
567 and _loan duration_ fields.
568 * The "Edit Items" grid action in the Item Status interface will now open
569 in the combined volume/copy editor in batch.  This makes the behavior
570 consistent with the "Edit Selected Items" grid action in the copy
571 buckets interface.
572 * Staff members are now required to choose a billing type when creating a
573 bill on a user account.
574 * The Web client now provides staff users with an alert and option to
575 override when an item with the Lost and Paid status is checked in.
576 * Fixes a bug where the Web client offline circ interface was not able
577 to set its working location.
578 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
579 granted.
580 * The MARC editor in the Web staff client now presents bib sources in
581 alphabetical order.
582 * Both circulation and grocery bills are now printed when a staff user selects
583 a patron account and clicks "Print Bills".
584 * Fixes an issue in the XUL serials interface the "Receive move/selected"
585 action from succeeding.
586 * Fixes a typo in the user password testing interface.
587
588 Acknowledgements
589 ~~~~~~~~~~~~~~~~
590 We would like to thank the following individuals who contributed code,
591 tests and documentation patches to the 3.0.3 point release of
592 Evergreen:
593
594 * Jason Boyer
595 * Bill Erickson
596 * Kyle Huckins
597 * Jeanette Lundgren
598 * Kathy Lussier
599 * Michele Morgan
600 * Mike Rylander
601 * Jane Sandberg
602 * Remington Steed
603 * Cesar Velez
604 * Dan Wells
605
606
607
608 Evergreen 3.0.2
609 ----------------
610 This release contains several bug fixes improving on Evergreen 3.0.1:
611
612 * Copy templates created in XUL Holdings Maintenance will now be
613 automatically converted and displayed in the web staff client's
614 volume/copy editor.
615 * The list of report templates now includes a column indicating whether
616 the template was originally created in the XUL staff client or the web
617 staff client; staff need to know this since report templates created in
618 one interface cannot be edited in the other.
619 * Call number prefixes and suffixes are now displayed in various grids
620 in the web staff client, including
621 ** Pending Copy Buckets
622 ** Copy Buckets
623 ** Checkin/Capture Holds
624 ** Holds Shelf
625 ** Patron Bills History
626 ** Patron Checkout
627 ** Patron Holds
628 ** Patron Items Out
629 ** Copy Editor
630 ** In-House Uses
631 ** Renew Items
632 ** Bib Record View Holds
633 ** Transit List
634 * Many patron fields have been redacted from the web staff client's patron
635 and record holds grids, leaving patron name, username, and ID.
636 * Fixes two bugs where patron records could fail to be saved upon editing.
637 * The web staff patron editor now better warns staff users about
638 duplicate names, IDs, phone numbers, and email addresses.
639 * Human readable labels are now displayed for certain fields in standing
640 penalty records.
641 * The patron summary in the web staff client now correctly displays
642 primary and secondary ID values.
643 * The web staff client's billing full details page now displays
644 information about the staff user that created a payment.
645 * The web staff client now requires staff users to explicitly set a
646 billing type when adding a manual bill.
647 * The web staff client's patron bill annotation modal now works.
648 * Patron barcode search completion in the web staff client now allows
649 the user to select from all of the matching patron records.
650 * The Hold Shelf Slip print template in the web staff client now has
651 access to the call number.
652 * The Checkout Receipt print template in the web staff client now can
653 include summary financial information, incuding current balance, total
654 paid on outstanding fines, and total owed.
655 * The web staff print templates for current and historical bills can
656 now include copy barcode and title.
657 * Fixes a bug that resulted in some catalog searches unexpectedly
658 timing out.
659 * Fixes a bug that resulted in catalog searches that specify a location
660 limit returning incorrect results.
661 * Fixes a bug where deleted copies could make records visible in the
662 public catalog.
663 * Fixes a bug where certain queries on copies used in the public catalog
664 could be very slow.
665 * Fixes a bug place a hold request in the public catalog could result
666 in "forgetting" the type and library of the user's previous search.
667 * The web staff client now respects staff user session timeouts, and
668 will log out all open tabs if a user's session has timed out.
669 * The web staff Z39.50 page will now give the staff user an alert if
670 they attempt to import a record with a duplicate TCN.
671 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
672 entries from being deleted.
673 * Fixes a bug that made using the volume/copy editor to change a copy's
674 price problematic.
675 * The administration interface for hard due dates now ensures that
676 new (or edited) ceiling dates have their time component set to end
677 of day, resolving an issue where ceiling dates would not be applied
678 during the ceiling date itself.
679 * The web staff client can now include dynamic information in browser
680 tab titles, e.g., "Smith, Jane - Checkout".
681 * The Concerto sample data set now includes data allowing for testing
682 placing holds on monographic parts.
683 * Asset merging during bibliographic record merging now correctly
684 recognizes call number prefixes and suffixes and deletes disused
685 call number records.
686 * Fixes a bug where displaying user surveys could result in PCRUD
687 drone starvation.
688 * Fixes a bug where pg_restore of an Evergreen database could fail
689 to create certain indexes on the `actor.usr` table.
690
691 Acknowledgements
692 ~~~~~~~~~~~~~~~~
693 We would like to thank the following individuals who contributed code,
694 tests and documentation patches to the 3.0.2 point release of
695 Evergreen:
696
697 * Andrea Neiman
698 * Alex Cautley 
699 * Angela Kilsdonk 
700 * Ben Shum 
701 * Bill Erickson 
702 * Blake Henderson
703 * Cesar Velez 
704 * Chris Sharp 
705 * Dan Scott 
706 * Dan Wells 
707 * Galen Charlton 
708 * Jane Sandberg 
709 * Jason Boyer 
710 * Jason Stephenson 
711 * Jeanette Lundgren 
712 * Jeff Davis 
713 * Jeff Godin 
714 * Kathy Lussier 
715 * Kyle Huckins 
716 * Michele Morgan 
717 * Mike Rylander 
718 * Remington Steed 
719 * Rogan Hamby 
720 * Skye Howard 
721 * Terra McCanna
722
723 Evergreen 3.0.1
724 ----------------
725 This release contains several bug fixes improving on Evergreen 3.0.0
726
727 * Fixes a bug in the web staff client that prevented initials from being
728 stored with copy notes.
729 * Adds billing types that may have been missed by systems that were 
730 running Evergreen prior to the 1.4 release.
731 * Fixes a web staff client bug with the CSV export option available from
732 the Import Queue in the MARC Batch Import/Export interface.
733 * Adds the missing copy alert field in the web client's volume/copy
734 editor.
735 * Fixes a bug where the setting to require date of birth in patron
736 registration was not being honored in the web staff client.
737 * Fixes a bug in the web staff client patron registration form where the 
738 password wasn't generating from the last four digits of the patron's
739 phone number.
740 * Fixes an issue in the web staff client where the complete barcode did
741 not display in some interfaces when partial barcodes were scanned.
742 * Fixes an HTML error in the new copy tags that display on the record
743 summary page.
744 * Fixes a web staff client bug where recording a large number of in-house
745 uses at one time doesn't display a confirmation dialog once it hits the 
746 correct threshold.
747 * Adds a _Print Full Grid_ action in the web staff client
748 holds pull list to allow staff to print the entire pull list as it
749 displays on the screen. This change also changes the _Export CSV_ action
750 to an _Export Full CSV_ option.
751 * Fixes an issue with the Patron Messages interface that prevented it
752 from saving column configuration changes in the web staff client.
753 * Fixes a bug in the web staff client where a billing prompt did not
754 correctly display after marking an item damaged in those systems that
755 have enabled the setting to bill for damaged items.
756 * Adds an option to the specific due date feature that allows saving
757 that due date until logout. This allows all circulations from a given
758 workstation to be due on the same date. 
759
760 Acknowledgements
761 ~~~~~~~~~~~~~~~~
762 We would like to thank the following individuals who contributed code,
763 tests and documentation patches to the 3.0.1 point release of
764 Evergreen:
765
766 * Jason Boyer
767 * Galen Charlton
768 * Bill Erickson
769 * Kyle Huckins
770 * Jeanette Lundgren
771 * Kathy Lussier
772 * Mike Rylander
773 * Jane Sandberg
774 * Chris Sharp
775 * Ben Shum
776 * Remington Steed
777 * Cesar Velez
778 * Dan Wells
779
780
781
782 3.0.0 Upgrade notes
783 -------------------
784
785 The minimum version of PostgreSQL required to run Evergreen 3.0 is
786 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
787
788 Change to Names of Shared Libraries
789 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
790 OpenSRF 3.0 changes how the shared libraries for services written in
791 C are named.  If upgrading from an earlier version of Evergreen,
792 `opensrf.xml` should be edited so that shared library file names
793 listed in the `<implementation>` tag start with "lib".  For example,
794
795 [source,sh]
796 ---------------------------------------------------------------------
797             <open-ils.cstore>
798                 <language>C</language>
799                 <implementation>oils_cstore.so</implementation>
800 ---------------------------------------------------------------------
801
802 should be changed to:
803
804 [source,sh]
805 ---------------------------------------------------------------------
806             <open-ils.cstore>
807                 <language>C</language>
808                 <implementation>liboils_cstore.so</implementation>
809 ---------------------------------------------------------------------
810
811 SIP Bugfix Requires SIPServer Upgrade
812 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
813
814 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
815 crash" requires that you also upgrade SIPServer with the fix for
816 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
817 SIP client problems."  This means that if you use SIP2 with Evergreen,
818 you must also upgrade SIPServer to the latest commit in the Git
819 repository.  Conversely, if you upgrade SIPServer to the latest commit
820 in Git, you must also upgrade Evergreen or, at least, apply the patch
821 for Launchpad Bug 1542495.  These two patches are complementary and
822 cannot be applied independently of one another.
823
824 `open-ils.auth.login`
825 ~~~~~~~~~~~~~~~~~~~~~
826 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
827 API's in the `opensrf_core.xml` file.
828
829 Sample diff:
830
831 [source,sh]
832 ---------------------------------------------------------------------
833 --- a/Open-ILS/examples/opensrf_core.xml.example
834 +++ b/Open-ILS/examples/opensrf_core.xml.example
835 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
836      <log_protect>
837        <match_string>open-ils.auth.authenticate.verify</match_string>
838        <match_string>open-ils.auth.authenticate.complete</match_string>
839 +      <match_string>open-ils.auth.login</match_string>
840        <match_string>open-ils.auth_proxy.login</match_string>
841        <match_string>open-ils.actor.patron.password_reset.commit</match_string>
842        <match_string>open-ils.actor.user.password</match_string>
843 ---------------------------------------------------------------------
844
845 RTL CSS Stylesheet
846 ~~~~~~~~~~~~~~~~~~
847 Administrators of Evergreen who use RTL locales and who have customized
848 `style-rtl.css.tt2` should now incorporate their customizations into
849 `style.css.tt2`.
850
851 Multi-Time Zone Installations
852 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
853
854 For Evergreen consortia that span more than one time zone, the following
855 query will adjust all historical, unaged circulations so
856 that if their due date field is pushed to the end of the day, it is done
857 in the circulating library's time zone, and not the server time zone.
858
859 It is safe to run this after any change to library time zones.
860
861 Running this is not required, as no code before this change has
862 depended on the time string of '23:59:59'.  It is also not necessary
863 if all of your libraries are in the same time zone, and that time zone
864 is the same as the database's configured time zone.
865
866 [source,sql]
867 ----
868 DO $$
869 declare
870     new_tz  text;
871     ou_id   int;
872 begin
873     for ou_id in select id from actor.org_unit loop
874         for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
875             if new_tz is not null then
876                 update  action.circulation
877                   set   due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
878                   where circ_lib = ou_id
879                         and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
880             end if;
881         end loop;
882     end loop;
883 end;
884 $$;
885 ----
886
887
888 Deprecation of XUL staff client
889 -------------------------------
890 Starting with the release of 3.0.0, patches that fix XUL bugs will not
891 be merged into master or backported unless they meet one or more of
892 the following conditions:
893
894 a. the bug is a security issue
895 b. the bug involves the destruction of data
896 c. the bug is a regression of functionality in the XUL staff client
897    introduced by other work done to Evergreen
898
899 Under no circumstances will XUL staff client feature enhancements be merged.
900
901 This policy will continue through the 3.0.x and 3.1.x maintenance
902 release cycles, and will become moot upon the release of 3.2.0, when
903 the XUL staff client is slated to be entirely removed.
904
905
906 3.0.0 New Features
907 ------------------
908
909 New Staff Client
910 ~~~~~~~~~~~~~~~~
911
912 Evergreen 3.0 features a new, modern staff client that runs in the web browser
913 and can be used on desktop and mobile devices. All functional areas of the 
914 system, including circulation, cataloging, acquisitions, serials, reports,
915 booking, administration, and offline circulation, are available in the new staff 
916 client. Chrome and Firefox are officially supported for use with the web client.
917
918 Library staff will no longer need to download separate software to perform most 
919 actions in Evergreen. A Chrome plugin called Hatch will be available as a 
920 separate installation for workstations that require seamless, dialog-free
921 printing to multiple printers.  
922
923 In addition to adding more portability and stability, the new staff client also
924 presents a cleaner and more modern interface for users. By virtue of running in
925 a browser, actions that users are accustomed to performing on other web sites
926 should now be available in the Evergreen client.
927
928 The old, XUL client will continue to be available to allow for a gradual 
929 transition to the browser-based client, but no new features will be added. The
930 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
931 release.
932
933
934
935 Administration
936 ~~~~~~~~~~~~~~
937
938
939
940 New EDI Order Generator 
941 ^^^^^^^^^^^^^^^^^^^^^^^
942
943 Configuration
944 +++++++++++++
945
946 . New database tables exist for configuring vendor-specific EDI order 
947 attributes.
948
949  * `acq.edi_attr .
950   ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add 
951      GIR segments
952  * `acq.edi_attr_set`
953   ** Collection of `edi_attr`s.  Each edi_account may be linked to one
954      `edi_attr_set`.
955   ** One `edi_attr_set` per known vendor is added to the stock data, matching
956      the stock configuration found in the JEDI template.
957  * `acq.edi_attr_set_map`
958   ** Link between `edi_attr`s and `edi_attr_set`s.
959
960 . EDI Attribute Sets are manged via a new (browser client only) configuration
961   interface at 'Administration -> Acquisitions Administration -> EDI
962   Attribute Sets'.
963
964 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`.  If a link
965   is not set, default values will be used.  Links between an EDI account
966   and an attribute set are managed in the EDI Accounts configuration 
967   interface.
968
969 . Local modifications to the stock EG JEDI template are managed by modifying
970   and/or adding additional `edi_att_set`s as needed.
971
972 . A new `edi_order_pusher.pl` script is added which replaces the functionality
973   of `edi_pusher.pl`.  `edi_pusher.pl` is still available.
974
975 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
976   definition is no longer required and can be disabled.
977
978 Migration
979 +++++++++
980
981 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
982 specifies whether PO's generated via the account should be built using 
983 EDI attributes or fall back to traditional JEDI A/T template generation.
984
985 This allows sites to activate EDI attributes on a per-account basis, making 
986 it possible to migrate piecemeal to EDI attributes.  For the initial roll
987 out of this new feature, no accounts will be configured to use EDI 
988 attributes by default.  
989
990
991
992
993
994 3 Day Courtesy Notice by SMS
995 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
996 New optional SMS text notification to be sent out 3 days prior to the due
997 date of any circulating item for patrons who have an SMS text number and
998 carrier stored in their accounts. This action trigger is disabled by default,
999 but can be enabled and modified by going into 'Administration -> Local Administration ->
1000 Notifications / Action Triggers'.
1001
1002 You may wish to make use of granularity so that these messages are batched
1003 and sent at the same time each day.
1004
1005
1006
1007
1008 Add Description Field to Circulation and Hold Configuration Entries
1009 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1010 The circulation and hold policy configuration rules now each have a
1011 description field. This allows administrators to add comments to
1012 describe the purpose of each rule.
1013
1014
1015
1016
1017 Apache Internal Port Configuration Option
1018 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1019 Apache configuration now supports a new variable which allows admins to
1020 specify the port used by Apache to handle HTTP traffic.  The value is
1021 used for HTTP requests routed from Perl handlers back to the same Apache
1022 instance, like added content requests.  Use this when running Apache
1023 with a non-standard port, typical with a proxy setup.  Defaults to "80".
1024
1025 [source,conf]
1026 -------------------------------------------------------------------
1027 <Location /eg>
1028     ...
1029     PerlSetVar OILSWebInternalHTTPPort "7080"
1030     ...
1031 </Location>
1032 -------------------------------------------------------------------
1033
1034
1035
1036
1037 Configurable Bib Record Display Fields
1038 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1039
1040 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration 
1041 fields: 'Display Field?' and 'Display XPath'.
1042
1043 When 'Display Field' is set to true, data from the field will be extracted
1044 from each record and added to a new table of display data for each bib 
1045 record.  
1046
1047 If a value is present in the 'Display XPath' field, this XPath will be
1048 applied to the extracted data *after* the base XPath (from the 'XPath' 
1049 field) is applied to each field.
1050
1051 This data acts as a replacement for the various and sundry ways bib record 
1052 data is currently extracted, including inline XPath in the TPAC, reporter 
1053 views, real-time 'MVR' compilation from MODS, etc. and will be available
1054 to the user interface, notification templates, etc. for rendering bib 
1055 records.  
1056
1057 The browser client gets a new service 'egBibDisplay' which is capable
1058 of translating the display field data from various formats into 
1059 data more suitable for JavaScript usage.
1060
1061 The database gets 3 new views for representing display data in various
1062 formats:
1063
1064  * `metabib.flat_display_entry`
1065   ** List of all display fields linked to their configuration.
1066  * `metabib.compressed_display_entry`
1067   ** Same as `metabib.flat_display_entry` except there's one row
1068      per display field type, with 'multi' rows compressed into
1069      JSON arrays.  Non-multi fields are represented as JSON 
1070      strings/numbers.
1071  * `metabib.wide_display_entry`
1072   ** Tabular view of display field data, one column per well-known
1073      field.  Values are represented JSON, consistent with 
1074      `metabib.flat_display_entry`.  The view does *not* contain locally
1075      configured display fields, as each field must be encoded in
1076      the view and IDL definition.  This is essentially a replacement 
1077      for `reporter.simple_record`.
1078
1079 Reingesting
1080 +++++++++++
1081
1082 After making changes to display field configuration, it's possible to 
1083 reingest only display field data in the database using the following:
1084
1085 [source,sql]
1086 ---------------------------------------------------------------------
1087 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE, 
1088   (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
1089   FROM biblio.record_entry WHERE NOT deleted AND id > 0;
1090 ---------------------------------------------------------------------
1091
1092
1093
1094
1095
1096 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
1097 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1098 The existing permission was incorrectly created with a code of
1099 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
1100 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`.  This
1101 update changes the permission code to match what the event requires.
1102
1103
1104
1105
1106
1107 Hold Targeter V2 Repairs and Improvements
1108 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1109 * Make the batch targeter more resilient to a single-hold failure.
1110 * Additional batch targeter info logging.
1111 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
1112 * Removes the confusingly named `--target-all` option
1113  ** The same behavior can be achieved by using `--retarget-interval "0s"`
1114 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
1115
1116 New --next-check-interval Option
1117 ++++++++++++++++++++++++++++++++
1118 Specify how long after the current run time the targeter will retarget
1119 the currently affected holds. Applying a specific interval is useful
1120 when the retarget-interval is shorter than the time between targeter
1121 runs.
1122
1123 For example, if the targeter is run nightly at midnight with a
1124 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
1125 since the holds won't be processed again until 48 hours later. This
1126 ensures that the org unit closed date checks are looking at the correct
1127 date. 
1128
1129 This setting overrides the default behavior of calculating the next 
1130 retarget time from the retarget-interval.
1131
1132 New --soft-retarget-interval Option
1133 +++++++++++++++++++++++++++++++++++
1134 This is a replacement for (and rebranding of) the `--skip-viable` option. 
1135 The new option allows for time-based soft-targeting instead simple binary 
1136 on/off soft-targeting.
1137
1138 How soft-targeting works:
1139
1140 * Update hold copy maps for all affected holds
1141 * Holds with viable targets (on the pull list) are otherwise left alone.
1142 * Holds without viable targets are retargeted in the usual manner. 
1143
1144
1145
1146
1147
1148 New marc_export --descendants Option
1149 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1150
1151 The `marc_export` script has a new option, `--descendants`.  This option
1152 takes one argument of an organizational unit shortname.  It works much
1153 like the existing `--library` option except that it is aware of the
1154 org. tree and will export records with holdings at the specified
1155 organizational unit and all of its descendants.  This is handy if you
1156 want to export the records for all of the branches of a system.  You
1157 can do that by specifying this option and the system's shortname,
1158 instead of specifying multiple `--library` options for each branch.
1159
1160 The `--descendants` option can be repeated, as the `--library` option can.
1161 All of the specified org. units and their descendants will be included
1162 in the output.  It can also be combined with individual `--library`
1163 options when necessary.
1164
1165
1166
1167
1168 RTL and LTR Public Catalog Stylesheets Merged
1169 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1170 The RTL stylesheet for the public catalog,
1171 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1172 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1173 template will provide RTL or LTR styles based on the value of
1174 the `rtl` flag of the active locale. An `rtl` variable is also available
1175 in the template to allow the correct style to be chosen.
1176
1177
1178
1179
1180 Miscellaneous Improvements
1181 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1182
1183  * If a filter is in effect in the Library Settings Editor,
1184    the filter will continue to be applied after a user 
1185    changes the selected library.
1186  * Copy templates used for serials now correctly link to age
1187    protection rules and MARC item type values (for the
1188    "Circ as Type" field). During upgrade, the database update
1189    will set to NULL any age protection and circ as type fields
1190    in serial copy templates that do not point to defined values.
1191
1192
1193
1194
1195 Obsolete Internal Flag Removed
1196 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1197
1198 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1199 flag was removed from the `config.internal_flags` table.  It was
1200 rendered obsolete by the addition of the 3 flags to control the
1201 browse, search, and facet indexing.
1202
1203
1204
1205
1206 Tweaks to Caching/Expiry of Public Catalog Assets
1207 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1208 The default cache expiration time for static assets (e.g.,
1209 CSS, image, and JavaScript files) in the public catalog and
1210 the Kid's PAC has been increased to one year. Links to all
1211 such assets now have a cache-busting value tacked on as a
1212 query parameter. This value is refreshed when `autogen.sh` is
1213 run, but it can also be manually set by adjusting the
1214 `ctx.cache_key` Template Toolkit variable.
1215
1216
1217
1218
1219 Action/Trigger Events Data Purging
1220 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1221
1222 Action/Trigger event definitions have a new field called 'Retention 
1223 Interval'.  When an optional interval value is applied, events and
1224 template output data linked to the event definition will be deleted
1225 from the database once they reach the specified age.
1226
1227 Retention Interval Restrictions for Passive Hooks
1228 +++++++++++++++++++++++++++++++++++++++++++++++++
1229
1230 Restrictions are placed on retention interval values for event definitions
1231 using passive hooks to prevent data from being deleted while it's still
1232 needed by the system.
1233
1234 The presence of event data is how the system knows not to send duplicate
1235 events.  As long as a scenario exists where a duplicate event may be
1236 generated, the events must be retained.
1237
1238 To apply a retention interval value to a passive-hook event definition:
1239
1240  * The event definition must have a max_delay value.
1241  * The retention interval must be larger than the difference between
1242    the `delay` and `max_delay` values.
1243
1244 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1245 interval must be greater than 3 days to ensure no duplicate events are 
1246 created between the first event on day 7 and the end of the event validity
1247 window on day 10.
1248
1249 Deployment
1250 ++++++++++
1251
1252 A new `purge_at_events.sh` script is installed in the bin directory
1253 (typically `/openils/bin`) which should be added to CRON for regular
1254 maintenance.
1255
1256 NOTE: On large data sets, this script can take a long time to run and
1257 create higher than normal I/O load as it churns though the event and
1258 event_output tables.  You may wish to run the script by hand the first
1259 time so it can be monitored.  It can be run in psql like so:
1260
1261 [source,sql]
1262 ---------------------------------------------------------------
1263 SELECT action_trigger.purge_events();
1264 ---------------------------------------------------------------
1265
1266 NOTE: On *very* large data sets (10s to 100s of millions of event and
1267 event_output rows), it may be advisable to first repopulate the `event`
1268 and `event_output` tables with only the desired data before starting
1269 regular purges.  This can be done, for example, using the copy to temp
1270 table, truncate source table, repopulate source table from temp table
1271 approach.  This will be much faster than the `purge_events()` function
1272 in cases where most of the data will be purged.
1273
1274 Hook Data Cleanup
1275 +++++++++++++++++
1276
1277 A number of `action_trigger.hook` entries which have always been treated
1278 as active hooks, though are configured as passive hooks, have been 
1279 updated to properly reflect the non-passive-ness.  This allows for 
1280 simpler configuration of their retention interval values.
1281
1282
1283
1284
1285
1286 Remove JSPAC Redirects
1287 ^^^^^^^^^^^^^^^^^^^^^^
1288 Future versions of Evergreen will no longer contain automatic redirects
1289 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1290 that the JSPAC is no longer supported.  Existing sites, however, may
1291 wish to retain JSPAC redirects in their Apache configuration files since
1292 JSPAC URLs may still be used in the wild to access their catalogs.
1293
1294 The original JSPAC URL redirects are all retained in the file 
1295 `Open-ILS/examples/jspac_redirects.conf` for reference.
1296
1297
1298
1299
1300 API
1301 ~~~
1302
1303
1304
1305 New open-ils.auth.login API
1306 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1307 The `open-ils.auth` service has a new API for requesting an authentication
1308 token.  It performs the same steps as the 
1309 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1310 using the bare password.  No intermediate password hashing is required.
1311
1312 The paramaters are the same as the `.complete` call with a few modifications.
1313
1314 1. Using the generic 'identifier' parameter in combination with the
1315    'org' parameter allows the API to reliably determine if an identifier
1316    value is a username or barcode.  The caller is no longer required to 
1317    make that determination up front.  
1318
1319 2. The 'nonce' parameter is no longer used.
1320
1321
1322
1323
1324
1325 Batch Patron Contact Invalidation
1326 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1327 The following methods are used to mark patron contact fields
1328 as invalid by moving the invalid value to a standing penalty:
1329
1330  * `open-ils.actor.invalidate.email`
1331  * `open-ils.actor.invalidate.day_phone`
1332  * `open-ils.actor.invalidate.evening_phone`
1333  * `open-ils.actor.invalidate.other_phone`
1334
1335 These methods now accept a fifth argument specifying the value
1336 of the contact field, e.g., a specific phone number or email
1337 address. If supplied, and if a specific patron ID (the first
1338 argument) is not supplied, all patrons with that specific contact
1339 value will have it marked invalid.
1340
1341
1342
1343
1344 Architecture
1345 ~~~~~~~~~~~~
1346
1347
1348
1349 Pure-SQL catalog searching
1350 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1351 Public and staff catalog search is now both more accurate and faster
1352 by redesigning how the visibility of records is calculated.
1353
1354
1355
1356
1357 Cataloging
1358 ~~~~~~~~~~
1359
1360
1361
1362 Authority Record and Headings Browse Improvements
1363 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1364 Various improvements are made to support for authority records
1365 and headings browsing:
1366
1367  * The MARC to MADS XSLT stylesheet is now used as part of parsing
1368    headings from authority records. Since the MODS and MADS stylesheets
1369    extract headings in similar ways, duplicate browse entries are now
1370    much less likely to occur.
1371  * A new configuration table, `authority.heading_field`, is now used
1372    to specify how headings should be extracted from authority records.
1373  * Related headings can now be identified as narrower or broader when
1374    browsing in the public catalog.
1375  * See references are now more reliably included in the browse list.
1376  * Scope (public) notes now display only under the main heading.
1377  * There is now a global flag, Display related headings (see-also) in browse,
1378    that can be used to control whether related headings (see-alsos) are
1379    displayed in the public catalog list.
1380  * A complete set of thesauruses are now included in the seed data.  Thesauruses
1381    can now be identified using short and long codes.
1382  * The labels for see and see-also references in the public catalog are 
1383    a bit more patron-friendly, and can now be tweaked via TPAC template
1384    customization in the browse.tt2 file.
1385
1386
1387
1388
1389
1390 Copy Tags and Digital Bookplates
1391 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1392 Copy tags will allow staff to apply custom, pre-defined labels or tags
1393 to copies.  Copy tags are searchable in both the staff client and public
1394 catalog.  This feature was designed to be used for Digital Bookplates to
1395 attach donation or memorial information to copies, but may be used for
1396 broader purposes to tag items.
1397
1398 Each copy tag can either be publicly-visible or visible only to staff.
1399 Copy tags also have types that can be used for restricting catalog
1400 searches on copy tags to particular types.
1401
1402 Copy tags are displayed in the copy table in the record summary page in
1403 the public catalog, and a new library setting can be used to add
1404 a "Digital Bookplate" search field.  Copy tags can also be used
1405 as a search filter, e.g.,
1406
1407   * `copy_tag(bookplate, jane smith)`: search for records that have a
1408     copy tag of type 'bookplate' whose value contains 'jane smith'.
1409   * `copy_tag(*, jane smith)`: search for records that have a
1410     copy tag of any type whose value contains 'jane smith'.
1411
1412 All staff-side interfaces related to copy tags exist only in the web
1413 staff client.  There are two new administration interfaces for managing
1414 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1415 button for applying copy tags to copies; that interface can also be
1416 used to create new copy tags on the fly. Furthermore, the copy buckets
1417 interface now has an 'Apply Tags' action for assigning tags to groups
1418 of copies.
1419
1420 Permissions
1421 +++++++++++
1422
1423 Two new permission are included:
1424
1425   * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1426      'Administration -> Server Administration -> Copy Tag Types'
1427   * `ADMIN_COPY_TAG`: required to create a new tag under
1428     'Administration -> Local Administration -> Copy Tags'
1429
1430 The existing permission `UPDATE_COPY` controls whether or not a user
1431 can link copies to tags.
1432
1433 Library Settings
1434 ++++++++++++++++
1435 A new library setting, 'Enable Digital Bookplate Search', controls
1436 whether to display a 'Digital Bookplate' field in the search index
1437 drop-downs in the catalog. A 'Digital Bookplate' search will include
1438 all records that have a copy that matches the tag specified by the user.
1439 It should be noted that this library setting does not affect the
1440 display of copy tags on the catalog record summary page.
1441
1442
1443
1444
1445 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1446 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1447 The call number prefix and suffix, when present, are now included in
1448 subfields $k and $m of the 852 field when running `marc_export` with
1449 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1450 server configured to embed item data in 852 fields, the affixes are now
1451 included in subfields $k and $m.
1452
1453
1454
1455
1456 Circulation
1457 ~~~~~~~~~~~
1458
1459
1460
1461 Batch Editing of Patron Records
1462 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1463 There is a now a new interface analogous to the Copy Bucket interface
1464 to select and group a set of users into a User Bucket.
1465 The addition of users to a User Bucket is possible from the Patron Search
1466 interface by the use of a new grid Action, and directly on the User Bucket
1467 interface by user barcode. It is also possible to add users to a User
1468 Bucket by uploading a text file that contains a list of user barcodes.
1469
1470 From this interface it is possible to perform a set of specific batch update
1471 operations on user records.
1472
1473 Editing Users
1474 +++++++++++++
1475
1476 These fields can now be changed in batch via an action on the User Bucket
1477 grid if the staff user has the `UPDATE_USER` permission:
1478
1479  * Active flag
1480  * Primary Permission Group (group application permissions consulted)
1481  * Juvenile flag
1482  * Home Library (`UPDATE_USER` checked against both old and new value)
1483  * Privilege Expiration Date
1484  * Barred flag (`BAR_PATRON` permission consulted)
1485  * Internet Access Level
1486
1487 Changes made in this interface can be rolled back.
1488
1489 As a batch process, rather than a direct edit, this mechanism explicitly skips
1490 processing of Action/Trigger event definitions for user update.
1491
1492 Deleting Users
1493 ++++++++++++++
1494
1495 The batch edit mechanism also allows for the batch deletion of user.  The staff
1496 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1497
1498 Changes made in this interface can be rolled back.
1499
1500 As a batch process, rather than a direct edit, this mechanism explicitly skips
1501 processing of Action/Trigger event definitions for user deletion.
1502
1503 This mechanism does not use the Purge User functionality, but instead simply
1504 marks the users as deleted.
1505
1506 Editing Statistical Category Entries
1507 ++++++++++++++++++++++++++++++++++++
1508
1509 All users in the bucket can have their Statistical Category Entries
1510 modified. Unlike user data field updates, modification of Statistical
1511 Category Entries is permanent and cannot be rolled back.
1512
1513 As a batch process, rather than a direct edit, this mechanism explicitly skips
1514 processing of Action/Trigger event definitions for user update.
1515
1516 New Service Requirement
1517 +++++++++++++++++++++++
1518
1519 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1520 unused in production.  If this service has been removed from the configuration
1521 of a live Evergreen instances, it will need to be added back in order for
1522 batch user editing to succeed.
1523
1524
1525
1526
1527 Honor Timezone of the Acting Library
1528 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1529
1530 Summary
1531 +++++++
1532
1533 * Display day-granular due dates in the circulating library's timezone.
1534 * Only display the date portion of the due date for day-granular circulations.
1535 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1536 * Provide infrastructure for more advanced formatting of timestamps.
1537 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1538
1539 Details
1540 +++++++
1541
1542 This is a followup to the work done for 2.12, where we added the ability
1543 for the client to specify a timezone in which timestamps should be interpreted
1544 in business logic and the database.
1545
1546 Most specifically, this work focuses on circulation due dates and the closed
1547 date editor. Due dates, where displayed using stock templates (including
1548 receipt templates) and used for fine calculation, are now manipulated in the
1549 library's configured timezone. This is controlled by the new 'lib.timezone'
1550 setting available via the Library Settings Editor, loaded from the server when
1551 required. Additionally, closings are recorded in the library's timezone so that
1552 due date calculation is more accurate. The closed date editor is also
1553 taught how to display closings in the
1554 closed library's timezone. Closed date entries also explicitly record if they
1555 are a full day closing, or a multi-day closing. This significantly simplifies
1556 the editor, and may be useful in other contexts.
1557
1558 To accomplish this, we use the moment.js library and the moment-timezone addon.
1559 This is necessary because the stock AngularJS date filter does not understand
1560 locale-aware timezone values, which are required to support DST. A simple
1561 mapper translates the differences in format values from AngularJS date to
1562 moment.js.
1563
1564 Of special note are a set of new filters used for formatting timestamps under
1565 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1566 filters provide the functionality, and autogrid is enhanced to make use of
1567 these where applicable. egGrid and egGridField are also taught to accept
1568 default and field-specific options for applying date filters. These filters may
1569 be useful in other or related contexts.
1570
1571 The egDueDate filter, used for all existing displays of due date via Angular
1572 code, intentionally interprets timestamps in two different ways WRT timezone,
1573 based on the circulation duration. If the duration is day-granular (that is,
1574 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1575 of seconds) then the date is interpreted as being in the circulation library's
1576 timezone. If it is an hourly loan (any duration that does not meet the
1577 day-granular criterium) then it is instead displayed in the client's timezone,
1578 just as all other timestamps currently are, because of the previous Evergreen
1579 timezone work.
1580
1581 The public catalog is adjusted to always display the due date in the circulating
1582 library's timezone. Because the public catalog displays only the date portion of the due
1583 date field, this difference is currently considered acceptable. If this proves
1584 to be a problem in the future, a minor adjustment can be made to match the
1585 egDueDate filter logic.
1586
1587 Now that due dates are globally stored in the configured timezone of the
1588 circulating library, the automatic adjustment to day-granular due dates needs
1589 to take those timezones into account.
1590
1591 An optional SQL command is provided by the upgrade script to retroactively
1592 adjust existing due dates after library configuration is complete.
1593
1594
1595
1596
1597
1598 Enhancements to Hard Due Date Functionality
1599 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1600 It will now be possible to delete Hard Due Date Values for dates that have
1601 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1602 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1603 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1604
1605
1606
1607
1608 Patron Search by Birth Date
1609 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1610 * Now you can include the patron birth year and/or birth month and/or
1611   birth day when searching for patrons using the web staff client.
1612 * Day and month values are exact matches.  E.g. month "1" (or "01")
1613   matches January, "12" matches December.
1614 * Year searches are "contains" searches.  E.g. year "15" matches 2015,
1615   1915, 1599, etc.  For exact matches use the full 4-digit year.
1616
1617
1618
1619 Patron Search from Place Hold
1620 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1621 This feature allows staff members, when placing a
1622 hold on behalf of a patron in the web staff client, to search for
1623 patrons by names and other searchable patron information, rather than
1624 relying on barcode alone. In particular, after performing a catalog
1625 search or going to a specific bib record and clicking the 'Place Hold'
1626 button, the form now includes a 'Patron Search' button. This button
1627 will open a dialog allowing the staff member search for and select
1628 a patron record.
1629
1630
1631
1632
1633 Retrieve Recent Patrons 
1634 ^^^^^^^^^^^^^^^^^^^^^^^
1635
1636 Adds a new library setting 'Number of Retrievable Recent Patrons' 
1637 ('ui.staff.max_recent_patrons') that specifies the number of recently
1638 retrieved patrons that can be re-fetched from the staff client.
1639
1640 A value of 0 means no recent patrons can be retrieved.
1641 A value greater than 1 means staff will be able to retrieve multiple
1642 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1643
1644 The default value is 1 for backwards compatibility.
1645
1646
1647
1648
1649
1650
1651 Fuller title in XUL client Simplified Pull List
1652 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1653 The Simplified Pull List in the XUL client will now display subfields 245$n and
1654 $p in the title field. The addition will make it easier for staff to distinguish
1655 between different parts or seasons in a series.
1656
1657
1658
1659
1660
1661 Transit Cancel Time and Terminology Change
1662 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1663
1664 Transit Cancel Time
1665 +++++++++++++++++++
1666
1667 Previously, Evergreen deleted canceled (aborted) transits from the database.  Now
1668 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1669 are preserved in the database, though still not visible to the end user in the staff client.
1670 This allows for better tracking of when transits are canceled for the purposes of knowing
1671 which staff member canceled the transit, etc.
1672
1673 NOTE: This change may require the re-creation of transit reports to filter out canceled
1674 transits from the results.  Cloning the template and adding a 'Base Filter' of 'Cancel Time 
1675 Is NULL' will suffice.
1676
1677 "Canceled Transit" Terminology Change
1678 +++++++++++++++++++++++++++++++++++++
1679
1680 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1681 For internal continuity, however, the following permission codes have not changed:
1682
1683  * `ABORT_TRANSIT`
1684  * `ABORT_REMOTE_TRANSIT`
1685  * `ABORT_TRANSIT_ON_LOST`
1686  * `ABORT_TRANSIT_ON_MISSING`
1687
1688
1689
1690
1691 Client
1692 ~~~~~~
1693
1694 Offline Circulation Available in Web Staff Client
1695 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1696 Offline circulation is now available in the web staff client. In order to use the
1697 offline interface, users must first log into the web staff client, perform
1698 a patron search, select a user from the results, and open the patron editor
1699 interface to collect all the relevent configuration information for the 
1700 workstation. In addition, the offline interface available from the Circulation
1701 menu provides a 'Download block list' button for users who are logged in.
1702
1703 As is the case in the old staff client, users can check materials in and out,
1704 renew items, and create new patron accounts while offline. The patron fields
1705 available in the offline patron registration editor are the same ones that
1706 are available to staff when working online.
1707
1708
1709
1710 Add Circ Modifier to Record Detail Page in Staff TPAC
1711 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1712 The circulation modifier field is added to the table of copies to make
1713 more information available to staff without having to open
1714 the Holdings View.
1715
1716
1717
1718
1719
1720 Date+Time Format Settings for Web Client
1721 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1722
1723 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1724 and adds two settings for use with the webstaff client:
1725
1726   * 'Format Dates with this pattern'
1727   * 'Format Date+Time with this pattern'
1728
1729 These settings use format strings as documented here:
1730
1731 https://docs.angularjs.org/api/ng/filter/date
1732
1733 There is overlap with how the Dojo formats worked, but also some differences.
1734
1735 The original 'Format Dates' and 'Format Times' settings worked together, but the
1736 new settings work independently.  Certain field elements will use one, and
1737 certain field elements will use the other.  These distinctions are hard-coded
1738 in the various UI templates, with the idea being that timestamp fields in
1739 which the date component alone is sufficient information (for example, date of birth)
1740 will use the 'Format Dates' setting.  Fields where the time component is
1741 important (for example, checkout time) will use the 'Format Date+Time' setting.
1742
1743 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1744 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1745
1746
1747
1748
1749
1750 Global Option to Remove Sound for a Specific Event
1751 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1752 A new `nosound.wav` file has been added to the web client. The file can be used
1753 to globally disable audio alerts for a specific event on an Evergreen system.
1754
1755 For example, to silence the alert that sounds after a successful patron search:
1756
1757 [source,sh]
1758 ----
1759 mkdir -p /openils/var/web/audio/notifications/success/patron/
1760 cd /openils/var/web/audio/notifications/success/patron/
1761 ln -s ../../nosound.wav by_search.wav
1762 ----
1763
1764
1765 Documentation
1766 ~~~~~~~~~~~~~
1767
1768 The official Evergreen manual has been split into eight new manuals, each
1769 designed for a specific audience. This new approach is designed to make
1770 the documentation more readable and usable.
1771
1772 The specific audiences for the new manuals are:
1773
1774 * Acquisitions staff
1775 * Circulation staff
1776 * Cataloging staff
1777 * Public services staff who use the public catalog
1778 * Serials staff
1779 * System administrators who use the command line
1780 * System administrators who use the Web client
1781 * System administrators and programmers who wish to integrate Evergreen
1782 with other technologies
1783
1784 All manuals are available at http://docs.evergreen-ils.org
1785
1786
1787 Public catalog
1788 ~~~~~~~~~~~~~~
1789
1790 Improvements to ebook API
1791 ^^^^^^^^^^^^^^^^^^^^^^^^^
1792
1793 Evergreen now supports checking out and placing holds on
1794 OverDrive and OneClickdigital ebook titles from within the public
1795 catalog.  This is an experimental feature.  It is not recommended for production
1796 use without careful testing.
1797
1798 When ebook integration is enabled, a "Check Out E-Item" link will be
1799 displayed when viewing an ebook title from a supported vendor in the
1800 catalog.  Clicking on the link allows the user to check out and download
1801 that title from the vendor directly within the catalog.
1802
1803 If no copies are available for the title, a "Place Hold on E-Item" link
1804 is displayed instead, and the user may place a hold on the title.  (Note
1805 that some vendors require the user's account to have an email address
1806 before permitting a hold.)
1807
1808 My Account includes the ability to view current ebook checkouts and
1809 holds, download already-checked-out titles, and cancel holds.
1810
1811 For API integration to work, you need to request API access from the
1812 vendor, and the vendor must have a way of authenticating your patrons.
1813 Your Evergreen system also needs to be configured for ebook API
1814 integration, following the instructions in the command line system
1815 administration manual
1816
1817
1818 This feature assumes that you are importing MARC records supplied by the
1819 vendor into your Evergreen system, using Vandelay or some other MARC
1820 import method.  This feature does not search the vendor's online
1821 collections or automatically import vendor records into your system; it
1822 merely augments records that are already in Evergreen.
1823
1824 Improvements to Bill Payment Pages
1825 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1826 The bill payment pages in the public catalog have been revamped
1827 to
1828
1829  * use the term "charges" instead of "fees"
1830  * include images of credit cards accepted
1831  * make the default print receipt template match other itemized receipts;
1832    note that this change is not automatically applied when upgrading.
1833  * display billing type
1834  * add button to pay only selected charges
1835  * reformat the credit card number input page
1836
1837
1838
1839
1840
1841 Clickable Copy Locations
1842 ^^^^^^^^^^^^^^^^^^^^^^^^
1843 Adds a URL field to the copy locations editor. When a URL is entered in this field, 
1844 the associated copy location will display as a link in the public catalog summary display.
1845 This link can be useful for retrieving maps or other directions to the copy
1846 location to aid users in finding material.
1847
1848
1849
1850
1851 Download Checkout History CSV Fixed for Large Number of Circulations
1852 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1853 Downloading checkout history as a CSV from My Account has been fixed
1854 for users with a large circulation history.  Previously, this would
1855 time out for patrons with more than 100 or so circulations.
1856
1857 This feature no longer uses the action/trigger mechanism and the public catalog
1858 now generates the CSV directly.  The old action/trigger code is still
1859 present in the database and should be removed at some point in the
1860 near future.
1861
1862
1863
1864
1865 Google Books Preview Rewrite
1866 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1867 The Google Books Preview functionality in record detail pages has been
1868 rewritten to modernize its style and optimize its performance:
1869
1870 * The Dojo JavaScript framework is no longer used, saving approximately
1871   150K of JavaScript and CSS and four network requests per page load.
1872 * The Embedded Viewer is not loaded unless a possible preview is found,
1873   saving more network and memory overhead.
1874 * The Google Books Loader is used to load the Embedded Viewer instead of the
1875   https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1876   Google Loader].
1877 * All variables are self-contained and do not pollute the global namespace.
1878 * Event listeners are registered to handle clicks, rather than attaching
1879   `href="javascript:function()"` to <a> elements.
1880 * Book previews are displayed in a panel sized according to the viewport
1881   of the browser, improving its appearance on both mobile and desktop
1882   browsers.
1883 * The rewritten code is now served up directly from
1884   `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1885
1886
1887
1888
1889 jQuery for the Public Catalog
1890 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1891 This release adds optional support for jQuery in the public catalog.  This support
1892 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1893 `config.tt2` template.
1894
1895
1896
1897
1898
1899 New Popularity Parameters
1900 ^^^^^^^^^^^^^^^^^^^^^^^^^
1901 New popularity parameters for in-house use over time and for count of distinct
1902 organizational units that own a title are now available. Evergreen sites
1903 can use these parameters to create new statistical popularity badges for
1904 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1905
1906 The in-house use parameters will apply a badge to titles that have the most
1907 in-house use activity over time. The organizational unit count parameter
1908 will apply a badge to titles owned by the most number of libraries in a
1909 consortium. Ownership is determined by the copy's circulation library.
1910
1911
1912
1913
1914 Option to Suspend Holds at the Time They are Placed
1915 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1916 Users now have the option to suspend a hold at the same time they place the
1917 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1918 who want to suspend a hold at the time it is placed. There is also an option
1919 to set the activation date at the same time. This option is also available
1920 when placing holds on a batch of titles from 'My List' and will apply to
1921 all the titles in the batch.
1922
1923
1924
1925
1926
1927 Reports
1928 ~~~~~~~
1929
1930
1931
1932 Fix to reporter.classic_current_circ View
1933 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1934 The `reporter.classic_current_circ` view, which is part of some
1935 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1936 has been fixed to not exclude loans for patrons who do not have a
1937 billing address set. Users of this view should rerun
1938 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1939
1940
1941
1942
1943 New Report Source Table Allowing Report of "Last" Deleted copy
1944 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1945
1946 This source table allows you to construct a clever aggregate report template
1947 which will report bibliographic IDs where a library or a group of libraries 
1948 no longer have a copy attached but *had* a copy attached. This is especially
1949 useful when a holdings sync is required with an external vendor.
1950
1951
1952 Instructions for creating a report template with this source:
1953
1954   * Create a new report template using "Library Holdings Count with Deleted" as the source
1955   * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1956   * Add "Last Edit Date" (Max) to Aggregate Filters.  In Aggregate Filters, change the operator to "Between"
1957   * Add Circulation Library -> "Organizational Unit ID" to Base Filters, with the Raw Data transform.  In the list of Base Filters, change the operator to "In list"
1958   * Add "Bib ID" to Displayed Fields
1959   * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1960   * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1961   * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1962
1963
1964 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1965 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the 
1966 specified date range. Unfortunately the user will have to manually type the date range without the date
1967 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1968 copy and more than two deleted copies."
1969
1970
1971
1972
1973 Add Provider to Provider Note Link
1974 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1975 The Provider reporting source now includes a link to the Provider Note reporting source.
1976
1977
1978
1979
1980 Link ILS User and Working Location Reporting Sources
1981 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1982 The Working Location reporting source now has labels
1983 and it is now linked to the ILS User reporting source, allowing
1984 reports to display or filter on staff working location.
1985
1986
1987
1988
1989 New Circulation Report Source "All Circulation Combined Types"
1990 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1991
1992 This report source will allow you to create a single report template for all of the following:
1993
1994  * In-house uses
1995  * In-house uses of non-cataloged items
1996  * Circulations
1997  * Circulations of non-cataloged items
1998
1999 To distinguish between these different types of library use, it's important to display these columns
2000 in your report templates:
2001
2002  * Item Type
2003  * Circulation Type
2004
2005
2006
2007
2008
2009 Reports Template Searching
2010 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2011 A new form appears along the top of the reports interface for searching
2012 report templates.  Once found, typical template actions (e.g. create new
2013 report) are available from within the results interface.
2014
2015 Searches may be performed across selected (visible) folders or all 
2016 folders visible to the logged in user.
2017
2018 Searches are case-insensitive, any word order, with left-anchored words.  
2019 All searched words must appear in at least one of the searched fields.
2020
2021 Examples
2022 ++++++++
2023
2024  * Searching for 'stat cat' matches:
2025   ** stat cat
2026   ** statistical category
2027   ** categories, statistical
2028   ** patrons (stat cat)
2029  * Searching for 'stat cat' does not match:
2030   ** stat 
2031    *** both words must be present in the searched field(s)
2032   ** stat location
2033     *** location contains 'cat' but it's not left-anchored.
2034
2035 Reporter Paging
2036 +++++++++++++++
2037
2038 The templates, reports, and output interfaces now support paging via 
2039 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
2040
2041
2042
2043
2044
2045
2046 Serials
2047 ~~~~~~~
2048
2049
2050
2051 Web Staff Client Serials Module
2052 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2053 The serials module has been ported over to the web staff
2054 client, implementing a unified serials interface that combines
2055 ideas from both the serial control view and alternate serials
2056 control view from the old staff client.
2057
2058 In addition to carrying over functionality that was available
2059 in the old staff client, several new features are included:
2060
2061 * the ability to save prediction pattern codes as templates
2062   that can be shared and reused within an Evergreen database
2063 * a more streamlined interface for managing subscriptions,
2064   distributions, and streams
2065 * it is no longer necessary to create a starting issue in
2066   order to predict a run of issues; the dialog box for
2067   generating a set of predicted issues now lets you specify
2068   the starting point directly.
2069 * the ability to more directly edit MFHDs
2070     
2071 The new serials interfaces can be accessed from the record
2072 details page via a Serials drop-down button that links to
2073 a subscription management page, a quick-receive action, and
2074 a MFHD management page. There is also a new 'Serials Administration'
2075 page where prediction pattern and serial copy templates can
2076 be managed.
2077
2078
2079
2080
2081 SIP
2082 ~~~
2083
2084
2085
2086 SIP Bugfix Changes How Encoding Is Determined in Configuration
2087 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2088
2089 The combined fix for the above mentioned SIP bugs alters the way that
2090 SIPServer looks up the output encoding in the configuration file (typically
2091 `oils_sip.xml`).  SIPServer now looks for the encoding in the following
2092 places:
2093
2094 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
2095 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
2096 3. The +encoding+ element that is a child of the +implementation_config+ element that is itself a child of the +institution+ element of the currently active SIP account.
2097 4. If none of the above exist, then the default encoding (ASCII) is used.
2098
2099 Number 3 is provided to ease the transition to the new code.  It is
2100 the current location of the +encoding+ element in the sample
2101 configuration file and as such, where it is likely to be found in
2102 actual files.  It is recommended that you alter your configuration to
2103 move this element out of the +implementation_config+ element and into
2104 its parent +institution+ element.  Ideally, SIPServer should *not* look into
2105 the implementation config, and this check may be removed at some time
2106 in the future.
2107
2108
2109
2110 Acknowledgments
2111 ---------------
2112
2113 Web Client Acknowledgments
2114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2115
2116 The project to develop a new browser-based web client launched four 
2117 years ago at the September 2013 Evergreen developer hack-a-way when the
2118 developer community voted to move away from the XUL client and explore other
2119 platforms. The first web client preview became available in Evergreen 2.7 when
2120 circulation was available in the new platform.
2121
2122 The browser-based client is available due to the work of many coders, testers,
2123 bug reporters, documentors, translators, project managers, spec writers, funders
2124 and other contributors over the past four years.
2125
2126 The Evergreen project would like to acknowledge the following organizations
2127 that funded development of the Web Staff Client:
2128
2129 * Bibliomation
2130 * British Columbia Libraries Cooperative
2131 * Consortium of Ohio Libraries
2132 * C/W MARS
2133 * Georgia Public Library Service
2134 * Grand Rapids Public Library
2135 * The Howe Library
2136 * Kenton County Public Library
2137 * King County Library System
2138 * MassLNC
2139 * NC Cardinal
2140 * Pennsylvania Integrated Library System
2141 * Pioneer Library System
2142 * SC LENDS
2143
2144 The Evergreen project would also like to thank the following individuals who 
2145 contributed code, translations, documentation patches, tests, bug reports, 
2146 technical specifications, and project management to the Web Staff Client:
2147
2148 * Jason Boyer
2149 * Adam Bowling
2150 * Christine Burns
2151 * Steve Callender
2152 * Eva Cerniňáková
2153 * Galen Charlton
2154 * Dawn Dale
2155 * Jeff Davis
2156 * Grace Dunbar
2157 * Bill Erickson
2158 * Jason Etheridge
2159 * Lynn Floyd
2160 * Sally Fortin
2161 * Jeff Godin
2162 * Rogan Hamby
2163 * Elaine Hardy
2164 * Blake Henderson
2165 * Billy Horn
2166 * Skye Howard
2167 * Kyle Huckins
2168 * Linda Jansová
2169 * Tina Ji
2170 * Mary Jinglewski
2171 * Angela Kilsdonk
2172 * Joan Kranich
2173 * Victoria Lewis
2174 * Mary Llewelyn
2175 * Jeanette Lundgren
2176 * Kathy Lussier
2177 * Terran McCanna
2178 * Christine Morgan
2179 * Michele Morgan
2180 * Stephen Moss
2181 * Andrea Neiman
2182 * Nawras Othman
2183 * Freddy Enrique Pelayo Huapalla
2184 * Jillianne Presley
2185 * Jennifer Pringle
2186 * Michelle Purcell
2187 * Erica Rohlfs
2188 * Mike Rylander
2189 * Jane Sandberg
2190 * Janet Schrader
2191 * Dan Scott
2192 * Chris Sharp
2193 * Ben Shum
2194 * Clare Sobotka
2195 * Tim Spindler
2196 * Remington Steed
2197 * Jason Stephenson
2198 * Josh Stompro
2199 * Yamil Suarez
2200 * Amy Terlaga
2201 * Scott Thomas
2202 * Anahi Valdez
2203 * Cesar Velez
2204 * Jessica Venturo
2205 * Dan Wells
2206 * Beth Willis
2207 * Tigran Zargaryan
2208
2209 Evergreen 3.0 Acknowledgments
2210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2211
2212 The Evergreen project would like to acknowledge the following
2213 organizations that commissioned developments in this release of
2214 Evergreen:
2215
2216 * Bibliomation
2217 * British Columbia Libraries Cooperative (BC Sitka)
2218 * C/W MARS
2219 * Georgia Public Library Service
2220 * King County Library System
2221 * MassLNC
2222 * Pennsylvania Integrated Library System
2223 * Pioneer Library System
2224
2225 We would also like to thank the following individuals who contributed
2226 code, translations, documentation patches, and tests to this release of
2227 Evergreen:
2228
2229 * Adam Bowling
2230 * Jason Boyer
2231 * Eva Cerniňáková
2232 * Galen Charlton
2233 * Dawn Dale
2234 * Jeff Davis
2235 * Martha Driscoll
2236 * Bill Erickson
2237 * Jason Etheridge
2238 * Lynn Floyd
2239 * Jeff Godin
2240 * Rogan Hamby
2241 * Blake Henderson
2242 * Billy Horn
2243 * Skye Howard
2244 * Kyle Huckins
2245 * Linda Jansova
2246 * Tina Ji
2247 * Pasi Kallinen
2248 * Angela Kilsdonk
2249 * Debbie Luchenbill
2250 * Jeanette Lundgren
2251 * Kathy Lussier
2252 * Terran McCanna
2253 * Christine Morgan
2254 * Michele Morgan
2255 * Andrea Neiman
2256 * Bill Ott
2257 * Suzanne Paterno
2258 * Dan Pearl
2259 * Jillianne Presley
2260 * Mike Rylander
2261 * Jane Sandberg
2262 * Dan Scott
2263 * Srey Seng
2264 * Chris Sharp
2265 * Ben Shum
2266 * Remington Steed
2267 * Jason Stephenson
2268 * Josh Stompro
2269 * Scott Thomas
2270 * Cesar Velez
2271 * Dan Wells
2272 * Liam Whalen
2273 * Beth Willis
2274
2275 We also thank the following organizations whose employees contributed
2276 patches:
2277
2278 * British Columba Libraries Cooperative
2279 * Calvin College
2280 * Catalyte
2281 * CW/MARS
2282 * Emerald Data Networks, Inc.
2283 * Equinox Open Library Initiative
2284 * Georgia PINES
2285 * Grand Rapids Public Library
2286 * Indiana State Library
2287 * Jabok Library
2288 * King County Library System
2289 * Lake Agassiz Regional Library
2290 * Laurentian University
2291 * Linn-Benton Community College
2292 * MassLNC
2293 * Merrimack Valley Library Consortium
2294 * MOBIUS Consortium
2295 * North of Boston Library Exchange
2296 * Pennsylvania Integrated Library System
2297 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2298 * Sigio
2299 * Traverse Area District Library
2300
2301 We regret any omissions.  If a contributor has been inadvertently
2302 missed, please open a bug at http://bugs.launchpad.net/evergreen/
2303 with a correction.
2304