Notifikationstypen und Darstellung in der Oberfläche

Eine Notifikation kann einen Typ enthalten (für die Erstellung von Notifikationen über API siehe auch Notification API). Folgende Typen werden unterstützt:

Information ("type": "info")

Notifikationen dieses Typs bieten Informationen über ein Ereignis. Im Folgenden ist ein Beispiel vom Request-Body, wie man über API eine Notifikation des Typs Information erstellt:

   {
      "subject": "Erste Anmeldung in BPC",
      "message": "Herzlich willkommen im BPC",
      "recipients": [ "bpcuser" ],
      "recipientsType": "role",
      "type": "info"
   }

Die Notifikation wird in der Oberfläche des Empfängers wie folgt dargestellt:

Darstellung der Info-Notifikation

Warnung ("type": "warning")

Notifikationen dieses Typs weisen den Nutzer auf eine Warnung hin. Im Folgenden ist ein Beispiel vom Request-Body, wie man über API eine Notifikation des Typs Warnung erstellt:

   {
      "subject": "Wartungsmodus aktiv",
      "message": "Das BPC befindet sich im Wartungsmodus",
      "recipients": [ "bpcuser" ],
      "recipientsType": "role",
      "type": "warning"
   }

Die Notifikation wird in der Oberfläche des Empfängers wie folgt dargestellt:

Darstellung der Warn-Notifikation

Fehler ("type": "error")

Notifikationen dieses Typs weisen den Nutzer auf einen Fehler hin. Im Folgenden ist ein Beispiel vom Request-Body, wie man über API eine Notifikation des Typs Fehler erstellt:

   {
      "subject": "Starten vom Module 'monitor' fehlgeschlagen",
      "message": "Das Module 'Monitor kann nicht gestartet werden, bitte wenden Sie an Ihren Administrator.'",
      "recipients": [ "bpcuser" ],
      "recipientsType": "role",
      "type": "error"
   }

Die Notifikation wird in der Oberfläche des Empfängers wie folgt dargestellt:

Darstellung der Fehler-Notifikation

Verknüpfung ("type": "link")

Notifikationen dieses Typs bieten Informationen und die Möglichkeit, direkt zu der relevanten Stelle im BPC oder zu einer externen Seite zu navigieren. Im Folgenden ist ein Beispiel vom Request-Body, wie man über API eine Notifikation des Typs Verknüpfung erstellt:

   {
      "subject": "API bald abgelaufen",
      "message": "API Key API-39e889a ist bald abgelaufen. Kontaktieren Sie bitte Ihren Administrator.",
      "recipients": [ "bpcadmin" ],
      "recipientsType": "role",
      "icon": "fa-file-certificate",
      "type": "link",
      "typeSpecificData": {
         "targetModule": "_core",
         "route" : ["_core", "apiKeys", "api", "API-39e889a"]
      }
   }

Die Notifikation wird in der Oberfläche des Empfängers wie folgt dargestellt:

Darstellung der Link-Notifikation

In dem Beispiel: wenn man auf dem gekennzeichneten Button klickt, springt das BPC automatisch zu der API-Keys-Liste im Core-Konfigurator und fokussiert den API-Key mit der ID API-39e889a.

Bei diesem Typ von Nofitikationen ist es wichtig, typeSpecificData zu setzen.

Nachfolgend werden die Attribute vom typeSpecificData erläutert:

targetModule : das Zielmodul im BPC, wohin man navigiert werden soll.
route : die Route-Elemente, um auf die Ziel-Komponente des Zielmoduls zu navigeren.
url: die Ziel-URL der externen Seite, wohin man weitergeleitet werden soll.

Für Informationen über das Routing-Konzept im BPC siehe auch Routing / Deep Links.

Keywords: