From 69746eec97f236fee6c5f80fbf2e113d94644b9d Mon Sep 17 00:00:00 2001 From: Dominik George <dominik.george@teckids.org> Date: Sat, 16 Apr 2022 22:08:03 +0200 Subject: [PATCH] [Docs] Explain school ID --- docs/admin/20_configuration.rst | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/admin/20_configuration.rst b/docs/admin/20_configuration.rst index 065dbf3..edf58c5 100644 --- a/docs/admin/20_configuration.rst +++ b/docs/admin/20_configuration.rst @@ -45,11 +45,29 @@ you have to set the following settings: host = "mysqlserver" port = 3306 +Preferences +----------- + +The preferences for the import can be set from the menu under +`Admin → Configuration → Untis`. + +Configure the school ID +~~~~~~~~~~~~~~~~~~~~~~~ + +The only required preference is the Untis school ID. You need to +provide this in all cases, even if your Untis database hosts only one +school. + +.. warning:: + + If your Untis database hosts several schools, but you forget to + configure the school ID, data corruption may occur! + Customise how data are imported -------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The way data are imported can be configured from the menu under -`Admin → Configuration → Untis`. The following preferences are available: +The behaviour of the import can be customised in several ways. The +following preferences are available: * **Update values of existing subjects:** This will update the values of already existing subjects if Untis has different data. -- GitLab