A /wiki/spaces/DDSDOI/pages/330203281 was distributed to help shape the following requirements.
User Interface Requirements
These requirements are deemed most pertinent to the end user. They focus on the visiting scientists and define how they interact and navigate the system.
Number | Requirement | User Story | Importance | Notes | ||
|---|---|---|---|---|---|---|
UR-1 | The UI should provide a way for users to be able to upload files to supplement their investigation / visit data. | As a DGW user, I want to be able to supplement my data that i’ve I’ve collected as part of my visit to the DLS facility. |
| Deciding to append datasets to investigations | ||
UR-2 | The UI should provide a way for users to be able to upload any file type but | As a DGW user I don’t want to download any potential files that impose a security threat. note | ||||
MED | As zenodo do | |||||
UR-3 | The UI should notify the user if their total number of files exceeds 50GB 10GB in size. | As a data distributerdistributor, we don’t want the system to be abused. |
| Can be changed, but for now 10GB seems sensible based on testing | ||
UR-4 | The UI should provide feedback on the upload progress. | As a DGW user, i I want to be informed as to how my upload is progressing Info | | |||
UR-5 | The UI should provide the ability for users to stop a resume their uploads at a later date. | As a DGW user, i I want to be able to navigate away from the DGW webpage and have my uploads resume on my return. |
| tus.io provides resumable uploads | ||
UR-6 | The UI should allow users to view their uploaded data. | As a DGW user, i I want to be able to view the data i I have uploaded. |
| |||
UR-7 | The UI should allow users to download their uploaded data. | As a DGW user, i I want to be able to download the data i I have uploaded. |
|
Functional Requirements
Number | Requirement | User StoryImportance | Notes | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
FR-1 | The system should validate the uploaded data for integrity and completeness. | As a data provider, we need to make must ensure all uploaded data is correct. |
| So partial files are not uploaded | ||||||||
FR-2 | The system should support concurrent uploads from multiple users. | As a data provider, we need to be able to provide upload functionality to more than one user at a time. |
| |||||||||
FR-3 | The system should handle the transfer of large data files securely | As a user, which who has some commercial data stored in ICAT, i I want to make sure that all uploaded data is not available to other ICAT users |
| It is assumed that uploaded data will not need to be encrypted in transit. | ||||||||
FR-4 | The system should use the existing DataGateway User Interface | As a user, i want to view, download and upload my data in a single place. |
| FR-5 | The system should alert email all users involved in the experiment via email, that some new data has been uploaded. | I as As a member of an experiment, i I want to be notified when another member uploads some new data. |
| assuming all investigation users will want to receive an email | ||||
FR-5 | The system should ultimately store the newly uploaded data where existing data is held, on tape | As a data provider, we don’t want to maintain lots of different storage systems, with data fragmented across them. |
Constraints
Number | Requirement | User StoryImportance | Notes |
|---|---|---|---|
CR-1 | The system should not allow the users to delete their uploaded dataset | As a data provider, we do not provide the ability for users to delete their data | It is not currently possible in DGW anyway |
CR-2 | Only the Principal Investigator of the visit should be able to upload data | As a Principal Investigator of a visit, I don’t want everyone involved in the visit to be able to upload data. | Assumed |
CR-3 | The system should use the existing DataGateway User Interface | As a user, I want to view, download and upload my data in a single place. |