Content
View differences
Updated by Andrej Sandorf over 1 year ago
**As a** project member
**I want to** have different export options
**so that** I can configure the export to my specific needs.
### **Acceptance criteria**
* User selects the file format of the export:
* **PDF**
* **XLS**
* **CSV**
* When selecting **PDF** the user can choose the export type:
* **Table:** exports the table view itself.
* Users being able to choose which columns to be displayed in the table, excluding long text fields. The pre-selected attributes are the ones in the query.
* **Report:** exports a detailed report of each work package in the view:
* Users being able to choose (and order) which query columns to be displayed in the attributes table, excluding long text fields. The pre-selected columns are the ones in the query. query.
* Users being able to choose (and order) which long text custom fields are displayed below the attribute table. Pre-selected attributes are all available.
* **Gantt:** exports the Gantt view itself with the first column being the work package subject, type, ID, status and, start and end dates.
* PDF Gantt export is an Enterprise add-on therefore for Community users is displayed in a disabled way and with the Enterprise icon.
* Users can choose the page size, the zoom level on the date scale and the column width.
* When selecting **XLS** the user can choose the export type:
* Users being able to choose (and order) which query columns to be displayed in the table, excluding long text fields. The pre-selected attributes are the ones in the query.
* Users can choose to include relations or not.
* Users can choose to include the description as raw markdown/html column.
* When selecting **CSV** the user can choose the export type:
* Users being able to choose which query columns to be displayed in the table, excluding long text fields. The pre-selected attributes are the ones in the query.
* Users can choose to include the description as raw markdown/html column.
* Once the user clicks on the "Export" button the user will see:
* 1st a loading state with the title "Work packages are being exported" and a description "One moment please, this might take some time..."
* 2nd the resolution of the export being:
* Success: with the title "Export completed", the description "The download should start automatically. Or, click here to download." and, a checkbox to save the export settings as part of the query for the next export. Also, a button to close the modal is displayed. _(note: displayed. _(note: checkbox implementation was moved to ###57388_
_**NOTE:** In **PDF** the automatically downloaded file must opened in a separate tab._
* Error: with the title "Something went wrong", the description "An error has occurred while trying to export the work packages. For PDF tables with too many columns the error is specified in the description.
**Note**: Most of the requirements above describe current features. These are additional new features/changes besides the modal itself:
* Column selection of the Query can be overwritten in the export modal
* Long text fields included in the PDF Report can be selected (and ordered)
* Atom is removed from the export modal
### Open points
* [x] Are we deleting the **RSS Atom** export? _We work with the assumption that we remove it._
* [x] Is the term "Zoom dates" clear in the **PDF Gantt**? _We've updated the term to "Zoom level"._
### Figma and visuals
[https://www.figma.com/file/n0uj7NMxC4Q2nAzMyhdBXF/Export-work-packages-table?type=design&node-id=0-1&mode=design](https://www.figma.com/file/n0uj7NMxC4Q2nAzMyhdBXF/Export-work-packages-table?type=design&node-id=0-1&mode=design)
### **Out of Scope**
* Formatting options: Having a frontend to configure the PDF.
* Borders
* Icons
* Font sizes
* Colors
* Do we want to include the long text fields by default in the **PDF table**, **XLS** and **CSV** exports? _Yes it should be possible to include long texts for each of them._
* Selection of long text fields for table based ecports (custom or description)
* Saving the last preferences
**I want to** have different export options
**so that** I can configure the export to my specific needs.
### **Acceptance criteria**
* User selects the file format of the export:
* **PDF**
* **XLS**
* **CSV**
* When selecting **PDF** the user can choose the export type:
* **Table:** exports the table view itself.
* Users being able to choose which columns to be displayed in the table, excluding long text fields. The pre-selected attributes are the ones in the query.
* **Report:** exports a detailed report of each work package in the view:
* Users being able to choose (and order) which query columns to be displayed in the attributes table, excluding long text fields. The pre-selected columns are the ones in the query.
* Users being able to choose (and order) which long text custom fields are displayed below the attribute table. Pre-selected attributes are all available.
* **Gantt:** exports the Gantt view itself with the first column being the work package subject, type, ID, status and, start and end dates.
* PDF Gantt export is an Enterprise add-on therefore for Community users is displayed in a disabled way and with the Enterprise icon.
* Users can choose the page size, the zoom level on the date scale and the column width.
* When selecting **XLS** the user can choose the export type:
* Users being able to choose (and order) which query columns to be displayed in the table, excluding long text fields. The pre-selected attributes are the ones in the query.
* Users can choose to include relations or not.
* Users can choose to include the description as raw markdown/html column.
* When selecting **CSV** the user can choose the export type:
* Users being able to choose which query columns to be displayed in the table, excluding long text fields. The pre-selected attributes are the ones in the query.
* Users can choose to include the description as raw markdown/html column.
* Once the user clicks on the "Export" button the user will see:
* 1st a loading state with the title "Work packages are being exported" and a description "One moment please, this might take some time..."
* 2nd the resolution of the export being:
* Success: with the title "Export completed", the description "The download should start automatically. Or, click here to download." and, a checkbox to save the export settings as part of the query for the next export. Also, a button to close the modal is displayed. _(note:
_**NOTE:** In **PDF** the automatically downloaded file must opened in a separate tab._
* Error: with the title "Something went wrong", the description "An error has occurred while trying to export the work packages. For PDF tables with too many columns the error is specified in the description.
**Note**: Most of the requirements above describe current features. These are additional new features/changes besides the modal itself:
* Column selection of the Query can be overwritten in the export modal
* Long text fields included in the PDF Report can be selected (and ordered)
* Atom is removed from the export modal
### Open points
* [x] Are we deleting the **RSS Atom** export? _We work with the assumption that we remove it._
* [x] Is the term "Zoom dates" clear in the **PDF Gantt**? _We've updated the term to "Zoom level"._
### Figma and visuals
[https://www.figma.com/file/n0uj7NMxC4Q2nAzMyhdBXF/Export-work-packages-table?type=design&node-id=0-1&mode=design](https://www.figma.com/file/n0uj7NMxC4Q2nAzMyhdBXF/Export-work-packages-table?type=design&node-id=0-1&mode=design)
### **Out of Scope**
* Formatting options: Having a frontend to configure the PDF.
* Borders
* Icons
* Font sizes
* Colors
* Do we want to include the long text fields by default in the **PDF table**, **XLS** and **CSV** exports? _Yes it should be possible to include long texts for each of them._
* Selection of long text fields for table based ecports (custom or description)
* Saving the last preferences