Anschlussbeschreibung STARFACE Modul

Vorwort

Diese Dokumentation ist gültig ab der UC-Analytics Version 13.1.1.

Neuer STARFACE CDR-Connector v204 für STARFACE 7.3.x nötig
Für die STARFACE Version 7.3.x muss der CDR-Connector v204 genutzt werden. → https://www.aurenz.de/de/support/downloads.html
Achtung: STARFACE CDR-Connector v204 funktioniert nur mit STARFACE Version 7.3.x.

Neuer STARFACE CDR-Connector v210 für STARFACE 8.x nötig
Für die STARFACE Version 7.3.x muss der CDR-Connector v204 genutzt werden. → https://www.aurenz.de/de/support/downloads.html
Achtung: STARFACE CDR-Connector v210 funktioniert nur mit STARFACE Version 8.x.

Bis zur Starface Version 7.2.0.4 besteht leider ein kleiner Bug innerhalb der Modul-Konfigurationsmasken:
Eine Änderung in einem Reiter unseres Modul's "aurenz CDR-Connector" führt unter Umständen dazu, dass das hinterlegte Kennwort für die aurenz-Software "verschwindet".
Details finden Sie hier: Anschlussbeschreibung STARFACE Modul#Kontrolle_Passwort__STARFACE_CDR_Connector



Die in diesem Dokument beschriebenen Konfigurationsmasken und Funktionen beziehen sich auf STARFACE ab 7.0 (7.0.2.1).

Für diese Art der Anschaltung wird ein spezielles Modul "CDR-Connector" für den Abruf der CDR-Daten benötigt!

Das vorliegende Dokument beschreibt die Datenübermittlung über das Modul "CDR-Connector" von der STARFACE. Dazu werden der UC-Analytics PC und das TK-System am LAN angeschlossen. Die Übertragung der Daten erfolgt mittels HTTP oder HTTPS (die entsprechenden Ports dürfen nicht von einer Firewall blockiert werden).

Vor einer Übertragung müssen das Telefonsystem und UC-Analytics vorbereitet werden. Dazu ist es notwendig, Einstellungen vorzunehmen welche die STARFACE veranlassen die Daten über die entsprechende Schnittstelle auszugeben. Auch UC-Analytics muss vorbereitet werden um die entsprechenden Daten entgegenzunehmen.

Einstellung des Telefonsystems STARFACE

Die hier beschriebenen Einstellungen sind als Hilfestellung gedacht und können von der tatsächliche Konfiguration abweichen. Mit diesen Einstellungen funktioniert die Anbindung zwischen einer Telefonanlage STARFACE 7.0 und UC-Analytics (ab Version 13.1.1.02).

Modul STARFACE CDR-Connector einrichten

Melden Sie sich an der STARFACE Admin-Oberfläche an und gehen Sie zu dem Punkt "Module".

Falls Sie das Modul "STARFACE_CDR_Connector" aktualisieren, beachten Sie bitte das Vorgehen bei "Update STARFACE CDR-Connector"!

Sobald Sie im Modul Änderungen vornehmen und "Speichern" oder "Übernehmen" drücken, kontrollieren Sie bitte nochmals, ob das Passwort noch gesetzt ist! Das Vorgehen ist beschrieben unter "Kontrolle des Passwort im STARFACE CDR-Connector".

Modul STARFACE CDR-Connector importieren

Gehen Sie zu dem Punkt "Modul-Library". Dort werden die bereits installierten Module aufgelistet. Wenn dort das Modul "STARFACE CDR-Connector" noch nicht vorhanden ist, dann muss dieses zuerst importiert werden. Wählen Sie dazu den Punkt "Modul importieren" und wählen Sie unter "Modul mittels Upload installieren" die entsprechende "sfm"-Datei aus (In diesem Beispiel ist dies die Datei "STARFACE_CDRConnector_v114.sfm" -der Dateiname kann ggf. abweichen). Durch Drücken von "Weiter" wird das Modul importiert.

Konfiguration Aurenz-CDR-Connector anlegen

Durch den vorherigen Vorgang wird nur das Modul importiert, jedoch noch keine "Konfiguration" angelegt.

Um eine "Konfiguration" anzulegen, muss unter "Modul-Konfiguration" der Punkt "Neue Konfiguration" ausgewählt und "STARFACE CDR-Connector" gewählt werden. Durch Drücken auf "Erstellen" wird eine "Konfiguration" angelegt.

Hier sind jetzt noch Einstellung notwendig.

Unter "Allgemein" muss hier ein Name vergeben werden (z.B.: "Aurenz-CDR-Connector") und drücken Sie "Übernehmen".

Zusätzlich muss noch ein Passwort für die Kommunikation vergeben werden. Dazu unter "Konfiguration" unter "Passwortschutz" ein entsprechendes Passwort festlegen und "Speichern" drücken.

Ab dem CDR-Connector v185 sind zusätzliche Parameter hinzugekommen. Diese haben folgende Bedeutung:

  • Erstdatenbezug nicht älter als:
    Hier wird das Datum festgelegt, ab welchem die Daten eingelesen werden sollen. Dies wird nur bei der ersten Abfrage beachtet. Speziell wenn eine Anlage schon lange läuft und viele Daten angesammelt wurden, kann eine Abfrage sonst lange dauern. Durch diesen Parameter kann dies eingeschränkt werden.

  • Datensammlung ("Gruppen Login/Logouts Sammeln" und "Telefoniestatusänderungen von Benutzern Sammeln")
    Diese beiden Parameter dienen dem "Debugging" und sollen bei der Analyse von Performance-Problemen helfen. Werden diese Parameter "deaktiviert", so werden die entsprechenden Daten nicht mehr gesammelt und fehlen damit in der Analyse. Somit ist dies nur temporär zu deaktivieren.

Update STARFACE_CDR_Connector

Beim Aktualisieren des STARFACE_CDR_Connector ist auf das korrekte Vorgehen zu achten. Bitte halten Sie hierzu folgende Schritte ein:

  1. Das "Modul" stoppen. Hierzu in das Modul (in Modul-Konfiguration) gehen, auf der Seite "Konfiguration" bei dem Punkt "Dienst" auf "Stoppen" umschalten und "Speichern" drücken.

  2. Nun kann das Modul aktualisiert werden.

  3. Das Modul wieder starten. Hierzu in das Modul (in Modul-Konfiguration) gehen, auf der Seite "Konfiguration" bei dem Punkt "Dienst" auf "Starten" umschalten und "Speichern" drücken (zuvor nochmals sicherstellen, dass das "Passwort" eingetragen ist - d.h. es müssen hier "Punkte" erscheinen).

  4. Nochmals kontrollieren, ob das "Passwort" übernommen wurde (siehe "Kontrolle des Passwort im STARFACE CDR-Connector"),

Kontrolle des Passwort im STARFACE CDR-Connector

Werden im Modul Änderungen vorgenommen und "Speichern" oder "Übernehmen" gedrückt, so sollte nochmals kontrolliert werden, ob das "Passwort" noch gesetzt ist. Hierzu sind folgende Schritte durchzuführen:

  1. In der STARFACE Administration den Punkt "Module" wählen (Modulmanager).

  2. Im Reiter "Modul-Konfiguration" das Modul "STARFACE CDR-Connector" auswählen und bearbeiten (auf den "Stift" drücken).

  3. Auf den Reiter "Konfiguration" gehen und im Feld "Passwortschutz" sollten nun "Punkte" erscheinen - das Passwort ist gesetzt. Sollte das Feld leer sein, so ist das "Passwort" nicht gesetzt und muss neu gesetzt werden!

Administrator User in der Starface Konfiguration

Der Benutzer mit dem die Daten aus dem CDR-Conntector abgefragt werden muss alle Administratoren-Rechte haben.

 

Live-Dashboard

Um das Live-Dashboard für die STARFACE iQueue nutzen zu können, muss in der jeweiligen iQueue unter “Konfiguration” → “Gruppen” → “iQueue” → “Auswertung” folgende Option aktiv sein:

  • “Live-Schnittstelle aktivieren”

  • “History-Schnittstelle aktivieren”

 

Anschaltung von UC-Analytics über Starface Modul

Installation der Software UC-Anayltics

Starten Sie das Setup und folgen Sie den angezeigten Hinweisen der Installationsroutine. Nach der Installation werden sie gefragt ob Sie die Anbindung an das Telefonsystem sofort oder später installieren möchten, wählen sie „Jetzt installieren" und führen sie die folgenden Schritte aus (alle Einstellungen lasen sich später über die Konfigurationsoberfläche abändern oder ergänzen).

Auswahl des Telefonsystems

Bei Auswahl der Datenquelle wählen Sie den Hersteller "Starface" und dort den Typ "Starface Modul" aus.

Einstellen der Parameter

Wichtig ist die Einstellung des Standortes des TK-Systems. Die Datenquelle kann mit einer eigenen Bezeichnung gespeichert werden.
 

Die Datenquelle wurde nun angelegt und muss noch konfiguriert werden. Gehen Sie dazu auf den Reiter "Starface Modul" und tragen Sie die entsprechenden Parameter ein.

Register "Starface Modul"

Die Parameter haben folgende Bedeutung:

  • IP-Adresse der Telefonanlage: Dies ist die IP-Adresse (oder DNS) der STARFACE.

  • Port-Nr.: Hier muss der zu verwendende Port eingetragen werden (normalerweise Port 80 für HTTP und Port 443 für HTTPS).

  • Gesicherte Verbindung (SSL): Falls HTTPS verwendet werden soll, muss dies aktiviert werden (und der Port entsprechend angepasst werden).

  • Login ID: Dies ist eine "Login-ID" eines Benutzers in der STARFACE.

  • Login Kennwort: Das entsprechende Kennwort zu der "Login-ID".

  • Modul Konfiguration Name: Dies ist der Name der "Konfiguration", welche in der STARFACE angelegt wurde (siehe Konfiguration Aurenz-CDR-Connector anlegen).

  • Modul Konfiguration Passwort: Dies ist das Passwort der "Konfiguration", welche in der STARFACE festgelegt wurde (siehe Konfiguration Aurenz-CDR-Connector anlegen).

  • Limit für die Abfrage (Anzahl Daten): Hiermit kann festgelegt werden, wie viele CDR in einer Abfrage geliefert werden.

  • Poll-Intervall (Sekunden): In diesem Intervall werden bei einer Standverbindung neue CDR von der STARFACE abgefragt. (Hinweis: Diese Punkt sollte nicht zu klein gewählt werden, da sonst die Datenbank der STARFACE zu sehr beansprucht wird).

Ob eine Verbindung mit den eingegebenen Daten hergestellt werden kann, kann mittels "Verbindungstest" getestet werden (siehe Anschlussbeschreibung STARFACE Modul#Verbindungstest)

 

Register "Verzeichnis scannen"

Die Daten, welche von der STARFACE abgerufen werden, werden zuerst in ein Verzeichnis kopiert (und dort als Datei abgelegt). Dafür muss ein Pfad eingetragen werden, wo die Dateien abgelegt werden sollen. Aus diesem Pfad werden die Dateien dann verarbeitet.

Hier gibt es noch die Option, die Rohdaten zu sichern ("Eingelesene Dateien in ein Sicherungsverzeichnis kopieren"). Dies ermöglicht, dass die CDR ggf. nachträglich nochmals eingespielt werden können (falls die Daten nicht mehr in der STARFACE vorhanden sind).

Weitere Einstellungen der Datenquelle (nicht STARFACE spezifisch)

In den weiteren Reitern können zusätzliche Konfigurationen vorgenommen werden. Diese sind nicht STARFACE spezifisch.

Registerkarte „Allgemein"

Diese Registerkarte ermöglicht die Eingabe einer kundenspezifischen Bezeichnung für die STARFACE Datenquelle, die zugeordnete Datenaufnahme ist vorbelegt und muss nicht geändert werden.
 


Registerkarte „Kommunikationssystem"

Diese Registerkarte dient der Festlegung des Standortes des Telefonsystems sowie des genutzten Netzanbieters, welcher zur Preisberechnung der einzelnen Telefonate herangezogen wird.
 

Bitte Beachten

  • Die Einstellungen des genutzten Netzanbieters erfolgt in der UC-Analytics Administration unter Datei / Programm einrichten / Netzanbieter. Weiterführende Beschreibungen finden Sie im Handbuch von UC-Analytics.

  • Die Einstellungen im Reiter Access haben für die STARFACE keine Bewandtnis.

Registerkarte „Zeitfenster"

Über diese Registerkarte legen Sie fest, an welchen Wochentagen und zu welchen Zeiten die Daten aus der STARFACE verarbeitet werden.

Hinweis: Wird hier bei Intervall "Standverbindung" gewählt, so kommt der Parameter "Poll-Intervall" (auf dem Reiter "Starface Modul") zum Tragen. D.h. von der STARFACE werden dann nach den im "Poll-Intervall" festgelegten Sekunden neue CDR abgerufen.

Registerkarte „Nebenstellen"(Optional)

Option zur Einstellung, welche Nebenstellen zur Gesprächsverarbeitung herangezogen werden sollen.

Registerkarte „Fax-Nebenstellen" (Optional)

Bei Nutzung der der Option Faxnebenstellen wird hier der/die Präfix(e) der Faxboxen eingetragen.
 
Beispiel: Nebenstelle Müller = 115 / Faxbox Müller = 98115
Achtung:
Dieses Merkmal wird nicht von allen TK-Anlagen unterstützt!

Test der Installation

Verbindungstest

Zur Kontrolle, ob mit den eingegebenden Parametern eine Verbindung zur STARFACE (und zu dem Modul) aufgebaut werden kann, kann mittels "Verbindungstest" geprüft werden. Dieser befindet sich auf dem Reiter "Starface Modul".

Beispiel einer erfolgreichen Verbindung

Beispiel fehlerhafte Verbindung

Bei diesem Beispiel ist die Login-ID falsch!



Bei diesem Beispiel ist der "Modul Konfiguration Name" falsch!

Datenabholung

Starten Sie die UC-Analytics Datenaufnahme und Öffnen Sie durch den Menüpunkt "Telefonanlagen → Übersicht" das Datenquellenübersichtsfenster. Markieren Sie Ihr Telefonsystem und wählen Sie nun den Menüpunkt "Telefonanlagen → Datensatzmonitor".

Führen Sie einige Testgespräche über die STARFACE. Sollte die Datenquelle nicht auf "Standverbindung" eingestellt sein, so wählen Sie im Menü "Telefonanlagen → Verbinden", so dass die gesammelten Daten verarbeitet werden.

Sie können die Übertragung mittels der beiden Monitorfenster überprüfen. Im Fenster Übersichtsmonitor wird die Übertragung der Daten angezeigt und im Fenster Datensatzmonitor deren Interpretation.
Der Datensatzmonitor solle nach Abschluss der Tests geschlossen werden.
 



Sonstiges

Wallboard

Die Anleitung zur Einrichtung eines Dashboards für ein Wallboard finden Sie hier: Wallboard - Dashboard auf einem zentralen Monitor

 

Problembehebung bezüglich Abholung der Daten: CDR + Login Logout + Telefonstatus / Telstate

Die Abholung vn Daten wird anhand von “Keys” realisiert um zu wissen, welche Daten bereits eingelesen wurden und welche nicht.
Sollte es aus verschiedenen Gründen Probleme mit der Starface Datenbank mit den Informationen kommen (Update Backup-Recovery, …) kann hier eine manuelle Korrektur statt finden. DIes ist dann nötig, wenn z. B. die entsprechende Datenbank neu erstellt wurde und nun neue Ereignisse mit IDs versehen werden, die aber bereits abgerufen und verarbeitet wurden.
Achtung: Dies sollte nur von erfahrenen Starface Technikern durchgeführt werden!
Informationen zu den Keys welche verarbeitet wurden finden sich im Installationsverzeichnis hier: C:\ProgramData\Aurenz\iQueue Pro UC-Analytics\PbxBuffers\Pbx<Pbx-Id>.sle

Diese Datei kann mit einem Text-Editor geöffnet und bearbeitet werden.

Es gibt 3 Datenbestände:

a.      CDR (Gesprächsdaten): CDR_CALL_ID und CDR_KEY

b.      Login-Daten: LOGIN_KEY

c.      Telefonstatus: TELSTATE_KEY

Soll nun für einen oder mehrere dieser Datenbeswtände (wieder) von 0 an abgerufen werden:

  • Windows Dienst „UC-Analytics Datenaufnahme“ beenden

  • Aus der Datei die entsprechenden Teile entfernen (damit wird wieder bei 0 begonnen)
    (Beispiel: Will man, dass die CDR wieder von 0 an neu eingelesen werden, dann die beiden Zeilen „CDR_CALL_ID“ und „CDR_KEY“ entfernen).

  • Den Dienst „UC-Analytics Datenaufnahme“ starten und Daten abholen.

Beispiel Dateiinhalt:

CDR_CALL_ID=7272 CDR_KEY=26975 LOGIN_KEY=210 TELSTATE_KEY=64829

 

© aurenz GmbH 2022