How-to-guides
Updated:
August 17, 2023

How to perform various system administrator tasks in TE Curriculum

The administrator menu supports lots of configuration options. Most of them are grouped in a logical way via the different How to ... guides. A number of 'other' configuration options is grouped in this page, to prevent from having a separate How to ... explanation for each menu item. The menus covered are: Ignorable, Config, Report templates and Audit log.

Configure an export filter (ignorable)

TE Curriculum offers a filter option to exclude specific defined objects from the interface. The configured objects will not be available via the interface and are defined as TE Curriculum internal only.
This option is added to provide a basic filter option in case due to architectural constraints the ESB is not allowed to filter or the receiving system is not capable of filtering.

Multiple ignore-filters can be used to prevent specific data to be send via the API

Use the Add to define a new, or click on an already defined rule to configure the object to be filtered.


Configure the filter by providing the type, external ID / IDs and a explanation as documentation

The following options can be used to configure the filter:

  • Type - Object type to be filtered. Supported object types are:
    - Faculty
    - Module
    - Module group
    - Organisation
    - Person group
    - Person
    - Programme (study)
    - Schedule
    - Year
  • External ID - The unique External ID of the object to be filtered. Multiple IDs can be specified separated by a comma (,)
  • Description - Reason / description why the object is filtered

Configure (generic) system parameters / settings

Via the menu-option Config the administrator can define configuration parameters that will effect the behaviour of the system.

Beware: this configuration is meant for experienced system administrators / TE consultants and has no support in offering pull-down menu's or other fixed select options!

The system administrator can configure the behaviour of the system via config

The supported configuration options are:

  • calendar weeks - Show calendar weeks too in the different planning related overviews
  • copy.full.year - When creating a new academic year, set this to true in order to automatically make a copy of all data to the new year.
  • cost-division.reset -
  • cost-division.task -
  • curriculum.force_owner -
  • curriculum.max_depth - The maximum allowed depth (number of module-groups) in the curriculum
  • curriculum.move - Enable the move of groups and modules in the curriculum structure view
  • curriculum.order - Keep the order of the groups and modules, by automatically adding the order/sequence.
  • curriculum.show_flattened - Show the structure view with less indent
  • customer.style - A customer specific CSS used to manage the used color scheme.
  • dashboard.add.module - Indicator if a button is shown on the dashboard that allows to add a new module. For the button to be shown, the user must also have a role with the right to add new modules.
  • dashboard.export - Indicator if a button is shown on the dashboard that allows to export data.
  • description.editor - Indicator what editor is used for editing descriptions. Supported options are text, markdown or html.
  • description.html.editor - Supported html-tags by the html editor used for editing descriptive (study guide) texts. F.i. bold,italic,underline,bullet,ordered,link,list
  • description.html.editor.copypaste.clean - Indicator if during copy-paste actions all non-standard data (e.g. html tags) are stripped.
  • description.html.editor.count.plain_text - If a max length is defined, strip the HTML tags and only count the actual text.
  • description.markdown.editor - Supported tags by the markdown editor used for editing descriptive (study guide) texts. F.i. bold,italic,underline,bullet,ordered,link,list
  • description.markdown.editor.count.plain_text - If a max length is defined, strip the markdown tags and only count the actual text.
  • export.latest - Export the latest status of the objects, instead exporting only the approved information.
  • export.strategy - Indicator if the export is done AUTOMATIC or not, e.g. triggered by a user like the administrator.
  • faculty.export.legend -
  • group.tabs - Enable the use of tabs in the detailed view
  • html.editor - Supported html-tags by the html editor. F.i. bold,italics,ul,ol,insertLink
  • html.editor.copypaste.clean - Indicator if during copy-paste actions all non-standard data (e.g. html tags) are stripped.
  • html.editor.count.plain_text - If a max length is defined, strip the HTML tags and only count the actual text.
  • language.default - Default language the user is offered at first login.
  • language.descriptions - Supported languages to be entered for descriptive texts, e.g. EN or NL or EN, NL (multi-language). In case not filled in, the language.supported is used as the default
  • language.descriptions_required - Configure the languages that must be filled by the suer
  • language.supported - Supported languages in the user interface by the system, e.g. EN or NL or EN, NL (multi-language).
  • mardown.editor - Indicator to default use the markdown editor
  • markdown.editor.count.plain_text - If a max length is defined, strip the markdown tags and only count the actual text.
  • module-group.code_unique - Indicator if the module-group code should be unique within the system
  • module.code_unique - Indicator if the module code should be unique within the system
  • module.period_versions -
  • module.studies.table_mode - Indicator if the overview of studies that use a module uses a table mode
  • period.view - Indicator how the period information is shown, e.g. block
  • planboard.show_code - Indicator to define if the module code is shown on the planboard, or only the module name is displayed.
  • reference.changes.migrated - Indicator if the changes in reference data are migrated.
  • relations.vacancy -
  • report.directory - Path to a custom report directory
  • schedule.complete.enabled - Indicator if completion of the schedule workflow is enabled/shown
  • schedule.historical_years - Configure the number of years the users are allowed to copy the schedule preferences from.
  • schedule.teacher.optional - Indicator if the definition of relations (teachers) in the scheduling add-on is optional (true) or required (false)
  • select.search_from -
  • support.email - Email used for support requests
  • system.availability - Indicator if the system is available, or unavailable for the normal users.
  • tab.limit - The number of items shown in the tab. In case the number of items exceed the limit an indicator 'more ...' is shown.
  • ui.dateformat - The date format used in the application, f.i. dd-MM-yyyy
  • ui.datetimeformat - The datetime format used in the application, f.i. dd-MM-yyyy HH:mm:ss
  • url.title - Title of the application, shown in the Browser header bar.
  • user.login - Indicator if usage of the internal user-store is allowed for authentication
  • user.noroles.allowed - Indicator if users with no assigned role can login and use (read-only) the system

Configure report templates to report on (curriculum) changes

Report templates are used to configure an overview of all outstanding change requests made by a specific role and targeted to a specific role.
The reports defined by the administrator are shown in the users Reports menu as 'Reports'.

Select the menu option Report templates to manage the templates.

Manage the report templates

Select add or an existing report template to start/modify the configuration of a template.

The report template is configured for the exam committee, to only report changes proposed by the curriculum committee on the examination descriptions.

The template configuration consists of the following elements.

  • Name - Unique name of the report used in the user report menu.
  • Required Role - The role the user must have to select and run the report.
  • Role changes - Changes to the role (new allocation of a person) to be reported.
  • Description changes - Changes to the descriptive texts to be reported.

View the audit log of (administrator) config changes

The data related audit log is available at the user side and provides different report options to report on changes for different stakeholders or reasons, e.g. accreditation.

The administrator audit log provides information on changes made by the administrator to the configuration of the system. The information can be filtered, for instance to show the changes made during a specific time period. The report of changes applied to a test or acceptance environment can be used as input to apply the changes in the production environment.

Select the administrator option 'Audit log' to open the audit log report.

The audit log report provides an overview of all configuration changes

The screen shows the changes made.
Use the different filter options to adjust the information to your needs:

  • Action - Select the action of the change made
    - Created
    - Deleted
    - Modified
  • Type - Specify the search criterium for filtering on the type of configuration item that is changed.
  • Name - Specify the search criterium for filtering on name of the value of a configuration item that is changed.
  • User - Specify the search criterium for filtering on the user that performed changed.
  • From date/time - Specify the start date (time) to only show changes made after the given date (time).
  • To date/time - Specify the end date (time) to only show changes made before the given date (time). Providing both from and to allow to only show changes made in a certain period.

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