Archivists Toolkit integration

From Archivematica
Jump to navigation Jump to search

Main Page > Development > Development documentation > 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 page which must be completed by the user
  4. When the user saves the data and closes the data-entry page, the data are written to a 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.

Metadata entry template

Example 1

Metadata entry 1.png


Text file field mapping

  • From data entry:
    • Use statement --> useStatement
    • Restrictions apply? --> restrictionsApply
    • Is component --> FALSE
    • Object type --> objectType
    • Date expression --> dateExpression
    • Date begin --> dateBegin
    • Date end --> dateEnd
  • Auto-populated:
    • digitalObjectID (file UUID)
    • title (filename without extension)
    • url (filepath and filename)
    • existenceLocationOriginals (AIP UUID)


Example 2

Metadata entry 2.png

Text file field mapping

  • From data entry:
    • Parent digital object ID --> digitalObjectID
    • Use statement --> useStatement
    • Restrictions apply? --> restrictionsApply (TRUE)
    • Is component --> isComponent (TRUE)
    • Object type --> objectType
  • Auto-populated:
    • title (filename without extension)
    • url (filepath and filename)
    • existenceLocationOriginals (AIP UUID)