File-Object: Show number of downloads

1 Initial Problem

ILIAS shows the number of read-events of a file, but not how many times it was actually downloaded.

2 Conceptual Summary

The info page of a file object is extended to show the number of downloads. Initially (with an update step) the number of read-events is used as the number of downloads, the oldest entry in read_events for this file is used as the date. The display is also supplemented with the information since when the count has taken place (initial: creation date of the object).

3 User Interface Modifications

3.1 List of Affected Views

• Info-Page of File-Objects: New Item in "File Information"

3.2 User Interface Details

New Item "Downloads" in "File Information":

In Administration -> Repository and Objects -> File, a new Checkbox (initially checked after update/installation) is implemented to activate/deactivate the display of the value on a File-Objects's info-Page. This setting has no relation to the setting "Show Tracking Information" in Administration -> Repository.

3.3 New User Interface Concepts

No new User Interface Concepts

3.4 Accessibility Implications

None

4 Technical Information

The information will be stored in file_data and will be increased everytime, a user downloads a file. We will initially parse the infos from read_event in a database-update step which will increase the number of downloads with data from read_events. after that, those features are no longer related to each other. 

5 Privacy

No user-related data is stored as part of this feature

6 Security

No security-related changes are made to the code as part of this feature.

7 Contact

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

8 Funding

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

• …

9 Discussion

Schmid, Fabian [fschmid] 2022-05-27: As maintainer I support this request

Kunkel, Matthias [mkunkel], 19 JUL 2022 : I suggest a slight modification of the shown information to start the value with the most important date:
Downloads: {number} since {date}

Schmid, Fabian [fschmid], 03 AUG 2022: Thanks Matthias for the suggestion, we will implement it that way.

Jansen, Michael [mjansen], 08 AUG 2022: Do we really need a new database field to store the event of a file download? IMO a Read Event is already recorded in \ilObjFileGUI::sendFile if the file download request is initiated by a user . So the information "Date/Time of 1st Download" and "Number of Downloads" could be provided by the read_event database table, which belongs to the Tracking Service. If there isn't an appropriate API, yet, this could maybe be created.

JourFixe, ILIAS [jourfixe], 08 AUG 2022: Before scheduling this feature we have to clarify how we enable/control this feature. Is it dependent from the general setting "Show Tracking Information" in Administration » Repository? Or will there be a distinct setting for it in the File administration to disable/enable the presentation of the number of downloads.

JourFixe, ILIAS [jourfixe], 14 NOV 2022: Thanks for updating the request and giving an answer to the question from the JF. We highly appreciate this suggestion and accept the feature request for ILIAS 9.

10 Implementation

Test Cases

Test cases completed at 23th DEC 2022 by Lorenz, Katharina [klorenz]

• C53172: Anzahl Downloads im Info-Tab anzeigen

Approval

Approved at 16th DEC 2022 by Seibt, Alina [alina.seibt].