# Epic SSI-8 - Automatically generated work package subjects

Project: Stream Storage Integrations
Status: closed
URL: https://community.openproject.org/work_packages/SSI-8

## Detailed specification

### Motivation and background information

### Acceptance criteria

### Out of scope

*   Automatic file naming

| Attribute | Value |
| --- | --- |
| Mockups | https://www.figma.com/design/I2IVNb97j1fNNCs32H6p2m/Automatic-generated-subjects?node-id=0-1 |

## Planning

| Attribute | Value |
| --- | --- |
| Roadmap |  |
| Date | 2025-02-19 – 2025-03-26 |
| Votes |  |
| List |  |
| Target versions | 16.0.0 |
| Relevance |  |

## Subitems

| ID | Type | Subject | Status | Assignee | Target versions | Project | Priority | Spent time |
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
| SSI-196 | Feature | Define subject patterns in work package type settings | closed |  | 16.0.0 | Stream Storage Integrations | Medium |  |
| SSI-197 | Feature | Prevent editing of subject on work package creation and update | closed |  | 16.0.0 | Stream Storage Integrations | Medium |  |
| SSI-198 | Feature | Block users from editing managed subjects of work packages in table views | closed |  | 16.0.0 | Stream Storage Integrations | Medium |  |
| SSI-202 | Feature | Add enterprise banner to subject configuration | closed |  | 16.0.0 | Stream Storage Integrations | Medium |  |
| SSI-246 | Feature | Validate subject pattern | closed |  | 16.0.0 | Stream Storage Integrations | Medium |  |
| OP-16607 | Feature | Allow adding "short path" of CF hierarchy item to subject pattern | new |  | Wish List | OpenProject | Medium |  |
| SSI-218 | Feature | Allow admin to trigger selectively generation of subjects on work packages of a certain type | in specification |  | Wish List | Stream Storage Integrations | Medium |  |
| SSI-166 | Open Point | How to handle work package creation when attributes are not available on creation? | decided |  |  | Stream Storage Integrations | Medium |  |
| SSI-167 | Open Point | When are subjects updated? | decided |  |  | Stream Storage Integrations | Medium |  |
| SSI-168 | Open Point | If pattern changes, should old work packages subjects be changed too? | new |  |  | Stream Storage Integrations | Medium |  |
| SSI-172 | Open Point | What happens when values of attributes are missing? | decided |  |  | Stream Storage Integrations | Medium |  |
| SSI-173 | Open Point | Should we allow parent references? | decided |  |  | Stream Storage Integrations | Medium |  |
| SSI-174 | Open Point | Should the settings page be primerized? | decided |  |  | Stream Storage Integrations | Medium |  |
| SSI-175 | Open Point | What kind of pattern validation will the input have? | decided |  |  | Stream Storage Integrations | Medium |  |
| SSI-191 | Open Point | Define representation of attributes by data type | needs clarification |  |  | Stream Storage Integrations | Medium |  |
| SSI-192 | Open Point | Should "Automatically generated work package subjects" be an enterprise feature? | decided | Niels Lindenthal |  | Stream Storage Integrations | Medium |  |
| SSI-200 | Open Point | Define list of attributes | decided |  |  | Stream Storage Integrations | Medium |  |
| SSI-201 | Feature | Warn user with danger zone when enabling managed subjects | on hold |  |  | Stream Storage Integrations | Medium |  |
| SSI-250 | Open Point | What should the final name of this feature be? | new |  |  | Stream Storage Integrations | Medium |  |

## Bugs and other work packages

| ID | Type | Subject | Status | Assignee | Target versions | Module |
| --- | --- | --- | --- | --- | --- | --- |
| SSI-247 | Bug | Input starts within existing subject pill when adding a new attribute | closed |  | 15.4.0 |  |
| SSI-243 | Bug | Unclear error when cf that was added as an attribute does not belong to wp configuration form | closed |  | 15.4.0 |  |
| SSI-239 | Bug | Subject field stays editable in create work package form after switching to a type that has automatically generated subjects | closed |  | 15.4.0 |  |
| SSI-238 | Bug | Adding custom field of the work package itself to subject pattern not possible (only for parents) | closed |  | 15.4.0 |  |
| SSI-294 | Bug | Project in automatic subject is resolved to the id | closed |  | 16.0.0 |  |
| SSI-276 | Documentation | Automatic subjects - Admin guide | closed |  | 16.0.0 |  |
| SSI-275 | Documentation | Automatic subjects - User guide | closed |  | 16.0.0 |  |
| SSI-268 | Bug | Cannot inline create a WP with auto generated subject when no other attribute is a required field | closed |  | 16.0.0 |  |
| SSI-252 | Bug | Autocompleter dropdown in pattern input is missing default entry | closed |  | 16.0.0 |  |
| SSI-256 | Bug | Can't close the dropdown on Subject pattern by clicking outside | confirmed |  | Wish List | Modules and project features / Documents |
| SSI-248 | Bug | Parent custom fields can be added to subject pattern but prevent the WP creation  | closed |  |  |  |
| SSI-171 | Open Point | Can we have optional attributes? | rejected |  |  |  |
| SSI-170 | Open Point | What symbol to use to mark placeholders / macros e.g. "{{" ? | rejected |  |  |  |
| SSI-200 | Open Point | Define list of attributes | decided |  |  |  |
| SSI-192 | Open Point | Should "Automatically generated work package subjects" be an enterprise feature? | decided | Niels Lindenthal |  |  |
| SSI-175 | Open Point | What kind of pattern validation will the input have? | decided |  |  |  |
| SSI-174 | Open Point | Should the settings page be primerized? | decided |  |  |  |
| SSI-173 | Open Point | Should we allow parent references? | decided |  |  |  |
| SSI-172 | Open Point | What happens when values of attributes are missing? | decided |  |  |  |
| SSI-167 | Open Point | When are subjects updated? | decided |  |  |  |
| SSI-166 | Open Point | How to handle work package creation when attributes are not available on creation? | decided |  |  |  |
| SSI-267 | Bug | Subject pattern autocompleter search doesn't ignore special characters | confirmed |  |  | Modules and project features / Documents |
| SSI-191 | Open Point | Define representation of attributes by data type | needs clarification |  |  |  |
| SSI-250 | Open Point | What should the final name of this feature be? | new |  |  |  |
| SSI-168 | Open Point | If pattern changes, should old work packages subjects be changed too? | new |  |  |  |

## Details

| Attribute | Value |
| --- | --- |
| Module |  |
| Enterprise plan | Enterprise / Professional (PRO) |
| Labels |  |

## People

| Attribute | Value |
| --- | --- |
| Assignee |  |
| Accountable | Dominic Bräunlein |
| Product manager |  |
| Feature Lead |  |
| Designer | Marc Alcobé |
| Developers | OP Dev Titan Team |
| Requested by |  |
| Interest by |  |

## Estimates and progress

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

## Description

# User problem

## User

  - **Admins:** Want to enforce specific naming conventions for certain work package types (e.g., invoices, vacation requests).

  - **Project Members:** Need consistent titles to identify and process specific work packages.

## Problem

  - Currently, users can input any title for a work package, leading to inconsistencies. For certain types of work packages e.g. invoices or vacation requests, admins want predefined title patterns to maintain uniformity and avoid errors. These patterns must include relevant attributes (e.g., author name, project name, date) but are not enforced in the current system.

#### Example

  - The user creates a work package of type VACATION REQUEST
    
      - This is needed for internal documentation of employee vacations
    
      - The user needs to enter a subject for the work package according to a specific pattern
    
      - At the same time the attributes needed to compose the subject are required anyway to further process the request

## Pain

  - Patterns are applied inconsistently, and updates to patterns are not reflected in existing titles.

  - Users must rely on verbal or written instructions to apply patterns, which may not always be accurate or up to date.
    
    <br>

## Solution

  - **Subject Patterns for Work Package Types**
    
      - Admins can define title composition rules for specific work package types via a settings page.
    
      - The Admin can search and select attributes or add free text in the input field.
        
          - The options are shown as flat drop down list
        
          - The options are current work package attributes and project attributes
        
          - Project attributes do have the prefix "Project" e.g. "Project name"
    
      - List of available attributes: <mention class="mention" data-id="59921" data-type="work_package" data-text="#59921">\#59921</mention> 
    
      - **Proposed UI to define subject pattern:**
        
        <img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/248646/content">

  - **Enforced Subjects**
    
      - Subjects for these specific types are automatically generated and read-only.
    
      - The user should get appropriate feedback via tooltip why the subject is not editable.

  - **Dynamic Updates**
    
      - Subject updates automatically when a work package is updated.
    
      - When project attributes there will be no automatic update of the subject.
    
      - Remark: In a future iteration there should be a bulk update on project or instance level

  - **Configuration Location**
    
      - Patterns are set under the work package type settings in the tab "Subject configuration" (`/types/:id/edit/settings`).
        
        <br>

# Launch and Growth

## Measures

  - Increase in consistency for specific work package types.

  - Reduction in user errors when creating work package titles.

  - Feedback from admins on ease of setup and usage.

## Messaging

<figure class="table op-uc-figure_align-center op-uc-figure"><table class="op-uc-table"><tbody><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head" style="width:150px;"><p class="op-uc-p">Headline</p></th><td class="op-uc-table--cell"><p class="op-uc-p">Take control of work package subjects</p></td></tr><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">First Paragraph</p></th><td class="op-uc-table--cell"><p class="op-uc-p">With OpenProject's new automated subject patterns, you can ensure consistent naming conventions for specific work package types like invoices, vacation requests, and more. Say goodbye to manual errors and hello to streamlined workflows!</p></td></tr><tr class="op-uc-table--row"><th class="op-uc-table--cell op-uc-table--cell_head"><p class="op-uc-p">Customer Quote</p></th><td class="op-uc-table--cell"><p class="op-uc-p"><br></p></td></tr></tbody></table></figure><br>

## Go to market

  - Feature announcement in release notes and newsletters.

  - There is an opportunity to create a blog article about this feature, highlighting use cases and provide customers with a number of patterns they can copy for their workflows. Like a template provider to cover standard use cases. 

## Figma and mockups

<https://www.figma.com/design/I2IVNb97j1fNNCs32H6p2m/Automatic-generated-subjects?node-id=0-1>
