[DOCU-820] Wp form configuration update https://community.openprojec… (#23513)
* [DOCU-820] Wp form configuration update https://community.openproject.org/wp/DOCU-820 [DOCU-820] Wp form configuration update https://community.openproject.org/wp/DOCU-820 * [DOCU-820] Wp form configuration update https://community.openproject.org/wp/DOCU-820 [DOCU-820] Wp form configuration update https://community.openproject.org/wp/DOCU-820 * update * update --------- Co-authored-by: Maya Berdygylyjova <MayaBerd@users.noreply.github.com>
@@ -3,7 +3,7 @@ sidebar_navigation:
|
||||
title: Types
|
||||
priority: 800
|
||||
description: Configure work package types in OpenProject.
|
||||
keywords: work package types
|
||||
keywords: work package types, work package form, related work package, work package table, relations, pdf export, automatic subject
|
||||
---
|
||||
|
||||
# Manage work package types
|
||||
@@ -27,7 +27,7 @@ Click the green **+ Type** button to add a new work package type in the system,
|
||||
1. Give the new work package type a **name** that easily identifies what kind of work should be tracked.
|
||||
2. Choose a **color** from the drop-down list which should be used for this work package type in the Gantt chart. You can configure new colors [here](../../colors).
|
||||
3. You can **copy a [workflow](../work-package-workflows)** from an existing type.
|
||||
4. You can enter a **default text for the work package description field**, which always be shown when creating new work package from this type. This way, you can easily create work package templates, e.g. for risk management or bug tracking which already contain certain required information in the description.
|
||||
4. You can enter **default text for the work package description field**, which always be shown when creating new work package from this type. This way, you can easily create work package templates, e.g. for risk management or bug tracking, that already contain certain required information in the description.
|
||||
5. Choose whether the type should be a **milestone**, e.g. displayed as a milestone in the Gantt chart with the same start and finish date.
|
||||
6. Choose whether the type should be displayed in the [roadmap](../../../user-guide/roadmap/) by default.
|
||||
7. Select if the work package type should be **active in new projects by default**. This way work package types will not need to be [activated in the project settings](../../../user-guide/projects/project-settings/work-packages/#work-package-types) but will be available for every project.
|
||||
@@ -37,41 +37,39 @@ Click the green **+ Type** button to add a new work package type in the system,
|
||||
|
||||
## Work package form configuration (Enterprise add-on)
|
||||
|
||||
You can freely **configure the attributes shown** for each work package type to decide which attributes are shown in the form and how they are grouped.
|
||||
You can customize the work package form for each work package type to display the attributes most relevant to your team's workflow. Attributes can be added, removed, and arranged within the form as needed.
|
||||
|
||||
> [!NOTE]
|
||||
> Following parts of the Work package form configuration are an Enterprise add-on:
|
||||
>
|
||||
>- **Add new attribute groups**
|
||||
> - **Rename attribute groups**
|
||||
> - **Add table of related work packages to a work package form**
|
||||
In the Enterprise edition, you can also create and rename sections and add a related work packages table.
|
||||
|
||||
[feature: edit_attribute_groups ]
|
||||
|
||||
To configure a type, first select the type from the list of types (see above) and select the tab **Form configuration**.
|
||||
To configure the work package form for a type, navigate to **Administration → Work packages → Types**, select a type, and open the **Form configuration** tab.
|
||||
|
||||
Active attributes shown in blue color on the left will be displayed in the work package form for this type.
|
||||
You can then decide for each attribute which group it should be assigned to (using drag and drop or removing it by clicking the remove icon). You can also rename attribute groups simply by clicking on their name or re-order attribute groups with drag and drop.
|
||||
The form preview on the right shows the attributes that are currently displayed when creating or editing work packages of this type. Attributes are organized into sections.
|
||||
|
||||
Inactive attributes shown in the grey color on the right. Attributes which have been removed are shown in the **Inactive** column on the right. This column also includes [custom fields](../../custom-fields) which have been created. The custom fields also can be added with drag and drop to the active form (the blue part on the left) to be displayed in the form.
|
||||
On the left side are all available attributes and [custom fields](../../custom-fields) that are not currently used in the form. You can filter them using the search field.
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> Starting with OpenProject 15.0, when adding new custom fields to a type through the form configuration, the added custom fields will not automatically be enabled in all projects that have this work package type currently enabled.
|
||||
To customize the form:
|
||||
|
||||
To add additional group, click the **+ Group** button and select **Add attribute group**. Give the new group a name. You can then assign attributes (e.g. custom fields) via drag and drop. Note that adding attribute groups is only possible with the [OpenProject Enterprise on-premises](https://www.openproject.org/enterprise-edition/) and the [OpenProject Enterprise cloud](https://www.openproject.org/enterprise-edition/#hosting-options).
|
||||
- Add attributes and custom fields by dragging them from the left side into the desired section.
|
||||
- Remove attributes from the form using the **(...)** menu next to the attribute.
|
||||
- Reorder attributes and sections using drag and drop or the available move options from the **(...)** menu.
|
||||
- Rename sections using the **(...)** menu.
|
||||
|
||||
In case you made a mistake, click the **Reset to defaults** button to reset all settings to the original state.
|
||||
|
||||
Finally, **save** the settings to apply them.
|
||||
> [!NOTE]
|
||||
> If you use custom fields, remember that they must also be activated for the relevant projects before they can be used.
|
||||
|
||||

|
||||
|
||||
If you then create a new work package of this type, the input form will have exactly these attributes selected in the form configuration.
|
||||
To add a new section, click **+ Add** and select **Section**. Enter a name for the section and then drag attributes into it.
|
||||
|
||||
In this case, all attributes in the blue area on the left are displayed under the corresponding attribute group.
|
||||
To add a related work packages table, click **+ Add** and select **Related work packages table**.
|
||||
|
||||

|
||||
If you want to restore the default form layout for this type, click **Reset form**. This resets the entire form configuration, including all sections and attribute assignments.
|
||||
|
||||

|
||||
|
||||
Changes are saved automatically. Users creating or editing a work package of this type will see the form exactly as configured.
|
||||
|
||||
Watch the following video to see how you can customize your work packages with custom fields and configure the work package forms:
|
||||
|
||||
@@ -79,41 +77,47 @@ Watch the following video to see how you can customize your work packages with c
|
||||
|
||||
## Add table of related work packages to a work package form (Enterprise add-on)
|
||||
|
||||
Also, you can add a table of related work packages to your work package form. Click the green **+ Group** button and choose **Add table of related work package** from the drop-down list.
|
||||
You can add a related work packages table to your work package form. Click the **+ Add** button and select **Related work packages table**.
|
||||
|
||||
[feature: work_package_query_relation_columns ]
|
||||
|
||||

|
||||
|
||||
Now, you can configure which related work packages should be included in your embedded list, e.g. child work packages or work packages related to this work package, and more. Then you can configure how the list should be filtered, grouped, etc. The configuration of the work package table can be done according to the [work package table configuration](../../../user-guide/work-packages/work-package-table-configuration/).
|
||||
You can configure which related work packages should be displayed in the table, for example child work packages or work packages with a specific relation type. You can also define how the table is filtered, grouped, sorted, and displayed. Configure the table in the same way as a regular [work package table](../../../user-guide/work-packages/work-package-table-configuration/).
|
||||
|
||||
Click the green **Apply** button to add this work package list to your form.
|
||||
When you have finished configuring the table, click **Apply** to add it to the form.
|
||||
|
||||

|
||||

|
||||
|
||||
The embedded related work package table in the work package form will look like this. Here, the work packages with the chosen relation will be shown automatically (based on the filtered criteria in the embedded list) or new work packages with this relation can be added.
|
||||
The related work packages table is then displayed directly in the work package form. It automatically shows work packages that match the configured relation and filters. Users can also create new related work packages directly from the table.
|
||||
|
||||

|
||||

|
||||
|
||||
## Work package automatic subject configuration (Enterprise add-on)
|
||||
|
||||
[feature: work_package_subject_generation ]
|
||||
|
||||
Please refer to [this guide](automatic-subjects) for a detailed description of automatically generated work packages subjects in OpenProject.
|
||||
Please refer to [this guide](automatic-subjects) for a detailed description of automatically generated work package subjects in OpenProject.
|
||||
|
||||
|
||||
## Activate work package types for projects
|
||||
|
||||
Under *Administration -> Work packages -> Types* on the tab **Projects** you can select for which projects this work package type should be activated.
|
||||
Under **Administration → Work packages → Types**, open the **Projects** tab to select for which projects a work package type should be activated.
|
||||
|
||||
The **Activated for new projects by default** setting in the Types will only activate this type for new projects. For existing projects, the type needs to be activated manually.
|
||||
This can be also configured in the [project settings](../../../user-guide/projects/project-settings).
|
||||
The **Enabled for new projects by default** setting (which can be selected when creating or editing a work package type) only activates the type for newly created projects. It does not activate the type for existing projects.
|
||||
|
||||
For existing projects, work package types can also be activated manually in the [project settings](../../../user-guide/projects/project-settings). There, work package types can be enabled or disabled on a per-project basis.
|
||||
|
||||
To activate a work package type for all projects, enable the **Enable for all projects** switch.
|
||||
|
||||
If **Enable for all projects** is disabled, a list of projects is displayed. Select the projects for which the work package type should be available and click **Save**.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
## Activate templates for PDF exports
|
||||
|
||||
Under the **Generate PDF** tab of *Administration -> Work packages -> Types* you can select which templates from currently available ones should be enabled for the PDF export of this specific type.
|
||||
Under the **Generate PDF** tab of **Administration -> Work packages -> Types**, you can select which PDF export templates are available for this work package type.
|
||||
|
||||
The template determines the design and attributes visible in the exported PDF of a work package using this type. The first template on the list is selected by default.
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 25 KiB |
|
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 38 KiB |
|
After Width: | Height: | Size: 28 KiB |
|
After Width: | Height: | Size: 28 KiB |
|
After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 48 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 119 KiB |