NOTICE

What is this for?

With NOTICE you display notifications / banners for the users of your tenant.

Typical examples:

• "Maintenance work on May 20, 6:00–10:00 PM"
• "New feature: ticket plugin available"
• A mandatory notice that everyone has to acknowledge once

For each notice you can configure, among other things:

• Title and text
• Visibility period
• Whether the notice has to be acknowledged ("dismiss") or remains as a banner
• Which role(s) it is shown to

There is also an overview of who has already read the notice.

---

Typical day-to-day tasks

• Create a notice
• Activate / deactivate a notice
• See who has already dismissed it
• Delete a notice

---

Step by step

1) Manage notices

1. Admin → Notices (/settings/admin/notices).
2. You see the list with status (active / inactive) and time range.

2) New notice

1. "New" (/settings/admin/notices/new).
2. Fill in the fields:

• Title, text (HTML/Markdown depending on the editor)
• Time range (from / to)
• Visibility (role / everyone)
• Behavior (permanently visible or one-time dismissible)

3. Save (POST /settings/admin/notices/save).

3) Activate / deactivate

• POST /settings/admin/notices/{id}/activate – immediately visible.
• POST /settings/admin/notices/{id}/deactivate – hide.

4) Read / acknowledgement status

• GET /settings/admin/notices/{id}/reads – shows which users have seen / dismissed the notice.

5) Delete a notice

• POST /settings/admin/notices/{id}/delete.

6) End user: dismissing the notice

• If the notice is marked as "dismissible", every user can close it once:
• POST /notices/{id}/dismiss.
• After that it is no longer visible to that user (it remains visible to others until they dismiss it themselves).

---

Common questions / problems

"My notice isn't shown to anyone"

• Is it set to active?
• Does the "from/to" date match the current date?
• Is the role correct?

"A user claims they never saw the notice"

• Check the read status ({id}/reads).
• The notice may have been activated only after they logged in.

"The notice nags every day all over again"

• Set the behavior to "one-time dismissible" instead of "always show".

---

Technical URLs (quick reference)

Admin (/settings/admin/notices):

• GET /settings/admin/notices – list
• GET /settings/admin/notices/new – new
• GET /settings/admin/notices/{id}/edit – edit
• POST /settings/admin/notices/save – save
• POST /settings/admin/notices/{id}/activate
• POST /settings/admin/notices/{id}/deactivate
• POST /settings/admin/notices/{id}/delete
• GET /settings/admin/notices/{id}/reads – read status

End users:

• POST /notices/{id}/dismiss – dismiss the notice

Notes

• Use notices sparingly – otherwise they get ignored.
• Send sensitive information via MAIL rather than displaying it in a banner.