Versions Compared

Key

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

...

Warning
titleDSpace 7.0 does not yet support all features

In DSpace 7.0, it is not possible to export to CSV based on search results.  This feature existed in 6.x, and it is scheduled to be restored in a later 7.x release (currently 7.1). See DSpace Release 7.0 Status.

Added in DSpace 7.3:

  • Validate a Batch Metadata CSV before applying changes Export search results to a CSV(similar to 6.x).  When uploading a CSV for batch updates (using "Import" menu), a new "Validate Only" option is selected by default. When selected, the uploaded CSV will only be validated & you'll receive a report of the detected changes in the CSV.  This allows you to verify the changes are correct before applying them.  (NOTE: applying the changes requires re-submitting the CSV with the "Validate Only" option deselected)Export search results to a CSV (similar to 6.x).When logged in as an Administrator, after performing a search a new "Export search results as CSV" button appears. Clicking it will export the metadata of all items in your search results to a CSV.  This CSV can then be used to perform batch metadata updates (based on the items in your search results). - Release Notes#7.3ReleaseNotes

Please see below documentation for more information on the CSV format and actions that can be performed by editing the CSV.

Command Line Export

The following table summarizes the basics.

...

Command used:

  • When logged in as an Administrator, after performing a search a new "Export search results as CSV" button appears. Clicking it will export the metadata of all items in your search results to a CSV.  This CSV can then be used to perform batch metadata updates (based on the items in your search results). - Release Notes#7.3ReleaseNotes

Please see below documentation for more information on the CSV format and actions that can be performed by editing the CSV.

Command Line Export

The following table summarizes the basics.

Command used:

[dspace]/bin/dspace metadata-export

Java class:

org.dspace.app.bulkedit.MetadataExport

Arguments short and (long) forms):

Description

-f or --file

Required. The filename of the resulting CSV.

-i or --id

The Item, Collection, or Community handle or Database ID to export. If not specified, all items will be exported.

-a or --all

Include all the metadata fields that are not normally changed (e.g. provenance) or those fields you configured in the [dspace]/config/modules/bulkedit.cfg to be ignored on export.

-h or --help

Display the help page.

To run the batch editing exporter, at the command line:

Code Block
[dspace]/bin/dspace metadata-export

...

Java class:

...

org.dspace.app.bulkedit.MetadataExport

...

Arguments short and (long) forms):

...

Description

...

-f or --file

...

Required. The filename of the resulting CSV.

...

-i or --id

...

The Item, Collection, or Community handle or Database ID to export. If not specified, all items will be exported.

...

-a or --all

...

Include all the metadata fields that are not normally changed (e.g. provenance) or those fields you configured in the [dspace]/config/modules/bulkedit.cfg to be ignored on export.

...

-h or --help

...

Display the help page.

 -f name_of_file.csv -i 1023/24

Example:

Code Block
[dspace]/bin/dspace metadata-export -f /batch_export/col_14.csv -i /1989.1/24

In the above example we have requested that a collection, assigned handle '1989.1/24' export the entire collection to the file 'col_14.csv' found in the '/batch_export' directory.

Please see below documentation for more information on the CSV format and actions that can be performed by editing the CSV .

Import Function

Note
titleImporting large CSV files

It is not recommended to import CSV files of more than 1,000 lines (i.e. 1,000 items). When importing files larger than this, it may be difficult for an Administrator to accurately verify the changes that the import tool states it will make. In addition, depending on the memory available to the DSpace site, large files may cause 'Out Of Memory' errors part way through the import process.

Web Interface Import

Batch metadata imports (from CSV) can be performed from the Administrative menu:

  • First, complete all editing of the CSV and save your changes
  • Login as an Administrative User
  • In sidebar, select "Import" → "Metadata" and drag & drop the CSV file
Warning
titleDSpace 7.0 does not yet support all features

In DSpace 7.0, metadata import will occur immediately & results will be reported.  In 6.x, after uploading the CSV, you were first presented with a summary of the changes that were to be performed, allowing you to review and choose whether to apply them or cancel.  This "preview" feature will be restored in a later 7.x release (currently 7.1), see DSpace Release 7.0 Status.

Added in DSpace 7.3:

  • Validate a Batch Metadata CSV before applying changes (similar to 6.x).  When uploading a CSV for batch updates (using "Import" menu), a new "Validate Only" option is selected by default. When selected, the uploaded CSV will only be validated & you'll receive a report of the detected changes in the CSV.  This allows you to verify the changes are correct before applying them.  (NOTE: applying the changes requires re-submitting the CSV with the "Validate Only" option deselected)  - Release Notes#7.3ReleaseNotes

To run the batch editing exporter, at the command line:

Code Block
[dspace]/bin/dspace metadata-export -f name_of_file.csv -i 1023/24

Example:

Code Block
[dspace]/bin/dspace metadata-export -f /batch_export/col_14.csv -i /1989.1/24

In the above example we have requested that a collection, assigned handle '1989.1/24' export the entire collection to the file 'col_14.csv' found in the '/batch_export' directory.

Please see below documentation for more information on the CSV format and actions that can be performed by editing the CSV .

Import Function

Note
titleImporting large CSV files

It is not recommended to import CSV files of more than 1,000 lines (i.e. 1,000 items). When importing files larger than this, it may be difficult for an Administrator to accurately verify the changes that the import tool states it will make. In addition, depending on the memory available to the DSpace site, large files may cause 'Out Of Memory' errors part way through the import process.

Web Interface Import

Batch metadata imports (from CSV) can be performed from the Administrative menu:

  • First, complete all editing of the CSV and save your changes
  • Login as an Administrative User
  • In sidebar, select "Import" → "Metadata" and drag & drop the CSV file
Warning
titleDSpace 7.0 does not yet support all features
In DSpace 7.0, metadata import will occur immediately & results will be reported.  In 6.x, after uploading the CSV, you were first presented with a summary of the changes that were to be performed, allowing you to review and choose whether to apply them or cancel.  This "preview" feature will be restored in a later 7.x release (currently 7.1), see DSpace Release 7.0 Status.


Command Line Import

The following table summarizes the basics.

...