ESciDoc Item Container Version History

This is a protected page.

Concepts

See Item, Container Specs&APIs here

Container Handler

Containers offer the concept of aggregation, i.e. they can contain other (simple and complex) objects. Each container includes a structural map, which manages references to all members of the aggregation. Containers are versionable. They can be associated with a persistent identifier. Containers have a built-in basic object lifecycle. The status of a Container within its object lifecycle influences which actions are applicable and which user privileges are to be evaluated.

Item Handler

Items are objects representing the actual content of the repository. An item is a simple or complex object like an article, a report or a translation. Items are versionable. They can be associated with a persistent identifier. Items have a built-in basic object lifecycle. The status of an Item within its object lifecycle influences which actions are applicable and which user privileges are to be evaluated.

Premis Event Entity

The Event entity aggregates information about an action that involves one or more Object entities. Metadata about an Event would normally be recorded and stored separately from the digital object.

Whether or not a preservation repository records an Event depends upon the importance of the event. Actions that modify objects should always be recorded. Other actions such as copying an object for backup purposes may be recorded in system logs or an audit trail but not necessarily in an Event entity. Mandatory semantic units are: eventIdentifier, eventType, and eventDateTime.

This is a hierarchical listing of the semantic units included in the Data Dictionary. The information in parentheses following each semantic unit indicates whether the element is Mandatory (M) or Optional (O), followed by whether it is Repeatable (R), Not repeatable (NR) or Attribute (A).

V1.0

1. eventIdentifier (M, NR)
   1. eventIdentifierType (M, NR)
   2. eventIdentifierValue (M, NR)
2. eventType (M, NR)
3. eventDateTime (M, NR)
4. eventDetail (O, NR)
5. eventOutcomeInformation (O, R)
   1. eventOutcome (O, NR)
   2. eventOutcomeDetail (O, R)
6. linkingAgentIdentifier (O, R)
   1. linkingAgentIdentifierType (M, NR)
   2. linkingAgentIdentifierValue (M, NR)
   3. linkingAgentRole (O, R)
   4. linkingAgentXmlID (O, A)
7. linkingObjectIdentifier (O, R)
   1. linkingObjectIdentifierType (M, NR)
   2. linkingObjectIdentifierValue (M, NR)
   3. linkingObjectXmlID (O, A)
8. xmlID (M, A)

V2.0

1. eventIdentifier (M, NR)
   1. eventIdentifierType (M, NR)
   2. eventIdentifierValue (M, NR)
2. eventType (M, NR)
3. eventDateTime (M, NR)
4. eventDetail (O, NR)
5. eventOutcomeInformation (O, R)
   1. eventOutcome (O, NR)
   2. eventOutcomeDetail (O, R)
      1. eventOutcomeDetailNote (O, NR)
      2. eventOutcomeDetailExtension (O, NR)
6. linkingAgentIdentifier (O, R)
   1. linkingAgentIdentifierType (M, NR)
   2. linkingAgentIdentifierValue (M, NR)
   3. linkingAgentRole (O, R)
   4. LinkAgentXmlID (O, A)
7. linkingObjectIdentifier (O, R)
   1. linkingObjectIdentifierType (M, NR)
   2. linkingObjectIdentifierValue (M, NR)
   3. linkingObjectRole (O, R)
   4. LinkObjectXmlID (O, A)
8. xmlID (M, A)

Semantic unit	2.1 eventIdentifier
Semantic components	2.1.1 eventIdentifierType 2.1.2 eventIdentifierValue
Definition	A designation used to uniquely identify the event within the preservation repository system.
Rationale	Each event recorded by the preservation archive must have a unique identifier to allow it to be related to objects, agents, and other events.
Data constraint	Container
Repeatability	Not repeatable
Obligation	Mandatory
Creation / Maintenance notes	The eventIdentifier is likely to be system generated. There is no global scheme or standard for these identifiers. The identifier is therefore not repeatable.
eSciDoc	Each event recorded by the preservation archive must have a unique identifier to allow it to be related to objects, agents, and other events.

Semantic unit	2.1.1 eventIdentifierType
Semantic components	None
Definition	A designation of the domain within which the event identifier is unique. ifier to allow it to be related to objects, agents, and other events.
Data constraint	None
Examples	FDA Stanford Repository Event ID UUID
Repeatability	Not repeatable
Obligation	Mandatory
Creation / Maintenance notes	For most preservation repositories, the eventIdentifierType will be its own internal numbering system. It can be implicit within the system and provided explicitly only if the data is exported.
eSciDoc

Data constraint None Examples FDA

                 Stanford Repository Event ID
                 UUID

Repeatability Not repeatable Obligation Mandatory Creation / For most preservation repositories, the eventIdentifierType will be its Maintenance notes own internal numbering system. It can be implicit within the system

                 and provided explicitly only if the data is exported.

Changes v1.0=>v2.0

• Complete schema in one file instead of separate files.
• Added elements:
  • eventOutcomeDetailNote (O, NR)
  • eventOutcomeDetailExtension (O, NR)
  • linkingObjectRole (O, R)

Links

• PREMIS all schemas
• PREMIS v2.0: Data Dictionary PDF, HTML
• PREMIS v2.0 Hierarchical Listing of Semantic Units, see Event.
• PREMIS v1.0 => v2.0 changes
• JIRA ticket AS-765
• Object Manager
  • API Documentation Container Handler, Item Handler
  • Schemas: Container, Item
• TOC Container
• Version History XSD

Examples

• container version-history, dev-coreservice, escidoc:29780
• item version-history, dev-coreservice, escidoc:29777

Enhanced Scientific Documentation

Identifier

Preservation Metadata: Implementation Strategies

Error Management and Project Management Software

Application Programming Interface