Content
View differences
Updated by Dominic Bräunlein over 1 year ago
# User problem
## User
* **Admins:** Want to enforce specific naming conventions for certain work package types (e.g., invoices, vacation requests). Project manager
* **Project Members:** Need consistent titles to identify and process specific work packages. Project member
## Problem
* Currently, users can input any title The user needs to manually enter a subject for a work package, leading package according to inconsistencies. For certain types of specific pattern while all information that is needed to compose the subject is already present in work packages e.g. invoices package attributes 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. other associated fields (projects, author, ...).
#### ## 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 Right now the user needs to apply the pattern for subjects manually.
* The user needs to be informed about these patterns are not reflected in existing titles. through alternative communication channels.
* Users must rely on verbal or written instructions Nobody enforces the pattern
* Therefore the user:
* needs to learn the pattern
* stay updated about the pattern
* apply patterns, which may not always be accurate or up to date.
<br> it correctly
* Outdated subjects after the project manager changes a pattern
## Solution
* **Subject Patterns for Work Package Types**
* Admins For a specific work package type, the admin can define title composition rules for specific work package types via a settings page.
* Example:
`{{projectValue:name}} the subject based on attributes and free text.
```text
{{projectValue:name}} - {{workPackageValue:Type}} - {{workPackageValue:CustomFieldName}}`.
{{workPackageValue:ProzesskennungShort}} - {{workPackageValue:Version}}
```
* **Enforced Titles**
The work package title is **read only** to avoid manual violations of this rule.
* Titles for these specific types are automatically generated The subject needs to be set on work package creation and read-only.
* **Dynamic Updates**
* Title any further updates automatically when referenced attributes (e.g., project name, date) are changed. (to be discussed)
of the attributes.
* **Configuration Location**
* Patterns are set under The work package subject is defined in the work package type settings (`/types/:id/edit/settings`).
setting /types/3/edit/settings
* **Marcros**
Admins can use OpenProject macros to compose rules
* Additional macros Marcros need to be created for parent work package values and custom field of type hierarchy https://www.openproject.org/docs/user-guide/wysiwyg/#available-attributes-for-work-packages
## Out of scope for the MVC
* Automatic file naming
# Launch and Growth
## Measures Acceptance criteria
* 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 titles</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.
* Detailed user guide with examples of pattern usage.
<br> tbd
## 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
####
* 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
* The user needs to be informed about these
* Users must rely on verbal or written instructions
* Therefore the user:
* needs
* stay updated about the pattern
*
<br>
* Outdated subjects after the project manager changes a pattern
## Solution
* **Subject Patterns for Work Package Types**
* Admins
* Example:
`{{projectValue:name}}
```text
{{projectValue:name}}
```
* **Dynamic Updates**
* Title
* Patterns are set under
* Automatic file naming
# 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 titles</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.
* Detailed user guide with examples of pattern usage.
<br>