Skip to end of metadata
Go to start of metadata


1. Installation

Bitte beachten Sie unsere Anleitung zur Installation von Modulen.

2. Verwendung

Das Modul versendet an die konfigurierte E-Mail-Adresse eine ausführliche Dokumentation der STARFACE-Telefonanlage. Dieser Mailversand wird durch das Aktivieren der Modulinstanz ausgelöst.

3. Beispielausgabe

4. Template-Anpassung

Generell ist es möglich, ein vollständig eigens gestaltetes Template zu erstellen. Dazu muss das Modul (die SFM-Datei) mit einem Kompressionsprogramm wie 7-Zip o. Ä. geöffnet und editiert werden. Anschließend sollten Sie es auch wieder als SFM-Datei verpacken. Folgende Dateien sollten angepasst werden:

  • documentation.html
  • logo.png
  • style.css
  • credits.txt

Es gilt jedoch, folgende festen Variablen und CSS-Klassen zu beachten:

HTML & Template-Variablen

Zum Anpassen des HTML-Templates einfach die Datei documentation.html ersetzen. Die HTML-Datei enthält Variablen, die bei Ausführung des Moduls durch Anlagen-Informationen ersetzt werden.

VariableErklärung
#DATE#Aktuelles Datum
#TIME#Aktuelle Uhrzeit
#STARFACE-VERSION#Die Version der STARFACE
#LICENCE#Lizenzschlüssel
#APPLIANCE#Typ der STARFACE-Lizenz
#HOSTNAME#Hostname der STARFACE
#IP#IP der STARFACE
#GATEWAY#Genutzter Gateway
#DNS1#Primärer DNS-Server
#DNS2#Sekundärer DNS-Server
#PROXY#Auflistung der Proxy-Einstellungen
#MAILSERVER#Auflistung der Mailserver-Einstellungen
#DEPOSIT#Rufnummer des Abwurfplatzes
#AUTOPROVISIONING#Gibt an, ob Autoprovisionierung aktiviert oder deaktiviert ist
#FEDERATION#Gibt an, ob sich die STARFACE-Anlage in einem Anlagenverbund befindet
#LINE-CONFIGURATION#Tabelle der externen Leitungen
#USERS#Tabelle der STARFACE-Benutzer
#MODULES#Tabelle der Modulinstanzen
#EMPLOYEE#Name des ausführenden Mitarbeiters (siehe Abschnitt credits.txt)
#COMPANY#"Name der Firma (siehe Abschnitt credits.txt)


Die Datei logo.png kann nach Belieben ausgetauscht werden. Die mitgelieferte Datei hat eine Auflösung von 800x141 Pixel.
Um einen reibungslosen Ablauf beim Austausch des Logos zu gewährleisten, wird empfohlen, eine Datei mit ähnlichen Abmessungen zu wählen.

CSS

In der Datei style.css sind folgende CSS-Klassen sind fester Bestandteil und dienen der optischen Anpassung automatisch generierter Tabellen und Listen:

Tabellen:

  • .report-table
  • .report-table td
  • .report-table th
  • .report-table .report-table-odd
  • .report-table .report-table-even

Listen:

  • .ul.report-list


Die Standardwerte lauten wie folgt:

.report-table {
	min-width: 50%;
	border-collapse: collapse;
	border-spacing: 0px;
	border: none #999;
}
.report-table td {
	font-family: Arial, sans-serif;
	font-size: 14px;
	padding: 10px 5px;
	overflow: hidden;
	word-break: normal;
	border: 0px none #999;
	color: #444;
	background-color: #F7FDFA;
	text-align: center;
}
.report-table th {
	font-family: Arial, sans-serif;
	font-size: 14px;
	font-weight: normal;
	padding: 10px 5px;
	overflow: hidden;
	word-break: normal;
	border: 0px solid #999;
	color: #fff;
	background-color: #26ADE4;
}
.report-table .report-table-odd {
	vertical-align: top
}
.report-table .report-table-even {
	background-color: #D2E4FC;
	vertical-align:top
}

ul.report-list {
	list-style: square inside;
	font-size: 14px;
	color: #333;
}

Alle anderen CSS-Klassen sind entweder zu editieren oder ersetzen, je nach eigener Fasson.

credits.txt

Die im Modul hinterlegte Datei credits.txt ist einfach erklärt. Die erste Zeile ist der Name der ausführenden Firma, die zweite gibt den Namen des ausführenden Mitarbeiters an.


Downloads

DatumModulversionGetestet mit STARFACE-VersionDownloadChangelog
03.11.201763
Installationsdokumentation_v63.sfm
30.11.2017130SF 6.4.3.26 - 6.4.3.28Installationsdokumentation_v130.sfm
  • Optimierte Darstellung bei Ausgabe von leeren Werten
  • Optimierte Darstellung bei Ausgabe von leeren Tabellen
  • Kompatibilität mit STARFACE wiederhergestellt
17.01.2018131
Installationsdokumentation_v131.sfm
  • Hilfe-Tab: Update Impressum
24.01.2018132
Installationsdokumentation_v132.sfm
  • Hilfe-Tab: Entfernter Text "Vielen Dank..."
08.03.2018136
Installationsdokumentation_v136_lic2018-1.7.1-2.sfm
  • Auto-Skalierung des Logos
  • Modul "Installationsdokumentation" wird selbst nicht mehr in Doku ausgegeben
  • Rufumleitungen werden in Doku ausgegeben
  • Verwendung des neuen Offline-Lizenzmechanismus 1.7.1
13.03.20181376.4.3.26 - 6.4.3.34
  • Fehler in Link zu Modulresource behoben
26.06.20181386.5.0.30 - 6.6.0.*, 6.7.0.*Installationsdokumentation_v138.sfm
  • Kompatibilität mit STARFACE


FAQ

Frage/ProblemAntwort/Lösung
Das Modullog meldet "org.postgresql.util.PSQLException: FATAL: connection limit exceeded for non-superusers".

Das Verbindungslimit der Datenbank muss erhöht werden:


Diese Anpassung können Sie in der Datei "/var/lib/pgsql/data/postgresql.conf"
unter der Option finden:

  • max_connections = X

Für den Tomcat können Sie diesen DB-Pool in der Datei "/var/lib/tomcat6/webapps/localhost/starface/WEB-INF/starface-config.xml" verändern unter:

  • <property name="dbConnectionPool_maxActive" value="X" />

Danach noch ein Diensteneustart beider Dienste:

  • service tomcat6 restart
  • service postgresql restart

Weitere Informationen

Haben wir Ihnen geholfen?

Konnten Sie mit dieser Dokumentation alle Ihre Fragen zum Produkt klären und es wie gewünscht in Betrieb nehmen? Wir freuen uns über Ihre Verbesserungsvorschläge - sowohl zum Produkt, als auch zu unserer Dokumentation. Schreiben Sie uns ganz formlos über unsere Kontaktseite. Vielen Dank