summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorChristian Hofmaier2019-05-19 20:08:01 +0200
committerChristian Hofmaier2019-05-19 20:08:01 +0200
commit515836a9fe7fb5756f23b43c308ad23a577f8d30 (patch)
tree8f96efd935f3943078913ca993192f2ee5f653c2 /documentation
parent[documentation] Some corrections + image border dark / light theme image. (diff)
downloadbas-515836a9fe7fb5756f23b43c308ad23a577f8d30.tar.gz
bas-515836a9fe7fb5756f23b43c308ad23a577f8d30.tar.xz
bas-515836a9fe7fb5756f23b43c308ad23a577f8d30.zip
[Documentation] Add Eventmanager Module
Diffstat (limited to 'documentation')
-rw-r--r--documentation/de/webapp/modules.md57
-rw-r--r--documentation/webapp/modules.md56
2 files changed, 113 insertions, 0 deletions
diff --git a/documentation/de/webapp/modules.md b/documentation/de/webapp/modules.md
index ab20c71..2d8c48e 100644
--- a/documentation/de/webapp/modules.md
+++ b/documentation/de/webapp/modules.md
@@ -5,6 +5,63 @@
## iPXE Konfigurator
## Client Registrierung
## Eventverwaltung
+Dieses Modul liefert eine Übersichtstabelle von allen Veranstaltungen.
+
+<a :href="$withBase('/img/event_manager_de.png')" target="_blank"><img :src="$withBase('/img/event_manager_de.png')" alt="BAS Event Manager"></a>
+
+Wird eine Veranstaltung erstellt <span class="tutorial-label">1</span> oder bearbeitet <span class="tutorial-label">2</span>, so öffnet sich ein Dialog mit allen einstellbaren Optionen.
+Ausgewählte Veranstaltungen können über den ```Löschen```-Button <span class="tutorial-label">3</span> entfernt werden.
+
+Um eine Veranstaltung zu erstellen müssen allgemeine Einstellungen vorgenommen werden (Schritt 1), Gruppen und/oder Clients zugewiesen werden (Schritt 2) und optional eine Blacklist von Subgruppen und/oder Clients erstellt werden.
+::: warning WARNUNG
+Eine Veranstaltung kann bereits ohne zugewiesenen Gruppen erstellt werden, muss dann allerdings nachträglich editiert werden.
+:::
+
+### Allgemeine Einstellungen
+<a :href="$withBase('/img/event_manager_edit_de.png')" target="_blank"><img :src="$withBase('/img/event_manager_edit_de.png')" alt="BAS Event Manager Dialog"></a>
+
+> <span class="tutorial-label">1</span> - Wähle eine Konfiguration, die während der laufenden Veranstaltung gebootet werden soll. \
+> <span class="tutorial-label">2</span> - Wähle diese Option, wenn die Veranstaltung Priorität gegenüber anderen Veranstaltungen haben soll. \
+> <span class="tutorial-label">3</span> - Wähle diese Option, wenn Wake-On-Lan zu Beginn der Veranstaltung für alle zugewiesenen Gruppen und Clients ausgeführt werden soll. \
+> <span class="tutorial-label">4</span> - Setze Beginn und Ende der Veranstaltung. \
+> <span class="tutorial-label">5</span> - Erstelle eine periodische Veranstaltung.
+
+::: warning WARNUNG
+Mehrere, als ```important``` makierte, Veranstaltungen auf der selben Ebene lösen die Erstellung eines dynamischen Menüs aus (siehe [Configloader](/api/collections.md#configloader)).
+:::
+
+#### Periodische Veranstaltungen
+<a :href="$withBase('/img/event_manager_edit_recurrent_de.png')" target="_blank"><img :src="$withBase('/img/event_manager_edit_recurrent_de.png')" alt="BAS Event Manager Dialog"></a>
+
+> <span class="tutorial-label">1</span> - Wähle an welchen Tagen die Veranstaltung stattfindet. Standard: Alle ausgewählt. \
+> <span class="tutorial-label">2</span> - Wähle in welchen Monaten die Veranstaltung stattfindet. Standard: Alle ausgewählt. \
+> <span class="tutorial-label">3</span> - Setze das Intervall. \
+> <span class="tutorial-label">4</span> - Wähle den Typ des Intervalls. Optionen sind: ```Tag```, ```Woche``` und ```Monat```.
+
+::: warning WARNUNG
+Durch die Änderung auf eine periodische Veranstaltung wird die Bedeutung der ausgewählten Zeiten und Tage geändert.
+Startdatum und Enddatum sind nun der erste und letzte mögliche Tag der Veranstaltung und die Veranstaltung findet nun von Startzeit bis Endzeit an jedem durch das Intervall bestimmten Tag statt.
+:::
+
+::: tip TIPP
+Intervalltyp <span class="tutorial-label">4</span> ```Woche``` bestimmt, dass die Veranstaltung die gesamte Woche stattfindet, während ```Monat``` lediglich das Startdatum jeden Monat ist.
+Z.B. wählt man den 13. Januar als Startdatum aus und ```1, Monat``` als Intervall, so findet die Veranstaltung am 13ten jeden Monats zwischen Startdatum und Enddatum statt, mit Ausnahme der nicht ausgewählten Monate in <span class="tutorial-label">2</span>.
+Wählt man ```2, Woche``` als Intervall, so findet die Veranstaltung jede 2te Woche statt, die Woche des Startdatums als erste Woche mit laufender Veranstaltung.
+:::
+
+### Gruppen und Clients
+<a :href="$withBase('/img/event_manager_edit_step_2_de.png')" target="_blank"><img :src="$withBase('/img/event_manager_edit_step_2_de.png')" alt="BAS Event Manager Dialog"></a>
+
+Gruppen <span class="tutorial-label">1</span> und Clients <span class="tutorial-label">2</span>, die von der Veranstaltung betroffen sind, müssen ausgwählt werden.
+Das Auswählen einer Gruppe aktiviert den ```WEITER```-Button.
+
+Die Blacklist zeigt nur Subgruppen und Clients der zuvor ausgewählten Gruppen.
+Die Liste wird genutzt, um Gruppen und Clients auszuwählen, die von der Veranstaltung ausgenommen werden sollen.
+
+::: warning WARNUNG
+Wenn eine zuvor ausgewählte Gruppe innerhalb einer geblacklisteten Gruppe ist wird die zuvor ausgewählte Gruppe nicht von der Veranstaltung ausgeschlossen.
+:::
+
## Externe Backends
## Rechtemanager
## iPXE Builder
diff --git a/documentation/webapp/modules.md b/documentation/webapp/modules.md
index 77ee29e..716936e 100644
--- a/documentation/webapp/modules.md
+++ b/documentation/webapp/modules.md
@@ -4,6 +4,62 @@
## IP Ranges
## iPXE Configurator
## Event Manager
+This module provides an overview table of all existing events.
+
+<a :href="$withBase('/img/event_manager.png')" target="_blank"><img :src="$withBase('/img/event_manager.png')" alt="BAS Event Manager"></a>
+
+An event can be created <span class="tutorial-label">1</span> or edited <span class="tutorial-label">3</span>, which opens a dialog with all configurable options.
+Selected events can be deleted by using the ```DELETE``` button <span class="tutorial-label">2</span>.
+
+To create an event general options must be set (Step 1), groups and/or clients must be assigned (Step 2) and optionally a blacklist of subgroups and/or clients can be created (Step 3).
+::: warning
+The event can be created right away without assigning any group, but then has to be edited later on.
+:::
+
+### General Options
+<a :href="$withBase('/img/event_manager_edit.png')" target="_blank"><img :src="$withBase('/img/event_manager_edit.png')" alt="BAS Event Manager Dialog"></a>
+
+> <span class="tutorial-label">1</span> - Choose one of the existing configurations which will be booted while the event is live. \
+> <span class="tutorial-label">2</span> - Enable this option, if the event has priority over other ongoing events. \
+> <span class="tutorial-label">3</span> - Enable this option, if Wake-On-Lan shall be triggered for all assigned groups and clients at the start of the event. \
+> <span class="tutorial-label">4</span> - Set start and end of the event. \
+> <span class="tutorial-label">5</span> - Enable to create an recurrent event.
+
+::: warning
+Multiple ```important``` events on the same layer trigger dynamic menu building (see [Configloader](/api/collections.md#configloader)).
+:::
+
+#### Recurrent Events
+<a :href="$withBase('/img/event_manager_edit_recurrent.png')" target="_blank"><img :src="$withBase('/img/event_manager_edit_recurrent.png')" alt="BAS Event Manager Dialog"></a>
+
+> <span class="tutorial-label">1</span> - Select on which days the event is happening. Default: all selected. \
+> <span class="tutorial-label">2</span> - Select in which months the event is happening. Default: all selected. \
+> <span class="tutorial-label">3</span> - Set the interval. \
+> <span class="tutorial-label">4</span> - Select the type of the interval. Options are ```days```, ```weeks``` and ```months```.
+
+::: warning
+Activating the recurrent switch changes from an one-time event to an recurrent event, therefore changing the meaning of start date/time and end date/time.
+The dates are now referring to the first and the last date of the event, with the event ongoing from start to end time at every day determined by the interval.
+:::
+
+::: tip
+Intervaltype <span class="tutorial-label">4</span> ```week``` means the event is ongoing for the whole week, while ```month``` is only the start date in the month.
+E.g. choosing the 13th of january as the start date and ```1, month``` as interval will set up the event on the 13th of every month between start and end date with exception of the non-selected months in <span class="tutorial-label">2</span>.
+While for ```2, week``` as interval the event is ongoing every 2nd week with the start date being in the first ongoing week.
+:::
+
+### Groups and Clients
+<a :href="$withBase('/img/event_manager_edit_step_2.png')" target="_blank"><img :src="$withBase('/img/event_manager_edit_step_2.png')" alt="BAS Event Manager Dialog"></a>
+
+Groups <span class="tutorial-label">1</span> and/or clients <span class="tutorial-label">2</span> which are affected by the event have to be selected.
+Selecting a group will activate the ```CONTINUE``` button.
+
+The blacklist only shows subgroups and clients of the previously selected groups.
+The list is used for selecting groups and clients which shall be excluded of the event.
+
+::: warning
+If a previously selected group is inside of a blacklisted group, the previously selected group is not excluded from the event.
+:::
## Client Registration
## External Backends