Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#57588] 14.5 Documentation: Work packages export modal with settings… #16657

Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/user-guide/gantt-chart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,15 +188,17 @@ To export a Gantt chart in a PDF format click the **More** (three dots) icon in

![Export Gantt chart option in OptionProject](openproject-user-guide-gantt-charts-export.png)

Then select the **PDF Gantt** option.
Then select the **PDF Gantt** option under PDF export type. Configure the parameters of the PDF export, such as zoom level for the dates, column width and paper size. Then click the green **Export** button.

![Gantt chart export options in OpenProject](openproject-user-guide-gantt-pdf-gantt-icon.png)
![Gantt chart export options in OpenProject](openproject-user-guide-export-gantt-chart.png)

Configure the parameters of the PDF export, such as zoom level for the dates, column width and paper size. Then click the green **Export** button.

![Configure PDF Gantt export in OpenProject](openproject-user-guide-gantt-pdf-gantt-options.png)
You can then save the Gantt chart in PDF form to share with your project stakeholders or print it directly.

You can now save the Gantt chart in PDF form to share with your project stakeholders or print it directly.
> ![TIP]
>
> You can also export Gantt charts in PDF format from the [work packages module](../work-packages/exporting/#gantt-chart-pdf).

## Gantt chart views

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 50 additions & 22 deletions docs/user-guide/work-packages/exporting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,79 +24,105 @@ This will open a dialog where you can select the desired format. Click on one of

All work packages that are included in the work package table in the currently selected view will be exported, unless a certain export limit has been defined by the instance administrator. The limit can be changed in the [work package settings](../../../system-admin-guide/system-settings/general-settings/#general-system-settings) in the system administration. Newly created instances have a maximum of 500 work packages set as a limit by default.

> **Note**: PDF export options includes all of the work packages in the selected work package table, regardless of the limit. The possible export limit is relevant for XLS, CSV and Atom export options.
> [!NOTE]
> PDF export options includes all of the work packages in the selected work package table, regardless of the limit. The possible export limit is relevant for XLS, CSV and Atom export options.
MayaBerd marked this conversation as resolved.
Show resolved Hide resolved

**Columns**

The exported file will display the columns that are activated for the work package table. By adding or removing specific columns you can control the columns that will be included into the exported file. Please make sure to [save the work package view](../work-package-table-configuration/#save-work-package-views) you configured for the changes to be included into the report.
You can choose which columns will to be displayed in the table (excluding long text fields) and change their order. The pre-selected columns are the ones in the work package table query. Learn how to [save the work package view](../work-package-table-configuration/#save-work-package-views).

Some formats such as PDF will limit the number of columns available due to limitations of the PDF rendering engine to avoid overflowing the available space.

## Export format options

OpenProject has multiple options of exporting work packages, including PDF, XLS, CSV and Atom. See below what each format entails.
OpenProject has multiple file format options for exporting work packages, including PDF, XLS and CSV. See below what each format entails.

## PDF export

OpenProject has multiple options of exporting work packages in PDF format.
OpenProject has multiple options of exporting work packages in PDF format. These include table, report and Gantt chart.

### PDF Table

PDF Table exports the work package table displaying work packages as single rows with the selected columns for the work package table. Work packages IDs are linked to the respective work packages. Clicking on a work package ID will lead you directly to the work package in OpenProject.

![OpenProject PDF Table export](openproject_pdf_table_export.png)

> [!TIP]
>
> If ["display sums" is activated](../work-package-table-configuration/) in the work package table, then the sum table is included at the bottom of the exported work package table.

### PDF Report

With PDF Reports you can export detailed up to date work plans for your project in a clean and practical format. It includes a title page, a table of contents (listing all of the work packages), followed by the description of single work packages in a block form. Table of contents is clickable and is linked to the respective pages within the report, making navigation much easier.

For each work package a table of attributes is included, where attributes correspond to the columns in the work package table. For a single work package export, attributes are displayed according to the work package form configuration.
![Define a PDF report for OpenProject work packages export](openproject_pdf_export_report_options.png)

For each work package a table of attributes is included, where attributes correspond to the columns you specified for the export. For a [single work package export](#export-single-work-packages), attributes are displayed according to the work package form configuration.

Table of attributes is followed by the work package description and if necessary custom long text fields, which support [embedded work package and project attributes](../../wysiwyg/#attributes).

> **Note**: Embedding of rich text, e.g. descriptions of other work package, is currently not supported.
> [!NOTE]
> Embedding of rich text, e.g. descriptions of other work package, is currently not supported.

![OpenProject_pdf_report_export](openproject-pdf-export-work-plans.png)

> **Note**: If ["display sums" is activated](../work-package-table-configuration/) in the work package table, then the sum table is included between table of contents and work packages description in an Overview section.
> [!TIP]
> If ["display sums" is activated](../work-package-table-configuration/) in the work package table, then the sum table is included between table of contents and work packages description in an Overview section.

![OpenProject_work_package_table_sum](openproject_wp_table_total_sum.png)

![OpenProject_pdf_report_sum](openproject_wp_report_total_sum.png)

### PDF Report with images

PDF Report with images is the same as PDF Report, but also includes the images from the work package description.
If you select the **Include images** option, your PDF Report will include the images from the work package description.

> **Note**: Images attached or linked in the work package Files section or in the Activity comments are not included into the PDF Report with images.
![Include images in OpenProject work packages export](openproject_wp_report_include_images_checked.png)

> [!NOTE]
> Images attached or linked in the work package Files section or in the Activity comments are not included into the PDF Report with images.

![OpenProject_work_package_export](openproject_pdf_report_images.png)

> **Note**: if you need to export work packages in a Gantt chart form, please refer to the [Gantt chart PDF Export guide](../../gantt-chart/#gantt-chart-pdf-export-enterprise-add-on).
### Gantt chart PDF

> [!NOTE]
> Gantt chart PDF export is an Enterprise add-on and can only be used with [Enterprise cloud](../../../enterprise-guide/enterprise-cloud-guide) or [Enterprise on-premises](../../../enterprise-guide/enterprise-on-premises-guide). An upgrade from the free Community edition is easy and helps support OpenProject.

You can export Gantt charts directly from the work packages module by selecting the respective option, or from the Gantt charts module by doing the same.

![Gantt chart PDF export in OpenProject](openproject_pdf_export_report_gantt_chart_options.png)

For more information on using the Gantt chart module and Gantt exports, please refer to the [Gantt chart PDF Export guide](../../gantt-chart/#gantt-chart-pdf-export-enterprise-add-on).

## Excel (XLS) export

> **Note**: To open XLS exported files into Microsoft Excel, ensure you set the encoding to UTF-8. Excel will not auto-detect the encoding or ask you to specify it, but simply open with a wrong encoding under Microsoft Windows.
> [!TIP]
> To open XLS exported files into Microsoft Excel, ensure you set the encoding to UTF-8. Excel will not auto-detect the encoding or ask you to specify it, but simply open with a wrong encoding under Microsoft Windows.

OpenProject can export the table for Microsoft Excel with the following options:

### XLS

**XLS** is a plain sheet that matches the OpenProject work packages table with its columns and work packages as rows matching the selected filter(s).

![Work package export in Excel form in OpenProject](openproject_pdf_export_report_excel_options.png)

In **XLS** format export you can manage and reoder columns that should be included, as well as decided if relations and descriptions should be included into the report.

![OpenProject_work_package_export_excel](openproject_export_excel.png)

### XLS with descriptions

**XLS with descriptions** is same as above, but with an additional column for work package descriptions, which cannot be selected in the table.
If you activate the **Include descriptions** option, an additional column will be included into the report, showing work package descriptions.

![OpenProject_work_package_export_excel_description](openproject_pdf_table_export_description.png)
![OpenProject_work_package_export_excel_description](openproject_export_excel_with_descriptions.png)

### XLS with relations

**XLS with relations** same as **XLS**, but with additional columns to list each work package relation in a separate row with the relation target and its ID and relation type included in the export.
If you activate **Include relations** option, additional columns to list each work package relation in a separate row will be included in the report. It will include the relation target and its ID and relation type

![OpenProject_work_package_export_excel_relations](openproject_pdf_table_export_relations.png)
![OpenProject_work_package_export_excel_relations](openproject_export_excel_with_relations.png)

### Limitations

Expand All @@ -109,9 +135,16 @@ The OpenProject XLS export currently does not respect all options in the work pa

OpenProject can export the table into a comma-separated CSV. This file will be UTF-8 encoded.

> **Note**: To open CSV exported files into Microsoft Excel, ensure you set the encoding to UTF-8. Excel will not auto-detect the encoding or ask you to specify it, but simply open with a wrong encoding under Microsoft Windows.
![Export work packages in CSV format in OpenProject](openproject_pdf_report_csv_options.png)

> [!TIP]
> To open CSV exported files into Microsoft Excel, ensure you set the encoding to UTF-8. Excel will not auto-detect the encoding or ask you to specify it, but simply open with a wrong encoding under Microsoft Windows.

![OpenProject work package CSV export](openproject_export_csv.png)

![OpenProject_work_package_export_csv](openproject_export_csv.png)
If you select the **Include descriptions** option, work package description field will be included into the export.

![OpenProject work package CSV export with descriptions](openproject_export_csv_with_descriptions.png)

### Limitations

Expand All @@ -120,11 +153,6 @@ The OpenProject CSV export currently does not respect all options in the work pa
- The order of work packages in a manually sorted query is not respected. This is known limitation ([Ticket](https://community.openproject.org/projects/openproject/work_packages/34971/activity)).
- The hierarchy of work packages as displayed in the work package view. The exported CSV is always in "flat" mode.

## Atom (XML) export

OpenProject can export the table into a XML-based atom format. This file will be UTF-8 encoded.

![OpenProject_work_package_export_atom](openproject_export_atom.png)

## Export single work packages

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.