Course Archiver

Administration tools ::: tool_coursearchiver
Maintained by Matthew Davidson
Archive and remove past courses with this handy tool that can also be used to send notifications to course teachers, hide courses in bulk, and has the ability for course teachers to opt out of the archiving.

Course Archiver 4.1.6 (Build: 2016090200)

Moodle 2.8, 2.9, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10, 3.11, 4.0, 4.1, 4.2
Released: Monday, 4 September 2023, 10:51 PM

Code prechecks

phplint phpcs js css phpdoc savepoint thirdparty grunt shifter mustache gherkin
HTML | XML

Release Fixes

courses with unsafe filename characters in the idnumber were breaking backup

Course Archiver

This tool is used to search for courses, notify the course owners, and mass hide or archive (backup and remove) courses. The courses are stored with Moodle's backup file extension ".mbz". These files can then be manually found in the user defined folder and can be restored using Moodle's built in restore feature.

Install

copy the coursearchiver folder into the admin/tool folder.

Settings

Folder path

A folder created within the moodledata folder. The tool will create this folder, however it is recommended that the folder be created outside the moodledata folder, and a shortcut be placed in the moodledata folder.

Course Hide Email

This is the template email that will be sent to the owners of the selected courses to notify them that their course(s) will be hidden. There are two required variables in the email %to (name of the recipient) and %courses (a list of courses with mailto hyperlinks to notify the site administrator that the user wishes to opt out) or if you do not want to have the opt out link use %courses_nolink instead.

Course Archive Email

This is the template email that will be sent to the owners of the selected courses to notify them that their course(s) will be archived. There are two required variables in the email %to (name of the recipient) and %courses (a list of courses with mailto hyperlinks to notify the site administrator that the user wishes to opt out) or if you do not want to have the opt out link use %courses_nolink instead.

Course opt out persistence

A course can be opted out of the archival process and future archiver searches. This setting determines how many months the opt out with last.

Archive deletion delay

When an archived file is selected for deletion, the actual removal of the file will be delayed by x days.

Archive search limiter

Archives can get very large. This limits the amount of records returned to screen at one time.

Version information

Version build number
2023090400
Version release name
4.1.6 (Build: 2016090200)
Can be updated from
2.x (Build: 2015110501), 2.x (Build: 2015110901), 2.x (Build: 2015111301), 2.x (Build: 2015111601), 2.x (Build: 2016011801), 2.x (Build: 2016012500), 3.x (Build: 2016090200), 3.x (Build: 2016090200), 3.x (Build: 2016090200), 3.x (Build: 2016090200), 3.x (Build: 2016090200), 3.2.1 (Build: 2016090200), 3.2.2 (Build: 2016090200), 3.2.2 (Build: 2016090200), 3.3.1 (Build: 2016090200), 3.3.1 (Build: 2016090200), 3.3.1 (Build: 2016090200), 3.3.1 (Build: 2016090200), 3.3.1 (Build: 2016090200), 3.3.1 (Build: 2016090200), 3.3.1 (Build: 2016090200), 3.5.1 (Build: 2016090200), 3.5.1 (Build: 2016090200), 3.5.1 (Build: 2016090200), 3.5.1 (Build: 2016090200), 3.5.1 (Build: 2016090200), 3.5.1 (Build: 2016090200), 3.6.1 (Build: 2016090200), 3.6.1 (Build: 2016090200), 3.6.2 (Build: 2016090200), 3.6.2 (Build: 2016090200), 3.7.1 (Build: 2016090200), 3.7.1 (Build: 2016090200), 3.7.1 (Build: 2016090200), 3.7.1 (Build: 2016090200), 3.7.2 (Build: 2016090200), 3.7.3 (Build: 2016090200) (2019062700), 4.0.0 (Build: 2016090200) (2022042200), 4.0.1 (Build: 2016090200) (2022100400), 4.1.1 (Build: 2016090200) (2023021700), 4.1.2 (Build: 2016090200) (2023032100), 4.1.3 (Build: 2016090200) (2023040400), 4.1.4 (Build: 2016090200) (2023071200), 4.1.5 (Build: 2016090200), 4.1.5 (Build: 2016090200) (2023083001)
Can be updated to
4.1.7 (Build: 2016090200) (2023090500), 4.1.8 (Build: 2016090200) (2023100400), 4.5.0 (Build: 2016090200) (2025060200), 5.0.0 (2025070102)
Maturity
Stable version
MD5 Sum
89d1ee957c72e9de8baf74dc5e98816c
Supported software
Moodle 2.8, Moodle 2.9, Moodle 3.0, Moodle 3.1, Moodle 3.2, Moodle 3.3, Moodle 3.4, Moodle 3.5, Moodle 3.6, Moodle 3.7, Moodle 3.8, Moodle 3.9, Moodle 3.10, Moodle 3.11, Moodle 4.0, Moodle 4.1, Moodle 4.2
Change log URL
Alternative download URL

Version control information

Version control system (VCS)
GIT
VCS repository URL
VCS tag
v2023090400

Default installation instructions for plugins of the type Administration tools

  1. Make sure you have all the required versions.
  2. Download and unpack the module.
  3. Place the folder (eg "mytool") in the "admin/tool" subdirectory.
  4. Visit http://yoursite.com/admin to finish the installation