Difference between revisions of "Archivists Toolkit integration"

From Archivematica
Jump to navigation Jump to search
Line 4: Line 4:
  
 
=Workflow=
 
=Workflow=
 +
#The user sets AT upload configuration options in the admin tab, via a menu called Archivists' Toolkit settings (see '''Settings''', below)
 
#The user processes a SIP the same way that all SIPs are processed
 
#The user processes a SIP the same way that all SIPs are processed
 
#At the Upload DIP micro-service, the user selects "Upload to Archivists' Toolkit"
 
#At the Upload DIP micro-service, the user selects "Upload to Archivists' Toolkit"
−
#This automatically opens a data-entry form which must be completed by the user
+
#A tab-delimited file generated from the settings called ATmetadata.txt is placed in the DIP
−
#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''
 
 
#The DIP is placed in ''/uploadedDIPs/AT/''.
 
#The DIP is placed in ''/uploadedDIPs/AT/''.
 
#The user can edit the metadata in the text file if desired
 
#The user can edit the metadata in the text file if desired
Line 19: Line 19:
 
**auto-populated from metadata generated during processing
 
**auto-populated from metadata generated during processing
  
−
==Metadata entry template==
+
==Settings==
  
 
===Field mapping===
 
===Field mapping===
  
−
This screenshot shows the metadata entry form with the tab-delimited text file column headers indicated in grey font:
+
This screenshot shows the settings form in the admin tab:
  
−
[[File:Metadata_entry_0.png|380px|thumb|center|]]
+
[[File:Metadata_entry.png|380px|thumb|center|]]
  
 
</br>
 
</br>

Revision as of 14:37, 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

Field mapping

This screenshot shows the settings form in the admin tab:

Metadata entry.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=7532"