Content
View differences
Updated by Marc Alcobé over 3 years ago
**As** an OpenProject user
**I want** to receive an notification before a work package becomes overdue
**so that** I save time and energy to not forget important deadlines.
### Use case (example)
* Recurring tasks such as
* testing the backup and restore procedure
* doing feedback conversations with team members
* checking the logged time invoicing the customers
### Acceptance criteria
####
#### Notification settings
This feature :
* adds date alerts to the _Notification settings_ page and
* proposes changes in phrasing and organisation for more clarity.
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37074/content">
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37075/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37076/content">
**Participating**
* The first block is renamed "Participating" (vs the current "~~Notify me immediately~~").
* The description text is changed to:
* "Notifications for all activities in work packages you are involved in (assignee, accountable or watcher)" (note lack of period at the end of the sentence).
* There are four options:
* @mentioned (vs current "~~I am @mentioned~~")
* Watcher (new here, currently "~~Updates on watched items~~" in the second group)
* Assignee (vs current "~~Assigned to me or accountable~~")
* Accountable (split from ""~~Assigned to me or accountable~~")
* The first two options are disabled.
**Date alerts**
* The second block is titled "Date alerts"
* The description is:
* "Automatic notifications when important dates are approaching for open work packages you are involved in (assignee, accountable or watcher)"
* There is a check box labeled "Start date" (checked by default), with a drop down next to it with "1 day before" selected by default.
* There is a check box labeled "Finish date" (checked by default), with a drop down next to it with "1 day before" selected by default.
* There is a check box labeled "When overdue" (not checked by default), once checked, a drop down next the selection "everyday" selected appears.
* The options for the checkbox in "Start and Finish dates" are:
* same day
* 1 day before
* 3 days before
* a week before
* The options for the checkbox in "When overdue" are:
* everyday
* every 3 days
* every week
* Unchecking the checkboxes hides the drop-down.
* The notifications will be sent at 1am local time (this is not configurable).
* This notifications only apply for open work packages.
* When overdue affects all the work packages that meets all the following criteria:
* Work package is open
* Finish date is in the past (meaning one day or more in the past)
* NOTE: Start date does not define in any case an overdue state
**Non-participating**
* The third block is renamed "Non-participating" (vs current "~~Also notify me for~~")
* The description text is changed to: "Additional notifications for activities in all projects"
* The "Updates on watched items" item is removed (since is now available to the first block)
**Project-specific notification settings**
* Setting up specific rules of notifications per project is still possible using the button "+ Add settings for project"
* The table generated after selecting the project has been redesigned to contain the "Date alerts". Also the other sections has been reorganised as in the main settings section:
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37077/content">
**Edition Enterprise banners**
For the case when the EE banner is displayed with an expansion panel style defined in the work package <mention class="mention" data-id="44481" data-type="work_package" data-text="#44481">#44481</mention>:
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/39521/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/39522/content">
**On Notification Center**
There is a new card design and a new entry in the sidebar.
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37180/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37181/content">
**Sidebar**
* The sidebar header "~~Involvement~~" is renamed to "Reason"
* There is a new entry called "Date alert"
* Icon: An SVG export is available in Figma.
* Badges will be visible based on # of date alert notifications that are unread.
**Notification card**
* The _reason_ provided for a date alert notification (comparable to "mentioned" or "watched") will be "Date alert".
* When the user is inside the sidebar element "Date alert" the 3rd line of information always display the related info with the date alert in the style specified in the visuals. As the {time} is relative, this will change accordingly with the current date:
* "Start date is {time}" ("Start date was {time}" in case of past)
* "Finish date is {time}"
* Once the finish date is in the past, the work package is considered overdue: "Overdue since {time}"
* {time} is the relative difference between the current date and the set date in question
* In case the user is in any of the other sidebar elements (eg. Inbox) there are two possibilities:
* There is only one notification for the work package and it is a date alert: in this case the 3rd line will follow the same logic specified above.
* There is one date alert but also other notifications concerning that work package: the date alert isn't immediately visible, we will display the normal information "X days ago by Name Surname".
* In case start and finish date are on the same day and the configuration is also configured equally for both start and finish date, only display the finish date information as that one is more important.
* In the specific case of MILESTONES as they only have a single date, the finish date of the configuration will govern whether to create a notification.
* Display text that is specific to milestones: "Milestone date is {time}".
* Overdue should the same for milestone-typed WPs as for any other type.
**Email digest**
* Include date alert in email digest.
* Add date reference (e.g. Start date is today) to email digest in case of a date alert.
* If the user specifically clicked on the date alert notification (vs. a notification that also has date alerts but which isn't the reason mention in the digest), it should open in the date alerts panel on the sidebar.
### **Out of scope**
* The date alert is displayed when there are multiple notifications in the same work package, depending on priority for aggregated journal entries (this will be implemented together with the details of the notification in <mention class="mention" data-id="38680" data-type="work_package" data-text="#38680">#38680</mention>).
### Figma
Mockups and test translations for the new Notification settings in Spanish, German and French are available on Figma:
* Notification settings: [https://www.figma.com/file/Zi5ZwMqJZY1kQ6Kq2nd4cZ/Notification-Center---Settings?node-id=0%3A1](https://www.figma.com/file/Zi5ZwMqJZY1kQ6Kq2nd4cZ/Notification-Center---Settings?node-id=0%3A1)
* Notification centre card: [https://www.figma.com/file/54psSIYZuUgcyXrpGxHB1Z/Notification-Center---Main-View?node-id=1888%3A1450](https://www.figma.com/file/54psSIYZuUgcyXrpGxHB1Z/Notification-Center---Main-View?node-id=1888%3A1450)
**I want** to receive an notification before a work package becomes overdue
**so that** I save time and energy to not forget important deadlines.
### Use case (example)
* Recurring tasks such as
* testing the backup and restore procedure
* doing feedback conversations with team members
* checking the logged time invoicing the customers
### Acceptance criteria
####
#### Notification settings
This feature :
* adds date alerts to the _Notification settings_ page and
* proposes changes in phrasing and organisation for more clarity.
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37074/content">
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37075/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37076/content">
**Participating**
* The first block is renamed "Participating" (vs the current "~~Notify me immediately~~").
* The description text is changed to:
* "Notifications for all activities in work packages you are involved in (assignee, accountable or watcher)" (note lack of period at the end of the sentence).
* There are four options:
* @mentioned (vs current "~~I am @mentioned~~")
* Watcher (new here, currently "~~Updates on watched items~~" in the second group)
* Assignee (vs current "~~Assigned to me or accountable~~")
* Accountable (split from ""~~Assigned to me or accountable~~")
* The first two options are disabled.
**Date alerts**
* The second block is titled "Date alerts"
* The description is:
* "Automatic notifications when important dates are approaching for open work packages you are involved in (assignee, accountable or watcher)"
* There is a check box labeled "Start date" (checked by default), with a drop down next to it with "1 day before" selected by default.
* There is a check box labeled "Finish date" (checked by default), with a drop down next to it with "1 day before" selected by default.
* There is a check box labeled "When overdue" (not checked by default), once checked, a drop down next the selection "everyday" selected appears.
* The options for the checkbox in "Start and Finish dates" are:
* same day
* 1 day before
* 3 days before
* a week before
* The options for the checkbox in "When overdue" are:
* everyday
* every 3 days
* every week
* Unchecking the checkboxes hides the drop-down.
* The notifications will be sent at 1am local time (this is not configurable).
* This notifications only apply for open work packages.
* When overdue affects all the work packages that meets all the following criteria:
* Work package is open
* Finish date is in the past (meaning one day or more in the past)
* NOTE: Start date does not define in any case an overdue state
**Non-participating**
* The third block is renamed "Non-participating" (vs current "~~Also notify me for~~")
* The description text is changed to: "Additional notifications for activities in all projects"
* The "Updates on watched items" item is removed (since is now available to the first block)
**Project-specific notification settings**
* Setting up specific rules of notifications per project is still possible using the button "+ Add settings for project"
* The table generated after selecting the project has been redesigned to contain the "Date alerts". Also the other sections has been reorganised as in the main settings section:
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37077/content">
**Edition Enterprise banners**
For the case when the EE banner is displayed with an expansion panel style defined in the work package <mention class="mention" data-id="44481" data-type="work_package" data-text="#44481">#44481</mention>:
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/39521/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/39522/content">
**On Notification Center**
There is a new card design and a new entry in the sidebar.
<img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37180/content"><img class="op-uc-image op-uc-image_inline" src="/api/v3/attachments/37181/content">
**Sidebar**
* The sidebar header "~~Involvement~~" is renamed to "Reason"
* There is a new entry called "Date alert"
* Icon: An SVG export is available in Figma.
* Badges will be visible based on # of date alert notifications that are unread.
**Notification card**
* The _reason_ provided for a date alert notification (comparable to "mentioned" or "watched") will be "Date alert".
* When the user is inside the sidebar element "Date alert" the 3rd line of information always display the related info with the date alert in the style specified in the visuals. As the {time} is relative, this will change accordingly with the current date:
* "Start date is {time}" ("Start date was {time}" in case of past)
* "Finish date is {time}"
* Once the finish date is in the past, the work package is considered overdue: "Overdue since {time}"
* {time} is the relative difference between the current date and the set date in question
* In case the user is in any of the other sidebar elements (eg. Inbox) there are two possibilities:
* There is only one notification for the work package and it is a date alert: in this case the 3rd line will follow the same logic specified above.
* There is one date alert but also other notifications concerning that work package: the date alert isn't immediately visible, we will display the normal information "X days ago by Name Surname".
* In case start and finish date are on the same day and the configuration is also configured equally for both start and finish date, only display the finish date information as that one is more important.
* In the specific case of MILESTONES as they only have a single date, the finish date of the configuration will govern whether to create a notification.
* Display text that is specific to milestones: "Milestone date is {time}".
* Overdue should the same for milestone-typed WPs as for any other type.
**Email digest**
* Include date alert in email digest.
* Add date reference (e.g. Start date is today) to email digest in case of a date alert.
* If the user specifically clicked on the date alert notification (vs. a notification that also has date alerts but which isn't the reason mention in the digest), it should open in the date alerts panel on the sidebar.
### **Out of scope**
* The date alert is displayed when there are multiple notifications in the same work package, depending on priority for aggregated journal entries (this will be implemented together with the details of the notification in <mention class="mention" data-id="38680" data-type="work_package" data-text="#38680">#38680</mention>).
### Figma
Mockups and test translations for the new Notification settings in Spanish, German and French are available on Figma:
* Notification settings: [https://www.figma.com/file/Zi5ZwMqJZY1kQ6Kq2nd4cZ/Notification-Center---Settings?node-id=0%3A1](https://www.figma.com/file/Zi5ZwMqJZY1kQ6Kq2nd4cZ/Notification-Center---Settings?node-id=0%3A1)
* Notification centre card: [https://www.figma.com/file/54psSIYZuUgcyXrpGxHB1Z/Notification-Center---Main-View?node-id=1888%3A1450](https://www.figma.com/file/54psSIYZuUgcyXrpGxHB1Z/Notification-Center---Main-View?node-id=1888%3A1450)