SORMAS-Project icon indicating copy to clipboard operation
SORMAS-Project copied to clipboard

Provide user notifications documentation [1]

Open MartinWahnschaffe opened this issue 2 years ago • 2 comments

Problem Description

We need a documentation for user notifications similarly to what we have for user rights based on #10200 .

Proposed Change

  • [ ] Add descriptions to notifications to be shown in the UI when hovering a notification in the user role edit view. The descriptions will be provided by @MartinWahnschaffe
  • [ ] Extend SORMAS_User_Roles.xlsx with another sheet that lists all details for the user notifications: enum name, group, caption, description
  • [ ] In the user roles sheet add a column "Notifications" at the end that stays empty. For each notification type add another column that contains whether the user role is using the notifications type.
  • [ ] Update https://github.com/hzi-braunschweig/SORMAS-Project/blob/development/docs/SERVER_CUSTOMIZATION.md#user-role-configuration to also mention notifications.
  • [ ] In the user roles sheet move the Uuid, Port health user, Has associated district user, Has optional health facility, Enabled columns between Description and a new column "User rights" that stays empty and marks the start of the user rights

Acceptance Criteria

Implementation Details

  • Write every notification type once and write into the cell if SMS, EMAIL, both ("SMS, EMAIL") or none = "" are enabled.

Additional Information

MartinWahnschaffe avatar Sep 08 '22 08:09 MartinWahnschaffe

@JaquM-HZI Please double check whether this makes sense to you. Adding the configuration of the notifications to the sheet with the user roles next to the user rights, will mean there are even more columns, but from my point of view this would be ok here.

MartinWahnschaffe avatar Sep 08 '22 08:09 MartinWahnschaffe

@MartinWahnschaffe double checked and it's fine for me. Thanks!

JaquM-HZI avatar Sep 09 '22 08:09 JaquM-HZI

@SahaLinaPrueger @JaquM-HZI Please double-check the descriptions I have provided above for the notification types. I'd also suggest to rename "Case disease changed" to "Case VHF disease changed" because it is only triggered when an "Unspecified VHF" case disease is changed to something else.

MartinWahnschaffe avatar Sep 27 '22 11:09 MartinWahnschaffe