Skip to content

Commit

Permalink
[#58110] 14.6 Documentation: Enable a custom field for multiple proje… (
Browse files Browse the repository at this point in the history
#16855)

* [#58110] 14.6 Documentation: Enable a custom field for multiple projects at once  https://community.openproject.org/work_packages/58110

[#58110] 14.6 Documentation: Enable a custom field for multiple projects at once

https://community.openproject.org/work_packages/58110

* Apply suggestions from code review

Co-authored-by: dominic-braeunlein <[email protected]>

---------

Co-authored-by: dominic-braeunlein <[email protected]>
  • Loading branch information
MayaBerd and dominic-braeunlein authored Oct 8, 2024
1 parent 18cf051 commit af1e830
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 10 deletions.
20 changes: 16 additions & 4 deletions docs/system-admin-guide/custom-fields/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,30 @@ Depending on the module, for which the new custom field is being created, sligh

> [!IMPORTANT]
>
> Custom fields need to be activated per work package type and per project. Work package custom fields are only visible when two conditions are met:
> Custom fields need to be activated per work package type and added to a project. Work package custom fields are only visible when two conditions are met:
>
> 1. Custom field has been added to the work package type (form configuration).
> 2. Custom field is activated for the project.
1. [Assign a custom field to a work package type](../manage-work-packages/work-package-types/#work-package-form-configuration-enterprise-add-on) (Form configuration). You can do this directly via the link in the custom field overview.
### Assign a custom field to a work package type (Enterprise add-on)

You can [assign a custom field to a work package type](../manage-work-packages/work-package-types/#work-package-form-configuration-enterprise-add-on) (form configuration) directly via the link in the custom field overview.

![Add a custom field to a work package type](system-admin-add-field-to-wp-type.png)

2. Activate the custom field for a project in the [project settings](../../user-guide/projects/project-settings/custom-fields/). This is not relevant if the setting **For all projects** has been configured for the custom field.
### Add a custom field to one or multiple projects

You can activate the custom field for specific projects under the respective [project settings](../../user-guide/projects/project-settings/custom-fields/).

>[!TIP]
>This is not relevant if the setting **For all projects** has been configured for the custom field.
You can active a custom field for multiple projects at once by opening the custom field in question and selecting the *Projects* tab. Click the **Add projects** button.
![Add a custom field to multiple projects at once in OpenProject administration](openproject_system_guide_new_custom_field_add_to_projects.png)

Use the search field to identify the projects and select multiple projects at once. You can also include the sub-projects by checking the respective option. Click the **Add** button to active the custom fields in all of the selected projects.

With these additional settings, you have absolute freedom which custom fields are relevant for your projects and types. You can customize only those types that are relevant and create a whole set of custom attributes for your work packages.
![](openproject_system_guide_new_custom_field_add_to_projects_search.png)

## Edit or remove a custom field

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,9 @@ Yes, this is possible. When you edit existing work packages for which the custom
## Where do custom fields for document categories show up?

You can find them when navigating to *Administration -> Enumerations* and clicking on an existing document category (or creating a new one).

## Can I activate custom fields for multiple projects at the same time?

Yes, you can. Select the custom field and use the **Add projects** button to add it to multiple projects at the same time.


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.
22 changes: 16 additions & 6 deletions docs/user-guide/projects/project-settings/custom-fields/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,30 @@ keywords: custom fields, activate work package custom field
---
# Enable custom fields in projects

**Custom fields for work packages can be activated or deactivated in a project**.
Custom fields for work packages can be activated or deactivated under project settings.

<div class="glossary">
**Custom fields** are defined as additional attribute fields which can be added to existing attribute fields. The different sections that can use custom fields are work packages, spent time, projects, versions, users, groups, activities (time tracking), and work package priorities.
</div>

**Please note:** The instructions in this section *only* apply to custom fields for work packages.

Before you can enable a custom field it needs to be created in the [system administration](../../../../system-admin-guide/custom-fields). Afterwards, open the respective project and go to -> *Project settings* -> *Custom fields*.
> [!NOTE]
> The instructions in this section *only* apply to custom fields for work packages.
Before you can enable a custom field, it needs to be created in the [system administration](../../../../system-admin-guide/custom-fields). Afterwards, open the respective project and go to *Project settings* -> *Custom fields*.

1. Manage the custom field by clicking on the name.

2. **Select if the custom fields shall be enabled in the project**. If enabled globally in the custom fields settings in the system administration, it will automatically be displayed in all projects.

3. View the work package types for which the custom field is already enabled. Only for the displayed types the custom field will be active. You can add the custom field to additional work package types by [adding them to the respective work package form](../../../../system-admin-guide/manage-work-packages/work-package-types/#work-package-form-configuration-enterprise-add-on).
4. **Create a new custom field** with the green + Custom field button. You have to be a system administrator in order to create new custom fields.
5. Press the blue **Save** button to confirm your changes.

![User-guide_project-settings-custom-fields](User-guide_project-settings-custom-fields.png)
4. **Create a new custom field** by clicking the **+ Custom field** button.

> [!TIP]
>
> Keep in mind that you have to be a system administrator in order to create new custom fields.
5. Press the **Save** button to confirm your changes.

![Custom fields settings in OpenProject project settings](openproject_user_guide_projects_project_settings_custom_fields.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit af1e830

Please sign in to comment.