Update metadata
Target release | 2.3 |
|---|---|
Epic | |
Document status | DRAFT |
Document owner | @Deb Weigand |
Designer | @Yaw Nti-Addae |
Tech lead | @KevinPalis |
Developer(s) | @KevinPalis, @Angel Manica Raquel, @Luke Cook, @Joshua Lamos-Sweeney |
QA |
|
Objective
Allow users to update existing data in the database for the following entities or tables
germplasm
dnasample
dnarun
marker
linkage_group
marker_limkage_group
Users can only update one entity table at a time.
Users will be able to update any arbitrary field and props field by uploading a tab-delimited file containing such information with the appropriate entity id.
All headers in the input file must follow the same nomenclature (tablename_fieldname) as used in the data extract files. e.g. dnasample_trial_name
Users will not be able to update fields associated with other entities. e.g. users will not be allowed to update the list of dnasamples associated with a different project
Fields that contain information relating to other entity tables cannot be updated. e.g. marker 'variant'
Users will receive an email that indicates
SUCCESS or FAIL of the update
which table was updated
the number of records updated
Success metrics
Goal | Metric |
|---|---|
|
|
Updatable Tables and Columns
Information below represent columns that may be present in a file, with table_id used to identify records that can be updated and all other columns being updatable columns.
germplasm | dnasample | dnarun | marker | linkage_group | marker_linkage_group |
|---|---|---|---|---|---|
germplasm_id | dnasample_id | dnarun_id | marker_id | linkage_group_id |
|
name | name | name | name | name | start |
external_code | platename | props - system defined | ref | start | stop |
species_name | num | props - user defined | alts | stop |
|
type_name | well_col |
| sequence |
|
|
props - system defined | well_row |
| primers |
|
|
props - user defined | uuid |
| strand_name |
|
|
| props - system defined |
| probsets |
|
|
| props - user defined |
| props - system defined |
|
|
|
|
| props - user defined |
|
|
Requirements
User interaction and design
Open Questions
Question | Answer | Date Answered |
|---|---|---|
is there an upper limit to the number of records we will allow the user to update? makes a difference as to how we implement the update |
| |
will there be a UI that allows for single updates and bulk updates? |
|
|
Single table extracts that a user can modify and re-upload? |
|
|
dnarun props? e.g. barcode | as per @Elizabeth Jones leave it out for now | Sep 30, 2019 |
do we want to update modified and modified dates? |
|
|