Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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

...

a Single AIP

Note

This option allows you to essentially use an AIP as an SIP (Submission Information Package). The default settings will create a new object (with a new handle and a new parent object, if specified) from your 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 specify the -p (or --parent) package parameter to the command. Also, note that you are running the packager in -s (submit) mode.

...

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

If If you leave out these packagethe -p parameter options, the AIP package ingester will attempt to install the AIP under the same 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.

...

. As you are also specifying the -s (submit) parameter, the packager will assume you want a new Handle to be assigned (as you are effectively specifying that you are submitting a new object). If you want the object to retain the Handle specified in the AIP, you can specify the -o ignoreHandle=false option to force the packager to not ignore the Handle specified in the AIP.

Ingesting an AIP Hierarchy

Note

This option allows you to essentially use a set of AIPs as SIPs (Submission Information Packages). The default settings will create a new object (with a new handle and a new parent object, if specified) from each AIP

To ingest an AIP hierarchy from a directory of AIPs, use the -a (or --all) package parameter. In addition, as this is not a restore, you'd want to specify the -o ignoreParent=true parameter (ignores Parent Object information contained in the package) and the -o ignoreHandle=true parameter (ignores handle in package, and a new handle is assigned on ingest)the -a (or --all) package parameter.

For example, use this 'packager' command template:

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

for example:

Code Block
 /dspace/bin/dspace packager -s -a -t AIP -e admin@myu.edu -p 4321/12 -o ignoreParent=true -o ignoreHandle=true aip4567.zip

The above command will ingest the package named "aip4567.zip" as a child of the specified Parent Object (handle="4321/12"). The resulting object is assigned a new Handle (-o ignoreHandle=truesince -s is specified). In addition, any child AIPs referenced by "aip4567.zip" are also recursively ingested (a new Handle is also assigned for each child AIP).

...

Code Block
 /dspace/bin/dspace packager -s -a -t AIP -e admin@myu.edu -p 4321/0 -o ignoreParent=true -o ignoreHandle=true community-aip.zip

The above command will ingest the package named "community-aip.zip" as a top-level community (i.e. the specified parent is "4321/0" which is a Site Handle). Again, the resulting object is assigned a new Handle (-o ignoreHandle=true). In addition, any child AIPs referenced by "community-aip.zip" are also recursively ingested (a new Handle is also assigned for each child AIP).

...