...

 /dspace/bin/dspace packager -d -t AIP -e florey@mitadmin@myu.edu -i 1721.14321/4567 aip4567.zip

The above code will export the object of the given handle (1721.14321/4567) into an AIP file named "aip4567.zip". This will not include any child objects for Communities or Collections.

...

To export an AIP hierarchy, use the includeChildren and childDirectory package parameters.

For example, use this 'packager' command template:

...

 /dspace/bin/dspace packager -d -t AIP -e florey@mitadmin@myu.edu -i 1721.14321/4567 \
                             -o includeChildren=true -o childDirectory=/path/to/children-aips/ aip4567.zip

The above code will export the object of the given handle (1721.14321/4567) into an AIP file named "aip4567.zip". In addition it would export all children objects to a directory at the path "/path/to/children-aips/". The child AIPs are all named using the following format:

• File Name Format: <Obj-Type>@<Handle-with-dashes>.zip
  • e.g. COMMUNITY@123456789-1.zip, COLLECTION@123456789-2.zip, ITEM@123456789-200.zip
  • This general file naming convention ensures that you can easily locate an object to restore by its name (assuming you know its Object Type and Handle).
• Alternatively, if object doesn't have a Handle, it uses this File Name Format: <Obj-Type>@internal-id-<DSpace-ID>.zip

Exporting entire Site

To export an entire DSpace Site, pass the packager the Handle <site-handle-prefix>/0. For example, if your site prefix is "4321", you'd run a command similar to the following:

 /dspace/bin/dspace packager -d -t AIP -e admin@myu.edu -i 4321/0 \
                             -o includeChildren=true -o childDirectory=/path/to/children-aips/ sitewide-aip.zip

Again, this would export the DSpace Site AIP into the file "sitewide-aip.zip", and export AIPs for all Communities, Collections and Items into the "/path/to/children-aips" directory.

Ingesting AIPs

Again, like export, there are two main "modes" you can run the AIP packager in:

• Single AIP (default) - Ingests just an AIP describing a single DSpace object. So, if you ran it in this default mode for a Collection AIP, you'd just create a DSpace Collection from the AIP (but not ingest any of its child objects)
• Hierarchy (including child objects) - Ingests the requested AIP describing an object, plus the AIP for all child objects. Some examples follow:
  • For a Site - this would create all Communities, Collections & Items based on the located AIP files
  • For a Community - this would create that Community and all SubCommunities, Collections and Items based on the located AIP files
  • For a Collection - this would create that Collection and all contained Items based on the located AIP files
  • For an Item – this just create the Item (including all Bitstreams & Bundles) based on the AIP file.

Ingesting just a Single AIP

To ingest a single AIP and create a new DSpace object under a parent of your choice, add the ignoreParent and ignoreHandle package parameters to the command. Also, note that you are running the packager in -s (submit) mode.

NOTE: This only ingests the single AIP specified. It does not ingest all children objects.

 /dspace/bin/dspace packager -s -t AIP -e <eperson> -p <parent-handle> -o ignoreParent=true -o ignoreHandle=true <file-path>

If you leave out these package-parameter options, the AIP package ingester will attempt to install the AIP under the parent handle it had before, and give it back its original Handle. After all, the point of AIPs was to reproduce the exact object that was exported. When you are effectively using the AIP as a SIP, however, you may not want it back under the same parent or handle, so there is a way to override these features.

Ingesting an AIP Hierarchy

Details Coming Soon! In all likelihood it will take the same parameters as the "Exporting an AIP Hierarchy", except that you'll be running the packager in -s (submit) mode.

Questions / Comments?

Questions or comments – either add them inline above, or contact Tim Donohue