From c9967043442d72e018d73efaccee4548783827de Mon Sep 17 00:00:00 2001 From: anhefti Date: Mon, 23 Mar 2020 11:36:30 +0100 Subject: [PATCH] config overview --- docs/client_config.rst | 12 ++++++++++-- docs/config_template | 2 -- docs/config_template.rst | 12 ++++++++++++ docs/configurations.rst | 18 +++++++++++++++++- docs/exam_config.rst | 11 ++++++++++- 5 files changed, 49 insertions(+), 6 deletions(-) delete mode 100644 docs/config_template create mode 100644 docs/config_template.rst diff --git a/docs/client_config.rst b/docs/client_config.rst index ddbeb31e..b298e998 100644 --- a/docs/client_config.rst +++ b/docs/client_config.rst @@ -1,3 +1,11 @@ -Client Configuration --------------------- +.. _client-configuration-label: +Client Configuration +==================== + +Overview +-------- + + +Use Cases +--------- diff --git a/docs/config_template b/docs/config_template deleted file mode 100644 index ddc94fae..00000000 --- a/docs/config_template +++ /dev/null @@ -1,2 +0,0 @@ -Exam Configuration Templates ------------------------------ \ No newline at end of file diff --git a/docs/config_template.rst b/docs/config_template.rst new file mode 100644 index 00000000..7483a541 --- /dev/null +++ b/docs/config_template.rst @@ -0,0 +1,12 @@ +.. _config-template-label: + +Exam Configuration Templates +============================ + +Overview +-------------------- + + +Use Cases +------------ + diff --git a/docs/configurations.rst b/docs/configurations.rst index 4d1d18ca..ed7f7ab9 100644 --- a/docs/configurations.rst +++ b/docs/configurations.rst @@ -1,7 +1,23 @@ SEB Configurations ================== -TODO +There are two different kind of SEB specific configurations that must be defined and be put in place to support e-assessments with +SEB and SEB Server. The Client Configuration is used to configure SEB with all needed information to securely connect to SEB Server +and an Exam Configuration is used to configure SEB to access a running exam with SEB. The Client Configuration is only needed at least +once for an institution and must be deployed as start-configuration on a managed SEB setup or can be placed as a download link within +an internal trusted server, that automatically loads within the SEB application and configures the SEB to connect to the SEB Server. + +An Exam Configuration, as the name implies, is done for an exam and contains most of the known configuration attributes +from the latest `SEB Configuration Tool `_ +Currently an Exam Configuration can only be applied to one Exam but can easily be copied to use with another exam. For detailed +information about Exam Configuration see :ref:`exam-configuration-label` + +Within Configuration Templates, it is possible to create templates for Exam Configuration. Within the current version of SEB Server +there is the possibility to define different default value(s) for each exam configuration attribute and also to define if the attribute +is been shown in the Exam Configuration or not. This allows an Exam Administrator to create a exam configuration template for exams +with context defines default values and also to be able to only see change the attributes that are relevant for an exam configuration. +This feature is currently in an experimental state and may be changed and / or expanded within future releases of SEB Server. See +:ref:`config-template-label` .. toctree:: diff --git a/docs/exam_config.rst b/docs/exam_config.rst index 79fc2745..a37f0d70 100644 --- a/docs/exam_config.rst +++ b/docs/exam_config.rst @@ -1,2 +1,11 @@ +.. _exam-configuration-label: + Exam Configuration ------------------- +================== + +Overview +-------- + + +Use Cases +---------