Release notes for v4.2.0-RC1

This release contains bug fixes plus some small feature improvements. Bug fixes include correcting an issue with the download of the PDF on the public interface on mobile devices and correcting an issue that prevented setting a user as inactive in the staff interface from some of the views. Small feature improvements include the addition of a configuration to set which fields are included when the Duplicate Resource functionality in the staff interface is used and a new option to exclude URIs from PDFs downloaded from the staff interface. There are also a number of small fixes to improve accessibility, particularly for the public interface.

Configurations and Migrations

This release adds two new configuration options to the configuration file:

1. Resource fields to exclude when duplicating a resource

When duplicating a resource fields are generally copied over from the original resource to the duplicated one. An option to exclude specific fields from resource record duplication is now available. Note: If required resource record fields (e.g. 'level') are added here, they will be ignored.

Example:

AppConfig[:resource_fields_not_to_duplicate] = ['finding_aid_status', 'finding_aid_author']

This configuration option is empty by default, so all fields are included in resource duplication - no changes in behavior since the previous version.

2. Favicon customization

A set of configuration options have been added allowing easy customization of the favicons used on the public and staff user interfaces.

To customize the favicons it is now possible to add png and svg versions of the icons in:

directory: plugins/local/public/assets/images for the public user interface
directory: plugins/local/frontend/assets/images for the staff user interface

and set the corresponding configuration options:

# Public UI:
AppConfig[:pui_png_favicon] = '/assets/images/custom-favicon.png'
AppConfig[:pui_svg_favicon] = '/assets/images/custom-favicon.svg' 

# Staff UI:
AppConfig[:frontend_png_favicon] = 'archivesspace/custom-favicon.png'
AppConfig[:frontend_svg_favicon] = 'archivesspace/custom-favicon.svg'

The standard ArchivesSpace favicon is used by default.

No migrations or solr configuration changes

This release includes no new database migrations. The solr schema and configuration are also not updated.

Solr and Java versions (when using the zip distribution):

Support for Solr 9.9 and Java 21 has been added for this release. Because of upcoming upgrades to our version of jRuby, version 4.2.0 of the application is the last that will support Java 11. If using docker, you do not need to worry about these dependencies.

Plugin considerations:

The standard caution to check plugins before upgrading applies. Due to changes in the rendering of the tree for the Resources read-only page (the show view) in the staff interface, any plugins that modify this feature will likely need to be updated.

Notable dependency updates since v4.1.1 include:

Dependency	v4.1.1	v4.2.0
Bundler	2.5.15	2.6.9
jdbc-mysql	8.0.30	9.1.0.1
Rails	6.1.6	6.1.7.10
rufus-scheduler	2.0.24	3.9.2
rubyzip	1.3.0	3.2.2
write_xlsx	1.01.0	1.12.3
net-ldap	0.16.3	0.20.0
oai	1.2.1	1.3.0

If using plugins with any of the above dependencies, make sure they are tested with v4.2.0 before upgrading your production installation.

Community Contributions

Our thanks go out to these members of the community for their code contributions:

Alexander Duryee:
- Adding modified_since to API docs
Brian Hoffman:
- remove stranded reports code
- Avoid Memory Leaks in Converters
DJ Hayes:
- Fix release badge
Harris Papazoglou:
- ANW-1023: Default Top Container values (#3732)
- ANW-1794: fixes custom report filter to show enum value
- ANW-1802: adds enum fields to user_defined select in custom reports. (#3728)
- ANW-1811: Usage dates on form names (#3545)
- ANW-1903: Provide two Plus One buttons on the Create Batch Locations form (#3725)
- ANW-2101: Translation missing for new values in event_event_type
- ANW-2143: Replaces 'authoritive' and 'authoritative' with 'authorized' on people facing labels (#3724)
- ANW-2199: Fix issues with CSV export (#3710)
- ANW-2217: Fix top container title-with-semicolon bug for PUI pdf export (#3729)
- ANW-2347: Fix translation keys related to top_container_mgmt (#3700)
Jonny Bylsma:
- ANW 2445: Extend launcher to allow log appending
Joshua Shaw:
- Allow Indexer Hooks to access Ancestor data in PUI Index (#3667)
- fix job log wrapping
- Indexer State files for Trees
- add documentation for jobs_with_files endpoint
Laura L. R. Sinhur:
- Translated using Weblate (Ukrainian)
Lora Woodford:
- ANW-2564 Batch Update Location description
- ANW-2546 Add apple-touch-icon to frontend and public (#3789)
- ANW_2494 Remove jquery.kiketable.colsizable.css
- ANW-2476 Set resource fields not to duplicate in AppConfig
- ANW-2459 Do not duplicate ao note persistent_id
Lydia Tang:
- Translated using Weblate (Polish)
Mark Triggs:
- Optimize handling of deletes against Solr (#3702)
Michael Glanznig:
- Translations update from Hosted Weblate (German)
Regine Heberlein:
- ANW-2145 adds two subrecords of the extent record to MARC serialization (#3797)
René Vlak:
- Translations update from Hosted Weblate (Dutch)
Vasilis Chouliaras:
- ANW-1811: Usage dates on form names (#3545)

Total community contributions accepted: 31

JIRA Tickets and Pull Requests Completed

PR: 3957: Translations update from Hosted Weblate (#3957)
PR: 3955 - ANW-2519: ANW-2519 fix delete digital objects spec and accession spawn digital object spec (#3955)
PR: 3964 - ANW-2519: Release v4.2.x
PR: 3964: Release v4.2.x
PR: 3964 - ANW-2607: Release v4.2.x
PR: 3964 - ANW-2330: Release v4.2.x
PR: 3964 - ANW-2616: Release v4.2.x
PR: 3919 - ANW-2610: ANW-2610 build docker images also on release branches
PR: 3916 - ANW-2609: ANW-2609 Don't allow dangerous html tags in mixed content
PR: 3917: Moving E2E documentation to tech docs
PR: 3830 - ANW-1763: ANW-1763: Add "Create and Link" for Related Accessions (#3830)
PR: 3914: Upgrade JS top level dev dependencies
PR: 3901 - ANW-1682: ANW-1682: Add skip to main content link in Staff User Interface (SUI) (#3901)
PR: 3907 - ANW-2187: ANW-2187 Fix missing translation for revision_statement option in staff batch find and replace select menu
PR: 3906: Translations update from Hosted Weblate (#3906)
PR: 3903: Translations update from Hosted Weblate (#3903)
PR: 3904: Translations update from Hosted Weblate (#3904)
PR: 3905: Translations update from Hosted Weblate (#3905)
PR: 3909: Translations update from Hosted Weblate
PR: 3910: Translations update from Hosted Weblate
PR: 3911: Translations update from Hosted Weblate
PR: 3908: Translations update from Hosted Weblate
PR: 3902: Translations update from Hosted Weblate (#3902)
PR: 3899 - ANW-2592: ANW-2592 Move PUI facets badge counts to enable screen reader access (#3899)
PR: 3876 - ANW-2589: ANW-2589 Fix ARIA bugs in linkers across record types
PR: 3897 ...

Release notes for v4.1.1

This patch release contains a very small number of bug fixes and improvements. The main fix is to an issue in the public interface that caused mixed content in notes that was surfaced by the search terms in context feature not to display and affect other results.

Configurations and Migrations

This release contains no modifications to the configuration defaults file.

This release includes 0 new database migrations. The schema number for this release is UNCHANGED.

Solr Schema

The Solr schema has changed. A rebuild and reindex of the Solr core will be required:

+        <charFilter class="solr.HTMLStripCharFilterFactory" />

If you are using the Docker configuration package, see: Upgrading with Docker and Solr Schema changes.

If you are using the standard zip distribution, see: Upgrading using the zip distribution.

Community Contributions

Our thanks go out to these members of the community for their code contributions:

Brian Hoffman:
- Delete URI from Revision Statement Schema
Laura L. R. Sinhur:
- Ukrainian translations from Weblate
Rubina Bazzani:
- Italian translations from Weblate
Vasilis Chouliaras:
- ANW-1998: Make Classifications Reorder Mode consistent with others (#3562)

Total community contributions accepted: 4

JIRA Tickets and Pull Requests Completed

PR: 3561 - ANW-2384: ANW-2384 WIP fix release notes generation
PR: 3647: fix indentation error
PR: 3646 - ANW-2406: ANW-2406 build separate metadata for each image type
PR: 3640: disable github workflows
PR: 3638: Update README.md
PR: 3637 - ANW-2406: ANW-2406 return empty ticket if not included in branch name (for exam…
PR: 3636 - ANW-2406: ANW-2406 fix image names
PR: 3615 - ANW-2406: ANW-2406 use docker metadata action to generate docker tags (#3615)
PR: 3635: Translations update from Hosted Weblate
PR: 3634: Translations update from Hosted Weblate
PR: 3631: Translations update from Hosted Weblate
PR: 3632: Translations update from Hosted Weblate
PR: 3633: Translations update from Hosted Weblate
PR: 3629 - ANW-2418: Anw 2418 strip tags while indexing
PR: 3629: Anw 2418 strip tags while indexing
PR: 3628 - ANW-2417: ANW-2417: Fix staff readonly display of notes with mixed content
PR: 3626: Translations update from Hosted Weblate
PR: 3625: Translations update from Hosted Weblate
PR: 3624: Translations update from Hosted Weblate
PR: 3621: Translations update from Hosted Weblate
PR: 3620: Translations update from Hosted Weblate
PR: 3619 - ANW-2407: ANW-2407 Handle mixed content in PUI search results highlighting
PR: 3618: Translations update from Hosted Weblate
PR: 3616: Translations update from Hosted Weblate
PR: 3611: coveralls conf remove spaces from carryforward parameter in workflow …
PR: 3610 - ANW-2406: ANW-2406: add GitHub Actions workflow for building and pushing Docker…
PR: 3609: Translations update from Hosted Weblate
PR: 3608: Translations update from Hosted Weblate
PR: 3607: Translations update from Hosted Weblate
PR: 3606: Translations update from Hosted Weblate
PR: 3605: Update help.yml
PR: 3602 - ANW-2401: ANW-2401 remove config overrides from docker env to avoid confusion
PR: 3603 - ANW-2393: ANW-2393: Correcting some issues with the context-sensitive help for custom report templates
PR: 3600: ci(github-actions): update workflow to trigger on all branches for pu…
PR: 3599: e2e tests workflow integration
PR: 3598: fix flakky groups spec
PR: 3597: Translations update from Hosted Weblate
PR: 3596: Translations update from Hosted Weblate
PR: 3595: Translations update from Hosted Weblate
PR: 3593: Translations update from Hosted Weblate
PR: 3592: Add e2e tests workflow
PR: 3586: End to end test with Cucumber
PR: 3584: Delete URI from Revision Statement Schema
PR: 3583: Translations update from Hosted Weblate
PR: 3582: Translations update from Hosted Weblate
PR: 3577: Translations update from Hosted Weblate (#3577)
PR: 3578: enums translated using Weblate (Italian) (#3578)
PR: 3576: Translations update from Hosted Weblate (#3576)
PR: 3573: Translations update from Hosted Weblate (#3573)
PR: 3479 - ANW-2276: ANW-2276 fix test coverage reports, integrate coveralls (#3479)
PR: 3566: Translations update from Hosted Weblate
PR: 3565: Translations update from Hosted Weblate
PR: 3564: Translations update from Hosted Weblate
PR: 3562 - ANW-1998: ANW-1998: Make Classifications Reorder Mode consistent with others (#3562)
PR: 3560: Translations update from Hosted Weblate
PR: 3559: Translations update from Hosted Weblate
PR: 3557: Translations update from Hosted Weblate
PR: 3558: Translations update from Hosted Weblate
PR: 3554: Translations update from Hosted Weblate

Total Pull Requests accepted: 58
Total Jira Tickets closed: 10

@marktriggs

Release notes for v4.1.0

This release contains bug fixes and small feature improvements. Bug fixes include addressing issues with some mixed context in the staff or public interface, including a bug that prevented text tagged with <title> from displaying in the public interface; getting rid of translation errors in the search highlighting in the public interface; restoring datepicker visual focus in the staff interface; restoring the formatting of print styles for records, including accessions; and addressing a memory leak issue experienced when using some kinds of plugins. Small improvements include a new button in the public interface to print a collection's finding aid from any of its archival objects.

Configurations and Migrations

This release includes one modification to the configuration defaults file:

+# Default search scope setting
+# Options: 'all_record_types', 'collections_only'
+AppConfig[:search_default_scope] = 'all_record_types'

This release includes 0 new database migrations. The schema number for this release is UNCHANGED.

Solr Schema

The Solr schema has changed:

-    <dynamicField name="*_relator_sort" type="sort_string" indexed="true" stored="true" multiValued="false" />

A rebuild and reindex of the Solr core will be required.

Note to Plugin Users and Maintainers:

This release includes changing from render :inline to render :template for rendering plugin partial views. This will not affect the functionality of most plugins, but we still recommend testing your plugins after updating.

As discovered by @marktriggs, the render :inline used in the initial release of ArchivesSpace 4.0 creates a memory leak for instances that are running plugins with specific partials. See the corresponding Pull Request for more details.

Credits to @marktriggs and @jdshaw for this fix!

Community Contributions

Our thanks go out to these members of the community for their code contributions:

Blake Carver:
- Changes to user_defined date help wording
- Fix missing locales (#3380)
- ANW-2273: Fix missing enum instance_type_enum_s on highlighting (#3480)
Brian Harrington:
- ANW-2368: Fix daogrp issues in staff PDF export
Brian Hoffman:
- Remove Dynamic _relator_sort Fields from Solr Schema
- Remove Required Field Templates for Notes
- Fix controlled value lists translation column
Corey Schmidt:
- Add Python and Shell examples to group.rb endpoints
Joshua Shaw:
- Fix Plugin Partial Render Memory Leak (#3512)
- ANW-2270: Fix Archival Object accession linker prelinker bug(#3471)
Laura L. R. Sinhur:
- Ukrainian translations from Weblate
Lora Woodford:
- ANW-2245: Ensure imported subjects are valid on EAD export (#3455)
Mark Triggs:
- Improve handling of non-existent import template
Rubina Bazzani:
- Italian translations from Weblate
Vasilis Chouliaras:
- ANW-773: Add download PDF button to PUI archival object views (#3459)
- ANW-1080: Adjust default search options in Public UI
- ANW-1351: Handle error on preference page without a repository
- ANW-1499: Fix accession reports "total_count" field calculation
- ANW-1505: Add partial/whole extent in PUI (#3383)
- ANW-1610: Add About field on repos list
- ANW-2029: Missing translation for date label
- ANW-2228: Add Help links to Bulk AO Updater (#3498)

Total community contributions accepted: 22

JIRA Tickets and Pull Requests Completed

PR: 3552: Remove duplicate gem versions
PR: 3551: Translations update from Hosted Weblate
PR: 3550: Translations update from Hosted Weblate
PR: 3549 - ANW-2377: ANW-2377: Adjust frontend drag handle design
PR: 3548 - ANW-2353: ANW-2353 Fix mixed content display in toolbars across record types
PR: 3547 - ANW-2353: ANW-2353: Remove old spec that has been replaced by newer spec
PR: 3543 - ANW-2353: ANW-2353 Fix more mixed content in display of record titles
PR: 3544: Translations update from Hosted Weblate
PR: 3542: fix locale files
PR: 3539: Translations update from Hosted Weblate
PR: 3541: Translations update from Hosted Weblate
PR: 3540: Translations update from Hosted Weblate
PR: 3537 - ANW-2353: ANW-2353: Fix more mixed content display bugs and add spec
PR: 3538 - ANW-2344: ANW-2344 Fix PUI notes displays and Softserv blockquote styles
PR: 3533 - ANW-2232: ANW-2232 fix and re-enable accessibility specs
PR: 3534 - ANW-2353: ANW-2353: Fix more mixed content bugs in frontend and public
PR: 3530 - ANW-2366: ANW-2366 Make Agent Required Fields form consistent with their counterpart Agent form
PR: 3512: Fixes Plugin Partial Render Memory Leak (#3512)
PR: 3526 - ANW-2363: ANW-2363: Enable lightmode on Agent Required Fields form
PR: 3525 - ANW-2362: ANW-2362: Fix frontend date picker
PR: 3524: Translations update from Hosted Weblate
PR: 3519 - ANW-2355: ANW-2355 Fix agents required forms
PR: 3516 - ANW-1844: ANW-1844: Render request modal conditionally based on pui_page_actions_request
PR: 3522: Improve handling of non-existent import template
PR: 3520 - ANW-2361: ANW-2361 - Put back intended uses of the word "target"
PR: 3518 - ANW-2334: ANW-2334: Add bibliography notes to PUI pdf generation
PR: 3498 - ANW-2228: ANW-2228 Adds Help links to Bulk AO Updater (#3498)
PR: 3484: Translations update from Hosted Weblate
PR: 3510: Translations update from Hosted Weblate
PR: 3514: Translations update from Hosted Weblate
PR: 3509 - ANW-2353: ANW-2353: Fix mixed content handling across public and frontend
PR: 3486: Translations update from Hosted Weblate
PR: 3511: changes user_defined date help wording
PR: 3506 - ANW-2349: ANW-2349: Update PUI print styles for the Softserv updates
PR: 3503 - ANW-2333: ANW-2333: Move PUI font awesome files from vendor to app/assets
PR: 3501 - ANW-2336: ANW-2336: Improve frontend print styles
PR: 3500: prefix setup for development
PR: 3499 - ANW-2029: ANW-2029: Missing translation for date label
PR: 3483: Translations update from Hosted Weblate
PR: 3487: Remove Dynamic _relator_sort Fields from Solr Schema
PR: [3492](https://github.com/archivesspace/archivess...

Release notes for v4.0.0

This release includes major upgrades to the technical infrastructure of the application, including newer versions of Bootstrap, Rails, JRuby, jQuery, and Jetty. The staff application's css has been migrated from less to sass, and Nokogiri and Sequel are also now on more recent versions. Many gems have been updated and specs have been ported to capybara. Beyond formatting changes necessitated by the Bootstrap upgrade, many of these changes will not be particularly noticeable for users of the application, but they represent significant progress for the ArchivesSpace tech stack and will put us in a better position for future development.

There are also useful functionality improvements for users of the interfaces of the application on both the public and staff side. On the public side, aligning with recommendations made by the Usability sub-team, there is now a configuration to move the collection organization sidebar to the right or left of the page. There is also an option to load all of the associated children for a resource at once rather than working through the infinite scroll. Search terms are now highlighted in many types of results and a bug that caused extra lines to be introduced for some notes in the public interface display has also been addressed.

On the staff side, the functionality of the very popular bulk updater plugin developed by Hudson Molonglo for The New School is now part of the core application. Some additional time savers are options to duplicate a full resource record or archival object record, additions to the spreadsheet importers, and a new option to download a partially completed spreadsheet of digital object information.

We have also launched a new technical documentation site - we welcome feedback and suggestions for additional documentation. (For now both the old and new site are live.)

Docker support

Starting with this release, we support Docker as the recommended way to get ArchivesSpace up and running - see our Running on Docker documentation.

Configurations and Migrations

This release includes several modifications to the configuration defaults file:

+AppConfig[:pui_show_favicon] = true # whether or not to show a favicon
+AppConfig[:frontend_show_favicon] = true # whether or not to show a favicon

+# Where to position the PUI Collection Organization sidebar
+# Options: 'left' or 'right'
+AppConfig[:pui_collection_org_sidebar_position] = 'left'

-#The number of characters to truncate before showing the 'Read More' link on notes
-AppConfig[:pui_readmore_max_characters] = 450
+# The number of characters to truncate before showing the 'Read More' link on notes
+AppConfig[:pui_readmore_max_characters] = 1000

+# Allow users with the 'administer_system' role to view the system_info route (e.g., FRONTEND_BASE_URL/system_info)
+# By default, this route is only accessible to the 'admin' user, and no other admins.
+AppConfig[:allow_other_admins_access_to_system_info] = false

+# If enabled, the importer will drop subrecords (dates, extents, instances or
+# notes) when all spreadsheet columns for that existing subrecord have no values.
+# As not all subrecord fields have a corresponding column in the spreadsheet, you
+# may unwittingly drop a subrecord which has data in other fields.
+AppConfig[:bulk_archival_object_updater_apply_deletes] = false
+# By default, the importer will throw an error when it finds a top container
+# in the spreadsheet that is not attached within the current resource's hierarchy.
+# When enabled, those missing top containers are created on demand.
+# This configuration setting can be overridden by providing a
+# `create_missing_top_containers` parameter to the import job.
+AppConfig[:bulk_archival_object_updater_create_missing_top_containers] = false

This release includes 0 new database migrations. The schema number for this release is UNCHANGED.

Other Considerations

Because of changes that were needed for some of the other infrastructure upgrades, we are no longer able to support Java 8 as of this version. Please upgrade to Java 11 or 17 to continue using ArchivesSpace from version 4.0.0 forward. More information about supported versions is on our Getting Started page.

Solr v9 is required to run ArchivesSpace version 4.0.0. See the Upgrading Solr documentation for more details. We specifically recommend Solr 9.4.1.

Because of the many upgrades to the dependencies of ArchivesSpace as of this version, we strongly encourage you to check your plugins before upgrading.

Breaking change of OAI identifiers:

We have upgraded the oai gem to version v1.0.0. Oai identifiers are now being generated/expected with a colon between namespace and prefix, rather than slash.
So oai URIs that used to look like:

/oai?verb=GetRecord&identifier=oai:archivesspace/#{@test_resource_record}&metadataPrefix=oai_dcterms

now become:

/oai?verb=GetRecord&identifier=oai:archivesspace:{Resource ID}&metadataPrefix=oai_dcterms

This is now in conformance with oai-pmh guidelines, more about it in the oai gem release notes.

Community Contributions

Our thanks go out to these members of the community for their code contributions:

Alexander Duryee:
- ANW-2015 export leading mixed content in revisiondesc (#3304)
Andrew Morrison:
- Anw-1846 relabel group permissions
Blake Carver:
- Fix missing locales (#3380)
- fix email_perform_deliveries config alias
- Set additional file version links to target=new
Brian Hoffman:
- Revert "Use the hash syntax when translating enumeration values in the listing."
- test that ISO-639 controlled value list displays translated labels
- Ensure Gem Group Exclusion Works By Setting BUNDLE_APP_CONFIG (#3422)
James Bullen:
- give the sidebar a flex-column class so that plugin footers render under rather than beside the other sidebar entries
Joshua Shaw:
- HTML Language Declaration
- Core Code Plugin Support - Changes for 4.0 (#3329)
Kristina Spurgin:
- ANW-2113 Don't create pre-1970 authority record creation event_dates
Laney McGlohon:
- Bulk Updater plugin conversion to core code
Lora Woodford:
- ANW-2206 Do not show external repo warning for global records
- ANW-2107 Allow owner repo to be imported via CSV (#3275)
Manny Rodriguez:
- ANW-1075: Better error messages for PUI PDF errors
- ANW-799: allow users with admin privs access to system_information page
Mark Cooper
- updates for Solr and Java 17
Martin Lovell:
- Ignore AppConfig[:limit_csv_fields] unless the params[:dt] == 'csv'
Vasilis Chouliaras:
- ANW-972: Change label of pdf icon in PUI
- ANW-1799: Modify date calculator to handle child OA
- ANW-1773: Singluar and Plural on PUI digital objects
- ANW-1780: Display hyperlinks in classification description on PUI
- ANW-1571: Modify record groups display for collections to match hyperlinks common design

The Hudson Molonglo team wrote the original code for the bulk updater functionality as a plugin for The New School.

Total community contributions accepted: 76

JIRA Tickets and Pull Requests Completed

PR: 3422: Ensure Gem Group Exclusion Works By Setting BUNDLE_APP_CONFIG (#3422)
PR: 3411: fix api docs generation (#3411)
PR: 3404: add debug messages in release notes building
PR: 3403: fix merge terminology locales on release-v4.0.x branch
PR: 3401: Merge from master
PR: 3401 - ANW-2162: Merge from master
PR: 3395: Latest from master
PR: 3395 - ANW-2215: Latest from master
PR: 3395 - ANW-2169: Latest from master
PR: 3380: Fix missing locales (#3380)
PR: 3304 - ANW-2015: ANW-2015 export leading mixed content in revisiondesc (#3304)
PR: 3275 - ANW-2107: ANW-2107 Allow owner repo to be imported via CSV (#3275)
PR: 3368 - ANW-2186: ANW-2186 add logging (#3368)
PR: 3365: fix +1 Event stuff (#3365)
PR: 3367 - ANW-2157: ANW-2157 Skip asset pipeline for PUI favicon (#3367)
PR: 3329: Core Code Plugin Support - Changes for 4.0 (#3329)
PR: [3340](https://github.com/archivesspac...

Release notes for v4.0.0-RC1

This release candidate includes major upgrades to the technical infrastructure of the application, including newer versions of Bootstrap, Rails, JRuby, jQuery, and Jetty. The staff application's css has been migrated from less to sass, and Nokogiri and Sequel are also now on more recent versions. Many gems have been updated and specs have been ported to capybara. Beyond formatting changes necessitated by the Bootstrap upgrade, many of these changes will not be particularly noticeable for users of the application, but they represent significant progress for the ArchivesSpace tech stack and will put us in a better position for future development.

There are also useful functionality improvements for users of the interfaces of the application on both the public and staff side. On the public side, aligning with recommendations made by the Usability sub-team, there is now a configuration to move the collection organization sidebar to the right or left of the page. There is also an option to load all of the associated children for a resource at once rather than working through the infinite scroll. Search terms are now highlighted in many types of results and a bug that caused extra lines to be introduced for some notes in the public interface display has also been addressed.

On the staff side, the functionality of the very popular bulk updater plugin developed by Hudson Molonglo for The New School is now part of the core application. Some additional time savers are options to duplicate a full resource record or archival object record, additions to the spreadsheet importers, and a new option to download a partially completed spreadsheet of digital object information.

We have also launched a new technical documentation site - we welcome feedback and suggestions for additional documentation. (For now both the old and new site are live.)

Configurations and Migrations

This release includes several modifications to the configuration defaults file:

+AppConfig[:pui_show_favicon] = true # whether or not to show a favicon
+AppConfig[:frontend_show_favicon] = true # whether or not to show a favicon

+# Where to position the PUI Collection Organization sidebar
+# Options: 'left' or 'right'
+AppConfig[:pui_collection_org_sidebar_position] = 'left'

-#The number of characters to truncate before showing the 'Read More' link on notes
-AppConfig[:pui_readmore_max_characters] = 450
+# The number of characters to truncate before showing the 'Read More' link on notes
+AppConfig[:pui_readmore_max_characters] = 1000

+# Allow users with the 'administer_system' role to view the system_info route (e.g., FRONTEND_BASE_URL/system_info)
+# By default, this route is only accessible to the 'admin' user, and no other admins.
+AppConfig[:allow_other_admins_access_to_system_info] = false

+# If enabled, the importer will drop subrecords (dates, extents, instances or
+# notes) when all spreadsheet columns for that existing subrecord have no values.
+# As not all subrecord fields have a corresponding column in the spreadsheet, you
+# may unwittingly drop a subrecord which has data in other fields.
+AppConfig[:bulk_archival_object_updater_apply_deletes] = false
+# By default, the importer will throw an error when it finds a top container
+# in the spreadsheet that is not attached within the current resource's hierarchy.
+# When enabled, those missing top containers are created on demand.
+# This configuration setting can be overridden by providing a
+# `create_missing_top_containers` parameter to the import job.
+AppConfig[:bulk_archival_object_updater_create_missing_top_containers] = false

This release includes 0 new database migrations. The schema number for this release is UNCHANGED.

Other Considerations

Because of changes that were needed for some of the other infrastructure upgrades, we are no longer able to support Java 8 as of this version. Please upgrade to Java 11 or 17 to continue using ArchivesSpace from version 4.0.0 forward. More information about supported versions is on our Getting Started page.

Because of the many upgrades to the dependencies of ArchivesSpace as of this version, we strongly encourage you to check your plugins as part of testing this release candidate.

Breaking change of OAI identifiers:

We have upgraded the oai gem to version v1.0.0. Oai identifiers are now being generated/expected with a colon between namespace and prefix, rather than slash.
So oai URIs that used to look like:

/oai?verb=GetRecord&identifier=oai:archivesspace/#{@test_resource_record}&metadataPrefix=oai_dcterms

now become:

/oai?verb=GetRecord&identifier=oai:archivesspace:{Resource ID}&metadataPrefix=oai_dcterms

This is now in conformance with oai-pmh guidelines, more about it in the oai gem release notes.

Community Contributions

Our thanks go out to these members of the community for their code contributions:

Alexander Duryee:
- ANW-2015 export leading mixed content in revisiondesc (#3304)
Andrew Morrison:
- ANW-1846 relabel group permissions
Blake Carver:
- Fix missing locales (#3380)
- fix email_perform_deliveries config alias
- Set additional file version links to target=new
Joshua Shaw:
- HTML Language Declaration
- Core Code Plugin Support - Changes for 4.0 (#3329)
Laney McGlohon:
- Bulk Updater plugin conversion to core code
Lora Woodford:
- ANW-2206 Do not show external repo warning for global records
- ANW-2107 Allow owner repo to be imported via CSV (#3275)
Manny Rodriguez:
- ANW-1075: Better error messages for PUI PDF errors
- ANW-799: allow users with admin priviledges access to system_information page
Mark Cooper:
- updates for Solr and java 17
Martin Lovell:
- Ignore AppConfig[:limit_csv_fields] unless the params[:dt] == 'csv'
Vasilis Chouliaras:
- ANW-1571: Modify record groups display for collections to match hyperlinks common design

The Hudson Molonglo team wrote the original code for the bulk updater functionality as a plugin for The New School.

Total community contributions accepted: 57

JIRA Tickets and Pull Requests Completed

PR: 3401 - ANW-2162: Extraneous buttons appear for adding more right statements after the first rights statement is saved
PR: 3395 - ANW-2215: Tooltips for some agent fields/labels pulse sometimes rather than staying open until the mouse is moved or the tooltip is clicked
PR: 3395 - ANW-2169: Summary of WAVE tool-detectable accessibility errors with staff interface post-upgrades
PR: 3380: Fix missing locales (#3380)
PR: 3368 - ANW-2186: ANW-2186 add logging (#3368)
PR: 3365: fix +1 Event bug (#3365)
PR: 3367 - ANW-2157: ANW-2157 Skip asset pipeline for PUI favicon (#3367)
PR: 3329: Core Code Plugin Support - Changes for 4.0 (#3329)
PR: 3340 - ANW-2064: ANW-2064 preserve roles from merged agents (#3340)
PR: 3322 - ANW-2031: ANW-2031 Update Staff PDF archival object component unique identifier
PR: 3319 - ANW-2147: ANW-2147: Fix report label and value layouts
PR: 3318 - ANW-2148: ANW-2149, ANW-2148: Fix frontend missing badge styles
PR: 3318 - ANW-2149: ANW-2149, ANW-2148: Fix frontend missing badge styles
PR: 3317 - ANW-2084: ANW-2084: Fix Agent Type label layout
PR: 3314 - ANW-2044: ANW-2044 Staff PDF archival object component unique identifier
PR: 3312 - ANW-2087: ANW-2087 Include archival object component unique identifier in PDFs gererated on PUI
PR: 3310: Merge fixes to release branch
PR: 3310 - ANW-2126: Merge fixes to release branch
PR: 3304 - ANW-2015: A...

Release notes for v3.5.1

This patch release addresses three issues introduced in recent releases.

Undoes the inadvertent change of some URLs from http to https for EAD and some other exports.
Adds an option on EAD exports to include/not include URIs as a unitid.
Adds back support for proxy prefixes for the public interface.

Configurations and Migrations

This release includes one modification to the configuration defaults file:

-# alternate example:  AppConfig[:oai_ead_options] = { :include_daos => true, :use_numbered_c_tags => true }
+# Example: AppConfig[:oai_ead_options] = { :include_daos => true, :use_numbered_c_tags => true, :include_uris => false }

This release includes 0 new database migrations. The schema number for this release is UNCHANGED.

Other Considerations:

EAD export plugins or OAI harvests will need to take into account the additional option to include/exclude URIs as unitids

Community Contributions

Our thanks go out to these members of the community for their code contributions:

Brian Harrington: Replace https in XML namespaces with http
Andrew Morrison: plugin upon which the option to exclude URIs from EAD exports was based

Total community contributions accepted: 2

JIRA Tickets and Pull Requests Completed

PR: 3253: V3.5.1 patch, incorporating:
-- ANW-2025 Replace https in XML namespaces with http
-- ANW-1843 Exclude URIs from EAD export
-- ANW-2000 account for potential app proxy prefix in IR code
-- ANW-2077 fix error on previous conflict resolution while merging: #3288
-- fix specs for #3194
-- regenerate OAI test fixture that was having issues

@quoideneuf

Release notes for v3.5.0

This release includes bug fixes and feature enhancements. For staff interface users, some of the most significant may be the ability to set column preferences for the Manage Top Containers area, reset passwords (when the feature is enabled by the system administrator), and a small redesign and bug fixes for reorder mode. For public interface users, this release includes some improvements to scrolling and performance of the Collection Organization section on resource records, which are the first in a group of usability improvements planned for future releases. Users will likely also welcome formatting changes made primarily to the public PDF to make the staff and public side PDFs more consistent with each other.

For developers and systems administrators, please note that while we are evaluating removing support for Java 8 in the near future, support for Java 8 will continue with 3.5.0. This release also includes a fix for handling changeovers to/from Daylight Saving Time.

Configurations and Migrations

This release includes several modifications to the configuration defaults file:

New configurations

+AppConfig[:db_pool_timeout] = 5 # number of seconds to wait before raising a PoolTimeout error

+# Set the font used to generate PDFs in the PUI
+AppConfig[:pui_pdf_font_files] = ["KurintoText-Rg.ttf",
+                                  "KurintoText-Bd.ttf",
+                                  "KurintoText-It.ttf",
+                                  "KurintoTextJP-Rg.ttf",
+                                  "KurintoTextJP-Bd.ttf",
+                                  "KurintoTextJP-It.ttf",
+                                  "KurintoTextKR-Rg.ttf",
+                                  "KurintoTextKR-Bd.ttf",
+                                  "KurintoTextKR-It.ttf",
+                                  "KurintoTextSC-Rg.ttf",
+                                  "KurintoTextSC-Bd.ttf",
+                                  "KurintoTextSC-It.ttf",
+                                  "NotoSerif-Regular.ttf",
+                                  "NotoSerif-Bold.ttf",
+                                  "NotoSerif-Italic.ttf"]
+AppConfig[:pui_pdf_font_name] = "Kurinto Text,Kurinto Text JP,Kurinto Text KR,Kurinto Text SC,Noto Serif"
+AppConfig[:pui_pdf_paragraph_line_height] = "125%"
+AppConfig[:pui_pdf_title_line_height] = "140%"

+# Password recovery - requires email configuration
+AppConfig[:allow_password_reset] = false

Renamed configurations for email (used for request and new password reset functionality)

-# AppConfig[:pui_email_delivery_method] = :sendmail
-# AppConfig[:pui_email_sendmail_settings] = {
-#AppConfig[:pui_email_perform_deliveries] = true
-#AppConfig[:pui_email_raise_delivery_errors] = true
-#AppConfig[:pui_email_delivery_method] = :smtp
-#AppConfig[:pui_email_smtp_settings] = {
-#AppConfig[:pui_email_perform_deliveries] = true
-#AppConfig[:pui_email_raise_delivery_errors] = true

renamed to

+AppConfig[:global_email_from_address] = "[email protected]"
+# AppConfig[:email_delivery_method] = :sendmail
+# AppConfig[:email_sendmail_settings] = {
+#AppConfig[:email_perform_deliveries] = true
+#AppConfig[:email_raise_delivery_errors] = true
+#AppConfig[:email_delivery_method] = :smtp
+#AppConfig[:email_smtp_settings] = {
+#AppConfig[:email_perform_deliveries] = true
+#AppConfig[:email_raise_delivery_errors] = true

This release includes 3 new database migrations. The schema number for this release is 175.

Solr Schema

The Solr schema has changed. A rebuild and reindex of the Solr core will be required:

-<schema name="archivesspace" version="1.5">
+<schema name="archivesspace" version="1.6">

-    <field name="fullrecord" type="text_general" indexed="true" stored="false" multiValued="false" />
+    <field name="fullrecord" type="text_general" indexed="true" stored="false" multiValued="true" />
+    <field name="fullrecord_published" type="text_general" indexed="true" stored="false" multiValued="true" />
+    <copyField source="fullrecord_published" dest="fullrecord" />

-    <field name="notes" type="text_general" indexed="true" stored="true" multiValued="false" />
+    <!-- why are notes stored? (public app gets them from json for display) probably to support highlighting a long time ago -->
+    <!-- https://github.com/archivesspace/archivesspace/commit/87b7270f11456e0db329c45404333a1ce68419b8 -->
+    <field name="notes" type="text_general" indexed="true" stored="true" multiValued="true" />
+    <field name="notes_published" type="text_general" indexed="true" stored="true" multiValued="true" />
+    <copyField source="notes_published" dest="notes" />

+    <field name="linked_record_titles" type="string" indexed="true" stored="true" multiValued="true" />

Community Contributions

Our thanks go out to these members of the community for their code contributions:

Andrew Morrison

ANW-1341: Display user-friendly message when trying to delete an agent linked to a user
ANW-1800: Add a "find_by_id" API endpoint for top containers
Fix agents plugin support in staff interface
Do not set up PUI routes for handling slug-based URLs if use_human_readable_urls is false
Indexer efficiency improvements and fixes
Do not re-index records in private repositories unnecessarily
Add EAD export hooks to allow plugins to add extra information in child elements of origination and controlaccess

Joshua Shaw

Plugins can add to top of body in PUI
Plugin addition to PUI welcome

Garrett Armstrong

Fix mismatch between docker-compose & ./proxy/Dockerfile ARG

Mark Triggs

Adjust handling of UTC date conversion to avoid problems around DST

Sam Sciolla

Add variable substition to solrconfig.xml for indexConfig/lockType

Valerie Addonizio

Typo in en.yml

JIRA Tickets and Pull Requests Completed

catch PRs merged with GH squash option and add section for Solr schem… by @quoideneuf in #2994
ANW-504: adding support for marking agent links as primary by @avatar382 in #2991
Plugins can add to top of body in PUI by @jdshaw in #2998
Translations update from Hosted Weblate by @weblate in #3004
Translations update from Hosted Weblate by @weblate in #3003
ANW-1599: only display help text on top container search form if multiselect is… by @avatar382 in #2975
ANW-1075: Update PUI PDF output to support foreign language characters by @avatar382 in #2961
ANW-1715: fix digital object classification term links by @mark-cooper in #2968
ANW-1450: include physoc note labels in all EAD and PDF exports by @avatar382 in #2970
ANW-625: Refactor staff drag and drop modal as toolbar buttons by @brianzelip in #2974
ANW-332: Adding option to sort search results by identifier in PUI by @avatar382 in #3002
ANW-258: Updates to Staff and PUI PDF generation by @avatar382 in #2901
ANW-1477 allow users to recover / reset password by @quoideneuf in #2979
ANW-1690 ensure record link after +1 event by @donaldjosephsmith in #2980
Update docker startup script by @mark-cooper in #3029
Translations update from Hosted Weblate by @weblate in #3026
Plugin addition to PUI welcome - fix by @jdshaw in #3017
ANW-1229 Sequel DST timestamp fix by @donaldjosephsmith in #2973
Fix release notes and release config export by @quoideneuf in #3005
ANW-1734 add support for representative DO imports by @donaldjosephsmith in #3034
ANW-1101 use column prefs for top container listing by @donaldjosephsmith in #3010
Translations update from Hosted Weblate by @weblate in #3040
Return display string in compact resource respresentations by @mark-cooper in #3041
ANW-1450: porting over physloc work in PUI PDF from ANW-258 branch by @avatar382 in #3048
ANW-1477 Password reset fixes/updates by @donaldjosephsmith in #3049
Devcontainer: install gems directly as final step by @mark-cooper in #3042
Translations update from Hosted Weblate by @weblate in #3038
Translations update from Hosted Weblate by @weblate in #3027
Fix agents plugin support in staff interface by @andrew-morrison in #3046
Translations update from Hosted Weblate by @weblate in #3028
ANW-1341: Display user-friendly message when trying to delete an agent linked to a user by @A...

@quoideneuf

Release notes for v3.5.0-RC1

This release candidate includes bug fixes and feature enhancements. For staff interface users, some of the most significant may be the ability to set column preferences for the Manage Top Containers area, reset passwords (when the feature is enabled by the system administrator), and a small redesign and bug fixes for reorder mode. For public interface users, this release includes some improvements to scrolling and performance of the Collection Organization section on resource records, which are the first in a group of usability improvements planned for future releases. Users will likely also welcome formatting changes made primarily to the public PDF to make the staff and public side PDFs more consistent with each other.

For developers and systems administrators, please note that while we are evaluating removing support for Java 8 in the near future, support for Java 8 will continue with 3.5.0.

Configurations and Migrations

This release includes several modifications to the configuration defaults file:

New configurations

+AppConfig[:db_pool_timeout] = 5 # number of seconds to wait before raising a PoolTimeout error

+# Set the font used to generate PDFs in the PUI
+AppConfig[:pui_pdf_font_file] = "NotoSerif-Regular.ttf"
+AppConfig[:pui_pdf_bold_font_file] = "NotoSerif-Bold.ttf"
+AppConfig[:pui_pdf_italic_font_file] = "NotoSerif-Italic.ttf"
+AppConfig[:pui_pdf_font_name] = "Noto Serif"


+# Password recovery - requires email configuration
+AppConfig[:allow_password_reset] = false

Renamed configurations for email (used for request and new password reset functionality)

-# AppConfig[:pui_email_delivery_method] = :sendmail
-# AppConfig[:pui_email_sendmail_settings] = {
-#AppConfig[:pui_email_perform_deliveries] = true
-#AppConfig[:pui_email_raise_delivery_errors] = true
-#AppConfig[:pui_email_delivery_method] = :smtp
-#AppConfig[:pui_email_smtp_settings] = {
-#AppConfig[:pui_email_perform_deliveries] = true
-#AppConfig[:pui_email_raise_delivery_errors] = true

renamed to

+AppConfig[:global_email_from_address] = "[email protected]"
+# AppConfig[:email_delivery_method] = :sendmail
+# AppConfig[:email_sendmail_settings] = {
+#AppConfig[:email_perform_deliveries] = true
+#AppConfig[:email_raise_delivery_errors] = true
+#AppConfig[:email_delivery_method] = :smtp
+#AppConfig[:email_smtp_settings] = {
+#AppConfig[:email_perform_deliveries] = true
+#AppConfig[:email_raise_delivery_errors] = true

This release includes 3 new database migrations. The schema number for this release is 175.

Solr Schema

The Solr schema has changed. A rebuild and reindex of the Solr core will be required.

-<schema name="archivesspace" version="1.5">
+<schema name="archivesspace" version="1.6">

-    <field name="fullrecord" type="text_general" indexed="true" stored="false" multiValued="false" />
+    <field name="fullrecord" type="text_general" indexed="true" stored="false" multiValued="true" />
+    <field name="fullrecord_published" type="text_general" indexed="true" stored="false" multiValued="true" />
+    <copyField source="fullrecord_published" dest="fullrecord" />

-    <field name="notes" type="text_general" indexed="true" stored="true" multiValued="false" />
+    <!-- why are notes stored? (public app gets them from json for display) probably to support highlighting a long time ago -->
+    <!-- https://github.com/archivesspace/archivesspace/commit/87b7270f11456e0db329c45404333a1ce68419b8 -->
+    <field name="notes" type="text_general" indexed="true" stored="true" multiValued="true" />
+    <field name="notes_published" type="text_general" indexed="true" stored="true" multiValued="true" />
+    <copyField source="notes_published" dest="notes" />

+    <field name="linked_record_titles" type="string" indexed="true" stored="true" multiValued="true" />

Community Contributions

Our thanks go out to these members of the community for their code contributions:

Andrew Morrison

ANW-1341: Display user-friendly message when trying to delete an agent linked to a user
ANW-1800: Add a "find_by_id" API endpoint for top containers
Fix agents plugin support in staff interface
Do not set up PUI routes for handling slug-based URLs if use_human_readable_urls is false
Indexer efficiency improvements and fixes
Do not re-index records in private repositories unnecessarily
Add EAD export hooks to allow plugins to add extra information in child elements of origination and controlaccess

Joshua Shaw

Plugins can add to top of body in PUI
Plugin addition to PUI welcome

Garrett Armstrong

Fix mismatch between docker-compose & ./proxy/Dockerfile ARG

Mark Triggs

Adjust handling of UTC date conversion to avoid problems around DST

Sam Sciolla

Add variable substition to solrconfig.xml for indexConfig/lockType

Valerie Addonizio

Typo in en.yml

JIRA Tickets and Pull Requests Completed

catch PRs merged with GH squash option and add section for Solr schem… by @quoideneuf in #2994
ANW-504: adding support for marking agent links as primary by @avatar382 in #2991
Plugins can add to top of body in PUI by @jdshaw in #2998
Translations update from Hosted Weblate by @weblate in #3004
Translations update from Hosted Weblate by @weblate in #3003
ANW-1599: only display help text on top container search form if multiselect is… by @avatar382 in #2975
ANW-1075: Update PUI PDF output to support foreign language characters by @avatar382 in #2961
ANW-1715: fix digital object classification term links by @mark-cooper in #2968
ANW-1450: include physoc note labels in all EAD and PDF exports by @avatar382 in #2970
ANW-625: Refactor staff drag and drop modal as toolbar buttons by @brianzelip in #2974
ANW-332: Adding option to sort search results by identifier in PUI by @avatar382 in #3002
ANW-258: Updates to Staff and PUI PDF generation by @avatar382 in #2901
ANW-1477 allow users to recover / reset password by @quoideneuf in #2979
ANW-1690 ensure record link after +1 event by @donaldjosephsmith in #2980
Update docker startup script by @mark-cooper in #3029
Translations update from Hosted Weblate by @weblate in #3026
Plugin addition to PUI welcome - fix by @jdshaw in #3017
ANW-1229 Sequel DST timestamp fix by @donaldjosephsmith in #2973
Fix release notes and release config export by @quoideneuf in #3005
ANW-1734 add support for representative DO imports by @donaldjosephsmith in #3034
ANW-1101 use column prefs for top container listing by @donaldjosephsmith in #3010
Translations update from Hosted Weblate by @weblate in #3040
Return display string in compact resource respresentations by @mark-cooper in #3041
ANW-1450: porting over physloc work in PUI PDF from ANW-258 branch by @avatar382 in #3048
ANW-1477 Password reset fixes/updates by @donaldjosephsmith in #3049
Devcontainer: install gems directly as final step by @mark-cooper in #3042
Translations update from Hosted Weblate by @weblate in #3038
Translations update from Hosted Weblate by @weblate in #3027
Fix agents plugin support in staff interface by @andrew-morrison in #3046
Translations update from Hosted Weblate by @weblate in #3028
ANW-1341: Display user-friendly message when trying to delete an agent linked to a user by @andrew-morrison in #3035
fixing mismatch between docker-compose & ./proxy/Dockerfile ARG by @GarrettArm in #3044
Use frontend proxy url for password reset by @mark-cooper in #3051
Small edit to password reset directions by @cdibella in #3050
Fix frontend plugin initializer by @mark-cooper in #3052
Translations update from Hosted Weblate by @weblate in #3055
Dedupe ancestor title requests and lookup once per field by @mark-cooper in #3025
ANW-1101 Top Container mgmt browse column prefs - take 2 by @donaldjosephsmith in https://github.com/archivesspace/archivess...

Release notes for v3.4.1

This release addresses several small issues introduced in v3.4.0. Because #3031 has security implications for people using the public interface, we recommend upgrading directly to 3.4.1.

Configurations and Migrations

This release includes no configuration file changes or new database migrations. The schema number for this release is unchanged from the previous release.

Community Contributions

Our thanks go out to these members of the community for their code contributions:

Peter Heiner:
- Correct issue with migration 160 (#3023)

JIRA Tickets and Pull Requests Completed

PR: 3023 use correct field in migration
PR: 3024 - ANW-1777 Bulk import failing to assign container instance
PR: 3031 validate search params for from_year and to_year
PR: 3032 - ANW-1777 remediate by adding novel container types to enum when import

Total Pull Requests accepted: 4

Release notes for v3.4.0

This release includes many bug fixes and feature enhancements. Of particular note are some enhancements related to creating digital objects and making it easier to identify digital content for and in the public interface. The most complex work relates to new functionality using the previously unused Make Representative button. Based on a community-authored specification, it is now possible to mark a particular file version on a digital object or digital object component for display on different types of records, including digital objects, digital object components, accessions, resources, and archival objects. Representative images also display in relevant browse and search result displays in the public and staff interface.

Other enhancements for digital objects include the option to set a preference to spawn description fields from the linked accession, resource or archival object record when creating digital object instances; a View Digital Material section added to the "pill" for resource records in the public interface when there is digital content within the resource; breadcrumbs that make the context for linked digital objects easier to see in result displays; and a more recognizable generic button for digital content when an image cannot be shown.

Enhancements not related to digital objects but still significant include work submitted by Hudson Molonglo that it did for Princeton University to add local access restriction fields to the spreadsheet importers and RDE, and including URIs in EAD exports; more attractive print displays for records, including accessions; a new CSV import for standalone subjects; internal note fields for top containers and container profiles; and the elimination of a bug that caused hover text for the help center to sometimes appear at inopportune times.

Configurations and Migrations

This release includes several modifications to the configuration defaults file:

-# By default, Solr backups will run at midnight.  See https://crontab.guru/ for
-# information about the schedule syntax.
-AppConfig[:solr_backup_schedule] = "0 0 * * *"
-# By default no backups. If enabling (by setting > 0) then you must also ensure
-# that AppConfig[:solr_index_directory] is set to the correct path
-AppConfig[:solr_backup_number_to_keep] = 0
-AppConfig[:solr_backup_directory] = proc { File.join(AppConfig[:data_directory], "solr_backups") }

-# DEPRECATED OAI Settings: Moved to database in ANW-674
-# NOTE: As of release 2.5.2, these settings should be set in the Staff User interface
-# To change these settings, select Manage OAI-PMH Settings from the System menu in the staff interface
-# These three settings are at the top of the page in the General Settings section
-# These settings will be removed from the config file completely when version 2.6.0 is released
-AppConfig[:oai_admin_email] = '[email protected]'
-AppConfig[:oai_record_prefix] = 'oai:archivesspace'
-AppConfig[:oai_repository_name] = 'ArchivesSpace OAI Provider'
-# In addition to the sets based on level of description, you can define OAI Sets
-# based on repository codes and/or sponsors as follows
-#
-# AppConfig[:oai_sets] = {
-#   'repository_set' => {
-#     :repo_codes => ['hello626'],
-#     :description => "A set of one or more repositories",
-#   },
-#
-#   'sponsor_set' => {
-#     :sponsors => ['The_Sponsor'],
-#     :description => "A set of one or more sponsors",
-#   },
-# }

-# Set the path to the solr index for the external Solr instance.
-# This setting is used by the solr backups configuration but only
-# applies if the solr index directory is accessible to ArchivesSpace.
-AppConfig[:solr_index_directory] = File.join('', 'var', 'solr', 'data', 'archivesspace', 'data')

+# When 'true' restrict authentication attempts to only the source already set for the user
+AppConfig[:authentication_restricted_by_source] = false # default: allow any source

+# Allow mixed content in the title fields of resources, archival objects,
+# digital objects, digital object components, and accessions
+AppConfig[:allow_mixed_content_title_fields] = false

-# :container_management_extent_calculator globally defines the behavior of the exent calculator.
+# :container_management_extent_calculator globally defines the behavior of the extent calculator.

-AppConfig[:pui_branding_img] = 'archivesspace.small.png'
+AppConfig[:pui_branding_img] = 'ArchivesSpaceLogo.svg'
-AppConfig[:frontend_branding_img] = 'archivesspace/archivesspace.small.png'
+AppConfig[:frontend_branding_img] = 'archivesspace/ArchivesSpaceLogo.svg'

-# Turns on representative file version features - still in development
-AppConfig[:enable_representative_file_version] = false
+# Enables Language Selection in PUI
+AppConfig[:allow_pui_language_selection] = true
+# How repositories should be sorted in the PUI. Options are :display_string or :position
+AppConfig[:pui_repositories_sort] = :display_string

This release includes 8 new database migrations. The schema number for this release is 172.

API Deprecations

No additional API deprecations in this release candidate. For more information see the ArchivesSpace API documentation.

Solr Schema

The Solr schema has changed. A rebuild and reindex of the Solr core will be required:

+    <field name="title_ws" type="text_ws" indexed="true" stored="true" multiValued="false" />
+    <copyField source="title" dest="title_ws" />

+    <field name="identifier_ws" type="text_ws" indexed="true" stored="true" multiValued="false" />
+    <copyField source="identifier" dest="identifier_ws" />

+    <dynamicField name="*_int_sort" type="int" indexed="true" stored="false" multiValued="false" />

+        <filter class="solr.LowerCaseFilterFactory" />

Other considerations (plugins etc.):

There are a number of small changes to the MARCXML importers and exporters based on requests made or reviewed by the Metadata Standards sub-team. If you have plugins that rely upon or modify the previous behavior you should check to make sure they work as expected.

The .yml files for reports have been consolidated. If you have translations related to reports you may need to replicate them in the new structure.

Community Contributions

Our thanks go out to these members of the community for their code contributions:

Andrew Morrison:
- ANW-1607 additional changes (#2933)
- Fix for inability to suppress controlled value list values if the enumeration has no relationships to records
- Enable plug-ins to customize EAD3 export differently to EAD 2002
- ANW-1584: fix for filters being dropped after first page of subject pages on PUI
- Some small fixes to SUI permissions
Brian Harrington:
- ANW-1502 Don't create 049 if it will be empty
Corey Schmidt:
- API documentation updates
Dave Mayo:
- Fixes ANW-1550 - replaces broken XMLCleaner with Nokogiri PushParser
James Bullen:
- Enhancements to spreadsheet importer, RDE, and EAD exports
Jason Jordan:
- ANW-1738: Don't show PUI generic icon when linked DO is unpublished (#2989)
Jonathan Green:
- Update typo in config-defaults.rb
Joshua Shaw:
- Feature - PUI View Hooks for Plugins
- Add run_serialize_step hook to digital objects
Lora Woodford:
- ANW-1557 MARCXML import add 852$j
- ANW-1565 MARCXML import conditionally add 264$c
- ANW-1566 MARCXML import add 555
- ANW-1567 MARCXML import add 583
- ANW-1568 MARCXML import add 584 (#2856)
Manny Rodriguez (contracted development paid for through membership funds):
- ANW-339, ANW-300: display subjects list in PUI sorted by first term type, display agents related as subjects in related names section
- ANW-440: import marc call numbers as record identifiers
- ANW-956: Always display date label in PUI
- ANW-1084: publish flags for revision statements respect user preferences
- ANW-1257: improve invalid UTF-8 error message on spreadsheet import
- ANW-1260: MARCXML import: update 300 processing for extents
- ANW-1350: export bibliography notes in MARCXML to 581 tag
- ANW-1408: map 111,611,711 $c to location for corp agents in bib marcxml imports
- ANW-1414: include primary agent_record_identifier in MARC export subfield $0
- ANW-1416: Use MARC country codes instead of ISO-3166 codes in marc exports
- ANW-1471: adding context-sensitive help for metadata rights dec
- ANW-1472: adding links to help documentation for classification record links
- ANW-1488: display top_container internal note on show view and results page
- ANW-1503: bugfix for identifier value not appearing in CSV download
- ANW-1526: Fix for file version URIs not appearing when linked in file version and custom report where FV is linked
- ANW-1542: adding option to import subjects in marc agents and lcnaf importers
- ANW-1549: displays restricted status on container show page in PUI
- ANW-1608: adding missing translation
- ANW-1612: update translations
- ANW-1648: Applied fix for table markup breaking PDF generation
- ANW-1662: adding missing translation
Mark Triggs:
- Enhancements to spreadsheet importer, RDE, and EAD exports
- Ensure prefilled collection in "browse top containers" works with a URL prefix
- ANW-1666 mixed content in titles (#2929)
- Include a new "emph-italic" option to make italics easy to apply
Michael Glanznig:
- Translations updates
Nick Butler:
- Allow the light mode toggle to appear when creating new Agents
Payten Giles:
- Enhancements to spreadsheet ...

Releases: archivesspace/archivesspace

V4.2.0-RC1

Release notes for v4.2.0-RC1

Configurations and Migrations

1. Resource fields to exclude when duplicating a resource

2. Favicon customization

No migrations or solr configuration changes

Solr and Java versions (when using the zip distribution):

Plugin considerations:

Community Contributions

JIRA Tickets and Pull Requests Completed

Uh oh!

V4.1.1

Release notes for v4.1.1

Configurations and Migrations

Solr Schema

Community Contributions

JIRA Tickets and Pull Requests Completed

Uh oh!

v4.1.0

Release notes for v4.1.0

Configurations and Migrations

Solr Schema

Note to Plugin Users and Maintainers:

Community Contributions

JIRA Tickets and Pull Requests Completed

Contributors

Uh oh!

V4.0.0

Release notes for v4.0.0

Docker support

Configurations and Migrations

Other Considerations

Breaking change of OAI identifiers:

Community Contributions

JIRA Tickets and Pull Requests Completed

Uh oh!

V4.0.0-RC1

Release notes for v4.0.0-RC1

Configurations and Migrations

Other Considerations

Breaking change of OAI identifiers:

Community Contributions

JIRA Tickets and Pull Requests Completed

Uh oh!

V3.5.1

Release notes for v3.5.1

Configurations and Migrations

Other Considerations:

Community Contributions

JIRA Tickets and Pull Requests Completed

Uh oh!

V3.5.0

Release notes for v3.5.0

Configurations and Migrations

Solr Schema

Community Contributions

JIRA Tickets and Pull Requests Completed

Contributors

Uh oh!

V3.5.0-RC1

Release notes for v3.5.0-RC1

Configurations and Migrations

Solr Schema

Community Contributions

JIRA Tickets and Pull Requests Completed

Contributors

Uh oh!

V3.4.1

Release notes for v3.4.1

Configurations and Migrations

Community Contributions

JIRA Tickets and Pull Requests Completed

Uh oh!

V3.4.0

Release notes for v3.4.0

Configurations and Migrations

API Deprecations

Solr Schema

Other considerations (plugins etc.):