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

Timestamp:

17 Apr 2015, 14:43:42 (10 years ago)

Author:

Henrik Bettermann

Message:

More documentation.

File:

• main/waeup.kofa/trunk/docs/source/userdocs/datacenter.rst (modified) (3 diffs)

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

@@ -28 +28 @@
 Regular data exporters (1) collect objects from specific containers, (2) iterate over the collected objects, (3) extract and mangle information from each object, (4) write the information of each object into a row of a CSV file and (5) finally provide the file for download. The CSV file is neither stored in the database nor archived in the filesystem. (3) and (4) means a flattening of the hierarchical data structure, i.e. a mapping of objects to flat relational data to be stored in a CSV table. The extracted information must not necessarily be based only on static attributes of the collected object. The data, finally stored in the CSV file, can also be derived from parent or child objects, or dynamically computed by the object's methods and property attributes. These methods and properties can retrieve information from everywhere in the portal's database.
 
-In the following we list all exporter classes including two attributes and a method description. The `fields` attribute contain the column titles of the export file. These are not necessarily only attributes of the exported objects. The `title` attribute unveils the name of the exporter under which this exporter will be displayed in the user interface. The `mangle_value()` method shows how some of fields are being dynamically computed.
+In the following we list all exporter classes including two attributes and a method description. The `fields` attribute contain the column titles of the export file. These are not necessarily only attributes of the exported objects.
+
+.. note::
+
+  The list of exported columns usually underlies heavy customizations. In the Kofa base package only very fiew columns are being exported. In some Kofa custom packages tons of data are being gathered from applicants and students and the number of columns increase accordingly.
+
+The `title` attribute unveils the name of the exporter under which this exporter will be displayed in the user interface. The `mangle_value()` method shows how some of fields are being dynamically computed.
 
 Regular Exporters
@@ -77 +83 @@
 
 
-.. autoclass:: waeup.kofa.applicants.export.ApplicantsContainerExporter()
-  :noindex:
-
-  .. autoattribute:: waeup.kofa.applicants.export.ApplicantsContainerExporter.fields
-  .. autoattribute:: waeup.kofa.applicants.export.ApplicantsContainerExporter.title
-
-.. autoclass:: waeup.kofa.applicants.export.ApplicantExporter()
-  :noindex:
-
-  .. autoattribute:: waeup.kofa.applicants.export.ApplicantExporter.fields
-  .. autoattribute:: waeup.kofa.applicants.export.ApplicantExporter.title
-  .. automethod:: waeup.kofa.applicants.export.ApplicantExporter.mangle_value()
-
 .. autoclass:: waeup.kofa.accesscodes.export.AccessCodeBatchExporter()
   :noindex:
@@ -115 +108 @@
   .. autoattribute:: waeup.kofa.hostels.export.BedExporter.title
 
+Application Data Exporters
+--------------------------
+
+.. autoclass:: waeup.kofa.applicants.export.ApplicantsContainerExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.applicants.export.ApplicantsContainerExporter.fields
+  .. autoattribute:: waeup.kofa.applicants.export.ApplicantsContainerExporter.title
+
+.. autoclass:: waeup.kofa.applicants.export.ApplicantExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.applicants.export.ApplicantExporter.fields
+  .. autoattribute:: waeup.kofa.applicants.export.ApplicantExporter.title
+  .. automethod:: waeup.kofa.applicants.export.ApplicantExporter.mangle_value()
 
 Student Data Exporters
 ----------------------
 
+When starting a Student Data Exporter in the Data Center all student records will be taken into consideration, no matter what or where a student is studying. The exporter can also be started 'locally' at various levels in the academic section. Starting one of the exporters e.g. at faculty or department level means that only the data of students are exported who study in this faculty or department respectively. The exporter can also be started at certificate level. Then only the data of students, who are studying the named study course, will be taken into account. At course level the data of those students are being exported who have attended or taken this specific course.
+
+Student Data Exporter can be further configured through a configuration page. Search parameters like the student's current level, current session and current study mode  can be set to filter sets of students in order to decrease the size of the export file. The set of filter parameters varies and depends on the 'locatation' from where the exporter is called. A completely different set of filter parameters is provided for courses. In this case the session and level can be selected when the course was taken by the student.
+
+.. autoclass:: waeup.kofa.students.export.StudentExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.students.export.StudentExporter.fields
+  .. autoattribute:: waeup.kofa.students.export.StudentExporter.title
+  .. automethod:: waeup.kofa.students.export.StudentExporter.mangle_value()
+
+.. autoclass:: waeup.kofa.students.export.StudentStudyCourseExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.students.export.StudentStudyCourseExporter.fields
+  .. autoattribute:: waeup.kofa.students.export.StudentStudyCourseExporter.title
+  .. automethod:: waeup.kofa.students.export.StudentStudyCourseExporter.mangle_value()
+
+.. autoclass:: waeup.kofa.students.export.StudentStudyLevelExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.students.export.StudentStudyLevelExporter.fields
+  .. autoattribute:: waeup.kofa.students.export.StudentStudyLevelExporter.title
+  .. automethod:: waeup.kofa.students.export.StudentStudyLevelExporter.mangle_value()
+
+.. autoclass:: waeup.kofa.students.export.CourseTicketExporter()
+  :noindex:
+
+  .. autoattribute:: waeup.kofa.students.export.CourseTicketExporter.fields
+  .. autoattribute:: waeup.kofa.students.export.CourseTicketExporter.title
+  .. automethod:: waeup.kofa.students.export.CourseTicketExporter.mangle_value()
 
 Data Import