Feature Wiki
Tabs
WOPI: Convert Actions
Page Overview
[Hide]- 1 Initial Problem
- 2 Conceptual Summary
- 3 Additional Information
- 3.1 Involved Authorities
- 3.2 Technical Aspects
- 3.3 Privacy
- 3.4 Security
- 3.5 Contact
- 3.6 Funding
- 4 Discussion
- 5 Implementation
- 5.1 Description and Screenshots
- 5.2 Test Cases
- 5.3 Privacy
- 5.4 Approval
1 Initial Problem
It is often important to be able to convert files from one format to another. A common use case for this is, for example, that you want to convert an edited document (Word) into a PDF at the end.
2 Conceptual Summary
WOPI editors usually offer an additional API for such purposes. This makes it possible to open a file and convert it into another format at the same time. These APIs are currently offered by Collabora and OnlyOffice:
In ILIAS, an additional button “Convert to PDF” would be displayed in the Versions tab for supported file types. Clicking on the button sends the current file to the conversion API of the configured WOPI editor (if supported). After submitting the form, the current file is sent to the conversion service. The result is then saved as a new file version (revision). This means that it is also possible to restore the original file at a later point.
2.1 List of Affected Views
- Files -> Versions
2.2 User Interface Details
- New Button "Convert to PDF"
- Opens Modal wirth Selection of Target Formats
2.3 New User Interface Concepts
The feature is implemented with existing UI components and does not introduce any new UI concepts.
2.4 Accessibility Implications
The use of existing UI components does not introduce any new implications for accessibility.
3 Additional Information
3.1 Involved Authorities
- Authority to Sign off on Conceptual Changes: Schmid, Fabian [fschmid]
- Authority to Sign off Code Changes: Schmid, Fabian [fschmid]
If this request is related to multiple components, please list both authorities for all related components.
3.2 Technical Aspects
The Conversion API is not an official part of the WOPI specification. Microsoft itself has not implemented this API, for example, but the two competitors (and currently the only editors used with ILAIS), the API is present and structured in the same way. In principle, other conversions would also be possible at a later date, and the same mechanism could also be used to create preview images for Word documents, for example.
3.3 Privacy
No new personal data is collected or processed as a result of the implementation of the feature.
3.4 Security
The implementation of the feature does not introduce any new attack vectors. there are no further special security-related considerations to be made.
3.5 Contact
Person to be contacted in case of questions about the feature or for funding offers: Lorenz, Katharina [klorenz]
3.6 Funding
Funding status and funding parties are listed in the block 'Status of Feature' in the right column of this page.
If you are interested to give funding for this feature, please get into contact with the person mentioned above as 'Contact'.
4 Discussion
5 Implementation
Feature has been implemented by {Please add related profile link of this person}
5.1 Description and Screenshots
{ Description of the final implementation and screenshots if possible. }
5.2 Test Cases
Test cases completed at {date} by {user}
- {Test case number linked to Testrail} : {test case title}
5.3 Privacy
Information in privacy.md of component: updated at {date} by {user} | no change required
5.4 Approval
Approved at {date} by {user}.
Last edited: 14. Feb 2025, 16:25, Schmid, Fabian [fschmid]