archivematica / Issues

Issues repository for the Archivematica project
GNU Affero General Public License v3.0
16 stars 1 forks source link

Problem: ArchivesSpace integration configuration is not clearly documented #149

Open sallain opened 6 years ago

sallain commented 6 years ago

Version of the documentation 1.7

Page (and section, if applicable) where the issue occurs Integrations page

Description of the issue ArchivesSpace is not listed on the integrations page. Details about how to configure ArchivesSpace and Archivematica to talk to each other are scant within the documentation and there's no centralized landing place for learning about how the integration works.

Suggested fix

sevein commented 5 years ago

@sallain can we close this?

sallain commented 5 years ago

@sevein I'll check to make sure that the changes to AS are documented properly and then close.

jhsimpson commented 5 years ago

There are some details of the integration between Archivematica and ArchivesSpace, implemented in the Appraisal Tab, that are not yet documented.

The integration was developed for the Bentley Historical Library at the University of Michigan and has some site-specific details hard-coded into the workflow.

The Bentley workflow is to create SIP's in the Appraisal Tab of Archivematica, and make a digital object record in ArchivesSpace for the SIP.

Later, when the SIP becomes an AIP, the Storage Service sends it to DSpace for storage. DSpace (as implemented at the University of Michigan in Deep Blue) requires 6 specific metadata fields to be supplied in order to create a new record (called an Item in DSpace).

For Bentley, some of these properties are kept in ArchivesSpace. The appraisal tab looks up those properties using the ArchivesSpace api, and stores these values in the Archivematica database, and they are eventually written out as dublin core in the AIP METS file in the dmdSec for the package.

When sending the AIP to DSpace, the storage service then reads out these 6 values, and converts them to qualified dublin core that is then submitted to DSpace via the Sword API.

This google sheet documents the metadata mapping between Archivematica's dublin core (stored in the AIP METS file in the dmdSec for the package), and qualified dublin core properties required to create a DSpace Item, and how the Appraisal Tab tries to populate those fields: https://docs.google.com/spreadsheets/d/1wMi5nWakdREWsLFvqEPmGCRAeYAhbCQwrEBx3CcI6JU/edit?usp=sharing

Here is where Archivematica pulls these fields from ArchivesSpace, to populate the dublin core dmdSec in the AIP's METS file: https://github.com/artefactual/archivematica/blob/stable/1.9.x/src/dashboard/src/components/access/views.py#L435-L459

and here is where the mapping code lives in the Storage Service, to read from the dublinc core dmdSec and map to DSpace dc properties: https://github.com/artefactual/archivematica-storage-service/blob/stable/0.14.x/storage_service/locations/models/dspace.py#L127-L135