| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
Please note that this documentation will use staff-side terminology rather than the default labels used in the Public Interface. For example, this documentation will use the word “Accessions” rather than “Unprocessed Material.” For a list of the differences between the default terms used in the staff interface vs. the public interface, please see Appendix A.
Features
Switch to to Staff Interface from the Public Interface
...
If you are currently logged into the Staff interface in the same browser that you are using to access the Public Interface, then you will see a “Staff Only” action button on those pages that you can access directly (including, for instance, resource, archival object, and even top container records, but excluding repository records). Note that you must have permissions to edit those records in the Staff interface, as well as permissions for that particular repository, otherwise the link will not resolve since you cannot actually edit that record. Here is an example of what the Staff Only action button looks like, from the context of an archival object page in the public interface:
Repository logo
...
Want to add a logo for your repository in the public interface? This can be done by adding a link to a web-accessible URL in the “Branding Image URL” field for that particular repository record in the staff interface. Previously this field has only been used by ArchivesSpace’s EAD export (XPath: /ead/eadheader/filedesc/publicationstmt/p[@id=’logostmt’/extref/@xlink:href) and EAD-to-PDF transformation process, but starting with version 2.1 it can also be used to include a repository logo in the staff interface.
Citation action button and the Preferred Citation note
...
There are two types of citation notes in the public interface: 1) partially-constructed citation notes, which will use the preferred citation note as entered in the staff interface’s notes module, and 2) fully-constructed citation notes, which will be dynamically created by elements already present in the description.
...
Notebook, Bali and C[hinese] Theatre Notes, 1932. Harold Acton papers, GEN MSS 663. Series III. Yale University Library Special Collections. http://pui.hudmol.com/repositories/3/archival_objects/1280 Accessed July 09, 2017.
Where:
“Notebook, Bali and C[hinese] Theatre Notes, 1932” is the Display String, which is constructed as the title of the archival object, concatenated with a comma and the first (but only the first!) date subrecord, as per the rules in place in the ArchivesSpace staff interface.
“Harold Acton papers” is the Resource title.
“GEN MSS 663. Series III.” is the composite identifier for the archival object, which is a configurable inheritance option for the new public interface.
“Yale University Library Special Collections” is the repository name.
“http://pui.hudmol.com/repositories/3/archival_objects/1280” is the URI of the archival object upon which the user has clicked the Citation action button.
“July 09, 2017” is the date when the Citation action button was clicked.
...
Multiple analog instances:
xxx
Series-based facets for top containers
...
xxx
Internal linking
...
You can use the “ref” EAD element along with it’s @href attribute in the staff interface to provide internal links within the same finding aid in the public interface. The advantage of using this… Here’s an example:
...
Please note, the “make representative” feature that’s in the staff interface is not yet used in the Public Interface. The following user story in JIRA might eventually be implemented so that a staff user can determine which digital object link to highlight: AR-XXXX.
Links between digital object records and accessions, resources, and archival objects
...
Agent links
...
Please note that if you provide a description of a relationship between two agents, the same description will appear on both agent landing pages. This behavior is the same in the staff interface as it is now in the public interface. You will need to keep this in mind when authoring any descriptive notes for agent relationships, since you cannot have two different descriptions written from different perspectives associated with the same relationship in ArchivesSpace 2.1. For example, if you were to link an agent record for Vincent Price and his mother, Marguerite Cobb Price, in the staff interface, it would be best to have the note reference both names since the same note will appear on both Vincent’s landing page as well as Marguerite’s, assuming that both agent records are published in the staff interface.
Publishing/unpublishing Agent records
...
In ArchivesSpace versions 2.0 and earlier, an agent record had to be published AND linked to a material description record (i.e. an accession, resource, digital object, or archival object) in order to appear in the public interface. Now that the new ArchivesSpace Public Interface also displays linked relationships between agent records, that restriction has been relaxed so that any agent record that is published in the staff interface will appear in the public interface. Please note this difference and review your the publication status of your agent records prior to turning on the ArchivesSpace Public Interface version 2.1. Remember, for instance, that every User and Repository record in ArchivesSpace also has an Agent record, so you will not want to publish all of your ArchivesSpace agent records in the staff interface.
Embedded metadata
...
Metadata about agents (corporate bodies and persons) and resource level pages is embedded in the PUI by default, using the schema.org vocabulary (and one extension for “archival collections” currently used in OCLC’s WorldCat database). As adoption increases, and the Architypes’ proposed schema.org extension is realized, these metadata mappings should be updated and expanded to other parts of the public interface.
See this JIRA ticket for the mappings used in ArchivesSpace 2.1 (but note that the Repository mappings have not yet been put into place): https://archivesspace.atlassian.net/browse/AR-1484
You can test out these new features by going to Google’s Structured Data Testing Tool, https://search.google.com/structured-data/testing-tool, and pasting in a URI from the public interface for a resource or person/corporate body agent record.
Customizable features
Archival Inheritance
...
With the new version of the Public Interface, all elements of description can be inherited. This is especially important since the PUI displays each level of description as its own webpage.
...
Additionally, the identifier element in ArchivesSpace, which is better known as the Reference Code in ISAD-G and DACS, can be inherited in a composite manner. When inherited in a composite manner, the inherited elements will be concatenated together. In other words, an identifier at the item level could look like this: MSS 1. Series A. Item 1. Though the archival object has an identifier of “Item 1”, a composite identifier is displayed since the collection series-level record to which the item belongs has an identifier of “MSS 1”"Series A”, which in turn also belongs to a seriescollection-level record that has an identifier of “Series A”“MSS 1”.
By default, the following elements are turned on for inheritance:
Title (direct inheritance)
Identifier (indirect inheritance, but it is advised to inherit this element in a composite fashion once it is determined whether the level of description should or should not display as part of the identifier, which will depend upon local data-entry practices)
Language note, or code (direct inheritance, but there is a bug keeping this from displaying with the 2.1 release; when fixed, it should be set to indirect by default.)
Dates (direct inheritance)
Extents (direct inheritance... should be changed to indirect by default)
Creator (indirect inheritance)
Access restrictions note (direct inheritance)
Scope and contents note (indirect inheritance)
See https://github.com/archivesspace/archivesspace/blob/master/common/config/config-defaults.rb#L296-L396 for more information and examples.
Also, a video overview of this feature, which was recorded before development was finished, is available online: https://vimeo.com/195457286
Request action button
...
By default, this action button is turned off. This feature has been configured in the Test Corpus, however, so that a Gmail email account is used to 1) email users with information about their request, and 2) to email staff detailed information about the user’s request. The information that is included in a request is detailed in the following JIRA ticket: https://archivesspace.atlassian.net/browse/AR-1660
See https://github.com/archivesspace/archivesspace/blob/master/common/config/config-defaults.rb#L493-L524 for more information about how to configure this option.
Additional Customizations
...
Search the configuration file, https://github.com/archivesspace/archivesspace/blob/master/common/config/config-defaults.rb, for “pui” and “public” for other options that can be configured easily.
The labels used in the PUI may also be configured in whichever YML file is used: https://github.com/archivesspace/archivesspace/tree/master/public/config/locales
Known Bugs
...
...
...
Appendices
Appendix A
Staff-side default label | Public-side default label |
Resource | Collection |
Accession | Unprocessed Material |
Digital Object | Digital Material |
Agents | Names |
Classifications | Record Groups |
...