Difference between revisions of "Archivists Toolkit integration"

From Archivematica
Jump to navigation Jump to search
Line 31: Line 31:
  
 
*'''restrictionsApply''': TRUE or FALSE (see also '''RestrictionsApply: Base on PREMIS''', below)
 
*'''restrictionsApply''': TRUE or FALSE (see also '''RestrictionsApply: Base on PREMIS''', below)
*'''isComponent''': FALSE
+
*'''isComponent''': TRUE or FALSE
 
*'''eadDaoActuate''': onRequest
 
*'''eadDaoActuate''': onRequest
 
*'''eadDaoShow''': new
 
*'''eadDaoShow''': new
 
*'''useStatement''': Image-Service [for example]
 
*'''useStatement''': Image-Service [for example]
*'''objectType''': if no data entered, leave emtpy
+
*'''objectType''': If no data entered, leave emtpy
*'''conditionsGoverningAccess''': if no data entered, automatically populate from PREMIS <rightsGrantedNote>. If there is no content in <rightsGrantedNote>, leave empty
+
*'''conditionsGoverningAccess''': If no data entered, automatically populate from PREMIS <rightsGrantedNote>. If there is no content in <rightsGrantedNote>, leave empty
 
*'''conditionsGoverningUse''': If no data entered, leave empty  
 
*'''conditionsGoverningUse''': If no data entered, leave empty  
*'''digitalObjectID''': automatically populate with file UUID
+
*'''digitalObjectID''': If empty, automatically populate with file UUID
*'''title''': automatically populate with filename (without UUID)
+
*'''title''': Automatically populate with filename (without UUID)
*'''uri''': automatically populate with eg www.rockarch.org/[UUID]-filename
+
*'''uri''': Automatically populate with eg www.rockarch.org/[UUID]-filename
 
*'''existenceLocationOriginals''': automatically populate with AIP UUID
 
*'''existenceLocationOriginals''': automatically populate with AIP UUID
 +
</br>
  
===RestrictionsApply: Base on PREMIS===
+
==RestrictionsApply: Base on PREMIS==
  
 
*If PREMIS <act>= Disseminate and PREMIS <restriction> = Allow, restrictionsApply = FALSE
 
*If PREMIS <act>= Disseminate and PREMIS <restriction> = Allow, restrictionsApply = FALSE
Line 50: Line 51:
 
*In addition, when restrictionsApply=TRUE, both eadDaoActuate and eadDaoShow will be set to “none.”
 
*In addition, when restrictionsApply=TRUE, both eadDaoActuate and eadDaoShow will be set to “none.”
  
</br>
 
 
===Example 1===
 
 
'''Metadata entry form'''
 
 
[[File:Metadata_entry_1.png|380px|thumb|center|]]
 
 
</br>
 
 
'''Column headers and sample values'''
 
 
{| border="1" cellpadding="10" cellspacing="0" width="100%"
 
|-
 
!'''useStatement'''
 
!'''restrictionsApply'''
 
!'''isComponent'''
 
!style="width:20%"|'''digitalObjectID'''
 
!'''objectType'''
 
!style="width:5%"|'''title'''
 
!'''dateExpession'''
 
!'''dateBegin'''
 
!'''dateEnd'''
 
!style="width:30%"|'''uri'''
 
!style="width:20%"|'''existenceLocationOriginals'''
 
|-
 
|Image-Service
 
|FALSE
 
|FALSE
 
|n952198j-70kj-7dn1-d353-2071lb670e7k
 
|still image
 
|Image 01
 
|August 12, 2009
 
|2009
 
|2009
 
|.../uploadedDIPs/AT/Image-01.jpg-n952198j-70kj-7dn1-d353-2071lb670e7k
 
|v753198j-85kj-7ec1-b181-7051fb000e8m
 
|-
 
|Image-Service
 
|FALSE
 
|FALSE
 
|x732198n-80fi-6em1-j934-3091cb090e3g
 
|still image
 
|Image 02
 
|August 12, 2009
 
|2009
 
|2009
 
|.../uploadedDIPs/AT/Image-02.jpg-x732198n-80fi-6em1-j934-3091cb090e3g
 
|v753198j-85kj-7ec1-b181-7051fb000e8m
 
|-
 
|Image-Service
 
|FALSE
 
|FALSE
 
|z022198m-90kg-8ed1-w395-4551sb054e0v
 
|still image
 
|Image 03
 
|August 12, 2009
 
|2009
 
|2009
 
|.../uploadedDIPs/AT/Image-03.jpg-z022198m-90kg-8ed1-w395-4551sb054e0v
 
|v753198j-85kj-7ec1-b181-7051fb000e8m
 
|-
 
|Image-Service
 
|FALSE
 
|FALSE
 
|v753198j-85kj-7ec1-b181-7051fb070e8b
 
|still image
 
|Image 04
 
|August 12, 2009
 
|2009
 
|2009
 
|.../uploadedDIPs/AT/Image-04.jpg-v753198j-85kj-7ec1-b181-7051fb070e8b
 
|v753198j-85kj-7ec1-b181-7051fb000e8m
 
|-
 
|}
 
 
</br>
 
 
===Example 2===
 
 
'''Metadata entry form'''
 
 
[[File:Metadata_entry_2.png|380px|thumb|center|]]
 
 
'''Column headers and sample values'''
 
 
{| border="1" cellpadding="10" cellspacing="0" width="100%"
 
|-
 
!'''useStatement'''
 
!'''restrictionsApply'''
 
!'''isComponent'''
 
!'''digitalObjectID'''
 
!'''objectType'''
 
!style="width:5%"|'''title'''
 
!'''dateExpession'''
 
!'''dateBegin'''
 
!'''dateEnd'''
 
!style="width:30%"|'''uri'''
 
!style="width:20%"|'''existenceLocationOriginals'''
 
|-
 
|Image-Service
 
|TRUE
 
|TRUE
 
|AM1004.2
 
|still image
 
|Image 01
 
|
 
|
 
|
 
|.../uploadedDIPs/AT/Image-01.jpg-n952198j-70kj-7dn1-d353-2071lb670e7k
 
|v753198j-85kj-7ec1-b181-7051fb000e8m
 
|-
 
|Image-Service
 
|TRUE
 
|TRUE
 
|AM1004.2
 
|still image
 
|Image 02
 
|
 
|
 
|
 
|.../uploadedDIPs/AT/Image-02.jpg-x732198n-80fi-6em1-j934-3091cb090e3g
 
|v753198j-85kj-7ec1-b181-7051fb000e8m
 
|-
 
|Image-Service
 
|TRUE
 
|TRUE
 
|AM1004.2
 
|still image
 
|Image 03
 
|
 
|
 
|
 
|.../uploadedDIPs/AT/Image-03.jpg-z022198m-90kg-8ed1-w395-4551sb054e0v
 
|v753198j-85kj-7ec1-b181-7051fb000e8m
 
|-
 
|Image-Service
 
|TRUE
 
|TRUE
 
|AM1004.2
 
|still image
 
|Image 04
 
|
 
|
 
|
 
|.../uploadedDIPs/AT/Image-04.jpg-v753198j-85kj-7ec1-b181-7051fb070e8b
 
|v753198j-85kj-7ec1-b181-7051fb000e8m
 
|-
 
|}
 
  
 
__NOTOC__
 
__NOTOC__
  
 
[[Category:Development documentation]]
 
[[Category:Development documentation]]

Revision as of 16:59, 7 February 2013

Main Page > Development > Requirements > Integration with Archivists' Toolkit

This feature will re-format a DIP for import into Archivists' Toolkit.

Workflow

  1. The user sets AT upload configuration options in the admin tab, via a menu called Archivists' Toolkit settings (see Settings, below)
  2. The user processes a SIP the same way that all SIPs are processed
  3. At the Upload DIP micro-service, the user selects "Upload to Archivists' Toolkit"
  4. A tab-delimited file generated from the settings called ATmetadata.txt is placed in the DIP
  5. The DIP is placed in /uploadedDIPs/AT/.
  6. The user can edit the metadata in the text file if desired
  7. The user manually imports the text file into Archivists' Toolkit

DIP requirements

  • A DIP formatted for upload to Archivists' Toolkit consists of the objects plus a tab-delimited text file called ATmetadata.txt.
  • The tab-delimited text file contains field values:
    • entered directly by the user from the data-entry form described above
    • auto-populated from metadata generated during processing

Settings

This screenshot shows the settings form in the admin tab, with some default settings:

Metadata entry.png


ATmetadata.txt file

The tab-delimited file ATmetadata.txt will contain one row of metadata per digital object in the DIP. On DIP metadata upload, all of the metadata will be used to populate the digital object instances in AT as follows:

  • restrictionsApply: TRUE or FALSE (see also RestrictionsApply: Base on PREMIS, below)
  • isComponent: TRUE or FALSE
  • eadDaoActuate: onRequest
  • eadDaoShow: new
  • useStatement: Image-Service [for example]
  • objectType: If no data entered, leave emtpy
  • conditionsGoverningAccess: If no data entered, automatically populate from PREMIS <rightsGrantedNote>. If there is no content in <rightsGrantedNote>, leave empty
  • conditionsGoverningUse: If no data entered, leave empty
  • digitalObjectID: If empty, automatically populate with file UUID
  • title: Automatically populate with filename (without UUID)
  • uri: Automatically populate with eg www.rockarch.org/[UUID]-filename
  • existenceLocationOriginals: automatically populate with AIP UUID


RestrictionsApply: Base on PREMIS

  • If PREMIS <act>= Disseminate and PREMIS <restriction> = Allow, restrictionsApply = FALSE
  • If PREMIS <act>= Disseminate and PREMIS <restriction> = Conditional, restrictionsApply = TRUE
  • If PREMIS <act>= Disseminate and PREMIS <restriction> = Disallow, restrictionsApply = TRUE
  • In addition, when restrictionsApply=TRUE, both eadDaoActuate and eadDaoShow will be set to “none.”