Study Guide: basic configuration and administration

Der Auftragsbericht gibt einen Überblick über alle durchgeführten Importaktionen, die Dauer und den Status.

Das folgende Beispiel zeigt die Übersicht über den täglichen Importauftrag, der alle Daten für ein bestimmtes akademisches Jahr importiert, und einen Ad-hoc-Import nur für die Referenzen.

Die Synchronisation kann durchgeführt werden:

• Geplant: Der Systemadministrator hat einen Zeitpunkt festgelegt, zu dem der gesamte Studienführer synchronisiert wird.
• Ad-hoc (vollständig): Der Administrator kann eine Ad-hoc-Synchronisierung des gesamten Studienführers durchführen (Gehen Sie zum Administrator -> Importieren)
• Ad-hoc (Studie, Gruppe, Modul): Der Administrator kann eine Ad-hoc-Synchronisierung eines Objekts über die Schaltfläche Importieren auf dem Objektdetailbildschirm (Benutzeroberfläche) durchführen.
• Ad-hoc (Referenzen): Der Administrator kann eine Ad-hoc-Synchronisierung der Referenzen aus dem Übersichtsbericht Referenzen durchführen.

Die Synchronisierung läuft im Hintergrund.

Gehen Sie zu Administrator -> Aufträge, um den Bildschirm Auftragsbericht zu öffnen und den Status des Auftrags zu überprüfen.

Die Option Referenzen dient zur Verwaltung der Referenzinformationen, die automatisch aus dem Lehrplan importiert und den Benutzern in Filtern und Detailseiten angezeigt werden.

Gehen Sie zu Administrator -> Referenzen, um den Bildschirm für die Referenzverwaltung zu öffnen.

Der Bildschirm unten zeigt die Konfiguration für die Referenzliste "Schwierigkeit", die vom Curriculum-Management-System nur als numerische Codes bereitgestellt wird.
Die Schaltfläche " Importieren" in der rechten oberen Ecke kann für eine Ad-hoc-Synchronisierung nur der Referenzinformationen verwendet werden.

Die detaillierte Konfiguration der Benutzeroberfläche ermöglicht es auch, nur die Bezeichnung (Standardverhalten) oder eine gestaltete Kombination aus Code und Name anzuzeigen.

Verwenden Sie das Auswahlfeld für Typ, um zwischen den verschiedenen importierten Referenztypen zu wechseln. Die angezeigten Optionen sind die verschiedenen Werte für Referenzen, die aus dem Lehrplan importiert wurden

Klicken Sie auf Bearbeiten, um eine bestehende Konfiguration eines Referenzobjekts zu ändern.

Das nachstehende Beispiel zeigt die Konfiguration für das Referenzobjekt SCHWIERIGKEITSVERTIEFELUNG (Code = 3). Der Code kann nicht geändert werden, um zu verhindern, dass Admins ihn kaputt machen ;-)

Optionen:

• Name: Name/Beschriftung, die dem Benutzer für das Referenzobjekt angezeigt wird
  Je nach Systemkonfiguration kann der Name für die konfigurierten Sprachen festgelegt werden.
• Sichtbar: Legt fest, ob dieser spezifische Wert dem Benutzer angezeigt werden soll oder ob er nicht angezeigt werden soll. Diese Option kann verwendet werden, um die angebotenen Filteroptionen einzuschränken.
• Manuell: legt fest, dass dieser Wert manuell angepasst wurde und nicht durch die automatische Importfunktion überschrieben werden sollte
• Reihenfolge: die Reihenfolge der Optionen in einem Filter.

Die Option Etiketten konfigurieren wird verwendet, um die verschiedenen in der Anwendung verwendeten Etiketten zu definieren. Labels sind alle Texte (Links, Fixes, Buttons, Meldungen), die standardmäßig von der Anwendung angeboten werden und NICHT kundenbezogen sind. Die im Kundendatenkontext verwendeten Labels werden über die Menüoption konfiguriert.

Gehen Sie zu Administrator -> Etiketten, um den Bildschirm für die Etikettenverwaltung zu öffnen.

Verwenden Sie den oberen Filter, um nach bestimmten Bezeichnungen zu suchen, und verwenden Sie den Sprachwähler, um nur die relevante Sprache auszuwählen.

Das folgende Beispiel zeigt die Konfiguration des Etiketts für das Modul Bildungssprache.

Die Zeiträume, die mit dem Studienführer ausgetauscht wurden, sind über das Verwaltungsmenü verfügbar.

Gehen Sie zu Verwalter -> Perioden, um das Bild Periodenvalidierung zu öffnen.

Der Bericht über die Perioden dient nur der Validierung und kann verwendet werden, um zu überprüfen, ob alle Perioden aus dem Quellsystem ausgetauscht wurden.

‍

Das generische Verhalten des Studienleitfadens wird mit Hilfe der Parameter definiert.

Gehen Sie zu Administrator -> Parameter, um den Bildschirm für die Parameterkonfiguration zu öffnen.

Folgende Konfigurationsoptionen werden unterstützt:

• customer.style: Konfiguration, die die Verwendung und den Wechsel zwischen verschiedenen visuellen Themen ermöglicht (Endbenutzer)
• description.format: das Format, in dem die Beschreibungstexte dargestellt werden. Unterstützte Werte sind html und markdown
• import.enabled: Konfiguration, um die Ausführung des geplanten "vollständigen Synchronisierungsauftrags" zu ermöglichen
• import.exclude.faculties: Konfiguration zum Ausschluss des Imports von Fakultäten (und Fakultätsinformationen)
• import.latest: Konfiguration, ob die "veröffentlichten" Informationen synchronisiert werden, oder ob die "neuesten" (und noch nicht genehmigten Texte) synchronisiert werden
• import.years: Konfiguration der zu synchronisierenden (akademischen) Jahre. Es können mehrere Jahre definiert werden, getrennt durch , (z. B. 2022, 2023)
• Sprachen: Konfiguration der Sprachen, die in der Benutzeroberfläche unterstützt werden.
• languages.default: Konfiguration der Standardsprache, wenn diese nicht automatisch erkannt werden kann
• visible.years: Konfiguration der Jahre, die für die Nutzer verfügbar sein sollen. Es können mehrere Jahre definiert werden, getrennt durch , (z. B. 2022, 2023)

Configure visible years and validation of not yet public available year

Independent of the visible year configuration all active years defined, will be available for the administrator. This allows for validation of a new year by the administrator prior to open it for the users.

The configuration options used are:

• The year configuration attribute 'active'
  This attribute is used to define which configured years are actively synchronised and potentially available for users. e.g. 2023, 2024, 2025
• The system setting 'visible years'
  This setting which years are available for users, e.g. 2023, 2024

Embed full study guide

In order to embed the full study guide in an external web page / portal use the underlying code.

The HTML code used to embed is:

<html>
<body>
<h1>Embedded study guide</h1>
<iframe src="https://<URL to studyguide>/studies" width="500px" height="500px">
</iframe>
</body>
</html>

In this case the study guide will open directly with the overview of the studies. By adding another or no path the standard landing page used for the embedded study guide can be manipulated.

Embed study guide page

The above option is used to embed the full study guide, including navigation and filters, in another web page using an iFrame.

In case the information to be shown is known it would be helpful to only show the detail page with the relevant information without navigation and filters. This option is added in this release, where a dedicated information page from study guide can be embedded in the desired language.

Configuration of the URL:‍

The URL will follow a standard convention and has four attributes to show the desired tab:

• URL base: https://<your link to the study guide>/
• URL extension:
  • studies/<study_code>
  • modules/<module_code>
• Page to show:
  • tab=<page_name>
• Year to show
  • year=<year>
• Indicator to only show data
  • data_only=true
• Language indicator
  • language=NL
  • language=EN
  • no language specified will show the language switcher in case of a multi-lingual configuration

The full URL could look something like:
https://studyguide.timeedit.dev/studies/ADQS?tab=study-general&year=2023&data-only=true&language=EN

This option is supported for all data pages and widgets, such as the curriculum mapping matrix, module detail page, study structure page.

The print button is default shown on each page in the study guide. An option is added to disable the Print button on all pages using a global configuration parameter.

Configuration:

• Navigate to the Parameter menu under Administration
• Set the print.visible parameter to false (hide) or true (show, the default value)

The functionality of the study guide is enhanced to support 'banner-like' information display. For example an highlighted information message shown in a tab or all tabs to highlight a year is not fully published.

The information display is available as a widget, which means all options of using widgets on tabs are supported for this new banner widget. Let's first look at the configuration and display the corresponding notification display.

Configuration:

• Add a widget of type Banner
The widget can shown:
  
  • Main tabs, between topbar and breadcrumbs. Usable on main tabs (e.g. study list)
  • Detail tabs (e.g. study ABC-1)
  • Sub-tabs (e.g. study/detail)
  • Fixed positions (e.g. sidebar sequence 4).
• Select widget field type Info
The widget is shown as an alert with configurable Severity. Severity is only shown for INFO widget fields; cleared otherwise.
• Use  Title and details (where other widgets use label and tooltip) .
• Optional define a Filter to restrict the display of the widget. Added shortcuts:
  • credits → credits.[opt/max/min]
  • language → language.externalId
  • year → currently selected year.id (the year selected in the dropdown)
• Add the banner to the relevant Page(s)

‍

Add a banner to be shown on a main tab

Add a banner information message to be shown in a widget

In this case there is already a defined widget, the general widget. A field of type Info is added to this widget, just like any other field.
In the example the info field is added after the credit field and will only appear if a certain filter value is met.