•  
     
    story #12345 export results to csv
Summary
Empty
export results to csv

I can do my own computation and stuff

Functional overview

Export is done with a click on a button near the result table.

On Click of the export button, a csv file is generated and proposed to be downloaded. The export can be long and generate large files.

What is exported

  • The data set corresponds to the ALL the artifacts that match the query (no pagination of results)
  • Fields that are covered
    • Always there fields
      • project label
      • tracker label
      • last update date
      • last update by
      • submission date
      • submitted by
      • artifact id
    • Semantics
      • Status
      • Title
      • Description
    • Fields "by duck typing" that are present in at least two selected trackers
      • String
      • Text
      • Integer
      • Float
      • Dates (with or without time)

What is "export by duck typing" ?

As data will be exported from several projects, the content might not be consistent. In order to get a result that "mean" something, for "general fields" (not always there fields or semantics) the export will consider that 2 fields are the same if

  • They have the same name (label might be different)
  • They have the same type (int, float, etc).

All other fields will be ignored (that is to say, if one field is present in only one tracker it won't be exported).

WARNING: it's likely that big query with large number of results and/or large number of computed fields might not be able to generate the file is a "human acceptable" time. This story doesn't cover this use case and this should be treated in a dedicated story once we collect enough information how it behaves on "real" data sets.

Technical overview

Export is done with a dedicated CSV endpoint which is paginated.

How to build the result

  • 1 query for Always There Fields + Sementics
  • + N queries per "extra" field
  • + M queries per artifact and per computed field

Will be done in later stories

  • Exporting Single value list (eg. select box and radio button): see story #12523: Export single-value list fields to CSV
  • Exporting Computed fields (not by default, it's an option that user must activate like a checkbox)
Empty
Empty
Status
Empty
Done
Development
  • [ ] Does it involves User Interface? 
  • [ ] Are there any mockups?
  • [ ] Are permissions checked?
  • [ ] Does it need Javascript development?
  • [ ] Does it need a forge upgrade bucket?
  • [ ] Does it need to execute things in system events?
  • [ ] Does it impact project creation (templates)?
  • [ ] Is it exploratory?
Empty
Details
#12345
Manuel Vacelet (vaceletm)
2018-11-15 16:52
2018-10-02 11:27
4273

References
Referencing story #12345

Git commit

tuleap/tuleap/stable

Refactoring: move reading/writing state to Vuex 841f63ed40
Refactoring: Split representation building 651f68fa6e
Refactoring: remove the www folder c6f42a3c36
Fix RPM build 0617752657
Have an endpoint for CSV export a2ee1b483d
Refactoring: Use Vuex to manage report saved state aa5b7d85ec
Refactoring: Use Vuex to manage reportId 153d62382f
CrossTracker uses PSR4 autoloader 364bfe48a5
Refactoring: Use Vuex to manage feedbacks 24479732e8
Add an Export CSV button 420a887863
Export tracker label as CSV c09a2be3cd
Export project label as CSV 792465b4b4
Export Always-there dates ebc711255d
Export Always-there User fields cd18cabf5d
Add BOM with javascript 369ce0aed7
Export title semantic as CSV e3bd3a94cc
Export description semantic as CSV 86112387dc
Export Status semantic as CSV d51918b855
Export duck-typed String fields 65658bf865
Export duck-typed Text fields f480e06fe6
Export duck-typed int and float fields a39686de2a
Export duck-typed date fields 712fa81255

Follow-ups

User avatar
Joris MASSON (jmasson)2018-11-15 16:52
Updated AC to reflect what has been implemented

  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
  • Category set to
User avatar
Joris MASSON (jmasson)2018-11-13 11:55
  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
  • Status changed from On going to Done
User avatar
  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
User avatar
  • So that
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes
  • Acceptance criteria
    Something went wrong, the follow up content couldn't be loaded
    Only formatting have been changed, you should switch to markup to see the changes