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