User Stories
We note that Diamond users are already publishing data elsewhere.
By searching for “Diamond Light Source” in Zenodo we can see multiple datasets (281 results at the time of writing): https://zenodo.org/search?page=1&size=20&q=%22diamond%20light%20source%22&type=dataset
These user stories will help derive any potential requirements and Test Cases.
1. Instantly create User-defined Data Publications |
Actor |
A Principal Investigator (PI) |
Preconditions |
|
Use Case Description |
An existing ICAT user who is a Principal Investigator for a set of Visits, logs into DataGateway to create a data publication for the data that they are PI for. They should be able to create DPs for datasets and datafiles. The system should:
|
Technical Implications / Details |
|
Questions |
|
Expected Output |
|
1.a: Create User-defined Data Publications for Whole Visits |
Actor |
A Principal Investigator (PI) |
Preconditions |
|
Use Case Description |
An existing ICAT user who is a Pricipal Investigator for a set of Visits logs into DataGateway to create a data publication for the data that they are PI for. The system should:
|
Technical Implications |
This isn’t possible right now (18/5/23) due to the size limit imposed on downloads by SCD. This means that investigations are not selectable in the data gateway front end. |
Questions |
|
Expected Output |
|
1.b: Create a Datapublication at a later date |
Actor |
A Prinicipal Investigator (PI) |
Preconditions |
|
Use Case Description |
The description encompasses the two use cases above but gives the user the option to create a DP/DOI at a date in future. |
Technical Implications |
|
Questions |
|
Expected Output |
|
2. Data exclusion & DataPublication deletion |
Actor |
An existing ICAT user with a valid account |
Preconditions |
|
Use Case Description |
|
Technical Implications |
|
Questions |
|
Expected Output |
|
3. Automatic minting of DOIs |
Actor |
System (or cron job) |
Preconditions |
|
Use Case Description |
At regular intervals, a batch system creates a set of DataPublications & associated DOIs for existing Investigations in ICAT. |
Technical Implications / Details |
This functionality will be used to do two things:
The script will need to take a config that lists all the datasets, datafiles or visits that need to be excluded from the minting process. Diamond are to provide this list. This functionality is to be released after the user-defined finctionality. |
Questions |
|
Expected Output |
A set of ICAT entities have been processed, and their related:
|
4. An external review process |
Actor |
An Editor for the New Scientist Magazine (other experts in the field?) |
Preconditions |
They have access to the internet |
Use Case Description |
A scientist who has visited DLS wants their findings published in a fancy magazine. Along with the research, the Scientist wants to give temporary read access to the editor so they can review the draft findings, making sure they are accurate. Once the editor has reviewed the draft DOI, the Scientist can move the DOI from a draft state into findable, public one. The scientist will be able to share this via a link which anyone can access (internal icat users and external). |
Technical Implications |
|
Questions |
|
Expected Output |
A publisher is able to review data produced by a visiting DLS scientist and has confidence that the content they provide is scientifically accurate. |