Release notes for v3.0.0-RC2

This release candidate centers around changes to the agents module of ArchivesSpace to make it more standards-compliant with EAC-CPF and the MARCXML format for authority data, enabling deeper and richer description of people, families, and corporate entities, their relationships to each other and their relationships to materials held outside ArchivesSpace. This work is the result of a community specification involving the participation of many users across the ArchivesSpace community, mostly notably Cory Nimer, Sue Luftschein, and Brad Westbrook. Through this work new fields and sub-records have been added to the agents schema, and staff and public interface views, imports, exports, and auxiliary functionality like agent merging have all been updated. There is also a new Light mode, which provides the option for users to continue to work with agent records in the staff interface in a pared down view that is similar to that of ArchivesSpace versions prior to this one.

While the bulk of the changes in this release candidate relate to the agents module, the release candidate also contains improvements in some other areas of the application contributed by community developers and program team developers and contractors. For spreadsheet fans, the developers and archivists at Harvard University have contributed another feature, this one focused on adding top containers and associated information to existing archival objects. With this feature, a user will download a file of archival objects for a resource, add top container information outside the application, and then import the information into the resource record, from the Load via Spreadsheet area. Some draft documentation for this feature written by Harvard staff is available at https://docs.google.com/document/d/10poB5BDwgEWGYwrfLgkfy_sOjkhmbvStDat_BIm6ucw/edit?usp=sharing.

Also included among the community contributions are additional performance, backend and staff interface improvements courtesy of work Hudson Molonglo developers James Bullen, Mark Triggs, and Payten Giles did for Queensland State Archives as part of a larger project.

Configurations and Migrations

This release includes one modification to the configuration defaults file:

For agents export
AppConfig[:export_eac_agency_code] = false

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

API Deprecations

The following API endpoints have been newly deprecated as part of this release. For the time being, they will work and you may continue to use them, however they will be removed from the core code of ArchivesSpace on or after 2022-04-16. For more information see the ArchivesSpace API documentation.

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')

Community Contributions

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

• Andrew Morrison:

  • Fix for PUI slowness caused by unnecessary counting of record types
  • Fix for EAD import bug when top-level descriptive identification has container info but no langmaterial
  • Set publish on subnotes the same as parent multi-part note in EAD importer

• April Rieger:

  • ANW-695: Top Container CSV Export

• Blake Carver:

  • Don't limit report to just repo 2
  • generate_accession_identifiers does not handle prefxes

• Braydon Justice:

  • ANW-695: Top Container CSV Export
  • ANW-1015: Add External Documents to Assessment

• Brian Zelip:

  • Resolve some Javascript errors in the Manage Top Containers area (GH-1920 --C-- Fix bugs, listen for modal)

• Corey Schmidt:

  • Update API documentation for export endpoints

• Dave Mayo:

  • Add generic search route docs to API docs

• Dee Dee Crema:

  • Top Container CSV download template and spreadsheet linking of top containers to archival objects

• Fred Reiss:

  • Update marcxml_base_map.rb to account for 099

• James Bullen:

  • Respect position in backend enum source
  • When indexing enum values, don't hardcode the list of enums, dig them out of the schemas
  • Don't reload specs from plugins
  • Affix at the sidebar level, rather than the nav list.
  • The two fields of external_id are not null in the db , so let's tell the schema about it
  • Add a section id for container locations

• Katie Amaral:

  • Spreadsheet linking of top containers to archival objects

• Manny Rodriguez:

  • Many changes related to the agents module work

• Mark Triggs:

  • It's 2019 now so we can probably have bigger batches than this
  • Faster version of extract_string_values
  • Detect when a connection becomes read-only and reconnect
  • Bugfix: these variables can be accessed from multiple threads
  • Fix handling of nested DB.open calls when retries are happening
  • Threading bug fix for relationships
  • Shouldn't call a protected method here
  • Cope with ArrayList here too
  • Document a strange sequence of events that caused imports to silently rollback.
  • Bugfix: Don't mark failed jobs as "completed"
  • Don't blow up when indexing an accession with no title or date
  • Don't require URI patterns with placeholders to end in a slash
  • Ensure that realtime-indexing always sees up-to-date records
  • Reduce JSON parsing by storing extra data about records in a batch
  • ANW-1240 Add a new filter_query search parameter and use it for "Search within results"
  • Avoid adding blank lines on each poll loop in job output display
  • Log a warning if a configured plugin can't be found
  • Add a new render_plugin_partials hook for use by plugins
  • Add new current_record helper to return the currently displayed record object
  • Date calculator robustness: Dates shouldn't require zero padding for months or days
  • Show line breaks in the read-only raw view for note text

• Nick Butler:

  • ANW-977: add functionality of publish_partial_trees plugin

• Noah Geraci:

  • ANW-1083: MARCXML import field 730

• Payten Giles:

  • Show a link to the conflicting record when conflicting_record error is raised
  • Add custom sortable solr fields for dates
  • Fix NPE upon validation error when creating a repository
  • Bugfix: Clicking the 'X' button on a selected facet in a "Browse records" modal did nothing
  • Allow the search_embedded section id to be set
  • Ensure linker typehead dropdown is hidden when browsing/creating from a linker as sometimes blur leaves them visible
  • Fix any tree view sidebar changing the hash in the location, losing the current node context upon saving/refreshing the page
  • Merge advanced search criteria with any aq already on the URI
  • Fix contents empty validation error not showing label when content is omitted for a single part note
  • Fix notes type sync failing due to apostrophe in label
  • Allow an integer typed JSONModel schema field to be 0

• Peter Heiner:

  • avoid passing nil elements to Hash
  • call o.e.jetty.server.Server.new only once

• Steve Majewski:

  • mariadb fix for resource_list_report + extent_subreport
  • ANW-1200 : function became reserved word in MySQL 8.0.1

Total community contributions accepted: 58

JIRA Tickets and Pull Requests Completed

• PR: 1936: GH-1920 --C-- Fix bugs, listen for modal
• PR: 2060: Use github api for release notes [ci skip]
• PR: 2061: Hm qsa 110620
• PR: 2063: Staff UI accessibility enhancements
• PR: 2064: Update build status from Travis to GH Actions
• PR: 2071: mariadb fix for resource_list_report + extent_subreport
• PR: 2075: Confirm all notes, dates, etc. appear in view only display of subrecords
• PR: 2076: Check agent record has genders
• PR: 2077: Updated exports.rb documentation
• PR: 2078: Staff sidebar enhancements for agents
• PR: 2079: Light mode toggle
• PR: 2081: Fix for PUI slowness caused by unnecessary counting of record types
• PR: 2082: Add 'Publish All' to agents
• PR: 2086: Update agent display in pui
• PR: 2087: Update linked subjects when agent is saved
• PR: 2088: Expand subject linker by default
• PR: 2089: Add generic search route docs to API docs
• PR: 2090: Missing enumeration translations should default to the value
• PR: 2091: Agents PUI view updates pt.2
• PR: 2093: Agents PUI display update pt.3
• PR: 2095: Lightmode updates
• PR: 2097: Update name dates processing
• PR: 2098: Fix conflation of romanization and transliteration in agent names
• PR: 2099: Fix structured date templates to use type
• PR: 2100: Lightmode toggle only in edit
• PR: 2101: SDL pass type to template
• PR: 2102: Don't limit report to just repo 2
• PR: 2103 - Anw 429: Anw 429 MARC import enhancements
• PR: 2104: Use SDL common fields
• PR: 2105: PUI gender use value if translation not available
• PR: 2106: Fix to handle subnotes array and add type if not text
• PR: 2107: generate_accession_identifiers does not handle prefxes
• PR: 2108: Fix for EAD import bug when top-level descriptive identification has container info but no langmaterial
• PR: 2109: Update marcxml_base_map.rb to account for 099
• PR: 2111: Update dates type handling
• PR: 2112: Update OAI Provider resolve list
• PR: 2113: Only get required fields when needed per action
• PR: 2114: avoid passing nil elements to Hash
• PR: 2115 - ANW-429: ANW-429 Exports update 1
• PR: 2116: Marc auth export updates
• PR: 2117: EAC export updates
• PR: 2118 - ANW-695: ANW-695: Top Container CSV Export
• PR: 2119 - ANW-1015: ANW-1015: Adds External Documents to Assessment
• PR: 2120: call o.e.jetty.server.Server.new only once
• PR: 2121 - ANW-429: ANW-429 EAC import enhancements
• PR: 2122: Prevent loss of agent contact details, fixes #2110
• PR: 2123: Minor tweaks to marc export map
• PR: 2124 - ANW-1112: ANW-1112 Restrict merge if denied contact details
• PR: 2125: PUI tweaks
• PR: 2126 - ANW-429: ANW-429 Additional MARC/EAC import updates, new migration
• PR: 2127: Update LCNAF import to process multiple selections of subjects
• PR: 2128: Staff interface tweaks + fixes
• PR: 2131: Updates for the Docker environment:
• PR: 2134: use an environment variable ARCHIVESSPACE_VERSION rather than editing
• PR: 2135: Bump Docker to java 11 and include java 11 in tests
• PR: 2138 - ANW-689: ANW-689 and ANW-429 related agents enhancements
• PR: 2139 - ANW-429: ANW-429 Conference proceedings
• PR: 2140 - ANW-1217: ANW-1217 Only show same type agents in merge dropdown
• PR: 2141 - ANW-429: ANW-429 related agents publish
• PR: 2142 - ANW-429: ANW-429 account for conference proceedings
• PR: 2143 - ANW-1211: ANW-1211: Don't publish rel agents by default
• PR: 2144 - ANW-1228: ANW-1228 Related agents rest of name whitespace fix
• PR: 2145 - ANW-1225: ANW-1225: Clean trailing characters from MARC auth import
• PR: 2146: Removing irrelevant sections and export options from agents software form
• PR: 2147: Bulk Linking of Top Containers to Archival Objects
• PR: 2148 - ANW-1215: ANW-1215: Show specific relator if present in PUI
• PR: 2149 - ANW-1210: ANW-1210 hide related agent subrecords when there are more than 4
• PR: 2150 - ANW-1230: ANW-1230 Fix eac citation subnote export
• PR: 2151 - ANW-1227: ANW-1227: MARC export related agents 'w' and 'i' subfs
• PR: 2152 - ANW-1226: ANW-1226: EAC export related agents tags/attributes
• PR: 2153: Updating Translation values (EN)
• PR: 2155: Minor selenium cleanup
• PR: 2156 - ANW-1233: ANW-1233: Deprecate EAC export endpoints for software agents
• PR: 2158 - ANW-977: ANW-977: add functionality from the publish_partial_trees plugin
• PR: 2159: ANW-1232
• PR: 2165: update mimemagic gem to 0.3.8
• PR: 2168 - ANW-1173: ANW-1173 EAD import should support multiple s
• PR: 2169: Add shared-mime-info (required since mimemagic 0.3.8)
• PR: 2170 - ANW-1246: ANW-1246 Assign label to lightmode toggle button
• PR: 2173 - ANW-1232: ANW-1232: JSON validations for software agents excised fields
• PR: 2174 - ANW-913: ANW-913: Show warning when trying to merge 2 agents that have a relationship
• PR: 2178 - anw-1200: anw-1200 : function became reserved word in MySQL 8.0.1
• PR: 2179: Prevent OOM error by batching date records (migration 143)
• PR: 2181: Implements rubocop check and updates existing codebase
• PR: 2182 - ANW-1248: ANW-1248: Improve combobox accessibility
• PR: 2183 - ANW-1240: ANW-1240 Add a new filter_query search parameter and use it for "Search within results"
• PR: 2186 - ANW-1173: ANW-1151, ANW-1173 Don't try to create empty langmaterial note
• PR: 2187 - ANW-1238: ANW-1238 marc auth collection
• PR: 2189 - ANW-1219: ANW-1219 Add resource title and identifier to ao citations
• PR: 2190: Fixes 140 migration by checking for existing enum value before insert
• PR: 2191: fix errant merge conflict
• PR: 2192 - ANW-1174: ANW-1174 Import MARC extents that include only numbers and commas
• PR: 2193: remove these old unneeded scripts
• PR: 2194: Add log_bin_trust_function_creators=1 for github actions env
• PR: 2195 - ANW-251: ANW-251 Provide error for invalid restriction date
• PR: 2196 - ANW-1261: ANW-1261: Update translation files for foreign languages
• PR: 2197: Avoid adding blank lines on each poll loop in job output display
• PR: 2200 - ANW-1231: ANW-1231: Add tooltip for related agents fields
• PR: 2201 - ANW-1234: ANW-1234: Update translation values for agent relationship types
• PR: 2202: Set publish on subnotes the same as parent multi-part note in EAD importer
• PR: 2204 - ANW-1253: ANW-1253: Bugfix for merging linked top containers into unassociated top container
• PR: 2205 - ANW-1199: ANW-1199: Updating help links
• PR: 2206 - ANW-695: ANW-695: Apply stored search params to download CSV for top containers
• PR: 2207 - ANW-1083: ANW-1083: MARCXML import field 730
• PR: 2208: Hm qsa 041421
• PR: 2209 - ANW-1037: ANW-1037: UI tweaks for note_outline subform
• PR: 2210: Show line breaks in the read-only raw view for note text
• PR: 2211 - ANW-1267: ANW-1267 Remove default source and rules from MARCXML Auth Importer
• PR: 2212 - Anw 977: Anw 977 publish partial trees
• PR: 2213 - ANW-1036: ANW-1036: Adding dates field from name form to sort name string for software
• PR: 2214 - ANW-1259: ANW-1259 MARCXML Auth import 035 prepended with (DLC) source and type
• PR: 2215 - ANW-1269: ANW-1269: Updating tooltip labels for help links
• PR: 2221: upgrade rails to 5.2.5
  Total Pull Requests accepted: 113