Eigene Connect Addons installieren
Ab Customer Service powered by GREYHOUND 5.5 gibt es im Customer Service Server die Möglichkeit, eigene Addons ausrollen zu können, die automatisch an alle Customer Service Clients verteilt werden. Dazu gibt es im Updates-Ordner des Customer Service Servers einen Unterordner namens “CustomAddons”. Dort hinein müssen eine addon.ini und eine oder mehrere Zip-Dateien. Was das genau bedeutet und wie man sich ein eigenes Addon für Customer Service powered by GREYHOUND baut, ist in diesem Artikel beschrieben.
Achtung
Eigen entwickelte Addons können von unserem Kundenservice nicht supportet werden. Die Verantwortung liegt beim Kunden selbst. Dieser Artikel richtet sich an Experten und Kenner von Customer Service powered by GREYHOUND mit tiefgreifendem IT-Knowhow.
Wie sind Addons von Customer Service powered by GREYHOUND aufgebaut?
Ab Customer Service powered by GREYHOUND 5.5 ist es möglich, eigene Addons im Customer Service Server zu hinterlegen, die automatisch an alle Customer Service Clients verteilt werden. Dazu gibt es im Installationsverzeichnis des Servers einen Unterordner GREYHOUND\Server\Updates\CustomAddons. In diesem Ordner muss für jedes Addon ein eigener Unterordner angelegt werden. In diesem wird dann das Addon als Zip-Archiv abgelegt und eine Datei namens addon.ini, die folgendes Format haben muss:
[Global]
Name=myAddon
[1.0.0.100]
Filename=myAddon_1.0.0_build_100.zip
MinGreyhoundVersion=5.0.0.0
MaxGreyhoundVersion=6.0.0.0
In diesem Beispiel heißt das Addon “myAddon“, der Ordner wurde ebenfalls “myAddon” genannt und in der addon.ini als Name auch “myAddon” eingetragen. Der Name der Zip-Datei ist beliebig, aber der Übersichtlichkeit halber empfiehlt es sich, hier den Namen des Addons und die Version zu verwenden.
Die Datei addon.ini liegt also in folgendem Pfad: GREYHOUND\Server\Updates\CustomAddons\myAddon\addon.ini
Die Zip-Datei enthält die Erweiterungen von Customer Service powered by GREYHOUND (im Unterordner “extensions”) und ggf. HTML, Javascript, CSS oder PHP Dateien des Addons. Dabei muss die Zip-Datei so erzeugt werden, dass kein Unterordner “myAddon” auf oberster Ebene der Zip-Datei liegt, sondern direkt der Inhalt des “myAddon” Ordners:
myAddon_1.0.0_build_100.zip:
- css
- greyhound.css
- greyhound-lite.css
- greyhound-none.css
- extensions
- myAddonPreviewHeader.ghExtension
- myAddonSidebar.ghExtension
- myAddonWindow.ghExtension
- previewHeader.php
- sidebar.php
- window.php
Die “.ghExtension” Dateien sind Erweiterungen, die über den Customer Service Client angelegt und exportiert wurden. Die Benutzergruppen-Zuordnung spielt beim Exportieren einer Erweiterung für ein Addon keine Rolle, da der Customer Service Server Erweiterungen aus dem “extensions” Ordner von Addons beim ersten Importieren automatisch für alle Benutzergruppen sichtbar macht.
Folgendes Beispiel enthält die oben beschriebene addon.ini und Zip-Datei. Diese Dateien können als Vorlage für eigene Addons verwendet werden. Die beigelegten Stylesheets können dafür verwendet werden, die Erweiterungen so aussehen zu lassen, dass sie sich optisch in den Customer Service Client einfügen.
Installation eigener Addons
Wenn im Order GREYHOUND\Server\Updates\CustomAddons ein Unterordner mit “addon.ini” und einer (in der addon.ini aufgeführten) Zip-Datei vorliegt, installiert der Customer Service Server das Addon automatisch, wenn …
- der Customer Service Server neu gestartet wird ODER
- im Customer Service Client im Menu “Administration” der Eintrag “Addons aktualisieren” ausgewählt wird.
Die Customer Service Clients erhalten das Addon dann, wenn sie sich das nächste Mal mit dem Customer Service Server verbinden. Das heißt: Um ein Addon im laufenden Betrieb zu installieren, legt man in CustomAddons einen Unterordner an, legt dort die addon.ini und die Zip-Datei ab, ruft im Client “Administration > Addons aktualisieren” auf und startet dann die Customer Service Clients einmal neu.
Automatische Updates für eigene Addons
Updates laufen ähnlich einfach wie die Installation: Die Zip-Datei mit der neuen Version des Addons wird in den Unterordner des CustomAddons Ordners gelegt und in der addon.ini die Versionsnummer und der Dateiname der Zip-Datei angepasst. Dann wird, wie bei er Installation, “Administration > Addons aktualisieren” ausgewählt und die Customer Service Clients neu gestartet. Der Customer Service Server merkt sich, welche Version von welchem Addon installiert ist und aktualisiert das Addon automatisch, wenn in der addon.ini eine höhere Versionsnummer eingetragen ist als vorher.