Skip to content

Architecture Overview

Seth Erickson edited this page Apr 13, 2020 · 20 revisions

Works and Work Versions

The Work is the primary unit of content in ScholarSphere. A Work consist of metadata and a series of Versions, each of which includes additional descriptive metadata (title, publication date, creators, etc.) and uploaded files.

A Version exists in one of three states:

  • Draft: Creating a Work automatically creates a Version in the Draft state, and new Versions of the Work are created in the Draft state. Files and metadata may be modified by the Work's creator or repository administrators only. A Work can have only one Version in the Draft state at a time.
  • Published: files and metadata may be accessed according to the access settings of the Work the Version belongs to. Metadata and files of Published versions may only be modified by repository administrators; updates to the metadata or files should be made by creating a new Version.
  • Withdrawn: metadata (but not files) may be accessed according to the access settings of the Work the Version belongs to. Metadata and files may only be modified by repository administrators. Only repository administrators can set a Version to the Withdrawn state.

In addition, the current Version of a Work (the Version presented to users who access the Work) is the most recently Published or Withdrawn Version.

The following table describes how metadata fields are stored (at the Work or Version-level) and indicates fields that may or may not change between Versions.

Metadata Description Associated with Work/Version Comment
Visibility/ACL Work Applies to all Versions
Depositor Work ...
Work Type Work ...
Embargo Release Date Work ...
Collection Memberships Work ...
DOI Both Work-level & Version-level DOIs
Version State Version Only one Draft Version per Work
Title Version Can Change between Versions
Creators Version ...
Keywords Version ...
Publication Date Version ...
etc. Version ...
Clone this wiki locally