summaryrefslogtreecommitdiffstats
path: root/documentation/webapp/modules.md
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/webapp/modules.md')
-rw-r--r--documentation/webapp/modules.md56
1 files changed, 56 insertions, 0 deletions
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