The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
Table of Contents
This plugin enables the import of course or group memberships via CSV file. User accounts are identified by either:
- user account name
- email address
- matriculation number
The user accounts MUST exist already. This plugin cannot be used to create user accounts. The plugin will process files as a background task to enable administrators to better protect system resources. Users with the permission to manage course/group members (typically: course admin, group admin) can access a new tab: "Membership import" for courses and groups. There users can upload a CSV file containing the users to be added as course/group members. The plugin cannot be used to remove users from courses or groups.
The CrsGrpEnrollment plugin will create a report file (CSV) for download once an import task is done. This report will ONLY list user accounts that could not be added to the course/group and list the (potential) reason:
- no user account found matching a) user account name, b) email adress or c) matriculation number (please note: in case of the email address only the primary email address is checked)
- user account already assigned to course/group
- course/group no longer available (i.e. has been deleted before the import was run)
- PHP:
- ILIAS:
- Permissions: In order to import course or group memberships, the active user MUST have the permission to manage members for courses/groups in ILIAS.
- SOAP administration MUST be enabled.
- Background Tasks: In order to enable asynchronous processing of import files you SHOULD activate the asynchronous processing of background tasks in the ILIAS setup. Otherwise uploaded files will be processed on runtime. System administrators SHOULD configure the max. number of concurrent tasks according to the available system resources. In addition, system administrators SHOULD enable the cron for cleanup of files left behind by background processes.
- CSV: The import file MUST be CSV and MUST contain 1 (one) user account name OR 1 (one) email address OR 1 (one) matriculation number per row. The file MUST contain 1 (one) column only.
This plugin MUST be installed as a User Interface Plugin.
The files MUST be saved in the following directory:
<ILIAS>/Customizing/global/plugins/Services/UIComponent/UserInterfaceHook/CrsGrpEnrollment
Correct file and folder permissions MUST be ensured by the responsible system administrator.
After the plugin files have been installed as described above,
please install the composer dependencies:
cd Customizing/global/plugins/Services/UIComponent/UserInterfaceHook/CrsGrpEnrollment
composer install --no-devSee LICENSE file in this repository.