Feature Wiki

Information about planned and released features

Tabs

OER-Harvester automatically creates Exports

1 Initial Problem

Teachers download OER from i.e. twillo and can import it into their ILIAS if it has the right format. Then they can immediately employ it or edit it. 

To allow for this all OER must be made available as an export file. In practice than means manually exporting every object that is to be published as OER. This process should be automated.

2 Conceptual Summary

When collecting objects marked as OER, the OER-Harvester should check whether the objects already have an export file marked as 'Public Access' (see Public Access Export Files for All Objects), and if not automatically create one. As the Harvester currently does not collect any container objects (see also OER-Harvester collects more object types), this process does not require any user input.

The settings of the OER-Harvester cron-job is to be expanded by a multi-select input, where object types can be deselected and excluded from being harvested. This is in addition to the opt-out for single objects that is offered currently. There is no additional opt-out for just the creation of export files: all objects that are harvested also get a public access export file, no exceptions.

This depends on the implementation of Public Access Export Files for All Objects (and subsequently Managing the Exportfiles via IRSS).

3 User Interface Modifications

3.1 List of Affected Views

  • 'Metadata' tab of any Object
  • Administration > General Settings > OER Harvester > Edit

3.2 User Interface Details

In the settings of the OER-Harvester cron job, a new multi-select 'Harvested Object Types' is shown, listing all object types that are harvested (see OER-Harvester collects more object types). By default all types are selected.

When a type is deselected, it is not harvested anymore. Previously harvested objects of that type remain in the Category where the harvester linked it to, and has to be removed manually if needed.

Further, if a license selected for the OER-Harvester is chosen in the 'Metadata' tab of an object that can be harvested (and the opt-out checkbox was not checked), the confirmation modal shows in addition to the usual warning the following text:

The copyright license you have selected makes this object eligible to be harvested as an Open Educational Ressource. If you continue, it will be listed as such along with an export file, and it might get published beyond this platform.

Moving forms to KS

To be able to move 'Edit: "OER Harvester"' to the KS, the classes from Services/Cron responsible for the generic Cron Job settings need to be moved first (which in turn depends on every other Cron Job). This would be a project in its own right, and is out of scope for this feature.

Further, repository pickers need to be implemented for KS forms. This is currently in active developement, see here.

3.3 New User Interface Concepts

No new user interface concepts required.

3.4 Accessibility Implications

No accessibility implications.

4 Technical Information

-

5 Privacy

No privacy implications beyond those explained in Public Access Export Files for All Objects.

6 Security

No foreseeable security implications.

7 Contact

8 Funding

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

9 Discussion

Kunkel, Matthias [mkunkel], 10 APR 2024: The implementation of Public Access Export Files for All Objects is a pre-requisite for this feature. Authors need to have control which version of their content is published. Unlike for the file object, other content objects can be constantly modified within ILIAS. You want to know which version is harvested and offered as an XML file to the public.

Schmitz, Tim [tschmitz], 12 APR 2024: Agreed, this feature really only makes sense with Public Access Export Files for All Objects. I'll make the dependency obligatory in the article.

Kunkel, Matthias [mkunkel], 13 MAY 2024: FR Public Access Export Files for All Objects has been accepted by JF and scheduled for ILIAS 10 at 29 APR 2024.

JourFixe, ILIAS [jourfixe], 13 MAY 2024: We highly appreciate this suggestion and schedule the feature for ILIAS 10 / trunk.

10 Implementation

{ The maintainer has to give a description of the final implementation and add screenshots if possible. }

Test Cases

Test cases completed at {date} by {user}

  • {Test case number linked to Testrail} : {test case title}

Privacy

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

Approval

Approved at {date} by {user}.

Last edited: 11. Sep 2024, 14:47, Vorkauf, Klaus [KlausVorkauf]