Difference between revisions of "ESciDoc Access Rights"

From MPDLMediaWiki
Jump to navigation Jump to search
Line 8: Line 8:
*'''Collaborator''' - role granted to users, user groups that can access the content and items under specified conditions of item and version statuses.  
*'''Collaborator''' - role granted to users, user groups that can access the content and items under specified conditions of item and version statuses.  
*'''Audience''' - role granted to users, user groups that can access the component and its content when item is released in case when visibility for the component is set to "Audience".
*'''Audience''' - role granted to users, user groups that can access the component and its content when item is released in case when visibility for the component is set to "Audience".
The descriptions of the roles are very short here. I am missing all information about containers. Is the corresponding document from FIZ ([http://www.escidoc-project.de/documentation/Soap_api_doc_AA_Role.pdf API Documentation Role]) still valid? --[[User:Kristina|Kristina]] 08:39, 27 November 2008 (UTC)


====Component visibility====
====Component visibility====

Revision as of 08:39, 27 November 2008

Related discussion[edit]

see ESciDoc Institutional Visibility Discussion

Description of the roles/groups in the access rules tables[edit]

  • Depositor - role that when granted allows to create items in the repository and manage items (including components and their content) she created in accordance with the overall workflow rules.
  • DataAdmin - role that when granted allows to create items and manage items (including components and their content) independently from their ownership and in accordance with the overall workflow rules.
  • QARole - placeholder for roles in the system that are responsible for the quality assurance of the data e.g. Metadata editor, Moderator, Authority, Rights checking.
  • Collaborator - role granted to users, user groups that can access the content and items under specified conditions of item and version statuses.
  • Audience - role granted to users, user groups that can access the component and its content when item is released in case when visibility for the component is set to "Audience".

The descriptions of the roles are very short here. I am missing all information about containers. Is the corresponding document from FIZ (API Documentation Role) still valid? --Kristina 08:39, 27 November 2008 (UTC)

Component visibility[edit]

    • Internal - content of the component can be accessed by Depositor, DataAdmin, QARole
    • Public - no access level restriction
    • Audience - content of the component can be accessed by Depositor, DataAdmin, QARole and additional users or groups of users are granted with the role Audience for a defined scope. Groups of users can be defined via:
      • List of organizational units
      • List of account users
      • Shibboleth attributes
      • Key/Certificate based (unregistered user) (status: not planned for release 1.0 of core services)
  • Audience and Collaborator roles differ by their access rights during the Item workflow. In addition, Colaborator role may have modification privileges (not yet described in here).

Description of the access rules tables[edit]

  • Item status - the public-status of the item. Item may have different public status then the status of the last version of the item.
  • Who may access - Name of the role with which user should be granted to access the item and or the content associated with the component of the item.
  • Where is role defined - The eSciDoc resource type for which the role has defined scope when granting privilege for access
  • Check for access level - Whether or not to check the access level for this role/group under specified conditions

Access rules table for Items[edit]

Item status Who may access Where is access level defined (scope)
pending Depositor (only if owner)
DataAdmin
Context
pending Colaborator Context, Item
submitted, in-revision Depositor (if owner)
DataAdmin
QARole
Context
submitted, in-revision Colaborator Context, Item
released any user System
withdrawn Depositor (if owner)
DataAdmin
QARole
Context

Access rules table for Components[edit]

Item status Who may access Where is access level defined (scope) Check for access level
pending Depositor (only if owner)
DataAdmin
Context No
pending Colaborator Component (thus Item implicitly) No
submitted, in-revision Depositor (if owner)
DataAdmin
QARole
Context No
submitted Colaborator Component (thus item implicitly) No
released Depositor (if owner)
DataAdmin
QARole
Context No
released Colaborator Component (thus item implicitly) No
released Audience Component (thus item implicitly) Yes => Visibility level can be Public XOR Internal* XOR Audience*
withdrawn Depositor (if owner)
DataAdmin
QARole
Context No

Example[edit]

  • Item A is created by Depositor D in context C and consist of:
    • Component C1
    • Component C2
  • QA User 1 - has QA role assigned for context C
  • QA User 2 - has QA role assigned for context C, context D

Case 1[edit]

  • Depositor D gives Internal access for Component C2 and Public access for Component C1
  • Depositor D gives additionally access to Colaborator User U and to Colaborator Person P for Component C2
  • Colaborator User U - is account user and is known to the system via his/her user account
  • Colaborator Person P - is a system visitor who received a security "Key" from Depositor D with which s/he can access the Component C2


  • According to the upper table:
    • When item is in Pending status, beside Depositor D:
      • Component C1 can be accessed by DataAdmin
      • Component C2 can be accessed by Colaborator User U, Colaborator Person P and DataAdmin
      • Implicitly: Item retrieval allowed for Colaborator User U, Colaborator Person P and DataAdmin
    • When item is in Submitted status, beside Depositor D:
      • Component C1 can be accessed by DataAdmin, QA User 1, QA User 2
      • Component C2 can be accessed by Colaborator User U, Colaborator Person P, DataAdmin, QA User 1, QA User 2
      • Implicitly: Item retrieval allowed for Colaborator User U, Colaborator Person P, DataAdmin, QA User 1, QA User 2
    • When item is in Released status, beside Depositor D:
      • Component C1 can be accessed by any user (i.e. Audience=Public)
      • Component C2 can be accessed by Colaborator User U, Colaborator Person P, DataAdmin, QA User 1, QA User 2
      • Implicitly: Item retrieval allowed for all users
    • When item is in Withdrawn status, beside Depositor D:
      • Component C1 can be accessed by DataAdmin, QA User 1, QA User 2
      • Component C2 can be accessed by DataAdmin, QA User 1, QA User 2
      • Implicitly: Item retrieval allowed for all users

Case 2[edit]

  • Depositor D gives Internal access for Component C2 and MPG wide access for Component C1
  • Depositor D gives additionally access to Colaborator User U and to Colaborator Person P for Component C2
  • Colaborator User U - is account user and is known to the system via his/her user account
  • Colaborator Person P - is a system visitor who received a security "Key" from Depositor D with which s/he can access the Component C2
  • According to the upper table:
    • When item is in Pending status, beside Depositor D:
      • Component C1 can be accessed by DataAdmin
      • Component C2 can be accessed by Colaborator User U, DataAdmin and Colaborator Person P
      • Implicitly: item retrieval allowed for Colaborator User U, DataAdmin and Colaborator Person P
    • When item is in Submitted status, beside Depositor D:
      • Component C1 can be accessed by DataAdmin, QA User 1, QA User 2
      • Component C2 can be accessed by Colaborator User U, Colaborator Person P, DataAdmin, QA User 1, QA User 2
      • Implicitly: item retrieval allowed for Colaborator User U, DataAdmin and Colaborator Person P, QA User 1, QA User 2
    • When item is in Released status, beside Depositor D:
      • Component C1 can be accessed by any user that comes from MPG (i.e. Audience="MPG wide")
      • Component C2 can be accessed by Colaborator User U, Colaborator Person P, DataAdmin, QA User 1, QA User 2
      • Implicitly: item retrieval allowed for all users
    • When item is in Withdrawn status, beside Depositor D:
      • Component C1 can be accessed by DataAdmin, QA User 1, QA User 2
      • Component C2 can be accessed by DataAdmin, QA User 1, QA User 2
      • Implicitly: item retrieval allowed for all users