Difference between revisions of "Appraisal Arrangement tab"
| (17 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
[[Main Page]] > [[Development]] > [[Requirements]] > Appraisal and Arrangement Tab | [[Main Page]] > [[Development]] > [[Requirements]] > Appraisal and Arrangement Tab | ||
| + | |||
| + | <div style="padding: 10px 10px; border: 1px solid black; background-color: #F79086;">This page is no longer being maintained and may contain inaccurate information. Please see the [https://www.archivematica.org/docs/latest/ Archivematica documentation] for up-to-date information.</div><p> | ||
| + | |||
| + | [[Category:Feature requirements]] | ||
== Background == | == Background == | ||
| − | The Bentley Historical Library has a Mellon grant which is sponsoring development on the foundational project to create an Appraisal and Arrangement tab. This tab will function as a place between Transfer and Ingest where archivists can make archival appraisal decisions with material from Transfer, and structure an arrangement for the SIP before starting Ingest processes. As of the Archivematica 1.3.0 release, the arrangement/appraisal decisions are made at the top of the Ingest tab by selecting transfers from the [https:// | + | The Bentley Historical Library has a Mellon grant which is sponsoring development on the foundational project to create an Appraisal and Arrangement tab. This tab will function as a place between Transfer and Ingest where archivists can make archival appraisal decisions with material from Transfer, and structure an arrangement for the SIP before starting Ingest processes. As of the Archivematica 1.3.0 release, the arrangement/appraisal decisions are made at the top of the Ingest tab by selecting transfers from the [https://www.archivematica.org/en/docs/archivematica-1.3/user-manual/ingest/ingest/#arrange-sip backlog for arrangement]. This process, including the transfer backlog search, is to be moved into the new Appraisal and Arrangement tab. |
Older requirements for similar functionality: | Older requirements for similar functionality: | ||
| Line 9: | Line 13: | ||
* [[Transfer backlog requirements]] | * [[Transfer backlog requirements]] | ||
| + | === Interim development === | ||
| + | |||
| + | Mid-way development feedback is available as a narrative [https://docs.google.com/document/d/1LZ0D1HbVRM4JDzj84ANK0XRsO0Z13LFlRKhS6yQjLi4/edit# here] and as an itemized spreadsheet [https://docs.google.com/spreadsheets/d/1UvATSsHJUJh9A-3CxHVJnCI_zArTh5aQXFpUvUjyxKc/edit#gid=75756948 here]. | ||
== Requirements == | == Requirements == | ||
| Line 38: | Line 45: | ||
What are the requirements for querying or filtering the data gathered above? | What are the requirements for querying or filtering the data gathered above? | ||
| + | |||
| + | === Workflow questions === | ||
| + | |||
| + | These are some questions related to workflow that have arisen since the early development of the Tab: | ||
| + | |||
| + | Given the ability to produce a refined list of digital objects in the File List pane: | ||
| + | |||
| + | 1. Is it necessary to be able to filter by format or PUID from the backlog, or only from the refined list? | ||
| + | |||
| + | Sample workflow: | ||
| + | * User performs search of backlog and populates backlog pane | ||
| + | * User selects transfers relevant to their purpose | ||
| + | * User '''then''' filters the selected transfers by a specific file type, which populates the File List pane? | ||
| + | |||
| + | '''Answer''': Selections from the backlog pane inform what shows up on the analysis pane and selections from the analysis pane in turn inform what shows up in the file list. Actually, that's why we'd like to be able to click on more than one piece of the pie at a time, or on more than one file type from the report at a time, or on a FPR group. | ||
| + | |||
| + | 2. From where does a user drag files in order to create a SIP? From backlog, the File List pane, or both? | ||
| + | |||
| + | '''Answer''': In our discussions, the user would drag and drop from the backlog. This is because, at least for us, arrangement will most likely be based on the original directory structure or the tags we've applied, but probably not often on something like file format or type (important for appraisal to be sure, but not so much, at least for us, for arrangement). As such, dragging and dropping right from the file list isn't something we really considered. | ||
| + | |||
| + | For an example of a workflow that might use the Appraisal tab and the Archivematica/ArchivesSpace integration see [[Archivematica to ArchivesSpace Workflow]] | ||
| + | |||
| + | == User Stories == | ||
| + | |||
| + | These are some user stories added during development as final requirements are being defined: | ||
| + | |||
| + | '''Moving Files to Different Digital Object Components''' | ||
| + | |||
| + | As an archivist, I need to move files dragged to a resource in the ArchivesSpace pane to different locations in the arrangement, so that I can change the arrangement as new relationships become apparent. Without this ability, I would need to think about and note the arrangement of files before beginning to drag them from a package in the backlog and would not easily be able to fix mistakes. | ||
| + | |||
| + | '''Adding Multiple Files to a Digital Object Component''' | ||
| + | |||
| + | As an archivist, I need to drag a folder of files from a package in the backlog to the same digital object component, so that I can easily add large numbers of items to a resource without having to move each file individually. For this reason, I also need to be able to drag multiple selected files within a folder from a transfer package to a digital object component. | ||
| + | |||
| + | '''Controlling File Order Under Digital Object Components''' | ||
| + | |||
| + | As an archivist, I need to be able to control the order of items grouped under digital object components in the Appraisal tab, so that I can order the items in a way that is meaningful to understanding the files and/or conducive to users finding items. It would be helpful if Archivematica defaulted to sorting alphanumerically by filename but also allowed me to change the order manually. | ||
== Mockups == | == Mockups == | ||
| + | |||
| + | '''Version 1 of the transfer backlog/reporting pane:''' | ||
| + | |||
| + | [[Image:Appraisal_Arrangement_tab_pane_mockups_-_Transfer_backlog_pane.png|700 px]] | ||
| + | |||
| + | '''Screenshots during interim development period, July 2015:''' | ||
| + | |||
| + | [[Image:a_a_tab_July2015_1.png|700 px]] | ||
| + | |||
| + | [[Image:a_a_tab_July2015_2.png|700 px]] | ||
| + | |||
| + | New functionality identified during this period includes tagging content while processing the backlog, as an "aide memoire"- in this example, a reminder that some material will be discarded from the accession. | ||
| + | |||
| + | [[Image:a_a_tab_July2015_3.png|700 px]] | ||
| + | |||
| + | Detail of potential ArchivesSpace workflow- editing metadata to change title, date, level of description and general note. | ||
| + | |||
| + | [[Image:ArchivesSpace_workflow.png|700 px]] | ||
| + | |||
| + | '''Screenshots taken during development January/February 2016''' | ||
| + | |||
| + | Files from packages sent to the backlog in Archivematica can be dragged to digital object components which have been added to archival objects in the ArchivesSpace pane. | ||
| + | |||
| + | [[Image:Feb2016 Backlog ArchivesSpace panes.png|700 px]] | ||
| + | |||
| + | Tags can be added to files in the backlog. | ||
| + | |||
| + | [[Image:Feb2016 adding tags.png|500 px]] | ||
| + | |||
| + | Files selected in the backlog appear in the Analysis pane which can be used to populate the File List pane. Tags can also be added here. | ||
| + | |||
| + | [[Image:Feb2016 Analysis FileList panes.png|700 px]] | ||
| + | |||
| + | The Analysis pane also includes options for creating visualizations. | ||
| + | |||
| + | [[Image:Feb2016 Analysis pane visulalization.png| 700 px]] | ||
== Technical architecture == | == Technical architecture == | ||
| + | |||
| + | An initial mockup of the appraisal tab has been started, developed as an Angular.js app. The code is available on [https://github.com/artefactual-labs/appraisal-tab github]. | ||
| + | |||
| + | The basic idea is to create an Angular app, that communicates with the Archivematica Dashboard via its REST api. | ||
| + | |||
| + | More details [[Appraisal Tab Architecture]] | ||
| + | |||
| + | == Improvements == | ||
| + | |||
| + | For discussion about possible enhancements to the Appraisal arrangement tab, see: | ||
| + | |||
| + | * [[Improvements/Appraisal]] | ||
Latest revision as of 17:15, 11 February 2020
Main Page > Development > Requirements > Appraisal and Arrangement Tab
Background[edit]
The Bentley Historical Library has a Mellon grant which is sponsoring development on the foundational project to create an Appraisal and Arrangement tab. This tab will function as a place between Transfer and Ingest where archivists can make archival appraisal decisions with material from Transfer, and structure an arrangement for the SIP before starting Ingest processes. As of the Archivematica 1.3.0 release, the arrangement/appraisal decisions are made at the top of the Ingest tab by selecting transfers from the backlog for arrangement. This process, including the transfer backlog search, is to be moved into the new Appraisal and Arrangement tab.
Older requirements for similar functionality:
Interim development[edit]
Mid-way development feedback is available as a narrative here and as an itemized spreadsheet here.
Requirements[edit]
Data[edit]
Data gathered during the Transfer stage has the potential to be used in the Appraisal/Arrangement tab for reports and visualizations. Below is a (currently unordered) list of potentially required data:
- What data points about the objects themselves? Filename, format, MIME type, other?
- Bulk Extractor reports (which ones? how to view?)
- Directory printer text file -or- METS.xml structMap (same info)
- File format information (grouped by file extension? by PRONOM ID?)
- Size of content (space on disk), number of files
- Viewer based on format ID
- logs (virus scan, format identification, etc)
- Other?
ArchivesSpace resources[edit]
See also ArchivesSpace integration requirements
How will ArchivesSpace resources be displayed for matching? Questions for requirements gathering:
- How many resources and at what level should be loaded in the tab?
- What options does the user have to search for existing resources?
- How does the user create a new resource?
- What data points are displayed (labels, level of description, other)?
Querying/filtering[edit]
What are the requirements for querying or filtering the data gathered above?
Workflow questions[edit]
These are some questions related to workflow that have arisen since the early development of the Tab:
Given the ability to produce a refined list of digital objects in the File List pane:
1. Is it necessary to be able to filter by format or PUID from the backlog, or only from the refined list?
Sample workflow:
- User performs search of backlog and populates backlog pane
- User selects transfers relevant to their purpose
- User then filters the selected transfers by a specific file type, which populates the File List pane?
Answer: Selections from the backlog pane inform what shows up on the analysis pane and selections from the analysis pane in turn inform what shows up in the file list. Actually, that's why we'd like to be able to click on more than one piece of the pie at a time, or on more than one file type from the report at a time, or on a FPR group.
2. From where does a user drag files in order to create a SIP? From backlog, the File List pane, or both?
Answer: In our discussions, the user would drag and drop from the backlog. This is because, at least for us, arrangement will most likely be based on the original directory structure or the tags we've applied, but probably not often on something like file format or type (important for appraisal to be sure, but not so much, at least for us, for arrangement). As such, dragging and dropping right from the file list isn't something we really considered.
For an example of a workflow that might use the Appraisal tab and the Archivematica/ArchivesSpace integration see Archivematica to ArchivesSpace Workflow
User Stories[edit]
These are some user stories added during development as final requirements are being defined:
Moving Files to Different Digital Object Components
As an archivist, I need to move files dragged to a resource in the ArchivesSpace pane to different locations in the arrangement, so that I can change the arrangement as new relationships become apparent. Without this ability, I would need to think about and note the arrangement of files before beginning to drag them from a package in the backlog and would not easily be able to fix mistakes.
Adding Multiple Files to a Digital Object Component
As an archivist, I need to drag a folder of files from a package in the backlog to the same digital object component, so that I can easily add large numbers of items to a resource without having to move each file individually. For this reason, I also need to be able to drag multiple selected files within a folder from a transfer package to a digital object component.
Controlling File Order Under Digital Object Components
As an archivist, I need to be able to control the order of items grouped under digital object components in the Appraisal tab, so that I can order the items in a way that is meaningful to understanding the files and/or conducive to users finding items. It would be helpful if Archivematica defaulted to sorting alphanumerically by filename but also allowed me to change the order manually.
Mockups[edit]
Version 1 of the transfer backlog/reporting pane:
Screenshots during interim development period, July 2015:
New functionality identified during this period includes tagging content while processing the backlog, as an "aide memoire"- in this example, a reminder that some material will be discarded from the accession.
Detail of potential ArchivesSpace workflow- editing metadata to change title, date, level of description and general note.
Screenshots taken during development January/February 2016
Files from packages sent to the backlog in Archivematica can be dragged to digital object components which have been added to archival objects in the ArchivesSpace pane.
Tags can be added to files in the backlog.
Files selected in the backlog appear in the Analysis pane which can be used to populate the File List pane. Tags can also be added here.
The Analysis pane also includes options for creating visualizations.
Technical architecture[edit]
An initial mockup of the appraisal tab has been started, developed as an Angular.js app. The code is available on github.
The basic idea is to create an Angular app, that communicates with the Archivematica Dashboard via its REST api.
More details Appraisal Tab Architecture
Improvements[edit]
For discussion about possible enhancements to the Appraisal arrangement tab, see: