DSpace Documentation : DSpaceAIPFormat
This page last changed on Oct 29, 2010 by tdonohue.
General AIP Structure / ExamplesGenerally 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:
Notes:
What is NOT in AIPs
Customizing What Is Stored in Your AIPsIf you choose, you can customize exactly what information is stored in your AIPs. However, you should be aware that you can only restore information which is stored within your AIPs. If you choose to remove information from your AIPs, you will be unable to restore it later on (unless you are also backing up your entire DSpace database and assetstore folder).
There are two ways to go about customizing your AIP format:
AIP Details: METS Structure
Metadata in METSThe following tables describe how various metadata schemas are populated (via DSpace Crosswalks) in the METS file for an AIP. DIM (DSpace Intermediate Metadata) SchemaDIM Schema is essentially a way of representing DSpace internal metadata structure in XML. DSpace's internal metadata is very similar to a Qualified Dublin Core in its structure, and is primarily meant for descriptive metadata. However, DSpace's metadata allows for custom elements, qualifiers or schemas to be created (so it is extendable to any number of schemas, elements, qualifiers). These custom fields/schemas may or may not be able to be translated into normal Qualified Dublin Core. So, the DIM Schema must be able to express metadata schemas, elements or qualifiers which may or may not exist within Qualified Dublin Core. In the METS structure, DIM metadata always appears within a dmdSec inside an <mdWrap MDTYPE="OTHER" OTHERMDTYPE="DIM"> element. For example: <dmdSec ID="dmdSec_2190"> <mdWrap MDTYPE="OTHER" OTHERMDTYPE="DIM"> ... </mdWrap> </dmdSec> By default, DIM metadata is always included in AIPs. It is controlled by the following configuration in your dspace.cfg: aip.disseminate.dmd = MODS, DIM DIM Descriptive Elements for Item objectsAs all DSpace Items already have user-assigned DIM (essentially Qualified Dublin Core) metadata fields, those fields are just exported into the DIM Schema within the METS file. DIM Descriptive Elements for Collection objectsFor Collections, the following fields are translated to the DIM schema:
DIM Descriptive Elements for Community objectsFor Communities, the following fields are translated to the DIM schema:
DIM Descriptive Elements for Site objectsFor the Site Object, the following fields are translated to the DIM schema:
MODS SchemaBy default, all DSpace descriptive metadata (DIM) is also translated into the MODS Schema by utilizing DSpace's MODSDisseminationCrosswalk. DSpace's DIM to MODS crosswalk is defined within your [dspace]/config/crosswalks/mods.properties configuration file. This file allows you to customize the MODS that is included within your AIPs. For more information on the MODS Schema, see http://www.loc.gov/standards/mods/mods-schemas.html In the METS structure, MODS metadata always appears within a dmdSec inside an <mdWrap MDTYPE="MODS"> element. For example: <dmdSec ID="dmdSec_2189"> <mdWrap MDTYPE="MODS"> ... </mdWrap> </dmdSec> By default, MODS metadata is always included in AIPs. It is controlled by the following configuration in your dspace.cfg: aip.disseminate.dmd = MODS, DIM The MODS metadata is included within your AIP to support interoperability. It provides a way for other systems to interact with or ingest the AIP without needing to understand the DIM Schema. You may choose to disable MODS if you wish, however this may decrease the likelihood that you'd be able to easily ingest your AIPs into a non-DSpace system (unless that non-DSpace system is able to understand the DIM schema). When restoring/ingesting AIPs, DSpace will always first attempt to restore DIM descriptive metadata. Only if no DIM metadata is found, will the MODS metadata be used during a restore. AIP Technical Metadata Schema (AIP-TECHMD)The AIP Technical Metadata Schema is a way to translate technical metadata about a DSpace object into the DIM Schema. It is kept separate from DIM as it is considered technical metadata rather than descriptive metadata. In the METS structure, AIP-TECHMD metadata always appears within a sourceMD inside an <mdWrap MDTYPE="OTHER" OTHERMDTYPE="AIP-TECHMD"> element. For example: <amdSec ID="amd_2191"> ... <sourceMD ID="sourceMD_2198"> <mdWrap MDTYPE="OTHER" OTHERMDTYPE="AIP-TECHMD"> ... </mdWrap> </sourceMD> ... </amdSec> By default, AIP-TECHMD metadata is always included in AIPs. It is controlled by the following configuration in your dspace.cfg: aip.disseminate.sourceMD = AIP-TECHMD AIP Technical Metadata for Item
AIP Technical Metadata for Bitstream
AIP Technical Metadata for Collection
AIP Technical Metadata for Community
AIP Technical Metadata for Site
PREMIS SchemaAt this point in time, the PREMIS Schema is only used to represent technical metadata about DSpace Bitstreams (i.e. Files). The PREMIS metadata is generated by DSpace's PREMISCrosswalk. Only the PREMIS Object Entity Schema is used. In the METS structure, PREMIS metadata always appears within a techMD inside an <mdWrap MDTYPE="PREMIS"> element. PREMIS metadata is always wrapped withn a <premis:premis> element. For example: <amdSec ID="amd_2209"> ... <techMD ID="techMD_2210"> <mdWrap MDTYPE="PREMIS"> <premis:premis> ... </premis:premis> </mdWrap> </techMD> ... </amdSec> Each Bitstream (file) has its own amdSec within a METS manifest. So, there will be a separate PREMIS techMD for each Bitstream within a single Item. By default, PREMIS metadata is always included in AIPs. It is controlled by the following configuration in your dspace.cfg: aip.disseminate.techMD = PREMIS, DSPACE-ROLES PREMIS Metadata for BitstreamThe following Bitstream information is translated into PREMIS for each DSpace Bitstream (file):
DSPACE-ROLES SchemaAll DSpace Groups and EPeople objects are translated into a custom DSPACE-ROLES XML Schema. This XML Schema is a very simple representation of the underlying DSpace database model for Groups and EPeople. The DSPACE-ROLES Schemas is generated by DSpace's RoleCrosswalk. Only the following DSpace Objects utilize the DSPACE-ROLES Schema in their AIPs:
In the METS structure, DSPACE-ROLES metadata always appears within a techMD inside an <mdWrap MDTYPE="OTHER" OTHERMDTYPE="DSPACE-ROLES"> element. For example: <amdSec ID="amd_2068"> ... <techMD ID="techMD_2070"> <mdWrap MDTYPE="OTHER" OTHERMDTYPE="DSPACE-ROLES"> ... </mdWrap> </techMD> ... </amdSec> By default, DSPACE-ROLES metadata is always included in AIPs. It is controlled by the following configuration in your dspace.cfg: aip.disseminate.techMD = PREMIS, DSPACE-ROLES Example of DSPACE-ROLES Schema for a SITE AIPBelow is a general example of the structure of a DSPACE-ROLES XML file, as it would appear in a SITE AIP. <DSpaceRoles> <Groups> <Group ID="1" Name="Administrator"> <Members> <Member ID="1" Name="bsmith@myu.edu" /> </Members> </Group> <Group ID="0" Name="Anonymous" /> <Group ID="70" Name="COLLECTION_hdl:123456789/57_ADMIN"> <Members> <Member ID="1" Name="bsmith@myu.edu" /> </Members> </Group> <Group ID="75" Name="COLLECTION_hdl:123456789/57_DEFAULT_READ"> <MemberGroups> <MemberGroup ID="0" Name="Anonymous" /> </MemberGroups> </Group> <Group ID="71" Name="COLLECTION_hdl:123456789/57_SUBMIT"> <Members> <Member ID="1" Name="bsmith@myu.edu" /> </Members> </Group> <Group ID="72" Name="COLLECTION_hdl:123456789/57_WORKFLOW_STEP_1"> <MemberGroups> <MemberGroup ID="1" Name="Administrator" /> </MemberGroups> </Group> <Group ID="73" Name="COLLECTION_hdl:123456789/57_WORKFLOW_STEP_2"> <MemberGroups> <MemberGroup ID="1" Name="Administrator" /> </MemberGroups> </Group> <Group ID="8" Name="COLLECTION_hdl:123456789/6703_DEFAULT_READ" /> <Group ID="9" Name="COLLECTION_hdl:123456789/2_ADMIN"> <Members> <Member ID="1" Name="bsmith@myu.edu" /> </Members> </Group> </Groups> <People> <Person ID="1"> <Email>bsmith@myu.edu</Email> <Netid>bsmith</Netid> <FirstName>Bob</FirstName> <LastName>Smith</LastName> <Language>en</Language> <CanLogin /> </Person> <Person ID="2"> <Email>jjones@myu.edu</Email> <FirstName>Jane</FirstName> <LastName>Jones</LastName> <Language>en</Language> <CanLogin /> <SelfRegistered /> </Person> </People> </DSpaceRoles>
Example of DSPACE-ROLES Schema for a Community or CollectionBelow is a general example of the structure of a DSPACE-ROLES XML file, as it would appear in a Community or Collection AIP. This specific example is for a Collection, which has associated Administrator, Submitter, and Workflow approver groups. In this very simple example, each group only has one Person as a member of it. Please notice that the Person's information (Name, NetID, etc) is NOT contained in this content (however they are available in the DSPACE-ROLES example for a SITE, as shown above) <DSpaceRoles> <Groups> <Group ID="9" Name="COLLECTION_hdl:123456789/2_ADMIN" Type="ADMIN"> <Members> <Member ID="1" Name="bsmith@myu.edu" /> </Members> </Group> <Group ID="13" Name="COLLECTION_hdl:123456789/2_SUBMIT" Type="SUBMIT"> <Members> <Member ID="2" Name="jjones@myu.edu" /> </Members> </Group> <Group ID="10" Name="COLLECTION_hdl:123456789/2_WORKFLOW_STEP_1" Type="WORKFLOW_STEP_1"> <Members> <Member ID="1" Name="bsmith@myu.edu" /> </Members> </Group> <Group ID="11" Name="COLLECTION_hdl:123456789/2_WORKFLOW_STEP_2" Type="WORKFLOW_STEP_2"> <Members> <Member ID="2" Name="jjones@myu.edu" /> </Members> </Group> <Group ID="12" Name="COLLECTION_hdl:123456789/2_WORKFLOW_STEP_3" Type="WORKFLOW_STEP_3"> <Members> <Member ID="1" Name="bsmith@myu.edu" /> </Members> </Group> </Groups> </DSpaceRoles> METSRights SchemaAll DSpace Policies (permissions on objects) are translated into the METSRights schema. This is different than the above DSPACE-ROLES schema, which only represents Groups and People objects. Instead, the METSRights schema is used to translate the permission statements (e.g. a group named "Library Admins" has Administrative permissions on a Community named "University Library"). But the METSRights schema doesn't represent who is a member of a particular group (that is defined in the DSPACE-ROLES schema, as described above).
All DSpace Object's AIPs (except for the SITE AIP) utilize the METSRights Schema in order to define what permissions people and groups have on that object. Although there are several sections to the METSRights Schema, DSpace AIPs only use the <RightsDeclarationMD> section, as this is what is used to describe rights on an object. In the METS structure, METSRights metadata always appears within a rightsMD inside an <mdWrap MDTYPE="OTHER" OTHERMDTYPE="METSRIGHTS"> element. For example: <amdSec ID="amd_2068"> ... <rightsMD ID="rightsMD_2074"> <mdWrap MDTYPE="OTHER" OTHERMDTYPE="METSRIGHTS"> ... </mdWrap> </rightsMD> ... </amdSec> By default, METSRights metadata is always included in AIPs. It is controlled by the following configuration in your dspace.cfg: aip.disseminate.rightsMD = DSpaceDepositLicense:DSPACE_DEPLICENSE, \ CreativeCommonsRDF:DSPACE_CCRDF, CreativeCommonsText:DSPACE_CCTEXT, METSRIGHTS Example of METSRights Schema for an ItemAn Item AIP will almost always contain several METSRights metadata sections within its METS Manifest. A separate METSRights metadata section is used to describe the permissions on:
Below is an example of a METSRights sections for a publicly visible Bitstream, Bundle or Item. Notice it specifies that the "GENERAL PUBLIC" has the permission to DISCOVER or DISPLAY this object. <rights:RightsDeclarationMD xmlns:rights="http://cosimo.stanford.edu/sdr/metsrights/" RIGHTSCATEGORY="LICENSED"> <rights:Context CONTEXTCLASS="GENERAL PUBLIC"> <rights:Permissions DISCOVER="true" DISPLAY="true" MODIFY="false" DELETE="false" /> </rights:Context> </rights:RightsDeclarationMD> Example of METSRights Schema for a CollectionA Collection AIP contains one METSRights section, which describes the permissions different Groups or People have within the Collection Below is an example of a METSRights sections for a publicly visible Collection, which also has an Administrator group, a Submitter group, and a group for each of the three DSpace workflow approval steps. You'll notice that each of the groups is provided with very specific permissions within the Collection. Submitters & Workflow approvers can "ADD CONTENTS" to a collection (but cannot delete the collection). Administrators have full rights. <rights:RightsDeclarationMD xmlns:rights="http://cosimo.stanford.edu/sdr/metsrights/" RIGHTSCATEGORY="LICENSED"> <rights:Context CONTEXTCLASS="MANAGED_GRP"> <rights:UserName USERTYPE="GROUP">COLLECTION_hdl:123456789/2_SUBMIT</rights:UserName> <rights:Permissions DISCOVER="true" DISPLAY="true" MODIFY="true" DELETE="false" OTHER="true" OTHERPERMITTYPE="ADD CONTENTS" /> </rights:Context> <rights:Context CONTEXTCLASS="MANAGED_GRP"> <rights:UserName USERTYPE="GROUP">COLLECTION_hdl:123456789/2_WORKFLOW_STEP_3</rights:UserName> <rights:Permissions DISCOVER="true" DISPLAY="true" MODIFY="true" DELETE="false" OTHER="true" OTHERPERMITTYPE="ADD CONTENTS" /> </rights:Context> <rights:Context CONTEXTCLASS="MANAGED_GRP"> <rights:UserName USERTYPE="GROUP">COLLECTION_hdl:123456789/2_WORKFLOW_STEP_2</rights:UserName> <rights:Permissions DISCOVER="true" DISPLAY="true" MODIFY="true" DELETE="false" OTHER="true" OTHERPERMITTYPE="ADD CONTENTS" /> </rights:Context> <rights:Context CONTEXTCLASS="MANAGED_GRP"> <rights:UserName USERTYPE="GROUP">COLLECTION_hdl:123456789/2_WORKFLOW_STEP_1</rights:UserName> <rights:Permissions DISCOVER="true" DISPLAY="true" MODIFY="true" DELETE="false" OTHER="true" OTHERPERMITTYPE="ADD CONTENTS" /> </rights:Context> <rights:Context CONTEXTCLASS="MANAGED_GRP"> <rights:UserName USERTYPE="GROUP">COLLECTION_hdl:123456789/2_ADMIN</rights:UserName> <rights:Permissions DISCOVER="true" DISPLAY="true" COPY="true" DUPLICATE="true" MODIFY="true" DELETE="true" PRINT="true" OTHER="true" OTHERPERMITTYPE="ADMIN" /> </rights:Context> <rights:Context CONTEXTCLASS="GENERAL PUBLIC"> <rights:Permissions DISCOVER="true" DISPLAY="true" MODIFY="false" DELETE="false" /> </rights:Context> </rights:RightsDeclarationMD> Example of METSRights Schema for a CommunityA Community AIP contains one METSRights section, which describes the permissions different Groups or People have within that Community. Below is an example of a METSRights sections for a publicly visible Community, which also has an Administrator group. As you'll notice, this content looks very similar to the Collection METSRights section (as described above) <rights:RightsDeclarationMD xmlns:rights="http://cosimo.stanford.edu/sdr/metsrights/" RIGHTSCATEGORY="LICENSED"> <rights:Context CONTEXTCLASS="MANAGED_GRP"> <rights:UserName USERTYPE="GROUP">COMMUNITY_hdl:123456789/10_ADMIN</rights:UserName> <rights:Permissions DISCOVER="true" DISPLAY="true" COPY="true" DUPLICATE="true" MODIFY="true" DELETE="true" PRINT="true" OTHER="true" OTHERPERMITTYPE="ADMIN" /> </rights:Context> <rights:Context CONTEXTCLASS="GENERAL PUBLIC"> <rights:Permissions DISCOVER="true" DISPLAY="true" MODIFY="false" DELETE="false" /> </rights:Context> </rights:RightsDeclarationMD> ![]() ![]() ![]() ![]() |
![]() |
Document generated by Confluence on Nov 06, 2010 19:27 |