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