1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.7.
10 * Fixes an issue that caused records with located URIs to be
11 retrieved in Copy Location and Copy Location Group searches.
12 * Fixes an error message that appeared in the search box
13 while placing hold after an advanced search.
14 * Fixes regression errors in the search results page.
15 * Removes redundant call numbers from the Show More Details
17 * Adds spaces between subfields when suggesting a call
18 number for a new volume.
19 * MarcXML exports from the MARC Batch Import/Export ->
20 Export Records screen now downloads the file, rather than opening
22 * Adds some padding to the bottom of Web Client interfaces.
23 * Fixes an issue that prevented users from searching for
24 receivable issues using Database ID or ISSN in the Serials
25 Batch Receive interface.
26 * The Item Status Circulation Library column now displays a
27 shortname rather than the full library name.
28 * The Item Status Remaining Renewals column now displays
30 * The Item Status now has a "Last Renewal Workstation" column
32 * Fixes the circulation counts displayed in Item Status Details.
33 * Staff members can now manually override the patron juvenile
34 flag value, regardless of the patron's date of birth.
35 * Checkboxes on patron registration screen are now properly aligned
37 * The user permission group dropdowns in the patron registration,
38 edit, and search interfaces now have scrollbars.
39 * The Merge Patrons interface now displays the date of birth.
40 * When a patron summary contains an image of the patron,
41 that image tag now has a null alt attribute to remove it from
42 the flow of a screen reader.
43 * The MARC editor now handles 008 fields better.
44 * Corrects an issue that caused the transit dialog showed the
46 * The cursor in the in-house use screen now automatically goes
48 * The novelist entry in `eg_vhost.conf` includes two new
50 * Corrects an issue with the `--max-sleep` argument on the
51 `action_trigger_runner.pl` support script.
52 * Corrects an issue with how the `eg_pbx_allocator.pl` script
53 detects an existing lock file.
54 * The 3.0.2-3.0.3 upgrade script disables triggers before
55 recalculating bib visibility.
56 * Fixes an issue where multiple copies with different values for required
57 statistical categories could not be edited and saved in batch.
62 We would like to thank the following individuals who contributed code,
63 tests and documentation patches to the 3.0.8 point release of
89 This release contains bug fixes improving on Evergreen 3.0.6.
91 * Fixes a performance issue with the Patron Billing History screen and
92 other screens that cause Flattener.pm to re-create joins
94 * Fixes an issue that prevented patron alerts from showing to staff at
96 * Corrects the "Holdable" attribute display on the Item Status detailed
98 * Fixes the ability to delete multiple copies from Item Status.
102 We would like to thank the following individuals who contributed code,
103 tests and documentation patches to the 3.0.7 point release of
117 This release is a security release that fixes cross-site scripting
118 (XSS) vulnerabilities in the Evergreen public catalog. This release
119 also includes several other bugfixes improving on Evergreen 3.0.5.
121 Security Issue: XSS Vulnerability in Public Catalog
122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123 This release fixes several cross-site scripting (XSS) vulnerabilities
124 in the public catalog. When upgrading, Evergreen administrators should
125 review whether any of the following templates have been customized
126 or overridden. If so, either the template should be replaced with the
127 stock version or the XSS fix (which entails adding the `| html` filter
128 in several places) applied to the customized version.
130 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
131 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
132 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
134 Note that exploiting the XSS vulnerabilities fixed in this release
135 would require either the ability to create maliciously-constructed
136 MARC bibliographic or holdings records or the ability to set a
137 maliciously constructed organizational unit name.
141 Evergreen 3.0.6 also includes the following changes:
143 * When using 'Selection Lists -> Edit MARC Order Record' in the web
144 staff client, now only one click is required to save the MARC
145 record rather than two.
146 * The volume/copy editor in the web staff client now better handles
147 editing multiple items that have different sets of statistical
148 category values assigned to them.
149 * The act of merging bibliographic records now updates bookbags
150 that referred to the source bibliographic record rather than
151 effectively deleting entries for that record.
152 * Additional columns were added to the Holds Pull List in the
154 * The patron registration form in the web staff client now correctly
155 manages setting user preferences.
156 * An error in a pgTAP unit test was corrected.
160 We would like to thank the following individuals who contributed code,
161 tests and documentation patches to the 3.0.6 security release of
177 This release contains bug fixes improving on Evergreen 3.0.4.
179 * The MARC Editor in the Web staff client now wraps long fields.
180 * The MARC Editor no longer allows catalogers to enter new lines
182 * Fixes an issue that prevented serials items from being deleted or
184 * The Web staff client Check In screen no longer reloads the whole
185 page multiple times each time an item is scanned.
186 * Fixes an issue that displayed the oldest -- rather than the newest
187 -- transit in the Web staff client Item Status page.
188 * Fixes an issue that prevented the reports module from being displayed
190 * Fixes an issue in the Web staff client reports module that caused
191 syntax errors in reports that use virtual fields and joins.
192 * Fixes an issue that prevented several dropdown menus in the Web staff
193 client from activating.
194 * Fixes an issue that created duplicate copy data when copies or
195 volumes with parts were transferred.
196 * Fixes the Trim List feature in the Web staff client Check In screen.
197 * The Item Status grid now displays the Circulation Modifier.
198 * Restores missing data from the Profile column in Place Hold patron
200 * Fixes an issue with the http -> https redirect on Apache 2.4.
201 * Fixes an color contrast accessibility issue in the Web staff
202 client and adds underlining to links in grid cells for added accessibility.
203 * Adds automated regression and unit tests for the Web staff client
205 * Adds a process for spell-checking the official documentation.
206 * Adds a script that simplifies the release process related to translations.
211 We would like to thank the following individuals who contributed code,
212 tests and documentation patches to the 3.0.5 point release of
217 * Blake Graham-Henderson
232 This release contains bug fixes improving on Evergreen 3.0.3:
234 * Fixes a bug that caused all searches limited by shelving location to
236 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
237 rather than the ordering agency's SAN.
238 * Fixes a bug that prevented Safari/iOS users from logging in to the
240 * Fixes a bug that prevented users from using the browse interface.
241 * Fixes a bug in the Item Status List view that caused incorrect due
243 * Approval code is now a required field in the web client's patron
244 credit card payment form.
245 * Fixes a bug with credit card payments that caused a receipt to print
246 showing that the patron paid the bill when the payment had not actually
248 * Fixes a bug that prevented the EDI translator from being installed on
250 * Fixes a bug that caused entries to show up multiple times in the
251 Items Out and Holds tabs in the patron record.
252 * Fixes a bug that caused grids on Bills and Patron Messages
253 screens to not display properly.
254 * The following fields are now available for the Checkout and Items Out
261 ** money_summary.balance_owed
262 ** money_summary.total_paid
263 ** money_summary.total_owed
268 * The following fields are now available on the Bill Payment receipt templates:
278 * Payment type is now a column in the payments tab of the patron record
279 Bill History section.
280 * The "Replace Barcode" function now makes it more difficult for staff
281 members to attempt to create blank patron barcodes.
282 * The patron bills screen now prevents staff members from double-clicking
283 on the Apply Payment button (which otherwise would apply two payments).
284 * Fixes a bug that prevented patrons attached to statistical categories
285 from displaying in the patron search-to-hold dialog.
286 * Fixes a performance issue related to uploading CSV files of barcodes
287 to the item status and patron bucket interfaces.
288 * Fixes several small bugs in the Spanish translation.
289 * Fixes a performance bug related to patrons logging in by barcode.
293 We would like to thank the following individuals who contributed code,
294 tests and documentation patches to the 3.0.4 point release of
316 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
317 update the visibility attributes of all bibs that make use of Located URIs or
318 bib sources. It may take a while to run on large datasets. If it it running
319 too long, it can be canceled and the following psql commands will create and
320 run a script that will perform the same action serially over time without
321 blocking writes to bibs:
324 \o /tmp/luri_visibility_update.sql
325 SELECT 'UPDATE biblio.record_entry SET ' ||
326 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
327 'WHERE id = ' || id || '; SELECT ' || id || ';'
328 FROM biblio.record_entry
330 SELECT DISTINCT cn.record
331 FROM asset.call_number cn
333 AND cn.label = '##URI##'
336 FROM asset.uri_call_number_map m
337 WHERE m.call_number = cn.id
340 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
345 \i /tmp/luri_visibility_update.sql
348 It will output the id of each updated bib so that the script can be killed
349 and then edited to remove completed bibs. The remainder can be run at a
352 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
353 we do NOT update the bib's visibility attributes, as doing so causes a loop
354 and an eventual trigger stack violation. This flag should ONLY be used when
355 forcing reingest of record attributes (NOT visibility attributes), search,
356 facet, and display fields, so if using this flag under normal operation,
357 proceed at your own risk and know that Located URI and bib source changes
358 will not be reflected in the visibility attributes of the record.
362 This release contains several bug fixes improving on Evergreen 3.0.1:
364 * Fixes several issues related to the display of located URIs and records with
365 bib sources in search results.
366 * Setting `opac_visible` to false for a copy location group now hides only
367 the location group itself, rather than also hiding every single copy in the
369 * Fixes a bug that prevented the copy editor from displaying the _fine level_
370 and _loan duration_ fields.
371 * The "Edit Items" grid action in the Item Status interface will now open
372 in the combined volume/copy editor in batch. This makes the behavior
373 consistent with the "Edit Selected Items" grid action in the copy
375 * Staff members are now required to choose a billing type when creating a
376 bill on a user account.
377 * The Web client now provides staff users with an alert and option to
378 override when an item with the Lost and Paid status is checked in.
379 * Fixes a bug where the Web client offline circ interface was not able
380 to set its working location.
381 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
383 * The MARC editor in the Web staff client now presents bib sources in
385 * Both circulation and grocery bills are now printed when a staff user selects
386 a patron account and clicks "Print Bills".
387 * Fixes an issue in the XUL serials interface the "Receive move/selected"
388 action from succeeding.
389 * Fixes a typo in the user password testing interface.
393 We would like to thank the following individuals who contributed code,
394 tests and documentation patches to the 3.0.3 point release of
413 This release contains several bug fixes improving on Evergreen 3.0.1:
415 * Copy templates created in XUL Holdings Maintenance will now be
416 automatically converted and displayed in the web staff client's
418 * The list of report templates now includes a column indicating whether
419 the template was originally created in the XUL staff client or the web
420 staff client; staff need to know this since report templates created in
421 one interface cannot be edited in the other.
422 * Call number prefixes and suffixes are now displayed in various grids
423 in the web staff client, including
424 ** Pending Copy Buckets
426 ** Checkin/Capture Holds
428 ** Patron Bills History
435 ** Bib Record View Holds
437 * Many patron fields have been redacted from the web staff client's patron
438 and record holds grids, leaving patron name, username, and ID.
439 * Fixes two bugs where patron records could fail to be saved upon editing.
440 * The web staff patron editor now better warns staff users about
441 duplicate names, IDs, phone numbers, and email addresses.
442 * Human readable labels are now displayed for certain fields in standing
444 * The patron summary in the web staff client now correctly displays
445 primary and secondary ID values.
446 * The web staff client's billing full details page now displays
447 information about the staff user that created a payment.
448 * The web staff client now requires staff users to explicitly set a
449 billing type when adding a manual bill.
450 * The web staff client's patron bill annotation modal now works.
451 * Patron barcode search completion in the web staff client now allows
452 the user to select from all of the matching patron records.
453 * The Hold Shelf Slip print template in the web staff client now has
454 access to the call number.
455 * The Checkout Receipt print template in the web staff client now can
456 include summary financial information, incuding current balance, total
457 paid on outstanding fines, and total owed.
458 * The web staff print templates for current and historical bills can
459 now include copy barcode and title.
460 * Fixes a bug that resulted in some catalog searches unexpectedly
462 * Fixes a bug that resulted in catalog searches that specify a location
463 limit returning incorrect results.
464 * Fixes a bug where deleted copies could make records visible in the
466 * Fixes a bug where certain queries on copies used in the public catalog
468 * Fixes a bug place a hold request in the public catalog could result
469 in "forgetting" the type and library of the user's previous search.
470 * The web staff client now respects staff user session timeouts, and
471 will log out all open tabs if a user's session has timed out.
472 * The web staff Z39.50 page will now give the staff user an alert if
473 they attempt to import a record with a duplicate TCN.
474 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
475 entries from being deleted.
476 * Fixes a bug that made using the volume/copy editor to change a copy's
478 * The administration interface for hard due dates now ensures that
479 new (or edited) ceiling dates have their time component set to end
480 of day, resolving an issue where ceiling dates would not be applied
481 during the ceiling date itself.
482 * The web staff client can now include dynamic information in browser
483 tab titles, e.g., "Smith, Jane - Checkout".
484 * The Concerto sample data set now includes data allowing for testing
485 placing holds on monographic parts.
486 * Asset merging during bibliographic record merging now correctly
487 recognizes call number prefixes and suffixes and deletes disused
489 * Fixes a bug where displaying user surveys could result in PCRUD
491 * Fixes a bug where pg_restore of an Evergreen database could fail
492 to create certain indexes on the `actor.usr` table.
496 We would like to thank the following individuals who contributed code,
497 tests and documentation patches to the 3.0.2 point release of
528 This release contains several bug fixes improving on Evergreen 3.0.0
530 * Fixes a bug in the web staff client that prevented initials from being
531 stored with copy notes.
532 * Adds billing types that may have been missed by systems that were
533 running Evergreen prior to the 1.4 release.
534 * Fixes a web staff client bug with the CSV export option available from
535 the Import Queue in the MARC Batch Import/Export interface.
536 * Adds the missing copy alert field in the web client's volume/copy
538 * Fixes a bug where the setting to require date of birth in patron
539 registration was not being honored in the web staff client.
540 * Fixes a bug in the web staff client patron registration form where the
541 password wasn't generating from the last four digits of the patron's
543 * Fixes an issue in the web staff client where the complete barcode did
544 not display in some interfaces when partial barcodes were scanned.
545 * Fixes an HTML error in the new copy tags that display on the record
547 * Fixes a web staff client bug where recording a large number of in-house
548 uses at one time doesn't display a confirmation dialog once it hits the
550 * Adds a _Print Full Grid_ action in the web staff client
551 holds pull list to allow staff to print the entire pull list as it
552 displays on the screen. This change also changes the _Export CSV_ action
553 to an _Export Full CSV_ option.
554 * Fixes an issue with the Patron Messages interface that prevented it
555 from saving column configuration changes in the web staff client.
556 * Fixes a bug in the web staff client where a billing prompt did not
557 correctly display after marking an item damaged in those systems that
558 have enabled the setting to bill for damaged items.
559 * Adds an option to the specific due date feature that allows saving
560 that due date until logout. This allows all circulations from a given
561 workstation to be due on the same date.
565 We would like to thank the following individuals who contributed code,
566 tests and documentation patches to the 3.0.1 point release of
588 The minimum version of PostgreSQL required to run Evergreen 3.0 is
589 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
591 Change to Names of Shared Libraries
592 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
593 OpenSRF 3.0 changes how the shared libraries for services written in
594 C are named. If upgrading from an earlier version of Evergreen,
595 `opensrf.xml` should be edited so that shared library file names
596 listed in the `<implementation>` tag start with "lib". For example,
599 ---------------------------------------------------------------------
601 <language>C</language>
602 <implementation>oils_cstore.so</implementation>
603 ---------------------------------------------------------------------
605 should be changed to:
608 ---------------------------------------------------------------------
610 <language>C</language>
611 <implementation>liboils_cstore.so</implementation>
612 ---------------------------------------------------------------------
614 SIP Bugfix Requires SIPServer Upgrade
615 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
617 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
618 crash" requires that you also upgrade SIPServer with the fix for
619 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
620 SIP client problems." This means that if you use SIP2 with Evergreen,
621 you must also upgrade SIPServer to the latest commit in the Git
622 repository. Conversely, if you upgrade SIPServer to the latest commit
623 in Git, you must also upgrade Evergreen or, at least, apply the patch
624 for Launchpad Bug 1542495. These two patches are complementary and
625 cannot be applied independently of one another.
627 `open-ils.auth.login`
628 ~~~~~~~~~~~~~~~~~~~~~
629 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
630 API's in the `opensrf_core.xml` file.
635 ---------------------------------------------------------------------
636 --- a/Open-ILS/examples/opensrf_core.xml.example
637 +++ b/Open-ILS/examples/opensrf_core.xml.example
638 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
640 <match_string>open-ils.auth.authenticate.verify</match_string>
641 <match_string>open-ils.auth.authenticate.complete</match_string>
642 + <match_string>open-ils.auth.login</match_string>
643 <match_string>open-ils.auth_proxy.login</match_string>
644 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
645 <match_string>open-ils.actor.user.password</match_string>
646 ---------------------------------------------------------------------
650 Administrators of Evergreen who use RTL locales and who have customized
651 `style-rtl.css.tt2` should now incorporate their customizations into
654 Multi-Time Zone Installations
655 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
657 For Evergreen consortia that span more than one time zone, the following
658 query will adjust all historical, unaged circulations so
659 that if their due date field is pushed to the end of the day, it is done
660 in the circulating library's time zone, and not the server time zone.
662 It is safe to run this after any change to library time zones.
664 Running this is not required, as no code before this change has
665 depended on the time string of '23:59:59'. It is also not necessary
666 if all of your libraries are in the same time zone, and that time zone
667 is the same as the database's configured time zone.
676 for ou_id in select id from actor.org_unit loop
677 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
678 if new_tz is not null then
679 update action.circulation
680 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
681 where circ_lib = ou_id
682 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
691 Deprecation of XUL staff client
692 -------------------------------
693 Starting with the release of 3.0.0, patches that fix XUL bugs will not
694 be merged into master or backported unless they meet one or more of
695 the following conditions:
697 a. the bug is a security issue
698 b. the bug involves the destruction of data
699 c. the bug is a regression of functionality in the XUL staff client
700 introduced by other work done to Evergreen
702 Under no circumstances will XUL staff client feature enhancements be merged.
704 This policy will continue through the 3.0.x and 3.1.x maintenance
705 release cycles, and will become moot upon the release of 3.2.0, when
706 the XUL staff client is slated to be entirely removed.
715 Evergreen 3.0 features a new, modern staff client that runs in the web browser
716 and can be used on desktop and mobile devices. All functional areas of the
717 system, including circulation, cataloging, acquisitions, serials, reports,
718 booking, administration, and offline circulation, are available in the new staff
719 client. Chrome and Firefox are officially supported for use with the web client.
721 Library staff will no longer need to download separate software to perform most
722 actions in Evergreen. A Chrome plugin called Hatch will be available as a
723 separate installation for workstations that require seamless, dialog-free
724 printing to multiple printers.
726 In addition to adding more portability and stability, the new staff client also
727 presents a cleaner and more modern interface for users. By virtue of running in
728 a browser, actions that users are accustomed to performing on other web sites
729 should now be available in the Evergreen client.
731 The old, XUL client will continue to be available to allow for a gradual
732 transition to the browser-based client, but no new features will be added. The
733 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
743 New EDI Order Generator
744 ^^^^^^^^^^^^^^^^^^^^^^^
749 . New database tables exist for configuring vendor-specific EDI order
753 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
756 ** Collection of `edi_attr`s. Each edi_account may be linked to one
758 ** One `edi_attr_set` per known vendor is added to the stock data, matching
759 the stock configuration found in the JEDI template.
760 * `acq.edi_attr_set_map`
761 ** Link between `edi_attr`s and `edi_attr_set`s.
763 . EDI Attribute Sets are manged via a new (browser client only) configuration
764 interface at 'Administration -> Acquisitions Administration -> EDI
767 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
768 is not set, default values will be used. Links between an EDI account
769 and an attribute set are managed in the EDI Accounts configuration
772 . Local modifications to the stock EG JEDI template are managed by modifying
773 and/or adding additional `edi_att_set`s as needed.
775 . A new `edi_order_pusher.pl` script is added which replaces the functionality
776 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
778 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
779 definition is no longer required and can be disabled.
784 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
785 specifies whether PO's generated via the account should be built using
786 EDI attributes or fall back to traditional JEDI A/T template generation.
788 This allows sites to activate EDI attributes on a per-account basis, making
789 it possible to migrate piecemeal to EDI attributes. For the initial roll
790 out of this new feature, no accounts will be configured to use EDI
791 attributes by default.
797 3 Day Courtesy Notice by SMS
798 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
799 New optional SMS text notification to be sent out 3 days prior to the due
800 date of any circulating item for patrons who have an SMS text number and
801 carrier stored in their accounts. This action trigger is disabled by default,
802 but can be enabled and modified by going into 'Administration -> Local Administration ->
803 Notifications / Action Triggers'.
805 You may wish to make use of granularity so that these messages are batched
806 and sent at the same time each day.
811 Add Description Field to Circulation and Hold Configuration Entries
812 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
813 The circulation and hold policy configuration rules now each have a
814 description field. This allows administrators to add comments to
815 describe the purpose of each rule.
820 Apache Internal Port Configuration Option
821 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
822 Apache configuration now supports a new variable which allows admins to
823 specify the port used by Apache to handle HTTP traffic. The value is
824 used for HTTP requests routed from Perl handlers back to the same Apache
825 instance, like added content requests. Use this when running Apache
826 with a non-standard port, typical with a proxy setup. Defaults to "80".
829 -------------------------------------------------------------------
832 PerlSetVar OILSWebInternalHTTPPort "7080"
835 -------------------------------------------------------------------
840 Configurable Bib Record Display Fields
841 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
843 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
844 fields: 'Display Field?' and 'Display XPath'.
846 When 'Display Field' is set to true, data from the field will be extracted
847 from each record and added to a new table of display data for each bib
850 If a value is present in the 'Display XPath' field, this XPath will be
851 applied to the extracted data *after* the base XPath (from the 'XPath'
852 field) is applied to each field.
854 This data acts as a replacement for the various and sundry ways bib record
855 data is currently extracted, including inline XPath in the TPAC, reporter
856 views, real-time 'MVR' compilation from MODS, etc. and will be available
857 to the user interface, notification templates, etc. for rendering bib
860 The browser client gets a new service 'egBibDisplay' which is capable
861 of translating the display field data from various formats into
862 data more suitable for JavaScript usage.
864 The database gets 3 new views for representing display data in various
867 * `metabib.flat_display_entry`
868 ** List of all display fields linked to their configuration.
869 * `metabib.compressed_display_entry`
870 ** Same as `metabib.flat_display_entry` except there's one row
871 per display field type, with 'multi' rows compressed into
872 JSON arrays. Non-multi fields are represented as JSON
874 * `metabib.wide_display_entry`
875 ** Tabular view of display field data, one column per well-known
876 field. Values are represented JSON, consistent with
877 `metabib.flat_display_entry`. The view does *not* contain locally
878 configured display fields, as each field must be encoded in
879 the view and IDL definition. This is essentially a replacement
880 for `reporter.simple_record`.
885 After making changes to display field configuration, it's possible to
886 reingest only display field data in the database using the following:
889 ---------------------------------------------------------------------
890 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
891 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
892 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
893 ---------------------------------------------------------------------
899 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
900 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901 The existing permission was incorrectly created with a code of
902 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
903 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
904 update changes the permission code to match what the event requires.
910 Hold Targeter V2 Repairs and Improvements
911 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
912 * Make the batch targeter more resilient to a single-hold failure.
913 * Additional batch targeter info logging.
914 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
915 * Removes the confusingly named `--target-all` option
916 ** The same behavior can be achieved by using `--retarget-interval "0s"`
917 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
919 New --next-check-interval Option
920 ++++++++++++++++++++++++++++++++
921 Specify how long after the current run time the targeter will retarget
922 the currently affected holds. Applying a specific interval is useful
923 when the retarget-interval is shorter than the time between targeter
926 For example, if the targeter is run nightly at midnight with a
927 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
928 since the holds won't be processed again until 48 hours later. This
929 ensures that the org unit closed date checks are looking at the correct
932 This setting overrides the default behavior of calculating the next
933 retarget time from the retarget-interval.
935 New --soft-retarget-interval Option
936 +++++++++++++++++++++++++++++++++++
937 This is a replacement for (and rebranding of) the `--skip-viable` option.
938 The new option allows for time-based soft-targeting instead simple binary
939 on/off soft-targeting.
941 How soft-targeting works:
943 * Update hold copy maps for all affected holds
944 * Holds with viable targets (on the pull list) are otherwise left alone.
945 * Holds without viable targets are retargeted in the usual manner.
951 New marc_export --descendants Option
952 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
954 The `marc_export` script has a new option, `--descendants`. This option
955 takes one argument of an organizational unit shortname. It works much
956 like the existing `--library` option except that it is aware of the
957 org. tree and will export records with holdings at the specified
958 organizational unit and all of its descendants. This is handy if you
959 want to export the records for all of the branches of a system. You
960 can do that by specifying this option and the system's shortname,
961 instead of specifying multiple `--library` options for each branch.
963 The `--descendants` option can be repeated, as the `--library` option can.
964 All of the specified org. units and their descendants will be included
965 in the output. It can also be combined with individual `--library`
966 options when necessary.
971 RTL and LTR Public Catalog Stylesheets Merged
972 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
973 The RTL stylesheet for the public catalog,
974 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
975 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
976 template will provide RTL or LTR styles based on the value of
977 the `rtl` flag of the active locale. An `rtl` variable is also available
978 in the template to allow the correct style to be chosen.
983 Miscellaneous Improvements
984 ^^^^^^^^^^^^^^^^^^^^^^^^^^
986 * If a filter is in effect in the Library Settings Editor,
987 the filter will continue to be applied after a user
988 changes the selected library.
989 * Copy templates used for serials now correctly link to age
990 protection rules and MARC item type values (for the
991 "Circ as Type" field). During upgrade, the database update
992 will set to NULL any age protection and circ as type fields
993 in serial copy templates that do not point to defined values.
998 Obsolete Internal Flag Removed
999 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1001 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1002 flag was removed from the `config.internal_flags` table. It was
1003 rendered obsolete by the addition of the 3 flags to control the
1004 browse, search, and facet indexing.
1009 Tweaks to Caching/Expiry of Public Catalog Assets
1010 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1011 The default cache expiration time for static assets (e.g.,
1012 CSS, image, and JavaScript files) in the public catalog and
1013 the Kid's PAC has been increased to one year. Links to all
1014 such assets now have a cache-busting value tacked on as a
1015 query parameter. This value is refreshed when `autogen.sh` is
1016 run, but it can also be manually set by adjusting the
1017 `ctx.cache_key` Template Toolkit variable.
1022 Action/Trigger Events Data Purging
1023 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1025 Action/Trigger event definitions have a new field called 'Retention
1026 Interval'. When an optional interval value is applied, events and
1027 template output data linked to the event definition will be deleted
1028 from the database once they reach the specified age.
1030 Retention Interval Restrictions for Passive Hooks
1031 +++++++++++++++++++++++++++++++++++++++++++++++++
1033 Restrictions are placed on retention interval values for event definitions
1034 using passive hooks to prevent data from being deleted while it's still
1035 needed by the system.
1037 The presence of event data is how the system knows not to send duplicate
1038 events. As long as a scenario exists where a duplicate event may be
1039 generated, the events must be retained.
1041 To apply a retention interval value to a passive-hook event definition:
1043 * The event definition must have a max_delay value.
1044 * The retention interval must be larger than the difference between
1045 the `delay` and `max_delay` values.
1047 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1048 interval must be greater than 3 days to ensure no duplicate events are
1049 created between the first event on day 7 and the end of the event validity
1055 A new `purge_at_events.sh` script is installed in the bin directory
1056 (typically `/openils/bin`) which should be added to CRON for regular
1059 NOTE: On large data sets, this script can take a long time to run and
1060 create higher than normal I/O load as it churns though the event and
1061 event_output tables. You may wish to run the script by hand the first
1062 time so it can be monitored. It can be run in psql like so:
1065 ---------------------------------------------------------------
1066 SELECT action_trigger.purge_events();
1067 ---------------------------------------------------------------
1069 NOTE: On *very* large data sets (10s to 100s of millions of event and
1070 event_output rows), it may be advisable to first repopulate the `event`
1071 and `event_output` tables with only the desired data before starting
1072 regular purges. This can be done, for example, using the copy to temp
1073 table, truncate source table, repopulate source table from temp table
1074 approach. This will be much faster than the `purge_events()` function
1075 in cases where most of the data will be purged.
1080 A number of `action_trigger.hook` entries which have always been treated
1081 as active hooks, though are configured as passive hooks, have been
1082 updated to properly reflect the non-passive-ness. This allows for
1083 simpler configuration of their retention interval values.
1089 Remove JSPAC Redirects
1090 ^^^^^^^^^^^^^^^^^^^^^^
1091 Future versions of Evergreen will no longer contain automatic redirects
1092 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1093 that the JSPAC is no longer supported. Existing sites, however, may
1094 wish to retain JSPAC redirects in their Apache configuration files since
1095 JSPAC URLs may still be used in the wild to access their catalogs.
1097 The original JSPAC URL redirects are all retained in the file
1098 `Open-ILS/examples/jspac_redirects.conf` for reference.
1108 New open-ils.auth.login API
1109 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1110 The `open-ils.auth` service has a new API for requesting an authentication
1111 token. It performs the same steps as the
1112 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1113 using the bare password. No intermediate password hashing is required.
1115 The paramaters are the same as the `.complete` call with a few modifications.
1117 1. Using the generic 'identifier' parameter in combination with the
1118 'org' parameter allows the API to reliably determine if an identifier
1119 value is a username or barcode. The caller is no longer required to
1120 make that determination up front.
1122 2. The 'nonce' parameter is no longer used.
1128 Batch Patron Contact Invalidation
1129 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1130 The following methods are used to mark patron contact fields
1131 as invalid by moving the invalid value to a standing penalty:
1133 * `open-ils.actor.invalidate.email`
1134 * `open-ils.actor.invalidate.day_phone`
1135 * `open-ils.actor.invalidate.evening_phone`
1136 * `open-ils.actor.invalidate.other_phone`
1138 These methods now accept a fifth argument specifying the value
1139 of the contact field, e.g., a specific phone number or email
1140 address. If supplied, and if a specific patron ID (the first
1141 argument) is not supplied, all patrons with that specific contact
1142 value will have it marked invalid.
1152 Pure-SQL catalog searching
1153 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1154 Public and staff catalog search is now both more accurate and faster
1155 by redesigning how the visibility of records is calculated.
1165 Authority Record and Headings Browse Improvements
1166 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1167 Various improvements are made to support for authority records
1168 and headings browsing:
1170 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1171 headings from authority records. Since the MODS and MADS stylesheets
1172 extract headings in similar ways, duplicate browse entries are now
1173 much less likely to occur.
1174 * A new configuration table, `authority.heading_field`, is now used
1175 to specify how headings should be extracted from authority records.
1176 * Related headings can now be identified as narrower or broader when
1177 browsing in the public catalog.
1178 * See references are now more reliably included in the browse list.
1179 * Scope (public) notes now display only under the main heading.
1180 * There is now a global flag, Display related headings (see-also) in browse,
1181 that can be used to control whether related headings (see-alsos) are
1182 displayed in the public catalog list.
1183 * A complete set of thesauruses are now included in the seed data. Thesauruses
1184 can now be identified using short and long codes.
1185 * The labels for see and see-also references in the public catalog are
1186 a bit more patron-friendly, and can now be tweaked via TPAC template
1187 customization in the browse.tt2 file.
1193 Copy Tags and Digital Bookplates
1194 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1195 Copy tags will allow staff to apply custom, pre-defined labels or tags
1196 to copies. Copy tags are searchable in both the staff client and public
1197 catalog. This feature was designed to be used for Digital Bookplates to
1198 attach donation or memorial information to copies, but may be used for
1199 broader purposes to tag items.
1201 Each copy tag can either be publicly-visible or visible only to staff.
1202 Copy tags also have types that can be used for restricting catalog
1203 searches on copy tags to particular types.
1205 Copy tags are displayed in the copy table in the record summary page in
1206 the public catalog, and a new library setting can be used to add
1207 a "Digital Bookplate" search field. Copy tags can also be used
1208 as a search filter, e.g.,
1210 * `copy_tag(bookplate, jane smith)`: search for records that have a
1211 copy tag of type 'bookplate' whose value contains 'jane smith'.
1212 * `copy_tag(*, jane smith)`: search for records that have a
1213 copy tag of any type whose value contains 'jane smith'.
1215 All staff-side interfaces related to copy tags exist only in the web
1216 staff client. There are two new administration interfaces for managing
1217 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1218 button for applying copy tags to copies; that interface can also be
1219 used to create new copy tags on the fly. Furthermore, the copy buckets
1220 interface now has an 'Apply Tags' action for assigning tags to groups
1226 Two new permission are included:
1228 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1229 'Administration -> Server Administration -> Copy Tag Types'
1230 * `ADMIN_COPY_TAG`: required to create a new tag under
1231 'Administration -> Local Administration -> Copy Tags'
1233 The existing permission `UPDATE_COPY` controls whether or not a user
1234 can link copies to tags.
1238 A new library setting, 'Enable Digital Bookplate Search', controls
1239 whether to display a 'Digital Bookplate' field in the search index
1240 drop-downs in the catalog. A 'Digital Bookplate' search will include
1241 all records that have a copy that matches the tag specified by the user.
1242 It should be noted that this library setting does not affect the
1243 display of copy tags on the catalog record summary page.
1248 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1249 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1250 The call number prefix and suffix, when present, are now included in
1251 subfields $k and $m of the 852 field when running `marc_export` with
1252 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1253 server configured to embed item data in 852 fields, the affixes are now
1254 included in subfields $k and $m.
1264 Batch Editing of Patron Records
1265 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1266 There is a now a new interface analogous to the Copy Bucket interface
1267 to select and group a set of users into a User Bucket.
1268 The addition of users to a User Bucket is possible from the Patron Search
1269 interface by the use of a new grid Action, and directly on the User Bucket
1270 interface by user barcode. It is also possible to add users to a User
1271 Bucket by uploading a text file that contains a list of user barcodes.
1273 From this interface it is possible to perform a set of specific batch update
1274 operations on user records.
1279 These fields can now be changed in batch via an action on the User Bucket
1280 grid if the staff user has the `UPDATE_USER` permission:
1283 * Primary Permission Group (group application permissions consulted)
1285 * Home Library (`UPDATE_USER` checked against both old and new value)
1286 * Privilege Expiration Date
1287 * Barred flag (`BAR_PATRON` permission consulted)
1288 * Internet Access Level
1290 Changes made in this interface can be rolled back.
1292 As a batch process, rather than a direct edit, this mechanism explicitly skips
1293 processing of Action/Trigger event definitions for user update.
1298 The batch edit mechanism also allows for the batch deletion of user. The staff
1299 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1301 Changes made in this interface can be rolled back.
1303 As a batch process, rather than a direct edit, this mechanism explicitly skips
1304 processing of Action/Trigger event definitions for user deletion.
1306 This mechanism does not use the Purge User functionality, but instead simply
1307 marks the users as deleted.
1309 Editing Statistical Category Entries
1310 ++++++++++++++++++++++++++++++++++++
1312 All users in the bucket can have their Statistical Category Entries
1313 modified. Unlike user data field updates, modification of Statistical
1314 Category Entries is permanent and cannot be rolled back.
1316 As a batch process, rather than a direct edit, this mechanism explicitly skips
1317 processing of Action/Trigger event definitions for user update.
1319 New Service Requirement
1320 +++++++++++++++++++++++
1322 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1323 unused in production. If this service has been removed from the configuration
1324 of a live Evergreen instances, it will need to be added back in order for
1325 batch user editing to succeed.
1330 Honor Timezone of the Acting Library
1331 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1336 * Display day-granular due dates in the circulating library's timezone.
1337 * Only display the date portion of the due date for day-granular circulations.
1338 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1339 * Provide infrastructure for more advanced formatting of timestamps.
1340 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1345 This is a followup to the work done for 2.12, where we added the ability
1346 for the client to specify a timezone in which timestamps should be interpreted
1347 in business logic and the database.
1349 Most specifically, this work focuses on circulation due dates and the closed
1350 date editor. Due dates, where displayed using stock templates (including
1351 receipt templates) and used for fine calculation, are now manipulated in the
1352 library's configured timezone. This is controlled by the new 'lib.timezone'
1353 setting available via the Library Settings Editor, loaded from the server when
1354 required. Additionally, closings are recorded in the library's timezone so that
1355 due date calculation is more accurate. The closed date editor is also
1356 taught how to display closings in the
1357 closed library's timezone. Closed date entries also explicitly record if they
1358 are a full day closing, or a multi-day closing. This significantly simplifies
1359 the editor, and may be useful in other contexts.
1361 To accomplish this, we use the moment.js library and the moment-timezone addon.
1362 This is necessary because the stock AngularJS date filter does not understand
1363 locale-aware timezone values, which are required to support DST. A simple
1364 mapper translates the differences in format values from AngularJS date to
1367 Of special note are a set of new filters used for formatting timestamps under
1368 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1369 filters provide the functionality, and autogrid is enhanced to make use of
1370 these where applicable. egGrid and egGridField are also taught to accept
1371 default and field-specific options for applying date filters. These filters may
1372 be useful in other or related contexts.
1374 The egDueDate filter, used for all existing displays of due date via Angular
1375 code, intentionally interprets timestamps in two different ways WRT timezone,
1376 based on the circulation duration. If the duration is day-granular (that is,
1377 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1378 of seconds) then the date is interpreted as being in the circulation library's
1379 timezone. If it is an hourly loan (any duration that does not meet the
1380 day-granular criterium) then it is instead displayed in the client's timezone,
1381 just as all other timestamps currently are, because of the previous Evergreen
1384 The public catalog is adjusted to always display the due date in the circulating
1385 library's timezone. Because the public catalog displays only the date portion of the due
1386 date field, this difference is currently considered acceptable. If this proves
1387 to be a problem in the future, a minor adjustment can be made to match the
1388 egDueDate filter logic.
1390 Now that due dates are globally stored in the configured timezone of the
1391 circulating library, the automatic adjustment to day-granular due dates needs
1392 to take those timezones into account.
1394 An optional SQL command is provided by the upgrade script to retroactively
1395 adjust existing due dates after library configuration is complete.
1401 Enhancements to Hard Due Date Functionality
1402 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1403 It will now be possible to delete Hard Due Date Values for dates that have
1404 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1405 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1406 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1411 Patron Search by Birth Date
1412 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1413 * Now you can include the patron birth year and/or birth month and/or
1414 birth day when searching for patrons using the web staff client.
1415 * Day and month values are exact matches. E.g. month "1" (or "01")
1416 matches January, "12" matches December.
1417 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1418 1915, 1599, etc. For exact matches use the full 4-digit year.
1422 Patron Search from Place Hold
1423 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1424 This feature allows staff members, when placing a
1425 hold on behalf of a patron in the web staff client, to search for
1426 patrons by names and other searchable patron information, rather than
1427 relying on barcode alone. In particular, after performing a catalog
1428 search or going to a specific bib record and clicking the 'Place Hold'
1429 button, the form now includes a 'Patron Search' button. This button
1430 will open a dialog allowing the staff member search for and select
1436 Retrieve Recent Patrons
1437 ^^^^^^^^^^^^^^^^^^^^^^^
1439 Adds a new library setting 'Number of Retrievable Recent Patrons'
1440 ('ui.staff.max_recent_patrons') that specifies the number of recently
1441 retrieved patrons that can be re-fetched from the staff client.
1443 A value of 0 means no recent patrons can be retrieved.
1444 A value greater than 1 means staff will be able to retrieve multiple
1445 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1447 The default value is 1 for backwards compatibility.
1454 Fuller title in XUL client Simplified Pull List
1455 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1456 The Simplified Pull List in the XUL client will now display subfields 245$n and
1457 $p in the title field. The addition will make it easier for staff to distinguish
1458 between different parts or seasons in a series.
1464 Transit Cancel Time and Terminology Change
1465 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1470 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1471 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1472 are preserved in the database, though still not visible to the end user in the staff client.
1473 This allows for better tracking of when transits are canceled for the purposes of knowing
1474 which staff member canceled the transit, etc.
1476 NOTE: This change may require the re-creation of transit reports to filter out canceled
1477 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1478 Is NULL' will suffice.
1480 "Canceled Transit" Terminology Change
1481 +++++++++++++++++++++++++++++++++++++
1483 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1484 For internal continuity, however, the following permission codes have not changed:
1487 * `ABORT_REMOTE_TRANSIT`
1488 * `ABORT_TRANSIT_ON_LOST`
1489 * `ABORT_TRANSIT_ON_MISSING`
1497 Offline Circulation Available in Web Staff Client
1498 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1499 Offline circulation is now available in the web staff client. In order to use the
1500 offline interface, users must first log into the web staff client, perform
1501 a patron search, select a user from the results, and open the patron editor
1502 interface to collect all the relevent configuration information for the
1503 workstation. In addition, the offline interface available from the Circulation
1504 menu provides a 'Download block list' button for users who are logged in.
1506 As is the case in the old staff client, users can check materials in and out,
1507 renew items, and create new patron accounts while offline. The patron fields
1508 available in the offline patron registration editor are the same ones that
1509 are available to staff when working online.
1513 Add Circ Modifier to Record Detail Page in Staff TPAC
1514 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1515 The circulation modifier field is added to the table of copies to make
1516 more information available to staff without having to open
1523 Date+Time Format Settings for Web Client
1524 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1526 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1527 and adds two settings for use with the webstaff client:
1529 * 'Format Dates with this pattern'
1530 * 'Format Date+Time with this pattern'
1532 These settings use format strings as documented here:
1534 https://docs.angularjs.org/api/ng/filter/date
1536 There is overlap with how the Dojo formats worked, but also some differences.
1538 The original 'Format Dates' and 'Format Times' settings worked together, but the
1539 new settings work independently. Certain field elements will use one, and
1540 certain field elements will use the other. These distinctions are hard-coded
1541 in the various UI templates, with the idea being that timestamp fields in
1542 which the date component alone is sufficient information (for example, date of birth)
1543 will use the 'Format Dates' setting. Fields where the time component is
1544 important (for example, checkout time) will use the 'Format Date+Time' setting.
1546 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1547 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1553 Global Option to Remove Sound for a Specific Event
1554 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1555 A new `nosound.wav` file has been added to the web client. The file can be used
1556 to globally disable audio alerts for a specific event on an Evergreen system.
1558 For example, to silence the alert that sounds after a successful patron search:
1562 mkdir -p /openils/var/web/audio/notifications/success/patron/
1563 cd /openils/var/web/audio/notifications/success/patron/
1564 ln -s ../../nosound.wav by_search.wav
1571 The official Evergreen manual has been split into eight new manuals, each
1572 designed for a specific audience. This new approach is designed to make
1573 the documentation more readable and usable.
1575 The specific audiences for the new manuals are:
1577 * Acquisitions staff
1580 * Public services staff who use the public catalog
1582 * System administrators who use the command line
1583 * System administrators who use the Web client
1584 * System administrators and programmers who wish to integrate Evergreen
1585 with other technologies
1587 All manuals are available at http://docs.evergreen-ils.org
1593 Improvements to ebook API
1594 ^^^^^^^^^^^^^^^^^^^^^^^^^
1596 Evergreen now supports checking out and placing holds on
1597 OverDrive and OneClickdigital ebook titles from within the public
1598 catalog. This is an experimental feature. It is not recommended for production
1599 use without careful testing.
1601 When ebook integration is enabled, a "Check Out E-Item" link will be
1602 displayed when viewing an ebook title from a supported vendor in the
1603 catalog. Clicking on the link allows the user to check out and download
1604 that title from the vendor directly within the catalog.
1606 If no copies are available for the title, a "Place Hold on E-Item" link
1607 is displayed instead, and the user may place a hold on the title. (Note
1608 that some vendors require the user's account to have an email address
1609 before permitting a hold.)
1611 My Account includes the ability to view current ebook checkouts and
1612 holds, download already-checked-out titles, and cancel holds.
1614 For API integration to work, you need to request API access from the
1615 vendor, and the vendor must have a way of authenticating your patrons.
1616 Your Evergreen system also needs to be configured for ebook API
1617 integration, following the instructions in the command line system
1618 administration manual
1621 This feature assumes that you are importing MARC records supplied by the
1622 vendor into your Evergreen system, using Vandelay or some other MARC
1623 import method. This feature does not search the vendor's online
1624 collections or automatically import vendor records into your system; it
1625 merely augments records that are already in Evergreen.
1627 Improvements to Bill Payment Pages
1628 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1629 The bill payment pages in the public catalog have been revamped
1632 * use the term "charges" instead of "fees"
1633 * include images of credit cards accepted
1634 * make the default print receipt template match other itemized receipts;
1635 note that this change is not automatically applied when upgrading.
1636 * display billing type
1637 * add button to pay only selected charges
1638 * reformat the credit card number input page
1644 Clickable Copy Locations
1645 ^^^^^^^^^^^^^^^^^^^^^^^^
1646 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1647 the associated copy location will display as a link in the public catalog summary display.
1648 This link can be useful for retrieving maps or other directions to the copy
1649 location to aid users in finding material.
1654 Download Checkout History CSV Fixed for Large Number of Circulations
1655 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1656 Downloading checkout history as a CSV from My Account has been fixed
1657 for users with a large circulation history. Previously, this would
1658 time out for patrons with more than 100 or so circulations.
1660 This feature no longer uses the action/trigger mechanism and the public catalog
1661 now generates the CSV directly. The old action/trigger code is still
1662 present in the database and should be removed at some point in the
1668 Google Books Preview Rewrite
1669 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1670 The Google Books Preview functionality in record detail pages has been
1671 rewritten to modernize its style and optimize its performance:
1673 * The Dojo JavaScript framework is no longer used, saving approximately
1674 150K of JavaScript and CSS and four network requests per page load.
1675 * The Embedded Viewer is not loaded unless a possible preview is found,
1676 saving more network and memory overhead.
1677 * The Google Books Loader is used to load the Embedded Viewer instead of the
1678 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1680 * All variables are self-contained and do not pollute the global namespace.
1681 * Event listeners are registered to handle clicks, rather than attaching
1682 `href="javascript:function()"` to <a> elements.
1683 * Book previews are displayed in a panel sized according to the viewport
1684 of the browser, improving its appearance on both mobile and desktop
1686 * The rewritten code is now served up directly from
1687 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1692 jQuery for the Public Catalog
1693 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1694 This release adds optional support for jQuery in the public catalog. This support
1695 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1696 `config.tt2` template.
1702 New Popularity Parameters
1703 ^^^^^^^^^^^^^^^^^^^^^^^^^
1704 New popularity parameters for in-house use over time and for count of distinct
1705 organizational units that own a title are now available. Evergreen sites
1706 can use these parameters to create new statistical popularity badges for
1707 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1709 The in-house use parameters will apply a badge to titles that have the most
1710 in-house use activity over time. The organizational unit count parameter
1711 will apply a badge to titles owned by the most number of libraries in a
1712 consortium. Ownership is determined by the copy's circulation library.
1717 Option to Suspend Holds at the Time They are Placed
1718 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1719 Users now have the option to suspend a hold at the same time they place the
1720 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1721 who want to suspend a hold at the time it is placed. There is also an option
1722 to set the activation date at the same time. This option is also available
1723 when placing holds on a batch of titles from 'My List' and will apply to
1724 all the titles in the batch.
1735 Fix to reporter.classic_current_circ View
1736 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1737 The `reporter.classic_current_circ` view, which is part of some
1738 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1739 has been fixed to not exclude loans for patrons who do not have a
1740 billing address set. Users of this view should rerun
1741 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1746 New Report Source Table Allowing Report of "Last" Deleted copy
1747 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1749 This source table allows you to construct a clever aggregate report template
1750 which will report bibliographic IDs where a library or a group of libraries
1751 no longer have a copy attached but *had* a copy attached. This is especially
1752 useful when a holdings sync is required with an external vendor.
1755 Instructions for creating a report template with this source:
1757 * Create a new report template using "Library Holdings Count with Deleted" as the source
1758 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1759 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1760 * 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"
1761 * Add "Bib ID" to Displayed Fields
1762 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1763 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1764 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1767 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1768 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1769 specified date range. Unfortunately the user will have to manually type the date range without the date
1770 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1771 copy and more than two deleted copies."
1776 Add Provider to Provider Note Link
1777 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1778 The Provider reporting source now includes a link to the Provider Note reporting source.
1783 Link ILS User and Working Location Reporting Sources
1784 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1785 The Working Location reporting source now has labels
1786 and it is now linked to the ILS User reporting source, allowing
1787 reports to display or filter on staff working location.
1792 New Circulation Report Source "All Circulation Combined Types"
1793 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1795 This report source will allow you to create a single report template for all of the following:
1798 * In-house uses of non-cataloged items
1800 * Circulations of non-cataloged items
1802 To distinguish between these different types of library use, it's important to display these columns
1803 in your report templates:
1812 Reports Template Searching
1813 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1814 A new form appears along the top of the reports interface for searching
1815 report templates. Once found, typical template actions (e.g. create new
1816 report) are available from within the results interface.
1818 Searches may be performed across selected (visible) folders or all
1819 folders visible to the logged in user.
1821 Searches are case-insensitive, any word order, with left-anchored words.
1822 All searched words must appear in at least one of the searched fields.
1827 * Searching for 'stat cat' matches:
1829 ** statistical category
1830 ** categories, statistical
1831 ** patrons (stat cat)
1832 * Searching for 'stat cat' does not match:
1834 *** both words must be present in the searched field(s)
1836 *** location contains 'cat' but it's not left-anchored.
1841 The templates, reports, and output interfaces now support paging via
1842 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1854 Web Staff Client Serials Module
1855 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1856 The serials module has been ported over to the web staff
1857 client, implementing a unified serials interface that combines
1858 ideas from both the serial control view and alternate serials
1859 control view from the old staff client.
1861 In addition to carrying over functionality that was available
1862 in the old staff client, several new features are included:
1864 * the ability to save prediction pattern codes as templates
1865 that can be shared and reused within an Evergreen database
1866 * a more streamlined interface for managing subscriptions,
1867 distributions, and streams
1868 * it is no longer necessary to create a starting issue in
1869 order to predict a run of issues; the dialog box for
1870 generating a set of predicted issues now lets you specify
1871 the starting point directly.
1872 * the ability to more directly edit MFHDs
1874 The new serials interfaces can be accessed from the record
1875 details page via a Serials drop-down button that links to
1876 a subscription management page, a quick-receive action, and
1877 a MFHD management page. There is also a new 'Serials Administration'
1878 page where prediction pattern and serial copy templates can
1889 SIP Bugfix Changes How Encoding Is Determined in Configuration
1890 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1892 The combined fix for the above mentioned SIP bugs alters the way that
1893 SIPServer looks up the output encoding in the configuration file (typically
1894 `oils_sip.xml`). SIPServer now looks for the encoding in the following
1897 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1898 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1899 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.
1900 4. If none of the above exist, then the default encoding (ASCII) is used.
1902 Number 3 is provided to ease the transition to the new code. It is
1903 the current location of the +encoding+ element in the sample
1904 configuration file and as such, where it is likely to be found in
1905 actual files. It is recommended that you alter your configuration to
1906 move this element out of the +implementation_config+ element and into
1907 its parent +institution+ element. Ideally, SIPServer should *not* look into
1908 the implementation config, and this check may be removed at some time
1916 Web Client Acknowledgments
1917 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1919 The project to develop a new browser-based web client launched four
1920 years ago at the September 2013 Evergreen developer hack-a-way when the
1921 developer community voted to move away from the XUL client and explore other
1922 platforms. The first web client preview became available in Evergreen 2.7 when
1923 circulation was available in the new platform.
1925 The browser-based client is available due to the work of many coders, testers,
1926 bug reporters, documentors, translators, project managers, spec writers, funders
1927 and other contributors over the past four years.
1929 The Evergreen project would like to acknowledge the following organizations
1930 that funded development of the Web Staff Client:
1933 * British Columbia Libraries Cooperative
1934 * Consortium of Ohio Libraries
1936 * Georgia Public Library Service
1937 * Grand Rapids Public Library
1939 * Kenton County Public Library
1940 * King County Library System
1943 * Pennsylvania Integrated Library System
1944 * Pioneer Library System
1947 The Evergreen project would also like to thank the following individuals who
1948 contributed code, translations, documentation patches, tests, bug reports,
1949 technical specifications, and project management to the Web Staff Client:
1986 * Freddy Enrique Pelayo Huapalla
2012 Evergreen 3.0 Acknowledgments
2013 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015 The Evergreen project would like to acknowledge the following
2016 organizations that commissioned developments in this release of
2020 * British Columbia Libraries Cooperative (BC Sitka)
2022 * Georgia Public Library Service
2023 * King County Library System
2025 * Pennsylvania Integrated Library System
2026 * Pioneer Library System
2028 We would also like to thank the following individuals who contributed
2029 code, translations, documentation patches, and tests to this release of
2078 We also thank the following organizations whose employees contributed
2081 * British Columba Libraries Cooperative
2085 * Emerald Data Networks, Inc.
2086 * Equinox Open Library Initiative
2088 * Grand Rapids Public Library
2089 * Indiana State Library
2091 * King County Library System
2092 * Lake Agassiz Regional Library
2093 * Laurentian University
2094 * Linn-Benton Community College
2096 * Merrimack Valley Library Consortium
2098 * North of Boston Library Exchange
2099 * Pennsylvania Integrated Library System
2100 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2102 * Traverse Area District Library
2104 We regret any omissions. If a contributor has been inadvertently
2105 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / Evergreen.git / blob