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