more docu

This commit is contained in:
anhefti 2020-05-20 08:43:01 +02:00
parent 13a3eba97e
commit 03a88cf284
4 changed files with 47 additions and 9 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

View file

@ -86,4 +86,26 @@ overview temporary network latency or other irregularities, when this two time v
In the detail view you are also able to use the instructions "Quit SEB Client" and "Mark as Canceled" for the selected SEB client connection.
All SEB Client Logs
-------------------
As an exam administrator as well as an exam supporter, you are able to search SEB client events for all exams that have been run on the SEB Server and that
you have access to within your user-account privilege settings. As an exam supporter you will only see the SEB client logs of the exams you are assigned to.
To search all SEB client log events, go the the "Monitoring" section and click on the "SEB Client Logs" menu on the left menu pane. The SEB Server will show
you a list of all SEB client logs ever happen and you have access to. You can filter and sort the list as usual by using the filter above to find all logs
of an exam for example.
.. image:: images/monitoring/sebClientLogs.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/sebClientLogs.png
To show a detailed view of a specific SEB client log, just double click on the list entry or select the specific list entry and use the "Show Details"
action form the right action pane to open up a pop-up containing all related information about the SEB client log event.
.. image:: images/monitoring/sebClientLogDetail.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/sebClientLogDetail.png
Currently there is no export functionality to export all interessting SEB client logs to a CSV table for example. But such a feature will probably come
with a next version of SEB Server.

View file

@ -175,9 +175,9 @@ A column tool-tip usually also explains how to use the column-related filter.
Forms are used for domain entity specific data input or presentation, like HTML Forms usually do. Forms appear in three
different ways within the SEB Server GUI:
- When a object is first created in edit mode
- When an object is modified also in edit mode
- And when an object is just shown, in read-only mode
- When a domain entity is first created in edit mode
- When a domain entity is modified also in edit mode
- And when a domain entity is just shown, in read-only mode
The following images shows the same form, once in read-only mode and once edit mode
@ -191,8 +191,13 @@ The following images shows the same form, once in read-only mode and once edit m
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/overview/form_edit.png
There usually is a tool-tip on a form field element for almost all attributes that can be activated by either going over and stay on the form field label or the input section.
If a form field is mandatory to either create or save an object, this is marked with a little red arrow just to the right of the form field label.
There may be more field validations takes place on saving the object. If a input needs a special form that is not given by the current input, the form-field
will be marked with a red border and a thin red explanation text is shown right below the input field. After correct the missing or wrong input and save again,
the SEB Server will accept and process the changes. If the user navigates away from a form in edit mode, the GUI will inform about possible data loss and asks for proceed or abort.
There usually is a tool-tip on a form field element for almost all attributes that can be activated by either going over and stay on the form
field label or the input section.
If a form field is mandatory to either create or save an entity, this is marked with a little red arrow just to the right of the form field label.
There may also be more field validation takes place on saving the object. If a input needs a special form that is not given by the current input, the form-field
will be marked with a red border around the input field and a thin red explanation text is shown right below the input field.
After correcting the missing or wrong input and saveing the form again, the SEB Server will accept and process the changes.
.. note::
If you navigate away from a form in edit mode, the GUI will inform you about possible data loss on this action and will prompt you to
proceed or abort the action.

View file

@ -1,4 +1,15 @@
Troubleshooting
===============
TODO
This page's purpose is to collect frequently ask questions, problems and workarounds that are reported and known.
There shall be at least a problem description, an optional explanation if needed, a solution description and the SEB Server version and domain information. For Example:
--------------------------------
- **Version** : 1.0.0
- **Domain** : Exam Administration / Exam / Indicator
- **Problem** : This is an example problem description.
- **Explanation** : An explanation is not mandatory but shall be provided if you want to give some background information to the problem.
- **Solution** : A description of the solution, workaround or upcoming fixes.
--------------------------------