PubMan Func Spec Visibility

From MPDLMediaWiki
Jump to navigation Jump to search

WORK IN PROGRESS!!!

Institutional Visibility Scenario[edit]

Visibility for items[edit]

Item visibility in PubMan depends on item status and user role:

Item status Who may access
pending Depositor (only if owner)

Collaborator

submitted (as well submitted, in re-vision) Depositor (only if owner)

Moderator (QARole)
Collaborator

released any user
withdrawn any user (only with known eSciDoc ID)

Visibility for item components[edit]

There are two levels of visibility for components in PubMan:

  • public and
  • private (is to be renamed restricted).

By default, component visibility level is set to "public" during easy and full submission.

For restricted there are two possibilities:

  • private and
  • audience.

For both visibility level, private and audience it's possible to provide an embargo date. If a user is not the owner and does not have special rights to access the component(s) of an item, the respective component(s) is/are not visible to the user until embargo time is over.


Component visibility in Pubman depends on item status, access level of component and user role:

Item status Access level of component Who may access
pending
pending public Depositor (only if owner)

Collaborator

pending restricted - private Depositor (only if owner)

Collaborator

pending restricted - audience Depositor (only if owner)

Collaborator

submitted
submitted public Depositor (only if owner)

Moderator (QARole)
Collaborator

submitted restricted - private Depositor (only if owner)

Moderator (QARole)
Collaborator

submitted restricted - audience Depositor (only if owner)

Moderator (QARole)
Collaborator

released
released public all users
released restricted - private Depositor (only if owner)

Moderator (QARole)
Privileged Viewer

released restricted - audience Depositor (only if owner)

Moderator (QARole)
Respective Usergroup / Organizational Unit
Privileged Viewer

Assign institutional visibility (audience) for component(s)[edit]

Assign institutional visibility workflow during submission[edit]

  • the user uploads a file
  • as mentioned above, the system default visibility level for components is "public"
  • the user wants to change visibility level
  • he/she chooses component visibility level "restricted"
  • afterwards the user chooses, if the restricted access should be "private" or "audience"
  • he/she chooses visibility level "audience"
  • afterwards its possible to choose a respective audience group from a list of displayed user groups
    • these user groups are based on organizational unit level (at least for R5)
  • the user is able to choose more than one OU
    • future development: provide possibility to choose single persons of various OUs for audience groups
  • any user within the chosen user group(s) can access the item component as soon as the item is released (but no right to modify for audience group)


Who is able to assign audience privileges?[edit]

  • the visibility level for a component can be changed by
    • the owner of the item (Depositor)
    • a user with QA role (Moderator)
    • a user with Collaborator-Modifier privileges


Where is the access level of the component defined?[edit]

  • audience privileges can be assigned for single components as well as for an item (with all of its components included)


What has to be done on admin interface?[edit]

  • create usergroup (defined by Organizational Units for now)
    • future development: choose single persons to create a usergroup
  • name of the usergroup = new value for audience selection during submission


PubMan Item View[edit]

  • metadata information
    • component x
      • visibility:
a) "visibility for usergroup x" (nice scenario)
b) "audience" (worst scenario - depends on FIZ)


New Usecases[edit]

  • UC create usergroup
  • UC assign privileges to user group for context (e.g. all secretaries are Depositors)
  • UC add members to usergroup (at first (R5) just the list of OUs; later a list of single persons)


Collaboration scenario[edit]

The Collaborator is a user role that can be assigned to give user access on context level and item level. Access on component level will be possible in the future.

The Collaborator is split in two roles:

  • Collaborator who has only rights to view items in all states
  • Collaborator who has rights to view and modify


Definitions and user role descriptions[edit]

Definition of used terms[edit]

Term Definition
Item In PubMan an item contains all metadata and its attached files describing a special type of document which is stored in the respository.
Content Content is only the binary content (simply the file) which is uploaded to PubMan.
Component Component can contain also some metadata and a pointer to the content. The content in eSciDoc can be internal managed (what in pubman is called "File"), or externally referenced (what in pubman is called "Locator"). In core services i.e. in the components.xsd schema of eSciDoc, this is known as "storage" property of the component.
Context Context are the administrative units for management of the publication items. One or more organizational units are responsible for a context.

Definition of mentioned user roles[edit]

Term Definition
Depositor Role that when granted allows to create items in the repository and manage items (including components and their content) he/she created in accordance with the overall workflow rules.
Moderator QARole

Is responsible for the quality assurance of the data.

Collaborator Two different types of collaborators: collaborater-viewer & collaborator-modifier.

Role that when granted allows access and/or modify the containers, the items, their components and the internally managed content independently of item state.

Privileged Viewer Role that when granted allows to access all components and their content of a released item in one context/collection independently of visibility.