IRSS: Migrate Exercise to IRSS (Instruction Files)

1 Initial Problem

This is a Spin-Off from IRSS: Migrate Exercise to IRSS.

The exercise object has different use cases for working with files. These are migrated separately into the IRSS.

The instruction files are also used to document the view of how files in a collection can be processed. In the course of the migration, these views are to be converted to UI components and replace the corresponding deprecated views from the services/file system (see  PR#5158).

2 Conceptual Summary

The migration of the instruction files is implemented analogously to the procedure (https://github.com/ILIAS-eLearning/ILIAS/blob/trunk/Services/ResourceStorage/MIGRATIONS.md) and made available to the Mintainer as a pull request. Internally, the exercise object is modified so that new instruction files are stored directly in the IRSS. However, a conversion of the forms to UI inputs is not part of this conversion.

The implementation is done in such a way that the old views are used for non-migrated exercise units (from the service/file system), and the new views with UI components are used for migrated ones.

The table exc_assignment gets a new column if_rcid which stores the ResourceCollection-ID. All files that are added to an exercise unit as an instruction file are part of a corresponding ResourceCollection.

3 User Interface Modifications

3.1 List of Affected Views

• The display of the files uses the following feature: IRSS: Resource-Collection User-Interface

3.2 User Interface Details

See IRSS: Resource-Collection User-Interface

3.3 New User Interface Concepts

See IRSS: Resource-Collection User-Interface

3.4 Accessibility Implications

See IRSS: Resource-Collection User-Interface

4 Technical Information

For details on the IRSS see https://github.com/ILIAS-eLearning/ILIAS/tree/trunk/src/ResourceStorage 

5 Privacy

For current privacy state in exercises see https://github.com/ILIAS-eLearning/ILIAS/blob/trunk/Modules/Exercise/PRIVACY.md and https://github.com/ILIAS-eLearning/ILIAS/blob/trunk/src/ResourceStorage/PRIVACY.md

This feature does not include any privacy related changes.

6 Security

The Project: ILIAS Resource Storage Service (IRSS) aims to increase security in the long run, for details visit the project page.

7 Contact

• Author of the Request: Schmid, Fabian [fschmid]
• Maintainer:  
• Implementation of the feature is done by: Schmid, Fabian [fschmid] 

8 Funding

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

9 Discussion

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

10 Implementation

The Implementation has been presented as Pull-Request and has been merged by the maintainer: https://github.com/ILIAS-eLearning/ILIAS/pull/5964

A new migration has been introduced with ILIAS 9:  exercise.ilExerciseInstructionFilesMigration

The migration lists one step per assignment. The instruction files assigned to an assignment are moved to a ResourceCollection. The assignment saves the corresponding ResourceCollectionIdentification.

The presentation of the instruction files uses the ilResourceCollectionGUI:

Test Cases

• There are no seperate test cases for Migrations

Privacy

Information in privacy.md of component:  no change required

Approval

Approved at 19. October, 2023 by Amstutz, Timon [amstutz].