August 17, 2023

How to manage user communication (labels and news)

The use of the system can be helped by using the language of your own university. Each of the labels, messages (error, warning) and other information shown or distributed via TE Curriculum can be 'translated' into either another language or in your internally used language. For instance the default label set uses module, where in your situation course could be more appropriate.

Use your own language for labels

All texts shown in the application can be configured (and translated) using the label management option.

A label is defined on a page using a 'technical key'. In the screenshot below, the Description.Entity is an example of such a 'technical key'. There is not a complete list of all labels used on each individual page.

This means that the easiest way to change a text and determine if the correct text is changed is done by following the following steps:

  1. Open a second window with the page containing the label / text to be changed
  2. Search for the text in the label management screen
  3. Change the text to the desired value and click on Save
  4. Refresh the secondary window to validate if the text is changed correctly (and if the correct text has been changed).
All labels and messages are available and can easily be changed to the institutions internal used vocabulary

It it also possible to enrich the label text with an HTML tag.
This might be handy to add a link to external documentation: <a href="" target="New">(i)</a>

All labels are automatically predefined with a default text value in the system.
If a technical key is shown in the user interface instead of a label or message, this means that the label is not defined automatically and must be added manually.

To add this label:

  1. Click on the “+Add” button
  2. Copy the 'cryptic name' (label identifier) to the Keyword
  3. Define the relevant label values (NL, EN)
  4. Click on Save

Refresh the user screen to validate if the label is defined correctly and the text is shown in stead of the the label identifier.

Post messages on the dashboard News widget

The users personal dashboards provides a way to show generic news messages via the News widget.

An example of a news message shown on the users personal dashboard

The administrator menu News can be used to configure news items to be shown on the dashboard.

List and manage the defined news items

Use the Add button to define a new News item, or the Edit button to change an already defined item.
Use the delete button to remove News items.

Configure a news item to inform your colleagues

The definition of News items consists of the following elements.

  • Title - The title of the news item
  • Message - The content of the news item. HTML-tags may be used.
  • Style - CSS-configuration to add a specific style to the message. This can also be obtained by embedding the style in the HTML-tags of the message.
  • Fixed in header - Show the news message in the page header. Typically used as a banner to inform the users of an upcoming event.
    (banner color is dependent on used Style: success → green, warning → yellow, danger → red, info → blue)
  • Show admin only - Show the message only to the administrator, so it can be tested first.

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