Difference between revisions of "Archivists Toolkit integration"

From Archivematica
Jump to navigation Jump to search
Line 49: Line 49:
  
 
===Example 1===
 
===Example 1===
 +
 +
'''Metadata entry form'''
  
 
[[File:Metadata_entry_1.png|380px|thumb|center|]]
 
[[File:Metadata_entry_1.png|380px|thumb|center|]]
  
 
</br>
 
</br>
 +
 +
'''Column headers and sample values'''
 +
 
{| border="1" cellpadding="10" cellspacing="0" width="100%"
 
{| border="1" cellpadding="10" cellspacing="0" width="100%"
 
|-
 
|-
Line 120: Line 125:
  
 
===Example 2===
 
===Example 2===
 +
 +
'''Metadata entry form'''
  
 
[[File:Metadata_entry_2.png|380px|thumb|center|]]
 
[[File:Metadata_entry_2.png|380px|thumb|center|]]
  
−
====Text file field mapping====
+
'''Column headers and sample values'''
−
*From data entry:
 
−
**Parent digital object ID --> digitalObjectID
 
−
**Use statement --> useStatement
 
−
**Restrictions apply? --> restrictionsApply (TRUE)
 
−
**Is component --> isComponent (TRUE)
 
−
**Object type --> objectType
 
  
−
*Auto-populated:
+
{| border="1" cellpadding="10" cellspacing="0" width="100%"
−
**title (filename without extension)
+
|-
−
**url (filepath and filename)
+
!'''useStatement'''
−
**existenceLocationOriginals (AIP UUID)
+
!'''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 13:16, 18 September 2012

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

Workflow

  1. The user processes a SIP the same way that all SIPs are processed
  2. At the Upload DIP micro-service, the user selects "Upload to Archivists' Toolkit"
  3. This automatically opens a data-entry form which must be completed by the user
  4. When the user saves the data and closes the data-entry form, the data are written to a tab-delimited text file in the DIP called ATmetadata.txt
  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 AIP METS file is not copied to the DIP.
  • 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

Metadata entry template

Field mapping

This screenshot shows the metadata entry form with the tab-delimited text file column headers indicated in grey font:

Metadata entry 0.png


Field notes

From metadata entry form:

  • useStatement (required element)
  • restrictionsApply (yes = TRUE, no = FALSE) - Question: would it be possible to auto-populate based on PREMIS rights?
  • isComponent (yes = TRUE, no = FALSE)
  • digitalObjectID (required if isComponent = TRUE, user bases entry on ID of parent digital object description in AT. If isComponent = FALSE, this field is auto-populated with the file UUID.)
  • objectType
  • title (if user leaves blank, this field is auto-populated with original filename)
  • dateExpression (free text field)
  • dateBegin (must be year only, eg 2012)
  • dateEnd (must be year only, eg 2012)


Auto-populated:

  • digitalObjectID (if not filled in by user, this field is auto-populated with file UUID)
  • title (if not filled in by user, this field is auto-populated with original filename)
  • uri (filepath and filename, including extension and UUID)
  • existenceLocationOriginals (AIP UUID)


Example 1

Metadata entry form

Metadata entry 1.png


Column headers and sample values

useStatement restrictionsApply isComponent digitalObjectID objectType title dateExpession dateBegin dateEnd uri 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


Example 2

Metadata entry form

Metadata entry 2.png

Column headers and sample values

useStatement restrictionsApply isComponent digitalObjectID objectType title dateExpession dateBegin dateEnd uri 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
Retrieved from "https://wiki.archivematica.org/index.php?title=Archivists_Toolkit_integration&oldid=6743"