Custom Metadata for Individual Assessment

1 Initial Problem

Advanced Metadata are a standard way in ILIAS to add custom fields to ILIAS objects. Currently they are only supported from some objects. They facilitate scenarios where users should be given some none standard information about objects or ILIAS is connected to some external system that delivers or requires additional information.

The Individual Assessment should support Advanced Metadata, just like other ILIAS-objects.

2 Conceptual Summary

The Individual Assessment should support Custom Metadata just like other objects. That means:

• In the administration of the Custom Metadata it should be possible to attach a dataset to the Individual Assessment with the two option "Dataset always offered" and "Dataset needs activation".
• If "Dataset alwas offered" is chosen for the Individual Assessment, a new tab "Metadata" appears in Individual Assessment, displaying a form with the custom metadata record.
• If "Dataset needs activation" is chosen, the record is only shown like described above if the "Additional Feature" "Custom Metadata" is activated for an Individual Assessment in the its general settings.

3 User Interface Modifications

3.1 List of Affected Views

• Individual Assessment > Settings
• Administration > Metadata > Custom Metadata
• Repository view of Individual Assessment
• Individual Assessment > Info

3.2 User Interface Details

• Individual Assessment > Settings will get a new Option "Custom Metadata".
• in Administration > Metadata > Custom Metadata the Individual Assessment is added to the "Assigned Objects" with the three options "Dataset not used", "Dataset always offered" and "Dataset needs activation". This will also be done in the related form, which is opened upon clicking on "edit" at said page.
• Individual Assessment will get a new Tab "Metadata" displaying the according records is a standard manner.

3.3 New User Interface Concepts

None, pretty standard.

4 Technical Information

This will add a new dependency from the Individual Assessment to the Custom Metadata Service.

5 Contact

• Author of the Request: Richard Klees
• Maintainer: Richard Klees
  
• Implementation of the feature is done by: {The maintainer must add the name of the implementing developer.}

6 Funding

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

• DHBW Karlsruhe

7 Discussion

JourFixe, ILIAS [jourfixe], 04 JUN 2018 : We highly appreciate this suggestion and schedule it for 5.4. A documentation of the custom metadata service is very welcome. Please clarify in this documentation what a developer needs to do to include the custom metadata into the Lucene server service.

Klees, Richard [rklees], 2018-11-08 - As requested in this PR we implemented the custom metadata for the individual assessment. The LO-metadata was never addresses during concept phase or developement of this feature. When testing the feature, the customer realized, that in fact the LO-metadata is not included in this feature. He thinks that this will irritate his users that are accustomed to the "full" set of metadata, which is an argument which I can understand and agree to. The customer does realize, as well as I do, that this request does not include LOM and that introduction of LOM would need to be a a new feature request for 6.0. I still agreed to ask for the courtesy of the JF to allow the introduction of LOM after the fact based on this feature request and the observation that users won't understand why custom and LO-metadata are not shipped at the same time and be confused about the missing LOM. The risk involved here is quite low from my perspective as a maintainer as introduction of the LOM in addition to the custom metadata is a standard procedure.

Klees, Richard [rklees], 2018-12-04: For documentation purpose: The JF accepted the addition of LOM as usability bugfix on 2018-11-12. The code was added in [https://github.com/ILIAS-eLearning/ILIAS/pull/1345|PR 1345]/[https://github.com/ILIAS-eLearning/ILIAS/pull/1346|PR 1346]. The documentation an testcases where adjusted accordingly.

8 Implementation

Test Cases

Test cases completed at 2018-10-22 by Klees, Richard [rklees]

• 24874: Objekte mit erweiterten Metadaten versehen (Individuelle Bewertung)
• 24875: Konfiguration von erweiterten Metadaten (Individuelle Bewertung)
• 25067: Objekte mit optionalen erweiterten Metadaten versehen (Individuelle Bewertung)
• 25068: Erweiterte Metadaten sind nur für Benutzer mit "Einstellungen bearbeiten" sichtbar (Individuelle Bewertung)
• 25086: Individual Assessment bietet LOM an

Approval

Approved at 2018-10-16 by Jackisch, Ingo [jackisch]
LOM additionally approved 2018-12-03 by < Jackisch, Ingo [jackisch]