Pushprofil erstellen¶

In diesem Abschnitt wird die Erstellung/Bearbeitung von Push-Profilen erläutert. Die Push-Profile können unter Datei… -> Einstellungen bearbeitet werden.

In den Entwicklermodus wechseln¶

Vorhandene Accounts können editiert und erweitert werden. Dies geschieht im Entwicklermodus. Im Entwicklermodus lassen sich alle Kommunikationsparameter wie Serveranfrage, Auswertung der Serverantwort, Anzahl Accountparameter etc. einstellen. Der Entwicklermodus kann nur für nicht systemweite Accounts gestartet werden. Sie können einen systemweiten Account kopieren (Bearbeiten… -> Kopieren), um ihm zu einem nicht systmweiten Account zu machen. Der Entwicklermodus kann gestartet werden, indem in den Accounteinstellungen der Knopf Entwickler-Modus gedrückt wird.

Erstellen der Serveranfrage¶

Folgende Parameter lassen sich im Reiter Anfrage konfigurieren:

Name: Frei wählbarer Name der den Account in BosMon identifizieren soll.
Beschreibung: Frei wählbare Beschreibung des Accounts
URL: URL des Anbieters über die Push-Nachrichten verschickt werden.
Methode: Methode zur Datenübermittlung, mögliche Einstellungen sind GET oder POST.
POST Content-Type: Content-Type der bei Übertragung der Daten per POST gesetzt wird.
Parameter: Parameter die dem Anbieter bei der Übermittlung der Nachrichten übergeben werden sollen.

Welche Daten in die Felder URL‘ und Parameter eingetragen werden müssen bzw. können hängt vom jeweiligen Anbieter ab. BosMon legt bereits Konfigurationen für die Anbieter NMA und Prowl an.

Es können Variablen benutzt werden, die von BosMon automatisch durch die richtigen Werte ersetzt werden. Folgende Variablen werden von BosMon ersetzt:

%message% Die zu übermittelnde Push-Nachricht. Der Inhalt der Nachricht wird über die Aktion in den Telegrammereignissen definiert.
%title% Betreff der Push-Nachricht. Dies ist der Name des Telegrammereignisses.
%address% Empfänger der Push-Nachricht.
%field1% Benutzerparameter.
%field2% Benutzerparameter.
%field3% Benutzerparameter.
%field4% Benutzerparameter.
%*field5%* Benutzerparameter.

Auswerten der Serverantwort¶

Standardmäßig geht BosMon davon aus, dass die Nachricht erfolgreich übermittelt wurde wenn der Webserver den HTTP-Code 200 (OK) zurückliefert. Dieses Verhalten kann verändert werden, indem im Reiter Script Programmcode zur Auswertung der Serverantwort hinterlegt wird. Der Programmcode muss in C# geschrieben sein. Es wird die folgende Methode erwartet:

public static bool ProcessResponse(int httpCode, String[] header, String content, out String result) {
}

Folgende Parameter werden der Methode übergeben:

httpCode: HTTP Code des Webserver (Beispiel: 200)
header: String Array alle vom Webserver zurückgelieferten Header, pro Zeile ein Array-Eintrag.
content: Inhalt (Body) der HTTP Antwort des Servers.
result: Result muss mit einem Text gefüllt werden. Dieser Text wird in der Statuszeile und in dem Ereignisfenster angezeigt

Rückgabe-Wert:

Die Methode soll true zurückgeben, wenn die Serverantwort besagt, dass die Nachricht übermittelt wurde und false falls der Server einen Fehler zurückgegeben. hat.

Variablen vorbereiten¶

Es ist unter Umständen erwünscht, dass einige Variablen die für die Push-Nachricht verwendet werden vorab geprüft und/oder modifiziert werden. Über die Methode PrepareVariables lassen sich die im System vorhandenen Variablen verändern.

public static void PrepareVariables(System.Collections.Generic.IDictionary<String, String> variables) {
}

Felder für Benutzerparameter¶

Bei einigen Anbietern ist es notwendig benutzerspezifische Daten zu übertragen (Benutzername, Passwort etc.). Im Reiter Felder lassen sich bis zu 5 Felder definieren, die dem Benutzer im Reiter Einstellungen angezeigt werden. Die Inhalte dieser Felder stehen als Variablen %field1% bis %field5% im Reiter Anfrage zur Verfügung. Ist das Feld „Notwendig“ aktiviert, so muss dieses Feld vom Nutzer ausgefüllt werden bevor der Account benutzt werden kann.