1 Evergreen 3.0 Release Notes
2 ===========================
8 This release is a security release that fixes cross-site scripting
9 (XSS) vulnerabilities in the Evergreen public catalog. This release
10 also includes several other bugfixes improving on Evergreen 3.0.5.
12 Security Issue: XSS Vulnerability in Public Catalog
13 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 This release fixes several cross-site scripting (XSS) vulnerabilities
15 in the public catalog. When upgrading, Evergreen administrators should
16 review whether any of the following templates have been customized
17 or overridden. If so, either the template should be replaced with the
18 stock version or the XSS fix (which entails adding the `| html` filter
19 in several places) applied to the customized version.
21 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
22 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
23 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
25 Note that exploiting the XSS vulnerabilities fixed in this release
26 would require either the ability to create maliciously-constructed
27 MARC bibliographic or holdings records or the ability to set a
28 maliciously constructed organizational unit name.
32 Evergreen 3.0.6 also includes the following changes:
34 * When using 'Selection Lists -> Edit MARC Order Record' in the web
35 staff client, now only one click is required to save the MARC
36 record rather than two.
37 * The volume/copy editor in the web staff client now better handles
38 editing multiple items that have different sets of statistical
39 category values assigned to them.
40 * The act of merging bibliographic records now updates bookbags
41 that referred to the source bibliographic record rather than
42 effectively deleting entries for that record.
43 * Additional columns were added to the Holds Pull List in the
45 * The patron registration form in the web staff client now correctly
46 manages setting user preferences.
47 * An error in a pgTAP unit test was corrected.
51 We would like to thank the following individuals who contributed code,
52 tests and documentation patches to the 3.0.6 security release of
68 This release contains bug fixes improving on Evergreen 3.0.4.
70 * The MARC Editor in the Web staff client now wraps long fields.
71 * The MARC Editor no longer allows catalogers to enter new lines
73 * Fixes an issue that prevented serials items from being deleted or
75 * The Web staff client Check In screen no longer reloads the whole
76 page multiple times each time an item is scanned.
77 * Fixes an issue that displayed the oldest -- rather than the newest
78 -- transit in the Web staff client Item Status page.
79 * Fixes an issue that prevented the reports module from being displayed
81 * Fixes an issue in the Web staff client reports module that caused
82 syntax errors in reports that use virtual fields and joins.
83 * Fixes an issue that prevented several dropdown menus in the Web staff
84 client from activating.
85 * Fixes an issue that created duplicate copy data when copies or
86 volumes with parts were transferred.
87 * Fixes the Trim List feature in the Web staff client Check In screen.
88 * The Item Status grid now displays the Circulation Modifier.
89 * Restores missing data from the Profile column in Place Hold patron
91 * Fixes an issue with the http -> https redirect on Apache 2.4.
92 * Fixes an color contrast accessibility issue in the Web staff
93 client and adds underlining to links in grid cells for added accessibility.
94 * Adds automated regression and unit tests for the Web staff client
96 * Adds a process for spell-checking the official documentation.
97 * Adds a script that simplifies the release process related to translations.
102 We would like to thank the following individuals who contributed code,
103 tests and documentation patches to the 3.0.5 point release of
108 * Blake Graham-Henderson
123 This release contains bug fixes improving on Evergreen 3.0.3:
125 * Fixes a bug that caused all searches limited by shelving location to
127 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
128 rather than the ordering agency's SAN.
129 * Fixes a bug that prevented Safari/iOS users from logging in to the
131 * Fixes a bug that prevented users from using the browse interface.
132 * Fixes a bug in the Item Status List view that caused incorrect due
134 * Approval code is now a required field in the web client's patron
135 credit card payment form.
136 * Fixes a bug with credit card payments that caused a receipt to print
137 showing that the patron paid the bill when the payment had not actually
139 * Fixes a bug that prevented the EDI translator from being installed on
141 * Fixes a bug that caused entries to show up multiple times in the
142 Items Out and Holds tabs in the patron record.
143 * Fixes a bug that caused grids on Bills and Patron Messages
144 screens to not display properly.
145 * The following fields are now available for the Checkout and Items Out
152 ** money_summary.balance_owed
153 ** money_summary.total_paid
154 ** money_summary.total_owed
159 * The following fields are now available on the Bill Payment receipt templates:
169 * Payment type is now a column in the payments tab of the patron record
170 Bill History section.
171 * The "Replace Barcode" function now makes it more difficult for staff
172 members to attempt to create blank patron barcodes.
173 * The patron bills screen now prevents staff members from double-clicking
174 on the Apply Payment button (which otherwise would apply two payments).
175 * Fixes a bug that prevented patrons attached to statistical categories
176 from displaying in the patron search-to-hold dialog.
177 * Fixes a performance issue related to uploading CSV files of barcodes
178 to the item status and patron bucket interfaces.
179 * Fixes several small bugs in the Spanish translation.
180 * Fixes a performance bug related to patrons logging in by barcode.
184 We would like to thank the following individuals who contributed code,
185 tests and documentation patches to the 3.0.4 point release of
207 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
208 update the visibility attributes of all bibs that make use of Located URIs or
209 bib sources. It may take a while to run on large datasets. If it it running
210 too long, it can be canceled and the following psql commands will create and
211 run a script that will perform the same action serially over time without
212 blocking writes to bibs:
215 \o /tmp/luri_visibility_update.sql
216 SELECT 'UPDATE biblio.record_entry SET ' ||
217 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
218 'WHERE id = ' || id || '; SELECT ' || id || ';'
219 FROM biblio.record_entry
221 SELECT DISTINCT cn.record
222 FROM asset.call_number cn
224 AND cn.label = '##URI##'
227 FROM asset.uri_call_number_map m
228 WHERE m.call_number = cn.id
231 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
236 \i /tmp/luri_visibility_update.sql
239 It will output the id of each updated bib so that the script can be killed
240 and then edited to remove completed bibs. The remainder can be run at a
243 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
244 we do NOT update the bib's visibility attributes, as doing so causes a loop
245 and an eventual trigger stack violation. This flag should ONLY be used when
246 forcing reingest of record attributes (NOT visibility attributes), search,
247 facet, and display fields, so if using this flag under normal operation,
248 proceed at your own risk and know that Located URI and bib source changes
249 will not be reflected in the visibility attributes of the record.
253 This release contains several bug fixes improving on Evergreen 3.0.1:
255 * Fixes several issues related to the display of located URIs and records with
256 bib sources in search results.
257 * Setting `opac_visible` to false for a copy location group now hides only
258 the location group itself, rather than also hiding every single copy in the
260 * Fixes a bug that prevented the copy editor from displaying the _fine level_
261 and _loan duration_ fields.
262 * The "Edit Items" grid action in the Item Status interface will now open
263 in the combined volume/copy editor in batch. This makes the behavior
264 consistent with the "Edit Selected Items" grid action in the copy
266 * Staff members are now required to choose a billing type when creating a
267 bill on a user account.
268 * The Web client now provides staff users with an alert and option to
269 override when an item with the Lost and Paid status is checked in.
270 * Fixes a bug where the Web client offline circ interface was not able
271 to set its working location.
272 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
274 * The MARC editor in the Web staff client now presents bib sources in
276 * Both circulation and grocery bills are now printed when a staff user selects
277 a patron account and clicks "Print Bills".
278 * Fixes an issue in the XUL serials interface the "Receive move/selected"
279 action from succeeding.
280 * Fixes a typo in the user password testing interface.
284 We would like to thank the following individuals who contributed code,
285 tests and documentation patches to the 3.0.3 point release of
304 This release contains several bug fixes improving on Evergreen 3.0.1:
306 * Copy templates created in XUL Holdings Maintenance will now be
307 automatically converted and displayed in the web staff client's
309 * The list of report templates now includes a column indicating whether
310 the template was originally created in the XUL staff client or the web
311 staff client; staff need to know this since report templates created in
312 one interface cannot be edited in the other.
313 * Call number prefixes and suffixes are now displayed in various grids
314 in the web staff client, including
315 ** Pending Copy Buckets
317 ** Checkin/Capture Holds
319 ** Patron Bills History
326 ** Bib Record View Holds
328 * Many patron fields have been redacted from the web staff client's patron
329 and record holds grids, leaving patron name, username, and ID.
330 * Fixes two bugs where patron records could fail to be saved upon editing.
331 * The web staff patron editor now better warns staff users about
332 duplicate names, IDs, phone numbers, and email addresses.
333 * Human readable labels are now displayed for certain fields in standing
335 * The patron summary in the web staff client now correctly displays
336 primary and secondary ID values.
337 * The web staff client's billing full details page now displays
338 information about the staff user that created a payment.
339 * The web staff client now requires staff users to explicitly set a
340 billing type when adding a manual bill.
341 * The web staff client's patron bill annotation modal now works.
342 * Patron barcode search completion in the web staff client now allows
343 the user to select from all of the matching patron records.
344 * The Hold Shelf Slip print template in the web staff client now has
345 access to the call number.
346 * The Checkout Receipt print template in the web staff client now can
347 include summary financial information, incuding current balance, total
348 paid on outstanding fines, and total owed.
349 * The web staff print templates for current and historical bills can
350 now include copy barcode and title.
351 * Fixes a bug that resulted in some catalog searches unexpectedly
353 * Fixes a bug that resulted in catalog searches that specify a location
354 limit returning incorrect results.
355 * Fixes a bug where deleted copies could make records visible in the
357 * Fixes a bug where certain queries on copies used in the public catalog
359 * Fixes a bug place a hold request in the public catalog could result
360 in "forgetting" the type and library of the user's previous search.
361 * The web staff client now respects staff user session timeouts, and
362 will log out all open tabs if a user's session has timed out.
363 * The web staff Z39.50 page will now give the staff user an alert if
364 they attempt to import a record with a duplicate TCN.
365 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
366 entries from being deleted.
367 * Fixes a bug that made using the volume/copy editor to change a copy's
369 * The administration interface for hard due dates now ensures that
370 new (or edited) ceiling dates have their time component set to end
371 of day, resolving an issue where ceiling dates would not be applied
372 during the ceiling date itself.
373 * The web staff client can now include dynamic information in browser
374 tab titles, e.g., "Smith, Jane - Checkout".
375 * The Concerto sample data set now includes data allowing for testing
376 placing holds on monographic parts.
377 * Asset merging during bibliographic record merging now correctly
378 recognizes call number prefixes and suffixes and deletes disused
380 * Fixes a bug where displaying user surveys could result in PCRUD
382 * Fixes a bug where pg_restore of an Evergreen database could fail
383 to create certain indexes on the `actor.usr` table.
387 We would like to thank the following individuals who contributed code,
388 tests and documentation patches to the 3.0.2 point release of
419 This release contains several bug fixes improving on Evergreen 3.0.0
421 * Fixes a bug in the web staff client that prevented initials from being
422 stored with copy notes.
423 * Adds billing types that may have been missed by systems that were
424 running Evergreen prior to the 1.4 release.
425 * Fixes a web staff client bug with the CSV export option available from
426 the Import Queue in the MARC Batch Import/Export interface.
427 * Adds the missing copy alert field in the web client's volume/copy
429 * Fixes a bug where the setting to require date of birth in patron
430 registration was not being honored in the web staff client.
431 * Fixes a bug in the web staff client patron registration form where the
432 password wasn't generating from the last four digits of the patron's
434 * Fixes an issue in the web staff client where the complete barcode did
435 not display in some interfaces when partial barcodes were scanned.
436 * Fixes an HTML error in the new copy tags that display on the record
438 * Fixes a web staff client bug where recording a large number of in-house
439 uses at one time doesn't display a confirmation dialog once it hits the
441 * Adds a _Print Full Grid_ action in the web staff client
442 holds pull list to allow staff to print the entire pull list as it
443 displays on the screen. This change also changes the _Export CSV_ action
444 to an _Export Full CSV_ option.
445 * Fixes an issue with the Patron Messages interface that prevented it
446 from saving column configuration changes in the web staff client.
447 * Fixes a bug in the web staff client where a billing prompt did not
448 correctly display after marking an item damaged in those systems that
449 have enabled the setting to bill for damaged items.
450 * Adds an option to the specific due date feature that allows saving
451 that due date until logout. This allows all circulations from a given
452 workstation to be due on the same date.
456 We would like to thank the following individuals who contributed code,
457 tests and documentation patches to the 3.0.1 point release of
479 The minimum version of PostgreSQL required to run Evergreen 3.0 is
480 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
482 Change to Names of Shared Libraries
483 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
484 OpenSRF 3.0 changes how the shared libraries for services written in
485 C are named. If upgrading from an earlier version of Evergreen,
486 `opensrf.xml` should be edited so that shared library file names
487 listed in the `<implementation>` tag start with "lib". For example,
490 ---------------------------------------------------------------------
492 <language>C</language>
493 <implementation>oils_cstore.so</implementation>
494 ---------------------------------------------------------------------
496 should be changed to:
499 ---------------------------------------------------------------------
501 <language>C</language>
502 <implementation>liboils_cstore.so</implementation>
503 ---------------------------------------------------------------------
505 SIP Bugfix Requires SIPServer Upgrade
506 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
508 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
509 crash" requires that you also upgrade SIPServer with the fix for
510 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
511 SIP client problems." This means that if you use SIP2 with Evergreen,
512 you must also upgrade SIPServer to the latest commit in the Git
513 repository. Conversely, if you upgrade SIPServer to the latest commit
514 in Git, you must also upgrade Evergreen or, at least, apply the patch
515 for Launchpad Bug 1542495. These two patches are complementary and
516 cannot be applied independently of one another.
518 `open-ils.auth.login`
519 ~~~~~~~~~~~~~~~~~~~~~
520 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
521 API's in the `opensrf_core.xml` file.
526 ---------------------------------------------------------------------
527 --- a/Open-ILS/examples/opensrf_core.xml.example
528 +++ b/Open-ILS/examples/opensrf_core.xml.example
529 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
531 <match_string>open-ils.auth.authenticate.verify</match_string>
532 <match_string>open-ils.auth.authenticate.complete</match_string>
533 + <match_string>open-ils.auth.login</match_string>
534 <match_string>open-ils.auth_proxy.login</match_string>
535 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
536 <match_string>open-ils.actor.user.password</match_string>
537 ---------------------------------------------------------------------
541 Administrators of Evergreen who use RTL locales and who have customized
542 `style-rtl.css.tt2` should now incorporate their customizations into
545 Multi-Time Zone Installations
546 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
548 For Evergreen consortia that span more than one time zone, the following
549 query will adjust all historical, unaged circulations so
550 that if their due date field is pushed to the end of the day, it is done
551 in the circulating library's time zone, and not the server time zone.
553 It is safe to run this after any change to library time zones.
555 Running this is not required, as no code before this change has
556 depended on the time string of '23:59:59'. It is also not necessary
557 if all of your libraries are in the same time zone, and that time zone
558 is the same as the database's configured time zone.
567 for ou_id in select id from actor.org_unit loop
568 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
569 if new_tz is not null then
570 update action.circulation
571 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
572 where circ_lib = ou_id
573 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
582 Deprecation of XUL staff client
583 -------------------------------
584 Starting with the release of 3.0.0, patches that fix XUL bugs will not
585 be merged into master or backported unless they meet one or more of
586 the following conditions:
588 a. the bug is a security issue
589 b. the bug involves the destruction of data
590 c. the bug is a regression of functionality in the XUL staff client
591 introduced by other work done to Evergreen
593 Under no circumstances will XUL staff client feature enhancements be merged.
595 This policy will continue through the 3.0.x and 3.1.x maintenance
596 release cycles, and will become moot upon the release of 3.2.0, when
597 the XUL staff client is slated to be entirely removed.
606 Evergreen 3.0 features a new, modern staff client that runs in the web browser
607 and can be used on desktop and mobile devices. All functional areas of the
608 system, including circulation, cataloging, acquisitions, serials, reports,
609 booking, administration, and offline circulation, are available in the new staff
610 client. Chrome and Firefox are officially supported for use with the web client.
612 Library staff will no longer need to download separate software to perform most
613 actions in Evergreen. A Chrome plugin called Hatch will be available as a
614 separate installation for workstations that require seamless, dialog-free
615 printing to multiple printers.
617 In addition to adding more portability and stability, the new staff client also
618 presents a cleaner and more modern interface for users. By virtue of running in
619 a browser, actions that users are accustomed to performing on other web sites
620 should now be available in the Evergreen client.
622 The old, XUL client will continue to be available to allow for a gradual
623 transition to the browser-based client, but no new features will be added. The
624 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
634 New EDI Order Generator
635 ^^^^^^^^^^^^^^^^^^^^^^^
640 . New database tables exist for configuring vendor-specific EDI order
644 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
647 ** Collection of `edi_attr`s. Each edi_account may be linked to one
649 ** One `edi_attr_set` per known vendor is added to the stock data, matching
650 the stock configuration found in the JEDI template.
651 * `acq.edi_attr_set_map`
652 ** Link between `edi_attr`s and `edi_attr_set`s.
654 . EDI Attribute Sets are manged via a new (browser client only) configuration
655 interface at 'Administration -> Acquisitions Administration -> EDI
658 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
659 is not set, default values will be used. Links between an EDI account
660 and an attribute set are managed in the EDI Accounts configuration
663 . Local modifications to the stock EG JEDI template are managed by modifying
664 and/or adding additional `edi_att_set`s as needed.
666 . A new `edi_order_pusher.pl` script is added which replaces the functionality
667 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
669 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
670 definition is no longer required and can be disabled.
675 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
676 specifies whether PO's generated via the account should be built using
677 EDI attributes or fall back to traditional JEDI A/T template generation.
679 This allows sites to activate EDI attributes on a per-account basis, making
680 it possible to migrate piecemeal to EDI attributes. For the initial roll
681 out of this new feature, no accounts will be configured to use EDI
682 attributes by default.
688 3 Day Courtesy Notice by SMS
689 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
690 New optional SMS text notification to be sent out 3 days prior to the due
691 date of any circulating item for patrons who have an SMS text number and
692 carrier stored in their accounts. This action trigger is disabled by default,
693 but can be enabled and modified by going into 'Administration -> Local Administration ->
694 Notifications / Action Triggers'.
696 You may wish to make use of granularity so that these messages are batched
697 and sent at the same time each day.
702 Add Description Field to Circulation and Hold Configuration Entries
703 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
704 The circulation and hold policy configuration rules now each have a
705 description field. This allows administrators to add comments to
706 describe the purpose of each rule.
711 Apache Internal Port Configuration Option
712 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
713 Apache configuration now supports a new variable which allows admins to
714 specify the port used by Apache to handle HTTP traffic. The value is
715 used for HTTP requests routed from Perl handlers back to the same Apache
716 instance, like added content requests. Use this when running Apache
717 with a non-standard port, typical with a proxy setup. Defaults to "80".
720 -------------------------------------------------------------------
723 PerlSetVar OILSWebInternalHTTPPort "7080"
726 -------------------------------------------------------------------
731 Configurable Bib Record Display Fields
732 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
734 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
735 fields: 'Display Field?' and 'Display XPath'.
737 When 'Display Field' is set to true, data from the field will be extracted
738 from each record and added to a new table of display data for each bib
741 If a value is present in the 'Display XPath' field, this XPath will be
742 applied to the extracted data *after* the base XPath (from the 'XPath'
743 field) is applied to each field.
745 This data acts as a replacement for the various and sundry ways bib record
746 data is currently extracted, including inline XPath in the TPAC, reporter
747 views, real-time 'MVR' compilation from MODS, etc. and will be available
748 to the user interface, notification templates, etc. for rendering bib
751 The browser client gets a new service 'egBibDisplay' which is capable
752 of translating the display field data from various formats into
753 data more suitable for JavaScript usage.
755 The database gets 3 new views for representing display data in various
758 * `metabib.flat_display_entry`
759 ** List of all display fields linked to their configuration.
760 * `metabib.compressed_display_entry`
761 ** Same as `metabib.flat_display_entry` except there's one row
762 per display field type, with 'multi' rows compressed into
763 JSON arrays. Non-multi fields are represented as JSON
765 * `metabib.wide_display_entry`
766 ** Tabular view of display field data, one column per well-known
767 field. Values are represented JSON, consistent with
768 `metabib.flat_display_entry`. The view does *not* contain locally
769 configured display fields, as each field must be encoded in
770 the view and IDL definition. This is essentially a replacement
771 for `reporter.simple_record`.
776 After making changes to display field configuration, it's possible to
777 reingest only display field data in the database using the following:
780 ---------------------------------------------------------------------
781 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
782 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
783 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
784 ---------------------------------------------------------------------
790 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
791 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
792 The existing permission was incorrectly created with a code of
793 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
794 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
795 update changes the permission code to match what the event requires.
801 Hold Targeter V2 Repairs and Improvements
802 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
803 * Make the batch targeter more resilient to a single-hold failure.
804 * Additional batch targeter info logging.
805 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
806 * Removes the confusingly named `--target-all` option
807 ** The same behavior can be achieved by using `--retarget-interval "0s"`
808 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
810 New --next-check-interval Option
811 ++++++++++++++++++++++++++++++++
812 Specify how long after the current run time the targeter will retarget
813 the currently affected holds. Applying a specific interval is useful
814 when the retarget-interval is shorter than the time between targeter
817 For example, if the targeter is run nightly at midnight with a
818 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
819 since the holds won't be processed again until 48 hours later. This
820 ensures that the org unit closed date checks are looking at the correct
823 This setting overrides the default behavior of calculating the next
824 retarget time from the retarget-interval.
826 New --soft-retarget-interval Option
827 +++++++++++++++++++++++++++++++++++
828 This is a replacement for (and rebranding of) the `--skip-viable` option.
829 The new option allows for time-based soft-targeting instead simple binary
830 on/off soft-targeting.
832 How soft-targeting works:
834 * Update hold copy maps for all affected holds
835 * Holds with viable targets (on the pull list) are otherwise left alone.
836 * Holds without viable targets are retargeted in the usual manner.
842 New marc_export --descendants Option
843 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
845 The `marc_export` script has a new option, `--descendants`. This option
846 takes one argument of an organizational unit shortname. It works much
847 like the existing `--library` option except that it is aware of the
848 org. tree and will export records with holdings at the specified
849 organizational unit and all of its descendants. This is handy if you
850 want to export the records for all of the branches of a system. You
851 can do that by specifying this option and the system's shortname,
852 instead of specifying multiple `--library` options for each branch.
854 The `--descendants` option can be repeated, as the `--library` option can.
855 All of the specified org. units and their descendants will be included
856 in the output. It can also be combined with individual `--library`
857 options when necessary.
862 RTL and LTR Public Catalog Stylesheets Merged
863 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
864 The RTL stylesheet for the public catalog,
865 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
866 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
867 template will provide RTL or LTR styles based on the value of
868 the `rtl` flag of the active locale. An `rtl` variable is also available
869 in the template to allow the correct style to be chosen.
874 Miscellaneous Improvements
875 ^^^^^^^^^^^^^^^^^^^^^^^^^^
877 * If a filter is in effect in the Library Settings Editor,
878 the filter will continue to be applied after a user
879 changes the selected library.
880 * Copy templates used for serials now correctly link to age
881 protection rules and MARC item type values (for the
882 "Circ as Type" field). During upgrade, the database update
883 will set to NULL any age protection and circ as type fields
884 in serial copy templates that do not point to defined values.
889 Obsolete Internal Flag Removed
890 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
892 An obsolete and unused `ingest.disable_metabib_field_entry` internal
893 flag was removed from the `config.internal_flags` table. It was
894 rendered obsolete by the addition of the 3 flags to control the
895 browse, search, and facet indexing.
900 Tweaks to Caching/Expiry of Public Catalog Assets
901 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
902 The default cache expiration time for static assets (e.g.,
903 CSS, image, and JavaScript files) in the public catalog and
904 the Kid's PAC has been increased to one year. Links to all
905 such assets now have a cache-busting value tacked on as a
906 query parameter. This value is refreshed when `autogen.sh` is
907 run, but it can also be manually set by adjusting the
908 `ctx.cache_key` Template Toolkit variable.
913 Action/Trigger Events Data Purging
914 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
916 Action/Trigger event definitions have a new field called 'Retention
917 Interval'. When an optional interval value is applied, events and
918 template output data linked to the event definition will be deleted
919 from the database once they reach the specified age.
921 Retention Interval Restrictions for Passive Hooks
922 +++++++++++++++++++++++++++++++++++++++++++++++++
924 Restrictions are placed on retention interval values for event definitions
925 using passive hooks to prevent data from being deleted while it's still
926 needed by the system.
928 The presence of event data is how the system knows not to send duplicate
929 events. As long as a scenario exists where a duplicate event may be
930 generated, the events must be retained.
932 To apply a retention interval value to a passive-hook event definition:
934 * The event definition must have a max_delay value.
935 * The retention interval must be larger than the difference between
936 the `delay` and `max_delay` values.
938 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
939 interval must be greater than 3 days to ensure no duplicate events are
940 created between the first event on day 7 and the end of the event validity
946 A new `purge_at_events.sh` script is installed in the bin directory
947 (typically `/openils/bin`) which should be added to CRON for regular
950 NOTE: On large data sets, this script can take a long time to run and
951 create higher than normal I/O load as it churns though the event and
952 event_output tables. You may wish to run the script by hand the first
953 time so it can be monitored. It can be run in psql like so:
956 ---------------------------------------------------------------
957 SELECT action_trigger.purge_events();
958 ---------------------------------------------------------------
960 NOTE: On *very* large data sets (10s to 100s of millions of event and
961 event_output rows), it may be advisable to first repopulate the `event`
962 and `event_output` tables with only the desired data before starting
963 regular purges. This can be done, for example, using the copy to temp
964 table, truncate source table, repopulate source table from temp table
965 approach. This will be much faster than the `purge_events()` function
966 in cases where most of the data will be purged.
971 A number of `action_trigger.hook` entries which have always been treated
972 as active hooks, though are configured as passive hooks, have been
973 updated to properly reflect the non-passive-ness. This allows for
974 simpler configuration of their retention interval values.
980 Remove JSPAC Redirects
981 ^^^^^^^^^^^^^^^^^^^^^^
982 Future versions of Evergreen will no longer contain automatic redirects
983 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
984 that the JSPAC is no longer supported. Existing sites, however, may
985 wish to retain JSPAC redirects in their Apache configuration files since
986 JSPAC URLs may still be used in the wild to access their catalogs.
988 The original JSPAC URL redirects are all retained in the file
989 `Open-ILS/examples/jspac_redirects.conf` for reference.
999 New open-ils.auth.login API
1000 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1001 The `open-ils.auth` service has a new API for requesting an authentication
1002 token. It performs the same steps as the
1003 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1004 using the bare password. No intermediate password hashing is required.
1006 The paramaters are the same as the `.complete` call with a few modifications.
1008 1. Using the generic 'identifier' parameter in combination with the
1009 'org' parameter allows the API to reliably determine if an identifier
1010 value is a username or barcode. The caller is no longer required to
1011 make that determination up front.
1013 2. The 'nonce' parameter is no longer used.
1019 Batch Patron Contact Invalidation
1020 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1021 The following methods are used to mark patron contact fields
1022 as invalid by moving the invalid value to a standing penalty:
1024 * `open-ils.actor.invalidate.email`
1025 * `open-ils.actor.invalidate.day_phone`
1026 * `open-ils.actor.invalidate.evening_phone`
1027 * `open-ils.actor.invalidate.other_phone`
1029 These methods now accept a fifth argument specifying the value
1030 of the contact field, e.g., a specific phone number or email
1031 address. If supplied, and if a specific patron ID (the first
1032 argument) is not supplied, all patrons with that specific contact
1033 value will have it marked invalid.
1043 Pure-SQL catalog searching
1044 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1045 Public and staff catalog search is now both more accurate and faster
1046 by redesigning how the visibility of records is calculated.
1056 Authority Record and Headings Browse Improvements
1057 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1058 Various improvements are made to support for authority records
1059 and headings browsing:
1061 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1062 headings from authority records. Since the MODS and MADS stylesheets
1063 extract headings in similar ways, duplicate browse entries are now
1064 much less likely to occur.
1065 * A new configuration table, `authority.heading_field`, is now used
1066 to specify how headings should be extracted from authority records.
1067 * Related headings can now be identified as narrower or broader when
1068 browsing in the public catalog.
1069 * See references are now more reliably included in the browse list.
1070 * Scope (public) notes now display only under the main heading.
1071 * There is now a global flag, Display related headings (see-also) in browse,
1072 that can be used to control whether related headings (see-alsos) are
1073 displayed in the public catalog list.
1074 * A complete set of thesauruses are now included in the seed data. Thesauruses
1075 can now be identified using short and long codes.
1076 * The labels for see and see-also references in the public catalog are
1077 a bit more patron-friendly, and can now be tweaked via TPAC template
1078 customization in the browse.tt2 file.
1084 Copy Tags and Digital Bookplates
1085 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1086 Copy tags will allow staff to apply custom, pre-defined labels or tags
1087 to copies. Copy tags are searchable in both the staff client and public
1088 catalog. This feature was designed to be used for Digital Bookplates to
1089 attach donation or memorial information to copies, but may be used for
1090 broader purposes to tag items.
1092 Each copy tag can either be publicly-visible or visible only to staff.
1093 Copy tags also have types that can be used for restricting catalog
1094 searches on copy tags to particular types.
1096 Copy tags are displayed in the copy table in the record summary page in
1097 the public catalog, and a new library setting can be used to add
1098 a "Digital Bookplate" search field. Copy tags can also be used
1099 as a search filter, e.g.,
1101 * `copy_tag(bookplate, jane smith)`: search for records that have a
1102 copy tag of type 'bookplate' whose value contains 'jane smith'.
1103 * `copy_tag(*, jane smith)`: search for records that have a
1104 copy tag of any type whose value contains 'jane smith'.
1106 All staff-side interfaces related to copy tags exist only in the web
1107 staff client. There are two new administration interfaces for managing
1108 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1109 button for applying copy tags to copies; that interface can also be
1110 used to create new copy tags on the fly. Furthermore, the copy buckets
1111 interface now has an 'Apply Tags' action for assigning tags to groups
1117 Two new permission are included:
1119 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1120 'Administration -> Server Administration -> Copy Tag Types'
1121 * `ADMIN_COPY_TAG`: required to create a new tag under
1122 'Administration -> Local Administration -> Copy Tags'
1124 The existing permission `UPDATE_COPY` controls whether or not a user
1125 can link copies to tags.
1129 A new library setting, 'Enable Digital Bookplate Search', controls
1130 whether to display a 'Digital Bookplate' field in the search index
1131 drop-downs in the catalog. A 'Digital Bookplate' search will include
1132 all records that have a copy that matches the tag specified by the user.
1133 It should be noted that this library setting does not affect the
1134 display of copy tags on the catalog record summary page.
1139 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1140 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1141 The call number prefix and suffix, when present, are now included in
1142 subfields $k and $m of the 852 field when running `marc_export` with
1143 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1144 server configured to embed item data in 852 fields, the affixes are now
1145 included in subfields $k and $m.
1155 Batch Editing of Patron Records
1156 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1157 There is a now a new interface analogous to the Copy Bucket interface
1158 to select and group a set of users into a User Bucket.
1159 The addition of users to a User Bucket is possible from the Patron Search
1160 interface by the use of a new grid Action, and directly on the User Bucket
1161 interface by user barcode. It is also possible to add users to a User
1162 Bucket by uploading a text file that contains a list of user barcodes.
1164 From this interface it is possible to perform a set of specific batch update
1165 operations on user records.
1170 These fields can now be changed in batch via an action on the User Bucket
1171 grid if the staff user has the `UPDATE_USER` permission:
1174 * Primary Permission Group (group application permissions consulted)
1176 * Home Library (`UPDATE_USER` checked against both old and new value)
1177 * Privilege Expiration Date
1178 * Barred flag (`BAR_PATRON` permission consulted)
1179 * Internet Access Level
1181 Changes made in this interface can be rolled back.
1183 As a batch process, rather than a direct edit, this mechanism explicitly skips
1184 processing of Action/Trigger event definitions for user update.
1189 The batch edit mechanism also allows for the batch deletion of user. The staff
1190 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1192 Changes made in this interface can be rolled back.
1194 As a batch process, rather than a direct edit, this mechanism explicitly skips
1195 processing of Action/Trigger event definitions for user deletion.
1197 This mechanism does not use the Purge User functionality, but instead simply
1198 marks the users as deleted.
1200 Editing Statistical Category Entries
1201 ++++++++++++++++++++++++++++++++++++
1203 All users in the bucket can have their Statistical Category Entries
1204 modified. Unlike user data field updates, modification of Statistical
1205 Category Entries is permanent and cannot be rolled back.
1207 As a batch process, rather than a direct edit, this mechanism explicitly skips
1208 processing of Action/Trigger event definitions for user update.
1210 New Service Requirement
1211 +++++++++++++++++++++++
1213 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1214 unused in production. If this service has been removed from the configuration
1215 of a live Evergreen instances, it will need to be added back in order for
1216 batch user editing to succeed.
1221 Honor Timezone of the Acting Library
1222 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1227 * Display day-granular due dates in the circulating library's timezone.
1228 * Only display the date portion of the due date for day-granular circulations.
1229 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1230 * Provide infrastructure for more advanced formatting of timestamps.
1231 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1236 This is a followup to the work done for 2.12, where we added the ability
1237 for the client to specify a timezone in which timestamps should be interpreted
1238 in business logic and the database.
1240 Most specifically, this work focuses on circulation due dates and the closed
1241 date editor. Due dates, where displayed using stock templates (including
1242 receipt templates) and used for fine calculation, are now manipulated in the
1243 library's configured timezone. This is controlled by the new 'lib.timezone'
1244 setting available via the Library Settings Editor, loaded from the server when
1245 required. Additionally, closings are recorded in the library's timezone so that
1246 due date calculation is more accurate. The closed date editor is also
1247 taught how to display closings in the
1248 closed library's timezone. Closed date entries also explicitly record if they
1249 are a full day closing, or a multi-day closing. This significantly simplifies
1250 the editor, and may be useful in other contexts.
1252 To accomplish this, we use the moment.js library and the moment-timezone addon.
1253 This is necessary because the stock AngularJS date filter does not understand
1254 locale-aware timezone values, which are required to support DST. A simple
1255 mapper translates the differences in format values from AngularJS date to
1258 Of special note are a set of new filters used for formatting timestamps under
1259 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1260 filters provide the functionality, and autogrid is enhanced to make use of
1261 these where applicable. egGrid and egGridField are also taught to accept
1262 default and field-specific options for applying date filters. These filters may
1263 be useful in other or related contexts.
1265 The egDueDate filter, used for all existing displays of due date via Angular
1266 code, intentionally interprets timestamps in two different ways WRT timezone,
1267 based on the circulation duration. If the duration is day-granular (that is,
1268 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1269 of seconds) then the date is interpreted as being in the circulation library's
1270 timezone. If it is an hourly loan (any duration that does not meet the
1271 day-granular criterium) then it is instead displayed in the client's timezone,
1272 just as all other timestamps currently are, because of the previous Evergreen
1275 The public catalog is adjusted to always display the due date in the circulating
1276 library's timezone. Because the public catalog displays only the date portion of the due
1277 date field, this difference is currently considered acceptable. If this proves
1278 to be a problem in the future, a minor adjustment can be made to match the
1279 egDueDate filter logic.
1281 Now that due dates are globally stored in the configured timezone of the
1282 circulating library, the automatic adjustment to day-granular due dates needs
1283 to take those timezones into account.
1285 An optional SQL command is provided by the upgrade script to retroactively
1286 adjust existing due dates after library configuration is complete.
1292 Enhancements to Hard Due Date Functionality
1293 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1294 It will now be possible to delete Hard Due Date Values for dates that have
1295 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1296 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1297 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1302 Patron Search by Birth Date
1303 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1304 * Now you can include the patron birth year and/or birth month and/or
1305 birth day when searching for patrons using the web staff client.
1306 * Day and month values are exact matches. E.g. month "1" (or "01")
1307 matches January, "12" matches December.
1308 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1309 1915, 1599, etc. For exact matches use the full 4-digit year.
1313 Patron Search from Place Hold
1314 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1315 This feature allows staff members, when placing a
1316 hold on behalf of a patron in the web staff client, to search for
1317 patrons by names and other searchable patron information, rather than
1318 relying on barcode alone. In particular, after performing a catalog
1319 search or going to a specific bib record and clicking the 'Place Hold'
1320 button, the form now includes a 'Patron Search' button. This button
1321 will open a dialog allowing the staff member search for and select
1327 Retrieve Recent Patrons
1328 ^^^^^^^^^^^^^^^^^^^^^^^
1330 Adds a new library setting 'Number of Retrievable Recent Patrons'
1331 ('ui.staff.max_recent_patrons') that specifies the number of recently
1332 retrieved patrons that can be re-fetched from the staff client.
1334 A value of 0 means no recent patrons can be retrieved.
1335 A value greater than 1 means staff will be able to retrieve multiple
1336 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1338 The default value is 1 for backwards compatibility.
1345 Fuller title in XUL client Simplified Pull List
1346 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1347 The Simplified Pull List in the XUL client will now display subfields 245$n and
1348 $p in the title field. The addition will make it easier for staff to distinguish
1349 between different parts or seasons in a series.
1355 Transit Cancel Time and Terminology Change
1356 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1361 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1362 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1363 are preserved in the database, though still not visible to the end user in the staff client.
1364 This allows for better tracking of when transits are canceled for the purposes of knowing
1365 which staff member canceled the transit, etc.
1367 NOTE: This change may require the re-creation of transit reports to filter out canceled
1368 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1369 Is NULL' will suffice.
1371 "Canceled Transit" Terminology Change
1372 +++++++++++++++++++++++++++++++++++++
1374 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1375 For internal continuity, however, the following permission codes have not changed:
1378 * `ABORT_REMOTE_TRANSIT`
1379 * `ABORT_TRANSIT_ON_LOST`
1380 * `ABORT_TRANSIT_ON_MISSING`
1388 Offline Circulation Available in Web Staff Client
1389 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1390 Offline circulation is now available in the web staff client. In order to use the
1391 offline interface, users must first log into the web staff client, perform
1392 a patron search, select a user from the results, and open the patron editor
1393 interface to collect all the relevent configuration information for the
1394 workstation. In addition, the offline interface available from the Circulation
1395 menu provides a 'Download block list' button for users who are logged in.
1397 As is the case in the old staff client, users can check materials in and out,
1398 renew items, and create new patron accounts while offline. The patron fields
1399 available in the offline patron registration editor are the same ones that
1400 are available to staff when working online.
1404 Add Circ Modifier to Record Detail Page in Staff TPAC
1405 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1406 The circulation modifier field is added to the table of copies to make
1407 more information available to staff without having to open
1414 Date+Time Format Settings for Web Client
1415 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1417 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1418 and adds two settings for use with the webstaff client:
1420 * 'Format Dates with this pattern'
1421 * 'Format Date+Time with this pattern'
1423 These settings use format strings as documented here:
1425 https://docs.angularjs.org/api/ng/filter/date
1427 There is overlap with how the Dojo formats worked, but also some differences.
1429 The original 'Format Dates' and 'Format Times' settings worked together, but the
1430 new settings work independently. Certain field elements will use one, and
1431 certain field elements will use the other. These distinctions are hard-coded
1432 in the various UI templates, with the idea being that timestamp fields in
1433 which the date component alone is sufficient information (for example, date of birth)
1434 will use the 'Format Dates' setting. Fields where the time component is
1435 important (for example, checkout time) will use the 'Format Date+Time' setting.
1437 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1438 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1444 Global Option to Remove Sound for a Specific Event
1445 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1446 A new `nosound.wav` file has been added to the web client. The file can be used
1447 to globally disable audio alerts for a specific event on an Evergreen system.
1449 For example, to silence the alert that sounds after a successful patron search:
1453 mkdir -p /openils/var/web/audio/notifications/success/patron/
1454 cd /openils/var/web/audio/notifications/success/patron/
1455 ln -s ../../nosound.wav by_search.wav
1462 The official Evergreen manual has been split into eight new manuals, each
1463 designed for a specific audience. This new approach is designed to make
1464 the documentation more readable and usable.
1466 The specific audiences for the new manuals are:
1468 * Acquisitions staff
1471 * Public services staff who use the public catalog
1473 * System administrators who use the command line
1474 * System administrators who use the Web client
1475 * System administrators and programmers who wish to integrate Evergreen
1476 with other technologies
1478 All manuals are available at http://docs.evergreen-ils.org
1484 Improvements to ebook API
1485 ^^^^^^^^^^^^^^^^^^^^^^^^^
1487 Evergreen now supports checking out and placing holds on
1488 OverDrive and OneClickdigital ebook titles from within the public
1489 catalog. This is an experimental feature. It is not recommended for production
1490 use without careful testing.
1492 When ebook integration is enabled, a "Check Out E-Item" link will be
1493 displayed when viewing an ebook title from a supported vendor in the
1494 catalog. Clicking on the link allows the user to check out and download
1495 that title from the vendor directly within the catalog.
1497 If no copies are available for the title, a "Place Hold on E-Item" link
1498 is displayed instead, and the user may place a hold on the title. (Note
1499 that some vendors require the user's account to have an email address
1500 before permitting a hold.)
1502 My Account includes the ability to view current ebook checkouts and
1503 holds, download already-checked-out titles, and cancel holds.
1505 For API integration to work, you need to request API access from the
1506 vendor, and the vendor must have a way of authenticating your patrons.
1507 Your Evergreen system also needs to be configured for ebook API
1508 integration, following the instructions in the command line system
1509 administration manual
1512 This feature assumes that you are importing MARC records supplied by the
1513 vendor into your Evergreen system, using Vandelay or some other MARC
1514 import method. This feature does not search the vendor's online
1515 collections or automatically import vendor records into your system; it
1516 merely augments records that are already in Evergreen.
1518 Improvements to Bill Payment Pages
1519 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1520 The bill payment pages in the public catalog have been revamped
1523 * use the term "charges" instead of "fees"
1524 * include images of credit cards accepted
1525 * make the default print receipt template match other itemized receipts;
1526 note that this change is not automatically applied when upgrading.
1527 * display billing type
1528 * add button to pay only selected charges
1529 * reformat the credit card number input page
1535 Clickable Copy Locations
1536 ^^^^^^^^^^^^^^^^^^^^^^^^
1537 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1538 the associated copy location will display as a link in the public catalog summary display.
1539 This link can be useful for retrieving maps or other directions to the copy
1540 location to aid users in finding material.
1545 Download Checkout History CSV Fixed for Large Number of Circulations
1546 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1547 Downloading checkout history as a CSV from My Account has been fixed
1548 for users with a large circulation history. Previously, this would
1549 time out for patrons with more than 100 or so circulations.
1551 This feature no longer uses the action/trigger mechanism and the public catalog
1552 now generates the CSV directly. The old action/trigger code is still
1553 present in the database and should be removed at some point in the
1559 Google Books Preview Rewrite
1560 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1561 The Google Books Preview functionality in record detail pages has been
1562 rewritten to modernize its style and optimize its performance:
1564 * The Dojo JavaScript framework is no longer used, saving approximately
1565 150K of JavaScript and CSS and four network requests per page load.
1566 * The Embedded Viewer is not loaded unless a possible preview is found,
1567 saving more network and memory overhead.
1568 * The Google Books Loader is used to load the Embedded Viewer instead of the
1569 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1571 * All variables are self-contained and do not pollute the global namespace.
1572 * Event listeners are registered to handle clicks, rather than attaching
1573 `href="javascript:function()"` to <a> elements.
1574 * Book previews are displayed in a panel sized according to the viewport
1575 of the browser, improving its appearance on both mobile and desktop
1577 * The rewritten code is now served up directly from
1578 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1583 jQuery for the Public Catalog
1584 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1585 This release adds optional support for jQuery in the public catalog. This support
1586 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1587 `config.tt2` template.
1593 New Popularity Parameters
1594 ^^^^^^^^^^^^^^^^^^^^^^^^^
1595 New popularity parameters for in-house use over time and for count of distinct
1596 organizational units that own a title are now available. Evergreen sites
1597 can use these parameters to create new statistical popularity badges for
1598 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1600 The in-house use parameters will apply a badge to titles that have the most
1601 in-house use activity over time. The organizational unit count parameter
1602 will apply a badge to titles owned by the most number of libraries in a
1603 consortium. Ownership is determined by the copy's circulation library.
1608 Option to Suspend Holds at the Time They are Placed
1609 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1610 Users now have the option to suspend a hold at the same time they place the
1611 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1612 who want to suspend a hold at the time it is placed. There is also an option
1613 to set the activation date at the same time. This option is also available
1614 when placing holds on a batch of titles from 'My List' and will apply to
1615 all the titles in the batch.
1626 Fix to reporter.classic_current_circ View
1627 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1628 The `reporter.classic_current_circ` view, which is part of some
1629 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1630 has been fixed to not exclude loans for patrons who do not have a
1631 billing address set. Users of this view should rerun
1632 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1637 New Report Source Table Allowing Report of "Last" Deleted copy
1638 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1640 This source table allows you to construct a clever aggregate report template
1641 which will report bibliographic IDs where a library or a group of libraries
1642 no longer have a copy attached but *had* a copy attached. This is especially
1643 useful when a holdings sync is required with an external vendor.
1646 Instructions for creating a report template with this source:
1648 * Create a new report template using "Library Holdings Count with Deleted" as the source
1649 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1650 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1651 * 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"
1652 * Add "Bib ID" to Displayed Fields
1653 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1654 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1655 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1658 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1659 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1660 specified date range. Unfortunately the user will have to manually type the date range without the date
1661 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1662 copy and more than two deleted copies."
1667 Add Provider to Provider Note Link
1668 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1669 The Provider reporting source now includes a link to the Provider Note reporting source.
1674 Link ILS User and Working Location Reporting Sources
1675 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1676 The Working Location reporting source now has labels
1677 and it is now linked to the ILS User reporting source, allowing
1678 reports to display or filter on staff working location.
1683 New Circulation Report Source "All Circulation Combined Types"
1684 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1686 This report source will allow you to create a single report template for all of the following:
1689 * In-house uses of non-cataloged items
1691 * Circulations of non-cataloged items
1693 To distinguish between these different types of library use, it's important to display these columns
1694 in your report templates:
1703 Reports Template Searching
1704 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1705 A new form appears along the top of the reports interface for searching
1706 report templates. Once found, typical template actions (e.g. create new
1707 report) are available from within the results interface.
1709 Searches may be performed across selected (visible) folders or all
1710 folders visible to the logged in user.
1712 Searches are case-insensitive, any word order, with left-anchored words.
1713 All searched words must appear in at least one of the searched fields.
1718 * Searching for 'stat cat' matches:
1720 ** statistical category
1721 ** categories, statistical
1722 ** patrons (stat cat)
1723 * Searching for 'stat cat' does not match:
1725 *** both words must be present in the searched field(s)
1727 *** location contains 'cat' but it's not left-anchored.
1732 The templates, reports, and output interfaces now support paging via
1733 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1745 Web Staff Client Serials Module
1746 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1747 The serials module has been ported over to the web staff
1748 client, implementing a unified serials interface that combines
1749 ideas from both the serial control view and alternate serials
1750 control view from the old staff client.
1752 In addition to carrying over functionality that was available
1753 in the old staff client, several new features are included:
1755 * the ability to save prediction pattern codes as templates
1756 that can be shared and reused within an Evergreen database
1757 * a more streamlined interface for managing subscriptions,
1758 distributions, and streams
1759 * it is no longer necessary to create a starting issue in
1760 order to predict a run of issues; the dialog box for
1761 generating a set of predicted issues now lets you specify
1762 the starting point directly.
1763 * the ability to more directly edit MFHDs
1765 The new serials interfaces can be accessed from the record
1766 details page via a Serials drop-down button that links to
1767 a subscription management page, a quick-receive action, and
1768 a MFHD management page. There is also a new 'Serials Administration'
1769 page where prediction pattern and serial copy templates can
1780 SIP Bugfix Changes How Encoding Is Determined in Configuration
1781 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1783 The combined fix for the above mentioned SIP bugs alters the way that
1784 SIPServer looks up the output encoding in the configuration file (typically
1785 `oils_sip.xml`). SIPServer now looks for the encoding in the following
1788 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1789 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1790 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.
1791 4. If none of the above exist, then the default encoding (ASCII) is used.
1793 Number 3 is provided to ease the transition to the new code. It is
1794 the current location of the +encoding+ element in the sample
1795 configuration file and as such, where it is likely to be found in
1796 actual files. It is recommended that you alter your configuration to
1797 move this element out of the +implementation_config+ element and into
1798 its parent +institution+ element. Ideally, SIPServer should *not* look into
1799 the implementation config, and this check may be removed at some time
1807 Web Client Acknowledgments
1808 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1810 The project to develop a new browser-based web client launched four
1811 years ago at the September 2013 Evergreen developer hack-a-way when the
1812 developer community voted to move away from the XUL client and explore other
1813 platforms. The first web client preview became available in Evergreen 2.7 when
1814 circulation was available in the new platform.
1816 The browser-based client is available due to the work of many coders, testers,
1817 bug reporters, documentors, translators, project managers, spec writers, funders
1818 and other contributors over the past four years.
1820 The Evergreen project would like to acknowledge the following organizations
1821 that funded development of the Web Staff Client:
1824 * British Columbia Libraries Cooperative
1825 * Consortium of Ohio Libraries
1827 * Georgia Public Library Service
1828 * Grand Rapids Public Library
1830 * Kenton County Public Library
1831 * King County Library System
1834 * Pennsylvania Integrated Library System
1835 * Pioneer Library System
1838 The Evergreen project would also like to thank the following individuals who
1839 contributed code, translations, documentation patches, tests, bug reports,
1840 technical specifications, and project management to the Web Staff Client:
1877 * Freddy Enrique Pelayo Huapalla
1903 Evergreen 3.0 Acknowledgments
1904 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1906 The Evergreen project would like to acknowledge the following
1907 organizations that commissioned developments in this release of
1911 * British Columbia Libraries Cooperative (BC Sitka)
1913 * Georgia Public Library Service
1914 * King County Library System
1916 * Pennsylvania Integrated Library System
1917 * Pioneer Library System
1919 We would also like to thank the following individuals who contributed
1920 code, translations, documentation patches, and tests to this release of
1969 We also thank the following organizations whose employees contributed
1972 * British Columba Libraries Cooperative
1976 * Emerald Data Networks, Inc.
1977 * Equinox Open Library Initiative
1979 * Grand Rapids Public Library
1980 * Indiana State Library
1982 * King County Library System
1983 * Lake Agassiz Regional Library
1984 * Laurentian University
1985 * Linn-Benton Community College
1987 * Merrimack Valley Library Consortium
1989 * North of Boston Library Exchange
1990 * Pennsylvania Integrated Library System
1991 * Pohjois-Karjalan Tietotekniikkakeskus Oy
1993 * Traverse Area District Library
1995 We regret any omissions. If a contributor has been inadvertently
1996 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob