Project attributes
Project attributes are custom fields shown on the Project home page. They allow you to communicate key information relevant to a project.
Nota
Prior to version 14.0, these were called “project custom fields” and described under the Custom fields page. Starting with 14.0, they are referred to as project attributes.
This page describes how instance administrators can create, order, and group project attributes, and assign them to projects. For instructions on editing project attribute values within a project, see the Project home page.
View project attributes
To view all existing project attributes, navigate to Administration settings → Projects → Project attributes.
Project attributes are organized into sections. Each attribute row contains:
- Drag handle
- Project attribute name
- Format
- Number of projects using the attribute
- More button
An empty section will display a button to add a project attribute.
Sections
At least one section must exist before project attributes can be created.
To add a section:
- Click + Add in the top right corner.
- Select Section.
Name the section and save it.
Each section includes a location selector defining where it appears on the Project home page:
- Side panel — Shows the section and its attributes in the right-hand panel.
- Main area — Shows the section and its attributes as a widget in the central area.
Use the More menu on the right side of the section header to rename, delete, or reorder a section.
Consejo
A section can only be deleted if it contains no attributes.
Attributes can be dragged between sections. Entire sections can be reordered via drag and drop. Use the drag and drop handle to the left of the section name.
Consejo
Attributes always appear in the section they are assigned to across all projects.
Create a project attribute
To create a new project attribute, click on the + Add button in the top right corner, select Project attribute and select the project attribute format from the list of available options.
Importante
You cannot change the project attribute format once the project attribute is created.
You can pick from multiple project attribute formats. Depending on the chosen format, you can define additional parameters, such as minimum and maximum width, default value or regular expressions for validation.
This is an example of new project attribute with a format List.
-
Name: This is the name that will be visible in the Project home page, if the custom field is activated on that project.
-
Section: If there are sections, you can pick where this new project attribute should appear. Learn about sections for more information.
-
Allow multi-select: Allows the user to assign multiple values to this custom field.
-
Possible values: Add, define, arrange or remove possible values for this project attribute.
-
Required: Checking this enables this project attribute and makes it required for all projects. It cannot be deactivated at a project level. Existing projects will not require a value when being updated.
Importante
Project attributes of type Boolean and Calculated value can NOT be set to be required.
-
For all projects: Mark the attribute as available in all existing and new projects.
-
Admin-only: If you enable this, the project attribute will only be visible to administrators. All other users will not see it, even if it is activated in a project.
-
Searchable: Checking this makes this project attribute (and its value) available as a filter in project lists.
Once you create a project attribute, you can enable it for specific projects and define help text.
Project attribute formats
There are multiple format options for project attributes in OpenProject. You can select one of the following formats:
- Boolean - creates a project attribute, that is either true or false. It is represented by a checkbox that can be checked or unchecked.
- Calculated value (Enterprise add-on) - creates a project attribute that enables automatic computations based on formulas using numeric project attributes, for example from Weighted item lists.
- Date - creates a project attribute, which allows selecting dates from a date picker.
- Float - creates a project attribute for rational numbers.
- Hierarchy (Enterprise add-on) - creates a project attribute, which allows selecting one or multiple items from a hierarchical list structure. The structure can be created in the Items tab of the project attribute.
- Integer - creates a project attribute for integers.
- Link (URL) - creates a project attribute for URLs.
- List - creates a project attribute with flat list options.
- Text - creates a project attribute in text format with the specified length restrictions.
- Long text - creates a project attribute for cases where longer text needs to be entered.
- User - creates a project attribute, which allows selecting users that are allowed to access the entity containing the project attribute.
- Version - creates a project attribute, which allows selecting one or multiple versions. Versions are created on the project level in Backlogs module.
- Weighted item list (Enterprise add-on) - creates a project attribute similar to the Hierarchy type, but with underlying numerical values used for project evaluation (e.g., calculated values project attributes. Please keep in mind that weighted item lists custom fields can’t be used as multi-select.
Hierarchy project attribute (Enterprise add-on)
Project attributes of the Hierarchy type function in the same way as work package custom fields of the Hierarchy type. For detailed information, please refer to Work package custom fields documentation.
Weighted item list project attribute (Enterprise add-on)
Weighted item list project attributes function similarly to the Hierarchy type. They let you define a structured list of items arranged in a hierarchy for users to choose from.
To set up a project attribute of the Weighted item list type, follow the same procedure as when adding a standard project attribute and select the Weighted item list option.
Adding and modifying items within a weighted item list works in the same way as for a hierarchy project attribute.
In contrast to Hierarchy, items in a weighted item list do not include a Short value but instead require a Weight.
This numeric value is required and can be used in calculations — for example, within a project attribute of type Calculated value
Calculated value project attribute (Enterprise add-on)
Calculated values enable automatic computations based on formulas using numeric project attributes, including scores from Weighted item lists or even other calculated values. The computed result is displayed directly on the project overview and in the project list. It automatically updates whenever one of its source attributes (e.g., Benefit or Effort in the example below) is changed. This allows teams to calculate project scores and prioritise consistently across the portfolio.
To set up a project attribute of the Calculated value type, follow the same procedure as when adding a standard project attribute and select the Calculated value option. Define the name, section it will appear in and the calculation formula.
In the example below, a project attribute called Initiative score (calculated) is determined by this formula: (Strategic fit * 0.4) + ( User benefit* 0.4) - (Effort * 0.2).
Modify project attributes
You can edit existing attributes under Administration settings → Projects → Project attributes.
Click on the More icon to the right of each project attribute to edit, re-order or delete a project attribute.
Advertencia
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.
Nota
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.
Enable project attributes
Under Administration settings → Projects → Project attributes select the More menu and select Edit or simply clicking on the name of the project attribute. This will open a detailed view of the project attribute you selected.
The Details tab will allow you to edit the name, section and visibility.
The Enabled in projects tab will show a list of all the projects this project attributes was activated in.
You can remove a project attribute from a specific project by selecting the More menu at the end of the line and clicking the Remove from project option.
To add this project attribute to a specific project click the +Add projects button. A modal will appear allowing you to search for projects to add this project attribute into. Please note that the projects in which the project attribute is already activated will be shown disabled in that selection. You can include subprojects.
Nota
It is not possible to add or remove a project attribute, if a project attribute is set to be required.
Define project attribute help text
To define field caption and help text click on a project attribute and navigate to Attribute help text tab. Here you can define the following:
- Caption - a short text that will be displayed as project attribute caption to provide context.
- Help text - a longer text that will be shown when a user hovers over a question mark next to the project attribute name. Here you can provide more detailed explanation. This is a required field.
- Attachments - attach files or images to illustrate a project attribute.
Importante
Any text and images you add here will be publicly visible to all logged in users.
