Feature #9960

Add DIP object import task

Added by Mike Cantelon about 4 years ago. Updated almost 3 years ago.

Status:VerifiedStart date:06/03/2016
Priority:MediumDue date:
Assignee:-% Done:


Target version:Release 2.4.0
Google Code Legacy ID: Tested version:
Sponsored:Yes Requires documentation:


Add task, based on David J's work, to import digital objects from an Archivematica DIP.


#2 Updated by Dan Gillean about 4 years ago

  • Status changed from New to QA/Review
  • Target version set to Release 2.4.0
  • Sponsored changed from No to Yes
  • Requires documentation set to Yes

#3 Updated by Dan Gillean almost 4 years ago

  • Status changed from QA/Review to Feedback

Hi Mike, can you add some testing instructions for this? I have figured out that the command is:

php symfony import:dip-objects dip

Help command outputs the following:

 symfony import:dip-objects [--application[="..."]] [--env="..."] [--connection="..."] [--undo-log-dir[="..."]] [--audit] dip

 dip             The DIP directory.

 --application   The application name (default: 1)
 --env           The environment (default: cli)
 --connection    The connection name (default: propel)
 --undo-log-dir  Directory to write undo logs to (default: )
 --audit         Audit mode

 Process a CSV file to import digital objects from an Archivematica DIP to
 existing information objects in AtoM.

 The CSV file can be named anything, but must have the extension "csv" 

 The CSV file must start with a header row specifying column order. A "filename" 
 column must be included. Additionally, either an "identifier" or a "slug" 
 column must be included (not both: one of these will be used to specify
 information objects to import to).

 The import script expects that Archivematica will have modified the filename

 a) The original object file has been converted to a derivative with a
    corresponding extension ("jpg" for example)

 b) A UUID has been pre-pended to the filename (for example:

 Note: Filenames must be unique (without UUID) to avoid colliding on import.

 The undo-log-dir option can be used to log which information objects have
 digital objects added to them. This log can be used, in event of an incomplete
 import, to either establish where the import stopped or to manually remove the
 imported digital objects. Undo logs contain two columns: the ID of the
 information object to which objects have beem imported and the DIP directory
 the objects were imported from.

 The audit option can be used to verify that all objects specified in a DIP's
 CSV file were imported. If any are found to be missing the object filename
 will be output.

What I need clarified:

  • the dip argument: is this a path to the directory where the dips live, or a path to the csv file that tells AtoM where to find the dips?
  • Do the dips have to be unzipped then, so they are just dip objects not in a package? (e.g. a bunch of archivematica jpgs, mp3s, etc)
  • If the path is the to csv, maybe we should update the help instructions to indicate this - e.g. path/to/import-dips.csv or something?

I think that should give me enough to test. Thanks!

#4 Updated by Mike Cantelon almost 4 years ago

The dip argument is a path to a single DIP (not a path to the CSV file). The DIPs have to be unzipped, yes. The CSV should be located in the objects directory of the DIP - it doesn't need to be named anything particular.

#5 Updated by Dan Gillean almost 4 years ago

  • Status changed from Feedback to QA/Review
  • Assignee changed from Mike Cantelon to Dan Gillean

#6 Updated by Dan Gillean about 3 years ago

  • Assignee deleted (Dan Gillean)

#7 Updated by Dan Gillean almost 3 years ago

  • Status changed from QA/Review to Verified

#8 Updated by Dan Gillean almost 3 years ago

  • Requires documentation deleted (Yes)

Also available in: Atom PDF