Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 99
Next »
These user stories will help derive any potential requirements and Test Cases.
User-defined DOIs
mint whole Visits
mint at a later date
Data exclusion & DataPublications deletion
Automatic minting of DOIs
An external review process
1. Instantly create User-defined Data |
Actor |
A Principal Investigator (PI) |
Preconditions |
They are able to log into DataGateway They are able to see data from the experiments in which they participate, either as PIs or other roles.
|
|
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 . . The system should: |
Technical Implications / Details |
The Users will be responsible for providing the required metadata and so will need to provide the DataPublications' creator, title and description. Full list of metadata used in DOI here. It is assumed that the DataGateway front end will assist the user with these mandatory inputs. Only data in which they are PI in for the overall investigation can be minted There is to be NO review process for these DPs/DOIs This functionality is to be released first
|
Questions |
? |
Expected Output |
A and associated created from a user-defined set of metadata. The underlying data is now open and retrievable by anyone in the world A DOI in a findable/searchable state with an associated landing page.
|
1.a: Create User-defined Data |
Actor |
A Principal Investigator (PI) |
Preconditions |
They are able to log into DataGateway They are able to see data from the experiments in which they participate, either as PIs or other roles.
|
|
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 . |
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 |
A and associated created from a user-defined set of metadata. The underlying data is now open and retrievable by anyone in the world A DOI in a findable/searchable state with an associated landing page.
|
1.b: Create a Datapublication at a later date |
Actor |
A Prinicipal Investigator (PI) |
Preconditions |
They are able to log into DataGateway They are able to see data from the experiments in which they participate, either as PIs or other roles.
|
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 with a valid account |
Preconditions |
|
Use Case Description |
Automatic minting: A PI wants remove a specific datasets from a data publication once a DOI has been created. Diamond are worried that confidential data may make it into DPs
|
Technical Implications |
Automatic minting: Once the automatic process is ran, a DP and DOI will be created but the data won’t be open until 3 years time, however if in the meantime, some confidential datasets are are added. A new Rule will need to be created to check a flag in the dataset, as so to never release confidential / sensitive data. In this case the DP and DOI will reference only the “open source” data. The Automatic process should not create DOIs and DP for confidential Visits in the first place so a flag will also need to be set against the Visit.
|
Questions |
|
Expected Output |
|
3. Automatic minting of DOIs |
Actor |
System (or cron job) |
Preconditions |
Any developed software can connect to the ICAT DB. Correct permissions are set to allow the software to access the ICAT. There exist sufficient data to fill out the required metadata fields in the Datapublication and DOI.
|
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: Create DataPublications and DOIs for the backlog of data that should already be open but isn’t. All Visits with an + n days, barring any exceptions provided by diamond (see here), will need to be processed. Be added to a cron job to regularly check for Visits added to ICAT to process. The investigation end date will be used. The script will need to check if any investigations have ended in the last 24 h and create DPs and DOI accordingly. Again, barring any exceptions provided by diamond (see here).
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: DataPublication has been created in ICAT DOI has been created and is in a findable/searchable state A landing page for each of the process ICAT entities is created and assigned to the relevant DataPublication and DOI.
|
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. |
Technical Implications |
We would not facilitate the review process. How they communicate, provide sign off would not be included. More complicated authorisation model,
|
Questions |
what other existing systems do similar?, google docs If we created a sharable link to the DP Landing page, would this:
|
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. |
Add Comment