Difference between revisions of "Releases/Roadmap"

From AtoM wiki
(Search and Browse)
(Search and Browse)
Line 106: Line 106:
'''Related documentation'''
'''Related documentation'''
* [https://www.accesstomemory.org/en/docs/2.5/user-manual/access-content/search-atom/#authicon-authority-records Add an advanced search interface for authority records]
* [https://www.accesstomemory.org/en/docs/2.5/user-manual/access-content/search-atom/#authicon-authority-records Advanced search in authority records]
''Sponsored by the Royal BC Museum / British Columbia Archives''
''Sponsored by the Royal BC Museum / British Columbia Archives''

Revision as of 21:00, 1 April 2019

Main Page > Releases > Releases/Roadmap

On this page, you'll find summaries about upcoming releases, and issue tickets related to them. As the releases are finalized, elements on this page will be used to draft the formal release announcements found here.


You can also check out the issues associated with upcoming releases by looking at the Roadmap page in our issue tracker.

Release 2.5

Archival descriptions

The 2.5 release will add audit logging for archival descriptions - administrators will be able to view a log of all creation and modification events associated with a description (including date of change and the user account associated with the change), as well as a log of all description modification events associated with a particular user account (with links to the affected descriptions). Users will be able to see their own logs, though only admins will be able to see all user logs. Additionally, editors will now be able to run a job that will automatically calculate the date range for a parent description, based on the broadest dates found on any descendant records. Finally, administrators can now hide RAD Rights notes from the public interface via the Visible elements module.

Sponsored by Docuteam and the Bank for International Settlements

  • #12115 - Calculate accumulated dates
  • #12130 - Add new archival description audit log

Sponsored by the Provincial Archives of Saskatchewan

  • #12860 - Add Rights RAD note support to Visible Elements module

Related documentation

Authority records

In addition to the new Advanced search interface for authority records (described in the Search and Browse section below), The 2.5 release will also see subject and place access points added to authority records (including support in EAC-CPF XML and CSV import/exports), and the ability to attach a single digital object to an authority record via upload in the user interface, or URL. We're also enhancing the authority record search/browse results with thumbnails of attached digital objects, and text snippets taking from the related record's History field, similar to the scope and content snippets shown on description results.

Sponsored enhancements (institution undisclosed)

  • #12650 - Add the ability to upload a single digital object to an authority record, and supplement search/browse result stubs for authority records with thumbnails and history snippets
  • #12647 - Add subject and place access points to authority records

Related documentation


In the 2.5 release, users will be able to save a clipboard in one session, and then load it again in the future - with the option to either merge with the current clipboard results, or to replace them. An administrator can also set how long saved clipboards will be preserved in the system.

Sponsored by Simon Fraser University Archives

  • #11360 - Allow users to save and retrieve clipboard results across sessions


AtoM 2.5 will add support for the Parsedown PHP library, which will allow users to format content using GitHub-flavored Markdown - meaning that italics, bolding, lists, tables, and more formatting will be supported within edit templates. Previous special formatting in AtoM will be removed, but a command-line task to convert existing custom link syntax to the new Markdown link syntax will also be added (see the Command-line tools section below). Parsedown syntax will also be automatically ignored in searches, and Parsedown is smart enough to ignore open ended tags - meaning if you forget to close a bolding element or a table, you won't break your whole site.

Sponsored by Texas A&M University - Cushing Memorial Library and Archives and McMaster University

  • #12148 - Add Markdown support in AtoM

Related documentation


Minor enhancements to the EAD XML import mapping.

Sponsored by Texas A&M University - Cushing Memorial Library and Archives

  • #12172 - Add additional fields to AtoM EAD import and export
  • #12267 - Convert bold, italic, and bolditalic EAD emphasis tag to markdown when markdown is enabled in AtoM

Other additions include:

  • #8387 - Change csv:export behavior to not just append to existing files

Search and Browse

We have upgraded the Elasticsearch index to use version 5.2 . Additionally, a new Hierarchical browse page option, comprised of a full-screen treeview displaying all records, will be available as an alternative way of browsing site holdings. In the authority record search/browse page, we're adding a full Advanced search panel for authority records, similar to the desrciption advanced search. Users will also be able to change the sort direction of results in the sort button (Ascending and Descending). Additionally, we're adding a couple performance improvements: first, for edits that affect many descendant records, the job scheduler will now be used to make any necessary updates in the background. Second, we've added pagination to the full-width treeview to help scalability and performance in very large hierarchies.

  • #10847 - Upgrade Elasticsearch to version 5.x
  • #12000 - Add alternative sort directions to the sort button in search/browse pages
  • #12140 - Include creator name as an option in the Advanced search panel's field drop-down

Sponsored by the Bank for International Settlements

  • #11955 - Add hierarchical (treeview-based) browse page to explore all holdings in AtoM

Sponsored by the University of Strathclyde Archives

  • #11855: Search index is not updated when edits affect descendant records

Sponsored by an undisclosed institution

  • #12651 - Add an advanced search interface for authority records

Related documentation

Sponsored by the Royal BC Museum / British Columbia Archives

  • #12611 - Add pagination to the full-width treeview


  • #11980 - Add notification when changing settings so users know the changes have been saved
  • #12139 - Organize identifier-related settings into their own settings page
  • #12160 - Add option to hide login button to Admin options in Visible elements

Sponsored by the National Library of Sweden

  • #11761 - Update slug generation rules include a more permissive option

Command-line tasks

New tasks to help manage Physical storage locations have been added, as well as a number of performance improvements to the CSV import task that should decrease import times. There is also a new task to help remove redundant links to authority records at lower levels (that can cause performance issues in large installations), where creator inheritance would achieve the same results. The digital object load task will also gain the ability to discard master digital objects after derivative creation, storing the path to their locations instead - similar to when URLs are used for linking when uploading digital objects via the user interface. This will allow institutions who maintain their digital objects in a separate shared internal location to avoid the need to duplicate their objects when linking them to descriptions in AtoM. Finally, a new search:status task has been added to help users gather more information about their Elasticsearch installation, helpful when troubleshooting.

Sponsored by the City of Victoria Archives

  • #11910 - Create command-line task that removes unnecessary actor links at lower levels where inheritance could be used

Sponsored by Texas A&M University - Cushing Memorial Library and Archives and McMaster University

  • #12149 - Convert existing AtoM data to Parsedown syntax

Sponsored by the Provincial Archives of Saskatchewan

  • #12532 - Improve csv:import CLI task performance
  • #12826 - Improve CSV Import term creation logic performance
  • #12739 - CSV Accession Import CLI task should create keymap records for import matching
  • #12840 - Add ability for digital object load task to discard master DO after derivative creation

Sponsored by the City of Vancouver Archives

  • #12618 - Add new physical object normalization command-line task to merge duplicate containers
  • #12646 - Add new command-line task to delete any Physical storage locations not linked to any descriptions

Other additions include:

  • #9520 - Add --slug option to search:populate task
  • #12042 - Add cache clearing after migrate task is executed
  • #12580 - Add option to log execution of scripts using the tools:run task
  • #12521 - Add a search:status task to provide basic information on ES index status
  • #12627 - Add Elasticsearch search/index information display to search:status task

Bug fixes and minor enhancements

  • #7650 - Delete rights should warn user
  • #8345 - Administrator cannot delete "About" static page
  • #8406 - Top-level menu nodes should allow empty paths
  • #9308 - Move "Maximum image width (pixels)" setting to digital object derivatives tab in settings
  • #9839 - Adjust MODS import/export mapping for digital object
  • #10505 - Deleting a creator from an imported record also removes the date
  • #10856 - Sidebar treeview's "xx more" expand button cannot be translated
  • #11177 - Changing "users" menu name breaks user administration page
  • #11186 - Allow key menu item names to be locked
  • #11189 - Output of jobs:list and CSV jobs export via user interface is inconsistent
  • #11449 - Deleting digital object link from record in UI breaks digital object link for other records
  • #11507 - Title of descriptions not displayed on Jobs page when created in a different culture
  • #11639 - Symfony task for building models from schemas doesn't work with PHP 7
  • #11646 - CSV import should not import blank rows
  • # 11855 - Search index is not updated when edits affect descendant records
  • #11963 - Remove unused code from finding aid generation
  • #12167 - Deletions and/or edits to display labels on login, logout, and myProfile menu nodes have no effect
  • # 12232 - Genre browse page lacks results count column


For a full list of issues related to the 2.5 release, see the following links to our issue tracker:


This project in our issue tracker is where new unsponsored feature requests for Access to Memory (AtoM) can be added. This allows us to log feature requests, and begin discussion about requirements and design without adding confusion to the main AtoM project's issue tracker as to which features will be included in an upcoming release.

See the AtoM Wishlist project here:


Once you've followed the link above, you can click on the "Issues" link at the top of the page to browse all issue tickets in the AtoM Wishlist. You can sort the list of issues by clicking on a column header, and use the Filter drop-down menu to the right to customize the query.

How the Wishlist works

When features are sponsored by an institution, or developed and submitted via community pull request, they will be copied to the main AtoM project in our issue tracker (here), and marked verified in the Wishlist project. Developer discussion, quality assurance testing, and other related updates will be posted to the related development ticket in the main AtoM project.

The tested version tag can be used in the Wishlist's issue description to keep track of when the feature was requested (e.g. which version of AtoM was most recent when the feature request came in)

The target version will only be applied before a Wishlist ticket is verified (closed) and copied to the main AtoM project.


  • We've got information on our main AtoM issue tracker, and how you can use it to submit a bug report here: Resources/Issue tracker.
  • Got questions? Not sure if something is a bug or not, if a wishlist feature might be of interest to the rest of the community, or if something is already on our upcoming development roadmap? Why not make a post in our AtoM User Forum?