Inconsistencies in which finding aid data fields are displayed to end users

Description

If you fill in every field in the Finding Aid Data section of a resource in the staff interface, some fields are not displayed in the PUI, and/or the PDFs (there are two kinds: generated by the PUI when a user clicks the Print button and generated by the backend triggered by a job run in the staff interface). But pretty much all are searchable using the default keyword search, and included in EAD exports.

The following table summarizes this:

Field

Displayed in PUI HTML

Displayed in PUI PDF

Displayed in backend PDF

Searchable in PUI

Included in EAD export

EAD ID

No

No

No

Yes

Yes

EAD Location

No

No

No

Yes

No

Finding Aid Title

Yes

Yes

No

Yes

Yes

Finding Aid Subtitle

Yes

Yes

Yes

Yes

Yes

Finding Aid Filing Title

No

Yes

Yes

Yes

Yes

Finding Aid Date

Yes

No

No

Yes

Yes

Finding Aid Author

Yes

No

No

Yes

Yes

Description Rules

Yes

Yes

Yes

Only abbreviated form

Yes

Language of Description

Yes

Yes

No

Only ISO 639-2 code

Only EAD3, not EAD2002

Script of Description

Yes

No

No

Only ISO 15924 code

Only EAD3, not EAD2002

Language of Description Note

Yes

No

Yes

Yes

Yes

Sponsor

Yes

No

No

Yes

Yes

Edition Statement

Yes

Yes

Yes

Yes

Yes

Series Statement

No

No

No

Yes

Yes

Finding Aid Status

Yes

No

No

Only as code in resource_finding_aid_status

Yes

Finding Aid Note

No

No

No

Yes

Yes

Some of these seem like they should at least be displayed in the PUI HTML, in the "Finding Aid & Administrative Information" section. But because these are all simple text fields, and therefore don't have publish checkboxes, any decision to display them needs to work for everyone. For example, I have been asked by archivists here at the Bodleian to make the Finding Aid Note visible, because we use it to give credit to contributors beyond the author of the finding aid. But other institutions may have decided to use it for staff-only notes (however, if so, they may not be aware the contents are searchable and included in the EAD, and therefore the OAI-PMH feed.)

I'd say that anything which is displayed in the PUI HTML should be displayed in both types of PDF, but if so where?

Anything which is, by design, not displayed to end users should probably be skipped by the indexer, so peopel are not confused by records which match their search query without any visible reason why.

Does anyone have any opinions on what should be displayed where in a stock ArchivesSpace system? Anything can be changed via plug-ins, but we're trying to reduce the number of templates we override, as they each require review whenever upgrading to a new core release.

Environment

None

Activity

Show:

Diane BiunnoJanuary 24, 2025 at 7:58 PM

Metadata discussed this ticket during our meeting on 1/7/25: Regarding the EAD 2.0 export for language/script of description : Within the <profiledesc> portion of the <eadheader> an optional subelement <langsage> can be used to provide information about the languages, sublanguages, and dialects represented in the finding aid. The language(s) in which the finding aid is written can be further specified using the <language> subelement within <langusage>. For bilingual or multilingual finding aids, either identify each language in a separate <language> element, or mention only the predominant language. The LANGCODE attribute can be used to provide the three-letter ISO 639-2b code for the language. The SCRIPTCODE attribute may be used to specify the ISO 15924 code for the script in which the language is written.

Regine HeberleinMay 2, 2023 at 5:49 PM

Metadata will address this as part of their review of export functionality next term.

Althea TopekNovember 1, 2022 at 5:16 PM
Edited

DevPri discussed this ticket at the November 2022 meeting and recommend:

  1. No changes should be made to fields searchable in the PUI

  2. Fields should display consistently

  3. Do not add an option to publish certain fields (a new ticket should be created if this is a future issue for users)

  4. Metadata standards should review the EAD export display issues before passing the ticket

The table in my October 21 comment has been updated to reflect the November 2022 DevPri discussion

Andrew MorrisonOctober 24, 2022 at 8:28 AM

Some notes:

  • Backend PDFs are generated from EAD, hence you cannot have "No" in the latter column and "Yes" in the former.

  • If display of certain fields are optional in the PUI because they might contain confidential information, then they should also be optional in EAD (because otherwise they'll be made public via OAI-PMH) and backend PDFs (because some ArchivesSpace members, such as Yale, serve backend PDFs via their public web sites.)

  • Are end users likely to want to search for the finding aid's author, or the language/script it is written in? It means someone searching for English poetry will get back results including poetry in all other languages, as long as they are described in English. Or someone searching for Paris will get back results including any collections catalogued by someone with Paris in their name. It might be better to give such fields their own dedicated indexes, for searching/filtering in the staff interface.

Althea TopekOctober 21, 2022 at 7:32 PM
Edited

Usability reviewed this ticket at the October 2022 meeting and created a new chart documenting optimal display outcomes. We recommend at least two fields (Sponsor; Finding Aid Note) are optional to publish. All other fields should display consistently. We also recommend the Finding Aid Date, Finding Aid Author, and Script of Description display on the PDF title page.

Field

Displayed in PUI HTML

Displayed in PUI PDF

Displayed in backend PDF

Searchable in PUI

Included in EAD export

EAD ID

Yes

Yes

Yes

Yes

metadata to review

EAD Location

Yes

Yes

Yes

Yes

metadata to review

Finding Aid Title

Yes

Yes

Yes

Yes

metadata to review

Finding Aid Subtitle

Yes

Yes

Yes

Yes

metadata to review

Finding Aid Filing Title

Yes

Yes

Yes

Yes

metadata to review

Finding Aid Date

Yes

Yes (on title page)

Yes (on title page)

Yes

metadata to review

Finding Aid Author

Yes

Yes (on title page)

Yes (on title page)

Yes

metadata to review

Description Rules

Yes

Yes

Yes

Only abbreviated form

metadata to review

Language of Description

Yes

Yes

Yes

Only ISO 639-2 code

metadata to review

Script of Description

Yes

Yes (next to Language of Description)

Yes (next to Language of Description)

Only ISO 15924 code

metadata to review

Language of Description Note

Yes

Yes

Yes

Yes

metadata to review

Sponsor (add publish option)

Yes

Yes

Yes

Yes

metadata to review

Edition Statement

Yes

Yes

Yes

Yes

metadata to review

Series Statement

Yes

Yes

Yes

Yes

metadata to review

Finding Aid Status

Yes

Yes

Yes

Only as code in resource_finding_aid_status

metadata to review

Finding Aid Note (add publish option)

Yes

Yes

Yes

Yes

metadata to review

Details

Assignee

Reporter

Priority

Harvest Time Tracking

Open Harvest Time Tracking

Created March 16, 2020 at 12:04 PM
Updated January 24, 2025 at 7:58 PM
Harvest Time Tracking