Appendix B – DNX Data Dictionary
The source field indicates how the field is populated. The possible values are:
- User – The field can be updated either by the staff users via the Web editor, or by the submission application, before the SIP is submitted.
- System – The field is updated automatically by one of Rosetta modules. This table will include as much as possible the exact stage and task that updates the field.
In sections that are mandatory for Rosetta, not all fields are mandatory. The fields that are mandatory are marked as 'Rosetta Mandatory' in the table below.
| Name | Description | Source | PREMIS path |
|---|---|---|---|
| generalIECharacteristics | IE attributes | Non-PREMIS | |
| submissionReason | The reason for submitting the IE (for example, donation of this collection to the National Library). | User – Pre ingest or through the UI (MD form, web editor) | |
| status | The status of the IE - Active or Suppressed (Only active IEs are published). A suppressed IE is not available for searches from outside of Rosetta (when the search is performed via the SRU protocol). It can be used as an alternative for deleting the IE altogether from Rosetta. | User– Pre-ingest of through the UI (web editor) | |
| generalIECharacteristics.Version | The version of the IE. | System – when the IE is committed to permanent | |
| statusDate | The date of the status change. | System – Upon committing the new version of the IE. | |
|
IEEntityType
|
Logical categories such as digitized books, e-journals, videos, and so forth. | User – Pre-ingest or through the web editor | |
| These fields are available for users for storing metadata that has no designated DNX field. | User – Pre-ingest or through the web editor | ||
| UserDefinedB | |||
| UserDefinedC | |||
| generalRepCharacteristics | Representation attributes | User | Non-PREMIS |
| label | Label of the representation for display in Delivery. | Users can populate this section pre-ingest or through the Web editor | |
| preservationType | Possible values are:
Preservation Master – The master representation for preservation – for example, TIFF files of the scanned book. Modified Master – The representation to be created out from the master representation – for example, text files for each page of the scanned book. Derivative Copy – Access copies that are not preserved; used for better and faster access to Delivery. IEs must contain one preservation master and may contain up to one modified master. Other types are unlimited.
* Rosetta Mandatory |
||
| usageType | Currently, Rosetta supports only the VIEW value as a type of usage. A representation that is defined otherwise will not be available for Delivery.
* Rosetta Mandatory |
||
| representationEntityType | This field is used to distinguish between different structures of representations. | ||
| contentType | This field is used to distinguish between different types of content. | ||
| contextType | This field is used to distinguish between different types of context. | ||
| hardwareUsed | The hardware that was used to create the content of this Representation. | ||
| physicalCarrierMedia | The physical media that the content was originally on. | ||
| derivedFromId | Used in migration and ‘adding Representation’ tasks to identify the source representation that was used to derive this representation. | ||
| deliveryPriority | The priority of listing the representations in Delivery. | ||
| orderingSequence | The ordering sequence of representations of the same priority. | ||
| DigitalOriginal | Used to mark a Preservation Master as being the digital original of the IE. | ||
| RevisionNumber | Used to sequence the set of Master Representations. The highest revision number is by definition the latest master. | ||
| RepresentationCode | A code that categorizes a representation in terms of how it can be used in Delivery and external systems. | ||
| TaskID | An identifier of a certain type of derivative copy, used to manage the derivative copy when a task operates on an IE. | ||
| RepresentationOriginalName | The name of the object as submitted to or harvested by the repository, before any renaming by the repository. | OBJECT:OriginalName | |
| UserDefinedA | These fields available for the users for storing metadata that has no designated DNX field. | ||
| UserDefinedB | |||
| UserDefinedC | |||
| generalFileCharacteristics | File attributes | User/System | PREMIS |
| label | When there is no struct map as part of the ingest, a physical struct map is generated automatically using this label for file delivery. Once generated, this label is no longer in effect. | User – Pre-ingest or as part of deposit | |
| note | An internal note pertaining to the file. | User – Pre-ingest or as part of deposit | |
| FileEntityType | Sub-format (GeoTiff). | User – Pre-ingest | |
| compositionLevel | An indication of whether the object is subject to one or more processes of decoding or unbundling. | User – Pre-ingest | OBJECT:objectCharacteristics.compositionLevel |
| fileLocationType | The means of referencing the location of the content. During the Loading stage the value is set to ‘FILE’ as a default. |
System - Loading stage |
OBJECT:storage.contentLocation.contentLocationType |
| fileLocation | Could be used for reference to the location of the content. (Currently not in use). | User – Pre-ingest | OBJECT:storage.contentLocation.contentLocationValue |
| fileOriginalName | The name of the object as submitted to or harvested by the repository, before any renaming by the repository. | User – Pre-ingest or during web deposit (bulk load) | OBJECT:OriginalName |
| fileOriginalPath | The original path from which the file was taken (user PC, server).
Exported files are structured according to this path. |
User – Pre-ingest or during web deposit (bulk load) | |
| fileOriginalID | Used to store the location of the file on the Deposit server. |
System – Loading stage * Rosetta Mandatory |
|
| fileExtension | The normalized and definitive file extension for the file. |
System – loading stage, based on the file name * Rosetta Mandatory |
|
| fileMIMEType | The definitive MIME type for the file.
This value should be the same as in the fileFormat section. If the value was populate by the user, the system will not override it, and then it might mismatch the value in the fileFormat section.
|
User – can populate in Submission application System – During format validation task, based on format library * Rosetta Mandatory | |
| fileSizeBytes | File size in bytes. | System – Calculated by fixity task. (It can be populated pre-ingest as well) | OBJECT:objectCharacteristics.size |
| storageID | Currently not in use. | OBJECT:storage.storageMedium | |
| streamRefId | Currently not in use. | ||
| formatLibraryId | Reference to the file format library. The format library ID is used by the system to search and create sets, based on a given format. (For example, preservation sets). |
System – Validation Stack – Format Identification task * Rosetta Mandatory |
|
| riskLibraryIdentifiers | List of Tools Driven risks associated with the file format. All the Tool Driven risks that were found as relevant for the file are stored in this field (concatenated to a string). Property Driven risks are not stored in the DNX. | System – Validation Stack – Risk Extraction task | |
| fileCreationDate | The date the file was created. | User – during ingest System - during ingest (if not provided by user) | |
| fileModificationtionDate | The date the file was modified. | User – during ingest System - during ingest (if not provided by user) | |
| objectCharacteristics | Attributes applicable to all types | System | Non-PREMIS |
| objectType | INTELLECTUAL_ENTITY, REPRESENTATION, FILE |
Pre-ingest or during loading stage * Rosetta Mandatory |
|
| parentID | This field is currently not in use. | ||
| groupID | Link between objects on the same level that cross over representation boundaries. | Pre-ingest or during loading stage | |
| creationDate | Creation date of the IE. |
Loading stage * Rosetta Mandatory |
|
| createdBy | User who created the IE. |
Loading stage * Rosetta Mandatory |
|
| modificationDate | Modification date. | Upon committing new version * Rosetta Mandatory | |
| modifiedBy | User who was the last to modify the IE. |
Upon committing new version * Rosetta Mandatory |
|
| owner | Consortia ownership path. |
Loading stage – Based on the output of the SIP routing rule * Rosetta Mandatory |
|
| CMS | Collection Management System | User / System | Non-PREMIS |
| system | The ILS system in which this IE is described - Aleph, Voyager, Taphui. | User – Pre-ingest System – In the CMS Update task | |
| recordId | The record ID in the ILS. | ||
| mId | The ID of the record in the HDEMETADATA table. (System generated) | ||
| webHarvesting | Metadata of Web harvesting (NLNZ) | User | Non-PREMIS |
| primarySeedURL | The URL of the harvested domain. | ||
| WCTIdentifier | The Web curator tool that was used for the Web harvest. | Pre-ingest or through the web editor. | |
| targetName | The name of the harvested site. | ||
| group | If a group of sites is being harvested, this is the name of the group. | ||
| harvestDate | Date of the Web harvest. | ||
| harvestTime | Time of the Web harvest. | ||
| internalIdentifier | Rosetta internal identifiers | System | Non-PREMIS |
| internalIdentifierType | For example, PID, UUID, SIPID, DepositSetID. |
This section is populated during the loading phase. * Rosetta Mandatory |
|
| internalIdentifierValue | Deposit ID: Generated ORACLE sequence
SIP ID: Generated ORACLE sequence IE PID: IE + Generated ORACLE sequence REP PID: REP + Generated ORACLE sequence FILE PID: FL + Generated ORACLE sequence BITSTREAM PID: BS + Generated ORACLE sequence |
||
| objectIdentifier | A designation used to uniquely identify the object within the preservation repository system in which it is stored. | System, User | PREMIS |
| objectIdentifierType | A designation of the domain within which the object identifier is unique. (for example, Handle, URN). |
User – Pre-ingest System – as part of the PiGeneratorGenericTask task |
OBJECT:objectIdentifier.objectIdentifierType |
| objectIdentifierValue | The value of the objectIdentifier. | OBJECT:objectIdentifier.objectIdentifierValue | |
| preservationLevel | Preservation level | User | PREMIS |
| preservationLevelValue | A value indicating the set of preservation functions expected to be applied to the object (for example, bit-level, full). |
Pre-ingest or through the web-editor |
OBJECT:preservationLevel.preservationLevelValue |
| preservationLevelRole | A value indicating the context in which a set of preservation options is applicable (for example, requirement, intention, capability). | OBJECT:preservationLevel.preservationLevelRole | |
| preservationLevelType | A value indicating the type of preservation functions expected to be applied to the object for this preservation level. | OBJECT:preservationLevel.preservationLevelType | |
| preservationLevelRationale | The reason a particular preservationLevelValue was applied to the object. | OBJECT:preservationLevel.preservationLevelRationale | |
| preservationLevelDateAssigned | The date, or date and time, when a particular preservationLevelValue was assigned to the object. | OBJECT:preservationLevel.preservationLevelDateAssigned | |
| significantProperties | Significant properties | System/User | PREMIS |
| significantPropertiesType | The aspect, facet, or attribute of an object about which significant properties are being described (for example, content, structure, behavior, page count, page width). | This section is populated for files, by the MD Extraction task during the Validation Stack stage. However, users can use this section in the IE and Representation level and populate it pre-ingest. | OBJECT:significantProperties.significantPropertiesType |
| significantPropertiesValue | Description of the characteristics of a particular object. These properties are important for characterizing objects, finding objects, identifying risk in objects, and evaluating the success of preservation actions. | OBJECT:significantProperties.significantPropertiesValue | |
| significantPropertiesExtension | A container to include semantic units defined outside of PREMIS for significant properties. | OBJECT:significantProperties.significantPropertiesExtension | |
| fileFixity | The file fixity | System | PREMIS |
| agent | The agent ID of the file fixity utility (such as JAVA SE v5) if performed internally, or externally provided agent information. | Populated by the Fixity task (part of the validation stack)
* Rosetta Mandatory |
OBJECT:objectCharacteristics.fixity.messageDigestOriginator |
| fixityType | The specific algorithm used to construct the message digest for the digital object (such as MD5, CRC32, and SHA-256). | OBJECT:objectCharacteristics.fixity.messageDigestAlgorithm | |
| fixityValue | The output of the message digest algorithm. | OBJECT:objectCharacteristics.fixity.messageDigest | |
| fileFormat | The file format | System | PREMIS |
| Agent | Agent ID of the file format utility (such as DROID v1 definition file v17).
* Rosetta Mandatory |
These fields are populated during the format validation task (runs as part of the validation task) | |
| formatRegistry | Type of format library record (such as PRONOM). | OBJECT:ObjectCharacteristics.format.formatRegistry.formatRegistryName | |
| formatRegistryId | The registry ID. | OBJECT:ObjectCharacteristics.format.formatRegistry.formatRegistryKey | |
| formatRegistryRole | The purpose or expected use of the registry: format identification. | OBJECT:ObjectCharacteristics.format.formatRegistry.formatRegistryRole | |
| formatName | A designation of the format of the file or bitstream. (The ID of the Format in the Format Library e.g. fmt/7 for TIFF).
* Rosetta Mandatory |
OBJECT:ObjectCharacteristics.format.formatDesignation.formatName | |
| formatVersion | The version of the format listed in formatName.
* Rosetta Mandatory |
OBJECT:ObjectCharacteristics.format.formatDesignation.formatVersion | |
| formatStatus | Whether the format identification result was successful or not. | ||
| formatErrorMessage | The error message received when the format identification was unsuccessful. | ||
| formatDescription | The format description from the format library entry. (e.g. ‘Tagged Image File Format’ for format fmt/7 (TIFF)). | ||
| formatNote | Contains the note as entered by the Technical Analyst upon the manual format assignment. | OBJECT:ObjectCharacteristics.format.formatNote | |
| exactFormatIdentification | True – in case the format was identified by the format identification tool (e.g. DROID).
False – in case the Format was not identified by the tool (multiple or tentative results) and it was populated based on auto-correction rule or manually by a staff user (Technical Analyst). |
||
| mimeType | Based on the mime type in the format library. | ||
| agentVersion | The version of the tool used for identifying the format (such as DROID).
* Rosetta Mandatory |
||
| agentSignatureVersion | The version of the format’s signatures file that is used by the format identification tool.
* Rosetta Mandatory |
||
| IdentificationMethod | The method that the file format is identified. Possible values are: signature, extension, container, manual, and rule. | ||
| fileVirusCheck | The file virus check | System | Non-PREMIS |
| Agent | Agent ID of the file virus check utility (such as MacAfee v32, def file 98). |
This section is populated by the virus check task (part of the validation stack) |
|
| Status | Passed/fail | ||
| content | The descriptive output of the virus check utility. | ||
| fileValidation | The file validation utility (such as jhove, NLNZ MD extractor) | System | Non-PREMIS |
| Agent | Name and version of the file validation utility.
* Rosetta Mandatory |
This section is as part of the validation stack | |
| pluginName | Name of the plugin used for validation. | ||
| Status | This field is currently not in use. | ||
| errorMessage | The error message received during the MD extraction (if received). | ||
| errorId | The error ID received during the MD extraction (if received). | ||
| Format | A designation of the format of the file or bitstream. (for example, TIFF).
* Rosetta Mandatory |
||
| version |
The version of the format listed in format. (such as 1.0). * Rosetta Mandatory |
||
| mimeType | Specific output of JHOVE/NLNZ. In case no mimeType was identified by the utility, this field will remain empty. | ||
| Profile | This field is currently not in use. | ||
| isValid | True/False indicator. | ||
| isWellFormed | True/False indicator. | ||
| agentVersion | This field is currently not in use. | ||
| validationDetails | Further details regarding the validation (if applicable). | ||
| fileTechnicalMetadataExtractio | The technical MD extraction utility | System | Non-PREMIS |
| agent | The agent that did the MD extraction. | This section is populated during the MD extraction task | |
| pluginName | The plug-in that did the MD extraction. | ||
| errorMessage | The error message received during the MD extraction (if received). | ||
| errorId | The error ID received during the MD extraction (if received). | ||
| vsOutcome | The validation stack results - one record per check | System | Non-PREMIS |
| checkDate | The date of the validation stack.
* Rosetta Mandatory |
This section is populated by the validation stack task chain. | |
| vsAgent | Same agent as in the output of specific sections.
* Rosetta Mandatory |
||
| Type | Fixity, virus, validation, and so forth.
* Rosetta Mandatory |
||
| Result | Passed, fail
* Rosetta Mandatory |
||
| resultDetails | The automatic output from the validation stack agent (such as: /exlibris/dps/d4_1/profile/repository/storage1/2010/01/03/file_1/FL1123 is Virus Free | ||
| vsEvaluation | Passed, fail
* Rosetta Mandatory |
||
| vsEvaluationDetails | If the result was changed by the Technical Analyst, this field will capture the details. | ||
| creatingApplication | Information about the application that created the object | User/System | PREMIS |
| creatingApplicationName | A designation for the name of the software program that created the object (such as MSWord). | This section can be populated by:
|
OBJECT:ObjectCharacteristics.creatingApplication.creatingApplicationName |
| creatingApplicationVersion | The version of the software program that created the object. | OBJECT:ObjectCharacteristics.creatingApplication.creatingApplicationVersion | |
| dateCreatedByApplication | The actual or approximate date and time the object was created. | OBJECT:ObjectCharacteristics.creatingApplication.dateCreatedByApplication | |
| creatingApplicationExtension | Application creation information using semantic units defined externally to PREMIS. | OBJECT:ObjectCharacteristics.creatingApplication.creatingApplicationExtension | |
| inhibitors | Features of the object intended to inhibit access, use, or migration. | User | PREMIS |
| inhibitorType | The inhibitor method employed (such as DES, PGP, Blowfish Password protection). | User can populate this section pre-ingest (in submission application) or via web editor | OBJECT:ObjectCharacteristics.inhibitors.inhibitorType |
| inhibitorTarget | The content or function protected by the inhibitor (All content, Function: Play, Function: Print). | OBJECT:ObjectCharacteristics.inhibitors.inhibitorTarget | |
| inhibitorKey | The decryption key or password. | OBJECT:ObjectCharacteristics.inhibitors.inhibitorKey | |
| objectCharacteristicsExtension | A container to include semantic units defined outside of PREMIS. | User | PREMIS |
| objectCharacteristicsExtension | User can populate this section pre-ingest | OBJECT:ObjectCharacteristics.objectCharacteristicsExtension | |
| environment | Hardware/software combinations supporting the use of the object. | User | PREMIS |
| environmentCharacteristic | An assessment of the extent to which the described environment supports its purpose (such as recommended, minimum). |
User can populate this section pre-ingest (in submission application) or via web editor |
OBJECT:environment.environmentCharacteristic |
| environmentPurpose | The use(s) supported by the specified environment (such as render, edit). | OBJECT:environment.environmentPurpose | |
| environmentNote | Additional information about the environment. | OBJECT:environment.environmentNote | |
| environmentDependencies | Information about a non-software component or associated file needed in order to use or render the representation or file - for example, a schema, DTD, or an entity file declaration. | User | PREMIS |
| dependencyName | A designation for a component or associated file needed by the representation or file. |
User can populate this section pre-ingest (in submission application) or via web editor |
OBJECT:environment.dependency.dependencyIdentifier.dependencyIdentifierValue |
| dependencyIdentifierType1 | A designation of the domain in which the identifier of the dependent resource is unique (for example, URI). | OBJECT:environment.dependency.dependencyIdentifier.dependencyIdentifierType | |
| dependencyIdentifierValue1 | The value of the dependencyIdentifier (for example, http://www.teic.org/P4X/DTD/teicorp2.dtd) | OBJECT:environment.dependency.dependencyIdentifier.dependencyIdentifierValue | |
| dependencyIdentifierType2 | These fields allow holding another 2 sets of environment dependencies. | ||
| dependencyIdentifierValue2 | |||
| dependencyIdentifierType3 | |||
| dependencyIdentifierValue3 | |||
| environmentSoftware | Software required for rendering or using the object. | User | PREMIS |
| softwareName | Manufacturer and title of the software application (for example, Adobe Photoshop). |
User can populate this section pre-ingest (in submission application) or via web editor |
OBJECT:environment.software.swName |
| softwareVersion | The version or versions of the software referenced in softwareName (for example, >=2.2.0). | OBJECT:environment.software.swVersion | |
| softwareType | Class or category of software (for example, renderer, operating system). | OBJECT:environment.software.swType | |
| softwareOtherInformation | Additional requirements or instructions related to the software referenced in softwareName. | OBJECT:environment.software.swOtherInformation | |
| softwareDependancy | The name and, if applicable, version of any software component needed by the software referenced in softwareName in the context of using this object. | OBJECT:environment.software.swDependancy | |
| envSoftwareRegistry | Software required for rendering or using the object. | User | Non-PREMIS |
| registryId | User can populate this section pre-ingest (in submission application) or via web editor | ||
| environmentHardware | Hardware required for rendering or using the object. | User | PREMIS |
| hardwareName | Manufacturer, model, and version (if applicable) of the hardware (for example, Intel Pentium III). | User can populate this section pre-ingest (in submission application) or via web editor | OBJECT:environment.software.hwName |
| hardwareType | Class or category of the hardware (for example, processor, memory, input/output device). | OBJECT:environment.software.hwType | |
| hardwareOtherInformation | Additional requirements or instructions related to the hardware referenced in hardwareName (for example, 32MB minimum). | OBJECT:environment.software.hwOtherInformation | |
| envHardwareRegistry | Hardware required for rendering or using the object. | User | Non-PREMIS |
| registryId | User can populate this section pre-ingest (in submission application) or via web editor | ||
| environmentExtension | A container to include semantic units defined outside of PREMIS. | User | Non-PREMIS |
| environmentExtension | User can populate this section pre-ingest (in submission application) or via web editor | OBJECT:environment.environmentExtension | |
| signatureInformation | Information needed to use a digital signature to authenticate the signer of an object and/or the information contained in the object. | User | PREMIS |
| signatureInformationEncoding | The encoding used for the values of signatureValue, keyInformation (for example, Base64, Ds:CrytoBinary). | User can populate this section pre-ingest (in submission application) or via web editor | OBJECT:signatureInformation.signature.signatureInformationEncoding |
| signer | The individual, institution, or authority responsible for generating the signature. | OBJECT:signatureInformation.signature.signer | |
| signatureMethod | A designation for the encryption and hash algorithms used for signature generation (for example, DSA-SHA-256,DSA-SHA-256). | OBJECT:signatureInformation.signature.signatureMethod | |
| signatureValue | The digital signature; a value generated from the application of a private key to a message digest. | OBJECT:signatureInformation.signature.signatureValue | |
| signatureValidationRules | The operations to be performed in order to validate the digital signature. | OBJECT:signatureInformation.signature.signatureValidationRules | |
| signatureProperties | Additional information about the generation of the signature. | OBJECT:signatureInformation.signature.signatureProperties | |
| keyInformation | Information about the signer’s public key needed to validate the digital signature. | OBJECT:signatureInformation.signature.keyInformation | |
| signatureInformationExtension | Digital signature information using semantic units defined outside of PREMIS. | User | PREMIS |
| signatureInformationExtension | User can populate this section pre-ingest (in submission application) | OBJECT:signatureInformation. signatureInformationExtension | |
| relationship | User | PREMIS | |
| relationshipType | A high-level categorization of the nature of the relationship. | User can populate this section pre-ingest (in submission application) or via web editor | OBJECT:relationship.relationshipType |
| relationshipSubType | A specific characterization of the nature of the relationship documented in relationshipType. | OBJECT:relationship.relationshipSubType | |
| relatedObjectIdentifierType1 | A designation of the domain within which the identifier is unique. | OBJECT:relationship.relatedObjectIdentification.relatedObjectIdentifierType | |
| relatedObjectIdentifierValue1 | The value of the related object identifier. | OBJECT:relationship.relatedObjectIdentification.relatedObjectIdentifierType | |
| relatedObjectSequence1 | The order of the related object relative to other objects with the same type of relationship. | OBJECT:relationship.relatedObjectIdentification.relatedObjectSequence | |
| relatedObjectIdentifierType2 | These fields allow holding another 2 sets of relations.
|
||
| relatedObjectIdentifierValue2 | |||
| relatedObjectSequence2 | |||
| relatedObjectIdentifierType3 | |||
| relatedObjectIdentifierValue3 | |||
| relatedObjectSequence3 | |||
| IERelationship | User | PREMIS | |
| relationshipType | A high-level categorization of the nature of the relationship. Accepted value “STRUCTURAL”. | User can populate this section pre-ingest (in submission application) or via web editor | OBJECT:relationship.relationshipType |
| relationshipSubType | A specific characterization of the nature of the relationship. Accepted value “HAS_PART”. | OBJECT:relationship.relationshipSubType | |
| relatedObjectIdentifierType | The type of the identifier for which the related child IE identifier is unique. Accepted value “PID”. | OBJECT:relationship.relatedObjectIdentifier.relatedObjectIdentifierType | |
| relatedObjectIdentifierValue | The value of the related child IE identifier. | OBJECT:relationship.relatedObjectIdentifier.relatedObjectIdentifierValue | |
| relatedObjectSequence | The order of the related child IE relative to other child IEs under the parent IE. Accepted value is a positive integer. | OBJECT:relationship.relatedObjectIdentifier.relatedObjectSequence | |
| linkingIEIdentifier | An identifier for an intellectual entity associated with the object | User | PREMIS |
| linkingIEIdentifierType | The type of the linked object. | User can populate this section pre-ingest (in submission application) or via web editor | OBJECT:linkingIntellectualEntityIdentifier.linkingIntellectualEntityIdentifierType |
| linkingIEIdentifierValue | The ID of the linked object. | OBJECT:linkingIntellectualEntityIdentifier.linkingIntellectualEntityIdentifierValue | |
| producer | Producer information | System | Non-PREMIS |
| producerId | The Producer ID in the Rosetta DB.
* Rosetta Mandatory |
This section is populated by the system during the loading stage, as part of the SIP processing. | |
| userIdAppId | The user ID in the Rosetta DB.
* Rosetta Mandatory |
||
| defaultLanguage | Default language of the Producer. | ||
| authorativeName | Authoritative name of the Producer.
* Rosetta Mandatory |
||
| userName | The user name (if the Producer is not an organization). | ||
| firstName | First name of the Producer.
* Rosetta Mandatory |
||
| lastName | Last name of the Producer.
* Rosetta Mandatory |
||
| middleName | Middle name of the Producer. | ||
| jobTitle | Job title (if the Producer has a user record of a staff member). | ||
| address1 | The Producer's address (street, neighborhood, city, state).
* Rosetta Mandatory |
||
| address2 | |||
| address3 | |||
| address4 | |||
| address5 | |||
| zip | Zip code. | ||
| emailAddress | E-mail address.
* Rosetta Mandatory |
||
| webSiteUrl | Producer's Web site. | ||
| telephone1 | Phone number.
* Rosetta Mandatory |
||
| telephone2 | |||
| producerAgent | Producer Agent information | System | Non-PREMIS |
| firstName | First name of the Producer Agent.
* Rosetta Mandatory |
This section is populated by the system during the loading stage, as part of the SIP processing. | |
| lastName | Last name of the Producer Agent.
* Rosetta Mandatory |
||
| middleName | Middle name of the Producer Agent. | ||
| event | Events that were created during the SIP processing | System/User | PREMIS |
| eventIdentifierType | Type of event (for example, Rosetta)
* Rosetta Mandatory |
Events are created by the system. All the provenance events are written into the DNX upon creation and copied to the METS file upon moving to permanent. Pre-ingest events can be created by the users and written in the METS as part ofthe submission application. |
EVENT:eventIdentifier.eventIdentifierType |
| eventIdentifierValue | ID of the event in the generating system
* Rosetta Mandatory |
EVENT:eventIdentifier.eventIdentifierValue | |
| eventType | Event category in the generating system (processing, deposit)
* Rosetta Mandatory |
EVENT:eventType | |
| eventDescription | Description of the event in the generating system.
* Rosetta Mandatory |
||
| eventDateTime | Event date.
* Rosetta Mandatory |
EVENT:eventDateTime | |
| eventOutcome1 | Event outcome can be Success or Failure. | EVENT:eventOutcomeInformation.eventOutcome | |
| eventOutcomeDetail1 | A detailed description of the result or product of the event in textual form. | EVENT:eventOutcomeInformation.eventOutcomeDetail.eventOutcomeDetailNote | |
| eventOutcomeDetailExtension1 | If the event contains an XML file that should be stored as is.
XML should be wrapped as CDATA
|
EVENT:eventOutcomeInformation.eventOutcomeDetail.eventOutcomeDetailExtension | |
| eventOutcome2 | The section structure allows to have 3 sets of eventOutcome , eventOutcomeDetail and eventOutcomeDetailExtension as part of the same event. | ||
| eventOutcomeDetail2 | |||
| eventOutcomeDetailExtension2 | |||
| eventOutcome3 | |||
| eventOutcomeDetail3 | |||
| eventOutcomeDetailExtension3 | |||
| linkingAgentIdentifierXMLID1 | If there is an XML that is generated by the agent. | ||
| linkingAgentIdentifierType1 | If the event is being generated by different agents, such as specific software | EVENT:linkingAgentIdentifier.linkingAgentIdentifierType | |
| linkingAgentIdentifierValue1 | The ID of the agent - software tool name. | EVENT:linkingAgentIdentifier.linkingAgentIdentifierValue | |
| linkingAgentRole1 | The role of the agent - migration, rendering, and so forth. | EVENT:linkingAgentIdentifier.linkingAgentRole | |
| linkingAgentIdentifierXMLID2 | The section structure allows to have 3 sets of linkingAgentIdentifierXMLID, linkingAgentIdentifierType, linkingAgentIdentifierValue and linkingAgentRole as part of the same event. | ||
| linkingAgentIdentifierType2 | |||
| linkingAgentIdentifierValue2 | |||
| linkingAgentRole2 | |||
| linkingAgentIdentifierXMLID3 | |||
| linkingAgentIdentifierType3 | |||
| linkingAgentIdentifierValue3 | |||
| linkingAgentRole3 | |||
| linkingRightsStatementIdentifier | An identifier for a rights statement associated with the object. | User | PREMIS |
| linkingRightsStatementIdentifierType | A designation of the domain within which the linkingRightsStatementIdentifier is unique. | User can populate this section pre-ingest (in submission application) | OBJECT: linkingRightsStatementIdentifier. linkingRightsStatementIdentifierType |
| linkingRightsStatementIdentifierValue | The value of the linkingRightsStatementIdentifier. | OBJECT: linkingRightsStatementIdentifier. linkingRightsStatementIdentifierValue | |
| accessRightsPolicy | Access rights Policy | System/User | Non-PREMIS |
| policyId | The ID of the policy in its shared MD format (in the hdemetadata table in the staging DB and in the permanent repository). Note that this ID can be a string (for example, OPEN_ACCESS). |
The system assigns the IE with the AR policy of the material flow. The AR policy can be re-assigned by the user in the web editor (3A, editor) * Rosetta Mandatory |
|
| policyParameters | Modifying parameters of the access rights policy record (future use) | ||
| policyDescription | Textual brief description of the access rights policy record | ||
| retentionPeriodPolicy | Retention Period | System/User | Non-PREMIS |
| policyId | The ID of the policy in its shared MD format (in the hdemetadata table in the staging DB and in the permanent repository). Note that this ID can be a string (for example, FIVE YEARS). | ||
| policyDescription | Textual brief description of the retention rights policy record | ||
| grantedRightsStatement | The deposit boilerplate statement | User | Non-PREMIS |
| grantedRightsStatementIdentifier | The ID of the boilerplate that is related to the material flow through which this IE was inserted. This ID is generated in Rosetta when creating a new copyrights statement. | User can populate this section pre-ingest (in submission application) | |
| grantedRightsStatementValue | Actual content of the statement | ||
| metadata (Deprecated) | The Metadata record | System | Non-PREMIS |
| This table is deprecated and not in use. | |||
| MID | The ID of the metadata record as it stored in the PID/MID table.
* Rosetta Mandatory |
This section is populated in the METS file upon the move to permanent. |
|
| UUID | The unique ORACLE sequence ID of the metadata record in the HDEMETADATA table.
* Rosetta Mandatory |
||
| creationDate | Creation date of the metadata record in Rosetta.
* Rosetta Mandatory |
||
| createdBy | User who created the metadata record.
* Rosetta Mandatory |
||
| modificationDate | Modification date.
* Rosetta Mandatory |
||
| modifiedBy | User who modified the record.
* Rosetta Mandatory |
||
| metadataType | Metadata type (DNX, descriptive DC, access rights).
* Rosetta Mandatory |
||
| description | This field is currently not in use. | ||
| externalSystem | The external system from which this metadata record was brought. | ||
| externalRecordId | The ID of the MD in an external system. | ||
| collection | Collection information | System | Non-PREMIS |
| collectionID | The unique ID of the collection.
* Rosetta Mandatory |
||
| collectionName | The name of the Collection
* Rosetta Mandatory |
||
| externalSystem | Future use - The external system from which this Collection record was brought. | ||
| externalRecordId | Future use - The ID of the Collection in an external system. | ||
| parentCollectionId | The Collection ID of the parent collection, in case it exists. | ||
DNX Controlled Lists
The following table lists the DNX fields which can hold only values from a predefined list. The list of available values is defined using Rosetta Code Table mechanism.
| Field Name | Code Table Name | Editable by Staff User |
|---|---|---|
| status | IEStatus | Yes |
| IEEntityType | IEEntityType | Yes |
| preservationType | PreservationType | Some values are read=only but new ones can be added |
| PreservationLevelType | PreservationLevelType | Yes |
| usageType | UsageType | No |
| representationEntityType | representationEntityType | Yes |
| RepresentationCode | RepresentationCode | Yes |
| FileEntityType | FileEntityType | Yes |
| fileLocationType | fileLocationType | No |
| fileExtension | com.exlibris.preservation.format.FormatsExtensionsPopulator | No |
| fileMIMEType | com.exlibris.preservation.format.FormatsMimeTypesPopulator | No |
| objectType | objectType | No |
| system | ExternalSystems | Yes |
| internalIdentifierType | internalIdentifierType | No |
| objectIdentifierType | objectIdentifierType | Yes |
| fixityType | fixityType | Some values are read only but new ones can be added |
| type | vsOutcomeType | No |
| result | vsResult | No |
| vsEvaluation | vsEvaluation | No |
| creatingApplicationExtension | SubmissionFormatFileExtensions | No |
| inhibitorType | inhibitorType | No |
| dependencyIdentifierType1 | dependencyIdentifierType | No |
| dependencyIdentifierType2 | dependencyIdentifierType | No |
| dependencyIdentifierType3 | dependencyIdentifierType | No |
| relationshipType | relationshipType | No |
| relationshipSubType | relationshipSubType | No |
| relatedObjectIdentifierType1 | relatedObjectIdentifierType | No |
| relatedObjectIdentifierType2 | relatedObjectIdentifierType | No |
| relatedObjectIdentifierType3 | relatedObjectIdentifierType | No |
| linkingIEIdentifierType | linkingIEIdentifierType | No |
| defaultLanguage | UserLanguage | Yes |
| eventType | eventTypeCategory | No |
| linkingAgentIdentifierType1 | linkingAgentIdentifierType | No |
| linkingAgentIdentifierType2 | linkingAgentIdentifierType | No |
| linkingAgentIdentifierType3 | linkingAgentIdentifierType | No |
| linkingRightsStatementIdentifierType | linkingRightsStatementIdentifierType | No |
| linkingAgentRole | linkingAgentRole | No |