Release 2.7

From AtoM wiki
Revision as of 15:09, 21 December 2022 by JennR (talk | contribs)

Main Page > Releases > Releases/Release announcements > Release 2.7

Release date: December 21, 2022

Download link: atom-2.7.0.tar.gz

Database schema version: v192

Release 2.7 is the first major AtoM release since July 2020, and includes new features, some dependency upgrades, accessibility improvements, as well as bug fixes. Some highlights include:

  • An updated version of Bootstrap - both BS5 and BS2 are supported in 2.7
  • The ability to use Central Authentication Service (CAS) for single sign on
  • Enhanced Archivematica integration with the ability to download AIP and preservation files directly from AtoM
  • Improved digital object metadata display area
  • Introduction of a validation tool for CSV imports via the user interface
  • New command line tasks to help verify imports and resolve issues

We’ve closed a number of issues as part of this release – you can view more details on each ticket in our issue tracker at the following links


Visit the Downloads page to download the most recent release, and consult the 2.7 Upgrading and Installation guides in our documentation for further information.

If you’re a brand new AtoM user, we suggest that you deploy a new install with BS5. If you are performing an upgrade and you have a custom theme we recommend you continue to use BS2 at this time.

An overview of some of the major changes in the 2.7 release is included below, followed by a list of links to relevant tickets, sponsors and contributors, and documentation for new features.

Tip

Issue numbers associated with new features and bug fixes listed below refer to the AtoM project issue tracker. Artefactual uses the issue tracker to track development tasks, feature requirements, quality assurance testing, and related development discussion. You can use the numbers to search for the related issue ticket in our Issue tracker - often the tickets will include more information on how the feature was implemented.

For more information, see: Issue tracker


Accessibility

Community contributor Matt Innes has contributed a number of minor accessibility enhancements to the latest AtoM release, addressing elements such as adding missing aria labels or instructions, better tab navigation flow and general page structure improvements, removal of redundant elements affecting accessibility, etc. These changes do not affect the look or feel of AtoM, but should provide some quality of life improvements for users with assistive technologies such as screen readers.

Community contributions from Matt Innes

  • #13535 - Enhance accessibility support of various AtoM template elements

Bootstrap 5

AtoM will be integrating Bootstrap 5 into AtoM. Bootstrap is a framework for developing websites and is used in AtoM to provide theme templates to administrators This updated version of Bootstrap provides a number of improvements such as better security, responsiveness and accessibility.

The new version of Bootstrap enables significant accessibility and responsiveness improvements over previous AtoM versions and it has better responsiveness for public users accommodating portable devices with varying screen sizes making the websites more easily accessible independent of device.

The new version of Bootstrap will be available in future releases of AtoM and more information will be provided in future forum announcements.

Related documentation

Accessions

This release sees some additional incremental support for elements of the Canadian Archival Accession Information Standard (CAAIS). In this release, we have added a basic module for managing events in conformance with CAAIS Element 5.1, which are "the actions taken by repository staff throughout the accession process." The 5.1.1 Event Type field is linked to a new Accession Events taxonomy that can be customized by an administrator as needed.

General bug fixes and enhancements

  • #13466 - Accession donors are not indexed properly

Sponsored by the Government of the Northwest Territories

  • #13315 - Add ability to associate events with accession records

Related documentation:

Authentication

AtoM now supports use of the Central Authentication Service (CAS) protocol for single sign-on and authentication management. Additionally, the previously undocumented support for LDAP now has configuration instructions in the Administrator's manual (on the same page as the CAS documentation linked below).

Sponsored by Simon Fraser University Archives

  • #13383 - Support CAS single sign-on

Related documentation

Archivematica integration

For users who are using AtoM with Archivematica, administrators who have Archivematica access can now download AIP and preservation files directly from AtoM. This coincides with the digital object metadata improvements described in the Digital objects section below.

Sponsored by Simon Fraser University Archives

  • #13351 - Support AIP download from AtoM UI for authorized users

Related documentation

Authority records

This release adds a minor enhancement that will provide a warning notification to authenticated users when a duplicate authority record identifier is entered. This warning is never shown to public users, similar to existing warnings in the standards-based templates.

Sponsored by an undisclosed institution

  • #13373 - Display warning for duplicate authority record identifiers

Command-line tasks

In addition to the CLI enhancements described in the Import/Export section below, this release also includes a new task to help system administrators remove temporary files, such as old saved clipboards and downloads found in the jobs subdirectory. When troubleshooting upgrade issues related to the database schema version, users an also use a new option on the tools:upgrade task to run individual schema migrations, in case one is missed during an upgrade process.

Another feature that has been added as part of this release is replacing the AtoM web installer with a command line driver installation. This feature addresses the installation timeout via the web browser by moving the AtoM installation steps. It should simplify the installation process overall, better support automated deployments, and resolve the timeout issues resulting from the web installer's current use.

General bug fixes and enhancements

  • #13368 - Add CLI option to migration task to run individual migrations
  • #13440 - Add ability for tools:expire-data to delete temp files
  • #13452 - Replace AtoM's web installer with a command-line driven installation process
  • #13500 - Add CLI task to generate finding aids

Sponsored by Mills Archive

  • #13361 - Add option to cache XML task to generate only EAD or DC XML

Related documentation

Digital objects

The 2.7 release includes a number of minor enhancements to the Digital object functionality in AtoM. The Digital object metadata area has been expanded to display separate details about the original and all derivatives, and the corresponding public visibility controls in the Visible Elements module have also been expanded to match. Administrators can now enable an option that will allow public users to include digital objects in their clipboard downloads. A new API endpoint has been added to allow authorized users to access the master digital object associated with a description. Additionally, thanks to a community pull request, subtitle and chapter tracks can now be uploaded alongside audio and video digital objects.

General bug fixes and enhancements

  • #13497 - Video derivatives not generated when linking via URL

Community pull requests from Matt Innes

  • #13459 - Reintroduce responsive audio/video
  • #13471 - Clarify digital object derivative settings
  • #13490 - Add support for subtitle and chapter tracks in video and audio digital objects

Related documentation

Sponsored by an undisclosed institution

  • #13395 - Add option to include digital objects in clipboard exports

Related documentation

Sponsored by Simon Fraser University Library

  • #13388 - Improve digital object metadata display
  • #13417 - Digital object preservation copy displays UCT time stamps

Related documentation

Sponsored by the Mills Archive

  • #13436 - Add API endpoint to download master digital object

Related documentation

Finding aids and reports

We've addressed a few issues that prevented finding aids from generating when the Library of Congress EAD DTD was inaccessible by using a local DTD instead, and added a new administrative setting that can disable finding aid generation. When disabled, related finding view page links and advanced search filters will also be hidden in the user interface.

General bug fixes and enhancements

  • #13247 - Finding aid generation sometimes fails reading DTD file
  • #13590 - Finding aid generation fails due to a "403 Forbidden" error
  • #13593 - Add the ability to turn off finding aid features in the AtoM UI

Related documentation

Import and export

The 2.7 release includes a new major module to support better CSV imports - the ability to validate a CSV prior to import, from the command-line or via the user interface. Additionally, an administrator can set validation to run automatically before any import if desired. We've also added a few command-line tasks to help verify imports or resolve issues - one task can audit a CSV against AtoM's database and report any rows that were not imported, and another task can delete descriptions created by a CSV import for cases where the import results were not as expected.

Other bug fixes in this release include the ability to export in CSV RAD note types for cast, credit, and signatures as well as the ability to export descriptions in CSV from the clipboard in RAD.

General bug fixes and enhancements

  • #13287 - Repository CSV import fails when new terms added to Description Statuses in import file
  • #13295 - Authority record CSV import fails when encountering new entity type (or variations in capitalization)
  • #13457 - Create command line task to delete records created by a CSV import
  • #13475 - Enhance AtoM's csv:check-import task to support pre-import validation
  • #13481 - Some RAD notes fields don't appear in CSV exports
  • #13483 - Description CSV exports from clipboard only exporting in ISAD
  • #13561 - Add ability to use CSV check task on a directory full of CSV files
  • #13567 - CSV authority record import requires identifier column be populated
  • #13569 - Add CSV audit import task

The development of this tool has been made possible by the Council of Nova Scotia Archives and the Library and Archives Canada's Documentary Heritage Communities Programs

  • #13508 - Integrate AtoM's CSV Validator into the Web UI

Sponsored by UN Geneva Library

  • #13549 - Add slug column to CSV information object export

Related documentation

Rights

It's now possible to enable the Copyright pop-up to apply to all digital objects in AtoM, without needing to individually apply Rights statements to each related record for the pop-up to trigger.

Sponsored by the UN Archives Geneva

  • #13570 - Add ability to apply copyright pop-up globally without accompanying Rights statement

Related documentation

Scalability and performance

General bug fixes and enhancements

  • #13435 - Permission denied creating a new child description when Grant "create" on parent
  • #13437 - Digital object authorization code is too complicated

Sponsored by an undisclosed institution

  • #11556 - Make AtoM's clipboard work with the Varnish Cache web application accelerator
  • #13389 - Support ability for reverse proxies like Varnish to cache content that's not in the default culture
  • #13415 - An archival description with many descendants loads slowly when the DO carousel is enabled

Settings

Sponsored by an undisclosed institution

  • #13411 - Add setting to enable or disable repository "upload limit" widget

Related documentation

Treeview

General bug fixes and enhancements

  • #13423 - Full-width treeview fails to load for descriptions with 900K+ children
  • #13446 - Clicking on a description in the full-width treeview doesn't update the page URL
  • #13491 - Terms treeview list tab's "Next" pager button does not work

Other bug fixes and enhancements

  • #12628 - Drag and drop on full-width treeview makes it difficult for public users to scroll on mobile devices
  • #13297 - Privacy policy static page cannot be deleted from the menus
  • #13458 - PDF logo not included in PDF Finding Aids
  • #13469 - Do not return 404 responses from search/autocomplete when there are no results
  • #13506 - Copyright pop-up preview page no longer renders preview content
  • #13586 - Certain special characters displays incorrectly in Web Page Title

Community code contributions from Matt Innes

  • #10682 - Cannot create new authority record and add relationship at the same time
  • #13218 - Error when adding function related to another
  • #13499 - Various relation dialog fixes and improvements
  • #13515 - Capitalize initial letter of languages in menu
  • #13544 - Exclude narrower terms link and filter tag always link to description results

Community code contribution from Jason Hildebrand and PeaceWorks Technology Solutions

  • #13441 - Improve Dockerfile layers caching