Studienführer: Konfiguration der Nutzererfahrung

Die Option "Registerkarten konfigurieren" wird verwendet, um die Registerkarten zu definieren, die der Endbenutzer für die Navigation durch die verschiedenen Bildungselemente im Studienführer verwendet.

Registerkarten können unter konfiguriert werden:

• die Hauptebene, die direkten Zugang zu bestimmten Bildungsobjekten bietet. Die Hauptregisterkarten können auf einem Filter basieren, z.B.studyId in ('BA', 'MA')
• die Detailseite, die eine Umschaltmöglichkeit zwischen verschiedenen Arten von Inhalten bietet, z. B. Texte und Struktur für das Studium oder Texte, Lernziele und Bewertungsschema zum Modul.

Im Folgenden finden Sie drei verschiedene Optionen für die Konfiguration der Registerkarten

‍

Gehen Sie zu Administrator -> Registerkarten, um den Bildschirm zur Verwaltung der Registerkarten zu öffnen.

Der Bildschirm öffnet eine Übersicht über die definierten Registerkarten.
Indikatoren werden verwendet, um zu definieren, ob die Registerkarte eine Unterregisterkarte ist (auf einer Detailseite), Widgets zugewiesen hat und den optionalen definierten Filter.

Verwenden Sie das Auswahlfeld für den Entitätstyp, um zwischen den verschiedenen Typen zu wechseln (Studium, Modulgruppe, Modul oder alle anzeigen).

Klicken Sie auf Hinzufügen, um eine Registerkarte hinzuzufügen, oder klicken Sie auf den Bleistift, um eine bestehende Registerkartenkonfiguration zu ändern. Das folgende Beispiel zeigt die Konfiguration für die Registerkarte "Bachelor".

Optionen:

• Name: Name (technische Identifikation) für die Einstellung der Registerkarte
• Entitätstyp: das Bildungselement (Studium, Modulgruppe, Modul), für das die Registerkarte konfiguriert ist
• Eltern auswählen: Für Unterregisterkarten muss die übergeordnete Seite definiert werden, d. h. die Seite, die die verschiedenen Registerkarten bereitstellt.
• Widget hinzufügen: Wählen Sie die Widgets aus, die auf dieser Seite angezeigt werden sollen. Überprüfen Sie die Position der Widgets und die Konfiguration der Widgets in den nächsten Abschnitten dieses Handbuchs.
• Beschriftung: der Text, der dem Benutzer auf der Registerkarte angezeigt wird.
  Wenn das System als "mehrsprachig" konfiguriert ist, kann die Beschriftung für jede Sprache festgelegt werden.
• Reihenfolge: die Reihenfolge der Registerkarten in der Kopfleiste
• Filter: der Filter, der von der Registerkarte
  verwendet werden soll. Unterstützte Filteroptionen sind =, !=, in, z. B. type in (BA, MA). Der verwendete filter_name und filter_ value sollten beide existieren und dem in Curriculum definierten Wert Name / Code ähnlich sein.

Die Hauptregisterkarte Bachelor verwendet einen Filter, um nur Studien eines bestimmten Typs (BA) anzuzeigen.

‍

The search result is fully configurable, where two sections are defined and can be styled independent.

On the left side is the Container area, where the first available description is shown. A configuration option is available to show the Title of the description, or just only the text (as is the current situation).

On the right side is the Sidebar are, where the relevant attributes are shown.

The details are still accessible by clicking on the link to show more details.

The first step to configure the search result is to define three separate widgets, one for the search header, one for the container, and one for the sidebar (details). In the example below the second two are shown and named quickview-main for the Container and quickview-detail for the Sidebar.

Next step is to configure the quickview-detail.
Just click the pencil (Edit) of the quickview-detail and add the fields to be shown.

The example has added the code, credits and periods field.

The next step is to configure the quickview-primary (header).
Define the fields to be shown including the sequence,

The widget field with the lowest sequence number is shown as title bold in the overview, with other fields displayed below it. When multiple values are present, they will be separated by commas.

For instance, you can display a title or name in bold using a widget field of type VALUE, where a format like (${code}) ${name} can be configured.
Currently, only the ${code} and ${name} keys are supported for this purpose.

The display format configuration option is provide for each object and supports ${code} and ${name} as replaceable attributes and can be constructed using standard characters, e.g. Intro to curriculum (VS1) -> {name} ({code})

Additional configuration options include:

• Customizing proper labels.
• Hiding empty values.
• Adding tooltips.

Admins can also customize views differently for various entities (e.g., studies, groups, faculties) and refine the study guide with this new flexibility. As a tab can have filters, it becomes possible to configure different fields for each distinct overview. For example, the tab for minor programs might show a faculty and link field, whereas the master program tab shows an organization instead.

If no Primary widget is configured, the system will revert to a preconfigured title and field layout. However, we highly recommend setting this configuration up, as the hardcoded values might get removed in a future update.

The search result header base on the above list of fields is 'pretty crowded', but provides a good overview of setting the title and what happens in case a huge number of fields are selected for the search result header. Depending on the field, a direct link to a 'related object' is provided.

The next step is to configure the quickview-main.
Define the description to be shown including the sequence they will be evaluated on existence of data.
The example belows will by default show Learning Goals (sequence 1), and have a fall-back to show EntryRequirements (sequence 2).

Don't forget to set the 'hide when empty' flag on the description to prevent from showing the Title.

The next step is to configure the module search result widget by assigning the two defined widgets.

Configuration also allows to only define for instance the Container (quickview-main), so only the descriptive text is shown and no additional fields are shown in the Container area.

Search result tab or list view

This search result provides two options to be shown:

• tile-oriented table result
• condensed list result

The tile-oriented (table) result is shown in the examples in this section (above).
The condensed list mode for product overviews is less verbose and might in some cases offer more structure and a user-friendly layout to the search result data. By supporting both option it provides admins with significant flexibility in how information is presented.

Two Display Modes

Admins can configure available modes per tab using the new modes option:‍

• Existing tabs: Default to the existing list mode to ensure no breaking changes.

• New tabs: Default to both list and table modes (list,table), allowing users to switch between the two.

• The order in which modes are configured determines the default display:
  • table,list: Shows both table and list modes, with the table displayed first.
  • list,table: Shows both table and list modes, but defaults to the list view first.
  • list: Only shows the paneled list mode
  • table: Only shows the condensed table mode
• The mode selector is only shown when multiple modes are enabled.

• If no modes are configured (e.g. for new tabs), both list and table modes are active, with list mode displayed by default.

Table Mode Features:

• Primary Widget Fields: Each widget field is shown as a column, showing the labels as headers. The Table mode always requires configuration through widgets, unlike the List which has a fallback to fixed fields.

• Widget Field Types: All field types are supported, horizontal scrolling is available when necessary (with the first column fixed on tablet and desktop).

• Clickable Rows: Clicking on a row navigates to the product, while URL and LINKS fields open their links instead.

• Increased Page Sizes: If the table is the default mode, the page size(s) increase.

‍

Based on the configuration an option is offered two switch between the different display modes.

This feature allows for highly tailored views, like a simple table for faculties with a few key fields, or an extensive list for modules showing multiple widget fields.

We recommend enabling both list and table modes (list,table) to offer users flexibility. Table mode is especially useful for those who prefer structured data or need easier navigation, and may improve accessibility, particularly for users using a screen reader.

Die Detailseite eines Bildungsobjekts (Fakultät, Qualifikation, Studium, Modulgruppe, Modul) ist in einem generischen Layout mit gekennzeichneten Abschnitten aufgebaut.

Jeder Abschnitt kann mit Widgets gefüllt werden. Ein Widget ermöglicht die Konfiguration von Informationen, die in einem bestimmten Format angezeigt werden sollen.

Die unterstützten Abschnitte sind:

• Seitenleiste: Der Bereich auf der rechten Seite, der sowohl Informationen als auch kontextbezogene Informationen über das angezeigte Bildungsobjekt enthält.
• Container: Der Bereich, in dem die beschreibenden Texte des Studienführers angezeigt werden. Wenn ein Gliederungsabschnitt definiert ist, wird eine Schaltfläche angezeigt, mit der Sie zwischen den verschiedenen Ansichten wechseln können.
• (Programm-)Struktur: Der Bereich, der verwendet wird, um den strukturellen Aufbau eines Programms oder einer Modulgruppe zu zeigen. Wenn Sie sowohl einen Container als auch eine Struktur haben, können Sie mit einer Schaltfläche zwischen den beiden Ansichten wechseln.
• Beurteilungen: Der Bereich, der für die Visualisierung des Bewertungsschemas (Beurteilungs-Widget) vorgesehen ist.
  
• Schaltflächen: Der Bereich oben, in dem Links zu anderen Systemen konfiguriert werden können, die als Schaltflächen angezeigt werden.

‍

Um die Informationen zu konfigurieren, die als praktische Informationen angezeigt werden sollen, muss ein Widget mit dem Namen general definiert werden.

Gehen Sie zu Administrator -> Widgets, um den Bildschirm zur Verwaltung der Widgets zu öffnen.

Es wird eine Übersicht der bereits definierten (oder vorkonfigurierten) Widgets angezeigt.

Auf der linken Seite können die Widgets verwaltet werden.
Klicken Sie auf das Auswahlfeld unter Typ, um die konfigurierten Widgets für einen bestimmten Bildungsobjekttyp (Dozent, Qualifikation, Studium, Modulgruppe, Modul) zu filtern.
Auf der rechten Seite werden die für das Widget konfigurierten Informationselemente aufgelistet.

Hinzufügen oder Ändern einer Widget-Konfiguration

Klicken Sie auf die Schaltfläche Widget hinzufügen, um ein Widget hinzuzufügen, oder auf den Bleistift, um ein vorhandenes Widget zu ändern.
Das folgende Beispiel zeigt die Konfiguration für ein Widget mit praktischen Informationen in den Moduldetails.

Unterstützte Optionen sind:

• Name: der technische Name, der zur Identifizierung im Studienführer verwendet wird
  
• Objekttyp: der Typ (Fakultät, Qualifikation, Studium, Modulgruppe, Modul), für den das Widget bestimmt ist
• Filter: Optionale Filterkonfiguration, um dieses Widget nur dann anzuzeigen, wenn die Konfiguration erfüllt ist, z. B. type = MOOC, um dieses Widget nur anzuzeigen, wenn der Modultyp = MOOC ist.
• Label: der (mehrsprachige) Text, der in der Kopfzeile des Widgets angezeigt wird
• Typ: Definieren Sie den Typ des Widgets, indem Sie das Anzeigeformat festlegen:
  • Beurteilungen - spezifische Ansicht zur Anzeige des Beurteilungsplans.
  • Schaltflächen - Schaltflächenbereich, in dem definierte Links als Schaltflächen angezeigt werden
  • Container - der Textbereich (66%) auf der linken Seite
  • Seitenleiste - der Seitenleistenbereich (33%) auf der rechten Seite
  • Programmstruktur - spezifische Ansicht zur Darstellung der Studien-/Modulgruppenstruktur
• Reihenfolge: die Reihenfolge der Widgets in der linken Spalte
• Sichtbar: Toggle, um festzulegen, ob das Widget sichtbar ist oder nicht
• Show on print: configuration option to mark if a widget should be shown when printing a study or module page.
• Hide header: hide the header of the widget
• Hide show more: hide the show more on 'descriptive texts'. This setting causes to show the full text without the show more.

Der Standarddruck druckt nur den Inhaltsbereich in voller Seitenbreite.
Wenn Sie die Widgets in der Seitenleiste als Beim Druck angezeigt konfigurieren, werden sie ebenfalls mitgedruckt.

Hinzufügen oder Ändern von Feldern, die in einem Widget angezeigt werden

Klicken Sie auf Feld hinzufügen, um ein Feld hinzuzufügen, oder auf den Bleistift, um eine bestehende Feldkonfiguration zu ändern.
Das folgende Beispiel zeigt die Konfiguration für das Feld, das das Datum der letzten Überprüfung des Moduls anzeigt. Dieses Feld wird in Curriculum als zusätzliches benutzerdefiniertes Feld konfiguriert.

Unterstützte Optionen sind: 

• (Feld-)Typ: der Typ, der das Feld definiert
• Name: der technische Name, der zur Identifizierung des konfigurierten Feldes im Curriculum verwendet wird
• Reihenfolge: die Reihenfolge der Registerkarten in der Kopfleiste
• Filter: die optionale Filterkonfiguration, um dieses Widget nur dann anzuzeigen, wenn die Konfiguration erfüllt ist, z.B. type = MOOC, um dieses Widget nur anzuzeigen, wenn der Modultyp = MOOC ist.
• Format: Option to configure the information to be shown in case a reference list is used as information source. Default the name of the value is shown, but using the format this can be altered using the verbs ${name} and ${code}. E.g configure to show both name and code, something like ${name} (${code}).
• Referenztyp: Die Option zur Angabe des anzuzeigenden Objekttyps, die nur für den Feldtyp Link (siehe unten) verwendet wird.
• Label: der (mehrsprachige) Text, der in der Kopfzeile des Widgets angezeigt wird
• Tooltip: zusätzliche Informationen, die dem Benutzer über einen Tooltip zur Verfügung gestellt werden
• Sichtbarkeit: Option zur Festlegung, ob das Feld angezeigt wird (nie, immer, nur wenn ein Wert vorhanden ist) und eine Option zum Testen, um die Sichtbarkeit auf den Administrator zu beschränken.

Unterstützte Feldtypen

Verschiedene Feldtypen werden unterstützt und können verwendet werden, um Felder hinzuzufügen und implizit das Verhalten der dem Benutzer angezeigten Informationen zu definieren.

Unterstützt werden folgende Typen:

• additional: wird verwendet, um einen Wert anzuzeigen, der als zusätzliches benutzerdefiniertes Feld in Curriculum konfiguriert ist
• Beurteilungen: zur Anzeige von Werten, die auf den Beurteilungs-/Beurteilungsobjekten im Lehrplan definiert sind
• benutzerdefiniert: wird verwendet, um einen benutzerdefinierten Wert zu definieren
• Beschreibung: wird verwendet, um einen beschreibenden Text anzuzeigen
• Gruppen (nur Modul): Zeigt die Gruppen aller Modulgruppen an, die das Modul anbieten.
• Lizenzen: zur Anzeige der Informationen und Werte des Lizenzobjekts
• Verknüpfungen: dienen zur Darstellung der verbundenen Bildungsobjekte, z. B. Studium aus Modul, Qualifikation/Spezifikation aus Studium.
• Methoden: dient zur Darstellung der Lehrmethoden
• Ziele: die definierten und mit dem Modul verbundenen Ziele
• Zeiträume: wird verwendet, um Informationen über den Angebotszeitraum anzuzeigen. Falls ein Modul mehrfach angeboten wird, werden die Zeiträume durch Komma getrennt angezeigt.
• periods_value: wird verwendet, um Werte anzuzeigen, die in den Perioden definiert sind
• Beziehung: dient zur Anzeige der Beziehungen, konfiguriert nach Typ (z. B. Koordinator, Dozent, ...)
• url: wird verwendet, um einen Link zu einem externen System anzuzeigen
• Wert: wird verwendet, um einen Wert anzuzeigen, der als ein im Curriculum konfiguriertes Basisinformationselement gilt, z. B. Code

Spezifische Konfigurationsregeln für Feldtypen

Die Konfiguration der Feldtypen ist recht einfach, indem Sie einfach die verschiedenen gewünschten Felder ausfüllen.

Bei der Konfiguration der verschiedenen Typen gibt es einige Regeln / Überlegungen bezüglich der Verwendung des Wertes Name.

• additional: Der Name sollte genau dem Namen entsprechen, der für das zusätzliche benutzerdefinierte Feld im Curriculum verwendet wird.
• Beurteilungen: Der Name sollte genau mit dem Namen übereinstimmen, der für das benutzerdefinierte Beurteilungs-/Beurteilungsfeld in Curriculum
• Beschreibung: der Name sollte genau dem Code entsprechen, der im Lehrplan für einen bestimmten Text verwendet wird (Elementkonfiguration im Lehrplan)
• Links: Geben Sie den Typ des Objekts an, das als Link angezeigt werden soll, indem Sie den Referenztyp verwenden.
• Punkte: der Name sollte aus Punkten bestehen
• periods_value: Der Name sollte genau mit dem Namen übereinstimmen, der für das benutzerdefinierte Feld periods in Curriculum
• Beziehung: Der Name sollte genau dem Code entsprechen, der im Lehrplan für eine bestimmte Rolle verwendet wird (Konfiguration der Rollen im Lehrplan).
• ‍Wert: Der Name sollte genau dem Namen entsprechen, der für das benutzerdefinierte Feld im Lehrplan verwendet wird. Für Credits verwenden Sie den voreingestellten Namen Credits.

Setting the right credits (custom-field) information

The default credits configuration in Curriculum provides the fields minimum, optimum and maximum. It is supported to hide these fields and / or add own defined custom-fields. These fields were not exchanged with study guide and couldn't therefor not be added/shown in study guide. This has been fixed, so the custom-fields defined for credits are correctly exchanged and available for display in the study guide.

Setting the period display type

The default display of periods is showing the period(s) using the defined abbreviation, separated by a comma in case multiple offering periods are defined. E.g., S1, S2.

Next to the default a specific visualisation widget for offering periods named PERIODS_TIMELINE is available next to the PERIODS_VALUE (e.g. P1, S2), as shown below.

The period widget that is based on the PERIODS_TIMELINE can be used both in the detail pages and list pages.
It will default visualise the periods as shown above. In case multiple offering periods are defined and there is an overlapping period (e.g., S1 and Q2+Q3), the display will fall back for that specific module to the standard value representation (S1, Q2+Q3).

The configuration starts with the standard configuration of a new widget, and add a field based on the PERIODS_TIMELINE template.

In the example below the standard module-search-header is configured to show the module title, the credits and the periods as timeline visualisation.

The configuration of the field credits is straight-forward. Just define the field credits is based on PERIODS_TIMELINE and the config is done.

The visualisation is added to the search result, which means the search result is as shown below. In this case we added a module with overlapping periods, to show that happens in that specific case.

Die Konfiguration des allgemeinen (Inhalts-)Bereichs kann aus der Definition mehrerer verschiedener Widget-Typen bestehen.

Das folgende Beispiel zeigt die Konfiguration der Seite mit den Studiendetails und zwei Registerkarten, die mithilfe von Tab config konfiguriert wurden.
Für jede dieser beiden Registerkarten muss ein spezifisches Widget definiert werden.

Dieser Abschnitt befasst sich mit der Konfiguration des Inhalts-Widgets, das die Textinformationen anbietet.
Die nächsten Abschnitte befassen sich mit der Definition der Struktur und des Bewertungs-Widgets.

Die Aktionen zum Erstellen und Bearbeiten der Schaltflächen sind ähnlich wie bei den anderen Widgets und werden nicht wiederholt. Navigieren Sie einfach zurück zum Abschnitt für die allgemeine Widget-Konfiguration.

Die verfügbaren Texte für den ausgewählten Objekttyp basieren auf den vom Curriculum erhaltenen Element-(Referenz-)Informationen zu Beschreibungen.
. Der jeweilige unterstützte Beschreibungstext ist die Referenzinformation:

• FAKULTÄTS_BESCHREIBUNG
• SPEZIFIKATION_BESCHREIBUNG
• QUALIFIKATION_BESCHREIBUNG
• STUDIEN_BESCHREIBUNG
• MODULEGROUP_DESCRIPTION
• MODUL_BESCHREIBUNG

Fügen Sie ein Feld für jeden der gewünschten beschreibenden Textabschnitte hinzu.

Der Wert Ausblenden, wenn leer kann nützlich sein, um zu verhindern, dass leere Überschriften für Textabschnitte ohne Inhalt angezeigt werden.

Die Strukturseite bietet einen detaillierten Überblick über die Programmstruktur. Es können nur die Informationen (und Überschriften) konfiguriert werden, die in der Übersicht der Module angezeigt werden.

Die obige Konfiguration in der Widget-Konfiguration wird unten angezeigt.
Die Beschreibung wird nicht angezeigt, da keines dieser Module eine Beschreibung hat und die Konfiguration den Wert Hide when empty gesetzt hat.

Beachten Sie, dass in dieser speziellen Situation Felder vom Typ CUSTOM verwendet werden. Der Grund dafür ist, dass die Informationen in einer Struktur teilweise auf dem Kontext und der Beziehung basieren. So kann z.B. ein Modul, das im Kontext eines bestimmten Programms angegeben wird, einen anderen Angebotszeitraum haben als ein Modul, das in einem anderen Programm enthalten ist.

Die verfügbaren CUSTOM-Typen, bei denen der Name genau übereinstimmen muss, damit der richtige Wert angezeigt wird, sind:

• Angebote: zeigt den/die Angebotszeitraum(e) an, der/die in der Beziehung Modul->Modulgruppe definiert ist/sind
• Phase: zeigt die Phase an, die in der Beziehung Modul->Modulgruppe definiert ist
• Credits: zeigt standardmäßig die definierten optimalen Credits an. Dies könnte auch als VALUE konfiguriert werden, da es nicht auf der Relation, sondern auf dem Modul selbst definiert ist. Es sollte der Name credits verwendet werden.

Das Beurteilungs-Widget ist vom Typ Beurteilungen, das die Visualisierung der Bewertungen, der Gewichtung, der Mindestnote usw. in einer bestimmten Ansicht ermöglicht.

Das Beurteilungs-Widget ist in vielerlei Hinsicht dem Struktur-Widget ähnlich. Es wird verwendet, um festzulegen, welche "Informationen" im Beurteilungsschema angezeigt werden sollen, ähnlich wie die Modulinformationen in der Strukturansicht.

Verwenden Sie die Standardoptionen für die Widget-Verwaltung, um ein Widget hinzuzufügen oder zu verwalten. Die Beispielkonfiguration unten zeigt, dass das Beurteilungs-Widget mit zwei zusätzlichen Feldern, der Gewichtung und dem Code der Beurteilung, angereichert wurde.

Das Lernziel-Widget wird verwendet, um die Lernziele zu visualisieren, die für die Module im Curriculum definiert wurden.

Die Konfiguration ist äußerst einfach, da nur ein Feld konfiguriert werden muss, um eine Aufzählung aller Lernziele anzuzeigen.

Wie bei allen anderen Widgets wird das Label verwendet, um den Titel oberhalb des Widgets zu konfigurieren.

The tooltip can for this specific widget type be used to specify an introduction to the bullet list, e.g. At the end of the module, the student has learned.

Das Schaltflächen-Widget dient zur Konfiguration der im Schaltflächenbereich angezeigten Schaltflächen.

Links können nicht nur über Schaltflächen definiert werden, sondern auch als Felder zum allgemeinen Widget hinzugefügt werden, indem der Feldtyp URL verwendet wird.

Die Aktionen zum Erstellen und Bearbeiten der Schaltflächen sind ähnlich wie bei den anderen Widgets und werden nicht wiederholt. Navigieren Sie einfach zurück zum Abschnitt für die allgemeine Widget-Konfiguration.

Um eine Schaltfläche zu konfigurieren, definieren Sie den Typ (URL) und den Link. Unterstützte Felder, die durch die (Modul-)Informationen des ausgewählten Moduls, der Studie, der Fakultät, ... ersetzt werden, sind:

• {code} - der Code des Moduls, der Studie oder der Modulgruppe
• {id} - die technische (externe Id) des Moduls, der Studie oder der Modulgruppe

‍

‍

Curriculum mapping has been added to Curriculum and extended the last year. Some curriculum mapping data has been made available in Study guide at module level in the last year too. This year we kick-off of with the first iteration of a matrix-report widget that provides insight in the subjects (learning outcomes, skills, ...) that will be the outcome of the study and the contribution of the modules in the study to the different subjects and objectives (learning goals).

The image below shows a configured example of the curriculum mapping matrix report for a study in the study guide. The matrix-report is available to show the curriculum mapping information both for the Study object and the Module-group object.

As might be noticed, the category grouping as defined in curriculum (top of the image) is shown as code and not as the label. This is a known issue, but requires an API change that wasn't feasible to be done in this release.

Configuration

The configuration consists of different steps from definition of the basic configuration to enabling the widget to be shown in the study guide.

1 - Configure the widget

Configure a new widget of type Matrix.

A filter can be applied to limit the visualisation of the subjects to a specific category, e.g. reference.type=Lo&reference.subType=V. This filter shows only subjects with subject type Lo and subject category V.

The setup of the filter requires knowledge of the configuration in Curriculum and the used subject categories and types.

2 - Add the widget to the tab

The widget is designed (and usable) as a separate tab, just like the structure tab. This means that the visualisation of the curriculum mapping widget is performed by adding it as a new tab. This is done by adding the widget as a tab to the relevant parent(s).

‍

3 - Validate the configuration

The tab should be added and by selecting for instance a study the tab (Subjects) should be available and show the study curriculum mapping widget.