Versions Compared

Key

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

...

  • Login as an Administrative user
  • In Sidebase, select "Export" → "Metadata".  Type in the Community/Collection name.
    • Alternatively, browse
    Browse
    • to the Community or Collection you wish to export, and
    click
    • then go to "Export
    Metadata" link to export to a downloadable CSV
    • In XMLUI, "Export Metadata" can be found in the "Context" menu on a Community/Collection homepage
    • In JSPUI, "Export Metadata" can be found in the "Admin Tools" menu on a Community/Collection homepage
  • Or search for items within your repository, and click "Export Metadata" in the search results to export to a downloadable CSV
    • In XMLUI, perform a search, and click on "Export Search Metadata" in the "Context" menu. By default, this option is only available to Administrators (xmlui.search.metadata_export=admin), but you can optionally allow any logged in user to export this metadata (xmlui.search.metadata_export=user), or anyone (xmlui.search.metadata_export=anonymous). 
    • In JSPUI, perform a search, and click on the "Export Metadata" button above the search results.
    • " → "Metadata".  That Community/Collection will be preselected.
  • Click "Export".  A new Process will be created (in "Processes" menu).  Once completed, download the resulting CSV.
Warning

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.

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

...

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:

...

  • First, complete all editing of the CSV and save your changes
  • Login as an Administrative User
  • Click In sidebar, select "Import" → "Metadata" and select drag & drop the CSV file
Warning

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.

Command used:

[dspace]/bin/dspace metadata-import

Java class:

org.dspace.app.bulkedit.MetadataImport

Arguments short and (long) forms:

Description

-f or --file

Required. The filename of the CSV file to load.

-s or --silent

Silent mode. The import function does not prompt you to make sure you wish to make the changes.

-e or --email

The email address of the user. This is only required when adding new items.

-w or --workflow

When adding new items, the program will queue the items up to use the Collection Workflow processes.

-n or --notify

when adding new items using a workflow, send notification emails.

-t or --template

When adding new items, use the Collection template, if it exists.

-h or --help

Display the brief help page.

Silent Mode should be used carefully. It is possible (and probable) that you can overlay the wrong data and cause irreparable damage to the database.

...

Info
titleTips to Simplify the Editing Process

 When editing a CSV, here's a couple of basic tips to keep in mind:

  1. The "id" column MUST remain intact. This column also must always have a value in it.
  2. To simplify the CSV, you can simply remove any columns you do NOT wish to edit (except for "id" column, see #1). Don't worry, removing the entire column won't delete metadata (see #3)
  3. When importing a CSV file, the importer will overlay the metadata onto what is already in the repository to determine the differences. It only acts on the contents of the CSV file, rather than on the complete item metadata. This means that the CSV file that is exported can be manipulated quite substantially before being re-imported. Rows (items) or Columns (metadata elements) can be removed and will be ignored. 
    1. For example, if you only want to edit "dc.subject", you can remove ALL columns EXCEPT for "id" and "dc.subject" so that you can just manipulate the "dc.subject" field. On import, DSpace will see that you've only included the "dc.subject" field in your CSV and therefore will only update the "dc.subject" metadata field for any items listed in that CSV.
  4. Because removing an entire column does NOT delete metadata value(s), if you actually wish to delete a metadata value you should leave the column intact, and simply clear out the appropriate row's value (in that column).

...


Editing Collection Membership

...