Feature Wiki

Information about planned and released features

Tabs

Incremental Indexing of Exercises and Wikis

Page Overview

[Hide]

1 Initial Problem

Native Lucene indexing does NOT allow for incremental updating indices. Is a learning modules title is changed, the entirety of the object must be indexed again: Including all chapters, pages and files. This is expansive and depresses performance. 

2 Conceptual Summary

It is of high importance that ONLY those objects are indexed nightly which were actually changed.

To allow determining actual changes the following object types must record the datetime of their last change.

  • Wikis
    • Pages
  • Exercises
    • Assignments titles,
    • instruction text and instruction files,
    • Start- Enddates of assignments

3 User Interface Modifications

3.1 List of Affected Views

None.

3.2 User Interface Details

This feature does not change the UI in anyway. 

3.3 New User Interface Concepts

None. 

3.4 Accessibility Implications

None. 

4 Technical Information

Should be implemented by extending the LuceneObjectDefinition.xml files (and triggering the update events).

5 Privacy

Current state exercise: https://github.com/ILIAS-eLearning/ILIAS/blob/trunk/Modules/Exercise/PRIVACY.md

Current state wikis: https://github.com/ILIAS-eLearning/ILIAS/blob/trunk/Modules/Wiki/PRIVACY.md

This feature does not add any privacy related changes.

6 Security

None.

7 Contact

8 Funding

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

  • …

9 Discussion

Killing, Alexander [alex], 7 June 2023: Several things needed, before this can go to the JF. a) The feature title adresses exercises and glossaries, the first chapter learning modules and containers. b) chapter 3 is missing, if no UI changes, this needs to be stated c) I need to write a privacy md for containers, the other ones are existing d) this really needs conceptual clarification. What are the "objects" being incrementally indexed in an exercise? How to deal with chapters / structural changes in a  learning module? How is this technically being set up exactly? I need to discuss this with Stefan first.

Tödt, Alexandra [atoedt] June, 8th 2023: 

a) & b) are done

c) is not required for this feature request but only for Incremental Indexing Learning Modules and Container

d) As per Indexability of Object Types "objects" to be incrementally indexed in excercises are

  • Object Title and description
  • Assignments titles,
  • instruction text and instruction files,
  • Start- Enddates of assignments 

Kergomard, Stephan [skergomard], 06 AUG 2023: I don't get this. How should this work? Why has Search anything to do with this beyond providing an interface for Components/Objects handing over the changes to be indexed? For me this looks like Search has internal information on Components/Objects that it should absolutely never (need to) have and that will lead to it braking upon the slightest gust of wind. If we invest in a clear and clean interface this should become obsolete, shouldn't it?

JourFixe, ILIAS [jourfixe], 07 AUG 2023 : We highly appreciate this suggestion and schedule the feature for ILIAS 9.

10 Implementation

No screenshot because there are no changes in the GUI. 

Test Cases

Tödt, Alexandra [atoedt] at 2023-10-27

  • 63607 : Search for recently changed a term

Approval

Approved at 26.10.2023 by Glaubitz, Marko [mglaubitz].

Last edited: 27. Oct 2023, 14:42, Tödt, Alexandra [atoedt]