Globale Mitteilungen für Benutzer konfigurieren

Sie können zentral Mitteilungen für Benutzergruppen oder alle Benutzer konfigurieren. Die Konfiguration erfolgt über ein zentral definiertes Skript, Sie teilen die Konfiguration den Benutzern anschließend über Berechtigungen zu. Die Benutzer können diese Konfiguration nicht ändern.

Die Mitteilungen aktivieren sich für den Benutzer, sobald dieser sich das erste Mal in agorum core anmeldet.

Die Konfiguration definieren

---

Sie legen die Konfiguration in der Regel in einem eigenen Projekt ab (in diesem Beispiel heißt das Projekt test_notification). Sie legen nun eine globale Mitteilungskonfiguration für den Eingang (aktuell) an. Der interne Name lautet inbox-current.

1. Legen Sie unterhalb des Projektordners test_notification den Ordner js an.
2. Legen Sie im Ordner js den Ordner notification an.
   
   Ergebnis: Folgende Struktur ergibt sich:

   test_notification
     |- js
       |- notification

3. Erstellen Sie eine JavaScript-Datei mit dem Namen notification-settings-inbox-current.js und folgendem Inhalt:

   /* global sc */
   
   // Base configuration for agorum core notification
   // can be used to configure a notifications for a group of users
   // global configuration, will be activated on first login of the user
   // this configuration is registered in the MetaDb:
   // MAIN_MODULE_MANAGEMENT/customers/agorum.composite.acic.notification/notification-global-settings/[ test_notification ]/test_notification_inbox_current
   
   // export configuration
   exports.settings = user => {
     user = user || sc.loginUser;
   
     return [
       {
         // information center configuration/search (name), that should be used
         // in out example. inbox_current -> Eingang (Aktuell)
         notification_configuration: 'inbox-current',
         customizable: false,
         notification_types: {
           // home bar
           homeBar: {
             // information center window orientation
             // left, center or right
             orientation: 'right',
   
             // show filter (true) or not (false)
             showFilter: true,
   
             // Text for the home bar button
             displayName: 'Eingang (aktuell)',
   
             // enable/disable configuration
             active: true,
   
             // interval in minutes
             interval: 5,
   
             // show directly in home bar (true) or in "more..." (false)
             favorite: true,
   
             // show details
             showDetails: false,
           },
           // email
           email: {
             // enable/disable configuration
             active: true,
   
             // interval in minutes
             interval: 5,
           },
         },
       },
     ];
   };
   
   

Parameter

Das System gibt ein Array zurück. Mehrere Konfigurationen können gleichzeitig enthalten sein.

Parameter	Beschreibung	Mögliche Werte
notification_configuration	Definiert den Namen der Suchkonfiguration des agorum core information centers.	Standardkonfigurationen ac_all (Alles) inbox_current (Eingang aktuell) inbox_all (Eingang alles) Sie können hier eigens erstellte Filter in der Suche verwenden.
notification_types	Definiert den Typ der Mitteilung.	Typen homeBar (die Schaltflächen oben rechts in der Weboberfläche) email (Informiert über Mitteilungen per E-Mail. Das System nimmt als Empfänger automatisch die primäre E-Mail-Adresse des jeweiligen Benutzers.) Zu homeBar und email existieren weitere Parameter.
customizable	siehe Spalte Mögliche Werte	true Der Benutzer kann die globale Mitteilung konfigurieren / ändern. Setzen Sie true, hat die Konfiguration des Benutzers Vorrang vor der globalen Konfiguration. false (Standard) Der Benutzer kann die globale Mitteilung nicht konfigurieren / ändern und die Mitteilungen für diese Konfiguration nicht einstellen. Setzen Sie false, hat die globale Konfiguration Vorrang vor der Konfiguration des Benutzers. Das System legt diese Konfiguration automatisch beim Benutzer an, wenn der Benutzer sich zum ersten Mal in agorum core anmeldet, sofern die Konfiguration im Benutzer noch nicht vorhanden ist. Der Benutzer kann die Konfiguration dann ändern. Wenn Sie die globale Konfiguration ändern, gilt diese nicht für den Benutzer. Sie gilt erst dann wieder, wenn der Benutzer seine eigene Konfiguration löscht.

Parameter zu „homeBar“

Parameter	Beschreibung	Mögliche Werte
orientation	Definiert die Ausrichtung des Fensters, wenn ein Benutzer auf die Schaltfläche für die Mitteilungen klickt.	left, center, right
showFilter	siehe Spalte Mögliche Werte	true Der Filter scheint beim Öffnen der Suche links. false Der Filter scheint NICHT, wenn ein Benutzer die Suche öffnet.
displayName	Definiert den Namen der Schaltflächen in der Home-Bar.	String
active	siehe Spalte Mögliche Werte	true Die Konfiguration ist aktiviert. false Die Konfiguration ist deaktiviert.
interval	Definiert in Minuten, wie oft das System nach neuen Mitteilungen je Benutzer sucht.	Integer Nur positive Werte sind möglich. Achtung: Beeinträchtigung des Systembetriebs durch den Wert 0. Das System arbeitet bei diesem Wert stark verlangsamt. Verwenden Sie diesen Wert nicht.
favorite	siehe Spalte Mögliche Werte	true Die Schaltfläche erscheint in der Home-Bar. false Die Schaltfläche erscheint unterhalb von Weitere …
showDetails	siehe Spalte Mögliche Werte	true Die Vorschau erscheint beim Öffnen der Suche rechts. false Die Vorschau erscheint NICHT beim Öffnen der Suche.

Parameter zu „email“

Parameter	Beschreibung	Mögliche Werte
active	siehe Spalte Mögliche Werte Sie müssen diesen Parameter zwingend setzen.	true Die Konfiguration ist aktiviert. false Die Konfiguration ist deaktiviert.
interval	Definiert in Minuten, wie oft das System nach neuen Mitteilungen je Benutzer sucht. Sie müssen diesen Parameter zwingend setzen.	Integer Nur positive Werte sind möglich. Achtung: Beeinträchtigung des Systembetriebs durch den Wert 0. Das System arbeitet bei diesem Wert stark verlangsamt. Verwenden Sie diesen Wert nicht.

Die Konfiguration registrieren

---

1. Öffnen Sie links in der Seitenleiste Explorer.
2. Folgen Sie den Anweisungen unter Die Konfiguration definieren.

   Hinweis: Die JavaScript-Datei muss in einem Unterordner namens notification liegen, damit die automatische Registrierung funktioniert. Andernfalls erscheint eine Fehlermeldung beim Registrieren.

3. Klicken Sie mit der rechten Maustaste auf die erstellte JavaScript-Datei.
4. Wählen Sie im Kontextmenü agorum core template manager > Registrieren > global notification.
5. Klicken Sie im Dialog Register global notification auf OK.
6. Klicken Sie im Dialog Register Name nochmals auf OK.
   
   Ergebnis: Das System legt im Unterordner yml in der Datei export.yml den Eintrag register notification an.

Den notification-Worker im agorum core support tool zurückzusetzen

---

Setzen Sie den notification-Worker im agorum core support tool zurück, damit der Worker die neue Konfiguration lädt.

Sie müssen den notification-Worker zurücksetzen, wenn Sie etwas am JavaScript der Konfiguration angepasst haben.

1. Öffnen Sie links in der Seitenleiste Weitere Apps und dann support tool.
2. Wählen Sie links im Menü Workers > Actions > QueryScript: agorum_composite_acic_notifications.
3. Klicken Sie auf Reset Worker.