Page History

...

For a full list of code changes (including patches) see: AipCoreAPIChanges

Various AIP Processing "Modes"

A short list of definitions of the various modes in which you can interact (export or import) with an AIP or set of AIPs:

1. Exporting Modes
   • Disseminate Mode (-d option) – disseminate/export AIP(s) based on objects in DSpace
2. Importing Modes
   • Submit/Ingest Mode (-s option, default) – submit AIP(s) to DSpace in order to create a new object(s).
   • Restore Mode (-r option) – restore pre-existing object(s) in DSpace based on AIP(s). This also attempts to restore all handles and relationships (parent/child objects). This is a specialized type of "submit", where the object is created with a known Handle and known relationships.
   • Replace Mode (-r -f option) – replace existing object(s) in DSpace based on AIP(s). This also attempts to restore all handles and relationships (parent/child objects). This is a specialized type of "restore" where existing object(s) are removed and replaced by the contents in the AIP(s). By default, if a "restore" encounters an existing object, it will back out (i.e. rollback all changes) and report which object already exists.

In addition, you can specify a recursive mode (--all or -a) for any of the above export or ingest modes. Recursive mode means that for Communities or Collections you will also export/import all of their "child objects". So, if you specified -d -a for a Community, you would recursively export an AIP for that Community along with any Sub-Communities, Collections or Items contained in that Community.

Running the Code

Here's how to get up and running relatively quickly!

...

• Submission Mode (-s) - creates a new object
  • By default, a new Handle is always assigned
    • However, you can force it to use the handle specified in the AIP by specifying -o ignoreHandle=false as one of your parameters
  • By default, a new Parent object must be specified (using the -p parameter). This is the location where the new object will be created.
    • However, you can force it to use the parent object specified in the AIP by specifiying -o ignoreParent=false as one of your parameters
  • By default, will respect a Collection's Workflow process when you submit an Item to a Collection
    • However, you can specifically skip any workflow approval processes by specifying -w parameter.
  • Always adds a new Deposit License to Items
  • Always adds new DSpace System metadata to Items (includes new 'dc.date.accessioned', 'dc.date.available', 'dc.date.issued' and 'dc.description.provenance' entries)

• Restore / Replace Mode - restores a new object (as if from a backup)
  • By default, the Handle specified in the AIP is restored
    • However, you can force a new handle to be generated by specifying -o ignoreHandle=true as one of your parameters. (NOTE: Doesn't work for replace mode as the new object always retains the handle of the replaced object)
  • By default, the object is restored under the Parent specified in the AIP
    • However, you can force it to restore under a different parent object by using the -p parameter. (NOTE: Doesn't work for replace mode, as the new object always retains the parent of the replaced object)
  • Always skips any Collection workflow approval processes when restoring an Item to a Collection
  • Never adds a new Deposit License to Items (rather it restores the previous deposit license, as long as it is in the AIP)
  • Never adds new DSpace System metadata to Items (rather it just restores the metadata as specified in the AIP)

...