View Source

Generally speaking, an AIP is an Zip file containing a METS manifest and all related content bitstreams, license files and any other associated files.

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 as dspace67075091976862014717971209717749394363.
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:
  1. object's descriptive metadata crosswalked to MODS (specified by mets/dmdSec/mdWrap@MDTYPE="MODS")
  2. 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")
- When the mdWrap @TYPE value is OTHER, the element MUST include a value for the @OTHERTYPE attribute which names the crosswalk that produced (or interprets) that metadata, e.g. AIP-TECHMD.
First mets/amdSec element - admin (technical, source, rights, and provenance) metadata for the entire archival object.
- rightsMD elements of the following TYPEs
  - DSpaceDepositLicense 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.)
- digiprovMD
  - Not used at this time.
Additional mets/amdSec elements - technical metadata for each of an Items's Bitstreams, both in PREMIS and DIM formats
- techMD 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. The fileGrp has a @USE attribute which corresponds to the Bundle name.
Bitstreams in bundles become file elements under fileGrp.
file/@SEQ contains the Bitstream sequence ID

file@CREATED and file@SIZE

<span style="color: red">The DSpace SIP calls for the use of <code>@CREATED</code> for the file element, AIP examples do not use <code>@CREATED</code>, but do use <code>@SIZE</code>, which is not recommended by SIP.</span>
\[Since Bitstreams don't have any dates (neither created nor last-modified) the at CREATED cannot be set on dissemination. --lcs\]

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.
For archival objects of types COLLECTION and COMMUNITY:
- Only if the object has a logo bitstream, there is a fileSec with one fileGrp child of @USE="LOGO".
- The fileGrp contains one file element, representing the logo Bitstream. It has the same file format, checksum, etc fields as the Item content bitstreams, but does not include metadata section references or a SequenceID.
- See the main structMap for the reference to this file.

mets/structMap - Primary structure map, @LABEL="DSpace Object", @TYPE="LOGICAL"
- For ITEM objects:
  1. Top-Level div with @TYPE="DSpace Object Contents".
    - For every Bitstream in Item it contains a div with @TYPE="DSpace Content Bitstream". Each Bitstream div has a single fptr element which references the bitstream location.
  - If Item has primary bitstream, put it in structMap/div/fptr (i.e. directly under the div with @TYPE="DSpace Object Contents")
- For COLLECTION objects:
  1. Top-Level div with @TYPE="DSpace Object Contents".
    - For every Item in the Collection, it contains a div with @TYPE="DSpace Item". Each Item div has up to two child mptr elements:
      1. One linking to the Handle of that Item. Its @LOCTYPE="HANDLE", and @xlink:href value is the raw Handle.
      2. (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.
  - If Collection has a Logo bitstream, there is an fptr reference to it in the very first div.
- For COMMUNITY objects:
  1. Top-Level div with @TYPE="DSpace Object Contents".
    - For every Sub-Community in the Community it contains a div with @TYPE="DSpace Community". Each Community div has up to two mptr elements:
      1. One linking to the Handle of that Community. Its @LOCTYPE="HANDLE", and @xlink:href value is the raw Handle.
      2. (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.
    - For every Collection in the Community there is a div with @TYPE="DSpace Collection". Each Collection div has up to two mptr elements:
      1. One linking to the Handle of that Collection. Its @LOCTYPE="HANDLE", and @xlink:href value is the raw Handle.
      2. (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.
  - If Community has a Logo bitstream, there is an fptr reference to it in the very first div.
- For SITE objects:
  1. Top-Level div with @TYPE="DSpace Object Contents".
    - For every Top-level Community in Site, it contains a div with @TYPE="DSpace Community". Each Item div has up to two child mptr elements:
      1. One linking to the Handle of that Community. Its @LOCTYPE="HANDLE", and @xlink:href value is the raw Handle.
      2. (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.
mets/structMap - Structure Map to indicate object's Parent, @LABEL="Parent", @TYPE="LOGICAL"
- Contains one div element which has the unique attribute value TYPE="AIP Parent Link" to identify it as the older of the parent pointer.
  - It contains a mptr element whose xlink:href attribute value is the raw Handle of the parent object, e.g. 1721.1/4321.

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="5d4ba536-c42c-4341-a876-fbbbe6b27d57"><ac:plain-text-body><![CDATA[	dc.identifier.uri	Handle of Site (format: `[handle_prefix]/0`)	]]></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="c13dc60f-4ca6-4f33-9337-17ca93abcd9d"><ac:plain-text-body><![CDATA[	dc.identifier.uri	Site Handle (format: `[handle_prefix]/0`)	]]></ac:plain-text-body></ac:structured-macro>