Preface
This documentation is valid as of the iQueue pro/iPro UC-Analytics version 13.1.1.
The connection to the Starface was completely revised with the release 13.1.1. The call data is now actively transferred to the UC-Analytics from Starface via http/https, using a STARFACE CDR-Connector module. Please download the latest version of this module here: aurenz download
The configuration screenshots and functions described in this document refer to STARFACE 7.0 (7.0.2.1).
This document describes the data transfer from STARFACE via the module CDR-Connector. In order to make this work, the UC Analytics PC and the STARFACE must be connected to LAN. The data is transferred via HTTP or HTTPS (make sure that the corresponding ports are not blocked by a firewall).
Before CDR transfer, the STARFACE and the UC-Analytics must be prepared which is described in the next sections.
Configuration of the STARFACE
The settings described here are intended as a guide and may differ from the actual configuration. With these settings, the connection between STARFACE 7.0 and UC-Analytics (as of the version 13.1.1.02) is working.
Set up STARFACE CDR Connector module
Log in to the STARFACE admin interface and go to the item module.
Import STARFACE CDR connector module
Go to the item module library where the already installed modules are listed. If the module STARFACE CDR-Connector is not available here, it must be imported. To do this, select the item import module and choose the corresponding "sfm" file under install module via upload (in this case, it is the file "STARFACE_CDRConnector_v114.sfm" - the file name may differ). Press next to import the module.
Create configuration Aurenz CDR Connector
The previous process only imports the module, but does not yet create a configuration. To create a configuration, please click new configuration under module configuration and select "STARFACE_CDRConnector_vxxx". By clicking create, a new configuration for this module is created.
Here, adjustments are still necessary:
- Under general a name must be given, (e.g.: "Aurenz-CDR-Connector") then press apply.
- In addition, a password must be assigned for communication. To do this, set an appropriate password in configuration under password protection and press apply.
- The parameters name and password are required when configuring the data source in UC-Analytics and they must match!
Connection of UC-Analytics via a Starface module
Installation of the UC-Anayltics software
Start the setup from the iQueue pro/ iPro UC-Analytics download and follow the instructions of the installation routine. For standard installations, default settings of the installation wizard can be used. After the installation, you will be asked whether you want to setup the connection to the telephone system immediately or later, select "Install now" and carry out the following steps (all settings can be changed via the configuration tool datacollector later on).
Selecting the phone system
When choosing the data source, select the manufacturer Starface and then as type Starface module.
Setting the parameters
It is important to set the correct location of the pbx outbreak if you want to use the accounting features. Based on the location of the outbreak and the call destination the call costs will be calculated. The data source can be saved with its own name.
The data source has now been created but must yet be configured. To do this, go to the TAB Starface module and enter the corresponding parameters.
Register Starface module
The parameters have the following meaning:
- IP address of the STARFACE: This is the IP address (or DNS) of the STARFACE.
- Port number: The module port to be used must be entered here (normally port 80 for HTTP and port 443 for HTTPS).
- Secured connection (SSL): If HTTPS is to be used, this must be activated (and the port adjusted accordingly).
- Login ID: The "login ID" of a user in STARFACE. With this user the login into the STARFACE module will be performed.
- Login Password: The corresponding password to the "Login ID".
- Module configuration name: This is the name of the "configuration" that was created in STARFACE like described before.
- Module configuration password: This is the password of the "configuration" that was set in module configuration like described before.
- Limit for query (number of data): This can be used to define how many CDRs are retrieved per query.
- 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).
- Poll interval (seconds): In this interval, new CDRs are queried during a permanent data connection. (Note: Don't set this point too low, or else the STARFACE database could be overloaded).
Please check if the connection based on that parameters can be establish through clicking the "test" button.
Register "Verzeichnis scannen"
“Scan Directory” TAB
Bei der Einrichtung der Datenquelle wird der Pfad schon "korrekt" vorbelegt und es sind hier keine weiteren Konfigurationen notwendig
When setting up the data source, the path is already "correctly" pre-set and no further configurations are necessary here.
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.
The data which is retrieved from STARFACE is first copied into a directory (and stored there as a file). For this, a path must be entered where the files are to be stored. The files are then processed from this path.
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).
There is still the option to save raw data ("copy imported files into a backup directory"). This enables the CDRs to be imported again later if necessary (if the data is no longer available in STARFACE).
Weitere Einstellungen der Datenquelle (nicht STARFACE spezifisch)
Other data source settings (not STARFACE specific)
In den weiteren Reitern können zusätzliche Konfigurationen vorgenommen werden. Diese sind nicht STARFACE spezifisch.
Additional configurations can be made in the other TABs. These are not STARFACE specific.
Registerkarte „Allgemein"
TAB “General“
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.
This TAB allows you to enter a customised name for the STARFACE data source, the assigned data recording is pre-set and does not need to be changed.
Registerkarte „Kommunikationssystem"
TAB “Communication system“
Diese Registerkarte dient der Festlegung des Standortes des Telefonsystems sowie des genutzten Netzanbieters, welcher zur Preisberechnung der einzelnen Telefonate herangezogen wird.
This TAB is used to define the location of the telephone system as well as which network carrier is used to calculate the price of the individual telephone calls.
Bitte Beachten
Please consider
- 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.
- The settings for the used network carrier are made in the UC-Analytics administrator under File / Set up programme / Network carrier. Further descriptions can be found in the UC-Analytics manual.
- Die Einstellungen im Reiter Access haben für die STARFACE keine Bewandtnis.
- The settings in the Access TAB have no relevance for STARFACE.
Registerkarte „Zeitfenster"
TAB “Time slot“
Über diese Registerkarte legen Sie fest, an welchen Wochentagen und zu welchen Zeiten die Daten aus der STARFACE verarbeitet werden.
Use this TAB to define on which days of the week/ times of the day the data from STARFACE shall be processed.
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.
Note
If "permanent connection" is selected for the interval, the parameter "poll interval" (on the TAB "Starface module") comes into effect. I.e. new CDRs are retrieved from STARFACE after the amount of seconds defined in "poll interval".
Registerkarte „Nebenstellen"(Optional)
TAB “Extensions“(optional)
Option zur Einstellung, welche Nebenstellen zur Gesprächsverarbeitung herangezogen werden sollen.
Here you have the option to set which extensions to use for call processing.
Registerkarte „Fax-Nebenstellen" (Optional)
TAB “Fax extension“(optional)
Bei Nutzung der der Option Faxnebenstellen wird hier der/die Präfix(e) der Faxboxen eingetragen.
When using the fax extensions option, the prefix of the FAX Boxes is entered here.
Beispiel: Nebenstelle Müller = 115 / Faxbox Müller = 98115
Example: Extension Johnson = 115 / Fax Box Johnson = 98115
Achtung:
Dieses Merkmal wird nicht von allen TK-Anlagen unterstützt!
Warning:
This feature is not supported by all PBXs!
Test der Installation
Testing the installation
Verbindungstest
Connection test
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".
To verify whether a connection to STARFACE (and to the module) can be established with the entered parameters, you can use the connection test. This can be found on the TAB "Starface module".
Beispiel einer erfolgreichen Verbindung
Example of a successful connection
Beispiel fehlerhafte Verbindung
Example of an incorrect connection
Bei diesem Beispiel ist die Login-ID falsch!
In this example, the login ID is incorrect!
Bei diesem Beispiel ist der "Modul Konfiguration Name" falsch!
In this example, the "module configuration name" is incorrect!
Datenabholung
Data collection
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".
Start the UC-Analytics data collection and open the data source overview window through the menu item "Telephone Systems → Overview". Highlight your telephone system and select the menu item "Telephone systems → Data set monitor".
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.
Make some test calls via STARFACE. If the data source is not set to "permanent connection", select "telephone systems → connect" in the menu, so that the collected data will be processed.
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.
You can check the transfer using the two monitor windows. The overview monitor window shows the transfer of the data and the data set monitor window shows its interpretation.
The data set monitor should be closed after the tests are completed.