1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.6.
10 * Fixes a performance issue with the Patron Billing History screen and
11 other screens that cause Flattener.pm to re-create joins
13 * Fixes an issue that prevented patron alerts from showing to staff at
15 * Corrects the "Holdable" attribute display on the Item Status detailed
17 * Fixes the ability to delete multiple copies from Item Status.
21 We would like to thank the following individuals who contributed code,
22 tests and documentation patches to the 3.0.5 point release of
36 This release is a security release that fixes cross-site scripting
37 (XSS) vulnerabilities in the Evergreen public catalog. This release
38 also includes several other bugfixes improving on Evergreen 3.0.5.
40 Security Issue: XSS Vulnerability in Public Catalog
41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
42 This release fixes several cross-site scripting (XSS) vulnerabilities
43 in the public catalog. When upgrading, Evergreen administrators should
44 review whether any of the following templates have been customized
45 or overridden. If so, either the template should be replaced with the
46 stock version or the XSS fix (which entails adding the `| html` filter
47 in several places) applied to the customized version.
49 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
50 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
51 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
53 Note that exploiting the XSS vulnerabilities fixed in this release
54 would require either the ability to create maliciously-constructed
55 MARC bibliographic or holdings records or the ability to set a
56 maliciously constructed organizational unit name.
60 Evergreen 3.0.6 also includes the following changes:
62 * When using 'Selection Lists -> Edit MARC Order Record' in the web
63 staff client, now only one click is required to save the MARC
64 record rather than two.
65 * The volume/copy editor in the web staff client now better handles
66 editing multiple items that have different sets of statistical
67 category values assigned to them.
68 * The act of merging bibliographic records now updates bookbags
69 that referred to the source bibliographic record rather than
70 effectively deleting entries for that record.
71 * Additional columns were added to the Holds Pull List in the
73 * The patron registration form in the web staff client now correctly
74 manages setting user preferences.
75 * An error in a pgTAP unit test was corrected.
79 We would like to thank the following individuals who contributed code,
80 tests and documentation patches to the 3.0.6 security release of
96 This release contains bug fixes improving on Evergreen 3.0.4.
98 * The MARC Editor in the Web staff client now wraps long fields.
99 * The MARC Editor no longer allows catalogers to enter new lines
101 * Fixes an issue that prevented serials items from being deleted or
103 * The Web staff client Check In screen no longer reloads the whole
104 page multiple times each time an item is scanned.
105 * Fixes an issue that displayed the oldest -- rather than the newest
106 -- transit in the Web staff client Item Status page.
107 * Fixes an issue that prevented the reports module from being displayed
109 * Fixes an issue in the Web staff client reports module that caused
110 syntax errors in reports that use virtual fields and joins.
111 * Fixes an issue that prevented several dropdown menus in the Web staff
112 client from activating.
113 * Fixes an issue that created duplicate copy data when copies or
114 volumes with parts were transferred.
115 * Fixes the Trim List feature in the Web staff client Check In screen.
116 * The Item Status grid now displays the Circulation Modifier.
117 * Restores missing data from the Profile column in Place Hold patron
119 * Fixes an issue with the http -> https redirect on Apache 2.4.
120 * Fixes an color contrast accessibility issue in the Web staff
121 client and adds underlining to links in grid cells for added accessibility.
122 * Adds automated regression and unit tests for the Web staff client
124 * Adds a process for spell-checking the official documentation.
125 * Adds a script that simplifies the release process related to translations.
130 We would like to thank the following individuals who contributed code,
131 tests and documentation patches to the 3.0.5 point release of
136 * Blake Graham-Henderson
151 This release contains bug fixes improving on Evergreen 3.0.3:
153 * Fixes a bug that caused all searches limited by shelving location to
155 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
156 rather than the ordering agency's SAN.
157 * Fixes a bug that prevented Safari/iOS users from logging in to the
159 * Fixes a bug that prevented users from using the browse interface.
160 * Fixes a bug in the Item Status List view that caused incorrect due
162 * Approval code is now a required field in the web client's patron
163 credit card payment form.
164 * Fixes a bug with credit card payments that caused a receipt to print
165 showing that the patron paid the bill when the payment had not actually
167 * Fixes a bug that prevented the EDI translator from being installed on
169 * Fixes a bug that caused entries to show up multiple times in the
170 Items Out and Holds tabs in the patron record.
171 * Fixes a bug that caused grids on Bills and Patron Messages
172 screens to not display properly.
173 * The following fields are now available for the Checkout and Items Out
180 ** money_summary.balance_owed
181 ** money_summary.total_paid
182 ** money_summary.total_owed
187 * The following fields are now available on the Bill Payment receipt templates:
197 * Payment type is now a column in the payments tab of the patron record
198 Bill History section.
199 * The "Replace Barcode" function now makes it more difficult for staff
200 members to attempt to create blank patron barcodes.
201 * The patron bills screen now prevents staff members from double-clicking
202 on the Apply Payment button (which otherwise would apply two payments).
203 * Fixes a bug that prevented patrons attached to statistical categories
204 from displaying in the patron search-to-hold dialog.
205 * Fixes a performance issue related to uploading CSV files of barcodes
206 to the item status and patron bucket interfaces.
207 * Fixes several small bugs in the Spanish translation.
208 * Fixes a performance bug related to patrons logging in by barcode.
212 We would like to thank the following individuals who contributed code,
213 tests and documentation patches to the 3.0.4 point release of
235 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
236 update the visibility attributes of all bibs that make use of Located URIs or
237 bib sources. It may take a while to run on large datasets. If it it running
238 too long, it can be canceled and the following psql commands will create and
239 run a script that will perform the same action serially over time without
240 blocking writes to bibs:
243 \o /tmp/luri_visibility_update.sql
244 SELECT 'UPDATE biblio.record_entry SET ' ||
245 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
246 'WHERE id = ' || id || '; SELECT ' || id || ';'
247 FROM biblio.record_entry
249 SELECT DISTINCT cn.record
250 FROM asset.call_number cn
252 AND cn.label = '##URI##'
255 FROM asset.uri_call_number_map m
256 WHERE m.call_number = cn.id
259 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
264 \i /tmp/luri_visibility_update.sql
267 It will output the id of each updated bib so that the script can be killed
268 and then edited to remove completed bibs. The remainder can be run at a
271 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
272 we do NOT update the bib's visibility attributes, as doing so causes a loop
273 and an eventual trigger stack violation. This flag should ONLY be used when
274 forcing reingest of record attributes (NOT visibility attributes), search,
275 facet, and display fields, so if using this flag under normal operation,
276 proceed at your own risk and know that Located URI and bib source changes
277 will not be reflected in the visibility attributes of the record.
281 This release contains several bug fixes improving on Evergreen 3.0.1:
283 * Fixes several issues related to the display of located URIs and records with
284 bib sources in search results.
285 * Setting `opac_visible` to false for a copy location group now hides only
286 the location group itself, rather than also hiding every single copy in the
288 * Fixes a bug that prevented the copy editor from displaying the _fine level_
289 and _loan duration_ fields.
290 * The "Edit Items" grid action in the Item Status interface will now open
291 in the combined volume/copy editor in batch. This makes the behavior
292 consistent with the "Edit Selected Items" grid action in the copy
294 * Staff members are now required to choose a billing type when creating a
295 bill on a user account.
296 * The Web client now provides staff users with an alert and option to
297 override when an item with the Lost and Paid status is checked in.
298 * Fixes a bug where the Web client offline circ interface was not able
299 to set its working location.
300 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
302 * The MARC editor in the Web staff client now presents bib sources in
304 * Both circulation and grocery bills are now printed when a staff user selects
305 a patron account and clicks "Print Bills".
306 * Fixes an issue in the XUL serials interface the "Receive move/selected"
307 action from succeeding.
308 * Fixes a typo in the user password testing interface.
312 We would like to thank the following individuals who contributed code,
313 tests and documentation patches to the 3.0.3 point release of
332 This release contains several bug fixes improving on Evergreen 3.0.1:
334 * Copy templates created in XUL Holdings Maintenance will now be
335 automatically converted and displayed in the web staff client's
337 * The list of report templates now includes a column indicating whether
338 the template was originally created in the XUL staff client or the web
339 staff client; staff need to know this since report templates created in
340 one interface cannot be edited in the other.
341 * Call number prefixes and suffixes are now displayed in various grids
342 in the web staff client, including
343 ** Pending Copy Buckets
345 ** Checkin/Capture Holds
347 ** Patron Bills History
354 ** Bib Record View Holds
356 * Many patron fields have been redacted from the web staff client's patron
357 and record holds grids, leaving patron name, username, and ID.
358 * Fixes two bugs where patron records could fail to be saved upon editing.
359 * The web staff patron editor now better warns staff users about
360 duplicate names, IDs, phone numbers, and email addresses.
361 * Human readable labels are now displayed for certain fields in standing
363 * The patron summary in the web staff client now correctly displays
364 primary and secondary ID values.
365 * The web staff client's billing full details page now displays
366 information about the staff user that created a payment.
367 * The web staff client now requires staff users to explicitly set a
368 billing type when adding a manual bill.
369 * The web staff client's patron bill annotation modal now works.
370 * Patron barcode search completion in the web staff client now allows
371 the user to select from all of the matching patron records.
372 * The Hold Shelf Slip print template in the web staff client now has
373 access to the call number.
374 * The Checkout Receipt print template in the web staff client now can
375 include summary financial information, incuding current balance, total
376 paid on outstanding fines, and total owed.
377 * The web staff print templates for current and historical bills can
378 now include copy barcode and title.
379 * Fixes a bug that resulted in some catalog searches unexpectedly
381 * Fixes a bug that resulted in catalog searches that specify a location
382 limit returning incorrect results.
383 * Fixes a bug where deleted copies could make records visible in the
385 * Fixes a bug where certain queries on copies used in the public catalog
387 * Fixes a bug place a hold request in the public catalog could result
388 in "forgetting" the type and library of the user's previous search.
389 * The web staff client now respects staff user session timeouts, and
390 will log out all open tabs if a user's session has timed out.
391 * The web staff Z39.50 page will now give the staff user an alert if
392 they attempt to import a record with a duplicate TCN.
393 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
394 entries from being deleted.
395 * Fixes a bug that made using the volume/copy editor to change a copy's
397 * The administration interface for hard due dates now ensures that
398 new (or edited) ceiling dates have their time component set to end
399 of day, resolving an issue where ceiling dates would not be applied
400 during the ceiling date itself.
401 * The web staff client can now include dynamic information in browser
402 tab titles, e.g., "Smith, Jane - Checkout".
403 * The Concerto sample data set now includes data allowing for testing
404 placing holds on monographic parts.
405 * Asset merging during bibliographic record merging now correctly
406 recognizes call number prefixes and suffixes and deletes disused
408 * Fixes a bug where displaying user surveys could result in PCRUD
410 * Fixes a bug where pg_restore of an Evergreen database could fail
411 to create certain indexes on the `actor.usr` table.
415 We would like to thank the following individuals who contributed code,
416 tests and documentation patches to the 3.0.2 point release of
447 This release contains several bug fixes improving on Evergreen 3.0.0
449 * Fixes a bug in the web staff client that prevented initials from being
450 stored with copy notes.
451 * Adds billing types that may have been missed by systems that were
452 running Evergreen prior to the 1.4 release.
453 * Fixes a web staff client bug with the CSV export option available from
454 the Import Queue in the MARC Batch Import/Export interface.
455 * Adds the missing copy alert field in the web client's volume/copy
457 * Fixes a bug where the setting to require date of birth in patron
458 registration was not being honored in the web staff client.
459 * Fixes a bug in the web staff client patron registration form where the
460 password wasn't generating from the last four digits of the patron's
462 * Fixes an issue in the web staff client where the complete barcode did
463 not display in some interfaces when partial barcodes were scanned.
464 * Fixes an HTML error in the new copy tags that display on the record
466 * Fixes a web staff client bug where recording a large number of in-house
467 uses at one time doesn't display a confirmation dialog once it hits the
469 * Adds a _Print Full Grid_ action in the web staff client
470 holds pull list to allow staff to print the entire pull list as it
471 displays on the screen. This change also changes the _Export CSV_ action
472 to an _Export Full CSV_ option.
473 * Fixes an issue with the Patron Messages interface that prevented it
474 from saving column configuration changes in the web staff client.
475 * Fixes a bug in the web staff client where a billing prompt did not
476 correctly display after marking an item damaged in those systems that
477 have enabled the setting to bill for damaged items.
478 * Adds an option to the specific due date feature that allows saving
479 that due date until logout. This allows all circulations from a given
480 workstation to be due on the same date.
484 We would like to thank the following individuals who contributed code,
485 tests and documentation patches to the 3.0.1 point release of
507 The minimum version of PostgreSQL required to run Evergreen 3.0 is
508 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
510 Change to Names of Shared Libraries
511 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
512 OpenSRF 3.0 changes how the shared libraries for services written in
513 C are named. If upgrading from an earlier version of Evergreen,
514 `opensrf.xml` should be edited so that shared library file names
515 listed in the `<implementation>` tag start with "lib". For example,
518 ---------------------------------------------------------------------
520 <language>C</language>
521 <implementation>oils_cstore.so</implementation>
522 ---------------------------------------------------------------------
524 should be changed to:
527 ---------------------------------------------------------------------
529 <language>C</language>
530 <implementation>liboils_cstore.so</implementation>
531 ---------------------------------------------------------------------
533 SIP Bugfix Requires SIPServer Upgrade
534 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
536 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
537 crash" requires that you also upgrade SIPServer with the fix for
538 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
539 SIP client problems." This means that if you use SIP2 with Evergreen,
540 you must also upgrade SIPServer to the latest commit in the Git
541 repository. Conversely, if you upgrade SIPServer to the latest commit
542 in Git, you must also upgrade Evergreen or, at least, apply the patch
543 for Launchpad Bug 1542495. These two patches are complementary and
544 cannot be applied independently of one another.
546 `open-ils.auth.login`
547 ~~~~~~~~~~~~~~~~~~~~~
548 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
549 API's in the `opensrf_core.xml` file.
554 ---------------------------------------------------------------------
555 --- a/Open-ILS/examples/opensrf_core.xml.example
556 +++ b/Open-ILS/examples/opensrf_core.xml.example
557 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
559 <match_string>open-ils.auth.authenticate.verify</match_string>
560 <match_string>open-ils.auth.authenticate.complete</match_string>
561 + <match_string>open-ils.auth.login</match_string>
562 <match_string>open-ils.auth_proxy.login</match_string>
563 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
564 <match_string>open-ils.actor.user.password</match_string>
565 ---------------------------------------------------------------------
569 Administrators of Evergreen who use RTL locales and who have customized
570 `style-rtl.css.tt2` should now incorporate their customizations into
573 Multi-Time Zone Installations
574 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
576 For Evergreen consortia that span more than one time zone, the following
577 query will adjust all historical, unaged circulations so
578 that if their due date field is pushed to the end of the day, it is done
579 in the circulating library's time zone, and not the server time zone.
581 It is safe to run this after any change to library time zones.
583 Running this is not required, as no code before this change has
584 depended on the time string of '23:59:59'. It is also not necessary
585 if all of your libraries are in the same time zone, and that time zone
586 is the same as the database's configured time zone.
595 for ou_id in select id from actor.org_unit loop
596 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
597 if new_tz is not null then
598 update action.circulation
599 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
600 where circ_lib = ou_id
601 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
610 Deprecation of XUL staff client
611 -------------------------------
612 Starting with the release of 3.0.0, patches that fix XUL bugs will not
613 be merged into master or backported unless they meet one or more of
614 the following conditions:
616 a. the bug is a security issue
617 b. the bug involves the destruction of data
618 c. the bug is a regression of functionality in the XUL staff client
619 introduced by other work done to Evergreen
621 Under no circumstances will XUL staff client feature enhancements be merged.
623 This policy will continue through the 3.0.x and 3.1.x maintenance
624 release cycles, and will become moot upon the release of 3.2.0, when
625 the XUL staff client is slated to be entirely removed.
634 Evergreen 3.0 features a new, modern staff client that runs in the web browser
635 and can be used on desktop and mobile devices. All functional areas of the
636 system, including circulation, cataloging, acquisitions, serials, reports,
637 booking, administration, and offline circulation, are available in the new staff
638 client. Chrome and Firefox are officially supported for use with the web client.
640 Library staff will no longer need to download separate software to perform most
641 actions in Evergreen. A Chrome plugin called Hatch will be available as a
642 separate installation for workstations that require seamless, dialog-free
643 printing to multiple printers.
645 In addition to adding more portability and stability, the new staff client also
646 presents a cleaner and more modern interface for users. By virtue of running in
647 a browser, actions that users are accustomed to performing on other web sites
648 should now be available in the Evergreen client.
650 The old, XUL client will continue to be available to allow for a gradual
651 transition to the browser-based client, but no new features will be added. The
652 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
662 New EDI Order Generator
663 ^^^^^^^^^^^^^^^^^^^^^^^
668 . New database tables exist for configuring vendor-specific EDI order
672 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
675 ** Collection of `edi_attr`s. Each edi_account may be linked to one
677 ** One `edi_attr_set` per known vendor is added to the stock data, matching
678 the stock configuration found in the JEDI template.
679 * `acq.edi_attr_set_map`
680 ** Link between `edi_attr`s and `edi_attr_set`s.
682 . EDI Attribute Sets are manged via a new (browser client only) configuration
683 interface at 'Administration -> Acquisitions Administration -> EDI
686 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
687 is not set, default values will be used. Links between an EDI account
688 and an attribute set are managed in the EDI Accounts configuration
691 . Local modifications to the stock EG JEDI template are managed by modifying
692 and/or adding additional `edi_att_set`s as needed.
694 . A new `edi_order_pusher.pl` script is added which replaces the functionality
695 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
697 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
698 definition is no longer required and can be disabled.
703 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
704 specifies whether PO's generated via the account should be built using
705 EDI attributes or fall back to traditional JEDI A/T template generation.
707 This allows sites to activate EDI attributes on a per-account basis, making
708 it possible to migrate piecemeal to EDI attributes. For the initial roll
709 out of this new feature, no accounts will be configured to use EDI
710 attributes by default.
716 3 Day Courtesy Notice by SMS
717 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
718 New optional SMS text notification to be sent out 3 days prior to the due
719 date of any circulating item for patrons who have an SMS text number and
720 carrier stored in their accounts. This action trigger is disabled by default,
721 but can be enabled and modified by going into 'Administration -> Local Administration ->
722 Notifications / Action Triggers'.
724 You may wish to make use of granularity so that these messages are batched
725 and sent at the same time each day.
730 Add Description Field to Circulation and Hold Configuration Entries
731 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
732 The circulation and hold policy configuration rules now each have a
733 description field. This allows administrators to add comments to
734 describe the purpose of each rule.
739 Apache Internal Port Configuration Option
740 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
741 Apache configuration now supports a new variable which allows admins to
742 specify the port used by Apache to handle HTTP traffic. The value is
743 used for HTTP requests routed from Perl handlers back to the same Apache
744 instance, like added content requests. Use this when running Apache
745 with a non-standard port, typical with a proxy setup. Defaults to "80".
748 -------------------------------------------------------------------
751 PerlSetVar OILSWebInternalHTTPPort "7080"
754 -------------------------------------------------------------------
759 Configurable Bib Record Display Fields
760 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
762 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
763 fields: 'Display Field?' and 'Display XPath'.
765 When 'Display Field' is set to true, data from the field will be extracted
766 from each record and added to a new table of display data for each bib
769 If a value is present in the 'Display XPath' field, this XPath will be
770 applied to the extracted data *after* the base XPath (from the 'XPath'
771 field) is applied to each field.
773 This data acts as a replacement for the various and sundry ways bib record
774 data is currently extracted, including inline XPath in the TPAC, reporter
775 views, real-time 'MVR' compilation from MODS, etc. and will be available
776 to the user interface, notification templates, etc. for rendering bib
779 The browser client gets a new service 'egBibDisplay' which is capable
780 of translating the display field data from various formats into
781 data more suitable for JavaScript usage.
783 The database gets 3 new views for representing display data in various
786 * `metabib.flat_display_entry`
787 ** List of all display fields linked to their configuration.
788 * `metabib.compressed_display_entry`
789 ** Same as `metabib.flat_display_entry` except there's one row
790 per display field type, with 'multi' rows compressed into
791 JSON arrays. Non-multi fields are represented as JSON
793 * `metabib.wide_display_entry`
794 ** Tabular view of display field data, one column per well-known
795 field. Values are represented JSON, consistent with
796 `metabib.flat_display_entry`. The view does *not* contain locally
797 configured display fields, as each field must be encoded in
798 the view and IDL definition. This is essentially a replacement
799 for `reporter.simple_record`.
804 After making changes to display field configuration, it's possible to
805 reingest only display field data in the database using the following:
808 ---------------------------------------------------------------------
809 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
810 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
811 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
812 ---------------------------------------------------------------------
818 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
819 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
820 The existing permission was incorrectly created with a code of
821 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
822 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
823 update changes the permission code to match what the event requires.
829 Hold Targeter V2 Repairs and Improvements
830 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
831 * Make the batch targeter more resilient to a single-hold failure.
832 * Additional batch targeter info logging.
833 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
834 * Removes the confusingly named `--target-all` option
835 ** The same behavior can be achieved by using `--retarget-interval "0s"`
836 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
838 New --next-check-interval Option
839 ++++++++++++++++++++++++++++++++
840 Specify how long after the current run time the targeter will retarget
841 the currently affected holds. Applying a specific interval is useful
842 when the retarget-interval is shorter than the time between targeter
845 For example, if the targeter is run nightly at midnight with a
846 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
847 since the holds won't be processed again until 48 hours later. This
848 ensures that the org unit closed date checks are looking at the correct
851 This setting overrides the default behavior of calculating the next
852 retarget time from the retarget-interval.
854 New --soft-retarget-interval Option
855 +++++++++++++++++++++++++++++++++++
856 This is a replacement for (and rebranding of) the `--skip-viable` option.
857 The new option allows for time-based soft-targeting instead simple binary
858 on/off soft-targeting.
860 How soft-targeting works:
862 * Update hold copy maps for all affected holds
863 * Holds with viable targets (on the pull list) are otherwise left alone.
864 * Holds without viable targets are retargeted in the usual manner.
870 New marc_export --descendants Option
871 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
873 The `marc_export` script has a new option, `--descendants`. This option
874 takes one argument of an organizational unit shortname. It works much
875 like the existing `--library` option except that it is aware of the
876 org. tree and will export records with holdings at the specified
877 organizational unit and all of its descendants. This is handy if you
878 want to export the records for all of the branches of a system. You
879 can do that by specifying this option and the system's shortname,
880 instead of specifying multiple `--library` options for each branch.
882 The `--descendants` option can be repeated, as the `--library` option can.
883 All of the specified org. units and their descendants will be included
884 in the output. It can also be combined with individual `--library`
885 options when necessary.
890 RTL and LTR Public Catalog Stylesheets Merged
891 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
892 The RTL stylesheet for the public catalog,
893 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
894 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
895 template will provide RTL or LTR styles based on the value of
896 the `rtl` flag of the active locale. An `rtl` variable is also available
897 in the template to allow the correct style to be chosen.
902 Miscellaneous Improvements
903 ^^^^^^^^^^^^^^^^^^^^^^^^^^
905 * If a filter is in effect in the Library Settings Editor,
906 the filter will continue to be applied after a user
907 changes the selected library.
908 * Copy templates used for serials now correctly link to age
909 protection rules and MARC item type values (for the
910 "Circ as Type" field). During upgrade, the database update
911 will set to NULL any age protection and circ as type fields
912 in serial copy templates that do not point to defined values.
917 Obsolete Internal Flag Removed
918 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
920 An obsolete and unused `ingest.disable_metabib_field_entry` internal
921 flag was removed from the `config.internal_flags` table. It was
922 rendered obsolete by the addition of the 3 flags to control the
923 browse, search, and facet indexing.
928 Tweaks to Caching/Expiry of Public Catalog Assets
929 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
930 The default cache expiration time for static assets (e.g.,
931 CSS, image, and JavaScript files) in the public catalog and
932 the Kid's PAC has been increased to one year. Links to all
933 such assets now have a cache-busting value tacked on as a
934 query parameter. This value is refreshed when `autogen.sh` is
935 run, but it can also be manually set by adjusting the
936 `ctx.cache_key` Template Toolkit variable.
941 Action/Trigger Events Data Purging
942 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
944 Action/Trigger event definitions have a new field called 'Retention
945 Interval'. When an optional interval value is applied, events and
946 template output data linked to the event definition will be deleted
947 from the database once they reach the specified age.
949 Retention Interval Restrictions for Passive Hooks
950 +++++++++++++++++++++++++++++++++++++++++++++++++
952 Restrictions are placed on retention interval values for event definitions
953 using passive hooks to prevent data from being deleted while it's still
954 needed by the system.
956 The presence of event data is how the system knows not to send duplicate
957 events. As long as a scenario exists where a duplicate event may be
958 generated, the events must be retained.
960 To apply a retention interval value to a passive-hook event definition:
962 * The event definition must have a max_delay value.
963 * The retention interval must be larger than the difference between
964 the `delay` and `max_delay` values.
966 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
967 interval must be greater than 3 days to ensure no duplicate events are
968 created between the first event on day 7 and the end of the event validity
974 A new `purge_at_events.sh` script is installed in the bin directory
975 (typically `/openils/bin`) which should be added to CRON for regular
978 NOTE: On large data sets, this script can take a long time to run and
979 create higher than normal I/O load as it churns though the event and
980 event_output tables. You may wish to run the script by hand the first
981 time so it can be monitored. It can be run in psql like so:
984 ---------------------------------------------------------------
985 SELECT action_trigger.purge_events();
986 ---------------------------------------------------------------
988 NOTE: On *very* large data sets (10s to 100s of millions of event and
989 event_output rows), it may be advisable to first repopulate the `event`
990 and `event_output` tables with only the desired data before starting
991 regular purges. This can be done, for example, using the copy to temp
992 table, truncate source table, repopulate source table from temp table
993 approach. This will be much faster than the `purge_events()` function
994 in cases where most of the data will be purged.
999 A number of `action_trigger.hook` entries which have always been treated
1000 as active hooks, though are configured as passive hooks, have been
1001 updated to properly reflect the non-passive-ness. This allows for
1002 simpler configuration of their retention interval values.
1008 Remove JSPAC Redirects
1009 ^^^^^^^^^^^^^^^^^^^^^^
1010 Future versions of Evergreen will no longer contain automatic redirects
1011 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1012 that the JSPAC is no longer supported. Existing sites, however, may
1013 wish to retain JSPAC redirects in their Apache configuration files since
1014 JSPAC URLs may still be used in the wild to access their catalogs.
1016 The original JSPAC URL redirects are all retained in the file
1017 `Open-ILS/examples/jspac_redirects.conf` for reference.
1027 New open-ils.auth.login API
1028 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1029 The `open-ils.auth` service has a new API for requesting an authentication
1030 token. It performs the same steps as the
1031 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1032 using the bare password. No intermediate password hashing is required.
1034 The paramaters are the same as the `.complete` call with a few modifications.
1036 1. Using the generic 'identifier' parameter in combination with the
1037 'org' parameter allows the API to reliably determine if an identifier
1038 value is a username or barcode. The caller is no longer required to
1039 make that determination up front.
1041 2. The 'nonce' parameter is no longer used.
1047 Batch Patron Contact Invalidation
1048 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1049 The following methods are used to mark patron contact fields
1050 as invalid by moving the invalid value to a standing penalty:
1052 * `open-ils.actor.invalidate.email`
1053 * `open-ils.actor.invalidate.day_phone`
1054 * `open-ils.actor.invalidate.evening_phone`
1055 * `open-ils.actor.invalidate.other_phone`
1057 These methods now accept a fifth argument specifying the value
1058 of the contact field, e.g., a specific phone number or email
1059 address. If supplied, and if a specific patron ID (the first
1060 argument) is not supplied, all patrons with that specific contact
1061 value will have it marked invalid.
1071 Pure-SQL catalog searching
1072 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1073 Public and staff catalog search is now both more accurate and faster
1074 by redesigning how the visibility of records is calculated.
1084 Authority Record and Headings Browse Improvements
1085 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1086 Various improvements are made to support for authority records
1087 and headings browsing:
1089 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1090 headings from authority records. Since the MODS and MADS stylesheets
1091 extract headings in similar ways, duplicate browse entries are now
1092 much less likely to occur.
1093 * A new configuration table, `authority.heading_field`, is now used
1094 to specify how headings should be extracted from authority records.
1095 * Related headings can now be identified as narrower or broader when
1096 browsing in the public catalog.
1097 * See references are now more reliably included in the browse list.
1098 * Scope (public) notes now display only under the main heading.
1099 * There is now a global flag, Display related headings (see-also) in browse,
1100 that can be used to control whether related headings (see-alsos) are
1101 displayed in the public catalog list.
1102 * A complete set of thesauruses are now included in the seed data. Thesauruses
1103 can now be identified using short and long codes.
1104 * The labels for see and see-also references in the public catalog are
1105 a bit more patron-friendly, and can now be tweaked via TPAC template
1106 customization in the browse.tt2 file.
1112 Copy Tags and Digital Bookplates
1113 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1114 Copy tags will allow staff to apply custom, pre-defined labels or tags
1115 to copies. Copy tags are searchable in both the staff client and public
1116 catalog. This feature was designed to be used for Digital Bookplates to
1117 attach donation or memorial information to copies, but may be used for
1118 broader purposes to tag items.
1120 Each copy tag can either be publicly-visible or visible only to staff.
1121 Copy tags also have types that can be used for restricting catalog
1122 searches on copy tags to particular types.
1124 Copy tags are displayed in the copy table in the record summary page in
1125 the public catalog, and a new library setting can be used to add
1126 a "Digital Bookplate" search field. Copy tags can also be used
1127 as a search filter, e.g.,
1129 * `copy_tag(bookplate, jane smith)`: search for records that have a
1130 copy tag of type 'bookplate' whose value contains 'jane smith'.
1131 * `copy_tag(*, jane smith)`: search for records that have a
1132 copy tag of any type whose value contains 'jane smith'.
1134 All staff-side interfaces related to copy tags exist only in the web
1135 staff client. There are two new administration interfaces for managing
1136 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1137 button for applying copy tags to copies; that interface can also be
1138 used to create new copy tags on the fly. Furthermore, the copy buckets
1139 interface now has an 'Apply Tags' action for assigning tags to groups
1145 Two new permission are included:
1147 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1148 'Administration -> Server Administration -> Copy Tag Types'
1149 * `ADMIN_COPY_TAG`: required to create a new tag under
1150 'Administration -> Local Administration -> Copy Tags'
1152 The existing permission `UPDATE_COPY` controls whether or not a user
1153 can link copies to tags.
1157 A new library setting, 'Enable Digital Bookplate Search', controls
1158 whether to display a 'Digital Bookplate' field in the search index
1159 drop-downs in the catalog. A 'Digital Bookplate' search will include
1160 all records that have a copy that matches the tag specified by the user.
1161 It should be noted that this library setting does not affect the
1162 display of copy tags on the catalog record summary page.
1167 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1168 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1169 The call number prefix and suffix, when present, are now included in
1170 subfields $k and $m of the 852 field when running `marc_export` with
1171 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1172 server configured to embed item data in 852 fields, the affixes are now
1173 included in subfields $k and $m.
1183 Batch Editing of Patron Records
1184 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1185 There is a now a new interface analogous to the Copy Bucket interface
1186 to select and group a set of users into a User Bucket.
1187 The addition of users to a User Bucket is possible from the Patron Search
1188 interface by the use of a new grid Action, and directly on the User Bucket
1189 interface by user barcode. It is also possible to add users to a User
1190 Bucket by uploading a text file that contains a list of user barcodes.
1192 From this interface it is possible to perform a set of specific batch update
1193 operations on user records.
1198 These fields can now be changed in batch via an action on the User Bucket
1199 grid if the staff user has the `UPDATE_USER` permission:
1202 * Primary Permission Group (group application permissions consulted)
1204 * Home Library (`UPDATE_USER` checked against both old and new value)
1205 * Privilege Expiration Date
1206 * Barred flag (`BAR_PATRON` permission consulted)
1207 * Internet Access Level
1209 Changes made in this interface can be rolled back.
1211 As a batch process, rather than a direct edit, this mechanism explicitly skips
1212 processing of Action/Trigger event definitions for user update.
1217 The batch edit mechanism also allows for the batch deletion of user. The staff
1218 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1220 Changes made in this interface can be rolled back.
1222 As a batch process, rather than a direct edit, this mechanism explicitly skips
1223 processing of Action/Trigger event definitions for user deletion.
1225 This mechanism does not use the Purge User functionality, but instead simply
1226 marks the users as deleted.
1228 Editing Statistical Category Entries
1229 ++++++++++++++++++++++++++++++++++++
1231 All users in the bucket can have their Statistical Category Entries
1232 modified. Unlike user data field updates, modification of Statistical
1233 Category Entries is permanent and cannot be rolled back.
1235 As a batch process, rather than a direct edit, this mechanism explicitly skips
1236 processing of Action/Trigger event definitions for user update.
1238 New Service Requirement
1239 +++++++++++++++++++++++
1241 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1242 unused in production. If this service has been removed from the configuration
1243 of a live Evergreen instances, it will need to be added back in order for
1244 batch user editing to succeed.
1249 Honor Timezone of the Acting Library
1250 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1255 * Display day-granular due dates in the circulating library's timezone.
1256 * Only display the date portion of the due date for day-granular circulations.
1257 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1258 * Provide infrastructure for more advanced formatting of timestamps.
1259 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1264 This is a followup to the work done for 2.12, where we added the ability
1265 for the client to specify a timezone in which timestamps should be interpreted
1266 in business logic and the database.
1268 Most specifically, this work focuses on circulation due dates and the closed
1269 date editor. Due dates, where displayed using stock templates (including
1270 receipt templates) and used for fine calculation, are now manipulated in the
1271 library's configured timezone. This is controlled by the new 'lib.timezone'
1272 setting available via the Library Settings Editor, loaded from the server when
1273 required. Additionally, closings are recorded in the library's timezone so that
1274 due date calculation is more accurate. The closed date editor is also
1275 taught how to display closings in the
1276 closed library's timezone. Closed date entries also explicitly record if they
1277 are a full day closing, or a multi-day closing. This significantly simplifies
1278 the editor, and may be useful in other contexts.
1280 To accomplish this, we use the moment.js library and the moment-timezone addon.
1281 This is necessary because the stock AngularJS date filter does not understand
1282 locale-aware timezone values, which are required to support DST. A simple
1283 mapper translates the differences in format values from AngularJS date to
1286 Of special note are a set of new filters used for formatting timestamps under
1287 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1288 filters provide the functionality, and autogrid is enhanced to make use of
1289 these where applicable. egGrid and egGridField are also taught to accept
1290 default and field-specific options for applying date filters. These filters may
1291 be useful in other or related contexts.
1293 The egDueDate filter, used for all existing displays of due date via Angular
1294 code, intentionally interprets timestamps in two different ways WRT timezone,
1295 based on the circulation duration. If the duration is day-granular (that is,
1296 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1297 of seconds) then the date is interpreted as being in the circulation library's
1298 timezone. If it is an hourly loan (any duration that does not meet the
1299 day-granular criterium) then it is instead displayed in the client's timezone,
1300 just as all other timestamps currently are, because of the previous Evergreen
1303 The public catalog is adjusted to always display the due date in the circulating
1304 library's timezone. Because the public catalog displays only the date portion of the due
1305 date field, this difference is currently considered acceptable. If this proves
1306 to be a problem in the future, a minor adjustment can be made to match the
1307 egDueDate filter logic.
1309 Now that due dates are globally stored in the configured timezone of the
1310 circulating library, the automatic adjustment to day-granular due dates needs
1311 to take those timezones into account.
1313 An optional SQL command is provided by the upgrade script to retroactively
1314 adjust existing due dates after library configuration is complete.
1320 Enhancements to Hard Due Date Functionality
1321 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1322 It will now be possible to delete Hard Due Date Values for dates that have
1323 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1324 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1325 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1330 Patron Search by Birth Date
1331 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1332 * Now you can include the patron birth year and/or birth month and/or
1333 birth day when searching for patrons using the web staff client.
1334 * Day and month values are exact matches. E.g. month "1" (or "01")
1335 matches January, "12" matches December.
1336 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1337 1915, 1599, etc. For exact matches use the full 4-digit year.
1341 Patron Search from Place Hold
1342 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1343 This feature allows staff members, when placing a
1344 hold on behalf of a patron in the web staff client, to search for
1345 patrons by names and other searchable patron information, rather than
1346 relying on barcode alone. In particular, after performing a catalog
1347 search or going to a specific bib record and clicking the 'Place Hold'
1348 button, the form now includes a 'Patron Search' button. This button
1349 will open a dialog allowing the staff member search for and select
1355 Retrieve Recent Patrons
1356 ^^^^^^^^^^^^^^^^^^^^^^^
1358 Adds a new library setting 'Number of Retrievable Recent Patrons'
1359 ('ui.staff.max_recent_patrons') that specifies the number of recently
1360 retrieved patrons that can be re-fetched from the staff client.
1362 A value of 0 means no recent patrons can be retrieved.
1363 A value greater than 1 means staff will be able to retrieve multiple
1364 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1366 The default value is 1 for backwards compatibility.
1373 Fuller title in XUL client Simplified Pull List
1374 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1375 The Simplified Pull List in the XUL client will now display subfields 245$n and
1376 $p in the title field. The addition will make it easier for staff to distinguish
1377 between different parts or seasons in a series.
1383 Transit Cancel Time and Terminology Change
1384 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1389 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1390 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1391 are preserved in the database, though still not visible to the end user in the staff client.
1392 This allows for better tracking of when transits are canceled for the purposes of knowing
1393 which staff member canceled the transit, etc.
1395 NOTE: This change may require the re-creation of transit reports to filter out canceled
1396 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1397 Is NULL' will suffice.
1399 "Canceled Transit" Terminology Change
1400 +++++++++++++++++++++++++++++++++++++
1402 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1403 For internal continuity, however, the following permission codes have not changed:
1406 * `ABORT_REMOTE_TRANSIT`
1407 * `ABORT_TRANSIT_ON_LOST`
1408 * `ABORT_TRANSIT_ON_MISSING`
1416 Offline Circulation Available in Web Staff Client
1417 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1418 Offline circulation is now available in the web staff client. In order to use the
1419 offline interface, users must first log into the web staff client, perform
1420 a patron search, select a user from the results, and open the patron editor
1421 interface to collect all the relevent configuration information for the
1422 workstation. In addition, the offline interface available from the Circulation
1423 menu provides a 'Download block list' button for users who are logged in.
1425 As is the case in the old staff client, users can check materials in and out,
1426 renew items, and create new patron accounts while offline. The patron fields
1427 available in the offline patron registration editor are the same ones that
1428 are available to staff when working online.
1432 Add Circ Modifier to Record Detail Page in Staff TPAC
1433 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1434 The circulation modifier field is added to the table of copies to make
1435 more information available to staff without having to open
1442 Date+Time Format Settings for Web Client
1443 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1445 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1446 and adds two settings for use with the webstaff client:
1448 * 'Format Dates with this pattern'
1449 * 'Format Date+Time with this pattern'
1451 These settings use format strings as documented here:
1453 https://docs.angularjs.org/api/ng/filter/date
1455 There is overlap with how the Dojo formats worked, but also some differences.
1457 The original 'Format Dates' and 'Format Times' settings worked together, but the
1458 new settings work independently. Certain field elements will use one, and
1459 certain field elements will use the other. These distinctions are hard-coded
1460 in the various UI templates, with the idea being that timestamp fields in
1461 which the date component alone is sufficient information (for example, date of birth)
1462 will use the 'Format Dates' setting. Fields where the time component is
1463 important (for example, checkout time) will use the 'Format Date+Time' setting.
1465 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1466 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1472 Global Option to Remove Sound for a Specific Event
1473 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1474 A new `nosound.wav` file has been added to the web client. The file can be used
1475 to globally disable audio alerts for a specific event on an Evergreen system.
1477 For example, to silence the alert that sounds after a successful patron search:
1481 mkdir -p /openils/var/web/audio/notifications/success/patron/
1482 cd /openils/var/web/audio/notifications/success/patron/
1483 ln -s ../../nosound.wav by_search.wav
1490 The official Evergreen manual has been split into eight new manuals, each
1491 designed for a specific audience. This new approach is designed to make
1492 the documentation more readable and usable.
1494 The specific audiences for the new manuals are:
1496 * Acquisitions staff
1499 * Public services staff who use the public catalog
1501 * System administrators who use the command line
1502 * System administrators who use the Web client
1503 * System administrators and programmers who wish to integrate Evergreen
1504 with other technologies
1506 All manuals are available at http://docs.evergreen-ils.org
1512 Improvements to ebook API
1513 ^^^^^^^^^^^^^^^^^^^^^^^^^
1515 Evergreen now supports checking out and placing holds on
1516 OverDrive and OneClickdigital ebook titles from within the public
1517 catalog. This is an experimental feature. It is not recommended for production
1518 use without careful testing.
1520 When ebook integration is enabled, a "Check Out E-Item" link will be
1521 displayed when viewing an ebook title from a supported vendor in the
1522 catalog. Clicking on the link allows the user to check out and download
1523 that title from the vendor directly within the catalog.
1525 If no copies are available for the title, a "Place Hold on E-Item" link
1526 is displayed instead, and the user may place a hold on the title. (Note
1527 that some vendors require the user's account to have an email address
1528 before permitting a hold.)
1530 My Account includes the ability to view current ebook checkouts and
1531 holds, download already-checked-out titles, and cancel holds.
1533 For API integration to work, you need to request API access from the
1534 vendor, and the vendor must have a way of authenticating your patrons.
1535 Your Evergreen system also needs to be configured for ebook API
1536 integration, following the instructions in the command line system
1537 administration manual
1540 This feature assumes that you are importing MARC records supplied by the
1541 vendor into your Evergreen system, using Vandelay or some other MARC
1542 import method. This feature does not search the vendor's online
1543 collections or automatically import vendor records into your system; it
1544 merely augments records that are already in Evergreen.
1546 Improvements to Bill Payment Pages
1547 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1548 The bill payment pages in the public catalog have been revamped
1551 * use the term "charges" instead of "fees"
1552 * include images of credit cards accepted
1553 * make the default print receipt template match other itemized receipts;
1554 note that this change is not automatically applied when upgrading.
1555 * display billing type
1556 * add button to pay only selected charges
1557 * reformat the credit card number input page
1563 Clickable Copy Locations
1564 ^^^^^^^^^^^^^^^^^^^^^^^^
1565 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1566 the associated copy location will display as a link in the public catalog summary display.
1567 This link can be useful for retrieving maps or other directions to the copy
1568 location to aid users in finding material.
1573 Download Checkout History CSV Fixed for Large Number of Circulations
1574 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1575 Downloading checkout history as a CSV from My Account has been fixed
1576 for users with a large circulation history. Previously, this would
1577 time out for patrons with more than 100 or so circulations.
1579 This feature no longer uses the action/trigger mechanism and the public catalog
1580 now generates the CSV directly. The old action/trigger code is still
1581 present in the database and should be removed at some point in the
1587 Google Books Preview Rewrite
1588 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1589 The Google Books Preview functionality in record detail pages has been
1590 rewritten to modernize its style and optimize its performance:
1592 * The Dojo JavaScript framework is no longer used, saving approximately
1593 150K of JavaScript and CSS and four network requests per page load.
1594 * The Embedded Viewer is not loaded unless a possible preview is found,
1595 saving more network and memory overhead.
1596 * The Google Books Loader is used to load the Embedded Viewer instead of the
1597 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1599 * All variables are self-contained and do not pollute the global namespace.
1600 * Event listeners are registered to handle clicks, rather than attaching
1601 `href="javascript:function()"` to <a> elements.
1602 * Book previews are displayed in a panel sized according to the viewport
1603 of the browser, improving its appearance on both mobile and desktop
1605 * The rewritten code is now served up directly from
1606 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1611 jQuery for the Public Catalog
1612 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1613 This release adds optional support for jQuery in the public catalog. This support
1614 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1615 `config.tt2` template.
1621 New Popularity Parameters
1622 ^^^^^^^^^^^^^^^^^^^^^^^^^
1623 New popularity parameters for in-house use over time and for count of distinct
1624 organizational units that own a title are now available. Evergreen sites
1625 can use these parameters to create new statistical popularity badges for
1626 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1628 The in-house use parameters will apply a badge to titles that have the most
1629 in-house use activity over time. The organizational unit count parameter
1630 will apply a badge to titles owned by the most number of libraries in a
1631 consortium. Ownership is determined by the copy's circulation library.
1636 Option to Suspend Holds at the Time They are Placed
1637 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1638 Users now have the option to suspend a hold at the same time they place the
1639 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1640 who want to suspend a hold at the time it is placed. There is also an option
1641 to set the activation date at the same time. This option is also available
1642 when placing holds on a batch of titles from 'My List' and will apply to
1643 all the titles in the batch.
1654 Fix to reporter.classic_current_circ View
1655 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1656 The `reporter.classic_current_circ` view, which is part of some
1657 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1658 has been fixed to not exclude loans for patrons who do not have a
1659 billing address set. Users of this view should rerun
1660 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1665 New Report Source Table Allowing Report of "Last" Deleted copy
1666 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1668 This source table allows you to construct a clever aggregate report template
1669 which will report bibliographic IDs where a library or a group of libraries
1670 no longer have a copy attached but *had* a copy attached. This is especially
1671 useful when a holdings sync is required with an external vendor.
1674 Instructions for creating a report template with this source:
1676 * Create a new report template using "Library Holdings Count with Deleted" as the source
1677 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1678 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1679 * 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"
1680 * Add "Bib ID" to Displayed Fields
1681 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1682 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1683 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1686 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1687 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1688 specified date range. Unfortunately the user will have to manually type the date range without the date
1689 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1690 copy and more than two deleted copies."
1695 Add Provider to Provider Note Link
1696 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1697 The Provider reporting source now includes a link to the Provider Note reporting source.
1702 Link ILS User and Working Location Reporting Sources
1703 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1704 The Working Location reporting source now has labels
1705 and it is now linked to the ILS User reporting source, allowing
1706 reports to display or filter on staff working location.
1711 New Circulation Report Source "All Circulation Combined Types"
1712 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1714 This report source will allow you to create a single report template for all of the following:
1717 * In-house uses of non-cataloged items
1719 * Circulations of non-cataloged items
1721 To distinguish between these different types of library use, it's important to display these columns
1722 in your report templates:
1731 Reports Template Searching
1732 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1733 A new form appears along the top of the reports interface for searching
1734 report templates. Once found, typical template actions (e.g. create new
1735 report) are available from within the results interface.
1737 Searches may be performed across selected (visible) folders or all
1738 folders visible to the logged in user.
1740 Searches are case-insensitive, any word order, with left-anchored words.
1741 All searched words must appear in at least one of the searched fields.
1746 * Searching for 'stat cat' matches:
1748 ** statistical category
1749 ** categories, statistical
1750 ** patrons (stat cat)
1751 * Searching for 'stat cat' does not match:
1753 *** both words must be present in the searched field(s)
1755 *** location contains 'cat' but it's not left-anchored.
1760 The templates, reports, and output interfaces now support paging via
1761 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1773 Web Staff Client Serials Module
1774 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1775 The serials module has been ported over to the web staff
1776 client, implementing a unified serials interface that combines
1777 ideas from both the serial control view and alternate serials
1778 control view from the old staff client.
1780 In addition to carrying over functionality that was available
1781 in the old staff client, several new features are included:
1783 * the ability to save prediction pattern codes as templates
1784 that can be shared and reused within an Evergreen database
1785 * a more streamlined interface for managing subscriptions,
1786 distributions, and streams
1787 * it is no longer necessary to create a starting issue in
1788 order to predict a run of issues; the dialog box for
1789 generating a set of predicted issues now lets you specify
1790 the starting point directly.
1791 * the ability to more directly edit MFHDs
1793 The new serials interfaces can be accessed from the record
1794 details page via a Serials drop-down button that links to
1795 a subscription management page, a quick-receive action, and
1796 a MFHD management page. There is also a new 'Serials Administration'
1797 page where prediction pattern and serial copy templates can
1808 SIP Bugfix Changes How Encoding Is Determined in Configuration
1809 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1811 The combined fix for the above mentioned SIP bugs alters the way that
1812 SIPServer looks up the output encoding in the configuration file (typically
1813 `oils_sip.xml`). SIPServer now looks for the encoding in the following
1816 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1817 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1818 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.
1819 4. If none of the above exist, then the default encoding (ASCII) is used.
1821 Number 3 is provided to ease the transition to the new code. It is
1822 the current location of the +encoding+ element in the sample
1823 configuration file and as such, where it is likely to be found in
1824 actual files. It is recommended that you alter your configuration to
1825 move this element out of the +implementation_config+ element and into
1826 its parent +institution+ element. Ideally, SIPServer should *not* look into
1827 the implementation config, and this check may be removed at some time
1835 Web Client Acknowledgments
1836 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1838 The project to develop a new browser-based web client launched four
1839 years ago at the September 2013 Evergreen developer hack-a-way when the
1840 developer community voted to move away from the XUL client and explore other
1841 platforms. The first web client preview became available in Evergreen 2.7 when
1842 circulation was available in the new platform.
1844 The browser-based client is available due to the work of many coders, testers,
1845 bug reporters, documentors, translators, project managers, spec writers, funders
1846 and other contributors over the past four years.
1848 The Evergreen project would like to acknowledge the following organizations
1849 that funded development of the Web Staff Client:
1852 * British Columbia Libraries Cooperative
1853 * Consortium of Ohio Libraries
1855 * Georgia Public Library Service
1856 * Grand Rapids Public Library
1858 * Kenton County Public Library
1859 * King County Library System
1862 * Pennsylvania Integrated Library System
1863 * Pioneer Library System
1866 The Evergreen project would also like to thank the following individuals who
1867 contributed code, translations, documentation patches, tests, bug reports,
1868 technical specifications, and project management to the Web Staff Client:
1905 * Freddy Enrique Pelayo Huapalla
1931 Evergreen 3.0 Acknowledgments
1932 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1934 The Evergreen project would like to acknowledge the following
1935 organizations that commissioned developments in this release of
1939 * British Columbia Libraries Cooperative (BC Sitka)
1941 * Georgia Public Library Service
1942 * King County Library System
1944 * Pennsylvania Integrated Library System
1945 * Pioneer Library System
1947 We would also like to thank the following individuals who contributed
1948 code, translations, documentation patches, and tests to this release of
1997 We also thank the following organizations whose employees contributed
2000 * British Columba Libraries Cooperative
2004 * Emerald Data Networks, Inc.
2005 * Equinox Open Library Initiative
2007 * Grand Rapids Public Library
2008 * Indiana State Library
2010 * King County Library System
2011 * Lake Agassiz Regional Library
2012 * Laurentian University
2013 * Linn-Benton Community College
2015 * Merrimack Valley Library Consortium
2017 * North of Boston Library Exchange
2018 * Pennsylvania Integrated Library System
2019 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2021 * Traverse Area District Library
2023 We regret any omissions. If a contributor has been inadvertently
2024 missed, please open a bug at http://bugs.launchpad.net/evergreen/