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