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