Difference between revisions of "Archivists Toolkit integration"

From Archivematica
Jump to navigation Jump to search
m (Move to feature requirements category)
Line 2: Line 2:
This feature will re-format a DIP for import into Archivists' Toolkit.
This feature will re-format a DIP for import into Archivists' Toolkit.
[[Category:Feature requirements]]
Line 60: Line 62:
=Mapping digital objects to descriptions=
=Mapping digital objects to descriptions=
[[Category:Development documentation]]

Revision as of 14:28, 23 March 2017

Main Page > Development > Requirements > Archivists' Toolkit integration

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


  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. Archivematica opens a separate tab with user interface to allow the user to link digital objects to resource components in AT (see Mapping digital objects to descriptions, below)
  5. The DIP is placed in /uploadedDIPs/AT/.
  6. Archivematica sends the DIP metadata to Archivists Toolkit

DIP requirements


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

Metadata entry.png

Database field mapping

  • 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 isComponent is TRUE, populate from Parent digital object ID field in settings; if isComponent is FALSE, automatically populate with file UUID
  • title: Automatically populate with filename (without UUID)
  • uri: Automatically populate with eg http://www.myinstitution.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
  • If PREMIS <act> = Disseminate, populate ConditionsGoverningAccess with contents of PREMIS rightsGrantedNote
  • When restrictionsApply=TRUE, both eadDaoActuate and eadDaoShow will be set to “none.”


  • If PREMIS <act> = Publish, populate ConditionsGoverningUse with contents of PREMIS rightsGrantedNote

Mapping digital objects to descriptions


For examples and discussion of what the user interface described below might look like, see http://ux.stackexchange.com/questions/25715/how-can-i-allow-users-to-easily-pair-items-from-long-lists.

  1. The user is presented with a menu to select the Archivists’ Toolkit collection to which digital access objects should be added.
    • This menu should list at least the title of the collection and the Resource ID
  2. Archivematica returns all components of that collection at every level, including the collection level.
    • Enough data needs to be returned to the user to distinguish between components. At minimum, this would likely include the title, date, level (ie series, subseries, file) and persistent ID of the component.
  3. The user is presented with a screen that allows them to match components with digital access objects.
    • The user should be presented with the information specified above for each component. For digital objects, the user should be presented with the filename of the digital access objects, preferably without the Archivematica UUIDs since these are appended to the beginning of filenames and would confuse the user and/or inhibit sorting.
    • The user should be able to match components at any level with a digital access object.
    • The user should be able to match multiple digital access objects to a single component
    • A sorting mechanism should be available.
    • Once a match is made, the matched objects should move to another part of the screen or be grayed out.
  4. Once all desired matches have been made, a review/confirmation screen should be presented to the user, allowing them to confirm that they have made the correct matches. This could be accomplished by a different view of the matches made, or by export or print functionality.
  5. On confirmation, Archivematica writes data directly to the AT database. In all cases, Archivematica will add a digital object link and record, not replace or modify an existing link or record.

User interface

The user interface will be based on the following design:


Here is an example of the search and pairing template:


The user can then review and approve the pairs. If the user deletes a digital object from this screen, the digital object re-appears in the search and pairing template and can be re-matched.