github archivesspace/archivesspace v3.2.0
V3.2.0

latest releases: v3.4.0-RC0, v3.3.1, v3.3.0...
2 years ago

Release notes for v3.2.0

This release marks the previously announced transition to external Solr. Links to documentation, a tutorial video, and other information are available at https://archivesspace.org/archives/7151.

Beyond external Solr, there are several items to note in the release candidate.

  • The Smithsonian worked with Hudson Molonglo to improve the ARKs feature. The scope of the work is described in #2437.
  • There is a new custom reports feature, worked on by several developers over the years, including former ArchivesSpace Tech Lead Laney McGlohon.
  • Other highlights include small improvements to the spreadsheet importers, a new page within the application for downloading templates, and various small bug fixes and features prioritized by the Development Prioritization sub-team.

Configurations and Migrations

This release includes modifications to the configuration defaults file:

Added settings:

AppConfig[:solr_verify_checksums] = true
AppConfig[:enable_custom_reports] = false

Additions related to ARK changes:
AppConfig[:ark_minter] = :archivesspace_ark_minter
AppConfig[:ark_enable_repository_shoulder] = false
AppConfig[:ark_shoulder_delimiter] = ''

AppConfig[:disable_config_changed_warning] = false

Changed settings:

AppConfig[:solr_url] = "http://localhost:8983/solr/archivesspace"

Removed settings:

AppConfig[:enable_solr] = true

AppConfig[:bulk_import_rows] = 1000
AppConfig[:bulk_import_size] = 256

The way the citation feature in the public interface presents options for the citation has been changed for better accessibility. These settings related to the previous tab layout were removed:
AppConfig[:pui_page_actions_cite] must be set to true for this to take effect.
AppConfig[:pui_active_citation_tab_item] = true

Please note that there was a change to the migration for ARKs between the release candidate and the release. Testing of the release candidate revealed issues for some users who used the previous ARK functionality. The revised migration will better handle problematic records by either quietly correcting them or flagging them so that they can be corrected.

This release includes 2 new database migrations. The schema number for this release is 159.

API Deprecations

As previously noted, the following API endpoints remain deprecated, and will be removed from the core code of ArchivesSpace on or after 2022-04-16:

  • Endpoint.get('/repositories/:repo_id/archival_contexts/softwares/:id.xml')
  • Endpoint.get('/repositories/:repo_id/archival_contexts/softwares/:id.:fmt/metadata')

Additionally, as previously noted, the following API endpoints remain deprecated, and will be removed from the core code of ArchivesSpace on or after 2021-10-30:

  • Endpoint.get_or_post('/search/subjects')
  • Endpoint.get('/repositories/:repo_id/resources/:id/tree')
  • Endpoint.get('/repositories/:repo_id/digital_objects/:id/tree')
  • Endpoint.get('/repositories/:repo_id/classifications/:id/tree')

For more information see the ArchivesSpace API documentation.

Other Considerations

Because of the transition to external Solr, this release requires a full reindex.

Community Contributions

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

  • Andrew Morrison:

    • ANW-1060 New tests for extra ARKs created when records are edited
    • Enable ARKs when running public test suite
    • Do not set up PUI route for handling ARK URLs if arks_enabled is false
  • Blake Carver:

    • Stylesheets should be cp -r too
  • Brian Zelip:

    • ANW-573, ANW-553 Allow less granular advanced search dates, add frontend test
    • ANW-1337 Improve PUI modals accessibility and citation modal
    • ANW-1448 Fix tooltip bug in staff tree toolbar, add test
    • Refactor staff tree bulk load help tooltip to fix reorder render bug
    • Update front ends lint test dependencies
    • Fix css lint errors & format all front end programmatically
    • Fix js and css lint errors manually across 14 files
    • Add front end lint CI checks
  • Dean Farrell:

    • Use aspace base to determine location of gem files
  • Jacob Shelby:

    • Added API examples for component add children
  • James Bullen:
    ARKs refactoring and expansion, including

    • Reduce the number of cases where a new ARK is minted.
    • Resolve external arks when they have our prefix
    • Tickle mtime when editing arks to catch up indexer
    • Fix the logic in calculate_values to accord with with ark_name value columns semantics
    • Use the handy new ability to turn off config changed warnings in the ARK model tests
    • Add a config option to disable the config changed warning - nice when running tests that need to fiddle with config
    • Update tests for new ARK generalisation
    • Introduce backend endpoints for directly editing ark_name objects.
    • Rename ark_prefix to ark_shoulder to agree with the standard
  • Laney McGlohon

    • Work on custom reports feature
  • Lora Woodford:

    • ANW-819 Filter by identifiers for all record types
    • ANW-1115 Use bulk import to add rights restriction begin and end dates
    • ANW-1220 Don't break index when background jobs plugins are disabled
    • ANW-1243 Retain label attribute for abstract note
    • ANW-1258 Don't link tc with different barcode to existing tc
    • ANW-1292 Clarify /root API endpoints
    • ANW-1294 Indicate required permissions for endpoints in API docs
    • ANW-1303_cont Minor tweak to pdf export job runner
    • ANW-1304 Custom reports check/uncheck changes
    • ANW-1305 API examples and permissions
    • ANW-1306 Refactor narrow by functionality
    • ANW-1335 Fix API examples for arrays
    • ANW-1388 Add subject merge api examples
    • ANW-1402 Add change tracking/standard toolbar to custom report templates
    • ANW-1412 Address custom report index and templates accessibility
    • ANW-1421 Don't allow bulk import to import bad date types
    • ANW-1439 and ANW-1432 Improve custom report template show page
    • Add weblate translation status badge to readme
    • Updates to aliased locales not handled by weblate
    • Remove deprecated config options for bulk import (again)
    • Clean up factory_bot_helpers and improve api documentation
    • Add API tree examples and improve parameters/data styling
    • Common locales cleanup
    • Public locales cleanup
    • Frontend locale cleanup
    • Add basic color contrast test
    • Enumerations translations updates and start linter implementation
    • Don't show scrollbars on windows in badge-and-identifier
  • Manny Rodriguez:

    • ANW-600 Allow users with delete_event_record permission to delete event records
    • ANW-701 Include ancestor listing in digital object components
    • ANW-1131 Add a preference option to toggle how to sort RDEs
    • ANW-1411 Set conference_meeting = true for 111, 611 and 711 tags
    • ANW-1415 Include subject authority_in 65X field, $0
    • ANW-1424, ANW-1177 Allow include unpublished in exports to be set as a user preference
    • Add aria-expanded attr to merge menu
    • Add role=button to boostrap datepicker
    • Bugfix for help icon staying visible after reorder mode is activated
  • Mario Terranova:

    • common translated using Weblate (Italian)
  • Mark Triggs:
    ARKs refactoring and expansion, including

    • Add a new Smithsonian ARK minter
    • Migrate ARK values into ArkName and support previous ARKs and a single current
    • Extend the ARK background job to the new scheme
    • Ensure generated ARK values are unique to a record
    • Index ARKs to make them available to the public interface
    • Add ARKs to IDLookup
    • Import current and previous ARKs during EAD import
    • Only save ARKs if there are changes to save
    • Interface for editing ARKs as the admin user
    • Correct uniqueness checks
      Also
    • Remove unnecessary warning log triggered on concurrent logins
    • Improve EAD import performance for unnumbered components
  • Michael Glanznig:

    • common translated using Weblate (German)
    • enums translated using Weblate (German)
    • public translated using Weblate (German)
    • frontend_help translated using Weblate (German)
    • frontend translated using Weblate (German)
  • Payten Giles:
    ARKs refactoring and expansion, including

    • Include the AppConfig[:ark_minter] in the ARK version_key so changing the minter is picked up by the Generate ARKs job
    • Reindex any records with an ARK so the new PUI resolver picks up these records; and only apply the uniq constraint for ark_name entries after the migration of old data
    • Write ARK tests for external_ark_url uniqueness and extra ARK minted upon external_ark_url edit
    • Fix importer to ensure ark is set on the nearest archival object or resource (we can't trust the current context object)
    • Add ARK tests for EAD converter
    • Fix up OAI ARK mappers
    • Update exports to handle new ARK schema
    • Refactor and add to ARK-related EAD/EAD3 export tests
    • Support previous ARKs
    • Move ARK handling into apply_nested_records so we can be sure to have our changes applied after creation but before the realtime indexer has fired
  • Saron Tran:

    • ANW-810 add thumbnails to collections / resources in the PUI-- the same way it does for archival objects

Total community contributions accepted: 208

JIRA Tickets and Pull Requests Completed

  • PR: 2598: Translations update from Hosted Weblate
  • PR: 2596: ANW-1465: Update locales for custom report templates
  • PR: 2595: ANW-1448: Refactor staff tree load-via-spreadsheet help-tooltip to fix reorder render bug
  • PR: 2594: ANW-1469: Update metadata rights declaration sidebar position
  • PR: 2589: Translations update from Hosted Weblate
  • PR: 2590: Proxy default conf will always be https enabled
  • PR: 2588: Translations update from Hosted Weblate
  • PR: 2587: Translations update from Hosted Weblate
  • PR: 2582: Translations update from Hosted Weblate
  • PR: 2573: ANW-573: Fine tune advanced search date query
  • PR: 2580: Translations update from Hosted Weblate
  • PR: 2579: Translations update from Hosted Weblate
  • PR: 2581: mizuno-aspace is now a proper rubygem
  • PR: 2578: Translations update from Hosted Weblate
  • PR: 2575: correct yml root keys for de pt and it locales files
  • PR: 2567: Translations update from Hosted Weblate
  • PR: 2565: Translations update from Hosted Weblate
  • PR: 2574: Translations update from Hosted Weblate
  • PR: 2562: Translations update from Hosted Weblate
  • PR: 2571: decouple accessions csv spec and template for download
  • PR: 2569: ANW-1463: Fix agent software merge
  • PR: 2539: Translations update from Hosted Weblate
  • PR: 2568: Updated CSV templates
  • PR: 2564: Small wording/naming updates for the import templates page
  • PR: 2534: ANW-1177: Add a user preference to include unpublished in exports
  • PR: 2552: Translations update from Hosted Weblate
  • PR: 2557: Translations update from Hosted Weblate
  • PR: 2558: add true/false data validations for recently added columns in spreadsheets
  • PR: 2556: Translations update from Hosted Weblate
  • PR: 2555: ANW-1459 assign a random identifier to bulk import digital objects
  • PR: 2554: Translations update from Hosted Weblate
  • PR: 2551: ANW-1460 add help text and link for bulk template downloads
  • PR: 2546: ANW-1448 Fix tooltip bug in staff tree toolbar
  • PR: 2547: ANW-1456 Sort templates
  • PR: 2485: ANW-1131: display RDE templates in alpha order in dropdown menu
  • PR: 2541: Translations update from Hosted Weblate
  • PR: 2540: Translations update from Hosted Weblate
  • PR: 2545: Use solr latest img for dev
  • PR: 2543: Translations update from Hosted Weblate
  • PR: 2544: Translations update from Hosted Weblate
  • PR: 2542: stylesheets should be cp -r too
  • PR: 2537: ANW-1337: Addendum to PR GH-2488 re: PUI citation modal
  • PR: 2536: Remove unnecessary warning log triggered on concurrent logins
  • PR: 2535: ANW-1411: Support mapping for Conference Meeting boolean for x11's in the MARC importer
  • PR: 2532: Translations update from Hosted Weblate
  • PR: 2533: chore: Update front end linting npm dependencies
  • PR: 2522: ANW-701: include ancestor listing in digital object components
  • PR: 2520: Use Jetty 9 for the development webservers
  • PR: 2488: ANW-1337: Improve public modal screen reader accessibility
  • PR: 2528: Clean up factory_bot_helpers and improve api documentation
  • PR: 2529: ANW-1415: include subject authority_id 65X field, $0
  • PR: 2526: ensure untitled object display strings in PUI use date for display
  • PR: 2523: ANW-1335 Fix API examples for arrays
  • PR: 2519: ANW-1388 Add subject merge api examples
  • PR: 2518: ANW-1294 Indicate required permissions for endpoints in API docs
  • PR: 2517: Translations update from Weblate
  • PR: 2516: Jetty 9
  • PR: 2515: ANW-1292 Clarify /root API endpoints
  • PR: 2507: ANW-1158 add publish fields to bulk import csv importers
  • PR: 2481: Translations update from Weblate
  • PR: 2480: Translations update from Weblate
  • PR: 2479: Translations update from Weblate
  • PR: 2477: ANW-600 refactor tests
  • PR: 2509: ANW-1243 Retain label attribute for abstract note
  • PR: 2508: move bulk import templates out of public directory so as not to bork …
  • PR: 2505: add public directory to frontend warble config
  • PR: 2503: ANW-1305 update: Remove narrow_by
  • PR: 2502: ANW-1402 Add change tracking/standard toolbar to custom report templates
  • PR: 2499: ANW-1059 Import Template Page
  • PR: 2501: Split proxy cfg by function
  • PR: 2500: ANW-1439 and ANW-1432 Improve custom report template show page
  • PR: 2496: Solr updates
  • PR: 2491: ANW-1115 Use bulk import to add rights restriction begin and end dates
  • PR: 2495: Corrected three typos related to agent maintenance
  • PR: 2494: Bump nginx proxy version
  • PR: 2490: Translations update from Weblate
  • PR: 2486: ANW-1421 Don't allow bulk import to import bad date types
  • PR: 2478: Translations update from Weblate
  • PR: 2487: ANW-1377: Remove inaccurate error message when multiple digital
  • PR: 2484: ANW-1258 Don't link tc with different barcode to existing tc
  • PR: 2483: ANW-819 rebased
  • PR: 2482: Small edit to the description of custom reports
  • PR: 2572: ANW 573: Fine tune advanced search date query
  • PR: 2472: Ark generalization
  • PR: 2461: ANW-1375: Fixes for color contract accessibility tickets
  • PR: 2464: Translations update from Weblate
  • PR: 2470: Updates for how ARCHIVESSPACE_VERSION is determined
  • PR: 2468: Translations update from Weblate
  • PR: 2467: refactor frontend accessibility tests and use rspec/retry x3
  • PR: 2465: Solr 8.10
  • PR: 2463: Translations update from Weblate
  • PR: 2462: Add weblate translation status badge to readme
  • PR: 2460: Updates to aliased locales not handled by weblate
  • PR: 2459: Translations update from Weblate
  • PR: 2457: Translations update from Weblate
  • PR: 2458: Translations update from Weblate
  • PR: 2456: Translations update from Weblate
  • PR: 2455: Translations update from Weblate
  • PR: 2454: Remove deprecated config options for bulk import (again)
  • PR: 2497: Translation Error.
  • PR: 2625: ANW-1479 & ANW-1484
  • PR: 2631: fix column key publish -> digital
    Total Pull Requests accepted: 110

Don't miss a new archivesspace release

NewReleases is sending notifications on new releases.