| 1 | .. _configuration: |
|---|
| 2 | |
|---|
| 3 | Portal Configuration |
|---|
| 4 | ******************** |
|---|
| 5 | |
|---|
| 6 | There are many places in Kofa where portal parameters can be set or |
|---|
| 7 | page descriptions can be added. These parameters are attributes of |
|---|
| 8 | either dedicated configuration objects or of containers in the |
|---|
| 9 | academics, applicants or data center sections. The latter have been |
|---|
| 10 | described elsewehere. Here we explain the interfaces of the |
|---|
| 11 | configuration section. |
|---|
| 12 | |
|---|
| 13 | Technically speaking, the portal configuration section is a |
|---|
| 14 | container of type `ConfigurationContainer` with id ``configuration`` |
|---|
| 15 | which contains session configuration subobjects:: |
|---|
| 16 | |
|---|
| 17 | |
|---|
| 18 | Portal Configuration (ConfigurationContainer) |
|---|
| 19 | | |
|---|
| 20 | +--->SessionConfiguration |
|---|
| 21 | |
|---|
| 22 | Much like ``academics``, ``students``, ``applicants``, ``hostels`` |
|---|
| 23 | and ``documents``, also ``configuration`` is a unique container |
|---|
| 24 | which is located in the `IUniversity` instance. |
|---|
| 25 | |
|---|
| 26 | Site Settings |
|---|
| 27 | ============= |
|---|
| 28 | |
|---|
| 29 | Site parameters are the attributes of the configuration container to |
|---|
| 30 | be set via the `ConfigurationContainerManageFormPage`. The page |
|---|
| 31 | opens, if an officer with |
|---|
| 32 | :py:class:`ManagePortalConfiguration<waeup.kofa.permissions.ManagePortalConfiguration>` |
|---|
| 33 | permission clicks the 'Portal Configuration' link in the side box. |
|---|
| 34 | |
|---|
| 35 | The `ConfigurationContainer` class implements exactly one interface: |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | .. literalinclude:: ../../../src/waeup/kofa/interfaces.py |
|---|
| 39 | :pyobject: IConfigurationContainer |
|---|
| 40 | |
|---|
| 41 | The page furthermore lists containing session configuration objects |
|---|
| 42 | and allows to add them. |
|---|
| 43 | |
|---|
| 44 | Session Settings |
|---|
| 45 | ================ |
|---|
| 46 | |
|---|
| 47 | Session parameters are the attributes of session configuration |
|---|
| 48 | objects. These parameters may vary between academic sessions. |
|---|
| 49 | Particularly student fees, which often vary from one session to the |
|---|
| 50 | next, can be configured here, if the portal has been customized |
|---|
| 51 | accordingly, see :ref:`customization` below. The session |
|---|
| 52 | configuration objects also serve to: |
|---|
| 53 | |
|---|
| 54 | - disable student payments for certain payment categories and |
|---|
| 55 | subgroups of students |
|---|
| 56 | |
|---|
| 57 | See also `Disable Payment Groups |
|---|
| 58 | <https://kofa-demo.waeup.org/sources#collapseDisablePaymentGroups>`_ |
|---|
| 59 | in the base package. |
|---|
| 60 | |
|---|
| 61 | - disable clearance by clearance officers for the selected session |
|---|
| 62 | |
|---|
| 63 | If clearance is disabled, students can still fill and submit the |
|---|
| 64 | clearance form, but clearance officers can't process the clearance |
|---|
| 65 | requests afterwards. They can neither clear these students nor |
|---|
| 66 | reject their clearance request. |
|---|
| 67 | |
|---|
| 68 | - set the course registration deadline |
|---|
| 69 | |
|---|
| 70 | If the course registration deadline is set, student can't register |
|---|
| 71 | courses unless they pay the late registration fee. |
|---|
| 72 | |
|---|
| 73 | Session configuration objects implement the following interface: |
|---|
| 74 | |
|---|
| 75 | .. literalinclude:: ../../../src/waeup/kofa/interfaces.py |
|---|
| 76 | :pyobject: ISessionConfiguration |
|---|
