Feature Wiki

Information about planned and released features

Tabs

Presenting Validation Failure

Page Overview

[Hide]

1 Initial Problem

If the import aborts and gets stuck without an error message.

The person doing the import must instist on informing the administrator who then in turn is to sieve through the logs. The administrator has no error message telling what to look for, which specific object caused the abort. 

This is more cumbersome than it should be. 

Implementing Move Add New Item to Toolbar and into Modal should not be made impossible by this request. 

2 Conceptual Summary

  1. User clicks on "Add New Item". 
  2. ILIAS presents Create-dialogue with options in accordions.
  3. User selects "Option 2: Import Object Type" and uploads xml.zip of export-file. 
  4. ILIAS starts validating the object and runs into trouble.
  5. User is presented with information what is causing the trouble.:
    • For individual objects a message is presented "The uploaded file is not a valid export file: Imported export file misses x.  Please rectify export file."
    • For container objects a message is presented "Container Type comprises x objects. At least one does not validate. Please rectify all export files indict
      • Type | Title | Component  | Validation statement.
      • ...
      • Type | Title | Component | Validation statement.".
  6. ILIAS aborts the import.

3 User Interface Modifications

3.1 List of Affected Views

  • Create-Dialogue 

3.2 User Interface Details

Import of an individual object is aborted upon validation failure. Validation failure statement is presented exactly were import error messages are presented in ILIAS 9.
Import of a container with message on validating comprised objects. All objects are presented as a flat list.

3.3 New User Interface Concepts

No new UI elements are needed. 

3.4 Accessibility Implications

There are no foreseen accessibility issues. 

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

There are no foreseen privacy issues. 

6 Security

There are no foreseen security issues. 

7 Contact

8 Funding

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

  • …

9 Discussion

Kergomard, Stephan [skergomard], 14 SEP 2023: This FR looks really rudimentary, most information is missing, the printscreens show current screens (as far as I know). I don't think this is in a state to be discussed. Additional questions:

  • What importance does the "Loging Service Appender" [sic!] have for this?
  • What does this have to do with the New Item in a Modal?
  • Why should there be a download via txt-file bypassing all existing options? Shouldn't we think first about the role of this in a bigger context? Is this a concept we are going to need elsewhere? In how far is this really different from the system-errors, where the administrator only gets a reference?

Simply put: This seems to be lacking a clear concept and it is in no state to be implemented anytime soon.

Kergomard, Stephan [skergomard], 18. SEP 2023: Now the whole FR changed and it did not get any better: This we already do have in a somewhat similar form in the import for users. If we decide to do something like this we should build a usable infrastructure for all these places. Especially as a User in ILIAS is a glorified Object.

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: 18. Sep 2023, 12:43, Kergomard, Stephan [skergomard]