Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
A
AlekSIS-App-Untis
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
AlekSIS®
Official
AlekSIS-App-Untis
Commits
1a96eee3
Verified
Commit
1a96eee3
authored
3 years ago
by
Nik | Klampfradler
Browse files
Options
Downloads
Patches
Plain Diff
[Docs] Add references
parent
6273c726
Branches
docs-refs
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!110
[Docs] Add references
Pipeline
#49862
canceled
3 years ago
Stage: prepare
Stage: test
Stage: build
Stage: publish
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/admin/10_features.rst
+3
-1
3 additions, 1 deletion
docs/admin/10_features.rst
docs/admin/20_configuration.rst
+11
-8
11 additions, 8 deletions
docs/admin/20_configuration.rst
docs/conf.py
+2
-0
2 additions, 0 deletions
docs/conf.py
with
16 additions
and
9 deletions
docs/admin/10_features.rst
+
3
−
1
View file @
1a96eee3
...
@@ -7,7 +7,7 @@ functionality to automatically import data from Untis into data models
...
@@ -7,7 +7,7 @@ functionality to automatically import data from Untis into data models
of the core and `Chronos`, the timetable and substitution app of AlekSIS.
of the core and `Chronos`, the timetable and substitution app of AlekSIS.
Currently, we only support importing data from the MySQL database of
Currently, we only support importing data from the MySQL database of
`Untis MultiUser`. This is done through configurable background tasks
`Untis MultiUser`
_
. This is done through configurable background tasks
which are executed in a specific interval or at specific points in time.
which are executed in a specific interval or at specific points in time.
Supported Untis features
Supported Untis features
...
@@ -34,3 +34,5 @@ Currently, the following features are known not to be supported:
...
@@ -34,3 +34,5 @@ Currently, the following features are known not to be supported:
* Prebookings
* Prebookings
* Statistical data
* Statistical data
* Special rooms (subject and group rooms)
* Special rooms (subject and group rooms)
.. _Untis MultiUser: https://www.untis.at/produkte/untis-das-grundpaket/multiuser
This diff is collapsed.
Click to expand it.
docs/admin/20_configuration.rst
+
11
−
8
View file @
1a96eee3
...
@@ -9,14 +9,14 @@ license (version 2019 and above) and a MySQL database which
...
@@ -9,14 +9,14 @@ license (version 2019 and above) and a MySQL database which
is reachable by the AlekSIS server. How to configure Untis
is reachable by the AlekSIS server. How to configure Untis
to use this database is described in the `Untis MultiUser Manual`_.
to use this database is described in the `Untis MultiUser Manual`_.
In addition to the technical re
quirements of AlekSIS itself,
In addition to the technical
:
re
f:`core-install-prerequisites` of
a few extra system packages are required:
the AlekSIS core itself,
a few extra system packages are required:
.. code-block:: shell
.. code-block:: shell
apt install libmariadb-dev
apt install libmariadb-dev
The MySQL (or MariaDB) server must be reachable from the AlekSIS
The MySQL (or
`
MariaDB
`_
) server must be reachable from the AlekSIS
server, and a user account in the database is needed. It is sufficient
server, and a user account in the database is needed. It is sufficient
to create this user with ``SELECT`` permissions. On the MySQL shell,
to create this user with ``SELECT`` permissions. On the MySQL shell,
you can create such a user with something like:
you can create such a user with something like:
...
@@ -32,7 +32,8 @@ you can create such a user with something like:
...
@@ -32,7 +32,8 @@ you can create such a user with something like:
Configure database connection
Configure database connection
-----------------------------
-----------------------------
In the AlekSIS configuration file, you have to set following settings:
In the AlekSIS configuration file (cf. :ref:`core-configuraiton-files`,
you have to set the following settings:
.. code-block:: toml
.. code-block:: toml
...
@@ -72,7 +73,7 @@ The way data are imported can be configured from the menu under
...
@@ -72,7 +73,7 @@ The way data are imported can be configured from the menu under
Scheduling import tasks
Scheduling import tasks
-----------------------
-----------------------
The integration provides different
background
tasks to import the data from Untis:
The integration provides different
:ref:`core-periodic-
tasks
`
to import the data from Untis:
* ``untis_import_mysql_current_term``: This will import all data from the **current**
* ``untis_import_mysql_current_term``: This will import all data from the **current**
Untis term.
Untis term.
...
@@ -98,8 +99,10 @@ How existing data is matched
...
@@ -98,8 +99,10 @@ How existing data is matched
If there are already existing data in AlekSIS' database, the Untis import will
If there are already existing data in AlekSIS' database, the Untis import will
always try to combine these data. The main data field used for this is the
always try to combine these data. The main data field used for this is the
``short name`` field. If the data were imported
one time, each object in
``short name`` field
(cf. :ref:`core-concept-group`
. If the data were imported
Chronos will save the respective ID from Untis to make
sure that the data are
one time, each object in
Chronos will save the respective ID from Untis to make
properly updated at the next import.
sure that the data are
properly updated at the next import.
The import is thus idempotent.
The import is thus idempotent.
.. _MariaDB: https://mariadb.org
This diff is collapsed.
Click to expand it.
docs/conf.py
+
2
−
0
View file @
1a96eee3
...
@@ -204,4 +204,6 @@ epub_exclude_files = ["search.html"]
...
@@ -204,4 +204,6 @@ epub_exclude_files = ["search.html"]
intersphinx_mapping
=
{
intersphinx_mapping
=
{
"
https://docs.python.org/
"
:
None
,
"
https://docs.python.org/
"
:
None
,
"
https://docs.djangoproject.com/en/stable
"
:
"
https://docs.djangoproject.com/en/stable/_objects
"
,
"
https://docs.djangoproject.com/en/stable
"
:
"
https://docs.djangoproject.com/en/stable/_objects
"
,
"
https://aleksis.edugit.io/AlekSIS-Core/docs
"
:
None
,
"
https://aleksis.edugit.io/AlekSIS-App-Chronos/docs
"
:
None
,
}
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment