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

Last change on this file since 13054 was 12971, checked in by Henrik Bettermann, 9 years ago

Add StudentUnpaidPaymentExporter? to export only unpaid tickets. This exporter is designed for finding and finally purging outdated payment ticket.

File size: 10.9 KB
Line 
1.. _export:
2
3Data Export
4***********
5
6Regular data exporters (1) collect objects from specific containers,
7(2) iterate over the collected objects, (3) extract and mangle
8information from each object, (4) write the information of each object
9into a row of a CSV file and (5) finally provide the file for
10download. The CSV file is neither stored in the database nor archived
11in the filesystem. (3) and (4) means a flattening of the hierarchical
12data structure, i.e. a mapping of objects to flat relational data to
13be stored in a CSV table. The extracted information must not
14necessarily be based only on static attributes of the collected
15object. The data, finally stored in the CSV file, can also be derived
16from parent or child objects, or dynamically computed by the object's
17methods and property attributes. These methods and properties can
18retrieve information from everywhere in the portal's database. In the
19following we list all exporter classes including two attributes and a
20method description. The `fields` attribute contain the column titles
21of the export file. These are not necessarily only attributes of the
22exported objects.
23
24.. note::
25
26  The list of exported columns usually underlies heavy customizations.
27  In the Kofa base package only very few columns are being exported. In
28  some Kofa custom packages tons of data are being gathered from
29  applicants and students and the number of columns increase accordingly.
30
31The `title` attribute unveils the name of the exporter under which
32this exporter will be displayed in the user interface. The
33`mangle_value()` method shows how some of fields are being dynamically
34computed.
35
36Regular Exporters
37=================
38
39User Exporter
40-------------
41
42.. autoclass:: waeup.kofa.userscontainer.UserExporter()
43
44  .. autoattribute:: waeup.kofa.userscontainer.UserExporter.fields
45  .. autoattribute:: waeup.kofa.userscontainer.UserExporter.title
46  .. automethod:: waeup.kofa.userscontainer.UserExporter.mangle_value()
47
48Faculty Exporter
49----------------
50
51.. autoclass:: waeup.kofa.university.export.FacultyExporter()
52
53  .. autoattribute:: waeup.kofa.university.export.FacultyExporter.fields
54  .. autoattribute:: waeup.kofa.university.export.FacultyExporter.title
55  .. automethod:: waeup.kofa.university.export.FacultyExporter.mangle_value()
56
57Department Exporter
58-------------------
59
60.. autoclass:: waeup.kofa.university.export.DepartmentExporter()
61
62  .. autoattribute:: waeup.kofa.university.export.DepartmentExporter.fields
63  .. autoattribute:: waeup.kofa.university.export.DepartmentExporter.title
64  .. automethod:: waeup.kofa.university.export.DepartmentExporter.mangle_value()
65
66Course Exporter
67---------------
68
69.. autoclass:: waeup.kofa.university.export.CourseExporter()
70
71  .. autoattribute:: waeup.kofa.university.export.CourseExporter.fields
72  .. autoattribute:: waeup.kofa.university.export.CourseExporter.title
73  .. automethod:: waeup.kofa.university.export.CourseExporter.mangle_value()
74
75Certificate Exporter
76--------------------
77
78.. autoclass:: waeup.kofa.university.export.CertificateExporter()
79
80  .. autoattribute:: waeup.kofa.university.export.CertificateExporter.fields
81  .. autoattribute:: waeup.kofa.university.export.CertificateExporter.title
82  .. automethod:: waeup.kofa.university.export.CertificateExporter.mangle_value()
83
84Certificate Course Exporter
85---------------------------
86
87.. autoclass:: waeup.kofa.university.export.CertificateCourseExporter()
88
89  .. autoattribute:: waeup.kofa.university.export.CertificateCourseExporter.fields
90  .. autoattribute:: waeup.kofa.university.export.CertificateCourseExporter.title
91  .. automethod:: waeup.kofa.university.export.CertificateCourseExporter.mangle_value()
92
93Access Code Batch Exporter
94--------------------------
95
96.. autoclass:: waeup.kofa.accesscodes.export.AccessCodeBatchExporter()
97
98  .. autoattribute:: waeup.kofa.accesscodes.export.AccessCodeBatchExporter.fields
99  .. autoattribute:: waeup.kofa.accesscodes.export.AccessCodeBatchExporter.title
100
101Access Code Exporter
102--------------------
103
104.. autoclass:: waeup.kofa.accesscodes.export.AccessCodeExporter()
105
106  .. autoattribute:: waeup.kofa.accesscodes.export.AccessCodeExporter.fields
107  .. autoattribute:: waeup.kofa.accesscodes.export.AccessCodeExporter.title
108  .. automethod:: waeup.kofa.accesscodes.export.AccessCodeExporter.mangle_value()
109
110Hostel Exporter
111---------------
112
113.. autoclass:: waeup.kofa.hostels.export.HostelExporter()
114
115  .. autoattribute:: waeup.kofa.hostels.export.HostelExporter.fields
116  .. autoattribute:: waeup.kofa.hostels.export.HostelExporter.title
117
118Bed Exporter
119------------
120
121.. autoclass:: waeup.kofa.hostels.export.BedExporter()
122
123  .. autoattribute:: waeup.kofa.hostels.export.BedExporter.fields
124  .. autoattribute:: waeup.kofa.hostels.export.BedExporter.title
125
126Application Data Exporters
127==========================
128
129Applicants Container Exporter
130-----------------------------
131
132.. autoclass:: waeup.kofa.applicants.export.ApplicantsContainerExporter()
133
134  .. autoattribute:: waeup.kofa.applicants.export.ApplicantsContainerExporter.fields
135  .. autoattribute:: waeup.kofa.applicants.export.ApplicantsContainerExporter.title
136
137Applicant Exporter
138------------------
139
140.. autoclass:: waeup.kofa.applicants.export.ApplicantExporter()
141
142  .. autoattribute:: waeup.kofa.applicants.export.ApplicantExporter.fields
143  .. autoattribute:: waeup.kofa.applicants.export.ApplicantExporter.title
144  .. automethod:: waeup.kofa.applicants.export.ApplicantExporter.mangle_value()
145
146Student Data Exporters
147======================
148
149When starting a Student Data Exporter in the Data Center all student
150records will be taken into consideration, no matter what or where a
151student is studying. The exporter can also be started 'locally' at
152various levels in the academic section. Starting one of the exporters
153e.g. at faculty or department level means that only the data of
154students are exported who study in this faculty or department
155respectively. The exporter can also be started at certificate level.
156Then only the data of students, who are studying the named study
157course, will be taken into account. At course level the data of those
158students are being exported who have attended or taken this specific
159course.
160
161Student Data Exporter can be further configured through a
162configuration page. Search parameters like the student's current level,
163current session and current study mode can be set to filter sets of
164students in order to decrease the size of the export file. The set of
165filter parameters varies and depends on the 'locatation' from where
166the exporter is called. A completely different set of filter
167parameters is provided for courses. In this case the session and level
168can be selected when the course was taken by the student.
169
170Student Exporter
171----------------
172
173.. autoclass:: waeup.kofa.students.export.StudentExporter()
174
175  .. autoattribute:: waeup.kofa.students.export.StudentExporter.fields
176  .. autoattribute:: waeup.kofa.students.export.StudentExporter.title
177  .. automethod:: waeup.kofa.students.export.StudentExporter.mangle_value()
178
179Student Study Course Exporter
180-----------------------------
181
182.. autoclass:: waeup.kofa.students.export.StudentStudyCourseExporter()
183
184  .. autoattribute:: waeup.kofa.students.export.StudentStudyCourseExporter.fields
185  .. autoattribute:: waeup.kofa.students.export.StudentStudyCourseExporter.title
186  .. automethod:: waeup.kofa.students.export.StudentStudyCourseExporter.mangle_value()
187
188Student Study Level Exporter
189----------------------------
190
191.. autoclass:: waeup.kofa.students.export.StudentStudyLevelExporter()
192
193  .. autoattribute:: waeup.kofa.students.export.StudentStudyLevelExporter.fields
194  .. autoattribute:: waeup.kofa.students.export.StudentStudyLevelExporter.title
195  .. automethod:: waeup.kofa.students.export.StudentStudyLevelExporter.mangle_value()
196
197Course Ticket Exporter
198----------------------
199
200.. autoclass:: waeup.kofa.students.export.CourseTicketExporter()
201
202  .. autoattribute:: waeup.kofa.students.export.CourseTicketExporter.fields
203  .. autoattribute:: waeup.kofa.students.export.CourseTicketExporter.title
204  .. automethod:: waeup.kofa.students.export.CourseTicketExporter.mangle_value()
205
206Student Payment Exporter
207------------------------
208
209.. autoclass:: waeup.kofa.students.export.StudentPaymentExporter()
210
211  .. autoattribute:: waeup.kofa.students.export.StudentPaymentExporter.fields
212  .. autoattribute:: waeup.kofa.students.export.StudentPaymentExporter.title
213  .. automethod:: waeup.kofa.students.export.StudentPaymentExporter.mangle_value()
214
215Student Unpaid Payment Exporter
216-------------------------------
217
218.. autoclass:: waeup.kofa.students.export.StudentUnpaidPaymentExporter()
219
220  .. autoattribute:: waeup.kofa.students.export.StudentUnpaidPaymentExporter.title
221
222Bed Ticket Exporter
223-------------------
224
225.. autoclass:: waeup.kofa.students.export.BedTicketExporter()
226
227  .. autoattribute:: waeup.kofa.students.export.BedTicketExporter.fields
228  .. autoattribute:: waeup.kofa.students.export.BedTicketExporter.title
229  .. automethod:: waeup.kofa.students.export.BedTicketExporter.mangle_value()
230
231.. note::
232
233  The above exporters refer to a specific content type (object class).
234  They export all attributes of these objects and a few additional
235  parameters derived from the parent objects. These exporters can be
236  used for reimport, or more precisely for backing up and restoring
237  data. The following 'special' exporters are made on request of some
238  universities to collect and compose student data for analysis and
239  postprocessing by the university.
240
241DataForBursary Exporter
242-----------------------
243
244.. autoclass:: waeup.kofa.students.export.DataForBursaryExporter()
245
246  .. autoattribute:: waeup.kofa.students.export.DataForBursaryExporter.fields
247  .. autoattribute:: waeup.kofa.students.export.DataForBursaryExporter.title
248  .. automethod:: waeup.kofa.students.export.DataForBursaryExporter.mangle_value()
249
250Student Payments Overview Exporter
251----------------------------------
252
253.. autoclass:: waeup.kofa.students.export.StudentPaymentsOverviewExporter()
254
255  .. autoattribute:: waeup.kofa.students.export.StudentPaymentsOverviewExporter.fields
256  .. autoattribute:: waeup.kofa.students.export.StudentPaymentsOverviewExporter.title
257  .. autoattribute:: waeup.kofa.students.export.StudentPaymentsOverviewExporter.curr_year
258  .. automethod:: waeup.kofa.students.export.StudentPaymentsOverviewExporter.mangle_value()
259
260Student Study Levels Overview Exporter
261--------------------------------------
262
263.. autoclass:: waeup.kofa.students.export.StudentStudyLevelsOverviewExporter()
264
265  .. autoattribute:: waeup.kofa.students.export.StudentStudyLevelsOverviewExporter.fields
266  .. autoattribute:: waeup.kofa.students.export.StudentStudyLevelsOverviewExporter.title
267  .. automethod:: waeup.kofa.students.export.StudentStudyLevelsOverviewExporter.mangle_value()
268
269Combo Card Data Exporter
270------------------------
271
272.. autoclass:: waeup.kofa.students.export.ComboCardDataExporter()
273
274  .. autoattribute:: waeup.kofa.students.export.ComboCardDataExporter.fields
275  .. autoattribute:: waeup.kofa.students.export.ComboCardDataExporter.title
276  .. automethod:: waeup.kofa.students.export.ComboCardDataExporter.mangle_value()
Note: See TracBrowser for help on using the repository browser.