How-to-guides
Updated:
August 17, 2023

How to configure TE Study Guide

The TE Study Guide is highly configurable by the Administrator using the configuration options. To start the configuration options login to the system as a user with the Administrator role.

Configure filters (left side bar)

Objects can be filtered via filters. The administrator can add or modify the (visual) behaviour of filters for each of the objects.

The image below shows two defined filters.

An overview of studies with two defined filters (Credits and Study type)

Go to the Administrator -> Filters to open the filter management screen.

The filters are grouped on Entity type, available filters are marked as 'Filtered'

The configuration screen shows the different options that can be used for filtering the different Study guide entity types(study, module-group and module).
Use the select box for entity type to switch between the different types.

The available filter options for the selected entity type are shown. Filters will automatically be created and populated based on the data that is fed into the study guide. Data types like numbers and reference lists (selectable, pre-defined values) will be presented, free text fields will not be filterable via the filter.

Click on Edit to add a new filter or configure a new filter.

Standard filters

The default configuration options are available for the standard filters. The options supported are:

  • Filtered: enables the option as a filter
  • Sequence: the order in which the filter is presented to the user
  • Values: the supported/offered values for filtering.
    Default the values are automatically generated based on the different values for the element in the data set (e.g. all different credit values for the studies).
  • Type: defines the used display option for the filter
  • Show all filters is default selected, that will show all defined filter options
  • Show more/less toggle will default show the configured Max. filters displayed amount of filter options. This offers the option to reduce the shown values and have more overview of all other defined filters. Especially in case a large(r) list of filter options is available, the underlying filters  may be pushed out of the direct visual part of the screen.
  • Show popup with all filters is intended for filters that have a large amount of filter options. The options will be opened in a popup that provides a search to find and select the desired filter option(s).
Edit screen to add or modify a standard filter

In case a filter uses a reference, like the imported difficulty, the values provided in the reference list are use by default. The values can be overwritten by adding 'own' values.
This option can also be used to limit the filters, by only allowing a limited set of difficulties.

Specific filters (credits and years)

The filters for credits and years are filters supporting different configuration options. They provide less options than the other filter fields, due to their technical nature.
The supported options are:

  • Filtered: enables the option as a filter
  • Sequence: the order in which the filter is presented to the user
  • Values: the supported/offered values for filtering.
    Default the values are automatically generated based on the different values for the element in the data set (e.g. all different credit values for the studies).
Filter definition for credits supports limited configuration options

In case a filter uses a reference, like the imported credits, the values provided in the reference list are use by default. The values can be overwritten by adding 'own' values.
This option can also be used to limit the filters, by only allowing a limited set of filters on credits.

Configure labels

The configure labels option is used to define the different labels used in the application. Labels are all texts (links, fixed, buttons, messages) that are standard offered by the application and that are NOT customer data related. The labels used in the customer data context are configured via themenu option.

Go to the Administrator -> Labels to open the label management screen.

All available labels (fixed texts) in the TE Study Guide are shown and can be modified.

Use the select box for Language  to switch between the different supported languages.

Go to the Administrator -> Labels to open the label management screen.

The example below shows the configuration of the label for the disclaimer in the footer.

Configuration of the label for the disclaimer in the footer

Configure references

The configure references option is used to define the reference information shown to the users and provided as ‘reference data’ (code, key, optional label) to the study guide. This option allows to override the text offered by the curriculum management system (e.g. TE Curriculum) by a text that better fits the  user (e.g. student).

Go to the Administrator -> References to open the reference management screen.

The screen below shows the configuration for the reference list 'difficulty' that is provided as just numeric values by the curriculum management system.

Reference list 'difficulty' with its defined values.

Use the select box for Type to switch between the different reference types. The options shown are the different values for references that have been identified in the study guide data.

Click on Edit to modify an existing reference item configuration. The example below shows the configuration for the reference item DIFFICULTY - code = 1.

Options:

  • Name: name / label shown to the user for the reference item
    Depending on the system configuration the different names for the configured languages can be configured.
  • Visibility: defines if this specific value should be shown to the user
  • Sequence: the order of the tab in the header bar
Configuration of a single value in the Difficulty reference list

In case a reference is used in a filter the default values provided in the filter are the defined visible reference items.

Configure tabs

The configure tabs option is used to define the tabs used for navigating the different education elements by the end user in the study guide.

A tab acts like a predefined filter providing direct access to studies or courses (filter on education element), but can also be used to provide direct access to studies or modules of a specific type, e.g. bachelor or master (study) or cursory and free choice (modules).

A simple tab definition, just shown the studies and modules (courses)

A simple configuration shows the tabs that lead to the studies, groups (minor, major, specialisation, …) and courses.
Via configuration the offered tabs can be defined and configured , as shown in the example below.

An advanced filter definition, creating multiple Tabs for specific study types.

Go to the Administrator -> Tabs to open the tabs management screen.

The screen below shows the (advanced) configuration for the tab setting with the 4 options (bachelor, minor, master, courses).

Advanced tab configuration by using filter options to distinct different types of study

Use the select box for Type to switch between the different types (study, module group, module or show all).

Click on Add to add a tab or click on the pencil to modify an existing tab configuration. The example below shows the configuration for the bachelor tab.

Options:

  • Name: name (technical identification) for the tab setting
  • Type: the education element (study, module group, module) the tab is configured for
  • Label: the text shown in the tab to the user.
    In case the system is configured ‘multi-lingual’, the label can de set for each language
  • Sequence: the order of the tab in the header bar
  • Filter: the filter to be used by the tab
    Filter options supported are =, !=, in, e.g. type in (bachelor, master)
Different options to configure a tab

Configure descriptive information (texts on the detail page)

The information on the detail page of a study, module group or module is split in two sections:

  • On he left side the descriptive information of the selected education component
  • On the right hand side the configured widgets
Detailed study information with texts (left) and widgets (right)

The descriptive text section is configured by the configure Reference option.

Go to the Administrator -> Reference to open the reference management screen.

The module supports a number of texts to be shown to the study guide users

he texts are defined as Reference items that configure the types of descriptive texts and can be used to manage the texts:

  • FACULTY_DESCRIPTION
  • STUDY_DESCRIPTION
  • MODULEGROUP_DESCRIPTION
  • MODULE_DESCRIPTION  

Select the type of descriptive text that needs to be configured.
The screenshot above shows 2 descriptive texts that are available and should be shown in a specific order.
The available descriptive texts depend on the defined texts in the integrated system.

Click on Edit to modify an existing description configuration. The example below shows the configuration for the module description Contents.

Options:

  • Name: the (multi-lingual) name/label to the shown as title above the descriptive text
  • Visible: indicator if the text should be shown
  • Sequence: the order of the text on the detailed information screen
Configuration of the 'contents' text section.

Configure widgets (information block on the detail page)

The information on the detail page of a study, module group or module is split in two sections:

  • On he left side the descriptive information of the selected education component
  • On the right hand side the configured widgets
Detailed study information with texts (left) and widgets (right)

The configure widget option is used to define the widgets shown to the users on the right hand of the detail screens (study, module group, module).

Go to the Administrator -> Widgets to open the Widget management screen.

The widget configuration, with the configuration for the Study widget

On the left hand the widgets can be managed. Use the select box for Type to switch between the different education element types (study, module group, module).  On the right hand the information elements defined for the widget are shown.

Add or modify a Widget configuration

Click on Add widget to add or on the pencil to modify an existing widget configuration.
The example below shows the configuration for a widget with practical information in the study details.

Add/modify a widget definition

Options supported are:

  • Name: the technical name, used for identification in the study guide
  • Type: the type (study, module group, module) the widget is for
  • Label: the (multi-lingual) text shown in the header of the widget
  • Sequence: the order of the widget in the left column

Add or modify fields shown in a Widget

Click on Add field to add or on the pencil to modify an existing field configuration.
The example below shows the configuration for the field that shows the code of the module.

Add or modify a field configuration within a Widget

Options supported are:

  • Name: the technical name, used for identification in the study guide
  • Type: the type that defines the field
  • Sequence: the order of the tab in the header bar
  • Label: the (multi-lingual) text shown in the header of the widget
  • Tooltip: additional information provided via a tooltip to the user
  • Visibility: option to define if/how the field will be shown.

Supported field types

Different field types are supported and can be used to add fields and implicit define behaviour of the information shown to the user.

Supported types are:

  • periods: used to show session of offering information. In case a module is offered multiple times, the sessions are shown comma separated.
  • groups (module only): used to show the groups, including a link, of al the module groups that offer the module.
  • relation: used to show the relations, configured by type (e.g. coordinator, lecturer, …)
  • description: used to show a descriptive text
  • link: used to show a link to an external system
  • value: a plain value, that is considered a base information element, e.g. code
  • additional: a plain value, that is considered an additional information element
  • studies (module, module group only): used to show the studies, including a link, of al the studies that offer the module group or module.
Field type: periods

The field type period is used to configure and show session of offering information for a module. In case a module is offered multiple times, the sessions are shown comma separated.

The Name is used to identify the information element that defines the sessions of offering.

Add period information of the module to the Widget
Field type: relation

The field type relation is used to configure and show the relations, configured by type (e.g. coordinator, lecturer, …) for a study, module group or module.

The Name is used to specify the type to be shown. The supported types depend on the configuration of your system.

Add relation (coordinator) information of the module to the Widget
Field type: description

The field type description is used to configure and show information considered as descriptive text information. The descriptive text is standard shown on the left hand side of the module (study or module group) details. They can also be configured to be shown in a widget on the right hand side.

The Name is used to specify the type to be shown. The supported types depend on the configuration of your system.

Add descriptive contact information of the module to the Widget
Field type: link

The field type link is used to configure and show a link to an external system.

The Name is used to specify the link. Supported fields that will be substituted by the module information of the selected module by the user are:

  • :code - the module, study or module group code
  • :id - the technical (external Id) of the module, study or module group
Add a link including the module ID to the Widget
Field type: additional

The field type additional is used to configure and show information considered as additional (not basic) information for a study, module group or module.

The Name is used to identify the information element to be shown.

Add additional information on 'difficulty' of the module to the Widget

Configure academic years

The academic years that have been exchanged to the study guide are available via the administration menu.

Go to the Administrator -> Academic years to open the Academic Year management screen.

Academic years exchanged with(and available) in the study guide

Use the pencil to configure the visibility of the academic year.

In the example the year 2023-2024 is active and therefor available to the study guide users.
In case multiple years are 'active' a toggle is provide to the users to switch between the 'active' years.

Validate exchanged periods

The periods that have been exchanged to the study guide are available via the administration menu.

Go to the Administrator -> Periods to open the Period validation screen.

Periods defined in 2023-2024 that are exchanged to and available in the study guide

The report on periods is for validation only and can be used to check if all periods have been exchanged from the source system (e.g. TE Curriculum).

Configure parameters (system settings)

The generic behaviour of the study guide is defined using the Parameters.

Go to the Administrator -> Parameters to open the Parameter configuration screen.

Sample configuration of the study guide

Supported configuration options are:

  • import.enabled - configuration to enable the execution of the scheduled 'full synchronization job'
  • import.exclude.faculties - configuration to exclude the import of faculties (and faculty information)
  • import.latest - configuration if the 'published' information is synchronized, or if the 'latest' (and not yet approved texts) is synchronized
  • import.references - configuration to enable import of reference information
  • import.years - configuration of the (academic) years to be synchronized. Multiple years can be defined, separated by , (e.g. 2022, 2023)
  • languages - configuration of the languages supported in the user interface.
  • theme.selector - configuration that enables usage and switching between different visual themes (end user)
  • visible.years - configuration of the years that will be available for the users. Multiple years can be defined, separated by , (e.g. 2022, 2023)

Report on (scheduled) Jobs

The study guide will synchronize the study guide information from the source (e.g. TE Curriculum).

The synchronization can be executed:

  • Scheduled - the system administrator has configured a time the entire study guide is synchronised
  • Ad-hoc (complete) - the administrator can execute an ad-hoc sync of the entire study guide (Go to the Administrator -> Import)
  • Ad-hoc (study, group, module) - the administrator can execute an ad-hoc sync of an object via the Import button on the object detail screen.

Synchronization will run in the background.

Go to the Administrator -> Jobs to open the Jobs report screen, and validate the status of the Job.

Overview of the jobs that ran to synchronize the study guide information.

Customer unique training

This class is available to receive tailor made for your database set-up. Just fill out the form below and our product expert will get in touch with you to set-up your bespoke class.
I want a bespoke class