Document Resource Type
The “Document” resource type should be used for objects primarily containing formatted, page-oriented, textual files (such as Word documents, PDFs, slide decks, etc.) which combine character strings, font (size, type), alignment, headers/footers, or other visual formatting elements. (For unformatted text objects, see the plaintext resource type.)
A document object must contain one or more primary content files. Document objects may also include one or more DocumentMD metadata files.
The Document resource type is analogous to the DRS2 document content model (CMID-4.1).
For guidance about file formatting, please see DPS’s document preservation format recommendations.
Object Metadata
In addition to the global metadata requirements for all objects, the following metadata elements (or specific values, as shown) are required for document objects:
Resource Type (ObjResType) = “Document”
File Metadata
Primary content files
In addition to the global metadata requirements, the following metadata elements (or specific values, as shown) are required for primary content files:
File Purpose (FilePurpose) = Data
The following metadata elements are recommended for primary content files files:
Page Count (DocPageCt)
Word Count (DocWordCt)
Language (DocLanguage)
For optional and system-supplied metadata elements, please review the DRS3 Data Dictionary.
DocumentMD files
In addition to the global metadata requirements, the following metadata elements (or specific values, as shown) are required for DocumentMD files:
File Purpose (FilePurpose) = “Metadata”
Metadata Role (FileMetaRole) = Technical
The following metadata elements (or specific values, as shown) are recommended for DocumentMD files:
Byte Size (TxtByteSize) = 8
Character Size (TxtCharSize) = variable
Character Set (TxtCharset) = UTF-8
Markup Basis (TxtMrkupBasis) = XML
Markup Language (TxtMrkupLang) = DocumentMD: http://www.fcla.edu/dls/md/docmd.xsd
Relationships
The following relationship metadata elements are recommended when applicable:
Has Metadata (RelHasMeta) = DocumentMD[|||]urn
Delivery Requirements
IMPORTANT Document objects are delivered via the File Delivery Service (direct download of the file); they are not rendered in a browser.
In addition to the requirements and recommendations above, the following file-level metadata elements are required for delivery:
Access Flag (FileAccFlag) = “P” or “R”
Authority Path (ProcAuthPath) must be a valid NRS authority path
Name Pattern (ProcNamePattern)
The following file-level metadata elements are recommended for delivery:
[File] Owner Supplied Name (D3OSN)
File Role (FileRole) = “DELIVERABLE”
TAKE NOTE When supplying multiple values for a repeatable field such as this, values should be supplied concatenated with “[|]”, such as: “PAGE_IMAGE[|]DELIVERABLE”
Metadata Quick Reference
IECode | Object | Primary content file | DocumentMD file |
|---|---|---|---|
D3SubName | Recommended | Recommended | Recommended |
D3OSN | REQUIRED | Recommended | Recommended |
D3Label | Recommended | Optional | not expected |
ObjRole | Recommended | not expected | not expected |
ObjResType | REQUIRED | not expected | not expected |
ObjPurpose | REQUIRED | not expected | not expected |
ObjInfoType | Recommended | not expected | not expected |
FilePurpose | not expected | REQUIRED | REQUIRED |
FileRole | not expected | Recommended | Recommended |
FileAccFlag | not expected | REQUIRED for delivery | REQUIRED for delivery |
FileMetaRole | not expected | not expected | Recommended |
MODSTitle | Recommended | Optional | not expected |
MODSName | Recommended | Optional | not expected |
MODSPublisher | Recommended | Optional | not expected |
MODSPlace | Recommended | Optional | not expected |
MODSEdition | Recommended | Optional | not expected |
MODSAbstract | Recommended | Optional | not expected |
MODSDateCreated | Recommended | Optional | not expected |
MODSDateIssued | Recommended | Optional | not expected |
MODSDateCaptured | Recommended | Optional | not expected |
MODSCopyrightDate | Recommended | Optional | not expected |
RelHasMeta | Recommended | Recommended | not expected |
DocPageCt | not expected | Recommended | not expected |
DocWordCt | not expected | Recommended | not expected |
DocLanguage | not expected | Recommended | not expected |
TxtByteSize | not expected | not expected | Recommended |
TxtCharSize | not expected | not expected | Recommended |
TxtCharset | not expected | not expected | Recommended |
TxtMrkupBasis | not expected | not expected | Recommended |
TxtMrkupLang | not expected | not expected | Recommended |
ProcAuthPath | not expected | REQUIRED for delivery | not expected |
ProcNamePattern | not expected | REQUIRED for delivery | not expected |
ProcArchMode | REQUIRED | not expected | not expected |
A submission control file customized to document objects is provided here:.