Changeset 14934 for main/waeup.kofa/trunk/docs

Timestamp:

10 Jan 2018, 14:44:49 (7 years ago)

Author:

Henrik Bettermann

Message:

Do no longer hide the 'Create students' buttons but switch the portal to
maintenance mode to ensure that nobody can enter the portal during
record creation except for user 'admin'. This guarantees that record
creation is only started once.

File:

• main/waeup.kofa/trunk/docs/source/userdocs/applicants/create_students.rst (modified) (2 diffs)

main/waeup.kofa/trunk/docs/source/userdocs/applicants/create_students.rst

@@ -25 +25 @@
   applicants will be skipped without further notice.
 
-3. Last but not least, the portal manager with user id ``admin``
-   does see a link button:
+3. Last but not least, the portal managers do see a link button:
 
   |create_students_button|
@@ -32 +31 @@
   on the `ApplicantsContainerPage` and on the `ApplicantsRootPage`
   which creates student records from applicants inside a single
-  applicants container or even portal-wide respectively.
+  applicants container or even portal-wide respectively. A warning
+  message appears before the process is started. After start the
+  portal is immediately switched into maintenance mode to ensure that
+  nobody can enter the portal during record creation except for user
+  'admin'. Maintenance mode is switched off as soon as the process has
+  finished.
 
-  The reader may wonder: Why only user ``admin``?
+.. note::
 
   Batch creation of thousands or even tenthousands of student records
   is very computation intensive and takes quite a long time, even with
   powerful computers. Experience has shown that the portal must be
-  disconnected from the Internet in order to avoid database write
-  conflict errors, which cannot be resolved if also students access
-  the portal. Usually conflict errrors are not serious. Unresolved
-  conflicts just lead to an error message and the database remains
-  unchanged. Unfortunataly, student creation does not only alter the
-  object database. As we will see below, also folders and files in the
-  filesystem are added. These filesystem changes are not being
-  reverted after unresolved conflicts, a fact which can cause serious
-  problems.
-
-  So the answer to the question is trivial: We expect that the admin
-  user knows what s/he is doing and is careful enough to start the
-  creation process in maintenance mode, which means when the portal is
-  disconnected from a public network.
+  switched to maintenance mode (or even disconnected from the Internet)
+  in order to avoid database write conflict errors, which cannot be
+  resolved if also students access the portal. Usually conflict
+  errrors are not serious. Unresolved conflicts just lead to an error
+  message and the database remains unchanged. Unfortunataly, student
+  creation does not only alter the object database. As we will see
+  below, also folders and files in the filesystem are added. These
+  filesystem changes are not being reverted after unresolved conflicts,
+  a fact which can cause serious problems.