source: main/waeup.kofa/trunk/docs/source/userdocs/configuration.rst @ 14312

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

More docs.

File size: 2.6 KB
Line 
1.. _configuration:
2
3Portal Configuration
4********************
5
6There are many places in Kofa where portal parameters can be set or
7page descriptions can be added. These parameters are attributes of
8either dedicated configuration objects or of containers in the
9academics, applicants or data center sections. The latter have been
10described elsewehere. Here we explain the interfaces of the
11configuration section.
12
13Technically speaking, the portal configuration section is a
14container of type `ConfigurationContainer` with id ``configuration``
15which contains session configuration subobjects::
16
17
18  Portal Configuration (ConfigurationContainer)
19  |
20  +--->SessionConfiguration
21
22Much like ``academics``, ``students``, ``applicants``, ``hostels``
23and ``documents``, also ``configuration`` is a unique container
24which is located in the `IUniversity` instance.
25
26Site Settings
27=============
28
29Site parameters are the attributes of the configuration container to
30be set via the `ConfigurationContainerManageFormPage`. The page
31opens, if an officer with
32:py:class:`ManagePortalConfiguration<waeup.kofa.permissions.ManagePortalConfiguration>`
33permission clicks the 'Portal Configuration' link in the side box.
34
35The `ConfigurationContainer` class implements exactly one interface:
36
37
38.. literalinclude:: ../../../src/waeup/kofa/interfaces.py
39   :pyobject: IConfigurationContainer
40
41The page furthermore lists containing session configuration objects
42and allows to add them.
43
44Session Settings
45================
46
47Session parameters are the attributes of session configuration
48objects. These parameters may vary between academic sessions.
49Particularly student fees, which often vary from one session to the
50next, can be configured here, if the portal has been customized
51accordingly, see :ref:`customization` below. The session
52configuration 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
73Session configuration objects implement the following interface:
74
75.. literalinclude:: ../../../src/waeup/kofa/interfaces.py
76   :pyobject: ISessionConfiguration
Note: See TracBrowser for help on using the repository browser.