The package level is the top level of the meemoo SIP and consists of at least a METS.xml file, a /metadata directory and a /representations directory. It contains information about the IE(s) of the SIP and the SIP as a whole.
The package level may contain a /documentation and a /schemas directory. The former may contain additional information aiding the interpretation of the SIP, while the latter may contain XML Schema Definition (XSD) files of the metadata schemas used in the SIP. These two directories are ignored during ingest and will therefore not be archived.
The root directory MUST contain exactly one METS.xml file. The word METS in the filename MUST be written in all caps as displayed here.
The root directory MUST have the value of the OBJID attribute in the METS.xml header as its directory name. In the example tree structure above, that means that the OBJID attribute MUST be uuid-e4eb34c0-4fc6-4395-b61c-0671f8e0b04c since that is the name of the root directory. See mets/@OBJID for more details.
The root directory MUST contain exactly one /metadata directory.
The root directory MUST contain exactly one /representations directory.
The root directory MAY contain exactly one /documentation directory.
The root directory MAY contain exactly one /schemas directory.
METS.xml (file)
Metadata Encoding and Transmission Standard (METS) is a metadata standard for encoding descriptive, administrative and structural metadata. In the case of the meemoo SIP, the METS.xml file’s main purpose is to act as an inventory of the files and directories contained within. Since it is situated at the package-level, it is also known as the package METS file.
It should not be confused with the METS.xml files situated in their respective representation folders. The package METS.xml file does not record the internal structure of the different representations in the /representations directory. It only references the different METS.xml files contained in each representation directory. Each of the METS.xml files at the representation level references its own internal structure.
Elements and internal references
A METS.xml file typically consists of a number of fixed elements, outlined below. Each of these elements is covered in a dedicated subsection in the remainder of this section.
<mets> element: the root tag; this element contains a number of attributes with information about the type of SIP and its identification.
<metsHdr> element: this tag mainly covers the agents (such as software or the CP) involved with the creation and submission process of the SIP.
<dmdSec> element: this tag contains descriptive metadata, either embedded within the tag or with a reference to an external metadata file.
<amdSec> element: this tag contains preservation metadata, either embedded within the tag or with a reference to an external metadata file.
<fileSec> element: this tag acts as an inventory of the files that comprise the digital object being described in the METS.xml file.
<structMap> element: this tag organizes the digital content represented in the <fileSec>, <dmdSec>, and <amdSec> elements into a coherent hierarchical structure. This is important for a correct comprehension and navigation of digital content with complex relationships between the digital objects, such as newspapers.
Some of these elements, or their child elements, are identified with an identifier, contained in the @ID attribute (see the requirements in the sections below). These identifiers must be unique within the SIP.
The <structMap> serves as the entrypoint for locating the metadata, data or manifest files during parsing of the SIP. Therefore, it contains pointers to the @ID identifiers defined in the <fileSec>, <dmdSec>, and <amdSec> sections. An overview of the different elements and references on the package level is given in the following figure.
Internal references between elements in the METS.xml.
In addition, the <fileGrp> and <file> elements can also reference contents of the <amdSec> and <dmdSec>, however this is optional. A summary of all possible references and their obligation is given in the table below.
This is the root element of the package METS file. It contains a number of XML schema namespaces together with a number of attributes to uniquely identify the package METS file and the type of data it lists. The various requirements are listed in the table below.
This attribute MUST be set to declare the category of the content held in the SIP. Be aware of the difference between the required en dash character used below (–) vs. the regularly used hypen character (-) that is shorter.
Textual works – Print Textual works – Digital Textual works – Electronic Serials Digital Musical Composition (score-based representations) Musical Scores - Print Musical Scores - Digital Photographs – Print Photographs – Digital Other Graphic Images – Print Other Graphic Images – Digital Microforms Audio – On Tangible Medium (digital or analog) Audio – Media-independent (digital) Motion Pictures – Digital and Physical Media Video – File-based and Physical Media Software Software and Video Games Email Datasets Geospatial Data Geographic Information System (GIS) - Vector Data GIS Raster and Georeferenced Images GIS Vector and Raster Combined Non-GIS Cartographic 2D and 3D Computer Aided Design Design (schematics, architectural drawings) - Print Scanned 3D Objects (output from photogrammetry scanning) Databases Websites Web Archives Collection Event Image Interactive resource Moving image Sound Still image Text Physical object Service Mixed Other
Cardinality
1..1
Obligation
MUST
Attribute
mets[@TYPE="OTHER"]/@csip:OTHERTYPE
Name
Other content category
Description
When the mets/@TYPE attribute is set to “OTHER”, the mets/@csip:OTHERTYPE attribute SHOULD be used to declare the content category of the package representation not contained in the fixed vocabulary of the @TYPE attribute.
This attribute must have the value “OTHER”. The value of the mets/@csip:OTHERCONTENTINFORMATIONTYPE attribute describes the value of the profile of the meemoo SIP.
This attribute is used to declare the Content Information Type Specification used when creating the SIP. Meemoo uses this attribute to indicate which of meemoo’s content profiles a SIP uses. Its value MUST be a valid URI which can be found on the different content profile pages, e.g. the URI https://data.hetarchief.be/id/sip/2.0/basic for the basic content profile which can be found on its content profile page. ote that the sample above has the value of the basic profile as an example.
This element contains administrative metadata about the SIP such as its creator and its creation software. It does so by using separate agent tags for every role in the SIPs creation and submission process.
Example
<metsHdrCREATEDATE="2022-02-16T10:01:15.014+02:00"csip:OAISPACKAGETYPE="SIP"><!-- information about the software --><agentROLE="CREATOR"TYPE="OTHER"OTHERTYPE="SOFTWARE"><name>meemoo SIP creator</name><notecsip:NOTETYPE="SOFTWARE VERSION">0.1.</note></agent><!-- information about the archival creator--><agentROLE="ARCHIVIST"TYPE="ORGANIZATION"><name>Flemish Cat Museum</name><notecsip:NOTETYPE="IDENTIFICATIONCODE">OR-m30wc4t</note></agent><!-- information about the submitting organisation --><agentROLE="CREATOR"TYPE="ORGANIZATION"><name>Flemish Cat Museum</name><notecsip:NOTETYPE="IDENTIFICATIONCODE">OR-m30wc4t</note></agent></metsHdr>
Requirements
Element
mets/metsHdr
Name
Package header
Description
General element that contains descriptive information about the SIP.
Cardinality
1..1
Obligation
MUST
Attribute
mets/metsHdr/@CREATEDATE
Name
Package creation datetime
Description
This attribute records the date and time the SIP was created.
In case the SIP was modified since its creation, this attribute records the date and time of that modification. This attribute MUST be present and filled in when the SIP has been modified since its creation datetime.
A way of indicating the status of the SIP and to instruct meemoo on how to properly handle it. If not set, the expected value is NEW. Meemoo investigates the use of the @RECORDSTATUS attribute for future use cases such as e.g. a metadata update (i.e. ingest of metadata only with the goal of updating, adding or deleting existing metadata in meemoo’s archive system).
mets/metsHdr/agent[@ROLE='CREATOR' and @OTHERTYPE='SOFTWARE']/note
Name
SIP creator software agent additional information
Description
The mandatory note element records the version of the software tool used to create the IP. It MUST have a @csip:NOTETYPE attribute with the value SOFTWARE VERSION.
A wrapper element that enables to encode the name of the person/people or CP that originally created the content being transferred. This can be different from the CP tasked with preparing and sending the SIP to meemoo (cf. ‘submitting agent’ below).
Cardinality
0..1
Obligation
MAY
Attribute
mets/metsHdr/agent[@ROLE='ARCHIVIST']/@ROLE
Name
Archival creator agent role
Description
The role of the person/people or CP responsible for the digital content. This value MUST be set to ARCHIVIST.
An optional reference to a previous submission agreement associated with the SIP. When used, the @TYPE attribute MUST be set to PREVIOUSSUBMISSIONAGREEMENT.
An optional reference to indicate where in the archival hierarchy the package shall be placed in meemoo’s archive. When used, the @TYPE attribute MUST be set to REFERENCECODE.
In cases where the SIP originates from other institutions maintaining a reference code structure, this element can be used to record these reference codes and therefore support the provenance of the package when a whole archival description is not submitted with the submission. When used, the @TYPE attribute MUST be set to PREVIOUSREFERENCECODE.
The dmdSec element (short for ‘descriptive metadata section’) contains descriptive metadata about the IE(s) in the SIP. Descriptive metadata in the meemoo SIP MUST be contained in dedicated metadata files located in the /metadata/descriptive directory of the package level. This means that the dmdSec MUST use <mdRef> elements to reference the external metadata files.
Example
<dmdSecID="uuid-c6a678a7-b4b0-45af-a7d4-33123d9f0911"><mdRefLOCTYPE="URL"MDTYPE="DC"xlink:type="simple"xlink:href="./metadata/descriptive/dc_1.xml"MIMETYPE="text/xml"SIZE="663"CREATED="2022-02-16T10:01:15.014+02:00"CHECKSUM="cd17cbb2153946c8462e10b337e0e9c1"CHECKSUMTYPE="MD5"/></dmdSec><!-- ref to descriptive metadata about IE1 --><dmdSecID="uuid-7a3443ed-9925-414b-819f-fc4830475e22"><mdRefLOCTYPE="URL"MDTYPE="DC"xlink:type="simple"xlink:href="./metadata/descriptive/dc_2.xml"MIMETYPE="text/xml"SIZE="738"CREATED="2022-02-16T10:01:15.014+02:00"CHECKSUM="fbab574560f2d548fd84c6c1fd1cb7f2"CHECKSUMTYPE="MD5"/></dmdSec><!-- ref to descriptive metadata about IE2 --><dmdSecID="uuid-dff9e2ad-ab58-490a-9d80-df6c812404d2"><mdRefLOCTYPE="URL"MDTYPE="DC"xlink:type="simple"xlink:href="./metadata/descriptive/dc_3.xml"MIMETYPE="text/xml"SIZE="748"CREATED="2022-02-16T10:01:15.014+02:00"CHECKSUM="9d55815152e83db76a32f74990d79cd3"CHECKSUMTYPE="MD5"/></dmdSec>
Requirements
Element
mets/dmdSec
Name
Descriptive metadata section
Description
Wrapper element that contains a reference to a separate descriptive metadata file in the directory /metadata/descriptive. It MUST be used if descriptive metadata for the package content is available. Each dmdsec contains a single reference to a descriptive metadata file and MUST be repeated for multiple metadata files, when available.
Cardinality
0..*
Obligation
SHOULD
Attribute
mets/dmdSec/@ID
Name
Descriptive metadata section identifier
Description
A unique identifier for the dmdSec used for internal package references. It MUST be unique within the SIP.
Describes the status of the dmdSec which is supported by the profile. Meemoo investigates the use of the @STATUS attribute for future use cases such as e.g. a descriptive metadata update (i.e. ingest of metadata only with the goal of updating, adding or deleting existing metadata in meemoo’s archive system).
Reference to the document with the descriptive metadata
Description
Reference to the descriptive metadata file(s) located in the /metadata/descriptive directory.
Cardinality
1..1
Obligation
MUST
Attribute
mets/dmdSec/mdRef[@LOCTYPE='URL']
Name
Type of locator
Description
Indication of the locator type used to refer to the descriptive metadata file in the /metadata/descriptive directory. It MUST always be used with the value URL.
The amdSec element (short for ‘administrative metadata section’) contains preservation metadata about the IE(s) of the SIP and about the SIP as a whole. Preservation data in the meemoo SIP MUST be contained in dedicated metadata files located in the metadata/preservation directory of the package-level. This means that the amdSec MUST use <mdRef> elements, contained in <digiprovMD> elements, to reference the external metadata files.
Example
<!-- ref to the PREMIS metadata about IE(s)/package --><amdSec><digiprovMDID="uuid-4ac13924-fe19-4711-b51f-6b5acc692ec0"><mdRefLOCTYPE="URL"MDTYPE="PREMIS"xlink:type="simple"xlink:href="./metadata/preservation/premis.xml"MIMETYPE="text/xml"SIZE="6295"CREATED="2022-02-16T10:01:15.014+02:00"CHECKSUM="01de8b0a874407472a183aeece47505d"CHECKSUMTYPE="MD5"/></digiprovMD></amdSec>
Requirements
Element
mets/amdSec
Name
Administrative metadata section
Description
Wrapper element that contains a reference to a separate preservation metadata file in the directory /metadata/preservation. It MUST be used if preservation metadata for the package content is available. All preservation metadata MUST be present in a single metadata file, resulting in a single amdSec element.
Cardinality
0..1
Obligation
SHOULD
Element
mets/amdSec/digiprovMD
Name
Digital provenance metadata
Description
Wrapper element for including preservation information using the PREMIS standard.
Cardinality
1..1
Obligation
MUST
Attribute
mets/amdSec/digiprovMD/@ID
Name
Digital provenance metadata identifier
Description
A unique identifier used for internal package references. It MUST be unique within the SIP.
Describes the status of the digiprovMD which is supported by the profile. Meemoo investigates the use of the @STATUS attribute for future use cases such as e.g. a preservation metadata update (i.e. ingest of metadata only with the goal of updating, adding or deleting existing metadata in meemoo’s archive system).
Reference to the file with the preservation metadata.
Description
Reference to the preservation metadata file located in the /metadata/preservation directory.
Cardinality
1..1
Obligation
MUST
Attribute
mets/amdSec/digiprovMD/mdRef[@LOCTYPE='URL']
Name
Type of locator
Description
Indication of the locator type used to refer to the preservation metadata file in the /metadata/preservation directory. It MUST always be used with the value URL.
Indication of the actual location of the preservation metadata file. As indicated by the @LOCTYPE attribute, this filepath MUST be a URL type filepath.
Specification of the type of metadata that is used in the externally located preservation metadata file in the /metadata/preservation directory. The value MUST be set to PREMIS.
The fileSec element (short for ‘file section’) lists all files of the package level in the SIP. It contains references to the representation METS.xml files of the different representations, but does not list other files of those representations. The listing of other representation files (i.e. metadata files and media files) is left to the respective representation METS.xml files.
There MUST NOT be more than one fileSec element in the METS.xml file.
The fileSec element of the package METS.xml file MUST NOT reference anything from the different representation levels, EXCEPT the representation METS.xml files.
Each representation METS.xml MUST be referenced within its own fileGrp element within the fileSec element of the package METS.xml.
Element
mets/fileSec
Name
mets/fileSec
Description
Wrapper element for the file section of the METS which contains different fileGrp elements which acts as an inventory of the package level and its content. Only a single fileSec element should be present.
Cardinality
0..1
Obligation
SHOULD
Attribute
mets/fileSec/@ID
Name
File section identifier
Description
A unique identifier for the file section used for internal package references. It MUST be unique within the SIP.
All documentation pertaining to the transferred content is placed in one or more file group elements with mets/fileSec/fileGrp/@USE attribute value “Documentation”.
Cardinality
0..1
Obligation
MAY
Attribute
mets/fileSec/fileGrp[@USE='Schemas']
Name
Schema file group
Description
XML schemas used in the information package can be included in one or more file groups with mets/fileSec/fileGrp/@USE attribute value “Schemas”.
A pointer to the METS document describing the representation or pointers to the content being transferred must be present in one or more file groups with mets/fileSec/fileGrp/@USE attribute value starting with Representations followed by the path to the folder where the representation levelMETS.xml file is placed.
Cardinality
1..*
Obligation
MUST
Attribute
mets/fileSec/fileGrp/@ADMID
Name
Reference to administrative metadata
Description
Reference to the ID of the corresponding administrative metadata section, in case an amdSec was used.
When the mets/fileSec/fileGrp/@csip:CONTENTINFORMATIONTYPE attribute has the value OTHER the attribute mets/fileSec/fileGrp/@csip:OTHERCONTENTINFORMATIONTYPE must state a value for the Content Information Type Specification used.
Cardinality
0..1
Obligation
MAY
Attribute
mets/fileSec/fileGrp/@USE
Name
Description of the use of the file group
Description
The value in the mets/fileSec/fileGrp/@USE attribute is the name of the whole folder structure to the data, e.g. representations/representation_1 or documentation.
The structMap element outlines the hierarchical structure of the package level of the SIP. It provides links between elements and metadata files located elsewhere in the package level.
The administrative metadata division should reference all current administrative metadata sections. All amdSec elements with @STATUS='CURRENT' SHOULD be referenced by their identifier, @ID. The current amdSec elements’ @IDs are recorded in the div[@LABEL='Metadata']/@ADMID attribute in a space delimited list.
The descriptive metadata division should reference all current descriptive metadata sections. All dmdSec elements with @STATUS='CURRENT' SHOULD be referenced by their identifier, @ID. The current dmdSec elements’ @IDs are recorded in the div[@LABEL='Metadata']/@DMDID attribute in a space delimited list.
All file groups containing documentation described in the package are referenced via the relevant file group identifiers. There MUST be one file group reference per fptr element.
All file groups containing schemas described in the package are referenced via the relevant file group identifiers. There MUST be one file group reference per fptr element.
A package consists of multiple representations, each described by a representation level METS.xml file, there should be a discrete representation \div element for each representation. Each representation div references the representation level METS.xml file, documenting the structure of the representation and its content.
The package’s representation division div element @LABEL attribute value must be the path to the representation level METS.xml file starting with the value Representations followed by the main folder name, e.g. Representations/representation_1.
The division div of the specific representation includes one occurrence of the METS pointer mptr element, pointing to the appropriate representation METS.xml file.
Indication of the actual location of the METS.xml file. As indicated by the @LOCTYPE attribute, this filepath MUST be a URL type filepath. One SHOULD use the relative location of the file in this URL.
Indication of the locator type used to refer to the representation METS.xml files of the different representation levels. It MUST always be used with the value URL.
The /metadata directory contains both descriptive and preservation metadata about the IE(s) at the package level. It also contains preservation metadata about the SIP as a whole.
Requirements
The /metadata directory MUST contain exactly two subdirectories: /descriptive and /preservation.
/descriptive (directory)
The /descriptive directory contains descriptive metadata about the IE(s) at the package level. This descriptive metadata is stored in different XML files, depending on the number of IE(s) present in the SIP. Examples are mods.xml and dc+schema.xml. These files apply a certain metadata schema, such as DCTERMS or MODS. The concrete requirements of descriptive metadata files and the applied metadata schemas are defined by the content profiles.
/preservation (directory)
The /preservation directory contains preservation metadata about the IE(s) at the package level.
Requirements
The /preservation directory MUST contain exactly one file: premis.xml.
The premis.xml file at the package-level contains preservation metadata about the IE(s) of the SIP, and about the SIP as a whole. It also contains any additional IDs related to the IE(s) of the SIP. It relies on the Preservation Metadata: Implementation Strategies (PREMIS) standard in order to provide basic preservation information. More detailed preservation information can be described using PREMIS events and PREMIS agents.
If descriptive metadata is available for a given IE, a link is established via a shared ID between the relevant PREMIS object in the premis.xml file and the corresponding descriptive/dc*.xml file. This ID is stored in the <premis:objectIdentifier> element of the relevant PREMIS object and in the <dcterms:identifier> element of the corresponding dc*.xml file in the /descriptive directory.
Describing Intellectual Entities
On the package level, the preservation metadata is used to express
what the different IEs are contained in the SIP; and
how they relate to eachother and to possible representations.
Example
<?xml version="1.0" encoding="UTF-8"?><premis:premisversion="3.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:premis="http://www.loc.gov/premis/v3"xsi:schemaLocation="http://www.loc.gov/premis/v3 https://www.loc.gov/standards/premis/premis.xsd"><!-- IE about the Felis Catus Flamens --><premis:objectxsi:type="premis:intellectualEntity"><premis:objectIdentifier><premis:objectIdentifierType>UUID</premis:objectIdentifierType><premis:objectIdentifierValue>uuid-b21a86aa-97a3-4f7b-a9f5-4d330af641c0</premis:objectIdentifierValue></premis:objectIdentifier><!-- relationship between the main IE and the nested IEs --><premis:relationship><premis:relationshipTypeauthority="relationshipType"authorityURI="http://id.loc.gov/vocabulary/preservation/relationshipType"valueURI="http://id.loc.gov/vocabulary/preservation/relationshipType/str">structural</premis:relationshipType><premis:relationshipSubTypeauthority="relationshipSubType"authorityURI="http://id.loc.gov/vocabulary/preservation/relationshipSubType"valueURI="http://id.loc.gov/vocabulary/preservation/relationshipSubType/hsp">has part</premis:relationshipSubType><premis:relatedObjectIdentifier><premis:relatedObjectIdentifierType>UUID</premis:relatedObjectIdentifierType><premis:relatedObjectIdentifierValue>uuid-948e2213-ca54-459c-8c87-5818adeb9444</premis:relatedObjectIdentifierValue></premis:relatedObjectIdentifier><premis:relatedObjectIdentifier><premis:relatedObjectIdentifierType>UUID</premis:relatedObjectIdentifierType><premis:relatedObjectIdentifierValue>uuid-01d59d41-f523-4d06-a549-4bf6f7cef853</premis:relatedObjectIdentifierValue></premis:relatedObjectIdentifier></premis:relationship></premis:object><!-- nested IE1 about the Felis Catus Flamens lying on the sofa --><premis:objectxsi:type="premis:intellectualEntity"><premis:objectIdentifier><premis:objectIdentifierType>UUID</premis:objectIdentifierType><premis:objectIdentifierValue>uuid-948e2213-ca54-459c-8c87-5818adeb9444</premis:objectIdentifierValue></premis:objectIdentifier><!-- relationship between nested IE1 and the main IE --><premis:relationship><premis:relationshipTypeauthority="relationshipType"authorityURI="http://id.loc.gov/vocabulary/preservation/relationshipType"valueURI="http://id.loc.gov/vocabulary/preservation/relationshipType/str">structural</premis:relationshipType><premis:relationshipSubTypeauthority="relationshipSubType"authorityURI="http://id.loc.gov/vocabulary/preservation/relationshipSubType"valueURI="http://id.loc.gov/vocabulary/preservation/relationshipSubType/isp">is part of</premis:relationshipSubType><premis:relatedObjectIdentifier><premis:relatedObjectIdentifierType>UUID</premis:relatedObjectIdentifierType><premis:relatedObjectIdentifierValue>uuid-b21a86aa-97a3-4f7b-a9f5-4d330af641c0</premis:relatedObjectIdentifierValue></premis:relatedObjectIdentifier></premis:relationship><!-- relationship between nested IE1 and its representation --><premis:relationship><premis:relationshipTypeauthority="relationshipType"authorityURI="http://id.loc.gov/vocabulary/preservation/relationshipType"valueURI="http://id.loc.gov/vocabulary/preservation/relationshipType/str">structural</premis:relationshipType><premis:relationshipSubTypeauthority="relationshipSubType"authorityURI="http://id.loc.gov/vocabulary/preservation/relationshipSubType"valueURI="http://id.loc.gov/vocabulary/preservation/relationshipSubType/isr">is represented by</premis:relationshipSubType><premis:relatedObjectIdentifier><premis:relatedObjectIdentifierType>UUID</premis:relatedObjectIdentifierType><premis:relatedObjectIdentifierValue>uuid-541292c3-223a-4b80-b747-66bc86ff4a89</premis:relatedObjectIdentifierValue></premis:relatedObjectIdentifier></premis:relationship></premis:object><!-- nested IE2 about the Felis Catus Flamens sitting on its cat tree --><premis:objectxsi:type="premis:intellectualEntity"><premis:objectIdentifier><premis:objectIdentifierType>UUID</premis:objectIdentifierType><premis:objectIdentifierValue>uuid-01d59d41-f523-4d06-a549-4bf6f7cef853</premis:objectIdentifierValue></premis:objectIdentifier><!-- relationship between nested IE2 and the main IE --><premis:relationship><premis:relationshipTypeauthority="relationshipType"authorityURI="http://id.loc.gov/vocabulary/preservation/relationshipType"valueURI="http://id.loc.gov/vocabulary/preservation/relationshipType/str">structural</premis:relationshipType><premis:relationshipSubTypeauthority="relationshipSubType"authorityURI="http://id.loc.gov/vocabulary/preservation/relationshipSubType"valueURI="http://id.loc.gov/vocabulary/preservation/relationshipSubType/isp">is part of</premis:relationshipSubType><premis:relatedObjectIdentifier><premis:relatedObjectIdentifierType>UUID</premis:relatedObjectIdentifierType><premis:relatedObjectIdentifierValue>uuid-b21a86aa-97a3-4f7b-a9f5-4d330af641c0</premis:relatedObjectIdentifierValue></premis:relatedObjectIdentifier></premis:relationship><!-- relationship between nested IE2 and its representation --><premis:relationship><premis:relationshipTypeauthority="relationshipType"authorityURI="http://id.loc.gov/vocabulary/preservation/relationshipType"valueURI="http://id.loc.gov/vocabulary/preservation/relationshipType/str">structural</premis:relationshipType><premis:relationshipSubTypeauthority="relationshipSubType"authorityURI="http://id.loc.gov/vocabulary/preservation/relationshipSubType"valueURI="http://id.loc.gov/vocabulary/preservation/relationshipSubType/isr">is represented by</premis:relationshipSubType><premis:relatedObjectIdentifier><premis:relatedObjectIdentifierType>UUID</premis:relatedObjectIdentifierType><premis:relatedObjectIdentifierValue>uuid-de83045d-3b0f-4161-9f96-40079af0d480</premis:relatedObjectIdentifierValue></premis:relatedObjectIdentifier></premis:relationship></premis:object></premis:premis>
Overview of relevant PREMIS relationships
The table below gives an overview of the different relationship types that can be used on the package level:
This attribute signals which PREMIS version is being used. The attribute’s value MUST be set to 3.0.
Cardinality
1..1
Obligation
MUST
Attribute
premis:premis/@xsi:schemaLocation
Name
Schema location declaration
Description
This attribute signals where to find the relevant XSD schema in order to validate the PREMIS file.
When used, its value MUST be set to http://www.loc.gov/premis/v3 https://www.loc.gov/standards/premis/premis.xsd to signal conformance with PREMIS 3.0.
Cardinality
0..1
Obligation
SHOULD
Element
premis:premis/premis:object
Name
PREMIS object element
Description
A premis:object element MUST be defined for each IE in the SIP.
Cardinality
1..*
Obligation
MUST
Attribute
premis:premis/premis:object/@xsi:type
Name
Object type
Description
This attribute signals whether a PREMIS object is of type intellectual entity, representation or file.
Since the package level can only contain IEs, this attribute’s value MUST always be set to premis:intellectualEntity.
This element contains object identifier information.
There MUST be exactly one object identifier present with premis:objectIdentifierType set to UUID (see below). This is the main identifier for the object, which uniquely identifies the concerned IE and establishes a link between the relevant preservation metadata in the premis.xml file and the descriptive metadata in the dc+schema.xml or mods.xml file, if any is present.
There MAY be zero or more additional object identifiers of a different type. It is RECOMMENDED to include an identifier with premis:objectIdentifierType set to MEEMOO-LOCAL-ID to pinpoint the main local identifier well known to the SIP submitter (e.g., the record identifier in the local collection registration system), which can be used to easily retrieve the intellectual entity from the meemoo archive.
The type of the PREMIS object identifier being used.
At least one identifier of type UUID MUST be defined in order to provide a unique identifier for each PREMIS object.
This unique identifier is also used to link the concerned PREMIS object with the descriptive metadata in the /metadata/descriptive/dc+schema.xml or /metadata/descriptive/mods.xml file, if any is present.
The actual value that makes up the identifier of the PREMIS object.
Datatype
String (depending on the value of the premis:objectIdentifierType)
Cardinality
1..1
Obligation
MUST
Element
premis:premis/premis:object/premis:relationship
Name
PREMIS relationship
Description
Information about a relationship between the current object and one or more other objects.
In the case of the premis.xml file of the package level, this element MUST detail the relationships between the IE defined at the package level and all of its representations defined in the various directories of the representation level.
A high-level categorization of the nature of the relationship.
This element’s value MUST be set to structural when expressing the relationship between one IE and another or between the IE object and one of its representations.
This attribute indicates the name of the authority/controlled vocabulary that is being used for the different relationship types. Its value MUST be set to relationshipType.
This attribute references the URI that contains the authority/controlled vocabulary. Its value MUST be set to http://id.loc.gov/vocabulary/preservation/relationshipType.
This attribute references the URI that contains the specific entry from the authority/controlled vocabulary.
If the structural relationship type is being used, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/relationshipType/str.
A detailed categorization of the nature of the relationship.
In the case of the premis.xml file of the package level, this element’s value MUST be set to is represented by when expressing the relationship between the IE object and one of its representations.
When multiple IEs are used in the SIP, this element’s value MUST be set to generalizes when the relationship is expressed from the side of the main IE (i.e. the main IE is the subject of the relationship); when the relationship is expressed from the side of one of the subIEs (i.e. one of the subIEs is the subject of the relationship), this element’s value MUST be set to specializes.
This attribute indicates the name of the authority/controlled vocabulary that is being used for the different relationship subtypes. Its value MUST be set to relationshipSubType.
This attribute references the URI that contains the authority/controlled vocabulary. Its value MUST be set to http://id.loc.gov/vocabulary/preservation/relationshipSubType.
This attribute references the URI that contains the specific entry from the authority/controlled vocabulary.
If the is represented by relationship subtype is being used, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/relationshipSubType/isr. If the has part relationship subtype is being used, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/relationshipSubType/hsp. If the is part of relationship subtype is being used, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/relationshipSubType/isp
The actual value that makes up the identifier of the PREMIS related object.
Datatype
String (depending on the value of the premis:relatedObjectIdentifierType)
Cardinality
1..1
Obligation
MUST
Adding provenance of representations
If desired, a representation’s provenance trail can be added to the preservation metadata using PREMIS events and agents. In most cases, events are used to submit information about the digitization process that created the representations. The use of events might be prohibited or enforced depending on the given content profile.
The possible event types are limited and managed by a controlled list. This list is still under development and will be published in a future release of the specification.
<?xml version="1.0" encoding="UTF-8"?><premis:premisversion="3.0"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:premis="http://www.loc.gov/premis/v3"xsi:schemaLocation="http://www.loc.gov/premis/v3 https://www.loc.gov/standards/premis/premis.xsd"><!-- description of objects (left out for clarity) -->
...
<!-- description of the digitization event that created the supplied representation --><premis:event><premis:eventIdentifier><premis:eventIdentifierType>UUID</premis:eventIdentifierType><premis:eventIdentifierValue>uuid-f0513e06-4c57-4faf-a758-042043d99b81</premis:eventIdentifierValue></premis:eventIdentifier><premis:eventType>DIGITIZATION</premis:eventType><premis:eventDateTime>2022-05-17T11:50:13</premis:eventDateTime><premis:eventDetailInformation><premis:eventDetail/></premis:eventDetailInformation><premis:eventOutcomeInformation><premis:eventOutcomevalueURI="http://id.loc.gov/vocabulary/preservation/eventOutcome/suc">succes</premis:eventOutcome></premis:eventOutcomeInformation><premis:linkingAgentIdentifier><premis:linkingAgentIdentifierType>OR-id</premis:linkingAgentIdentifierType><premis:linkingAgentIdentifierValue>OR-m30wc4t</premis:linkingAgentIdentifierValue><premis:linkingAgentRolevalueURI="http://id.loc.gov/vocabulary/preservation/eventRelatedAgentRole/imp">implementer</premis:linkingAgentRole></premis:linkingAgentIdentifier><premis:linkingAgentIdentifier><premis:linkingAgentIdentifierType>UUID</premis:linkingAgentIdentifierType><premis:linkingAgentIdentifierValue>uuid-1cc1fe7a-da78-4c53-847a-0fd141ce2d3b</premis:linkingAgentIdentifierValue><premis:linkingAgentRole>player</premis:linkingAgentRole></premis:linkingAgentIdentifier><premis:linkingObjectIdentifier><premis:linkingObjectIdentifierType>UUID</premis:linkingObjectIdentifierType><premis:linkingObjectIdentifierValue>uuid-de83045d-3b0f-4161-9f96-40079af0d480</premis:linkingObjectIdentifierValue><premis:linkingObjectRolevalueURI="http://id.loc.gov/vocabulary/preservation/eventRelatedObjectRole/out">outcome</premis:linkingObjectRole></premis:linkingObjectIdentifier></premis:event><!-- description of the video player used to digitize an analog carrier --><premis:agent><premis:agentIdentifier><premis:agentIdentifierType>UUID</premis:agentIdentifierType><premis:agentIdentifierValue>uuid-1cc1fe7a-da78-4c53-847a-0fd141ce2d3b</premis:agentIdentifierValue></premis:agentIdentifier><premis:agentName>SONY PDW-U2</premis:agentName><premis:agentType>hardware</premis:agentType><premis:agentExtensionxmlns:schema="http://schema.org/"><schema:model>PDW-U2</schema:model><schema:brand><schema:name>SONY</schema:name></schema:brand><schema:serialNumber>123456</schema:serialNumber></premis:agentExtension></premis:agent>
...
</premis:premis>
Element
premis:premis/premis:event
Name
PREMIS event element
Description
A premis:event element MAY be defined for one or more representations in the SIP.
Cardinality
0..*
Obligation
MAY
Element
premis:premis/premis:event/premis:eventIdentifier
Name
Event identifier
Description
This element contains event identifier information.
At least one event identifier MUST be present to uniquely identify the event.
Additional information as unstructured text. Multiple details should be recorded in independent premis:eventDetailInformation containers instead of repeating the premis:eventDetail element.
This attribute references the URI that contains the specific entry from the authority/controlled vocabulary.
If the event outcome is fail, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/eventOutcome/fai. If the event outcome is success, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/eventOutcome/suc. If the event outcome is warning, this attribut’s value MUST be set to http://id.loc.gov/vocabulary/preservation/eventOutcome/war.
This attribute references the URI that contains the specific entry from the authority/controlled vocabulary.
If the authorizer role is being used, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/eventRelatedAgentRole/aut. If the executing program role is being used, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/eventRelatedAgentRole/exe. If the implementer role is being used, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/eventRelatedAgentRole/imp. If the validator role is being used, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/eventRelatedAgentRole/val
This attribute references the URI that contains the specific entry from the authority/controlled vocabulary.
If the outcome role is being used, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/eventRelatedObjectRole/out. If the source role is being used, this attribute’s value MUST be set to http://id.loc.gov/vocabulary/preservation/eventRelatedObjectRole/sou.
A person, organization or piece of software or hardware associated to preservation events in the life of a data object. A premis:agent element MAY be defined for one or more events.
Cardinality
0..*
Obligation
MAY
Element
premis:premis/premis:agent/premis:agentIdentifier
Name
Agent identifier
Description
This element contains agent identifier information.
At least one agent identifier MUST be present to uniquely identify the agent.
Any extra metadata to further describe the agent. Its constraints are defined in the applied content profile.
Cardinality
0..1
Obligation
MAY
/representations (directory)
The /representations directory contains a separate /representation_* (where * is a positive integer increasing by 1 for each additional representation) directory for each representation of (the) IE(s) of the package level.
Requirements
The /representations directory MUST at least contain one /representation_* directory.
The different subdirectories in the /representations directory MUST be named /representation_*, with * being a positive integer that is incremented by 1 for each additional representation in the /representations directory.
