Versions Compared

Key

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

...

This section describes the parameters used in configuring the OAI-ORE / OAI-ORE harvester. This harvester can be used to harvest content (bitstreams and metadata) into DSpace from an external OAI-PMH or OAI-ORE server.

Info
titleDSpace Supported in 7.0 does not support this1 or above

OAI Harvesting is was not available in DSpace 7.0. It is has been added was restored in DSpace 7.1. See DSpace Release 7.0 Status

Harvesting from another DSpace

...

The harvest script can be called from both the CLI and REST API by calling "harvest". It uses the paramaters as defined in the following table.

Short optionLong optionArgumentExplanation
-p--purge
NO
[none]Delete all the items in the collection provided with the -c parameter.
-r--run
NO
[none]Run the standard harvesting procedure for the collection provided with the -c parameter.
-g--ping
NO
[none]Verify that the server provided through the -a parameter and the set provided through the -i parameter can be resolved and work.
-s--setup
NO
[none]Set the collection provided with the -c parameter up for harvesting. The server will need to be provided through the -a parameter, and the oai set id needs to be provided by the -i parameter.
-S--start
NO
[none]Start the harvest loop for all collections.
-R--reset
NO
[none]Reset the harvest status on all collections.
-P--purgeCollections
NO
[none]Purge all harvestable collections.
-o--reimport
NO
[none]Reimport all items the items in the collection provided by the -c parameter. This is the equivalent of running both the -p and the -r command for the provided collection.
-c--collection
YES
[id-or-handle]The harvesting collection (handle or id)
-t--type
YES
[type-code]The type of harvesting: 0 for no harvesting, 1 for metadata only, 2 for metadata and bitstream references (requires ORE support), 3 for metadata and bitstreams (requires ORE support)
-a--address
YES
[url]The address of the OAI-PMH server to be harvested
-i--oai_set_id
YES
[set-id]The id of the PMH set representing the harvested collection. In case all sets need to harvested the value "all" should be provided.
-m--metadata_format
YES
[format]The name of the desired metadata format for harvesting, resolved to namespace and crosswalk in the dspace.cfg
-h --help
NO
[none]Print the help message
-e--eperson
YES
[email](CLI ONLY) The eperson that performs the harvest. When the command is used from the REST API, the currently logged in user will be used.


Examples of harvesting a collection through CLI commands

...