Page History
Batch Metadata Editing
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Batch Metadata Editing Tool
DSpace provides a batch metadata editing tool. The batch editing tool is able to produce a comma delimited file in the CVS CSV format. The batch editing tool facilitates the user to perform the following:
- Batch editing of metadata (e.g. perform an external spell check)
- Batch additions of metadata (e.g. add an abstract to a set of items, add controlled vocabulary such as LCSH)
- Batch find and replace of metadata values (e.g. correct misspelled surname across several records)
- Mass move items between collections
- Mass deletion, withdrawal, or re-instatement of items
- Enable the batch addition of new items (without bitstreams) via a CSV file
- Re-order the values in a list (e.g. authors)
For information about configuration options for the Batch Metadata Editing tool, see Batch Metadata Editing Configuration
Export Function
The following table summarizes the basics.
...
Command used: |
| ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.app.bulkedit.MetadataExport | |
Arguments short and (long) forms): | Description | |
| Required. The filename of the resulting CSV. | |
| The Item, Collection, or Community handle or Database ID to export. If not specified, all items will be exported. | |
| Include all the metadata fields that are not normally changed (e.g. provenance) or those fields you configured in the | |
| Display the help page. |
...
In the above example we have requested that a collection, assigned handle '1989.1/24' export the entire collection to the file 'col_14.cvscsv' found in the '/batch_export' directory.
...
The following table summarizes the basics.
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9977499a-b081-4233-a603-1471e50d5a8d"><ac:plain-text-body><![CDATA[ | Command used: |
| ]]></ac:plain-text-body></ac:structured-macro> |
Java class: | org.dspace.app.bulkedit.MetadataImport | ||
Arguments short and (long) forms: | Description | ||
| Required. The filename of the CSV file to load. | ||
| Silent mode. The import function does not prompt you to make sure you wish to make the changes. | ||
| The email address of the user. This is only required when adding new items. | ||
| When adding new items, the program will queue the items up to use the Collection Workflow processes. | ||
| when adding new items using a workflow, send notification emails. | ||
| When adding new items, use the Collection template, if it exists. | ||
| Display the brief help page. |
...
| Code Block |
|---|
[dspace]/bin/dspace metadata-import -f name_of_file.csv |
Example
| Code Block |
|---|
[dspace]/bin/dspace metadata-import -f /dImport/col_14.csv |
...
| Code Block |
|---|
[dspace]/bin/dspace/ metadata-import -f /dImport/new_file.csv -e joe@user.com -w -n -t |
...
The csv files that this tool can import and export abide by the RFC4180 CSV format http://www.ietf.org/rfc/rfc4180.txt. This means that new lines, and embedded commas can be included by wrapping elements in double quotes. Double quotes can be included by using two double quotes. The code does all this for you, and any good csv editor such as Excel or OpenOffice will comply with this convention.
...
If you want to store multiple values for a given metadata element, they can be separated with the double-pipe '||' (or another character that you defined in your _dspacemodules/bulkedit.cfg _ file. For example:
| Code Block |
|---|
Horses||Dogs||Cats |
...
When importing a csv file, the importer will overlay the data 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. For example, if you only want to edit item abstracts, you can remove all of the other columns and just leave the abstract column. (You do need to leave the ID column intact. This is mandatory).
Editing Collection Membership
collection membership.Items can be moved between collections by editing the collection handles in the 'collection' column. Multiple collections can be included. The first collection is the 'owning collection'. The owning collection is the primary collection that the item appears in. Subsequent collections (separated by the field separator) are treated as mapped collections. These are the same as using the map item functionality in the DSpace user interface. To move items between collections, or to edit which other collections they are mapped to, change the data in the collection column.
Adding Metadata-Only Items
items.New metadata-only items can be added to DSpace using the batch metadata importer. To do this, enter a plus sign '+' in the first 'id' column. The importer will then treat this as a new item. If you are using the command line importer, you will need to use the -e flag to specify the user email address or id of the user that is registered as submitting the items.
Deleting Metadata
Data.It is possible to perform metadata deletes across the board of certain metadata fields from an exported file. For example, let's say you have used keywords (dc.subject) that need to be removed en masse. You would leave the column (dc.subject) intact, but remove the data in the corresponding rows.
Performing 'actions' on items
It is possible to perform certain 'actions' on items. This is achieved by adding an 'action' column to the CSV file (after the id, and collection columns). There are three possible actions:
- 'expunge' This permanently deletes an item. Use with care! This action must be enabled by setting 'allowexpunge = true' in
modules/bulkedit.cfg - 'withdraw' This withdraws an item from the archive, but does not delete it.
- 'reinstate' This reinstates an item that has previously been withdrawn.
If an action makes no change (for example, asking to withdraw an item that is already withdrawn) then, just like metadata that has not changed, this will be ignored.
Migrating Data or Exchanging data.
It is possible that you have data in one Dublin Core (DC) element and you wish to really have it in another. An example would be that your staff have input Library of Congress Subject Headings in the Subject field (dc.subject) instead of the LCSH field (dc.subject.lcsh). Follow these steps and your data is migrated upon import:
...
Overview
Content Tools