Extractor: Output Files - Fields added (props & IDs)

Target release2.2
Epic GWEB-22 - Getting issue details... STATUS
Document status
DRAFT
Document owner
DesignerDeb Weigand
Tech leadKevinPalis
Developer(s)KevinPalis
QADeb Weigand

Objective

Client's Goal: as per GR-136 (Jira server):
GOBii-GDM has been designed to allow breeding programs define their own meta information they would like to store without having to make modifications to database schema. These meta information are referred to as property fields or simply properties.

GDM currently allows users to only extract system defined properties, which are commonly known meta information that are pre-defined in any instance of GDM. This means that users cannot extract custom defined properties that they have loaded data to.

Users will like to be able to extract meta information they have loaded to GDM, both system defined and custom ones.

In addition, there is a need for IDs to be extracted for various entities.

User Story:

As a GDM user, I want to be able to extract additional fields including various props and IDs.

  • For sample.file
    • Props (both system and user defined)
      • germplasm props
      • dnasample props
      • project props
    • IDs:
      • germplasm_id
      • dnasample_id
      • dnarun_id
  • For marker.file:
    • marker props (both system and user defined)
    • IDs:
      • marker_id
      • linkage_group_id
  • Headers for props fields in the files should be prefixed with the main entity table name. e.g. trial_name in dnasample props should have a header "dnasample_trial_name" in sample.file
  • Dataset.hmp.txt will contain all the props fields, both system and user defined

Acceptance Criteria:

  • Extract output sample.file contains the props, both system and user defined, and the various IDs (as listed above)
  • Extract output marker.file contains the props, both system and user defined, and the various IDs (as listed above)
  • Extract output Dataset.hmp.txt contains all the props fields, both system and user defined


Notes from meeting Wed 11/20:

Kevin had a question as to conflicts if a property has the same name in both system and user defined 

Nomenclature - We may need to prefix user defined props with something in order to remove any conflicts with system defined props  

Liz does not want any names changed that are currently in the extract now to prevent downstream QC analysis to fail 

Append to the end, the remaining system props and after that, the dynamic user property list 


List any assumptions you have about your users, technical constraints, or business goals (e.g., Most users will access this feature from a tablet)
Assumptions

Issues in Epic

key summary type assignee priority status issuelinks
Loading...
Refresh

User interaction and design

Open Questions

QuestionAnswerDate Answered

Should the following properties be extracted:

  • project props
  • mapset props
  • platform props

yes to project props,

no to mapset and platform props

 
What samples fields should be included in Hapmap file?all props fields should be included  

wed 11/20