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

[#58113] 14.6 Documentation: Progress reporting changes https://comm… #16869

Merged
Merged
Show file tree
Hide file tree
Changes from 12 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
17 changes: 9 additions & 8 deletions docs/system-admin-guide/manage-work-packages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ Manage work packages in OpenProject.

## Overview

| Popular Topics | Description |
| ----------------------------------- | :----------------------------------------------------------- |
| [Settings](work-package-settings) | Configure general work package settings and defaults, such as display options and more. |
| [Types](work-package-types) | Create and manage work package types. |
| [Status](work-package-status) | Create and manage work package status. |
| [Workflows](work-package-workflows) | Create and manage workflows for work packages in OpenProject. |
| [Custom actions](custom-actions) | Create custom actions for work packages (Enterprise add-on). |
| [FAQs](work-packages-faq) | Frequently asked questions about work packages in OpenProject. |
| Popular Topics | Description |
| --------------------------------------------------- | :----------------------------------------------------------- |
| [Settings](work-package-settings) | Configure general work package settings and defaults, such as display options and more. |
| [Types](work-package-types) | Create and manage work package types. |
| [Status](work-package-status) | Create and manage work package status. |
| [Progress tracking](work-package-progress-tracking) | Manage work package progress reporting settings. |
| [Workflows](work-package-workflows) | Create and manage workflows for work packages in OpenProject. |
| [Custom actions](custom-actions) | Create custom actions for work packages (Enterprise add-on). |
| [FAQs](work-packages-faq) | Frequently asked questions about work packages in OpenProject. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---

sidebar_navigation:
title: Progress tracking
priority: 965
description: Manage Work package progress tracking.
keywords: work package progress tracking, percentage complete, % complete
---

# Manage work package progress tracking

To manage the settings for progress tracking in work packages, navigate to *Administration* → *Work packages* → *Progress tracking*.

![Progress tracking settings under OpenProject administration](openproject_system_guide_progress_tracking_settings.png)

## Progress calculation mode
*Progress calculation mode* lets you select between *work-based* and *status-based* modes.

- **Work-based mode**: *% Complete* is either set manually or is automatically calculated based on *Work* and *Remaining work*, if they exist. Please refer to [progress tracking user guide](../../../user-guide/time-and-costs/progress-tracking/#work-based-progress-reporting) for more details and calculation examples.
- **Status-based mode**: you will have to define fixed % Complete values for each [work package status](../work-package-status), which will update automatically when team members update the status of their work packages.

> [!NOTE]
> When switching progress calculation mode from one to another, you will see a warning message.
>
> - Changing progress calculation mode from work-based to status-based will result in all existing *% Complete* values to be lost and replaced with values associated with each status. Existing values for *Remaining work* may also be recalculated to reflect this change. This action is not reversible.
>
> - Changing progress calculation mode from status-based to work-based will make the *% Complete* field freely editable. If you optionally enter values for *Work* or *Remaining work*, they will also be linked to *% Complete*. Changing *Remaining work* can then update *% Complete*.

![Warning message when changing progress calculation mode in OpenProject administration](openproject_system_guide_progress_tracking_settings_warning_message.png)

## Calculation of % Complete hierarchy totals

*Calculation of % Complete hierarchy totals* lets you determine how the values of the *% Complete* will be calculated in work package hierarchies.

- **Weighted by work**: The total *% Complete* will be weighted against the *Work* of each work package in the hierarchy. Work packages with no *Work* values are not included into the calculation.

- **Simple average**: The total *% Complete* is calculated by averaging the *% Complete* values of all work packages, regardless of their *Work* values. *Work* is not factored into the calculation.

## % Complete when status is closed

*% Complete when status is closed* lets you chose what happens to % Complete when you close a work package (even in the work-based mode).

- **No change** - if you select this option, the value of *% Complete* will not change even when a work package is closed.
- **Automatically set to 100%** - if you select this option, work package will be considered complete when closed.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,12 @@ To change basic settings for work package tracking in OpenProject, navigate to *
You can adjust the following:

1. **Allow cross-project work package relations**, i.e. that work packages created in one project can have relations to work packages in another project, for example parent-children work packages.

2. **Display subprojects work packages in main projects** by default. This way the work packages of subprojects will always be visible in the main project if a user has the corresponding role in the subproject to see work packages.

3. **Use current date as start date for new work packages**. This way the current date will always be set as a start date if your create new work packages. Also, if you copy projects, the new work packages will get the current date as start date.

4. **Progress calculation** lets you pick between two modes for how the **% Complete** field is calculated for work packages.
- **Work-based**: % Complete is automatically calculated based on Work and Remaining work values for that work package, both of which are then necessary to have a value for % Complete.

- **Status-based**: you will have to define fixed % Complete values for each [work package status](../work-package-status), which will update automatically when team members update the status of their work packages.

> [!NOTE]
> When switching progress calculation mode from one to another, you will see a warning message.
>
> - Changing progress calculation mode from work-based to status-based will result in all existing *% Complete* values to be lost and replaced with values associated with each status. Existing values for *Remaining work* may also be recalculated to reflect this change. This action is not reversible.
>
> - Changing progress calculation mode from status-based to work-based will make % Complete a non-editable field whose value is derived from Work and Remaining work. Existing values for % Complete are preserved. If values for Work and Remaining work were not present, they will be required in order to change % Complete.

![Warning message when changing progress calculation mode in OpenProject administration](openproject_system_guide_work_package_settings_warning.png)



5. **Default highlighting mode** (Enterprise add-on) defines which should be the default [attribute highlighting](../../../user-guide/work-packages/work-package-table-configuration/#attribute-highlighting-enterprise-add-on) mode, e.g. to highlight the following criteria in the work package table. This setting is only available for Enterprise on-premises and Enterprise cloud users.
4. **Default highlighting mode** (Enterprise add-on) defines which should be the default [attribute highlighting](../../../user-guide/work-packages/work-package-table-configuration/#attribute-highlighting-enterprise-add-on) mode, e.g. to highlight the following criteria in the work package table. This setting is only available for Enterprise on-premises and Enterprise cloud users.

![default highlighting mode](openproject_system_guide_default_highlighting_mode.png)

6. Customize the appearance of the work package lists to **define which work package attributes are displayed in the work package lists by default and in what order**.
5. Customize the appearance of the work package lists to **define which work package attributes are displayed in the work package lists by default and in what order**.

Do not forget to save your changes with the green **Save** button at the bottom.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading