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