1. Upgrade notes

This release includes an import fix to values in the Coded Value Map table. Please refer to the "FIX DB Table config.coded_value_map" section further down for important information on whether you need to apply the fix and how to do so.

2. New Features

2.1. Acquisitions

2.1.1. EDI Attribute Added for Enumerating Lineitems Sequentially

Historically, Evergreen’s EDI output has used the internal lineitem ID as the line sequence number in LIN lines. Some vendors (e.g. ULS) would prefer LIN to use a sequentially assigned number instead. A new EDI attribute, "Lineitems Are Enumerated Sequentially," has been added to support that. See [LP 1949243](https://bugs.launchpad.net/evergreen/+bug/1949243) for further discussion.

2.2. Administration

2.2.1. Add payment type to OPAC printed payment receipt Action Trigger definition

Adds correct payment type to the money.payment_receipt.print action trigger template, replacing the hard-coded "Credit Card".

An upgrade script is include which updates the money.payment_receipt.print action trigger template if it has not been altered from stock.

2.2.2. IMPORTANT: FIX DB Table config.coded_value_map

If your Evergreen database pre-dates version 3.13 and you have executed the DB upgrade (1416) which was included in the Evergreen upgrade files:

  • Open-ILS/src/sql/Pg/version-upgrade/3.12.3-3.13.0-upgrade-db.sql

  • Open-ILS/src/sql/Pg/version-upgrade/1416.data.updated_marc_tag_tables.sql

As described in LP2073561

You have two options:

  1. Use the provided fix SQL script to reset the tables to stock

  2. Use a backup database that you may have pre-3.13 upgrade, and restore these two tables:

    1. config.coded_value_map

    2. config.composite_attr_entry_definition

      Note
      		 You might prefer option 2 if you have customized the coded_value_map for new/different OPAC Icon/Search Formats.
Option 1: Reset the tables to stock

You will need to manually run the provided SQL file:

Important
 Open-ILS/src/sql/Pg/LP2073561.fix.coded.value.map-post_3.13_upgrade.sql

Example:

psql evergreen < Open-ILS/src/sql/Pg/LP2073561.fix.coded.value.map-post_3.13_upgrade.sql

You may need additional options for the psql command depending on your environment.

Option 2: Restore from backup

  1. From the old copy of your database, pre-dating an upgrade to 3.13 

    pg_dump evergreen --data-only --schema config \
--table config.coded_value_map \
--table config.composite_attr_entry_definition \
> ccvm_restore.sql

  2. Copy ccvm_restore.sql to an accessible location on your production database 

    psql evergreen -c "truncate config.coded_value_map CASCADE;"
psql evergreen < ccvm_restore.sql

You may need additional options for the psql and pg_dump commands depending on your environment.

Important
 We highly recommend testing these steps on a non-production database!
Note
 If your Evergreen database started on version 3.13 and above, then you may ignore these instructions.

2.2.3. Reporter Lock File Improvements

Changes in the location, name, and handling of the reporter’s (clark-kent.pl) lockfile may require adjustments in local management scripts.

The lockfile’s default location has been moved from /tmp/reporter-LOCK to LOCALSTATEDIR/run/reporter.pid, /openils/var/run/reporter.pid in a default configuration. This change allows it to fit in better with other Evergeen utilities that use a similar location and name for their runtime files: SIPServer, the MARC stream importer, etc.

If run as a daemon, the reporter now deletes the lockfile when the main process exits. This is not only good disk hygiene; the user or administrator no longer has to manually delete the lockfile before starting a new instance of the reporter.

Sites with scripts to start and stop the reporter may wish to review them to determine if this update requires any changes to their processes.

2.2.4. Global Long-Lived Cache Clearing for Staff Client

A new global flag (staff.client_cache_key) has been added that allows administrators to clear certain long-lived cache values from all staff clients at next login by simply changing the value. Currently only the MARC Tag Tables used by the bibliographic and authority record editors are cleared, but the list of localStorage items cleared may be expanded in future. This key is simply an opaque string - no special format is required - changing the value in any way will trigger a wave of cache clearing.

2.3. Architecture

2.3.1. Evergreen Supports PostgreSQL 17

PostgreSQL 17 can be installed along with Evergreen using the normal prerequisite installation process.

2.4. Cataloging

2.4.1. Batch Edit Parts in the Holdings Editor

The holdings editor now has an option to batch edit bibliographic parts.

2.5. Client

2.5.1. Table Density Setting

Evergreen staff users can now set their preferred density for grids throughout the client. The three options are: compact (not much whitespace), Standard, and Wide (more whitespace).

To select a setting:

  1. Go to Administration → Workstation.

  2. Select a value from the "Table Density" dropdown.

  3. Log out of the staff client and log back in to load the newly selected density setting.

2.6. OPAC

2.6.1. Eresource link click tracking

This version of Evergreen introduces the ability to track user clicks on eresources in the public catalog.

This feature provides usage data on eresources in the catalog. One potential use for this feature is to provide the equivalent of circulation statistics for online course materials.

Data can be accessed via the Evergreen reporter.

Data collection

This feature does not collect any personally identifiable data about the user who clicks on the link. The pieces of data that are collected are:

  • The URL clicked

  • The time it was clicked

  • The bibliographic record that contains the URL.

  • The ID, name, and number of any courses that use the bibliographic record.

Enabling the feature

The new tables can grow forever, so before enabling this feature:

  • Ensure that you are monitoring disk space on the server(s) that house your postgres database.

  • Decide on a retention period for click data, and set up the provided ``delete_old_eresource_link_clicks`` script to delete old data regularly.

To enable this feature:

  1. Set the ``opac.eresources.link_click_tracking`` global flag to true.

  2. Restart memcached and apache HTTP server.

Accuracy

Statistics from this feature are collected on a best efforts basis, and have certain limitations when it comes to accuracy:

  • It does not provide any guarantees against somebody deliberately inflating the statistics of a particular link, either through repeated network calls or repeatedly clicking on a link they don’t actually intend to read.

  • Clicks from certain very old, unsupported browsers (notable Microsoft Internet Explorer) will not be counted.

  • Major bots are excluded, but uncommon bots and bots that set a misleading User Agent header are included unless they are blocked at the web server or load balancer level.

# Library Group Item Counts in catalog

When a user selects a library group in the catalog (either the public catalog or the staff catalog), the catalog now displays the number of items held and available in that group. This information supplements the existing holding statements available in the catalog.

If you have customized any of the following files, you will need to update them to see the library group item counts.

  • opac/parts/misc_util.tt2

  • opac/parts/record/copy_counts.tt2

  • opac/parts/result/copy_counts.tt2

2.6.2. Move the OPAC alert banner to a library setting

Moves the Bootstrap OPAC maintenance message alert banner from the config.tt2 file to a trio of new library settings.

  1. OPAC Alert Banner: Display (true / false)

  2. OPAC Alert Banner: Text (the message that will appear)

  3. OPAC Alert Banner: Type (success, info, warning, danger)

The alert banner types utilize the existing CSS to determine the color scheme.

2.6.3. Move Google Analytics configuration to library settings

Moves the Google Analytics configuration from the config.tt2 file in the Bootstrap OPAC to two new library settings.

  1. Google Analytics: Enable (true/false)

  2. Google Analytics: Code (Analytics account code)

2.7. Miscellaneous

  • Remove deprecated method "open-ils.serial.bib.summary_statements". As an upgrade note, any site that is still keeping the legacy JSPAC running will experience more degradation of its functionality.

  • Make the foreign key relationship between the acq.invoice_item and acq.fund_debit tables deferrable so that fund debits can be deleted when they reference invoice items that are deleted in the same transaction. (LP#2009066)

  • Update test data. (Bug 2081634)

  • Give OPAC users more time before logging out if needed (Bug 1894900)

  • Patron status badges; persistent patron search form labels; Angular Circulation accessibility cleanup (Bug 2065344)

  • Shared depth selector component (Bug 2065344)

  • Angular Circulation notes, alerts, and messages (Bug 2065344)

  • Side navigation for Angular Circulation (Bug 2065344)

  • Fix line item cancellation failure due to undefined volume retrieval. (Bug 2084096)

  • DOB input compatibility for old OPAC self-reg templates (Bug 2084166)

  • Bugfix for record bucket sharing perm check. (Bug 2084835)

  • Patron phone number search includes SMS and default phone numbers (Bug 1823085)

  • Fix a bug that prevented canceling holds from the Holds Shelf interface. (Bug 2085646)

  • Fix installation issue in docker containers.

  • Use opensrf chunk/bundle in additional areas of Evergreen (Bug 1710293)

  • Fix vandelay background importer perl script (Bug 2078506)

  • Removes undefined author links in catalog search results (Bug 2081317)

  • Fixes display conflict on OPAC home screen where autosuggest list appears behind carousel buttons. (Bug 2086709)

  • Redirect to Angular staff portal from AngularJS login (Bug 1983500)

  • Refactor filter handling in search controls for more consistent performance. (Bug 2087609)

  • Fixes an Operator display issue in the report definition editor. (Bug 2084837)

  • .gitignore DEV Docker generated signal files (Bug 2081832)

  • Adds default owning org unit for copy tags and types. (Bug 1721026)

  • Assures a successful Stripe payment is credited when the patron record has changed. (Bug 2077343)

  • Ensure all literary form filters append correct lit_form parameter in queries. (Bug 2087609)

  • Trim spaces from TCN when importing Z39.50 (Bug 2049934)

  • Fixes up/down arrows, CTRL-D, context menus in MARC editor (Bug 2084166)

  • Check for duplicate values and address alerts when loading staged users. (Bug 2046000)

  • Fixes a race condition retrieving the cat.require_call_number_labels ou setting (Bug 2052742)

  • Fixes patron bills error that causes several settings to be skipped when Uncheck Bills setting is used. (Bug 2069358)

  • Fixes report template and CCVM composite definition editor regression introduced during an opimization change. (Bug 2087562)

  • Developers no longer get an error message while checking how much of Evergreen’s staff client code is covered by automated tests (Bug 2062944)

  • Add automated tests and developer documentation for search visibility. (Bug 2067191)

  • Fix alignment of the "Filter value" input in the new reports editor. (Bug 2085970)

  • Fix capitalization of "New template" button in the Angular Reporter (Bug 208702)

  • Improve the release process. (Bug 2089305)

  • [Developer] Have Git enforce consistent line endings on Perl and AsciiDoc files. (Bug 2089390)

  • Angular report template documentation now shown (Bug 2077443)

  • Fix bug that could result in incorrect or incomplete data being fetched from the database, particularly in interfaces that page through results. (Bug 2089419)

  • Prevents reservation screen navigation if reservation confirmation fails. (Bug 2091015)

  • Remove deprecated open-ils.storage.id_list.biblio.record_entry.search.isbn and open-ils.storage.id_list.biblio.record_entry.search.issn methods. (Bug 2067211)

  • Fixes the fund dropdown on invoice direct charges. (Bug 2086786)

  • Remove outdated code from the build process. (Bug 2073532)

  • Stop including partial changelogs in official tarballs. (Bug 2082209)

  • Update booking module documentation with new visuals for better usability.

  • Fix potential failure in database upgrade script. (Bug 2086105)

  • Hides alert box on public catalog holds history page when not needed. (Bug 2092227)

  • Fix the "Add to my list" button in the public catalog (Bug 2092600)

  • Fix the position of the "My List" selection boxes for each title in the public catalog. (Bug 2092589)

  • Correct error message in the actor.create_salt database function (Bug 2093010)

  • Serials quick receive no longer includes issues in non-receivable statuses, such as Discarded or Not Published. (Bug 2091728)

  • In Angular Reports, restrict selectable report filter values by library ownership when applicable and possible. (Bug 2088100)

  • Fixes report template upgrade issues relating to more complex join types in older templates. (Bug 2089066)

  • Fix issues with sorting and filtering the contents of reports folders in the Reports interface. (Bug 2077438)

  • Allow paging through list of report outputs; fixes issue where this could time out in the Angular Reports interface for output folders that have many completed reports. (Bug 2086861)

  • Add a new user interface widget to provide a way for users of the Angular Reporter to select multiple values when filtering a report on a linked field. (Bug 2077357)

  • Prevents | fixed field codes from automatically selecting OPAC advanced search filters (Bug 2080691)

  • Corrects misleading comment explaining vis_level values in offline.js (Bug 2093358)

  • Include status and location in marc_export when determining item visibility in the 852 MARC tag. (Bug 2056343)

  • Fixes typo in AngularJS Booking > Pick Up Reservation (Bug 2095190)

  • Remove noise from the browser developer console. (Bug 2095026)

  • Ensures tag order in the authority.generate_overlay_template function output. (Bug 2088529)

  • Removes the Z39.50 search source autosave to match the previous version of the interface. (Bug 2094284)

  • Remove unused dependency that caused logins to fail. (Bug 2095046)

  • Adds owning and item circulating libraries to hold grids. (Bug 1851721)

  • New installs will now have table actor.usr_mfa_exception (Bug 2095215)

  • Refactor booking module documentation for clarity and updated visuals

  • Fixes Angular Reports duplicating share/unshare buttons. (Bug 2081883)

  • Fixes basket buttons on OPAC item details page (Bug 2093791)

  • Hides SMS test success message until after test is sent. (Bug 2096772)

  • Hides facet options when viewing basket in the staff catalog (Bug 2093108)

  • The Clear Form button on the Import Record from Z39.50 interface now only clears the search fields, not the services and credentials inputs. (Bug 2084348)

  • MARC rich editor special characters map feature (Bug 1555766)

  • Hides canceled holds from holds view (Bug 2091041)

  • Display hold status in Angular Self Check (Bug 2091041)

  • Corrects auto-logout popup button text (Bug 2093903)

  • Adds workstation setting for Monograph Parts grid preferences (Bug 1975852)

  • Refresh line item status and color coding when Purchase order is activated. (Bug 1991801)

  • Use words for Acq PO search Expand|Collapse All button (Bug 2042988)

  • Place holds can retrieve recent patrons. (Bug 2009725)

  • Fixes Retrieve Recent Patrons link (Bug 2091174)

  • Fixes whitespace issue with empty list descriptions in the patron’s lists in their OPAC account. (Bug 2088180)

  • Fix Text/SMS Carrier label type in the Modify Hold’s dialog box. (Bug 2091111)

  • Creates new UPDATE_TOP_OF_QUEUE permission for setting a hold to the top of the queue. (Bug 1949392)

  • Fix borders, wrapped button text in org unit settings grid (Bug 2083725)

  • Adds an Email Receipt option for patrons when paying by credit card (Bug 1988085)

  • Fixes incorrect calculation of the line-item level cost and amount paid that can occur when creating an invoice from a purchase order or a line item. (Bug 2097049)

  • Fixes typo in bibliographic record source in IDL. (Bug 2086227)

  • Patron barcode file uploads in the User Bucket’s Pending User(s) list are now able to retrieve patrons whose barcode value contains embedded spaces. (Bug 2087873)

  • Add class name @Input to org unit selector component. (Bug 2083725)

  • Fixes reporting source Item’s link for last captured hold (Bug 2097281)

  • Remove spellcheck attribute from password fields. (Bug 2002327)

  • Fixes the alignment of the Opac’s Search & History Preference form. (Bug 2097154)

  • Fixes broken select all button on OPAC search results. (Bug 2097384)

  • PCRUD queries for copies can now flesh the open circulation. (Bug 2084694)

  • Fixes bug where user could not add multiple new search rows in OPAC Advanced Search. (Bug 2097131)

  • Fix a bug in calculating item counts within a library group. (Bug 2093846)

  • Add workstation setting for Angular grid UI whitespace (Bug 2087979)

  • Remove outdated dojo dependency from the OPAC shelving location selector (Bug 2060351)

  • Fix OPAC shelving location selector when user chooses a shelving location group. (Bug 2060351)

  • Makes sure checkboxes are still checked on Refine My Original Search. (Bug 2060351)

  • Makes "Clear Form" button on patron search more visible (Bug 2089192)

  • Prevent hold reset entries from blocking hold aging and and user merges and purges (Bug 2097622)

  • Fix an issue in the Shelving Location Group admin screen that caused keyboard focus to disappear. (Bug 2098550)

  • Fixes an issue that caused the "Include items?" option when exporting records from the Record Buckets interface to be ignored. (Bug 2097391)

  • Fix an issue that caused MARC editor interface to change unexpectedly when a record is saved. (Bug 2093128)

  • Improve and reorganize action triggers documentation in admin module

  • [dev] Update the release note extractor so that all lines of a multi-line release notes in a commit message are incuded in the output (Bug 2098814)

  • Add a signal handler to the reporter to log the signal and exit. (Bug 2098994)

  • Display a "Show Invoice in Legacy Interface" in invoices when configured. (Bug 2099133)

  • Restores OPAC ability to set Cancel if not filled by and suspended hold activation dates. (Bug 2097009)

  • Fix inconsistent display of name fields in offline patron registration (Bug 2096865)

  • Restores the ability to select charges for payment in the OPAC. (Bug 2090958)

  • Fixes blank user setting handling in Angular staff catalog place holds. (Bug 2073896)

  • Fix EDI output by adding a field to the FTX line. (Bug 1949243)

  • Fixes undo/redo in MARC rich editor fixed fields and LDR. (Bug 2084929)

  • Sets user email as default for report output email option (Bug 2088096)

  • Retro-fixing config.coded_value_map (Bug 2073561)

  • Allows basic HTML in OPAC alert banner. (Bug 2103646)

  • Fixes inputBlurred() console error for MARC fixed fields (Bug 2084929)

  • Fixes blank screen when logging in after timeout. (Bug 2100807)

  • A new opensrf.xml config file option, honor_secondary_groups, allows secondary group membership to add MFA configuration to a user, in addition to the main profile group. This option defaults to "false", i.e., secondary permission groups are not considered. If the option is turned on, if any permission group associated with the user, including the profile, requires MFA, MFA will be required of the user. (Bug 2080572)

  • Allows staff portal entry links to open new tabs; styling for links that open in new tabs (Bug 2015351)

  • Add workstation setting for opening links in new tabs (Bug 2015351)

  • Clarify what the "name" label in create PO form refers to (Bug 2018839)

  • Implements an OpenAPI server for Evergreen (Bug 2067414)

  • Fix a bug that caused empty search results in the OPAC after changes were made to the organizational unit tree and the autogen script had not yet been run. (Bug 2103630)

  • Added a commit message template to the repository to improve the developer experience. To use the template, run the following command from the root of your Evergreen repostiory: git config commit.template commit-template. (Bug 2051946)

3. Acknowledgments

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

  • C/W MARS

  • ECDI

  • NOBLE

  • PaILS

We would also like to thank the following individuals who contributed code, translations, documentations patches and tests to this release of Evergreen:

  • a. bellenir

  • Andrea Buntz Neiman

  • Bill Erickson

  • Blake Graham-Henderson

  • Carol Witt

  • Chris Sharp

  • Christine Burns

  • Christine Morgan

  • Chrisy Schroth

  • Dan Briem

  • Dan Guarracino

  • Elizabeth Davis

  • Galen Charlton

  • Garry Collum

  • Gina Monti

  • Ian Skelskey

  • Jane Sandberg

  • Jason Boyer

  • Jason Etheridge

  • Jason Stephenson

  • Jeff Davis

  • Jeff Godin

  • Jennifer Pringle

  • Jennifer Weston

  • John Amundson

  • Joni Paxton

  • Josh Stompro

  • Lindsay Stratton

  • Llewellyn Marshall

  • Mary Llewellyn

  • Michele Morgan

  • Mike Rylander

  • Ruth Frasur Davis

  • Scott Angel

  • Shula Link

  • Stephanie Leary

  • Steven Callender

  • Steven Mayo

  • Susan Morrison

  • Tara Kunesh

  • Terran McCanna

  • Tiffany Little

We also thank the following organizations whose employees contributed patches:

  • Bibliomation

  • British Columbia Libraries Cooperative

  • C/W MARS

  • Equinox Open Library Initiative

  • Evergreen Collaborative Development Initiative (ECDI)

  • Georgia Public Library Service (GPLS)

  • Greater Clarks Hill Regional Library

  • Kenton County Public Library

  • King County Library Systems

  • Lake Agassiz Regional Library

  • MOBIUS

  • NC Cardinal

  • OWWL

  • North of Boston Library Exchange (NOBLE)

  • PaILS

  • Princeton University

  • Traverse Area District Library

  • Westchester Library System

We regret any omissions. If a contributor has been inadvertently missed, please open a bug at http://bugs.launchpad.net/evergreen/ with a correction.