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