Skip to content

Commit

Permalink
Docs for project attributes (including Project overview and new Proje…
Browse files Browse the repository at this point in the history
…cts admin menu) (#15345)

* Added docs for admin side of project attributes

Also changed the structure to represent changes to the Admin menu. Still need to add images.

* Typos/minor

* Updated docs re: Project Overview page

* Minor/typos

* Added docs for project settings

* Update docs/system-admin-guide/custom-fields/custom-fields-projects/README.md

* project attributes docs update

* project attributes docs changes

* fixing links in docs

* update

* link fix

---------

Co-authored-by: Maya Berdygylyjova <MayaBerd@users.noreply.github.com>
  • Loading branch information
psatyal and MayaBerd committed Apr 23, 2024
1 parent 362a579 commit 0233891
Show file tree
Hide file tree
Showing 30 changed files with 234 additions and 112 deletions.
2 changes: 1 addition & 1 deletion docs/glossary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ Versions in OpenProject are defined as an attribute for [work packages](#work-pa

### Widget

A widget in OpenProject is defined as a small and customizable element that provides relevant information at a glance. Use widgets on your [My Page](#my-page) dashboard or on the [project overview](#project-overview). [See all available project overview widgets](../user-guide/project-overview/#available-project-overview-widgets) and read [how to add a widget to the project overview](../user-guide/project-overview/#add-a-widget-to-the-project-overview).
A widget in OpenProject is defined as a small and customizable element that provides relevant information at a glance. Use widgets on your [My Page](#my-page) dashboard or on the [project overview](#project-overview). [See all available project overview widgets](../user-guide/project-overview/#available-project-overview-widgets) and read [how to add a widget to the project overview](../user-guide/project-overview/#widgets).

### Wiki

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,57 +5,10 @@ sidebar_navigation:
description: Custom fields for projects.
keywords: custom fields for projects, show custom fields
---
# Manage and display custom fields in the project list (Enterprise add-on)
# Custom fields for projects

As a user of [OpenProject Enterprise on-premises](https://www.openproject.org/enterprise-edition/) or [OpenProject Enterprise cloud](https://www.openproject.org/enterprise-edition/#hosting-options) you can customize the work package list and show additional project information by adding custom fields to the project list, e.g. adding accountable, project due date, progress, and more.
As a user of [OpenProject Enterprise on-premises](https://www.openproject.org/enterprise-edition/) or [OpenProject Enterprise cloud](https://www.openproject.org/enterprise-edition/#hosting-options) you can customize work package lists and show additional project information by adding custom attributes to project lists, e.g. adding accountable, project due date, progress, and more.

## Create a custom field for projects

To create a new custom field for projects, navigate to -> *Administration* -> *Custom fields* and select the tab **Project**.
Click on the link **Create a new custom field** to create a project custom field.

![Sys-admin-create-custom-field-projects](Sys-admin-create-custom-field-projects.png)

1. In the newly opened create form provide a **name** to display in the project list (e.g. Project ID).
2. Choose a **format** for the custom field, e.g. List. Decide if you want to the custom field to allow multi-select.
3. **Enter the possible values** which can be selected (for a list). This is not relevant if you choose e.g. text format.
4. Define if the custom field should be **required**.
5. If you check **visible** it will also be visible for all users (non-admins) in the project overview and displayed in the project details widget on the [Project Overview](../../../user-guide/project-overview/).
6. Define if the custom field for projects should be **searchable**.
7. Click **Save** to create the custom field.

![project_custom_field_create](project_custom_field_create-1952858.png)

## Populate a project custom field

Once you created the custom field you can set a value for it in the [project settings](../../../user-guide/projects/project-settings/).

To do this navigate to a project and select *Project settings* from the side menu. The project custom field is visible under *Information*. As a project manager you can populate or edit the project custom field.

![Sys-admin-custom-fields-project-settings](Sys-admin-custom-fields-project-settings.png)



## Display project custom fields



If you selected *Visible* in the custom fields settings, the custom field for projects is also available in the [View all projects](../../../user-guide/projects/project-lists/) overview.

Navigate to this project list by selecting *View all projects* from the project selection menu on the top left side.

![Sys-admin-view-all-projects](Sys-admin-view-all-projects-1579704910470.png)

In the list of all projects you will see the project custom fields displayed as a columns in the project list. Therefore, you can easily communicate project information across multiple projects.

![Sys-admin-display-project-custom-field](Sys-admin-display-project-custom-field.png)

> **Please note**: The visibility settings of the project custom fields will be overruled by [these settings](../../system-settings/project-system-settings/#settings-for-the-projects-overview-list) for the projects overview list.
To change the **order of the project custom fields' columns**, change it in -> *Administration* -> *Custom fields* by using the sorting **arrows**.

![image-20201007163002544](image-20201007163002544.png)



Furthermore, the project custom fields will also be displayed in the Project details widget on the [project overview page](../../../user-guide/project-overview/).
>**Important**: Starting with version 14.0, project custom fields are called "project attributes". Please refer to our [user guide on project attributes](../../../user-guide/project-overview) for more information.
>
>If you are an administrator and wish to configure project attributes, please refer to our [admin guide on project attributes](../../projects/project-attributes).
18 changes: 18 additions & 0 deletions docs/system-admin-guide/projects/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
sidebar_navigation:
title: Project settings
priority: 100
description: Adjusting settings for projects in your instance, including defaults for new projects, project attributes and project lists.
keywords: project settings, project attributes, project lists, configuration, new projects
---
# Project settings

The **Projects** page lets you configure settings for projects in your instance, including default settings for new projects, project attributes and project lists.

>**Note:** These settings moved from *Administration → System settings → Projects* to now *Administration → Projects* in version 14.0.
| Topic | Content |
| ---------------------------------------- | ------------------------------------------------------------ |
| [Project attributes](project-attributes) | Viewing, creating and modifying project attributes in OpenProject |
| [New project](new-project) | Choose which modules are enabled by default for new projects and what roles are given to non-admin users who create a project |
| [Project lists](project-lists) | Define which project attributes should be visible as columns in the cross-project global project lists and Gantt views |
22 changes: 22 additions & 0 deletions docs/system-admin-guide/projects/new-project/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_navigation:
title: New project
priority: 200
description: Choose which modules are enabled by default for new projects and the role given to non-admin users who create a project
keywords: new project, settings, default, modules
---

# New project

To set defaults for new projects, navigate to **Administration settings****Projects****New project**.

![New project settings in OpenProject adminstration](open_project_system_guide_new_project_settings.png)

You will find the following options on this page:

**New projects are public by default**: Check this option to make new projects public by default when they are created. If this is unchecked, all new projects will be private by default and will have to be marked as public manually.

- **Default enabled modules for new projects:** The checked modules will be enabled by default when a new project is created. Project admins can enable or disable specific modules later.
- **Role given to a non-admin users who creates project**: The default role you want to assign *in the project* to the user that created it (if this user is not an instance admin). By default, the default role is 'Project admin'.

Once you make your modifications, click on **Save** to apply the settings instance-wide.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
91 changes: 91 additions & 0 deletions docs/system-admin-guide/projects/project-attributes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
sidebar_navigation:
title: Project attributes
priority: 300
description: Viewing, creating and modifying project attributes in OpenProject
keywords: project attributes, create, project settings
---

# Project attributes (Enterprise add-on)

> **Please note:** Project attributes are an Enterprise add-on and will only be displayed here for Enterprise on-premises and Enterprise cloud.
Project attributes are custom fields that allow you to communicate key information relevant to a project in the [Project Overview](../../../user-guide/project-overview) page.

>**Note**: Prior to version 14.0, these were called "project custom fields" and described under the [Custom fields](../../custom-fields/custom-fields-projects/) page. Starting with 14.0, there is now a new entry in the administration section called 'Project attributes' under 'Projects'.
This page describes how to create, order and group project attributes and is directed at instance administrators. If you want know how to enable and set the values for project attributes at a project level, please refer to the [Project Overview](../../../user-guide/project-overview) page of the user guide.

## View project attributes

To view all existing project attributes, navigate to **Administration settings****Projects****Project attributes**.

![List of existing project attributes in OpenProject administration](open_project_system_admin_guide_project_attributes_list.png)

Each project attribute will be displayed in individual rows, which contain:

![OpenProject project attribute explained](open_project_system_guide_project_attribute_explained.png)

1. The drag handle
2. The project attribute name
3. Format
4. Number of projects using the attribute
5. More button

Attributes may also be contained in [sections](#sections).

## Create a project attribute
To create a new project attribute, click on the **+ Project attribute** button in the top right corner.

This will display the "New attribute" form with these options:

![Create a new attribute form in OpenProject adminstration](open_project_system_guide_project_attributes_new_attribute.png)

- **Name**: This is the name that will be visible in the [Project Overview](../../../user-guide/project-overview) page.

- **Section:** If there are sections, you can pick where this new project attribute should appear. [Learn about sections](#sections) for more information.

- **Format**: You can pick from nine different types of fields: text, long text, integer, float, list, date, boolean, user and version.

> **Note**: You cannot change this once the project attribute is created.
- **Format options:** Depending on the type you choose, you might have additional options, such as minimum and maximum width, default value or regular expressions for validation.

- **Required**: Checking this makes this project attribute a required field in projects where it is enabled, i.e. it cannot be left empty.

- **Visible**: Checking this field makes the attribute visible to non-admins.

> **Note**: This is enabled by default. Only disable this if you want this field to be invisible to non-admin users.
- **Searchable**: Checking this makes this project attribute (and its value) available to the search engine and filters.


## Modify project attributes

You can edit existing attributes under **Administration settings****Projects****Project attributes**.

![Edit or move a project attribute in the OpenProject administration](open_project_system_admin_guide_project_attributes_more_icon_menu.png)

Click on the More icon to the right of each project attribute to edit, re-order or delete a project attribute.

>**Note:** Deleting a project attribute will delete it and the corresponding values for it from all projects.
You can also use the drag handles to the left of each project attribute to drag and drop it to a new position.

>**Note**: Project admins can chose to enable or disable a project attribute from their project, but they cannot change the order. The order set in this page is the order in which they will appear in all projects.

## Sections

You can group project attributes into sections to better organise them.

You can click on more icon to the right of each section to rename it, delete it or change its order.

> **Note**: A section can only be deleted if no project attributes were assigned to it.
You can drag any existing project attribute into a section to move it there. You may also drag and drop entire sections up and down to re-order them.

>**Note:** If a project attribute belongs to a section, it will be displayed within that section in _all_ projects.
![Edit project attribute sections in OpenProject administration](open_project_system_admin_guide_project_attributes_section_more_icon_menu.png)

Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions docs/system-admin-guide/projects/project-lists/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
sidebar_navigation:
title: Project lists
priority: 100
description: Define which project attributes should be visible as columns in the cross-project global project lists and Gantt views
keywords: project attributes, project lists, columns, gantt
---

# Project lists

OpenProject lets users access Project lists, which allow them to get an overview of all projects to which they have access. This page describes how to modify the columns displayed in each project list. For more information on using project lists, read our [user guide on Project lists](../../../user-guide/projects/project-lists).

To configure project lists, navigate to **Administration settings****Projects****Project lists**.

![Project lists in OpenProject administration](open_project_system_guide_projects_project_lists.png)

## Modify and add columns

Here, you can view a list of *chips*, or little rectangles with names of project attributes. Each one represents a column in the Project list tables. You can drag and drop these around to change the order in which they appear.

To add a new project attribute as a column, click on the field with the label **Add columns** (where it says *Select a column*). You will be shown a list of existing project attributes. You can type in a keyword to search through this list and find the project attribute you would like to add.

## Project portfolio Gantt view

OpenProject lets users view a list of projects as a Gantt chart. You can edit the default query that is used to display this Gantt chart by clicking on the **Edit query** link. This displays a modal that lets you modify the visible the columns, filters, sort order and other view configuration options.

![Work package table configuration in OpenProject administration](open_project_system_guide_projects_project_lists_gannt_query.png)
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions docs/system-admin-guide/system-settings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ To modify these settings, navigate to **Administration → System settings**.

## Overview

| Topic | Content |
| ---------------------------------- | :----------------------------------------------------------- |
| [General](general-settings) | How to configure general system settings, e.g. a welcome text block on the application landing page, attachment size, and much more. |
| [Languages](languages) | How to configure languages. |
| [Project](project-system-settings) | Settings for new projects. |
| [Repositories](repositories) | How to integrate SVN or GIT repositories. |
| Topic | Content |
| ---------------------------- | :----------------------------------------------------------- |
| [General](general-settings) | How to configure general system settings, e.g. a welcome text block on the application landing page, attachment size, and much more. |
| [Languages](languages) | How to configure languages. |
| [Project](../projects) | Settings for new projects. |
| [Repositories](repositories) | How to integrate SVN or GIT repositories. |

This file was deleted.

Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ No, only Administrators can update other Administrators attributes like name or

### Can I set a default role for a user that creates a new project?

You can set a [default role](../../system-settings/project-system-settings/#settings-for-new-projects) that users with this permission will have in a project they created.
You can set a [default role](../../projects/new-project) that users with this permission will have in a project they created.

### Users do not see the action *Create project* in the main navigation even though they have the create project permission?

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Both the Community edition and Enterprise edition allow you to create an unlimit

</div>

Within a project Modules can be activated and deactivated under "Modules" in the project settings menu by project members who have sufficient permissions to adjust project settings. Which modules or single functionalities will be available within projects is controlled in the global Administration settings (please see [System admin guide](../system-admin-guide/system-settings/project-system-settings/) to see how this is done).
Within a project Modules can be activated and deactivated under "Modules" in the project settings menu by project members who have sufficient permissions to adjust project settings. Which modules or single functionalities will be available within projects is controlled in the global Administration settings (please see [System admin guide](../system-admin-guide/projects) to see how this is done).

Please choose the module or feature you want to learn more about.

Expand Down
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 0233891

Please sign in to comment.