Difference between revisions of "ArchivesSpace integration"

From Archivematica
Jump to navigation Jump to search
 
(72 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
[[Main Page]] > [[Development]] > [[Requirements]] > ArchivesSpace integration
 
[[Main Page]] > [[Development]] > [[Requirements]] > ArchivesSpace integration
 +
 +
<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]]
  
 
==ArchivesSpace user stories==
 
==ArchivesSpace user stories==
  
 
* See Jira site: [https://archivesspace.atlassian.net/projects/AASWF/issues user stories]
 
* See Jira site: [https://archivesspace.atlassian.net/projects/AASWF/issues user stories]
 +
 +
==Community demonstration and feedback==
 +
 +
* [[SAA_2015_Demonstration_and_Feedback|SAA 2015 demonstration documentation and feedback]]
  
 
==Bentley blog==
 
==Bentley blog==
Line 10: Line 18:
  
 
==Appraisal and Arrangement tab==
 
==Appraisal and Arrangement tab==
−
* See [[Appraisal_Arrangement_tab#ArchivesSpace_resources|Appraisal and Arrangement tab]] for detailed mockups and requirements of the tab where the integration will be most explicit
+
* See [[Appraisal_Arrangement_tab#ArchivesSpace_resources|Appraisal and Arrangement tab]] for detailed mockups and requirements
  
 
==Signal Blog post about the Bentley project==
 
==Signal Blog post about the Bentley project==
Line 16: Line 24:
  
 
==Archivematica to ArchivesSpace Rights records==
 
==Archivematica to ArchivesSpace Rights records==
 +
 +
===Field mapping table===
  
 
{| border="1" cellpadding="10" cellspacing="0" width=90%
 
{| border="1" cellpadding="10" cellspacing="0" width=90%
Line 32: Line 42:
 
|rightsStatementIdentifierValue
 
|rightsStatementIdentifierValue
 
|rightsStatementIdentifierValue
 
|rightsStatementIdentifierValue
−
|
+
|Identifier
−
|
+
|UUID in both AM and AS
 
|-
 
|-
 
|rightsBasis
 
|rightsBasis
 
|rightsBasis
 
|rightsBasis
−
|
+
|rights_type
−
|
+
|AS uses "intellectual property" instead of "copyright" in controlled vocabulary
 
|-
 
|-
 
|copyrightStatus
 
|copyrightStatus
 
|copyrightStatus
 
|copyrightStatus
−
|
+
|ip_status
 
|
 
|
 
|-
 
|-
 
|copyrightJurisdiction
 
|copyrightJurisdiction
 
|copyrightJurisdiction
 
|copyrightJurisdiction
−
|
+
|jurisdiction
 
|
 
|
 
|-
 
|-
Line 57: Line 67:
 
|copyrightNote
 
|copyrightNote
 
|copyrightNote
 
|copyrightNote
−
|
+
|type_note
 
|
 
|
 
|-
 
|-
Line 67: Line 77:
 
|copyrightDocumentationIdentifierValue
 
|copyrightDocumentationIdentifierValue
 
|copyrightDocumentationIdentifierValue
 
|copyrightDocumentationIdentifierValue
−
|
+
|external_document/location
 
|
 
|
 
|-
 
|-
 
|copyrightDocumentationRole
 
|copyrightDocumentationRole
 
|copyrightDocumentationRole
 
|copyrightDocumentationRole
−
|
+
|external_document/title
−
|
+
|Not an exact mapping
 
|-
 
|-
 
|copyrightApplicableDates/startDate
 
|copyrightApplicableDates/startDate
Line 82: Line 92:
 
|copyrightApplicableDates/endDate
 
|copyrightApplicableDates/endDate
 
|copyrightApplicableDates/endDate
 
|copyrightApplicableDates/endDate
−
|
+
|ip_expiration_date
 
|
 
|
 
|-
 
|-
Line 92: Line 102:
 
|licenseDocumentationIdentifierValue
 
|licenseDocumentationIdentifierValue
 
|licenseDocumentationIdentifierValue
 
|licenseDocumentationIdentifierValue
−
|
+
|external_document/location
 
|
 
|
 
|-
 
|-
 
|licenseDocumentationRole
 
|licenseDocumentationRole
 
|licenseDocumentationRole
 
|licenseDocumentationRole
−
|
+
|external_document/title
−
|
+
|Not an exact mapping
 
|-
 
|-
 
|licenseTerms
 
|licenseTerms
 
|licenseTerms
 
|licenseTerms
−
|
+
|license_identifier_terms
 
|
 
|
 
|-
 
|-
 
|licenseNote
 
|licenseNote
 
|licenseNote
 
|licenseNote
−
|
+
|type_note
 
|
 
|
 
|-
 
|-
Line 120: Line 130:
 
|
 
|
 
|-
 
|-
 +
|statuteJurisdiction
 +
|statuteJurisdiction
 +
|jurisdiction
 
|
 
|
 +
|-
 +
|statuteCitation
 +
|statuteCitation
 +
|statute_citation
 
|
 
|
 +
|-
 +
|statuteInformationDeterminationDate
 +
|statuteInformationDeterminationDate
 
|
 
|
 
|
 
|
 
|-
 
|-
 +
|statuteNote
 +
|statuteNote
 +
|type_note
 
|
 
|
 +
|-
 +
|statuteDocumentationIdentifierType
 +
|statuteDocumentationIdentifierType
 
|
 
|
 
|
 
|
 +
|-
 +
|statuteDocumentationIdentifierValue
 +
|statuteDocumentationIdentifierValue
 +
|external_document/location
 +
|
 +
|-
 +
|statuteDocumentationRole
 +
|statuteDocumentationRole
 +
|external_document/title
 +
|Not an exact mapping
 +
|-
 +
|statuteApplicableDates/startDate
 +
|statuteApplicableDates/startDate
 +
|
 +
|
 +
|-
 +
|statuteApplicableDates/endDate
 +
|statuteApplicableDates/endDate
 +
|
 +
|
 +
|-
 +
|otherRightsDocumentationIdentifierType
 +
|otherRightsDocumentationIdentifierType
 +
|
 +
|
 +
|-
 +
|otherRightsDocumentationIdentifierValue
 +
|otherRightsDocumentationIdentifierValue
 +
|
 +
|
 +
|-
 +
|otherRightsDocumentationRole
 +
|otherRightsDocumentationRole
 +
|
 +
|
 +
|-
 +
|otherRightsBasis
 +
|otherRightsBasis
 +
|
 +
|
 +
|-
 +
|otherRightsApplicableDates/startDate
 +
|otherRightsApplicableDates/startDate
 +
|
 +
|
 +
|-
 +
|otherRightsApplicableDates/endDate
 +
|otherRightsApplicableDates/endDate
 +
|
 +
|
 +
|-
 +
|otherRightsNote
 +
|otherRightsNote
 +
|
 +
|
 +
|-
 +
|act
 +
|act
 +
|
 +
|PREMIS DD recommends this be a single word such as "Disseminate", "Replicate", etc., with values taken from a controlled vocabulary.
 +
|-
 +
|restriction
 +
|restriction
 +
|restrictions
 +
|Controlled vocabulary in AM; Free text field in AS. Not an exact mapping, since AS "permissions" may be used to concantenate a number of PREMIS semantic units. Map to rightsGrantedNote in AM?
 +
|-
 +
|termOfGrant/startDate
 +
|termOfGrant/startDate
 +
|
 +
|
 +
|-
 +
|termOfGrant/endDate
 +
|termOfGrant/endDate
 +
|
 +
|
 +
|-
 +
|termOfRestriction/startDate
 +
|termOfRestriction/startDate
 +
|restriction_start_date
 +
|
 +
|-
 +
|termOfRestriction/endDate
 +
|termOfRestriction/endDate
 +
|restriction_end_date
 +
|
 +
|-
 +
|rightsGrantedNote
 +
|rightsGrantedNote
 +
|granted_note
 +
|
 +
|-
 +
|linkingObjectIdentifierType
 +
|linkingObjectIdentifierType
 +
|
 +
|If AS rights are imported into AM, AM will need to add objecIdentifer information
 +
|-
 +
|linkingObjectIdentifierValue
 +
|linkingObjectIdentifierValue
 +
|
 +
|If AS rights are imported into AM, AM will need to add objecIdentifer information
 +
|-
 +
|linkingObjectRole
 +
|
 +
|
 +
|
 +
|-
 +
|linkingAgentIdentifierType
 +
|
 +
|
 +
|
 +
|-
 +
|linkingAgentIdentifierValue
 +
|
 +
|linked_agents/ref
 +
|
 +
|-
 +
|linkingAgentRole
 +
|
 +
|linked_agents/relator
 +
|
 +
|-
 +
|rightsExtension
 +
|
 +
|
 +
|
 +
|-
 +
|
 +
|
 +
|permissions
 +
|Free text field. Map to rightsGrantedNote?
 +
|-
 +
|
 +
|
 +
|active
 +
|Values are true or false
 +
|-
 +
|
 +
|
 +
|materials
 +
|Free text field used to indicate to which parts of a collection the rights statement applies.
 +
|-
 +
|
 +
|
 +
|external_document/publish
 +
|Values are true or false. Refers to publication of the referenced external document?
 +
|-
 +
|-
 +
|
 +
|
 +
|linking_agents/title
 
|
 
|
 
|-
 
|-
 
|}
 
|}
  
 +
</br>
  
 +
===Sample Archivematica to ArchivesSpace mapping===
  
 +
</br>
  
 +
{| border="1" cellpadding="10" cellspacing="0" width=90%
 +
|-
 +
|- style="background-color:#cccccc;"
 +
!style="width:30%"|'''Archivematica rights statement'''
 +
!style="width:30%"|'''How this might look in ArchivesSpace'''
 +
!style="width:30%"|'''Notes'''
 +
|-
 +
|<ul>
 +
<li>'''rightsStatementIdentifierType''': UUID
 +
<li>'''rightsStatementIdentifierValue''': a5b3a778-da39-4aee-a82d-96fd95847bdd
 +
<li>'''rightsBasis''': copyright
 +
<li>'''copyrightStatus''': copyrighted
 +
<li>'''copyrightJurisdiction''': CA
 +
<li>'''copyrightNote''': Copyright held by Jane Doe
 +
<li>'''copyrightDocumentationIdentifierType''': Accession number
 +
<li>'''copyrightDocumentationIdentifierValue''': 2006/017
 +
<li>'''copyrightDocumentationRole''': Accession record
 +
<li>'''copyrightApplicableDates/startDate''': 2006-04-16
 +
<li>'''copyrightApplicableDates/endDate''': OPEN
 +
<li>'''act''': Disseminate
 +
<li>'''restriction''': Allow
 +
<li>'''termOfGrant/startDate''': 2006-04-16
 +
<li>'''termOfGrant/endDate''': OPEN
 +
<li>'''act''': Publish
 +
<li>'''restriction''': Conditional
 +
<li>'''termOfRestriction/startDate''': 2006-04-16
 +
<li>'''termOfRestriction/endDate''': 2021-04-16
 +
<li>'''rightsGrantedNote''': Permission to publish must be obtained from the copyright holder
 +
<li>'''linkingObjectIdentifierType''': UUID
 +
<li>'''linkingObjectIdentifierValue''': 93bbfdc1-b715-441e-8ded-68c30f7d4ef7
 +
</ul>
 +
|<ul>
 +
<li>'''identifier''': a5b3a778-da39-4aee-a82d-96fd95847bdd
 +
<li>'''rights_type''': intellectual property
 +
<li>'''ip_status''': Copyrighted
 +
<li>'''ip_expiration_date''': OPEN
 +
<li>'''jurisdiction''': CA
 +
<li>'''type_note''': Copyright held by Jane Doe
 +
<li>'''external_document/location''': 2006/17
 +
<li>'''external_document/title''': Accession record
 +
<li>'''granted_note''': Permission to publish must be obtained from the copyright holder
 +
<li>'''restriction_end_date''': 2021-04-16
 +
</ul>
 +
|<ul>
 +
<li>PREMIS allows any end date to be OPEN if not known, but AS data entry template does not allow OPEN as a date value, so '''copyrightApplicableDates/endDate''': OPEN  may not map properly to '''ip_expiration_date'''.
 +
<li>PREMIS '''act''' and some related semantic units do not map from AM to AS.
 +
|-
 +
|}
  
  
 +
</br>
  
 +
===Sample ArchivesSpace to Archivematica mapping===
  
  
 +
</br>
  
−
 
+
{| border="1" cellpadding="10" cellspacing="0" width=90%
−
 
+
|-
−
statuteJurisdiction
+
|- style="background-color:#cccccc;"
−
statuteCitation
+
!style="width:30%"|'''ArchivesSpace rights statement'''
−
statuteInformationDeterminationDate
+
!style="width:30%"|'''How this might look in Archivematica'''
−
statuteNote
+
!style="width:30%"|'''Notes'''
−
statuteDocumentationIdentifierType
+
|-
−
statuteDocumentationIdentifierValue
+
|<ul>
−
statuteDocumentationRole
+
<li>'''active''': true
−
statuteApplicableDates/startDate
+
<li>'''identifier''': a5b3a778-da39-4aee-a82d-96fd95847bdd
−
statuteApplicableDates/endDate
+
<li>'''rights_type''': intellectual_property
−
otherRightsDocumentationIdentifierType
+
<li>'''materials''': applies to xyz materials only
−
otherRightsDocumentationIdentifierValue
+
<li>'''ip_status''': copyrighted
−
otherRightsDocumentationRole
+
<li>'''ip_expiration_date''': 2050-01-01
−
otherRightsBasis
+
<li>'''jurisdiction''': CA
−
otherRightsApplicableDates/startDate
+
<li>'''type_note''': Copyright held by Jane Doe
−
otherRightsApplicableDates/endDate
+
<li>'''external_document/location''': 2006/17
−
otherRightsNote
+
<li>'''external_document/title''': Accession record
 +
<li>'''permissions''': Reference copies may be made available online
 +
<li>'''restrictions''': Permission to publish must be obtained from the copyright holder
 +
<li>'''restriction_start_date''': 2006-04-16
 +
<li>'''restriction_end_date''': 2021-04-16
 +
<li>'''linked_agents/ref''': /agents/people/5494
 +
<li>'''linked_agents/relator''': copyright holder
 +
<li>'''linked_agents/title''': Doe, Jane
 +
</ul>
 +
|<ul>
 +
<li>'''identifierType''': UUID
 +
<li>'''identifierValue''': a5b3a778-da39-4aee-a82d-96fd95847bdd
 +
<li>'''rightsBasis''': copyright
 +
<li>'''copyrightStatus''': copyrighted
 +
<li>'''copyrightApplicableDates/endDate''': 2050-01-01
 +
<li>'''copyrightJurisdiction''': CA
 +
<li>'''copyrightNote''': Copyright held by Jane Doe
 +
<li>'''coyrightDocumentationIdentifier''': 2006/17
 +
<li>'''copyrightDocumentationRole''': Accession record
 +
<li>'''rightsGrantedNote''': Reference copies may be made available online
 +
<li>'''rightsGrantedNote''': Permission to publish must be obtained from the copyright holder
 +
<li>'''termOfRestriction/startDate''': 2006-04-16
 +
<li>'''termOfRestriction/endDate''': 2021-04-16
 +
<li>'''agentIdentifierValue''': /agents/people/5494
 +
<li>'''agentName''': Doe, Jane
 +
<li>'''agentType''': person
 +
<li>'''linkingRightsStatementIdentifierType''': UUID
 +
<li>'''linkingRightsStatementIdentifierValue'''a5b3a778-da39-4aee-a82d-96fd95847bdd
 +
</ul>
 +
|<ul>
 +
<li>Transfer of PREMIS rights from AS to AM creates invalid AM METS XML because '''copyrightApplicableDates/startDate''', '''act''' and '''restriction''' are absent.
 +
<li>AS '''linked_agent''' fields are mapped to the PREMIS agent entity in AM.
 +
</ul>
 +
|-
 +
|}

Latest revision as of 17:15, 11 February 2020

Main Page > Development > Requirements > ArchivesSpace integration

This page is no longer being maintained and may contain inaccurate information. Please see the Archivematica documentation for up-to-date information.

ArchivesSpace user stories[edit]

Community demonstration and feedback[edit]

Bentley blog[edit]

Appraisal and Arrangement tab[edit]

Signal Blog post about the Bentley project[edit]

Archivematica to ArchivesSpace Rights records[edit]

Field mapping table[edit]

PREMIS semantic unit Archivematica field ArchivesSpace field notes
rightsStatementIdentifierType rightsStatementIdentifierType
rightsStatementIdentifierValue rightsStatementIdentifierValue Identifier UUID in both AM and AS
rightsBasis rightsBasis rights_type AS uses "intellectual property" instead of "copyright" in controlled vocabulary
copyrightStatus copyrightStatus ip_status
copyrightJurisdiction copyrightJurisdiction jurisdiction
copyrightStatusDeterminationDate copyrightStatusDeterminationDate
copyrightNote copyrightNote type_note
copyrightDocumentationIdentifierType copyrightDocumentationIdentifierType
copyrightDocumentationIdentifierValue copyrightDocumentationIdentifierValue external_document/location
copyrightDocumentationRole copyrightDocumentationRole external_document/title Not an exact mapping
copyrightApplicableDates/startDate copyrightApplicableDates/startDate
copyrightApplicableDates/endDate copyrightApplicableDates/endDate ip_expiration_date
licenseDocumentationIdentifierType licenseDocumentationIdentifierType
licenseDocumentationIdentifierValue licenseDocumentationIdentifierValue external_document/location
licenseDocumentationRole licenseDocumentationRole external_document/title Not an exact mapping
licenseTerms licenseTerms license_identifier_terms
licenseNote licenseNote type_note
licenseApplicableDates/startDate licenseApplicableDates/startDate
licenseApplicableDates/endDate licenseApplicableDates/endDate
statuteJurisdiction statuteJurisdiction jurisdiction
statuteCitation statuteCitation statute_citation
statuteInformationDeterminationDate statuteInformationDeterminationDate
statuteNote statuteNote type_note
statuteDocumentationIdentifierType statuteDocumentationIdentifierType
statuteDocumentationIdentifierValue statuteDocumentationIdentifierValue external_document/location
statuteDocumentationRole statuteDocumentationRole external_document/title Not an exact mapping
statuteApplicableDates/startDate statuteApplicableDates/startDate
statuteApplicableDates/endDate statuteApplicableDates/endDate
otherRightsDocumentationIdentifierType otherRightsDocumentationIdentifierType
otherRightsDocumentationIdentifierValue otherRightsDocumentationIdentifierValue
otherRightsDocumentationRole otherRightsDocumentationRole
otherRightsBasis otherRightsBasis
otherRightsApplicableDates/startDate otherRightsApplicableDates/startDate
otherRightsApplicableDates/endDate otherRightsApplicableDates/endDate
otherRightsNote otherRightsNote
act act PREMIS DD recommends this be a single word such as "Disseminate", "Replicate", etc., with values taken from a controlled vocabulary.
restriction restriction restrictions Controlled vocabulary in AM; Free text field in AS. Not an exact mapping, since AS "permissions" may be used to concantenate a number of PREMIS semantic units. Map to rightsGrantedNote in AM?
termOfGrant/startDate termOfGrant/startDate
termOfGrant/endDate termOfGrant/endDate
termOfRestriction/startDate termOfRestriction/startDate restriction_start_date
termOfRestriction/endDate termOfRestriction/endDate restriction_end_date
rightsGrantedNote rightsGrantedNote granted_note
linkingObjectIdentifierType linkingObjectIdentifierType If AS rights are imported into AM, AM will need to add objecIdentifer information
linkingObjectIdentifierValue linkingObjectIdentifierValue If AS rights are imported into AM, AM will need to add objecIdentifer information
linkingObjectRole
linkingAgentIdentifierType
linkingAgentIdentifierValue linked_agents/ref
linkingAgentRole linked_agents/relator
rightsExtension
permissions Free text field. Map to rightsGrantedNote?
active Values are true or false
materials Free text field used to indicate to which parts of a collection the rights statement applies.
external_document/publish Values are true or false. Refers to publication of the referenced external document?
linking_agents/title


Sample Archivematica to ArchivesSpace mapping[edit]


Archivematica rights statement How this might look in ArchivesSpace Notes
  • rightsStatementIdentifierType: UUID
  • rightsStatementIdentifierValue: a5b3a778-da39-4aee-a82d-96fd95847bdd
  • rightsBasis: copyright
  • copyrightStatus: copyrighted
  • copyrightJurisdiction: CA
  • copyrightNote: Copyright held by Jane Doe
  • copyrightDocumentationIdentifierType: Accession number
  • copyrightDocumentationIdentifierValue: 2006/017
  • copyrightDocumentationRole: Accession record
  • copyrightApplicableDates/startDate: 2006-04-16
  • copyrightApplicableDates/endDate: OPEN
  • act: Disseminate
  • restriction: Allow
  • termOfGrant/startDate: 2006-04-16
  • termOfGrant/endDate: OPEN
  • act: Publish
  • restriction: Conditional
  • termOfRestriction/startDate: 2006-04-16
  • termOfRestriction/endDate: 2021-04-16
  • rightsGrantedNote: Permission to publish must be obtained from the copyright holder
  • linkingObjectIdentifierType: UUID
  • linkingObjectIdentifierValue: 93bbfdc1-b715-441e-8ded-68c30f7d4ef7
  • identifier: a5b3a778-da39-4aee-a82d-96fd95847bdd
  • rights_type: intellectual property
  • ip_status: Copyrighted
  • ip_expiration_date: OPEN
  • jurisdiction: CA
  • type_note: Copyright held by Jane Doe
  • external_document/location: 2006/17
  • external_document/title: Accession record
  • granted_note: Permission to publish must be obtained from the copyright holder
  • restriction_end_date: 2021-04-16
  • PREMIS allows any end date to be OPEN if not known, but AS data entry template does not allow OPEN as a date value, so copyrightApplicableDates/endDate: OPEN may not map properly to ip_expiration_date.
  • PREMIS act and some related semantic units do not map from AM to AS.



Sample ArchivesSpace to Archivematica mapping[edit]


ArchivesSpace rights statement How this might look in Archivematica Notes
  • active: true
  • identifier: a5b3a778-da39-4aee-a82d-96fd95847bdd
  • rights_type: intellectual_property
  • materials: applies to xyz materials only
  • ip_status: copyrighted
  • ip_expiration_date: 2050-01-01
  • jurisdiction: CA
  • type_note: Copyright held by Jane Doe
  • external_document/location: 2006/17
  • external_document/title: Accession record
  • permissions: Reference copies may be made available online
  • restrictions: Permission to publish must be obtained from the copyright holder
  • restriction_start_date: 2006-04-16
  • restriction_end_date: 2021-04-16
  • linked_agents/ref: /agents/people/5494
  • linked_agents/relator: copyright holder
  • linked_agents/title: Doe, Jane
  • identifierType: UUID
  • identifierValue: a5b3a778-da39-4aee-a82d-96fd95847bdd
  • rightsBasis: copyright
  • copyrightStatus: copyrighted
  • copyrightApplicableDates/endDate: 2050-01-01
  • copyrightJurisdiction: CA
  • copyrightNote: Copyright held by Jane Doe
  • coyrightDocumentationIdentifier: 2006/17
  • copyrightDocumentationRole: Accession record
  • rightsGrantedNote: Reference copies may be made available online
  • rightsGrantedNote: Permission to publish must be obtained from the copyright holder
  • termOfRestriction/startDate: 2006-04-16
  • termOfRestriction/endDate: 2021-04-16
  • agentIdentifierValue: /agents/people/5494
  • agentName: Doe, Jane
  • agentType: person
  • linkingRightsStatementIdentifierType: UUID
  • linkingRightsStatementIdentifierValuea5b3a778-da39-4aee-a82d-96fd95847bdd
  • Transfer of PREMIS rights from AS to AM creates invalid AM METS XML because copyrightApplicableDates/startDate, act and restriction are absent.
  • AS linked_agent fields are mapped to the PREMIS agent entity in AM.
Retrieved from "https://wiki.archivematica.org/index.php?title=ArchivesSpace_integration&oldid=13369"