1 Evergreen 3.0 Release Notes
2 ===========================
8 This release contains bug fixes improving on Evergreen 3.0.7. Note that
9 all bug fixes refer to the web staff client unless otherwise specified.
17 * The MARC editor now handles 008 fields better.
18 * Adds spaces between subfields when suggesting a call
19 number for a new volume.
20 * MarcXML exports from the MARC Batch Import/Export ->
21 Export Records screen now downloads the file, rather than opening
23 * The Item Status Circulation Library column now displays a
24 shortname rather than the full library name.
25 * The Item Status Remaining Renewals column now displays
27 * The Item Status now has a "Last Renewal Workstation" column
29 * Fixes the circulation counts displayed in Item Status Details.
30 * Fixes an issue where multiple copies with different values for required
31 statistical categories could not be edited and saved in batch.
32 * Add an option to remove floating in the copy editor.
33 * Fixes an issue with the floating dropdown in the copy editor.
34 * Reduces the number of API calls that the MARC Editor requires.
39 * Fixes an issue that prevented the offline patron registration
41 * Fixes an issue with searching patrons by permission group.
42 * Staff members can now manually override the patron juvenile
43 flag value, regardless of the patron's date of birth.
44 * Checkboxes on patron registration screen are now properly aligned
46 * The user permission group dropdowns in the patron registration,
47 edit, and search interfaces now have scrollbars.
48 * The check-in screen now includes a copy status column.
49 * The Merge Patrons interface now displays the date of birth.
50 * The payment button on patron bills screen is now inactive if the
51 Payment Received field is blank.
52 * The Bill History receipt now includes a Finish date and a Last
54 * When a patron summary contains an image of the patron,
55 that image tag now has a null alt attribute to remove it from
56 the flow of a screen reader.
57 * Corrects an issue that caused the transit dialog to show the
59 * Restores the call number prefix and suffix fields to the holds
61 * The documentation at the top of the hold shelf slip template
63 * The cursor in the in-house use screen now automatically goes
65 * Add support for converting change to patron credit in the patron bills
66 interface, consistent with the XUL feature.
67 * Fixes a bug that caused pickup/request library fields to be
69 * Fixes a bug in the offline org unit tree.
71 Command-line system administration
72 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
74 * The novelist entry in `eg_vhost.conf` includes two new
76 * Corrects an issue with the `--max-sleep` argument on the
77 `action_trigger_runner.pl` support script.
78 * Corrects an issue with how the `eg_pbx_allocator.pl` script
79 detects an existing lock file.
80 * The 3.0.2-3.0.3 upgrade script disables triggers before
81 recalculating bib visibility.
86 * Fixes an issue that caused records with located URIs to be
87 retrieved in Copy Location and Copy Location Group searches.
88 * Fixes an error message that appeared in the search box
89 in the public catalog while placing hold after an advanced search.
90 * Restores the display of copy information for the user's
91 preferred library in the public catalog.
92 * Fixes regression errors in the search results page.
93 * Removes redundant call numbers from the Show More Details
99 * Fixes an issue that prevented users from searching for
100 receivable issues using Database ID or ISSN in the Serials
101 Batch Receive interface.
106 * Adds some padding to the bottom of Web Client interfaces.
112 We would like to thank the following individuals who contributed code,
113 tests and documentation patches to the 3.0.8 point release of
147 This release contains bug fixes improving on Evergreen 3.0.6.
149 * Fixes a performance issue with the Patron Billing History screen and
150 other screens that cause Flattener.pm to re-create joins
152 * Fixes an issue that prevented patron alerts from showing to staff at
154 * Corrects the "Holdable" attribute display on the Item Status detailed
156 * Fixes the ability to delete multiple copies from Item Status.
160 We would like to thank the following individuals who contributed code,
161 tests and documentation patches to the 3.0.7 point release of
175 This release is a security release that fixes cross-site scripting
176 (XSS) vulnerabilities in the Evergreen public catalog. This release
177 also includes several other bugfixes improving on Evergreen 3.0.5.
179 Security Issue: XSS Vulnerability in Public Catalog
180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181 This release fixes several cross-site scripting (XSS) vulnerabilities
182 in the public catalog. When upgrading, Evergreen administrators should
183 review whether any of the following templates have been customized
184 or overridden. If so, either the template should be replaced with the
185 stock version or the XSS fix (which entails adding the `| html` filter
186 in several places) applied to the customized version.
188 * `Open-ILS/src/templates/opac/parts/record/contents.tt2`
189 * `Open-ILS/src/templates/opac/parts/record/copy_counts.tt2`
190 * `Open-ILS/src/templates/opac/parts/record/issues-mfhd.tt2`
192 Note that exploiting the XSS vulnerabilities fixed in this release
193 would require either the ability to create maliciously-constructed
194 MARC bibliographic or holdings records or the ability to set a
195 maliciously constructed organizational unit name.
199 Evergreen 3.0.6 also includes the following changes:
201 * When using 'Selection Lists -> Edit MARC Order Record' in the web
202 staff client, now only one click is required to save the MARC
203 record rather than two.
204 * The volume/copy editor in the web staff client now better handles
205 editing multiple items that have different sets of statistical
206 category values assigned to them.
207 * The act of merging bibliographic records now updates bookbags
208 that referred to the source bibliographic record rather than
209 effectively deleting entries for that record.
210 * Additional columns were added to the Holds Pull List in the
212 * The patron registration form in the web staff client now correctly
213 manages setting user preferences.
214 * An error in a pgTAP unit test was corrected.
218 We would like to thank the following individuals who contributed code,
219 tests and documentation patches to the 3.0.6 security release of
235 This release contains bug fixes improving on Evergreen 3.0.4.
237 * The MARC Editor in the Web staff client now wraps long fields.
238 * The MARC Editor no longer allows catalogers to enter new lines
240 * Fixes an issue that prevented serials items from being deleted or
242 * The Web staff client Check In screen no longer reloads the whole
243 page multiple times each time an item is scanned.
244 * Fixes an issue that displayed the oldest -- rather than the newest
245 -- transit in the Web staff client Item Status page.
246 * Fixes an issue that prevented the reports module from being displayed
248 * Fixes an issue in the Web staff client reports module that caused
249 syntax errors in reports that use virtual fields and joins.
250 * Fixes an issue that prevented several dropdown menus in the Web staff
251 client from activating.
252 * Fixes an issue that created duplicate copy data when copies or
253 volumes with parts were transferred.
254 * Fixes the Trim List feature in the Web staff client Check In screen.
255 * The Item Status grid now displays the Circulation Modifier.
256 * Restores missing data from the Profile column in Place Hold patron
258 * Fixes an issue with the http -> https redirect on Apache 2.4.
259 * Fixes an color contrast accessibility issue in the Web staff
260 client and adds underlining to links in grid cells for added accessibility.
261 * Adds automated regression and unit tests for the Web staff client
263 * Adds a process for spell-checking the official documentation.
264 * Adds a script that simplifies the release process related to translations.
269 We would like to thank the following individuals who contributed code,
270 tests and documentation patches to the 3.0.5 point release of
275 * Blake Graham-Henderson
290 This release contains bug fixes improving on Evergreen 3.0.3:
292 * Fixes a bug that caused all searches limited by shelving location to
294 * Fixes a bug that caused EDI orders to be sent with the vendor's SAN,
295 rather than the ordering agency's SAN.
296 * Fixes a bug that prevented Safari/iOS users from logging in to the
298 * Fixes a bug that prevented users from using the browse interface.
299 * Fixes a bug in the Item Status List view that caused incorrect due
301 * Approval code is now a required field in the web client's patron
302 credit card payment form.
303 * Fixes a bug with credit card payments that caused a receipt to print
304 showing that the patron paid the bill when the payment had not actually
306 * Fixes a bug that prevented the EDI translator from being installed on
308 * Fixes a bug that caused entries to show up multiple times in the
309 Items Out and Holds tabs in the patron record.
310 * Fixes a bug that caused grids on Bills and Patron Messages
311 screens to not display properly.
312 * The following fields are now available for the Checkout and Items Out
319 ** money_summary.balance_owed
320 ** money_summary.total_paid
321 ** money_summary.total_owed
326 * The following fields are now available on the Bill Payment receipt templates:
336 * Payment type is now a column in the payments tab of the patron record
337 Bill History section.
338 * The "Replace Barcode" function now makes it more difficult for staff
339 members to attempt to create blank patron barcodes.
340 * The patron bills screen now prevents staff members from double-clicking
341 on the Apply Payment button (which otherwise would apply two payments).
342 * Fixes a bug that prevented patrons attached to statistical categories
343 from displaying in the patron search-to-hold dialog.
344 * Fixes a performance issue related to uploading CSV files of barcodes
345 to the item status and patron bucket interfaces.
346 * Fixes several small bugs in the Spanish translation.
347 * Fixes a performance bug related to patrons logging in by barcode.
351 We would like to thank the following individuals who contributed code,
352 tests and documentation patches to the 3.0.4 point release of
374 * The upgrade script for 3.0.3 contains a post-transaction command to forcibly
375 update the visibility attributes of all bibs that make use of Located URIs or
376 bib sources. It may take a while to run on large datasets. If it it running
377 too long, it can be canceled and the following psql commands will create and
378 run a script that will perform the same action serially over time without
379 blocking writes to bibs:
382 \o /tmp/luri_visibility_update.sql
383 SELECT 'UPDATE biblio.record_entry SET ' ||
384 'vis_attr_vector = biblio.calculate_bib_visibility_attribute_set(id) ' ||
385 'WHERE id = ' || id || '; SELECT ' || id || ';'
386 FROM biblio.record_entry
388 SELECT DISTINCT cn.record
389 FROM asset.call_number cn
391 AND cn.label = '##URI##'
394 FROM asset.uri_call_number_map m
395 WHERE m.call_number = cn.id
398 SELECT id FROM biblio.record_entry WHERE source IS NOT NULL
403 \i /tmp/luri_visibility_update.sql
406 It will output the id of each updated bib so that the script can be killed
407 and then edited to remove completed bibs. The remainder can be run at a
410 NOTE: When the internal flag 'ingest.reingest.force_on_same_marc' is enabled,
411 we do NOT update the bib's visibility attributes, as doing so causes a loop
412 and an eventual trigger stack violation. This flag should ONLY be used when
413 forcing reingest of record attributes (NOT visibility attributes), search,
414 facet, and display fields, so if using this flag under normal operation,
415 proceed at your own risk and know that Located URI and bib source changes
416 will not be reflected in the visibility attributes of the record.
420 This release contains several bug fixes improving on Evergreen 3.0.1:
422 * Fixes several issues related to the display of located URIs and records with
423 bib sources in search results.
424 * Setting `opac_visible` to false for a copy location group now hides only
425 the location group itself, rather than also hiding every single copy in the
427 * Fixes a bug that prevented the copy editor from displaying the _fine level_
428 and _loan duration_ fields.
429 * The "Edit Items" grid action in the Item Status interface will now open
430 in the combined volume/copy editor in batch. This makes the behavior
431 consistent with the "Edit Selected Items" grid action in the copy
433 * Staff members are now required to choose a billing type when creating a
434 bill on a user account.
435 * The Web client now provides staff users with an alert and option to
436 override when an item with the Lost and Paid status is checked in.
437 * Fixes a bug where the Web client offline circ interface was not able
438 to set its working location.
439 * Fixes an issue that prevented the ADMIN_COPY_TAG permission from being
441 * The MARC editor in the Web staff client now presents bib sources in
443 * Both circulation and grocery bills are now printed when a staff user selects
444 a patron account and clicks "Print Bills".
445 * Fixes an issue in the XUL serials interface the "Receive move/selected"
446 action from succeeding.
447 * Fixes a typo in the user password testing interface.
451 We would like to thank the following individuals who contributed code,
452 tests and documentation patches to the 3.0.3 point release of
471 This release contains several bug fixes improving on Evergreen 3.0.1:
473 * Copy templates created in XUL Holdings Maintenance will now be
474 automatically converted and displayed in the web staff client's
476 * The list of report templates now includes a column indicating whether
477 the template was originally created in the XUL staff client or the web
478 staff client; staff need to know this since report templates created in
479 one interface cannot be edited in the other.
480 * Call number prefixes and suffixes are now displayed in various grids
481 in the web staff client, including
482 ** Pending Copy Buckets
484 ** Checkin/Capture Holds
486 ** Patron Bills History
493 ** Bib Record View Holds
495 * Many patron fields have been redacted from the web staff client's patron
496 and record holds grids, leaving patron name, username, and ID.
497 * Fixes two bugs where patron records could fail to be saved upon editing.
498 * The web staff patron editor now better warns staff users about
499 duplicate names, IDs, phone numbers, and email addresses.
500 * Human readable labels are now displayed for certain fields in standing
502 * The patron summary in the web staff client now correctly displays
503 primary and secondary ID values.
504 * The web staff client's billing full details page now displays
505 information about the staff user that created a payment.
506 * The web staff client now requires staff users to explicitly set a
507 billing type when adding a manual bill.
508 * The web staff client's patron bill annotation modal now works.
509 * Patron barcode search completion in the web staff client now allows
510 the user to select from all of the matching patron records.
511 * The Hold Shelf Slip print template in the web staff client now has
512 access to the call number.
513 * The Checkout Receipt print template in the web staff client now can
514 include summary financial information, incuding current balance, total
515 paid on outstanding fines, and total owed.
516 * The web staff print templates for current and historical bills can
517 now include copy barcode and title.
518 * Fixes a bug that resulted in some catalog searches unexpectedly
520 * Fixes a bug that resulted in catalog searches that specify a location
521 limit returning incorrect results.
522 * Fixes a bug where deleted copies could make records visible in the
524 * Fixes a bug where certain queries on copies used in the public catalog
526 * Fixes a bug place a hold request in the public catalog could result
527 in "forgetting" the type and library of the user's previous search.
528 * The web staff client now respects staff user session timeouts, and
529 will log out all open tabs if a user's session has timed out.
530 * The web staff Z39.50 page will now give the staff user an alert if
531 they attempt to import a record with a duplicate TCN.
532 * Fixes a bug that prevented copy notes, copy tags, and copy bucket
533 entries from being deleted.
534 * Fixes a bug that made using the volume/copy editor to change a copy's
536 * The administration interface for hard due dates now ensures that
537 new (or edited) ceiling dates have their time component set to end
538 of day, resolving an issue where ceiling dates would not be applied
539 during the ceiling date itself.
540 * The web staff client can now include dynamic information in browser
541 tab titles, e.g., "Smith, Jane - Checkout".
542 * The Concerto sample data set now includes data allowing for testing
543 placing holds on monographic parts.
544 * Asset merging during bibliographic record merging now correctly
545 recognizes call number prefixes and suffixes and deletes disused
547 * Fixes a bug where displaying user surveys could result in PCRUD
549 * Fixes a bug where pg_restore of an Evergreen database could fail
550 to create certain indexes on the `actor.usr` table.
554 We would like to thank the following individuals who contributed code,
555 tests and documentation patches to the 3.0.2 point release of
586 This release contains several bug fixes improving on Evergreen 3.0.0
588 * Fixes a bug in the web staff client that prevented initials from being
589 stored with copy notes.
590 * Adds billing types that may have been missed by systems that were
591 running Evergreen prior to the 1.4 release.
592 * Fixes a web staff client bug with the CSV export option available from
593 the Import Queue in the MARC Batch Import/Export interface.
594 * Adds the missing copy alert field in the web client's volume/copy
596 * Fixes a bug where the setting to require date of birth in patron
597 registration was not being honored in the web staff client.
598 * Fixes a bug in the web staff client patron registration form where the
599 password wasn't generating from the last four digits of the patron's
601 * Fixes an issue in the web staff client where the complete barcode did
602 not display in some interfaces when partial barcodes were scanned.
603 * Fixes an HTML error in the new copy tags that display on the record
605 * Fixes a web staff client bug where recording a large number of in-house
606 uses at one time doesn't display a confirmation dialog once it hits the
608 * Adds a _Print Full Grid_ action in the web staff client
609 holds pull list to allow staff to print the entire pull list as it
610 displays on the screen. This change also changes the _Export CSV_ action
611 to an _Export Full CSV_ option.
612 * Fixes an issue with the Patron Messages interface that prevented it
613 from saving column configuration changes in the web staff client.
614 * Fixes a bug in the web staff client where a billing prompt did not
615 correctly display after marking an item damaged in those systems that
616 have enabled the setting to bill for damaged items.
617 * Adds an option to the specific due date feature that allows saving
618 that due date until logout. This allows all circulations from a given
619 workstation to be due on the same date.
623 We would like to thank the following individuals who contributed code,
624 tests and documentation patches to the 3.0.1 point release of
646 The minimum version of PostgreSQL required to run Evergreen 3.0 is
647 PostgreSQL 9.4. Evergreen 3.0 also requires OpenSRF 3.0.0 or later.
649 Change to Names of Shared Libraries
650 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
651 OpenSRF 3.0 changes how the shared libraries for services written in
652 C are named. If upgrading from an earlier version of Evergreen,
653 `opensrf.xml` should be edited so that shared library file names
654 listed in the `<implementation>` tag start with "lib". For example,
657 ---------------------------------------------------------------------
659 <language>C</language>
660 <implementation>oils_cstore.so</implementation>
661 ---------------------------------------------------------------------
663 should be changed to:
666 ---------------------------------------------------------------------
668 <language>C</language>
669 <implementation>liboils_cstore.so</implementation>
670 ---------------------------------------------------------------------
672 SIP Bugfix Requires SIPServer Upgrade
673 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
675 The fix for Launchpad Bug 1542495: "OpenILS::SIP::clean_text() can
676 crash" requires that you also upgrade SIPServer with the fix for
677 Launchpad Bug 1463943: "Non-ascii Unicode characters in messages cause
678 SIP client problems." This means that if you use SIP2 with Evergreen,
679 you must also upgrade SIPServer to the latest commit in the Git
680 repository. Conversely, if you upgrade SIPServer to the latest commit
681 in Git, you must also upgrade Evergreen or, at least, apply the patch
682 for Launchpad Bug 1542495. These two patches are complementary and
683 cannot be applied independently of one another.
685 `open-ils.auth.login`
686 ~~~~~~~~~~~~~~~~~~~~~
687 The new `open-ils.auth.login` API must be added to the list of `<log_protect>`
688 API's in the `opensrf_core.xml` file.
693 ---------------------------------------------------------------------
694 --- a/Open-ILS/examples/opensrf_core.xml.example
695 +++ b/Open-ILS/examples/opensrf_core.xml.example
696 @@ -180,6 +180,7 @@ Example OpenSRF bootstrap configuration file for Evergreen
698 <match_string>open-ils.auth.authenticate.verify</match_string>
699 <match_string>open-ils.auth.authenticate.complete</match_string>
700 + <match_string>open-ils.auth.login</match_string>
701 <match_string>open-ils.auth_proxy.login</match_string>
702 <match_string>open-ils.actor.patron.password_reset.commit</match_string>
703 <match_string>open-ils.actor.user.password</match_string>
704 ---------------------------------------------------------------------
708 Administrators of Evergreen who use RTL locales and who have customized
709 `style-rtl.css.tt2` should now incorporate their customizations into
712 Multi-Time Zone Installations
713 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
715 For Evergreen consortia that span more than one time zone, the following
716 query will adjust all historical, unaged circulations so
717 that if their due date field is pushed to the end of the day, it is done
718 in the circulating library's time zone, and not the server time zone.
720 It is safe to run this after any change to library time zones.
722 Running this is not required, as no code before this change has
723 depended on the time string of '23:59:59'. It is also not necessary
724 if all of your libraries are in the same time zone, and that time zone
725 is the same as the database's configured time zone.
734 for ou_id in select id from actor.org_unit loop
735 for new_tz in select oils_json_to_text(value) from actor.org_unit_ancestor_setting('lib.timezone',ou_id) loop
736 if new_tz is not null then
737 update action.circulation
738 set due_date = (due_date::timestamp || ' ' || new_tz)::timestamptz
739 where circ_lib = ou_id
740 and substring((due_date at time zone new_tz)::time::text from 1 for 8) <> '23:59:59';
749 Deprecation of XUL staff client
750 -------------------------------
751 Starting with the release of 3.0.0, patches that fix XUL bugs will not
752 be merged into master or backported unless they meet one or more of
753 the following conditions:
755 a. the bug is a security issue
756 b. the bug involves the destruction of data
757 c. the bug is a regression of functionality in the XUL staff client
758 introduced by other work done to Evergreen
760 Under no circumstances will XUL staff client feature enhancements be merged.
762 This policy will continue through the 3.0.x and 3.1.x maintenance
763 release cycles, and will become moot upon the release of 3.2.0, when
764 the XUL staff client is slated to be entirely removed.
773 Evergreen 3.0 features a new, modern staff client that runs in the web browser
774 and can be used on desktop and mobile devices. All functional areas of the
775 system, including circulation, cataloging, acquisitions, serials, reports,
776 booking, administration, and offline circulation, are available in the new staff
777 client. Chrome and Firefox are officially supported for use with the web client.
779 Library staff will no longer need to download separate software to perform most
780 actions in Evergreen. A Chrome plugin called Hatch will be available as a
781 separate installation for workstations that require seamless, dialog-free
782 printing to multiple printers.
784 In addition to adding more portability and stability, the new staff client also
785 presents a cleaner and more modern interface for users. By virtue of running in
786 a browser, actions that users are accustomed to performing on other web sites
787 should now be available in the Evergreen client.
789 The old, XUL client will continue to be available to allow for a gradual
790 transition to the browser-based client, but no new features will be added. The
791 old client will totally be removed from Evergreen in the Fall 2018 3.2.0
801 New EDI Order Generator
802 ^^^^^^^^^^^^^^^^^^^^^^^
807 . New database tables exist for configuring vendor-specific EDI order
811 ** List of EDI order generation toggles, e.g. "INCLUDE_COPIES" to add
814 ** Collection of `edi_attr`s. Each edi_account may be linked to one
816 ** One `edi_attr_set` per known vendor is added to the stock data, matching
817 the stock configuration found in the JEDI template.
818 * `acq.edi_attr_set_map`
819 ** Link between `edi_attr`s and `edi_attr_set`s.
821 . EDI Attribute Sets are manged via a new (browser client only) configuration
822 interface at 'Administration -> Acquisitions Administration -> EDI
825 . Each `acq.edi_account` should be linked to an `acq.edi_attr_set`. If a link
826 is not set, default values will be used. Links between an EDI account
827 and an attribute set are managed in the EDI Accounts configuration
830 . Local modifications to the stock EG JEDI template are managed by modifying
831 and/or adding additional `edi_att_set`s as needed.
833 . A new `edi_order_pusher.pl` script is added which replaces the functionality
834 of `edi_pusher.pl`. `edi_pusher.pl` is still available.
836 . After moving to `edi_order_pusher.pl`, the JEDI Action/Trigger event
837 definition is no longer required and can be disabled.
842 EDI accounts have a new boolean field 'Use EDI Attributes' (`use_attrs`) that
843 specifies whether PO's generated via the account should be built using
844 EDI attributes or fall back to traditional JEDI A/T template generation.
846 This allows sites to activate EDI attributes on a per-account basis, making
847 it possible to migrate piecemeal to EDI attributes. For the initial roll
848 out of this new feature, no accounts will be configured to use EDI
849 attributes by default.
855 3 Day Courtesy Notice by SMS
856 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
857 New optional SMS text notification to be sent out 3 days prior to the due
858 date of any circulating item for patrons who have an SMS text number and
859 carrier stored in their accounts. This action trigger is disabled by default,
860 but can be enabled and modified by going into 'Administration -> Local Administration ->
861 Notifications / Action Triggers'.
863 You may wish to make use of granularity so that these messages are batched
864 and sent at the same time each day.
869 Add Description Field to Circulation and Hold Configuration Entries
870 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
871 The circulation and hold policy configuration rules now each have a
872 description field. This allows administrators to add comments to
873 describe the purpose of each rule.
878 Apache Internal Port Configuration Option
879 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
880 Apache configuration now supports a new variable which allows admins to
881 specify the port used by Apache to handle HTTP traffic. The value is
882 used for HTTP requests routed from Perl handlers back to the same Apache
883 instance, like added content requests. Use this when running Apache
884 with a non-standard port, typical with a proxy setup. Defaults to "80".
887 -------------------------------------------------------------------
890 PerlSetVar OILSWebInternalHTTPPort "7080"
893 -------------------------------------------------------------------
898 Configurable Bib Record Display Fields
899 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
901 'Administration -> Server Administration -> MARC Search/Facet Fields' have 2 new configuration
902 fields: 'Display Field?' and 'Display XPath'.
904 When 'Display Field' is set to true, data from the field will be extracted
905 from each record and added to a new table of display data for each bib
908 If a value is present in the 'Display XPath' field, this XPath will be
909 applied to the extracted data *after* the base XPath (from the 'XPath'
910 field) is applied to each field.
912 This data acts as a replacement for the various and sundry ways bib record
913 data is currently extracted, including inline XPath in the TPAC, reporter
914 views, real-time 'MVR' compilation from MODS, etc. and will be available
915 to the user interface, notification templates, etc. for rendering bib
918 The browser client gets a new service 'egBibDisplay' which is capable
919 of translating the display field data from various formats into
920 data more suitable for JavaScript usage.
922 The database gets 3 new views for representing display data in various
925 * `metabib.flat_display_entry`
926 ** List of all display fields linked to their configuration.
927 * `metabib.compressed_display_entry`
928 ** Same as `metabib.flat_display_entry` except there's one row
929 per display field type, with 'multi' rows compressed into
930 JSON arrays. Non-multi fields are represented as JSON
932 * `metabib.wide_display_entry`
933 ** Tabular view of display field data, one column per well-known
934 field. Values are represented JSON, consistent with
935 `metabib.flat_display_entry`. The view does *not* contain locally
936 configured display fields, as each field must be encoded in
937 the view and IDL definition. This is essentially a replacement
938 for `reporter.simple_record`.
943 After making changes to display field configuration, it's possible to
944 reingest only display field data in the database using the following:
947 ---------------------------------------------------------------------
948 SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE,
949 (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field))
950 FROM biblio.record_entry WHERE NOT deleted AND id > 0;
951 ---------------------------------------------------------------------
957 Fix COPY_STATUS_LONGOVERDUE.override Permission Typo
958 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
959 The existing permission was incorrectly created with a code of
960 `COPY_STATUS_LONGOVERDUE.override`, while the event thrown requires a
961 permission with a code of `COPY_STATUS_LONG_OVERDUE.override`. This
962 update changes the permission code to match what the event requires.
968 Hold Targeter V2 Repairs and Improvements
969 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
970 * Make the batch targeter more resilient to a single-hold failure.
971 * Additional batch targeter info logging.
972 * Set `OSRF_LOG_CLIENT` in `hold_targeter_v2.pl` for log tracing
973 * Removes the confusingly named `--target-all` option
974 ** The same behavior can be achieved by using `--retarget-interval "0s"`
975 * Removes `--skip-viable` (see `--soft-retarget-interval` below)
977 New --next-check-interval Option
978 ++++++++++++++++++++++++++++++++
979 Specify how long after the current run time the targeter will retarget
980 the currently affected holds. Applying a specific interval is useful
981 when the retarget-interval is shorter than the time between targeter
984 For example, if the targeter is run nightly at midnight with a
985 `--retarget-interval 36h`, you would set `--next-check-interval` to `48hr`,
986 since the holds won't be processed again until 48 hours later. This
987 ensures that the org unit closed date checks are looking at the correct
990 This setting overrides the default behavior of calculating the next
991 retarget time from the retarget-interval.
993 New --soft-retarget-interval Option
994 +++++++++++++++++++++++++++++++++++
995 This is a replacement for (and rebranding of) the `--skip-viable` option.
996 The new option allows for time-based soft-targeting instead simple binary
997 on/off soft-targeting.
999 How soft-targeting works:
1001 * Update hold copy maps for all affected holds
1002 * Holds with viable targets (on the pull list) are otherwise left alone.
1003 * Holds without viable targets are retargeted in the usual manner.
1009 New marc_export --descendants Option
1010 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1012 The `marc_export` script has a new option, `--descendants`. This option
1013 takes one argument of an organizational unit shortname. It works much
1014 like the existing `--library` option except that it is aware of the
1015 org. tree and will export records with holdings at the specified
1016 organizational unit and all of its descendants. This is handy if you
1017 want to export the records for all of the branches of a system. You
1018 can do that by specifying this option and the system's shortname,
1019 instead of specifying multiple `--library` options for each branch.
1021 The `--descendants` option can be repeated, as the `--library` option can.
1022 All of the specified org. units and their descendants will be included
1023 in the output. It can also be combined with individual `--library`
1024 options when necessary.
1029 RTL and LTR Public Catalog Stylesheets Merged
1030 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1031 The RTL stylesheet for the public catalog,
1032 `templates/opac/css/style-rtl.css.tt2`, has been merged into the LTR
1033 one (`templates/opac/css/style.css.tt2`). The combined stylesheet
1034 template will provide RTL or LTR styles based on the value of
1035 the `rtl` flag of the active locale. An `rtl` variable is also available
1036 in the template to allow the correct style to be chosen.
1041 Miscellaneous Improvements
1042 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1044 * If a filter is in effect in the Library Settings Editor,
1045 the filter will continue to be applied after a user
1046 changes the selected library.
1047 * Copy templates used for serials now correctly link to age
1048 protection rules and MARC item type values (for the
1049 "Circ as Type" field). During upgrade, the database update
1050 will set to NULL any age protection and circ as type fields
1051 in serial copy templates that do not point to defined values.
1056 Obsolete Internal Flag Removed
1057 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1059 An obsolete and unused `ingest.disable_metabib_field_entry` internal
1060 flag was removed from the `config.internal_flags` table. It was
1061 rendered obsolete by the addition of the 3 flags to control the
1062 browse, search, and facet indexing.
1067 Tweaks to Caching/Expiry of Public Catalog Assets
1068 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1069 The default cache expiration time for static assets (e.g.,
1070 CSS, image, and JavaScript files) in the public catalog and
1071 the Kid's PAC has been increased to one year. Links to all
1072 such assets now have a cache-busting value tacked on as a
1073 query parameter. This value is refreshed when `autogen.sh` is
1074 run, but it can also be manually set by adjusting the
1075 `ctx.cache_key` Template Toolkit variable.
1080 Action/Trigger Events Data Purging
1081 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1083 Action/Trigger event definitions have a new field called 'Retention
1084 Interval'. When an optional interval value is applied, events and
1085 template output data linked to the event definition will be deleted
1086 from the database once they reach the specified age.
1088 Retention Interval Restrictions for Passive Hooks
1089 +++++++++++++++++++++++++++++++++++++++++++++++++
1091 Restrictions are placed on retention interval values for event definitions
1092 using passive hooks to prevent data from being deleted while it's still
1093 needed by the system.
1095 The presence of event data is how the system knows not to send duplicate
1096 events. As long as a scenario exists where a duplicate event may be
1097 generated, the events must be retained.
1099 To apply a retention interval value to a passive-hook event definition:
1101 * The event definition must have a max_delay value.
1102 * The retention interval must be larger than the difference between
1103 the `delay` and `max_delay` values.
1105 For example, if the `delay` is 7 days and `max_delay` is 10 days, the retention
1106 interval must be greater than 3 days to ensure no duplicate events are
1107 created between the first event on day 7 and the end of the event validity
1113 A new `purge_at_events.sh` script is installed in the bin directory
1114 (typically `/openils/bin`) which should be added to CRON for regular
1117 NOTE: On large data sets, this script can take a long time to run and
1118 create higher than normal I/O load as it churns though the event and
1119 event_output tables. You may wish to run the script by hand the first
1120 time so it can be monitored. It can be run in psql like so:
1123 ---------------------------------------------------------------
1124 SELECT action_trigger.purge_events();
1125 ---------------------------------------------------------------
1127 NOTE: On *very* large data sets (10s to 100s of millions of event and
1128 event_output rows), it may be advisable to first repopulate the `event`
1129 and `event_output` tables with only the desired data before starting
1130 regular purges. This can be done, for example, using the copy to temp
1131 table, truncate source table, repopulate source table from temp table
1132 approach. This will be much faster than the `purge_events()` function
1133 in cases where most of the data will be purged.
1138 A number of `action_trigger.hook` entries which have always been treated
1139 as active hooks, though are configured as passive hooks, have been
1140 updated to properly reflect the non-passive-ness. This allows for
1141 simpler configuration of their retention interval values.
1147 Remove JSPAC Redirects
1148 ^^^^^^^^^^^^^^^^^^^^^^
1149 Future versions of Evergreen will no longer contain automatic redirects
1150 from JSPAC URLs to TPAC URLs, with the exception of `myopac.xml`, given
1151 that the JSPAC is no longer supported. Existing sites, however, may
1152 wish to retain JSPAC redirects in their Apache configuration files since
1153 JSPAC URLs may still be used in the wild to access their catalogs.
1155 The original JSPAC URL redirects are all retained in the file
1156 `Open-ILS/examples/jspac_redirects.conf` for reference.
1166 New open-ils.auth.login API
1167 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1168 The `open-ils.auth` service has a new API for requesting an authentication
1169 token. It performs the same steps as the
1170 `open-ils.auth.authenticate.init` and `.complete` APIs in a single call,
1171 using the bare password. No intermediate password hashing is required.
1173 The paramaters are the same as the `.complete` call with a few modifications.
1175 1. Using the generic 'identifier' parameter in combination with the
1176 'org' parameter allows the API to reliably determine if an identifier
1177 value is a username or barcode. The caller is no longer required to
1178 make that determination up front.
1180 2. The 'nonce' parameter is no longer used.
1186 Batch Patron Contact Invalidation
1187 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1188 The following methods are used to mark patron contact fields
1189 as invalid by moving the invalid value to a standing penalty:
1191 * `open-ils.actor.invalidate.email`
1192 * `open-ils.actor.invalidate.day_phone`
1193 * `open-ils.actor.invalidate.evening_phone`
1194 * `open-ils.actor.invalidate.other_phone`
1196 These methods now accept a fifth argument specifying the value
1197 of the contact field, e.g., a specific phone number or email
1198 address. If supplied, and if a specific patron ID (the first
1199 argument) is not supplied, all patrons with that specific contact
1200 value will have it marked invalid.
1210 Pure-SQL catalog searching
1211 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1212 Public and staff catalog search is now both more accurate and faster
1213 by redesigning how the visibility of records is calculated.
1223 Authority Record and Headings Browse Improvements
1224 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1225 Various improvements are made to support for authority records
1226 and headings browsing:
1228 * The MARC to MADS XSLT stylesheet is now used as part of parsing
1229 headings from authority records. Since the MODS and MADS stylesheets
1230 extract headings in similar ways, duplicate browse entries are now
1231 much less likely to occur.
1232 * A new configuration table, `authority.heading_field`, is now used
1233 to specify how headings should be extracted from authority records.
1234 * Related headings can now be identified as narrower or broader when
1235 browsing in the public catalog.
1236 * See references are now more reliably included in the browse list.
1237 * Scope (public) notes now display only under the main heading.
1238 * There is now a global flag, Display related headings (see-also) in browse,
1239 that can be used to control whether related headings (see-alsos) are
1240 displayed in the public catalog list.
1241 * A complete set of thesauruses are now included in the seed data. Thesauruses
1242 can now be identified using short and long codes.
1243 * The labels for see and see-also references in the public catalog are
1244 a bit more patron-friendly, and can now be tweaked via TPAC template
1245 customization in the browse.tt2 file.
1251 Copy Tags and Digital Bookplates
1252 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1253 Copy tags will allow staff to apply custom, pre-defined labels or tags
1254 to copies. Copy tags are searchable in both the staff client and public
1255 catalog. This feature was designed to be used for Digital Bookplates to
1256 attach donation or memorial information to copies, but may be used for
1257 broader purposes to tag items.
1259 Each copy tag can either be publicly-visible or visible only to staff.
1260 Copy tags also have types that can be used for restricting catalog
1261 searches on copy tags to particular types.
1263 Copy tags are displayed in the copy table in the record summary page in
1264 the public catalog, and a new library setting can be used to add
1265 a "Digital Bookplate" search field. Copy tags can also be used
1266 as a search filter, e.g.,
1268 * `copy_tag(bookplate, jane smith)`: search for records that have a
1269 copy tag of type 'bookplate' whose value contains 'jane smith'.
1270 * `copy_tag(*, jane smith)`: search for records that have a
1271 copy tag of any type whose value contains 'jane smith'.
1273 All staff-side interfaces related to copy tags exist only in the web
1274 staff client. There are two new administration interfaces for managing
1275 copy tags and copy tag types. The copy editor now has a 'Copy Tags'
1276 button for applying copy tags to copies; that interface can also be
1277 used to create new copy tags on the fly. Furthermore, the copy buckets
1278 interface now has an 'Apply Tags' action for assigning tags to groups
1284 Two new permission are included:
1286 * `ADMIN_COPY_TAG_TYPES`: required to create a new tag type under
1287 'Administration -> Server Administration -> Copy Tag Types'
1288 * `ADMIN_COPY_TAG`: required to create a new tag under
1289 'Administration -> Local Administration -> Copy Tags'
1291 The existing permission `UPDATE_COPY` controls whether or not a user
1292 can link copies to tags.
1296 A new library setting, 'Enable Digital Bookplate Search', controls
1297 whether to display a 'Digital Bookplate' field in the search index
1298 drop-downs in the catalog. A 'Digital Bookplate' search will include
1299 all records that have a copy that matches the tag specified by the user.
1300 It should be noted that this library setting does not affect the
1301 display of copy tags on the catalog record summary page.
1306 Include Call Number Prefixes and Suffixes in Export and Z39.50 output
1307 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1308 The call number prefix and suffix, when present, are now included in
1309 subfields $k and $m of the 852 field when running `marc_export` with
1310 the `--items` switch. Similarly, when using Evergreen as a Z39.50
1311 server configured to embed item data in 852 fields, the affixes are now
1312 included in subfields $k and $m.
1322 Batch Editing of Patron Records
1323 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1324 There is a now a new interface analogous to the Copy Bucket interface
1325 to select and group a set of users into a User Bucket.
1326 The addition of users to a User Bucket is possible from the Patron Search
1327 interface by the use of a new grid Action, and directly on the User Bucket
1328 interface by user barcode. It is also possible to add users to a User
1329 Bucket by uploading a text file that contains a list of user barcodes.
1331 From this interface it is possible to perform a set of specific batch update
1332 operations on user records.
1337 These fields can now be changed in batch via an action on the User Bucket
1338 grid if the staff user has the `UPDATE_USER` permission:
1341 * Primary Permission Group (group application permissions consulted)
1343 * Home Library (`UPDATE_USER` checked against both old and new value)
1344 * Privilege Expiration Date
1345 * Barred flag (`BAR_PATRON` permission consulted)
1346 * Internet Access Level
1348 Changes made in this interface can be rolled back.
1350 As a batch process, rather than a direct edit, this mechanism explicitly skips
1351 processing of Action/Trigger event definitions for user update.
1356 The batch edit mechanism also allows for the batch deletion of user. The staff
1357 user must have both the `UPDATE_USER` and `DELETE_USER` permissions.
1359 Changes made in this interface can be rolled back.
1361 As a batch process, rather than a direct edit, this mechanism explicitly skips
1362 processing of Action/Trigger event definitions for user deletion.
1364 This mechanism does not use the Purge User functionality, but instead simply
1365 marks the users as deleted.
1367 Editing Statistical Category Entries
1368 ++++++++++++++++++++++++++++++++++++
1370 All users in the bucket can have their Statistical Category Entries
1371 modified. Unlike user data field updates, modification of Statistical
1372 Category Entries is permanent and cannot be rolled back.
1374 As a batch process, rather than a direct edit, this mechanism explicitly skips
1375 processing of Action/Trigger event definitions for user update.
1377 New Service Requirement
1378 +++++++++++++++++++++++
1380 This new functionality makes use of the QStore service (`open-ils.qstore`), which was previously
1381 unused in production. If this service has been removed from the configuration
1382 of a live Evergreen instances, it will need to be added back in order for
1383 batch user editing to succeed.
1388 Honor Timezone of the Acting Library
1389 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1394 * Display day-granular due dates in the circulating library's timezone.
1395 * Only display the date portion of the due date for day-granular circulations.
1396 * Display the full timestamp, in the client's timezone rather than the circulation library's, for hourly circulations.
1397 * Provide infrastructure for more advanced formatting of timestamps.
1398 * Override the built-in AngularJS date filter with an implementation that uses moment.js, providing consistency and better standards compliance.
1403 This is a followup to the work done for 2.12, where we added the ability
1404 for the client to specify a timezone in which timestamps should be interpreted
1405 in business logic and the database.
1407 Most specifically, this work focuses on circulation due dates and the closed
1408 date editor. Due dates, where displayed using stock templates (including
1409 receipt templates) and used for fine calculation, are now manipulated in the
1410 library's configured timezone. This is controlled by the new 'lib.timezone'
1411 setting available via the Library Settings Editor, loaded from the server when
1412 required. Additionally, closings are recorded in the library's timezone so that
1413 due date calculation is more accurate. The closed date editor is also
1414 taught how to display closings in the
1415 closed library's timezone. Closed date entries also explicitly record if they
1416 are a full day closing, or a multi-day closing. This significantly simplifies
1417 the editor, and may be useful in other contexts.
1419 To accomplish this, we use the moment.js library and the moment-timezone addon.
1420 This is necessary because the stock AngularJS date filter does not understand
1421 locale-aware timezone values, which are required to support DST. A simple
1422 mapper translates the differences in format values from AngularJS date to
1425 Of special note are a set of new filters used for formatting timestamps under
1426 certain circumstances. The new egOrgDateInContext, egOrgDate, and egDueDate
1427 filters provide the functionality, and autogrid is enhanced to make use of
1428 these where applicable. egGrid and egGridField are also taught to accept
1429 default and field-specific options for applying date filters. These filters may
1430 be useful in other or related contexts.
1432 The egDueDate filter, used for all existing displays of due date via Angular
1433 code, intentionally interprets timestamps in two different ways WRT timezone,
1434 based on the circulation duration. If the duration is day-granular (that is,
1435 the number of seconds in the duration is divisible by 86,400, or 24 hours worth
1436 of seconds) then the date is interpreted as being in the circulation library's
1437 timezone. If it is an hourly loan (any duration that does not meet the
1438 day-granular criterium) then it is instead displayed in the client's timezone,
1439 just as all other timestamps currently are, because of the previous Evergreen
1442 The public catalog is adjusted to always display the due date in the circulating
1443 library's timezone. Because the public catalog displays only the date portion of the due
1444 date field, this difference is currently considered acceptable. If this proves
1445 to be a problem in the future, a minor adjustment can be made to match the
1446 egDueDate filter logic.
1448 Now that due dates are globally stored in the configured timezone of the
1449 circulating library, the automatic adjustment to day-granular due dates needs
1450 to take those timezones into account.
1452 An optional SQL command is provided by the upgrade script to retroactively
1453 adjust existing due dates after library configuration is complete.
1459 Enhancements to Hard Due Date Functionality
1460 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1461 It will now be possible to delete Hard Due Date Values for dates that have
1462 passed. Also, the Hard Due Date updater will no longer change Ceiling Dates
1463 to a past date. This allows editing Ceiling Dates directly in a Hard Due Date
1464 as well as scheduling Ceiling Date changes via Hard Due Date Values.
1469 Patron Search by Birth Date
1470 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1471 * Now you can include the patron birth year and/or birth month and/or
1472 birth day when searching for patrons using the web staff client.
1473 * Day and month values are exact matches. E.g. month "1" (or "01")
1474 matches January, "12" matches December.
1475 * Year searches are "contains" searches. E.g. year "15" matches 2015,
1476 1915, 1599, etc. For exact matches use the full 4-digit year.
1480 Patron Search from Place Hold
1481 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1482 This feature allows staff members, when placing a
1483 hold on behalf of a patron in the web staff client, to search for
1484 patrons by names and other searchable patron information, rather than
1485 relying on barcode alone. In particular, after performing a catalog
1486 search or going to a specific bib record and clicking the 'Place Hold'
1487 button, the form now includes a 'Patron Search' button. This button
1488 will open a dialog allowing the staff member search for and select
1494 Retrieve Recent Patrons
1495 ^^^^^^^^^^^^^^^^^^^^^^^
1497 Adds a new library setting 'Number of Retrievable Recent Patrons'
1498 ('ui.staff.max_recent_patrons') that specifies the number of recently
1499 retrieved patrons that can be re-fetched from the staff client.
1501 A value of 0 means no recent patrons can be retrieved.
1502 A value greater than 1 means staff will be able to retrieve multiple
1503 recent patrons via a new Circulation 'Retrieve Recent Patrons' menu entry.
1505 The default value is 1 for backwards compatibility.
1512 Fuller title in XUL client Simplified Pull List
1513 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1514 The Simplified Pull List in the XUL client will now display subfields 245$n and
1515 $p in the title field. The addition will make it easier for staff to distinguish
1516 between different parts or seasons in a series.
1522 Transit Cancel Time and Terminology Change
1523 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1528 Previously, Evergreen deleted canceled (aborted) transits from the database. Now
1529 the rows in `action.transit_copy`, `action.hold_transit_copy`, and `action.reservation_transit_copy`
1530 are preserved in the database, though still not visible to the end user in the staff client.
1531 This allows for better tracking of when transits are canceled for the purposes of knowing
1532 which staff member canceled the transit, etc.
1534 NOTE: This change may require the re-creation of transit reports to filter out canceled
1535 transits from the results. Cloning the template and adding a 'Base Filter' of 'Cancel Time
1536 Is NULL' will suffice.
1538 "Canceled Transit" Terminology Change
1539 +++++++++++++++++++++++++++++++++++++
1541 The term "abort" has been replaced with "cancel" in all of the affected user interfaces.
1542 For internal continuity, however, the following permission codes have not changed:
1545 * `ABORT_REMOTE_TRANSIT`
1546 * `ABORT_TRANSIT_ON_LOST`
1547 * `ABORT_TRANSIT_ON_MISSING`
1555 Offline Circulation Available in Web Staff Client
1556 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1557 Offline circulation is now available in the web staff client. In order to use the
1558 offline interface, users must first log into the web staff client, perform
1559 a patron search, select a user from the results, and open the patron editor
1560 interface to collect all the relevent configuration information for the
1561 workstation. In addition, the offline interface available from the Circulation
1562 menu provides a 'Download block list' button for users who are logged in.
1564 As is the case in the old staff client, users can check materials in and out,
1565 renew items, and create new patron accounts while offline. The patron fields
1566 available in the offline patron registration editor are the same ones that
1567 are available to staff when working online.
1571 Add Circ Modifier to Record Detail Page in Staff TPAC
1572 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1573 The circulation modifier field is added to the table of copies to make
1574 more information available to staff without having to open
1581 Date+Time Format Settings for Web Client
1582 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1584 This change deprecates the existing 'Format Dates' and 'Format Times' settings
1585 and adds two settings for use with the webstaff client:
1587 * 'Format Dates with this pattern'
1588 * 'Format Date+Time with this pattern'
1590 These settings use format strings as documented here:
1592 https://docs.angularjs.org/api/ng/filter/date
1594 There is overlap with how the Dojo formats worked, but also some differences.
1596 The original 'Format Dates' and 'Format Times' settings worked together, but the
1597 new settings work independently. Certain field elements will use one, and
1598 certain field elements will use the other. These distinctions are hard-coded
1599 in the various UI templates, with the idea being that timestamp fields in
1600 which the date component alone is sufficient information (for example, date of birth)
1601 will use the 'Format Dates' setting. Fields where the time component is
1602 important (for example, checkout time) will use the 'Format Date+Time' setting.
1604 When the settings 'Format Dates' and 'Format Date+Time' are unset, we will default
1605 to "shortDate" (M/d/yy) and "short" (M/d/yy h:mm a), respectively.
1611 Global Option to Remove Sound for a Specific Event
1612 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1613 A new `nosound.wav` file has been added to the web client. The file can be used
1614 to globally disable audio alerts for a specific event on an Evergreen system.
1616 For example, to silence the alert that sounds after a successful patron search:
1620 mkdir -p /openils/var/web/audio/notifications/success/patron/
1621 cd /openils/var/web/audio/notifications/success/patron/
1622 ln -s ../../nosound.wav by_search.wav
1629 The official Evergreen manual has been split into eight new manuals, each
1630 designed for a specific audience. This new approach is designed to make
1631 the documentation more readable and usable.
1633 The specific audiences for the new manuals are:
1635 * Acquisitions staff
1638 * Public services staff who use the public catalog
1640 * System administrators who use the command line
1641 * System administrators who use the Web client
1642 * System administrators and programmers who wish to integrate Evergreen
1643 with other technologies
1645 All manuals are available at http://docs.evergreen-ils.org
1651 Improvements to ebook API
1652 ^^^^^^^^^^^^^^^^^^^^^^^^^
1654 Evergreen now supports checking out and placing holds on
1655 OverDrive and OneClickdigital ebook titles from within the public
1656 catalog. This is an experimental feature. It is not recommended for production
1657 use without careful testing.
1659 When ebook integration is enabled, a "Check Out E-Item" link will be
1660 displayed when viewing an ebook title from a supported vendor in the
1661 catalog. Clicking on the link allows the user to check out and download
1662 that title from the vendor directly within the catalog.
1664 If no copies are available for the title, a "Place Hold on E-Item" link
1665 is displayed instead, and the user may place a hold on the title. (Note
1666 that some vendors require the user's account to have an email address
1667 before permitting a hold.)
1669 My Account includes the ability to view current ebook checkouts and
1670 holds, download already-checked-out titles, and cancel holds.
1672 For API integration to work, you need to request API access from the
1673 vendor, and the vendor must have a way of authenticating your patrons.
1674 Your Evergreen system also needs to be configured for ebook API
1675 integration, following the instructions in the command line system
1676 administration manual
1679 This feature assumes that you are importing MARC records supplied by the
1680 vendor into your Evergreen system, using Vandelay or some other MARC
1681 import method. This feature does not search the vendor's online
1682 collections or automatically import vendor records into your system; it
1683 merely augments records that are already in Evergreen.
1685 Improvements to Bill Payment Pages
1686 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1687 The bill payment pages in the public catalog have been revamped
1690 * use the term "charges" instead of "fees"
1691 * include images of credit cards accepted
1692 * make the default print receipt template match other itemized receipts;
1693 note that this change is not automatically applied when upgrading.
1694 * display billing type
1695 * add button to pay only selected charges
1696 * reformat the credit card number input page
1702 Clickable Copy Locations
1703 ^^^^^^^^^^^^^^^^^^^^^^^^
1704 Adds a URL field to the copy locations editor. When a URL is entered in this field,
1705 the associated copy location will display as a link in the public catalog summary display.
1706 This link can be useful for retrieving maps or other directions to the copy
1707 location to aid users in finding material.
1712 Download Checkout History CSV Fixed for Large Number of Circulations
1713 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1714 Downloading checkout history as a CSV from My Account has been fixed
1715 for users with a large circulation history. Previously, this would
1716 time out for patrons with more than 100 or so circulations.
1718 This feature no longer uses the action/trigger mechanism and the public catalog
1719 now generates the CSV directly. The old action/trigger code is still
1720 present in the database and should be removed at some point in the
1726 Google Books Preview Rewrite
1727 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1728 The Google Books Preview functionality in record detail pages has been
1729 rewritten to modernize its style and optimize its performance:
1731 * The Dojo JavaScript framework is no longer used, saving approximately
1732 150K of JavaScript and CSS and four network requests per page load.
1733 * The Embedded Viewer is not loaded unless a possible preview is found,
1734 saving more network and memory overhead.
1735 * The Google Books Loader is used to load the Embedded Viewer instead of the
1736 https://productforums.google.com/forum/#!topic/books-api/lZrq5cWKrTo;context-place=forum/books-api[deprecated
1738 * All variables are self-contained and do not pollute the global namespace.
1739 * Event listeners are registered to handle clicks, rather than attaching
1740 `href="javascript:function()"` to <a> elements.
1741 * Book previews are displayed in a panel sized according to the viewport
1742 of the browser, improving its appearance on both mobile and desktop
1744 * The rewritten code is now served up directly from
1745 `/js/ui/default/opac/ac_google_books.js` rather than as a TT2 template.
1750 jQuery for the Public Catalog
1751 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1752 This release adds optional support for jQuery in the public catalog. This support
1753 is enabled by setting the `ctx.want_jquery` variable to a true value in the
1754 `config.tt2` template.
1760 New Popularity Parameters
1761 ^^^^^^^^^^^^^^^^^^^^^^^^^
1762 New popularity parameters for in-house use over time and for count of distinct
1763 organizational units that own a title are now available. Evergreen sites
1764 can use these parameters to create new statistical popularity badges for
1765 sorting in the catalog by Most Popular or by Popularity-Adjusted Relevance.
1767 The in-house use parameters will apply a badge to titles that have the most
1768 in-house use activity over time. The organizational unit count parameter
1769 will apply a badge to titles owned by the most number of libraries in a
1770 consortium. Ownership is determined by the copy's circulation library.
1775 Option to Suspend Holds at the Time They are Placed
1776 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1777 Users now have the option to suspend a hold at the same time they place the
1778 hold. The 'Place Hold' screen has a checkbox that can be enabled for users
1779 who want to suspend a hold at the time it is placed. There is also an option
1780 to set the activation date at the same time. This option is also available
1781 when placing holds on a batch of titles from 'My List' and will apply to
1782 all the titles in the batch.
1793 Fix to reporter.classic_current_circ View
1794 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1795 The `reporter.classic_current_circ` view, which is part of some
1796 extra views defined in `Open-ILS/src/sql/Pg/example.reporter-extension.sql`,
1797 has been fixed to not exclude loans for patrons who do not have a
1798 billing address set. Users of this view should rerun
1799 `Open-ILS/src/sql/Pg/example.reporter-extension.sql` during upgrade.
1804 New Report Source Table Allowing Report of "Last" Deleted copy
1805 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1807 This source table allows you to construct a clever aggregate report template
1808 which will report bibliographic IDs where a library or a group of libraries
1809 no longer have a copy attached but *had* a copy attached. This is especially
1810 useful when a holdings sync is required with an external vendor.
1813 Instructions for creating a report template with this source:
1815 * Create a new report template using "Library Holdings Count with Deleted" as the source
1816 * Add "Has Only Deleted Copies 0/1" (Min) to the Aggregate Filters -> Change Value to "1"
1817 * Add "Last Edit Date" (Max) to Aggregate Filters. In Aggregate Filters, change the operator to "Between"
1818 * 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"
1819 * Add "Bib ID" to Displayed Fields
1820 * Add "Last Edit Date" to Displayed Fields and Change Transform to Max
1821 * Add "Has Only Deleted Copies 0/1" to Displayed Fields and Change Transform to Min
1822 * Add "Total copies attached" to Displayed Fields and Change Transform to Sum
1825 This template will only output bibliographic IDs where all of the copies for the specified branch(es)
1826 are deleted. Furthermore, it will only output bibs whose copies were edited (deleted) during the
1827 specified date range. Unfortunately the user will have to manually type the date range without the date
1828 picker. This view will also allow you to answer questions like "Show me bibs where I have one visible
1829 copy and more than two deleted copies."
1834 Add Provider to Provider Note Link
1835 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1836 The Provider reporting source now includes a link to the Provider Note reporting source.
1841 Link ILS User and Working Location Reporting Sources
1842 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1843 The Working Location reporting source now has labels
1844 and it is now linked to the ILS User reporting source, allowing
1845 reports to display or filter on staff working location.
1850 New Circulation Report Source "All Circulation Combined Types"
1851 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1853 This report source will allow you to create a single report template for all of the following:
1856 * In-house uses of non-cataloged items
1858 * Circulations of non-cataloged items
1860 To distinguish between these different types of library use, it's important to display these columns
1861 in your report templates:
1870 Reports Template Searching
1871 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1872 A new form appears along the top of the reports interface for searching
1873 report templates. Once found, typical template actions (e.g. create new
1874 report) are available from within the results interface.
1876 Searches may be performed across selected (visible) folders or all
1877 folders visible to the logged in user.
1879 Searches are case-insensitive, any word order, with left-anchored words.
1880 All searched words must appear in at least one of the searched fields.
1885 * Searching for 'stat cat' matches:
1887 ** statistical category
1888 ** categories, statistical
1889 ** patrons (stat cat)
1890 * Searching for 'stat cat' does not match:
1892 *** both words must be present in the searched field(s)
1894 *** location contains 'cat' but it's not left-anchored.
1899 The templates, reports, and output interfaces now support paging via
1900 new 'Next', 'Prev', and 'Start' links next to the output limit selector.
1912 Web Staff Client Serials Module
1913 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1914 The serials module has been ported over to the web staff
1915 client, implementing a unified serials interface that combines
1916 ideas from both the serial control view and alternate serials
1917 control view from the old staff client.
1919 In addition to carrying over functionality that was available
1920 in the old staff client, several new features are included:
1922 * the ability to save prediction pattern codes as templates
1923 that can be shared and reused within an Evergreen database
1924 * a more streamlined interface for managing subscriptions,
1925 distributions, and streams
1926 * it is no longer necessary to create a starting issue in
1927 order to predict a run of issues; the dialog box for
1928 generating a set of predicted issues now lets you specify
1929 the starting point directly.
1930 * the ability to more directly edit MFHDs
1932 The new serials interfaces can be accessed from the record
1933 details page via a Serials drop-down button that links to
1934 a subscription management page, a quick-receive action, and
1935 a MFHD management page. There is also a new 'Serials Administration'
1936 page where prediction pattern and serial copy templates can
1947 SIP Bugfix Changes How Encoding Is Determined in Configuration
1948 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1950 The combined fix for the above mentioned SIP bugs alters the way that
1951 SIPServer looks up the output encoding in the configuration file (typically
1952 `oils_sip.xml`). SIPServer now looks for the encoding in the following
1955 1. An +encoding+ attribute on the +account+ element for the currently active SIP account.
1956 2. The +encoding+ element that is a child of the +institution+ element of the currently active SIP account.
1957 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.
1958 4. If none of the above exist, then the default encoding (ASCII) is used.
1960 Number 3 is provided to ease the transition to the new code. It is
1961 the current location of the +encoding+ element in the sample
1962 configuration file and as such, where it is likely to be found in
1963 actual files. It is recommended that you alter your configuration to
1964 move this element out of the +implementation_config+ element and into
1965 its parent +institution+ element. Ideally, SIPServer should *not* look into
1966 the implementation config, and this check may be removed at some time
1974 Web Client Acknowledgments
1975 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1977 The project to develop a new browser-based web client launched four
1978 years ago at the September 2013 Evergreen developer hack-a-way when the
1979 developer community voted to move away from the XUL client and explore other
1980 platforms. The first web client preview became available in Evergreen 2.7 when
1981 circulation was available in the new platform.
1983 The browser-based client is available due to the work of many coders, testers,
1984 bug reporters, documentors, translators, project managers, spec writers, funders
1985 and other contributors over the past four years.
1987 The Evergreen project would like to acknowledge the following organizations
1988 that funded development of the Web Staff Client:
1991 * British Columbia Libraries Cooperative
1992 * Consortium of Ohio Libraries
1994 * Georgia Public Library Service
1995 * Grand Rapids Public Library
1997 * Kenton County Public Library
1998 * King County Library System
2001 * Pennsylvania Integrated Library System
2002 * Pioneer Library System
2005 The Evergreen project would also like to thank the following individuals who
2006 contributed code, translations, documentation patches, tests, bug reports,
2007 technical specifications, and project management to the Web Staff Client:
2044 * Freddy Enrique Pelayo Huapalla
2070 Evergreen 3.0 Acknowledgments
2071 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2073 The Evergreen project would like to acknowledge the following
2074 organizations that commissioned developments in this release of
2078 * British Columbia Libraries Cooperative (BC Sitka)
2080 * Georgia Public Library Service
2081 * King County Library System
2083 * Pennsylvania Integrated Library System
2084 * Pioneer Library System
2086 We would also like to thank the following individuals who contributed
2087 code, translations, documentation patches, and tests to this release of
2136 We also thank the following organizations whose employees contributed
2139 * British Columba Libraries Cooperative
2143 * Emerald Data Networks, Inc.
2144 * Equinox Open Library Initiative
2146 * Grand Rapids Public Library
2147 * Indiana State Library
2149 * King County Library System
2150 * Lake Agassiz Regional Library
2151 * Laurentian University
2152 * Linn-Benton Community College
2154 * Merrimack Valley Library Consortium
2156 * North of Boston Library Exchange
2157 * Pennsylvania Integrated Library System
2158 * Pohjois-Karjalan Tietotekniikkakeskus Oy
2160 * Traverse Area District Library
2162 We regret any omissions. If a contributor has been inadvertently
2163 missed, please open a bug at http://bugs.launchpad.net/evergreen/
projects / working / Evergreen.git / blob