Archivematica - User contributions [en]

Appraisal Arrangement tab

2016-04-13T23:47:56Z

Bgormly:

[[Main Page]] > [[Development]] > [[Requirements]] > Appraisal and Arrangement Tab

== 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://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:
* [[Transfer and SIP creation]]
* [[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 ==

=== Data ===

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 ===
See also [[ArchivesSpace_integration|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 ===

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 ==

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

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]]

Archivematica to ArchivesSpace Workflow

2016-04-13T23:37:19Z

Bgormly:

[[Main Page]] > [[Development]] > [[Requirements]] > [[Appraisal Arrangement tab]] > Archivematica to ArchivesSpace Workflow

This page describes a basic Archivematica to ArchivesSpace workflow. It details the steps that would be taken to transfer, analyze, arrange, and create a Submission Information Package (SIP) from files transferred to Archivematica using the Appraisal tab.

== Send a Transfer to Backlog ==

In order to work with files in the Appraisal tab, they first must be in a transfer in Archivematica’s backlog.

1. The user provides a transfer name and uses browse to find the directory that will be transferred to Archivematica. S/he clicks “Add” and “Start transfer.”

[[Image:start_transfer.png|700 px]]

2. S/he approves the transfer and proceeds through the Transfer micro-services as needed for the particular transfer.

3. When the transfer reaches the micro-service “Create SIP from Transfer,” the user chooses “send to backlog” in the job “Create SIP(s).”

[[Image:create_SIP.png|700 px]]

== Searching the Backlog and Adding Tags ==

Now the user must locate the transfer in the backlog. The tags feature can also be used to identify information relevant for appraisal and arrangement.

1. The user navigates to the Appraisal tab (between Transfer and Ingest) and enters search terms/parameters in the search box at the top of the page to find the transfer.

[[Image:searching_backlog.png|700 px]]

2. The user then adds tags to identify information already known about the files. In this case, files that are part of the same series are identified.

[[Image:backlog_tags.png|500 px]]

== Analyzing Files Using the Analysis and File List Panes ==

At this point, the user might not know enough about the files to determine their place in the arrangement or even if they belong in the SIP. The Analysis and File List panes can be used to learn more about the transfer.

1. First, the user gains an overview of information about the files by selecting the files in the Backlog pane and clicking on Objects in the Analysis Pane. This generates a report with information such as the format and size of the files. Visualizations can also be used to gain an overview of the files.

[[Image:analysis_objects.png|700 px]]

2. Some files need further examination. They are selected in Analysis, adding them to the File List.

[[Image:analysis_file_list.png|700 px]]

3. The user clicks on individual files to preview them.

[[Image:analysis_preview_file.png|700 px]]

4. After examining these files, it is clear that they form a new series. The user adds a “series2” tag to assist with arrangement.

[[Image:file_list_tags.png|500 px]]

5. Tags now appear attached to files in the backlog. The user can also gain a sense of the scope of the two series that have been identified by clicking on “Tags” in the Analysis pane.

[[Image:analysis_tags.png|700 px]]

'''Note''': If the records contain personal information and the tool Bulk Extractor was used in Transfer, the user could use “Examine contents” to see what files were identified as having personal information.

== Arranging Files in the ArchivesSpace Pane ==

Having conducted a preliminary examination of the records, the user begins to work on the arrangement, associating the records with an ArchivesSpace finding aid. The user can return to the Analysis and File List panes at any point to further explore the records as s/he works on the arrangement and description.

1. The user opens the ArchivesSpace pane and finds the resource using the search box. Resources can be expanded to show lower levels of description.

[[Image:search_ArchivesSpace.png|500 px]]

2. Before files can be added to a resource, a space must be created for them by adding a digital object component. The user selects Series 1 and chooses “Add New Digital Object Component” which brings up a dialog box for adding basic metadata. The new digital object appears nested under the archival object “Series 1.”

[[Image:appraisal_tab_digital_object.png|500 px]]

3. Files in the backlog now can be arranged by dragging them to the digital object component.

[[Image:appraisal_tab_dragging_files_to_resource.png|700 px]]

4. The user repeats this process to add items that belong in Series 2.

5. The user also determines that other files in the transfer form a new series, which had not been described when the resource was created in ArchivesSpace. By selecting the resource (highest level of description) and using the “Add New Child Record” button the user can create another series.

[[Image:appraisal_tab_new_child_record.png|500 px]]

'''Note''': If the user wants to make changes to the description while working in the ArchivesSpace pane, s/he can also use the “Edit Metadata” button to change metadata for an existing item. “Edit Rights Metadata” provides a form for adding PREMIS rights. Mistakenly added archival objects can be deleted.

6. Finally, the user creates a SIP from the arrangement. A SIP is sent to Ingest by selecting the resource (highest level of description) and clicking “Finalize Arrangement.”

[[Image:appraisal_tab_ArchivesSpace.png|500 px]]

Archivematica to ArchivesSpace Workflow

2016-04-13T23:36:17Z

Bgormly:

[[Main Page]] > [[Development]] > [[Requirements]] > [[Appraisal and Arrangement Tab]] > Archivematica to ArchivesSpace Workflow

This page describes a basic Archivematica to ArchivesSpace workflow. It details the steps that would be taken to transfer, analyze, arrange, and create a Submission Information Package (SIP) from files transferred to Archivematica using the Appraisal tab.

== Send a Transfer to Backlog ==

In order to work with files in the Appraisal tab, they first must be in a transfer in Archivematica’s backlog.

1. The user provides a transfer name and uses browse to find the directory that will be transferred to Archivematica. S/he clicks “Add” and “Start transfer.”

[[Image:start_transfer.png|700 px]]

2. S/he approves the transfer and proceeds through the Transfer micro-services as needed for the particular transfer.

3. When the transfer reaches the micro-service “Create SIP from Transfer,” the user chooses “send to backlog” in the job “Create SIP(s).”

[[Image:create_SIP.png|700 px]]

== Searching the Backlog and Adding Tags ==

Now the user must locate the transfer in the backlog. The tags feature can also be used to identify information relevant for appraisal and arrangement.

1. The user navigates to the Appraisal tab (between Transfer and Ingest) and enters search terms/parameters in the search box at the top of the page to find the transfer.

[[Image:searching_backlog.png|700 px]]

2. The user then adds tags to identify information already known about the files. In this case, files that are part of the same series are identified.

[[Image:backlog_tags.png|500 px]]

== Analyzing Files Using the Analysis and File List Panes ==

At this point, the user might not know enough about the files to determine their place in the arrangement or even if they belong in the SIP. The Analysis and File List panes can be used to learn more about the transfer.

1. First, the user gains an overview of information about the files by selecting the files in the Backlog pane and clicking on Objects in the Analysis Pane. This generates a report with information such as the format and size of the files. Visualizations can also be used to gain an overview of the files.

[[Image:analysis_objects.png|700 px]]

2. Some files need further examination. They are selected in Analysis, adding them to the File List.

[[Image:analysis_file_list.png|700 px]]

3. The user clicks on individual files to preview them.

[[Image:analysis_preview_file.png|700 px]]

4. After examining these files, it is clear that they form a new series. The user adds a “series2” tag to assist with arrangement.

[[Image:file_list_tags.png|500 px]]

5. Tags now appear attached to files in the backlog. The user can also gain a sense of the scope of the two series that have been identified by clicking on “Tags” in the Analysis pane.

[[Image:analysis_tags.png|700 px]]

'''Note''': If the records contain personal information and the tool Bulk Extractor was used in Transfer, the user could use “Examine contents” to see what files were identified as having personal information.

== Arranging Files in the ArchivesSpace Pane ==

Having conducted a preliminary examination of the records, the user begins to work on the arrangement, associating the records with an ArchivesSpace finding aid. The user can return to the Analysis and File List panes at any point to further explore the records as s/he works on the arrangement and description.

1. The user opens the ArchivesSpace pane and finds the resource using the search box. Resources can be expanded to show lower levels of description.

[[Image:search_ArchivesSpace.png|500 px]]

2. Before files can be added to a resource, a space must be created for them by adding a digital object component. The user selects Series 1 and chooses “Add New Digital Object Component” which brings up a dialog box for adding basic metadata. The new digital object appears nested under the archival object “Series 1.”

[[Image:appraisal_tab_digital_object.png|500 px]]

3. Files in the backlog now can be arranged by dragging them to the digital object component.

[[Image:appraisal_tab_dragging_files_to_resource.png|700 px]]

4. The user repeats this process to add items that belong in Series 2.

5. The user also determines that other files in the transfer form a new series, which had not been described when the resource was created in ArchivesSpace. By selecting the resource (highest level of description) and using the “Add New Child Record” button the user can create another series.

[[Image:appraisal_tab_new_child_record.png|500 px]]

'''Note''': If the user wants to make changes to the description while working in the ArchivesSpace pane, s/he can also use the “Edit Metadata” button to change metadata for an existing item. “Edit Rights Metadata” provides a form for adding PREMIS rights. Mistakenly added archival objects can be deleted.

6. Finally, the user creates a SIP from the arrangement. A SIP is sent to Ingest by selecting the resource (highest level of description) and clicking “Finalize Arrangement.”

[[Image:appraisal_tab_ArchivesSpace.png|500 px]]

Archivematica to ArchivesSpace Workflow

2016-04-13T22:26:57Z

Bgormly:

This page describes a basic Archivematica to ArchivesSpace workflow. It details the steps that would be taken to transfer, analyze, arrange, and create a Submission Information Package (SIP) from files transferred to Archivematica using the Appraisal tab.

=== Send a Transfer to Backlog ===

In order to work with files in the Appraisal tab, they first must be in a transfer in Archivematica’s backlog.

1. The user provides a transfer name and uses browse to find the directory that will be transferred to Archivematica. S/he clicks “Add” and “Start transfer.”

[[Image:start_transfer.png|700 px]]

2. S/he approves the transfer and proceeds through the Transfer micro-services as needed for the particular transfer.

3. When the transfer reaches the micro-service “Create SIP from Transfer,” the user chooses “send to backlog” in the job “Create SIP(s).”

[[Image:create_SIP.png|700 px]]

=== Appraisal Tab: Backlog ===

Now the user must locate the transfer in the backlog. The tags feature can also be used to identify information relevant for appraisal and arrangement.

1. The user navigates to the Appraisal tab (between Transfer and Ingest) and enters search terms/parameters in the search box at the top of the page to find the transfer.

[[Image:searching_backlog.png|700 px]]

2. The user then adds tags to identify information already known about the files. In this case, files that are part of the same series are identified.

[[Image:backlog_tags.png|700 px]]

=== Appraisal Tab: Analysis and File List ===

At this point, the user might not know enough about the files to determine their place in the arrangement or even if they belong in the SIP. The Analysis and File List panes can be used to learn more about the transfer.

1. First, the user gains an overview of information about the files by selecting the files in the Backlog pane and clicking on Objects in the Analysis Pane. This generates a report with information such as the format and size of the files. Visualizations can also be used to gain an overview of the files.

[[Image:analysis_objects.png|700 px]]

2. Some files need further examination. They are selected in Analysis, adding them to the File List.

[[Image:analysis_file_list.png|700 px]]

3. The user clicks on individual files to preview them.

[[Image:analysis_preview_file.png|700 px]]

4. After examining these files, it is clear that they form a new series. The user adds a “series2” tag to assist with arrangement.

[[Image:file_list_tags.png|700 px]]

5. Tags now appear attached to files in the backlog. The user can also gain a sense of the scope of the two series that have been identified by clicking on “Tags” in the Analysis pane.

[[Image:analysis_tags.png|700 px]]

'''Note''': If the records contain personal information and the tool Bulk Extractor was used in Transfer, the user could use “Examine contents” to see what files were identified as having personal information.

=== Appraisal Tab: ArchivesSpace ===

Having conducted a preliminary examination of the records, the user begins to work on the arrangement, associating the records with an ArchivesSpace finding aid. The user can return to the Analysis and File List panes at any point to further explore the records as s/he works on the arrangement and description.

1. The user opens the ArchivesSpace pane and finds the resource using the search box. Resources can be expanded to show lower levels of description.

[[Image:search_ArchivesSpace.png|700 px]]

2. Before files can be added to a resource, a space must be created for them by adding a digital object component. The user selects Series 1 and chooses “Add New Digital Object Component” which brings up a dialog box for adding basic metadata. The new digital object appears nested under the archival object “Series 1.”

[[Image:appraisal_tab_digital_object.png|700 px]]

3. Files in the backlog now can be arranged by dragging them to the digital object component.

[[Image:appraisal_tab_dragging_files_to_resource.png|700 px]]

4. The user repeats this process to add items that belong in Series 2.

5. The user also determines that other files in the transfer form a new series, which had not been described when the resource was created in ArchivesSpace. By selecting the resource (highest level of description) and using the “Add New Child Record” button the user can create another series.

[[Image:appraisal_tab_new_child_record.png|700 px]]

'''Note''': If the user wants to make changes to the description while working in the ArchivesSpace pane, s/he can also use the “Edit Metadata” button to change metadata for an existing item. “Edit Rights Metadata” provides a form for adding PREMIS rights. Mistakenly added archival objects can be deleted.

6. Finally, the user creates a SIP from the arrangement. A SIP is sent to Ingest by selecting the resource (highest level of description) and clicking “Finalize Arrangement.”

[[Image:appraisal_tab_ArchivesSpace.png|700 px]]

File:Appraisal tab ArchivesSpace.png

2016-04-13T22:24:24Z

Bgormly:

File:Appraisal tab new child record.png

2016-04-13T22:22:08Z

Bgormly:

File:Appraisal tab dragging files to resource.png

2016-04-13T22:20:10Z

Bgormly:

File:Appraisal tab digital object.png

2016-04-13T22:17:43Z

Bgormly:

File:Search ArchivesSpace.png

2016-04-13T22:13:40Z

Bgormly:

File:Analysis tags.png

2016-04-13T21:59:03Z

Bgormly:

File:File list tags.png

2016-04-13T21:49:20Z

Bgormly:

File:Analysis preview file.png

2016-04-13T21:47:31Z

Bgormly:

File:Analysis file list.png

2016-04-13T21:45:48Z

Bgormly:

File:Analysis objects.png

2016-04-13T21:43:59Z

Bgormly:

Archivematica to ArchivesSpace Workflow

2016-04-13T21:41:40Z

Bgormly: Created page with "This page describes a basic Archivematica to ArchivesSpace workflow. It details the steps that would be taken to transfer, analyze, arrange, and create a Submission Informatio..."

File:Backlog tags.png

2016-04-13T21:40:55Z

Bgormly:

File:Searching backlog.png

2016-04-13T21:39:01Z

Bgormly:

File:Create SIP.png

2016-04-13T21:29:54Z

Bgormly:

File:Start transfer.png

2016-04-13T21:26:11Z

Bgormly:

Appraisal Arrangement tab

2016-02-03T22:13:05Z

Bgormly:

[[Main Page]] > [[Development]] > [[Requirements]] > Appraisal and Arrangement Tab

== 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://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:
* [[Transfer and SIP creation]]
* [[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 ==

=== Data ===

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 ===
See also [[ArchivesSpace_integration|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 ===

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.

== 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 ==

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

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]]

File:Feb2016 Analysis pane visulalization.png

2016-02-03T22:09:25Z

Bgormly:

File:Feb2016 Analysis FileList panes.png

2016-02-03T22:08:22Z

Bgormly:

File:Feb2016 Backlog ArchivesSpace panes.png

2016-02-03T21:54:43Z

Bgormly:

File:Feb2016 adding tags.png

2016-02-03T21:53:24Z

Bgormly:

Appraisal Arrangement tab

2016-01-28T00:30:39Z

Bgormly:

[[Main Page]] > [[Development]] > [[Requirements]] > Appraisal and Arrangement Tab

== 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://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:
* [[Transfer and SIP creation]]
* [[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 ==

=== Data ===

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 ===
See also [[ArchivesSpace_integration|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 ===

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.

== 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 ==

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]]

== 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]]