Content
View differences
Updated by Judith Roth 4 months ago
**As** an admin
**I want to** have a setting where I can decide between regular numeric work package IDs ids and semantic work package IDs ids
**so that** I can enable semantic work package IDs ids
**Acceptance criteria**
* In "Administration" in Administration -> "Work Packages" Work Packages is a new sub menu item "Identifier" "Identifiers"
* For for now, this is only accessible with a feature flag `SEMANTIC_WORK_PACKAGE_IDS`
* In in the new administration page, it should be possible to choose between
* Instance-wide numerical sequence (default) global numeric identifiers
* Project-based alphanumerical project-based identifiers _(maybe we can find even better wording for that)_
* See mockup for exact wording and help texts
* When selecting Project-based alphanumerical project based identifiers
* If there are existing project identifiers which are more than 10 characters or contain the user gets a dash, we will show a table with
* Name Project name
* Current Project identifier
* Automatically generated suggestion Example work package identifiers
* Recommendation
to review
* Recommendation:
* ✅️ for a shorter identifier
<= 10 characters, no dashes
* The table has ⚠️ for > 10 entries characters (tbd: warning text, include link to begin with and a "show more" to show project setting page where this can be changed)
* ⚠️ for "-" within the rest if there are more than 10
identifiers? (tbd: warning text)
* Below the table a warning is a button shown to accept tell the changes and activate user that the new setting switch may take a while
* After the user clicks to accept the project based identifiers we start a background job to generate the new identifiers (<mention class="mention" data-id="71645" data-type="work_package" data-text="#71645">#71645</mention>) and show a progress bar.
* While the job is running, it should not be possible to change the setting.
* When the user closes the page and navigates back to it while the job is running, the progress bar is shown and the setting can not be changed.
* When the background job is finished, the page reloads, the new setting is set to project-based identifiers and can be edited again
* It is NOT possible to abort the background job. ~~When When it is aborted, the page reloads and the setting is set to global numeric identifiers and can be edited again~~ again
**Technical notes**
* When selecting global numeric identifiers (after project-based identifiers were active before), the already existing semantic identifiers are not deleted (so that we can still resolve URLs with semantic identifiers)
* We need an algorithm / class to generate short project identifiers. This should be written in a way so it can be reused and applied when a new project is created.
**Permissions and visibility considerations**
* This is visible to everyone who is allowed to access and change global settings
**Translation considerations**
* Key terms are
* Instance-wide numerical sequence
* Project-based alphanumerical identifiers
_tbd_
**Out of scope**
* Implementation of the background job to generate the new identifiers (see <mention class="mention" data-id="71645" data-type="work_package" data-text="#71645">#71645</mention>)
_Set the_ **To be informed/consulted teams** _field to include all teams necessary to be informed of the changes._
**I want to** have a setting where I can decide between regular numeric work package IDs
**so that** I can enable semantic work package IDs
**Acceptance criteria**
* In "Administration"
* For
* In
* Instance-wide numerical sequence (default)
* Project-based alphanumerical
* See mockup for exact wording and help texts
* When selecting Project-based alphanumerical
* If there are existing project identifiers which are more than 10 characters or contain
* Name
* Current
* Automatically generated suggestion
* Recommendation
to review
* Recommendation:
* ✅️
* ⚠️ for "-" within
* After the user clicks to accept
* While the job is running, it should not be possible to change the setting.
* When the user closes the page and navigates back to it while the job is running, the progress bar is shown and the setting can not be changed.
* When the background job is finished, the page reloads, the new setting is set to project-based identifiers and can be edited again
* It is NOT possible to abort the background job. ~~When
**Technical notes**
* When selecting global numeric identifiers (after project-based identifiers were active before), the already existing semantic identifiers are not deleted (so that we can still resolve URLs with semantic identifiers)
* We need an algorithm / class to generate short project identifiers. This should be written in a way so it can be reused and applied when a new project is created.
**Permissions and visibility considerations**
* This is visible to everyone who is allowed to access and change global settings
**Translation considerations**
* Key terms are
* Instance-wide numerical sequence
* Project-based alphanumerical identifiers
* Implementation of the background job to generate the new identifiers (see <mention class="mention" data-id="71645" data-type="work_package" data-text="#71645">#71645</mention>)
_Set the_ **To be informed/consulted teams** _field to include all teams necessary to be informed of the changes._