Feature Wiki

Information about planned and released features

Tabs

SOAP: Add Method to Add Administrative Notifications

1 Initial Problem

By now (v9), administrative notifications (AN) can only be created via the GUI.
Thus, systems doing automated operations on ILIAS cannot create AN in the GUI.
As well, ILIAS itself cannot do so.

Examples:

  • github reports that hotfix is available for ILIAS: AN to administrator
  • github automatically updates ILIAS installation: AN to administrator
  • Server/docker creates a back-up of an ILIAS installation: AN to administrator

2 Conceptual Summary

SOAP method allows ILIAS to receive and process an XML file that describes the parameters of the AN:

  • Importance
  • Headline
  • Body (without markup)
  • Display
  • Dismissable
  • Presentation to language(s)
  • Presentation to role(s)

3 User Interface Modifications

3.1 List of Affected Views

  • (none)

3.2 User Interface Details

  • (none)

3.3 New User Interface Concepts

  • (none)

3.4 Accessibility Implications

{ If the proposal contains potential accessibility issues that are neither covered by existing UI components nor clarified by guidelines, please list them here. For every potential issue please either propose a solution or write down a short risk assessment about potential fallout if there would be no solution for the issue. }

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

{ Please list all personal data that will need to be stored or processed to implement this feature. For each date give a short explanation why it is necessary to use that date. }

6 Security

{ Does the feature include any special security relevant changes, e.g. the introducion of new endpoints or other new possible attack vectors. If yes, please explain these implications and include a commitment to deliver a written security concept as part of the feature development. This concept will need an additional approvement by the JourFixe. }

7 Contact

8 Funding

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

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}.

Last edited: 31. Jul 2024, 16:42, Suittenpointner, Florian [suittenpointner]