Versions Compared

Version Old Version 4 New Version Current
Changes made by

Dominic Wettstein

Daniel Graf

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

TODO

Allgemeine Benachrichtigungs-Einstellungen

Siehe Über Benachrichtigungen können Benutzer über Ereignisse innerhalb der Applikation informiert werden. Es stehen unterschiedliche Kanäle zur Verfügung über die Benutzer erreicht werden können.

Table of Contents
stylenone

Einstellung der Benachrichtigungen für den Benutzer

Benutzer können selbständig entscheiden welche, auf welchen Kanälen und wie oft Benachrichtigungen an sie versendet werden sollen.

...

Benutzer können das Sende-Intervall konfigurieren. Von:

  • Sofort: Benachrichtigungen werden direkt an den Benutzer versendet, bis

  • Wöchentlich: Die Benachrichtigungen werden gesammelt einmal in der Woche an den Benutzer versendet.

Konfiguration von Benachrichtigungen von Customizer und Administrator

Grundsätzliche Einstellungen

...

Einstellung der Notifications für den Benutzer

...

Setup von Benachrichtigungen von Customizer und Developer

Customizer

Der Customizer kann nur die Notification Templates bearbeiten:

  • Menu → Benachrichtigungen → Vorlage

  • Vorlagen können pro Sprache in einem Richtexteditor bearbeitet werden:

  • image-20241219-093827.pngImage Added

Developer

Das Grundsätzliche einrichten von Notifications kann nur ein Entwickler über die Builder-API in C# Code machen.

  1. Estellen einer Notification Event Group (optional):

    Code Block
    var exampleGroup = Builder.Add.NotificationEventGroup("BeispielsGruppe")
  .Caption(German, "Beispiels Gruppe");

  2. Estellen eines Notifaction Events:

    Code Block
    var exampleEvent = Builder.Add.NotificationEvent("BeispielsEreignis", exampleGroup )
  .Caption(German, "Beispiels Ereignis");

  3. Hinzufügen eines Notification Templates:

    Code Block
    exampleEvent.Add.Template(InApplicationNotificationChannel.Name)
  .Subject(German, "Icon")
  .Message(German, "Beispiel Ereignis {{ObjectMarkdownLink}} estellt")
  .SelectedByDefault();
  exampleEvent.Add.Template(NotificationEmailChannel.Name)
  .Subject(German, "Beispiel Ereignis {{ObjectTitle}} erstellt")
  .Message(German, "Beispiel Ereignis {{ObjectUrl}} wurde von Benutzer {{Assignee.EMail}} estellt")
  .SelectedByDefault();

    Hier können Templates pro Benachrichtigungs Kanal erstellt werden. HIer einmal Benachrichtigungen in der der Anwendung und als Email. Die Parameter ObjectMarkdownLink, ObjectTitle und Object Url werden stammen aus den Standart Parameter die über das Object zur Verfügung gestellt werden (https://encodo.atlassian.net/wiki/spaces/EB/pages/540049409/Template+Processor+f+r+Benachrichtigungen+Reports#Objekte ). Es ist auch möglich gemeinsam Email Vorlagen zu erstellen: https://encodo.atlassian.net/wiki/x/GoBCKw

  4. Senden einer Notification:

    Code Block
    var notificationSender = requirement.Session.GetInstance<INotificationSenderService>();
var parameters = new Dictionary<string, object> (); // A dictionary with the parameters for the notification
var assigneeIds = new Enumerable<Guid> (); // All receipients of the notification
var object: IDataObject; // The object which the notification is about
notificationSender.Send("BeispielsGruppe", object, parameters, assigneeIds);

Ereignisgruppen (Event Groups)

...

Eigentliche Event Definition

Empfänger??? - Nur im Code?

Kanäle (Channels)

Das sind die unterschiedlichen Arten wie die Notifications an die Empfänger geschickt werden.

...

Pro Kanal und Event wird ein Template definiert. Hier gibt man an welche Nachricht versendet werden soll.

...

wird die eigentliche Nachricht definiert.

Benachrichtigen (Notifications)

Das sind die Event-Instanzen die an die Empfänger versendet werden

...