1. Evergreen 3.12.8

This release contains bug fixes and documentation fixes improving on Evergreen 3.12.7.

1.1. Acquisitions

Allow acquisitions vendor MARC Order record load even if some subfields are empty. (Bug 924952)

1.2. Administration

Fixes issue with numeric usernames when AuthProxy falls (Bug 1828456)
Updates SIP2 Patron Status to support subfields "too many items charged" subfield (05) and "too many items lost" subfield (09). (Bug 1980978)
Automate part of the build process. (Bug 2082120)

1.3. Circulation

Fixes issue where self check screen is blank when user’s email doesn’t contain an @ sign (Bug 2081758)
Fixes receipt printing issues. (Bug 2076255

1.4. Documentation

Updates eboook API intergration documentation (Bug 2078643)

1.5. OPAC

Fixes mouse selection of autosuggest searches. (Bug 2061004)

1.6. Staff Catalog

Fixes issue with DOB saving incorrectly in certain time zones. (Bug 1828114)

1.7. Acknowledgements

We would like to thank the following individuals who contributed code, testing, documentation, and patches to the 3.12.7 point release of Evergreen:

Andrea Buntz Neiman
Dan Briem
Ian Skelskey
Jane Sandberg
Jason Stephenson
Jeff Davis
Josh Stompro
Lindsay Stratton
Llewellyn Marshall
Michele Morgan
Mike Rylander
Stephanie Leary
Steven Mayo
Susan Morrison
Terran McCanna
kdandy1

2. Evergreen 3.12.7

This release contains bug fixes and documentation fixes improving on Evergreen 3.12.6.

2.1. Acquisitions

Allow users to save grid settings in Acquisitions Distribution Formulas administrative interface. (Bug 2069750)
Allow receiving cancelled or backordered line items in Acq Search (Bug 2047940)
Fixes the Canadian Dollars currency symbol to CAD for acquisitions. (Bug 1807998)

2.2. Administration

Fixes typo in Bib source for brief records library setting (Bug 1910580)
Updates the wording on the latency test page to be a little more user-friendly. (Bug 2064355)
Add a --check-leader flag to marc_export to force leaders to 24 characters. (Bug 2063350)
Update a dependency in a Github action that documentation contributors use to check their work. (Bug 2979835)

2.3. Cataloging

Allow users to save grid settings in Conjoined Items grid. (Bug 2069472)
Fix bug in Merge/Overlay Profile preserve specifications. (Bug 1878984)

2.4. Circulation

Hide the "Credit Available" and Patron Credit payment options when patron credit is disabled on bills screen. (Bug 1810419)
After checking out an item with a deposit, show the updated balance in patron summary. (Bug 2069891)
Show the deposit amount (if any) on the overrideable events dialog in checkout interface. (Bug 2069890)
Fixes silent failure in offline mode Reprint Last Receipt. (Bug 1806780)
Allows staff to edit survey questions and answers with UPDATE_SURVEY perm (Bug 1910444)
Allows staff to create and delete surveys with CREATE_SURVEY and DELETE_SURVEY perms (Bug 1910444)
Allows staff to take survey responses with UPDATE_USER perm. (Bug 1910444)
Rename "View Borrowing History" privacy waiver to "Obtain Circulation Information" for accuracy. (Bug 2054595)
Consider age protection when determining if a patron can renew an item that others are waiting for. (Bug 1989740)

2.5. Documentation

Fixes headings and links in staff catalog docs.
Updates to column picker docs (Bug 2067746)
Updates to Holds Pull List documentation (Bug 2067739)
Adds updates regarding barred and inactive accounts (Bug 2062004)

2.6. OPAC

Fixes the OPAC Shelving Location Group sort to honor position, name. (Bug 2076357)
i18n for BooPAC circ history "Delete Selected" button (Bug 2076420)
Prevent the shelving location group from being dropped in library selection box (Bug 2077998)
Speed up Bootstrap OPAC by removing extra copy of jQuery (Bug 2078985)
Improve display of ebook API items in the public catalog. (Bug 1982217)

2.7. Staff Catalog

i18n for staff catalog Browse search form label (Bug 2069617)
Silence console errors in staff navigation menu (Bug 2077753)

2.8. Staff Client

Remove unintended grey stripes from popup dialogs in the staff client. (Bug 2073014)
Updates Circulating Library to Checkout / Renewal Library where relevant (Bug 2068934)
Check the staff client authentication session every three minutes, reducing chances of hidden eviction of the session (Bug 2034956)

2.9. Acknowledgements

The Evergreen project would like to acknowledge the following organizations that commissioned developments in this release of Evergreen:

PaILS

We would like to thank the following individuals who contributed code, testing, documentation, and patches to the 3.12.7 point release of Evergreen:

Andrea Buntz Neiman
Blake Graham-Henderson
Dan Briem
Elizabeth Davis
Galen Charlton
Jane Sandberg
Jason Boyer
Jason Stephenson
Jeff Davis
Jennifer Weston
Josh Stompro
Kathy Lussier
Lena Hernandez
Linda Jansová
Lindsay Stratton
Martha Driscoll
Mary Llewellyn
Michele Morgan
Mike Rylander
Rogan Hamby
Ruth Davis
Ruth Frasur Davis
Stephanie Leary
Steven Mayo
Susan Morrison
Terran McCanna
Tiffany Little

Evergreen 3.12.6 ==

This release contains bug fixes and documentation fixes improving on Evergreen 3.12.5.

0.1. Circulation

Fixes bug that prevented staff from placing holds for patrons with SMS notification preferences when SMS is not enabled in library settings. (Bug 2073990)

0.2. Documentation

Corrects error in Action Trigger examples (Bug 2073993)
Updates images for SMS messaging docs (Bug 2073411)
Updates Circulation Limit Sets page (Bug 2073412)
Updates Recent Staff Searches page (Bug 2073415)
Updates Library Settings page (Bug 2073417)
Updates Workstation page (Bug 2075231)
Updates images on Holds Management page (Bug 2075341)
Updates terminology in Using the Public Access Catalog page
Updates images in the Circulating Items page (Bug 2076267)
Adds alt text to images in docs

0.3. Staff Client

Updates automated tests for the staff client. (Bug 2069098 and https://bugs.launchpad.net/evergreen/+bug/2074220[Bug 2074220)

0.4. Acknowledgements

We would like to thank the following individuals who contributed code, testing, documentation, and patches to the 3.12.6 point release of Evergreen:

Andrea Buntz Neiman
Blake Graham-Henderson
Dan Briem
Gina Monti
Jane Sandberg
Jason Stephenson
Josh Stompro
Michele Morgan
Ruth Davis
Scott Angel
Steven Mayo
Susan Morrison
Terran McCanna

1. Evergreen 3.12.5

This release contains bug fixes improving on Evergreen 3.12.4.

1.1. Upgrade Notes

This release contains an upgrade script, which is necessary for the fixes to Bug 2055089, Bug 2062023, and Bug 2059974.

1.2. Accessibility

Makes Angular nav bar responsive (Bug 1945498)
SVG logos; support for forced colors mode (Bug 2049657)
Corrects current page ARIA in staff catalog pagination (Bug 2058747)
Fixes the barcode input label in Scan Item as Missing Pieces. (Bug 2058287)

1.3. Acquisitions

Get actual remote file name when sending EDI message via SFTP. (Bug 2060153)

1.4. Administration

Fixes custom permission tree display sort in the patron registration/edit screen (Bug 1843940)
Refactors Shelving Location Groups Admin for accessibility (Bug 2042879)
Remove unnecessary error message from ./configure installation step. (Bug 2054454)
Re-orders fields on Server Administration > Circulation Max Fine Rules (Bug 1839878)
Re-orders Server Admin > Circulation Duration Rules fields (Bug 1839875)
Reorders the fields for Local Admin > Statistical Categories (Bug 2052641)
Reorders fields for Local Admin > Hold Policies (Bug 1915464)
Adds field group styling option to fieldmapper editor (Bug 1915464)
Adds missing shipment notification permissions (Bug 2055089)
Add PATRON_BARRED.override permission if missing. (Bug 2062023)
Add a print button to the Desk and Staff User Payment grids to print the org, date range, totals, and full list. (Bug 2003090)
Fix bug that prevented action triggers from processing when granularity is an empty string. (Bug 2026206)
Corrects wording on Carousel Types interface (Bug 1853630)

1.5. Catalog

Mitigates a catalog search performance issue (Bug 2059974)
Fixes problem where the staff catalog could attempt to jump to an incorrect record when performing a metarecord search that returns a single result. (Bug 1949214)
Fixes Angular Search Preferences being empty after login (Bug 2072430)

1.6. Cataloging

Hides Edit call number link if missing permission (Bug 2015112)

1.7. Documentation

New development tool to help prepare release notes using information from Git commits. (Bug 2051874)
Adds missing alt text to image files

1.8. Self Checkout

Fixes issue where cover images were not displayed in the selfcheck holds list for titles that lack ISBNs. (Bug 2037564)

1.9. Acknowledgements

We would like to thank the following individuals who contributed code, testing, documentation, and patches to the 3.12.5 point release of Evergreen:

Andrea Buntz Neiman
Bill Erickson
Blake Graham-Henderson
Dan Briem
Elizabeth Davis
Galen Charlton
Garry Collum
Gina Monti
Ian Skelskey
Jane Sandberg
Jason Stephenson
Llewellyn Marshall
Michele Morgan
Mike Rylander
Ruth Davis
Scott Angel
Shula Link
Stephanie Leary
Steven Mayo
Terran McCanna

2. Evergreen 3.12.4

This release contains bug fixes improving on Evergreen 3.12.3.

This includes fixes for a critical-importance security issue and two high-importance security issues. Users are advised to upgrade as soon as possible.

2.1. Upgrade notes

The security patches for Bug 2069959 and Bug 2019157 both involve changes to OPAC Template Toolkit templates. If you have customized these templates, perhaps as branding for a specific org unit, please review your customized version to ensure that:

the loc_value variable in misc_util.tt2 has non-numeric charcters removed, and
the blimit variable in browse.tt2 has the html filter applied.

2.2. Security

Patch Insecure direct object reference (IDOR) vulnerability for action trigger output in OPAC list printing feature. (Bug 2070078)
Remediates a reflected Cross-site Scripting (XSS) vulnerability in the public catalog browse feature. (Bug 2069959)
Mitigate a reflected cross-site scripting (XSS) vulnerability in the public catalog. (Bug 2019157)

2.3. Further reading

To learn more about the mechanics and impact of IDOR and XSS vulnerabilities:

2.4. Contributors

Galen Charlton
Mike Rylander
Jane Sandberg
Jason Stephenson

3. Evergreen 3.12.3

This release contains bug fixes improving on Evergreen 3.12.2.

3.1. Upgrade Notes

Bug 2040514 requires two new prerequisite Perl modules. These can be installed by running the prerequisite installation for your Linux distribution. Please see the Evergreen installation instructions for more information.
IDL Improvements and Clean Up (Bug 2050227): If you have custom IDL entries, please see the full release note below under Architecture.
Bug 2028095 requires a database update
Bug 1909585 requires a database update

3.2. Accessibility

Increases the visibility of focus outlines in the Angular staff client (Bug 1828463)
Adds ARIA attribute to Angular staff client navbar (Bug 2046820)

3.3. Acquisitions

Fixes for SFTP Transfer of EDI Order Data - This repairs the SFTP transfer mechanism so that it should work with most vendors who require usernames and passwords for authentication. To switch from FTP to SFTP, edit the EDI account’s host entry to begin with "sftp://" instead of "ftp://". Check with your EDI vendor before making this change. They may have additional requirements. This fix requires two new Perl modules; see Upgrade Notes above. (Bug 2040514)
Restore bold styling of paid off amount in purchase order summary. (Bug 2051250)

3.4. Administration

Fixes bug that could cause the Cash Reports page to display payments for the wrong day. (Bug 2051599)
Adds HTML::defang to the opac.patron.custom_css Library Setting (Bug 1869971)
Fixes issue with Patrons with Negative Balances interface where a deleted patron with a negative balance would break the interface (Bug 2039725)
Sets a useful group of default columns in the Patrons with Negative Balances interface (Bug 2047704)
Teaches marc_export to generate an error if given an empty ID file (Bug1329872)
Makes it possible to display the org unit ID as a number on Angular record editor forms for editing org units (Bug 2051944)
Displays Org Unit ID in Org Config interface. (Bug 2051879)
Improves description of the "How to set default owning library for auto-created line item items" Library Setting (Bug 2028095)
Silences some "Use of uninitialized value" log entries from catalog search (Bug 2043045)
Removes placeholder attributes from inputs in the Angular record editor and display field help directly rather than in a tooltip. Also moves the translate button next to text inputs for translatable fields. (Bug 2021862)

3.5. Architecture

IDL Improvements and Clean Up * Bug 2050227

The IDL (fm_IDL.xml) has undergone improvement and clean up.

More fields have been marked required. Required fields are that those that come from a database table, have a "NOT NULL" constraint in the schema, and do not have a default value assigned in the database. This change has the advantage of making it easier for the Angular staff client to identify required fields and prevent bad data from being entered in many interfaces.

Classes that are read-only and virtual were ignored, since they cannot be updated. Virtual fields were also skipped for similar reasons.

No attempt was made to validate whether or not existing required fields should be required. If a field was required before these changes, it should still be required now.

Line wrap and spacing have been updated to match the output of libxml2.

Spaces used for indentation have been replaced with tabs using the vim and Emacs setting of 4 spaces per tab.

Two schema validation errors have been corrected:

A typo of "relteype" was corrected to "reltype."
An extra "retrieve" permissions entry was removed from the asc class.

If you have custom IDL entries, you will want to make sure that you merge with this update and check for conflicts. It would be a good idea to validate your merged IDL with the schema file:

xmllint --schema Open-ILS/examples/fm_IDL.xsd Open-ILS/examples/fm_IDL.xml

For maintaining future compatibility and ease of merging, you may want to ensure that your custom IDL entries follow the above formatting guidelines.

3.6. Catalog

Show the More/Less toggle on facet display in the staff catalog only when a facet has more than five entries. (Bug 2046974)
Removes inaccurate count of shelving locations from staff catalog (Bug 2048798)
Prevents holds with an invalid pickup location selected from being placed in the Angular catalog (Bug 2000270)

3.7. Cataloging

Fixes problem where "Form" value could not be saved in MARC editor for electronic resources. (Bug 2056204)
Numerous fixes to edits in item alerts: Fixes invocation of (Manage) Item Alerts dialog in Holdings Editor; Adds batch edit for Item Alerts in Holdings Editor; Alerts get grouped together for editing if they are mostly identical; Adds Manage Alerts button to Item Alerts dialog during alert display in Angular ("eg2") interfaces; Fixes TypeError: defaults is null exception for missing Default Item Alert Type preference; Adds a Changes Pending indicator for Holdings Editor (Bug 2012971)
Improves performance of item refresh after batch editing (Bug 1821094)

3.8. Circulation

Adds privilege expiration date column to Group Member Details table (Bug 1779743)
Fixes annotate payment when using keyboard navigation (Bug 2047158)
Adds help button for Convert change to patron credit on patron bills (Bug 1929596)
Fixes overly large barcode field on Mark Item as Missing Pieces page. (Bug 2051156

3.9. Documentation

Improves documentation of Fiscal Propagation and Rollover (Bug 2049774)
Updates the version of Antora used to build the documentation (Bug 2036328)
Updates documentation to include information about strict barcode (Bug 2053050)
Adds documentation for the Angular staff catalog, based on documentation produced by Indiana Evergreen.
Allow Windows users to generate the Evergreen manual locally. (Bug 1930099)

3.10. OPAC

Adds 245$n and 245$p to the title field in public catalog list CSV download, to better distinguish between multiple titles in the same series. (Bug 1909585)
Changes "Account Information and Preferences" in areas of the OPAC to "Personal Information and Preferences" (Bug 1980138)
Clarify button text in public catalog New List interface. (Bug 2047589)
Fixes placement of Save Notes button in public catalog My Lists page (Bug 2047588)
Changes button order in OPAC My Lists (Bug 2047592)

3.11. SIP

Adds code to flesh part level holds and issuance holds information in SIP/Patron.pm (Bug 1525394)

3.12. Staff Client

Fixes issue with logging out of multiple tab in AngularJS client pages (Bug 2034617)
Ensures that both AngularJS and Angular grids use a gear icon for the grid settings menu. (Bug 1803788)
Fixes issue where Reports interface would not load if the BitWarden browser plugin is installed (Bug 2052567)
Restores bold weight to eg-grid column headers (Bug 2051566)
Fixes the styling of the Angular grid’s Manage Columns modal (Bug 2056069)
Fixes the styling of the Angular grid’s Manage Actions Menu modal (Bug 2056069

3.12.1. Third Party Services

Adds idempotency to Stripe to prevent duplicate payments (Bug 2057948)

3.13. Acknowledgements

We would like to thank the following individuals who contributed code, testing, documentation, and patches to the 3.12.3 point release of Evergreen:

Andrea Buntz Neiman
Bill Erickson
Blake Graham-Henderson
Brett French
Carol Witt
Chris Sharp
Christine Morgan
Debbie Luchenbill
Eva Cerniňáková
Galen Charlton
Gina Monti
Jane Sandberg
Jason Boyer
Jason Etheridge
Jason Stephenson
Jeff Davis
Jennifer Pringle
Josh Stompro
Ken Cox
Lena Hernandez
Michele Morgan
Mike Rylander
Robin Fitch
Rogan Hamby
Shula Link
Spencer Pennington
Stephanie Leary
Steven Mayo
Susan Morrison
Terran McCanna
Jennifer Weston

4. Evergreen 3.12.2

This release contains bug fixes improving on Evergreen 3.12.1.

4.1. Upgrade Notes

Bug 2019207 requires a database update
Bug 2051140 requires a database update

4.2. Bug Fixes

4.2.1. Accessibility

Removes extra tab stops when navigating bib record actions in staff client using keyboard (Bug 2052960)

4.2.2. Acquisitions

The fund dropdowns for line items and direct charges on purchase orders now display funds that user has permission to use, fixing a regression (Bug 2040637)

4.2.3. Administration

Adds a new org unit setting that configures the discovery layer URL opened by the Patron View button on a staff catalog record (Bug 2019207)
Fixes misconfigured delete dialogs and adds dialogs where they were missing (Bug 2043508)
Follow up to Bug 2017941 to correctly build on Debian Buster
Adds missing bib bucket IDL permissions, fixes carousel admin interface (Bug 2051140)

4.2.4. Circulation

Patch ensures that when "Require Monographic Part when Present" is in effect, that deleted monograph parts are not taken into account when checking whether a title-level hold is possible (Bug 2051557)
Fixes bug that allowed one checkout after a patron had reached a group penalty threshold, for example PATRON_EXCEEDS_OVERDUE_COUNT or PATRON_EXCEEDS_CHECKOUT_COUNT (Bug 1890822)

4.2.5. Developer

Fixes test failure in Angular staff client (Bug 2053245)

4.2.6. Documentation

Updates to autosuggest documentation (Bug 2053047)

4.2.7. General

Expands the Concerto test data set (Bug 2023690)

4.2.8. Public catalog

Restores ability to submit basic OPAC search by hitting enter in search input (Bug 2053035)
Closes autosuggest dropdown in the public catalog when it loses focus (Big 2054128)
Ignores duplicate links from 856 fields with multiple $9’s (Bug 1582720)

4.2.9. Staff catalog

Adds a "Clear Added Content Cache" item to the Other Actions menu in the staff catalog record page (Bug 1939162)

4.3. Acknowledgements

We would like to thank the following individuals who contributed code, testing, documentation, and patches to the 3.12.2 point release of Evergreen:

Jason Boyer
Dan Briem
Galen Charlton
Elizabeth Davis
Ruth Frasur Davis
Jason Etheridge
Blake Graham-Henderson
Stephanie Leary
Tiffany Little
Llewellyn Marshall
Stephen Mayo
Terran McCanna
Gina Monti
Michele Morgan
Susan Morrison
Andrea Buntz Neiman
Jane Sandberg
Chris Sharp
Jason Stephenson

We would also like to thank the following organizations that sponsored development in this point release:

Pennsylvania Integrated Library System (PaILS)

5. Evergreen 3.12.1

This release contains bug fixes improving on Evergreen 3.12.0.

5.1. Upgrade Notes

Bug 1384796 requires a database update
Bug 2046575 requires a database update

5.2. Bug Fixes

5.2.1. Accessibility

Fixes placing of login error message & adds ARIA labeling to login screen (Bug 1839364)

5.2.2. Acquisitions

Fixes issue with Expand All button on Purchase Order pages (Bug 2049654)

5.2.3. Administration

Fixes an erroneous constraint on asset.copy_template (Bug 1384796)
Fixes copy stat cat fleshing in SuperCat (Bug 2047587)
A fix to reduce size of release tarball by not shipping the Angular build cache (Bug 2048907)

5.2.4. Cataloging

Fixes an issue in MARC Batch Import / Export where queue data was fetched in parallel, causing excessive pcrud calls (Bug 1945003)
Restores the <NONE> selection to prefix and suffix dropdowns in Angular holdings editor Batch Actions (Bug 1998413)

5.2.5. Circulation

Adds publication year to Angular Pull List (Bug 2049673)
Fixes issue with alerts not displaying upon the initial load of the Patron interface (Bug 1980273)
Holds grid can now print / download the Hold Status column (Bug 2051038)
Enables clearing the default pickup location in the patron editor (Bug 1939154)

5.2.6. Client

Fixes a printing issue on Patrons With Negative Balances admin page (Bug 20471668)
Fixes cropping on Reports icon in splash page (Bug 2046970)
Adds ability to save the column settings on the patron and item stat cat entries (Bug 2046575)
Improvements to Hours of Operation notes field (Bug 2036296)

5.2.7. Developer

Removes make_release -x option to build XUL client; make_release now builds the browser client by default (Bug 2051370)

5.2.8. Documentation

Fixes a typo in Booking Reservation docs (Bug 2045569)
Screenshot & layout updates for Booking Admin, Best Hold Selection Sort Order, Statistical Categories, and Column Picker docs (Bug 1933852, Bug 2045802, Bug 1426120, Bug 2048132, and Bug 2045805)
Updates to Self Check Docs (Bug 1494736)
Updates to Circulation Policy Docs (Bug 1906847)
Updates to Workstation User Settings docs (Bug 2011455)
Documentation for Added Content Tab feature
Documentation for Angular Link Checker feature
Documentation for Angular Custom Org Unit Trees feature
Updates to Emergency Closing Handler documentation (Bug 1871692)

5.2.9. General

Fixes an issue where the progress bar would not close in Firefox (Bug 1739638)

5.2.10. Public catalog

Removes non-functional staff-only "Locate Z39.50 Matches" buttons from OPAC templates (Bug 2021903)

5.2.11. Staff catalog

Makes the Hold Status, Current Item, and Requested Item Columns non-sortable on Angular holds grids to avoid errors (Bug 1889133)
Fixes a tab display error in the Traditional Staff Catalog (Bug 2047714)
Fixes crash when displaying Staff View for a deleted record that has no metarecord mappings (Bug 2039229)
Improves speed of searching for and displaying titles that are members of large metarecord sets (Bug 2051708)

5.3. Acknowledgements

We would like to thank the following individuals who contributed code, testing, documentation, and patches to the 3.12.1 point release of Evergreen:

Jason Boyer
Dan Briem
Galen Charlton
Jeff Davis
Ruth Frasur Davis
Bill Erickson
Blake Graham-Henderson
Stephanie Leary
Shula Link
Tiffany Little
Steven Mayo
Terran McCanna
Gina Monti
Michele Morgan
Susan Morrison
Andrea Buntz Neiman
Mike Rylander
Jane Sandberg
Chris Sharp
Jason Stephenson
Jessica Woolford

6. Upgrade notes

6.1. AutoRenew Event Definition default delay

Upgrade script required for change in AutoRenew Event Definition default delay

6.2. Removal of OpenSRF Legacy JSON Gateway

The OpenSRF Legacy JSON Gateway is deprecated and will been removed from OpenSRF. This requires removing any references to it in the Apache configuration.

This means removing references to "OSRFGatewayLegacyJSON" in /etc/apache2/eg_vhost.conf.

Example patch:

-# XXX Note, it's important to explicitly set the JSON encoding style
-# (OSRFGatewayLegacyJSON), since the default encoding style will likely change
-# with OpenSRF 1.0
-# ----------------------------------------------------------------------------------
-# OpenSRF JSON legacy gateway
-# ----------------------------------------------------------------------------------
-<Location /gateway>
-    SetHandler osrf_json_gateway_module
-    OSRFGatewayLegacyJSON "true"
-    Require all granted
-</Location>
-# ----------------------------------------------------------------------------------
-# New-style OpenSRF JSON gateway
+# OpenSRF JSON gateway
 # ----------------------------------------------------------------------------------
 <Location /osrf-gateway-v1>
     SetHandler osrf_json_gateway_module
-    OSRFGatewayLegacyJSON "false"
     Require all granted
 </Location>

7. New Features

7.1. Accessibility

Revamped OPAC search autosuggest (Bug 1187993)
Added empty alt text for OPAC book covers and format icons to eliminate redundant screen reader announcements of item titles and formats (Bug 1965985)
Added text alternatives for all icons and images in the staff interface (Bug 1818086, Bug 1833726, Bug 2042492)
Improved color contrast for links, buttons, and form inputs throughout the staff interface (Bug 2018326, Bug 2019735, Bug 2028088, Bug 2043238, Bug 2043847)
Added keyboard support for all buttons in the Angular staff interfaces (Bug 2039310, Bug 2040303, Bug 2043424, Bug 1850473)
Form fields are properly labeled in all core UI components in staff interface (Bug 1999158, Bug 20009853, Bug 2043421, Bug 2019031, Bug 2039606)
Added form field labels for staff catalog search preferences (Bug 2036313)
Added form field labels for patron survey question administration (Bug 2040186)
Improved landmarks and headings for screen reader navigation in staff catalog (Bug 2039483)
Improved table navigation for staff catalog shelving locations (Bug 2016742), cash reports in administration (Bug 2039311), and patron survey answers (Bug 2040184)
Improved screen reader announcement of repetitive links in staff catalog items table (Bug 2016343)
Automated accessibility tests for developers (Bug 2035535)

7.2. Acquisitions

7.2.1. Interface for Fiscal Years and Calendars

Bug 1956510

A new interface is now available for users to manage fiscal years and calendars . It is accessible via Administration → Acquisitions Administration → Fiscal Years and Calendars.

To add or edit fiscal calendars and years, a user must have the ADMIN_ACQ_FISCAL_YEAR permission.

Org units by default use the Default fiscal calendar. If new fiscal calendars are created and users wish their associated fiscal years to be visible in the Year drop down of other interfaces, the Fiscal Calendar must be updated to use the new fiscal calendar in the org unit.

7.3. Administration

7.3.1. Optional Evergreen "Authoritative" API Support

Bug 2012402

Previous versions of Evergreen supported "authoritative" API calls by default. These are API calls which force database reads to go the primary database instead of a pooled replica.

Going forward, this functionality will be disabled by default, but may be enabled via a new opensrf.xml setting.

If your site uses database pooling, with Evergreen actively reading from replicas, add this setting to your opensrf.xml file within the <default/> block:

<opensrf version='0.0.3'>
  <default>
    <uses_pooled_read_replica_dbs>true</uses_pooled_read_replica_dbs>
<!-- ... -->

7.3.2. Change in AutoRenew Event Definition Default Delay

Bug 1899976

The delay for the AutoRenew event has been changed from -23 hours to -24 hours and 1 minute. The previous values of -23 hours for the delay and -1 minute for the max_delay left a gap of approximately 1 hour where items would not auto-renew if they fell due during that time. Depending upon the time that the AutoRenew event runner is scheduled to run, this gap may never turn up. However, all it takes is a misconfigured client (i.e. an incorrect timezone setting) or a manually edited due date on a circulation for this to turn up. The new interval settings guarantee that all circulations for a given 24 hour period are selected with no gap.

A database upgrade script is provided to alter any event definitions using the Circ::Autorenew reactor and the previous default delay values to the new settings. If you have customized or added any event definitions using this reactor, you should double check that they are correct after an upgrade.

7.3.3. Hatch Print Config Angular Port

Bug 1965326

The Hatch printer settings interface has been ported to Angular.

The checkbox to enable Hatch printing has also been moved from the separate (now-retired) "Print Service (Hatch)" interface into the newly Angularized "Hatch (Print Service) Printer Settings" interface.

7.3.4. Shelving Locations Editor: Hide deleted shelving locations by default

Bug 1917092

In the Shelving Locations Editor under Local Administration, a filter to hide deleted locations is applied by default. Clicking the Remove Filters button or Clearing the filter on the Is Deleted column will reveal the deleted locations.

7.3.5. Hostname URL building

Bug 1862834

Fixed issue loading some AngularJS interfaces when hostname starts with staff or eg

7.3.6. marc_export script improvments

--852 option for marc_export

Bug 2041364

The new --852b switch (when used in conjunction with --items) takes the following values:

circ_lib - emit the item circulation library in 852$b
owning_lib - emit the owning library in 852$b
both - emit owning lib and circ lib as separate repeats of $b. This is both the default and legacy behavior.

--exclude-hidden option for marc_export

Bug 2015484

The --exclude-hidden option, when used in conjunction with --items, will not emit 852 fields for items if they are hidden from in the OPAC in any of the four ways that this can be specified in Evergreen. If a bib therefore ends up with no visible items, it will be excluded from the output.

marc_export sorting bib output

Bug #2029256

The marc_export script will now sort the bib record output by the bib record ID so that the records in the export file are in a consistant order.

marc_export default encoding changed to UTF-8

Bug #2015758

The default file encoding output when using the marc_export script is now UTF-8 instead of MARC8. After upgrading check your use of the marc_export script to ensure that if you need an encoding other than UTF-8 you specify it with the argument --encoding. This change has the possiblity of breaking your workflow.

7.3.7. Custom Org Unit Trees interface ported to Angular

Bug 1993825

Reimplemented the Admin Custom Org Unit trees interface in Angular.

7.3.8. Upgrading to Evergreen/OpenSRF Redis

Bug 2041431, Bug 2017941

Some of these steps are part of a standard install, included here for completeness.

Note	Most of these steps are done automatically when installing OpenSRF and Evergreen from scratch. It may be easier for some (and less error prone) to install new servers than to upgrade existing ones.

Assumptions

Evergreen/OpenSRF are installed in the default /openils directory.
Assumes a single machine localhost install.

Install

From within the dowload / checkout directory

sudo make -f OpenSRF/src/extras/Makefile.install ${OSNAME}
sudo make -f Evergreen/Open-ILS/src/extras/Makefile.install ${OSNAME}

cd OpenSRF
make clean all
sudo make install

# ----

cd ../Evergreen
make clean all
sudo make install

Configure

Redis passwords are generated at install time and stored in redis-accounts.txt.example. Make a local copy to retain our passwords. The defaults will be locally generated, unique, and safe to use.

cd /openils/conf
cp redis-accounts.txt.example redis-accounts.txt

Passwords are defined for opensrf, router, and gateway.

Example redis-accounts.txt entry for the opensrf account:

ACL SETUSER opensrf reset
ACL SETUSER opensrf on >1f129912-b38a-4c42-910f-521e0651b7b9
ACL SETUSER opensrf -@all +lpop +blpop +rpush +del ~opensrf:router:* ~opensrf:service:* ~opensrf:client:*

The opensrf account password for the example above is 1f129912-b38a-4c42-910f-521e0651b7b9. Copy this value into opensrf_core.xml

    <domain>private.localhost</domain>
    <username>opensrf</username>
    <passwd>1f129912-b38a-4c42-910f-521e0651b7b9</passwd>

Repeat this process for the router and gateway accounts. There will be one password entry for gateway and 2 password entries for router.

Going forward, the username for the <gateway/> section will be gateway.

Example:

  <gateway>
    ...
    <username>gateway</username>
    <passwd>a9080f2e-3504-4d38-9179-8e3d06c53bfd</passwd>
    <port>6379</port>
    <loglevel>3</loglevel>
    ...
  </gateway>

Update occurrences of port 5222 (i.e. your local ejabberd port) with the default Redis port 6379. There will be 4 occurrences by default.

Example:

    <domain>private.localhost</domain>
    <username>opensrf</username>
    <passwd>1f129912-b38a-4c42-910f-521e0651b7b9</passwd>
    <port>6379</port>

To avoid requiring Redis listen on multiple IP addresses, change the public and private hosts in /etc/hosts to use the same IP.

127.0.0.1 localhost public.localhost private.localhost

Disable message persistence by modifying the Redis save setting.

Open /etc/redis/redis.conf and make the following
- Apply a save value of ""
- Disable existing definitions for the save value.

# Snapshotting can be completely disabled with a single empty string argument
# as in following example:
#
save ""

# save 900 1
# save 300 10
# save 60 10000

Restart the Redis server to make the changes take effect:

sudo systemctl restart redis-server

osrf_control -l --restart-all
sudo systemctl restart apache2 nginx websocketd-osrf

Done!

Upgrade Note: Removal of OpenSRF Legacy JSON Gateway

The OpenSRF Legacy JSON Gateway is deprecated and will been removed from OpenSRF. This requires removing any references to it in the Apache configuration.

This means removing references to "OSRFGatewayLegacyJSON" in /etc/apache2/eg_vhost.conf.

Example patch:

-# XXX Note, it's important to explicitly set the JSON encoding style
-# (OSRFGatewayLegacyJSON), since the default encoding style will likely change
-# with OpenSRF 1.0
-# ----------------------------------------------------------------------------------
-# OpenSRF JSON legacy gateway
-# ----------------------------------------------------------------------------------
-<Location /gateway>
-    SetHandler osrf_json_gateway_module
-    OSRFGatewayLegacyJSON "true"
-    Require all granted
-</Location>
-# ----------------------------------------------------------------------------------
-# New-style OpenSRF JSON gateway
+# OpenSRF JSON gateway
 # ----------------------------------------------------------------------------------
 <Location /osrf-gateway-v1>
     SetHandler osrf_json_gateway_module
-    OSRFGatewayLegacyJSON "false"
     Require all granted
 </Location>

7.4. API

7.4.1. Carousel API Improvements

Bug 2017673

The open-ils.actor.carousel.retrieve_by_org API now returns the carousel’s default name in addition to the override name.
The open-ils.actor.carousel.get_contents API now returns the item author as well as title.

7.5. Cataloging

7.5.1. Create MARC Record Interface Enhancements

Add a global keyboard shortcut for Create MARC Record of Ctrl+F3. (Bug 2031040)
Focus on the template selector on load, and set unique page title for interface. (Bug 2031043)
Focus on item add checkbox and switch to call number input after activation. (Bug 2031114)
Hide the help button when the flat text editor is enabled since it doesn’t do anything in that mode. (Bug 2031123)
Add keyboard shortcut (Ctrl+s) to save in the flat text editor. (Bug 2031162)
Add shortcut key (Ctrl+E) to jump to the flat text editor textbox. (Bug 2031177)

7.5.2. Default Item Alert Type

Bug 2017673

Staff can now set a default item alert type for new item alerts. To do this:

Open the holdings editor
Select the Preferences tab.
Under the "Item Attribute Settings" heading, use the "Default Item Alert Type" dropdown to choose the type that you use most frequently.
The setting takes effect immediately, no need to save it.

7.5.3. Added Content Tab in Staff Catalog

Bug 1991294

Adds an Added Content tab to the record details page in the angular staff catalog.

The new Added Content tab currently supports only NoveList Select added content.
NoveList Select subscribers will need to request credentials specifying the staff client url from NoveList for the library settings, separate from the credentials used in the OPAC.

Added Content Library Settings

The following Library Settings control the behavior of the Added Content tab

Staff Client added content: NoveList Select API version (not required)
Staff Client added content: NoveList Select profile/user (
Staff Client added content: NoveList Select key/password
URL Override for NoveList Select added content javascript (not required)

The following new permission controls the ability to setting the URL Override library setting

UPDATE_ADDED_CONTENT_URL

Added Content Tab Behavior

If no NoveList settings are present for the OU level, the Added Content tab does not appear.
If NoveList is set up but the bib record lacks ISBNs, or there is no NoveList content available for the work, the tab appears but it will say "No Added Content" and its star will be empty and gray.
If NoveList is set up and content is available, the tab’s star will be gold and filled in. It may take a few seconds to change when you first load the record. It will load in the background while you are viewing any other tab in the record.

7.5.4. Link Checker ported to Angular

Bug 1993824

Reimplementation of Cataloging → Link Checker in Angular.

Relabeled URL Verification Attempts to Batches
Relabeled URL Verifications to Attempts
Main grid display combines Sessions and Batches.
Added a Filter Groups feature to allow users to name and save grid filter groups

7.6. Circulation

7.6.1. Expansion of Copy Statuses Eligible to Fill Holds

Bug 1904737

Copies with a status that has both the holdable and is_available fields set to true are now elibible to fill holds. This was previously limited to copies with a "magical" status of 0 or 7. The change expands the copies that can fill holds and affords better control over what copies with what statuses will appear on the holds pull list or target holds.

7.6.2. Add filters to Holds Pull List

Bug 1968070

Two new filter comboboxes have been added to the Holds Pull List, one to filter by Pickup Library and one to filter by Shelving Locations / Shelving Location Groups. The Print Full List and Download CSV actions respect the new filters, which will improve usability for libraries with large pull lists who need to split the list into sections for multiple staff to work on. The settings are also sticky, which will make it easier for individuals who always work on pulling holds in the same section of the library every day.

7.7. Client

7.7.1. Print Selected Rows

Bug 2037128

Grids throughout the staff client now have an option to print only rows that the user has selected, rather than printing all rows in the grid.

7.7.2. Add Survey Responses to Patron Data Print Template

(Bug 1994057

Includes most recent response to each available survey question on the Patron Data print template.

7.8. OPAC

7.8.1. Google Analytics 4 Update

Bug 2019972

Google is transitioning from Universal Analytics to GA4 during the Summer of 2023, which requires an update to the Javascript that is embedded in the public catalog pages.

Note that Google requires each site to set up a new unique code (G-) that replaces the old (UA-) code and this will also need to be updated in config.tt2.

7.8.2. New Setting for Default URI Notes

Bug 1812241

If a URI does not have a 856$z defining a note to display next to it in the OPAC you can use the opac.uri_default_note_text setting to define one.

This feature helps to save catalogers time. If your library has a note that should be added to a wide range of electronic resources, rather than applying the note to all applicable records, you can set this setting to an appropriate value, and add an 856$z note for any resources that shouldn’t receive the default note.

7.8.3. Improve OPAC URI link purpose display and coverage

Bug 1992827

Previously, the logic used in the OPAC and staff client to display non-located URIs was slightly different. In particular, the staff client included any 856 with an ind2 value of 0, 1, or 2, and provided a label indicating the purpose of the URI based on the ind2 value. The OPAC, on the other hand, only displayed 856s with an ind2 of 0 or 1, and did not distinguish the purpose.

Now the OPAC displays non-located URIs in the same ways as the staff client, including those with an ind2 value of 2 and displaying a descriptive purpose with the link.

7.8.4. Editing manual carousels via the original bucket

Bug 1920234

Creating a carousel from a bucket no longer creates a new "System-created bucket". When a new carousel is generated from a record bucket, any changes made to the bucket will be automatically reflected in the carousel. Staff no longer need to go to the Carousels Administration screen to make these changes.

This change only affects newly created carousels. Existing manual carousels will still need to be edited via the Carousels Administration screen.

7.8.5. Course Reserve Search Filter

Bug 1895699

This filter allows users to limit their search to records that are attached to courses at particular libraries, like so:

biology on_reserve(5, 10)

The filter can also be negated to search for records that are not attached to a course:

biology -on_reserve(5)

If an organization is opted into the Course Materials module, this filter will appear on the search results page of the public catalog. Staff at these organizations will have a new option in their staff catalog search preferences to enable this filter in the staff catalog as well.

7.8.6. Display Upcoming Closures in OPAC

Bug 2017913

Adds display of upcoming closures (as entered in the Closed Dates Editor) to the library information pages in the OPAC.

7.9. Reports

7.9.1. Reporting Sources for Invoice Totals

Bug 2036842

Three new reporting sources are available to permit reporting on the total amount of invoices, including both line items and direct charges. The sources are:

Invoice Totals
Invoice Debits by Fund
Invoice Debits by Fund Tag

These sources are meant to be used as the base source of a report, with any additional fields and tables of interest brought via navigating links in the template editor.

7.10. Miscellaneous

Barcode transfered to new copy in volume editor in Angular interface for fast item add (Bug 1986706)
Fix an issue where auto-renewal events can overwhelm open-ils.trigger drones (Bug 2030915)
Adds a new database view for open non-cataloged circulations: action.open_non_cataloged_circulation (Bug 2019974)
Reimplementation of Cataloging → Link Checker in Angular. Changed a few things hopefully for the better:
- Relabeled URL Verification Attempts to Batches
- Relabeled URL Verifications to Attempts
- Main grid display combines Sessions and Batches.
New Angular linting rules (Bug 1850473)

8. Acknowledgments