This documentation is for XNAT versions 1.6.0 - 1.6.5. You can find the latest documentation for XNAT 1.7 at https://xnat.org/documentation
Access to data stored in XNAT is governed by the data's relation to (or participation in) a given project. "Project Participation" for subject and experiment data in XNAT is split into two kinds of relationships: Ownership and Sharing.
The first (and most important) relationship between projects and their data instances is ownership. Subjects and experiments are ‘owned’ by a single project (referred to as the primary project). The owners and members of the primary project are the users who control access to, and modification of that data. In practice, the primary project is the project which first inserted the data into XNAT (usually the project which acquired or recruited the data). When the data is added to the primary project (at data insertion) the user has the opportunity to give it a unique identifier (label) which will be used across XNAT to refer to the data.
Access to data is governed by the relationships between projects and data instances. The permissions governing access to data are different depending on the nature of that relationship. There are four permission types which control user access/control of data.
|Role/Activity||Permissions||Project Owners||Project Members||Project Collaborators|
|Create||The ability to create data of this type||C||C|
|Read||The ability to read, including downloading, data of this type||R||R||R|
|Update||The ability to modify existing data of this type||U||U|
|Delete||The ability to remove data of this type||D|
However, the permissions available to a user in a project are different depending on the data’s relationship to the project.
The second relationship between projects and their data instances is sharing. When a user decides to use data from Project A in his/her project (Project B), then he can add the data to his project by ‘sharing’ the data into it. Any user who can access a data instance, can add that data to his/her project. The user has the option of defining a project-based identifier (label), which will be used within project-scope to refer to this data.
Data shared from Project A into Project B is not copied into Project B. It is the same data element, so any changes to the data in Project A are reflected in Project B.
|Role/Activity||Project A Owners||Project A Members||Project A Collaborators|
|Create Data in Project A||C||C|
|Read/Download Data from Project A||R||R||R|
|Update Project A Data||U||U|
|Delete Project A Data||D|
|Share Data (for example, into "Project B")||S||S||S|
"Project B" (Created by a collaborator of Project A)
|Role/Activity||Project B Owners||Project B Members||Project B Collaborators|
|Create Data in Project B||C||C|
|Read/Download Data in Project B||R||R||R|
|Read/Download Shared Data from Project A||R||R||R|
|Update Project B Data||U||U|
|Delete Project B Data||D|
|Share Data (for example, into "Project C")||S||S||S|
As this pair of charts shows, data shared from Project A cannot be modified in Project B, except by people who have the appropriate permissions in Project A. Thus, even though the owner of Project B is a collaborator in Project A, this user does not have the appropriate permission to modify or delete that shared data in Project B.
Any data instance (subject or experiment) has a generic ‘ID’ field. This field is used by XNAT to uniquely identify this instance throughout XNAT. This value is usually dynamically created by XNAT, behind the scenes.
The data instances also have project-based identifiers (labels) which identify the item within a specific project.
The relationship between data and its project is captured at the xml level, in the definition of those data instances. There are four pertinent areas of the xml document (subject or experiment) which identify the data’s projects and identifiers.
The attributes are described in the table below.
|ID||The generic ID used throughout the database to identify this item. It is the primary key of this item.|
|project||The ID of the primary project which owns this data.|
|label||The identifier used by the primary project to identify this item. This is used throughout the website and file system to refer to this item.|
These are the projects into which this item has been shared: