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