Feature Wiki

Information about planned and released features

Tabs

View-Actions in WOPI for File-Objects

Page Overview

[Hide]

1 Initial Problem

WOPI distinguishes between edit and view apps, currently ILIAS only uses the edit apps for editing files. However, the view apps can be used, for example, to display files (Word, PDFs, ...). The option should be offered to display file objects if you have the appropriate authorisation.

2 Conceptual Summary

If a file (ytp of the file) has a compatible WOPI view action, the file object receives an additional tab "Content" at the first position of the tabs. this then displays the WOPI editor (read-only) if a person has read permission on the file object.

In the settings of a file object, people with write rights are given a further option under "Action When Title Clicked":

- Show Content

This option cannot be activated if no view action is available for the existing file type via WOPI.

3 User Interface Modifications

3.1 List of Affected Views

  • File-Objects
    • New Tab "Content" if there is a WOPI view action for the file type
    • Settings: New option "Show Content" in "Action When Title Clicked"

3.2 User Interface Details

The settings have a new option: Clicking on the title of the file will display the content.
The editor opens the content of the file, but it cannot be edited.

3.3 New User Interface Concepts

None

3.4 Accessibility Implications

On the ILIAS side, only existing elements are used. The content and the WOPI editors cannot be influenced by ILIAS with regard to A11y. 

4 Technical Information

No special technical features. 

5 Privacy

No new personal data is collected or processed as a result of the implementation of the feature. 

6 Security

The implementation of the feature does not introduce any new attack vectors. there are no further special security-related considerations to be made.

7 Contact

8 Funding

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

9 Discussion

JourFixe, ILIAS [jourfixe], 30 SEP 2024: We highly appreciate this suggestion and accept the feature for ILIAS 10. To clarify the behaviour when clicking on the title and setting 'Show content of file': in the current implementation the file will be opened in view mode regardless of possible edit permissions. But this might be changed in a future implementation.

Schmid, Fabian [fschmid]: 28 OCT 2024: The following behaviour was not implemented (yet). I would like to discuss it as a development issue, which may also have an impact on ILIAS 9:

At the WOPI workshop in Graz and through other channels, it has already been communicated that the click behavior in ILIAS 9 is unclear or cannot be expected. One would expect that if you have the appropriate permissions and the file also has an external editor via WOPI, the editor will start directly. Currently, the file is simply downloaded. The additional setting, as suggested in this feature, would further complicate the behavior. Therefore, the following behavior is currently implemented, which could also be partially implemented in ILIAS 9:

The file object now works internally with so-called “capabilities” for all central functions. In many cases, these simply involve a permission check; in the case of WOPI, it also involves checking whether either an editor or a viewer is available for the current file. When you click on a file title in the magazine, the capabilities are checked in the following order and forwarded to the first one that is available:

  • View External: User has the permission to view the file in an external editor and the current file is supported by a WOPI viewer (open the current feature here)
  • Edit External: Dame but with a WOPI Editor
  • Download or View: The user has the permission to read the file, depending on the already available setting, the klicks leads to a download or to the info-page
  • Manage Versions: The user has write permission
  • Edit Settings: The user has write permission
  • Info Page: The user has only visible permission
  • None: The user doen't have any permission on the file

The same behavior (without the "View External" could be implemented in ILIAS 9 as well.

JourFixe, ILIAS [jourfixe], 11 NOV 2024: We highly appreciate the change of behaviour when clicking on the file title. The order of checks and the related action should be as follows:

  1. Is setting "Open Info Page" active? → Open Info page.
  2. User has the permission "VIEW CONTENT" and the current file is supported by a WOPI viewer (open the current feature here) → File is opened in WOPI viewer.
  3. User has permission "EDIT FILE" and WOPI is active → File is opened in WOPI editing mode.
  4. User has permission "EDIT SETTINGS" but no view permissions in WOPI → "Manage Versions" tab is opened
  5. User has only permissions "VISIBLE" → Info page is shown.
  6. No permission given → No title of the file object is shown in parent container.

We also accept to port this change back to ILIAS 9 (except step 2 which is not supported yet in ILIAS 9).

10 Implementation

The feature was implemented with one exception, see discussion topic (28 OCT) above:

Test Cases

Test cases completed at 25/10/24 by Lorenz, Katharina [klorenz]

  • C76998: Datei im Editor anzeigen bei Klick auf Titel

Privacy

Information in privacy.md of component: updated on {date} by {user} | no change required

Approval

Approved at 25.10.2024 by Katholische Hochschule NRW, Marvin Hackfort under the condition of fixing small bugs which were identified and will be resolved in the Beta. 

Last edited: 11. Nov 2024, 15:49, Kunkel, Matthias [mkunkel]