Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Changing instructions for recursive ingest/dissemination to use the new 'a' (or '-all') command flag.

...

To export an AIP hierarchy, use the -ca (or --includeChildrenall) package parameter.

For example, use this 'packager' command template:

Code Block
 /dspace/bin/dspace packager -d -a -t AIP -e <eperson> -i <handle> \
                             -c <child-dir-path> <file-path>

for example:

Code Block
 /dspace/bin/dspace packager -d -a -t AIP -e admin@myu.edu -i 4321/4567 \
                             -c /path/to/children-aips/ aip4567.zip
aip4567.zip

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

...

Code Block
 /dspace/bin/dspace packager -d -a -t AIP -e admin@myu.edu -i 4321/0 \
                             -c /path/to/children-aips/ sitewide-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" directorysame directory as the Site AIP.

Ingesting / Restoring AIPs

...

To ingest an AIP hierarchy from a directory of AIPs, use the -ca (or --includeChildrenall) 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).

...

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

for 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 \
                             -c /path/to/children-aips/ aip4567.zip
aip4567.zip

The above command will ingest the package named "aip4567.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=true). In addition, any child AIPs referenced by "aip4567.zip" in the folder "/path/to/children-aips" 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 \
                             -c /path/to/children-aips/ community-aip.zip
community-aip.zip

The above 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" in the folder "/path/to/children-aips" are also recursively ingested (a new Handle is also assigned for each child AIP).

...

Code Block
 /dspace/bin/dspace packager -r -a -t AIP -e <eperson> \
                             -c <child-dir-path> <file-path>
<file-path>

For exampleFor example:

Code Block
 /dspace/bin/dspace packager -r -a -t AIP -e admin@myu.edu \
                             -c /path/to/children-aips/ aip4567.zip
aip4567.zip

Notice that unlike -s option (for submission/ingesting)Notice that unlike -s option (for submission/ingesting), the -r option does not require the Parent Object (-p option) to be specified if it can be determined from the package itself.

In the above example, the package "aip4567.zip" is restored to the DSpace installation with the Handle provided within the package itself (and added as a child of the parent object specified within the package itself). In addition, any child AIPs referenced by "aip4567.zip" in the folder "/path/to/children-aips" are also recursively ingested. They are also restored with the Handles & Parent Objects provided with their package. If any object is found to already exist, all changes are rolled back (i.e. nothing is restored to DSpace)

...

One special case to note: If a Collection or Community is found to already exist, its child objects are also skipped over. So, this mode will not auto-restore items to an existing Collection.

Use this 'packager' command template:

Code Block
 /dspace/bin/dspace packager -r -k -t AIP -e <eperson> \
                             -c <child-dir-path> <file-path>

this mode will not auto-restore items to an existing Collection.

Use this 'packager' command templateFor example:

Code Block
 /dspace/bin/dspace packager -r -a -k -t AIP -e <eperson> <file-path>

For example:

Code Block
 /dspace/bin/dspace packager -r -a -k -t AIP -e admin@myu.eduadmin@myu.edu \
                             -c /path/to/children-aips/ aip4567.zip

In the above example, the package "aip4567.zip" is restored to the DSpace installation with the Handle provided within the package itself (and added as a child of the parent object specified within the package itself). In addition, any child AIPs referenced by "aip4567.zip" in the folder "/path/to/children-aips" are also recursively ingested. They are also restored with the Handles & Parent Objects provided with their package. If any object is found to already exist, it is skipped over (child objects are also skipped). All non-existing objects are restored.

...

Code Block
 /dspace/bin/dspace packager -r -f -t AIP -e <eperson> \
                             -c <child-dir-path> -a -f -t AIP -e <eperson> <file-path>

For example:

Code Block
 /dspace/bin/dspace packager -r -a -f -t AIP -e admin@myu.edu \
                             -c /path/to/children-aips/ aip4567.zip

In the above example, the package "aip4567.zip" is restored to the DSpace installation with the Handle provided within the package itself (and added as a child of the parent object specified within the package itself). In addition, any child AIPs referenced by "aip4567.zip" in the folder "/path/to/children-aips" are also recursively ingested. They are also restored with the Handles & Parent Objects provided with their package. If any object is found to already exist, it is removed from DSpace and replaced by the contents of the appropriate AIP.

...