Modulaktivierung

Dokumentation für Modulversion 1.2.1 ab STARFACE 8.1.0.4

Produktbeschreibung

Durch die Erweiterung “Modulaktivierung” für STARFACE besteht die Möglichkeit, vorab eingerichtete Modulinstanzen bequem per Anruf einer definierten internen oder externen Rufnummer zu aktivieren oder zu deaktivieren.

Dadurch erhält ein STARFACE Benutzer oder externer Teilnehmer die Möglichkeit Modulinstanzen, wie z.B. eine temporäre zeitgesteuerte Umleitung außerhalb der Geschäftszeiten, auch ohne Berechtigung zu aktivieren/deaktivieren.

Anwendungsbeispiel

Mit diesem Modul können andere Module per Anruf aktiviert oder deaktiviert werden. Dies ermöglicht es normalen Benutzern ohne Adminrechte bestimmte Module zu steuern. Zudem wird auch eine Steuerung von extern möglich.

Technische Voraussetzungen

  • ab STARFACE 8.1.0.4

  • Für dieses Modul stehen legacy Versionen ab STARFACE 8.0.0.5 zur Verfügung.

  • Server mit Docker, mind. 4 Core, 8GB Ram, 12GB HDD

Vorbereitung der IT-Umgebung:

Docker installieren

  • Per SSH Shell auf dem Server anmelden.

  • Docker Key Hinzufügen mit folgendem Befehl.

sudo apt-get update
sudo apt-get install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc
  • Docker Repository zu den APT Quellen hinzufügen.

echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
  • Docker Installieren.

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
  • Installation verifizieren mit Hello-World Programm.

sudo docker run hello-world

STARFACE-Konfiguration

  • Es muss vorab keine Konfiguration in der STARFACE vorgenommen werden.

Modulkonfiguration

Allgemein

allgemein
  • Name:

    • Wähle hier den Namen der Modulinstanz. Dieser Name sollte möglichst beschreibend vergeben werden, ein guter Ausgangspunkt ist der Name des Moduls. Sollen mehrere Instanzen des selben Moduls aktiv sein, muss für jede Instanz ein einmaliger Name vergeben werden.

  • Beschreibung:

    • Dieses Feld bietet Raum für eine detailliertere Dokumentation der Instanz. Hier kann beispielsweise dokumentiert werden, auf welche Nutzer/Gruppen das Modul zugreift.

  • Logdatei:

    • Jedes Modul informiert in den Leveln "ERROR, WARN, INFO, DEBUG, TRACE" in den jeweils verschiedenen Abstufungen über Prozesse, die im Modulbetrieb ablaufen. Falls ein Fehler auftritt hat man hier die Möglichkeit, die Logdatei zu speichern. Standardeinstellung ist das Level "INFO".

Das Log aktualisiert sich nicht automatisch, sondern nur, wenn die entsprechende Schaltfläche betätigt wird.

Rufnummern

rufnummern

Hier können interne und externe Rufnummern eingetragen werden.

Beachte, dass man durch das hinterlegen von externen Rufnummern flexibler ist, da das Modul auch von einer externen Rufnummer (also z.B. von unterwegs) aktiviert werden kann.

Die eingetragenen Rufnummern können angerufen werden, um die eingestellte Modulinstanz zu aktivieren oder diese zu deaktivieren.

Konfiguration

konfiguration

Modulinstanz

Hier wird der Instanzname der Modulinstanz eingetragen, die aktiviert oder deaktiviert werden soll.

Ansagen

Hier können individuelle Ansagen für das erfolgreiche Aktivieren oder Deaktivieren von Modulen hochgeladen werden.

  • Aktivierungsansage

    • Audiodatei (.wav) zum Hochladen auswählen. Diese Audiodatei wird bei erfolgreicher Modulinstanzaktivierung abgespielt.

  • Deaktivierungsansage

    • Audiodatei (.wav) zum Hochladen auswählen. Diese Audiodatei wird bei erfolgreicher Modulinstanzdeaktivierung abgespielt.

Text to Speech Ansagen

Hier kann ein Text für eine KI-generierte Sprachansage eingegeben werden, anstatt eine Audioansage hochzuladen. Für die Einrichtung und den Betrieb des Moduls wird eine SSH verbindung zum Dienstserver benötigt. Beim ersten Start des Moduls erscheint im Log der Fingerprint, der für die Konfiguration der SSH Verbindung benötigt wird. Beim ersten ausführen des Moduls wird ein Dienst auf dem Server installiert. Dies kann unter Umständen eine Weile dauern.

  • SSH-Server:

    • Definiere hier die IP-Adresse oder den DNS-Namen des SSH-Servers.

  • SSH-Port:

    • Gebe hier den Port an, über den die Kommunikation zum SSH-Server laufen soll (Standardwert: 22).

  • SSH-Benutzer/Passwort:

    • Definiere hier den Benutzer mit entsprechenden Lese- und Schreibrechten auf das gewählte Zielverzeichnis.

  • SSH-Zielverzeichnis:

    • Wähle hier das Zielverzeichnis aus, in dem das Modul arbeiten soll.

  • Fingerprint:

    • Gebe hier den Fingerprint ein, der beim ersten Modulstart im Log hinterlegt wurde.

Das Zielverzeichnis muss bereits existieren und es muss der absolute Pfad angegeben werden.
Für die Installation des Text-to-Speech-Service wird ein Server mit Docker und mind. 12GB freiem Speicherplatz benötigt.

Bekannte Probleme

  • Bei diesem Modul liegen keine bekannten Probleme vor.

  • Problem entdeckt? Schicke eine E-Mail an support@o-byte.com, um Fehler zu melden!

Versionshinweis

  • 1.2.1

    • Bugfix:

      • Namensänderung von "ModuleActivation" zu "Modulaktivierung"

      • kleinere Anpassungen in den Formulierungen der Konfiguration

    • Feature:

      • Text-To-Speech-Funktion für Ansagen hinzugefügt

Download

Bitte achte beim Download auf die Kompatibilität zur STARFACE Version!

Mit Klick auf den Downloadlink einer Modulversion öffnen sich ein Fenster mit Installationshinweisen und ein Pop-up-Fenster.

Modul testen:

  • Wir stellen unser Modul 14 Tage kostenfrei zum Testen zur Verfügung.

  • Nach dem Kauf oder Update: Mit E-Mail-Adresse verifizieren. Für die Inbetriebnahme/das Update ist kein Lizenzschlüssel nötig.

  • Wir stellen das Modul als .sfm Datei zur Verfügung.