[12870] | 1 | .. _import_processors: |
---|
| 2 | |
---|
| 3 | Batch Processors |
---|
| 4 | **************** |
---|
| 5 | |
---|
[12922] | 6 | .. seealso:: |
---|
| 7 | |
---|
[12952] | 8 | :ref:`Batch Processing Doctests (The Caveman Story) <batchprocessing_txt>` |
---|
[12922] | 9 | |
---|
[12952] | 10 | :ref:`Batch Processing via Browser Doctests <batchprocessing_browser_txt>` |
---|
[12922] | 11 | |
---|
[12883] | 12 | All batch processors inherit from the |
---|
| 13 | :py:class:`waeup.kofa.utils.batching.BatchProcessor` base class. The |
---|
| 14 | `doImport` method, described above, always remains unchanged. All |
---|
| 15 | processors have a property `available_fields` which defines the set |
---|
| 16 | of importable data. They correspond with the column titles of the |
---|
| 17 | import file. Available fields are usually composed of location fields, |
---|
[12884] | 18 | interface fields and additional fields. Overlaps are possible. |
---|
[12883] | 19 | Location fields define the minumum set of fields which are necessary |
---|
| 20 | to locate an existing object in order to update or remove it. |
---|
| 21 | Interface fields (schema fields) are the fields defined in the |
---|
| 22 | interface of the data entity. Additional fields are additionally |
---|
| 23 | needed for data processing. We further distinguish between required |
---|
| 24 | and optional fields or between schema and non-schema fields. |
---|
[12870] | 25 | |
---|
[12883] | 26 | In the following we list all available processors of the Kofa base |
---|
| 27 | package including some important methods which describe them best. We |
---|
| 28 | do not list available fields of each processor here. Available fields |
---|
| 29 | are shown in the browser user interface on the upload page of the |
---|
[12968] | 30 | portal. The processors of the Kofa base package can be viewed |
---|
| 31 | `here <http://kofa-demo.waeup.org/processors>`_. |
---|
[12870] | 32 | |
---|
| 33 | Regular Processors |
---|
| 34 | ================== |
---|
| 35 | |
---|
| 36 | User Processor |
---|
| 37 | -------------- |
---|
| 38 | |
---|
| 39 | .. autoclass:: waeup.kofa.authentication.UserProcessor() |
---|
| 40 | :noindex: |
---|
| 41 | |
---|
| 42 | Faculty Processor |
---|
| 43 | ----------------- |
---|
| 44 | |
---|
| 45 | .. autoclass:: waeup.kofa.university.batching.FacultyProcessor() |
---|
| 46 | :noindex: |
---|
| 47 | |
---|
| 48 | Department Processor |
---|
| 49 | -------------------- |
---|
| 50 | |
---|
| 51 | .. autoclass:: waeup.kofa.university.batching.DepartmentProcessor() |
---|
| 52 | :noindex: |
---|
| 53 | |
---|
| 54 | Certificate Processor |
---|
| 55 | --------------------- |
---|
| 56 | |
---|
| 57 | .. autoclass:: waeup.kofa.university.batching.CertificateProcessor() |
---|
| 58 | :noindex: |
---|
| 59 | |
---|
| 60 | Course Processor |
---|
| 61 | ---------------- |
---|
| 62 | |
---|
| 63 | .. autoclass:: waeup.kofa.university.batching.CourseProcessor() |
---|
| 64 | :noindex: |
---|
| 65 | |
---|
| 66 | Certificate Course Processor |
---|
| 67 | ---------------------------- |
---|
| 68 | |
---|
| 69 | .. autoclass:: waeup.kofa.university.batching.CertificateCourseProcessor() |
---|
| 70 | :noindex: |
---|
| 71 | |
---|
[12883] | 72 | Access Code Batch Processor |
---|
| 73 | --------------------------- |
---|
| 74 | |
---|
| 75 | .. autoclass:: waeup.kofa.accesscodes.batching.AccessCodeBatchProcessor() |
---|
| 76 | :noindex: |
---|
| 77 | |
---|
| 78 | Access Code Processor |
---|
| 79 | --------------------- |
---|
| 80 | |
---|
| 81 | .. autoclass:: waeup.kofa.accesscodes.batching.AccessCodeProcessor() |
---|
| 82 | :noindex: |
---|
| 83 | |
---|
| 84 | Hostel Processor |
---|
| 85 | ---------------- |
---|
| 86 | |
---|
| 87 | .. autoclass:: waeup.kofa.hostels.batching.HostelProcessor() |
---|
| 88 | :noindex: |
---|
| 89 | |
---|
[13434] | 90 | Bed Processor |
---|
| 91 | -------------- |
---|
| 92 | |
---|
| 93 | .. autoclass:: waeup.kofa.hostels.batching.BedProcessor() |
---|
| 94 | :noindex: |
---|
| 95 | |
---|
[13144] | 96 | Document Processor |
---|
| 97 | ------------------ |
---|
| 98 | |
---|
| 99 | .. autoclass:: waeup.kofa.documents.batching.DocumentProcessorBase() |
---|
| 100 | :noindex: |
---|
| 101 | |
---|
[12870] | 102 | Application Data Processors |
---|
| 103 | =========================== |
---|
| 104 | |
---|
| 105 | Applicants Container Processor |
---|
| 106 | ------------------------------ |
---|
| 107 | |
---|
| 108 | .. autoclass:: waeup.kofa.applicants.batching.ApplicantsContainerProcessor() |
---|
| 109 | :noindex: |
---|
| 110 | |
---|
| 111 | Applicant Processor |
---|
| 112 | ------------------- |
---|
| 113 | |
---|
| 114 | .. autoclass:: waeup.kofa.applicants.batching.ApplicantProcessor() |
---|
| 115 | :noindex: |
---|
[12872] | 116 | |
---|
[13876] | 117 | Applicant Online Payment Processor |
---|
| 118 | ---------------------------------- |
---|
| 119 | |
---|
| 120 | .. autoclass:: waeup.kofa.applicants.batching.ApplicantOnlinePaymentProcessor() |
---|
| 121 | :noindex: |
---|
| 122 | |
---|
[12872] | 123 | Student Data Processors |
---|
| 124 | ======================= |
---|
| 125 | |
---|
| 126 | Student Processor |
---|
| 127 | ----------------- |
---|
| 128 | |
---|
| 129 | .. autoclass:: waeup.kofa.students.batching.StudentProcessor() |
---|
| 130 | :noindex: |
---|
| 131 | |
---|
[14657] | 132 | .. _student_study_course_processor: |
---|
| 133 | |
---|
[12872] | 134 | Student Study Course Processor |
---|
| 135 | ------------------------------ |
---|
| 136 | |
---|
| 137 | .. autoclass:: waeup.kofa.students.batching.StudentStudyCourseProcessor() |
---|
| 138 | :noindex: |
---|
| 139 | |
---|
| 140 | Student Study Level Processor |
---|
| 141 | ----------------------------- |
---|
| 142 | |
---|
| 143 | .. autoclass:: waeup.kofa.students.batching.StudentStudyLevelProcessor() |
---|
[12882] | 144 | :noindex: |
---|
| 145 | |
---|
| 146 | .. note:: |
---|
| 147 | |
---|
[12883] | 148 | The student data processors described so far are mainly intended for |
---|
| 149 | restoring data. If the portal is operated correctly and without |
---|
| 150 | interruption and students follow the workflow from their first to the |
---|
| 151 | final study year, there is no need to use the above batch processors |
---|
| 152 | to maintain the data. The processors are not part of the student |
---|
| 153 | registration management. The following processors can or sometimes |
---|
| 154 | even must be integrated into the regular management of student data. |
---|
| 155 | Scores have to be imported, new payment tickets have to created, the |
---|
| 156 | verdicts have to be set or workflow transitions have to be triggered. |
---|
[12882] | 157 | |
---|
[13003] | 158 | .. _course_ticket_processor: |
---|
| 159 | |
---|
[12882] | 160 | Course Ticket Processor |
---|
| 161 | ----------------------- |
---|
| 162 | |
---|
| 163 | .. autoclass:: waeup.kofa.students.batching.CourseTicketProcessor() |
---|
| 164 | :noindex: |
---|
| 165 | |
---|
| 166 | Student Online Payment Processor |
---|
| 167 | -------------------------------- |
---|
| 168 | |
---|
| 169 | .. autoclass:: waeup.kofa.students.batching.StudentOnlinePaymentProcessor() |
---|
| 170 | :noindex: |
---|
| 171 | |
---|
| 172 | Verdict Processor |
---|
| 173 | ----------------- |
---|
| 174 | |
---|
| 175 | .. autoclass:: waeup.kofa.students.batching.StudentVerdictProcessor() |
---|
| 176 | :noindex: |
---|