Inactive User Cleanup: Difference between revisions
From MoodleDocs
| Inactive User Cleanup | |
|---|---|
| Type | Block |
| Set | N/A |
| Downloads | https://moodle.org/plugins/view.php?plugin=block_eledia_usercleanup |
| Issues | https://tracker.moodle.org/browse/CONTRIB-4257 |
| Discussion | |
| Maintainer(s) | Benjamin Wolf |
(the path should be moodle/admin/tool, not moodle/blocks) |
(Undo revision 147261 by Annalaattala (talk)) Tag: Undo |
||
| Line 7: | Line 7: | ||
|float = right | |float = right | ||
}} | }} | ||
== Overview == | == Overview == | ||
This plugin deletes inactive user accounts. The cleanup process runs with the Moodle cron. | This plugin deletes inactive user accounts. The cleanup process runs with the Moodle cron. | ||
The cleanup-process runs in two steps for each user. If an inactive user is found he gets a notification mail and is marked as notified within this plugin. | The cleanup-process runs in two steps for each user. If an inactive user is found he gets a notification mail and is marked as notified within this plugin. | ||
When the user still has not accessed the system after a chosen timespan he will be deleted in the second step. | When the user still has not accessed the system after a chosen timespan he will be deleted in the second step. | ||
When a notified user logs in again before the deletion process starts, his notify entry is removed with the next run of the cleanup process. | When a notified user logs in again before the deletion process starts, his notify entry is removed with the next run of the cleanup process. | ||
| Line 16: | Line 18: | ||
The process checks the last access time stamp of the user against the present time stamp. | The process checks the last access time stamp of the user against the present time stamp. | ||
You can configure how often the process is started by a time interval in days. | You can configure how often the process is started by a time interval in days. | ||
== Installation == | == Installation == | ||
# Make sure you have all the required versions. | # Make sure you have all the required versions. | ||
# Download the User Cleanup plugin. | # Download the User Cleanup plugin. | ||
# Unzip it into your '''moodle/ | # Unzip it into your '''moodle/blocks/''' directory. | ||
# Login to you moodle as Administrator and go to Site administration -> Notifications to trigger the installation process. | # Login to you moodle as Administrator and go to Site administration -> Notifications to trigger the installation process. | ||
# Turn editing on the home page. | # Turn editing on the home page. | ||
# Add the block to the page. | # Add the block to the page. | ||
# Follow the link in the block to the settings page and make your settings(Details described below). | # Follow the link in the block to the settings page and make your settings(Details described below). | ||
For more information see [[Installing contributed modules or plugins]]. | For more information see [[Installing contributed modules or plugins]]. | ||
== Using == | == Using == | ||
The block can be included by the admin on the main page. The block offers a link to the plugin settings. | The block can be included by the admin on the main page. The block offers a link to the plugin settings. | ||
''NOTE: The cleanup process itself runs in the moodle cron. So the moodle cron must be running to use this plugin. For more Information see [[Cron]].'' | ''NOTE: The cleanup process itself runs in the moodle cron. So the moodle cron must be running to use this plugin. For more Information see [[Cron]].'' | ||
[[Image:MoodleDocs Edit Settings.jpg|frame|right|Plugin Settings | |||
[[Image:MoodleDocs Edit Settings.jpg|frame|right|Plugin Settings]] | |||
=== Settings === | === Settings === | ||
The settings for the cleanup process | The settings for the cleanup process | ||
; Activate : Here you can activate or deactivate the cleanup cron process. | ; Activate : Here you can activate or deactivate the cleanup cron process. | ||
| Line 39: | Line 50: | ||
; Days before deletion : The number of days after the notify mail until he gets deleted. | ; Days before deletion : The number of days after the notify mail until he gets deleted. | ||
=== Mail Text === | === Mail Text === | ||
The mail text and any other texts of the plugin can be customized over the moodle [[Language customization]]. | The mail text and any other texts of the plugin can be customized over the moodle [[Language customization]]. | ||
== Credits == | == Credits == | ||
[http://eledia.de/ eLeDia - E-Learning im Dialog GmbH] | [http://eledia.de/ eLeDia - E-Learning im Dialog GmbH] | ||
Mail: info@eledia.de | Mail: info@eledia.de | ||
== See also == | == See also == | ||
CONTRIB-4257 | CONTRIB-4257 | ||
[https://moodle.org/plugins/view.php?plugin=block_eledia_usercleanup Modules & Plugins] database entry | [https://moodle.org/plugins/view.php?plugin=block_eledia_usercleanup Modules & Plugins] database entry | ||
=== GitHub === | === GitHub === | ||
You can also find the code on GitHub. | You can also find the code on GitHub. | ||
| Line 57: | Line 76: | ||
[[ | [[es:Limpieza de usuarios inactivos]] | ||
Latest revision as of 07:05, 3 November 2023
Overview
This plugin deletes inactive user accounts. The cleanup process runs with the Moodle cron.
The cleanup-process runs in two steps for each user. If an inactive user is found he gets a notification mail and is marked as notified within this plugin. When the user still has not accessed the system after a chosen timespan he will be deleted in the second step. When a notified user logs in again before the deletion process starts, his notify entry is removed with the next run of the cleanup process.
The process checks the last access time stamp of the user against the present time stamp. You can configure how often the process is started by a time interval in days.
Installation
- Make sure you have all the required versions.
- Download the User Cleanup plugin.
- Unzip it into your moodle/blocks/ directory.
- Login to you moodle as Administrator and go to Site administration -> Notifications to trigger the installation process.
- Turn editing on the home page.
- Add the block to the page.
- Follow the link in the block to the settings page and make your settings(Details described below).
For more information see Installing contributed modules or plugins.
Using
The block can be included by the admin on the main page. The block offers a link to the plugin settings.
NOTE: The cleanup process itself runs in the moodle cron. So the moodle cron must be running to use this plugin. For more Information see Cron.
File:MoodleDocs Edit Settings.jpg
Plugin Settings
Settings
The settings for the cleanup process
- Activate
- Here you can activate or deactivate the cleanup cron process.
- Interval to check
- Set how often the process should start (days). If set to 0 or negative the process runs with every moodle cron.
- Days of inactivity
- The number of days since last login to mark the user as inactive and notify him by mail.
- Days before deletion
- The number of days after the notify mail until he gets deleted.
Mail Text
The mail text and any other texts of the plugin can be customized over the moodle Language customization.
Credits
eLeDia - E-Learning im Dialog GmbH
Mail: info@eledia.de
See also
Modules & Plugins database entry
GitHub
You can also find the code on GitHub.
https://github.com/eledia/eledia_usercleanup
NOTE: In GitHub we use an empty master branch. The different plugin versions can be found in special branches for each Moodle version.
