Show Advanced KnowledgeHide Advanced Knowledge

Study Programme: Page Editor Element for Required Actions

1 Initial Problem

With the implementation of the feature request "Customize Study programme" it will be possible to design study programmes via ILIAS Page Editor in order to provide learners with information about a study programme (about content, objectives, etc.).

However, learners do not only want information on the content or objectives of a study program, but they also want to know their current, individual processing status at any time. Particularly in the case of compliance topics, which have to be completed within a certain period of time they would like to know the deadline of the processing period. Apart from E-Mail information there is currently no place in ILIAS where this information can be accessed by the learner. Only a learner's individual plan contains this information.

2 Conceptual Summary

In the page editing mode of a study programme, it should be possible to add a special page element "Action Note" in addition to the "usual" ILIAS page elements. This page element shall be offered for study programmes only in addition to the regular page elements.

As soon as the element has been added to the page via the + symbol it will show individual information about the user`s participation status in the study programme.

If the user is already listed on the "Members Tab" of the study programme, the information comes from the user's individual plan.
If a user is listed on the Members tab multiple times, only the most recent membership is relevant for the Action Note.

Depending on the individual plan of a user different information will be displayed in the "Action Note" element.
The following information should be displayed (also see chart below):

• "Required actions" (= Headline)
• No actions required. / Please complete the content. / Please complete the content until dd.mm.yyyy. (= Instruction)

If a user is listed on the Members tab multiple times, only the most recent membership is relevant for the Action Note.

An icon should visualise the importance of the information ("Something needs to be done here").

If a user is not yet listed on the Members tab of the study programme, the Action Note will say: "No actions required.".

3 User Interface Modifications

3.1 List of Affected Views

Content Tab >> Customize Page >> Page Editing Mode

3.2 User Interface Details

• Users add the page element by clicking on the "+" symbol in the editor.
• A selection menu opens.
• Users select "Insert Action Note"

• In the slate there are the 2 buttons "Save" and "Cancel" only (no settings).
• The content area will show a specific icon for the new page element.
• A click on "Cancel" will cancel the insertion process.
• A click on "Save", will add the element to the page.

3.3 New User Interface Concepts

Currently, the page editor elements are not part of the UI Framework of ILIAS. Hence, there is no initial framework to rely on when proposing new elements for the page editor. We (CaT Concepts and Training GmbH) pledge, however, to take care of this page editor element when the page editor elements become part of the UI framework.

4 Technical Information

This obviously depends on the Page Editor of ILIAS. Since that component already can be extended nicely from consumer components, we most likely won't need any modifications in the Page Editor and can do everything in the Study Programme. Due to the missing integration of the Page Editor in the UI Framework, we will also rely on legacy templating (see section above).

5 Privacy Information

To implement this feature we will process the current qualification status of the user of the component: the current assignment and progress therein, the previous assignment and metadata thereof. The data is already available via the Study Programme, especially the table showing the assignees, but will be presented in a denser form.

6 Security Implications

None.

7 Contact

• Author of the Request: Klees, Richard [rklees]
• Maintainer: Klees, Richard [rklees]
• Implementation of the feature is done by: Haagen, Nils [nlz]

8 Funding

If you are interest in funding this feature, please add your name and institution to this list.

• …

9 Discussion

Seiler, Yvonne [yvseiler], 2. OCT 2023: For the screen with the almost empty slate, we should add a title as for the other page elements (e.g. "Insert Action Note"). This makes it easier to see what the two buttons refer to.

It's probably not possible at the moment, but: Have you checked whether adding an action note would also work without the form in the slate? Workflow would be: Directly after clicking on + "action note" is inserted - no further action is necessary.

10 Implementation

The feature is implemented as described, the new component is available in the page editor.

Test Cases

Test cases completed at 2023-10-25 by Suittenpointner, Florian [suittenpointner].

• C63596 : Aktionshinweis als Seiteninhaltselement

Approval

Approved at 2023-10-30 by Zimmermann, Markus [markus.zimmermann]