Overview
While the need is quite generic, for a first implementation we will take a few hypothesis in order to limit the scope:
- The export is done based on a tracker report (as for the document generation)
- The feature is provided by DocGen plugin
- There is an hard limit of 3 in the depth of analyzed links (Current report -> 1st level of link -> 2nd level of link)
- By default only level 1 is proposed and exporter can choose to add a 2nd level dynamically
- At each level (User Stories -> Test Case Level 1 -> Test Exec Level 2, Risk -> Mitigation Level 1 -> Evidence Level 2, ...):
- One tracker can be selected and, optionally a link type
- For the given tracker, a report should be selected. The report will drive:
- The search criteria to further limit the selection of artifacts (the selected artifacts will be the linked one + any other criteria that applies in the report)
- Exported columns by field types:
- string
- text
- text: as is
- mardkwon: as is
- html: stripped
- date, submitted_on, last_update_date
- float
- int
- computed
- artifact id
- per tracker id
- submitted_by & last_update_by
- lists (select box, multi select box, radio button, checkbox, open list, shared fields): as comma separated. no decorators. Users are rendered by their username
- priority
- Only "forward links" are taken into account
Note. Not all reports can be proposed. Proposed reports must:
- Have only one table render (might have other renders like graphs)
- This table renderer has at least one column
About not covered field types:
- Files: no possibility to include file contents in the xlsx dans metadata seems worthless on their own
- Cross references: don't know how to render
- Links: export already takes links into account + don't know how to render.
- Burndow, burnup: don't know how to render
- Permissions on artifact: don't know how to render
- Steps and Step results: don't know how to render
- Containers (Columns & co): doesn't make sense to render
- Static (br, text, etc): doesn't make sense to render
- Encrypted field: R U Serious ?
Proposal
Figma prototype
At Tracker Report level, there is an option un "Export" dropdown to generate a cross tracker report.
This option opens a popup that allow to select:
- The 2nd level Tracker (any tracker, any project)
- The 3rd level Tracker (any tracker, any project)
Once validated, this will generate an xlsx report as attached (3 level export.xlsx):
- The artifacts are repeated at each line
Given A -> B -> {C, D} we will generate:
| A | B | C |
| A | B | D |
About the fields/columns:
- Supported fields are the fields already covered by TestPlan (ie all fields that can be represented in xlsx)
- Special column "links" (with types & formatting) are not exported because there is a functional overlap with this feature. If there is a need for this column, we should wait for the use case.
- When it's a text field that contains HTML, the HTML is stripped.
- There is no means to do proper formatting of the output so the generated document is meant to be tidied up by hand (styling, colors, etc).