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