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