Dokumentation

Produktbeschreibung

Die EventBridge erlaubt die regelbasierte Verarbeitung und Weiterleitung von Ereignissen, die in einem STARFACE-Telefoniesystem auftreten können. Die Verarbeitung kann von Bedingungen abhängig gemacht werden.

Zweckbestimmung: Für Systemintegratoren, Administratoren, Entwickler und technisch versierten Benutzer stellt die EventBridge einen Universal-Konnektor bereit, mit dem beliebige Drittsysteme über Ereignisse benachrichtigt werden können. Ereignisse können zudem protokolliert werden. Die konkrete Implementierung ist nicht vorgegeben und erfolgt durch den Implementierer.

Produkt-, Hersteller- und Sicherheitsinformationen, Kompatibilitätsangaben sowie Konformitätserklärungen finden Sie in den Release Notes der jeweiligen Modulversion.

Technische Eigenschaften

Voraussetzungen

• Eine mit der Modulversion kompatible STARFACE-Version.

  • Ja Appliance
  • Ja Cloud
  • Ja VM

• Erreichbarkeit der folgenden Hosts für die STARFACE-Installation

  • updates.sf-app.de (HTTPS, 443/TCP)
    für automatische Modulupdates (optional)
  • license.sf-app.de (HTTPS, 443/TCP)
    für automatische Abfrage der Modullizenz (optional)

• Moderner Webbrowser: Chrome 111 (oder neuer), Safari 16.4 (oder neuer), Firefox 128 (oder neuer)

Einschränkungen

• Der EventBridge unterstützt genau eine (1) anlagenweite Modulkonfiguration.

Vorbereitungen

Es sind keine vorbereitenden Maßnahmen erforderlich.

---

Anleitung

Installation

Module können auf zwei Arten installiert werden:

1. Per Mausklick mit dem Module Manager
   Die Installation per Module Manager hat den Vorteil, dass dieser die Kompatibilität prüft und automatisch die neueste kompatible Modulversion installiert. Außerdem werden bei Updates die Einstellungen der Modulkonfiguration beibehalten
   oder
2. manuell per Upload einer Moduldatei

🡆FAQ: Wie werden Updates installiert?

1. Module Manager (empfohlen)

Installation mit Module Manager (empfohlen)

Der Module Manager muß selbst einmalig manuell (gemäß dieser Anleitung) installiert werden. Anschließend können Module über die grafische Benutzeroberfläche per Mausklick installiert und aktualisiert werden.

2. Manuelle Installation

Manuelle Installation

1. Laden Sie die für Ihre STARFACE-Version passende Moduldatei herunter.
   Sie finden diese im Bereich Release Notes / Changelog.
2. Melden Sie sich an Ihrer STARFACE-Installation als Benutzer mit Administratorrechten an.
3. Öffnen Sie den Bereich Admin / Module / Modul-Library.
4. Klicken Sie auf Modul importieren.
5. Wählen Sie Modul mittels Upload installieren und wählen die zuvor heruntergeladene Moduldatei aus. Bestätigen Sie per Klick auf Weiter.
6. Legen Sie unter dem Tab Admin / Module / Modul-Konfiguration durch Klick auf Neue Konfiguration eine neue Modulkonfiguration an. Der neuen Modulkonfiguration muß ein eindeutiger Name (z.B. „EventBridge“) gegeben werden. Klicken Sie anschließend auf Speichern.

Das Modul ist nun installiert. Eine Modulkonfiguration kann über die Aktiv-Checkbox aktiviert oder deaktiviert werden. Per Doppelklick auf die Modul-Konfigurationszeile oder Klick auf wird die Modul-Konfiguration geöffnet.

Hinweis: Die Modulkonfiguration von Fluxpunkt-Modulen mit grafischer Oberfläche muß aktiviert sein, um Einstellungen darin vornehmen zu können.

🡆FAQ: Warum ist mein Modulkonfigurationsfenster weiß (ohne Inhalt)?🡆FAQ: Warum erhalte ich die Meldung Die Modullizenz konnte nicht registriert werden?

Drittanbietermodule

Die Option Module mittels Lizenzschlüssel installieren steht nur für Module des Herstellers STARFACE zur Verfügung. Drittanbietermodule müssen immer mittels Datei-Upload oder Module Manager installiert werden!

---

Lizenzierung & Weitere Konfiguration

Öffnen Sie die soeben erstellte Modulkonfiguration per Doppelklick auf die Modul-Konfigurationszeile oder Klick auf und fügen Sie den Modullizenzschlüssel in das dafür vorgesehene Feld im Bereich 1Info2 Lizenzierung ein:

Nach Eingabe eines gültigen Modullizenzschlüssels wechselt die Bedienoberfläche automatisch in denEinstellungen-Bereich für eine weitere Konfiguration des Moduls.

🡆FAQ: Warum wird mein Modullizenzschlüssel nicht akzeptiert?

Für die weitere Konfiguration des Moduls folgen sie bitte der entsprechenden Anleitung.

Übersicht

Die grafische Oberfläche innerhalb einer Modul-Konfiguration gliedert sich in verschiedene Bereiche, wobei die Bereiche B bis E zusammengeklappt werden können. Die Bereiche D und Esind nur bei aktiviertem Experten-Modus sichtbar.

1. AMenüleiste:
   Enthält Tabs zur Konfiguration, Überwachung und/oder Auswertung modulspezifischer Inhalte. Auf der rechten Seite wird der Produktname sowie der angemeldete Benutzer angezeigt. Per Klick auf das Benutzer-Bild kann ein Kontextmenü geöffnet werden, um das Konfigurationsfenster auszudocken oder das Farbschema bzw. Design der Oberfläche anzupassen.
2. BProduktinformationen:
   Benennt das verwendete Modul, beschreibt den vorgesehenen Nutzungszweck und verlinkt auf die Dokumentation, FAQ, Produktinformationen und Hersteller-Website. Mit dem Schalter Experte kann der Experten-Modus aktiviert werden, der weitere Einstellungsmöglichkeiten für fortgeschrittene Benutzer und ausgefallenere Anwendungsfälle einblendet.
3. CSupport-Informationen:
   Zeigt detaillierte Informationen zum Modul und der Betriebsumgebung, die im Rahmen von Supportleistungen oder Produktaktualisierungen von Bedeutung sind.
4. DUpdate-Einstellungen:
   Erlaubt die Aktivierung automatischer Updates: Der automatische Updateprozess prüft täglich auf Verfügbarkeit einer neueren Modulversion. Wenn die Kompatibilitätsangabe einer neueren Version mit der eingesetzten STARFACE-Version übereinstimmt und es sich nicht um ein kostenpflichtiges Upgrade handelt, wird dieses automatisch installiert.
   Mögliche Funktionseinschränkungen nach Auto-Update

   Der automatische Updateprozess kann nicht die Kompatibilität mit anderen Drittanbietermodulen sicherstellen. Unter Umständen erfordern Updates auch eine Anpassung der Konfiguration. Wir empfehlen automatische Updates daher nicht für Umgebungen der kritischen Infrastruktur einzusetzen oder wenn Funktionsunterbrechungen ernsthafte Folgen haben können.

   Aus diesem Grund wurde bewusst die Entscheidung getroffen – in Übereinstimmung mit Ausnahmeregelungen für IKT-Systeme des Cyber Resilience Act – die automatische Updatefunktion nicht standardmäßig zu aktivieren, sondern diese per Opt-In (anstatt Opt-Out) zur Verfügung zu stellen.

5. EBackup & Konfiguration-Import/Export:
   Die Einstellungen eines Moduls lassen sich für Archivzwecke oder der Verwendung in anderen Installationen exportieren/speichern. Jede Nacht wird ein automatisches Backup der Moduleinstellungen erstellt. Die Backups der letzten 10 Tage werden aufbewahrt. Versehentliche Konfigurationsänderungen lassen sich so leicht rückgängig machen.

Konfiguration

1. Ereignis auswählenAnruf, Konfigurationsänderung, An-/Abmeldung, und vieles mehr

   Ereignis auswählen

   Zustandsänderungen werden innerhalb der STARFACE durch das Versenden von Events propagiert. Verschiedene Komponenten können auf Zustandsänderungen reagieren, indem sie die entsprechenden Events verarbeiten.

   Um Herauszufinden, welche Arten von Events existieren und welches konkrete Event als Auslöser für eine bestimmte Reaktion tauglich ist, haben Sie zwei Möglichkeiten:

   1. Sie können eine gewünschte Zustandsänderung herbeiführen und das Eventsystem der STARFACE live beobachten.
   2. Im Abschnitt STARFACE Events finden Sie eine Vielzahl dokumentierter Ereignisse inklusive ihrer Eigenschaften.

   Im Auswahlmenü (1) kann das gewünschte Event ausgewählt oder manuell eingegeben werden:

   

   Ausgewähltes Event
2. Zugriff auf Event-DatenAuswahl der zu verwendenden Daten
3. Bedingung definierenIn welchen Fällen soll auf das Event reagiert werden?
4. Reaktion konfigurierenWebAPI aufrufen, E-Mail versenden, im Log protokollieren, neues Event generieren

Weiterführende Informationen

🗃Beispielkonfigurationen

13 Einträge

🗃STARFACE Events

7 Einträge

📄️n8n

Was ist n8n?