2025-11-10 Meeting Notes
Participants
@Susannah Broyles
@Kelly Kress
@Noah Lasley
@Nick Pavlik
@Brian Zelip
Links
Usability Google drive: https://drive.google.com/drive/folders/1_HqE4OszPNI7Bt_jtTjchqqQWkGYADCT
Jira Bug board: https://archivesspace.atlassian.net/secure/RapidBoard.jspa?rapidView=15
Jira Feature requests: https://archivesspace.atlassian.net/secure/RapidBoard.jspa?rapidView=16
Discussion topics/Notes
Topic | Notes |
|---|---|
Review of Configuration Setting HTML / User Interface exploration documentation (below) |
|
Configuration Settings
NOTE: Rows with blue background identify PUI settings
Config Setting | Config Parameter | Can it be a preference? | Preference Type | Notes from 2025-10-08 Technical Discussion | UI Exploration / Documentation Assignee | UI Exploration / Documentation | Value Type | Input Location |
|---|---|---|---|---|---|---|---|---|
Display identifiers in PUI collection organization tree | AppConfig[:pui_display_identifiers_in_resource_tree] | Yes | Public | Data comes from the 'Component Unique Identifier' field in the edit form | @Noah Lasley | <label>Display identifiers in PUI collection organization tree?</label>
<input type="checkbox">
has-tooltip title="Whether to display archival record identifiers in the PUI collection organization tree" | Boolean | PUI setting section (to be added, under System?) |
Maximum number of columns to display when searching or browsing | AppConfig[:max_search_columns] | Yes | Global | Requires schema change, might be a bigger project than expected. It could require the same permission as changing columns | Susannah | <label>Maximum number of columns to display when searching or browsing</label>
<input type="number" value="7" min="1"> | Integer | General settings section all 3 preference scopes |
Feedback link in PUI footer | AppConfig[:feedback_url] | Yes | Public |
| @Noah Lasley | <label>Feedback URL</label>
<input type="url" value="https://archivesspace.org/contact">
has-tooltip title="URL to direct the feedback link. You can remove this from the footer by making the value blank." | Text (String) | PUI setting section (to be added, under System?) |
Visibility of "Load Digital Objects" button at Resource Level during bulk import | AppConfig[:hide_do_load] | Yes | Repository |
|
| <label>Load Digital Objects button visible at resource level?</label>
<input type="checkbox">
has-tooltip title="Specifies whether the Load Digital Objects button is available at the Resource Level." | Boolean | General settings section all 3 preference scopes |
Abstract note length in collections overview page | AppConfig[:abstract_note_length] | Yes | Public |
| Susannah |
<label>Abstract note length</label>
<input type="number" value="500" min="50" step="10">
| Integer | PUI setting section (to be added, under System?) |
Expose external IDs in the frontend | AppConfig[:show_external_ids] | Yes | Global | Used in at least abstract archival objects, events, and subjects | Kelly | <label>Show external IDs></label>
<input type="checkbox"> | Boolean | PUI setting section to be added |
AppConfig[:pui_hide] | Yes | Public | Relates to the global header navigation | Kelly | <label>
<input type="checkbox">Repositories
</label>
<input type="text" disabled placeholder="Repositories">
<label>
<input type="checkbox">Resources
</label>
<input type="text" disabled placeholder="Resources">
<label>
<input type="checkbox">Digital Objects
</label>
<input type="text" disabled placeholder="Digital Objects
<label>
<input type="checkbox">Accessions
</label>
<input type="text" disabled placeholder="Accessions">
<label>
<input type="checkbox">Subjects
</label>
<input type="text" disabled placeholder="Subjects">
<label>
<input type="checkbox">Agents
</label>
<input type="text" disabled placeholder="Agents"
<label>
<input type="checkbox">Subjects
</label>
<input type="text" disabled placeholder="Subjects">
<label>
<input type="checkbox">Agents
</label>
<input type="text" disabled placeholder="Agents">
<label>
<input type="checkbox">Classifications
</label>
<input type="text" disabled placeholder="Classifications"> | Boolean and String | PUI setting section to be added | |
AppConfig[:pui_hide] | Yes | Public | Relates to the 'badge' navigation links on a repository page |
| <label>
<input type="checkbox">Resource badge
</label>
<input type="text" disabled placeholder="Resources">
<label>
<input type="checkbox">Record badge
</label>
<input type="text" disabled placeholder="Records">
<label>
<input type="checkbox">Digital Object badge
</label>
<input type="text" disabled placeholder="Digital Materials">
<label>
<input type="checkbox">Accessions badge
</label>
<input type="text" disabled placeholder="Unprocessed Materials">
<label>
<input type="checkbox">Subject badge
</label>
<input type="text" disabled placeholder="Subjects"
<label>
<input type="checkbox">Agent badge
</label>
<input type="text" disabled placeholder="Names">
<label>
<input type="checkbox">Agents
</label>
<input type="text" disabled placeholder="Agents">
<label>
<input type="checkbox">Classification badge
</label>
<input type="text" disabled placeholder="Record Gruops"> | Boolean and String | PUI setting section to be added | |
AppConfig[:default_page_size] | Yes | Global |
| Kelly | <label>Default page size</label>
<input type="number" value="10" min= max="250" step=
add minimum and maximum | Integer | General settings, Global scope | |
AppConfig[:search_default_scope] | Yes | Repository | Preferable over global preference | @Noah Lasley | <label>Default search scope setting</label>
<select>
<option value="all_record_types" selected>All record types</option>
<option value="collections_only">Collections only</option>
</select> | Radio Buttons | General Settings, Repository scope | |
AppConfig[:help_enabled] | Yes | Public |
|
| <label>Help enabled</label>
<input type="checkbox"> | Boolean | PUI setting section to be added | |
AppConfig[:help_url] | Yes | Public |
|
| <label>Help URL</label>
<input type="url" value="https://archivesspace.atlassian.net/wiki/spaces/ArchivesSpaceUserManual/overview"> | String | PUI setting section to be added | |
AppConfig[:help_topic_base_url] | Yes | Public |
|
| <label>Help Topic Base URL</label>
<input type="url" value="https://archivesspace.atlassian.net/wiki/spaces/ArchivesSpaceUserManual/pages/"> | String | PUI setting section to be added | |
AppConfig[:enable_custom_reports] | Maybe | Repository | Requires caution, changes could crash the application; might require constraining access via a new permission | @Noah Lasley | <label>Enable custom reports?</label>
<input type="checkbox">
has-tooltip title="USE WITH CAUTION - Running custom reports that are too complex may cause ArchivesSpace to crash" | Boolean | General settings section all 3 preference scopes | |
AppConfig[:pui_expand_all] | Yes | Public |
| @Noah Lasley | <label>Expand all additional information blocks at the bottom of record pages by default?</label>
<input type="checkbox"> | Boolean | PUI setting section to be added | |
Record inheritance (define fields that are inherited from ancestors if they don't have a value in the record itself) | AppConfig[:record_inheritance] | No | N/A | Requires reindexing | N/A | N/A | N/A | N/A |
AppConfig[:plugins] | No | N/A | Plugins can alter app behavior, disabling can break DB migrations, etc. | N/A | N/A | N/A | N/A |
Preliminary / WIP settings analysis
ArchivesSpace Configuration Parameter Usage Analysis (Focused List)
This document provides analysis of specific configuration parameters requested and their usage across the ArchivesSpace codebase.
Note: Configuration definition files in common/config/ are excluded from 'common' directory usage counts.
Summary
Total Configuration Parameters Analyzed: 24
Parameters with Usage: 18
Parameters with No Usage Found: 6
Usage by Top-Level Directory
backend: 2 parameters
common: 3 parameters
frontend: 10 parameters
public: 8 parameters
reports: 1 parameters
Detailed Parameter Analysis
AppConfig[:abstract_note_length]
Used in: public
Files:
./public/app/views/shared/_result_record_summary.html.erb
AppConfig[:default_page_size]
Used in: backend, frontend
Files:
./backend/app/lib/rest.rb./backend/spec/controller_agent_corporate_entity_spec.rb./frontend/spec/features/pagination_spec.rb
AppConfig[:enable_custom_reports]
Used in: frontend, reports
Files:
./frontend/app/views/shared/_header_repository.html.erb./frontend/config/routes.rb./frontend/spec/spec_helper.rb./reports/custom/custom_report.rb
AppConfig[:feedback_url]
Used in: frontend, public
Files:
./frontend/app/views/site/_footer.html.erb./public/app/views/shared/_footer.html.erb
AppConfig[:help_enabled]
Used in: frontend
Files:
./frontend/config/initializers/help.rb
AppConfig[:help_topic_base_url]
Used in: frontend
Files:
./frontend/config/initializers/help.rb
AppConfig[:help_url]
Used in: frontend
Files:
./frontend/config/initializers/help.rb
AppConfig[:hide_do_load]
Used in: frontend
Files:
./frontend/app/views/resources/_bulk_import_form.html.erb
AppConfig[:max_search_columns]
Used in: common, frontend
Files:
./common/schemas/defaults.rb./frontend/app/helpers/search_helper.rb./frontend/app/views/defaults/_template.html.erb
AppConfig[:plugins]
Used in: backend, common, frontend, public
Files:
./backend/app/main.rb./common/asutils.rb./common/db/db_migrator.rb./common/db/migrations/060_top_container_migration.rb./common/db/migrations/066_remove_top_container_legacy_restricted.rb./common/spec/appconfig_spec.rb./common/spec/jsonmodel_spec.rb./frontend/config/initializers/plugin.rb./public/app/models/finding_aid_pdf.rb
AppConfig[:pui_display_identifiers_in_resource_tree]
Used in: public
Files:
./public/app/views/layouts/application.html.erb
AppConfig[:pui_expand_all]
Used in: public
Files:
./public/app/views/agents/show.html.erb./public/app/views/shared/_record_innards.html.erb./public/app/views/subjects/show.html.erb
AppConfig[:pui_hide]
Used in: analyze_focused_config_usage.rb, public
Files:
./analyze_focused_config_usage.rb./public/app/models/repository.rb./public/app/views/repositories/_badge.html.erb./public/app/views/resources/_resource_alltabs.erb./public/app/views/shared/_navigation.html.erb./public/config/initializers/public_new_defaults.rb./public/spec/spec_helper.rb
AppConfig[:pui_hide][:repositories]
Used in: analyze_focused_config_usage.rb
Files:
./analyze_focused_config_usage.rb
AppConfig[:pui_hide][:search_tab]
Used in: public
Files:
./public/app/views/shared/_navigation.html.erb
AppConfig[:record_inheritance]
Used in: common
Files:
./common/record_inheritance.rb
AppConfig[:search_default_scope]
Used in: public
Files:
./public/app/helpers/search_config_helper.rb./public/spec/controllers/search_controller_spec.rb
AppConfig[:show_external_ids]
Used in: frontend
Files:
./frontend/app/helpers/application_helper.rb
Unused Parameters
The following configuration parameters were searched for but no usage was found in the codebase:
AppConfig[:pui_hide][:accessions]AppConfig[:pui_hide][:agents]AppConfig[:pui_hide][:classifications]AppConfig[:pui_hide][:digital_objects]AppConfig[:pui_hide][:resources]AppConfig[:pui_hide][:subjects]