Inhaltsverzeichnis - Service

Inhaltsverzeichnis
Einführung ..........................................................................................................................................3
Übersicht ........................................................................................................................................3
Begriffe ...........................................................................................................................................3
Abschnitt für den Projektleiter ............................................................................................................4
Projekt ............................................................................................................................................4
Erstellen eines Projekts ...............................................................................................................4
Löschen eines Projekts ................................................................................................................5
Datenreihen ....................................................................................................................................5
Hinzufügen von Datenreihen .......................................................................................................5
Editieren von Datenreihen ..........................................................................................................5
Löschen von Datenreihen ............................................................................................................6
ID einer Datenreihe herausfinden ...............................................................................................6
IDs aller Datenreihen herausfinden .............................................................................................6
Zustände.........................................................................................................................................7
Hinzufügen von Zuständen ..........................................................................................................7
Editieren von Zuständen .............................................................................................................7
Löschen von Zuständen ...............................................................................................................7
ID eines Zustands herausfinden ...................................................................................................8
Teilnehmer .....................................................................................................................................8
Teilnehmer autorisieren ..............................................................................................................8
Teilnehmer blockieren ................................................................................................................8
Blockierung eines Teilnehmers aufheben ....................................................................................8
Hinzufügen von Daten.....................................................................................................................8
Abschnitt für Teilnehmer .................................................................................................................. 10
Einem Projekt folgen ..................................................................................................................... 10
Ein Projekt verlassen ..................................................................................................................... 10
Abschnitt für beide ........................................................................................................................... 12
Erster Start.................................................................................................................................... 12
Daten manuell aktualisieren ......................................................................................................... 12
Daten automatisch aktualisieren ................................................................................................... 12
Anordnen von Datenreihen ........................................................................................................... 12
Verlauf einer Datenreihe betrachten............................................................................................. 12
Hinzufügen von Bereichen ............................................................................................................ 13
Entfernen von Bereichen............................................................................................................... 13
Editieren von Bereichen ................................................................................................................ 13
2
Einführung
Übersicht
Begriffe
In dieser Anleitung tauchen immer wieder einige Begriffe auf, die hier eine andere Bedeutung haben
als im Alltag, weswegen es sich anbietet diese hier im Vorfeld zu klären.
Projekt
Ein Projekt repräsentiert den Service der überwacht werden soll. Jeder Benutzer muss zu Beginn ein
Projekt erstellen oder an einem bereits bestehenden Projekt teilnehmen. Danach ist er an dieses
gebunden und muss es erst löschen bzw. verlassen, bevor er ein neues erstellen oder einem
anderem Projekt folgen kann.
Projektleiter
Der Projektleiter ist der Benutzer, der das Projekt erstellt hat. Somit hat jedes Projekt genau einen
Projektleiter. Dieser legt fest, welche Daten des Services an den das Projekt gebunden ist, überwacht
werden sollen, er verwaltet den Projektschlüssel der zum Einfügen neuer Daten benötigt wird und
bestimmt welche anderen Benutzer am Projekt teilnehmen dürfen und welche nicht.
Teilnehmer
Mit den Teilnehmern eines Projekts ist die Menge der Benutzer gemeint, die eine Anfrage an den
Projektleiter geschickt haben dem Projekt zu folgen und deren Anfrage bereits genehmigt wurde.
Benutzer die zwar eine Anfrage gesendet haben, diese aber abgelehnt wurde, werden als geblockte
Teilnehmer bezeichnet.
Datenreihe
Datenreihen spiegeln einen bestimmten Parameter des zu überwachenden Service wieder. Sie
können nur vom Projektleiter angelegt, entfernt, geändert und über den REST-Service mit Daten
versorgt werden.
3
Abschnitt für den Projektleiter
In diesem Abschnitt geht es nur um die Aktionen, die der Projektleiter ausführen kann. Um
Projektleiter zu werden, muss ein Benutzer zunächst ein Projekt erstellen. Anschließend sollte er
verschiedene Datenreihen anlegen, evtl. andere Benutzer zum Projekt hinzufügen und schließlich
einen Dienst einrichten und starten, der den REST-Service mit den benötigten Daten versorgt.
Projekt
Erstellen eines Projekts
Besitzt oder folgt man bereits einem Projekt, muss man dieses erst löschen (Link) bzw. sich von
diesem abmelden (Link).
Ist man weder Projektleiter noch Teilnehmer, wird man automatisch beim Start der App aufgefordert
ein Projekt zu erstellen oder an einem Teilzunehmen.


Projekt erstellen auswählen.
Angaben zum Projekt machen.
o Name: Der Name des Projekts kann an andere Benutzer, die dem Projekt folgen
wollen, weitergegeben werden.
o Projektschlüssel: Der Projektschlüssel wird benötigt, um dem Projekt Daten
hinzuzufügen. Er wird verschlüsselt in der App hinterlegt und kann jederzeit
abgerufen werden.
4
o

Öffentlich: Ist das Projekt öffentlich, kann jeder der den Namen des Projekts kennt
teilnehmen. Bei nicht öffentlichen Projekten muss jeder Teilnehmer erst bestätigt
werden.
Angaben durch Tap auf Projekt erstellen bestätigen.
Löschen eines Projekts
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Menü öffnen.
 Projekt löschen auswählen.
 Im Dialog das Löschen bestätigen.
Datenreihen
Hinzufügen von Datenreihen
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Datenreihen wechseln.
 Im Menüband Hinzufügen auswählen.
 Angaben zur Datenreihe machen.
o Name: Der Name der Datenreihe.
o Typ: Es gibt Zustands- und Werte-Datenreihen. Zustands-Datenreihen sind für
Zustände wie Service läuft, Service gestoppt oder Service pausiert gedacht und
Werte-Datenreihen stellen Ganzzahlen wie 1, 33 oder 7 dar.
o Zustände: Zustände sind nur für Zustands-Datenreihen relevant; deswegen wird die
Zustands-Seite automatisch ausgeblendet, wenn eine Werte-Datenreihe ausgewählt
wird. Ansonsten können auf der Zustands-Seite die Zustände verwaltet werden, die
die Datenreihe annehmen kann.
o Grenzwert: Für jede Datenreihe kann ein Grenzwert festgelegt werden, bei dessen
Erreichen, Unter- oder Überschreiten eine Benachrichtigung an alle
Projektteilnehmer gesendet wird. Bei Zustands-Datenreihen ist beim Unter- bzw.
Überschreiten die Reihenfolge der Zustände relevant.
Um bei Zustands-Datenreihen einen Grenzwert festlegen zu können, müssen
zunächst Zustände erstellt werden die dann als Grenzwerte angegeben werden
können.
 Wenn alle Angaben gemacht wurden, wieder zum Reiter Datenreihe wechseln und mit
Erstellen bestätigen.
Editieren von Datenreihen
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Datenreihen wechseln.
 In der Liste die zu editierende Datenreihe selektieren.
5



Im Menüband Bearbeiten auswählen.
Angaben zur Datenreihe bearbeiten
o Name: Der Name der Datenreihe.
o Typ: Es gibt Zustands- und Werte-Datenreihen. Zustands-Datenreihen sind für
Zustände wie offen, geschlossen oder verriegelt gedacht und Werte-Datenreihen
stellen Ganzzahlen wie 1, 33 oder 7 dar.
o Zustände: Zustände sind nur für Zustands-Datenreihen relevant; deswegen wird die
Zustands-Seite automatisch ausgeblendet, wenn eine Werte-Datenreihe ausgewählt
wird. Ansonsten können auf der Zustands-Seite die Zustände verwaltet werden, die
die Datenreihe annehmen kann.
o Grenzwert: Für jede Datenreihe kann ein Grenzwert festgelegt werden, bei dessen
Erreichen, Unter- oder Überschreiten eine Benachrichtigung an alle Teilnehmer
gesendet wird. Bei Zustands-Datenreihen ist beim Unter- bzw. Überschreiten die
Reihenfolge der Zustände relevant.
Um bei Zustands-Datenreihen einen Grenzwert festlegen zu können, müssen
zunächst Zustände erstellt werden die dann als Grenzwerte angegeben werden
können.
Wenn alle Angaben gemacht wurden, wieder zum Reiter Datenreihe wechseln und mit
Speichern bestätigen.
Löschen von Datenreihen
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Datenreihen wechseln.
 In der Liste die zu löschende Datenreihe selektieren.
 Im Menüband Löschen auswählen.
 Im Dialog das Löschen bestätigen.
ID einer Datenreihe herausfinden
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Datenreihen wechseln.
 In der Liste die Datenreihe auswählen, deren ID in Erfahrung gebracht werden soll.
 Im Menüband Editieren auswählen.
 Die ID kann aus den Informationen abgelesen werden.
IDs aller Datenreihen herausfinden
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Datenreihen wechseln.
 Menü öffnen
 IDs anzeigen auswählen.
6



In der Liste werden nun die Datenreihen im Format ID – Name der Datenreihe angezeigt. Die
IDs können also direkt aus der Liste abgelesen werden.
Menü öffnen
IDs verbergen auswählen. Die Liste wird wieder im ursprünglichen Format angezeigt.
Zustände
Hinzufügen von Zuständen
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Datenreihen wechseln.
 In der Liste die Datenreihe auswählen, bei der ein Zustand hinzugefügt werden soll.
 Im Menüband Bearbeiten auswählen.
 Zum Reiter Zustände wechseln.
 Im Menüband Hinzufügen auswählen.
 Bezeichnung des neuen Zustands eintragen.
 Bestätigen.
 Wenn alle Angaben gemacht wurden, wieder zum Reiter Datenreihe wechseln und mit
Speichern bestätigen.
Editieren von Zuständen
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Datenreihen wechseln.
 In der Liste die Datenreihe auswählen, bei der ein Zustand editiert werden soll.
 Im Menüband Bearbeiten auswählen.
 Zum Reiter Zustände wechseln.
 Den Zustand auswählen, der bearbeitet werden soll.
 Im Menüband Bearbeiten auswählen.
 Bezeichnung des Zustands ändern.
 Bestätigen.
 Wenn alle Angaben gemacht wurden, wieder zum Reiter Datenreihe wechseln und mit
Speichern bestätigen.
Löschen von Zuständen
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Datenreihen wechseln.
 In der Liste die Datenreihe auswählen, bei der ein Zustand gelöscht werden soll.
 Im Menüband Bearbeiten auswählen.
 Zum Reiter Zustände wechseln.
 Den Zustand auswählen, der gelöscht werden soll.
 Im Menüband Löschen auswählen.
7


Bestätigen.
Wenn alle Angaben gemacht wurden, wieder zum Reiter Datenreihe wechseln und mit
Speichern bestätigen.
ID eines Zustands herausfinden
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Datenreihen wechseln.
 In der Liste die Datenreihe auswählen, bei der die ID eines Zustands in Erfahrung gebracht
werden soll.
 Im Menüband Bearbeiten auswählen.
 Zum Reiter Zustände wechseln.
 In der Liste werden nun die Datenreihen im Format ID – Name des Zustands angezeigt. Die
IDs können also direkt aus der Liste abgelesen werden.
Teilnehmer
Teilnehmer autorisieren
 Damit ein neuer Benutzer dem Projekt folgen kann, muss dieser zunächst eine
Teilnahmeanfrage senden (Link).
 Bei jedem Start der App wird geprüft, ob neue Anmeldungen vorliegen. Falls ja erscheint ein
Dialog, in dem die zu autorisierenden Anfrager selektiert werden müssen.
 Die Auswahl mit Autorisieren bestätigen.
Teilnehmer blockieren
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Teilnehmer wechseln.
 In der Liste die zu blockierenden Teilnehmer selektieren.
 Auf Blockieren tappen.
Blockierung eines Teilnehmers aufheben
 Zur Startseite navigieren.
 Menü öffnen
 Projekt auswählen.
 Zum Reiter Blockiert wechseln.
 In der Liste die zu autorisierenden Teilnehmer selektieren.
 Auf Autorisieren tappen.
Hinzufügen von Daten
Um dem Projekt neue Daten hinzuzufügen muss eine POST-Nachricht an https://servicemonitor.com/api/datapush gesendet werden. In der POST-Nachricht müssen die Felder name
(Projektname) und key (Projektschlüssel) gesetzt sein. Des Weiteren muss es für jede Datenreihe ein
Feld geben, dessen Name die ID der Datenreihen ist. Die ID einer Datenreihe kann wie unter ID einer
Datenreihe herausfinden in Erfahrung gebracht werden. Handelt es sich um eine Datenreihe mit
8
Zahlenwerten, können diese direkt in das Feld eingetragen werden. Handelt es sich um eine
Datenreihe die an Status geknüpft ist, muss die ID des Status eingetragen werden, die wie unter ID
eines Zustands herausfinden beschrieben erlangt werden kann.
Beispiel einer POST-Nachricht
{
(name, Nightfly)
(key, geheim)
(1, 78)
(2, 1523)
(3, 7)
}
Der Projektname ist Nightfly und der Projektschlüssel ist geheim. Das Projekt besitzt drei
Datenreihen mit den IDs 1, 2 und 3. Bei den ersten beiden Datenreihen (IDs 1 und 2) werden die
Zahlenwerte 78 und 1523 abgespeichert. Der dritten Datenreihe (ID 3) wird der Status mit der ID 7
zugewiesen.
9
Abschnitt für Teilnehmer
Einem Projekt folgen
Besitzt oder folgt man bereits einem Projekt, muss man dieses erst löschen (Link) bzw. sich von
diesem abmelden (Link).
Ist man weder Projektleiter noch Teilnehmer, wird man automatisch beim Start der App aufgefordert
ein Projekt zu erstellen oder an einem Teilzunehmen.



Projekt folgen auswählen
Angaben zum Projekt machen.
o Name: Name des Projekts dem man folgen will. Ist der Name nicht bekannt, sollte er
vom Projektleiter in Erfahrung gebracht werden.
Angaben mit Projekt folgen bestätigen.
Ein Projekt verlassen






Zur Startseite navigieren.
Menü öffnen
Projekt auswählen.
Menü öffnen.
Projekt verlassen auswählen.
Bestätigen.
10
11
Abschnitt für beide
Erster Start






App starten.
Es wird ein Willkommenstext angezeigt. Weiter mit Tap auf Anmelden.
Eingeben von Name und Passwort des Microsoft Kontos mit anschließendem Tap auf Login.
Existiert kein Microsoft Konto, muss zunächst eins angelegt werden.
Bestätigen der Rechte. Werden die Rechte nicht gewährt, kann die App nicht gestartet
werden.
Wahl des Benutzernamens. Der Name kann später nicht mehr geändert werden und sollte
deswegen nicht sorglos gewählt werden. Weiter mit Tap auf Registrieren.
Auswählen ob man selbst ein neues Projekt erstellen oder einem bereits bestehendem
Projekt folgen will. Um ein Projekt zu erstellen weiter bei Erstellen eines Projekts und um
einem Projekt zu folgen weiter bei Einem Projekt folgen.
Daten manuell aktualisieren


Zur Startseite navigieren.
Auf Aktualisieren tappen.
Daten automatisch aktualisieren





Zur Startseite navigieren.
Menü öffnen
Einstellungen auswählen.
Daten im Hintergrund aktualisieren aktivieren.
Auf Aktualisierungsintervall tappen, gewünschte Zeitspanne einstellen und speichern.
Sobald das Aktualisierungsintervall geändert wurde, startet die nächste Aktualisierung nach Ablauf
des Intervalls, egal was vorher eingestellt war.
Anordnen von Datenreihen






Zur Startseite navigieren.
Menü öffnen
Projekt auswählen.
Zum Reiter Datenreihen wechseln.
Die Datenreihen wie gewünscht anordnen.
Im Menüband Speichern auswählen.
Die Anordnung der Datenreihen wird nur lokal auf dem Smartphone und nicht auf dem Server
gespeichert. Bei einer Neuinstallation der App geht die Anordnung also verloren.
Verlauf einer Datenreihe betrachten



Zur Startseite navigieren.
Auf die gewünschte Datenreihe tappen.
Den gewünschten Bereich auswählen.
Standardmäßig existieren die Bereiche 1 Stunde und 10 Minuten. Wie neue Bereiche hinzugefügt
werden können steht unter Neuen Bereich hinzufügen.
12
Hinzufügen von Bereichen





Zur Startseite navigieren.
Auf eine beliebige Datenreihe tappen.
Zum Reiter Bereiche wechseln.
Im Menüband Hinzufügen auswählen.
Angaben zum Bereich machen und bestätigen.
Die Bereiche werden nur lokal auf dem Smartphone und nicht auf dem Server gespeichert. Bei einer
Neuinstallation der App gehen die Bereiche also verloren.
Entfernen von Bereichen






Zur Startseite navigieren.
Auf eine beliebige Datenreihe tappen.
Zum Reiter Bereiche wechseln.
In der Liste den zu entfernenden Bereich selektieren.
Im Menüband Entfernen auswählen.
Im Dialog das Löschen bestätigen.
Die Bereiche werden nur lokal auf dem Smartphone und nicht auf dem Server gespeichert. Bei einer
Neuinstallation der App gehen die Bereiche also verloren.
Editieren von Bereichen






Zur Startseite navigieren.
Auf eine beliebige Datenreihe tappen.
Zum Reiter Bereiche wechseln.
In der Liste den zu editierenden Bereich selektieren.
Im Menüband Bearbeiten auswählen.
Angaben zum Bereich bearbeiten und bestätigen.
Die Bereiche werden nur lokal auf dem Smartphone und nicht auf dem Server gespeichert. Bei einer
Neuinstallation der App gehen die Bereiche also verloren.
13

Download Report