Archivists Toolkit integration

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 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:

Field notes

From metadata entry form:

• useStatement (required element)
• restrictionsApply (yes = TRUE, no = FALSE)
• 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)
• url (filepath and filename, including extension and UUID)
• existenceLocationOriginals (AIP UUID)

Example 1

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

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)