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