Network Issue

Aus Plambee.de Webhosting Wiki
Zur Navigation springen Zur Suche springen

Dieses Modul ermöglicht es Ihnen Störmeldungen zentral zu hinterlegen und Ihre Kunden somit über aktuelle oder geplante Aktionen zu Informieren. Zur Kundeninformation stellt das Modul zum einen eine Übersichtsseite im Kundenbereich zur Verfügung, zum anderen kann der Kunde aber auch eine E-Mail Benachrichtigung abonnieren.

Changelog

Den Changelog finden Sie der Übersichthalber ab sofort nur noch in unserem Dev Tracker. Dort können Sie auch Feature Requests einreichen.

Systemvoraussetzungen

Zur Nutzung des Networkissue Moduls müssen folgende Voraussetzungen erfüllt sein:

  • Lauffähige WHMCS Installation Version 7.x
  • Admin Zugang zu WHMCS
  • FTP Zugang
  • installierter Ioncube Loader (mindestens Version 5.x)
  • PHP mind. in Version 5.6

Installation

  • Loggen Sie sich bitte im Kundenbereich von Plambee.de Webhosting ein und laden Sich dort die aktuelle Version des Networkissue Moduls herunter.
  • Entpacken Sie die .zip Datei auf Ihrem Rechner und laden Sie den Ordner „networkissue“ via FTP in das WHMCS Verzeichnis /modules/addons/
  • Sollten Sie ein WHMCS Theme verwenden welches die „Six Sidebar“ verwendet, laden Sie bitte die „network_issue_menu.php“ aus dem Verzeichnis /includes/hooks/ in das entsprechende Verzeichnis Ihrer WHMCS Installation. Damit Sie das Menü anpassen und erweitern können ist diese Datei nicht verschlüsselt.
  • Wenn Sie möchten das Ihre Kunden über die in WHMCS 6 eingeführte Notification-Bar benachrichtigt werden, laden Sie bitte die „network_issue_alert.php“ aus dem Verzeichnis /inlcudes/hook/ in das entsprechende Verzeichnis hoch. Diese Funktion erfordert ein unterstützendes WHMCS Theme z.B. das Six Template.
  • Wenn Sie Punkt 3&4 durchgeführt haben benötigen Sie noch zusätzliche Lang Strings. Bevor Sie die Lang Dateien aus dem Modularchiv /lang/overrides hochladen vergewissern Sie sich bitte das das entsprechende WHMCS Verzeichnis leer ist. Enthält dieses schon Lang Dateien, überschreiben Sie diese bitte NICHT sondern fügen die im Modularchiv enthaltenen Strings der bestehenden Datei hinzu.
  • Im Ordner /modules/addons/ des Modules sind 3 .tpl Dateien enthalten. Die clientarea.tpl ist das Standardtheme und orientiert sich an dem Six Template, die clientarea-alternative.tpl orientiert sich ebenfalls am Six Template stellt die Meldungen allerdings in Tabellenform dar und die clientarea-five.tpl Datei orientiert sich am Five Template von WHMCS. Zum Ändern des Templates benenne Sie einfach eine der tpl. Dateien in „clientarea.tpl“ um. Alle .tpl Dateien können nach eigenen Wünschen angepasst werden.
  • Loggen Sie sich nun in Ihren WHMCS Adminbereich ein und gehen dort auf „System/Addon Module“
  • In der Addonauflistung suchen Sie nun bitte nach dem Modul „Networkissue“ und klicken dort bitte auf „Aktivieren“ und danach auf „Configure“
  • In dem Feld „Module license“ tragen Sie bitte ihren Lizenzcode ein, diesen finden Sie im Plambee.de Kundenbereich in den Produktdetails.
  • Mit dem Drop-Down Menü „Months to Display“ können Sie auswählen über welchen Zeitraum die Meldungen im Kundenbereich angezeigt werden sollen. Zur Auswahl stehen: 1/3/6/12 Monate
  • Wählen Sie zum Schluss bitte noch aus welche Admingruppen auf das Modul zugreifen können.

Nach Durchführung dieser Punkte ist das Modul vollständig installiert und kann verwendet werden.

Verwendbare Variablen

Das Modul liefert an den Kundenbereich und an die E-Mail Vorlagen unterschiedliche Variablen welche für die Darstellung verwendet werden können. Folgend erhalten Sie eine Auflistung aller möglichen Variablen

Variablen für E-Mail Vorlagen

Das Modul verwendet 2 verschiedene E-Mail Vorlagen. Einmal die Vorlage „Network Issue Occur“ (Meldung erstellt) und die Vorlage „Network Issue Update“ (Meldung geschlossen), aufgrund der verschiedenen Informationen gibt es hier Unterschiede bei den verwendbaren Variablen. Sie können die Variablen auch im Betreff der E-Mail verwenden, so können Sie z.B. den Titel bereits dort mit angeben.

Variablen für Network Issue Occur (Meldung erstellt)

{$description}: Stellt die im Modul hinterlegte Beschreibung dar
{$type}: Zeigt an um welche Art von Meldung es sich handelt z.B. Wartung, Störung,...
{$start_date}: Stellt den ausgewählten Startzeitpunkt dar
{$duration}: Stellt die im Modul hinterlegte geschätzte Dauer dar
{$server_name}: Diese Variable zeigt die betroffenen Server an
{$product_name}: Zeigt das betroffene Produkt an
{$name}: Zeigt den Titel der Meldung an.
{$affecting}: Gibt den Inhalt der zusätzlichen Textzeile bei „Sonstigen“ Meldungen wieder

Variablen für „Network Issue Update“ (Meldung geschlossen)

{$description}: Stellt die im Modul hinterlegte Beschreibung dar
{$type}: Zeigt an um welche Art von Meldung es sich handelt z.B. Wartung, Störung,...
{$start_date}: Stellt den ausgewählten Startzeitpunkt dar
{$end_date}: Zeigt den Zeitpunkt an an dem die Störung beendet wurde
{$server_name}: Diese Variable zeigt die betroffenen Server an
{$product_name}: Zeigt das betroffene Produkt an
{$name}: Zeigt den Titel der Meldung an.
{$affecting}: Gibt den Inhalt der zusätzlichen Textzeile bei „Sonstigen“ Meldungen wieder

Folgende Variablen können zur Darstellung der Störungsdauer verwendet werden:

{$duration_m}: Monate
{$duration_d}: Tage
{$duration_h}: Stunden
{$duration_mi}: Minuten

Zum Verständnis: Baut man die Zeitvariablen so auf:
{$duration_m} Monat(e), {$duration_d} Tag(e), {$duration_h} Stunde(n), {$duration_mi} Minute(n)
würde das in der E-Mail z.B. so aussehen:
4 Monat(e), 7 Tag(e), 1 Stunde(n), 42 Minute(n)

Variablen für den Kundenbereich

{$title}: Überschrift der Meldungen
{$type}: Art der Meldung (z.B. Störung, Wartung,.. kann mittels Sprachdatei geändert werden)
{$affecting}: Zeigt das betroffene Produkt an
{$priority}: Zeigt die bei der Erstellung angelegte Meldungspriorität an
{$descriptions}: Zeigt die bei der Erstellung hinterlegte Fehlerbeschreibung an
{$startdate}: Zeigt den Startzeitpunkt der Meldung an
{$enddate}: Zeigt das Ende der Meldung an
{$duration}: Zeigt die bei Erstellung der Meldung hinterlegte geschätzte Dauer an

Bei geschlossenen Meldungen kann auch im Kundenbereich die Dauer der Meldung genau angezeigt werden. Hierfür stehen folgende Variablen zur Verfügung
{$final_durations_months}: Monate {$final_durations_days}: Tage {$final_durations_hours}: Stunden {$final_durations_minutes}: Minuten

Verwendung

Die Übersichtsseite des Modul besteht aus einer oberen Tableiste mit 3 Punkten und einem Button und einer darunterliegenden Tabelle in der die jeweiligen Meldungen angezeigt werden. In der Tabelle finden Sie neben den Angaben rechts auch eine Möglichkeit Meldungen zu schließen/wiedereröffnen und zu löschen. Wenn Sie bei der Tableiste auf einen der Punkte klicken gelangen Sie zur dazu passenden Meldungsauflistung. Zusätzlich wird das Tab auf dem Sie sich aktuell befinden optisch hervorgehoben.

Anlegen einer Meldung

Um eine neue Meldung anzulegen gehen Sie bitte auf die Modulseite, diese erreichen Sie im Adminbereich über Addons/Networkissue/. Auf der nun erscheinenden Seite klicken Sie nun bitte auf den Button „Neue Meldung erstellen“.

In der nun erscheinenden Maske können Sie nun die Meldung erstellen. Die jeweiligen Felder haben folgende Bedeutung:
Bezeichnung: Hier geben Sie bitte eine Art Überschrift an. z.B. DDoS Attacke Host 123
Betroffene Art: Hier haben Sie die Möglichkeit auszuwählen ob die Meldung für einen Server, einen Dienst/Produkt oder eine Allgemeine Meldung für System oder „Anderes“ sein soll.
Server/Dienst/Andere: Wenn Sie im Schritt davor Server oder Dienst ausgewählt haben erhalten Sie eine vollständige Auflistung alle in Ihrem WHMCS eingerichteten Dienste bzw. Server. Hier wählen Sie nun das betroffene Produkt aus. Mit der Strg-Taste ist eine Mehrfachauswahl möglich. Haben Sie im Schritt davor System oder Anderes ausgewählt erhalten Sie ein Textfeld in dem Sie eine Eingabe machen können.
Art: Bei Art können Sie auswählen um was für eine Meldung es sich handeln soll. Standardmäßig haben Sie hier die Wahl zwischen: Störung, Hinweis, Wartung, System, Allgemeines, Sicherheit. Die Punkte können allerdings auch über die Sprachdateien umbenannt werden.
Priorität: Hier können Sie die Priorität der Meldung angeben.
Status: Hier können unterschiedliche Status ausgewählt werden. Standardmäßig haben Sie hier die Wahl zwischen: Berichtet, Untersuchung, In Bearbeitung, Ausfall, Geplant, Behoben. Aus diese Punkte können mit der Sprachdatei verändert werden.
Beginn: Hier wählen Sie bitte den Startzeitpunkt der Meldung aus, also z.B. seit wann der Ausfall vorliegt.
Ungefähre Dauer: Wenn Sie Ihren Kunden eine ungefähre Dauer des Ausfalls/der Störung nennen möchten/können. Können Sie diese hier eintragen. Es handelt sich um ein Textfeld in dem Sie eingeben können was Sie möchten.
Beschreibung: Im Beschreibungsfeld können Sie Ihre Kunden ausführlicher über die Störung informieren.
E-Mail deaktivieren: Wenn Sie diese Checkbox ankreuzen erhalten die Kunden keine E-Mail Benachrichtigung bzgl. dieser Meldung, auch wenn Sie die Benachrichtigung abonniert haben.

Bearbeiten einer Meldungen

Um eine bestehende Meldung zu bearbeiten klicken Sie in der Übersicht einfach auf die Bezeichnung der jeweiligen Meldung.

Schließen einer Meldungen

Wenn Sie eine Meldung schließen möchten haben Sie hierzu 2 Möglichkeiten. Möglichkeit eins wäre im Bearbeitungsfenster der Meldung den Status auf „behoben“ zu ändern und die Meldung zu schließen. Im Feld „Endzeit“ können Sie den Zeitpunkt angeben zu dem die Störung behoben wurde, wenn Sie das Feld leer lassen wird automatisch der aktuelle Zeitpunkt hinterlegt. Die zweite Möglichkeit wäre ein Klick auf den „Schließen“ Link in der Tabelle. Wenn Sie mehrere Meldungen gleichzeitig schließen möchten können Sie diese mittels der Checkboxen in der Tabelle markieren und mit einem Klick auf den Button „Auswahl Schließen“ schließen. Sobald Sie eine Meldung geschlossen haben werden, sofern der Versand nicht deaktiviert wurde, alle betroffenen Kunden benachrichtigt, zudem wird die Dauer der Meldung berechnet. Beachten Sie bitte. Beim Klick auch „Schließen“ wird die aktuelle Zeit als Endzeitpunkt verwendet.

FAQ

F: Wieso werden keine E-Mails verschickt?
A: Bitte überprüfen Sie ob die E-Mail Vorlagen „Network Issue Occur“, „Network Issue Update“ vorhanden sind und das die E-Mail Einstellungen Ihres WHMCS korrekt sind.

F: Manche Kunden erhalten keine E-Mails
A: Der Kunde muss die E-Mails selbstständig abonnieren. Dies kann er auf der Übersichtsseite im Kundenbereich machen.

Kontakt

Dieses WHMCS Modul wurde von Plambee.de Webhosting entwickelt. Bei Fragen können Sie sich via Support-Ticket unter https://www.plambee.de an uns wenden.