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
18 We would like to thank the following individuals who contributed code,
19 tests and documentation patches to the 3.0.5 point release of
31 This release is a security release that fixes cross-site scripting
32 (XSS) vulnerabilities in the Evergreen public catalog. This release
33 also includes several other bugfixes improving on Evergreen 3.0.5.
35 Security Issue: XSS Vulnerability in Public Catalog
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37 This release fixes several cross-site scripting (XSS) vulnerabilities
38 in the public catalog. When upgrading, Evergreen administrators should
39 review whether any of the following templates have been customized
40 or overridden. If so, either the template should be replaced with the
41 stock version or the XSS fix (which entails adding the `| html` filter
42 in several places) applied to the customized version.
44 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
45 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
46 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
48 Note that exploiting the XSS vulnerabilities fixed in this release
49 would require either the ability to create maliciously-constructed
50 MARC bibliographic or holdings records or the ability to set a
51 maliciously constructed organizational unit name.
55 Evergreen 3.0.6 also includes the following changes:
57 * When using 'Selection Lists -> Edit MARC Order Record' in the web
58 staff client, now only one click is required to save the MARC
59 record rather than two.
60 * The volume/copy editor in the web staff client now better handles
61 editing multiple items that have different sets of statistical
62 category values assigned to them.
63 * The act of merging bibliographic records now updates bookbags
64 that referred to the source bibliographic record rather than
65 effectively deleting entries for that record.
66 * Additional columns were added to the Holds Pull List in the
68 * The patron registration form in the web staff client now correctly
69 manages setting user preferences.
70 * An error in a pgTAP unit test was corrected.
74 We would like to thank the following individuals who contributed code,
75 tests and documentation patches to the 3.0.6 security release of
91 This release contains bug fixes improving on Evergreen 3.0.4.
93 * The MARC Editor in the Web staff client now wraps long fields.
94 * The MARC Editor no longer allows catalogers to enter new lines
96 * Fixes an issue that prevented serials items from being deleted or
98 * The Web staff client Check In screen no longer reloads the whole
99 page multiple times each time an item is scanned.
100 * Fixes an issue that displayed the oldest -- rather than the newest
101 -- transit in the Web staff client Item Status page.
102 * Fixes an issue that prevented the reports module from being displayed
104 * Fixes an issue in the Web staff client reports module that caused
105 syntax errors in reports that use virtual fields and joins.
106 * Fixes an issue that prevented several dropdown menus in the Web staff
107 client from activating.
108 * Fixes an issue that created duplicate copy data when copies or
109 volumes with parts were transferred.
110 * Fixes the Trim List feature in the Web staff client Check In screen.
111 * The Item Status grid now displays the Circulation Modifier.
112 * Restores missing data from the Profile column in Place Hold patron
114 * Fixes an issue with the http -> https redirect on Apache 2.4.
115 * Fixes an color contrast accessibility issue in the Web staff
116 client and adds underlining to links in grid cells for added accessibility.
117 * Adds automated regression and unit tests for the Web staff client
119 * Adds a process for spell-checking the official documentation.
120 * Adds a script that simplifies the release process related to translations.
125 We would like to thank the following individuals who contributed code,
126 tests and documentation patches to the 3.0.5 point release of
131 * Blake Graham-Henderson
146 This release contains bug fixes improving on Evergreen 3.0.3:
148 * Fixes a bug that caused all searches limited by shelving location to
150 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
151 rather than the ordering agency's SAN.
152 * Fixes a bug that prevented Safari/iOS users from logging in to the
154 * Fixes a bug that prevented users from using the browse interface.
155 * Fixes a bug in the Item Status List view that caused incorrect due
157 * Approval code is now a required field in the web client's patron
158 credit card payment form.
159 * Fixes a bug with credit card payments that caused a receipt to print
160 showing that the patron paid the bill when the payment had not actually
162 * Fixes a bug that prevented the EDI translator from being installed on
164 * Fixes a bug that caused entries to show up multiple times in the
165 Items Out and Holds tabs in the patron record.
166 * Fixes a bug that caused grids on Bills and Patron Messages
167 screens to not display properly.
168 * The following fields are now available for the Checkout and Items Out
175 ** money_summary.balance_owed
176 ** money_summary.total_paid
177 ** money_summary.total_owed
182 * The following fields are now available on the Bill Payment receipt templates:
192 * Payment type is now a column in the payments tab of the patron record
193 Bill History section.
194 * The "Replace Barcode" function now makes it more difficult for staff
195 members to attempt to create blank patron barcodes.
196 * The patron bills screen now prevents staff members from double-clicking
197 on the Apply Payment button (which otherwise would apply two payments).
198 * Fixes a bug that prevented patrons attached to statistical categories
199 from displaying in the patron search-to-hold dialog.
200 * Fixes a performance issue related to uploading CSV files of barcodes
201 to the item status and patron bucket interfaces.
202 * Fixes several small bugs in the Spanish translation.
203 * Fixes a performance bug related to patrons logging in by barcode.
207 We would like to thank the following individuals who contributed code,
208 tests and documentation patches to the 3.0.4 point release of
230 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
231 update the visibility attributes of all bibs that make use of Located URIs or
232 bib sources. It may take a while to run on large datasets. If it it running
233 too long, it can be canceled and the following psql commands will create and
234 run a script that will perform the same action serially over time without
235 blocking writes to bibs:
238 \o /tmp/luri_visibility_update.sql
239 SELECT 'UPDATE biblio.record_entry SET ' ||
240 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
241 'WHERE id = ' || id || '; SELECT ' || id || ';'
242 FROM biblio.record_entry
244 SELECT DISTINCT cn.record
245 FROM asset.call_number cn
247 AND cn.label = '##URI##'
250 FROM asset.uri_call_number_map m
251 WHERE m.call_number = cn.id
254 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
259 \i /tmp/luri_visibility_update.sql
262 It will output the id of each updated bib so that the script can be killed
263 and then edited to remove completed bibs. The remainder can be run at a
266 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
267 we do NOT update the bib's visibility attributes, as doing so causes a loop
268 and an eventual trigger stack violation. This flag should ONLY be used when
269 forcing reingest of record attributes (NOT visibility attributes), search,
270 facet, and display fields, so if using this flag under normal operation,
271 proceed at your own risk and know that Located URI and bib source changes
272 will not be reflected in the visibility attributes of the record.
276 This release contains several bug fixes improving on Evergreen 3.0.1:
278 * Fixes several issues related to the display of located URIs and records with
279 bib sources in search results.
280 * Setting `opac_visible` to false for a copy location group now hides only
281 the location group itself, rather than also hiding every single copy in the
283 * Fixes a bug that prevented the copy editor from displaying the _fine level_
284 and _loan duration_ fields.
285 * The "Edit Items" grid action in the Item Status interface will now open
286 in the combined volume/copy editor in batch. This makes the behavior
287 consistent with the "Edit Selected Items" grid action in the copy
289 * Staff members are now required to choose a billing type when creating a
290 bill on a user account.
291 * The Web client now provides staff users with an alert and option to
292 override when an item with the Lost and Paid status is checked in.
293 * Fixes a bug where the Web client offline circ interface was not able
294 to set its working location.
295 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
297 * The MARC editor in the Web staff client now presents bib sources in
299 * Both circulation and grocery bills are now printed when a staff user selects
300 a patron account and clicks "Print Bills".
301 * Fixes an issue in the XUL serials interface the "Receive move/selected"
302 action from succeeding.
303 * Fixes a typo in the user password testing interface.
307 We would like to thank the following individuals who contributed code,
308 tests and documentation patches to the 3.0.3 point release of
327 This release contains several bug fixes improving on Evergreen 3.0.1:
329 * Copy templates created in XUL Holdings Maintenance will now be
330 automatically converted and displayed in the web staff client's
332 * The list of report templates now includes a column indicating whether
333 the template was originally created in the XUL staff client or the web
334 staff client; staff need to know this since report templates created in
335 one interface cannot be edited in the other.
336 * Call number prefixes and suffixes are now displayed in various grids
337 in the web staff client, including
338 ** Pending Copy Buckets
340 ** Checkin/Capture Holds
342 ** Patron Bills History
349 ** Bib Record View Holds
351 * Many patron fields have been redacted from the web staff client's patron
352 and record holds grids, leaving patron name, username, and ID.
353 * Fixes two bugs where patron records could fail to be saved upon editing.
354 * The web staff patron editor now better warns staff users about
355 duplicate names, IDs, phone numbers, and email addresses.
356 * Human readable labels are now displayed for certain fields in standing
358 * The patron summary in the web staff client now correctly displays
359 primary and secondary ID values.
360 * The web staff client's billing full details page now displays
361 information about the staff user that created a payment.
362 * The web staff client now requires staff users to explicitly set a
363 billing type when adding a manual bill.
364 * The web staff client's patron bill annotation modal now works.
365 * Patron barcode search completion in the web staff client now allows
366 the user to select from all of the matching patron records.
367 * The Hold Shelf Slip print template in the web staff client now has
368 access to the call number.
369 * The Checkout Receipt print template in the web staff client now can
370 include summary financial information, incuding current balance, total
371 paid on outstanding fines, and total owed.
372 * The web staff print templates for current and historical bills can
373 now include copy barcode and title.
374 * Fixes a bug that resulted in some catalog searches unexpectedly
376 * Fixes a bug that resulted in catalog searches that specify a location
377 limit returning incorrect results.
378 * Fixes a bug where deleted copies could make records visible in the
380 * Fixes a bug where certain queries on copies used in the public catalog
382 * Fixes a bug place a hold request in the public catalog could result
383 in "forgetting" the type and library of the user's previous search.
384 * The web staff client now respects staff user session timeouts, and
385 will log out all open tabs if a user's session has timed out.
386 * The web staff Z39.50 page will now give the staff user an alert if
387 they attempt to import a record with a duplicate TCN.
388 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
389 entries from being deleted.
390 * Fixes a bug that made using the volume/copy editor to change a copy's
392 * The administration interface for hard due dates now ensures that
393 new (or edited) ceiling dates have their time component set to end
394 of day, resolving an issue where ceiling dates would not be applied
395 during the ceiling date itself.
396 * The web staff client can now include dynamic information in browser
397 tab titles, e.g., "Smith, Jane - Checkout".
398 * The Concerto sample data set now includes data allowing for testing
399 placing holds on monographic parts.
400 * Asset merging during bibliographic record merging now correctly
401 recognizes call number prefixes and suffixes and deletes disused
403 * Fixes a bug where displaying user surveys could result in PCRUD
405 * Fixes a bug where pg_restore of an Evergreen database could fail
406 to create certain indexes on the `actor.usr` table.
410 We would like to thank the following individuals who contributed code,
411 tests and documentation patches to the 3.0.2 point release of
442 This release contains several bug fixes improving on Evergreen 3.0.0
444 * Fixes a bug in the web staff client that prevented initials from being
445 stored with copy notes.
446 * Adds billing types that may have been missed by systems that were
447 running Evergreen prior to the 1.4 release.
448 * Fixes a web staff client bug with the CSV export option available from
449 the Import Queue in the MARC Batch Import/Export interface.
450 * Adds the missing copy alert field in the web client's volume/copy
452 * Fixes a bug where the setting to require date of birth in patron
453 registration was not being honored in the web staff client.
454 * Fixes a bug in the web staff client patron registration form where the
455 password wasn't generating from the last four digits of the patron's
457 * Fixes an issue in the web staff client where the complete barcode did
458 not display in some interfaces when partial barcodes were scanned.
459 * Fixes an HTML error in the new copy tags that display on the record
461 * Fixes a web staff client bug where recording a large number of in-house
462 uses at one time doesn't display a confirmation dialog once it hits the
464 * Adds a _Print Full Grid_ action in the web staff client
465 holds pull list to allow staff to print the entire pull list as it
466 displays on the screen. This change also changes the _Export CSV_ action
467 to an _Export Full CSV_ option.
468 * Fixes an issue with the Patron Messages interface that prevented it
469 from saving column configuration changes in the web staff client.
470 * Fixes a bug in the web staff client where a billing prompt did not
471 correctly display after marking an item damaged in those systems that
472 have enabled the setting to bill for damaged items.
473 * Adds an option to the specific due date feature that allows saving
474 that due date until logout. This allows all circulations from a given
475 workstation to be due on the same date.
479 We would like to thank the following individuals who contributed code,
480 tests and documentation patches to the 3.0.1 point release of
502 The minimum version of PostgreSQL required to run Evergreen 3.0 is
503 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
505 Change to Names of Shared Libraries
506 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
507 OpenSRF 3.0 changes how the shared libraries for services written in
508 C are named. If upgrading from an earlier version of Evergreen,
509 `opensrf.xml` should be edited so that shared library file names
510 listed in the `<implementation>` tag start with "lib". For example,
513 ---------------------------------------------------------------------
515 <language>C</language>
516 <implementation>oils_cstore.so</implementation>
517 ---------------------------------------------------------------------
519 should be changed to:
522 ---------------------------------------------------------------------
524 <language>C</language>
525 <implementation>liboils_cstore.so</implementation>
526 ---------------------------------------------------------------------
528 SIP Bugfix Requires SIPServer Upgrade
529 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
531 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
532 crash" requires that you also upgrade SIPServer with the fix for
533 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
534 SIP client problems." This means that if you use SIP2 with Evergreen,
535 you must also upgrade SIPServer to the latest commit in the Git
536 repository. Conversely, if you upgrade SIPServer to the latest commit
537 in Git, you must also upgrade Evergreen or, at least, apply the patch
538 for Launchpad Bug 1542495. These two patches are complementary and
539 cannot be applied independently of one another.
541 `open-ils.auth.login`
542 ~~~~~~~~~~~~~~~~~~~~~
543 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
544 API's in the `opensrf_core.xml` file.
549 ---------------------------------------------------------------------
550 --- a/Open-ILS/examples/opensrf_core.xml.example
551 +++ b/Open-ILS/examples/opensrf_core.xml.example
552 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
554 <match_string>open-ils.auth.authenticate.verify</match_string>
555 <match_string>open-ils.auth.authenticate.complete</match_string>
556 + <match_string>open-ils.auth.login</match_string>
557 <match_string>open-ils.auth_proxy.login</match_string>
558 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
559 <match_string>open-ils.actor.user.password</match_string>
560 ---------------------------------------------------------------------
564 Administrators of Evergreen who use RTL locales and who have customized
565 `style-rtl.css.tt2` should now incorporate their customizations into
568 Multi-Time Zone Installations
569 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
571 For Evergreen consortia that span more than one time zone, the following
572 query will adjust all historical, unaged circulations so
573 that if their due date field is pushed to the end of the day, it is done
574 in the circulating library's time zone, and not the server time zone.
576 It is safe to run this after any change to library time zones.
578 Running this is not required, as no code before this change has
579 depended on the time string of '23:59:59'. It is also not necessary
580 if all of your libraries are in the same time zone, and that time zone
581 is the same as the database's configured time zone.
590 for ou_id in select id from actor.org_unit loop
591 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
592 if new_tz is not null then
593 update action.circulation
594 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
595 where circ_lib = ou_id
596 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
605 Deprecation of XUL staff client
606 -------------------------------
607 Starting with the release of 3.0.0, patches that fix XUL bugs will not
608 be merged into master or backported unless they meet one or more of
609 the following conditions:
611 a. the bug is a security issue
612 b. the bug involves the destruction of data
613 c. the bug is a regression of functionality in the XUL staff client
614 introduced by other work done to Evergreen
616 Under no circumstances will XUL staff client feature enhancements be merged.
618 This policy will continue through the 3.0.x and 3.1.x maintenance
619 release cycles, and will become moot upon the release of 3.2.0, when
620 the XUL staff client is slated to be entirely removed.
629 Evergreen 3.0 features a new, modern staff client that runs in the web browser
630 and can be used on desktop and mobile devices. All functional areas of the
631 system, including circulation, cataloging, acquisitions, serials, reports,
632 booking, administration, and offline circulation, are available in the new staff
633 client. Chrome and Firefox are officially supported for use with the web client.
635 Library staff will no longer need to download separate software to perform most
636 actions in Evergreen. A Chrome plugin called Hatch will be available as a
637 separate installation for workstations that require seamless, dialog-free
638 printing to multiple printers.
640 In addition to adding more portability and stability, the new staff client also
641 presents a cleaner and more modern interface for users. By virtue of running in
642 a browser, actions that users are accustomed to performing on other web sites
643 should now be available in the Evergreen client.
645 The old, XUL client will continue to be available to allow for a gradual
646 transition to the browser-based client, but no new features will be added. The
647 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
657 New EDI Order Generator
658 ^^^^^^^^^^^^^^^^^^^^^^^
663 . New database tables exist for configuring vendor-specific EDI order
667 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
670 ** Collection of `edi_attr`s. Each edi_account may be linked to one
672 ** One `edi_attr_set` per known vendor is added to the stock data, matching
673 the stock configuration found in the JEDI template.
674 * `acq.edi_attr_set_map`
675 ** Link between `edi_attr`s and `edi_attr_set`s.
677 . EDI Attribute Sets are manged via a new (browser client only) configuration
678 interface at 'Administration -> Acquisitions Administration -> EDI
681 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
682 is not set, default values will be used. Links between an EDI account
683 and an attribute set are managed in the EDI Accounts configuration
686 . Local modifications to the stock EG JEDI template are managed by modifying
687 and/or adding additional `edi_att_set`s as needed.
689 . A new `edi_order_pusher.pl` script is added which replaces the functionality
690 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
692 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
693 definition is no longer required and can be disabled.
698 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
699 specifies whether PO's generated via the account should be built using
700 EDI attributes or fall back to traditional JEDI A/T template generation.
702 This allows sites to activate EDI attributes on a per-account basis, making
703 it possible to migrate piecemeal to EDI attributes. For the initial roll
704 out of this new feature, no accounts will be configured to use EDI
705 attributes by default.
711 3 Day Courtesy Notice by SMS
712 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
713 New optional SMS text notification to be sent out 3 days prior to the due
714 date of any circulating item for patrons who have an SMS text number and
715 carrier stored in their accounts. This action trigger is disabled by default,
716 but can be enabled and modified by going into 'Administration -> Local Administration ->
717 Notifications / Action Triggers'.
719 You may wish to make use of granularity so that these messages are batched
720 and sent at the same time each day.
725 Add Description Field to Circulation and Hold Configuration Entries
726 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
727 The circulation and hold policy configuration rules now each have a
728 description field. This allows administrators to add comments to
729 describe the purpose of each rule.
734 Apache Internal Port Configuration Option
735 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
736 Apache configuration now supports a new variable which allows admins to
737 specify the port used by Apache to handle HTTP traffic. The value is
738 used for HTTP requests routed from Perl handlers back to the same Apache
739 instance, like added content requests. Use this when running Apache
740 with a non-standard port, typical with a proxy setup. Defaults to "80".
743 -------------------------------------------------------------------
746 PerlSetVar OILSWebInternalHTTPPort "7080"
749 -------------------------------------------------------------------
754 Configurable Bib Record Display Fields
755 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
757 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
758 fields: 'Display Field?' and 'Display XPath'.
760 When 'Display Field' is set to true, data from the field will be extracted
761 from each record and added to a new table of display data for each bib
764 If a value is present in the 'Display XPath' field, this XPath will be
765 applied to the extracted data *after* the base XPath (from the 'XPath'
766 field) is applied to each field.
768 This data acts as a replacement for the various and sundry ways bib record
769 data is currently extracted, including inline XPath in the TPAC, reporter
770 views, real-time 'MVR' compilation from MODS, etc. and will be available
771 to the user interface, notification templates, etc. for rendering bib
774 The browser client gets a new service 'egBibDisplay' which is capable
775 of translating the display field data from various formats into
776 data more suitable for JavaScript usage.
778 The database gets 3 new views for representing display data in various
781 * `metabib.flat_display_entry`
782 ** List of all display fields linked to their configuration.
783 * `metabib.compressed_display_entry`
784 ** Same as `metabib.flat_display_entry` except there's one row
785 per display field type, with 'multi' rows compressed into
786 JSON arrays. Non-multi fields are represented as JSON
788 * `metabib.wide_display_entry`
789 ** Tabular view of display field data, one column per well-known
790 field. Values are represented JSON, consistent with
791 `metabib.flat_display_entry`. The view does *not* contain locally
792 configured display fields, as each field must be encoded in
793 the view and IDL definition. This is essentially a replacement
794 for `reporter.simple_record`.
799 After making changes to display field configuration, it's possible to
800 reingest only display field data in the database using the following:
803 ---------------------------------------------------------------------
804 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
805 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
806 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
807 ---------------------------------------------------------------------
813 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
814 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
815 The existing permission was incorrectly created with a code of
816 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
817 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
818 update changes the permission code to match what the event requires.
824 Hold Targeter V2 Repairs and Improvements
825 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
826 * Make the batch targeter more resilient to a single-hold failure.
827 * Additional batch targeter info logging.
828 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
829 * Removes the confusingly named `--target-all` option
830 ** The same behavior can be achieved by using `--retarget-interval "0s"`
831 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
833 New --next-check-interval Option
834 ++++++++++++++++++++++++++++++++
835 Specify how long after the current run time the targeter will retarget
836 the currently affected holds. Applying a specific interval is useful
837 when the retarget-interval is shorter than the time between targeter
840 For example, if the targeter is run nightly at midnight with a
841 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
842 since the holds won't be processed again until 48 hours later. This
843 ensures that the org unit closed date checks are looking at the correct
846 This setting overrides the default behavior of calculating the next
847 retarget time from the retarget-interval.
849 New --soft-retarget-interval Option
850 +++++++++++++++++++++++++++++++++++
851 This is a replacement for (and rebranding of) the `--skip-viable` option.
852 The new option allows for time-based soft-targeting instead simple binary
853 on/off soft-targeting.
855 How soft-targeting works:
857 * Update hold copy maps for all affected holds
858 * Holds with viable targets (on the pull list) are otherwise left alone.
859 * Holds without viable targets are retargeted in the usual manner.
865 New marc_export --descendants Option
866 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
868 The `marc_export` script has a new option, `--descendants`. This option
869 takes one argument of an organizational unit shortname. It works much
870 like the existing `--library` option except that it is aware of the
871 org. tree and will export records with holdings at the specified
872 organizational unit and all of its descendants. This is handy if you
873 want to export the records for all of the branches of a system. You
874 can do that by specifying this option and the system's shortname,
875 instead of specifying multiple `--library` options for each branch.
877 The `--descendants` option can be repeated, as the `--library` option can.
878 All of the specified org. units and their descendants will be included
879 in the output. It can also be combined with individual `--library`
880 options when necessary.
885 RTL and LTR Public Catalog Stylesheets Merged
886 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
887 The RTL stylesheet for the public catalog,
888 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
889 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
890 template will provide RTL or LTR styles based on the value of
891 the `rtl` flag of the active locale. An `rtl` variable is also available
892 in the template to allow the correct style to be chosen.
897 Miscellaneous Improvements
898 ^^^^^^^^^^^^^^^^^^^^^^^^^^
900 * If a filter is in effect in the Library Settings Editor,
901 the filter will continue to be applied after a user
902 changes the selected library.
903 * Copy templates used for serials now correctly link to age
904 protection rules and MARC item type values (for the
905 "Circ as Type" field). During upgrade, the database update
906 will set to NULL any age protection and circ as type fields
907 in serial copy templates that do not point to defined values.
912 Obsolete Internal Flag Removed
913 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
915 An obsolete and unused `ingest.disable_metabib_field_entry` internal
916 flag was removed from the `config.internal_flags` table. It was
917 rendered obsolete by the addition of the 3 flags to control the
918 browse, search, and facet indexing.
923 Tweaks to Caching/Expiry of Public Catalog Assets
924 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
925 The default cache expiration time for static assets (e.g.,
926 CSS, image, and JavaScript files) in the public catalog and
927 the Kid's PAC has been increased to one year. Links to all
928 such assets now have a cache-busting value tacked on as a
929 query parameter. This value is refreshed when `autogen.sh` is
930 run, but it can also be manually set by adjusting the
931 `ctx.cache_key` Template Toolkit variable.
936 Action/Trigger Events Data Purging
937 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
939 Action/Trigger event definitions have a new field called 'Retention
940 Interval'. When an optional interval value is applied, events and
941 template output data linked to the event definition will be deleted
942 from the database once they reach the specified age.
944 Retention Interval Restrictions for Passive Hooks
945 +++++++++++++++++++++++++++++++++++++++++++++++++
947 Restrictions are placed on retention interval values for event definitions
948 using passive hooks to prevent data from being deleted while it's still
949 needed by the system.
951 The presence of event data is how the system knows not to send duplicate
952 events. As long as a scenario exists where a duplicate event may be
953 generated, the events must be retained.
955 To apply a retention interval value to a passive-hook event definition:
957 * The event definition must have a max_delay value.
958 * The retention interval must be larger than the difference between
959 the `delay` and `max_delay` values.
961 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
962 interval must be greater than 3 days to ensure no duplicate events are
963 created between the first event on day 7 and the end of the event validity
969 A new `purge_at_events.sh` script is installed in the bin directory
970 (typically `/openils/bin`) which should be added to CRON for regular
973 NOTE: On large data sets, this script can take a long time to run and
974 create higher than normal I/O load as it churns though the event and
975 event_output tables. You may wish to run the script by hand the first
976 time so it can be monitored. It can be run in psql like so:
979 ---------------------------------------------------------------
980 SELECT action_trigger.purge_events();
981 ---------------------------------------------------------------
983 NOTE: On *very* large data sets (10s to 100s of millions of event and
984 event_output rows), it may be advisable to first repopulate the `event`
985 and `event_output` tables with only the desired data before starting
986 regular purges. This can be done, for example, using the copy to temp
987 table, truncate source table, repopulate source table from temp table
988 approach. This will be much faster than the `purge_events()` function
989 in cases where most of the data will be purged.
994 A number of `action_trigger.hook` entries which have always been treated
995 as active hooks, though are configured as passive hooks, have been
996 updated to properly reflect the non-passive-ness. This allows for
997 simpler configuration of their retention interval values.
1003 Remove JSPAC Redirects
1004 ^^^^^^^^^^^^^^^^^^^^^^
1005 Future versions of Evergreen will no longer contain automatic redirects
1006 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1007 that the JSPAC is no longer supported. Existing sites, however, may
1008 wish to retain JSPAC redirects in their Apache configuration files since
1009 JSPAC URLs may still be used in the wild to access their catalogs.
1011 The original JSPAC URL redirects are all retained in the file
1012 `Open-ILS/examples/jspac_redirects.conf` for reference.
1022 New open-ils.auth.login API
1023 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1024 The `open-ils.auth` service has a new API for requesting an authentication
1025 token. It performs the same steps as the
1026 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1027 using the bare password. No intermediate password hashing is required.
1029 The paramaters are the same as the `.complete` call with a few modifications.
1031 1. Using the generic 'identifier' parameter in combination with the
1032 'org' parameter allows the API to reliably determine if an identifier
1033 value is a username or barcode. The caller is no longer required to
1034 make that determination up front.
1036 2. The 'nonce' parameter is no longer used.
1042 Batch Patron Contact Invalidation
1043 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1044 The following methods are used to mark patron contact fields
1045 as invalid by moving the invalid value to a standing penalty:
1047 * `open-ils.actor.invalidate.email`
1048 * `open-ils.actor.invalidate.day_phone`
1049 * `open-ils.actor.invalidate.evening_phone`
1050 * `open-ils.actor.invalidate.other_phone`
1052 These methods now accept a fifth argument specifying the value
1053 of the contact field, e.g., a specific phone number or email
1054 address. If supplied, and if a specific patron ID (the first
1055 argument) is not supplied, all patrons with that specific contact
1056 value will have it marked invalid.
1066 Pure-SQL catalog searching
1067 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1068 Public and staff catalog search is now both more accurate and faster
1069 by redesigning how the visibility of records is calculated.
1079 Authority Record and Headings Browse Improvements
1080 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1081 Various improvements are made to support for authority records
1082 and headings browsing:
1084 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1085 headings from authority records. Since the MODS and MADS stylesheets
1086 extract headings in similar ways, duplicate browse entries are now
1087 much less likely to occur.
1088 * A new configuration table, `authority.heading_field`, is now used
1089 to specify how headings should be extracted from authority records.
1090 * Related headings can now be identified as narrower or broader when
1091 browsing in the public catalog.
1092 * See references are now more reliably included in the browse list.
1093 * Scope (public) notes now display only under the main heading.
1094 * There is now a global flag, Display related headings (see-also) in browse,
1095 that can be used to control whether related headings (see-alsos) are
1096 displayed in the public catalog list.
1097 * A complete set of thesauruses are now included in the seed data. Thesauruses
1098 can now be identified using short and long codes.
1099 * The labels for see and see-also references in the public catalog are
1100 a bit more patron-friendly, and can now be tweaked via TPAC template
1101 customization in the browse.tt2 file.
1107 Copy Tags and Digital Bookplates
1108 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1109 Copy tags will allow staff to apply custom, pre-defined labels or tags
1110 to copies. Copy tags are searchable in both the staff client and public
1111 catalog. This feature was designed to be used for Digital Bookplates to
1112 attach donation or memorial information to copies, but may be used for
1113 broader purposes to tag items.
1115 Each copy tag can either be publicly-visible or visible only to staff.
1116 Copy tags also have types that can be used for restricting catalog
1117 searches on copy tags to particular types.
1119 Copy tags are displayed in the copy table in the record summary page in
1120 the public catalog, and a new library setting can be used to add
1121 a "Digital Bookplate" search field. Copy tags can also be used
1122 as a search filter, e.g.,
1124 * `copy_tag(bookplate, jane smith)`: search for records that have a
1125 copy tag of type 'bookplate' whose value contains 'jane smith'.
1126 * `copy_tag(*, jane smith)`: search for records that have a
1127 copy tag of any type whose value contains 'jane smith'.
1129 All staff-side interfaces related to copy tags exist only in the web
1130 staff client. There are two new administration interfaces for managing
1131 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1132 button for applying copy tags to copies; that interface can also be
1133 used to create new copy tags on the fly. Furthermore, the copy buckets
1134 interface now has an 'Apply Tags' action for assigning tags to groups
1140 Two new permission are included:
1142 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1143 'Administration -> Server Administration -> Copy Tag Types'
1144 * `ADMIN_COPY_TAG`: required to create a new tag under
1145 'Administration -> Local Administration -> Copy Tags'
1147 The existing permission `UPDATE_COPY` controls whether or not a user
1148 can link copies to tags.
1152 A new library setting, 'Enable Digital Bookplate Search', controls
1153 whether to display a 'Digital Bookplate' field in the search index
1154 drop-downs in the catalog. A 'Digital Bookplate' search will include
1155 all records that have a copy that matches the tag specified by the user.
1156 It should be noted that this library setting does not affect the
1157 display of copy tags on the catalog record summary page.
1162 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1163 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1164 The call number prefix and suffix, when present, are now included in
1165 subfields $k and $m of the 852 field when running `marc_export` with
1166 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1167 server configured to embed item data in 852 fields, the affixes are now
1168 included in subfields $k and $m.
1178 Batch Editing of Patron Records
1179 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1180 There is a now a new interface analogous to the Copy Bucket interface
1181 to select and group a set of users into a User Bucket.
1182 The addition of users to a User Bucket is possible from the Patron Search
1183 interface by the use of a new grid Action, and directly on the User Bucket
1184 interface by user barcode. It is also possible to add users to a User
1185 Bucket by uploading a text file that contains a list of user barcodes.
1187 From this interface it is possible to perform a set of specific batch update
1188 operations on user records.
1193 These fields can now be changed in batch via an action on the User Bucket
1194 grid if the staff user has the `UPDATE_USER` permission:
1197 * Primary Permission Group (group application permissions consulted)
1199 * Home Library (`UPDATE_USER` checked against both old and new value)
1200 * Privilege Expiration Date
1201 * Barred flag (`BAR_PATRON` permission consulted)
1202 * Internet Access Level
1204 Changes made in this interface can be rolled back.
1206 As a batch process, rather than a direct edit, this mechanism explicitly skips
1207 processing of Action/Trigger event definitions for user update.
1212 The batch edit mechanism also allows for the batch deletion of user. The staff
1213 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1215 Changes made in this interface can be rolled back.
1217 As a batch process, rather than a direct edit, this mechanism explicitly skips
1218 processing of Action/Trigger event definitions for user deletion.
1220 This mechanism does not use the Purge User functionality, but instead simply
1221 marks the users as deleted.
1223 Editing Statistical Category Entries
1224 ++++++++++++++++++++++++++++++++++++
1226 All users in the bucket can have their Statistical Category Entries
1227 modified. Unlike user data field updates, modification of Statistical
1228 Category Entries is permanent and cannot be rolled back.
1230 As a batch process, rather than a direct edit, this mechanism explicitly skips
1231 processing of Action/Trigger event definitions for user update.
1233 New Service Requirement
1234 +++++++++++++++++++++++
1236 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1237 unused in production. If this service has been removed from the configuration
1238 of a live Evergreen instances, it will need to be added back in order for
1239 batch user editing to succeed.
1244 Honor Timezone of the Acting Library
1245 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1250 * Display day-granular due dates in the circulating library's timezone.
1251 * Only display the date portion of the due date for day-granular circulations.
1252 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1253 * Provide infrastructure for more advanced formatting of timestamps.
1254 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1259 This is a followup to the work done for 2.12, where we added the ability
1260 for the client to specify a timezone in which timestamps should be interpreted
1261 in business logic and the database.
1263 Most specifically, this work focuses on circulation due dates and the closed
1264 date editor. Due dates, where displayed using stock templates (including
1265 receipt templates) and used for fine calculation, are now manipulated in the
1266 library's configured timezone. This is controlled by the new 'lib.timezone'
1267 setting available via the Library Settings Editor, loaded from the server when
1268 required. Additionally, closings are recorded in the library's timezone so that
1269 due date calculation is more accurate. The closed date editor is also
1270 taught how to display closings in the
1271 closed library's timezone. Closed date entries also explicitly record if they
1272 are a full day closing, or a multi-day closing. This significantly simplifies
1273 the editor, and may be useful in other contexts.
1275 To accomplish this, we use the moment.js library and the moment-timezone addon.
1276 This is necessary because the stock AngularJS date filter does not understand
1277 locale-aware timezone values, which are required to support DST. A simple
1278 mapper translates the differences in format values from AngularJS date to
1281 Of special note are a set of new filters used for formatting timestamps under
1282 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1283 filters provide the functionality, and autogrid is enhanced to make use of
1284 these where applicable. egGrid and egGridField are also taught to accept
1285 default and field-specific options for applying date filters. These filters may
1286 be useful in other or related contexts.
1288 The egDueDate filter, used for all existing displays of due date via Angular
1289 code, intentionally interprets timestamps in two different ways WRT timezone,
1290 based on the circulation duration. If the duration is day-granular (that is,
1291 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1292 of seconds) then the date is interpreted as being in the circulation library's
1293 timezone. If it is an hourly loan (any duration that does not meet the
1294 day-granular criterium) then it is instead displayed in the client's timezone,
1295 just as all other timestamps currently are, because of the previous Evergreen
1298 The public catalog is adjusted to always display the due date in the circulating
1299 library's timezone. Because the public catalog displays only the date portion of the due
1300 date field, this difference is currently considered acceptable. If this proves
1301 to be a problem in the future, a minor adjustment can be made to match the
1302 egDueDate filter logic.
1304 Now that due dates are globally stored in the configured timezone of the
1305 circulating library, the automatic adjustment to day-granular due dates needs
1306 to take those timezones into account.
1308 An optional SQL command is provided by the upgrade script to retroactively
1309 adjust existing due dates after library configuration is complete.
1315 Enhancements to Hard Due Date Functionality
1316 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1317 It will now be possible to delete Hard Due Date Values for dates that have
1318 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1319 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1320 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1325 Patron Search by Birth Date
1326 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1327 * Now you can include the patron birth year and/or birth month and/or
1328 birth day when searching for patrons using the web staff client.
1329 * Day and month values are exact matches. E.g. month "1" (or "01")
1330 matches January, "12" matches December.
1331 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1332 1915, 1599, etc. For exact matches use the full 4-digit year.
1336 Patron Search from Place Hold
1337 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1338 This feature allows staff members, when placing a
1339 hold on behalf of a patron in the web staff client, to search for
1340 patrons by names and other searchable patron information, rather than
1341 relying on barcode alone. In particular, after performing a catalog
1342 search or going to a specific bib record and clicking the 'Place Hold'
1343 button, the form now includes a 'Patron Search' button. This button
1344 will open a dialog allowing the staff member search for and select
1350 Retrieve Recent Patrons
1351 ^^^^^^^^^^^^^^^^^^^^^^^
1353 Adds a new library setting 'Number of Retrievable Recent Patrons'
1354 ('ui.staff.max_recent_patrons') that specifies the number of recently
1355 retrieved patrons that can be re-fetched from the staff client.
1357 A value of 0 means no recent patrons can be retrieved.
1358 A value greater than 1 means staff will be able to retrieve multiple
1359 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1361 The default value is 1 for backwards compatibility.
1368 Fuller title in XUL client Simplified Pull List
1369 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1370 The Simplified Pull List in the XUL client will now display subfields 245$n and
1371 $p in the title field. The addition will make it easier for staff to distinguish
1372 between different parts or seasons in a series.
1378 Transit Cancel Time and Terminology Change
1379 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1384 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1385 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1386 are preserved in the database, though still not visible to the end user in the staff client.
1387 This allows for better tracking of when transits are canceled for the purposes of knowing
1388 which staff member canceled the transit, etc.
1390 NOTE: This change may require the re-creation of transit reports to filter out canceled
1391 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1392 Is NULL' will suffice.
1394 "Canceled Transit" Terminology Change
1395 +++++++++++++++++++++++++++++++++++++
1397 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1398 For internal continuity, however, the following permission codes have not changed:
1401 * `ABORT_REMOTE_TRANSIT`
1402 * `ABORT_TRANSIT_ON_LOST`
1403 * `ABORT_TRANSIT_ON_MISSING`
1411 Offline Circulation Available in Web Staff Client
1412 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1413 Offline circulation is now available in the web staff client. In order to use the
1414 offline interface, users must first log into the web staff client, perform
1415 a patron search, select a user from the results, and open the patron editor
1416 interface to collect all the relevent configuration information for the
1417 workstation. In addition, the offline interface available from the Circulation
1418 menu provides a 'Download block list' button for users who are logged in.
1420 As is the case in the old staff client, users can check materials in and out,
1421 renew items, and create new patron accounts while offline. The patron fields
1422 available in the offline patron registration editor are the same ones that
1423 are available to staff when working online.
1427 Add Circ Modifier to Record Detail Page in Staff TPAC
1428 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1429 The circulation modifier field is added to the table of copies to make
1430 more information available to staff without having to open
1437 Date+Time Format Settings for Web Client
1438 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1440 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1441 and adds two settings for use with the webstaff client:
1443 * 'Format Dates with this pattern'
1444 * 'Format Date+Time with this pattern'
1446 These settings use format strings as documented here:
1448 https://docs.angularjs.org/api/ng/filter/date
1450 There is overlap with how the Dojo formats worked, but also some differences.
1452 The original 'Format Dates' and 'Format Times' settings worked together, but the
1453 new settings work independently. Certain field elements will use one, and
1454 certain field elements will use the other. These distinctions are hard-coded
1455 in the various UI templates, with the idea being that timestamp fields in
1456 which the date component alone is sufficient information (for example, date of birth)
1457 will use the 'Format Dates' setting. Fields where the time component is
1458 important (for example, checkout time) will use the 'Format Date+Time' setting.
1460 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1461 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1467 Global Option to Remove Sound for a Specific Event
1468 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1469 A new `nosound.wav` file has been added to the web client. The file can be used
1470 to globally disable audio alerts for a specific event on an Evergreen system.
1472 For example, to silence the alert that sounds after a successful patron search:
1476 mkdir -p /openils/var/web/audio/notifications/success/patron/
1477 cd /openils/var/web/audio/notifications/success/patron/
1478 ln -s ../../nosound.wav by_search.wav
1485 The official Evergreen manual has been split into eight new manuals, each
1486 designed for a specific audience. This new approach is designed to make
1487 the documentation more readable and usable.
1489 The specific audiences for the new manuals are:
1491 * Acquisitions staff
1494 * Public services staff who use the public catalog
1496 * System administrators who use the command line
1497 * System administrators who use the Web client
1498 * System administrators and programmers who wish to integrate Evergreen
1499 with other technologies
1501 All manuals are available at http://docs.evergreen-ils.org
1507 Improvements to ebook API
1508 ^^^^^^^^^^^^^^^^^^^^^^^^^
1510 Evergreen now supports checking out and placing holds on
1511 OverDrive and OneClickdigital ebook titles from within the public
1512 catalog. This is an experimental feature. It is not recommended for production
1513 use without careful testing.
1515 When ebook integration is enabled, a "Check Out E-Item" link will be
1516 displayed when viewing an ebook title from a supported vendor in the
1517 catalog. Clicking on the link allows the user to check out and download
1518 that title from the vendor directly within the catalog.
1520 If no copies are available for the title, a "Place Hold on E-Item" link
1521 is displayed instead, and the user may place a hold on the title. (Note
1522 that some vendors require the user's account to have an email address
1523 before permitting a hold.)
1525 My Account includes the ability to view current ebook checkouts and
1526 holds, download already-checked-out titles, and cancel holds.
1528 For API integration to work, you need to request API access from the
1529 vendor, and the vendor must have a way of authenticating your patrons.
1530 Your Evergreen system also needs to be configured for ebook API
1531 integration, following the instructions in the command line system
1532 administration manual
1535 This feature assumes that you are importing MARC records supplied by the
1536 vendor into your Evergreen system, using Vandelay or some other MARC
1537 import method. This feature does not search the vendor's online
1538 collections or automatically import vendor records into your system; it
1539 merely augments records that are already in Evergreen.
1541 Improvements to Bill Payment Pages
1542 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1543 The bill payment pages in the public catalog have been revamped
1546 * use the term "charges" instead of "fees"
1547 * include images of credit cards accepted
1548 * make the default print receipt template match other itemized receipts;
1549 note that this change is not automatically applied when upgrading.
1550 * display billing type
1551 * add button to pay only selected charges
1552 * reformat the credit card number input page
1558 Clickable Copy Locations
1559 ^^^^^^^^^^^^^^^^^^^^^^^^
1560 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1561 the associated copy location will display as a link in the public catalog summary display.
1562 This link can be useful for retrieving maps or other directions to the copy
1563 location to aid users in finding material.
1568 Download Checkout History CSV Fixed for Large Number of Circulations
1569 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1570 Downloading checkout history as a CSV from My Account has been fixed
1571 for users with a large circulation history. Previously, this would
1572 time out for patrons with more than 100 or so circulations.
1574 This feature no longer uses the action/trigger mechanism and the public catalog
1575 now generates the CSV directly. The old action/trigger code is still
1576 present in the database and should be removed at some point in the
1582 Google Books Preview Rewrite
1583 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1584 The Google Books Preview functionality in record detail pages has been
1585 rewritten to modernize its style and optimize its performance:
1587 * The Dojo JavaScript framework is no longer used, saving approximately
1588 150K of JavaScript and CSS and four network requests per page load.
1589 * The Embedded Viewer is not loaded unless a possible preview is found,
1590 saving more network and memory overhead.
1591 * The Google Books Loader is used to load the Embedded Viewer instead of the
1592 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1594 * All variables are self-contained and do not pollute the global namespace.
1595 * Event listeners are registered to handle clicks, rather than attaching
1596 `href="javascript:function()"` to <a> elements.
1597 * Book previews are displayed in a panel sized according to the viewport
1598 of the browser, improving its appearance on both mobile and desktop
1600 * The rewritten code is now served up directly from
1601 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1606 jQuery for the Public Catalog
1607 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1608 This release adds optional support for jQuery in the public catalog. This support
1609 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1610 `config.tt2` template.
1616 New Popularity Parameters
1617 ^^^^^^^^^^^^^^^^^^^^^^^^^
1618 New popularity parameters for in-house use over time and for count of distinct
1619 organizational units that own a title are now available. Evergreen sites
1620 can use these parameters to create new statistical popularity badges for
1621 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1623 The in-house use parameters will apply a badge to titles that have the most
1624 in-house use activity over time. The organizational unit count parameter
1625 will apply a badge to titles owned by the most number of libraries in a
1626 consortium. Ownership is determined by the copy's circulation library.
1631 Option to Suspend Holds at the Time They are Placed
1632 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1633 Users now have the option to suspend a hold at the same time they place the
1634 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1635 who want to suspend a hold at the time it is placed. There is also an option
1636 to set the activation date at the same time. This option is also available
1637 when placing holds on a batch of titles from 'My List' and will apply to
1638 all the titles in the batch.
1649 Fix to reporter.classic_current_circ View
1650 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1651 The `reporter.classic_current_circ` view, which is part of some
1652 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1653 has been fixed to not exclude loans for patrons who do not have a
1654 billing address set. Users of this view should rerun
1655 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1660 New Report Source Table Allowing Report of "Last" Deleted copy
1661 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1663 This source table allows you to construct a clever aggregate report template
1664 which will report bibliographic IDs where a library or a group of libraries
1665 no longer have a copy attached but *had* a copy attached. This is especially
1666 useful when a holdings sync is required with an external vendor.
1669 Instructions for creating a report template with this source:
1671 * Create a new report template using "Library Holdings Count with Deleted" as the source
1672 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1673 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1674 * 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"
1675 * Add "Bib ID" to Displayed Fields
1676 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1677 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1678 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1681 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1682 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1683 specified date range. Unfortunately the user will have to manually type the date range without the date
1684 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1685 copy and more than two deleted copies."
1690 Add Provider to Provider Note Link
1691 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1692 The Provider reporting source now includes a link to the Provider Note reporting source.
1697 Link ILS User and Working Location Reporting Sources
1698 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1699 The Working Location reporting source now has labels
1700 and it is now linked to the ILS User reporting source, allowing
1701 reports to display or filter on staff working location.
1706 New Circulation Report Source "All Circulation Combined Types"
1707 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1709 This report source will allow you to create a single report template for all of the following:
1712 * In-house uses of non-cataloged items
1714 * Circulations of non-cataloged items
1716 To distinguish between these different types of library use, it's important to display these columns
1717 in your report templates:
1726 Reports Template Searching
1727 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1728 A new form appears along the top of the reports interface for searching
1729 report templates. Once found, typical template actions (e.g. create new
1730 report) are available from within the results interface.
1732 Searches may be performed across selected (visible) folders or all
1733 folders visible to the logged in user.
1735 Searches are case-insensitive, any word order, with left-anchored words.
1736 All searched words must appear in at least one of the searched fields.
1741 * Searching for 'stat cat' matches:
1743 ** statistical category
1744 ** categories, statistical
1745 ** patrons (stat cat)
1746 * Searching for 'stat cat' does not match:
1748 *** both words must be present in the searched field(s)
1750 *** location contains 'cat' but it's not left-anchored.
1755 The templates, reports, and output interfaces now support paging via
1756 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1768 Web Staff Client Serials Module
1769 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1770 The serials module has been ported over to the web staff
1771 client, implementing a unified serials interface that combines
1772 ideas from both the serial control view and alternate serials
1773 control view from the old staff client.
1775 In addition to carrying over functionality that was available
1776 in the old staff client, several new features are included:
1778 * the ability to save prediction pattern codes as templates
1779 that can be shared and reused within an Evergreen database
1780 * a more streamlined interface for managing subscriptions,
1781 distributions, and streams
1782 * it is no longer necessary to create a starting issue in
1783 order to predict a run of issues; the dialog box for
1784 generating a set of predicted issues now lets you specify
1785 the starting point directly.
1786 * the ability to more directly edit MFHDs
1788 The new serials interfaces can be accessed from the record
1789 details page via a Serials drop-down button that links to
1790 a subscription management page, a quick-receive action, and
1791 a MFHD management page. There is also a new 'Serials Administration'
1792 page where prediction pattern and serial copy templates can
1803 SIP Bugfix Changes How Encoding Is Determined in Configuration
1804 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1806 The combined fix for the above mentioned SIP bugs alters the way that
1807 SIPServer looks up the output encoding in the configuration file (typically
1808 `oils_sip.xml`). SIPServer now looks for the encoding in the following
1811 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1812 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1813 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.
1814 4. If none of the above exist, then the default encoding (ASCII) is used.
1816 Number 3 is provided to ease the transition to the new code. It is
1817 the current location of the +encoding+ element in the sample
1818 configuration file and as such, where it is likely to be found in
1819 actual files. It is recommended that you alter your configuration to
1820 move this element out of the +implementation_config+ element and into
1821 its parent +institution+ element. Ideally, SIPServer should *not* look into
1822 the implementation config, and this check may be removed at some time
1830 Web Client Acknowledgments
1831 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1833 The project to develop a new browser-based web client launched four
1834 years ago at the September 2013 Evergreen developer hack-a-way when the
1835 developer community voted to move away from the XUL client and explore other
1836 platforms. The first web client preview became available in Evergreen 2.7 when
1837 circulation was available in the new platform.
1839 The browser-based client is available due to the work of many coders, testers,
1840 bug reporters, documentors, translators, project managers, spec writers, funders
1841 and other contributors over the past four years.
1843 The Evergreen project would like to acknowledge the following organizations
1844 that funded development of the Web Staff Client:
1847 * British Columbia Libraries Cooperative
1848 * Consortium of Ohio Libraries
1850 * Georgia Public Library Service
1851 * Grand Rapids Public Library
1853 * Kenton County Public Library
1854 * King County Library System
1857 * Pennsylvania Integrated Library System
1858 * Pioneer Library System
1861 The Evergreen project would also like to thank the following individuals who
1862 contributed code, translations, documentation patches, tests, bug reports,
1863 technical specifications, and project management to the Web Staff Client:
1900 * Freddy Enrique Pelayo Huapalla
1926 Evergreen 3.0 Acknowledgments
1927 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1929 The Evergreen project would like to acknowledge the following
1930 organizations that commissioned developments in this release of
1934 * British Columbia Libraries Cooperative (BC Sitka)
1936 * Georgia Public Library Service
1937 * King County Library System
1939 * Pennsylvania Integrated Library System
1940 * Pioneer Library System
1942 We would also like to thank the following individuals who contributed
1943 code, translations, documentation patches, and tests to this release of
1992 We also thank the following organizations whose employees contributed
1995 * British Columba Libraries Cooperative
1999 * Emerald Data Networks, Inc.
2000 * Equinox Open Library Initiative
2002 * Grand Rapids Public Library
2003 * Indiana State Library
2005 * King County Library System
2006 * Lake Agassiz Regional Library
2007 * Laurentian University
2008 * Linn-Benton Community College
2010 * Merrimack Valley Library Consortium
2012 * North of Boston Library Exchange
2013 * Pennsylvania Integrated Library System
2014 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2016 * Traverse Area District Library
2018 We regret any omissions. If a contributor has been inadvertently
2019 missed, please open a bug at http://bugs.launchpad.net/evergreen/