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 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 select from a drop down (or + button) multiple items to generate the pattern
Example:
`{{projectValue:name}} - {{workPackageValue:Type}} - {{workPackageValue:CustomFieldName}}`.
* The options are shown as hierarchical list
* The options are items from the [OpenProject macro list](https://www.openproject.org/docs/user-guide/wysiwyg/#available-attributes-for-work-packages)
* Additionally separator items can be selected by the admin e.g. " -\_.,:"
* **Enforced Subjects**
* Titles for these specific types are automatically generated and read-only.
* **Dynamic Updates**
* Title updates automatically when referenced attributes (e.g., project name, date) are changed. (to be discussed)
* **Configuration Location**
* Patterns are set under the work package type settings (`/types/:id/edit/settings`).
* _**Marcros**_ **Marcros**
* _(maybe not needed) Additional macros 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_ 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
* 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>
<br>
## 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 select from a drop down (or + button) multiple items to generate the pattern
`{{projectValue:name}} - {{workPackageValue:Type}} - {{workPackageValue:CustomFieldName}}`.
* The options are items from the [OpenProject macro list](https://www.openproject.org/docs/user-guide/wysiwyg/#available-attributes-for-work-packages)
* Additionally separator items can be selected by the admin e.g. " -\_.,:"
* **Enforced Subjects**
* Titles for these specific types are automatically generated and read-only.
* **Dynamic Updates**
* Title updates automatically when referenced attributes (e.g., project name, date) are changed. (to be discussed)
* **Configuration Location**
* Patterns are set under the work package type settings (`/types/:id/edit/settings`).
* _**Marcros**_
* _(maybe not needed) Additional macros 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
* 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>
<br>