Use IRSS-Draft-Revisions for WOPI Edited Files

1 Initial Problem

With the implementation of the "Implement WOPI for File-Editing" feature, it will be possible to edit supported file types through an application connected via WOPI. Since ILIAS 7, the files of the file object are already in the IRSS and use, for example, the versioning (revisions) of the service.

Currently, it is intended that editing the file via a WOPI application leads to the current file version being updated. We would like to use so-called "Draft-Revisions" for this, which are proposed for the IRSS.

2 Conceptual Summary

The file object will continue to exist as a draft revision that can be edited via WOPI until this version is published. As soon as this version is published, a new draft is created and used when it is edited again via WOPI.

As long as a file object contains a draft, the behaviour is as follows:

• No new version can be created
• No existing version can be made the current version.
• File versions cannot be replaced

3 User Interface Modifications

3.1 List of Affected Views

• File-Object -> Versions
  • New Buttons "Open n Editor" (always present if the file can be edited in WOPI)
  • Publish (if there is a Draft Version)
  • New Action for Draft:versions: Publish

3.2 User Interface Details

None

3.3 New User Interface Concepts

None

3.4 Accessibility Implications

None; All standard components are used, and the new buttons are also alt-tagged where possible.

4 Technical Information

The feature uses the "IRSS draft revisions" and can only be implemented if this feature is available.

5 Privacy

No new data is collected, stored or processed. No changes to: https://github.com/ILIAS-eLearning/ILIAS/blob/trunk/Modules/File/PRIVACY.md

6 Security

No new security-relevant changes

7 Contact

• Author of the Request: Schmid, Fabian [fschmid]
• Maintainer: Schmid, Fabian [fschmid]
• 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.

• FernUniversität in Hagen
• Erziehungsdepartement Basel-Stadt

9 Discussion

Kunkel, Matthias [mkunkel], 03 JUL 2023: Maybe I misunderstood the workflow but I am wondering: You wrote 'As long as a file object contains a draft … file versions cannot be replaced' and 'As soon as this version is published, a new draft is created'. But then – IMHO – it will never be possible to stop the editing by WOPI process and to change (back) to the usual file upload for a file object. Because the file object will always be in 'editing by WOPI'-status and creating a new or replacing an existing version of this file is prevented. Or am I wrong?

JourFixe, ILIAS [jourfixe], 10 JUL 2023: We highly appreciate this suggestion and accept the feature for ILIAS 9. Once a draft has been deleted, it is possible to create a new version or replace an existing one _until_ another user starts to edit the file again. In this time, both related buttons are activated.

10 Implementation

The IRSS has been extended with the functionality of draft revisions: IRSS: Draft-Revisions. The usage of the draft revision in the file object are documented on the feature wiki page of the WOPI implementation: Implement WOPI for File-Editing.

Test Cases

The feature is covered by the test cases of the feature request Implement WOPI for File-Editing.

Privacy

Information in privacy.md of component: no change required

Approval

Approved at 16.10.2023 by Schmid, Fabian [fschmid] (JF via PR): https://github.com/ILIAS-eLearning/ILIAS/pull/6403
Approved at 24.10.2023 by Fréquelin, Fabrice [frequelin], FernUniversität in Hagen