# Epic AUTOWORK-283 - Project-specific values for custom fields (Contextualization of custom fields)

Project: Stream Workflows & Automations
Status: in development
URL: https://community.openproject.org/work_packages/AUTOWORK-283

## Detailed specification

### Motivation and background information

**Context:** Custom fields are freely definable fields that teams can use to add their own information to work packages, such as story points, a due date, or a supplier. Currently in OpenProject, custom fields can be assigned to projects and work package types, but their available options and default values are shared globally across all types. This creates friction for teams that need different option sets depending on project and/or work package type. Within Jira Data Center custom field contexts can be scoped to specific issue types and/or projects.

Examples:

  - The field customer might have different set of options in each project.

  - A cost center field might only offer the cost centers that belong to each project.

<br>

\----------

**Current Scope**

  - **V1:** Choose **which values** of a custom field of type hierarchy **can be used in which project**. The **global admin controls** this.

  - **V2:** The **project admin** with the right permission can see the global list and **can turn off / turn on values for their projects**, available globally. The **global list is managed by the global admin only**.

  - **V3:** **Project admins** with the right permission can **add new values in their project**, these **values stay project-specific**. Only the global admin can add them to the global list.

**Not included in this scope:**

  - Visibility and edit rights (differentiated permissions for who can see/edit the fields)

  - Archiving (marking used selection items as no longer selectable while keeping them in the system) <mention class="mention" data-id="80336" data-type="work_package" data-text="#AUTOWORK-299" data-display-id="AUTOWORK-299">\#AUTOWORK-299</mention> 

  - API-Administration: Setting Values via an API <mention class="mention" data-id="80277" data-type="work_package" data-text="#AUTOWORK-297" data-display-id="AUTOWORK-297">\#AUTOWORK-297</mention>

  - Adding items after initial setup (adding further selection items at the project level post-launch), planned for V3, not included in V1 or V2

  - Type-level configuration (configuring custom fields at the work package type level -\> different EPIC)

\---------

**Use cases**

**V1**

**Use Case 1: One global list of values**  
Global admins maintain one list of values (with sub-items) for a custom field and decide which projects use it.  
Example: The global admin creates the custom field Cost center with all cost centers of the company and adds it to the projects Alpha and Beta.

**Use Case 2: Choose which values each project can use**  
Global admins decide per custom field whether all projects see the same values, or whether each project only sees selected values. Users in a project can only pick the values available in their project.  
Example: Project Alpha only sees the cost centers 1000 to 1999, project Beta only 2000 to 2999. A user in Alpha cannot pick a cost center of Beta.

**V2**

**Use Case 3: Project admins adjust the selection for their project**  
With a permission given by the global admin, project admins see the global list and turn values on or off for their project, within the limits the global admin set.  
Example: The project admin of Alpha turns off cost center 1500 because the team no longer uses it. Users in Alpha no longer see 1500, other projects are not affected.

**V3**

**Use Case 4: Global admins define the framework**  
Global admins create the custom field and decide which projects can use it. They don’t maintain the values of each project.  
Example: The global admin creates the custom field Component and adds it to all projects of a department. Each project fills it with its own components.

**Use Case 5: Project admins create and maintain their own values**  
With a permission given by the global admin, project admins create, rename and remove values (including sub-values) for their project and set a default value. Users in the project only see and pick these values.  
Example: The project admin of Alpha adds the components Frontend and Backend, with Backend \> Database as a sub-value, and sets Frontend as default.

**Use Case 6: Project values stay in the project**  
Values created in a project are only visible in that project. Other projects cannot see them unless the global admin turns them into global values.  
Example: The value Database created in project Alpha does not appear in project Beta or in the global list.

**Use Case 7: Global admins turn a project value into a global value**  
Global admins can turn a value that was created in a project into a value of the global list.  
Example: Project Alpha created the value Database. Project Beta needs it too. The global admin turns Database into a global value. Database is now part of the global list.

**Jobs to be done**

  - **Global admin:** I want to keep one list of values for a certain hierarchy custom field in one place. I also want to decide which projects use the field and which values each project can use. Then I only maintain the list once, and every project only sees what it needs.

  - **Project admin:** I want to turn off / turn on values my project should or should not use, so my team has only relevant options to choose from.

  - **End user:** When I set a value on a work package, I only want to see the values that fit my project. Then I can find the right one fast and make fewer mistakes.
    
    <br>

**User Stories V1**

1.  As a global admin, I want to create and maintain one list of values (with sub-items) for a custom field, so that all projects use the same source. Projects can only turn values from this list on or off. They cannot create their own values.

2.  As a global admin, I want to choose in which projects a custom field (with all its values) is used.

3.  As a global admin, I want to choose which values from the custom field (only specific values) each project can use.

4.  As a global admin I want to decide per custom field if a new value is automatically active in all projects that use it, so that confidential values are not visible in projects that shouldn't see them.

**User Stories V2**

1.  As a global admin, I want to control with a permission whether project admins are allowed to turn values off, so that I decide who can change the selection.

2.  As a project admin with this permission, I want to see the full global list of values so that I can reuse existing values.

3.  As a project admin with this permission, I want to deselect some of the values my project got or select some additional ones from the global list, so that my team only sees the values that matter.

**User Stories V3**

1.  As a project admin with the right permission, I want to add new values to the custom field in my project.

2.  As a project admin, I want the values I add to stay in my project only, so other projects are not affected.

3.  As a project admin, I want my project-specific values to stay available after the global admin changes the custom field settings, so that my team's data does not disappear.

4.  As a global admin, I want to turn a project-specific value into a global value, so that other projects can use it without creating it again

**Oout of scope: User Stories V4 -Archiving of values is specified in** <mention class="mention" data-id="AUTOWORK-299" data-type="work_package" data-text="#AUTOWORK-299">#AUTOWORK-299</mention>

1.  As a global admin I would like to archive certain values, which should not be selected anymore, so that the users see only current data. The archived values should be still visible within filters for a historical reporting purposes.

**To clarify:**

  - If project and type restrictions conflict (a value is active at the project level but inactive at the type level, or vice versa), which one wins?

  - When an admin (and later, project) disables a value that is already used in that project:
    
      - Allow it, and show in activity tab:
        
          - "{Custom field name}: {value name} removed"
        
          - \[open\] Here, we would expose the name of the removed value. We don't do this yet. Are we okay doing this?

<br>

| Attribute | Value |
| --- | --- |
| Mockups | https://www.figma.com/design/oTMDTvcwrx35qExTkkSKBn/Custom-fields?node-id=2862-5733 |

## Planning

| Attribute | Value |
| --- | --- |
| Roadmap | 2027 Q1 |
| Date |  |
| Votes | 2 |
| List | RM Jira exit |
| Target versions |  |
| Sprint |  |
| Backlog bucket |  |
| Relevance | Showstopper — Go-Live Blocker |

## Subitems

| ID | Type | Subject | Status | Assignee | Target versions | Project | Priority | Spent time |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| AUTOWORK-303 | Feature | Implement Allow-list approach for customizing List, Hierarchy and Weighted fields | tested |  | 18.0.0 | Stream Workflows & Automations | Medium |  |
| AUTOWORK-339 | Feature | Implement Block-list approach for customizing List, Hierarchy and Weighted fields | tested |  | 18.0.0 | Stream Workflows & Automations | Medium |  |
| AUTOWORK-302 | Feature | Combine hierarchy and list into a single "List custom field" | needs review | Klaus Zanders | 18.1.0 | Stream Workflows & Automations | Medium |  |
| AUTOWORK-304 | Feature | Add permission to allow project administrators to contextualize custom fields | review approved |  | 18.1.0 | Stream Workflows & Automations | Medium |  |
| AUTOWORK-387 | Feature | Rename "Items" tab to "Values" for consistent semantics | merged |  | 18.1.0 | Stream Workflows & Automations | Medium |  |
| AUTOWORK-301 | Feature | Admin UI for contextualization of list/hierarchy custom fields | in development | Klaus Zanders |  | Stream Workflows & Automations | Medium |  |
| AUTOWORK-313 | Open Point | How do we refer to fields that offer project-level contextualisation? | resolved |  |  | Stream Workflows & Automations | Medium |  |
| AUTOWORK-378 | Open Point | What happens to project specific values, when the setting is turned off? | decided |  |  | Stream Workflows & Automations | Medium |  |
| AUTOWORK-382 | Implementation | Build database flags for project specific items | closed |  |  | Stream Workflows & Automations | Medium |  |

## Bugs and other work packages

| ID | Type | Subject | Status | Assignee | Target versions | Module |
| --- | --- | --- | --- | --- | --- | --- |
| AUTOWORK-380 | Code maintenance | Prepare Hierarchy Items to properly work with project specific values | closed |  | 18.0.0 |  |
| AUTOWORK-401 | Bug | Cost Queries do not restrict custom field list/hierarchy options according to block-/allowlist | merged |  | 18.0.0 | Administration / Custom fields, Modules and project features / Costs and budgets |
| AUTOWORK-394 | Bug | Global administrators see all options in normal project contexts | merged |  | 18.0.0 |  |
| AUTOWORK-405 | Code maintenance | Move Hierarchy Item management to our regular services | closed |  | 18.1.0 |  |
| AUTOWORK-378 | Open Point | What happens to project specific values, when the setting is turned off? | decided |  |  |  |
| AUTOWORK-313 | Open Point | How do we refer to fields that offer project-level contextualisation? | resolved |  |  |  |
| AUTOWORK-298 | Design Task | Clarify design architecture for v1 | in progress | Parimal Satyal |  |  |

## Details

| Attribute | Value |
| --- | --- |
| Module | Administration / Custom fields / Hierarchy, Administration / Custom fields |
| Labels |  |

## People

| Attribute | Value |
| --- | --- |
| Assignee | Sonita Soth |
| Accountable | Rosanna Sibora |
| Product manager | Sonita Soth |
| Feature Lead | Klaus Zanders |
| Designer | Parimal Satyal |
| Developers | OP Dev Sirius Team, Klaus Zanders |
| Requested by |  |
| Interest by | Black (37919), Bowling (40324), Home (224196000003952096) |

## Estimates and progress

| Attribute | Value |
| --- | --- |
| Work | 90d 0h · Σ 90d 0h |

## Description

**Summary**

Global admins keep one list of values for a custom field and decide which values each project can use. Later, project admins can adjust the selection for their project and add their own values. Users only see the values that fit their project.

<br>
