Changeset 15163 for main/waeup.kofa/trunk/docs/source/userdocs

Timestamp:

23 Sep 2018, 05:05:04 (6 years ago)

Author:

Henrik Bettermann

Message:

Merge with /main/waeup.kofa/branches/henrik-transcript-workflow:15127-15162

Location:

main/waeup.kofa/trunk

Files:

• . (modified) (1 prop)
• docs/source/userdocs/datacenter/export.rst (modified) (1 diff)
• docs/source/userdocs/datacenter/import_stages.rst (modified) (1 diff)
• docs/source/userdocs/security.rst (modified) (2 diffs)
• docs/source/userdocs/students/workflow.rst (modified) (3 diffs)

main/waeup.kofa/trunk/docs/source/userdocs/datacenter/export.rst

@@ -282 +282 @@
   .. autoattribute:: waeup.kofa.students.export.SessionPaymentsOverviewExporter.fields
   .. autoattribute:: waeup.kofa.students.export.SessionPaymentsOverviewExporter.title
-  .. autoattribute:: waeup.kofa.students.export.SessionPaymentsOverviewExporter.curr_year
   .. automethod:: waeup.kofa.students.export.SessionPaymentsOverviewExporter.mangle_value()
 

main/waeup.kofa/trunk/docs/source/userdocs/datacenter/import_stages.rst

@@ -8 +8 @@
    :ref:`Data Center Doctests <datacenter_txt>`
 
-The term 'data import' actually understates the range of funcnctions
+The term 'data import' actually understates the range of functions
 importers really have. As already stated, many importers do not only
 restore data once backed up by exporters or, in other words, take

main/waeup.kofa/trunk/docs/source/userdocs/security.rst

@@ -241 +241 @@
    :noindex:
 
+.. autoclass:: waeup.kofa.students.permissions.TranscriptOfficer()
+   :noindex:
+
+.. autoclass:: waeup.kofa.students.permissions.TranscriptSignee()
+   :noindex:
+
 .. _local_roles:
 
@@ -306 +312 @@
 .. autoclass:: waeup.kofa.permissions.CourseAdviser100()
    :noindex:
+
+.. autoclass:: waeup.kofa.permissions.LocalTranscriptOfficer()
+   :noindex:
+
+.. autoclass:: waeup.kofa.permissions.LocalTranscriptSignee()
+   :noindex:

main/waeup.kofa/trunk/docs/source/userdocs/students/workflow.rst

@@ -28 +28 @@
 
               a
-   created ------- admitted
-              b       |
-     +----------------+
-     |                         e
-     +------------------------------------------------------+
-     |                  c                            d      |
-   clearance started ------- clearance requested  ------- cleared
-                                                            |
-                                f                           |
-     +--------+---------------------------------------------+
-     |        |
-     | h    school fee paid -------- returning -------------+
-     |        |             \   l        |                  |
-     +--------+ g            \ _ _ _ m   | k                |
-              |                      \   |                  |
-           courses registered ------ courses validated      |
-                          |      i       |                  |
-                          |              | n                |
-                          | j            |                  |
-                          |          graduated              |
-                          |              |                  |
-                          |              | o                |
-                          |              |                  |
-                          |          transcript requested   |
-     a: admit             |                                 |
-    -a: reset1            +---------------------------------+
-     b: start_clearance
-    -b: reset2
-     c: request_clearance
-    -c: reset3 (= reject request)
-     d: clear
-    -d: N/A
+    created ------- admitted
+               b       |
+      +----------------+
+      |                         e
+      +------------------------------------------------------+
+      |                  c                            d      |
+    clearance started ------- clearance requested  ------- cleared
+                                                             |
+                                 f                           |
+      +--------+---------------------------------------------+
+      |        |
+      | h    school fee paid -------- returning -------------+
+      |        |             \   l        |                  |
+      +--------+ g            \ _ _ _ m   | k                |
+               |                      \   |                  |
+            courses registered ------ courses validated      |
+                           |      i       |                  |
+                           |              | n                |
+                           | j            |                  |
+                           |      +-- graduated              |
+                           |      |       |                  |
+                           |      |       | o                |
+                           |      |       |                  |
+                           |      |   transcript requested   |
+     a: admit              |      |       |                  |
+    -a: reset1             |    r |       | p                |
+     b: start_clearance    |      |       |                  |
+    -b: reset2             |      |   transcript validated   |
+     c: request_clearance  |      |       |                  |
+    -c: reset3             |      |       | q                |
+        (= reject request) |      |       |                  |
+     d: clear              |      +-- transcript released    |
+    -d: N/A                +---------------------------------+
      e: N/A
     -e: reset4 (= annul clearance)
@@ -81 +82 @@
     -n: N/A
      o: request_transcript
-    -o: process_transcript
-
+    -o: reset10 (= reject request)
+     p: validate_transcript
+    -p: N/A
+     q: release_transcript
+    -q: N/A
+     r: N/A
+    -r: reset11
 
 Student registration starts with the first login of the student into
@@ -131 +137 @@
 list.
 
+After graduation, former students (alumni) can apply for an official
+transcript. The transcript processing workflow (**opqr**) is a
+subset of the registration workflow which starts in state
+``graduated``. Many people are involved in transcript processing.
+Therefore, Kofa provides two additional roles, the Transcript
+Officer and Transcript Signee roles. Both are available globally and
+locally (at faculty level). First of all, the graduated student has
+to request a transcript **(o)** by filling a request form. The
+Transcript Officer will see the new request and can either reject
+the request **(-o)** or validate the request **(p)**. Before
+validation course results can be edited or added. After validation
+the entire studycourse including its content is locked. Nobody will
+be able to modify the course lists, neither through the UI nor by
+import. Transcripts can now be electronically signed by Transcript
+Signees. Once all signees have done their job, the Transcript
+Officer can release the transcript **(q)**. A pdf file is created
+and stored in the file system. The transcript pdf slip contains all
+signatures. The dynamic transcript generation is disabled. Nothing
+can be changed now, unless the entire transcript process is reset
+**(-r)** by a Students Manager. Then comments and signatures will be
+removed and the pdf file deleted. The student can start afresh.
+
 
 .. _registration_workflow_batch_processing: