All Versions
- DSpace 7.x (Current Release)
- DSpace 8.x (Unreleased)
- DSpace 6.x (EOL)
- DSpace 5.x (EOL)
- More Versions...
...
The basic concept behind the DSpace 's Simple Archive Format is to create an archive, which is a directory containing one subdirectory per item. Each item directory contains a file for the item's descriptive metadata, and the files that make up the item.
...
The contents
file simply enumerates, one file per line, the bitstream file names. See the following example:
Code Block |
---|
file_1.doc file_2.pdf license |
Please notice that the license
is optional, and if you wish to have one included, you can place the file in the .../item_001/ directory, for example.
...
metadata_[prefix].xml
, where the [prefix]
is replaced with the schema's prefix.<dublin_core>
element include the attribute schema=[prefix]
.Here is an example for ETD metadata, which would be in the file metadata_etd.xml
:
Code Block |
---|
<?xml version="1.0" encoding="UTF-8"?> <dublin_core schema="etd"> <dcvalue element="degree" qualifier="department">Computer Science</dcvalue> <dcvalue element="degree" qualifier="level">Masters</dcvalue> <dcvalue element="degree" qualifier="grantor">Michigan Institute of Technology</dcvalue> </dublin_core> |
...
Before running the item importer over items previously exported from a DSpace instance, please first refer to Transferring Items Between DSpace Instances.
Command used: |
|
Java class: |
|
Arguments short and (long) forms: | Description |
| Add items to DSpace ‡ |
| Replace items listed in mapfile ‡ |
| Delete items listed in mapfile ‡ |
| Source of the items (directory) |
| Destination Collection by their Handle or database ID |
| Where the mapfile for items can be found (name and directory) |
| Email of eperson doing the importing |
| Send submission through collection's workflow |
| Kicks off the email alerting of the item(s) has(have) been imported |
| Test run‚ do not actually import items |
| Apply the collection template |
| Resume a failed import (Used on Add only) |
| Command help |
| Name of zipfile |
‡ These are mutually exclusive.
...
Replacing existing items is relatively easy. Remember that mapfile you were supposed to savesaved above? Now you will use it. The command (in short form):
...
You are able to unimport or delete items provided you have the mapfile. Remember that mapfile you were supposed to savesaved above? The command is (in short form):
...
Visit "My DSpace" page
Moreover, the user can take the following actions:
Download the map file that was produced during the import. This file contains a list of items that were imported with the corresponding handle assigned to them by DSpace.
Delete the imported items. Everything that was imported will be deleted (including the history directory in the "[dspace]/import" directory)
In case of failure, the user can "Resume" the import. The user is taken to the upload form again, but the system recognizes the initial import (and the map file) in order to resume the old import. There is a red label in the form that informs the user about the "Resume" form.
A SimpleArchiveFormat package can be imported by an administrator in XMLUI. The SimpleArchiveFormat package needs to be compressed into a ZIP file, and it be will be uploaded to XMLUI through the browser. DSpace will then process that ZIP, and ingest items into DSpace. A stable network connection is recommended, as your browser will need to upload a potentially large ZIP file, and then wait while DSpace processes that ZIP file.
While logged in as an administrator, click on Batch Import (ZIP):
Then, choose the owning collection from the collection dropdown, and browse to the ZIP file on your computer that has the SimpleArchiveFormat ZIP file.
If successful, you will get a green message with a list of handles that were imported. It is what is considered the "map file".
If an error occurred, you will get a red error message with the issue:
The item exporter can export a single item or a collection of items, and creates a DSpace simple archive in the aforementioned format for each exported item. The items are exported in a sequential order in which they are retrieved from the database. As a consequence, the sequence numbers of the item subdirectories (item_000, item_001) are not related to DSpace handle or item ids.
Command used: |
|
Java class: | org.dspace.app.itemexport.ItemExport |
Arguments short and (long) forms: | Description |
| Type of export. COLLECTION will inform the program you want the whole collection. ITEM will be only the specific item. (You will actually key in the keywords in all caps. See examples below.) |
| The ID or Handle of the Collection or Item to export. |
| The destination path where you want the file of items to be placed. |
| Sequence number to begin export the items with. Whatever number you give, this will be the name of the first directory created for your export. The layout of the export directory is the same as the layout used for import. |
| Export the item/collection for migration. This will remove the handle and metadata that will be re-created in the new instance of DSpace. |
| Brief Help. |
Exporting a Collection
The CLI command to export the items of a collection:
...