Unsupported Release
This documentation relates to an old, unsupported version of DSpace, version 1.7.x. Looking for another version? See all documentation.
As of January 2014, the DSpace 1.7.x platform is no longer supported. We recommend upgrading to a more recent version of DSpace.
General AIP Structure / Examples
Generally speaking, an AIP is an Zip file containing a METS manifest and all related content bitstreams, license files and any other associated files.
Some examples include:
- Site AIP (Sample: SITE-example.zip)
- METS contains basic metadata about DSpace Site and persistent IDs referencing all Top Level Communities
- Community AIP (Sample: COMMUNITY@123456789-1.zip)
- METS contains all metadata for Community and persistent IDs referencing all members (SubCommunities or Collections). Package may also include a Logo file, if one exists.
- Collection AIP (Sample: COLLECTION@123456789-2.zip)
- METS contains all metadata for Collection and persistent IDs referencing all members (Items). Package may also include a Logo file, if one exists.
- Item AIP (Sample: ITEM@123456789-8.zip)
- METS contains all metadata for Item and references to all Bundles and Bitstreams. Package also includes all Bitstream files.
Notes:
- Bitstreams and Bundles are second-class archival objects; they are recorded in the context of an Item.
- BitstreamFormats are not even second-class; they are described implicitly within Item technical metadata, and reconstructed from that during restoration
What is NOT in AIPs
- DSpace Groups, EPeople and Policies (access rights) are currently not described in AIPs. However, there is hope to include them in a future version.
DSpace Site configurations ([dspace]/config/ directory) or customizations are not described in AIPs
- DSpace Database model (or customizations therein) is not described in AIPs
AIP Details: METS Structure
mets
element@PROFILE
fixed value="http://www.dspace.org/schema/aip/1.0/mets.xsd" (this is how we identify an AIP manifest)@OBJID
URN-format persistent identifier (i.e. Handle) if available, or else a unique identifier. (e.g. "hdl:123456789/1")@LABEL
title if available@TYPE
DSpace object type, one of "DSpace ITEM", "DSpace COLLECTION", "DSpace COMMUNITY" or , "DSpace SITE".@ID
is a globally unique identifier, such asdspace67075091976862014717971209717749394363
.
mets/metsHdr
element@CREATEDATE
timestamp that AIP was created.@LASTMODDATE
last-modified date for a DSpace Item, or nothing for other objects.agent
element:@ROLE
= "CUSTODIAN",@TYPE
= "OTHER",@OTHERTYPE
= "DSpace Archive",name
= Site handle. (Note: The Site Handle is of the format[handle_prefix]/0
, e.g. "123456789/0")
mets/dmdSec
element- By default, two
dmdSec
elements are included for all AIPs:- object's descriptive metadata crosswalked to MODS (specified by
mets/dmdSec/mdWrap@MDTYPE="MODS"
) - object's descriptive metadata in DSpace native DIM intermediate format, to serve as a complete and precise record for restoration or ingestion into another DSpace. (specified by
mets/dmdSec/mdWrap@MDTYPE="OTHER",@OTHERMDTYPE="DIM"
)
- object's descriptive metadata crosswalked to MODS (specified by
- When the
mdWrap
@TYPE
value isOTHER
, the element MUST include a value for the@OTHERTYPE
attribute which names the crosswalk that produced (or interprets) that metadata, e.g.AIP-TECHMD
.
- By default, two
- First
mets/amdSec
element - admin (technical, source, rights, and provenance) metadata for the entire archival object.rightsMD
elements of the following TYPEsDSpaceDepositLicense
if the object has a deposit license, it is contained here. (mdWrap@MDTYPE="OTHER",@OTHERMDTYPE="DSpaceDepositLicense"
)CreativeCommonsRDF
If the object is an Item with a Creative Commons license expressed in RDF, it is included here. (mdWrap@MDTYPE="OTHER",@OTHERMDTYPE="CreativeCommonsRDF"
)CreativeCommonsText
If the object is an Item with a Creative Commons license in plain text, it is included here. (mdWrap@MDTYPE="OTHER",@OTHERMDTYPE="CreativeCommonsText"
)
sourceMD
elements - recorded twice, once in DSpace native format, once in PREMIS:
NOTE: PREMIS is only implemented for Bitstreams at the moment, and for the forseeable future.- DSpace native format: MDTYPE="OTHER" OTHERMDTYPE="
AIP-TECHMD
" (see Metadata in METS section below for details) - PREMIS expression of this technical metadata for archival object. (To be done later.)
- DSpace native format: MDTYPE="OTHER" OTHERMDTYPE="
digiprovMD
- Not used at this time.
- Additional
mets/amdSec
elements - technical metadata for each of an Items's Bitstreams, both in PREMIS and DIM formatstechMD
element - PREMIS technical metadata, expanded from SIP, for each of an Item's Bitstreams.sourceMD
element, type is AIP-TECHMD.- Bitstream-specific metadata not all of which is explicitly encoded in PREMIS, i.e.
name
(dc.title
)description
(dc.descripton
)userFormatDescription
(dc.format
)- BitstreamFormat, including short name, MIME type, extension. (
dc.format.medium
)-
- Why are we recording the file format support status? That's a DSpace property, rather than an Item property. Do DSpace instances rely on objects to tell them their support status?
- Format support and other properties of the BitstreamFormat are recorded here in case the Item is restored in an empty DSpace that doesn't have that format yet, and the relevant bits of the format entry have to be reconstructed from the AIP. --lcs
-
mets/fileSec
element- For archival objects of type ITEM:
- Each distinct Bundle in an Item goes into a
fileGrp
. ThefileGrp
has a@USE
attribute which corresponds to the Bundle name. - Bitstreams in bundles become
file
elements underfileGrp
. mets/fileSec/fileGrp/file
element- Set
@SIZE
to length of the bitstream. There is a redundant value in the techMD but it is more accessible here. - Set
@MIMETYPE
,@CHECKSUM
,@CHECKSUMTYPE
to corresponding bitstream values. There is redundant info in the techMD. (For DSpace, the@CHECKSUMTYPE="MD5"
) - SET
@SEQ
to bitstream's SequenceID if it has one.
- Set
- Each distinct Bundle in an Item goes into a
- For archival objects of types COLLECTION and COMMUNITY:
- Only if the object has a logo bitstream, there is a
fileSec
with onefileGrp
child of@USE="LOGO"
. - The
fileGrp
contains onefile
element, representing the logo Bitstream. It has the same@MIMETYPE
,@CHECKSUM
,@CHECKSUMTYPE
attributes as the Item content bitstreams, but does NOT include metadata section references or a@SEQ
attribute. - See the main
structMap
for thefptr
reference to this logo file.
- Only if the object has a logo bitstream, there is a
- For archival objects of type ITEM:
mets/structMap
- Primary structure map,@LABEL="DSpace Object", @TYPE="LOGICAL"
- For ITEM objects:
- Top-Level
div
with@TYPE="DSpace Object Contents"
.- For every Bitstream in Item it contains a
div
with@TYPE="DSpace Content Bitstream"
. Each Bitstreamdiv
has a singlefptr
element which references the bitstream location.
- For every Bitstream in Item it contains a
- If Item has primary bitstream, put it in
structMap/div/fptr
(i.e. directly under thediv
with@TYPE="DSpace Object Contents"
)
- Top-Level
- For COLLECTION objects:
- Top-Level
div
with@TYPE="DSpace Object Contents"
.- For every Item in the Collection, it contains a
div
with@TYPE="DSpace Item"
. Each Itemdiv
has up to two childmptr
elements:- One linking to the Handle of that Item. Its
@LOCTYPE="HANDLE"
, and@xlink:href
value is the raw Handle. - (Optional) one linking to the location of the local AIP for that Item (if known). Its
@LOCTYPE="URL"
, and@xlink:href
value is a relative link to the AIP file on the local filesystem.
- One linking to the Handle of that Item. Its
- For every Item in the Collection, it contains a
- If Collection has a Logo bitstream, there is an
fptr
reference to it in the very firstdiv
.
- Top-Level
- For COMMUNITY objects:
- Top-Level
div
with@TYPE="DSpace Object Contents"
.- For every Sub-Community in the Community it contains a
div
with@TYPE="DSpace Community"
. Each Communitydiv
has up to twomptr
elements:- One linking to the Handle of that Community. Its
@LOCTYPE="HANDLE"
, and@xlink:href
value is the raw Handle. - (Optional) one linking to the location of the local AIP file for that Community (if known). Its
@LOCTYPE="URL"
, and@xlink:href
value is a relative link to the AIP file on the local filesystem.
- One linking to the Handle of that Community. Its
- For every Collection in the Community there is a
div
with@TYPE="DSpace Collection"
. Each Collectiondiv
has up to twomptr
elements:- One linking to the Handle of that Collection. Its
@LOCTYPE="HANDLE"
, and@xlink:href
value is the raw Handle. - (Optional) one linking to the location of the local AIP file for that Collection (if known). Its
@LOCTYPE="URL"
, and@xlink:href
value is a relative link to the AIP file on the local filesystem.
- One linking to the Handle of that Collection. Its
- For every Sub-Community in the Community it contains a
- If Community has a Logo bitstream, there is an
fptr
reference to it in the very firstdiv
.
- Top-Level
- For SITE objects:
- Top-Level
div
with@TYPE="DSpace Object Contents"
.- For every Top-level Community in Site, it contains a
div
with@TYPE="DSpace Community"
. Each Itemdiv
has up to two childmptr
elements:- One linking to the Handle of that Community. Its
@LOCTYPE="HANDLE"
, and@xlink:href
value is the raw Handle. - (Optional) one linking to the location of the local AIP for that Community (if known). Its
@LOCTYPE="URL"
, and@xlink:href
value is a relative link to the AIP file on the local filesystem.
- One linking to the Handle of that Community. Its
- For every Top-level Community in Site, it contains a
- Top-Level
- For ITEM objects:
mets/structMap
- Structure Map to indicate object's Parent,@LABEL="Parent", @TYPE="LOGICAL"
- Contains one
div
element which has the unique attribute valueTYPE="AIP Parent Link"
to identify it as the older of the parent pointer.- It contains a
mptr
element whosexlink:href
attribute value is the raw Handle of the parent object, e.g.1721.1/4321
.
- It contains a
- Contains one
Metadata in METS
The following tables describe how various metadata fields are populated (via DSpace Crosswalks) in the METS file for an AIP.
DIM Descriptive Elements for Collection objects
Metadata Field |
Database field or value |
---|---|
dc.description |
'introductory_text' field |
dc.description.abstract |
'short_description' field |
dc.description.tableofcontents |
'side_bar_text' field |
dc.identifier.uri |
Collection's handle |
dc.provenance |
'provenance_description' field |
dc.rights |
'copyright_text' field |
dc.rights.license |
'license' field |
dc.title |
'name' field |
DIM Descriptive Elements for Community objects
Metadata Field |
Database field or value |
---|---|
dc.description |
'introductory_text' field |
dc.description.abstract |
'short_description' field |
dc.description.tableofcontents |
'side_bar_text' field |
dc.identifier.uri |
Handle of Community |
dc.rights |
'copyright_text' field |
dc.title |
'name' field |
DIM Descriptive Elements for Site objects
Metadata Field |
Value |
||
---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="53b5c5df-f26b-4c42-9776-796f911935dd"><ac:plain-text-body><![CDATA[ |
dc.identifier.uri |
Handle of Site (format: |
]]></ac:plain-text-body></ac:structured-macro> |
dc.title |
Name of Site (from dspace.cfg 'dspace.name' config) |
AIP Technical Metadata for Item
Metadata Field |
Value |
---|---|
dc.contributor |
Submitter's email address |
dc.identifier.uri |
Handle of Item |
dc.relation.isPartOf |
Owning Collection's Handle (as a URN) |
dc.relation.isReferencedBy |
All other Collection's this item is linked to (Handle URN of each non-owner) |
dc.rights.accessRights |
"WITHDRAWN" if item is withdrawn |
AIP Technical Metadata for Bitstream
Metadata Field |
Value |
---|---|
dc.title |
Bitstream's name/title |
dc.title.alternative |
Bitstream's source (getSource()) |
dc.description |
Bitstream's description (getDescription()) |
dc.format |
Bitstream Format Description (getUserFormatDescription()) |
dc.format.medium |
Short Name of Format (getFormat().getShortDescription()) |
dc.format.mimetype |
MIMEType of Format (getFormat().getMIMEType()) |
dc.format.supportlevel |
System Support Level for Format (getFormat().getSupportLevel()) |
dc.format.internal |
Whether Format is internal (getFormat().isInternal()) |
AIP Technical Metadata for Collection
Metadata Field |
Value |
---|---|
dc.identifier.uri |
Handle of Collection |
dc.relation.isPartOf |
Owning Community's Handle (as a URN) |
dc.relation.isReferencedBy |
All other Communities this Collection is linked to (Handle URN of each non-owner) |
AIP Technical Metadata for Community
Metadata Field |
Value |
---|---|
dc.identifier.uri |
Handle of Community |
dc.relation.isPartOf |
Handle of Parent Community (as a URN) |
AIP Technical Metadata for Site
Metadata Field |
Value |
||
---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="acdd11d2-f3da-482d-aa14-15a0fbab6600"><ac:plain-text-body><![CDATA[ |
dc.identifier.uri |
Site Handle (format: |
]]></ac:plain-text-body></ac:structured-macro> |