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