Recognise Status of Processing in a Multi-part Study Programme by the Required Actions Element

1 Initial Problem

A user is assigned to a multi-part study programme, i.e., one equipped with sub-nodes.
The parts (sub-nodes) of the study programme are weighted with points.
Parts (sub-nodes) of the study programme have already been completed.

This user now wants to have a clue of how far he/she has come within the study programme, i.e., how many points are required and how many of the required points have already been achieved.
Thus, being able to inform a supervisor about one's progress.

A related requirement is to check whether the required points can be achieved at all (which might not be the case for several reasons), and to be able and contact someone in charge to indicate the non-achievability.

Finally, administrators need an option to decide whether to make points and contact information accessible.

2 Conceptual Summary

With Study Programme: Page Editor Element for Required Actions, a page element has been introduced that shows required actions to user assigned to a study programme.
By now (v9), this page element doens't have any settings at all.

To fulfil the requirements, first of all the "Action Note" page element is equipped with a settings form.

This form offers options to ...

• ... display a progress bar.
  When this functionality is activated, an Action Note shows for all users whose action is required what their score is within the study programme and how many points are required for completion.
  In case the study programme has only one level, the progress bar can only display 0 or maximum, otherwise also values in between.
  In case users cannot complete the study programme at all with their current assignment (due to configuration errors in the study programme as a whole or in the individual plan), the action note displays a warning.
• ... display a "Contact" button:
  When this functionality is activated, an e-mail address can and must be provided.
  This address is opened when users click the "Contact" button in the Actions Note element.

3 User Interface Modifications

3.1 List of Affected Views

• Settings form for the "Actions Note" page element (new)
• "Content" tab of study programmes

3.2 User Interface Details

• Settings form for the "Actions Note" page element:
  • Checkbox "Display Progress Bar"
  • Checkbox "Display 'Contact' Button"
    • Dependent input field "E-Mail Address", accepting only email addresses (incl. "@"):
      Missing entry or entries without "@" are rejected with a qualified warning message.
• "Content" tab of study programmes:
  • If enabled, "Actions Note" page element displays progress bar (like in the "Individual Plan" view).
  • If enabled, "Actions Note" page element displays "Contact" button opening a local mail client with the provided address.

3.3 New User Interface Concepts

(none)

3.4 Accessibility Implications

(none)

4 Technical Information

{ The maintainer has to provide necessary technical information, e.g. dependencies on other ILIAS components, necessary modifications in general services/architecture, potential security or performance issues. }

5 Privacy

(none)

6 Security

(none)

7 Contact

• Author of the Request: Suittenpointner, Florian [suittenpointner]
• Maintainer: Klees, Richard [rklees]
• Implementation of the feature is done by: Klees, Richard [rklees]

8 Funding

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

• CaT Concepts and Training GmbH

9 Discussion

10 Implementation

{ The maintainer has to give a description of the final implementation and add screenshots if possible. }

Test Cases

Test cases completed at {date} by {user}

• {Test case number linked to Testrail} : {test case title}

Privacy

Information in privacy.md of component: updated on {date} by {user} | no change required

Approval

Approved at {date} by {user}.